admin/kb-zup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

first

Browse Source
This commit is contained in:
wakadakawaka 2025-04-25 21:42:06 +05:00
commit 1587f32ca8
978 changed files with 287228 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
.gitignore vendored Normal file
View File

@ -0,0 +1,21 @@
# build output
dist/
# generated types
.astro/
# dependencies
node_modules/
# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
# environment variables
.env
.env.production
# macOS-specific files
.DS_Store

4
.vscode/extensions.json vendored Normal file
View File

@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}

11
.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}

54
README.md Normal file
View File

@ -0,0 +1,54 @@
# Starlight Starter Kit: Basics
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
```
npm create astro@latest -- --template starlight
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🚀 Project Structure
Inside of your Astro + Starlight project, you'll see the following folders and files:
```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the `public/` directory.
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

30
astro.config.mjs Normal file
View File

@ -0,0 +1,30 @@
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
// https://astro.build/config
export default defineConfig({
base: '/',
integrations: [
starlight({
title: 'Программный интерфейс ЗУП',
customCss: [
// Relative path to your custom CSS file
'./src/styles/custom.css',
],
//social: [{ icon: 'github', label: 'GitHub', href: 'https://git.sinenikolsky.ru/artem/starlite-bsp-kb.git' }],
sidebar: [
{
collapsed: true,
label: 'Зарплата и управление персоналом',
autogenerate: { directory: 'zup' },
},
{
collapsed: true,
label: 'Библиотека стандартных подсистем',
autogenerate: { directory: 'bsp' },
},
],
}),
],
});

6660
package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

17
package.json Normal file
View File

@ -0,0 +1,17 @@
{
"name": "starlight",
"type": "module",
"version": "0.0.1",
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview",
"astro": "astro"
},
"dependencies": {
"@astrojs/starlight": "^0.33.1",
"astro": "^5.6.1",
"sharp": "^0.32.5"
}
}

1
public/favicon.svg Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path fill-rule="evenodd" d="M81 36 64 0 47 36l-1 2-9-10a6 6 0 0 0-9 9l10 10h-2L0 64l36 17h2L28 91a6 6 0 1 0 9 9l9-10 1 2 17 36 17-36v-2l9 10a6 6 0 1 0 9-9l-9-9 2-1 36-17-36-17-2-1 9-9a6 6 0 1 0-9-9l-9 10v-2Zm-17 2-2 5c-4 8-11 15-19 19l-5 2 5 2c8 4 15 11 19 19l2 5 2-5c4-8 11-15 19-19l5-2-5-2c-8-4-15-11-19-19l-2-5Z" clip-rule="evenodd"/><path d="M118 19a6 6 0 0 0-9-9l-3 3a6 6 0 1 0 9 9l3-3Zm-96 4c-2 2-6 2-9 0l-3-3a6 6 0 1 1 9-9l3 3c3 2 3 6 0 9Zm0 82c-2-2-6-2-9 0l-3 3a6 6 0 1 0 9 9l3-3c3-2 3-6 0-9Zm96 4a6 6 0 0 1-9 9l-3-3a6 6 0 1 1 9-9l3 3Z"/><style>path{fill:#000}@media (prefers-color-scheme:dark){path{fill:#fff}}</style></svg>
Side by Side

After

Width:  |  Height:  |  Size: 696 B

BIN
src/assets/houston.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 96 KiB

7
src/content.config.ts Normal file
View File

@ -0,0 +1,7 @@
import { defineCollection } from 'astro:content';
import { docsLoader } from '@astrojs/starlight/loaders';
import { docsSchema } from '@astrojs/starlight/schema';
export const collections = {
docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
};

221
src/content/docs/bsp/ZipАрхивы.md Normal file
View File

@ -0,0 +1,221 @@
---
title: Zip архивы
slug: bsp/zip-архивы
---
## Создать
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры:
// ИмяФайла - Строка
//
// Возвращаемое значение:
// Структура - Описание:
// * ИмяФайла - Строка
// * Размер - Число
// * РазмерКаталога - Число
// * Файлы - Массив Из см. ПрочитатьЗаписьКаталога
// * Поток - ФайловыйПоток
//
Функция Создать(ИмяФайла) Экспорт
```
Пример вызова
```bsl
Результат = ZipАрхивы.Создать(ИмяФайла)
```
</details>
## ДобавитьФайл
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры:
// Архив - см. Создать
// ИмяФайла - Строка
//
Процедура ДобавитьФайл(Архив, ИмяФайла) Экспорт
```
Пример вызова
```bsl
ZipАрхивы.ДобавитьФайл(Архив, ИмяФайла)
```
</details>
## Размер
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры:
// Архив - см. Создать
//
// Возвращаемое значение:
// Число
Функция Размер(Архив) Экспорт
```
Пример вызова
```bsl
Результат = ZipАрхивы.Размер(Архив)
```
</details>
## ОтделитьЧасть
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры:
// Архив - см. Создать
// ИмяФайла - Строка
//
Процедура ОтделитьЧасть(Архив, ИмяФайла) Экспорт
```
Пример вызова
```bsl
ZipАрхивы.ОтделитьЧасть(Архив, ИмяФайла)
```
</details>
## Завершить
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры:
// Архив - см. Создать
//
Процедура Завершить(Архив) Экспорт
```
Пример вызова
```bsl
ZipАрхивы.Завершить(Архив)
```
</details>
## ПрочитатьАрхив
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Прочитать архив.
//
// Параметры:
// Источник - ФайловыйПоток, ПотокВПамяти, УникальныйИдентификатор -
// источник архива, если УникальныйИдентификатор - то это файл в томе.
//
// Возвращаемое значение:
// Структура:
// * КаталогФайлов - Соответствие из КлючИЗначение:
// ** Ключ - строка - имя файла.
// ** Значение - см. ПрочитатьЗаписьКаталога
// * Источник - ФайловыйПоток, ПотокВПамяти, УникальныйИдентификатор -
// * КонецКаталога - см. КонецКаталога
// * Смещение - Число
// * Размер - Число
// - Неопределено
Функция ПрочитатьАрхив(Источник) Экспорт
```
Пример вызова
```bsl
Результат = ZipАрхивы.ПрочитатьАрхив(Источник)
```
</details>
## ПрочитатьВложенныйНесжатыйАрхив
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры:
// ДанныеАрхива - см. ZipАрхивы.ПрочитатьАрхив
// ИмяФайла - Строка - имя файла в архиве
//
// Возвращаемое значение:
// см. ПрочитатьАрхив
Функция ПрочитатьВложенныйНесжатыйАрхив(ДанныеАрхива, ИмяФайла) Экспорт
```
Пример вызова
```bsl
Результат = ZipАрхивы.ПрочитатьВложенныйНесжатыйАрхив(ДанныеАрхива, ИмяФайла)
```
</details>
## ИзвлечьФайл
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры:
// ДанныеАрхива - см. ZipАрхивы.ПрочитатьАрхив
// ИмяФайла - Строка
// Каталог - Строка
//
// Возвращаемое значение:
// Булево
Функция ИзвлечьФайл(ДанныеАрхива, ИмяФайла, Каталог) Экспорт
```
Пример вызова
```bsl
Результат = ZipАрхивы.ИзвлечьФайл(ДанныеАрхива, ИмяФайла, Каталог)
```
</details>
## ПрочитатьФайл
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Прочитать файл
//
// Параметры:
// ДанныеАрхива - см. ZipАрхивы.ПрочитатьАрхив
// ИмяФайла - Строка
//
// Возвращаемое значение:
// ДвоичныеДанные, Неопределено - Прочитать файл
Функция ПрочитатьФайл(ДанныеАрхива, ИмяФайла) Экспорт
```
Пример вызова
```bsl
Результат = ZipАрхивы.ПрочитатьФайл(ДанныеАрхива, ИмяФайла)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

142
src/content/docs/bsp/АвтономнаяРабота.md Normal file
View File

@ -0,0 +1,142 @@
---
title: Автономная работа
slug: bsp/автономная-работа
---
## ОбъектПриЧтенииНаСервере
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик события формы ПриЧтенииНаСервере, который
// встраивается в формы элементов данных
// (элементов справочников, документов, записей регистров, и др.),
// чтобы заблокировать форму, если это попытка изменения неразделенных данных,
// получаемых из приложения, в автономном рабочем месте.
//
// Параметры:
// ТекущийОбъект - СправочникОбъект
// - ДокументОбъект
// - ПланВидовХарактеристикОбъект
// - ПланСчетовОбъект
// - ПланВидовРасчетаОбъект
// - БизнесПроцессОбъект
// - ЗадачаОбъект
// - ПланОбменаОбъект
// - РегистрСведенийМенеджерЗаписи - менеджер записи.
// ТолькоПросмотр - Булево - свойство ТолькоПросмотр формы.
//
Процедура ОбъектПриЧтенииНаСервере(ТекущийОбъект, ТолькоПросмотр) Экспорт
```
Пример вызова
```bsl
АвтономнаяРабота.ОбъектПриЧтенииНаСервере(ТекущийОбъект, ТолькоПросмотр)
```
</details>
## ОтключитьАвтоматическуюСинхронизациюДанныхСПриложениемВИнтернете
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отключает автоматическую синхронизацию между приложением в интернете
// и автономным рабочим местом в случаях когда, не задан пароль для установки подключения.
//
// Параметры:
// Источник - Справочник.НастройкиТранспортаСообщенийОбмена - запись справочника настроек транспорта,
// которая была изменена.
//
Процедура ОтключитьАвтоматическуюСинхронизациюДанныхСПриложениемВИнтернете(Источник) Экспорт
```
Пример вызова
```bsl
АвтономнаяРабота.ОтключитьАвтоматическуюСинхронизациюДанныхСПриложениемВИнтернете(Источник)
```
</details>
## ФлагНастройкиВопросаОДолгойСинхронизации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Читает и устанавливает настройку предупреждения о продолжительной синхронизации АРМ.
//
// Параметры:
// ЗначениеФлага - Булево - устанавливаемое значение флага
// ОписаниеНастройки - Структура - принимает значение для описания настройки.
//
// Возвращаемое значение:
// Булево, Неопределено - значение настройки отображения предупреждения о долгой синхронизации.
//
Функция ФлагНастройкиВопросаОДолгойСинхронизации(ЗначениеФлага = Неопределено, ОписаниеНастройки = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = АвтономнаяРабота.ФлагНастройкиВопросаОДолгойСинхронизации(ЗначениеФлага, ОписаниеНастройки);
```
</details>
## АдресДляВосстановленияПароляУчетнойЗаписи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает адрес для восстановления пароля учетной записи приложения в интернете.
//
// Возвращаемое значение:
// Строка - адрес восстановления пароля учетной записи.
//
Функция АдресДляВосстановленияПароляУчетнойЗаписи() Экспорт
```
Пример вызова
```bsl
Результат = АвтономнаяРабота.АдресДляВосстановленияПароляУчетнойЗаписи()
```
</details>
## ПродолжитьНастройкуАвтономногоРабочегоМеста
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Настраивает автономное рабочее место при первом запуске.
// Заполняет состав пользователей и другие настройки.
// Вызывается перед авторизацией пользователя. Может потребоваться перезапуск.
//
// Параметры:
// Параметры - Структура - структура параметров.
//
// Возвращаемое значение:
// Булево - признак возможности продолжения настройки автономного рабочего места.
//
Функция ПродолжитьНастройкуАвтономногоРабочегоМеста(Параметры) Экспорт
```
Пример вызова
```bsl
Результат = АвтономнаяРабота.ПродолжитьНастройкуАвтономногоРабочегоМеста(Параметры)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

1509
src/content/docs/bsp/АдминистрированиеКластера.md Normal file
View File

File diff suppressed because it is too large Load Diff

1260
src/content/docs/bsp/АдминистрированиеКластераКлиентСервер.md Normal file
View File

File diff suppressed because it is too large Load Diff

468
src/content/docs/bsp/АдресныйКлассификатор.md Normal file
View File

@ -0,0 +1,468 @@
---
title: Адресный классификатор
slug: bsp/адресный-классификатор
---
## НаименованиеРегионаПоКоду
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет полное наименование региона по его коду.
//
// Параметры:
// КодСубъектаРФ - Число
// - Строка - код региона. Например, 50.
//
// Возвращаемое значение:
// Строка - наименование региона согласно ГАР. Например, "Московская область" или "Московская обл".
// Неопределено - если регион не существует.
//
Функция НаименованиеРегионаПоКоду(КодСубъектаРФ) Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.НаименованиеРегионаПоКоду(КодСубъектаРФ)
```
</details>
## КодРегионаПоНаименованию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код региона по наименованию.
//
// Параметры:
// Название - Строка - наименование или полное наименование (с сокращением) региона.
// Например, "Московская" или Московская обл".
//
// Возвращаемое значение:
// Число - код региона, например, 50.
// Неопределено - если указанный регион не существует.
//
Функция КодРегионаПоНаименованию(Название) Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.КодРегионаПоНаименованию(Название)
```
</details>
## СубъектыРФ
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает информацию о субъектах РФ определенных в федеральной информационной адресной системе.
//
// Возвращаемое значение:
// ТаблицаЗначений - сведения о субъектах(регионах) РФ:
// * КодСубъектаРФ - Число - код субъекта, например 77 для Москвы.
// * Наименование - Строка - наименование субъекта. Например "Московская".
// * ТипОбъекта - Строка - сокращение субъекта. Например "обл".
// * ПочтовыйИндекс - Число - индекс региона. Если 0 - то индекс не определен.
// * Идентификатор - УникальныйИдентификатор - уникальный идентификационный код адресного объекта.
// * Сокращение - Строка - устарело. Следует использовать свойство ТипОбъекта.
//
Функция СубъектыРФ() Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.СубъектыРФ()
```
</details>
## КоличествоЗагруженныхРегионов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает количество загруженных в адресный классификатор субъектов РФ.
// Из-за проверки доступности веб-сервиса выполнение функции может занимать 7 секунд.
// Поэтому для исключения зависаний пользовательского интерфейса, например при открытии формы,
// следует вызвать в фоновом задании.
// Т.к. при использовании веб-сервиса фирмы "1С" предоставляющего через Интернет сведения об
// адресах РФ в формате адресного классификатора, всегда доступны адресные сведения по всем регионам РФ,
// то возвращает общее количество субъектов РФ.
//
// Возвращаемое значение:
// Число - количество субъектов РФ, содержащих загруженные адресные сведения в адресном классификаторе.
//
Функция КоличествоЗагруженныхРегионов() Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.КоличествоЗагруженныхРегионов()
```
</details>
## АдресныйКлассификаторЗагружен
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет наличие адресных сведений в адресном классификаторе.
// Из-за проверки доступности веб-сервиса выполнение функции может занимать 7 секунд.
// Поэтому для исключения зависаний пользовательского интерфейса, например при открытии формы,
// функцию следует вызвать в фоновом задании.
// При использовании веб-сервиса фирмы "1С" предоставляющего через Интернет сведения об
// адресах РФ в формате адресного классификатора, всегда возвращает Истина, если подключена интернет-поддержка пользователей.
//
// Возвращаемое значение:
// Булево - Истина, если адресный классификатор содержит сведения хотя бы по одному региону
// или подключен и доступен веб-сервис.
// Ложь, если адресные сведения отсутствуют, а веб-сервис недоступен.
//
Функция АдресныйКлассификаторЗагружен() Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.АдресныйКлассификаторЗагружен()
```
</details>
## РазрешенДоступВИнтернет
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает разрешение на доступ к веб-сервису адресов через сеть Интернет.
// Если доступ запрещен, то подбор и проверка адресов использует только загруженные данные в приложение.
// Изменение доступа выполняется в разделе Администрирование - Интернет-поддержка и сервисы.
//
// Возвращаемое значение:
// Булево - если Истина, то доступ к веб-сервису разрешен.
//
Функция РазрешенДоступВИнтернет() Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.РазрешенДоступВИнтернет()
```
</details>
## ПроверитьАдреса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет адреса на соответствие адресному классификатору
// и возвращает подходящие варианты, содержащие сведения об адресе.
// При проверке адреса через веб-сервиса выполнение функции может занимать 20 секунд.
// Поэтому для исключения зависаний пользовательского интерфейса, например при открытии формы,
// функцию следует вызвать в фоновом задании.
//
// Параметры:
// Адреса - Массив - проверяемые адреса. Содержит структуры с полями:
// * Адрес - проверяемый адрес во внутреннем формате JSON или в XML,
// соответствующем XDTO-пакету Адрес (HTTP://www.v8.1c.ru/ssl/contactinfo),
// или его XML-сериализация, соответствующая структуре XDTO-пакета.
//
// Возвращаемое значение:
// Массив - результаты анализа. Каждый элемент массива содержит структуры с полями:
// * Ошибки - Массив - описание ошибок поиска в классификаторе. Состоит из массива структур с полями:
// ** Ключ - Строка - служебный идентификатор места ошибки (путь XPath в объекте XDTO).
// ** Текст - Строка - текст ошибки.
// ** Подсказка - Строка - текст возможного исправления ошибки.
// * Варианты - Массив - устарело. Содержит описание найденных вариантов в виде массива структур с полями:
// ** Идентификатор - УникальныйИдентификатор - уникальный идентификационный код адресного объекта.
// ** Индекс - Число - почтовый индекс адресного объекта.
// ** КодКЛАДР - Число - код КЛАДР ближайшего объекта.
// ** OKATO - Число - код общероссийского классификатора объектов административно-территориального деления.
// ** ОКТМО - Число - код общероссийского классификатора территорий муниципальных образований.
// ** КодИФНСФЛ - Строка - код инспекции ФНС обслуживающей физических лиц.
// ** КодИФНСЮЛ - Строка - код инспекции ФНС обслуживающей юридические лица.
// ** КодУчасткаИФНСФЛ - Строка - код территориального участка инспекции ФНС обслуживающей физических лиц.
// ** КодУчасткаИФНСЮЛ - Строка - код территориального участка инспекции ФНС обслуживающей юридические лица.
//
// Пример:
// СтруктураПроверки = Новый Структура("Адрес", Адрес);
// РезультатыПроверки = АдресныйКлассификатор.ПроверитьАдреса(ОбщегоНазначенияКлиентСервер.ЗначениеВМассиве(СтруктураПроверки));
//
// Если РезультатыПроверки.Количество() > 0 И РезультатыПроверки.Варианты.Количество() > 0 Тогда
// КодКЛАДР = РезультатыПроверки.Варианты[0].КодКЛАДР;
// КонецЕсли;
//
Функция ПроверитьАдреса(Адреса) Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.ПроверитьАдреса(Адреса)
```
</details>
## ПолноеНаименованиеАдресногоСокращения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает полное наименование адресного объекта по его сокращению.
// Если уровень не указан, то возвращает первое найденное совпадение.
//
// Параметры:
// АдресноеСокращение - Строка - сокращение адресного объекта. Например, "г".
// Уровень - Число - код уровня адресного объекта. Например, для уровня города 4.
//
// Возвращаемое значение:
// Строка - полное наименование адресного объекта. Например, "город".
// Неопределено - если указанное сокращение не существует.
//
Функция ПолноеНаименованиеАдресногоСокращения(АдресноеСокращение, Уровень = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.ПолноеНаименованиеАдресногоСокращения(АдресноеСокращение, Уровень);
```
</details>
## КодыАдреса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает коды адрес (ОКТМО, ОКАТО, налоговых инспекций ФНС и др.) и
// уникальные идентификационные коды адресного объекта и дома.
// Кода не будут заполнены, если адрес не соответствует адресному классификатору или содержит адресные поля без идентификаторов.
// При получении кодов через веб-сервиса выполнение функции может занимать 20 секунд.
// Поэтому для исключения зависаний пользовательского интерфейса, например при открытии формы,
// функцию следует вызвать в фоновом задании.
// Если при попытке получения кодов через веб-сервис он оказывается недоступен или доступ к нему запрещен пользователем,
// то функция возвращает структуру с пустыми полями.
// Проверить, разрешен ли администратором доступ к веб-сервису адресов можно с помощью функции РазрешенДоступВИнтернет.
//
// Параметры:
// Адрес - Строка - адрес во внутреннем формате JSON или XML, соответствующий структуре XDTO-пакета Адрес.
// Источник - Строка - источник получения кодов адреса:
// "Сервис1С" - коды будут получены через веб-сервис "1С" предоставляющий сведения об адресах РФ в формате
// адресного классификатора;
// "ЗагруженныеДанные" - сначала будет попытка определить коды по загруженным данным адресного классификатора,
// а затем, если коды не были определены, то они будут получены через веб-сервис "1С".
// Если параметр не указан, то определение кодов будет аналогично параметру ЗагруженныеДанные.
// Возвращаемое значение:
// Структура - коды адреса. Если адрес не существует, то поля структуры содержат пустые значения:
// * Идентификатор - Строка - уникальный идентификационный код адресного объекта.
// * ИдентификаторДома - Строка - уникальный идентификационный код дома(здания) адресного объекта.
// * КодКЛАДР - Строка - код классификатор адресов России (КЛАДР).
// * КодИФНСФЛ - Строка - код инспекции ФНС, обслуживающей физических лиц.
// * КодИФНСЮЛ - Строка - код инспекции ФНС, обслуживающей юридические лица.
// * КодУчасткаИФНСФЛ - Строка - код территориального участка инспекции ФНС, обслуживающей физических лиц.
// * КодУчасткаИФНСЮЛ - Строка - код территориального участка инспекции ФНС, обслуживающей юридические лица.
// * OKATO - Строка - код общероссийского классификатора объектов административно-территориального деления.
// * ОКТМО - Строка - код общероссийского классификатора территорий муниципальных образований.
// * ОКТМОБюджетополучателя- Строка - код бюджетополучателя общероссийского классификатора
// территорий муниципальных образований.
//
Функция КодыАдреса(Адрес, Источник = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.КодыАдреса(Адрес, Источник);
```
</details>
## СокращенияАдресныхОбъектов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает соответствие полных наименований адресных объектов и их сокращения.
//
// Параметры:
// НаименованияАдресныхОбъектов - Массив из Строка - полные наименования адресных объектов.
// Если передан пустой массив, то будут возвращен полный список наименований и сокращений.
//
// Возвращаемое значение:
// Соответствие из КлючИЗначение:
// * Ключ - Строка - полное наименование адресного объекта.
// * Значение - Строка - сокращение адресного объекта.
//
Функция СокращенияАдресныхОбъектов(НаименованияАдресныхОбъектов) Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.СокращенияАдресныхОбъектов(НаименованияАдресныхОбъектов)
```
</details>
## СведенияПоОКМТО
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает сведения об адресе по коду ОКТМО, который состоит из 8 или 11 цифр.
//
// Параметры:
// ОКТМО - Соответствие - код общероссийского классификатора территорий муниципальных образований.
//
// Возвращаемое значение:
// Структура:
// * КодРегиона - Строка - код региона РФ.
// * Регион - Строка - текстовое представление региона РФ.
// * РегионТипПолный - Строка - полное наименование типа региона. Например: "область".
// * РегионТипКраткий - Строка - краткое наименование типа региона. Например: "обл".
// * ИдентификаторРегиона- УникальныйИдентификатор
// - Неопределено - идентификационный код региона.
// * МуниципальныйРайон - Строка - текстовое представление муниципального района для адреса по муниципальному делению.
// * МуниципальныйРайонТипПолный - Строка - полное наименование типа муниципального района по муниципальному
// делению. Например: "городской округ".
// * МуниципальныйРайонТипКраткий - Строка - краткое наименование типа муниципального района для адреса по
// муниципальному делению. Например: "мун.р-н".
// * ИдентификаторМуниципальногоРайона- УникальныйИдентификатор
// - Неопределено - идентификационный код муниципального район.
// * КодМуниципальногоРайона - Строка - код муниципального района: 1- муниципальный район; 2- городской округ;
// 3 - внутригородская территория города федерального значения; 4 - муниципальный округ.
// Если не удалось определить код, то возвращается пустая строка.
// * Поселение - Строка - текстовое представление поселения у адресов по муниципальному делению.
// * ПоселениеТипПолный - Строка - полное наименование типа сельского поселения по муниципальному делению.
// Например: "сельское поселение".
// * ПоселениеТипКраткий - Строка - краткое наименование типа муниципального района для адреса по муниципальному
// делению. Например: "с. п.".
// * ИдентификаторПоселения- УникальныйИдентификатор
// - Неопределено - идентификационный код поселения.
// * КодПоселения - Строка - код поселения: 1 - городское поселение; 2 - сельское поселение; 3- межселенная
// территория в составе муниципального района; 4 - внутригородской район городского округа;
// * НаселенныйПункт - Строка - текстовое представление населенного пункта.
// * НаселенныйПунктТипПолный - Строка - полное наименование типа населенного пункта. Например: "деревня".
// * НаселенныйПунктТипКраткий - Строка - краткое наименование типа населенного пункта. Например: "д".
// * ИдентификаторНаселенногоПункта- УникальныйИдентификатор
// - Неопределено - идентификационный код населенного пункта.
// * Территория - Строка - текстовое представление территории (элемент планировочной структуры).
// * ТерриторияТипПолный - Строка - полное наименование типа территории. Например: "Гаражно-строительный кооп.".
// * ТерриторияТипКраткий - Строка - краткое наименование типа территории. Например: "гск".
// * ИдентификаторТерритории- УникальныйИдентификатор
// - Неопределено - идентификационный код территории.
// * ПочтовыйИндекс - Число - почтовый индекс.
// * OKATO - Строка - код общероссийского классификатора объектов административно-территориального деления.
// * КодКЛАДР - Строка - код классификатор адресов России (КЛАДР).
// * КодИФНСФЛ - Строка - код инспекции ФНС, обслуживающей физических лиц.
// * КодИФНСЮЛ - Строка - код инспекции ФНС, обслуживающей юридические лица.
// * КодУчасткаИФНСФЛ - Строка - код территориального участка инспекции ФНС, обслуживающей физических лиц.
// * КодУчасткаИФНСЮЛ - Строка - код территориального участка инспекции ФНС, обслуживающей юридические лица.
//
Функция СведенияПоОКМТО(ОКТМО) Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.СведенияПоОКМТО(ОКТМО)
```
</details>
## ПроверитьОКТМОБюджетополучателя
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет корректность ОКМТО бюджетополучателей.
//
// Для проверки ОКТМО бюджетополучателей требуется подключение к Интернет-поддержке пользователей и наличие
// постоянного соединения с интернетом, т.к. адресные сведения, загруженные в приложение, не используются.
// Проверка выполняется порциям по 100 значений за один запросу к веб-сервису, поэтому рекомендуется выполнять
// ее в фоновом режиме.
// При получении ответа от веб-сервиса отличного от успешного (код 200 ОК) выполнение функции прерывается
// и возвращается ошибка. Поэтому если в данных результата отсутствует ОКТМО бюджетополучателя,
// то он не было проверен из-за ошибок работы с веб-сервисом.
//
// Параметры:
// ОКТМОБюджетополучателей - Массив из Строка - список ОКТМО бюджетополучателей.
// - Строка - ОКТМО бюджетополучателя.
//
// Возвращаемое значение:
// Структура:
// * Отказ - Булево - если Истина, то при получении ОКТМО бюджетополучателя через веб-сервис возникла ошибка.
// * ПредставлениеОшибкиДляПользователя - Строка - текст ошибки для отображения пользователю.
// * ИнформацияОбОшибке - ИнформацияОбОшибке - структурированная информация об ошибке.
// * Данные - Соответствие из КлючИЗначение:
// ** Ключ - Строка - ОКТМО бюджетополучателя.
// ** Значение - Структура:
// *** Успешно - Булево - если Истина, то код ОКТМО бюджетополучателей корректный;
// *** ТекстОшибки - Строка - текст ошибки, если ОКТМО некорректный;
// *** МуниципальныеОбразования - Массив из Строка - список муниципальных образований, принадлежащих данному ОКТМО.
//
Функция ПроверитьОКТМОБюджетополучателя(ОКТМОБюджетополучателей) Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.ПроверитьОКТМОБюджетополучателя(ОКТМОБюджетополучателей)
```
</details>
## ИдентификаторыАдреса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает идентификационный код дома и адресного объекта с помощью веб-сервиса фирмы 1С предоставляющего
// сведения об адресах РФ в формате адресного классификатора. Для получения идентификаторов требуется подключение
// к Интернет-поддержке пользователей и наличие постоянного соединения с интернетом,
// т.к. адресные сведения, загруженные в приложение, не используются.
//
// Параметры:
// Адрес - Строка - XML соответствующий структуре XDTO-пакета Адрес, содержащий адрес,
// для которого требуется определить идентификационные коды.
// Возвращаемое значение:
// Структура:
// * ИдентификаторАдресногоОбъекта - УникальныйИдентификатор - идентификационный код адресного объекта (улицы,
// нас. пункта).
// * ИдентификаторДома - УникальныйИдентификатор - идентификационный код дома адресного объекта.
// * Отказ - Булево - если Истина, то при работе с веб-сервисом возникла ошибка.
// * ПодробноеПредставлениеОшибки - Строка - полное описание ошибки, если при работе с веб-сервисом возникла
// ошибка, иначе Неопределено.
// * КраткоеПредставлениеОшибки - Строка - краткое описание ошибки, если при работе с веб-сервисом возникла
// ошибка, иначе Неопределено.
//
Функция ИдентификаторыАдреса(Адрес) Экспорт
```
Пример вызова
```bsl
Результат = АдресныйКлассификатор.ИдентификаторыАдреса(Адрес)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

64
src/content/docs/bsp/АдресныйКлассификаторКлиент.md Normal file
View File

@ -0,0 +1,64 @@
---
title: Адресный классификатор клиент
slug: bsp/адресный-классификатор-клиент
---
## ЗагрузитьАдресныйКлассификатор
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму загрузки классификатора.
//
// Параметры:
// Параметры - ПараметрыВыполненияКоманды
// - Структура - параметры открытия формы.
//
Процедура ЗагрузитьАдресныйКлассификатор(Параметры = Неопределено) Экспорт
```
Пример вызова
```bsl
АдресныйКлассификаторКлиент.ЗагрузитьАдресныйКлассификатор(Параметры);
```
</details>
## ПоказатьФормуЗагрузкиАдресногоКлассификатора
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму загрузки адресного классификатора.
//
// Параметры:
// ОповещениеОЗакрытие - ОписаниеОповещения - оповещение, которое вызывается при закрытии формы загрузки адресного классификатора.
// ПараметрыФормы - Структура - параметры открытия формы:
// * КодРегионаДляЗагрузки - Число
// - Массив - если указан, то регион будет отмечен для загрузки.
// ПараметрыОткрытия - Структура - параметры открытия формы:
// * Владелец - Произвольный - форма или элемент управления другой формы.
// * Уникальность - Произвольный - ключ, значение которого будет использоваться для поиска уже открытых форм.
// * Окно - ОкноКлиентскогоПриложения - окно приложения, в котором будет открыта форма.
// * НавигационнаяСсылка - Строка - задает навигационную ссылку, возвращаемую формой.
//
Процедура ПоказатьФормуЗагрузкиАдресногоКлассификатора(ОповещениеОЗакрытие = Неопределено, ПараметрыФормы = Неопределено, ПараметрыОткрытия = Неопределено) Экспорт
```
Пример вызова
```bsl
АдресныйКлассификаторКлиент.ПоказатьФормуЗагрузкиАдресногоКлассификатора(ОповещениеОЗакрытие, ПараметрыФормы, ПараметрыОткрытия);
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

29
src/content/docs/bsp/АнализСхемКонфигурации.md Normal file
View File

@ -0,0 +1,29 @@
---
title: Анализ схем конфигурации
slug: bsp/анализ-схем-конфигурации
---
## ОписанияРазличийСхемКонфигураций
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
Функция ОписанияРазличийСхемКонфигураций(ДанныеСхемыКонфигурацииИсточника, ДанныеСхемыКонфигурацииПриемника) Экспорт
```
Пример вызова
```bsl
Результат = АнализСхемКонфигурации.ОписанияРазличийСхемКонфигураций(ДанныеСхемыКонфигурацииИсточника, ДанныеСхемыКонфигурацииПриемника)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

135
src/content/docs/bsp/АсинхронноеПолучениеДанных.md Normal file
View File

@ -0,0 +1,135 @@
---
title: Асинхронное получение данных
slug: bsp/асинхронное-получение-данных
---
## ИдентификаторХранилища
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает идентификатор хранилища в виде строки.
// @skip-check module-empty-method - особенность реализации.
// @skip-warning - обратная совместимость.
//
// Возвращаемое значение:
// Строка - идентификатор хранилища.
//
Функция ИдентификаторХранилища() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанных.ИдентификаторХранилища()
```
</details>
## НовыйОписаниеВозвращаемыхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает новую структуру описания возвращаемых данных.
// @skip-check module-empty-method - особенность реализации.
// @skip-warning - обратная совместимость.
//
// Возвращаемое значение:
// Структура:
// * МодульМенеджер - ОбщийМодуль, СправочникиМенеджер, ОтчетыМенеджер - модуль менеджера получения данных.
// * Наименование - Строка - наименование возвращаемых данных.
// * Описание - Строка - подробное описание возвращаемых данных.
// * ТипыРезультата - Массив из Строка - типы возвращаемых данных.
//
Функция НовыйОписаниеВозвращаемыхДанных() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанных.НовыйОписаниеВозвращаемыхДанных()
```
</details>
## ДоступныеВозвращаемыеДанные
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает перечень доступных данных
// @skip-check module-empty-method - особенность реализации.
// @skip-warning - обратная совместимость.
//
// Возвращаемое значение:
// Соответствие из КлючИЗначение - перечень доступных возвращаемых данных:
// * Ключ - Строка - идентификатор данных.
// * Значение - см. АсинхронноеПолучениеДанных.НовыйОписаниеВозвращаемыхДанных
//
Функция ДоступныеВозвращаемыеДанные() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанных.ДоступныеВозвращаемыеДанные()
```
</details>
## ПриОпределенииПсевдонимовОбработчиков
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков.
// @skip-check module-empty-method - особенность реализации.
// @skip-warning - обратная совместимость.
//
// Параметры:
// СоответствиеИменПсевдонимам - см. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков.СоответствиеИменПсевдонимам
//
Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт
```
Пример вызова
```bsl
АсинхронноеПолучениеДанных.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам)
```
</details>
## ПодготовитьДанные
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Формирует данные для ответа по полученным параметрам.
// @skip-check module-empty-method - особенность реализации.
// @skip-warning - обратная совместимость.
//
// Параметры:
// ИдентификаторДанных - Строка - идентификатор данных, которые нужно получить.
// ИдентификаторПараметров - УникальныйИдентификатор - идентификатор файла параметров получения данных.
//
Процедура ПодготовитьДанные(ИдентификаторДанных, ИдентификаторПараметров) Экспорт
```
Пример вызова
```bsl
АсинхронноеПолучениеДанных.ПодготовитьДанные(ИдентификаторДанных, ИдентификаторПараметров)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

65
src/content/docs/bsp/АсинхронноеПолучениеДанныхПереопределяемый.md Normal file
View File

@ -0,0 +1,65 @@
---
title: Асинхронное получение данных переопределяемый
slug: bsp/асинхронное-получение-данных-переопределяемый
---
## УстановитьДоступныеВозвращаемыеДанные
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при формировании списка доступных возвращаемых данных и при получении данных.
// Определяет список возвращаемых данных, подключенных к подсистеме.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// ДоступныеВозвращаемыеДанные - Соответствие из КлючИЗначение - заполняемые доступные возвращаемые данные:
// * Ключ - Строка - идентификатор данных.
// * Значение - см. АсинхронноеПолучениеДанных.НовыйОписаниеВозвращаемыхДанных
//
Процедура УстановитьДоступныеВозвращаемыеДанные(ДоступныеВозвращаемыеДанные) Экспорт
```
Пример вызова
```bsl
АсинхронноеПолучениеДанныхПереопределяемый.УстановитьДоступныеВозвращаемыеДанные(ДоступныеВозвращаемыеДанные)
```
</details>
## АвторизоватьЗапрос
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при первичной обработке входящего запроса. Позволяет выполнить прикладную логику,
// связанную с валидацией входящего запроса и при необходимости отказать в обработке запроса.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// ИдентификаторДанных - Строка - идентификатор данных. Может быть переопределено при обработке.
// Указывается в качестве имени файла, возвращаемом в результате.
// Параметры - ДвоичныеДанные - переданные параметры получения данных.
// Отказ - Булево - Возвращаемый параметр. Признак отказа в авторизации. При отказе в авторизации устанавливать в Отказ = Истина.
// СообщениеОбОшибке - Строка - Возвращаемый параметр. Текст сообщения об ошибке при отказе в авторизации.
//
Процедура АвторизоватьЗапрос(ИдентификаторДанных, Параметры, Отказ, СообщениеОбОшибке) Экспорт
```
Пример вызова
```bsl
АсинхронноеПолучениеДанныхПереопределяемый.АвторизоватьЗапрос(ИдентификаторДанных, Параметры, Отказ, СообщениеОбОшибке)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

233
src/content/docs/bsp/АсинхронноеПолучениеДанныхСловарь.md Normal file
View File

@ -0,0 +1,233 @@
---
title: Асинхронное получение данных словарь
slug: bsp/асинхронное-получение-данных-словарь
---
## КодВозвратаОшибкаДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код ошибки данных.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаОшибкаДанных() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаОшибкаДанных()
```
</details>
## КодВозвратаОтказАвторизации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код отказа авторизации.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаОтказАвторизации() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаОтказАвторизации()
```
</details>
## КодВозвратаВнутренняяОшибка
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код внутренней ошибки.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаВнутренняяОшибка() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаВнутренняяОшибка()
```
</details>
## КодВозвратаВыполненоСПредупреждениями
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код выполнения с предупреждениями.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаВыполненоСПредупреждениями() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаВыполненоСПредупреждениями()
```
</details>
## КодВозвратаВыполнено
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код успешного выполнения.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаВыполнено() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаВыполнено()
```
</details>
## КодСостоянияОжидание
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код ожидания данных.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодСостоянияОжидание() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанныхСловарь.КодСостоянияОжидание()
```
</details>
## КодВозвратаНеНайдено
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код отсутствия данных.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаНеНайдено() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаНеНайдено()
```
</details>
## ТипJSON
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает строку с типом файла JSON
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Строка - "json"
//
Функция ТипJSON() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанныхСловарь.ТипJSON()
```
</details>
## ТипXLSX
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает строку с типом файла XLSX
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Строка - "xlsx"
//
Функция ТипXLSX() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанныхСловарь.ТипXLSX()
```
</details>
## ТипPDF
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает строку с типом файла PDF
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Строка - "PDF"
//
Функция ТипPDF() Экспорт
```
Пример вызова
```bsl
Результат = АсинхронноеПолучениеДанныхСловарь.ТипPDF()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

38
src/content/docs/bsp/БТС.md Normal file
View File

@ -0,0 +1,38 @@
---
title: БТС
slug: bsp/бтс
---
## ЗафиксироватьСобытиеСтатистикиРасширения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет фиксацию события работы расширения, в группе событий "Пользовательское"
// @skip-warning ПустойМетод - особенность реализации.
//
// Параметры:
// ИдентификаторСобытия - Строка - идентификатор события полученный в личном кабинете Менеджера сервиса (длина 36).
//
// Пример:
// БТС.ЗафиксироватьСобытиеСтатистикиРасширения("2f1df77a-9f07-11e9-9d8c-0242ac1d0004")
//
Процедура ЗафиксироватьСобытиеСтатистикиРасширения(Знач ИдентификаторСобытия) Экспорт
```
Пример вызова
```bsl
БТС.ЗафиксироватьСобытиеСтатистикиРасширения(ИдентификаторСобытия)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

38
src/content/docs/bsp/БТСКлиент.md Normal file
View File

@ -0,0 +1,38 @@
---
title: БТС клиент
slug: bsp/бтс-клиент
---
## ЗафиксироватьСобытиеСтатистикиРасширения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет фиксацию события работы расширения, в группе событий "Пользовательское"
// @skip-warning ПустойМетод - особенность реализации.
//
// Параметры:
// ИдентификаторСобытия - Строка - идентификатор события полученный в личном кабинете Менеджера сервиса (длина 36).
//
// Пример:
// БТСКлиент.ЗафиксироватьСобытиеСтатистикиРасширения("2f1df77a-9f07-11e9-9d8c-0242ac1d0004")
//
Процедура ЗафиксироватьСобытиеСтатистикиРасширения(Знач ИдентификаторСобытия) Экспорт
```
Пример вызова
```bsl
БТСКлиент.ЗафиксироватьСобытиеСтатистикиРасширения(ИдентификаторСобытия)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

143
src/content/docs/bsp/БизнесПроцессыИЗадачиВызовСервера.md Normal file
View File

@ -0,0 +1,143 @@
---
title: Бизнес процессы и задачи вызов сервера
slug: bsp/бизнес-процессы-и-задачи-вызов-сервера
---
## ФормаВыполненияЗадачи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать БизнесПроцессыИЗадачиСервер.ФормаВыполненияЗадачи.
// Получить структуру с описанием формы выполнения задачи.
//
// Параметры:
// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя
//
// Возвращаемое значение:
// см. БизнесПроцессыИЗадачиПереопределяемый.ПриПолученииФормыВыполненияЗадачи.ПараметрыФормы
//
Функция ФормаВыполненияЗадачи(Знач ЗадачаСсылка) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиВызовСервера.ФормаВыполненияЗадачи(ЗадачаСсылка)
```
</details>
## ЭтоЗадачаИсполнителю
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать БизнесПроцессыИЗадачиСервер.ЭтоЗадачаИсполнителю.
// Проверяет, находится ли в ячейке отчета ссылка на задачу и в параметре
// ЗначениеРасшифровки возвращает значение расшифровки.
//
// Параметры:
// Расшифровка - Строка - имя ячейки.
// ДанныеРасшифровкиОтчета - Строка - адрес во временном хранилище.
// ЗначениеРасшифровки - ЗадачаСсылка.ЗадачаИсполнителя
// - Произвольный - значение расшифровки из ячейки.
//
// Возвращаемое значение:
// Булево - Истина, если это задача исполнителю.
//
Функция ЭтоЗадачаИсполнителю(Знач Расшифровка, Знач ДанныеРасшифровкиОтчета, ЗначениеРасшифровки) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиВызовСервера.ЭтоЗадачаИсполнителю(Расшифровка, ДанныеРасшифровкиОтчета, ЗначениеРасшифровки)
```
</details>
## ВыполнитьЗадачу
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать БизнесПроцессыИЗадачиСервер.ВыполнитьЗадачу.
// Выполнить задачу ЗадачаСсылка, при необходимости выполнив обработчик.
// ОбработкаВыполненияПоУмолчанию модуля менеджера бизнес-процесса,
// к которому относится задача ЗадачаСсылка.
//
// Параметры:
// ЗадачаСсылка - ЗадачаСсылка
// ДействиеПоУмолчанию - Булево - признак необходимости вызова процедуры
// ОбработкаВыполненияПоУмолчанию у бизнес-процесса задачи.
//
Процедура ВыполнитьЗадачу(ЗадачаСсылка, ДействиеПоУмолчанию = Ложь) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиВызовСервера.ВыполнитьЗадачу(ЗадачаСсылка, ДействиеПоУмолчанию);
```
</details>
## ЭтоВедущаяЗадача
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать БизнесПроцессыИЗадачиСервер.ЭтоВедущаяЗадача.
// Проверяет, является ли указанная задача ведущей.
//
// Параметры:
// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя
//
// Возвращаемое значение:
// Булево
//
Функция ЭтоВедущаяЗадача(Знач ЗадачаСсылка) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиВызовСервера.ЭтоВедущаяЗадача(ЗадачаСсылка)
```
</details>
## СформироватьДанныеВыбораИсполнителя
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать БизнесПроцессыИЗадачиСервер.СформироватьДанныеВыбораИсполнителя.
// Формирует список подбора для указания исполнителя в полях ввода составного типа (Пользователь и Роль).
//
// Параметры:
// Текст - Строка - фрагмент текста для поиска возможных исполнителей.
//
// Возвращаемое значение:
// СписокЗначений - список подбора, содержащий возможных исполнителей.
//
Функция СформироватьДанныеВыбораИсполнителя(Знач Текст) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиВызовСервера.СформироватьДанныеВыбораИсполнителя(Текст)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

464
src/content/docs/bsp/БизнесПроцессыИЗадачиКлиент.md Normal file
View File

@ -0,0 +1,464 @@
---
title: Бизнес процессы и задачи клиент
slug: bsp/бизнес-процессы-и-задачи-клиент
---
## Остановить
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанные бизнес-процессы как остановленные.
//
// Параметры:
// ПараметрКоманды - Массив из ОпределяемыйТип.БизнесПроцесс
// - ОпределяемыйТип.БизнесПроцесс
//
Процедура Остановить(Знач ПараметрКоманды) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.Остановить(ПараметрКоманды)
```
</details>
## ОстановитьБизнесПроцессИзФормыОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанный бизнес-процесс как остановленный.
// Предназначена для вызова из формы бизнес-процесса.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения
// - РасширениеУправляемойФормыДляОбъектов - форма бизнес-процесса, где:
// * Объект - ОпределяемыйТип.БизнесПроцессОбъект - бизнес-процесс.
//
Процедура ОстановитьБизнесПроцессИзФормыОбъекта(Форма) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ОстановитьБизнесПроцессИзФормыОбъекта(Форма)
```
</details>
## СделатьАктивным
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанные бизнес-процессы как активные.
//
// Параметры:
// ПараметрКоманды - Массив из ОпределяемыйТип.БизнесПроцесс
// - СтрокаГруппировкиДинамическогоСписка
// - ОпределяемыйТип.БизнесПроцесс - бизнес процесс.
//
Процедура СделатьАктивным(Знач ПараметрКоманды) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.СделатьАктивным(ПараметрКоманды)
```
</details>
## ПродолжитьБизнесПроцессИзФормыОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанный бизнес-процесс как активный.
// Предназначена для вызова из формы бизнес-процесса.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения
// - РасширениеУправляемойФормыДляОбъектов - форма бизнес-процесса, где:
// * Объект - ОпределяемыйТип.БизнесПроцессОбъект - бизнес-процесс.
//
Процедура ПродолжитьБизнесПроцессИзФормыОбъекта(Форма) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ПродолжитьБизнесПроцессИзФормыОбъекта(Форма)
```
</details>
## ПринятьЗадачиКИсполнению
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанные задачи как принятые к исполнению.
//
// Параметры:
// МассивЗадач - Массив из ЗадачаСсылка.ЗадачаИсполнителя
//
Процедура ПринятьЗадачиКИсполнению(Знач МассивЗадач) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ПринятьЗадачиКИсполнению(МассивЗадач)
```
</details>
## ПринятьЗадачуКИсполнению
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанную задачу как принятую к исполнению.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения
// - РасширениеУправляемойФормыДляОбъектов - форма задачи, где:
// * Объект - ЗадачаОбъект - задача.
// ТекущийПользователь - СправочникСсылка.ВнешниеПользователи
// - СправочникСсылка.Пользователи - ссылка на текущего
// пользователя приложения.
//
Процедура ПринятьЗадачуКИсполнению(Форма, ТекущийПользователь) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ПринятьЗадачуКИсполнению(Форма, ТекущийПользователь)
```
</details>
## ОтменитьПринятиеЗадачКИсполнению
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанные задачи как не принятые к исполнению.
//
// Параметры:
// МассивЗадач - Массив из ЗадачаСсылка.ЗадачаИсполнителя
//
Процедура ОтменитьПринятиеЗадачКИсполнению(Знач МассивЗадач) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ОтменитьПринятиеЗадачКИсполнению(МассивЗадач)
```
</details>
## ОтменитьПринятиеЗадачиКИсполнению
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанную задачу как не принятую к исполнению.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения
// - РасширениеУправляемойФормыДляОбъектов - форма задачи, где:
// * Объект - ЗадачаОбъект - задача.
//
Процедура ОтменитьПринятиеЗадачиКИсполнению(Форма) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ОтменитьПринятиеЗадачиКИсполнению(Форма)
```
</details>
## ОбновитьДоступностьКомандПринятияКИсполнению
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устанавливает доступность команд принятия к исполнению.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма задачи, где:
// * Элементы - ВсеЭлементыФормы - элементы формы. Содержит:
// ** ФормаПринятьКИсполнению - ПолеВвода - кнопка команды на форме.
// ** ФормаОтменитьПринятиеКИсполнению - ПолеВвода - кнопка команды на форме.
//
Процедура ОбновитьДоступностьКомандПринятияКИсполнению(Форма) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ОбновитьДоступностьКомандПринятияКИсполнению(Форма)
```
</details>
## НастроитьОтложенныйСтарт
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму для настройки отложенного старта бизнес процесса.
//
// Параметры:
// БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс
// СрокИсполнения - Дата
//
Процедура НастроитьОтложенныйСтарт(БизнесПроцесс, СрокИсполнения) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.НастроитьОтложенныйСтарт(БизнесПроцесс, СрокИсполнения)
```
</details>
## ФормаЗадачиОбработкаОповещения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Стандартный обработчик оповещения для форм выполнения задач.
// Для вызова из обработчика события формы ОбработкаОповещения.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма выполнения задачи, где:
// * Объект - ЗадачаОбъект - задача объекта.
// ИмяСобытия - Строка - имя события.
// Параметр - Произвольный - параметр события.
// Источник - Произвольный - источник события.
//
Процедура ФормаЗадачиОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ФормаЗадачиОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник)
```
</details>
## СписокЗадачПередНачаломДобавления
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Стандартный обработчик ПередНачаломДобавления для списков задач.
// Для вызова из обработчика события таблицы формы ПередНачаломДобавления.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма задачи.
// Элемент - ТаблицаФормы - элементы таблицы формы.
// Отказ - Булево - признак отказа от добавления объекта. Если в теле процедуры-обработчика установить данному
// параметру значение Истина, то добавление объекта выполнено не будет.
// Копирование - Булево - определяет режим копирования. Если установлено Истина, то происходит копирование строки.
// Родитель - Неопределено
// - СправочникСсылка
// - ПланСчетовСсылка - ссылка на элемент, который будет использован при
// добавлении в качестве родителя.
// Группа - Булево - признак добавления группы. Истина - будет добавлена группа.
//
Процедура СписокЗадачПередНачаломДобавления(Форма, Элемент, Отказ, Копирование, Родитель, Группа) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.СписокЗадачПередНачаломДобавления(Форма, Элемент, Отказ, Копирование, Родитель, Группа)
```
</details>
## ЗаписатьИЗакрытьВыполнить
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Записать и закрыть форму выполнения задачи.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма выполнения задачи, где:
// * Объект - ЗадачаОбъект - задача бизнес-процесса.
// ВыполнитьЗадачу - Булево - задача записывается в режиме выполнения.
// ПараметрыОповещения - Структура - дополнительные параметры оповещения.
//
// Возвращаемое значение:
// Булево - Истина, если запись прошла успешно.
//
Функция ЗаписатьИЗакрытьВыполнить(Форма, ВыполнитьЗадачу = Ложь, ПараметрыОповещения = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиКлиент.ЗаписатьИЗакрытьВыполнить(Форма, ВыполнитьЗадачу, ПараметрыОповещения);
```
</details>
## СоздатьЗадание
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открыть форму для ввода нового задания.
//
// Параметры:
// ФормаВладелец - ФормаКлиентскогоПриложения - форма, которая должна быть владельцем для открываемой.
// ПараметрыФормы - Структура - параметры открываемой формы.
//
Процедура СоздатьЗадание(Знач ФормаВладелец = Неопределено, Знач ПараметрыФормы = Неопределено) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.СоздатьЗадание(ФормаВладелец, ПараметрыФормы);
```
</details>
## ПеренаправитьЗадачи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открыть форму для перенаправления одной или нескольких задач другому исполнителю.
//
// Параметры:
// ПеренаправляемыеЗадачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя
// ФормаВладелец - ФормаКлиентскогоПриложения - форма, которая должна быть владельцем для открываемой
// формы перенаправления задач.
//
Процедура ПеренаправитьЗадачи(ПеренаправляемыеЗадачи, ФормаВладелец) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ПеренаправитьЗадачи(ПеренаправляемыеЗадачи, ФормаВладелец)
```
</details>
## ОткрытьДопИнформациюОЗадаче
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открыть форму с дополнительной информацией о задаче.
//
// Параметры:
// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя
//
Процедура ОткрытьДопИнформациюОЗадаче(Знач ЗадачаСсылка) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ОткрытьДопИнформациюОЗадаче(ЗадачаСсылка)
```
</details>
## ОткрытьСписокРолейИИсполнителейЗадач
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает список ролей и исполнителей задач.
//
Процедура ОткрытьСписокРолейИИсполнителейЗадач() Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ОткрытьСписокРолейИИсполнителейЗадач()
```
</details>
## ОткрытьФормуВыбораРолиИсполнителя
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму выбора роли исполнителя.
//
// Параметры:
// ПараметрыФормы - см. ПараметрыФормыВыбораРолиИсполнителя
// Владелец - Неопределено
// - ФормаКлиентскогоПриложения - форма из которой открывается форма выбора роли исполнителя.
//
Процедура ОткрытьФормуВыбораРолиИсполнителя(ПараметрыФормы, Владелец) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиент.ОткрытьФормуВыбораРолиИсполнителя(ПараметрыФормы, Владелец)
```
</details>
## ПараметрыФормыВыбораРолиИсполнителя
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры открытия формы выбора роли исполнителя.
//
// Параметры:
// РольИсполнителя - СправочникСсылка.РолиИсполнителей - роль для ролевой адресации задачи участникам бизнес-процессов.
// ОсновнойОбъектАдресации - Произвольный - основной объект адресации для направления задачи.
// ДополнительныйОбъектАдресации - Произвольный - дополнительный объект адресации для направления задачи
//
// Возвращаемое значение:
// Структура:
// * РольИсполнителя - СправочникСсылка.РолиИсполнителей - роль для ролевой адресации задачи участникам бизнес-процессов.
// * ОсновнойОбъектАдресации - Произвольный - основной объект адресации для направления задачи
// * ДополнительныйОбъектАдресации - Произвольный - дополнительный объект адресации для направления задачи
// * ВыборОбъектаАдресации - Булево - если Истина, то в списке будет выбран основной объект адресации.
//
Функция ПараметрыФормыВыбораРолиИсполнителя(РольИсполнителя, ОсновнойОбъектАдресации = Неопределено, Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиКлиент.ПараметрыФормыВыбораРолиИсполнителя(РольИсполнителя, ОсновнойОбъектАдресации, );
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

42
src/content/docs/bsp/БизнесПроцессыИЗадачиКлиентПереопределяемый.md Normal file
View File

@ -0,0 +1,42 @@
---
title: Бизнес процессы и задачи клиент переопределяемый
slug: bsp/бизнес-процессы-и-задачи-клиент-переопределяемый
---
## ПриВыбореИсполнителя
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при открытии формы выбор исполнителя.
// Позволяет переопределить стандартную форму выбора.
//
// Параметры:
// ЭлементИсполнитель - ПолеФормы - элемент формы, в которой выбирается исполнитель.
// РеквизитИсполнитель - СправочникСсылка.Пользователи - выбранный ранее исполнитель.
// Используется для установки текущей строки в форме выбора исполнителя.
// ТолькоПростыеРоли - Булево - если Истина, то указывает что для выбора нужно
// использовать только роли без объектов адресации.
// БезВнешнихРолей - Булево - если Истина, то указывает, что для выбора надо использовать только роли,
// у которых не установлен признак ВнешняяРоль.
// СтандартнаяОбработка - Булево - если Ложь, то не требуется выводить стандартную форму выбора исполнителя.
//
Процедура ПриВыбореИсполнителя(ЭлементИсполнитель, РеквизитИсполнитель, ТолькоПростыеРоли, Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиентПереопределяемый.ПриВыбореИсполнителя(ЭлементИсполнитель, РеквизитИсполнитель, ТолькоПростыеРоли, );
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

67
src/content/docs/bsp/БизнесПроцессыИЗадачиКлиентСервер.md Normal file
View File

@ -0,0 +1,67 @@
---
title: Бизнес процессы и задачи клиент сервер
slug: bsp/бизнес-процессы-и-задачи-клиент-сервер
---
## ОбработкаПолученияПолейПредставленияБизнесПроцесса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
////////////////////////////////////////////////////////////////////////////////
// Обработчики подписок на события.
// Добавление полей, на основании которых будет формироваться представление бизнес-процесса.
//
// Параметры:
// МенеджерОбъекта - БизнесПроцессМенеджер - менеджер бизнес процесса.
// Поля - Массив - поля, из которых формируется представление бизнес-процесса.
// СтандартнаяОбработка - Булево - если установить Ложь, то стандартная обработка заполнения не будет
// выполнена.
//
Процедура ОбработкаПолученияПолейПредставленияБизнесПроцесса(МенеджерОбъекта, Поля, СтандартнаяОбработка) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиентСервер.ОбработкаПолученияПолейПредставленияБизнесПроцесса(МенеджерОбъекта, Поля, СтандартнаяОбработка)
```
</details>
## ОбработкаПолученияПредставленияБизнесПроцесса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// АПК:547-выкл Вызывается в подписке на событие ПолучитьПредставлениеБизнесПроцесса
// Обработка получения представления бизнес-процесса на основании полей данных.
//
// Параметры:
// МенеджерОбъекта - БизнесПроцессМенеджер - менеджер бизнес процесса.
// Данные - Структура - поля, из которых формируется представление бизнес процесса:
// Представление - Строка - представление бизнес процесса.
// СтандартнаяОбработка - Булево - если установить Ложь, то стандартная обработка заполнения не будет
// выполнена.
//
Процедура ОбработкаПолученияПредставленияБизнесПроцесса(МенеджерОбъекта, Данные, Представление, СтандартнаяОбработка) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиКлиентСервер.ОбработкаПолученияПредставленияБизнесПроцесса(МенеджерОбъекта, Данные, Представление, СтандартнаяОбработка)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

280
src/content/docs/bsp/БизнесПроцессыИЗадачиПереопределяемый.md Normal file
View File

@ -0,0 +1,280 @@
---
title: Бизнес процессы и задачи переопределяемый
slug: bsp/бизнес-процессы-и-задачи-переопределяемый
---
## ПриЗаписиСпискаБизнесПроцессов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается для обновления данных бизнес-процесса в регистре сведений ДанныеБизнесПроцессов.
//
// Параметры:
// Запись - РегистрСведенийЗапись.ДанныеБизнесПроцессов - запись данных бизнес-процесса.
//
Процедура ПриЗаписиСпискаБизнесПроцессов(Запись) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиПереопределяемый.ПриЗаписиСпискаБизнесПроцессов(Запись)
```
</details>
## ПриПроверкеПравНаОстановкуБизнесПроцесса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается для проверки прав на остановку и продолжение бизнес-процесса
// у текущего пользователя.
//
// Параметры:
// БизнесПроцесс - ОпределяемыйТип.БизнесПроцессОбъект
// ЕстьПрава - Булево - если установить Ложь, то прав нет.
// СтандартнаяОбработка - Булево - если установить Ложь, то стандартная проверка прав не будет выполнена.
//
Процедура ПриПроверкеПравНаОстановкуБизнесПроцесса(БизнесПроцесс, ЕстьПрава, СтандартнаяОбработка) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиПереопределяемый.ПриПроверкеПравНаОстановкуБизнесПроцесса(БизнесПроцесс, ЕстьПрава, СтандартнаяОбработка)
```
</details>
## ПриЗаполненииГлавнойЗадачиБизнесПроцесса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается для заполнения реквизита ГлавнаяЗадача из данных заполнения.
//
// Параметры:
// БизнесПроцессОбъект - ОпределяемыйТип.БизнесПроцессОбъект
// ДанныеЗаполнения - Произвольный - данные заполнения, которые передаются в обработчик заполнения.
// СтандартнаяОбработка - Булево - если установить Ложь, то стандартная обработка заполнения не будет
// выполнена.
//
Процедура ПриЗаполненииГлавнойЗадачиБизнесПроцесса(БизнесПроцессОбъект, ДанныеЗаполнения, СтандартнаяОбработка) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиПереопределяемый.ПриЗаполненииГлавнойЗадачиБизнесПроцесса(БизнесПроцессОбъект, ДанныеЗаполнения, СтандартнаяОбработка)
```
</details>
## ПриПолученииФормыВыполненияЗадачи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается для заполнения параметров формы задачи.
//
// Параметры:
// ИмяБизнесПроцесса - Строка - название бизнес-процесса.
// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя
// ТочкаМаршрутаБизнесПроцесса - ТочкаМаршрутаБизнесПроцессаСсылка.Задание - действие.
// ПараметрыФормы - Структура:
// * ИмяФормы - имя формы, передаваемое в метод ОткрытьФорму.
// * ПараметрыФормы - содержит параметры открываемой формы.
//
// Пример:
// Если ИмяБизнесПроцесса = "Задание" Тогда
// ИмяФормы = "БизнесПроцесс.Задание.Форма.ВнешнееДействие" + ТочкаМаршрутаБизнесПроцесса.Имя;
// ПараметрыФормы.Вставить("ИмяФормы", ИмяФормы);
// КонецЕсли;
//
Процедура ПриПолученииФормыВыполненияЗадачи(ИмяБизнесПроцесса, ЗадачаСсылка, Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиПереопределяемый.ПриПолученииФормыВыполненияЗадачи(ИмяБизнесПроцесса, ЗадачаСсылка, );
```
</details>
## ПриОпределенииБизнесПроцессов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполняет список бизнес-процессов, которые подключены к подсистеме
// и модули менеджеров которых содержат следующие экспортные процедуры и функции:
// - ПриПеренаправленииЗадачи.
// - ФормаВыполненияЗадачи.
// - ОбработкаВыполненияПоУмолчанию.
//
// Параметры:
// ПодключенныеБизнесПроцессы - Соответствие из КлючИЗначение:
// * Ключ - Строка - полное имя объекта метаданных, подключенного к подсистеме;
// * Значение - Строка - пустая строка.
//
// Пример:
// ПодключенныеБизнесПроцессы.Вставить(Метаданные.БизнесПроцессы.ЗаданиеСРолевойАдресацией.ПолноеИмя(), "");
//
Процедура ПриОпределенииБизнесПроцессов(ПодключенныеБизнесПроцессы) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиПереопределяемый.ПриОпределенииБизнесПроцессов(ПодключенныеБизнесПроцессы)
```
</details>
## ПриЗаполненииНаборовЗначенийДоступа
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается из модулей объектов подсистемы БизнесПроцессыИЗадачи для
// возможности настройки логики ограничения в прикладном решении.
//
// Пример заполнения наборов значений доступа см. в комментарии
// к процедуре УправлениеДоступом.ЗаполнитьНаборыЗначенийДоступа.
//
// Параметры:
// Объект - БизнесПроцессОбъект.Задание - объект, для которого нужно заполнить наборы.
// Таблица - см. УправлениеДоступом.ТаблицаНаборыЗначенийДоступа
//
Процедура ПриЗаполненииНаборовЗначенийДоступа(Объект, Таблица) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиПереопределяемый.ПриЗаполненииНаборовЗначенийДоступа(Объект, Таблица)
```
</details>
## ПриНачальномЗаполненииРолейИсполнителей
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается из модуля менеджера справочника РолиИсполнителей при начальном заполнении
// ролей исполнителей в прикладном решении.
//
// Параметры:
// КодыЯзыков - Массив из Строка - список языков конфигурации. Актуально для мультиязычных конфигураций.
// Элементы - ТаблицаЗначений - данные заполнения. Состав колонок соответствует набору реквизитов
// справочника РолиИсполнителей.
// ТабличныеЧасти - Структура - описание табличных частей объекта, где:
// * Ключ - Строка - имя табличной части;
// * Значение - ТаблицаЗначений - табличная часть в виде таблицы значений, структуру которой
// необходимо скопировать перед заполнением. Например:
// Элемент.Ключи = ТабличныеЧасти.Ключи.Скопировать();
// ЭлементТЧ = Элемент.Ключи.Добавить();
// ЭлементТЧ.ИмяКлюча = "Первичный";
//
Процедура ПриНачальномЗаполненииРолейИсполнителей(КодыЯзыков, Элементы, ТабличныеЧасти) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиПереопределяемый.ПриНачальномЗаполненииРолейИсполнителей(КодыЯзыков, Элементы, ТабличныеЧасти)
```
</details>
## ПриНачальномЗаполненииРолиИсполнителя
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается из модуля менеджера справочника РолиИсполнителей при начальном заполнении
// элемента роль исполнителя в прикладном решении.
//
// Параметры:
// Объект - СправочникОбъект.РолиИсполнителей - заполняемый объект.
// Данные - СтрокаТаблицыЗначений - данные заполнения.
// ДополнительныеПараметры - Структура
//
Процедура ПриНачальномЗаполненииРолиИсполнителя(Объект, Данные, ДополнительныеПараметры) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиПереопределяемый.ПриНачальномЗаполненииРолиИсполнителя(Объект, Данные, ДополнительныеПараметры)
```
</details>
## ПриНачальномЗаполненииОбъектовАдресацииЗадач
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается из модуля менеджера ПВХ ОбъектыАдресацииЗадач при начальном заполнении
// объектов адресации задача в прикладном решении.
// Стандартный реквизит ТипЗначения следует заполнять в процедуре ПриНачальномЗаполненииЭлементаОбъектаАдресацииЗадачи.
//
// Параметры:
// КодыЯзыков - Массив из Строка - список языков конфигурации. Актуально для мультиязычных конфигураций.
// Элементы - ТаблицаЗначений - данные заполнения. Состав колонок соответствует набору реквизитов объекта ПВХ ОбъектыАдресацииЗада.
// ТабличныеЧасти - Структура - описание табличных частей объекта, где:
// * Ключ - Строка - имя табличной части;
// * Значение - ТаблицаЗначений - табличная часть в виде таблицы значений, структуру которой
// необходимо скопировать перед заполнением. Например:
// Элемент.Ключи = ТабличныеЧасти.Ключи.Скопировать();
// ЭлементТЧ = Элемент.Ключи.Добавить();
// ЭлементТЧ.ИмяКлюча = "Первичный";
//
Процедура ПриНачальномЗаполненииОбъектовАдресацииЗадач(КодыЯзыков, Элементы, ТабличныеЧасти) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиПереопределяемый.ПриНачальномЗаполненииОбъектовАдресацииЗадач(КодыЯзыков, Элементы, ТабличныеЧасти)
```
</details>
## ПриНачальномЗаполненииЭлементаОбъектаАдресацииЗадачи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается из модуля менеджера ПВХ ОбъектыАдресацииЗадач при начальном заполнении
// элемента адресации задача в прикладном решении.
//
// Параметры:
// Объект - ПланВидовХарактеристикОбъект.ОбъектыАдресацииЗадач - заполняемый объект.
// Данные - СтрокаТаблицыЗначений - данные заполнения.
// ДополнительныеПараметры - Структура
//
Процедура ПриНачальномЗаполненииЭлементаОбъектаАдресацииЗадачи(Объект, Данные, ДополнительныеПараметры) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиПереопределяемый.ПриНачальномЗаполненииЭлементаОбъектаАдресацииЗадачи(Объект, Данные, ДополнительныеПараметры)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

874
src/content/docs/bsp/БизнесПроцессыИЗадачиСервер.md Normal file
View File

@ -0,0 +1,874 @@
---
title: Бизнес процессы и задачи сервер
slug: bsp/бизнес-процессы-и-задачи-сервер
---
## ФормаЗадачиПриСозданииНаСервере
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Инициализирует общие параметры формы выполнения задачи.
//
// Параметры:
// ФормаЗадачи - ФормаКлиентскогоПриложения - форма выполнения задачи.
// ЗадачаОбъект - ЗадачаОбъект - объект задачи.
// ЭлементГруппаСостояние - ГруппаФормы - группа с информации о состоянии задачи.
// ЭлементДатаИсполнения - ПолеФормы - поле с датой исполнения задачи.
//
Процедура ФормаЗадачиПриСозданииНаСервере(ФормаЗадачи, ЗадачаОбъект, Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ФормаЗадачиПриСозданииНаСервере(ФормаЗадачи, ЗадачаОбъект, );
```
</details>
## УстановитьОформлениеЗадач
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при создании формы списка задач на сервере.
//
// Параметры:
// СписокЗадачИлиЕгоУсловноеОформление - ДинамическийСписок
// - УсловноеОформлениеКомпоновкиДанных - условное оформление списка задач.
//
Процедура УстановитьОформлениеЗадач(Знач СписокЗадачИлиЕгоУсловноеОформление) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.УстановитьОформлениеЗадач(СписокЗадачИлиЕгоУсловноеОформление)
```
</details>
## УстановитьОформлениеБизнесПроцессов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при создании формы списка бизнес-процессов на сервере.
//
// Параметры:
// УсловноеОформлениеБизнесПроцессов - УсловноеОформлениеКомпоновкиДанных - условное оформление списка бизнес-процессов.
//
Процедура УстановитьОформлениеБизнесПроцессов(Знач УсловноеОформлениеБизнесПроцессов) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.УстановитьОформлениеБизнесПроцессов(УсловноеОформлениеБизнесПроцессов)
```
</details>
## ИсполнительСтрокой
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает строковое представление исполнителя задачи Исполнитель,
// либо указанного в параметрах РольИсполнителя, ОсновнойОбъектАдресации и ДополнительныйОбъектАдресации.
//
// Параметры:
// Исполнитель - СправочникСсылка.Пользователи - исполнитель задачи.
// РольИсполнителя - СправочникСсылка.РолиИсполнителей - роль.
// ОсновнойОбъектАдресации - ЛюбаяСсылка - ссылка на основной объект адресации.
// ДополнительныйОбъектАдресации - ЛюбаяСсылка - ссылка на дополнительный объект адресации.
//
// Возвращаемое значение:
// Строка - строковое представление исполнителя задачи, например:
// "Иванов Иван Иванович" - исполнитель, как указано в параметре Исполнитель;
// "Главный бухгалтер" - роль исполнителя, указанная в параметре РольИсполнителя;
// "Главный бухгалтер (ООО Солнышко)" - если роль указана вместе с основным объектом адресации;
// "Главный бухгалтер (ОАО Солнышко, Филиал в г.Москва)" - если роль указана вместе с обоими объектами
// адресации.
//
Функция ИсполнительСтрокой(Знач Исполнитель, Знач РольИсполнителя, Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.ИсполнительСтрокой(Исполнитель, РольИсполнителя, );
```
</details>
## РольСтрокой
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает строковое представление роли РольИсполнителя и ее объектов адресации, если они заданы.
//
// Параметры:
// РольИсполнителя - СправочникСсылка.РолиИсполнителей - роль.
// ОсновнойОбъектАдресации - ЛюбаяСсылка - ссылка на основной объект адресации.
// ДополнительныйОбъектАдресации - ЛюбаяСсылка - ссылка на дополнительный объект адресации.
//
// Возвращаемое значение:
// Строка - строковое представление роли, например:
// "Главный бухгалтер" - роль исполнителя, указанная в параметре РольИсполнителя;
// "Главный бухгалтер (ООО Солнышко)" - если роль указана вместе с основным объектом адресации;
// "Главный бухгалтер (ОАО Солнышко, Филиал в г.Москва)" - если роль указана вместе с обоими объектами
// адресации.
//
Функция РольСтрокой(Знач РольИсполнителя, Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.РольСтрокой(РольИсполнителя, );
```
</details>
## УстановитьПометкуУдаленияЗадач
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Помечает на удаление все задачи указанного бизнес-процесса (или снимает отметку).
//
// Параметры:
// БизнесПроцессСсылка - ОпределяемыйТип.БизнесПроцесс - бизнес-процесс, задачи которого нужно пометить на удаление.
// ПометкаУдаления - Булево - значение свойства ПометкаУдаления для задач.
//
Процедура УстановитьПометкуУдаленияЗадач(БизнесПроцессСсылка, ПометкаУдаления) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.УстановитьПометкуУдаленияЗадач(БизнесПроцессСсылка, ПометкаУдаления)
```
</details>
## УстановитьФорматДаты
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Установить формат отображения и редактирования поля формы типа Дата
// в зависимости от настроек подсистемы.
//
// Параметры:
// ПолеДаты - ПолеФормы - элемент управления формы, поле со значением типа Дата.
//
Процедура УстановитьФорматДаты(ПолеДаты) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.УстановитьФорматДаты(ПолеДаты)
```
</details>
## БизнесПроцессыВедущейЗадачи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Получить бизнес-процессы ведущей задачи ЗадачаСсылка.
//
// Параметры:
// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя - ведущая задача.
// ДляИзменения - Булево - если Истина, то следует установить исключительную управляемую блокировку
// на все бизнес-процессы указанной ведущей задачи. По умолчанию, Ложь.
// Возвращаемое значение:
// Массив из ОпределяемыйТип.БизнесПроцесс
//
Функция БизнесПроцессыВедущейЗадачи(ЗадачаСсылка, ДляИзменения = Ложь) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.БизнесПроцессыВедущейЗадачи(ЗадачаСсылка, ДляИзменения);
```
</details>
## ДатаЗавершенияБизнесПроцесса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает дату завершения указанного бизнес-процесса,
// полученную как максимальная дата исполнения задач бизнес-процесса.
//
// Параметры:
// БизнесПроцессСсылка - ОпределяемыйТип.БизнесПроцесс
//
// Возвращаемое значение:
// Дата
//
Функция ДатаЗавершенияБизнесПроцесса(БизнесПроцессСсылка) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.ДатаЗавершенияБизнесПроцесса(БизнесПроцессСсылка)
```
</details>
## БизнесПроцессыГлавнойЗадачи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает бизнес-процессы, подчиненные указанной задаче.
//
// Параметры:
// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя
// ДляИзменения - Булево - если Истина, то следует установить исключительную управляемую блокировку
// на все бизнес-процессы, подчиненные указанной задаче. По умолчанию, Ложь.
//
// Возвращаемое значение:
// Массив из ОпределяемыйТип.БизнесПроцесс
//
Функция БизнесПроцессыГлавнойЗадачи(ЗадачаСсылка, ДляИзменения = Ложь) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.БизнесПроцессыГлавнойЗадачи(ЗадачаСсылка, ДляИзменения);
```
</details>
## ПроверитьПраваНаИзменениеСостоянияБизнесПроцесса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет у текущего пользователя наличие прав на изменение состояния бизнес-процесса.
//
// Параметры:
// БизнесПроцессОбъект - ОпределяемыйТип.БизнесПроцессОбъект
//
Процедура ПроверитьПраваНаИзменениеСостоянияБизнесПроцесса(БизнесПроцессОбъект) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ПроверитьПраваНаИзменениеСостоянияБизнесПроцесса(БизнесПроцессОбъект)
```
</details>
## ЗаблокироватьБизнесПроцессы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Установить исключительную управляемую блокировку на указанные бизнес-процессы.
// Для вызова из обработчиков команд в динамических списках.
// Строки группировки динамического списка игнорируются.
//
// Параметры:
// БизнесПроцессы - ОпределяемыйТип.БизнесПроцесс
// - Массив из ОпределяемыйТип.БизнесПроцесс
//
Процедура ЗаблокироватьБизнесПроцессы(БизнесПроцессы) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ЗаблокироватьБизнесПроцессы(БизнесПроцессы)
```
</details>
## ЗаблокироватьЗадачи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Установить исключительную управляемую блокировку на указанные задачи.
// Для вызова из обработчиков команд в динамических списках.
// Строки группировки динамического списка игнорируются.
//
// Параметры:
// Задачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя
// - ЗадачаСсылка.ЗадачаИсполнителя
//
Процедура ЗаблокироватьЗадачи(Задачи) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ЗаблокироватьЗадачи(Задачи)
```
</details>
## ЗаполнитьГлавнуюЗадачу
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполняет реквизит ГлавнаяЗадача при создании бизнес-процесса на основании другого бизнес-процесса.
// См. также БизнесПроцессыИЗадачиПереопределяемый.ПриЗаполненииГлавнойЗадачиБизнесПроцесса.
//
// Параметры:
// БизнесПроцессОбъект - ОпределяемыйТип.БизнесПроцессОбъект
// ДанныеЗаполнения - ЗадачаСсылка
// - Произвольный - данные заполнения, которые передаются в обработчик заполнения.
//
Процедура ЗаполнитьГлавнуюЗадачу(БизнесПроцессОбъект, ДанныеЗаполнения) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ЗаполнитьГлавнуюЗадачу(БизнесПроцессОбъект, ДанныеЗаполнения)
```
</details>
## ГруппаИсполнителейЗадач
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Получить группу исполнителей задач, которая соответствует реквизитам адресации.
// Если группа еще не существует, то создается и возвращается новая.
//
// Параметры:
// РольИсполнителя - СправочникСсылка.РолиИсполнителей - роль исполнителя.
// ОсновнойОбъектАдресации - Характеристика.ОбъектыАдресацииЗадач - ссылка на основной объект адресации.
// ДополнительныйОбъектАдресации - Характеристика.ОбъектыАдресацииЗадач - ссылка на дополнительный объект адресации.
//
// Возвращаемое значение:
// СправочникСсылка.ГруппыИсполнителейЗадач
//
Функция ГруппаИсполнителейЗадач(РольИсполнителя, ОсновнойОбъектАдресации, ДополнительныйОбъектАдресации) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.ГруппаИсполнителейЗадач(РольИсполнителя, ОсновнойОбъектАдресации, ДополнительныйОбъектАдресации)
```
</details>
## ФормаВыполненияЗадачи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Получить структуру с описанием формы выполнения задачи.
//
// Параметры:
// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя
//
// Возвращаемое значение:
// см. БизнесПроцессыИЗадачиПереопределяемый.ПриПолученииФормыВыполненияЗадачи.ПараметрыФормы
//
Функция ФормаВыполненияЗадачи(Знач ЗадачаСсылка) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.ФормаВыполненияЗадачи(ЗадачаСсылка)
```
</details>
## ЭтоЗадачаИсполнителю
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет, находится ли в ячейке отчета ссылка на задачу и в параметре
// ЗначениеРасшифровки возвращает значение расшифровки.
//
// Параметры:
// Расшифровка - Строка - имя ячейки.
// ДанныеРасшифровкиОтчета - Строка - адрес во временном хранилище.
// ЗначениеРасшифровки - ЗадачаСсылка.ЗадачаИсполнителя
// - Произвольный - значение расшифровки из ячейки.
//
// Возвращаемое значение:
// Булево - Истина, если это задача исполнителю.
//
Функция ЭтоЗадачаИсполнителю(Знач Расшифровка, Знач ДанныеРасшифровкиОтчета, ЗначениеРасшифровки) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.ЭтоЗадачаИсполнителю(Расшифровка, ДанныеРасшифровкиОтчета, ЗначениеРасшифровки)
```
</details>
## ВыполнитьЗадачу
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполнить задачу ЗадачаСсылка, при необходимости выполнив обработчик.
// ОбработкаВыполненияПоУмолчанию модуля менеджера бизнес-процесса,
// к которому относится задача ЗадачаСсылка.
//
// Параметры:
// ЗадачаСсылка - ЗадачаСсылка
// ДействиеПоУмолчанию - Булево - признак необходимости вызова процедуры
// ОбработкаВыполненияПоУмолчанию у бизнес-процесса задачи.
//
Процедура ВыполнитьЗадачу(ЗадачаСсылка, ДействиеПоУмолчанию = Ложь) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ВыполнитьЗадачу(ЗадачаСсылка, ДействиеПоУмолчанию);
```
</details>
## ПеренаправитьЗадачи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Перенаправить задачи МассивЗадач новому исполнителю, указанному в структуре ИнфоОПеренаправлении.
//
// Параметры:
// ПеренаправляемыеЗадачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя
// ИнфоОПеренаправлении - Структура - новые значения реквизитов адресации задачи.
// ТолькоПроверка - Булево - если Истина, то функция не будет выполнять
// физического перенаправления задач, а только
// проверит возможность перенаправления.
// ПеренаправленныеЗадачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя - перенаправленные задачи.
// Может отличаться по составу элементов от массива
// ПеренаправляемыеЗадачи, если не все задачи удалось перенаправить.
//
// Возвращаемое значение:
// Булево - Истина, если перенаправление выполнено успешно.
//
Функция ПеренаправитьЗадачи(Знач ПеренаправляемыеЗадачи, Знач ИнфоОПеренаправлении, Знач ТолькоПроверка = Ложь, Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.ПеренаправитьЗадачи(ПеренаправляемыеЗадачи, ИнфоОПеренаправлении, ТолькоПроверка, );
```
</details>
## ЭтоВедущаяЗадача
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет, является ли указанная задача ведущей.
//
// Параметры:
// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя
//
// Возвращаемое значение:
// Булево
//
Функция ЭтоВедущаяЗадача(ЗадачаСсылка) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.ЭтоВедущаяЗадача(ЗадачаСсылка)
```
</details>
## СформироватьДанныеВыбораИсполнителя
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Формирует список подбора для указания исполнителя в полях ввода составного типа (Пользователь и Роль).
//
// Параметры:
// Текст - Строка - фрагмент текста для поиска возможных исполнителей.
//
// Возвращаемое значение:
// СписокЗначений - список подбора, содержащий возможных исполнителей.
//
Функция СформироватьДанныеВыбораИсполнителя(Текст) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.СформироватьДанныеВыбораИсполнителя(Текст)
```
</details>
## СделатьАктивнымБизнесПроцессы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанные бизнес-процессы как активные.
//
// Параметры:
// БизнесПроцессы - Массив из ОпределяемыйТип.БизнесПроцесс
//
Процедура СделатьАктивнымБизнесПроцессы(БизнесПроцессы) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.СделатьАктивнымБизнесПроцессы(БизнесПроцессы)
```
</details>
## СделатьАктивнымБизнесПроцесс
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанный бизнес-процесс как активный.
//
// Параметры:
// БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс
//
Процедура СделатьАктивнымБизнесПроцесс(БизнесПроцесс) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.СделатьАктивнымБизнесПроцесс(БизнесПроцесс)
```
</details>
## ОстановитьБизнесПроцессы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанные бизнес-процессы как остановленные.
//
// Параметры:
// БизнесПроцессы - Массив из ОпределяемыйТип.БизнесПроцесс
//
Процедура ОстановитьБизнесПроцессы(БизнесПроцессы) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ОстановитьБизнесПроцессы(БизнесПроцессы)
```
</details>
## ОстановитьБизнесПроцесс
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанный бизнес-процесс как остановленный.
//
// Параметры:
// БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс
//
Процедура ОстановитьБизнесПроцесс(БизнесПроцесс) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ОстановитьБизнесПроцесс(БизнесПроцесс)
```
</details>
## ПринятьЗадачиКИсполнению
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанные задачи как принятые к исполнению.
//
// Параметры:
// Задачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя
//
Процедура ПринятьЗадачиКИсполнению(Задачи) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ПринятьЗадачиКИсполнению(Задачи)
```
</details>
## ОтменитьПринятиеЗадачКИсполнению
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отмечает указанные задачи как не принятые к исполнению.
//
// Параметры:
// Задачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя
//
Процедура ОтменитьПринятиеЗадачКИсполнению(Задачи) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ОтменитьПринятиеЗадачКИсполнению(Задачи)
```
</details>
## ДобавитьПроцессДляОтложенногоСтарта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Добавляет процесс в очередь для отложенного старта.
//
// Параметры:
// Процесс - ОпределяемыйТип.БизнесПроцесс
// ДатаСтарта - Дата - дата отложенного старта.
//
Процедура ДобавитьПроцессДляОтложенногоСтарта(Процесс, ДатаСтарта) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ДобавитьПроцессДляОтложенногоСтарта(Процесс, ДатаСтарта)
```
</details>
## ОтключитьОтложенныйСтартПроцесса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отключает отложенный старт процесса.
//
// Параметры:
// Процесс - ОпределяемыйТип.БизнесПроцесс
//
Процедура ОтключитьОтложенныйСтартПроцесса(Процесс) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ОтключитьОтложенныйСтартПроцесса(Процесс)
```
</details>
## СтартоватьОтложенныйПроцесс
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Стартует отложенный бизнес-процесс, устанавливая признак старта.
//
// Параметры:
// БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс
//
Процедура СтартоватьОтложенныйПроцесс(БизнесПроцесс) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.СтартоватьОтложенныйПроцесс(БизнесПроцесс)
```
</details>
## ПараметрыОтложенногоПроцесса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает сведения о запуске для процесса.
//
// Параметры:
// Процесс - ОпределяемыйТип.БизнесПроцесс
//
// Возвращаемое значение:
// - Неопределено - если сведений нет.
// - Структура:
// * БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс.
// * ДатаОтложенногоСтарта - Дата
// * Состояние - ПеречислениеСсылка.СостоянияПроцессовДляЗапуска.
// * ПричинаОтменыСтарта - Строка - причина отмены старта.
//
Функция ПараметрыОтложенногоПроцесса(Процесс) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.ПараметрыОтложенногоПроцесса(Процесс)
```
</details>
## ДатаОтложенногоСтартаПроцесса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает дату старта отложенного бизнес-процесса в том случае, когда БизнесПроцесс
// ожидает отложенного старта. В противном случае возвращает пустую дату.
//
// Параметры:
// БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс
//
// Возвращаемое значение:
// Дата
//
Функция ДатаОтложенногоСтартаПроцесса(БизнесПроцесс) Экспорт
```
Пример вызова
```bsl
Результат = БизнесПроцессыИЗадачиСервер.ДатаОтложенногоСтартаПроцесса(БизнесПроцесс)
```
</details>
## УведомитьИсполнителейОНовыхЗадачах
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет рассылку уведомлений исполнителям о новых задачах за период с момента предыдущей рассылки.
// Рассылка выполняется по почте от системной учетной записи.
// Также является обработчиком регламентного задания УведомлениеИсполнителейОНовыхЗадачах.
//
Процедура УведомитьИсполнителейОНовыхЗадачах() Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.УведомитьИсполнителейОНовыхЗадачах()
```
</details>
## ПроконтролироватьЗадачи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет рассылку уведомлений исполнителям и авторам задач о задачах, не выполненных в срок.
// Рассылка выполняется по почте от системной учетной записи.
// Если задача направлена "в никуда", т.е. роли с пустым списком исполнителей,
// то создается новая задача ответственным за настройку ролей.
//
// Также является обработчиком регламентного задания МониторингЗадач.
//
Процедура ПроконтролироватьЗадачи() Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ПроконтролироватьЗадачи()
```
</details>
## НачатьОбновлениеПорцииНаборовЗначенийДоступа
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Подготовить первую порцию объектов для отложенной обработки прав доступа.
// Для вызова из отложенных обработчиков обновления при изменении логики формирования наборов значений доступа.
//
// Параметры:
// Параметры - Структура - структура параметров отложенного обработчика обновления.
// БизнесПроцесс - ОбъектМетаданныхБизнесПроцесс - метаданные бизнес-процесса, наборы значений доступа
// которого требуется обновить.
// ИмяПроцедуры - Строка - имя процедуры отложенного обработчика обновления для журнала регистрации.
// РазмерПорции - Число - количество объектов, обрабатываемых за один вызов.
//
Процедура НачатьОбновлениеПорцииНаборовЗначенийДоступа(Параметры, БизнесПроцесс, ИмяПроцедуры, РазмерПорции = 1000) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.НачатьОбновлениеПорцииНаборовЗначенийДоступа(Параметры, БизнесПроцесс, ИмяПроцедуры, РазмерПорции);
```
</details>
## ЗавершитьОбновлениеПорцииНаборовЗначенийДоступа
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Завершить обработку первой порции объектов для отложенной обработки прав доступа.
// Для вызова из отложенных обработчиков обновления при изменении логики формирования наборов значений доступа.
//
// Параметры:
// Параметры - Структура - параметры отложенного обработчика обновления.
//
Процедура ЗавершитьОбновлениеПорцииНаборовЗначенийДоступа(Параметры) Экспорт
```
Пример вызова
```bsl
БизнесПроцессыИЗадачиСервер.ЗавершитьОбновлениеПорцииНаборовЗначенийДоступа(Параметры)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

54
src/content/docs/bsp/БлокировкаРаботыСВнешнимиРесурсамиПереопределяемый.md Normal file
View File

@ -0,0 +1,54 @@
---
title: Блокировка работы с внешними ресурсами переопределяемый
slug: bsp/блокировка-работы-с-внешними-ресурсами-переопределяемый
---
## ПриРазрешенииРаботыСВнешнимиРесурсами
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при снятии блокировки работы с внешними ресурсами.
// Для включения работы механизмов, отключенных в процедуре ПриЗапретеРаботыСВнешнимиРесурсами.
//
Процедура ПриРазрешенииРаботыСВнешнимиРесурсами() Экспорт
```
Пример вызова
```bsl
БлокировкаРаботыСВнешнимиРесурсамиПереопределяемый.ПриРазрешенииРаботыСВнешнимиРесурсами()
```
</details>
## ПриЗапретеРаботыСВнешнимиРесурсами
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при установке блокировки работы с внешними ресурсами,
// при старте регламентного задания в копии информационной базы или интерактивно.
//
// Позволяет отключить произвольные механизмы, работа
// которых в копии информационной базы недопустима.
//
Процедура ПриЗапретеРаботыСВнешнимиРесурсами() Экспорт
```
Пример вызова
```bsl
БлокировкаРаботыСВнешнимиРесурсамиПереопределяемый.ПриЗапретеРаботыСВнешнимиРесурсами()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

1088
src/content/docs/bsp/ВариантыОтчетов.md Normal file
View File

File diff suppressed because it is too large Load Diff

86
src/content/docs/bsp/ВариантыОтчетовКлиент.md Normal file
View File

@ -0,0 +1,86 @@
---
title: Варианты отчетов клиент
slug: bsp/варианты-отчетов-клиент
---
## ОткрытьФормуОтчета
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму указанного отчета.
//
// Параметры:
// ФормаВладелец - ФормаКлиентскогоПриложения
// - Неопределено - форма, из которой открывается отчет.
// Вариант - СправочникСсылка.ВариантыОтчетов
// - СправочникСсылка.ДополнительныеОтчетыИОбработки - вариант
// отчета, форму которого требуется открыть. Если передан тип СправочникСсылка.ДополнительныеОтчетыИОбработки,
// то открывается дополнительный отчет, подключенный к программе.
// ДополнительныеПараметры - Структура - служебный параметр, не предназначен для использования.
//
Процедура ОткрытьФормуОтчета(Знач ФормаВладелец, Знач Вариант, Знач ДополнительныеПараметры = Неопределено) Экспорт
```
Пример вызова
```bsl
ВариантыОтчетовКлиент.ОткрытьФормуОтчета(ФормаВладелец, Вариант, ДополнительныеПараметры);
```
</details>
## ПоказатьПанельОтчетов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает панель отчетов. Для использования из модулей общих команд.
//
// Параметры:
// ПутьКПодсистеме - Строка - имя раздела или путь к подсистеме, для которой открывается панель отчетов.
// Задается в формате: "ИмяРаздела[.ИмяВложеннойПодсистемы1][.ИмяВложеннойПодсистемы2][...]".
// Раздел должен быть описан в ВариантыОтчетовПереопределяемый.ОпределитьРазделыСВариантамиОтчетов.
// ПараметрыВыполненияКоманды - ПараметрыВыполненияКоманды - параметры обработчика общей команды.
//
Процедура ПоказатьПанельОтчетов(ПутьКПодсистеме, ПараметрыВыполненияКоманды) Экспорт
```
Пример вызова
```bsl
ВариантыОтчетовКлиент.ПоказатьПанельОтчетов(ПутьКПодсистеме, ПараметрыВыполненияКоманды)
```
</details>
## ОбновитьОткрытыеФормы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Оповещает открытые панели отчетов, формы списков и элементов об изменениях варианта отчета.
//
// Параметры:
// КлючВарианта - Строка - если открыта форма отчета, установить в ней указанный вариант отчета.
// Источник - СправочникСсылка.ВариантыОтчетов
//
Процедура ОбновитьОткрытыеФормы(Знач КлючВарианта = "", Знач Источник = Неопределено) Экспорт
```
Пример вызова
```bsl
ВариантыОтчетовКлиент.ОбновитьОткрытыеФормы(КлючВарианта, Источник);
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

34
src/content/docs/bsp/ВариантыОтчетовКлиентСервер.md Normal file
View File

@ -0,0 +1,34 @@
---
title: Варианты отчетов клиент сервер
slug: bsp/варианты-отчетов-клиент-сервер
---
## ИдентификаторНачальнойСтраницы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Идентификатор, который используется для начальной страницы в модуле ВариантыОтчетовПереопределяемый.
//
// Возвращаемое значение:
// Строка - идентификатор, который используется для начальной страницы в модуле ВариантыОтчетовПереопределяемый.
//
Функция ИдентификаторНачальнойСтраницы() Экспорт
```
Пример вызова
```bsl
Результат = ВариантыОтчетовКлиентСервер.ИдентификаторНачальнойСтраницы()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

364
src/content/docs/bsp/ВариантыОтчетовПереопределяемый.md Normal file
View File

@ -0,0 +1,364 @@
---
title: Варианты отчетов переопределяемый
slug: bsp/варианты-отчетов-переопределяемый
---
## ПриОпределенииНастроек
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Задает настройки, применяемые как стандартные для объектов подсистемы.
//
// Параметры:
// Настройки - Структура - коллекция настроек подсистемы. Реквизиты:
// * ВыводитьОтчетыВместоВариантов - Булево - умолчание для вывода гиперссылок в панели отчетов:
// Истина - варианты отчетов по умолчанию скрыты, а отчеты включены и видимы.
// Ложь - варианты отчетов по умолчанию видимы, а отчеты отключены.
// Значение по умолчанию: Ложь.
// * ВыводитьОписания - Булево - умолчание для вывода описаний в панели отчетов:
// Истина - значение по умолчанию. Выводить описания в виде подписей под гиперссылками вариантов
// Ложь - выводить описания в виде всплывающих подсказок
// Значение по умолчанию: Истина.
// * Поиск - Структура - настройки поиска вариантов отчетов:
// ** ПодсказкаВвода - Строка - текст подсказки выводится в поле поиска когда поиск не задан.
// В качестве примера рекомендуется указывать часто используемые термины прикладной конфигурации.
// * ДругиеОтчеты - Структура - настройки формы "Другие отчеты":
// ** ЗакрыватьПослеВыбора - Булево - закрывать ли форму после выбора гиперссылки отчета.
// Истина - закрывать "Другие отчеты" после выбора.
// Ложь - не закрывать.
// Значение по умолчанию: Истина.
// ** ПоказыватьФлажок - Булево - показывать ли флажок ЗакрыватьПослеВыбора.
// Истина - показывать флажок "Закрывать это окно после перехода к другому отчету".
// Ложь - не показывать флажок.
// Значение по умолчанию: Ложь.
// * РазрешеноИзменятьВарианты - Булево - показывать расширенные настройки отчета
// и команды изменения варианта отчета.
//
// Пример:
// Настройки.Поиск.ПодсказкаВвода = НСтр("ru = 'Например, себестоимость'");
// Настройки.ДругиеОтчеты.ЗакрыватьПослеВыбора = Ложь;
// Настройки.ДругиеОтчеты.ПоказыватьФлажок = Истина;
// Настройки.РазрешеноИзменятьВарианты = Ложь;
//
Процедура ПриОпределенииНастроек(Настройки) Экспорт
```
Пример вызова
```bsl
ВариантыОтчетовПереопределяемый.ПриОпределенииНастроек(Настройки)
```
</details>
## ОпределитьРазделыСВариантамиОтчетов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет разделы командного интерфейса, в которых предусмотрены панели отчетов.
// В Разделы необходимо добавить метаданные тех подсистем первого уровня,
// в которых размещены команды вызова панелей отчетов.
//
// Параметры:
// Разделы - СписокЗначений - разделы, в которые выведены команды открытия панели отчетов:
// * Значение - ОбъектМетаданныхПодсистема
// - Строка - подсистема раздела глобального командного интерфейса,
// либо ВариантыОтчетовКлиентСервер.ИдентификаторНачальнойСтраницы для начальной страницы.
// * Представление - Строка - заголовок панели отчетов в этом разделе.
//
// Пример:
// Разделы.Добавить(Метаданные.Подсистемы.Анкетирование, НСтр("ru = 'Отчеты по анкетированию'"));
// Разделы.Добавить(ВариантыОтчетовКлиентСервер.ИдентификаторНачальнойСтраницы(), НСтр("ru = 'Основные отчеты'"));
//
Процедура ОпределитьРазделыСВариантамиОтчетов(Разделы) Экспорт
```
Пример вызова
```bsl
ВариантыОтчетовПереопределяемый.ОпределитьРазделыСВариантамиОтчетов(Разделы)
```
</details>
## НастроитьВариантыОтчетов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Задает расширенные настройки отчетов конфигурации, такие как:
// - описание отчета;
// - поля поиска: наименования полей, параметров и отборов (для отчетов не на базе СКД);
// - размещение в разделах командного интерфейса
// (начальная настройка размещения отчетов по подсистемам автоматически определяется из метаданных,
// ее дублирование не требуется);
// - признак Включен (для контекстных отчетов);
// - режима вывода в панелях отчетов (с группировкой по отчету или без);
// - и другие.
//
// В процедуре задаются только настройки отчетов (и вариантов отчетов) конфигурации.
// Для настройки отчетов из расширений конфигурации следует включать их в подсистему ПодключаемыеОтчетыИОбработки.
//
// Для задания настроек следует использовать следующие вспомогательные процедуры и функции:
// ВариантыОтчетов.ОписаниеОтчета,
// ВариантыОтчетов.ОписаниеВарианта,
// ВариантыОтчетов.УстановитьРежимВыводаВПанеляхОтчетов,
// ВариантыОтчетов.НастроитьОтчетВМодулеМенеджера.
//
// Изменяя настройки отчета, можно изменить настройки всех его вариантов.
// Однако, если явно получить настройки варианта отчета, то они станут самостоятельными,
// т.е. более не будут наследовать изменения настроек от отчета.
//
// Функциональные опции предопределенного варианта отчета объединяются с функциональными опциями этого отчета по правилам:
// (ФО1_Отчета ИЛИ ФО2_Отчета) И (ФО3_Варианта ИЛИ ФО4_Варианта).
// При этом для пользовательских вариантов отчета действуют только функциональные опции отчета
// - они отключаются только с отключением всего отчета.
//
// Параметры:
// Настройки - ТаблицаЗначений - коллекция предопределенных вариантов отчетов, где:
// * Отчет - СправочникСсылка.ИдентификаторыОбъектовРасширений
// - СправочникСсылка.ДополнительныеОтчетыИОбработки
// - СправочникСсылка.ИдентификаторыОбъектовМетаданных
// - Строка - полное имя или ссылка на идентификатор отчета.
// * Метаданные - ОбъектМетаданныхОтчет - метаданные отчета.
// * ИспользуетСКД - Булево - признак использования в отчете основной СКД.
// * КлючВарианта - Строка - идентификатор варианта отчета.
// * ОписаниеПолучено - Булево - признак того, что описание строки уже получено.
// * Включен - Булево - если Ложь, то вариант отчета не выводится в панели отчетов.
// * ВидимостьПоУмолчанию - Булево - если Ложь, то вариант отчета по умолчанию скрыт в панели отчетов.
// * ПоказыватьВПодменюВариантов - Булево - если Ложь, то вариант отчета не отображается в подменю выбора вариантов
// отчета в форме отчета. Используется, когда Включен - Ложь.
// * Наименование - Строка - наименование варианта отчета.
// * Описание - Строка - пояснение назначения отчета.
// * Размещение - Соответствие из КлючИЗначение - настройки размещения варианта отчета в разделах (подсистемах), где:
// ** Ключ - ОбъектМетаданных - подсистема, в которой размещается отчет или вариант отчета.
// ** Значение - Строка - настройки размещения в подсистеме (группе) - "", "Важный", "СмТакже".
// * НастройкиДляПоиска - Структура - дополнительные настройки для поиска этого варианта отчета, где:
// ** НаименованияПолей - Строка - имена полей варианта отчета.
// ** НаименованияПараметровИОтборов - Строка - имена настроек варианта отчета.
// ** КлючевыеСлова - Строка - дополнительная терминология (в т.ч. специализированная или устаревшая).
// ** ИменаМакетов - Строка - используется вместо НаименованияПолей.
// * СистемнаяИнформация - Структура - другая служебная информация.
// * Тип - Строка - перечень идентификаторов типов.
// * ЭтоВариант - Булево - признак того, что описание отчета относится к варианту отчета.
// * ФункциональныеОпции - Массив из Строка - коллекция идентификаторов функциональных опций, где:
// * ГруппироватьПоОтчету - Булево - признак необходимости группировки вариантов по отчету-основанию.
// * КлючЗамеров - Строка - идентификатор замера производительности отчета.
// * ОсновнойВариант - Строка - идентификатор основного варианта отчета.
// * ФорматНастроекСКД - Булево - признак хранения настроек в формате СКД.
// * ОпределитьНастройкиФормы - Булево - отчет имеет программный интерфейс для тесной интеграции с формой отчета,
// в том числе может переопределять некоторые настройки формы и подписываться на ее события.
// Если Истина и отчет подключен к общей форме ФормаОтчета,
// тогда в модуле объекта отчета следует определить процедуру по шаблону:
//
// // Задать настройки формы отчета.
// //
// // Параметры:
// // Форма - ФормаКлиентскогоПриложения, Неопределено
// // КлючВарианта - Строка, Неопределено
// // Настройки - см. ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию
// //
// Процедура ОпределитьНастройкиФормы(Форма, КлючВарианта, Настройки) Экспорт
// // Код процедуры.
// КонецПроцедуры
//
// Пример:
//
// // Добавление варианта отчета в подсистему.
// НастройкиВарианта = ВариантыОтчетов.ОписаниеВарианта(Настройки, Метаданные.Отчеты.ИмяОтчета, "<ИмяВарианта>");
// НастройкиВарианта.Размещение.Вставить(Метаданные.Подсистемы.ИмяРаздела.Подсистемы.ИмяПодсистемы);
//
// // Отключение варианта отчета.
// НастройкиВарианта = ВариантыОтчетов.ОписаниеВарианта(Настройки, Метаданные.Отчеты.ИмяОтчета, "<ИмяВарианта>");
// НастройкиВарианта.Включен = Ложь;
//
// // Отключение всех вариантов отчета, кроме одного.
// НастройкиОтчета = ВариантыОтчетов.ОписаниеОтчета(Настройки, Метаданные.Отчеты.ИмяОтчета);
// НастройкиОтчета.Включен = Ложь;
// НастройкиВарианта = ВариантыОтчетов.ОписаниеВарианта(Настройки, НастройкиОтчета, "<ИмяВарианта>");
// НастройкиВарианта.Включен = Истина;
//
// // Заполнение настроек для поиска - наименования полей, параметров и отборов:
// НастройкиВарианта = ВариантыОтчетов.ОписаниеВарианта(Настройки, Метаданные.Отчеты.ИмяОтчетаБезСхемы, "");
// НастройкиВарианта.НастройкиДляПоиска.НаименованияПолей =
// НСтр("ru = 'Контрагент
// |Договор
// |Ответственный
// |Скидка
// |Дата'");
// НастройкиВарианта.НастройкиДляПоиска.НаименованияПараметровИОтборов =
// НСтр("ru = 'Период
// |Ответственный
// |Контрагент
// |Договор'");
//
// // Переключение режима вывода в панелях отчетов:
// // Группировка вариантов отчета по этому отчету:
// ВариантыОтчетов.УстановитьРежимВыводаВПанеляхОтчетов(Настройки, Метаданные.Отчеты.ИмяОтчета, Истина);
// // Без группировки по отчету:
// Отчет = ВариантыОтчетов.ОписаниеОтчета(Настройки, Метаданные.Отчеты.ИмяОтчета);
// ВариантыОтчетов.УстановитьРежимВыводаВПанеляхОтчетов(Настройки, Отчет, Ложь);
//
Процедура НастроитьВариантыОтчетов(Настройки) Экспорт
```
Пример вызова
```bsl
ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов(Настройки)
```
</details>
## ЗарегистрироватьИзмененияКлючейВариантовОтчетов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Регистрирует изменения в именах вариантов отчетов.
// Используется при обновлении в целях сохранения ссылочной целостности,
// в частности для сохранения пользовательских настроек и настроек рассылок отчетов.
// Старое имя варианта резервируется и не может быть использовано в дальнейшем.
// Если изменений было несколько, то каждое изменение необходимо зарегистрировать,
// указывая в актуальном имени варианта последнее (текущее) имя варианта отчета.
// Поскольку имена вариантов отчетов не выводятся в пользовательском интерфейсе,
// то рекомендуется задавать их таким образом, что бы затем не менять.
// В Изменения необходимо добавить описания изменений имен вариантов
// отчетов, подключенных к подсистеме.
//
// Параметры:
// Изменения - ТаблицаЗначений - таблица изменений имен вариантов. Колонки:
// * Отчет - ОбъектМетаданных - метаданные отчета, в схеме которого изменилось имя варианта.
// * СтароеИмяВарианта - Строка - старое имя варианта, до изменения.
// * АктуальноеИмяВарианта - Строка - текущее (последнее актуальное) имя варианта.
//
// Пример:
// Изменение = Изменения.Добавить();
// Изменение.Отчет = Метаданные.Отчеты.<ИмяОтчета>;
// Изменение.СтароеИмяВарианта = "<СтароеИмяВарианта>";
// Изменение.АктуальноеИмяВарианта = "<АктуальноеИмяВарианта>";
//
Процедура ЗарегистрироватьИзмененияКлючейВариантовОтчетов(Изменения) Экспорт
```
Пример вызова
```bsl
ВариантыОтчетовПереопределяемый.ЗарегистрироватьИзмененияКлючейВариантовОтчетов(Изменения)
```
</details>
## ОпределитьОбъектыСКомандамиОтчетов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет объекты конфигурации, в модулях менеджеров которых предусмотрена процедура ДобавитьКомандыОтчетов,
// описывающая команды открытия контекстных отчетов.
// Синтаксис процедуры ДобавитьКомандыОтчетов см. в документации.
//
// Параметры:
// Объекты - Массив - объекты метаданных (ОбъектМетаданных) с командами отчетов.
//
Процедура ОпределитьОбъектыСКомандамиОтчетов(Объекты) Экспорт
```
Пример вызова
```bsl
ВариантыОтчетовПереопределяемый.ОпределитьОбъектыСКомандамиОтчетов(Объекты)
```
</details>
## ПередДобавлениемКомандОтчетов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определение списка глобальных команд отчетов.
// Событие возникает в процессе вызова модуля повторного использования.
//
// Параметры:
// КомандыОтчетов - ТаблицаЗначений - таблица команд для вывода в подменю, где:
// * Идентификатор - Строка - идентификатор команды.
// * Представление - Строка - представление команды в форме.
// * Важность - Строка - суффикс группы в подменю, в которой следует вывести эту команду.
// Допустимо использовать: "Важное", "Обычное" и "СмТакже".
// * Порядок - Число - порядок размещения команды в группе. Используется для настройки под конкретное
// рабочее место.
// * Картинка - Картинка - картинка команды.
// * СочетаниеКлавиш - СочетаниеКлавиш - сочетание клавиш для быстрого вызова команды.
// * ТипПараметра - ОписаниеТипов - типы объектов, для которых предназначена эта команда.
// * ВидимостьВФормах - Строка - имена форм через запятую, в которых должна отображаться команда.
// Используется когда состав команд отличается для различных форм.
// * ФункциональныеОпции - Строка - имена функциональных опций через запятую, определяющих видимость команды.
// * УсловияВидимости - Массив - определяет видимость команды в зависимости от контекста.
// Для регистрации условий следует использовать процедуру
// ПодключаемыеКоманды.ДобавитьУсловиеВидимостиКоманды().
// Условия объединяются по "И".
// * ИзменяетВыбранныеОбъекты - Булево - определяет доступность команды в ситуации,
// когда у пользователя нет прав на изменение объекта.
// Если Истина, то в описанной выше ситуации кнопка будет недоступна.
// Необязательный. Значение по умолчанию: Ложь.
// * МножественныйВыбор - Булево
// - Неопределено - если Истина, то команда поддерживает множественный выбор.
// В этом случае в параметре выполнения будет передан список ссылок.
// Необязательный. Значение по умолчанию: Истина.
// * Неконтекстный - Булево - если Истина, то будут доступны для выбора другие варианты этого отчета,
// возможность добавления в избранное, получение ссылки на вариант отчета.
// * РежимЗаписи - Строка - действия, связанные с записью объекта, которые выполняются перед обработчиком команды, где:
// "НеЗаписывать" - объект не записывается, а в параметрах обработчика вместо ссылок передается
// вся форма. В этом режиме рекомендуется работать напрямую с формой,
// которая передается в структуре 2 параметра обработчика команды.
// "ЗаписыватьТолькоНовые" - записывать новые объекты.
// "Записывать" - записывать новые и модифицированные объекты.
// "Проводить" - проводить документы.
// Перед записью и проведением у пользователя запрашивается подтверждение.
// Необязательный. Значение по умолчанию: "Записывать".
// * ТребуетсяРаботаСФайлами - Булево - если Истина, то в веб-клиенте предлагается
// установить расширение для работы с 1С:Предприятием.
// Необязательный. Значение по умолчанию: Ложь.
// * Менеджер - Строка - полное имя объекта метаданных, отвечающего за выполнение команды.
// Например, "Отчет.КнигаПокупок".
// * ИмяФормы - Строка - имя формы, которую требуется открыть или получить для выполнения команды.
// Если Обработчик не указан, то у формы вызывается метод "Открыть".
// * КлючВарианта - Строка - имя варианта отчета, открываемого при выполнении команды.
// * ИмяПараметраФормы - Строка - имя параметра формы, в который следует передать ссылку или массив ссылок.
// * ПараметрыФормы - Неопределено
// - Структура - параметры формы, указанной в ИмяФормы.
// * Обработчик - Строка - описание процедуры, обрабатывающей основное действие команды.
// Формат "<ИмяОбщегоМодуля>.<ИмяПроцедуры>" используется когда процедура размещена в общем модуле.
// Формат "<ИмяПроцедуры>" используется в следующих случаях:
// 1) если ИмяФормы заполнено то в модуле указанной формы ожидается клиентская процедура,
// 2) если ИмяФормы не заполнено то в модуле менеджера этого объекта ожидается серверная процедура.
// * ДополнительныеПараметры - Структура - параметры обработчика, указанного в Обработчик.
//
// Параметры - Структура - сведения о контексте исполнения, где:
// * ИмяФормы - Строка - полное имя формы.
//
// СтандартнаяОбработка - Булево - если установить в Ложь, то событие "ДобавитьКомандыОтчетов" менеджера объекта не
// будет вызвано.
//
Процедура ПередДобавлениемКомандОтчетов(КомандыОтчетов, Параметры, СтандартнаяОбработка) Экспорт
```
Пример вызова
```bsl
ВариантыОтчетовПереопределяемый.ПередДобавлениемКомандОтчетов(КомандыОтчетов, Параметры, СтандартнаяОбработка)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

184
src/content/docs/bsp/ВерсионированиеОбъектов.md Normal file
View File

@ -0,0 +1,184 @@
---
title: Версионирование объектов
slug: bsp/версионирование-объектов
---
## ЗаписатьНастройкуВерсионированияПоОбъекту
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Записывает настройку версионирования объекта.
//
// Параметры:
// ТипОбъекта - Строка
// - Тип
// - ОбъектМетаданных
// - СправочникСсылка.ИдентификаторыОбъектовМетаданных - объект метаданных;
// ВариантВерсионирования - ПеречислениеСсылка.ВариантыВерсионированияОбъектов - условие записи версий;
// СрокХраненияВерсий - ПеречислениеСсылка.СрокиХраненияВерсий - срок, после которого версии подлежат очистке.
//
Процедура ЗаписатьНастройкуВерсионированияПоОбъекту(Знач ТипОбъекта, Знач ВариантВерсионирования, Знач СрокХраненияВерсий = Неопределено) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектов.ЗаписатьНастройкуВерсионированияПоОбъекту(ТипОбъекта, ВариантВерсионирования, СрокХраненияВерсий);
```
</details>
## ПриСозданииНаСервере
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет с формой действия, необходимые для подключения подсистемы версионирования.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма для подключения механизма версионирования.
//
Процедура ПриСозданииНаСервере(Форма) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектов.ПриСозданииНаСервере(Форма)
```
</details>
## ВключеноВерсионированиеОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает признак использования версионирования для указанного объекта метаданных.
//
// Параметры:
// ИмяОбъекта - Строка - полный путь к объекту метаданных. Например, "Справочник.Номенклатура".
//
// Возвращаемое значение:
// Булево - Истина, если включено.
//
Функция ВключеноВерсионированиеОбъекта(ИмяОбъекта) Экспорт
```
Пример вызова
```bsl
Результат = ВерсионированиеОбъектов.ВключеноВерсионированиеОбъекта(ИмяОбъекта)
```
</details>
## ВключеноВерсионированиеОбъектов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает признак использования версионирования для списка объектов.
//
// Параметры:
// СписокОбъектов - Массив - список имен объектов метаданных.
//
// Возвращаемое значение:
// Соответствие из КлючИЗначение:
// * Ключ - Строка - имя объекта метаданных.
// * Значение - Булево - включено или выключено версионирование.
//
Функция ВключеноВерсионированиеОбъектов(СписокОбъектов) Экспорт
```
Пример вызова
```bsl
Результат = ВерсионированиеОбъектов.ВключеноВерсионированиеОбъектов(СписокОбъектов)
```
</details>
## ВключитьВерсионированиеОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Включает запись истории изменения для указанного объекта метаданных.
//
// Параметры:
// ИмяОбъекта - Строка - полный путь к объекту метаданных. Например, "Справочник.Номенклатура".
// ВариантВерсионирования - ПеречислениеСсылка.ВариантыВерсионированияОбъектов - вариант версионирования объекта.
//
Процедура ВключитьВерсионированиеОбъекта(ИмяОбъекта, Знач ВариантВерсионирования = Неопределено) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектов.ВключитьВерсионированиеОбъекта(ИмяОбъекта, ВариантВерсионирования);
```
</details>
## ВключитьВерсионированиеОбъектов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Включает запись истории изменения для указанных объектов метаданных.
//
// Параметры:
// Объекты - Соответствие из КлючИЗначение - объекты, для которых надо включить версионирование:
// * Ключ - Строка - полный путь к объекту метаданных. Например, "Справочник.Номенклатура".
// * Значение - ПеречислениеСсылка.ВариантыВерсионированияОбъектов - вариант версионирования объекта.
//
Процедура ВключитьВерсионированиеОбъектов(Объекты) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектов.ВключитьВерсионированиеОбъектов(Объекты)
```
</details>
## ЗначениеФлажкаХранитьИсторию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает признак хранения истории для формы настроек версионирования объекта.
//
// Возвращаемое значение:
// Булево
//
// Пример:
// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ВерсионированиеОбъектов") Тогда
// МодульВерсионированиеОбъектов = ОбщегоНазначения.ОбщийМодуль("ВерсионированиеОбъектов");
// ИспользоватьВерсионированиеОбъектов = МодульВерсионированиеОбъектов.ЗначениеФлажкаХранитьИсторию();
// Иначе
// Элементы.ГруппаУправлениеВерсионированиемОбъектов.Видимость = Ложь;
// КонецЕсли;
//
Функция ЗначениеФлажкаХранитьИсторию() Экспорт
```
Пример вызова
```bsl
Результат = ВерсионированиеОбъектов.ЗначениеФлажкаХранитьИсторию()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

142
src/content/docs/bsp/ВерсионированиеОбъектовКлиент.md Normal file
View File

@ -0,0 +1,142 @@
---
title: Версионирование объектов клиент
slug: bsp/версионирование-объектов-клиент
---
## ОткрытьОтчетПоИзменениям
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает отчет по версиям объекта в режиме сравнения версий.
//
// Параметры:
// Ссылка - ЛюбаяСсылка - ссылка на версионируемый объект;
// АдресСериализованногоОбъекта - Строка - адрес двоичных данных сравниваемой версии
// объекта во временном хранилище.
//
Процедура ОткрытьОтчетПоИзменениям(Ссылка, АдресСериализованногоОбъекта) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовКлиент.ОткрытьОтчетПоИзменениям(Ссылка, АдресСериализованногоОбъекта)
```
</details>
## ОткрытьОтчетПоВерсииОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Показывает сохраненную версию объекта.
//
// Параметры:
// Ссылка - ЛюбаяСсылка - ссылка на версионируемый объект;
// АдресСериализованногоОбъекта - Строка - адрес двоичных данных версии объекта во временном хранилище.
//
Процедура ОткрытьОтчетПоВерсииОбъекта(Ссылка, АдресСериализованногоОбъекта) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовКлиент.ОткрытьОтчетПоВерсииОбъекта(Ссылка, АдресСериализованногоОбъекта)
```
</details>
## ОбработкаОповещенияИзмененияФлажкаХранитьИсторию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик события ОбработкаОповещения для формы, на которой требуется отобразить флажок хранения истории изменения.
//
// Параметры:
// ИмяСобытия - Строка - имя события, которое было получено обработчиком события на форме.
// ХранитьИсториюИзменений - Число - реквизит, в который будет помещено значение.
//
// Пример:
// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ВерсионированиеОбъектов") Тогда
// МодульВерсионированиеОбъектовКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ВерсионированиеОбъектовКлиент");
// МодульВерсионированиеОбъектовКлиент.ОбработкаОповещенияИзмененияФлажкаХранитьИсторию(
// ИмяСобытия,
// ХранитьИсториюИзменений);
// КонецЕсли;
//
Процедура ОбработкаОповещенияИзмененияФлажкаХранитьИсторию(Знач ИмяСобытия, ХранитьИсториюИзменений) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовКлиент.ОбработкаОповещенияИзмененияФлажкаХранитьИсторию(ИмяСобытия, ХранитьИсториюИзменений)
```
</details>
## ПриИзмененииФлажкаХранитьИсторию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик события ПриИзменении для флажка, выполняющего переключение режима хранения истории изменений.
// Флажок должен быть связан с реквизитом типа Булево.
//
// Параметры:
// ЗначениеФлажкаХранитьИсториюИзменений - Булево - новое значение флажка, которое требуется обработать.
//
// Пример:
// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ВерсионированиеОбъектов") Тогда
// МодульВерсионированиеОбъектовКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ВерсионированиеОбъектовКлиент");
// МодульВерсионированиеОбъектовКлиент.ПриИзмененииФлажкаХранитьИсторию(ХранитьИсториюИзменений);
// КонецЕсли;
//
Процедура ПриИзмененииФлажкаХранитьИсторию(ЗначениеФлажкаХранитьИсториюИзменений) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовКлиент.ПриИзмененииФлажкаХранитьИсторию(ЗначениеФлажкаХранитьИсториюИзменений)
```
</details>
## ПоказатьНастройку
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму управления версионированием объектов.
// Не забудьте команду, выполняющую вызов процедуры,
// установить зависимой от функциональной опции ИспользоватьВерсионированиеОбъектов.
//
// Пример:
// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ВерсионированиеОбъектов") Тогда
// МодульВерсионированиеОбъектовКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ВерсионированиеОбъектовКлиент");
// МодульВерсионированиеОбъектовКлиент.ПоказатьНастройку();
// КонецЕсли;
//
Процедура ПоказатьНастройку() Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовКлиент.ПоказатьНастройку()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

176
src/content/docs/bsp/ВерсионированиеОбъектовПереопределяемый.md Normal file
View File

@ -0,0 +1,176 @@
---
title: Версионирование объектов переопределяемый
slug: bsp/версионирование-объектов-переопределяемый
---
## ПриПолученииТабличныхДокументовОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается для получения версионируемых табличных документов во время записи версии объекта.
// Табличный документ прикладывается к версии объекта в случае, когда в отчете по версии объекта требуется
// заменить "техногенную" табличную часть объекта на ее представление в виде табличного документа.
//
// Параметры:
// Ссылка - ЛюбаяСсылка - версионируемый объект конфигурации.
// ТабличныеДокументы - Структура:
// * Ключ - Строка - имя табличного документа;
// * Значение - Структура:
// ** Наименование - Строка - наименование табличного документа;
// ** Данные - ТабличныйДокумент - версионируемый табличный документ.
//
Процедура ПриПолученииТабличныхДокументовОбъекта(Ссылка, ТабличныеДокументы) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовПереопределяемый.ПриПолученииТабличныхДокументовОбъекта(Ссылка, ТабличныеДокументы)
```
</details>
## ПослеРазбораВерсииОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается после разбора прочитанной из регистра версии объекта,
// может использоваться для дополнительной обработки результата разбора версии.
//
// Параметры:
// Ссылка - ЛюбаяСсылка - версионируемый объект конфигурации.
// Результат - Структура - результат разбора версии подсистемой версионирования.
//
Процедура ПослеРазбораВерсииОбъекта(Ссылка, Результат) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовПереопределяемый.ПослеРазбораВерсииОбъекта(Ссылка, Результат)
```
</details>
## ПриВыбореРеквизитовОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается после определения реквизитов объекта из формы
// РегистрСведений.ВерсииОбъектов.ВыборРеквизитовОбъекта.
//
// Параметры:
// Ссылка - ЛюбаяСсылка - версионируемый объект конфигурации.
// ДеревоРеквизитов - ДанныеФормыДерево - дерево реквизитов объектов.
//
Процедура ПриВыбореРеквизитовОбъекта(Ссылка, ДеревоРеквизитов) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовПереопределяемый.ПриВыбореРеквизитовОбъекта(Ссылка, ДеревоРеквизитов)
```
</details>
## ПриОпределенииНаименованияРеквизитаОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при получении представления реквизита объекта.
//
// Параметры:
// Ссылка - ЛюбаяСсылка - версионируемый объект конфигурации.
// ИмяРеквизита - Строка - ИмяРеквизита, как оно задано в конфигураторе.
// НаименованиеРеквизита - Строка - выходной параметр, можно переопределить полученный синоним.
// Видимость - Булево - выводить реквизит в отчетах по версиям.
//
Процедура ПриОпределенииНаименованияРеквизитаОбъекта(Ссылка, ИмяРеквизита, НаименованиеРеквизита, Видимость) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовПереопределяемый.ПриОпределенииНаименованияРеквизитаОбъекта(Ссылка, ИмяРеквизита, НаименованиеРеквизита, Видимость)
```
</details>
## ПриПодготовкеДанныхОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Дополняет объект реквизитами, хранящимися отдельно от объекта либо в служебной части самого объекта,
// не предназначенной для вывода в отчетах.
//
// Параметры:
// Объект - СправочникОбъект
// - ДокументОбъект
// - ПланВидовРасчетаОбъект
// - ПланСчетовОбъект
// - ПланВидовХарактеристикОбъект -
// версионируемый объект.
// ДополнительныеРеквизиты - ТаблицаЗначений - коллекция дополнительных реквизитов, которые требуется сохранить вместе
// с версией объекта:
// * Идентификатор - Произвольный - уникальный идентификатор реквизита. Требуется при восстановлении из версии
// объекта в случае, когда значение реквизита хранится отдельно от объекта.
// * Наименование - Строка - название реквизита.
// * Значение - Произвольный - значение реквизита.
//
Процедура ПриПодготовкеДанныхОбъекта(Объект, ДополнительныеРеквизиты) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовПереопределяемый.ПриПодготовкеДанныхОбъекта(Объект, ДополнительныеРеквизиты)
```
</details>
## ПриВосстановленииВерсииОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Восстанавливает значения реквизитов объекта, хранящихся отдельно от объекта.
//
// Параметры:
// Объект - СправочникОбъект
// - ДокументОбъект
// - ПланВидовРасчетаОбъект
// - ПланСчетовОбъект
// - ПланВидовХарактеристикОбъект -
// версионируемый объект:
// * Ссылка - ЛюбаяСсылка
// ДополнительныеРеквизиты - ТаблицаЗначений - коллекция дополнительных реквизитов, которые были сохранены вместе с
// версией объекта:
// * Идентификатор - Произвольный - уникальный идентификатор реквизита.
// * Наименование - Строка - название реквизита.
// * Значение - Произвольный - значение реквизита.
//
Процедура ПриВосстановленииВерсииОбъекта(Объект, ДополнительныеРеквизиты) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовПереопределяемый.ПриВосстановленииВерсииОбъекта(Объект, ДополнительныеРеквизиты)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

61
src/content/docs/bsp/ВерсионированиеОбъектовСобытия.md Normal file
View File

@ -0,0 +1,61 @@
---
title: Версионирование объектов события
slug: bsp/версионирование-объектов-события
---
## ЗаписатьВерсиюОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Записывает версию объекта (кроме документов) в информационную базу.
//
// Параметры:
// Источник - СправочникОбъект - записываемый объект ИБ;
// Отказ - Булево - признак отказа от записи объекта.
//
Процедура ЗаписатьВерсиюОбъекта(Источник, Отказ) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовСобытия.ЗаписатьВерсиюОбъекта(Источник, Отказ)
```
</details>
## ЗаписатьВерсиюДокумента
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Записывает версию документа в информационную базу.
//
// Параметры:
// Источник - ДокументОбъект - записываемый документ ИБ;
// Отказ - Булево - признак отказа от записи документа.
// РежимЗаписи - РежимЗаписиДокумента - позволяет определить выполняется запись, проведение или отмена проведения.
// Изменение значения параметра позволяет изменить режим записи.
// РежимПроведения - РежимПроведенияДокумента - позволяет определить, выполняется оперативное проведение или нет.
// Изменение значения параметра позволяет изменить режим проведения.
//
Процедура ЗаписатьВерсиюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт
```
Пример вызова
```bsl
ВерсионированиеОбъектовСобытия.ЗаписатьВерсиюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

292
src/content/docs/bsp/Взаимодействия.md Normal file
View File

@ -0,0 +1,292 @@
---
title: Взаимодействия
slug: bsp/взаимодействия
---
## УстановитьИспользованиеПочтовогоКлиента
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Включает или выключает почтовый клиент.
//
// Параметры:
// Значение - Булево
//
Процедура УстановитьИспользованиеПочтовогоКлиента(Знач Значение) Экспорт
```
Пример вызова
```bsl
Взаимодействия.УстановитьИспользованиеПочтовогоКлиента(Значение)
```
</details>
## ИспользуетсяПочтовыйКлиент
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет возможность использования почтового клиента.
//
// Возвращаемое значение:
// Булево
//
Функция ИспользуетсяПочтовыйКлиент() Экспорт
```
Пример вызова
```bsl
Результат = Взаимодействия.ИспользуетсяПочтовыйКлиент()
```
</details>
## УстановитьИспользованиеОтправкиПисемВФорматеHTML
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Включает или выключает возможность отправки писем в формате HTML.
// Если выключить, то будет доступна отправка только в текстовом формате.
//
// Параметры:
// Значение - Булево
//
Процедура УстановитьИспользованиеОтправкиПисемВФорматеHTML(Знач Значение) Экспорт
```
Пример вызова
```bsl
Взаимодействия.УстановитьИспользованиеОтправкиПисемВФорматеHTML(Значение)
```
</details>
## ИспользуетсяОтправкаПисемВФорматеHTML
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет возможность использования отправки писем в формате HTML.
//
// Возвращаемое значение:
// Булево
//
Функция ИспользуетсяОтправкаПисемВФорматеHTML() Экспорт
```
Пример вызова
```bsl
Результат = Взаимодействия.ИспользуетсяОтправкаПисемВФорматеHTML()
```
</details>
## УстановитьИспользованиеПрочегоВзаимодействия
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Включает или выключает возможность учета телефонных звонков, SMS-сообщений,
// встреч и планирования взаимодействий.
//
// Параметры:
// Значение - Булево
//
Процедура УстановитьИспользованиеПрочегоВзаимодействия(Знач Значение) Экспорт
```
Пример вызова
```bsl
Взаимодействия.УстановитьИспользованиеПрочегоВзаимодействия(Значение)
```
</details>
## ИспользуютсяПрочиеВзаимодействия
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет возможность использования учета телефонных звонков, SMS-сообщений, встреч и планирования взаимодействий.
//
// Возвращаемое значение:
// Булево
//
Функция ИспользуютсяПрочиеВзаимодействия() Экспорт
```
Пример вызова
```bsl
Результат = Взаимодействия.ИспользуютсяПрочиеВзаимодействия()
```
</details>
## ЗаполнитьРеквизитыПоУмолчанию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается из обработчиков заполнения документов - взаимодействий и предметов заполнения.
// Выполняет необходимые действия по заполнению реквизитов по умолчанию.
//
// Параметры:
// Объект - ДокументОбъект - документ, для которого выполняется заполнение.
// ДанныеЗаполнения - Произвольный - значение,которое используется как основание для заполнения.
//
Процедура ЗаполнитьРеквизитыПоУмолчанию(Объект, ДанныеЗаполнения) Экспорт
```
Пример вызова
```bsl
Взаимодействия.ЗаполнитьРеквизитыПоУмолчанию(Объект, ДанныеЗаполнения)
```
</details>
## ПриЗаписиПредметаИзФормы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устанавливает во всей цепочке взаимодействий в качестве предмета созданный объект.
//
// Параметры:
// Предмет - ОпределяемыйТип.ПредметВзаимодействия - созданный предмет взаимодействий.
// Взаимодействие - ДокументСсылка - взаимодействие, по которому создан предмет.
// Отказ - Булево - флаг отказа от операции.
//
Процедура ПриЗаписиПредметаИзФормы(Предмет, Взаимодействие, Отказ) Экспорт
```
Пример вызова
```bsl
Взаимодействия.ПриЗаписиПредметаИзФормы(Предмет, Взаимодействие, Отказ)
```
</details>
## ПодготовитьОповещения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет подготовку оповещения при создании на сервере документа взаимодействий.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма, из которой будет отправлено оповещение.
// Параметры - Структура - параметры создания формы документа взаимодействий.
// ИспользоватьВзаимодействиеОснование - Булево - признак необходимости учитывать документ-основание.
//
Процедура ПодготовитьОповещения(Форма, Параметры, ИспользоватьВзаимодействиеОснование = Истина) Экспорт
```
Пример вызова
```bsl
Взаимодействия.ПодготовитьОповещения(Форма, Параметры, ИспользоватьВзаимодействиеОснование);
```
</details>
## УстановитьПризнакАктивен
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устанавливает признак активности предмета.
//
// Параметры:
// Предмет - ДокументСсылка
// - СправочникСсылка - предмет, для которого выполняется запись.
// Активен - Булево - признак активности предмета.
//
Процедура УстановитьПризнакАктивен(Предмет, Активен) Экспорт
```
Пример вызова
```bsl
Взаимодействия.УстановитьПризнакАктивен(Предмет, Активен)
```
</details>
## ЗаполнитьНаборыЗначенийДоступаПоУмолчанию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполняет наборы значений доступа к документам подсистемы значениями по умолчанию.
// Для использования в процедуре ВзаимодействияПереопределяемый.ПриЗаполненииНаборовЗначенийДоступа.
// С ее помощью можно объединять прикладной набор значений доступа к документам подсистемы
// со стандартным заполнением по умолчанию.
//
// Параметры:
// Объект - ДокументОбъект.Встреча
// - ДокументОбъект.ЗапланированноеВзаимодействие
// - ДокументОбъект.СообщениеSMS
// - ДокументОбъект.ТелефонныйЗвонок
// - ДокументОбъект.ЭлектронноеПисьмоВходящее
// - ДокументОбъект.ЭлектронноеПисьмоИсходящее - объект, для которого заполняются наборы.
// Таблица - см. УправлениеДоступом.ТаблицаНаборыЗначенийДоступа
//
Процедура ЗаполнитьНаборыЗначенийДоступаПоУмолчанию(Объект, Таблица) Экспорт
```
Пример вызова
```bsl
Взаимодействия.ЗаполнитьНаборыЗначенийДоступаПоУмолчанию(Объект, Таблица)
```
</details>
## ПредметВзаимодействия
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает предмет взаимодействия.
//
// Параметры:
// Взаимодействие - ДокументСсылка.Встреча,
// - ДокументСсылка.ЗапланированноеВзаимодействие,
// - ДокументСсылка.ТелефонныйЗвонок,
// - ДокументСсылка.СообщениеSMS,
// - ДокументСсылка.ЭлектронноеПисьмоВходящее,
// - ДокументСсылка.ЭлектронноеПисьмоИсходящее
//
// Возвращаемое значение:
// ОпределяемыйТип.ПредметВзаимодействия
//
Функция ПредметВзаимодействия(Взаимодействие) Экспорт
```
Пример вызова
```bsl
Результат = Взаимодействия.ПредметВзаимодействия(Взаимодействие)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

192
src/content/docs/bsp/ВзаимодействияКлиент.md Normal file
View File

@ -0,0 +1,192 @@
---
title: Взаимодействия клиент
slug: bsp/взаимодействия-клиент
---
## ОткрытьФормуОтправкиSMS
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму нового документа "Сообщение SMS" с переданными параметрами.
//
// Параметры:
// ПараметрыФормы - см. ВзаимодействияКлиент.ПараметрыФормыОтправкиSMS.
// УдалитьТекст - Строка - не используется.
// УдалитьПредмет - ЛюбаяСсылка - не используется.
// УдалитьОтправлятьВТранслите - Булево - не используется.
//
Процедура ОткрытьФормуОтправкиSMS(Знач ПараметрыФормы = Неопределено, Экспорт
```
Пример вызова
```bsl
ВзаимодействияКлиент.ОткрытьФормуОтправкиSMS(ПараметрыФормы, );
```
</details>
## ПараметрыФормыОтправкиSMS
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает параметры для передачи в ВзаимодействияКлиент.ОткрытьФормуОтправкиSMS.
//
// Возвращаемое значение:
// Структура:
// * Адресаты - Строка
// - СписокЗначений
// - Массив - список получателей письма.
// * Текст - Строка - текст письма.
// * Предмет - ЛюбаяСсылка - предмет письма.
// * ОтправлятьВТранслите - Булево - признак того, что сообщение при отправке должно быть преобразовано в латинские
// символы.
//
Функция ПараметрыФормыОтправкиSMS() Экспорт
```
Пример вызова
```bsl
Результат = ВзаимодействияКлиент.ПараметрыФормыОтправкиSMS()
```
</details>
## КонтактПослеЗаписи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик для события формы ПослеЗаписиНаСервере. Вызывается для контакта.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма, для которой обрабатывается событие.
// Объект - ДанныеФормыКоллекция - данные объекта хранимые в форме.
// ПараметрыЗаписи - Структура - структура, в которую добавляются параметры, которые потом будут
// посланы с оповещением.
// ИмяОбъектаОтправителяСообщения - Строка - имя объекта метаданных, для формы которого обрабатывается событие.
// ПосылатьОповещение - Булево - признак необходимости отправки оповещения из этой процедуры.
//
Процедура КонтактПослеЗаписи(Форма,Объект,ПараметрыЗаписи,ИмяОбъектаОтправителяСообщения,ПосылатьОповещение = Истина) Экспорт
```
Пример вызова
```bsl
ВзаимодействияКлиент.КонтактПослеЗаписи(Форма, Объект, ПараметрыЗаписи, ИмяОбъектаОтправителяСообщения, ПосылатьОповещение);
```
</details>
## ВзаимодействиеПредметПослеЗаписи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик для события формы ПослеЗаписиНаСервере. Вызывается для взаимодействия или предмета взаимодействия.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма, для которой обрабатывается событие.
// Объект - ОпределяемыйТип.ПредметВзаимодействия - данные объекта хранимые в форме.
// ПараметрыЗаписи - Структура - структура, в которую добавляются параметры, которые потом будут
// посланы с оповещением.
// ИмяОбъектаОтправителяСообщения - Строка - имя объекта метаданных, для формы которого обрабатывается событие.
// ПосылатьОповещение - Булево - признак необходимости отправки оповещения из этой процедуры.
//
Процедура ВзаимодействиеПредметПослеЗаписи(Форма,Объект,ПараметрыЗаписи,ИмяОбъектаОтправителяСообщения = "",ПосылатьОповещение = Истина) Экспорт
```
Пример вызова
```bsl
ВзаимодействияКлиент.ВзаимодействиеПредметПослеЗаписи(Форма, Объект, ПараметрыЗаписи, ИмяОбъектаОтправителяСообщения, ПосылатьОповещение);
```
</details>
## СписокПредметПроверкаПеретаскивания
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик для события формы ПроверкаПеретаскивания. Вызывается для списка предметов при перетаскивании в него взаимодействий.
//
// Параметры:
// Элемент - ТаблицаФормы - таблица, для которой обрабатывается событие.
// ПараметрыПеретаскивания - ПараметрыПеретаскивания - содержит перетаскиваемое значение, тип действия и возможные
// действия при перетаскивании.
// СтандартнаяОбработка - Булево - признак стандартной обработки события.
// СтрокаТаблицы - ДанныеФормыЭлементКоллекции - строка таблицы, над которой находится курсор.
// Поле - Поле - элемент управляемой формы, с которым связана данная колонка таблицы.
//
Процедура СписокПредметПроверкаПеретаскивания(Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка, СтрокаТаблицы, Поле) Экспорт
```
Пример вызова
```bsl
ВзаимодействияКлиент.СписокПредметПроверкаПеретаскивания(Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка, СтрокаТаблицы, Поле)
```
</details>
## СписокПредметПеретаскивание
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик для события формы Перетаскивание. Вызывается для списка предметов при перетаскивании в него взаимодействий.
//
// Параметры:
// Элемент - ТаблицаФормы - таблица, для которой обрабатывается событие.
// ПараметрыПеретаскивания - ПараметрыПеретаскивания - содержит перетаскиваемое значение, тип действия и возможные
// действия при перетаскивании.
// СтандартнаяОбработка - Булево - признак стандартной обработки события.
// СтрокаТаблицы - ДанныеФормыЭлементКоллекции - строка таблицы, над которой находится курсор.
// Поле - Поле - элемент управляемой формы, с которым связана данная колонка таблицы.
//
Процедура СписокПредметПеретаскивание(Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка, СтрокаТаблицы, Поле) Экспорт
```
Пример вызова
```bsl
ВзаимодействияКлиент.СписокПредметПеретаскивание(Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка, СтрокаТаблицы, Поле)
```
</details>
## СохранитьПисьмоНаДиск
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Сохраняет письмо на компьютер.
//
// Параметры:
// Письмо - ДокументСсылка.ЭлектронноеПисьмоВходящее
// - ДокументСсылка.ЭлектронноеПисьмоИсходящее - письмо, которое будет сохранено.
// УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор формы, из которой была вызвана команда сохранения.
//
Процедура СохранитьПисьмоНаДиск(Письмо, УникальныйИдентификатор) Экспорт
```
Пример вызова
```bsl
ВзаимодействияКлиент.СохранитьПисьмоНаДиск(Письмо, УникальныйИдентификатор)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

52
src/content/docs/bsp/ВзаимодействияКлиентПереопределяемый.md Normal file
View File

@ -0,0 +1,52 @@
---
title: Взаимодействия клиент переопределяемый
slug: bsp/взаимодействия-клиент-переопределяемый
---
## СоздатьКонтактНестандартнаяФорма
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВзаимодействияКлиентСерверПереопределяемый.ПриОпределенииВозможныхКонтактов.
// См. свойство ИмяФормыНовогоКонтакта параметра ТипыКонтактов.
//
// Вызывается при создании нового контакта.
// Используется, если для одного или нескольких видов контактов требуется,
// чтобы вместо основной формы при их создании открывалась другая форма.
// Например, это может быть форма помощника создания нового элемента справочника.
//
// Параметры:
// ТипКонтакта - Строка - имя справочника контакта.
// ПараметрФормы - Структура - параметр, который передается при открытии.
//
// Возвращаемое значение:
// Булево - Ложь, если открытие нестандартной формы не выполнено, Истина в обратном случае.
//
// Пример:
// Если ТипКонтакта = "Партнеры" Тогда
// ОткрытьФорму("Справочник.Партнеры.Форма.ПомощникНового", ПараметрФормы);
// Возврат Истина;
// КонецЕсли;
//
// Возврат Ложь;
//
Функция СоздатьКонтактНестандартнаяФорма(ТипКонтакта, ПараметрФормы) Экспорт
```
Пример вызова
```bsl
Результат = ВзаимодействияКлиентПереопределяемый.СоздатьКонтактНестандартнаяФорма(ТипКонтакта, ПараметрФормы)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

90
src/content/docs/bsp/ВзаимодействияКлиентСервер.md Normal file
View File

@ -0,0 +1,90 @@
---
title: Взаимодействия клиент сервер
slug: bsp/взаимодействия-клиент-сервер
---
## НовоеОписаниеКонтакта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает новое описание контакта взаимодействий.
// Для использования в ВзаимодействияКлиентСерверПереопределяемый.ПриОпределенииВозможныхКонтактов.
//
// Возвращаемое значение:
// Структура - свойства контакта взаимодействий:
// * Тип - Тип - тип ссылки контакта.
// * Имя - Строка - имя типа контакта , как оно определено в метаданных.
// * Представление - Строка - представление типа контакта для отображения пользователю.
// * Иерархический - Булево - признак того, является ли справочник иерархическим.
// * ЕстьВладелец - Булево - признак того, что у контакта есть владелец.
// * ИмяВладельца - Строка - имя владельца контакта, как оно определено в метаданных.
// * ИскатьПоДомену - Булево - признак того, что контакты данного типа будет подбираться
// по совпадению домена, а не по полному адресу электронной почты.
// * Связь - Строка - описывает возможную связь данного контакта с другим контактом, в
// случае когда текущий контакт является реквизитом другого контакта.
// Описывается следующей строкой "ИмяТаблицы.ИмяРеквизита".
// * ИмяРеквизитаПредставлениеКонтакта - Строка - имя реквизита контакта, из которого будет получено
// представление контакта. Если не указано, то используется
// стандартный реквизит Наименование.
// * ВозможностьИнтерактивногоСоздания - Булево - признак возможности интерактивного создания контакта из
// документов - взаимодействий.
// * ИмяФормыНовогоКонтакта - Строка - полное имя формы для создания нового контакта,
// например, "Справочник.Партнеры.Форма.ПомощникНового".
// Если не заполнено, то открывается форма элемента по умолчанию.
//
Функция НовоеОписаниеКонтакта() Экспорт
```
Пример вызова
```bsl
Результат = ВзаимодействияКлиентСервер.НовоеОписаниеКонтакта()
```
</details>
## ДобавитьЭлементМассиваОписанияВозможныхТиповКонтактов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВзаимодействияКлиентСервер.НовоеОписаниеКонтакта.
// Добавляет элемент в массив структур контакта.
//
// Параметры:
// МассивОписания - Массив - массив, в который будут добавлена структура описания контакта.
// Тип - Тип - тип ссылки контакта.
// ВозможностьИнтерактивногоСоздания - Булево - признак возможности интерактивного создания контакта из документов -
// взаимодействий.
// Имя - Строка - имя типа контакта , как оно определено в метаданных.
// Представление - Строка - представление типа контакта для отображения пользователю.
// Иерархический - Булево - признак того, является ли справочник иерархическим.
// ЕстьВладелец - Булево - признак того, что у контакта есть владелец.
// ИмяВладельца - Строка - имя владельца контакта, как оно определено в метаданных.
// ИскатьПоДомену - Булево - признак того, что по данному типу контакта будет осуществляться
// поиск по домену.
// Связь - Строка - описывает возможную связь данного контакта с другим контактом, в
// случае когда текущий контакт является реквизитом другого контакта.
// Описывается следующей строкой "ИмяТаблицы.ИмяРеквизита".
// ИмяРеквизитаПредставлениеКонтакта - Строка - имя реквизита контакта, из которого будет получено представление контакта.
//
Процедура ДобавитьЭлементМассиваОписанияВозможныхТиповКонтактов( Экспорт
```
Пример вызова
```bsl
ВзаимодействияКлиентСервер.ДобавитьЭлементМассиваОписанияВозможныхТиповКонтактов();
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

78
src/content/docs/bsp/ВзаимодействияКлиентСерверПереопределяемый.md Normal file
View File

@ -0,0 +1,78 @@
---
title: Взаимодействия клиент сервер переопределяемый
slug: bsp/взаимодействия-клиент-сервер-переопределяемый
---
## ПриОпределенииВозможныхПредметов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Задает типы предметов взаимодействий, например: заказы, вакансии и т.п.
// Используется, если в конфигурации определен хотя бы один предмет взаимодействий.
//
// Параметры:
// ТипыПредметов - Массив - предметы взаимодействий (Строка),
// например, "ДокументСсылка.ЗаказПокупателя" и т.п.
//
Процедура ПриОпределенииВозможныхПредметов(ТипыПредметов) Экспорт
```
Пример вызова
```bsl
ВзаимодействияКлиентСерверПереопределяемый.ПриОпределенииВозможныхПредметов(ТипыПредметов)
```
</details>
## ПриОпределенииВозможныхКонтактов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Задает описания возможных типов контактов взаимодействий, например: партнеры, контактные лица и т.п.
// Используется, если в конфигурации определен хотя бы один тип контактов взаимодействий,
// помимо справочника Пользователи.
//
// Параметры:
// ТипыКонтактов - Массив - содержит описания типов контактов взаимодействий (Структура) и их свойства:
// * Тип - Тип - тип ссылки контакта.
// * Имя - Строка - имя типа контакта , как оно определено в метаданных.
// * Представление - Строка - представление типа контакта для отображения пользователю.
// * Иерархический - Булево - признак того, является ли справочник иерархическим.
// * ЕстьВладелец - Булево - признак того, что у контакта есть владелец.
// * ИмяВладельца - Строка - имя владельца контакта, как оно определено в метаданных.
// * ИскатьПоДомену - Булево - признак того, что контакты данного типа будет подбираться
// по совпадению домена, а не по полному адресу электронной почты.
// * Связь - Строка - описывает возможную связь данного контакта с другим контактом, в
// случае когда текущий контакт является реквизитом другого контакта.
// Описывается следующей строкой "ИмяТаблицы.ИмяРеквизита".
// * ИмяРеквизитаПредставлениеКонтакта - Строка - имя реквизита контакта, из которого будет получено
// представление контакта. Если не указано, то используется
// стандартный реквизит Наименование.
// * ВозможностьИнтерактивногоСоздания - Булево - признак возможности интерактивного создания контакта из
// документов - взаимодействий.
// * ИмяФормыНовогоКонтакта - Строка - полное имя формы для создания нового контакта.
// Например, "Справочник.Партнеры.Форма.ПомощникНового".
// Если не заполнено, то открывается форма элемента по умолчанию.
//
Процедура ПриОпределенииВозможныхКонтактов(ТипыКонтактов) Экспорт
```
Пример вызова
```bsl
ВзаимодействияКлиентСерверПереопределяемый.ПриОпределенииВозможныхКонтактов(ТипыКонтактов)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

83
src/content/docs/bsp/ВзаимодействияЛокализация.md Normal file
View File

@ -0,0 +1,83 @@
---
title: Взаимодействия локализация
slug: bsp/взаимодействия-локализация
---
## ПриФорматированииТелефонногоНомераДляОтправки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возможность преобразовать указанный пользователем телефонный номер, в формат, который принимает провайдер отправки SMS
//
// Параметры:
// Номер - Строка - телефонный номер, указанный пользователем,
// НомерДляОтправки - Строка - в данный параметр помещается результат преобразования
//
Процедура ПриФорматированииТелефонногоНомераДляОтправки(Номер, НомерДляОтправки) Экспорт
```
Пример вызова
```bsl
ВзаимодействияЛокализация.ПриФорматированииТелефонногоНомераДляОтправки(Номер, НомерДляОтправки)
```
</details>
## ПриОпределенииИгнорируемыхИменПапокПриЗагрузкеПисем
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возможность дополнить массив имен папок, которые будут игнорироваться при загрузке писем с почтового сервера по
// протоколу IMAP.
//
// Параметры:
// ИменаПапок - Массив из Строка - массив имен игнорируемых папок.
//
Процедура ПриОпределенииИгнорируемыхИменПапокПриЗагрузкеПисем(ИменаПапок) Экспорт
```
Пример вызова
```bsl
ВзаимодействияЛокализация.ПриОпределенииИгнорируемыхИменПапокПриЗагрузкеПисем(ИменаПапок)
```
</details>
## ПриОпределенииСинонимовДоменовЭлектроннойПочты
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Дополняет соответствие идентичных (подменяемых) доменов электронной почты.
// Используется при определении того, что письмо отправлено на почтовый ящик отправителя.
// Может потребоваться при загрузке исходящего письма по протоколу IMAP.
// При отправке такого письма почтовый сервер мог указать в адресе отправителя другой домен.
//
// Параметры:
// СинонимыДоменовЭлектроннойПочты - Соответствие из КлючИЗначение:
// * Ключ - имя, которое нужно заменить
// * Значение - имя домена, на который нужно заменить
//
Процедура ПриОпределенииСинонимовДоменовЭлектроннойПочты(СинонимыДоменовЭлектроннойПочты) Экспорт
```
Пример вызова
```bsl
ВзаимодействияЛокализация.ПриОпределенииСинонимовДоменовЭлектроннойПочты(СинонимыДоменовЭлектроннойПочты)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

154
src/content/docs/bsp/ВзаимодействияПереопределяемый.md Normal file
View File

@ -0,0 +1,154 @@
---
title: Взаимодействия переопределяемый
slug: bsp/взаимодействия-переопределяемый
---
## ПриПоискеКонтактов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается для получения контактов (участников) по указанному предмету взаимодействия.
// Используется, если в конфигурации определен хотя бы один предмет взаимодействий.
//
// Параметры:
// ИмяТаблицыКонтактов - Строка - имя таблицы предмета взаимодействий, в котором требуется выполнить поиск.
// Например, "Документы.ЗаказПокупателя".
// ТекстЗапросаДляПоиска - Строка - в этот параметр указать фрагмент запроса для поиска. При выполнении запроса
// в параметр запроса &Предмет подставляется ссылка на предмет взаимодействия.
//
Процедура ПриПоискеКонтактов(Знач ИмяТаблицыКонтактов, ТекстЗапросаДляПоиска) Экспорт
```
Пример вызова
```bsl
ВзаимодействияПереопределяемый.ПриПоискеКонтактов(ИмяТаблицыКонтактов, ТекстЗапросаДляПоиска)
```
</details>
## ПриПолученииПрисоединенныхФайлов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет переопределить владельца присоединенных файлов для письма.
// Такая необходимость может возникнуть, например, при массовых рассылках, когда имеет смысл
// хранить одни и те же присоединенные файлы в одном месте, а не тиражировать их на все письма рассылки.
//
// Параметры:
// Письмо - ДокументСсылка.ЭлектронноеПисьмоВходящее
// - ДокументСсылка.ЭлектронноеПисьмоИсходящее - электронное письмо,
// для которого необходимо получить вложения.
// ПрисоединенныеФайлы - Структура - задать сведения о файлах, присоединенных к письму:
// * ВладелецФайлов - ОпределяемыйТип.ПрисоединенныйФайл - владелец присоединенных файлов.
// * ИмяСправочникаПрисоединенныхФайлов - Строка - имя объекта метаданных присоединенных файлов.
//
Процедура ПриПолученииПрисоединенныхФайлов(Письмо, ПрисоединенныеФайлы) Экспорт
```
Пример вызова
```bsl
ВзаимодействияПереопределяемый.ПриПолученииПрисоединенныхФайлов(Письмо, ПрисоединенныеФайлы)
```
</details>
## ПриЗаполненииНаборовЗначенийДоступа
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается для настройки логики ограничения доступа к взаимодействиям.
// Пример заполнения наборов значений доступа см. в комментарии
// к процедуре УправлениеДоступом.ЗаполнитьНаборыЗначенийДоступа.
//
// Параметры:
// Объект - ДокументОбъект.Встреча
// - ДокументОбъект.ЗапланированноеВзаимодействие
// - ДокументОбъект.СообщениеSMS
// - ДокументОбъект.ТелефонныйЗвонок
// - ДокументОбъект.ЭлектронноеПисьмоВходящее
// - ДокументОбъект.ЭлектронноеПисьмоИсходящее - объект, для которого нужно заполнить наборы.
// Таблица - см. УправлениеДоступом.ТаблицаНаборыЗначенийДоступа
//
Процедура ПриЗаполненииНаборовЗначенийДоступа(Объект, Таблица) Экспорт
```
Пример вызова
```bsl
ВзаимодействияПереопределяемый.ПриЗаполненииНаборовЗначенийДоступа(Объект, Таблица)
```
</details>
## ТекстЗапросаПоискКонтактовПоПредмету
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВзаимодействияПереопределяемый.ПриПоискеКонтактов.
// Возвращает текст запроса, отбирающего контакты (участников) предмета взаимодействия.
// Используется, если в конфигурации определен хотя бы один предмет взаимодействий.
//
// Параметры:
// УдалитьПомещатьВоВременнуюТаблицу - Булево - всегда Ложь.
// ИмяТаблицы - Строка - имя таблицы предмета взаимодействий, в котором будет выполнен поиск.
// УдалитьОбъединить - Булево - всегда Истина.
//
// Возвращаемое значение:
// Строка - текст запроса.
//
Функция ТекстЗапросаПоискКонтактовПоПредмету(УдалитьПомещатьВоВременнуюТаблицу, ИмяТаблицы, УдалитьОбъединить = Ложь) Экспорт
```
Пример вызова
```bsl
Результат = ВзаимодействияПереопределяемый.ТекстЗапросаПоискКонтактовПоПредмету(УдалитьПомещатьВоВременнуюТаблицу, ИмяТаблицы, УдалитьОбъединить);
```
</details>
## ДанныеОбъектаМетаданныхПрисоединенныхФайловПисьма
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВзаимодействияПереопределяемый.ПриПолученииПрисоединенныхФайлов.
// Возможность переопределить владельца присоединенных файлов для письма.
// Такая необходимость может возникнуть например при массовых рассылках. В этом случае имеет смысл
// хранить одни и те же присоединенные файлы в одном месте, а не тиражировать их на все письма рассылки.
//
// Параметры:
// Письмо - ДокументСсылка
// - ДокументОбъект - документ электронное письмо, для которого необходимо получить вложения.
//
// Возвращаемое значение:
// Структура, Неопределено - Неопределено, если присоединенные файлы хранятся при письме.
// Структура, если присоединенные файлы хранятся в другом объекте:
// * Владелец - ОпределяемыйТип.ПрисоединенныйФайл - владелец присоединенных файлов.
// * ИмяСправочникаПрисоединенныеФайлы - Строка - имя объекта метаданных присоединенных файлов.
//
Функция ДанныеОбъектаМетаданныхПрисоединенныхФайловПисьма(Письмо) Экспорт
```
Пример вызова
```bsl
Результат = ВзаимодействияПереопределяемый.ДанныеОбъектаМетаданныхПрисоединенныхФайловПисьма(Письмо)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

277
src/content/docs/bsp/ВидыПриложенийПереопределяемый.md Normal file
View File

@ -0,0 +1,277 @@
---
title: Виды приложений переопределяемый
slug: bsp/виды-приложений-переопределяемый
---
## ПриОпределенииВидовПриложенийКонфигурации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Формирует таблицу видов приложений конфигурации.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// ВидыПриложений - см. ВидыПриложенийСервер.НоваяТаблицаВидовПриложений.
//
Процедура ПриОпределенииВидовПриложенийКонфигурации(ВидыПриложений) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПриОпределенииВидовПриложенийКонфигурации(ВидыПриложений)
```
</details>
## ПриОпределенииДопСвойствБазовогоВидаПриложения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет дополнительные свойства базового вида приложения
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// ДополнительныеСвойства - Структура.
//
Процедура ПриОпределенииДопСвойствБазовогоВидаПриложения(ДополнительныеСвойства) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПриОпределенииДопСвойствБазовогоВидаПриложения(ДополнительныеСвойства)
```
</details>
## ПриОпределенииВидаПриложенияПоУмолчанию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает вид приложения, который будет установлен по умолчанию,
// если, например, не удалось определить вид приложения по имени или услугам.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// ВидПриложения - Структура - см. ВидыПриложенийСервер.НовыйВидПриложения (возвращаемые данные).
//
Процедура ПриОпределенииВидаПриложенияПоУмолчанию(ВидПриложения) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПриОпределенииВидаПриложенияПоУмолчанию(ВидПриложения)
```
</details>
## ПриДобавленииОбработчиковПереходаВидовПриложений
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Добавляет в таблицу процедуры-обработчики перехода от одного вида приложения к другому.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Обработчики - ТаблицаЗначений:
// * ИсходноеИмяВидаПриложения - Строка - имя вида приложения, с которого выполняется переход.
// * ИмяВидаПриложения - Строка - имя вида приложения, на который выполняется переход.
// * Процедура - Строка - полное имя процедуры-обработчика перехода.
// Обязательно должна быть экспортной.
// Примечание:
// Если отсутствует хотя бы один обработчик с предыдущего до целевого вида приложения, переход будет невозможен
//
Процедура ПриДобавленииОбработчиковПереходаВидовПриложений(Обработчики) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПриДобавленииОбработчиковПереходаВидовПриложений(Обработчики)
```
</details>
## ПриУстановкеБазовогоВидаПриложения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при установке базового вида приложения.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные):
// * Ошибка - Булево - признак ошибки обработки. По умолчанию = Ложь.
// * Сообщение - Строка - сообщение об ошибке обработки.
//
Процедура ПриУстановкеБазовогоВидаПриложения(РезультатОбработки) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПриУстановкеБазовогоВидаПриложения(РезультатОбработки)
```
</details>
## ПриОтменеУстановкиБазовогоВидаПриложения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при отмене установки базового вида приложения.
// Отмена установки базового вида приложения происходит, если выполняется установка постоянного вида приложения.
// Процедура должна вернуть данные, измененные при установке базового вида приложения, в исходное состояние.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные):
// * Ошибка - Булево - признак ошибки обработки. По умолчанию = Ложь.
// * Сообщение - Строка - сообщение об ошибке обработки.
//
Процедура ПриОтменеУстановкиБазовогоВидаПриложения(РезультатОбработки) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПриОтменеУстановкиБазовогоВидаПриложения(РезультатОбработки)
```
</details>
## ПослеУстановкиВидаПриложения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается после установки вида приложения.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// ВидПриложения - Строка - имя вида приложения.
// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные):
// * Ошибка - Булево - признак ошибки обработки. По умолчанию = Ложь.
// * Сообщение - Строка - сообщение об ошибке обработки.
//
Процедура ПослеУстановкиВидаПриложения(ВидПриложения, РезультатОбработки) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПослеУстановкиВидаПриложения(ВидПриложения, РезультатОбработки)
```
</details>
## ПередПереходомНаВидПриложения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается перед процедурами-обработчиками перехода на новый вид приложения.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// ВидПриложения - Строка - имя вида приложения, с которого выполняется переход.
// ЦелевойВидПриложения - Строка - имя вида приложения, на который выполняется переход.
// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные):
// * Ошибка - Булево - признак ошибки обработки. По умолчанию = Ложь.
// * Сообщение - Строка - сообщение об ошибке обработки.
//
Процедура ПередПереходомНаВидПриложения(ВидПриложения, ЦелевойВидПриложения, РезультатОбработки) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПередПереходомНаВидПриложения(ВидПриложения, ЦелевойВидПриложения, РезультатОбработки)
```
</details>
## ПослеПереходаНаВидПриложения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается после завершения перехода на новый вид приложения.
// @skip-warning ПустойМетод - переопределяемый метод.
// Параметры:
// ВидПриложения - Строка - имя вида приложения, с которого выполнен переход.
// ЦелевойВидПриложения - Строка - имя вида приложения, на который выполнен переход.
// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные):
// * Ошибка - Булево - признак ошибки обработки. По умолчанию = Ложь.
// * Сообщение - Строка - сообщение об ошибке обработки.
//
Процедура ПослеПереходаНаВидПриложения(ВидПриложения, ЦелевойВидПриложения, РезультатОбработки) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПослеПереходаНаВидПриложения(ВидПриложения, ЦелевойВидПриложения, РезультатОбработки)
```
</details>
## ПриОпределенииПараметровУведомления
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет параметры уведомления об обновлении вида приложения.
// @skip-warning ПустойМетод - переопределяемый метод.
// Параметры:
// ПараметрыУведомления - см. ВидыПриложенийСервер.НовыйПараметрыУведомленияОбОбновлении.
//
Процедура ПриОпределенииПараметровУведомления(ПараметрыУведомления) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПриОпределенииПараметровУведомления(ПараметрыУведомления)
```
</details>
## ПриОпределенииИменРасширенийВидовПриложений
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет массив имен расширений видов приложений, которые будут исключены из выгрузки
//
// @skip-warning ПустойМетод - переопределяемый метод.
// Параметры:
// ИменаРасширений - Массив из Строка
//
Процедура ПриОпределенииИменРасширенийВидовПриложений(ИменаРасширений) Экспорт
```
Пример вызова
```bsl
ВидыПриложенийПереопределяемый.ПриОпределенииИменРасширенийВидовПриложений(ИменаРасширений)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

233
src/content/docs/bsp/ВидыПриложенийСервер.md Normal file
View File

@ -0,0 +1,233 @@
---
title: Виды приложений сервер
slug: bsp/виды-приложений-сервер
---
## ВидыПриложенийКонфигурации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает таблицу видов приложений конфигурации.
//
// Параметры:
// ВключаяБазовый - Булево - Истина, если нужно включать базовый вид приложения в таблицу.
// По умолчанию = Истина.
//
// Возвращаемое значение:
// ТаблицаЗначений - см. НоваяТаблицаВидовПриложений
//
Функция ВидыПриложенийКонфигурации(ВключаяБазовый = Истина) Экспорт
```
Пример вызова
```bsl
Результат = ВидыПриложенийСервер.ВидыПриложенийКонфигурации(ВключаяБазовый);
```
</details>
## ОбработчикиПереходов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает таблицу обработчиков переходов видов приложений конфигурации
//
// Возвращаемое значение:
// ТаблицаЗначений - см. НоваяТаблицаОбработчиковПерехода
//
Функция ОбработчикиПереходов() Экспорт
```
Пример вызова
```bsl
Результат = ВидыПриложенийСервер.ОбработчикиПереходов()
```
</details>
## ОбработчикиПереходаВидаПриложения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает таблицу обработчиков перехода с вида приложения
//
// Параметры:
// ИсходноеИмяВидаПриложения - Строка - имя предыдущего вида приложения
// ИмяВидаПриложения - Строка, Неопределено - имя нового вида приложения. Неопределено - если новый вид приложения любой.
// По умолчанию, Неопределено
//
// Возвращаемое значение:
// ТаблицаЗначений - см. НоваяТаблицаОбработчиковПерехода
//
Функция ОбработчикиПереходаВидаПриложения(ИсходноеИмяВидаПриложения, ИмяВидаПриложения = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ВидыПриложенийСервер.ОбработчикиПереходаВидаПриложения(ИсходноеИмяВидаПриложения, ИмяВидаПриложения);
```
</details>
## ИмяТекущегоВидаПриложения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает имя вида приложения конфигурации, автономного рабочего места (АРМ) или области данных, если включено разделение
//
// Возвращаемое значение:
// Строка - имя текущего вида приложения
//
// Примечание:
// Имя вида приложения для АРМ может отличаться от итогового, если обращение к функции было до завершения загрузки данных в АРМ
//
Функция ИмяТекущегоВидаПриложения() Экспорт
```
Пример вызова
```bsl
Результат = ВидыПриложенийСервер.ИмяТекущегоВидаПриложения()
```
</details>
## ПредставлениеТекущегоВидаПриложения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает представление вида приложения конфигурации, автономного рабочего места (АРМ) или области данных, если включено разделение
//
// Возвращаемое значение:
// Строка - представление вида приложения
//
// Примечание:
// Представление вида приложения для АРМ может отличаться от итогового, если обращение к функции было до завершения загрузки данных в АРМ
//
Функция ПредставлениеТекущегоВидаПриложения() Экспорт
```
Пример вызова
```bsl
Результат = ВидыПриложенийСервер.ПредставлениеТекущегоВидаПриложения()
```
</details>
## СвойстваВидаПриложенияПоИмени
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает свойства вида приложения по имени.
//
// Параметры:
// Имя - Строка - имя вида приложения, свойства которого нужно получить.
// ВызыватьИсключение - Булево - если Ложь, то в случае отсутствия свойств вида приложения по имени
// исключение не будет вызвано. По умолчанию = Истина.
//
// Возвращаемое значение:
// Неопределено, ФиксированнаяСтруктура - Свойства вида приложения.
// Если свойства не найдены и ВызыватьИсключение = Ложь, возвращается Неопределено.
// Состав свойств см. в ВидыПриложенийСервер.НовыйВидПриложения.
//
Функция СвойстваВидаПриложенияПоИмени(Имя, ВызыватьИсключение = Истина) Экспорт
```
Пример вызова
```bsl
Результат = ВидыПриложенийСервер.СвойстваВидаПриложенияПоИмени(Имя, ВызыватьИсключение);
```
</details>
## СвойстваВидаПриложенияПоУслугам
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает свойства вида приложения по услугам.
// Поиск происходит по полному соответствию услуг в переданном параметре и описании вида приложения
//
// Параметры:
// Услуги - ТаблицаЗначений - описание см.НоваяТаблицаУслуг
// ВызыватьИсключение - Булево - если Ложь, то в случае отсутствия свойств вида приложения по услугам
// исключение не будет вызвано. По умолчанию, Истина.
//
// Возвращаемое значение:
// Неопределено, ФиксированнаяСтруктура - Свойства вида приложения.
// Если свойства не найдены и ВызыватьИсключение = Ложь, возвращается Неопределено.
// Состав свойств см. в ВидыПриложенийСервер.НовыйВидПриложения.
//
Функция СвойстваВидаПриложенияПоУслугам(Услуги, ВызыватьИсключение = Истина) Экспорт
```
Пример вызова
```bsl
Результат = ВидыПриложенийСервер.СвойстваВидаПриложенияПоУслугам(Услуги, ВызыватьИсключение);
```
</details>
## БазовыйВидПриложения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает вид приложения, соответствующий конфигурации.
//
// Возвращаемое значение:
// ФиксированнаяСтруктура - см. НовыйВидПриложения
//
Функция БазовыйВидПриложения() Экспорт
```
Пример вызова
```bsl
Результат = ВидыПриложенийСервер.БазовыйВидПриложения()
```
</details>
## ВидПриложенияПоУмолчанию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает вид приложения, который будет установлен по умолчанию,
// если, например, не удалось определить вид приложения по имени или услугам.
//
// Возвращаемое значение:
// ФиксированнаяСтруктура - см. НовыйВидПриложения
//
Функция ВидПриложенияПоУмолчанию() Экспорт
```
Пример вызова
```bsl
Результат = ВидыПриложенийСервер.ВидПриложенияПоУмолчанию()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

57
src/content/docs/bsp/ВнешниеКомпонентыВызовСервера.md Normal file
View File

@ -0,0 +1,57 @@
---
title: Внешние компоненты вызов сервера
slug: bsp/внешние-компоненты-вызов-сервера
---
## ИнформацияОКомпоненте
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВнешниеКомпонентыСервер.ИнформацияОКомпоненте.
// Возвращает информацию о внешней компоненте по идентификатору и версии.
//
// Параметры:
// Идентификатор - Строка - идентификатор объекта внешней компоненты.
// Версия - Строка - версия компоненты.
//
// Возвращаемое значение:
// Структура:
// * Существует - Булево - признак отсутствия компоненты.
// * ДоступноРедактирование - Булево - признак того, что компоненту может изменить администратор области.
// * ОписаниеОшибки - Строка - краткое описание ошибки.
// * Идентификатор - Строка - идентификатор объекта внешней компоненты.
// * Версия - Строка - версия компоненты.
// * Наименование - Строка - наименование и краткая информация о компоненте.
//
// Пример:
//
// Результат = ВнешниеКомпонентыВызовСервера.ИнформацияОКомпоненте("InputDevice", "8.1.7.10");
//
// Если Результат.Существует Тогда
// Идентификатор = Результат.Идентификатор;
// Версия = Результат.Версия;
// Наименование = Результат.Наименование;
// Иначе
// ОбщегоНазначенияКлиентСервер.СообщитьПользователю(Результат.ОписаниеОшибки);
// КонецЕсли;
//
Функция ИнформацияОКомпоненте(Знач Идентификатор, Знач Версия = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеКомпонентыВызовСервера.ИнформацияОКомпоненте(Идентификатор, Версия);
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

371
src/content/docs/bsp/ВнешниеКомпонентыКлиент.md Normal file
View File

@ -0,0 +1,371 @@
---
title: Внешние компоненты клиент
slug: bsp/внешние-компоненты-клиент
---
## ПараметрыПодключения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры для вызова процедуры ВнешниеКомпонентыКлиент.ПодключитьКомпоненту.
//
// Возвращаемое значение:
// Структура:
// * Кэшировать - Булево - (по умолчанию Истина) использовать механизм кэширования компонент на клиенте.
// * ПредложитьУстановить - Булево - (по умолчанию Истина) предлагать устанавливать компоненту.
// * ПредложитьЗагрузить - Булево - (по умолчанию Истина) предлагать загрузить компоненту с сайта ИТС.
// * ТекстПояснения - Строка - для чего нужна компонента и что не будет работать, если ее не устанавливать.
// * ИдентификаторыСозданияОбъектов - Массив - массив строк идентификаторов создания экземпляров модуля объекта,
// используется только для компонент, у которых есть несколько идентификаторов создания объектов,
// при задании параметр Идентификатор будет использоваться только для определения компоненты.
// * Изолированно - Булево, Неопределено - (по умолчанию Неопределено) если Истина, компонента будет подключена
// изолированно, в этом случае внешняя компонента загружается в отдельный процесс операционной системы;
// Ложь - в этом случае внешняя компонента будет выполняться в том же процессе операционной системы,
// который выполняет код встроенного языка; Неопределено - поддерживается поведение платформы по умолчанию:
// изолированно - если компонентой поддерживается только этот режим, не изолированно - в остальных случаях.
// См. https://its.1c.eu/db/v83doc#bookmark:dev:TI000001866
// * ОбновлятьАвтоматически - Булево - (по умолчанию Истина) при загрузке внешней компоненты устанавливать
// признак ОбновлятьСПортала1СИТС
//
// Пример:
//
// ПараметрыПодключения = ВнешниеКомпонентыКлиент.ПараметрыПодключения();
// ПараметрыПодключения.ТекстПояснения =
// НСтр("ru = 'Для использования сканера штрихкодов требуется
// |внешняя компонента ""1С:Сканеры штрихкода (NativeApi)"".'");
//
Функция ПараметрыПодключения() Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеКомпонентыКлиент.ПараметрыПодключения()
```
</details>
## ПодключитьКомпоненту
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Подключает компоненту, выполненную по технологии Native API или COM на клиентском компьютере.
// Для веб-клиента предлагается диалог, подсказывающий пользователю действия по установке.
// Выполняет проверку возможности исполнения компоненты на текущем клиенте пользователя.
//
// Параметры:
// Оповещение - ОписаниеОповещения - описание оповещения о подключении со следующими параметрами:
// * Результат - Структура - результат подключения компоненты:
// ** Подключено - Булево - признак подключения;
// ** ПодключаемыйМодуль - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты;
// - ФиксированноеСоответствие из КлючИЗначение - экземпляры объектов внешней компоненты,
// указанные в ПараметрыПодключения.ИдентификаторыСозданияОбъектов:
// *** Ключ - Строка - идентификатор внешней компоненты;
// *** Значение - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты.
// ** ОписаниеОшибки - Строка - краткое описание ошибки. При отмене пользователем пустая строка.
// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения.
// Идентификатор - Строка - идентификатор объекта внешней компоненты.
// Версия - Строка - версия компоненты.
// ПараметрыПодключения - см. ВнешниеКомпонентыКлиент.ПараметрыПодключения.
//
// Пример:
//
// Оповещение = Новый ОписаниеОповещения("ПодключитьКомпонентуЗавершение", ЭтотОбъект);
//
// ПараметрыПодключения = ВнешниеКомпонентыКлиент.ПараметрыПодключения();
// ПараметрыПодключения.ТекстПояснения =
// НСтр("ru = 'Для использования сканера штрихкодов требуется
// |внешняя компонента ""1С:Сканеры штрихкода (NativeApi)"".'");
//
// ВнешниеКомпонентыКлиент.ПодключитьКомпоненту(Оповещение, "InputDevice",, ПараметрыПодключения);
//
// &НаКлиенте
// Процедура ПодключитьКомпонентуЗавершение(Результат, ДополнительныеПараметры) Экспорт
//
// ПодключаемыйМодуль = Неопределено;
//
// Если Результат.Подключено Тогда
// ПодключаемыйМодуль = Результат.ПодключаемыйМодуль;
// Иначе
// Если Не ПустаяСтрока(Результат.ОписаниеОшибки) Тогда
// ПоказатьПредупреждение(, Результат.ОписаниеОшибки);
// КонецЕсли;
// КонецЕсли;
//
// Если ПодключаемыйМодуль <> Неопределено Тогда
// // ПодключаемыйМодуль содержит созданный экземпляр подключенной компоненты.
// КонецЕсли;
//
// ПодключаемыйМодуль = Неопределено;
//
// КонецПроцедуры
//
Процедура ПодключитьКомпоненту(Оповещение, Идентификатор, Версия = Неопределено, Экспорт
```
Пример вызова
```bsl
ВнешниеКомпонентыКлиент.ПодключитьКомпоненту(Оповещение, Идентификатор, Версия, );
```
</details>
## ПодключитьКомпонентуИзРеестраWindows
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Подключает компоненту, выполненную по технологии COM, из реестра Windows в асинхронном режиме.
// (не рекомендуется, для обратной совместимости с компонентами 1С 7.7).
//
// Параметры:
// Оповещение - ОписаниеОповещения - описание оповещения о подключении со следующими параметрами:
// * Результат - Структура - результат подключения компоненты:
// ** Подключено - Булево - признак подключения.
// ** ПодключаемыйМодуль - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты.
// ** ОписаниеОшибки - Строка - краткое описание ошибки.
// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения.
// Идентификатор - Строка - идентификатор объекта внешней компоненты.
// ИдентификаторСозданияОбъекта - Строка - идентификатор создания экземпляра модуля объекта
// (только для компонент, у которых идентификатор создания объекта отличается от ProgID).
//
// Пример:
//
// Оповещение = Новый ОписаниеОповещения("ПодключитьКомпонентуЗавершение", ЭтотОбъект);
// ВнешниеКомпонентыКлиент.ПодключитьКомпонентуИзРеестраWindows(Оповещение, "SBRFCOMObject", "SBRFCOMExtension");
//
// &НаКлиенте
// Процедура ПодключитьКомпонентуЗавершение(Результат, ДополнительныеПараметры) Экспорт
//
// ПодключаемыйМодуль = Неопределено;
//
// Если Результат.Подключено Тогда
// ПодключаемыйМодуль = Результат.ПодключаемыйМодуль;
// Иначе
// ПоказатьПредупреждение(, Результат.ОписаниеОшибки);
// КонецЕсли;
//
// Если ПодключаемыйМодуль <> Неопределено Тогда
// // ПодключаемыйМодуль содержит созданный экземпляр подключенной компоненты.
// КонецЕсли;
//
// ПодключаемыйМодуль = Неопределено;
//
// КонецПроцедуры
//
Процедура ПодключитьКомпонентуИзРеестраWindows(Оповещение, Идентификатор, Экспорт
```
Пример вызова
```bsl
ВнешниеКомпонентыКлиент.ПодключитьКомпонентуИзРеестраWindows(Оповещение, Идентификатор, );
```
</details>
## ПараметрыУстановки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Структура параметров для процедуры ВнешниеКомпонентыКлиент.УстановитьКомпоненту.
//
// Возвращаемое значение:
// Структура:
// * ТекстПояснения - Строка - для чего нужна компонента и что не будет работать, если ее не устанавливать.
// * ПредложитьЗагрузить - Булево - предложить загрузить компоненту с сайта ИТС
// * ПредложитьУстановить - Булево - (по умолчанию Ложь) предлагать устанавливать компоненту.
//
// Пример:
//
// ПараметрыУстановки = ВнешниеКомпонентыКлиент.ПараметрыУстановки();
// ПараметрыУстановки.ТекстПояснения =
// НСтр("ru = 'Для использования сканера штрихкодов требуется
// |внешняя компонента ""1С:Сканеры штрихкода (NativeApi)"".'");
//
Функция ПараметрыУстановки() Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеКомпонентыКлиент.ПараметрыУстановки()
```
</details>
## УстановитьКомпоненту
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устанавливает компоненту, выполненную по технологии Native API и COM асинхронном режиме.
// Выполняет проверку возможности исполнения компоненты на текущем клиенте пользователя.
//
// Параметры:
// Оповещение - ОписаниеОповещения - описание оповещения об установке внешней компоненты:
// * Результат - Структура - результат установки компоненты:
// ** Установлено - Булево - признак установки.
// ** ОписаниеОшибки - Строка - краткое описание ошибки. При отмене пользователем пустая строка.
// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения.
// Идентификатор - Строка - идентификатор объекта внешней компоненты.
// Версия - Строка - версия компоненты.
// ПараметрыУстановки - см. ПараметрыУстановки.
//
// Пример:
//
// Оповещение = Новый ОписаниеОповещения("УстановитьКомпонентуЗавершение", ЭтотОбъект);
//
// ПараметрыУстановки = ВнешниеКомпонентыКлиент.ПараметрыУстановки();
// ПараметрыУстановки.ТекстПояснения =
// НСтр("ru = 'Для использования сканера штрихкодов требуется
// |внешняя компонента ""1С:Сканеры штрихкода (NativeApi)"".'");
//
// ВнешниеКомпонентыКлиент.УстановитьКомпоненту(Оповещение, "InputDevice",, ПараметрыУстановки);
//
// &НаКлиенте
// Процедура УстановитьКомпонентуЗавершение(Результат, ДополнительныеПараметры) Экспорт
//
// Если Не Результат.Установлено И Не ПустаяСтрока(Результат.ОписаниеОшибки) Тогда
// ПоказатьПредупреждение(, Результат.ОписаниеОшибки);
// КонецЕсли;
//
// КонецПроцедуры
//
Процедура УстановитьКомпоненту(Оповещение, Идентификатор, Версия = Неопределено, Экспорт
```
Пример вызова
```bsl
ВнешниеКомпонентыКлиент.УстановитьКомпоненту(Оповещение, Идентификатор, Версия, );
```
</details>
## ПараметрыПоискаДополнительнойИнформации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает структуру параметров для описания правил поиска дополнительной информации в составе внешней компоненты,
// см. процедуру ЗагрузитьКомпонентуИзФайла.
//
// Возвращаемое значение:
// Структура:
// * ИмяФайлаXML - Строка - (необязательный) имя файла в составе компоненты, из которого будет извлечена информация.
// * ВыражениеXPath - Строка - (необязательный) XPath путь до информации в файле.
//
// Пример:
//
// ПараметрыЗагрузки = ВнешниеКомпонентыКлиент.ПараметрыПоискаДополнительнойИнформации();
// ПараметрыЗагрузки.ИмяФайлаXML = "INFO.XML";
// ПараметрыЗагрузки.ВыражениеXPath = "//drivers/component/@type";
//
Функция ПараметрыПоискаДополнительнойИнформации() Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеКомпонентыКлиент.ПараметрыПоискаДополнительнойИнформации()
```
</details>
## ПараметрыЗагрузки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Структура параметров для процедуру ВнешниеКомпонентыКлиент.ЗагрузитьКомпонентуИзФайла.
//
// Возвращаемое значение:
// Структура:
// * Идентификатор - Строка -(необязательный) идентификатор объекта внешней компоненты.
// * Версия - Строка - (необязательный) версия компоненты.
// * ПараметрыПоискаДополнительнойИнформации - Соответствие из КлючИЗначение - (необязательный) параметры:
// ** Ключ - Строка - идентификатор дополнительной запрошенной информации.
// ** Значение - см. ПараметрыПоискаДополнительнойИнформации.
// Пример:
//
// ПараметрыЗагрузки = ВнешниеКомпонентыКлиент.ПараметрыЗагрузки();
// ПараметрыЗагрузки.Идентификатор = "InputDevice";
// ПараметрыЗагрузки.Версия = "8.1.7.10";
//
Функция ПараметрыЗагрузки() Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеКомпонентыКлиент.ПараметрыЗагрузки()
```
</details>
## ЗагрузитьКомпонентуИзФайла
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Загружает файл компоненты в справочник внешних компонент в асинхронном режиме.
//
// Параметры:
// Оповещение - ОписаниеОповещения - описание оповещения об установке внешней компоненты:
// * Результат - Структура - результат загрузки компоненты:
// ** Загружена - Булево - признак загрузки.
// ** Идентификатор - Строка - идентификатор объекта внешней компоненты.
// ** Версия - Строка - версия загруженной компоненты.
// ** Наименование - Строка - наименование загруженной компоненты.
// ** ДополнительнаяИнформация - Соответствие из КлючИЗначение - дополнительная информация о компоненте,
// если не запрашивалась - пустое соответствие:
// *** Ключ - см. ПараметрыПоискаДополнительнойИнформации.
// *** Значение - см. ПараметрыПоискаДополнительнойИнформации.
// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения.
// ПараметрыЗагрузки - см. ПараметрыЗагрузки.
//
// Пример:
//
// ПараметрыЗагрузки = ВнешниеКомпонентыКлиент.ПараметрыЗагрузки();
// ПараметрыЗагрузки.Идентификатор = "InputDevice";
// ПараметрыЗагрузки.Версия = "8.1.7.10";
//
// Оповещение = Новый ОписаниеОповещения("ЗагрузитьКомпонентуИзФайлаПослеЗагрузкиКомпоненты", ЭтотОбъект);
//
// ВнешниеКомпонентыКлиент.ЗагрузитьКомпонентуИзФайла(Оповещение, ПараметрыЗагрузки);
//
// &НаКлиенте
// Процедура ЗагрузитьКомпонентуИзФайлаПослеЗагрузкиКомпоненты(Результат, ДополнительныеПараметры) Экспорт
//
// Если Результат.Загружено Тогда
// Идентификатор = Результат.Идентификатор;
// Версия = Результат.Версия;
// КонецЕсли;
//
// КонецПроцедуры
//
Процедура ЗагрузитьКомпонентуИзФайла(Оповещение, ПараметрыЗагрузки = Неопределено) Экспорт
```
Пример вызова
```bsl
ВнешниеКомпонентыКлиент.ЗагрузитьКомпонентуИзФайла(Оповещение, ПараметрыЗагрузки);
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

61
src/content/docs/bsp/ВнешниеКомпонентыКлиентЛокализация.md Normal file
View File

@ -0,0 +1,61 @@
---
title: Внешние компоненты клиент локализация
slug: bsp/внешние-компоненты-клиент-локализация
---
## ПриПоискеКомпонентНаПортале
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается для открытия формы поиска внешних компонент в Интернете.
//
// Параметры:
// Оповещение - ОписаниеОповещения
// Контекст - Структура:
// * ТекстПояснения - Строка
// * Идентификатор - Строка
// * Версия - Строка
// * ОбновлятьАвтоматически - Булево
//
Процедура ПриПоискеКомпонентНаПортале(Оповещение, Контекст) Экспорт
```
Пример вызова
```bsl
ВнешниеКомпонентыКлиентЛокализация.ПриПоискеКомпонентНаПортале(Оповещение, Контекст)
```
</details>
## ПриОбновленииКомпонентСПортала
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается для открытия формы обновление внешних компонент через Интернет.
//
// Параметры:
// Оповещение - ОписаниеОповещения
// ОбновляемыеКомпоненты - Массив из СправочникСсылка.ВнешниеКомпоненты
//
Процедура ПриОбновленииКомпонентСПортала(Оповещение, ОбновляемыеКомпоненты) Экспорт
```
Пример вызова
```bsl
ВнешниеКомпонентыКлиентЛокализация.ПриОбновленииКомпонентСПортала(Оповещение, ОбновляемыеКомпоненты)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

123
src/content/docs/bsp/ВнешниеКомпонентыСервер.md Normal file
View File

@ -0,0 +1,123 @@
---
title: Внешние компоненты сервер
slug: bsp/внешние-компоненты-сервер
---
## ПараметрыПодключения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры для вызова ВнешниеКомпонентыСервер.ПодключитьКомпоненту.
//
// Возвращаемое значение:
// Структура:
// * ИдентификаторыСозданияОбъектов - Массив из Строка - идентификаторы экземпляров модуля объекта,
// используется только для компонент, у которых есть несколько идентификаторов создания объектов.
// При задании параметр Идентификатор будет использоваться только для определения компоненты.
// * Изолированно - Булево - если Истина, компонента должна подключаться изолированно,
// в этом случае она загружается в отдельный процесс операционной системы.
// Если Ложь, то в этом случае компонента будет выполняться в том же процессе
// операционной системы, который выполняет код встроенного языка.
// - Неопределено - (по умолчанию Неопределено) соответствует поведению платформы:
// не изолированно - если компонентой поддерживается только этот режим,
// изолированно - в остальных случаях.
// См. https://its.1c.eu/db/v83doc#bookmark:dev:TI000001866
// * ПолноеИмяМакета - Строка - полное имя макета конфигурации с ZIP-архивом, в котором хранится компонента.
//
Функция ПараметрыПодключения() Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеКомпонентыСервер.ПараметрыПодключения()
```
</details>
## ПодключитьКомпоненту
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Подключает на сервере 1С:Предприятия внешнюю компоненту из хранилища внешних компонент,
// выполненную по технологии Native API или COM.
// В модели сервиса разрешено только подключение общих внешних компонент, одобренных администратором сервиса.
//
// Параметры:
// Идентификатор - Строка - идентификатор объекта внешней компоненты.
// Версия - Строка - версия компоненты.
// ПараметрыПодключения - см. ПараметрыПодключения.
//
// Возвращаемое значение:
// Структура - результат подключения компоненты:
// * Подключено - Булево - признак подключения;
// * ПодключаемыйМодуль - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты;
// - ФиксированноеСоответствие из КлючИЗначение - экземпляры объектов внешней компоненты,
// указанные в ПараметрыПодключения.ИдентификаторыСозданияОбъектов:
// ** Ключ - Строка - идентификатор,
// ** Значение - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты.
// * ОписаниеОшибки - Строка - краткое описание ошибки.
//
Функция ПодключитьКомпоненту(Знач Идентификатор, Версия = Неопределено, ПараметрыПодключения = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеКомпонентыСервер.ПодключитьКомпоненту(Идентификатор, Версия, ПараметрыПодключения);
```
</details>
## ИнформацияОКомпоненте
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает информацию о внешней компоненте по идентификатору и версии.
//
// Параметры:
// Идентификатор - Строка - идентификатор объекта внешней компоненты.
// Версия - Строка - версия компоненты.
//
// Возвращаемое значение:
// Структура:
// * Существует - Булево - признак отсутствия компоненты.
// * ДоступноРедактирование - Булево - признак того, что компоненту может изменить администратор области.
// * ОписаниеОшибки - Строка - краткое описание ошибки.
// * Идентификатор - Строка - идентификатор объекта внешней компоненты.
// * Версия - Строка - версия компоненты.
// * Наименование - Строка - наименование и краткая информация о компоненте.
//
// Пример:
//
// Результат = ВнешниеКомпонентыСервер.ИнформацияОКомпоненте("InputDevice", "8.1.7.10");
// Если Результат.Существует Тогда
// Идентификатор = Результат.Идентификатор;
// Версия = Результат.Версия;
// Наименование = Результат.Наименование;
// Иначе
// ОбщегоНазначенияКлиентСервер.СообщитьПользователю(Результат.ОписаниеОшибки);
// КонецЕсли;
//
Функция ИнформацияОКомпоненте(Знач Идентификатор, Знач Версия = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеКомпонентыСервер.ИнформацияОКомпоненте(Идентификатор, Версия);
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

188
src/content/docs/bsp/ВнешниеПользователи.md Normal file
View File

@ -0,0 +1,188 @@
---
title: Внешние пользователи
slug: bsp/внешние-пользователи
---
## ИспользоватьВнешнихПользователей
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает признак того, что в приложение настроен доступ внешним пользователям
// (значение функциональной опции ИспользоватьВнешнихПользователей).
//
// Возвращаемое значение:
// Булево - если Истина, внешние пользователи включены.
//
Функция ИспользоватьВнешнихПользователей() Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеПользователи.ИспользоватьВнешнихПользователей()
```
</details>
## ТекущийВнешнийПользователь
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает текущего внешнего пользователя.
// Рекомендуется использовать в коде, который поддерживает только внешних пользователей.
//
// Если вход в сеанс выполнил не внешний пользователь, тогда будет вызвано исключение.
//
// Возвращаемое значение:
// СправочникСсылка.ВнешниеПользователи - внешний пользователь.
//
Функция ТекущийВнешнийПользователь() Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеПользователи.ТекущийВнешнийПользователь()
```
</details>
## ГруппаВсеВнешниеПользователи
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает ссылку на стандартную группу ВсеВнешниеПользователи.
//
// Возвращаемое значение:
// СправочникСсылка.ГруппыВнешнихПользователей
//
Функция ГруппаВсеВнешниеПользователи() Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеПользователи.ГруппаВсеВнешниеПользователи()
```
</details>
## ПолучитьОбъектАвторизацииВнешнегоПользователя
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает ссылку на объект авторизации внешнего пользователя, полученный из информационной базы.
// Объект авторизации - это ссылка на объект информационной базы, используемый
// для связи с внешним пользователем, например: контрагент, физическое лицо и т.д.
//
// Параметры:
// ВнешнийПользователь - Неопределено - вернуть для текущего внешнего пользователя.
// - СправочникСсылка.ВнешниеПользователи
//
// Возвращаемое значение:
// ОпределяемыйТип.ВнешнийПользователь
//
Функция ПолучитьОбъектАвторизацииВнешнегоПользователя(ВнешнийПользователь = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеПользователи.ПолучитьОбъектАвторизацииВнешнегоПользователя(ВнешнийПользователь);
```
</details>
## НастроитьОтображениеСпискаВнешнихПользователей
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Используется для настройки отображения состояния внешних пользователей
// в списках справочников (партнеры, респонденты и др.), которые
// являются объектом авторизации в справочнике ВнешниеПользователи.
//
// Когда нет прав к справочнику ВнешниеПользователи или он не используется, тогда
// отключается видимость колонки ВнешнийДоступ и легенды ВнешнийДоступЛегенда.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения
// ДополнительныеПараметры - см. ПараметрыНастройкиОтображенияСпискаВнешнихПользователей
//
Процедура НастроитьОтображениеСпискаВнешнихПользователей(Форма, ДополнительныеПараметры = Неопределено) Экспорт
```
Пример вызова
```bsl
ВнешниеПользователи.НастроитьОтображениеСпискаВнешнихПользователей(Форма, ДополнительныеПараметры);
```
</details>
## ПараметрыНастройкиОтображенияСпискаВнешнихПользователей
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Конструктор дополнительных параметров процедуры НастроитьОтображениеСпискаВнешнихПользователей.
//
// Возвращаемое значение:
// Структура:
// * ИмяСписка - Строка - имя реквизита формы с динамическим списком.
// * ИмяПоля - Строка - имя поля запроса динамического списка.
// * ИмяЭлемента - Строка - имя элемента формы колонки динамического списка.
// * ИмяГруппыЛегенды - Строка - имя элемента формы, содержащую легенду состояний внешнего доступа.
//
Функция ПараметрыНастройкиОтображенияСпискаВнешнихПользователей() Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеПользователи.ПараметрыНастройкиОтображенияСпискаВнешнихПользователей()
```
</details>
## СписокВнешнихПользователейПриПолученииДанныхНаСервере
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Используется для заполнения значений поля состояния внешних пользователей
// в списках справочников (партнеры, респонденты и др.), которые
// являются объектом авторизации в справочнике ВнешниеПользователи.
//
// Вызов выполняется из события ПриПолученииДанныхНаСервере динамического списка
// справочника, при этом заполняется поле ВнешнийДоступ на основе данных поля Ссылка.
//
// Параметры:
// ИмяЭлемента - Строка
// Настройки - НастройкиКомпоновкиДанных
// Строки - СтрокиДинамическогоСписка
// ИмяПоля - Строка - имя поля номера картинки строк в динамическом списке.
//
Процедура СписокВнешнихПользователейПриПолученииДанныхНаСервере(ИмяЭлемента, Настройки, Строки, Экспорт
```
Пример вызова
```bsl
ВнешниеПользователи.СписокВнешнихПользователейПриПолученииДанныхНаСервере(ИмяЭлемента, Настройки, Строки, );
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

30
src/content/docs/bsp/ВнешниеПользователиКлиент.md Normal file
View File

@ -0,0 +1,30 @@
---
title: Внешние пользователи клиент
slug: bsp/внешние-пользователи-клиент
---
## ТекущийВнешнийПользователь
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ВнешниеПользователи.ТекущийВнешнийПользователь.
Функция ТекущийВнешнийПользователь() Экспорт
```
Пример вызова
```bsl
Результат = ВнешниеПользователиКлиент.ТекущийВнешнийПользователь()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

314
src/content/docs/bsp/ВыгрузкаЗагрузкаДанных.md Normal file
View File

@ -0,0 +1,314 @@
---
title: Выгрузка загрузка данных
slug: bsp/выгрузка-загрузка-данных
---
## ВыгрузитьДанныеТекущейОбластиВАрхив
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выгружает данные в zip-архив, из которого они в дальнейшем могут быть загружены
// в другую информационную базу или область данных с помощью функции
// ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива().
//
// Параметры:
// ПараметрыВыгрузки - Структура - содержащая параметры выгрузки данных:
// * ВыгружаемыеТипы - Массив из ОбъектМетаданных - данные которых требуется выгрузить в архив
// * ВыгружатьПользователей - Булево - выгружать информацию о пользователях информационной базы,
// * ВыгружатьНастройкиПользователей - Булево - игнорируется если ВыгружатьПользователей = Ложь.
// Также структура может содержать дополнительные ключи, которые могут быть обработаны внутри
// произвольных обработчиков выгрузки данных.
//
// Возвращаемое значение:
// Структура - с полями:
// * ИмяФайла - Строка - имя файла архива
// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам выгрузки.
//
Функция ВыгрузитьДанныеТекущейОбластиВАрхив(Знач ПараметрыВыгрузки) Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаДанных.ВыгрузитьДанныеТекущейОбластиВАрхив(ПараметрыВыгрузки)
```
</details>
## ЗагрузитьДанныеТекущейОбластиИзАрхива
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Загружает данные из zip архива с XML файлами.
//
// Параметры:
// ИмяАрхива - Строка, УникальныйИдентификатор, Структура - имя файла, идентификатор файла или данные файла полученные с помощью ZipАрхивы.ПрочитатьАрхив().
// ПараметрыЗагрузки - Структура - содержащая параметры загрузки данных:
// * ЗагружаемыеТипы - Массив Из ОбъектМетаданных - массив объектов метаданных, данные
// которых требуется загрузить из архива. Если значение параметра задано - все прочие
// данные, содержащиеся в файле выгрузки, загружены не будут. Если значение параметра
// не задано - будут загружены все данные, содержащиеся в файле выгрузки.
// * ЗагружатьПользователей - Булево - загружать информацию о пользователях информационной базы,
// * ЗагружатьНастройкиПользователей - Булево - игнорируется, если ЗагружатьПользователей = Ложь.
// * СопоставлениеПользователей - ТаблицаЗначений - таблица с колонками:
// ** Пользователь - СправочникСсылка.Пользователи - идентификатора пользователя из архива.
// ** ИдентификаторПользователяСервиса - УникальныйИдентификатор - идентификатор пользователя сервиса.
// ** СтароеИмяПользователяИБ - Строка - старое имя пользователя базы.
// ** НовоеИмяПользователяИБ - Строка - новое имя пользователя базы.
// Также структура может содержать дополнительные ключи, которые могут быть обработаны внутри
// произвольных обработчиков загрузки данных.
//
// Возвращаемое значение:
// Структура - с полями:
// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам загрузки.
//
Функция ЗагрузитьДанныеТекущейОбластиИзАрхива(Знач ИмяАрхива, Знач ПараметрыЗагрузки) Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива(ИмяАрхива, ПараметрыЗагрузки)
```
</details>
## ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет совместимость выгрузки из файла с текущей конфигурацией информационной базы.
//
// Параметры:
// ИмяАрхива - Строка - путь к файлу выгрузки.
//
// Возвращаемое значение:
// Булево - Истина если данные из архива могут быть загружены в текущую конфигурацию.
//
Функция ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(Знач ИмяАрхива) Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаДанных.ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(ИмяАрхива)
```
</details>
## ЗаписатьОбъектВФайл
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Записывает объект в файл.
//
// Параметры:
// Объект - Произвольный - записываемый объект.
// ИмяФайла - Строка - путь к файлу.
// Сериализатор - СериализаторXDTO - сериализатор.
//
Процедура ЗаписатьОбъектВФайл(Знач Объект, Знач ИмяФайла, Сериализатор = Неопределено) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанных.ЗаписатьОбъектВФайл(Объект, ИмяФайла, Сериализатор);
```
</details>
## ПрочитатьОбъектИзФайла
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает объект из файла.
//
// Параметры:
// ИмяФайла - Строка - путь к файлу.
//
// Возвращаемое значение:
// Произвольный - объект содержащий прочитанные данные
//
Функция ПрочитатьОбъектИзФайла(Знач ИмяФайла) Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаДанных.ПрочитатьОбъектИзФайла(ИмяФайла)
```
</details>
## ДополнитьТипомИсключаемымИзВыгрузкиЗагрузки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Дополняет массив типов исключаемых из выгрузки-загрузки
// Предназначен для использования в обработчиках ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.
//
// Параметры:
// Типы - Массив из ФиксированнаяСтруктура
// Тип - ОбъектМетаданных - объект метаданных исключаемый из выгрузки-загрузки
// ДействиеСоСсылками - Строка - вариант действия при обнаружении ссылки на объект исключаемый из выгрузки
// Поддерживаются следующие действия:
// ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиНеИзменять() - не будет произведено никаких действий
// ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиОчищать() - будет выполнено очищение ссылки на невыгружаемый объект
// ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиНеВыгружатьОбъект() - объект содержащий ссылку не будет выгружен
//
// Пример использования:
// Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт
// ВыгрузкаЗагрузкаДанных.ДополнитьТипомИсключаемымИзВыгрузкиЗагрузки(
// Типы,
// Метаданные.Справочники.ИсторияПроверкиИКорректировкиДанныхПрисоединенныеФайлы,
// ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиНеВыгружатьОбъект());
// КонецПроцедуры
//
Процедура ДополнитьТипомИсключаемымИзВыгрузкиЗагрузки(Типы, Тип, ДействиеСоСсылками) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанных.ДополнитьТипомИсключаемымИзВыгрузкиЗагрузки(Типы, Тип, ДействиеСоСсылками)
```
</details>
## ДействиеСоСсылкамиНеИзменять
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращаемое значение:
// Строка -
Функция ДействиеСоСсылкамиНеИзменять() Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиНеИзменять()
```
</details>
## ДействиеСоСсылкамиОчищать
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращаемое значение:
// Строка -
Функция ДействиеСоСсылкамиОчищать() Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиОчищать()
```
</details>
## ДействиеСоСсылкамиНеВыгружатьОбъект
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращаемое значение:
// Строка -
Функция ДействиеСоСсылкамиНеВыгружатьОбъект() Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиНеВыгружатьОбъект()
```
</details>
## ВыгрузитьДанныеВАрхив
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВыгрузкаЗагрузкаДанных.ВыгрузитьДанныеТекущейОбластиВАрхив
// Выгружает данные в zip-архив, из которого они в дальнейшем могут быть загружены
// в другую информационную базу или область данных с помощью функции
// ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива().
//
// Параметры:
// ПараметрыВыгрузки - Структура - содержащая параметры выгрузки данных:
// * ВыгружаемыеТипы - Массив из ОбъектМетаданных - массив объектов метаданных, данные которых требуется выгрузить в архив
// * ВыгружатьПользователей - Булево - выгружать информацию о пользователях информационной базы,
// * ВыгружатьНастройкиПользователей - Булево - игнорируется если ВыгружатьПользователей = Ложь.
// Также структура может содержать дополнительные ключи, которые могут быть обработаны внутри
// произвольных обработчиков выгрузки данных.
//
// Возвращаемое значение:
// Строка - путь к файлу выгрузки.
//
Функция ВыгрузитьДанныеВАрхив(Знач ПараметрыВыгрузки) Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаДанных.ВыгрузитьДанныеВАрхив(ПараметрыВыгрузки)
```
</details>
## ЗагрузитьДанныеИзАрхива
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива
// Загружает данные из zip архива с XML файлами.
//
// Параметры:
// ИмяАрхива - Строка - полное имя файла архива с данными,
// ПараметрыЗагрузки - Структура - содержащая параметры загрузки данных:
// * ЗагружаемыеТипы - Массив Из ОбъектМетаданных - массив объектов метаданных, данные
// которых требуется загрузить из архива. Если значение параметра задано - все прочие
// данные, содержащиеся в файле выгрузки, загружены не будут. Если значение параметра
// не задано - будут загружены все данные, содержащиеся в файле выгрузки.
// * ЗагружатьПользователей - Булево - загружать информацию о пользователях информационной базы,
// * ЗагружатьНастройкиПользователей - Булево - игнорируется, если ЗагружатьПользователей = Ложь.
// * СопоставлениеПользователей - ТаблицаЗначений - таблица с колонками:
// ** Пользователь - СправочникСсылка.Пользователи - идентификатора пользователя из архива.
// ** ИдентификаторПользователяСервиса - УникальныйИдентификатор - идентификатор пользователя сервиса.
// ** СтароеИмяПользователяИБ - Строка - старое имя пользователя базы.
// ** НовоеИмяПользователяИБ - Строка - новое имя пользователя базы.
// Также структура может содержать дополнительные ключи, которые могут быть обработаны внутри
// произвольных обработчиков загрузки данных.
//
Процедура ЗагрузитьДанныеИзАрхива(Знач ИмяАрхива, Знач ПараметрыЗагрузки) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеИзАрхива(ИмяАрхива, ПараметрыЗагрузки)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

273
src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.md Normal file
View File

@ -0,0 +1,273 @@
---
title: Выгрузка загрузка данных границ последовательностей
slug: bsp/выгрузка-загрузка-данных-границ-последовательностей
---
## ПриРегистрацииОбработчиковВыгрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при регистрации произвольных обработчиков выгрузки данных.
// в данной процедуре требуется дополнить таблицу обработчиков информацией о регистрируемых произвольных
// обработчиках выгрузки данных.
//
// Параметры:
// ТаблицаОбработчиков - ТаблицаЗначений - описание:
// * ОбъектМетаданных - ОбъектМетаданных - при выгрузке данных которого должен вызываться регистрируемый обработчик,
// * Обработчик - ОбщийМодуль - общий модуль, в котором реализован произвольный обработчик выгрузки данных.
// Набор экспортных процедур, которые должны быть реализованы в обработчике, зависит от установки значений
// следующих колонок таблицы значений.
// * Версия - Строка - номер версии интерфейса обработчиков выгрузки / загрузки данных, поддерживаемого обработчиком.
// * ПередВыгрузкойТипа - Булево - флаг необходимости вызова обработчика перед выгрузкой всех объектов информационной
// базы, относящихся к данному объекту метаданных. Если присвоено значение Истина - в общем модуле обработчика
// должна быть реализована экспортируемая процедура ПередВыгрузкойТипа() поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый
// в процессе выгрузи данных. Подробнее см. комментарий к программному интерфейсу обработки.
// Сериализатор - СериализаторXDTO - инициализированный с поддержкой выполнения аннотации ссылок.
// В случае, если в произвольном обработчике выгрузки требуется выполнять выгрузку дополнительных
// данных - следует использовать СериализаторXDTO, переданный в процедуру ПередВыгрузкойТипа() в качестве
// значения параметра Сериализатор, а не полученных с помощью свойства глобального контекста СериализаторXDTO.
// ОбъектМетаданных - ОбъектМетаданных - перед выгрузкой данных которого был вызван обработчик
// Отказ - Булево - Если в процедуре ПередВыгрузкойТипа() установить значение данного параметра равным
// Истина - выгрузка объектов, соответствующих текущему объекту метаданных, выполняться не будет.
// * ПередВыгрузкойОбъекта - Булево - флаг необходимости вызова обработчика перед выгрузкой конкретного объекта
// информационной базы. Если присвоено значение Истина - в общем модуле обработчика должна быть реализована
// экспортируемая процедура ПередВыгрузкойОбъекта(), поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый
// в процессе выгрузи данных. Подробнее см. комментарий к программному интерфейсу обработки.
// МенеджерВыгрузкиОбъекта - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерВыгрузкиДанныхИнформационнойБазы -
// менеджер выгрузки текущего объекта. Подробнее см. комментарий к программному интерфейсу обработки
// ВыгрузкаЗагрузкаДанныхМенеджерВыгрузкиДанныхИнформационнойБазы. Параметр передается только при вызове
// процедур обработчиков, для которых при регистрации указана версия не ниже 1.0.0.1,
// Сериализатор - СериализаторXDTO - инициализированный с поддержкой выполнения аннотации ссылок. В случае,
// если в произвольном обработчике выгрузки требуется выполнять выгрузку дополнительных данных - следует
// использовать СериализаторXDTO, переданный в процедуру ПередВыгрузкойОбъекта() в качестве значения параметра
// Сериализатор, а не полученных с помощью свойства глобального контекста СериализаторXDTO,
// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект, БизнесПроцессОбъект, ЗадачаОбъект,
// ПланСчетовОбъект, ПланОбменаОбъект, ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект,
// РегистрСведенийНаборЗаписей, РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей,
// РегистрРасчетаНаборЗаписей, ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей - объект данных
// информационной базы, перед выгрузкой которого был вызван обработчик.
// Значение, переданное в процедуру ПередВыгрузкойОбъекта() в качестве значения параметра Объект может быть
// модифицировано внутри обработчика ПередВыгрузкойОбъекта(), при этом внесенные изменения будут отражены
// в сериализации объекта в файлах выгрузки, но не будут зафиксированы в информационной базе.
// Артефакты - Массив Из ОбъектXDTO - набор дополнительной информации, логически неразрывно связанной с объектом,
// но не являющейся его частью (артефакты объекта). Артефакты должны сформированы внутри обработчика
// ПередВыгрузкойОбъекта() и добавлены в массив, переданный в качестве значения параметра Артефакты.
// Каждый артефакт должен являться XDTO-объектом, для типа которого в качестве базового типа используется
// абстрактный XDTO-тип {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}Artefact. Допускается использовать
// XDTO-пакеты, помимо изначально поставляемых в составе подсистемы ВыгрузкаЗагрузкаДанных. В дальнейшем
// артефакты, сформированные в процедуре ПередВыгрузкойОбъекта(), будут доступны в процедурах
// обработчиков загрузки данных (см. комментарий к процедуре ПриРегистрацииОбработчиковЗагрузкиДанных().
// Отказ - Булево - если в процедуре ПередВыгрузкойОбъекта() установить значение данного параметра равным
// Истина - выгрузка объекта, для которого был вызван обработчик, выполняться не будет.
// * ПослеВыгрузкиТипа - Булево - флаг необходимости вызова обработчика после выгрузки всех объектов информационной
// базы, относящихся к данному объекту метаданных. Если присвоено значение Истина - в общем модуле обработчика
// должна быть реализована экспортируемая процедура ПослеВыгрузкиТипа(), поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый
// в процессе выгрузи данных. Подробнее см. комментарий к программному интерфейсу обработки.
// Сериализатор - СериализаторXDTO - инициализированный с поддержкой выполнения аннотации ссылок. В случае,
// если в произвольном обработчике выгрузки требуется выполнять выгрузку дополнительных данных - следует
// использовать СериализаторXDTO, переданный в процедуру ПослеВыгрузкиТипа() в качестве значения параметра
// Сериализатор, а не полученных с помощью свойства глобального контекста СериализаторXDTO,
// ОбъектМетаданных - ОбъектМетаданных - после выгрузки данных которого был вызван обработчик.
//
Процедура ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков)
```
</details>
## ПередВыгрузкойТипа
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик события перед выгрузкой типа.
//
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера
// Сериализатор - СериализаторXDTO
// ОбъектМетаданных - ОбъектМетаданных
// Отказ - Булево
//
Процедура ПередВыгрузкойТипа(Контейнер, Сериализатор, ОбъектМетаданных, Отказ) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.ПередВыгрузкойТипа(Контейнер, Сериализатор, ОбъектМетаданных, Отказ)
```
</details>
## ПриРегистрацииОбработчиковЗагрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при регистрации произвольных обработчиков загрузки данных.
// В данной процедуре требуется дополнить таблицу значений информацией о регистрируемых
// произвольных обработчиках загрузки данных.
//
// Параметры:
// ТаблицаОбработчиков - ТаблицаЗначений - Колонки:
// * ОбъектМетаданных - ОбъектМетаданных - при загрузке данных которого должен вызываться регистрируемый обработчик
// * Обработчик - ОбщийМодуль - общий модуль, в котором реализован произвольный
// обработчик загрузки данных. Набор экспортных процедур, которые должны
// быть реализованы в обработчике, зависит от установки значений следующих
// колонок таблицы значений.
// * Версия - Строка - номер версии интерфейса обработчиков выгрузки / загрузки данных,
// поддерживаемого обработчиком.
// * ПередСопоставлениемСсылок - Булево - флаг необходимости вызова обработчика перед
// сопоставлением ссылок (в исходной ИБ и в текущей), относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПередСопоставлениемСсылок(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
// ОбъектМетаданных - ОбъектМетаданных - перед сопоставлением ссылок которого
// был вызван обработчик,
// СтандартнаяОбработка - Булево - Если процедуре ПередСопоставлениемСсылок()
// установить значение данного параметра равным Ложь, вместо стандартного
// сопоставления ссылок (поиск объектов в текущей ИБ с теми же значениями
// естественного ключа, которые были выгружены из ИБ-источника) будет
// вызвана функция СопоставитьСсылки() общего модуля, в процедуре
// ПередСопоставлениемСсылок() которого значение параметра СтандартнаяОбработка
// было установлено равным Ложь.
// Параметры функции СопоставитьСсылки():
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера,
// ТаблицаИсходныхСсылок - ТаблицаЗначений - содержащая информацию о ссылках,
// выгруженных из исходной ИБ. Колонки:
// ИсходнаяСсылка - ЛюбаяСсылка - ссылка объекта исходной ИБ, которую требуется
// сопоставить c ссылкой в текущей ИБ,
// Остальные колонки равным полям естественного ключа объекта, которые в
// процессе выгрузки данных были переданы в функцию
// Обработка.ВыгрузкаЗагрузкаДанныхМенеджерВыгрузкиДанныхИнформационнойБазы.ТребуетсяСопоставитьСсылкуПриЗагрузке()
// Возвращаемое значение функции СопоставитьСсылки() - ТаблицаЗначений, колонки:
// ИсходнаяСсылка - ЛюбаяСсылка - ссылка объекта, выгруженная из исходной ИБ,
// Ссылка - ЛюбаяСсылка - сопоставленная исходной ссылка в текущей ИБ.
// Отказ - Булево - если в процедуре ПередСопоставлениемСсылок() установить значение
// данного параметра равным Истина - сопоставление ссылок, соответствующих
// текущему объекту метаданных, выполняться не будет.
// * ПередЗагрузкойТипа - Булево - флаг необходимости вызова обработчика перед
// загрузкой всех объектов данных, относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПередЗагрузкойТипа(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
// ОбъектМетаданных - ОбъектМетаданных - перед загрузкой всех данных которого
// был вызван обработчик,
// Отказ - Булево - если в процедуре ПередЗагрузкойТипа() установить значение данного
// параметра равным Истина - загрузка всех объектов данных соответствующих текущему
// объекту метаданных выполняться не будет.
// * ПередЗагрузкойОбъекта - Булево - флаг необходимости вызова обработчика перед
// загрузкой объекта данных, относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПередЗагрузкойОбъекта(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект,
// БизнесПроцессОбъект, ЗадачаОбъект, ПланСчетовОбъект, ПланОбменаОбъект,
// ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект, РегистрСведенийНаборЗаписей,
// РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей,
// РегистрРасчетаНаборЗаписей, ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей -
// объект данных информационной базы, перед загрузкой которого был вызван обработчик.
// Значение, переданное в процедуру ПередЗагрузкойОбъекта() в качестве значения параметра
// Объект может быть модифицировано внутри процедуры обработчика ПередЗагрузкойОбъекта().
// Артефакты - Массив Из ОбъектXDTO - дополнительные данные, логически неразрывно связанные
// с объектом данных, но не являющиеся его частью. Сформированы в экспортируемых процедурах
// ПередВыгрузкойОбъекта() обработчиков выгрузки данных (см. комментарий к процедуре
// ПриРегистрацииОбработчиковВыгрузкиДанных(). Каждый артефакт должен являться XDTO-объектом,
// для типа которого в качестве базового типа используется абстрактный XDTO-тип
// {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}Artefact. Допускается использовать XDTO-пакеты,
// помимо изначально поставляемых в составе подсистемы ВыгрузкаЗагрузкаДанных.
// Отказ - Булево - если в процедуре ПередЗагрузкойОбъекта() установить значение данного
// параметра равным Истина - загрузка объекта данных выполняться не будет.
// * ПослеЗагрузкиОбъекта - Булево - флаг необходимости вызова обработчика после
// загрузки объекта данных, относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПослеЗагрузкиОбъекта(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект,
// БизнесПроцессОбъект, ЗадачаОбъект, ПланСчетовОбъект, ПланОбменаОбъект,
// ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект, РегистрСведенийНаборЗаписей,
// РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей,
// РегистрРасчетаНаборЗаписей, ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей -
// объект данных информационной базы, после загрузки которого был вызван обработчик.
// Артефакты - Массив Из ОбъектXDTO - дополнительные данные, логически неразрывно связанные
// с объектом данных, но не являющиеся его частью. Сформированы в экспортируемых процедурах
// ПередВыгрузкойОбъекта() обработчиков выгрузки данных (см. комментарий к процедуре
// ПриРегистрацииОбработчиковВыгрузкиДанных(). Каждый артефакт должен являться XDTO-объектом,
// для типа которого в качестве базового типа используется абстрактный XDTO-тип
// {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}Artefact. Допускается использовать XDTO-пакеты,
// помимо изначально поставляемых в составе подсистемы ВыгрузкаЗагрузкаДанных.
// * ПослеЗагрузкиТипа - Булево - флаг необходимости вызова обработчика после
// загрузки всех объектов данных, относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПослеЗагрузкиТипа(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
// ОбъектМетаданных - ОбъектМетаданных - после загрузки всех объектов которого
// был вызван обработчик.
//
Процедура ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков)
```
</details>
## ПослеЗагрузкиТипа
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ВыгрузкаЗагрузкаДанныхСлужебныйСобытия.ПриДобавленииСлужебныхСобытий
//
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера
// ОбъектМетаданных - ОбъектМетаданных
//
Процедура ПослеЗагрузкиТипа(Контейнер, ОбъектМетаданных) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.ПослеЗагрузкиТипа(Контейнер, ОбъектМетаданных)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

34
src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхДополнительныхОтчетовИОбработок.md Normal file
View File

@ -0,0 +1,34 @@
---
title: Выгрузка загрузка данных дополнительных отчетов и обработок
slug: bsp/выгрузка-загрузка-данных-дополнительных-отчетов-и-обработок
---
## ПриРегистрацииОбработчиковВыгрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при регистрации произвольных обработчиков выгрузки данных.
// в данной процедуре требуется дополнить таблицу обработчиков информацией о регистрируемых произвольных
// обработчиках выгрузки данных. См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриРегистрацииОбработчиковВыгрузкиДанных.
// @skip-check module-empty-method - особенность реализации.
//
Процедура ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхДополнительныхОтчетовИОбработок.ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

45
src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхКлиент.md Normal file
View File

@ -0,0 +1,45 @@
---
title: Выгрузка загрузка данных клиент
slug: bsp/выгрузка-загрузка-данных-клиент
---
## ПередНачаломРаботыСистемы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
Процедура ПередНачаломРаботыСистемы(Параметры) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхКлиент.ПередНачаломРаботыСистемы(Параметры)
```
</details>
## ПоказатьДиалогПрерваннойЗагрузкиПриНеобходимости
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
Процедура ПоказатьДиалогПрерваннойЗагрузкиПриНеобходимости() Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхКлиент.ПоказатьДиалогПрерваннойЗагрузкиПриНеобходимости()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

535
src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхПереопределяемый.md Normal file
View File

@ -0,0 +1,535 @@
---
title: Выгрузка загрузка данных переопределяемый
slug: bsp/выгрузка-загрузка-данных-переопределяемый
---
## ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполняет массив типов, для которых при выгрузке необходимо использовать аннотацию
// ссылок в файлах выгрузки.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Типы - Массив Из ОбъектМетаданных - массив типов ОбъектМетаданных.
//
Процедура ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке(Типы) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке(Типы)
```
</details>
## ПриЗаполненииТиповОбщихДанныхПоддерживающихСопоставлениеСсылокПриЗагрузке
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполняет массив типов неразделенных данных, для которых поддерживается сопоставление ссылок
// при загрузке данных в другую информационную базу.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Типы - Массив Из ОбъектМетаданных - массив типов ОбъектМетаданных.
//
Процедура ПриЗаполненииТиповОбщихДанныхПоддерживающихСопоставлениеСсылокПриЗагрузке(Типы) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповОбщихДанныхПоддерживающихСопоставлениеСсылокПриЗагрузке(Типы)
```
</details>
## ПриЗаполненииТиповОбщихДанныхНеТребующихСопоставлениеСсылокПриЗагрузке
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполняет массив типов неразделенных данных, для которых не требуется сопоставление ссылок
// при загрузке данных в другую информационную базу, т.к. корректное сопоставление ссылок
// гарантируется с помощью других механизмов.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Типы - Массив Из ОбъектМетаданных - массив типов ОбъектМетаданных.
//
Процедура ПриЗаполненииТиповОбщихДанныхНеТребующихСопоставлениеСсылокПриЗагрузке(Типы) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповОбщихДанныхНеТребующихСопоставлениеСсылокПриЗагрузке(Типы)
```
</details>
## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполняет массив типов, исключаемых из выгрузки и загрузки данных.
//
// Параметры:
// Типы - Массив из ОбъектМетаданных, ФиксированнаяСтруктура:
// * Тип - ОбъектМетаданных
// * Действие - Строка -
// Для добавления структуры рекомендуется применять ВыгрузкаЗагрузкаДанных.ДополнитьТипомИсключаемымИзВыгрузкиЗагрузки
Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы)
```
</details>
## ПередВыгрузкойДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается перед выгрузкой данных.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый в процессе
// выгрузки данных. См. комментарий к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
//
Процедура ПередВыгрузкойДанных(Контейнер) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПередВыгрузкойДанных(Контейнер)
```
</details>
## ПриРегистрацииОбработчиковВыгрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при регистрации произвольных обработчиков выгрузки данных.
// В данной процедуре требуется дополнить таблицу обработкчиков информацией
// о регистрируемых произвольных обработчиках выгрузки данных.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// ТаблицаОбработчиков - ТаблицаЗначений - описание:
// * ОбъектМетаданных - ОбъектМетаданных - при выгрузке данных которого должен вызываться регистрируемый обработчик
// * Обработчик - ОбщийМодуль - общий модуль, в котором реализован произвольный обработчик выгрузки данных.
// Набор экспортных процедур, которые должны быть реализованы в обработчике, зависит от установки значений
// следующих колонок таблицы значений.
// * Версия - Строка - номер версии интерфейса обработчиков выгрузки / загрузки данных, поддерживаемого обработчиком
// * ПередВыгрузкойТипа - Булево - флаг необходимости вызова обработчика перед
// выгрузкой всех объектов информационной базы, относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПередВыгрузкойТипа(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе выгрузи данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера,
// Сериализатор - СериализаторXDTO - инициализированный с поддержкой выполнения
// аннотации ссылок. В случае, если в произвольном обработчике выгрузки требуется
// выполнять выгрузку дополнительных данных - следует использовать
// СериализаторXDTO, переданный в процедуру ПередВыгрузкойТипа() в качестве
// значения параметра Сериализатор, а не полученных с помощью свойства глобального
// контекста СериализаторXDTO,
// ОбъектМетаданных - ОбъектМетаданных - перед выгрузкой данных которого
// был вызван обработчик,
// Отказ - Булево - если в процедуре ПередВыгрузкойТипа() установить значение
// данного параметра равным Истина - выгрузка объектов, соответствующих
// текущему объекту метаданных, выполняться не будет.
// * ПередВыгрузкойОбъекта - Булево - флаг необходимости вызова обработчика перед
// выгрузкой конкретного объекта информационной базы. Если присвоено значение
// Истина - в общем модуле обработчика должна быть реализована экспортируемая процедура
// ПередВыгрузкойОбъекта(), поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе выгрузи данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера,
// МенеджерВыгрузкиОбъекта - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерВыгрузкиДанныхИнформационнойБазы -
// менеджер выгрузки текущего объекта. Подробнее см. комментарий к программному интерфейсу обработки
// ВыгрузкаЗагрузкаДанныхМенеджерВыгрузкиДанныхИнформационнойБазы. Параметр передается только при вызове
// процедур обработчиков, для которых при регистрации указана версия не ниже 1.0.0.1,
// Сериализатор - СериализаторXDTO - инициализированный с поддержкой выполнения
// аннотации ссылок. В случае, если в произвольном обработчике выгрузки требуется
// выполнять выгрузку дополнительных данных - следует использовать
// СериализаторXDTO, переданный в процедуру ПередВыгрузкойОбъекта() в качестве
// значения параметра Сериализатор, а не полученных с помощью свойства глобального
// контекста СериализаторXDTO,
// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект,
// БизнесПроцессОбъект, ЗадачаОбъект, ПланСчетовОбъект, ПланОбменаОбъект,
// ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект, РегистрСведенийНаборЗаписей,
// РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей,
// РегистрРасчетаНаборЗаписей, ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей -
// объект данных информационной базы, перед выгрузкой которого был вызван обработчик.
// Значение, переданное в процедуру ПередВыгрузкойОбъекта() в качестве значения параметра
// Объект может быть модифицировано внутри обработчика ПередВыгрузкойОбъекта(), при
// этом внесенные изменения будут отражены в сериализации объекта в файлах выгрузки, но
// не будут зафиксированы в информационной базе
// Артефакты - Массив Из ОбъектXDTO - набор дополнительной информации, логически неразрывно
// связанной с объектом, но не являющейся его частью (артефакты объекта). Артефакты должны
// сформированы внутри обработчика ПередВыгрузкойОбъекта() и добавлены в массив, переданный
// в качестве значения параметра Артефакты. Каждый артефакт должен являться XDTO-объектом,
// для типа которого в качестве базового типа используется абстрактный XDTO-тип
// {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}Artefact. Допускается использовать XDTO-пакеты,
// помимо изначально поставляемых в составе подсистемы ВыгрузкаЗагрузкаДанных. В дальнейшем
// артефакты, сформированные в процедуре ПередВыгрузкойОбъекта(), будут доступны в процедурах
// обработчиков загрузки данных (см. комментарий к процедуре ПриРегистрацииОбработчиковЗагрузкиДанных().
// Отказ - Булево - если в процедуре ПередВыгрузкойОбъекта() установить значение
// данного параметра равным Истина - выгрузка объекта, для которого был вызван обработчик,
// выполняться не будет.
// * ПослеВыгрузкиТипа - Булево - флаг необходимости вызова обработчика после выгрузки всех
// объектов информационной базы, относящихся к данному объекту метаданных. Если присвоено значение
// Истина - в общем модуле обработчика должна быть реализована экспортируемая процедура
// ПослеВыгрузкиТипа(), поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе выгрузи данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера,
// Сериализатор - СериализаторXDTO - инициализированный с поддержкой выполнения
// аннотации ссылок. В случае, если в произвольном обработчике выгрузки требуется
// выполнять выгрузку дополнительных данных - следует использовать
// СериализаторXDTO, переданный в процедуру ПослеВыгрузкиТипа() в качестве
// значения параметра Сериализатор, а не полученных с помощью свойства глобального
// контекста СериализаторXDTO,
// ОбъектМетаданных - ОбъектМетаданных - после выгрузки данных которого
// был вызван обработчик.
//
Процедура ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков)
```
</details>
## ПослеВыгрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается после выгрузки данных.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый в процессе
// выгрузки данных. См. комментарий к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
//
Процедура ПослеВыгрузкиДанных(Контейнер) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПослеВыгрузкиДанных(Контейнер)
```
</details>
## ПередЗагрузкойДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается перед загрузкой данных.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый в процессе
// загрузки данных. См. комментарий к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
//
Процедура ПередЗагрузкойДанных(Контейнер) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПередЗагрузкойДанных(Контейнер)
```
</details>
## ПриРегистрацииОбработчиковЗагрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при регистрации произвольных обработчиков загрузки данных.
// В данной процедуре требуется дополнить эту таблицу значений информацией
// о регистрируемых произвольных обработчиках загрузки данных.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// ТаблицаОбработчиков - ТаблицаЗначений - описание:
// * ОбъектМетаданных - ОбъектМетаданных - при загрузке данных которого должен вызываться регистрируемый обработчик,
// * Обработчик - ОбщийМодуль - общий модуль, в котором реализован произвольный
// обработчик загрузки данных. Набор экспортных процедур, которые должны
// быть реализованы в обработчике, зависит от установки значений следующих
// колонок таблицы значений.
// * Версия - Строка - номер версии интерфейса обработчиков выгрузки / загрузки данных, поддерживаемого обработчиком.
// * ПередСопоставлениемСсылок - Булево - флаг необходимости вызова обработчика перед
// сопоставлением ссылок (в исходной ИБ и в текущей), относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПередСопоставлениемСсылок(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
// ОбъектМетаданных - ОбъектМетаданных - перед сопоставлением ссылок которого был вызван обработчик.
// СтандартнаяОбработка - Булево - если процедуре ПередСопоставлениемСсылок()
// установить значение данного параметра равным Ложь, вместо стандартного
// сопоставления ссылок (поиск объектов в текущей ИБ с теми же значениями
// естественного ключа, которые были выгружены из ИБ-источника) будет
// вызвана функция СопоставитьСсылки() общего модуля, в процедуре
// ПередСопоставлениемСсылок() которого значение параметра СтандартнаяОбработка
// было установлено равным Ложь.
// Параметры функции СопоставитьСсылки():
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера,
// ТаблицаИсходныхСсылок - ТаблицаЗначений - содержащая информацию о ссылках,
// выгруженных из исходной ИБ. Колонки:
// ИсходнаяСсылка - ЛюбаяСсылка - ссылка объекта исходной ИБ, которую требуется
// сопоставить c ссылкой в текущей ИБ,
// Остальные колонки равным полям естественного ключа объекта, которые в
// процессе выгрузки данных были переданы в функцию
// Обработка.ВыгрузкаЗагрузкаДанныхМенеджерВыгрузкиДанныхИнформационнойБазы.ТребуетсяСопоставитьСсылкуПриЗагрузке()
// Возвращаемое значение функции СопоставитьСсылки() - ТаблицаЗначений, колонки:
// ИсходнаяСсылка - ЛюбаяСсылка - ссылка объекта, выгруженная из исходной ИБ,
// Ссылка - ЛюбаяСсылка - сопоставленная исходной ссылка в текущей ИБ.
// Отказ - Булево - если в процедуре ПередСопоставлениемСсылок() установить значение
// данного параметра равным Истина - сопоставление ссылок, соответствующих
// текущему объекту метаданных, выполняться не будет.
// * ПередЗагрузкойТипа - Булево - флаг необходимости вызова обработчика перед
// загрузкой всех объектов данных, относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПередЗагрузкойТипа(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект - ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
// ОбъектМетаданных - ОбъектМетаданных - перед загрузкой всех данных которого
// был вызван обработчик,
// Отказ - Булево - если в процедуре ПередЗагрузкойТипа() установить значение данного
// параметра равным Истина - загрузка всех объектов данных соответствующих текущему
// объекту метаданных выполняться не будет.
// * ПередЗагрузкойОбъекта - Булево - флаг необходимости вызова обработчика перед
// загрузкой объекта данных, относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПередЗагрузкойОбъекта(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект,
// БизнесПроцессОбъект, ЗадачаОбъект, ПланСчетовОбъект, ПланОбменаОбъект,
// ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект, РегистрСведенийНаборЗаписей,
// РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей,
// РегистрРасчетаНаборЗаписей, ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей -
// объект данных информационной базы, перед загрузкой которого был вызван обработчик.
// Значение, переданное в процедуру ПередЗагрузкойОбъекта() в качестве значения параметра
// Объект может быть модифицировано внутри процедуры обработчика ПередЗагрузкойОбъекта().
// Артефакты - Массив Из ОбъектXDTO - дополнительные данные, логически неразрывно связанные
// с объектом данных, но не являющиеся его частью. Сформированы в экспортируемых процедурах
// ПередВыгрузкойОбъекта() обработчиков выгрузки данных (см. комментарий к процедуре
// ПриРегистрацииОбработчиковВыгрузкиДанных(). Каждый артефакт должен являться XDTO-объектом,
// для типа которого в качестве базового типа используется абстрактный XDTO-тип
// {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}Artefact. Допускается использовать XDTO-пакеты,
// помимо изначально поставляемых в составе подсистемы ВыгрузкаЗагрузкаДанных.
// Отказ - Булево - если в процедуре ПередЗагрузкойОбъекта() установить значение данного
// параметра равным Истина - загрузка объекта данных выполняться не будет.
// * ПослеЗагрузкиОбъекта - Булево - флаг необходимости вызова обработчика после
// загрузки объекта данных, относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПослеЗагрузкиОбъекта(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект - ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект,
// БизнесПроцессОбъект, ЗадачаОбъект, ПланСчетовОбъект, ПланОбменаОбъект,
// ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект, РегистрСведенийНаборЗаписей,
// РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей,
// РегистрРасчетаНаборЗаписей*, ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей -
// объект данных информационной базы, после загрузки которого был вызван обработчик.
// Артефакты - Массив Из ОбъектXDTO - дополнительные данные, логически неразрывно связанные
// с объектом данных, но не являющиеся его частью. Сформированы в экспортируемых процедурах
// ПередВыгрузкойОбъекта() обработчиков выгрузки данных (см. комментарий к процедуре
// ПриРегистрацииОбработчиковВыгрузкиДанных(). Каждый артефакт должен являться XDTO-объектом,
// для типа которого в качестве базового типа используется абстрактный XDTO-тип
// {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}Artefact. Допускается использовать XDTO-пакеты,
// помимо изначально поставляемых в составе подсистемы ВыгрузкаЗагрузкаДанных.
// * ПослеЗагрузкиТипа - Булево - флаг необходимости вызова обработчика после
// загрузки всех объектов данных, относящихся к данному объекту
// метаданных. Если присвоено значение Истина - в общем модуле обработчика должна
// быть реализована экспортируемая процедура ПослеЗагрузкиТипа(),
// поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
// ОбъектМетаданных - ОбъектМетаданных - после загрузки всех объектов которого
// был вызван обработчик.
//
Процедура ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков)
```
</details>
## ПослеЗагрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается после загрузки данных.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый в процессе
// загрузки данных. См. комментарий к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
//
Процедура ПослеЗагрузкиДанных(Контейнер) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПослеЗагрузкиДанных(Контейнер)
```
</details>
## ПриЗагрузкеПользователяИнформационнойБазы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается перед загрузкой пользователя информационной базы.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера,
// Сериализация - ОбъектXDTO - {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}InfoBaseUser,
// сериализация пользователя информационной базы,
// ПользовательИБ - ПользовательИнформационнойБазы - десериализованный из выгрузки,
// Отказ - Булево - при установке значения данного параметра внутри этой процедуры в
// значение Ложь загрузка пользователя информационной базы будет пропущена.
//
Процедура ПриЗагрузкеПользователяИнформационнойБазы(Контейнер, Сериализация, ПользовательИБ, Отказ) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗагрузкеПользователяИнформационнойБазы(Контейнер, Сериализация, ПользовательИБ, Отказ)
```
</details>
## ПослеЗагрузкиПользователяИнформационнойБазы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается после загрузки пользователя информационной базы.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера,
// Сериализация - ОбъектXDTO - {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}InfoBaseUser,
// сериализация пользователя информационной базы,
// ПользовательИБ - ПользовательИнформационнойБазы - десериализованный из выгрузки.
//
Процедура ПослеЗагрузкиПользователяИнформационнойБазы(Контейнер, Сериализация, ПользовательИБ) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПослеЗагрузкиПользователяИнформационнойБазы(Контейнер, Сериализация, ПользовательИБ)
```
</details>
## ПослеЗагрузкиПользователейИнформационнойБазы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается после загрузки всех пользователей информационной базы.
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер
// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий
// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера.
//
Процедура ПослеЗагрузкиПользователейИнформационнойБазы(Контейнер) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПослеЗагрузкиПользователейИнформационнойБазы(Контейнер)
```
</details>
## ПриЗаполненииМетаданныхИсключаемыхИзВыгрузкиВРежимеДляТехническойПоддержки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполняет массив метаданных, исключаемых из выгрузки в режиме для технической поддержки.
// Ссылки на исключаемые ссылочные данные так же будут очищены
// @skip-warning ПустойМетод - переопределяемый метод.
//
// Параметры:
// Типы - Массив Из ОбъектМетаданных - массив типов ОбъектМетаданных.
//
Процедура ПриЗаполненииМетаданныхИсключаемыхИзВыгрузкиВРежимеДляТехническойПоддержки(Типы) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииМетаданныхИсключаемыхИзВыгрузкиВРежимеДляТехническойПоддержки(Типы)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

348
src/content/docs/bsp/ВыгрузкаЗагрузкаОбластейДанных.md Normal file
View File

@ -0,0 +1,348 @@
---
title: Выгрузка загрузка областей данных
slug: bsp/выгрузка-загрузка-областей-данных
---
## ВыгрузитьТекущуюОбластьВАрхив
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выгружает данные приложения в zip-архив, из которого они в дальнейшем могут быть загружены
// в другую информационную базу или область данных с помощью функции
// ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзАрхива().
//
// Параметры:
// АдресДанных - Строка - адрес во временном хранилище, в который нужно поместить результат если данный параметр заполнен
// РежимВыгрузкиДляТехническойПоддержки - Булево - признак выгрузки в режиме для технической поддержки
// ДанныеСхемыКонфигурации - ДвоичныеДанные, Неопределено - двоичные данные схемы конфигурации сформированные методом
// СхемаКонфигурации.ДвоичныеДанныеСхемы(Истина, Ложь)
// ИмяФайлаВыгрузки - Строка, Неопределено - требуемое имя файла выгрузки (zip). Если не указано, для выгрузки будет
// использовано имя нового временного файла
// ВыгружатьДанныеРасширений - Булево - признак выгрузки исходных данных пользовательских расширений
// ПараметрыВыгрузки - Структура, Неопределено - параметры, используемые при выгрузке:
// * ВыгружатьЗарегистрированныеИзмененияДляУзловПланаОбмена - Булево - включение в выгрузку зарегистрированных изменений для узлов плана обмена (по умолчанию: Ложь).
// * ИдентификаторСостояния - УникальныйИдентификатор, Неопределено - если передан, в процессе выполнения будет фиксироваться состояние выполнения и рассчитываться прогресс. Идентификатор будет использоваться как ключ записи в регистре СостоянияВыгрузкиЗагрузкиОбластейДанных.
//
// Возвращаемое значение:
// Структура - с полями:
// * ИмяФайла - Строка - имя файла архива
// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам выгрузки.
//
Функция ВыгрузитьТекущуюОбластьВАрхив(Знач АдресДанных = Неопределено, Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьВАрхив(АдресДанных, );
```
</details>
## ВыгрузитьТекущуюОбластьДанныхВоВременноеХранилище
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выгружает данные приложения в zip-архив, который помещает во временное хранилище.
// В дальнейшем данные из архива могут быть загружены
// в другую информационную базу или область данных с помощью функции
// ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзАрхива().
//
// Параметры:
// АдресХранилища - Строка - адрес во временном хранилище, в который нужно поместить
// zip-архив с данными.
//
Процедура ВыгрузитьТекущуюОбластьДанныхВоВременноеХранилище(АдресХранилища) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьДанныхВоВременноеХранилище(АдресХранилища)
```
</details>
## ЗагрузитьТекущуюОбластьИзАрхива
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Загружает данные приложения из zip архива с XML файлами.
//
// Параметры:
// Архив - Строка, УникальныйИдентификатор - полное имя файла архива с данными или идентификатор файла в МС.
// ЗагружатьПользователей - Булево - флаг необходимости загрузки пользователей
// СвернутьЭлементыСправочникаПользователи - Булево - признак необходимости сворачивания пользователей
// СопоставлениеПользователей - ТаблицаЗначений - описание см. ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива()
// ДанныеРасширений - Структура - содержит информацию о ключе области и восстанавливаемых расширениях:
// * КлючОбластиДанных - Строка - ключ области данных
// * РасширенияДляВосстановления - Массив - список восстанавливаемых расширений
// ПараметрыЗагрузки - Структура, Неопределено - параметры, используемые при загрузке:
// * ИдентификаторСостояния - УникальныйИдентификатор, Неопределено - если передан, в процессе выполнения будет фиксироваться состояние выполнения и рассчитываться прогресс. Идентификатор будет использоваться как ключ записи в регистре СостоянияВыгрузкиЗагрузкиОбластейДанных.
// * АдресХранилищаРезультата - Строка - если передан, результат загрузки будет помещен во временное хранилище по указанному адресу.
// * ПропуститьВосстановлениеРасширений - Булево - если передано значение Истина, восстановление расширений перед загрузкой выполняться не будет.
//
// Возвращаемое значение:
// Структура - с полями:
// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам загрузки.
//
Функция ЗагрузитьТекущуюОбластьИзАрхива(Знач Архив, Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзАрхива(Архив, );
```
</details>
## ЗагрузитьТекущуюОбластьИзТома
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Загружает данные приложения из файла менеджера сервиса.
//
// Параметры:
// ИдентификаторФайла - УникальныйИдентификатор, Структура - полное имя файла архива с данными
// или структура с полями ИдентификаторФайлаПолнойКопии и ИдентификаторФайлаПолнойКопии
// ЗагружатьПользователей - Булево - флаг необходимости загрузки пользователей
// СвернутьЭлементыСправочникаПользователи - Булево - признак необходимости сворачивания пользователей
// СопоставлениеПользователей - ТаблицаЗначений - описание см. ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива()
// ДанныеРасширений - Структура - содержит информацию о ключе области и восстанавливаемых расширениях:
// * КлючОбластиДанных - Строка - ключ области данных
// * РасширенияДляВосстановления - Массив - список восстанавливаемых расширений
// ПараметрыЗагрузки - Структура, Неопределено - параметры, используемые при загрузке:
// * ИдентификаторСостояния - УникальныйИдентификатор, Неопределено - если передан, в процессе выполнения будет фиксироваться состояние выполнения и рассчитываться прогресс. Идентификатор будет использоваться как ключ записи в регистре СостоянияВыгрузкиЗагрузкиОбластейДанных.
//
// Возвращаемое значение:
// Структура - с полями:
// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам загрузки.
//
Функция ЗагрузитьТекущуюОбластьИзТома( Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзТома();
```
</details>
## ЗагрузитьДифференциальнуюКопию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Загружает данные приложения из дифференциальной копии.
//
// Параметры:
// ПолныйАрхив - Строка, УникальныйИдентификатор, Структура - имя файла, идентификатор файла или данные файла полученные с помощью ZipАрхивы.ПрочитатьАрхив().
// ДифференциальныйАрхив - Строка, УникальныйИдентификатор, Структура - имя файла, идентификатор файла или данные файла полученные с помощью ZipАрхивы.ПрочитатьАрхив().
// ЗагружатьПользователей - Булево - флаг необходимости загрузки пользователей.
// СвернутьЭлементыСправочникаПользователи - Булево - признак необходимости сворачивания пользователей.
// СопоставлениеПользователей - ТаблицаЗначений - описание см. ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива().
// ДанныеРасширений - Структура - содержит информацию о ключе области и восстанавливаемых расширениях:
// * КлючОбластиДанных - Строка - ключ области данных
// * РасширенияДляВосстановления - Массив - список восстанавливаемых расширений
// ПараметрыЗагрузки - Структура, Неопределено - параметры, используемые при загрузке:
// * ИдентификаторСостояния - УникальныйИдентификатор, Неопределено - если передан, в процессе выполнения будет фиксироваться состояние выполнения и рассчитываться прогресс. Идентификатор будет использоваться как ключ записи в регистре СостоянияВыгрузкиЗагрузкиОбластейДанных.
//
// Возвращаемое значение:
// Структура - с полями:
// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам загрузки.
//
Функция ЗагрузитьДифференциальнуюКопию( Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьДифференциальнуюКопию();
```
</details>
## ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет совместимость выгрузки из файла с текущей конфигурацией информационной базы.
//
// Параметры:
// ИмяАрхива - Строка - путь к файлу выгрузки.
//
// Возвращаемое значение:
// Булево - Истина если данные из архива могут быть загружены
// в текущую конфигурацию.
//
Функция ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(Знач ИмяАрхива) Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаОбластейДанных.ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(ИмяАрхива)
```
</details>
## ПроверитьВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет совместимость выгрузки из файла с текущей конфигурацией информационной базы.
//
// Параметры:
// ИмяАрхива - Строка - путь к файлу выгрузки.
//
Процедура ПроверитьВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(Знач ИмяАрхива) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаОбластейДанных.ПроверитьВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(ИмяАрхива)
```
</details>
## ПолучитьТипыМоделиДанныхОбласти
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Получает модель данных для дальнейшей загрузки/выгрузки данных
//
// Возвращаемое значение:
// Массив Из ОбъектМетаданных - типы.
Функция ПолучитьТипыМоделиДанныхОбласти() Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаОбластейДанных.ПолучитьТипыМоделиДанныхОбласти()
```
</details>
## ИмяФайлаПолногоАрхива
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает имя файла полного архива
//
// Возвращаемое значение:
// Строка - наименование файла полного архива.
//
Функция ИмяФайлаПолногоАрхива() Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаОбластейДанных.ИмяФайлаПолногоАрхива()
```
</details>
## ВыгрузитьТекущуюОбластьДанныхВАрхив
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьВАрхив
// Выгружает данные приложения в zip-архив, из которого они в дальнейшем могут быть загружены
// в другую информационную базу или область данных с помощью функции
// ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзАрхива().
//
// Параметры:
// АдресДанных - Строка - адрес во временном хранилище, в который нужно поместить результат если данный параметр заполнен
// РежимВыгрузкиДляТехническойПоддержки - Булево - признак выгрузки в режиме для технической поддержки
//
// Возвращаемое значение:
// Строка - путь к файлу выгрузки.
//
Функция ВыгрузитьТекущуюОбластьДанныхВАрхив(Знач АдресДанных = Неопределено, Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьДанныхВАрхив(АдресДанных, );
```
</details>
## ВыгрузитьТекущуюОбластьДанныхВФайлИРазделитьНаЧасти
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьВАрхив
// Выгружает данные приложения в zip-архив, разбивает, при необходимости,
// на части и помещает результат во временное хранилище.
//
// Параметры:
// АдресХранилища - Строка - адрес во временном хранилище для размещения результата
// АдресХранилищаФайла - Строка - адрес во временном хранилище для размещения файла
// ЭтоВебКлиент - Булево - признак веб клиента
// РазмерЧастиВМегабайтах - Число - размер одной части файла в мегабайтах
// РежимВыгрузкиДляТехническойПоддержки - Булево - признак выгрузки в режиме для технической поддержки
//
Процедура ВыгрузитьТекущуюОбластьДанныхВФайлИРазделитьНаЧасти(АдресХранилища, Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьДанныхВФайлИРазделитьНаЧасти(АдресХранилища, );
```
</details>
## ЗагрузитьТекущуюОбластьДанныхИзАрхива
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзАрхива
// Загружает данные приложения из zip архива с XML файлами.
//
// Параметры:
// ИмяАрхива - Строка - полное имя файла архива с данными
// ЗагружатьПользователей - Булево - флаг необходимости загрузки пользователей
// СвернутьЭлементыСправочникаПользователи - Булево - признак необходимости сворачивания пользователей
// СопоставлениеПользователей - ТаблицаЗначений - описание см. ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива()
// ДанныеРасширений - Структура - содержит информацию о ключе области и восстанавливаемых расширениях:
// * КлючОбластиДанных - Строка - ключ области данных
// * РасширенияДляВосстановления - Массив - список восстанавливаемых расширений
//
Процедура ЗагрузитьТекущуюОбластьДанныхИзАрхива(Знач ИмяАрхива, Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьДанныхИзАрхива(ИмяАрхива, );
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

61
src/content/docs/bsp/ВыгрузкаЗагрузкаПользователейИнформационнойБазы.md Normal file
View File

@ -0,0 +1,61 @@
---
title: Выгрузка загрузка пользователей информационной базы
slug: bsp/выгрузка-загрузка-пользователей-информационной-базы
---
## ВыгрузитьПользователейИнформационнойБазы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
Процедура ВыгрузитьПользователейИнформационнойБазы(Контейнер) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаПользователейИнформационнойБазы.ВыгрузитьПользователейИнформационнойБазы(Контейнер)
```
</details>
## ЗагрузитьПользователейИнформационнойБазы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
Процедура ЗагрузитьПользователейИнформационнойБазы(Контейнер) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаПользователейИнформационнойБазы.ЗагрузитьПользователейИнформационнойБазы(Контейнер)
```
</details>
## СоздатьПользователяСАдминистративнымиПравами
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
Процедура СоздатьПользователяСАдминистративнымиПравами() Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаПользователейИнформационнойБазы.СоздатьПользователяСАдминистративнымиПравами());
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

215
src/content/docs/bsp/ВыгрузкаЗагрузкаПредопределенныхДанных.md Normal file
View File

@ -0,0 +1,215 @@
---
title: Выгрузка загрузка предопределенных данных
slug: bsp/выгрузка-загрузка-предопределенных-данных
---
## ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполняет массив типов, для которых при выгрузке необходимо использовать аннотацию
// ссылок в файлах выгрузки.
//
// Параметры:
// Типы - Массив Из ОбъектМетаданных - объекты метаданных.
//
Процедура ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке(Типы) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаПредопределенныхДанных.ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке(Типы)
```
</details>
## ПриРегистрацииОбработчиковВыгрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при регистрации произвольных обработчиков выгрузки данных.
// В данной процедуре требуется дополнить эту таблицу значений информацией
// о регистрируемых произвольных обработчиках выгрузки данных.
//
// Параметры:
// ТаблицаОбработчиков - ТаблицаЗначений - колонки:
// * ОбъектМетаданных - ОбъектМетаданных - при выгрузке данных которого должен вызываться регистрируемый обработчик,
// * Обработчик - ОбщийМодуль - общий модуль, в котором реализован произвольный обработчик выгрузки данных.
// Набор экспортных процедур, которые должны быть реализованы в обработчике, зависит от установки значений
// следующих колонок таблицы значений.
// * Версия - Строка - номер версии интерфейса обработчиков выгрузки / загрузки данных, поддерживаемого обработчиком.
// * ПередВыгрузкойТипа - Булево - флаг необходимости вызова обработчика перед выгрузкой всех объектов информационной
// базы, относящихся к данному объекту метаданных. Если присвоено значение Истина - в общем модуле обработчика
// должна быть реализована экспортируемая процедура ПередВыгрузкойТипа(), поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый
// в процессе выгрузи данных. Подробнее см. комментарий к программному интерфейсу обработки.
// Сериализатор - СериализаторXDTO - инициализированный с поддержкой выполнения аннотации ссылок. В случае,
// если в произвольном обработчике выгрузки требуется выполнять выгрузку дополнительных данных - следует
// использовать СериализаторXDTO, переданный в процедуру ПередВыгрузкойТипа() в качестве значения параметра
// Сериализатор, а не полученных с помощью свойства глобального контекста СериализаторXDTO.
// ОбъектМетаданных - ОбъектМетаданных - перед выгрузкой данных которого был вызван обработчик.
// Отказ - Булево - если в процедуре ПередВыгрузкойТипа() установить значение данного параметра равным
// Истина - выгрузка объектов, соответствующих текущему объекту метаданных, выполняться не будет.
// * ПередВыгрузкойОбъекта - Булево - флаг необходимости вызова обработчика перед выгрузкой конкретного объекта
// информационной базы. Если присвоено значение Истина - в общем модуле обработчика должна быть реализована
// экспортируемая процедура ПередВыгрузкойОбъекта(), поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый
// в процессе выгрузи данных. Подробнее см. комментарий к программному интерфейсу обработки.
// МенеджерВыгрузкиОбъекта - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерВыгрузкиДанныхИнформационнойБазы -
// менеджер выгрузки текущего объекта. Подробнее см. комментарий к программному интерфейсу обработки
// ВыгрузкаЗагрузкаДанныхМенеджерВыгрузкиДанныхИнформационнойБазы. Параметр передается только при вызове
// процедур обработчиков, для которых при регистрации указана версия не ниже 1.0.0.1.
// Сериализатор - СериализаторXDTO - инициализированный с поддержкой выполнения аннотации ссылок. В случае,
// если в произвольном обработчике выгрузки требуется выполнять выгрузку дополнительных данных - следует
// использовать СериализаторXDTO, переданный в процедуру ПередВыгрузкойОбъекта() в качестве значения
// параметра Сериализатор, а не полученных с помощью свойства глобального контекста СериализаторXDTO.
// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект, БизнесПроцессОбъект, ЗадачаОбъект,
// ПланСчетовОбъект, ПланОбменаОбъект, ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект,
// РегистрСведенийНаборЗаписей, РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей,
// РегистрРасчетаНаборЗаписей, ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей - объект данных
// информационной базы, перед выгрузкой которого был вызван обработчик. Значение, переданное в процедуру
// ПередВыгрузкойОбъекта() в качестве значения параметра Объект может быть модифицировано внутри обработчика
// ПередВыгрузкойОбъекта(), при этом внесенные изменения будут отражены в сериализации объекта в файлах
// выгрузки, но не будут зафиксированы в информационной базе
// Артефакты - Массив Из ОбъектXDTO - набор дополнительной информации, логически неразрывно связанной с объектом,
// но не являющейся его частью (артефакты объекта). Артефакты должны сформированы внутри обработчика
// ПередВыгрузкойОбъекта() и добавлены в массив, переданный в качестве значения параметра Артефакты.
// Каждый артефакт должен являться XDTO-объектом, для типа которого в качестве базового типа используется
// абстрактный XDTO-тип {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}Artefact. Допускается использовать
// XDTO-пакеты, помимо изначально поставляемых в составе подсистемы ВыгрузкаЗагрузкаДанных. В дальнейшем
// артефакты, сформированные в процедуре ПередВыгрузкойОбъекта(), будут доступны в процедурах
// обработчиков загрузки данных (см. комментарий к процедуре ПриРегистрацииОбработчиковЗагрузкиДанных().
// Отказ - Булево - если в процедуре ПередВыгрузкойОбъекта() установить значение данного параметра
// равным Истина - выгрузка объекта, для которого был вызван обработчик, выполняться не будет.
// * ПослеВыгрузкиТипа - Булево - флаг необходимости вызова обработчика после выгрузки всех объектов информационной
// базы, относящихся к данному объекту метаданных. Если присвоено значение Истина - в общем модуле обработчика
// должна быть реализована экспортируемая процедура ПослеВыгрузкиТипа(), поддерживающая следующие параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый
// в процессе выгрузи данных. Подробнее см. комментарий к программному интерфейсу обработки.
// Сериализатор - СериализаторXDTO - инициализированный с поддержкой выполнения аннотации ссылок. В случае,
// если в произвольном обработчике выгрузки требуется выполнять выгрузку дополнительных данных - следует
// использовать СериализаторXDTO, переданный в процедуру ПослеВыгрузкиТипа() в качестве значения параметра
// Сериализатор, а не полученных с помощью свойства глобального контекста СериализаторXDTO,
// ОбъектМетаданных - ОбъектМетаданных - после выгрузки данных которого был вызван обработчик.
//
Процедура ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаПредопределенныхДанных.ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков)
```
</details>
## ПослеВыгрузкиОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
Процедура ПослеВыгрузкиОбъекта(Контейнер, МенеджерВыгрузкиОбъекта, Сериализатор, Объект, Артефакты) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаПредопределенныхДанных.ПослеВыгрузкиОбъекта(Контейнер, МенеджерВыгрузкиОбъекта, Сериализатор, Объект, Артефакты)
```
</details>
## ПриРегистрацииОбработчиковЗагрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры:
// ТаблицаОбработчиков - см. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриРегистрацииОбработчиковЗагрузкиДанных.ТаблицаОбработчиков
Процедура ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаПредопределенныхДанных.ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков)
```
</details>
## ПередСопоставлениемСсылок
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера.
// ОбъектМетаданных - ОбъектМетаданных - объект метаданных.
// ТаблицаИсходныхСсылок - ТаблицаЗначений - таблица ссылок.
// СтандартнаяОбработка - Булево - признак страндартной обработки.
// Отказ - Булево - признак отказа от обработки.
Процедура ПередСопоставлениемСсылок(Контейнер, ОбъектМетаданных, ТаблицаИсходныхСсылок, СтандартнаяОбработка, Отказ) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаПредопределенныхДанных.ПередСопоставлениемСсылок(Контейнер, ОбъектМетаданных, ТаблицаИсходныхСсылок, СтандартнаяОбработка, Отказ)
```
</details>
## СопоставитьСсылки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Параметры:
// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый в процессе
// загрузки данных. Подробнее см. комментарий к программному интерфейсу обработки.
// МенеджерСопоставленияСсылок - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерСопоставленияСсылок -
// ТаблицаИсходныхСсылок - ТаблицаЗначений - содержащая информацию о ссылках, выгруженных из исходной ИБ. Колонки:
// * ИсходнаяСсылка - ЛюбаяСсылка - ссылка объекта исходной ИБ, которую требуется сопоставить c ссылкой в текущей ИБ,
// Остальные колонки равным полям естественного ключа объекта.
// Возвращаемое значение:
// ТаблицаЗначений - колонки:
// * ИсходнаяСсылка - ЛюбаяСсылка - ссылка объекта, выгруженная из исходной ИБ,
// * Ссылка - ЛюбаяСсылка - сопоставленная исходной ссылка в текущей ИБ.
Функция СопоставитьСсылки(Контейнер, МенеджерСопоставленияСсылок, ТаблицаИсходныхСсылок) Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаЗагрузкаПредопределенныхДанных.СопоставитьСсылки(Контейнер, МенеджерСопоставленияСсылок, ТаблицаИсходныхСсылок)
```
</details>
## ПередЗагрузкойОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
Процедура ПередЗагрузкойОбъекта(Контейнер, Объект, Артефакты, Отказ) Экспорт
```
Пример вызова
```bsl
ВыгрузкаЗагрузкаПредопределенныхДанных.ПередЗагрузкойОбъекта(Контейнер, Объект, Артефакты, Отказ)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

43
src/content/docs/bsp/ВыгрузкаОбъектовВФайлы.md Normal file
View File

@ -0,0 +1,43 @@
---
title: Выгрузка объектов в файлы
slug: bsp/выгрузка-объектов-в-файлы
---
## СохранитьПоФорматуВФайл
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выгружает объекты в требуемом формате и записывает в файлы.
//
// Параметры:
// КомандыВыгрузки - Структура
// - Массив - команда или несколько команд выгрузки,
// см. УправлениеПечатью.КомандыПечатиФормы.
// СписокОбъектов - Массив из СправочникСсылка, ДокументСсылка - ссылки на сохраняемые объекты.
// НастройкиСохранения - см. УправлениеПечатью.НастройкиСохранения.
//
// Возвращаемое значение:
// ТаблицаЗначений:
// * ИмяФайла - Строка - имя файла;
// * ДвоичныеДанные - ДвоичныеДанные - файл печатной формы.
//
Функция СохранитьПоФорматуВФайл(КомандыВыгрузки, СписокОбъектов, НастройкиСохранения) Экспорт
```
Пример вызова
```bsl
Результат = ВыгрузкаОбъектовВФайлы.СохранитьПоФорматуВФайл(КомандыВыгрузки, СписокОбъектов, НастройкиСохранения)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

155
src/content/docs/bsp/ГенерацияШтрихкода.md Normal file
View File

@ -0,0 +1,155 @@
---
title: Генерация штрихкода
slug: bsp/генерация-штрихкода
---
## ПараметрыГенерацииШтрихкода
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Пустая структура для заполнения параметра "ПараметрыШтрихкода" используемого для получения изображения штрих кода.
//
// Возвращаемое значение:
// Структура:
// * Ширина - Число - ширина изображения штрих кода.
// * Высота - Число - высота изображения штрих кода.
// * ТипКода - Число - штрихкода.
// Возможные значение:
// 99 - Авто выбор
// 0 - EAN8
// 1 - EAN13
// 2 - EAN128
// 3 - Code39
// 4 - Code128
// 5 - Code16k
// 6 - PDF417
// 7 - Standart (Industrial) 2 of 5
// 8 - Interleaved 2 of 5
// 9 - Code39 Расширение
// 10 - Code93
// 11 - ITF14
// 12 - RSS14
// 14 - EAN13AddOn2
// 15 - EAN13AddOn5
// 16 - QR
// 17 - GS1DataBarExpandedStacked
// 18 - Datamatrix ASCII
// 19 - Datamatrix BASE256
// 20 - Datamatrix TEXT
// 21 - Datamatrix C40
// 22 - Datamatrix X12
// 23 - Datamatrix EDIFACT
// 24 - Datamatrix GS1ASCII
// 25 - Aztec
// * ОтображатьТекст - Булево - отображать HRI теста для штрихкода.
// * РазмерШрифта - Число - размер шрифта HRI теста для штрихкода.
// * УголПоворота - Число - угол поворота.
// Возможные значения: 0, 90, 180, 270.
// * Штрихкод - Строка - значение штрихкод в виде строки или Base64.
// * ТипВходныхДанных - Число - тип входных данных
// Возможные значения: 0 - Строка, 1 - Base64
// * ПрозрачныйФон - Булево - прозрачный фон изображения штрихкода.
// * УровеньКоррекцииQR - Число - уровень коррекции штрихкода QR.
// Возможные значения: 0 - L, 1 - M, 2 - Q, 3 - H.
// * Масштабировать - Булево - масштабировать изображение штрихкода.
// * СохранятьПропорции - Булево - сохранять пропорции изображения штрихкода.
// * ВертикальноеВыравнивание - Число - вертикальное выравнивание штрихкода.
// Возможные значения: 1 - По верхнему краю, 2 - По центру, 3 - По нижнему краю
// * GS1DatabarКоличествоСтрок - Число - количество строк в штрихкоде GS1Databar.
// * УбратьЛишнийФон - Булево
// * ЛоготипКартинка - Строка - строка с base64 представлением png картинки логотипа.
// * ЛоготипРазмерПроцентОтШК - Число - процент от генерированного QR для вписывания логотипа.
//
Функция ПараметрыГенерацииШтрихкода() Экспорт
```
Пример вызова
```bsl
Результат = ГенерацияШтрихкода.ПараметрыГенерацииШтрихкода()
```
</details>
## ИзображениеШтрихкода
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Формирование изображения штрихкода.
//
// Параметры:
// ПараметрыШтрихкода - см. ГенерацияШтрихкода.ПараметрыГенерацииШтрихкода.
//
// Возвращаемое значение:
// Структура:
// Результат - Булево - результат генерации штрихкода.
// ДвоичныеДанные - ДвоичныеДанные - двоичные данные изображения штрихкода.
// Картинка - Картинка - картинка с сформированным штрихкодом или НЕОПРЕДЕЛЕНО.
//
Функция ИзображениеШтрихкода(ПараметрыШтрихкода) Экспорт
```
Пример вызова
```bsl
Результат = ГенерацияШтрихкода.ИзображениеШтрихкода(ПараметрыШтрихкода)
```
</details>
## ДанныеQRКода
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает двоичные данные для формирования QR-кода.
//
// Параметры:
// QRСтрока - Строка - данные, которые необходимо разместить в QR-коде.
//
// УровеньКоррекции - Число - уровень погрешности изображения, при котором данный QR-код все еще возможно 100%
// распознать.
// Параметр должен иметь тип целого и принимать одно из 4 допустимых значений:
// 0 (7 % погрешности), 1 (15 % погрешности), 2 (25 % погрешности), 3 (35 % погрешности).
//
// Размер - Число - определяет длину стороны выходного изображения в пикселях.
// Если минимально возможный размер изображения больше этого параметра - код сформирован не будет.
//
// Возвращаемое значение:
// ДвоичныеДанные - буфер, содержащий байты PNG-изображения QR-кода.
//
// Пример:
//
// // Выводим на печать QR-код, содержащий в себе информацию зашифрованную по УФЭБС.
//
// QRСтрока = УправлениеПечатью.ФорматнаяСтрокаУФЭБС(РеквизитыПлатежа);
// ТекстОшибки = "";
// ДанныеQRКода = УправлениеПечатью.ДанныеQRКода(QRСтрока, 0, 190, ТекстОшибки);
// Если Не ПустаяСтрока(ТекстОшибки)
// ОбщегоНазначения.СообщитьПользователю(ТекстОшибки);
// КонецЕсли;
//
// КартинкаQRКода = Новый Картинка(ДанныеQRКода);
// ОбластьМакета.Рисунки.QRКод.Картинка = КартинкаQRКода;
//
Функция ДанныеQRКода(QRСтрока, УровеньКоррекции, Размер) Экспорт
```
Пример вызова
```bsl
Результат = ГенерацияШтрихкода.ДанныеQRКода(QRСтрока, УровеньКоррекции, Размер)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

190
src/content/docs/bsp/ГрафикиРаботы.md Normal file
View File

@ -0,0 +1,190 @@
---
title: Графики работы
slug: bsp/графики-работы
---
## ДатыПоГрафику
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает даты, которые отличаются указанной даты ДатаОт на количество дней,
// входящих в указанный график ГрафикРаботы.
//
// Параметры:
// ГрафикРаботы - СправочникСсылка.Календари - график, который необходимо использовать.
// ДатаОт - Дата - дата, от которой нужно рассчитать количество дней.
// МассивДней - Массив - количество дней (Число), на которые нужно увеличить дату начала.
// РассчитыватьСледующуюДатуОтПредыдущей - Булево - нужно ли рассчитывать следующую дату от предыдущей,
// или все даты рассчитываются от переданной даты.
// ВызыватьИсключение - Булево - если Истина, вызывается исключение в случае незаполненного графика.
//
// Возвращаемое значение:
// Массив, Неопределено - даты, увеличенные на количество дней, входящих в график ГрафикРаботы.
// Если график ГрафикРаботы не заполнен, и ВызыватьИсключение = Ложь, возвращается Неопределено.
//
Функция ДатыПоГрафику(Знач ГрафикРаботы, Знач ДатаОт, Знач МассивДней, Экспорт
```
Пример вызова
```bsl
Результат = ГрафикиРаботы.ДатыПоГрафику(ГрафикРаботы, ДатаОт, МассивДней, );
```
</details>
## ДатаПоГрафику
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает дату, которая отличается указанной даты ДатаОт на количество дней,
// входящих в указанный график ГрафикРаботы.
//
// Параметры:
// ГрафикРаботы - СправочникСсылка.Календари - график, который необходимо использовать.
// ДатаОт - Дата - дата, от которой нужно рассчитать количество дней.
// КоличествоДней - Число - количество дней, на которые нужно увеличить дату начала ДатаОт.
// ВызыватьИсключение - Булево - если Истина, вызывается исключение в случае незаполненного графика.
//
// Возвращаемое значение:
// Дата, Неопределено - дата, увеличенная на количество дней, входящих в график ГрафикРаботы.
// Если график ГрафикРаботы не заполнен, и ВызыватьИсключение = Ложь, возвращается Неопределено.
//
Функция ДатаПоГрафику(Знач ГрафикРаботы, Знач ДатаОт, Знач КоличествоДней, ВызыватьИсключение = Истина) Экспорт
```
Пример вызова
```bsl
Результат = ГрафикиРаботы.ДатаПоГрафику(ГрафикРаботы, ДатаОт, КоличествоДней, ВызыватьИсключение);
```
</details>
## ПараметрыПолученияБлижайшихДатПоГрафику
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Конструктор параметров получения ближайших к заданным дат, включенных в график.
// См. БлижайшиеРабочиеДаты.
//
// Возвращаемое значение:
// Структура:
// * ПолучатьПредшествующие - Булево - способ получения ближайшей даты:
// если Истина - определяются рабочие даты, предшествующие переданным в параметре НачальныеДаты,
// если Ложь - получаются ближайшие рабочие даты, следующие за начальными датами.
// Значение по умолчанию - Ложь:
// * ИгнорироватьНезаполненностьГрафика - Булево - если Истина, то в любом случае будет возвращено соответствие.
// Начальные даты, для которых не будет значений из-за незаполненности графика, включены не будут.
// Значение по умолчанию - Ложь:
// * ВызыватьИсключение - Булево - вызов исключения в случае не заполненного графика
// если Истина, вызвать исключение, если график не заполнен.
// если Ложь - даты, по которым не удалось определить ближайшую дату, будут просто пропущены.
// Значение по умолчанию - Истина.
//
Функция ПараметрыПолученияБлижайшихДатПоГрафику() Экспорт
```
Пример вызова
```bsl
Результат = ГрафикиРаботы.ПараметрыПолученияБлижайшихДатПоГрафику()
```
</details>
## БлижайшиеДатыВключенныеВГрафик
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет для каждой даты дату ближайшего к дня, включенного в график.
//
// Параметры:
// ГрафикРаботы - СправочникСсылка.Календари
// НачальныеДаты - Массив из Дата - даты, относительно которых нужно найти ближайшие.
// ПараметрыПолучения - см. ПараметрыПолученияБлижайшихДатПоГрафику.
//
// Возвращаемое значение:
// Соответствие из КлючИЗначение:
// * Ключ - Дата - начальная дата.
// * Значение - Дата - ближайшая к ней дата, включенная в график.
//
Функция БлижайшиеДатыВключенныеВГрафик(ГрафикРаботы, НачальныеДаты, ПараметрыПолучения = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ГрафикиРаботы.БлижайшиеДатыВключенныеВГрафик(ГрафикРаботы, НачальныеДаты, ПараметрыПолучения);
```
</details>
## РасписанияРаботыНаПериод
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Составляет расписания работы для дат, включенных в указанные графики на указанный период.
// Если расписание на предпраздничный день не задано, то оно определяется так, как если бы этот день был бы рабочим.
//
// Параметры:
// Графики - Массив - массив элементов типа СправочникСсылка.Календари, для которых составляются расписания.
// ДатаНачала - Дата - дата начала периода, за который нужно составить расписания.
// ДатаОкончания - Дата - дата окончания периода.
//
// Возвращаемое значение:
// ТаблицаЗначений:
// * ГрафикРаботы - СправочникСсылка.Календари - график работы.
// * ДатаГрафика - Дата - дата в графике работы ГрафикРаботы.
// * ВремяНачала - Дата - время начала работы в день ДатаГрафика.
// * ВремяОкончания - Дата - время окончания работы в день ДатаГрафика.
//
Функция РасписанияРаботыНаПериод(Графики, ДатаНачала, ДатаОкончания) Экспорт
```
Пример вызова
```bsl
Результат = ГрафикиРаботы.РасписанияРаботыНаПериод(Графики, ДатаНачала, ДатаОкончания)
```
</details>
## СоздатьВТРасписанияРаботыНаПериод
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Создает в менеджере временную таблицу ВТРасписанияРаботы с колонками, соответствующими возвращаемому значению
// функции РасписанияРаботыНаПериод.
//
// Параметры:
// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - менеджер, в котором будет создана временная таблица.
// Графики - Массив - массив элементов типа СправочникСсылка.Календари, для которых составляются расписания.
// ДатаНачала - Дата - дата начала периода, за который нужно составить расписания.
// ДатаОкончания - Дата - дата окончания периода.
//
Процедура СоздатьВТРасписанияРаботыНаПериод(МенеджерВременныхТаблиц, Графики, ДатаНачала, ДатаОкончания) Экспорт
```
Пример вызова
```bsl
ГрафикиРаботы.СоздатьВТРасписанияРаботыНаПериод(МенеджерВременныхТаблиц, Графики, ДатаНачала, ДатаОкончания)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

36
src/content/docs/bsp/ГрупповоеИзменениеОбъектовКлиент.md Normal file
View File

@ -0,0 +1,36 @@
---
title: Групповое изменение объектов клиент
slug: bsp/групповое-изменение-объектов-клиент
---
## ИзменитьВыделенные
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает диалог группового изменения реквизитов для выбранных в списке объектов.
//
// Параметры:
// СписокЭлемент - ТаблицаФормы
// - Массив из ЛюбаяСсылка - элемент формы со списком.
// СписокРеквизит - ДинамическийСписок - реквизит формы со списком.
//
Процедура ИзменитьВыделенные(СписокЭлемент, Знач СписокРеквизит = Неопределено) Экспорт
```
Пример вызова
```bsl
ГрупповоеИзменениеОбъектовКлиент.ИзменитьВыделенные(СписокЭлемент, СписокРеквизит);
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

101
src/content/docs/bsp/ГрупповоеИзменениеОбъектовПереопределяемый.md Normal file
View File

@ -0,0 +1,101 @@
---
title: Групповое изменение объектов переопределяемый
slug: bsp/групповое-изменение-объектов-переопределяемый
---
## ПриОпределенииОбъектовСКомандойГрупповогоИзмененияОбъектов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определить объекты метаданных, в формах списков которых
// будет выведена команда группового изменения выделенных объектов.
// см. ГрупповоеИзменениеОбъектовКлиент.ИзменитьВыделенные
//
// Параметры:
// Объекты - Массив из ОбъектМетаданных
//
// Пример:
// Объекты.Добавить(Метаданные.Справочники.Номенклатура);
// Объекты.Добавить(Метаданные.Справочники.Контрагенты);
//
Процедура ПриОпределенииОбъектовСКомандойГрупповогоИзмененияОбъектов(Объекты) Экспорт
```
Пример вызова
```bsl
ГрупповоеИзменениеОбъектовПереопределяемый.ПриОпределенииОбъектовСКомандойГрупповогоИзмененияОбъектов(Объекты)
```
</details>
## ПриОпределенииОбъектовСРедактируемымиРеквизитами
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определить объекты метаданных, в модулях менеджеров которых ограничивается возможность
// редактирования реквизитов при групповом изменении.
//
// Параметры:
// Объекты - Соответствие из КлючИЗначение - в качестве ключа указать полное имя объекта метаданных,
// подключенного к подсистеме "Групповое изменение объектов".
// Дополнительно в значении могут быть перечислены имена экспортных функций:
// "РеквизитыНеРедактируемыеВГрупповойОбработке",
// "РеквизитыРедактируемыеВГрупповойОбработке".
// Каждое имя должно начинаться с новой строки.
// Если указано "*", значит, в модуле менеджера определены обе функции.
//
// Пример:
// Объекты.Вставить(Метаданные.Документы.ЗаказПокупателя.ПолноеИмя(), "*"); // определены обе функции.
// Объекты.Вставить(Метаданные.БизнесПроцессы.ЗаданиеСРолевойАдресацией.ПолноеИмя(), "РеквизитыРедактируемыеВГрупповойОбработке");
// Объекты.Вставить(Метаданные.Справочники.Партнеры.ПолноеИмя(), "РеквизитыРедактируемыеВГрупповойОбработке
// |РеквизитыНеРедактируемыеВГрупповойОбработке");
//
Процедура ПриОпределенииОбъектовСРедактируемымиРеквизитами(Объекты) Экспорт
```
Пример вызова
```bsl
ГрупповоеИзменениеОбъектовПереопределяемый.ПриОпределенииОбъектовСРедактируемымиРеквизитами(Объекты)
```
</details>
## ПриОпределенииРедактируемыхРеквизитовОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет реквизиты объекта, которые разрешается редактировать с помощью обработки группового изменения реквизитов.
// По умолчанию все реквизиты объекта разрешено редактировать. Для ограничения списка реквизитов необходимо заполнить
// одну из коллекций РедактируемыеРеквизиты и НередактируемыеРеквизиты. Если заполнены обе коллекции, то для разрешения
// неоднозначности приоритет отдается в пользу коллекции НередактируемыеРеквизиты.
//
// Параметры:
// Объект - ОбъектМетаданных - объект, для которого устанавливается список редактируемых реквизитов.
// РедактируемыеРеквизиты - Неопределено, Массив из Строка - имена редактируемых групповой обработкой реквизитов объекта.
// Значение игнорируется, если заполнен параметр НередактируемыеРеквизиты.
// НередактируемыеРеквизиты - Неопределено, Массив из Строка - имена не редактируемых групповой обработкой реквизитов объекта.
//
Процедура ПриОпределенииРедактируемыхРеквизитовОбъекта(Объект, РедактируемыеРеквизиты, НередактируемыеРеквизиты) Экспорт
```
Пример вызова
```bsl
ГрупповоеИзменениеОбъектовПереопределяемый.ПриОпределенииРедактируемыхРеквизитовОбъекта(Объект, РедактируемыеРеквизиты, НередактируемыеРеквизиты)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

582
src/content/docs/bsp/ДатыЗапретаИзменения.md Normal file
View File

@ -0,0 +1,582 @@
---
title: Даты запрета изменения
slug: bsp/даты-запрета-изменения
---
## ИзменениеЗапрещено
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет, запрещено ли изменение данных при интерактивном редактировании пользователем
// или при программной загрузке данных из узла плана обмена УзелПроверкиЗапретаЗагрузки.
//
// Параметры:
// ДанныеИлиПолноеИмя - СправочникОбъект
// - ДокументОбъект
// - ПланВидовХарактеристикОбъект
// - ПланСчетовОбъект
// - ПланВидовРасчетаОбъект
// - БизнесПроцессОбъект
// - ЗадачаОбъект
// - ПланОбменаОбъект - проверяемый объект данных.
// - РегистрСведенийНаборЗаписей
// - РегистрНакопленияНаборЗаписей
// - РегистрБухгалтерииНаборЗаписей
// - РегистрРасчетаНаборЗаписей - проверяемый набор записей с необязательным
// свойством Замещение (Булево, РежимЗамещения) в структуре ДополнительныеСвойства,
// если свойство Замещение не указано, тогда оно будет вставлено со значением Истина.
// - Строка - полное имя объекта метаданных, данные которого следует проверить в базе данных.
// Например: "Документ.ПриходнаяНакладная".
// В этом случае следует указать в параметре ИдентификаторДанных,
// какие именно данные требуется прочитать из базы и проверить.
//
// ИдентификаторДанных - СправочникСсылка
// - ДокументСсылка
// - ПланВидовХарактеристикСсылка
// - ПланСчетовСсылка
// - ПланВидовРасчетаСсылка
// - БизнесПроцессСсылка
// - ЗадачаСсылка
// - ПланОбменаСсылка
// - Отбор - ссылка на элемент данных или отбор набора записей, который нужно проверить.
// При этом значение для проверки будет получено из базы данных.
// - РегистрСведенийНаборЗаписей
// - РегистрНакопленияНаборЗаписей
// - РегистрБухгалтерииНаборЗаписей
// - РегистрРасчетаНаборЗаписей - набор записей со свойством Замещение (Булево, РежимЗамещения)
// в структуре ДополнительныеСвойства и настроенным свойством Отбор в варианте замены записей,
// как в обработчике ПередЗаписью, для получения заменяемых записей из базы данных.
// - Неопределено - если не требуется получать значение для проверки из базы данных,
// а нужно проверить только данные самого объекта в ДанныеИлиПолноеИмя.
//
// ОписаниеОшибки - Null - значение по умолчанию. Сведения о запретах не требуются.
// - Строка - возвращаемое значение. Вернуть текстовое описание найденных запретов.
// - Структура - возвращаемое значение. вернуть структурное описание найденных запретов,
// подробнее см. функцию ДатыЗапретаИзменения.НайденЗапретИзмененияДанных.
//
// УзелПроверкиЗапретаЗагрузки - Неопределено
// - ПланОбменаСсылка - если Неопределено, то проверить запрет
// изменения данных; иначе - загрузку данных из указанного узла плана обмена.
//
// Возвращаемое значение:
// Булево - Истина, если изменение данных запрещено.
//
// Варианты вызова:
// ИзменениеЗапрещено(СправочникОбъект...) - проверить данные в переданном объекте (наборе записей).
// ИзменениеЗапрещено(Строка, СправочникСсылка...) - проверить данные, полученные из базы данных
// по полному имени объекта метаданных и ссылке (отбору набора записей).
// ИзменениеЗапрещено(СправочникОбъект..., СправочникСсылка...) - проверить одновременно
// данные в переданном объекте и данные в базе (т.е. "до" и "после" записи в базу, если проверка выполняется
// перед записью объекта).
//
Функция ИзменениеЗапрещено(ДанныеИлиПолноеИмя, ИдентификаторДанных = Неопределено, Экспорт
```
Пример вызова
```bsl
Результат = ДатыЗапретаИзменения.ИзменениеЗапрещено(ДанныеИлиПолноеИмя, ИдентификаторДанных, );
```
</details>
## ПроверитьДатыЗапретаЗагрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет наличие запрета загрузки объекта или набора записей Данные.
// При этом выполняется проверка старой и новой версии данных.
//
// Параметры:
// Данные - СправочникОбъект
// - ДокументОбъект
// - ПланВидовХарактеристикОбъект
// - ПланСчетовОбъект
// - ПланВидовРасчетаОбъект
// - БизнесПроцессОбъект
// - ЗадачаОбъект
// - ПланОбменаОбъект
// - УдалениеОбъекта
// - РегистрСведенийНаборЗаписей
// - РегистрНакопленияНаборЗаписей
// - РегистрБухгалтерииНаборЗаписей
// - РегистрРасчетаНаборЗаписей - элемент данных или набор записей.
//
// УзелПроверкиЗапретаЗагрузки - ПланОбменаСсылка - узел, для которого требуется проверка.
//
// Отказ - Булево - возвращаемый параметр: Истина, если загрузка запрещена.
//
// ОписаниеОшибки - Null - значение по умолчанию. Сведения о запретах не требуются.
// - Строка - возвращаемое значение. Вернуть текстовое описание найденных запретов.
// - Структура - возвращаемое значение. Вернуть структурное описание найденных запретов,
// подробнее см. функцию ДатыЗапретаИзменения.НайденЗапретИзмененияДанных.
//
Процедура ПроверитьДатыЗапретаЗагрузкиДанных(Данные, УзелПроверкиЗапретаЗагрузки, Отказ, ОписаниеОшибки = Null) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзменения.ПроверитьДатыЗапретаЗагрузкиДанных(Данные, УзелПроверкиЗапретаЗагрузки, Отказ, ОписаниеОшибки);
```
</details>
## ОбъектПриЧтенииНаСервере
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик события формы ПриЧтенииНаСервере, который встраивается в формы элементов справочников,
// документов, записей регистров и др., чтобы заблокировать форму, если изменение запрещено.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма элемента объекта или записи регистра.
//
// ТекущийОбъект - СправочникОбъект
// - ДокументОбъект
// - ПланВидовХарактеристикОбъект
// - ПланСчетовОбъект
// - ПланВидовРасчетаОбъект
// - БизнесПроцессОбъект
// - ЗадачаОбъект
// - ПланОбменаОбъект
// - РегистрСведенийМенеджерЗаписи - менеджер записи.
//
// Возвращаемое значение:
// Булево - Истина, если проверка запрета изменения была пропущена программно.
//
Функция ОбъектПриЧтенииНаСервере(Форма, ТекущийОбъект) Экспорт
```
Пример вызова
```bsl
Результат = ДатыЗапретаИзменения.ОбъектПриЧтенииНаСервере(Форма, ТекущийОбъект)
```
</details>
## ДобавитьСтроку
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Добавляет строку описания источника данных для проверки запрета изменения.
// Используется в процедуре ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения
// общего модуля ДатыЗапретаИзмененияПереопределяемый.
//
// Параметры:
// Данные - ТаблицаЗначений - передается в процедуру ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения.
// Таблица - Строка - полное имя объекта метаданных, например "Документ.ПриходнаяНакладная".
// ПолеДаты - Строка - имя реквизита объекта или табличной части, например: "Дата", "Товары.ДатаОтгрузки".
// Раздел - Строка - имя предопределенного элемента ПланВидовХарактеристикСсылка.РазделыДатЗапретаИзменения.
// ПолеОбъекта - Строка - имя реквизита объекта или реквизита табличной части, например: "Организация", "Товары.Склад".
//
Процедура ДобавитьСтроку(Данные, Таблица, ПолеДаты, Раздел = "", ПолеОбъекта = "") Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзменения.ДобавитьСтроку(Данные, Таблица, ПолеДаты, Раздел, ПолеОбъекта);
```
</details>
## НайденЗапретИзмененияДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Найти даты запрета по проверяемым данным для указанного пользователя или узла плана обмена.
//
// Параметры:
// ДанныеДляПроверки - см. ДатыЗапретаИзменения.ШаблонДанныхДляПроверки
//
// ПараметрыСообщенияОЗапрете - см. ДатыЗапретаИзменения.ПараметрыСообщенияОЗапрете
// - Неопределено - формировать текст сообщения о запрете не требуется.
//
// ОписаниеОшибки - Null - значение по умолчанию. Сведения о запретах не требуются.
// - Строка - возвращаемое значение. Вернуть текстовое описание найденных запретов.
// - Структура - возвращаемое значение. Вернуть структурное описание найденных запретов:
// * ПредставлениеДанных - Строка - представление данных, используемое в заголовке ошибки.
// * ЗаголовокОшибки - Строка - строка, подобная следующей:
// "Заказ 10 от 01.01.2017 невозможно изменить в запрещенном периоде.".
// * Запреты - ТаблицаЗначений - найденные запреты в виде таблицы с колонками:
// ** Дата - Дата - проверяемая дата.
// ** Раздел - Строка - имя раздела, по которому выполнялся поиск запретов, если
// пустая строка, значит, выполнялся поиск даты, действующей для всех разделов.
// ** Объект - ЛюбаяСсылка - ссылка на объект, по которому выполнялся поиск даты запрета.
// - Неопределено - выполнялся поиск даты, действующей для всех объектов.
// ** ДатаЗапрета - Дата - найденная дата запрета.
// ** ОбщаяДата - Булево - если Истина, значит, найденная дата запрета действует для
// всех разделов, а не только для раздела, по которому выполнялся поиск.
// ** ДляВсехОбъектов - Булево - если Истина, значит, найденная дата запрета действует для
// всех объектов, а не только для объекта, по которому выполнялся поиск.
// ** Адресат - ОпределяемыйТип.АдресатЗапретаИзменения - пользователь или узел
// плана обмена, для которого задана найденная дата запрета.
// ** Описание - Строка - строка, подобная следующей:
// "Дате 01.01.2017 по объекту ""Склад программ"" раздела ""Складской учет"" соответствует
// запрет изменения данных для всех пользователей (установлена общая дата запрета)".
//
// УзелПроверкиЗапретаЗагрузки - Неопределено - выполнить проверку изменения данных.
// - ПланОбменаСсылка - выполнить проверку загрузки данных для указанного узла.
//
// Возвращаемое значение:
// Булево - если Истина, то найден хотя бы один запрет изменения.
//
Функция НайденЗапретИзмененияДанных(Знач ДанныеДляПроверки, Экспорт
```
Пример вызова
```bsl
Результат = ДатыЗапретаИзменения.НайденЗапретИзмененияДанных(ДанныеДляПроверки, );
```
</details>
## ПараметрыСообщенияОЗапрете
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает параметры для формирования сообщение о запрете записи или загрузки данных.
// Для использования в функции ДатыЗапретаИзменения.НайденЗапретИзмененияДанных.
//
// Возвращаемое значение:
// Структура:
// * НоваяВерсия - Булево - если Истина, то сообщение о запрете необходимо
// сформировать для новой версии, иначе для старой версии.
// * Данные - ЛюбаяСсылка
// - СправочникОбъект
// - ДокументОбъект
// - РегистрСведенийНаборЗаписей
// - РегистрНакопленияНаборЗаписей
// - РегистрБухгалтерииНаборЗаписей
// - РегистрРасчетаНаборЗаписей - ссылка, объект данных,
// или набор записей регистра, представление которого будет выведено в сообщении о запрете.
// - Структура:
// ** Регистр - Строка - полное имя регистра.
// - РегистрСведенийНаборЗаписей
// - РегистрНакопленияНаборЗаписей
// - РегистрБухгалтерииНаборЗаписей
// - РегистрРасчетаНаборЗаписей - набор записей регистра.
// ** Отбор - Отбор - отбор набора записей.
// - Строка - подготовленное представление данных,
// которое будет выведено в сообщении о запрете.
//
Функция ПараметрыСообщенияОЗапрете() Экспорт
```
Пример вызова
```bsl
Результат = ДатыЗапретаИзменения.ПараметрыСообщенияОЗапрете()
```
</details>
## ШаблонДанныхДляПроверки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает новую таблицу значений с колонками Дата, Раздел и Объект
// для заполнения и последующей передачи в функцию ДатыЗапретаИзменения.НайденЗапретИзмененияДанных.
//
// Возвращаемое значение:
// ТаблицаЗначений:
// * Дата - Дата - дата без времени, которую нужно проверить на принадлежность установленным запретам.
// * Раздел - Строка - одно из имен разделов, указанных в процедуре
// ДатыЗапретаИзмененияПереопределяемый.ПриЗаполненииРазделовДатЗапретаИзменения
// * Объект - ЛюбаяСсылка - один из типов объектов, указанных для раздела в процедуре
// ДатыЗапретаИзмененияПереопределяемый.ПриЗаполненииРазделовДатЗапретаИзменения.
//
Функция ШаблонДанныхДляПроверки() Экспорт
```
Пример вызова
```bsl
Результат = ДатыЗапретаИзменения.ШаблонДанныхДляПроверки()
```
</details>
## ОтключитьПроверкуДатЗапрета
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// В текущем сеансе отключает и включает проверку дат запрета изменения и загрузки данных.
// Требуется для реализации специальной логики работы и ускорения пакетной обработки данных
// при записи объекта или набора записей, когда признак ОбменДанными.Загрузка не установлен.
//
// Для использования требуются полные права или привилегированный режим.
//
// Рекомендуется:
// - массовой загрузке данных из файла (если данные не попадают в запрещенный период);
// - массовой загрузке данных при обмене данными (если данные не попадают в запрещенный период);
// - в случае, когда требуется отключить проверку дат запрета не для одного объекта,
// путем вставки свойства ПропуститьПроверкуЗапретаИзменения в ДополнительныеСвойства объекта,
// а для всех объектов, которые будут записываться в рамках записи этого объекта.
//
// Параметры:
// Отключить - Булево - Истина - отключает проверку дат запрета изменения и загрузки данных.
// Ложь - включает проверку дат запрета изменения и загрузки данных.
//
// Пример:
//
// Вариант 1. Запись набора объектов вне транзакции (ТранзакцияАктивна() = Ложь).
//
// ПроверкаДатЗапретаОтключена = ДатыЗапретаИзменения.ПроверкаДатЗапретаОтключена();
// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(Истина);
// Попытка
// // Запись набора объектов.
// // ...
// Исключение
// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(ПроверкаДатЗапретаОтключена);
// //...
// ВызватьИсключение;
// КонецПопытки;
// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(ПроверкаДатЗапретаОтключена);
//
// Вариант 2. Запись набора объектов в транзакции (ТранзакцияАктивна() = Истина).
//
// ПроверкаДатЗапретаОтключена = ДатыЗапретаИзменения.ПроверкаДатЗапретаОтключена();
// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(Истина);
// НачатьТранзакцию();
// Попытка
// БлокировкаДанных.Заблокировать();
// // ...
// // Запись набора объектов.
// // ...
// ЗафиксироватьТранзакцию();
// Исключение
// ОтменитьТранзакцию();
// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(ПроверкаДатЗапретаОтключена);
// //...
// ВызватьИсключение;
// КонецПопытки;
// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(ПроверкаДатЗапретаОтключена);
//
Процедура ОтключитьПроверкуДатЗапрета(Отключить) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(Отключить)
```
</details>
## ПроверкаДатЗапретаОтключена
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает состояние отключения дат запрета, выполняемое
// процедурой ОтключитьПроверкуДатЗапрета.
//
// Возвращаемое значение:
// Булево
//
Функция ПроверкаДатЗапретаОтключена() Экспорт
```
Пример вызова
```bsl
Результат = ДатыЗапретаИзменения.ПроверкаДатЗапретаОтключена()
```
</details>
## ПроверитьДатуЗапретаИзмененияПередЗаписью
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик подписки на событие ПередЗаписью для проверки запрета изменения.
//
// Параметры:
// Источник - СправочникОбъект
// - ПланВидовХарактеристикОбъект
// - ПланСчетовОбъект
// - ПланВидовРасчетаОбъект
// - БизнесПроцессОбъект
// - ЗадачаОбъект
// - ПланОбменаОбъект - объект данных, передаваемый в подписку на событие ПередЗаписью.
//
// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
//
Процедура ПроверитьДатуЗапретаИзмененияПередЗаписью(Источник, Отказ) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередЗаписью(Источник, Отказ)
```
</details>
## ПроверитьДатуЗапретаИзмененияПередЗаписьюДокумента
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик подписки на событие ПередЗаписью для проверки запрета изменения.
//
// Параметры:
// Источник - ДокументОбъект - объект данных, передаваемый в подписку на событие ПередЗаписью.
// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
// РежимЗаписи - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
// РежимПроведения - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
//
Процедура ПроверитьДатуЗапретаИзмененияПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения)
```
</details>
## ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписей
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик подписки на событие ПередЗаписью для проверки запрета изменения.
//
// Параметры:
// Источник - РегистрСведенийНаборЗаписей
// - РегистрНакопленияНаборЗаписей - набор записей, передаваемый в подписку на событие ПередЗаписью.
// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
// Замещение - РежимЗамещения, Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
//
Процедура ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписей(Источник, Отказ, Замещение) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписей(Источник, Отказ, Замещение)
```
</details>
## ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраБухгалтерии
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик подписки на событие ПередЗаписью для проверки запрета изменения.
//
// Параметры:
// Источник - РегистрБухгалтерииНаборЗаписей - набор записей, передаваемый
// в подписку на событие ПередЗаписью.
// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
// Замещение - РежимЗамещения, Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
//
Процедура ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраБухгалтерии( Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраБухгалтерии();
```
</details>
## ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраРасчета
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик подписки на событие ПередЗаписью для проверки запрета изменения.
//
// Параметры:
// Источник - РегистрРасчетаНаборЗаписей - набор записей, передаваемый
// в подписку на событие ПередЗаписью.
// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
// Замещение - РежимЗамещения, Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
// ТолькоЗапись - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
// ЗаписьФактическогоПериодаДействия - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
// ЗаписьПерерасчетов - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
//
Процедура ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраРасчета( Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраРасчета();
```
</details>
## ПроверитьДатуЗапретаИзмененияПередУдалением
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик подписки на событие ПередУдалением для проверки запрета изменения.
//
// Параметры:
// Источник - СправочникОбъект
// - ДокументОбъект
// - ПланВидовХарактеристикОбъект
// - ПланСчетовОбъект
// - ПланВидовРасчетаОбъект
// - БизнесПроцессОбъект
// - ЗадачаОбъект
// - ПланОбменаОбъект - объект данных, передаваемый в подписку на событие ПередЗаписью.
//
// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью.
//
Процедура ПроверитьДатуЗапретаИзмененияПередУдалением(Источник, Отказ) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередУдалением(Источник, Отказ)
```
</details>
## ОбновитьРазделыДатЗапретаИзменения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Не требуется вызывать, так как обновление выполняется автоматически.
Процедура ОбновитьРазделыДатЗапретаИзменения() Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзменения.ОбновитьРазделыДатЗапретаИзменения()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

270
src/content/docs/bsp/ДатыЗапретаИзмененияПереопределяемый.md Normal file
View File

@ -0,0 +1,270 @@
---
title: Даты запрета изменения переопределяемый
slug: bsp/даты-запрета-изменения-переопределяемый
---
## НастройкаИнтерфейса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет изменить работу интерфейса при встраивании.
//
// Параметры:
// НастройкиРаботыИнтерфейса - Структура:
// * ИспользоватьВнешнихПользователей - Булево - начальное значение Ложь,
// если установить Истина, тогда даты запрета можно будет настраивать для внешних пользователей.
//
Процедура НастройкаИнтерфейса(НастройкиРаботыИнтерфейса) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзмененияПереопределяемый.НастройкаИнтерфейса(НастройкиРаботыИнтерфейса)
```
</details>
## ПриЗаполненииРазделовДатЗапретаИзменения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполняет разделы дат запрета изменения, используемые при настройке дат запрета.
// Если не указать ни одного раздела, тогда будет доступна только настройка общей даты запрета.
//
// Параметры:
// Разделы - ТаблицаЗначений:
// * Имя - Строка - имя, используемое в описании источников данных в
// процедуре ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения.
//
// * Идентификатор - УникальныйИдентификатор - идентификатор ссылки элемента плана видов характеристик.
// Чтобы получить идентификатор, нужно в режиме 1С:Предприятие выполнить метод платформы:
// "ПланыВидовХарактеристик.РазделыДатЗапретаИзменения.ПолучитьСсылку().УникальныйИдентификатор()".
// Не следует указывать идентификаторы, полученные любым другим способом,
// так как это может нарушить их уникальность.
//
// * Представление - Строка - представляет раздел в форме настройки дат запрета.
//
// * ТипыОбъектов - Массив - типы ссылок объектов, в разрезе которых можно настроить даты запрета,
// например Тип("СправочникСсылка.Организации"); если не указано ни одного типа,
// то даты запрета будут настраиваться только с точностью до раздела.
//
Процедура ПриЗаполненииРазделовДатЗапретаИзменения(Разделы) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзмененияПереопределяемый.ПриЗаполненииРазделовДатЗапретаИзменения(Разделы)
```
</details>
## ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет задать таблицы и поля объектов для проверки запрета изменения данных.
// Для добавления нового источника в ИсточникиДанных см. ДатыЗапретаИзменения.ДобавитьСтроку.
//
// Вызывается из процедуры ИзменениеЗапрещено общего модуля ДатыЗапретаИзменения,
// используемой в подписке на событие ПередЗаписью объекта для проверки наличия
// запретов и отказа от изменений запрещенного объекта.
//
// Параметры:
// ИсточникиДанных - ТаблицаЗначений:
// * Таблица - Строка - полное имя объекта метаданных,
// например Метаданные.Документы.ПриходнаяНакладная.ПолноеИмя().
// * ПолеДаты - Строка - имя реквизита объекта или табличной части,
// например: "Дата", "Товары.ДатаОтгрузки".
// * Раздел - Строка - имя раздела дат запрета, указанного в
// процедуре ПриЗаполненииРазделовДатЗапретаИзменения (см. выше).
// * ПолеОбъекта - Строка - имя реквизита объекта или реквизита табличной части,
// например: "Организация", "Товары.Склад".
//
Процедура ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения(ИсточникиДанных) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзмененияПереопределяемый.ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения(ИсточникиДанных)
```
</details>
## ПередПроверкойЗапретаИзменения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет переопределить выполнение проверки запрета изменения произвольным образом.
//
// Если проверка выполняется в процессе записи документа, то в свойстве ДополнительныеСвойства
// документа Объект имеется свойство РежимЗаписи (РежимЗаписиДокумента).
// Если выполняется проверка набора записей, то в свойстве ДополнительныеСвойства
// набора записей Объект имеется свойство Замещение (Булево, РежимЗамещения). Причем, в варианте
// замены записей настроено свойство Отбор для получения существующих записей из базы данных.
//
// Параметры:
// Объект - СправочникОбъект
// - ДокументОбъект
// - ПланВидовХарактеристикОбъект
// - ПланСчетовОбъект
// - ПланВидовРасчетаОбъект
// - БизнесПроцессОбъект
// - ЗадачаОбъект
// - ПланОбменаОбъект
// - РегистрСведенийНаборЗаписей
// - РегистрНакопленияНаборЗаписей
// - РегистрБухгалтерииНаборЗаписей
// - РегистрРасчетаНаборЗаписей - проверяемый элемент данных или набор записей
// (как в обработчиках ПередЗаписью и ПриЧтенииНаСервере).
//
// ПроверкаЗапретаИзменения - Булево - установить в Ложь, чтобы пропустить проверку запрета изменения данных.
// УзелПроверкиЗапретаЗагрузки - ПланОбменаСсылка
// - Неопределено - установить в Неопределено, чтобы
// пропустить проверку запрета загрузки данных.
// ВерсияОбъекта - Строка - установить "СтараяВерсия" или "НоваяВерсия", чтобы
// выполнить проверку только старой версии объекта (в базе данных)
// или только новой версии объекта (в параметре Объект).
// По умолчанию содержит значение "" - проверяются обе версии объекта сразу.
//
Процедура ПередПроверкойЗапретаИзменения(Объект, Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзмененияПереопределяемый.ПередПроверкойЗапретаИзменения(Объект, );
```
</details>
## ПередПроверкойСтаройВерсииДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет переопределить получение данных для проверки даты запрета старой (существующей) версии данных.
// Если заполнить ДанныеДляПроверки, тогда они не будут автоматически загружаться из
// базы данных по значениям параметров ОбъектМетаданных и ИдентификаторДанных.
//
// Если выполняется проверка набора записей, то в свойстве ДополнительныеСвойства
// набора записей ИдентификаторДанных имеется свойство Замещение (Булево, РежимЗамещения)
// с возможными значениями: Замещение, Обновление, Слияние, Удаление. Причем, в варианте
// замены записей настроено свойство Отбор для получения существующих записей из базы данных.
//
// Параметры:
// ОбъектМетаданных - ОбъектМетаданных - объект метаданных получаемых данных.
// ИдентификаторДанных - СправочникСсылка
// - ДокументСсылка
// - ПланВидовХарактеристикСсылка
// - ПланСчетовСсылка
// - ПланВидовРасчетаСсылка
// - БизнесПроцессСсылка
// - ЗадачаСсылка
// - ПланОбменаСсылка - ссылка на элемент данных.
// - Отбор - отбор набора записей, когда Замещение равно Истина.
// - РегистрСведенийНаборЗаписей
// - РегистрНакопленияНаборЗаписей
// - РегистрБухгалтерииНаборЗаписей
// - РегистрРасчетаНаборЗаписей - набор записей, когда Замещение не Булево.
//
// УзелПроверкиЗапретаЗагрузки - Неопределено
// - ПланОбменаСсылка - если Неопределено, то проверить запрет
// изменения данных; иначе - загрузку данных из указанного узла плана обмена.
//
// ДанныеДляПроверки - см. ДатыЗапретаИзменения.ШаблонДанныхДляПроверки.
//
// Пример:
// Если ТипЗнч(ИдентификаторДанных) = Тип("ДокументСсылка.Заказ") Тогда
// Данные = ОбщегоНазначения.ЗначенияРеквизитовОбъекта(ИдентификаторДанных, "Организация, ДатаОкончанияРабот, ЗаказНаряд");
// Если Данные.ЗаказНаряд Тогда
// Проверка = ДанныеДляПроверки.Добавить();
// Проверка.Раздел = "ЗаказНаряды";
// Проверка.Объект = Данные.Организация;
// Проверка.Дата = Данные.ДатаОкончанияРабот;
// КонецЕсли;
// КонецЕсли;
//
Процедура ПередПроверкойСтаройВерсииДанных(ОбъектМетаданных, ИдентификаторДанных, УзелПроверкиЗапретаЗагрузки, ДанныеДляПроверки) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзмененияПереопределяемый.ПередПроверкойСтаройВерсииДанных(ОбъектМетаданных, ИдентификаторДанных, УзелПроверкиЗапретаЗагрузки, ДанныеДляПроверки)
```
</details>
## ПередПроверкойНовойВерсииДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет переопределить получение данных для проверки даты запрета новой (будущей) версии данных.
// Если заполнить ДанныеДляПроверки, тогда они не будут автоматически извлекаться из объекта и
// дополнительно загружаться из базы данных по значениям параметров ОбъектМетаданных и Данные.
//
// Если проверка выполняется в процессе записи документа, то в свойстве ДополнительныеСвойства
// документа Данные имеется свойство РежимЗаписи (РежимЗаписиДокумента).
// Если выполняется проверка набора записей, то в свойстве ДополнительныеСвойства
// набора записей Данные имеется свойство Замещение (Булево, РежимЗамещения)
// с возможными значениями: Добавление, Замещение, Обновление, Слияние. Причем, в варианте
// замены записей настроено свойство Отбор для получения существующих записей из базы данных.
//
// Параметры:
// ОбъектМетаданных - ОбъектМетаданных - объект метаданных получаемых данных.
// Данные - СправочникОбъект
// - ДокументОбъект
// - ПланВидовХарактеристикОбъект
// - ПланСчетовОбъект
// - ПланВидовРасчетаОбъект
// - БизнесПроцессОбъект
// - ЗадачаОбъект
// - ПланОбменаОбъект
// - РегистрСведенийНаборЗаписей
// - РегистрНакопленияНаборЗаписей
// - РегистрБухгалтерииНаборЗаписей
// - РегистрРасчетаНаборЗаписей - проверяемый элемент данных или набор записей.
//
// УзелПроверкиЗапретаЗагрузки - Неопределено
// - ПланОбменаСсылка - если Неопределено, то проверить запрет
// изменения данных; иначе - загрузку данных из указанного узла плана обмена.
//
// ДанныеДляПроверки - см. ДатыЗапретаИзменения.ШаблонДанныхДляПроверки.
//
// Пример:
// Если ТипЗнч(Данные) = Тип("ДокументОбъект.Заказ") И Данные.ЗаказНаряд Тогда
//
// Проверка = ДанныеДляПроверки.Добавить();
// Проверка.Раздел = "ЗаказНаряды";
// Проверка.Объект = Данные.Организация;
// Проверка.Дата = Данные.ДатаОкончанияРабот;
//
// КонецЕсли;
//
Процедура ПередПроверкойНовойВерсииДанных(ОбъектМетаданных, Данные, УзелПроверкиЗапретаЗагрузки, ДанныеДляПроверки) Экспорт
```
Пример вызова
```bsl
ДатыЗапретаИзмененияПереопределяемый.ПередПроверкойНовойВерсииДанных(ОбъектМетаданных, Данные, УзелПроверкиЗапретаЗагрузки, ДанныеДляПроверки)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

854
src/content/docs/bsp/ДлительныеОперации.md Normal file
View File

@ -0,0 +1,854 @@
---
title: Длительные операции
slug: bsp/длительные-операции
---
## ВыполнитьФункцию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// АПК:142-выкл - Необязательных параметров более 3 для поддержки разных прикладных функций.
// АПК:134-выкл - Количество параметров более 7 для поддержки разных прикладных функций.
// Запустить выполнение функции в фоновом задании, если это возможно.
// Вызываемая функция может быть с произвольным числом параметров, но не более 7.
// Значения передаваемых параметров функции, а также возвращаемое значение должны быть сериализуемыми.
// Параметры функции не должны быть возвращаемыми.
//
// Не следует использовать эту функцию, если необходимо безусловно запускать фоновое задание.
// Рекомендуется применять совместно с функцией ДлительныеОперацииКлиент.ОжидатьЗавершение,
// если невозможно, тогда для проверки завершения операции использовать функцию ЗаданиеВыполнено.
//
// Параметры:
// ПараметрыВыполнения - ФормаКлиентскогоПриложения - форма, из которой выполняется вызов;
// - УникальныйИдентификатор - идентификатор формы, из которой выполняется вызов;
// - Структура - см. ПараметрыВыполненияФункции
// ИмяФункции - Строка - имя экспортной функции общего модуля, модуля менеджера объекта
// или модуля обработки, которую необходимо выполнить в фоне.
// Например, "МойОбщийМодуль.МояПроцедура", "Отчет.ЗагруженныеДанные.Сформировать"
// или "Обработка.ЗагрузкаДанных.МодульОбъекта.Загрузить".
//
// Параметр1 - Произвольный - произвольные параметры вызова функции. Количество параметров может быть от 0 до 7.
// Параметр2 - Произвольный
// Параметр3 - Произвольный
// Параметр4 - Произвольный
// Параметр5 - Произвольный
// Параметр6 - Произвольный
// Параметр7 - Произвольный
//
// Возвращаемое значение:
// Структура:
// * Статус - Строка - "Выполняется", если задание еще не завершилось;
// "Выполнено", если задание было успешно выполнено;
// "Ошибка", если задание завершено с ошибкой;
// "Отменено", если задание отменено пользователем или администратором.
// * ИдентификаторЗадания - УникальныйИдентификатор - если Статус = "Выполняется", то содержит
// идентификатор запущенного фонового задания.
// - Неопределено - если Статус <> "Выполняется" и фоновое задание не запускалось.
// * АдресРезультата - Строка - адрес временного хранилища, в которое будет
// помещен результат работы функции.
// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка".
// - Неопределено - если Статус <> "Ошибка".
// * Сообщения - ФиксированныйМассив - если Статус <> "Выполняется", то массив объектов СообщениеПользователю,
// которые были сформированы в фоновом задании.
// * КраткоеПредставлениеОшибки - Строка - устарел.
// * ПодробноеПредставлениеОшибки - Строка - устарел.
//
// Пример:
// В общем виде процесс запуска и обработки результата длительной операции в модуле формы выглядит следующим образом:
//
// 1) Функция, которая будет исполняться в фоне, располагается в модуле менеджера объекта или в серверном общем модуле:
// Функция РассчитатьЗначение(Знач МойПараметр1, Знач МойПараметр2) Экспорт
// ...
// Возврат Результат;
// КонецФункции
//
// 2) Запуск операции на сервере и подключение обработчика ожидания:
// &НаКлиенте
// Процедура РассчитатьЗначение()
// ДлительнаяОперация = НачатьВыполнениеНаСервере();
// ОповещениеОЗавершении = Новый ОписаниеОповещения("ОбработатьРезультат", ЭтотОбъект);
// ПараметрыОжидания = ДлительныеОперацииКлиент.ПараметрыОжидания(ЭтотОбъект);
// ДлительныеОперацииКлиент.ОжидатьЗавершение(ДлительнаяОперация, ОповещениеОЗавершении, ПараметрыОжидания);
// КонецПроцедуры
//
// &НаСервере
// Функция НачатьВыполнениеНаСервере()
// ПараметрыВыполнения = ДлительныеОперации.ПараметрыВыполненияФункции(УникальныйИдентификатор);
// Возврат ДлительныеОперации.ВыполнитьФункцию(ПараметрыВыполнения, "Обработка.МояОбработка.РассчитатьЗначение",
// МойПараметр1, МойПараметр2);
// КонецФункции
//
// 3) Обработка результата длительной операции:
// &НаКлиенте
// Процедура ОбработатьРезультат(Результат, ДополнительныеПараметры) Экспорт
// Если Результат = Неопределено Тогда
// Возврат;
// КонецЕсли;
// Если Результат.Статус = "Ошибка" Тогда
// СтандартныеПодсистемыКлиент.ВывестиИнформациюОбОшибке(Результат.ИнформацияОбОшибке);
// Возврат;
// КонецЕсли;
// ВывестиРезультат(Результат.АдресРезультата);
// КонецПроцедуры
//
Функция ВыполнитьФункцию(Знач ПараметрыВыполнения, ИмяФункции, Знач Параметр1 = Неопределено, Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ВыполнитьФункцию(ПараметрыВыполнения, ИмяФункции, Параметр1, );
```
</details>
## ВыполнитьПроцедуру
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// АПК:141-выкл - Первый необязательный параметр перед обязательным выбран
// для сохранения порядка параметров как в функции ВыполнитьФункцию.
// Запустить выполнение процедуры в фоновом задании, если это возможно.
// Вызываемая процедура может быть с произвольным числом параметров, но не более 7.
// Значения передаваемых параметров процедуры, а также возвращаемое значение должны быть сериализуемыми.
// Параметры процедуры не должны быть возвращаемыми.
//
// Не следует использовать эту функцию, если необходимо безусловно запускать фоновое задание.
// Рекомендуется применять совместно с функцией ДлительныеОперацииКлиент.ОжидатьЗавершение,
// если невозможно, тогда для проверки завершения операции использовать функцию ЗаданиеВыполнено.
//
// Параметры:
//
// ПараметрыВыполнения - см. ДлительныеОперации.ПараметрыВыполненияПроцедуры
//
// ИмяПроцедуры - Строка - имя экспортной процедуры общего модуля, модуля менеджера объекта
// или модуля обработки, которую необходимо выполнить в фоне.
// Например, "МойОбщийМодуль.МояПроцедура", "Отчет.ЗагруженныеДанные.Сформировать"
// или "Обработка.ЗагрузкаДанных.МодульОбъекта.Загрузить".
//
// Параметр1 - Произвольный - произвольные параметры вызова процедуры. Количество параметров может быть от 0 до 7.
// Параметр2 - Произвольный
// Параметр3 - Произвольный
// Параметр4 - Произвольный
// Параметр5 - Произвольный
// Параметр6 - Произвольный
// Параметр7 - Произвольный
//
// Возвращаемое значение:
// Структура - параметры выполнения задания:
// * Статус - Строка - "Выполняется", если задание еще не завершилось;
// "Выполнено", если задание было успешно выполнено;
// "Ошибка", если задание завершено с ошибкой;
// "Отменено", если задание отменено пользователем или администратором.
// * ИдентификаторЗадания - УникальныйИдентификатор - если Статус = "Выполняется", то содержит
// идентификатор запущенного фонового задания.
// - Неопределено - если Статус <> "Выполняется" и фоновое задание не запускалось.
// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка".
// - Неопределено - если Статус <> "Ошибка".
// * Сообщения - ФиксированныйМассив - если Статус <> "Выполняется", то массив объектов СообщениеПользователю,
// которые были сформированы в фоновом задании.
// * КраткоеПредставлениеОшибки - Строка - устарел.
// * ПодробноеПредставлениеОшибки - Строка - устарел.
//
// Пример:
// В общем виде процесс запуска и обработки результата длительной операции в модуле формы выглядит следующим образом:
//
// 1) Процедура, которая будет исполняться в фоне, располагается в модуле менеджера объекта или в серверном общем модуле:
// Процедура ВыполнитьРасчет(Знач МойПараметр1, Знач МойПараметр2) Экспорт
// ...
// КонецПроцедуры
//
// 2) Запуск операции на сервере и подключение обработчика ожидания (при необходимости):
// &НаКлиенте
// Процедура ВыполнитьРасчет()
// ДлительнаяОперация = НачатьВыполнениеНаСервере();
// ОповещениеОЗавершении = Новый ОписаниеОповещения("ОбработатьРезультат", ЭтотОбъект);
// ПараметрыОжидания = ДлительныеОперацииКлиент.ПараметрыОжидания(ЭтотОбъект);
// ДлительныеОперацииКлиент.ОжидатьЗавершение(ДлительнаяОперация, ОповещениеОЗавершении, ПараметрыОжидания);
// КонецПроцедуры
//
// &НаСервере
// Функция НачатьВыполнениеНаСервере()
// Возврат ДлительныеОперации.ВыполнитьПроцедуру(, "Обработка.МояОбработка.ВыполнитьРасчет",
// МойПараметр1, МойПараметр2);
// КонецФункции
//
// 3) Обработка результата длительной операции:
// &НаКлиенте
// Процедура ОбработатьРезультат(Результат, ДополнительныеПараметры) Экспорт
// Если Результат = Неопределено Тогда
// Возврат;
// КонецЕсли;
// Если Результат.Статус = "Ошибка" Тогда
// СтандартныеПодсистемыКлиент.ВывестиИнформациюОбОшибке(Результат.ИнформацияОбОшибке);
// Возврат;
// КонецЕсли;
// ПриЗавершенииРасчета();
// КонецПроцедуры
//
//@skip-check method-optional-parameter-before-required
//
Функция ВыполнитьПроцедуру(Знач ПараметрыВыполнения = Неопределено, ИмяПроцедуры, Знач Параметр1 = Неопределено, Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ВыполнитьПроцедуру(ПараметрыВыполнения, ИмяПроцедуры, Параметр1, );
```
</details>
## ВыполнитьФункциюВНесколькоПотоков
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// АПК:141-вкл
// АПК:134-вкл
// АПК:142-вкл
// Запустить выполнение функции в многопоточном фоновом задании, если это возможно.
// Вызываемая процедура может быть с произвольным числом параметров, но не более 7.
// Значения передаваемых параметров процедуры, а также возвращаемое значение должны быть сериализуемыми.
// Параметры процедуры не должны быть возвращаемыми.
// Многопоточные длительные операции в неразделенном сеансе не поддерживаются.
//
// Не следует использовать эту функцию, если необходимо безусловно запускать фоновое задание.
// Рекомендуется применять совместно с функцией ДлительныеОперацииКлиент.ОжидатьЗавершение,
// если невозможно, тогда для проверки завершения операции использовать функцию ЗаданиеВыполнено.
//
// Параметры:
// ИмяФункции - Строка - имя экспортной функции общего модуля, модуля менеджера объекта
// или модуля обработки, которую необходимо выполнить в фоне.
// Например, "МойОбщийМодуль.МояПроцедура", "Отчеты.ЗагруженныеДанные.Сформировать"
// или "Обработки.ЗагрузкаДанных.МодульОбъекта.Загрузить".
// ПараметрыВыполнения - см. ПараметрыВыполненияФункции
// НаборПараметровФункции - Соответствие из КлючИЗначение - произвольный набор параметров вызова функции:
// * Ключ - Произвольный - ключ набора
// * Значение - Массив - параметры вызова функции. Количество параметров может быть от 0 до 7.
//
// Возвращаемое значение:
// Структура:
// * Статус - Строка - "Выполняется", если задание еще не завершилось;
// "Выполнено", если задание было успешно выполнено;
// "Ошибка", если задание завершено с ошибкой;
// "Отменено", если задание отменено пользователем или администратором.
// * ИдентификаторЗадания - УникальныйИдентификатор - если Статус = "Выполняется", то содержит
// идентификатор запущенного фонового задания.
// - Неопределено - если Статус <> "Выполняется" и фоновое задание не запускалось.
// * АдресРезультата - Строка - адрес временного хранилища, в которое будет помещено Соответствие:
// ** Ключ - Произвольный
// ** Значение - см. ВыполнитьФункцию
// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка".
// - Неопределено - если Статус <> "Ошибка".
// * Сообщения - ФиксированныйМассив - если Статус <> "Выполняется", то массив объектов СообщениеПользователю,
// которые были сформированы в фоновом задании.
// * КраткоеПредставлениеОшибки - Строка - устарел.
// * ПодробноеПредставлениеОшибки - Строка - устарел.
//
Функция ВыполнитьФункциюВНесколькоПотоков(ИмяФункции, Знач ПараметрыВыполнения, Знач НаборПараметровФункции = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ВыполнитьФункциюВНесколькоПотоков(ИмяФункции, ПараметрыВыполнения, НаборПараметровФункции);
```
</details>
## ВыполнитьПроцедуруВНесколькоПотоков
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Запускает выполнение процедуры в многопоточном фоновом задании, если это возможно.
// Вызываемая процедура может быть с произвольным числом параметров, но не более 7.
// Значения передаваемых параметров процедуры, а также возвращаемое значение должны быть сериализуемыми.
// Параметры процедуры не должны быть возвращаемыми.
// Многопоточные длительные операции в неразделенном сеансе не поддерживаются.
//
// Не следует использовать эту функцию, если необходимо безусловно запускать фоновое задание.
// Рекомендуется применять совместно с функцией ДлительныеОперацииКлиент.ОжидатьЗавершение,
// если невозможно, тогда для проверки завершения операции использовать функцию ЗаданиеВыполнено.
//
// Параметры:
// ИмяПроцедуры - Строка - имя экспортной процедуры общего модуля, модуля менеджера объекта
// или модуля обработки, которую необходимо выполнить в фоне.
// ПараметрыВыполнения - см. ПараметрыВыполненияПроцедуры
// НаборПараметровПроцедуры - Соответствие из КлючИЗначение - произвольный набор параметров вызова процедуры:
// * Ключ - Произвольный - ключ набора
// * Значение - Массив - параметры вызова процедуры. Количество параметров может быть от 0 до 7.
//
// Возвращаемое значение:
// Структура:
// * Статус - Строка - "Выполняется", если задание еще не завершилось;
// "Выполнено", если задание было успешно выполнено;
// "Ошибка", если задание завершено с ошибкой;
// "Отменено", если задание отменено пользователем или администратором.
// * ИдентификаторЗадания - УникальныйИдентификатор - если Статус = "Выполняется", то содержит
// идентификатор запущенного фонового задания.
// - Неопределено - если Статус <> "Выполняется" и фоновое задание не запускалось.
// * АдресРезультата - Строка - адрес временного хранилища, в которое будет помещено Соответствие:
// ** Ключ - Произвольный
// ** Значение - см. ВыполнитьПроцедуру
// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка".
// - Неопределено - если Статус <> "Ошибка".
// * Сообщения - ФиксированныйМассив - если Статус <> "Выполняется", то массив объектов СообщениеПользователю,
// которые были сформированы в фоновом задании.
// * КраткоеПредставлениеОшибки - Строка - устарел.
// * ПодробноеПредставлениеОшибки - Строка - устарел.
//
Функция ВыполнитьПроцедуруВНесколькоПотоков(ИмяПроцедуры, Знач ПараметрыВыполнения, Знач НаборПараметровПроцедуры = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ВыполнитьПроцедуруВНесколькоПотоков(ИмяПроцедуры, ПараметрыВыполнения, НаборПараметровПроцедуры);
```
</details>
## ПараметрыВыполненияФункции
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Конструктор коллекции ПараметрыВыполненияФункции для функции ВыполнитьФункцию.
//
// Если ЗапуститьВФоне = Ложь и ЗапуститьНеВФоне = Ложь, то задание будет выполнено в фоне по возможности.
// Запуск с расширениями сеанса выполняется сразу в основном потоке при выполнении любого из следующих условий:
// * если вызов выполняется в файловой базе во внешнем соединении (в этом режиме фоновые задания не поддерживаются);
// * если приложение запущено в режиме отладки (параметр /C РежимОтладки) - для упрощения отладки конфигурации;
// * если в файловой ИБ имеются активные фоновые задания - для снижения времени ожидания пользователя.
//
// Параметры:
// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы,
// во временное хранилище которой надо поместить результат выполнения процедуры.
//
// Возвращаемое значение:
// Структура - параметры выполнения длительной операции:
// * ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы,
// во временное хранилище которой надо поместить результат выполнения процедуры.
// * ОжидатьЗавершение - Неопределено - ждать до момента завершения фонового задания.
// - Число - таймаут в секундах ожидания завершения фонового задания.
// Если задано 0, то ждать завершения задания не требуется.
// По умолчанию - 0.8 секунды, а для низкой скорости соединения - 4.
// * НаименованиеФоновогоЗадания - Строка - описание фонового задания. По умолчанию - имя процедуры.
// * КлючФоновогоЗадания - Строка - уникальный ключ активных фоновых заданий с одинаковым именем процедуры,
// чтобы в приложении нельзя было запустить более одного задания одновременно.
// По умолчанию не задан.
// * АдресРезультата - Строка - адрес временного хранилища, в которое должен быть помещен результат
// работы процедуры. Если не задан, адрес формируется автоматически.
// * ЗапуститьВФоне - Булево - если Истина, то задание будет всегда выполняться в фоне, кроме ситуаций:
// а) если вызов выполняется в файловой базе во внешнем соединении
// (в этом режиме фоновые задания не поддерживаются);
// б) если выполняется функция модуля внешней обработки или внешнего отчета.
// Кроме того, в файловом варианте при наличии ранее запущенных фоновых заданий,
// новое задание становится в очередь и начинает выполняться после завершения предыдущих.
// Если Ложь, то задание будет выполнено в фоне по возможности.
// * ЗапуститьНеВФоне - Булево - если Истина, задание всегда будет запускаться непосредственно,
// без использования фонового задания.
// * БезРасширений - Булево - если Истина, то фоновое задание будет запущено без подключения
// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне.
// * СРасширениямиБазыДанных - Булево - если Истина, то фоновое задание будет запущено с последней версией
// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне.
// * ВнешнийОтчетОбработка - Неопределено - по умолчанию.
// - ДвоичныеДанные - когда указано имя метода, которое начинается
// с "ВнешнийОтчет." или "ВнешняяОбработка.".
// Для вызова такого метода требуется право интерактивного открытия
// внешнего отчета или обработки соответственно.
// Внешний отчет или обработка подключаются с защитой от опасных действий.
// * ПрерватьВыполнениеЕслиОшибка - Булево - если Истина, то при возникновении ошибки в одном из дочерних фоновых
// заданий, выполнение многопоточного фонового задания будет прервано.
// Выполнение уже запущенных дочерних фоновых задания будет отменно.
// Параметр только для функции ВыполнитьФункциюВНесколькоПотоков.
// * УточнениеОшибки - Строка - если не пустая строка, тогда для пользователя текст ошибки
// будет уточнен указанным начальным текстом. Пример уточнения:
// НСтр("ru = 'Не удалось очистить адресный классификатор по причине:'")
//
Функция ПараметрыВыполненияФункции(Знач ИдентификаторФормы) Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ПараметрыВыполненияФункции(ИдентификаторФормы)
```
</details>
## ПараметрыВыполненияПроцедуры
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Конструктор коллекции ПараметрыВыполненияПроцедуры для функции ВыполнитьПроцедуру.
//
// Если ЗапуститьВФоне = Ложь и ЗапуститьНеВФоне = Ложь, то задание будет выполнено в фоне по возможности.
// Запуск с расширениями сеанса выполняется сразу в основном потоке при выполнении любого из следующих условий:
// * если вызов выполняется в файловой базе во внешнем соединении (в этом режиме фоновые задания не поддерживаются);
// * если приложение запущено в режиме отладки (параметр /C РежимОтладки) - для упрощения отладки конфигурации;
// * если в файловой ИБ имеются активные фоновые задания - для снижения времени ожидания пользователя.
//
// Возвращаемое значение:
// Структура - параметры выполнения длительной операции:
// * ОжидатьЗавершение - Неопределено - ждать до момента завершения фонового задания.
// - Число - таймаут в секундах ожидания завершения фонового задания.
// Если задано 0, то ждать завершения задания не требуется.
// По умолчанию - 0.8 секунды, а для низкой скорости соединения - 4.
// * НаименованиеФоновогоЗадания - Строка - описание фонового задания. По умолчанию - имя процедуры.
// * КлючФоновогоЗадания - Строка - уникальный ключ для активных фоновых заданий, имеющих такое же имя процедуры.
// По умолчанию не задан.
// * ЗапуститьВФоне - Булево - если Истина, то задание будет всегда выполняться в фоне, кроме ситуаций:
// а) если вызов выполняется в файловой базе во внешнем соединении
// (в этом режиме фоновые задания не поддерживаются);
// б) если выполняется функция модуля внешней обработки или внешнего отчета.
// Кроме того, в файловом варианте при наличии ранее запущенных фоновых заданий,
// новое задание становится в очередь и начинает выполняться после завершения предыдущих.
// Если Ложь, то задание будет выполнено в фоне по возможности.
// * ЗапуститьНеВФоне - Булево - если Истина, задание всегда будет запускаться непосредственно,
// без использования фонового задания.
// * БезРасширений - Булево - если Истина, то фоновое задание будет запущено без подключения
// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне.
// * СРасширениямиБазыДанных - Булево - если Истина, то фоновое задание будет запущено с последней версией
// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне.
// * ВнешнийОтчетОбработка - Неопределено - по умолчанию.
// - ДвоичныеДанные - когда указано имя метода, которое начинается
// с "ВнешнийОтчет." или "ВнешняяОбработка.".
// Для вызова такого метода требуется право интерактивного открытия
// внешнего отчета или обработки соответственно.
// Внешний отчет или обработка подключаются с защитой от опасных действий.
// * ПрерватьВыполнениеЕслиОшибка - Булево - если Истина, то при возникновении ошибки в одном из дочерних фоновых
// заданий, выполнение многопоточного фонового задания будет прервано.
// Выполнение уже запущенных дочерних фоновых задания будет отменно.
// Параметр только для функции ВыполнитьПроцедуруВНесколькоПотоков.
// * УточнениеОшибки - Строка - если не пустая строка, тогда для пользователя текст ошибки
// будет уточнен указанным начальным текстом. Пример уточнения:
// НСтр("ru = 'Не удалось очистить адресный классификатор по причине:'")
//
Функция ПараметрыВыполненияПроцедуры() Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ПараметрыВыполненияПроцедуры()
```
</details>
## ВыполнитьВФоне
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вместо этой функции рекомендуется использовать функции ВыполнитьФункцию и ВыполнитьПроцедуру.
//
// Запустить выполнение процедуры в фоновом задании, если это возможно.
// Не следует использовать эту функцию, если необходимо безусловно запускать фоновое задание.
// Рекомендуется применять совместно с функцией ДлительныеОперацииКлиент.ОжидатьЗавершение,
// если невозможно, тогда для проверки завершения операции использовать функцию ЗаданиеВыполнено.
//
// Параметры:
// ИмяПроцедуры - Строка - имя экспортной процедуры общего модуля, модуля менеджера объекта
// или модуля обработки, которую необходимо выполнить в фоне.
// Например, "МойОбщийМодуль.МояПроцедура", "Отчет.ЗагруженныеДанные.Сформировать"
// или "Обработка.ЗагрузкаДанных.МодульОбъекта.Загрузить".
// У процедуры должно быть два или три формальных параметра:
// * Параметры - Структура - произвольные параметры ПараметрыПроцедуры;
// * АдресРезультата - Строка - адрес временного хранилища, в которое нужно
// поместить результат работы процедуры. Обязательно;
// * АдресДополнительногоРезультата - Строка - если в ПараметрыВыполнения установлен
// параметр ДополнительныйРезультат, то содержит адрес дополнительного временного
// хранилища, в которое нужно поместить результат работы процедуры. Опционально.
// При необходимости выполнить в фоне функцию ее следует обернуть в процедуру,
// а ее результат возвращать через второй параметр АдресРезультата.
// ПараметрыПроцедуры - Структура - произвольные параметры вызова процедуры ИмяПроцедуры.
// ПараметрыВыполнения - см. ДлительныеОперации.ПараметрыВыполненияВФоне
//
// Возвращаемое значение:
// Структура:
// * Статус - Строка - "Выполняется", если задание еще не завершилось;
// "Выполнено", если задание было успешно выполнено;
// "Ошибка", если задание завершено с ошибкой;
// "Отменено", если задание отменено пользователем или администратором.
// * ИдентификаторЗадания - УникальныйИдентификатор - если Статус = "Выполняется", то содержит
// идентификатор запущенного фонового задания.
// - Неопределено - если Статус <> "Выполняется" и фоновое задание не запускалось.
// * АдресРезультата - Строка - адрес временного хранилища, в которое будет помещен результат работы процедуры
// (или уже помещен, если Статус = "Выполнено").
// * АдресДополнительногоРезультата - Строка - если установлен параметр ДополнительныйРезультат,
// содержит адрес дополнительного временного хранилища,
// в которое будет помещен результат работы процедуры
// (или уже помещен, если Статус = "Выполнено").
// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка".
// - Неопределено - если Статус <> "Ошибка".
// * Сообщения - ФиксированныйМассив - если Статус <> "Выполняется", то массив объектов СообщениеПользователю,
// которые были сформированы в фоновом задании.
// * КраткоеПредставлениеОшибки - Строка - устарел.
// * ПодробноеПредставлениеОшибки - Строка - устарел.
//
// Пример:
// В общем виде процесс запуска и обработки результата длительной операции выглядит следующим образом:
//
// 1) Процедура, которая будет исполняться в фоне, располагается в модуле менеджера объекта или в серверном общем модуле:
// Процедура ВыполнитьДействие(Параметры, АдресРезультата) Экспорт
// ...
// ПоместитьВоВременноеХранилище(Результат, АдресРезультата);
// КонецПроцедуры
//
// 2) Запуск операции на сервере и подключение обработчика ожидания:
// &НаКлиенте
// Процедура ВыполнитьДействие()
// ДлительнаяОперация = НачатьВыполнениеНаСервере();
// ПараметрыОжидания = ДлительныеОперацииКлиент.ПараметрыОжидания(ЭтотОбъект);
// ...
// ОповещениеОЗавершении = Новый ОписаниеОповещения("ВыполнитьДействиеЗавершение", ЭтотОбъект);
// ДлительныеОперацииКлиент.ОжидатьЗавершение(ДлительнаяОперация, ОповещениеОЗавершении, ПараметрыОжидания);
// КонецПроцедуры
//
// &НаСервере
// Функция НачатьВыполнениеНаСервере()
// ПараметрыПроцедуры = Новый Структура;
// ...
// ПараметрыВыполнения = ДлительныеОперации.ПараметрыВыполненияВФоне(УникальныйИдентификатор);
// ...
// Возврат ДлительныеОперации.ВыполнитьВФоне("Обработка.МояОбработка.ВыполнитьДействие",
// ПараметрыПроцедуры, ПараметрыВыполнения);
// КонецФункции
//
// 3) Обработка результата выполнения операции:
// &НаКлиенте
// Процедура ВыполнитьДействиеЗавершение(Результат, ДополнительныеПараметры) Экспорт
// Если Результат = Неопределено Тогда
// Возврат;
// КонецЕсли;
// Если Результат.Статус = "Ошибка" Тогда
// СтандартныеПодсистемыКлиент.ВывестиИнформациюОбОшибке(Результат.ИнформацияОбОшибке);
// Возврат;
// КонецЕсли;
// ВывестиРезультат(Результат);
// КонецПроцедуры
//
Функция ВыполнитьВФоне(Знач ИмяПроцедуры, Знач ПараметрыПроцедуры, Знач ПараметрыВыполнения) Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ВыполнитьВФоне(ИмяПроцедуры, ПараметрыПроцедуры, ПараметрыВыполнения)
```
</details>
## ПараметрыВыполненияВФоне
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает новую структуру для параметра ПараметрыВыполнения функции ВыполнитьВФоне.
//
// Если ЗапуститьВФоне = Ложь и ЗапуститьНеВФоне = Ложь, то задание будет выполнено в фоне по возможности.
// Запуск с расширениями сеанса выполняется сразу в основном потоке при выполнении любого из следующих условий:
// * если вызов выполняется в файловой базе во внешнем соединении (в этом режиме фоновые задания не поддерживаются);
// * если приложение запущено в режиме отладки (параметр /C РежимОтладки) - для упрощения отладки конфигурации;
// * если в файловой ИБ имеются активные фоновые задания - для снижения времени ожидания пользователя.
//
// Параметры:
// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, во временное хранилище которой
// необходимо поместить результат выполнения процедуры.
// - Неопределено - если временное хранилище не нужно создавать автоматически на время жизни
// формы, а его адрес предполагается задавать явно в свойстве АдресРезультата.
// В таком случае, временное хранилище нужно очищать явно при обработке результата
// длительной операции с помощью метода УдалитьИзВременногоХранилища.
// Возвращаемое значение:
// Структура:
// * ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы,
// во временное хранилище которой надо поместить результат выполнения процедуры.
// * ДополнительныйРезультат - Булево - признак использования дополнительного временного хранилища для передачи
// результата из фонового задания в родительский сеанс. По умолчанию - Ложь.
// * ОжидатьЗавершение - Неопределено - ждать до момента завершения фонового задания.
// - Число - таймаут в секундах ожидания завершения фонового задания.
// Если задано 0, то ждать завершения задания не требуется.
// По умолчанию - 0.8 секунды, а для низкой скорости соединения - 4.
// * НаименованиеФоновогоЗадания - Строка - описание фонового задания. По умолчанию - имя процедуры.
// * КлючФоновогоЗадания - Строка - уникальный ключ для активных фоновых заданий, имеющих такое же имя процедуры.
// По умолчанию не задан.
// * АдресРезультата - Строка - адрес временного хранилища, в которое должен быть помещен результат
// работы процедуры. Если не задан, адрес формируется автоматически
// на время жизни формы с помощью идентификатора ИдентификаторФормы.
// * ЗапуститьВФоне - Булево - если Истина, то задание будет всегда выполняться в фоне, кроме ситуаций:
// а) если вызов выполняется в файловой базе во внешнем соединении
// (в этом режиме фоновые задания не поддерживаются);
// б) если выполняется функция модуля внешней обработки или внешнего отчета.
// Кроме того, в файловом варианте при наличии ранее запущенных фоновых заданий,
// новое задание становится в очередь и начинает выполняться после завершения предыдущих.
// Если Ложь, то задание будет выполнено в фоне по возможности.
// * ЗапуститьНеВФоне - Булево - если Истина, задание всегда будет запускаться непосредственно,
// без использования фонового задания.
// * БезРасширений - Булево - если Истина, то фоновое задание будет запущено без подключения
// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне.
// * СРасширениямиБазыДанных - Булево - если Истина, то фоновое задание будет запущено с последней версией
// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне.
// * ВнешнийОтчетОбработка - Неопределено - по умолчанию.
// - ДвоичныеДанные - когда указано имя метода, которое начинается
// с "ВнешнийОтчет." или "ВнешняяОбработка.".
// Для вызова такого метода требуется право интерактивного открытия
// внешнего отчета или обработки соответственно.
// Внешний отчет или обработка подключаются с защитой от опасных действий.
// * УточнениеОшибки - Строка - если не пустая строка, тогда для пользователя текст ошибки
// будет уточнен указанным начальным текстом. Пример уточнения:
// НСтр("ru = 'Не удалось очистить адресный классификатор по причине:'")
//
Функция ПараметрыВыполненияВФоне(Знач ИдентификаторФормы = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ПараметрыВыполненияВФоне(ИдентификаторФормы);
```
</details>
## СообщитьПрогресс
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Регистрирует информацию о ходе выполнения длительной операции.
// Не следует использовать для передачи результата работы длительной операции по частям.
//
// Во избежание избыточного потребления памяти и ее утечек при выполнении одной длительной операции
// не следует сообщать прогресс более 100 раз.
//
// Если прогресс сообщается менее чем через 3 сек после предыдущего вызова, то последнее сообщение
// удаляется и заменяется на новое (если используется система взаимодействия, то отправка нового
// сообщения не выполняется, а будет выполнена спустя некоторое время - не быстрее 3 сек).
//
// Перед отправкой прогресса отправляются все сообщения, накопленные в очереди сообщений фонового задания.
//
// Для того чтобы выводить ход выполнения длительной операции для пользователя в стандартной форме ожидания,
// следует установить свойство ВыводитьПрогрессВыполнения в Истина (см. ДлительныеОперацииКлиент.ПараметрыОжидания).
//
// Параметры:
// Процент - Число - процент выполнения.
// Текст - Строка - информация о текущей операции.
// ДополнительныеПараметры - Произвольный - любая дополнительная информация, которую необходимо передать на клиент.
// Значение должно быть простым (сериализуемым в XML-строку).
// Размер данных не должен превышать размер, указанный для параметра Результат
// процедуры СерверныеОповещения.ОтправитьСерверноеОповещение.
//
Процедура СообщитьПрогресс(Знач Процент = Неопределено, Знач Текст = Неопределено, Знач ДополнительныеПараметры = Неопределено) Экспорт
```
Пример вызова
```bsl
ДлительныеОперации.СообщитьПрогресс(Процент, Текст, ДополнительныеПараметры);
```
</details>
## ПрочитатьПрогресс
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Считывает информацию о ходе выполнения длительной операции,
// записанную процедурой ДлительныеОперации.СообщитьПрогресс.
//
// Рекомендуется получать прогресс через обработчик оповещения,
// который подключается с помощью ДлительныеОперацииКлиент.ОжидатьЗавершение.
//
// Параметры:
// ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания.
//
// Возвращаемое значение:
// Неопределено - нет информации о ходе выполнения.
// Структура:
// * Процент - Число - необязательный. Процент выполнения.
// * Текст - Строка - необязательный. Информация о текущей операции.
// * ДополнительныеПараметры - Произвольный - необязательный. Любая дополнительная информация.
//
Функция ПрочитатьПрогресс(Знач ИдентификаторЗадания) Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ПрочитатьПрогресс(ИдентификаторЗадания)
```
</details>
## ОтменитьВыполнениеЗадания
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Отменяет выполнение фонового задания по переданному идентификатору.
// При этом если в длительной операции открывались транзакции, то будет произведен откат последней открытой транзакции.
//
// Таким образом, если длительная операция выполняет обработку (запись) данных, то для полной отмены всей операции
// следует выполнять запись в одной транзакции (в таком случае, будет отменена вся транзакция целиком).
// Если же достаточно, чтобы длительная операция была не отменена целиком, а прервана на достигнутом этапе,
// то, напротив, открывать одну длинную транзакцию не требуется.
//
// Параметры:
// ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания, полученный при запуске
// длительной операции. Смотри ДлительныеОперации.ВыполнитьВФоне.
//
Процедура ОтменитьВыполнениеЗадания(Знач ИдентификаторЗадания) Экспорт
```
Пример вызова
```bsl
ДлительныеОперации.ОтменитьВыполнениеЗадания(ИдентификаторЗадания)
```
</details>
## ЗаданиеВыполнено
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет состояние фонового задания по переданному идентификатору.
// При аварийном завершении задания вызывает исключение с текстом ошибки,
// возникшим в нем, и уточнением вида "См. также журнал регистрации".
//
// Параметры:
// ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания.
// РасширенныйРезультат - Булево - если Истина, вернуть структуру.
//
// Возвращаемое значение:
// Булево - состояние выполнения задания.
// Структура:
// * Статус - Строка - "Выполняется", если задание еще не завершилось;
// "Выполнено", если задание было успешно выполнено;
// "Ошибка", если задание завершено с ошибкой;
// "Отменено", если задание отменено пользователем или администратором.
//
// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка" или Статус = "Отменено".
// - Неопределено - если Статус <> "Ошибка" и Статус <> "Отменено".
//
// * ИдентификаторЗадания - УникальныйИдентификатор - последний идентификатор задания,
// если были перезапуски (например, при многопоточной длительной операции)
// или тот же идентификатор, что передан в функцию, когда перезапусков не было.
//
// * Задание - Неопределено - задание не найдено.
// - ФоновоеЗадание - когда задание найдено.
//
// * ТекстОшибки - Строка - устарел.
// * КраткоеПредставлениеОшибки - Строка - устарел.
// * ПодробноеПредставлениеОшибки - Строка - устарел.
//
Функция ЗаданиеВыполнено(Знач ИдентификаторЗадания, РасширенныйРезультат = Ложь) Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ЗаданиеВыполнено(ИдентификаторЗадания, РасширенныйРезультат);
```
</details>
## СообщенияПользователю
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Получает сообщения пользователю из фонового задания длительной операции.
//
// Рекомендуется получать сообщения через обработчик оповещения,
// который подключается с помощью ДлительныеОперацииКлиент.ОжидатьЗавершение.
//
// Параметры:
// УдалятьПолученные - Булево - признак необходимости удаления полученных сообщений.
// ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания, соответствующего длительной
// операции, у которой требуется получить сообщения пользователю.
// Если не задан, то сообщения пользователю возвращаются
// из сеанса текущего пользователя.
//
// Возвращаемое значение:
// ФиксированныйМассив - объекты СообщениеПользователю, которые были сформированы в фоновом задании.
//
// Пример:
// Операция = ДлительныеОперации.ВыполнитьВФоне(...);
// ...
// Сообщения = ДлительныеОперации.СообщенияПользователю(Истина, Операция.ИдентификаторЗадания);
//
Функция СообщенияПользователю(УдалятьПолученные = Ложь, ИдентификаторЗадания = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.СообщенияПользователю(УдалятьПолученные, ИдентификаторЗадания);
```
</details>
## ЗапуститьВыполнениеВФоне
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ВыполнитьВФоне.
//
// Запускает выполнение процедуры в фоновом задании.
// Является менее функциональным аналогом ВыполнитьВФоне, предусмотрена для обратной совместимости.
//
// Параметры:
// ИдентификаторФормы - УникальныйИдентификатор - идентификатор формы,
// из которой выполняется запуск длительной операции.
// ИмяЭкспортнойПроцедуры - Строка - имя экспортной процедуры,
// которую необходимо выполнить в фоне.
// Параметры - Структура - все необходимые параметры для
// выполнения процедуры ИмяЭкспортнойПроцедуры.
// НаименованиеЗадания - Строка - наименование фонового задания.
// Если не задано, то будет равно ИмяЭкспортнойПроцедуры.
// ИспользоватьДополнительноеВременноеХранилище - Булево - признак использования
// дополнительного временного хранилища для передачи данных
// в родительский сеанс из фонового задания. По умолчанию - Ложь.
//
// Возвращаемое значение:
// Структура - параметры выполнения задания:
// * АдресХранилища - Строка - адрес временного хранилища, в которое будет
// помещен результат работы задания;
// * АдресХранилищаДополнительный - Строка - адрес дополнительного временного хранилища,
// в которое будет помещен результат работы задания (доступно только если
// установлен параметр ИспользоватьДополнительноеВременноеХранилище);
// * ИдентификаторЗадания - УникальныйИдентификатор - уникальный идентификатор запущенного фонового задания;
// - Неопределено - если фоновое задание не запускалось;
// * ЗаданиеВыполнено - Булево - Истина если задание было успешно выполнено за время вызова функции.
//
Функция ЗапуститьВыполнениеВФоне(Знач ИдентификаторФормы, Знач Имя Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперации.ЗапуститьВыполнениеВФоне(ИдентификаторФормы, ИмяЭкспортнойПроцедуры, Параметры, );
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

284
src/content/docs/bsp/ДлительныеОперацииКлиент.md Normal file
View File

@ -0,0 +1,284 @@
---
title: Длительные операции клиент
slug: bsp/длительные-операции-клиент
---
## ОжидатьЗавершение
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открыть стандартную форму ожидания завершения длительной операции или использовать собственную форму
// и подключить обработчик оповещения о завершении и прогрессе выполнения процедуры длительной операции.
//
// Применяется совместно с функцией ДлительныеОперации.ВыполнитьВФоне для повышения отзывчивости
// пользовательского интерфейса, заменяя длительный серверный вызов на запуск фонового задания.
//
// Параметры:
// ДлительнаяОперация - см. ДлительныеОперации.ВыполнитьВФоне
// ОповещениеОЗавершении - ОписаниеОповещения - оповещение, которое вызывается после завершения
// длительной операции, в том числе после закрытия окна ожидания, если открывалось.
// Параметры процедуры-обработчика оповещения:
// # Результат - см. НовыйРезультатДлительнойОперации
// - Неопределено - если задание было отменено
// # ДополнительныеПараметры - Произвольный - произвольные данные, переданные в описании оповещения.
// ПараметрыОжидания - см. ДлительныеОперацииКлиент.ПараметрыОжидания
//
Процедура ОжидатьЗавершение(Знач ДлительнаяОперация, Знач ОповещениеОЗавершении = Неопределено, Экспорт
```
Пример вызова
```bsl
ДлительныеОперацииКлиент.ОжидатьЗавершение(ДлительнаяОперация, ОповещениеОЗавершении, );
```
</details>
## ПараметрыОжидания
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает пустую структуру для параметра ПараметрыОжидания процедуры ДлительныеОперацииКлиент.ОжидатьЗавершение.
//
// Параметры:
// ФормаВладелец - ФормаКлиентскогоПриложения
// - Неопределено - форма, из которой вызывается длительная операция.
//
// Возвращаемое значение:
// Структура - параметры выполнения задания:
// * ФормаВладелец - ФормаКлиентскогоПриложения
// - Неопределено - форма, из которой вызывается длительная операция.
// * Заголовок - Строка - заголовок окна, выводимый на форме ожидания. Если не задан, то не выводится.
// * ТекстСообщения - Строка - текст сообщения, выводимый на форме ожидания.
// Если не задан, то выводится "Пожалуйста, подождите...".
// * ВыводитьОкноОжидания - Булево - если Истина, то открыть окно ожидания с визуальной индикацией длительной операции.
// Если используется собственный механизм индикации, то следует указать Ложь.
// * РежимОткрытияОкнаОжидания - РежимОткрытияОкнаФормы - параметр РежимОткрытияОкна у формы ожидания.
// - Неопределено - значение по умолчанию.
// * ВыводитьПрогрессВыполнения - Булево - выводить прогресс выполнения в процентах на форме ожидания.
// Процедура-обработчик длительной операции может сообщить о ходе своего выполнения
// с помощью вызова процедуры ДлительныеОперации.СообщитьПрогресс.
// * ВыводитьСообщения - Булево - из формы ожидания выводить в ФормаВладелец сообщения,
// сформированные в процедуре-обработчике длительной операции.
// * ЗаголовокКнопкиОтмена - Строка - заголовок кнопки Отмена, если не указано, по умолчанию используется "Отмена"
// * ОповещениеОПрогрессеВыполнения - ОписаниеОповещения - оповещение, которое периодически вызывается при
// проверке готовности фонового задания, если ВыводитьОкноОжидания = Ложь.
// Параметры процедуры-обработчика оповещения:
// # Результат - см. НовоеСостояниеДлительнойОперации
// # ДополнительныеПараметры - Произвольный - произвольные данные, переданные в описании оповещения.
//
// * Интервал - Число - интервал в секундах между проверками готовности длительной операции.
// По умолчанию 0 - после каждой проверки интервал увеличивается с 1 до 15 секунд
// с коэффициентом 1.4.
// * ОповещениеПользователя - Структура:
// ** Показать - Булево - если Истина, то по завершении длительной операции вывести оповещение пользователя.
// ** Текст - Строка - текст оповещения пользователя.
// ** НавигационнаяСсылка - Строка - навигационная ссылка оповещения пользователя.
// ** Пояснение - Строка - пояснение оповещения пользователя.
// ** Картинка - Картинка - картинка, которая будет показана в окне оповещения. Если Неопределено, то
// картинка не выводится.
// ** Важное - Булево - если Истина, то оповещение после автоматического закрытия будет добавлено в
// центр оповещений.
//
// * ОтменятьПриЗакрытииФормыВладельца - Булево - по умолчанию ФормаВладелец.Открыта(), Ложь если форма не указана.
// Если Ложь, тогда длительная операция не будет отменена при закрытии формы владельца и при закрытии окна ожидания.
//
// * ПолучатьРезультат - Булево - служебный параметр. Не предназначен для использования.
//
Функция ПараметрыОжидания(ФормаВладелец) Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперацииКлиент.ПараметрыОжидания(ФормаВладелец)
```
</details>
## НовыйРезультатДлительнойОперации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает результат оповещения, указанного в параметре ОповещениеОЗавершении
// процедуры ДлительныеОперацииКлиент.ОжидатьЗавершение.
//
// Возвращаемое значение:
// Неопределено - передается в результат ОповещениеОЗавершении, если задание отменено пользователем.
// Структура:
// * Статус - Строка - "Выполнено", если задание было успешно выполнено.
// "Ошибка", если задание завершено с ошибкой.
//
// * АдресРезультата - Строка - адрес временного хранилища, в которое будет помещен
// (или уже помещен) результат работы процедуры длительной операции.
//
// * АдресДополнительногоРезультата - Строка - если установлен параметр ДополнительныйРезультат,
// содержит адрес дополнительного временного хранилища, в которое будет помещен
// (или уже помещен) дополнительный результат работы процедуры длительной операции.
//
// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка".
// - Неопределено - если Статус <> "Ошибка".
//
// * Сообщения - ФиксированныйМассив - массив объектов СообщениеПользователю,
// сформированных в процедуре-обработчике длительной операции.
// Массив будет пустым, когда в параметре ПараметрыОжидания
// процедуры процедуры ДлительныеОперацииКлиент.ОжидатьЗавершение
// свойство ВыводитьОкноОжидания = Ложь и
// заполнено свойство ОповещениеОПрогрессеВыполнения.
//
// * ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания, если запускалось.
// - Неопределено - если задание не запускалось (например, выполнение не в фоне).
//
// * КраткоеПредставлениеОшибки - Строка - устарел.
// * ПодробноеПредставлениеОшибки - Строка - устарел.
//
Функция НовыйРезультатДлительнойОперации() Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперацииКлиент.НовыйРезультатДлительнойОперации()
```
</details>
## НовоеСостояниеДлительнойОперации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает пустую структуру для передачи как результат оповещения, указанного
// в свойстве ОповещениеОПрогрессеВыполнения параметра ПараметрыОжидания
// процедуры ДлительныеОперацииКлиент.ОжидатьЗавершение.
//
// Возвращаемое значение:
// Структура:
// * Статус - Строка - "Выполняется", если задание еще не завершилось,
// "Выполнено", если задание было успешно выполнено,
// "Ошибка", если задание завершено с ошибкой.
//
// * Прогресс - см. ДлительныеОперации.ПрочитатьПрогресс
// * Сообщения - Неопределено - нет сообщений.
// - ФиксированныйМассив из СообщениеПользователю - порция сообщений,
// отправленных из процедуры длительной операции.
//
// * ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания, если запускалось.
// - Неопределено - если задание не запускалось (например, выполнение не в фоне).
//
Функция НовоеСостояниеДлительнойОперации() Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперацииКлиент.НовоеСостояниеДлительнойОперации()
```
</details>
## ИнициализироватьПараметрыОбработчикаОжидания
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ОжидатьЗавершение с параметром ПараметрыОжидания.ВыводитьОкноОжидания = Истина.
// Заполняет структуру параметров значениями по умолчанию.
//
// Параметры:
// ПараметрыОбработчикаОжидания - Структура - заполняется значениями по умолчанию.
//
//
Процедура ИнициализироватьПараметрыОбработчикаОжидания(ПараметрыОбработчикаОжидания) Экспорт
```
Пример вызова
```bsl
ДлительныеОперацииКлиент.ИнициализироватьПараметрыОбработчикаОжидания(ПараметрыОбработчикаОжидания)
```
</details>
## ОбновитьПараметрыОбработчикаОжидания
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ОжидатьЗавершение с параметром ПараметрыОжидания.ВыводитьОкноОжидания = Истина.
// Заполняет структуру параметров новыми расчетными значениями.
//
// Параметры:
// ПараметрыОбработчикаОжидания - Структура - заполняется расчетными значениями.
//
//
Процедура ОбновитьПараметрыОбработчикаОжидания(ПараметрыОбработчикаОжидания) Экспорт
```
Пример вызова
```bsl
ДлительныеОперацииКлиент.ОбновитьПараметрыОбработчикаОжидания(ПараметрыОбработчикаОжидания)
```
</details>
## ОткрытьФормуДлительнойОперации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ОжидатьЗавершение с параметром ПараметрыОжидания.ВыводитьОкноОжидания = Истина.
// Открывает форму-индикатор длительной операции.
//
// Параметры:
// ВладелецФормы - ФормаКлиентскогоПриложения - форма, из которой производится открытие.
// ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания.
//
// Возвращаемое значение:
// ФормаКлиентскогоПриложения - ссылка на открытую форму.
//
Функция ОткрытьФормуДлительнойОперации(Знач ВладелецФормы, Знач ИдентификаторЗадания) Экспорт
```
Пример вызова
```bsl
Результат = ДлительныеОперацииКлиент.ОткрытьФормуДлительнойОперации(ВладелецФормы, ИдентификаторЗадания)
```
</details>
## ЗакрытьФормуДлительнойОперации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ОжидатьЗавершение с параметром ПараметрыОжидания.ВыводитьОкноОжидания = Истина.
// Закрывает форму-индикатор длительной операции.
//
// Параметры:
// ФормаДлительнойОперации - ФормаКлиентскогоПриложения - ссылка на форму-индикатор длительной операции.
//
Процедура ЗакрытьФормуДлительнойОперации(ФормаДлительнойОперации) Экспорт
```
Пример вызова
```bsl
ДлительныеОперацииКлиент.ЗакрытьФормуДлительнойОперации(ФормаДлительнойОперации)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

380
src/content/docs/bsp/ДополнительныеОтчетыИОбработки.md Normal file
View File

@ -0,0 +1,380 @@
---
title: Дополнительные отчеты и обработки
slug: bsp/дополнительные-отчеты-и-обработки
---
## ПодключитьВнешнююОбработку
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Подключает и возвращает имя, под которым подключен внешний отчет или обработка.
// После подключения отчет или обработка регистрируется в программе под определенным именем,
// используя которое, можно создавать объект или открывать формы отчета или обработки.
//
// Важно: проверка функциональной опции "ИспользоватьДополнительныеОтчетыИОбработки"
// должна выполняться вызывающим кодом.
//
// Параметры:
// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - подключаемая обработка.
//
// Возвращаемое значение:
// Строка - имя подключенного отчета или обработки.
// Неопределено - если передана некорректная ссылка.
//
Функция ПодключитьВнешнююОбработку(Ссылка) Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработки.ПодключитьВнешнююОбработку(Ссылка)
```
</details>
## ОбъектВнешнейОбработки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает объект внешнего отчета или обработки.
//
// Важно: проверка функциональной опции "ИспользоватьДополнительныеОтчетыИОбработки"
// должна выполняться вызывающим кодом.
//
// Параметры:
// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - подключаемый отчет или обработка.
//
// Возвращаемое значение:
// ВнешняяОбработка - объект подключенной обработки.
// ВнешнийОтчет - объект подключенного отчета.
// Неопределено - если передана некорректная ссылка.
//
Функция ОбъектВнешнейОбработки(Ссылка) Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработки.ОбъектВнешнейОбработки(Ссылка)
```
</details>
## ПечатьПоВнешнемуИсточнику
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Формирует печатную форму по внешнему источнику.
//
// Параметры:
// ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - внешняя обработка.
// ПараметрыИсточника - Структура:
// * ИдентификаторКоманды - Строка - список макетов, перечисленных через запятую.
// * ОбъектыНазначения - Массив
// КоллекцияПечатныхФорм - ТаблицаЗначений - сформированные табличные документы (возвращаемый параметр).
// ОбъектыПечати - СписокЗначений - соответствие между объектами и именами областей печати
// табличного документа. Значение - Объект, представление - имя области,
// в которой был выведен объект (возвращаемый параметр).
// ПараметрыВывода - Структура - дополнительные параметры сформированных табличных документов
// (возвращаемый параметр).
//
Процедура ПечатьПоВнешнемуИсточнику(ДополнительнаяОбработкаСсылка, ПараметрыИсточника, КоллекцияПечатныхФорм, Экспорт
```
Пример вызова
```bsl
ДополнительныеОтчетыИОбработки.ПечатьПоВнешнемуИсточнику(ДополнительнаяОбработкаСсылка, ПараметрыИсточника, КоллекцияПечатныхФорм, );
```
</details>
## СведенияОВнешнейОбработке
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Формирует шаблон сведений о внешнем отчете или обработке для последующего заполнения.
//
// Параметры:
// ВерсияБСП - см. СтандартныеПодсистемыСервер.ВерсияБиблиотеки.
//
// Возвращаемое значение:
// Структура - параметры внешнего отчета или обработки:
// * Вид - ПеречислениеСсылка.ВидыДополнительныхОтчетовИОбработок
// - Строка - вид внешнего отчета или обработки. Для указания вида рекомендуется использовать функции
// ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработки<ИмяВида>.
// Также вид можно указать явно:
// "ПечатнаяФорма",
// "ЗаполнениеОбъекта",
// "СозданиеСвязанныхОбъектов",
// "Отчет",
// "ШаблонСообщения",
// "ДополнительнаяОбработка",
// "ДополнительныйОтчет".
//
// * Версия - Строка - версия отчета или обработки (далее - обработки).
// Задается в формате: "<Старший номер>.<Младший номер>".
//
// * Назначение - Массив - полные имена объектов конфигурации (Строка), для которых предназначен эта обработка.
// Необязательное свойство.
//
// * Наименование - Строка - представление для администратора (наименование элемента справочника).
// Если не заполнено, то берется представление объекта метаданных внешней обработки.
// Необязательное свойство.
//
// * БезопасныйРежим - Булево - признак подключения внешней обработки в безопасном режиме.
// Значение по умолчанию Истина (обработка будет выполняться безопасно).
// В безопасном режиме:
// Игнорируется привилегированный режим.
// Запрещены внешние по отношению к платформе 1С:Предприятия действия:
// COM;
// загрузка внешних компонент;
// запуск внешних приложений и команд операционной системы;
// доступ к файловой системе, кроме временных файлов;
// доступ к Интернету.
// Необязательное свойство.
//
// * Разрешения - Массив из ОбъектXDTO - дополнительные разрешения, необходимые внешней обработке при работе в
// безопасном режиме. Элемент массива - ОбъектXDTO - разрешение типа
// {HTTP://www.1c.ru/1cFresh/ApplicationExtensions/Permissions/a.b.c.d}PermissionBase.
// Для формирования описания разрешения рекомендуется использовать функции
// РаботаВБезопасномРежиме.Разрешение<ВидРазрешения>(<ПараметрыРазрешения>).
// Необязательное свойство.
//
// * Информация - Строка - краткая информация о внешней обработке.
// В этом параметре для администратора рекомендуется дать описание ее возможностей.
// Если не заполнено, то берется комментарий объекта метаданных внешней обработки.
//
// * ВерсияБСП - см. СтандартныеПодсистемыСервер.ВерсияБиблиотеки.
//
// * ОпределитьНастройкиФормы - Булево - только для дополнительных отчетов, подключенных к общей форме ФормаОтчета.
// Позволяет переопределять некоторые настройки общей формы отчета и
// подписываться на ее события.
// Если Истина, то в модуле объекта отчета следует определить процедуру по шаблону:
//
// * НазначениеВариантаОтчета - ПеречислениеСсылка.НазначенияВариантовОтчетов - назначение варианта отчета
// (ДляКомпьютеровИПланшетов, ДляСмартфонов, ДляЛюбыхУстройств).
//
// // Задать настройки формы отчета.
// //
// // Параметры:
// // Форма - ФормаКлиентскогоПриложения, Неопределено
// // КлючВарианта - Строка, Неопределено
// // Настройки - см. ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию
// //
// Процедура ОпределитьНастройкиФормы(Форма, КлючВарианта, Настройки) Экспорт
// // Код процедуры.
// КонецПроцедуры
//
// Подробнее см. в документации к подсистемам "Дополнительные отчеты и обработки" и "Варианты отчетов".
// Необязательное свойство.
//
// * Команды - ТаблицаЗначений - настройки команд, поставляемых внешней обработкой (необязательно для отчетов):
// ** Идентификатор - Строка - внутреннее имя команды. Для внешних печатных форм (когда Вид = "ПечатнаяФорма"):
// Идентификатор может содержать имена одной или нескольких команд печати,
// разделенные запятыми. Подробнее см. описание колонки Идентификатор
// в функции УправлениеПечатью.СоздатьКоллекциюКомандПечати.
// ** Представление - Строка - пользовательское представление команды.
// ** Использование - Строка - тип команды:
// "ВызовКлиентскогоМетода",
// "ВызовСерверногоМетода",
// "ЗаполнениеФормы",
// "ОткрытиеФормы" или
// "СценарийВБезопасномРежиме".
// Для получения типов команд рекомендуется использовать функции
// ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКоманды<ИмяТипа>.
// В комментариях к этим функциям также даны шаблоны процедур-обработчиков команд.
// ** ПоказыватьОповещение - Булево - если Истина, то при запуске команды выводится оповещение "Команда выполняется...".
// Действует для всех типов команд, кроме команд по открытию формы (Использование = "ОткрытиеФормы").
// ** Модификатор - Строка - дополнительная классификация команды.
// Для внешних печатных форм (когда Вид = "ПечатнаяФорма"):
// "ПечатьMXL" - для печатных форм на основе табличных макетов.
// Для загрузки данных из файла (когда Вид = "ПечатнаяФорма" и Использование = "ЗагрузкаДанныхИзФайла"):
// Модификатор является обязательным для заполнения
// и должен содержать полное имя объекта метаданных (справочника),
// для которого выполняется загрузка данных.
// ** Скрыть - Булево - необязательный. Признак того, что это служебная команда.
// Если установить в значение Истина, то команда скрывается в карточке дополнительного объекта.
//
Функция СведенияОВнешнейОбработке(ВерсияБСП = "") Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработки.СведенияОВнешнейОбработке(ВерсияБСП);
```
</details>
## ВыполнитьКоманду
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет команду обработки и возвращает результат ее выполнения.
//
// Важно: проверка функциональной опции "ИспользоватьДополнительныеОтчетыИОбработки"
// должна выполняться вызывающим кодом.
//
// Параметры:
// ПараметрыКоманды - Структура - параметры, с которыми выполняется команда:
// * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - элемент справочника.
// * ИдентификаторКоманды - Строка - имя выполняемой команды.
// * ОбъектыНазначения - Массив - ссылки объектов, для которых выполняется обработка. Обязательный для
// назначаемых обработок.
// АдресРезультата - Строка - адрес временного хранилища по которому будет размещен результат
// выполнения.
//
// Возвращаемое значение:
// Структура - результат выполнения, который далее передается на клиент.
// Неопределено - если был передан АдресРезультата.
//
Функция ВыполнитьКоманду(ПараметрыКоманды, АдресРезультата = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработки.ВыполнитьКоманду(ПараметрыКоманды, АдресРезультата);
```
</details>
## ВыполнитьКомандуИзФормыВнешнегоОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет команду обработки напрямую из формы внешнего объекта и возвращает результат ее выполнения.
// Пример использования - см. ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне.
//
// Важно: проверка функциональной опции "ИспользоватьДополнительныеОтчетыИОбработки"
// должна выполняться вызывающим кодом.
//
// Параметры:
// ИдентификаторКоманды - Строка - имя команды, как оно задано в функции СведенияОВнешнейОбработке() модуля объекта.
// ПараметрыКоманды - Структура - параметры выполнения команды.
// См. ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне.
// Форма - ФормаКлиентскогоПриложения - форма, в которую необходимо вернуть результат.
//
// Возвращаемое значение:
// Структура - для служебного использования.
//
Функция ВыполнитьКомандуИзФормыВнешнегоОбъекта(ИдентификаторКоманды, ПараметрыКоманды, Форма) Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработки.ВыполнитьКомандуИзФормыВнешнегоОбъекта(ИдентификаторКоманды, ПараметрыКоманды, Форма)
```
</details>
## РазделыДополнительныхОтчетов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Формирует список разделов, в которых доступна команда вызова дополнительных отчетов.
//
// Возвращаемое значение:
// Массив - массив объектов метаданных Подсистема - метаданные разделов, в которые выведен список команд
// дополнительных отчетов.
//
Функция РазделыДополнительныхОтчетов() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработки.РазделыДополнительныхОтчетов()
```
</details>
## РазделыДополнительныхОбработок
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Формирует список разделов, в которых доступна команда вызова дополнительных обработок.
//
// Возвращаемое значение:
// Массив - массив объектов метаданных Подсистема - метаданные разделов, в которые выведен список команд дополнительных
// обработок.
//
Функция РазделыДополнительныхОбработок() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработки.РазделыДополнительныхОбработок()
```
</details>
## СохранитьНастройки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Сохраняет настройки, требуемые для выполнения обработки.
// С ее помощью, например, в интерактивных обработках можно сохранять
// последние введенные пользователем значения, а для обработок, выполняемых по регламентному заданию,
// позволить администратору задавать значения по умолчанию и различные параметры работы.
//
// Параметры:
// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки
// Настройки - Произвольный - сохраняемые настройки
//
Процедура СохранитьНастройки(Ссылка, Настройки) Экспорт
```
Пример вызова
```bsl
ДополнительныеОтчетыИОбработки.СохранитьНастройки(Ссылка, Настройки)
```
</details>
## ЗагрузитьНастройки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает сохраненные параметры дополнительной обработки.
// См. процедуру СохранитьНастройки.
//
// Параметры:
// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки
//
// Возвращаемое значение:
// Произвольный - сохраненные настройки.
//
Функция ЗагрузитьНастройки(Ссылка) Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработки.ЗагрузитьНастройки(Ссылка)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

157
src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиент.md Normal file
View File

@ -0,0 +1,157 @@
---
title: Дополнительные отчеты и обработки клиент
slug: bsp/дополнительные-отчеты-и-обработки-клиент
---
## ОткрытьФормуКомандДополнительныхОтчетовИОбработок
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму с доступными командами.
//
// Параметры:
// ПараметрКоманды - Произвольный - передается "как есть" из параметров обработчика команды.
// ПараметрыВыполненияКоманды - ПараметрыВыполненияКоманды - передается "как есть" из параметров обработчика команды.
// Вид - Строка - вид обработки, который можно получить из серии функций:
// ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработки<...>.
// ИмяРаздела - Строка - имя раздела командного интерфейса, из которого вызывается команда.
//
Процедура ОткрытьФормуКомандДополнительныхОтчетовИОбработок(ПараметрКоманды, ПараметрыВыполненияКоманды, Вид, ИмяРаздела = "") Экспорт
```
Пример вызова
```bsl
ДополнительныеОтчетыИОбработкиКлиент.ОткрытьФормуКомандДополнительныхОтчетовИОбработок(ПараметрКоманды, ПараметрыВыполненияКоманды, Вид, ИмяРаздела);
```
</details>
## ОткрытьВариантДополнительногоОтчета
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму дополнительного отчета с заданным вариантом.
//
// Параметры:
// ДополнительныйОтчет - СправочникСсылка.ДополнительныеОтчетыИОбработки
// КлючВарианта - Строка - имя варианта дополнительного отчета.
//
Процедура ОткрытьВариантДополнительногоОтчета(ДополнительныйОтчет, КлючВарианта) Экспорт
```
Пример вызова
```bsl
ДополнительныеОтчетыИОбработкиКлиент.ОткрытьВариантДополнительногоОтчета(ДополнительныйОтчет, КлючВарианта)
```
</details>
## ПараметрыВыполненияКомандыВФоне
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает пустую структуру параметров выполнения команды в фоне.
//
// Параметры:
// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка выполняемой дополнительной обработки или отчета.
//
// Возвращаемое значение:
// Структура - шаблон параметров выполнения команды в фоне:
// * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - передается "как есть" из
// параметров формы.
// * СопровождающийТекст - Строка - текст длительной операции.
// * ОбъектыНазначения - Массив - ссылки объектов, для которых выполняется команда.
// Используется для назначаемых дополнительных обработок.
// * СозданныеОбъекты - Массив - ссылки объектов, созданных в процессе выполнения команды.
// Используется для назначаемых дополнительных обработок вида "Создание связанных объектов".
// * ФормаВладелец - ФормаКлиентскогоПриложения - форма объекта или списка, из которой была вызвана команда.
//
Функция ПараметрыВыполненияКомандыВФоне(Ссылка) Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиент.ПараметрыВыполненияКомандыВФоне(Ссылка)
```
</details>
## ВыполнитьКомандуВФоне
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет команду ИдентификаторКоманды в фоне с помощью механизма длительных операций.
// Для использования в формах внешних отчетов и обработок.
//
// Параметры:
// ИдентификаторКоманды - Строка - имя команды, как оно задано в функции СведенияОВнешнейОбработке модуля объекта.
// ПараметрыКоманды - Структура - параметры выполнения команды.
// Состав параметров описан в функции ПараметрыВыполненияКомандыВФоне.
// Также включает в себя служебный параметр, зарезервированный подсистемой:
// * ИдентификаторКоманды - Строка - имя выполняемой команды. Соответствует параметру ИдентификаторКоманды.
// Помимо стандартных параметров может содержать пользовательские для использования в обработчике команды.
// При добавлении собственных параметров рекомендуется использовать префикс в их именах,
// исключающий конфликты со стандартными параметрами, например "Контекст...".
// Обработчик - см. ДлительныеОперацииКлиент.ОжидатьЗавершение.ОповещениеОЗавершении
//
// Пример:
// &НаКлиенте
// Процедура ОбработчикКоманды(Команда)
// ПараметрыКоманды = ДополнительныеОтчетыИОбработкиКлиент.ПараметрыВыполненияКомандыВФоне(Параметры.ДополнительнаяОбработкаСсылка);
// ПараметрыКоманды.СопровождающийТекст = НСтр("ru = 'Выполняется команда...'");
// Обработчик = Новый ОписаниеОповещения("<ИмяЭкспортнойПроцедуры>", ЭтотОбъект);
// ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне(Команда.Имя, ПараметрыКоманды, Обработчик);
// КонецПроцедуры
//
Процедура ВыполнитьКомандуВФоне(Знач ИдентификаторКоманды, Знач ПараметрыКоманды, Знач Обработчик) Экспорт
```
Пример вызова
```bsl
ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне(ИдентификаторКоманды, ПараметрыКоманды, Обработчик)
```
</details>
## ИмяФормыДлительнойОперации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать обработчик оповещения
// (смотри параметр Обработчик в процедуре ВыполнитьКомандуВФоне)
// вместо использования события ОбработкаВыбора формы владельца совместно с анализом источника:
// ИсточникВыбора.ИмяФормы = ДополнительныеОтчетыИОбработкиКлиент.ИмяФормыДлительнойОперации().
//
// Возвращает имя формы для идентификации результата выполнения длительной операции.
//
// Возвращаемое значение:
// Строка - см. ВыполнитьКомандуВФоне.
//
Функция ИмяФормыДлительнойОперации() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиент.ИмяФормыДлительнойОперации()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

37
src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиентПереопределяемый.md Normal file
View File

@ -0,0 +1,37 @@
---
title: Дополнительные отчеты и обработки клиент переопределяемый
slug: bsp/дополнительные-отчеты-и-обработки-клиент-переопределяемый
---
## ПередВыполнениемКомандыПечатиВнешнейПечатнойФормы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать УправлениеПечатьюПереопределяемый.ПриОпределенииНастроекПечати
// Выполняет дополнительные действия перед формированием печатной формы.
//
// Параметры:
// ПечатаемыеОбъекты - Массив - ссылки на объекты, для которых выполняется команда печати;
// СтандартнаяОбработка - Булево - признак необходимости проверки проведенности печатаемых документов,
// если установить в Ложь, то проверка выполняться не будет.
//
Процедура ПередВыполнениемКомандыПечатиВнешнейПечатнойФормы(ПечатаемыеОбъекты, СтандартнаяОбработка) Экспорт
```
Пример вызова
```bsl
ДополнительныеОтчетыИОбработкиКлиентПереопределяемый.ПередВыполнениемКомандыПечатиВнешнейПечатнойФормы(ПечатаемыеОбъекты, СтандартнаяОбработка)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

598
src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиентСервер.md Normal file
View File

@ -0,0 +1,598 @@
---
title: Дополнительные отчеты и обработки клиент сервер
slug: bsp/дополнительные-отчеты-и-обработки-клиент-сервер
---
## ВидОбработкиПечатнаяФорма
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Печатная форма.
//
// Возвращаемое значение:
// Строка - имя вида дополнительных печатных форм.
//
Функция ВидОбработкиПечатнаяФорма() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиПечатнаяФорма()
```
</details>
## ВидОбработкиЗаполнениеОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Заполнение объекта.
//
// Возвращаемое значение:
// Строка - имя вида дополнительных обработок заполнения.
//
Функция ВидОбработкиЗаполнениеОбъекта() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиЗаполнениеОбъекта()
```
</details>
## ВидОбработкиСозданиеСвязанныхОбъектов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Создание связанных объектов.
//
// Возвращаемое значение:
// Строка - имя вида дополнительных обработок создания связанных объектов.
//
Функция ВидОбработкиСозданиеСвязанныхОбъектов() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиСозданиеСвязанныхОбъектов()
```
</details>
## ВидОбработкиОтчет
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Назначаемый отчет.
//
// Возвращаемое значение:
// Строка - имя вида дополнительных контекстных отчетов.
//
Функция ВидОбработкиОтчет() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиОтчет()
```
</details>
## ВидОбработкиШаблонСообщения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Создание связанных объектов.
//
// Возвращаемое значение:
// Строка - имя вида дополнительных контекстных отчетов.
//
Функция ВидОбработкиШаблонСообщения() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиШаблонСообщения()
```
</details>
## ВидОбработкиДополнительнаяОбработка
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Дополнительная обработка.
//
// Возвращаемое значение:
// Строка - имя вида дополнительных глобальных обработок.
//
Функция ВидОбработкиДополнительнаяОбработка() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиДополнительнаяОбработка()
```
</details>
## ВидОбработкиДополнительныйОтчет
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Дополнительный отчет.
//
// Возвращаемое значение:
// Строка - имя вида дополнительных глобальных отчетов.
//
Функция ВидОбработкиДополнительныйОтчет() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиДополнительныйОтчет()
```
</details>
## ТипКомандыВызовСерверногоМетода
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает имя типа команд с вызовом серверного метода. Для выполнения команд такого типа
// в модуле объекта следует определить экспортную процедуру по следующему шаблону.
//
// Для глобальных отчетов и обработок (Вид = "ДополнительнаяОбработка" или Вид = "ДополнительныйОтчет"):
// // Обработчик серверных команд.
// //
// // Параметры:
// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке().
// // ПараметрыВыполнения - Структура - контекст выполнения команды.
// // * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка обработки.
// // Может использоваться для чтения параметров обработки.
// // Пример см. в комментарии к функции ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы().
// // * РезультатВыполнения - Структура - результат выполнения команды.
// // Может использоваться для передачи результата с сервера или из фонового задания в исходную точку.
// // В частности, возвращается функциями ДополнительныеОтчетыИОбработки.ВыполнитьКоманду()
// // и ДополнительныеОтчетыИОбработки.ВыполнитьКомандуИзФормыВнешнегоОбъекта(),
// // а также может быть получено из временного хранилища
// // в обработчике ожидания процедуры ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне().
// //
// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ПараметрыВыполнения) Экспорт
// // Реализация логики команды.
// КонецПроцедуры
//
// Для печатных форм (Вид = "ПечатнаяФорма"):
// // Обработчик печати.
// //
// // Параметры:
// // МассивОбъектов - Массив - ссылки на объекты, которые нужно распечатать.
// // КоллекцияПечатныхФорм - ТаблицаЗначений - информация о табличных документах.
// // Используется для передачи в параметрах функции УправлениеПечатью.СведенияОПечатнойФорме().
// // ОбъектыПечати - СписокЗначений - соответствие между объектами и именами областей в табличных документах.
// // Используется для передачи в параметрах процедуры УправлениеПечатью.ЗадатьОбластьПечатиДокумента().
// // ПараметрыВывода - Структура - дополнительные параметры сформированных табличных документов.
// // * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка обработки.
// // Может использоваться для чтения параметров обработки.
// // Пример см. в комментарии к функции ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы().
// //
// // Пример:
// // ПечатнаяФорма = УправлениеПечатью.СведенияОПечатнойФорме(КоллекцияПечатныхФорм, "<ИдентификаторПечатнойФормы>");
// // Если ПечатнаяФорма <> Неопределено Тогда
// // ТабличныйДокумент = Новый ТабличныйДокумент;
// // ТабличныйДокумент.КлючПараметровПечати = "<КлючСохраненияПараметровПечатнойФормы>";
// // Для Каждого Ссылка Из МассивОбъектов Цикл
// // Если ТабличныйДокумент.ВысотаТаблицы > 0 Тогда
// // ТабличныйДокумент.ВывестиГоризонтальныйРазделительСтраниц();
// // КонецЕсли;
// // НачалоОбласти = ТабличныйДокумент.ВысотаТаблицы + 1;
// // // ... код по формированию табличного документа ...
// // УправлениеПечатью.ЗадатьОбластьПечатиДокумента(ТабличныйДокумент, НачалоОбласти, ОбъектыПечати, Ссылка);
// // КонецЦикла;
// // ПечатнаяФорма.ТабличныйДокумент = ТабличныйДокумент;
// // КонецЕсли;
// //
// Процедура Печать(МассивОбъектов, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) Экспорт
// // Реализация логики команды.
// КонецПроцедуры
//
// Для обработок создания связанных объектов (Вид = "СозданиеСвязанныхОбъектов"):
// // Обработчик серверных команд.
// //
// // Параметры:
// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке().
// // ОбъектыНазначения - Массив - ссылки объектов, для которых вызвана команда.
// // СозданныеОбъекты - Массив - ссылки новых объектов, созданных в результате выполнения команды.
// // ПараметрыВыполнения - Структура - контекст выполнения команды.
// // * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка обработки.
// // Может использоваться для чтения параметров обработки.
// // Пример см. в комментарии к функции ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы().
// // * РезультатВыполнения - Структура - результат выполнения команды.
// // Может использоваться для передачи результата с сервера или из фонового задания в исходную точку.
// // В частности, возвращается функциями ДополнительныеОтчетыИОбработки.ВыполнитьКоманду()
// // и ДополнительныеОтчетыИОбработки.ВыполнитьКомандуИзФормыВнешнегоОбъекта(),
// // а также может быть получено из временного хранилища
// // в обработчике ожидания процедуры ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне().
// //
// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ОбъектыНазначения, СозданныеОбъекты, ПараметрыВыполнения) Экспорт
// // Реализация логики команды.
// КонецПроцедуры
//
// Для обработок заполнения (Вид = "ЗаполнениеОбъекта"):
// // Обработчик серверных команд.
// //
// // Параметры:
// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке().
// // ОбъектыНазначения - Массив - ссылки объектов, для которых вызвана команда.
// // - Неопределено - для команд "ЗаполнениеФормы".
// // ПараметрыВыполнения - Структура - контекст выполнения команды.
// // * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка обработки.
// // Может использоваться для чтения параметров обработки.
// // Пример см. в комментарии к функции ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы().
// // * РезультатВыполнения - Структура - результат выполнения команды.
// // Может использоваться для передачи результата с сервера или из фонового задания в исходную точку.
// // В частности, возвращается функциями ДополнительныеОтчетыИОбработки.ВыполнитьКоманду()
// // и ДополнительныеОтчетыИОбработки.ВыполнитьКомандуИзФормыВнешнегоОбъекта(),
// // а также может быть получено из временного хранилища
// // в обработчике ожидания процедуры ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне().
// //
// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ОбъектыНазначения, ПараметрыВыполнения) Экспорт
// // Реализация логики команды.
// КонецПроцедуры
//
// Возвращаемое значение:
// Строка - имя типа команд с вызовом серверного метода.
//
Функция ТипКомандыВызовСерверногоМетода() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыВызовСерверногоМетода()
```
</details>
## ТипКомандыВызовКлиентскогоМетода
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает имя типа команд с вызовом клиентского метода. Для выполнения команд такого типа
// в основной форме внешнего объекта следует определить клиентскую экспортную процедуру по следующему шаблону.
//
// Для глобальных отчетов и обработок (Вид = "ДополнительнаяОбработка" или Вид = "ДополнительныйОтчет"):
// &НаКлиенте
// Процедура ВыполнитьКоманду(ИдентификаторКоманды) Экспорт
// // Реализация логики команды.
// КонецПроцедуры
//
// Для печатных форм (Вид = "ПечатнаяФорма"):
// &НаКлиенте
// Процедура Печать(ИдентификаторКоманды, ОбъектыНазначенияМассив) Экспорт
// // Реализация логики команды.
// КонецПроцедуры
//
// Для обработок создания связанных объектов (Вид = "СозданиеСвязанныхОбъектов"):
// &НаКлиенте
// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ОбъектыНазначенияМассив, СозданныеОбъекты) Экспорт
// // Реализация логики команды.
// КонецПроцедуры
//
// Для обработок заполнения и контекстных отчетов (Вид = "ЗаполнениеОбъекта" или Вид = "Отчет"):
// &НаКлиенте
// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ОбъектыНазначенияМассив) Экспорт
// // Реализация логики команды.
// КонецПроцедуры
//
// Дополнительно (для всех видов) в параметре формы "ДополнительнаяОбработкаСсылка" передается ссылка этого объекта
// (элемент справочника ДополнительныеОтчетыИОбработки, соответствующий этому объекту),
// которая может использоваться для фонового выполнения длительных операций.
// Подробнее см. в документации к подсистеме, раздел "Фоновое выполнение длительных операций".
//
// Возвращаемое значение:
// Строка - имя типа команд с вызовом клиентского метода.
//
Функция ТипКомандыВызовКлиентскогоМетода() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыВызовКлиентскогоМетода()
```
</details>
## ТипКомандыОткрытиеФормы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает имя типа команд по открытию формы. При выполнении этих команд
// открывается основная форма внешнего объекта с указанными ниже параметрами.
//
// Общие параметры:
// ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке().
// ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка этого объекта.
// Может использоваться для чтения и сохранения параметров обработки.
// Также может использоваться для фонового выполнения длительных операций.
// Подробнее см. в документации к подсистеме, раздел "Фоновое выполнение длительных операций".
// ИмяФормы - Строка - имя формы-владельца, из которой вызвана эта команда.
//
// Вспомогательные параметры для обработок создания связанных объектов (Вид = "СозданиеСвязанныхОбъектов"),
// обработок заполнения (Вид = "ЗаполнениеОбъекта") и контекстных отчетов (Вид = "Отчет"):
// ОбъектыНазначения - Массив - Ссылки объектов, для которых вызвана команда.
//
// Пример чтения общих параметров:
// ОбъектСсылка = ОбщегоНазначенияКлиентСервер.СвойствоСтруктуры(Параметры, "ДополнительнаяОбработкаСсылка");
// ИдентификаторКоманды = ОбщегоНазначенияКлиентСервер.СвойствоСтруктуры(Параметры, "ИдентификаторКоманды");
//
// Пример чтения значений дополнительных настроек:
// Если ЗначениеЗаполнено(ОбъектСсылка) Тогда
// ХранилищеНастроек = ОбщегоНазначения.ЗначениеРеквизитаОбъекта(ОбъектСсылка, "ХранилищеНастроек");
// Настройки = ХранилищеНастроек.Получить();
// Если ТипЗнч(Настройки) = Тип("Структура") Тогда
// ЗаполнитьЗначенияСвойств(ЭтотОбъект, "<ИменаНастроек>");
// КонецЕсли;
// КонецЕсли;
//
// Пример сохранения значений дополнительных настроек:
// Настройки = Новый Структура("<ИменаНастроек>", <ЗначенияНастроек>);
// ДополнительнаяОбработкаОбъект = ОбъектСсылка.ПолучитьОбъект();
// ДополнительнаяОбработкаОбъект.ХранилищеНастроек = Новый ХранилищеЗначения(Настройки);
// ДополнительнаяОбработкаОбъект.Записать();
//
// Возвращаемое значение:
// Строка - имя типа команд по открытию формы.
//
Функция ТипКомандыОткрытиеФормы() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы()
```
</details>
## ТипКомандыЗаполнениеФормы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает имя типа команд по заполнению формы без записи объекта. Данные команды доступны
// только в обработках заполнения (Вид = "ЗаполнениеОбъекта").
// Для выполнения команд такого типа в модуле объекта следует определить экспортную процедуру по шаблону:
// // Обработчик серверных команд.
// //
// // Параметры:
// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке().
// // ОбъектыНазначения - Массив - ссылки объектов, для которых вызвана команда.
// // - Неопределено - не передается для команд типа "ЗаполнениеФормы".
// // ПараметрыВыполнения - Структура - контекст выполнения команды.
// // * ЭтаФорма - ФормаКлиентскогоПриложения - заполняемая форма. Передается для команд типа "ЗаполнениеФормы".
// // * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка обработки.
// // Может использоваться для чтения параметров обработки.
// // Пример см. в комментарии к функции ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы().
// //
// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ОбъектыНазначения, ПараметрыВыполнения) Экспорт
// // Реализация логики команды.
// КонецПроцедуры
//
// Возвращаемое значение:
// Строка - имя типа команд по заполнению формы.
//
Функция ТипКомандыЗаполнениеФормы() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыЗаполнениеФормы()
```
</details>
## ТипКомандыЗагрузкаДанныхИзФайла
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает имя типа команд по загрузке данных из файла. Данные команды доступны
// только в глобальных обработках (Вид = "ДополнительнаяОбработка")
// при наличии в конфигурации подсистемы "ЗагрузкаДанныхИзФайла".
// Для выполнения команд такого типа в модуле объекта следует определить экспортные процедуры по шаблону:
// // Определяет параметры загрузки данных из файла.
// //
// // Параметры:
// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке().
// // ПараметрыЗагрузки - Структура - настройки загрузки данных:
// // * ИмяМакетаСШаблоном - Строка - имя макета с шаблоном загружаемых данных.
// // По умолчанию используется макет "ЗагрузкаИзФайла".
// // * ОбязательныеКолонкиМакета - Массив - список имен колонок обязательных для заполнения.
// //
// Процедура ОпределитьПараметрыЗагрузкиДанныхИзФайла(ИдентификаторКоманды, ПараметрыЗагрузки) Экспорт
// // Переопределение настроек загрузки данных из файла.
// КонецПроцедуры
//
// // Сопоставляет загружаемые данные с данными в информационной базе.
// //
// // Параметры:
// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке().
// // ЗагружаемыеДанные - ТаблицаЗначений - описание загружаемых данных:
// // * СопоставленныйОбъект - СправочникСсылка.Ссылка - ссылка на сопоставленный объект.
// // Заполняется внутри этой процедуры.
// // * <другие колонки> - Строка - данные, загруженные из файла.
// // Состав колонок соответствует макету "ЗагрузкаИзФайла".
// //
// Процедура СопоставитьЗагружаемыеДанныеИзФайла(ИдентификаторКоманды, ЗагружаемыеДанные) Экспорт
// // Реализация логики поиска данных в программе.
// КонецПроцедуры
//
// // Загружает сопоставленные данные в базу.
// //
// // Параметры:
// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке().
// // ЗагружаемыеДанные - ТаблицаЗначений - описание загружаемых данных:
// // * СопоставленныйОбъект - СправочникСсылка - ссылка на сопоставленный объект.
// // * РезультатСопоставленияСтроки - Строка - статус загрузки. Возможны варианты: Создан, Обновлен, Пропущен.
// // * ОписаниеОшибки - Строка - расшифровка ошибки загрузки данных.
// // * Идентификатор - Число - уникальный номер строки.
// // * <другие колонки> - Строка - данные, загруженные из файла.
// // Состав колонок соответствует макету "ЗагрузкаИзФайла".
// // ПараметрыЗагрузки - Структура - параметры с пользовательскими установками загрузки данных.
// // * СоздаватьНовые - Булево - требуется ли создавать новые элементы справочника.
// // * ОбновлятьСуществующие - Булево - требуется ли обновлять элементы справочника.
// // Отказ - Булево - признак отмены загрузки.
// //
// Процедура ЗагрузитьИзФайла(ИдентификаторКоманды, ЗагружаемыеДанные, ПараметрыЗагрузки, Отказ) Экспорт
// // Реализация логики загрузки данных в программу.
// КонецПроцедуры
//
// Возвращаемое значение:
// Строка - имя типа команд по загрузке данных из файла.
//
Функция ТипКомандыЗагрузкаДанныхИзФайла() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыЗагрузкаДанныхИзФайла()
```
</details>
## ТипФормыСписка
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Идентификатор формы списка.
//
// Возвращаемое значение:
// Строка - идентификатор форм списков.
//
Функция ТипФормыСписка() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипФормыСписка()
```
</details>
## ТипФормыОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Идентификатор формы объекта.
//
// Возвращаемое значение:
// Строка - идентификатор форм объектов.
//
Функция ТипФормыОбъекта() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипФормыОбъекта()
```
</details>
## ФильтрДиалоговВыбораИСохранения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Фильтр для диалогов выбора или сохранения дополнительных отчетов и обработок.
//
// Возвращаемое значение:
// Строка - фильтр для диалогов выбора или сохранения дополнительных отчетов и обработок.
//
Функция ФильтрДиалоговВыбораИСохранения() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ФильтрДиалоговВыбораИСохранения()
```
</details>
## ИмяНачальнойСтраницы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Имя раздела, соответствующего начальной странице.
//
// Возвращаемое значение:
// Строка - имя раздела, соответствующего начальной странице.
//
Функция ИмяНачальнойСтраницы() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ИмяНачальнойСтраницы()
```
</details>
## ИдентификаторРабочегоСтола
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ДополнительныеОтчетыИОбработкиКлиентСервер.ИмяНачальнойСтраницы.
// Имя раздела, соответствующего начальной странице.
//
// Возвращаемое значение:
// Строка
//
Функция ИдентификаторРабочегоСтола() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ИдентификаторРабочегоСтола()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

63
src/content/docs/bsp/ДополнительныеОтчетыИОбработкиПереопределяемый.md Normal file
View File

@ -0,0 +1,63 @@
---
title: Дополнительные отчеты и обработки переопределяемый
slug: bsp/дополнительные-отчеты-и-обработки-переопределяемый
---
## ОпределитьРазделыСДополнительнымиОбработками
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет разделы, в которых доступна команда вызова дополнительных обработок.
// В разделы необходимо добавить метаданные тех разделов,
// в которых размещены команды вызова.
// Для начальной страницы указать ДополнительныеОтчетыИОбработкиКлиентСервер.ИмяНачальнойСтраницы.
//
// Параметры:
// Разделы - Массив из ОбъектМетаданных - метаданные раздела (подсистемы).
// - Массив из Строка - для начальной страницы.
//
Процедура ОпределитьРазделыСДополнительнымиОбработками(Разделы) Экспорт
```
Пример вызова
```bsl
ДополнительныеОтчетыИОбработкиПереопределяемый.ОпределитьРазделыСДополнительнымиОбработками(Разделы)
```
</details>
## ОпределитьРазделыСДополнительнымиОтчетами
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет разделы, в которых доступна команда вызова дополнительных отчетов.
// В Разделы необходимо добавить метаданные тех разделов,
// в которых размещены команды вызова.
// Для начальной страницы указать ДополнительныеОтчетыИОбработкиКлиентСервер.ИмяНачальнойСтраницы.
//
// Параметры:
// Разделы - Массив из ОбъектМетаданных - метаданные раздела (подсистемы).
// - Массив из Строка - для начальной страницы.
//
Процедура ОпределитьРазделыСДополнительнымиОтчетами(Разделы) Экспорт
```
Пример вызова
```bsl
ДополнительныеОтчетыИОбработкиПереопределяемый.ОпределитьРазделыСДополнительнымиОтчетами(Разделы)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

151
src/content/docs/bsp/ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.md Normal file
View File

@ -0,0 +1,151 @@
---
title: Дополнительные отчеты и обработки регламентные задания в модели сервиса
slug: bsp/дополнительные-отчеты-и-обработки-регламентные-задания-в-модели-сервиса
---
## СоздатьНовоеЗадание
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать РегламентныеЗаданияСервер.ДобавитьЗадание().
//
// Возвращаемое значение:
// Неопределено - следует использовать РегламентныеЗаданияСервер.ДобавитьЗадание().
//
Функция СоздатьНовоеЗадание() Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.СоздатьНовоеЗадание()
```
</details>
## ПолучитьИдентификаторЗадания
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать РегламентныеЗаданияСервер.УникальныйИдентификатор().
//
// Параметры:
// Задание - РегламентноеЗадание - регламентное задание.
//
// Возвращаемое значение:
// Неопределено - следует использовать РегламентныеЗаданияСервер.УникальныйИдентификатор().
//
Функция ПолучитьИдентификаторЗадания(Знач Задание) Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.ПолучитьИдентификаторЗадания(Задание)
```
</details>
## УстановитьПараметрыЗадания
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать РегламентныеЗаданияСервер.ИзменитьЗадание().
//
// Параметры:
// Задание - РегламентноеЗадание - регламентное задание.
// Использование - Булево - флаг использования регламентного задания.
// Параметры - Массив - параметры регламентного задания.
// Расписание - РасписаниеРегламентногоЗадания - расписание регламентного задания.
//
Процедура УстановитьПараметрыЗадания(Задание, Использование, Параметры, Расписание) Экспорт
```
Пример вызова
```bsl
ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.УстановитьПараметрыЗадания(Задание, Использование, Параметры, Расписание)
```
</details>
## ПолучитьПараметрыЗадания
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать РегламентныеЗаданияСервер.НайтиЗадания().
//
// Параметры:
// Задание - РегламентноеЗадание - регламентное задание.
//
// Возвращаемое значение:
// Неопределено - следует использовать РегламентныеЗаданияСервер.НайтиЗадания().
//
Функция ПолучитьПараметрыЗадания(Знач Задание) Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.ПолучитьПараметрыЗадания(Задание)
```
</details>
## НайтиЗадание
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать РегламентныеЗаданияСервер.Задание().
//
// Параметры:
// Идентификатор - УникальныйИдентификатор - идентификатор регламентного задания.
//
// Возвращаемое значение:
// Неопределено - следует использовать РегламентныеЗаданияСервер.НайтиЗадания().
//
Функция НайтиЗадание(Знач Идентификатор) Экспорт
```
Пример вызова
```bsl
Результат = ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.НайтиЗадание(Идентификатор)
```
</details>
## УдалитьЗадание
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать РегламентныеЗаданияСервер.УдалитьЗадание().
//
// Параметры:
// Задание - РегламентноеЗадание - регламентное задание.
//
Процедура УдалитьЗадание(Знач Задание) Экспорт
```
Пример вызова
```bsl
ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.УдалитьЗадание(Задание)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

42
src/content/docs/bsp/ЖурналРегистрации.md Normal file
View File

@ -0,0 +1,42 @@
---
title: Журнал регистрации
slug: bsp/журнал-регистрации
---
## ЗаписатьСобытияВЖурналРегистрации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Процедура пакетной записи сообщений в журнал регистрации.
// После записи переменная СобытияДляЖурналаРегистрации очищается.
//
// Параметры:
// СобытияДляЖурналаРегистрации - СписокЗначений:
// * Значение - Структура:
// ** ИмяСобытия - Строка - имя записываемого события.
// ** ПредставлениеУровня - Строка - представление значений коллекции УровеньЖурналаРегистрации.
// Доступные значения: "Информация", "Ошибка", "Предупреждение", "Примечание".
// ** Комментарий - Строка - комментарий события.
// ** ДатаСобытия - Дата - дата события, подставляется в комментарий при записи.
// * Представление - Строка - не используется.
//
Процедура ЗаписатьСобытияВЖурналРегистрации(СобытияДляЖурналаРегистрации) Экспорт
```
Пример вызова
```bsl
ЖурналРегистрации.ЗаписатьСобытияВЖурналРегистрации(СобытияДляЖурналаРегистрации)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

105
src/content/docs/bsp/ЖурналРегистрацииКлиент.md Normal file
View File

@ -0,0 +1,105 @@
---
title: Журнал регистрации клиент
slug: bsp/журнал-регистрации-клиент
---
## ДобавитьСообщениеДляЖурналаРегистрации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Записывает сообщение в журнал регистрации.
// Если параметр ЗаписатьСобытия = Истина, то запись выполняется сразу (обращение к серверу).
// Если ЗаписатьСобытия = Ложь (по умолчанию), то сообщение помещается в очередь, которая
// будет записана позднее (обычно в течение 60 сек), либо при следующем вызове этой процедуры
// с признаком ЗаписатьСобытия = Истина, либо при вызове процедуры ЗаписатьСобытияВЖурналРегистрации.
//
// Параметры:
// ИмяСобытия - Строка - имя события для журнала регистрации;
// ПредставлениеУровня - Строка - описание уровня события, по нему будет определен уровень события при записи на
// сервере;
// Например: "Ошибка", "Предупреждение".
// Соответствуют именам элементов перечисления УровеньЖурналаРегистрации.
// Комментарий - Строка - комментарий для события журнала;
// ДатаСобытия - Дата - точная дата возникновения события, описанного в сообщении. Будет добавлена в начало
// комментария;
// ЗаписатьСобытия - Булево - выполнить запись всех ранее накопленных сообщений в журнал регистрации (обращение к
// серверу).
//
// Пример:
// ЖурналРегистрацииКлиент.ДобавитьСообщениеДляЖурналаРегистрации(СобытиеЖурналаРегистрации(), "Предупреждение",
// НСтр("ru = 'Невозможно подключиться к сети Интернет для проверки обновлений.'"));
//
Процедура ДобавитьСообщениеДляЖурналаРегистрации(Знач ИмяСобытия, Знач ПредставлениеУровня = "Информация", Экспорт
```
Пример вызова
```bsl
ЖурналРегистрацииКлиент.ДобавитьСообщениеДляЖурналаРегистрации(ИмяСобытия, ПредставлениеУровня, );
```
</details>
## ОткрытьЖурналРегистрации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму журнала регистрации с установленным отбором.
//
// Параметры:
// Отбор - Структура:
// * Пользователь - Строка
// - СписокЗначений - имя или список пользователей
// информационной базы.
// * СобытиеЖурналаРегистрации - Строка
// - Массив - идентификатор события.
// * ДатаНачала - Дата - начало интервала отображаемых событий.
// * ДатаОкончания - Дата - конец интервала отображаемых событий.
// * Данные - Произвольный - данные любого типа.
// * Сеанс - СписокЗначений - список выбираемых сеансов.
// * Уровень - Строка
// - Массив - представление уровня важности
// события журнала регистрации.
// * ИмяПриложения - Массив - массив идентификаторов приложения.
// Владелец - ФормаКлиентскогоПриложения - форма, из которой открывается журнал регистрации.
//
Процедура ОткрытьЖурналРегистрации(Знач Отбор = Неопределено, Владелец = Неопределено) Экспорт
```
Пример вызова
```bsl
ЖурналРегистрацииКлиент.ОткрытьЖурналРегистрации(Отбор, Владелец);
```
</details>
## ЗаписатьСобытияВЖурналРегистрации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Записывает накопленные сообщения из очереди в журнал регистрации (обращение к серверу).
// Сообщения добавляются в очередь с помощью процедуры ДобавитьСообщениеДляЖурналаРегистрации.
//
Процедура ЗаписатьСобытияВЖурналРегистрации() Экспорт
```
Пример вызова
```bsl
ЖурналРегистрацииКлиент.ЗаписатьСобытияВЖурналРегистрации()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

171
src/content/docs/bsp/ЗагрузкаДанныхИзФайла.md Normal file
View File

@ -0,0 +1,171 @@
---
title: Загрузка данных из файла
slug: bsp/загрузка-данных-из-файла
---
## СформироватьОписаниеКолонок
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает описание колонок табличной части или таблицы значений.
//
// Параметры:
// Таблица - ТаблицаЗначений - ОписаниеТабличнойЧасти с колонками.
// - ДанныеФормыКоллекция - таблица размещенная на форме
// - Строка - для получения списка колонок табличной части
// необходимо указать его полное имя строкой, как в метаданных, например "Документы.СчетНаОплату.ТабличныеЧасти.Товары".
// Колонки - Строка - список извлекаемых колонок, разделенный запятыми. Например: "Номер, Товар, Количество".
//
// Возвращаемое значение:
// Массив из см. ЗагрузкаДанныхИзФайлаКлиентСервер.ОписаниеКолонкиМакета.
//
Функция СформироватьОписаниеКолонок(Таблица, Колонки = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ЗагрузкаДанныхИзФайла.СформироватьОписаниеКолонок(Таблица, Колонки);
```
</details>
## НастройкиЗагрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Настройки загрузки новых и существующих элементов.
//
// Возвращаемое значение:
// Структура:
// * СоздаватьНовые - Булево
// * ОбновлятьСуществующие - Булево
//
Функция НастройкиЗагрузкиДанных() Экспорт
```
Пример вызова
```bsl
Результат = ЗагрузкаДанныхИзФайла.НастройкиЗагрузкиДанных()
```
</details>
## ОписаниеЗагружаемыхДанныхДляСправочников
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Добавляет в таблицу загружаемых данных служебные колонки.
// Список колонок таблицы динамический и формируется на основе макета загружаемых данных.
// В возвращаемом значении описаны только служебные колонки, которые присутствуют всегда.
//
// Параметры:
// ЗагружаемыеДанные - ТаблицаЗначений
// ОписаниеТипаОбъектаСопоставления - ОписаниеТипов - описание типа объекта сопоставления.
// ЗаголовокКолонкиОбъектаСопоставления - Строка - заголовок колонки объекта сопоставления.
//
// Возвращаемое значение:
// ТаблицаЗначений:
// * СопоставленныйОбъект - СправочникСсылка - ссылка на сопоставленный объект.
// * РезультатСопоставленияСтроки - Строка - статус загрузки, возможны варианты: Создан, Обновлен, Пропущен.
// * ОписаниеОшибки - Строка - расшифровка ошибки загрузки данных.
// * Идентификатор - Число - уникальный номер строки
// * СписокНеоднозначностей - СписокЗначений -список неоднозначностей возникших при загрузке данных.
//
Функция ОписаниеЗагружаемыхДанныхДляСправочников(ЗагружаемыеДанные, ОписаниеТипаОбъектаСопоставления, ЗаголовокКолонкиОбъектаСопоставления) Экспорт
```
Пример вызова
```bsl
Результат = ЗагрузкаДанныхИзФайла.ОписаниеЗагружаемыхДанныхДляСправочников(ЗагружаемыеДанные, ОписаниеТипаОбъектаСопоставления, ЗаголовокКолонкиОбъектаСопоставления)
```
</details>
## НовыйСписокНеоднозначностей
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Создать таблицу со списком неоднозначностей для которых в ИБ имеется несколько подходящих вариантов данных.
//
// Возвращаемое значение:
// ТаблицаЗначений:
// * Колонка - Строка - имя колонки, в которой была обнаружена неоднозначность;
// * Идентификатор - Число - идентификатор строки, в которой была обнаружена неоднозначность.
//
Функция НовыйСписокНеоднозначностей() Экспорт
```
Пример вызова
```bsl
Результат = ЗагрузкаДанныхИзФайла.НовыйСписокНеоднозначностей()
```
</details>
## ТаблицаСопоставления
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает таблицу, извлеченную из временного хранилища для сопоставления загружаемых данных с данными в приложении.
// Список колонок извлекаемой таблицы динамический и формируется на основе макета загружаемых данных.
// В возвращаемом значении описана только служебная колонка, которая присутствует всегда.
//
// Параметры:
// АдресРезультата - Строка - адрес во временном хранилища
//
// Возвращаемое значение:
// ТаблицаЗначений:
// * СопоставленныйОбъект - СправочникСсылка - ссылка на сопоставленный объект. Заполняется внутри процедуры.
//
Функция ТаблицаСопоставления(АдресРезультата) Экспорт
```
Пример вызова
```bsl
Результат = ЗагрузкаДанныхИзФайла.ТаблицаСопоставления(АдресРезультата)
```
</details>
## ЗаписатьСвойстваОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Сохраняет значения дополнительных реквизитов и свойств из строки таблицы загружаемых данных в объект-владелец.
// Внутри функции код сам находит колонки содержащие значения дополнительных реквизитов или свойств и записывает их.
// Вызывается из процедуры ЗагрузитьИзФайла при прикладной загрузке данных в модуле менеджере объекта.
//
// Параметры:
// СсылкаНаОбъект - ЛюбаяСсылка - ссылка на объект-владельца свойств куда загружаются данные.
// СтрокаТаблицы - СтрокаТаблицыЗначений из см. ЗагрузкаДанныхИзФайла.ОписаниеЗагружаемыхДанныхДляСправочников
//
Процедура ЗаписатьСвойстваОбъекта(СсылкаНаОбъект, СтрокаТаблицы) Экспорт
```
Пример вызова
```bsl
ЗагрузкаДанныхИзФайла.ЗаписатьСвойстваОбъекта(СсылкаНаОбъект, СтрокаТаблицы)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

65
src/content/docs/bsp/ЗагрузкаДанныхИзФайлаКлиент.md Normal file
View File

@ -0,0 +1,65 @@
---
title: Загрузка данных из файла клиент
slug: bsp/загрузка-данных-из-файла-клиент
---
## ПараметрыЗагрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Создает новую структуру параметров для загрузки данных из файла в табличную часть.
//
// Возвращаемое значение:
// Структура - параметры для открытия формы загрузки данных в табличную часть:
// * ПолноеИмяТабличнойЧасти - Строка - полный путь к табличной части документа,
// в виде "ИмяДокумента.ИмяТабличнойЧасти".
// * Заголовок - Строка - заголовок формы загрузки данных из файла.
// * ИмяМакетаСШаблоном - Строка - имя макета с шаблоном для ввода данных.
// * ДополнительныеПараметры - Структура - любые дополнительные сведения, которые будут переданы
// в процедуру сопоставления данных.
// * КолонкиМакета - Массив из см. ЗагрузкаДанныхИзФайлаКлиентСервер.ОписаниеКолонкиМакета
// - Неопределено - если описание колонок для макета загрузки данных из файла отсутствует.
//
Функция ПараметрыЗагрузкиДанных() Экспорт
```
Пример вызова
```bsl
Результат = ЗагрузкаДанныхИзФайлаКлиент.ПараметрыЗагрузкиДанных()
```
</details>
## ПоказатьФормуЗагрузки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает форму загрузки данных для заполнения табличной части.
//
// Параметры:
// ПараметрыЗагрузки - см. ЗагрузкаДанныхИзФайлаКлиент.ПараметрыЗагрузкиДанных.
// ОповещениеОЗагрузке - ОписаниеОповещения - оповещение, которое будет вызвано для добавления загруженных данных в
// табличную часть.
//
Процедура ПоказатьФормуЗагрузки(ПараметрыЗагрузки, ОповещениеОЗагрузке) Экспорт
```
Пример вызова
```bsl
ЗагрузкаДанныхИзФайлаКлиент.ПоказатьФормуЗагрузки(ПараметрыЗагрузки, ОповещениеОЗагрузке)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

98
src/content/docs/bsp/ЗагрузкаДанныхИзФайлаКлиентСервер.md Normal file
View File

@ -0,0 +1,98 @@
---
title: Загрузка данных из файла клиент сервер
slug: bsp/загрузка-данных-из-файла-клиент-сервер
---
## ОписаниеКолонкиМакета
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Создает структуру описания колонок для макета загрузки данных из файла.
//
// Параметры:
// Имя -Строка - имя колонки.
// Тип - ОписаниеТипов - тип колонки.
// Заголовок - Строка - заголовок колонки выводимый в бланке для загрузки.
// Ширина - Число - ширина колонки.
// Подсказка - Строка - подсказка, выводимая в заголовке колонки.
//
// Возвращаемое значение:
// Структура - структура с описание колонки:
// * Имя - Строка - имя колонки.
// * Заголовок - Строка - заголовок колонки выводимый в бланке для загрузки.
// * Тип - ОписаниеТипов - тип колонки.
// * Ширина - Число - ширина колонки.
// * Позиция - Число - позиция колонки в таблице
// * Подсказка - Строка - подсказка выводимая в заголовке колонки.
// * ОбязательнаДляЗаполнения - Булево - истина, если колонка обязательно должна содержать значения.
// * Группа - Строка - имя группы колонок.
// * Родитель - Строка - используется для связи динамической колонки с реквизитом табличной части объекта.
//
Функция ОписаниеКолонкиМакета(Имя, Тип, Заголовок = Неопределено, Ширина = 0, Подсказка = "") Экспорт
```
Пример вызова
```bsl
Результат = ЗагрузкаДанныхИзФайлаКлиентСервер.ОписаниеКолонкиМакета(Имя, Тип, Заголовок, Ширина, Подсказка);
```
</details>
## КолонкаМакета
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает колонку макета по имени.
//
// Параметры:
// Имя - Строка - имя колонки.
// СписокКолонок - Массив из см. ЗагрузкаДанныхИзФайлаКлиентСервер.ОписаниеКолонкиМакета
//
// Возвращаемое значение:
// - см. ОписаниеКолонкиМакета
// - Неопределено - если колонка не существует.
//
Функция КолонкаМакета(Имя, СписокКолонок) Экспорт
```
Пример вызова
```bsl
Результат = ЗагрузкаДанныхИзФайлаКлиентСервер.КолонкаМакета(Имя, СписокКолонок)
```
</details>
## УдалитьКолонкуМакета
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Удаляет колонку макета из массива.
//
// Параметры:
// Имя - Строка - имя колонки.
// СписокКолонок - Массив из см. ЗагрузкаДанныхИзФайлаКлиентСервер.ОписаниеКолонкиМакета
//
Процедура УдалитьКолонкуМакета(Имя, СписокКолонок) Экспорт
```
Пример вызова
```bsl
ЗагрузкаДанныхИзФайлаКлиентСервер.УдалитьКолонкуМакета(Имя, СписокКолонок)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

53
src/content/docs/bsp/ЗагрузкаДанныхИзФайлаПереопределяемый.md Normal file
View File

@ -0,0 +1,53 @@
---
title: Загрузка данных из файла переопределяемый
slug: bsp/загрузка-данных-из-файла-переопределяемый
---
## ПриОпределенииСправочниковДляЗагрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет список справочников, доступных для загрузки с помощью подсистемы "Загрузка данных из файла".
// Если справочник нужно исключить из списка загружаемых, то его следует удалить из таблицы.
//
// Параметры:
// ЗагружаемыеСправочники - ТаблицаЗначений - список справочников, в которые возможна загрузка данных:
// * ПолноеИмя - Строка - полное имя справочника (как в метаданных).
// * Представление - Строка - представление справочника в списке выбора.
// * ПрикладнаяЗагрузка - Булево - если Истина, значит справочник использует собственный алгоритм загрузки и
// в модуле менеджера справочника определены функции.
//
// Пример:
//
// // Собственный алгоритм загрузки в справочник Номенклатуры.
// Сведения = ЗагружаемыеСправочники.Добавить();
// Сведения.ПолноеИмя = Метаданные.Справочники.Номенклатура.ПолноеИмя();
// Сведения.Представление = Метаданные.Справочники.Номенклатура.Представление();
// Сведения.ПрикладнаяЗагрузка = Истина;
//
// //Загрузка в классификатор валюты запрещена.
// СтрокаТаблицы = ЗагружаемыеСправочники.Найти(Метаданные.Справочники.Валюты.ПолноеИмя(), "ПолноеИмя");
// Если СтрокаТаблицы <> Неопределено Тогда
// ЗагружаемыеСправочники.Удалить(СтрокаТаблицы);
// КонецЕсли;
//
Процедура ПриОпределенииСправочниковДляЗагрузкиДанных(ЗагружаемыеСправочники) Экспорт
```
Пример вызова
```bsl
ЗагрузкаДанныхИзФайлаПереопределяемый.ПриОпределенииСправочниковДляЗагрузкиДанных(ЗагружаемыеСправочники)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

65
src/content/docs/bsp/ЗаметкиПользователя.md Normal file
View File

@ -0,0 +1,65 @@
---
title: Заметки пользователя
slug: bsp/заметки-пользователя
---
## УстановитьСтатусИзмененияПометкиУдаленияДокумента
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Добавляет признак изменения пометки удаления документа.
// Состав параметров процедуры соответствует подписке на событие ПередЗаписью объекта Документ.
// Описание см. в синтакс-помощнике.
//
// Параметры:
// Источник - ДокументОбъект - источник события подписки.
// Отказ - Булево - признак отказа от записи. Если установить Истина, то запись выполнена не будет
// и будет вызвано исключение.
// РежимЗаписи - РежимЗаписиДокумента - текущий режим записи документа-источника.
// РежимПроведения - РежимПроведенияДокумента - текущий режим проведения документа-источника.
//
Процедура УстановитьСтатусИзмененияПометкиУдаленияДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт
```
Пример вызова
```bsl
ЗаметкиПользователя.УстановитьСтатусИзмененияПометкиУдаленияДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения)
```
</details>
## УстановитьСтатусИзмененияПометкиУдаленияОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Добавляет признак изменения пометки удаления объекта.
// Состав параметров процедуры соответствует подписке на событие ПередЗаписью любых объектов, кроме документов.
// Описание см. в синтакс-помощнике.
//
// Параметры:
// Источник - СправочникОбъект - источник события подписки.
// Отказ - Булево - признак отказа от записи. Если установить Истина, то запись выполнена не будет
// и будет вызвано исключение.
//
Процедура УстановитьСтатусИзмененияПометкиУдаленияОбъекта(Источник, Отказ) Экспорт
```
Пример вызова
```bsl
ЗаметкиПользователя.УстановитьСтатусИзмененияПометкиУдаленияОбъекта(Источник, Отказ)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

114
src/content/docs/bsp/ЗаполнениеОбъектовПереопределяемый.md Normal file
View File

@ -0,0 +1,114 @@
---
title: Заполнение объектов переопределяемый
slug: bsp/заполнение-объектов-переопределяемый
---
## ПриОпределенииОбъектовСКомандамиЗаполнения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет список объектов конфигурации, в модулях менеджеров которых предусмотрена процедура
// ДобавитьКомандыЗаполнения, формирующая команды заполнения объектов.
// Синтаксис процедуры ДобавитьКомандыЗаполнения см. в документации.
//
// Параметры:
// Объекты - Массив из ОбъектМетаданных - объекты метаданных с командами заполнения.
//
// Пример:
// Объекты.Добавить(Метаданные.Справочники.Организации);
//
Процедура ПриОпределенииОбъектовСКомандамиЗаполнения(Объекты) Экспорт
```
Пример вызова
```bsl
ЗаполнениеОбъектовПереопределяемый.ПриОпределенииОбъектовСКомандамиЗаполнения(Объекты)
```
</details>
## ПередДобавлениемКомандЗаполнения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет общие команды заполнения.
//
// Параметры:
// КомандыЗаполнения - ТаблицаЗначений - сформированные команды для вывода в подменю:
//
// Общие настройки:
// * Идентификатор - Строка - идентификатор команды.
//
// Настройки внешнего вида:
// * Представление - Строка - представление команды в форме.
// * Важность - Строка - группа в подменю, в которой следует вывести эту команду.
// Варианты: "Важное", "Обычное" и "СмТакже".
// * Порядок - Число - порядок размещения команды в подменю. Используется для настройки под конкретное
// рабочее место.
// * Картинка - Картинка - картинка команды.
//
// Настройки видимости и доступности:
// * ТипПараметра - ОписаниеТипов - типы объектов, для которых предназначена эта команда.
// * ВидимостьВФормах - Строка - имена форм через запятую, в которых должна отображаться команда.
// Используется, когда состав команд отличается для различных форм.
// * ФункциональныеОпции - Строка - имена функциональных опций через запятую, определяющих видимость команды.
// * УсловияВидимости - Массив - определяет видимость команды в зависимости от контекста.
// Для регистрации условий следует использовать процедуру
// ПодключаемыеКоманды.ДобавитьУсловиеВидимостиКоманды.
// Условия объединяются по "И".
//
// Настройки процесса выполнения:
// * МножественныйВыбор - Булево
// - Неопределено - если Истина (по умолчанию), то команда поддерживает множественный выбор.
// В этом случае в параметре выполнения будет передан список ссылок.
// * РежимЗаписи - Строка - действия, связанные с записью объекта, которые выполняются перед обработчиком команды:
// "Записывать" - записывать новые и модифицированные объекты (по умолчанию).
// Перед записью и проведением у пользователя запрашивается подтверждение.
// "НеЗаписывать" - объект не записывается, а в параметрах обработчика вместо ссылок передается
// вся форма. В этом режиме рекомендуется работать напрямую с формой,
// которая передается в структуре 2-го параметра обработчика команды.
// "ЗаписыватьТолькоНовые" - записывать новые объекты.
// "Проводить" - проводить документы.
// * ТребуетсяРаботаСФайлами - Булево - если Истина, то в веб-клиенте предлагается
// установить расширение для работы с 1С:Предприятием. Значение по умолчанию - Ложь.
//
// Настройки обработчика:
// * Менеджер - Строка - объект, отвечающий за выполнение команды.
// * ИмяФормы - Строка - имя формы, которую требуется получить для выполнения команды.
// Если Обработчик не указан, то у формы вызывается метод "Открыть".
// * ПараметрыФормы - Неопределено
// - ФиксированнаяСтруктура - параметры формы, указанной в ИмяФормы.
// * Обработчик - Строка - описание процедуры, обрабатывающей основное действие команды.
// Формат "<ИмяОбщегоМодуля>.<ИмяПроцедуры>" используется, когда процедура размещена в общем модуле.
// Формат "<ИмяПроцедуры>" используется в следующих случаях:
// если ИмяФормы заполнено, то в модуле указанной формы ожидается клиентская процедура;
// если ИмяФормы не заполнено, то в модуле менеджера этого объекта ожидается серверная процедура.
// * ДополнительныеПараметры - ФиксированнаяСтруктура - параметры обработчика, указанного в Обработчик.
//
// Параметры - Структура - сведения о контексте исполнения:
// * ИмяФормы - Строка - полное имя формы.
// СтандартнаяОбработка - Булево - если установить в Ложь, то событие ДобавитьКомандыЗаполнения менеджера объекта не
// будет вызвано.
//
Процедура ПередДобавлениемКомандЗаполнения(КомандыЗаполнения, Параметры, СтандартнаяОбработка) Экспорт
```
Пример вызова
```bsl
ЗаполнениеОбъектовПереопределяемый.ПередДобавлениемКомандЗаполнения(КомандыЗаполнения, Параметры, СтандартнаяОбработка)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

112
src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектов.md Normal file
View File

@ -0,0 +1,112 @@
---
title: Запрет редактирования реквизитов объектов
slug: bsp/запрет-редактирования-реквизитов-объектов
---
## ЗаблокироватьРеквизиты
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Принимает в качестве параметра форму объекта, к которому подключена подсистема,
// и запрещает редактирование заданных реквизитов,
// а также добавляет во "Все действия" команду для разрешения их редактирования.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения
// - РасширениеУправляемойФормыДляОбъектов - форма объекта, где:
// * Объект - ДанныеФормыСтруктура
// - СправочникОбъект
// - ДокументОбъект
// * Элементы - ВсеЭлементыФормы:
// ** РазрешитьРедактированиеРеквизитовОбъекта - КнопкаФормы
// ГруппаДляКнопкиЗапрета - ГруппаФормы - переопределяет стандартное размещение
// кнопки запрета в форме объекта.
// ЗаголовокКнопкиЗапрета - Строка - заголовок кнопки. По умолчанию "Разрешить редактирование реквизитов".
// Объект - Неопределено - взять объект из реквизита формы "Объект".
// - ДанныеФормыСтруктура - по типу объекта.
// - СправочникОбъект
// - ДокументОбъект
//
Процедура ЗаблокироватьРеквизиты(Форма, ГруппаДляКнопкиЗапрета = Неопределено, ЗаголовокКнопкиЗапрета = "", Экспорт
```
Пример вызова
```bsl
ЗапретРедактированияРеквизитовОбъектов.ЗаблокироватьРеквизиты(Форма, ГруппаДляКнопкиЗапрета, ЗаголовокКнопкиЗапрета, );
```
</details>
## БлокируемыеРеквизитыОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает список реквизитов и табличных частей объекта, по которым установлен запрет редактирования.
//
// Параметры:
// ИмяОбъекта - Строка - полное имя объекта метаданных.
//
// Возвращаемое значение:
// Массив из Строка
//
Функция БлокируемыеРеквизитыОбъекта(ИмяОбъекта) Экспорт
```
Пример вызова
```bsl
Результат = ЗапретРедактированияРеквизитовОбъектов.БлокируемыеРеквизитыОбъекта(ИмяОбъекта)
```
</details>
## НовыйБлокируемыйРеквизит
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает свойства нового расширенного описания блокируемого реквизита
// для использования в функциях ПолучитьБлокируемыеРеквизитыОбъекта модулей менеджеров объектов.
//
// Возвращаемое значение:
// Структура:
// * Имя - Строка - имя реквизита, например, "Объект.Автор", "ПриниматьВыручкуОбщейСуммой".
// Можно оставлять пустым для описания группы отдельно от реквизита.
// * ЭлементыФормы - Массив из Строка - имена элементов формы, соответствующие реквизиту.
// Требуется заполнить, когда их нельзя определить по пути элемента формы к имени реквизита,
// например, "ПриниматьВыручкуОбщейСуммойПереключатель".
// * Предупреждение - Строка - текст предупреждения о последствиях разблокировки, который выводится
// в форме разблокировки над реквизитом или группой реквизитов, если указана.
// * Группа - Строка - имя группы реквизитов, которая используется в форме разблокировки.
// Не требуется заполнять, когда реквизит выводится отдельно.
// Не учитывается при вызове из группового изменения реквизитов, кроме ОбщаяНадпись.
// * ПредставлениеГруппы - Строка - представление группы реквизитов, которое выводится в форме разблокировки.
// Не требуется заполнять, когда реквизит выводится отдельно.
// Не учитывается при вызове из группового изменения реквизитов, кроме ОбщаяНадпись.
// * ПредупреждениеГруппы - Строка - текст предупреждения о последствиях разблокировки, который выводится
// в форме разблокировки только над группой реквизитов, если указана.
// * Предупреждение - Строка - текст предупреждения о последствиях разблокировки, который выводится
// в форме разблокировки над реквизитом или группой реквизитов, если указана.
//
Функция НовыйБлокируемыйРеквизит() Экспорт
```
Пример вызова
```bsl
Результат = ЗапретРедактированияРеквизитовОбъектов.НовыйБлокируемыйРеквизит()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

202
src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектовКлиент.md Normal file
View File

@ -0,0 +1,202 @@
---
title: Запрет редактирования реквизитов объектов клиент
slug: bsp/запрет-редактирования-реквизитов-объектов-клиент
---
## РазрешитьРедактированиеРеквизитовОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Разрешает редактирование заблокированных элементов формы, связанных с заданными реквизитами.
//
// Если в объекте используется прикладная форма РазблокированиеРеквизитов, она будет открыта
// с параметрами Ссылка и ЗаблокированныеРеквизиты, а в описании оповещения закрытия формы
// должно быть возвращено Истина (все реквизиты разблокированы) или Массив имен реквизитов.
// При возврате Неопределено считается, что разблокировка не выполнялась.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения
// - РасширениеУправляемойФормыДляОбъектов - форма, в которой требуется разрешить
// редактирование элементов формы, заданных реквизитов, где:
// * Объект - ДанныеФормыСтруктура:
// ** Ссылка - СправочникСсылка, ДокументСсылка
//
// ОбработкаПродолжения - ОписаниеОповещения - оповещение, которое вызывается после выполнения процедуры.
// В обработку оповещения передается параметр типа Булево:
// Истина - ссылок не обнаружено или пользователь решил разрешить редактирование,
// Ложь - видимых заблокированных реквизитов нет или
// ссылки обнаружены и пользователь отказался от продолжения.
//
// ТолькоВидимые - Булево - чтобы получить и разблокировать все реквизиты объекта, нужно указать Ложь.
//
Процедура РазрешитьРедактированиеРеквизитовОбъекта(Знач Форма, ОбработкаПродолжения = Неопределено, Экспорт
```
Пример вызова
```bsl
ЗапретРедактированияРеквизитовОбъектовКлиент.РазрешитьРедактированиеРеквизитовОбъекта(Форма, ОбработкаПродолжения, );
```
</details>
## УстановитьДоступностьЭлементовФормы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устанавливает доступность элементов формы, связанных с заданными реквизитами,
// для которых установлено разрешение изменения. Если передать массив реквизитов,
// тогда сначала будет дополнен состав реквизитов, разрешенных для изменения.
// Если разблокировка элементов формы, связанных с заданными реквизитами,
// снята для всех реквизитов, тогда кнопка разрешения редактирования блокируется.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма, в которой требуется разрешить
// редактирование элементов формы, заданных реквизитов.
//
// Реквизиты - Массив из Строка - имена реквизитов, для которых нужно установить разрешенность изменения.
// Указывается, когда функция РазрешитьРедактированиеРеквизитовОбъекта не используется.
// - Неопределено - состав реквизитов, доступных для редактирования, не изменяется,
// а для элементов формы, связанных с реквизитами, изменение которых разрешено,
// устанавливается доступность.
//
Процедура УстановитьДоступностьЭлементовФормы(Знач Форма, Знач Реквизиты = Неопределено) Экспорт
```
Пример вызова
```bsl
ЗапретРедактированияРеквизитовОбъектовКлиент.УстановитьДоступностьЭлементовФормы(Форма, Реквизиты);
```
</details>
## УстановитьРазрешенностьРедактированияРеквизитов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устанавливает разрешенность редактирования для тех реквизитов, описание которых подготовлено в форме.
// Используется, когда доступность элементов формы изменяется самостоятельно, без
// использования функции УстановитьДоступностьЭлементовФормы.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма, в которой требуется разрешить редактирование реквизитов объекта, где:
// * Элементы - ВсеЭлементыФормы:
// ** РазрешитьРедактированиеРеквизитовОбъекта - КнопкаФормы
// Реквизиты - Массив из Строка - имена реквизитов, которые нужно пометить как разрешенные для изменения.
// РедактированиеРазрешено - Булево - значение разрешенности редактирования реквизитов, которое нужно установить.
// Значение не будет установлено в Истина, если нет права редактирования реквизита.
// - Неопределено - не изменять разрешенность редактирования реквизитов.
// ПравоРедактирования - Булево - позволяет переопределить или доопределить возможность разблокировки
// реквизитов, которая вычисляется автоматически с помощью метода ПравоДоступа.
// - Неопределено - не изменять свойство ПравоРедактирования.
//
Процедура УстановитьРазрешенностьРедактированияРеквизитов(Знач Форма, Знач Реквизиты, Экспорт
```
Пример вызова
```bsl
ЗапретРедактированияРеквизитовОбъектовКлиент.УстановитьРазрешенностьРедактированияРеквизитов(Форма, Реквизиты, );
```
</details>
## Реквизиты
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает массив имен реквизитов, заданных в свойстве формы ПараметрыЗапретаРедактированияРеквизитов
// на основе имен реквизитов, указанных в модуле менеджера объекта, исключая реквизиты,
// у которых ПравоРедактирования = Ложь.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма объекта с обязательным стандартным реквизитом "Объект".
// ТолькоЗаблокированные - Булево - для вспомогательных целей можно задать Ложь, чтобы
// получить список всех видимых реквизитов, которые могут разблокироваться.
// ТолькоВидимые - Булево - чтобы получить и разблокировать все реквизиты объекта, нужно указать Ложь.
//
// Возвращаемое значение:
// Массив из Строка - имена реквизитов.
//
Функция Реквизиты(Знач Форма, Знач ТолькоЗаблокированные = Истина, ТолькоВидимые = Истина) Экспорт
```
Пример вызова
```bsl
Результат = ЗапретРедактированияРеквизитовОбъектовКлиент.Реквизиты(Форма, ТолькоЗаблокированные, ТолькоВидимые);
```
</details>
## ПоказатьПредупреждениеВсеВидимыеРеквизитыРазблокированы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выводит предупреждение о том, что все видимые реквизиты разблокированы.
// Необходимость в предупреждении возникает, когда команда разблокировки
// остается включенной из-за наличия невидимых неразблокированных реквизитов.
//
// Параметры:
// ОбработкаПродолжения - Неопределено - никаких действий после выполнения процедуры.
// - ОписаниеОповещения - оповещение, которое вызывается после выполнения процедуры.
//
Процедура ПоказатьПредупреждениеВсеВидимыеРеквизитыРазблокированы(ОбработкаПродолжения = Неопределено) Экспорт
```
Пример вызова
```bsl
ЗапретРедактированияРеквизитовОбъектовКлиент.ПоказатьПредупреждениеВсеВидимыеРеквизитыРазблокированы(ОбработкаПродолжения);
```
</details>
## ПроверитьСсылкиНаОбъект
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Вместо этого вызова теперь проверка в общей форме РазблокированиеРеквизитов
// с длительной операцией. В собственной форме РазблокированиеРеквизитов следует
// самостоятельно реализовать проверку использования объектов с длительной операцией.
//
// Спрашивает у пользователя подтверждение на включение редактирования реквизитов
// и проверяет, есть ли ссылки на объект в информационной базе.
//
// Параметры:
// ОбработкаПродолжения - ОписаниеОповещения - оповещение, которое вызывается после проверки.
// В обработку оповещения передается параметр типа Булево:
// Истина - ссылок не обнаружено или пользователь решил разрешить редактирование,
// Ложь - видимых заблокированных реквизитов нет или
// ссылки обнаружены и пользователь отказался от продолжения.
// МассивСсылок - Массив - значения:
// * Ссылка - искомые ссылки в различных объектах.
// СинонимыРеквизитов - Массив - значения:
// * Строка - синонимы реквизитов, которые показываются пользователю.
//
Процедура ПроверитьСсылкиНаОбъект(Знач ОбработкаПродолжения, Знач МассивСсылок, Знач СинонимыРеквизитов) Экспорт
```
Пример вызова
```bsl
ЗапретРедактированияРеквизитовОбъектовКлиент.ПроверитьСсылкиНаОбъект(ОбработкаПродолжения, МассивСсылок, СинонимыРеквизитов)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

82
src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектовПереопределяемый.md Normal file
View File

@ -0,0 +1,82 @@
---
title: Запрет редактирования реквизитов объектов переопределяемый
slug: bsp/запрет-редактирования-реквизитов-объектов-переопределяемый
---
## ПриОпределенииОбъектовСЗаблокированнымиРеквизитами
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определить объекты метаданных, в модулях менеджеров которых ограничивается возможность
// редактирования реквизитов с помощью экспортной функции ПолучитьБлокируемыеРеквизитыОбъекта.
//
// Функция ПолучитьБлокируемыеРеквизитыОбъекта должна возвращать значение типа
// см. ЗапретРедактированияРеквизитовОбъектов.ОписаниеБлокируемогоРеквизита
//
// Поле надписи, связанное с реквизитом, не блокируется. Если требуется блокировать,
// имя элемента надписи нужно указать в описании блокируемого реквизита.
//
// Параметры:
// Объекты - Соответствие из КлючИЗначение:
// * Ключ - Строка - полное имя объекта метаданных, подключенного к подсистеме;
// * Значение - Строка - пустая строка.
//
// Пример:
// Объекты.Вставить(Метаданные.Документы.ЗаказПокупателя.ПолноеИмя(), "");
//
// При этом в модуле менеджера объекта размещается код, подобный:
// // См. ЗапретРедактированияРеквизитовОбъектовПереопределяемый.ПриОпределенииЗаблокированныхРеквизитов.ЗаблокированныеРеквизиты
// Функция ПолучитьБлокируемыеРеквизитыОбъекта() Экспорт
// БлокируемыеРеквизиты = Новый Массив;
// БлокируемыеРеквизиты.Добавить("Организация");
// БлокируемыеРеквизиты.Добавить("Партнер;Партнер");
// Реквизит = ЗапретРедактированияРеквизитовОбъектов.НовыйБлокируемыйРеквизит();
// Реквизит.Имя = "Контрагент";
// Реквизит.Предупреждение = НСтр("ru = 'Поле не рекомендуется менять, если уже есть введенные документы'");
// БлокируемыеРеквизиты.Добавить(Реквизит);
// ...
// Возврат БлокируемыеРеквизиты;
// КонецФункции
//
Процедура ПриОпределенииОбъектовСЗаблокированнымиРеквизитами(Объекты) Экспорт
```
Пример вызова
```bsl
ЗапретРедактированияРеквизитовОбъектовПереопределяемый.ПриОпределенииОбъектовСЗаблокированнымиРеквизитами(Объекты)
```
</details>
## ПриОпределенииЗаблокированныхРеквизитов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет переопределить список заблокированных реквизитов, заданных в модуле менеджера объекта.
//
// Параметры:
// ИмяОбъектаМетаданных - Строка - например, "Справочник.Файлы".
// ЗаблокированныеРеквизиты - Массив из см. ЗапретРедактированияРеквизитовОбъектов.ОписаниеБлокируемогоРеквизита
//
Процедура ПриОпределенииЗаблокированныхРеквизитов(ИмяОбъектаМетаданных, ЗаблокированныеРеквизиты) Экспорт
```
Пример вызова
```bsl
ЗапретРедактированияРеквизитовОбъектовПереопределяемый.ПриОпределенииЗаблокированныхРеквизитов(ИмяОбъектаМетаданных, ЗаблокированныеРеквизиты)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

481
src/content/docs/bsp/ЗащитаПерсональныхДанных.md Normal file
View File

@ -0,0 +1,481 @@
---
title: Защита персональных данных
slug: bsp/защита-персональных-данных
---
## ДобавитьКомандуПечатиСогласияНаОбработкуПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Процедура предназначена для использования из метода ДобавитьКомандыПечати
// стандартной подсистемы Печать в объектах, являющимися субъектами персональных данных.
// Добавляет в список команд печати команду перехода к подготовке согласия на обработку персональных данных субъекта.
//
// Параметры:
// КомандыПечати - см. УправлениеПечатью.СоздатьКоллекциюКомандПечати
//
Процедура ДобавитьКомандуПечатиСогласияНаОбработкуПерсональныхДанных(КомандыПечати) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.ДобавитьКомандуПечатиСогласияНаОбработкуПерсональныхДанных(КомандыПечати)
```
</details>
## ИзменитьНастройкиУничтоженияПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Изменяет настройки уничтожения персональных данных субъектов в соответствии с новыми настройками системы.
//
// Параметры:
// Параметры - Структура - параметры выполнения процедуры:
// * ИспользоватьУничтожениеПерсональныхДанных - Булево - новое значение признака.
// АдресРезультата - Строка - адрес временного хранилища, в которое нужно поместить результат работы процедуры.
//
Процедура ИзменитьНастройкиУничтоженияПерсональныхДанных(Параметры, АдресРезультата = "") Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.ИзменитьНастройкиУничтоженияПерсональныхДанных(Параметры, АдресРезультата);
```
</details>
## ЭтоОбъектСУничтоженнымиПерсональнымиДанными
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет наличие уничтоженных персональных данных в объекте. В качестве объекта может быть передан и сам субъект.
//
// Параметры:
// Объект - СправочникОбъект, СправочникСсылка, ДокументОбъект, ДокументСсылка, РегистрСведенийНаборЗаписей -
// проверяемый объект.
// Также в качестве значения параметра могут быть указаны наборы записей других регистров.
//
// Возвращаемое значение:
// Булево - признак наличия уничтоженных персональных данных.
//
Функция ЭтоОбъектСУничтоженнымиПерсональнымиДанными(Знач Объект) Экспорт
```
Пример вызова
```bsl
Результат = ЗащитаПерсональныхДанных.ЭтоОбъектСУничтоженнымиПерсональнымиДанными(Объект)
```
</details>
## ПриСозданииНаСервереФормыСписка
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// В форме списка добавляет колонку с картинкой, сигнализирующей об отсутствии требуемого согласия
// на обработку персональных данных по субъектам в строках. Добавляет команду показа субъектов со
// скрытыми персональными данными.
// Вызывается из события ПриСозданииНаСервере формы списка.
// У динамических списков должна быть определена основная таблица.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма списка.
// СписокФормы - ТаблицаФормы - элемент формы динамического списка субъектов.
//
Процедура ПриСозданииНаСервереФормыСписка(Форма, СписокФормы) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.ПриСозданииНаСервереФормыСписка(Форма, СписокФормы)
```
</details>
## ПриПолученииДанныхНаСервере
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// В форме списка заполняет колонку с картинкой, сигнализирующей об отсутствии требуемого согласия
// на обработку персональных данных по субъектам в строках.
// Вызывается из события ПриПолученииДанныхНаСервере формы списка.
//
// Параметры:
// Настройки - НастройкиКомпоновкиДанных - содержит копию полных настроек динамического списка.
// Строки - СтрокиДинамическогоСписка - коллекция содержит данные и оформление всех строк, получаемых в списке,
// кроме строк группировок.
//
Процедура ПриПолученииДанныхНаСервере(Настройки, Строки) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.ПриПолученииДанныхНаСервере(Настройки, Строки)
```
</details>
## ДатаУничтоженияДанныхСубъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает дату уничтожения персональных данных субъекта.
//
// Параметры:
// Субъект - ОпределяемыйТип.СубъектПерсональныхДанных
//
// Возвращаемое значение:
// Дата
//
Функция ДатаУничтоженияДанныхСубъекта(Субъект) Экспорт
```
Пример вызова
```bsl
Результат = ЗащитаПерсональныхДанных.ДатаУничтоженияДанныхСубъекта(Субъект)
```
</details>
## ИспользоватьУничтожениеПерсональныхДанныхСубъектов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает Истина если используется уничтожение персональных данных, иначе Ложь.
//
// Возвращаемое значение:
// Булево
//
Функция ИспользоватьУничтожениеПерсональныхДанныхСубъектов() Экспорт
```
Пример вызова
```bsl
Результат = ЗащитаПерсональныхДанных.ИспользоватьУничтожениеПерсональныхДанныхСубъектов()
```
</details>
## ДобавитьСубъектыДляРасчетаСроковХранения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Регистрирует субъекты для расчета срока хранения персональных данных.
//
// Параметры:
// Субъекты - Массив из ОпределяемыйТип.СубъектПерсональныхДанных
// ДатаСобытия - Дата
// ИспользоватьУничтожениеПДн - Булево
//
Процедура ДобавитьСубъектыДляРасчетаСроковХранения(Знач Субъекты, Знач ДатаСобытия, Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.ДобавитьСубъектыДляРасчетаСроковХранения(Субъекты, ДатаСобытия, );
```
</details>
## ПриЗаписиФормыНастройкиРегистрацииСобытий
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет преобразование данных формы настройки системы
// и установку использования события доступ для отмеченных категорий данных.
// В форме должны быть созданы
// - реквизит типа дерево значений, имя которого - "КатегорииПерсональныхДанных",
// - таблица формы, связанная с этим реквизитом,
// имя которой так же - "КатегорииПерсональныхДанных".
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма настройки системы.
//
Процедура ПриЗаписиФормыНастройкиРегистрацииСобытий(Форма) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.ПриЗаписиФормыНастройкиРегистрацииСобытий(Форма)
```
</details>
## УстановитьИспользованиеСобытияДоступ
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устанавливает режим использования события "Доступ. Доступ"
// журнала регистрации, контроль которого предусмотрен требованиями.
// Федерального закона от 27.07.2006 N152-ФЗ "О персональных данных"
// и подзаконных актов.
// Использование события "Доступ.Доступ" устанавливается для категорий персональных данных,
// сведения о которых перечислены в методе ЗаполнитьСведенияОПерсональныхДанных
// общего модуля ЗащитаПерсональныхДанныхПереопределяемый.
//
// Параметры:
// Использование - Булево - если Истина, то события будут регистрироваться.
// КатегорииДанных - Массив - массив категорий персональных данных, для которых производится установка
// использования (необязательный).
//
Процедура УстановитьИспользованиеСобытияДоступ(Использование, КатегорииДанных = Неопределено) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.УстановитьИспользованиеСобытияДоступ(Использование, КатегорииДанных);
```
</details>
## ИспользованиеСобытияДоступ
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Составляет дерево используемых областей персональных данных.
//
// Возвращаемое значение:
// ДеревоЗначений - дерево областей данных с колонками:
// * Имя - Строка - идентификатор области персональных данных.
// * Представление - Строка - пользовательское представление области данных.
// * Использование - Булево - признак того, что для области данных
// установлена регистрация события "Доступ. Доступ".
//
Функция ИспользованиеСобытияДоступ() Экспорт
```
Пример вызова
```bsl
Результат = ЗащитаПерсональныхДанных.ИспользованиеСобытияДоступ()
```
</details>
## ДействующееСогласиеНаОбработкуПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает сведения о действующем на указанную дату согласии субъекта на обработку персональных данных.
// Получение сведений производится в привилегированном режиме.
//
// Параметры:
// Субъект - ОпределяемыйТип.СубъектПерсональныхДанных - субъект, наличие согласия которого определяется,
// Организация - ОпределяемыйТип.Организация - оператор персональных данных, которому предоставлено согласие,
// Дата - Дата - дата, на которую запрашивается состояние, если не указана, выбирается последняя запись.
// ИсключаемыйРегистратор - ДокументСсылка.СогласиеНаОбработкуПерсональныхДанных - текущий документ;
// передается для того, чтобы при поиске согласия игнорировать выполненные текущим документом движения.
//
// Возвращаемое значение:
// Неопределено, Структура - Неопределено, если согласие не предоставлялось,
// или срок действия предоставленного согласия истек;
// Если обнаружено действующее согласие, то Структура со свойствами:
// * ДатаПолучения - Дата - дата получения согласия.
// * СрокДействия - Дата - дата, до которой будет действовать согласие.
// Если не указана, то согласие действует бессрочно.
// * ДокументОснование - ДокументСсылка.СогласиеНаОбработкуПерсональныхДанных - документ-основание.
//
Функция ДействующееСогласиеНаОбработкуПерсональныхДанных(Субъект, Организация = Неопределено, Знач Дата = Неопределено, Экспорт
```
Пример вызова
```bsl
Результат = ЗащитаПерсональныхДанных.ДействующееСогласиеНаОбработкуПерсональныхДанных(Субъект, Организация, Дата, );
```
</details>
## ЗаполнитьСубъектыДляРасчетаСроковХраненияПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Регистрирует всех субъектов с неуничтоженными персональными данными для расчета сроков хранения персональных данных.
Процедура ЗаполнитьСубъектыДляРасчетаСроковХраненияПерсональныхДанных() Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.ЗаполнитьСубъектыДляРасчетаСроковХраненияПерсональныхДанных()
```
</details>
## СубъектыСИстекшимСрокомХранения
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает субъекты с истекшим сроком хранения персональных данных.
//
// Параметры:
// Субъекты - см. РегистрыСведений.СрокиХраненияПерсональныхДанных.СубъектыСИстекшимСрокомХранения.Субъекты
// ДатаАктуальности - см. РегистрыСведений.СрокиХраненияПерсональныхДанных.СубъектыСИстекшимСрокомХранения.ДатаАктуальности
//
// Возвращаемое значение:
// Массив из ОпределяемыйТип.СубъектПерсональныхДанных
//
Функция СубъектыСИстекшимСрокомХранения(Субъекты, ДатаАктуальности = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ЗащитаПерсональныхДанных.СубъектыСИстекшимСрокомХранения(Субъекты, ДатаАктуальности);
```
</details>
## УдалитьИнформациюОбУничтоженииПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Удаляет информацию о том, что персональные данные субъекта уничтожены.
//
// Параметры:
// Субъект - ОпределяемыйТип.СубъектПерсональныхДанных
//
Процедура УдалитьИнформациюОбУничтоженииПерсональныхДанных(Субъект) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.УдалитьИнформациюОбУничтоженииПерсональныхДанных(Субъект)
```
</details>
## СкрытьПерсональныеДанныеСубъектов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела.
//
// Скрывает персональные данные субъектов. Состав персональных данных определяется программно.
//
// Параметры:
// Субъекты - Массив
// - ОпределяемыйТип.СубъектПерсональныхДанных - ссылка или массив ссылок одного типа на субъекты.
// СообщатьОбИсключениях - Булево - признак необходимости информирования пользователя о добавленных исключениях.
//
Процедура СкрытьПерсональныеДанныеСубъектов(Знач Субъекты, СообщатьОбИсключениях = Ложь) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.СкрытьПерсональныеДанныеСубъектов(Субъекты, СообщатьОбИсключениях);
```
</details>
## ЭтоОбъектСоСкрытымиПерсональнымиДанными
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ЗащитаПерсональныхДанных.ЭтоОбъектСУничтоженнымиПерсональнымиДанными
//
// Определяет наличие уничтоженных персональных данных в объекте. В качестве объекта может быть передан и сам субъект.
//
// Параметры:
// Объект - СправочникОбъект, СправочникСсылка, ДокументОбъект, ДокументСсылка, РегистрСведенийНаборЗаписей -
// проверяемый объект.
// Также в качестве значения параметра могут быть указаны наборы записей других регистров.
//
// Возвращаемое значение:
// Булево - признак наличия уничтоженных персональных данных.
//
Функция ЭтоОбъектСоСкрытымиПерсональнымиДанными(Знач Объект) Экспорт
```
Пример вызова
```bsl
Результат = ЗащитаПерсональныхДанных.ЭтоОбъектСоСкрытымиПерсональнымиДанными(Объект)
```
</details>
## ИзменитьНастройкиСкрытияПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует использовать ЗащитаПерсональныхДанных.ИзменитьНастройкиУничтоженияПерсональныхДанных
//
// Изменяет настройки уничтожения персональных данных субъектов в соответствии с новыми настройками системы.
//
// Параметры:
// Параметры - Структура - параметры выполнения процедуры:
// * ИспользоватьУничтожениеПерсональныхДанных - Булево - новое значение признака.
// АдресРезультата - Строка - адрес временного хранилища, в которое нужно поместить результат работы процедуры.
//
Процедура ИзменитьНастройкиСкрытияПерсональныхДанных(Параметры, АдресРезультата = "") Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.ИзменитьНастройкиСкрытияПерсональныхДанных(Параметры, АдресРезультата);
```
</details>
## ПослеЗагрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела.
//
// Параметры:
// Объект - ПланОбменаОбъект - узел плана обмена, для которого выполнялось получение данных.
//
Процедура ПослеЗагрузкиДанных(Объект) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанных.ПослеЗагрузкиДанных(Объект)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

108
src/content/docs/bsp/ЗащитаПерсональныхДанныхКлиент.md Normal file
View File

@ -0,0 +1,108 @@
---
title: Защита персональных данных клиент
slug: bsp/защита-персональных-данных-клиент
---
## ОткрытьФормуСогласиеНаОбработкуПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Осуществляет переход к форме подготовки согласия на обработку персональных данных,
// используется как клиентский обработчик печати (поэтому является функцией, а не процедурой).
//
// Параметры:
// ПараметрыПечати - Структура - параметры обработки команды печати:
// * ОбъектыПечати - Массив - в первом элементе ожидается субъект персональных данных;
// * Форма - ФормаКлиентскогоПриложения - форма, из которой выполняется печать.
//
// Возвращаемое значение:
// Неопределено - не требуется, т.к. функция является клиентским обработчиком печати.
//
Функция ОткрытьФормуСогласиеНаОбработкуПерсональныхДанных(ПараметрыПечати) Экспорт
```
Пример вызова
```bsl
Результат = ЗащитаПерсональныхДанныхКлиент.ОткрытьФормуСогласиеНаОбработкуПерсональныхДанных(ПараметрыПечати)
```
</details>
## ОбработкаОповещенияФормы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет, что указанное событие - это событие об уничтожении персональных данных субъектов
// и обновляет объект управляемой формы.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма субъекта.
// ИмяСобытия - Строка - имя обрабатываемого события.
//
Процедура ОбработкаОповещенияФормы(Форма, ИмяСобытия) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхКлиент.ОбработкаОповещенияФормы(Форма, ИмяСобытия)
```
</details>
## ОбработкаОповещенияФормыСписка
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет, что указанное событие - это событие об уничтожении персональных данных субъектов
// и обновляет данные в таблице субъектов.
//
// Параметры:
// СписокФормы - ТаблицаФормы - элемент формы динамического списка субъектов.
// ИмяСобытия - Строка - имя обрабатываемого события.
//
Процедура ОбработкаОповещенияФормыСписка(СписокФормы, ИмяСобытия) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхКлиент.ОбработкаОповещенияФормыСписка(СписокФормы, ИмяСобытия)
```
</details>
## ПоказыватьСоСкрытымиПДн
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработчик команды формы списка субъектов персональных данных.
//
// Параметры:
// Форма - ФормаКлиентскогоПриложения - форма субъекта.
// Список - ДинамическийСписок - динамический список субъектов.
//
Процедура ПоказыватьСоСкрытымиПДн(Форма, Список) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхКлиент.ПоказыватьСоСкрытымиПДн(Форма, Список)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

357
src/content/docs/bsp/ЗащитаПерсональныхДанныхПереопределяемый.md Normal file
View File

@ -0,0 +1,357 @@
---
title: Защита персональных данных переопределяемый
slug: bsp/защита-персональных-данных-переопределяемый
---
## ЗаполнитьСведенияОПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет задать настройки для регистрации событий доступа к персональным данным.
//
// При расширении состава субъектов персональных данных следует иметь в виду, что регистрация событий для них
// не начнется автоматически (это отдельно настраивает администратор программы). Однако если необходимо управлять этим
// при переходе на новую версию программы, то следует реализовать обработчик обновления, вызывающий
// процедуру ЗащитаПерсональныхДанных.УстановитьИспользованиеСобытияДоступ.
//
// Параметры:
// ТаблицаСведений - ТаблицаЗначений:
// * Объект - Строка - полное имя объекта метаданных с персональными данными;
// * ПоляРегистрации - Строка - имена полей, значения которых выводятся в журнал событий доступа к персональным
// данным для идентификации субъекта персональных данных. Для ссылочных типов,
// как правило, это поле "Ссылка". Отдельные поля регистрации отделяются запятой,
// альтернативные - символом "|";
// * ПоляДоступа - Строка - имена полей доступа через запятую. Обращение (попытка доступа) к этим полям
// приводит к записи журнала;
// * ОбластьДанных - Строка - идентификатор категории данных.
//
// Пример:
// Сведения = ТаблицаСведений.Добавить();
// Сведения.Объект = "Справочник.ФизическиеЛица";
// Сведения.ПоляРегистрации = "Ссылка";
// Сведения.ПоляДоступа = "Наименование";
// Сведения.ОбластьДанных = "ФИО";
//
// Сведения = ТаблицаСведений.Добавить();
// Сведения.Объект = "Справочник.ФизическиеЛица";
// Сведения.ПоляРегистрации = "Ссылка";
// Сведения.ПоляДоступа = "СерияДокумента,НомерДокумента,КемВыданДокумент,ДатаВыдачиДокумента";
// Сведения.ОбластьДанных = "ПаспортныеДанные";
//
Процедура ЗаполнитьСведенияОПерсональныхДанных(ТаблицаСведений) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьСведенияОПерсональныхДанных(ТаблицаСведений)
```
</details>
## ЗаполнитьОбластиПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обеспечивает составление коллекции областей персональных данных.
//
// Параметры:
// КатегорииПерсональныхДанных - ТаблицаЗначений:
// * Имя - Строка - идентификатор категории данных.
// * Представление - Строка - пользовательское представление категории данных.
// * Родитель - Строка - идентификатор родительской категории данных.
//
Процедура ЗаполнитьОбластиПерсональныхДанных(КатегорииПерсональныхДанных) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьОбластиПерсональныхДанных(КатегорииПерсональныхДанных)
```
</details>
## ДополнитьДанныеСубъектовПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при заполнении формы "Согласие на обработку персональных данных" данными,
// переданных в качестве параметров, субъектов.
//
// Параметры:
// СубъектыПерсональныхДанных - Массив из Структура - содержит сведения о субъектах:
// * Субъект - ОпределяемыйТип.СубъектПерсональныхДанных
// * ФИО - Строка
// * Адрес - Строка
// * ПаспортныеДанные - Строка
// ДатаАктуальности - Дата - дата, на которую нужно заполнить сведения.
//
Процедура ДополнитьДанныеСубъектовПерсональныхДанных(СубъектыПерсональныхДанных, ДатаАктуальности) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхПереопределяемый.ДополнитьДанныеСубъектовПерсональныхДанных(СубъектыПерсональныхДанных, ДатаАктуальности)
```
</details>
## ДополнитьДанныеОрганизацииОператораПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при заполнении формы "Согласие на обработку персональных данных" данными организации.
//
// Параметры:
// Организация - ОпределяемыйТип.Организация - оператор персональных данных.
// ДанныеОрганизации - Структура - данные об организации (адрес, ФИО ответственного и т.д.).
// ДатаАктуальности - Дата - дата, на которую нужно заполнить сведения.
//
Процедура ДополнитьДанныеОрганизацииОператораПерсональныхДанных(Организация, ДанныеОрганизации, ДатаАктуальности) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхПереопределяемый.ДополнитьДанныеОрганизацииОператораПерсональныхДанных(Организация, ДанныеОрганизации, ДатаАктуальности)
```
</details>
## ЗаполнитьФИОФизическогоЛица
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается при заполнении формы "Согласие на обработку персональных данных".
// Предназначена для заполнения поля ФИО ответственного за обработку ПДн.
//
// Параметры:
// ФизическоеЛицо - ОпределяемыйТип.ФизическоеЛицо - ответственный за обработку персональных данных.
// ФИО - Строка - ФИО ответственного, которые нужно заполнить.
//
Процедура ЗаполнитьФИОФизическогоЛица(ФизическоеЛицо, ФИО) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьФИОФизическогоЛица(ФизическоеЛицо, ФИО)
```
</details>
## ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
///////////////////////////////////////////////////////////////////////////////////////////////////////
// Уничтожение персональных данных (ПДн) выполняется при проведении документа "Акт об уничтожении персональных данных".
// При этом выполняется поиск объектов информационной базы, в которых содержатся ПДн субъектов.
// Состав таких объектов и их полей описывается в методе ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных.
// В найденных объектах значения реквизитов, содержащих ПДн, очищаются или заменяются случайными значениями.
// Запись объекта с уничтоженными ПДн выполняется в режиме загрузки. В случае необходимости выполнения дополнительных
// действий, при уничтожении ПДн перед записью и после записи объекта можно использовать обработчики
// ПередУничтожениемПерсональныхДанных и ПослеУничтоженияПерсональныхДанных соответственно.
// Заполняет таблицу значений с описанием объектов метаданных и их полей, в которых содержатся персональные данные
// субъектов, подлежащие уничтожению.
//
// Например, персональные данные физического лицо могут храниться в самом справочнике ФизическиеЛица,
// в регистре сведений ФИОФизическихЛиц, в документе ВедомостьНаВыплатуЗарплатыВБанк и т.д.
//
// Параметры:
// ТаблицаСведений - ТаблицаЗначений:
// * Объект - Строка - полное имя объекта метаданных, в котором содержатся персональные данные субъекта.
// Например, "Справочник.ФизическиеЛица".
// * ПолеСубъект - Строка - имя поля объекта, в котором содержится ссылка на субъекта.
// Для стандартных реквизитов используется имя реквизита, например "Ссылка".
// Для остальных полей используется полное имя объекта метаданных реквизита, например
// "Документ.ВедомостьНаВыплатуЗарплатыВБанк.ТабличнаяЧасть.Состав.Реквизит.ФизическоеЛицо"
// * Поля - Массив из Строка, Строка - имена полей объекта, в которых содержатся персональные данные субъекта
// Для стандартных реквизитов используется имя реквизита, например "Наименование".
// Для остальных полей используется полное имя объекта метаданных реквизита, например
// "Справочник.ФизическиеЛица.Реквизит.ФИО"
// * КатегорияДанных - Строка - категория, к которой относятся персональные данные.
//
// Пример:
//
// НовыеСведения = ТаблицаСведений.Добавить();
// НовыеСведения.Объект = "Справочник.ФизическиеЛица";
// НовыеСведения.ПолеСубъект = "Ссылка";
// НовыеСведения.Поля = ОбщегоНазначенияКлиентСервер.ЗначениеВМассиве("Наименование");
// НовыеСведения.КатегорияДанных = "ФИО";
//
// НовыеСведения = ТаблицаСведений.Добавить();
// НовыеСведения.Объект = "Документ.ВедомостьНаВыплатуЗарплатыВБанк";
// НовыеСведения.ПолеСубъект = "Документ.ВедомостьНаВыплатуЗарплатыВБанк.ТабличнаяЧасть.Состав.Реквизит.ФизическоеЛицо";
// НовыеСведения.Поля = ОбщегоНазначенияКлиентСервер.ЗначениеВМассиве(
// "Документ.ВедомостьНаВыплатуЗарплатыВБанк.ТабличнаяЧасть.Состав.Реквизит.СНИЛС");
// НовыеСведения.КатегорияДанных = "СНИЛС";
//
Процедура ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных(ТаблицаСведений) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхПереопределяемый.ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных(ТаблицаСведений)
```
</details>
## ПередСкрытиемПерсональныхДанныхСубъектов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет выполнить дополнительные действия перед уничтожением персональных данных субъектов. В том числе, отказаться
// от уничтожения персональных данных, добавив субъекта в таблицу исключений с указанием причины отказа от уничтожения.
// Или же добавить в массив субъектов других субъектов, данные которых тоже должны быть уничтожены. Например, если при
// уничтожении данных физического лица должны быть уничтожены данные связанных с ним кандидатов.
//
// Параметры:
// Субъекты - Массив из ОпределяемыйТип.СубъектПерсональныхДанных - ссылки на объекты данных, чьи персональные данные
// будут уничтожены.
// ТаблицаИсключений - ТаблицаЗначений:
// * Субъект - ОпределяемыйТип.СубъектПерсональныхДанных
// * ПричинаОтменыУничтожения - Строка
// - ТаблицаЗначений - в которую добавляются субъекты и причины отказа уничтожения их данных
// ОтказОтСкрытия - Булево - (по умолчанию Истина) признак отказа от скрытия. Если определены причины отказа
// от скрытия, то параметру необходимо установить значение Ложь.
//
Процедура ПередСкрытиемПерсональныхДанныхСубъектов(Субъекты, ТаблицаИсключений, ОтказОтСкрытия) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхПереопределяемый.ПередСкрытиемПерсональныхДанныхСубъектов(Субъекты, ТаблицаИсключений, ОтказОтСкрытия)
```
</details>
## ПередУничтожениемПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет выполнить дополнительные действия при уничтожении персональных данных перед записью объекта,
// а также отказаться от записи объекта.
//
// Параметры:
// Объект - СправочникОбъект,ДокументОбъект
// Субъекты - Массив из ОпределяемыйТип.СубъектПерсональныхДанных
// ВыполнитьЗаписьОбъекта - Булево - если Ложь, то запись объекта не выполняется.
//
Процедура ПередУничтожениемПерсональныхДанных(Объект, Субъекты, ВыполнитьЗаписьОбъекта) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхПереопределяемый.ПередУничтожениемПерсональныхДанных(Объект, Субъекты, ВыполнитьЗаписьОбъекта)
```
</details>
## ПослеУничтоженияПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Позволяет выполнить дополнительные действия при уничтожении персональных данных после записи объекта.
//
// Параметры:
// Объект - СправочникОбъект,ДокументОбъект
// Субъекты - Массив из ОпределяемыйТип.СубъектПерсональныхДанных
//
Процедура ПослеУничтоженияПерсональныхДанных(Объект, Субъекты) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхПереопределяемый.ПослеУничтоженияПерсональныхДанных(Объект, Субъекты)
```
</details>
## ПриРасчетеСроковХраненияПерсональныхДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
///////////////////////////////////////////////////////////////////////////////////////////////////////
// Срок хранения ПДн - это дата после которой необходимо уничтожить ПДн субъекта. Ранее этой даты уничтожить ПДн нельзя.
// Сроки хранения ПДн рассчитываются автоматически регламентным заданием РасчетСроковХраненияПерсональныхДанных.
// При наступлении события, которое влияет на срок хранения ПДн, необходимо с помощью метода
// ЗащитаПерсональныхДанных.ДобавитьСубъектыДляРасчетаСроковХранения зарегистрировать субъекта для расчета срока хранения.
// Такими событиями могут быть, например, создание нового физического лица, ввод согласия на обработку ПДн или
// прием сотрудника на работу.
// При расчете сроков хранения ПДн, в процедуре ПриРасчетеСроковХраненияПерсональныхДанных заполняется таблица значений,
// в которую различные подсистемы добавляют рассчитанные сроки хранения. Датой, при наступлении которой данные подлежат
// уничтожению, будет определена самая поздняя из всех заполненных для этого субъекта.
// Позволяет добавить в таблицу значений информацию о сроках хранения персональных данных.
//
// Параметры:
// ДанныеСубъектов - ТаблицаЗначений:
// * Субъект - ОпределяемыйТип.СубъектПерсональныхДанных - ссылка на субъекта.
// * ДатаСобытия - Дата - дата события, которое потребовало обновления срока хранения персональных данных.
// СрокиХранения - ТаблицаЗначений:
// * Субъект - ОпределяемыйТип.СубъектПерсональныхДанных - ссылка на субъекта
// * СрокХранения - Дата - дата, до которой должны храниться персональные данные субъекта и при наступлении которой,
// они должны быть уничтожены.
// * Организация - ОпределяемыйТип.Организация - ссылка на организацию субъекта (если организацию определить
// невозможно, не заполняется)
// * Комментарий - Строка - произвольная строка с пояснением к рассчитанному сроку хранения.
//
Процедура ПриРасчетеСроковХраненияПерсональныхДанных(ДанныеСубъектов, СрокиХранения) Экспорт
```
Пример вызова
```bsl
ЗащитаПерсональныхДанныхПереопределяемый.ПриРасчетеСроковХраненияПерсональныхДанных(ДанныеСубъектов, СрокиХранения)
```
</details>
## ОрганизацияПоУмолчанию
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела. Следует разместить функцию ОрганизацияПоУмолчанию в модуле менеджера справочника,
// указанного в определяемом типе Организация.
//
// Возвращаемое значение:
// ОпределяемыйТип.Организация
//
Функция ОрганизацияПоУмолчанию() Экспорт
```
Пример вызова
```bsl
Результат = ЗащитаПерсональныхДанныхПереопределяемый.ОрганизацияПоУмолчанию()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

283
src/content/docs/bsp/ЗаявлениеНаСертификатПереопределяемый.md Normal file
View File

@ -0,0 +1,283 @@
---
title: Заявление на сертификат переопределяемый
slug: bsp/заявление-на-сертификат-переопределяемый
---
## ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается в форме добавления заявления на новый сертификат для заполнения реквизитов организации и при ее выборе.
//
// Параметры:
// Параметры - Структура:
//
// * ТипОрганизации - ОписаниеТипов - возвращаемое значение. Содержит ссылочные типы, из которых
// можно сделать выбор. Начальное значение ОпределяемыйТип.Организация.
// - Неопределено - возвращаемое значение. Выбор организации не поддерживается.
//
// * Организация - СправочникСсылка - организация из ТипОрганизации, которую нужно заполнить.
// Если организация уже заполнена, требуется перезаполнить ее свойства - например,
// при повтором вызове, когда пользователь выбрал другую организацию.
// - Неопределено - если ТипОрганизации не настроен.
// Пользователю недоступен выбор организации.
//
// * ЭтоИндивидуальныйПредприниматель - Булево - возвращаемое значение:
// Ложь - начальное значение - указанная организация является юридическим лицом;
// Истина - указанная организация является индивидуальным предпринимателем.
//
// * ЭтоИностраннаяОрганизация - Булево - возвращаемое значение, когда Истина ОГРН не заполняется.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * НаименованиеСокращенное - Строка - возвращаемое значение. Краткое наименование организации.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * НаименованиеПолное - Строка - возвращаемое значение. Краткое наименование организации.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * ИНН - Строка - возвращаемое значение. ИНН организации.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * КПП - Строка - возвращаемое значение. КПП организации.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * ОГРН - Строка - возвращаемое значение. ОГРН организации (кроме иностранных).
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * РасчетныйСчет - Строка - возвращаемое значение. Основной расчетный счет организации для договора.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * БИК - Строка - возвращаемое значение. БИК банка расчетного счета.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * КорреспондентскийСчет - Строка - возвращаемое значение. Корреспондентский счет банка расчетного счета.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * Телефон - Строка - возвращаемое значение. Телефон организации в формате JSON, как его
// возвращает функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией.
//
// * ЮридическийАдрес - Строка - возвращаемое значение. Юридический адрес организации в формате JSON, как его
// возвращает функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
Процедура ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат(Параметры) Экспорт
```
Пример вызова
```bsl
ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат(Параметры)
```
</details>
## ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается в форме добавления заявления на новый сертификат для заполнении реквизитов владельца и при его выборе.
//
// Параметры:
// Параметры - Структура:
// * ЭтоФизическоеЛицо - Булево - если Истина, тогда заявление заполняется для физического лица, иначе для организации.
//
// * Организация - СправочникСсылка - выбранная организация из ТипОрганизации, на которую оформляется сертификат.
// - Неопределено - если ТипОрганизации не настроен или составной и тип организации не выбран.
//
// * ТипВладельца - ОписаниеТипов - возвращаемое значение. Содержит ссылочные типы, из которых можно сделать выбор.
// - Неопределено - возвращаемое значение. Выбор владельца не поддерживается.
//
// * Сотрудник - СправочникСсылка - возвращаемое значение. Владелец сертификата из ТипВладельца,
// которого нужно заполнить. Если уже заполнен (выбран пользователем), его не следует изменять.
// - Неопределено - если ТипВладельца не определен, тогда реквизит недоступен пользователю.
//
// * Директор - СправочникСсылка - возвращаемое значение. Директор из ТипВладельца, который может быть
// выбран, как владелец сертификата. Не учитывается, если заявление для ИП или физического лица.
// - Неопределено - начальное значение - скрыть директора из списка выбора.
//
// * ГлавныйБухгалтер - СправочникСсылка - возвращаемое значение. Главный бухгалтер из ТипВладельца, который может
// быть выбран как владелец сертификата. Не учитывается, если заявление для ИП или физического лица.
// - Неопределено - начальное значение - скрыть главного бухгалтера из списка выбора.
//
// * Пользователь - СправочникСсылка.Пользователи - возвращаемое значение. Пользователь - владелец сертификата.
// В общем случае может быть не заполнено. Рекомендуется заполнить, если есть возможность.
// Записывается в сертификат в поле Пользователь, может быть изменено в дальнейшем.
//
// * Фамилия - Строка - возвращаемое значение. Фамилия сотрудника.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * Имя - Строка - возвращаемое значение. Имя сотрудника.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * Отчество - Строка - возвращаемое значение. Отчество сотрудника.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * ДатаРождения - Дата - возвращаемое значение. Дата рождения сотрудника.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * Пол - Строка - возвращаемое значение. Пол сотрудника "Мужской" или "Женский".
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * МестоРождения - Строка - возвращаемое значение. Описание места рождения сотрудника.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * Гражданство - СправочникСсылка.СтраныМира - возвращаемое значение. Гражданство сотрудника.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * ИНН - Строка - возвращаемое значение. ИНН физического лица.
// Учитывается только в заявлении для физического лица.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * СтраховойНомерПФР - Строка - возвращаемое значение. СНИЛС сотрудника.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * Должность - Строка - возвращаемое значение. Должность сотрудника в организации.
// Не учитывается, если заявление для ИП или физического лица.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * Подразделение - Строка - возвращаемое значение. Обособленное подразделение организации, в котором
// работает сотрудник. Не учитывается, если заявление для ИП или физического лица.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
//
// * ДокументВид - Строка - возвращаемое значение. Строки "21" или "91". 21 - паспорт гражданина РФ,
// 91 - иной документ, предусмотренный законодательством РФ (по СПДУЛ).
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * ДокументНомер - Строка - возвращаемое значение. Номер документа сотрудника (серия и
// номер для паспорта гражданина РФ).
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * ДокументКемВыдан - Строка - возвращаемое значение. Кем выдан документ сотрудника.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * ДокументКодПодразделения - Строка - возвращаемое значение. Код подразделения, если вид документа 21.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * ДокументДатаВыдачи - Дата - возвращаемое значение. Дата выдачи документа сотрудника.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * АдресРегистрации - Строка - возвращаемое значение. Адрес постоянной или временной регистрации
// физического лица (минимум регион, населенный пункт) в формате JSON, как его возвращает
// функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией.
// Учитывается только в заявлении для физического лица.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * ЭлектроннаяПочта - Строка - возвращаемое значение. Адрес электронной почты сотрудника в формате JSON, как его
// возвращает функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * Телефон - Строка - возвращаемое значение. Телефон физического лица в формате JSON, как его
// возвращает функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией.
// Учитывается только в заявлении для физического лица.
//
//
Процедура ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат(Параметры) Экспорт
```
Пример вызова
```bsl
ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат(Параметры)
```
</details>
## ПриЗаполненииРеквизитовРуководителяВЗаявленииНаСертификат
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается в форме добавления заявления на новый сертификат для заполнения реквизитов руководителя и при его выборе.
// Только для юридического лица. Для индивидуального предпринимателя и физического лица не требуется.
//
// Параметры:
// Параметры - Структура:
// * Организация - СправочникСсылка - выбранная организация из ТипОрганизации, на которую оформляется сертификат.
// - Неопределено - если ТипОрганизации не настроен.
//
// * ТипРуководителя - ОписаниеТипов - возвращаемое значение. Содержит ссылочные типы, из которых можно сделать выбор.
// - Неопределено - возвращаемое значение. Выбор партнера не поддерживается.
//
// * Руководитель - СправочникСсылка - это значение из ТипРуководителя, выбранное пользователем,
// по которому нужно заполнить должность.
// - Неопределено - ТипРуководителя не определен.
// - ЛюбаяСсылка - возвращаемое значение. Руководитель, который будет подписывать документы.
//
// * Представление - Строка - возвращаемое значение. Представление руководителя.
// - Неопределено - получить представление от значения Руководитель.
//
// * Должность - Строка - возвращаемое значение. Должность руководителя, который будет подписывать документы.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * Основание - Строка - возвращаемое значение. Основание на котором действует
// должностное лицо (устав, доверенность, ...).
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
Процедура ПриЗаполненииРеквизитовРуководителяВЗаявленииНаСертификат(Параметры) Экспорт
```
Пример вызова
```bsl
ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовРуководителяВЗаявленииНаСертификат(Параметры)
```
</details>
## ПриЗаполненииРеквизитовПартнераВЗаявленииНаСертификат
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Вызывается в форме добавления заявления на новый сертификат для заполнения реквизитов партнера и при его выборе.
//
// Параметры:
// Параметры - Структура:
// * ЭтоФизическоеЛицо - Булево - если Истина, тогда заявление заполняется для физического лица, иначе для организации.
//
// * Организация - СправочникСсылка - выбранная организация из ТипОрганизации, на которую оформляется сертификат.
// - Неопределено - если ТипОрганизации не настроен.
//
// * ТипПартнера - ОписаниеТипов - содержит ссылочные типы из которых можно сделать выбор.
// - Неопределено - выбор партнера не поддерживается.
//
// * Партнер - СправочникСсылка - это контрагент (обслуживающая организация) из ТипПартнера,
// выбранный пользователем, по которому нужно заполнить реквизиты, описанные ниже.
// - Неопределено - ТипПартнера не определен.
// - ЛюбаяСсылка - возвращаемое значение. Значение, сохраняемое в заявке для истории.
//
// * Представление - Строка - возвращаемое значение. Представление партнера.
// - Неопределено - получить представление от значения Партнер.
//
// * ЭтоИндивидуальныйПредприниматель - Булево - возвращаемое значение:
// Ложь - начальное значение - указанный партнер является юридическим лицом,
// Истина - указанный партнер является индивидуальным предпринимателем.
//
// * ИНН - Строка - возвращаемое значение. ИНН партнера.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
// * КПП - Строка - возвращаемое значение. КПП партнера.
// - Неопределено - значение не указано, не изменять имеющееся значение.
//
Процедура ПриЗаполненииРеквизитовПартнераВЗаявленииНаСертификат(Параметры) Экспорт
```
Пример вызова
```bsl
ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовПартнераВЗаявленииНаСертификат(Параметры)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

261
src/content/docs/bsp/ИнтеграцияОбъектовОбластейДанных.md Normal file
View File

@ -0,0 +1,261 @@
---
title: Интеграция объектов областей данных
slug: bsp/интеграция-объектов-областей-данных
---
## ПриОпределенииПсевдонимовОбработчиков
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков
// @skip-warning ПустойМетод - особенность реализации.
//
// Параметры:
// СоответствиеИменПсевдонимам - см. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков.СоответствиеИменПсевдонимам
//
Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт
```
Пример вызова
```bsl
ИнтеграцияОбъектовОбластейДанных.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам)
```
</details>
## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки
//
// Параметры:
// Типы - см. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы
//
Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт
```
Пример вызова
```bsl
ИнтеграцияОбъектовОбластейДанных.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы)
```
</details>
## ДобавитьОбъектКОтправке
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Добавляет объект к отправке во внешнюю учетную систему.
// @skip-warning ПустойМетод - особенность реализации.
//
// Параметры:
// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных - учетная система.
// ИдентификаторОбъекта - Строка - идентификатор объекта, должен соответствовать
// требованиям к именованию файлов операционной системы (длина - 50).
// Обработчик - Строка - идентификатор обработчика объекта (длина - 50).
// ДанныеОбъекта - ДвоичныеДанные - данные объекта к отправке (если не указано, данные будут запрошены перед отправкой).
//
Процедура ДобавитьОбъектКОтправке(УчетнаяСистема, ИдентификаторОбъекта, Экспорт
```
Пример вызова
```bsl
ИнтеграцияОбъектовОбластейДанных.ДобавитьОбъектКОтправке(УчетнаяСистема, ИдентификаторОбъекта, );
```
</details>
## УдалитьОбъектКОтправке
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Удаляет объект из объектов к отправке в учетную систему.
// @skip-warning ПустойМетод - особенность реализации.
//
// Параметры:
// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных - учетная система.
// ИдентификаторОбъекта - Строка - идентификатор объекта (длина - 50).
// Обработчик - Строка - идентификатор обработчика объекта (длина - 50).
//
Процедура УдалитьОбъектКОтправке(УчетнаяСистема, Экспорт
```
Пример вызова
```bsl
ИнтеграцияОбъектовОбластейДанных.УдалитьОбъектКОтправке(УчетнаяСистема, );
```
</details>
## ОповеститьОбИзмененииОбъекта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет оповещение внешней учетной системы в соответствие с настройками оповещения.
// @skip-warning ПустойМетод - особеннность реализации.
//
// Параметры:
// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных, СправочникСсылка - учетная система.
// ИдентификаторОбъекта - Строка - идентификатор объекта (длина - 50).
// ВызыватьИсключение - Булево - признак вызова исключения при неудачной отправке оповещения.
//
Процедура ОповеститьОбИзмененииОбъекта(УчетнаяСистема, ИдентификаторОбъекта, Экспорт
```
Пример вызова
```bsl
ИнтеграцияОбъектовОбластейДанных.ОповеститьОбИзмененииОбъекта(УчетнаяСистема, ИдентификаторОбъекта, );
```
</details>
## Настройки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает настройки внешней учетной системы.
// @skip-warning ПустойМетод - особенность реализации.
//
// Параметры:
// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных, СправочникСсылка - учетная система.
// КлючиНастроек - Строка, Массив Из Строка - ключи настроек, по которым нужно вернуть значения.
//
// Возвращаемое значение:
// Структура - Настройки учетной системы:
// * ОповещатьОбИзменениях - Булево - признак использования оповещений при создании/изменении данных в приложении.
// * АдресСервиса - Строка - адрес сервиса приема оповещений об изменениях.
// * СпособАутентификации - ПеречислениеСсылка.СпособыАутентификации - способ аутентификации в сервисе приема оповещений.
// * Логин - Строка - логин аутентификации в сервисе приема оповещений (используется при basic-аутентификации).
// * Пароль - Строка - пароль аутентификации в сервисе приема оповещений (используется при basic-аутентификации).
// * ИспользоватьСертификат - Булево - признак использования сертификата при установке соединения с сервисом приема оповещений.
// * ИмяСертификата - Строка - имя файла сертификата.
// * ПарольСертификата - Строка - пароль сертификата (используется, если задано свойство ИспользоватьСертификат).
// * ДанныеСертификата - ДвоичныеДанные - двоичные данные сертификата в base64 (используется, если задано свойство ИспользоватьСертификат).
// * ПодписыватьДанные - Булево - признак использования подписи данных при отправке их в сервис приема оповещений.
// * КлючПодписи - Строка - секретное слово, для подписи отправляемых данных. Подпись выполняется с помощью алгоритма HMACSHA256.
//
Функция Настройки(УчетнаяСистема, Знач КлючиНастроек = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияОбъектовОбластейДанных.Настройки(УчетнаяСистема, КлючиНастроек);
```
</details>
## НовыйРезультатыВыполненияКоманды
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает шаблон для помещения результатов выполнения команды
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// ТаблицаЗначений - шаблон выполнения команды для возврата результатов:
// * ИдентификаторОбъекта - Строка - идентификатор объекта.
// * Обработчик - Строка - идентификатор обработчика.
//
Функция НовыйРезультатыВыполненияКоманды() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияОбъектовОбластейДанных.НовыйРезультатыВыполненияКоманды()
```
</details>
## ВыполнитьКоманду
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет полученную от учетной системы команду.
// @skip-warning ПустойМетод - особенность реализации.
//
// Параметры:
// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных - учетная система.
// ИдентификаторПараметров - Строка - идентификатор файла параметров выполнения команды (длина 36).
//
Процедура ВыполнитьКоманду(УчетнаяСистема, ИдентификаторПараметров) Экспорт
```
Пример вызова
```bsl
ИнтеграцияОбъектовОбластейДанных.ВыполнитьКоманду(УчетнаяСистема, ИдентификаторПараметров)
```
</details>
## ПодготовитьДанные
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Формирует пакет данных для получения учетной системой.
// @skip-warning ПустойМетод - особенность реализации.
//
// Параметры:
// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных - учетная система
// по которой готовятся данные.
//
Процедура ПодготовитьДанные(УчетнаяСистема) Экспорт
```
Пример вызова
```bsl
ИнтеграцияОбъектовОбластейДанных.ПодготовитьДанные(УчетнаяСистема)
```
</details>
## ОбработатьДанные
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обрабатывает полученный от учетной системы пакет данных.
// @skip-warning ПустойМетод - особенность реализации.
//
// Параметры:
// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных - учетная система
// по которой готовятся данные.
// ИдентификаторФайла - Строка - идентификатор файла для обработки (длина 36).
//
Процедура ОбработатьДанные(УчетнаяСистема, ИдентификаторФайла) Экспорт
```
Пример вызова
```bsl
ИнтеграцияОбъектовОбластейДанных.ОбработатьДанные(УчетнаяСистема, ИдентификаторФайла)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

123
src/content/docs/bsp/ИнтеграцияОбъектовОбластейДанныхСловарь.md Normal file
View File

@ -0,0 +1,123 @@
---
title: Интеграция объектов областей данных словарь
slug: bsp/интеграция-объектов-областей-данных-словарь
---
## КодВозвратаОшибкаДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код ошибки данных.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаОшибкаДанных() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияОбъектовОбластейДанныхСловарь.КодВозвратаОшибкаДанных()
```
</details>
## КодВозвратаВнутренняяОшибка
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код внутренней ошибки.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаВнутренняяОшибка() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияОбъектовОбластейДанныхСловарь.КодВозвратаВнутренняяОшибка()
```
</details>
## КодВозвратаВыполненоСПредупреждениями
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код выполнения с предупреждениями.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаВыполненоСПредупреждениями() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияОбъектовОбластейДанныхСловарь.КодВозвратаВыполненоСПредупреждениями()
```
</details>
## КодВозвратаВыполнено
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код успешного выполнения.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаВыполнено() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияОбъектовОбластейДанныхСловарь.КодВозвратаВыполнено()
```
</details>
## КодВозвратаНеНайдено
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает код отсутствия данных.
// @skip-warning ПустойМетод - особенность реализации.
//
// Возвращаемое значение:
// Число - стандартный код возврата по имени метода.
//
Функция КодВозвратаНеНайдено() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияОбъектовОбластейДанныхСловарь.КодВозвратаНеНайдено()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

508
src/content/docs/bsp/ИнтеграцияПодсистемБТС.md Normal file
View File

@ -0,0 +1,508 @@
---
title: Интеграция подсистем БТС
slug: bsp/интеграция-подсистем-бтс
---
## ПриОпределенииПодписокНаСобытияБСП
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработка программных событий, возникающих в подсистемах БСП.
// Только для вызовов из библиотеки БСП в БТС.
// Определяет события, на которые подписана эта библиотека.
//
// Параметры:
// Подписки - Структура - Ключами свойств структуры являются имена событий, на которые
// подписана эта библиотека.
//
Процедура ПриОпределенииПодписокНаСобытияБСП(Подписки) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриОпределенииПодписокНаСобытияБСП(Подписки)
```
</details>
## ПередЗапускомПрограммы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ОбщегоНазначенияПереопределяемый.ПередЗапускомПрограммы
Процедура ПередЗапускомПрограммы() Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПередЗапускомПрограммы()
```
</details>
## ПриДобавленииПодсистем
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ПодсистемыКонфигурацииПереопределяемый.ПриДобавленииПодсистем
//
// Параметры:
// МодулиПодсистем - Массив из Строка - имена модулей.
Процедура ПриДобавленииПодсистем(МодулиПодсистем) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриДобавленииПодсистем(МодулиПодсистем)
```
</details>
## ПриДобавленииОбработчиковУстановкиПараметровСеанса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ОбщегоНазначенияПереопределяемый.ПриДобавленииОбработчиковУстановкиПараметровСеанса.
Процедура ПриДобавленииОбработчиковУстановкиПараметровСеанса(Обработчики) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриДобавленииОбработчиковУстановкиПараметровСеанса(Обработчики)
```
</details>
## ПриДобавленииИсключенийПоискаСсылок
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ОбщегоНазначенияПереопределяемый.ПриДобавленииИсключенийПоискаСсылок
Процедура ПриДобавленииИсключенийПоискаСсылок(ИсключенияПоискаСсылок) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриДобавленииИсключенийПоискаСсылок(ИсключенияПоискаСсылок)
```
</details>
## ПриОтправкеДанныхГлавному
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ПриОтправкеДанныхГлавномув синтаксис-помощнике
//
// Параметры:
// ЭлементДанных - Произвольный - объект базы данных
// ОтправкаЭлемента - ОтправкаЭлементаДанных
// Получатель - ПланОбменаСсылка
Процедура ПриОтправкеДанныхГлавному(ЭлементДанных, ОтправкаЭлемента, Получатель) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриОтправкеДанныхГлавному(ЭлементДанных, ОтправкаЭлемента, Получатель)
```
</details>
## ПриОтправкеДанныхПодчиненному
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ПриОтправкеДанныхПодчиненномув синтаксис-помощнике
//
// Параметры:
// ЭлементДанных - Произвольный - объект базы данных
// ОтправкаЭлемента - ОтправкаЭлементаДанных
// СозданиеНачальногоОбраза - Булево
// Получатель - ПланОбменаСсылка
Процедура ПриОтправкеДанныхПодчиненному(ЭлементДанных, ОтправкаЭлемента, СозданиеНачальногоОбраза, Получатель) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриОтправкеДанныхПодчиненному(ЭлементДанных, ОтправкаЭлемента, СозданиеНачальногоОбраза, Получатель)
```
</details>
## ПриПолученииДанныхОтГлавного
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ПриПолученииДанныхОтГлавногов синтаксис-помощнике
//
// Параметры:
// ЭлементДанных - Произвольный - объект базы данных
// ПолучениеЭлемента - ПолучениеЭлементаДанных
// ОтправкаНазад - Булево
// Отправитель - ПланОбменаСсылка
Процедура ПриПолученииДанныхОтГлавного(ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад, Отправитель) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриПолученииДанныхОтГлавного(ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад, Отправитель)
```
</details>
## ПриПолученииДанныхОтПодчиненного
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ПриПолученииДанныхОтПодчиненного в синтаксис-помощнике
//
// Параметры:
// ЭлементДанных - Произвольный - объект базы данных
// ПолучениеЭлемента - ПолучениеЭлементаДанных
// ОтправкаНазад - Булево
// Отправитель - ПланОбменаСсылка
Процедура ПриПолученииДанныхОтПодчиненного(ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад, Отправитель) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриПолученииДанныхОтПодчиненного(ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад, Отправитель)
```
</details>
## ПриВключенииРазделенияПоОбластямДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. РаботаВМоделиСервисаПереопределяемый.ПриВключенииРазделенияПоОбластямДанных
Процедура ПриВключенииРазделенияПоОбластямДанных() Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриВключенииРазделенияПоОбластямДанных()
```
</details>
## ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ОбщегоНазначенияПереопределяемый.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов
// Параметры:
// СтруктураПоддерживаемыхВерсий - Структура - в ключе указывается имя программного интерфейса,
// а в значениях - массив строк с поддерживаемыми версиями этого интерфейса.
Процедура ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(Знач СтруктураПоддерживаемыхВерсий) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(СтруктураПоддерживаемыхВерсий)
```
</details>
## ПриДобавленииПараметровРаботыКлиентаПриЗапуске
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиентаПриЗапуске
// Параметры:
// Параметры - Структура - имена и значения параметров работы клиента при запуске, которые необходимо задать.
Процедура ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры)
```
</details>
## ПриДобавленииПараметровРаботыКлиента
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиента
//
// Параметры:
// Параметры - Структура - имена и значения параметров работы клиента при запуске, которые необходимо задать.
Процедура ПриДобавленииПараметровРаботыКлиента(Параметры) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриДобавленииПараметровРаботыКлиента(Параметры)
```
</details>
## ПриОпределенииОбъектовСРедактируемымиРеквизитами
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ГрупповоеИзменениеОбъектовПереопределяемый.ПриОпределенииОбъектовСРедактируемымиРеквизитами
//
// Параметры:
// Объекты - Соответствие из КлючИЗначение
Процедура ПриОпределенииОбъектовСРедактируемымиРеквизитами(Объекты) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриОпределенииОбъектовСРедактируемымиРеквизитами(Объекты)
```
</details>
## ПриУстановкеРежимаПодключенияДополнительногоОтчетаИлиОбработкиВОбластиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Устарела.
Процедура ПриУстановкеРежимаПодключенияДополнительногоОтчетаИлиОбработкиВОбластиДанных(ПоставляемаяОбработка, Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриУстановкеРежимаПодключенияДополнительногоОтчетаИлиОбработкиВОбластиДанных(ПоставляемаяОбработка, );
```
</details>
## ПриОпределенииСправочниковДляЗагрузкиДанных
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ЗагрузкаДанныхИзФайлаПереопределяемый.ПриОпределенииСправочниковДляЗагрузкиДанных
//
// Параметры:
// ЗагружаемыеСправочники - ТаблицаЗначений
Процедура ПриОпределенииСправочниковДляЗагрузкиДанных(ЗагружаемыеСправочники) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриОпределенииСправочниковДляЗагрузкиДанных(ЗагружаемыеСправочники)
```
</details>
## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузкиOData
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ИнтеграцияПодсистемБСП.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузкиOData
//
// Параметры:
// Типы - Массив из ОбъектМетаданных - объекты метаданных, исключаемые из выгрузки и загрузки.
Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузкиOData(Типы) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузкиOData(Типы)
```
</details>
## ПриЗавершенииОбработкиПользователяИБ
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ПользователиСлужебныйВМоделиСервиса.ПриЗавершенииОбработкиПользователяИБ
//
// Параметры:
// Пользователь - СправочникСсылка.Пользователи
Процедура ПриЗавершенииОбработкиПользователяИБ(Пользователь) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриЗавершенииОбработкиПользователяИБ(Пользователь)
```
</details>
## ПриПроверкеВозможностиНастройкиПрофилейБезопасности
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. РаботаВБезопасномРежимеПереопределяемый.ПриПроверкеВозможностиНастройкиПрофилейБезопасности
Процедура ПриПроверкеВозможностиНастройкиПрофилейБезопасности(Отказ) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриПроверкеВозможностиНастройкиПрофилейБезопасности(Отказ)
```
</details>
## ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. РаботаВБезопасномРежимеПереопределяемый.ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов
Процедура ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов(Знач ПрограммныйМодуль, Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов(ПрограммныйМодуль, );
```
</details>
## ПриЗапросеСозданияПрофиляБезопасности
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. РаботаВБезопасномРежимеПереопределяемый.ПриЗапросеСозданияПрофиляБезопасности
Процедура ПриЗапросеСозданияПрофиляБезопасности(Знач ПрограммныйМодуль, Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриЗапросеСозданияПрофиляБезопасности(ПрограммныйМодуль, );
```
</details>
## ПриЗапросеУдаленияПрофиляБезопасности
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. РаботаВБезопасномРежимеПереопределяемый.ПриЗапросеУдаленияПрофиляБезопасности
Процедура ПриЗапросеУдаленияПрофиляБезопасности(Знач ПрограммныйМодуль, Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриЗапросеУдаленияПрофиляБезопасности(ПрограммныйМодуль, );
```
</details>
## ПриПодключенииВнешнегоМодуля
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. РаботаВБезопасномРежимеПереопределяемый.ПриПодключенииВнешнегоМодуля
Процедура ПриПодключенииВнешнегоМодуля(Знач ВнешнийМодуль, Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриПодключенииВнешнегоМодуля(ВнешнийМодуль, );
```
</details>
## ПриОпределенииНастроекРегламентныхЗаданий
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроекРегламентныхЗаданий
Процедура ПриОпределенииНастроекРегламентныхЗаданий(Настройки) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриОпределенииНастроекРегламентныхЗаданий(Настройки)
```
</details>
## ПриЗаполненииПоставляемыхПрофилейГруппДоступа
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. УправлениеДоступомПереопределяемый.ПриЗаполненииПоставляемыхПрофилейГруппДоступа
Процедура ПриЗаполненииПоставляемыхПрофилейГруппДоступа(ОписанияПрофилей, ПараметрыОбновления) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриЗаполненииПоставляемыхПрофилейГруппДоступа(ОписанияПрофилей, ПараметрыОбновления)
```
</details>
## ПриПолученииПриоритетаОбновления
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. ИнтеграцияПодсистемБСП.ПриПолученииПриоритетаОбновления.
Процедура ПриПолученииПриоритетаОбновления(Приоритет) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТС.ПриПолученииПриоритетаОбновления(Приоритет)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

110
src/content/docs/bsp/ИнтеграцияПодсистемБТСКлиент.md Normal file
View File

@ -0,0 +1,110 @@
---
title: Интеграция подсистем БТС клиент
slug: bsp/интеграция-подсистем-бтс-клиент
---
## ПриОпределенииПодписокНаСобытияБСП
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Обработка программных событий, возникающих в подсистемах БСП.
// Только для вызовов из библиотеки БСП в БТС.
// Определяет события, на которые подписана эта библиотека.
//
// Параметры:
// Подписки - Структура - Ключами свойств структуры являются имена событий, на которые
// подписана эта библиотека.
//
Процедура ПриОпределенииПодписокНаСобытияБСП(Подписки) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТСКлиент.ПриОпределенииПодписокНаСобытияБСП(Подписки)
```
</details>
## ПередНачаломРаботыСистемы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. процедуру ОбщегоНазначенияКлиентПереопределяемый.ПередНачаломРаботыСистемы
// Параметры:
// Параметры - см. ОбщегоНазначенияКлиентПереопределяемый.ПередНачаломРаботыСистемы.Параметры
Процедура ПередНачаломРаботыСистемы(Параметры) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТСКлиент.ПередНачаломРаботыСистемы(Параметры)
```
</details>
## ПриНачалеРаботыСистемы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. процедуру ОбщегоНазначенияКлиентПереопределяемый.ПриНачалеРаботыСистемы.
// Параметры:
// Параметры - Структура:
// * Модули - Массив - ссылки на модули.
Процедура ПриНачалеРаботыСистемы(Параметры) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТСКлиент.ПриНачалеРаботыСистемы(Параметры)
```
</details>
## ПриЗавершенииСеансов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. процедуру УдаленноеАдминистрированиеБТСКлиент.ПриЗавершенииСеансов.
Процедура ПриЗавершенииСеансов(ФормаВладелец, Знач НомераСеансов, СтандартнаяОбработка, Знач ОповещениеПослеЗавершенияСеанса = Неопределено) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТСКлиент.ПриЗавершенииСеансов(ФормаВладелец, НомераСеансов, СтандартнаяОбработка, ОповещениеПослеЗавершенияСеанса);
```
</details>
## ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. процедуру РаботаВБезопасномРежимеКлиентПереопределяемый.ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов.
Процедура ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов(Знач ИдентификаторыЗапросов, ФормаВладелец, ОповещениеОЗакрытии, СтандартнаяОбработка) Экспорт
```
Пример вызова
```bsl
ИнтеграцияПодсистемБТСКлиент.ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов(ИдентификаторыЗапросов, ФормаВладелец, ОповещениеОЗакрытии, СтандартнаяОбработка)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

260
src/content/docs/bsp/ИнтеграцияССистемойВзаимодействия.md Normal file
View File

@ -0,0 +1,260 @@
---
title: Интеграция с системой взаимодействия
slug: bsp/интеграция-с-системой-взаимодействия
---
## ДанныеДляУправленияСистемойВзаимодействия
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Данные для управления системой взаимодействия.
//
// Возвращаемое значение:
// Строка
Функция ДанныеДляУправленияСистемойВзаимодействия() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.ДанныеДляУправленияСистемойВзаимодействия()
```
</details>
## ДоступноПодключениеКСистемеВзаимодействияВМоделиСервиса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Доступно подключение к системе взаимодействия в модели сервиса.
//
// Возвращаемое значение:
// Булево - Ложь
Функция ДоступноПодключениеКСистемеВзаимодействияВМоделиСервиса() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.ДоступноПодключениеКСистемеВзаимодействияВМоделиСервиса()
```
</details>
## ЗапросВСервис
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает результат запроса к HTTP-сервису для управления системой взаимодействия
//
// Параметры:
// АдресПубликацииСервисаУправления - Строка
// КодУправления - Строка
// ИмяМетода - Строка
// ПараметрыЗапроса - Структура
//
// Возвращаемое значение:
// Структура - результат запроса в сервис с полями:
// * Успешно - Булево
// * ТекстСообщения - Строка
// * ДанныеРезультата - Структура
//
Функция ЗапросВСервис(АдресПубликацииСервисаУправления, КодУправления, ИмяМетода, ПараметрыЗапроса = Неопределено) Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.ЗапросВСервис(АдресПубликацииСервисаУправления, КодУправления, ИмяМетода, ПараметрыЗапроса);
```
</details>
## ЗарегистрироватьБазуЧерезСервис
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Зарегистрировать базу через сервис
//
// Параметры:
// АдресПубликацииСервисаУправления - Строка
// КодУправления - Строка
// ИмяБазы - Строка
//
// Возвращаемое значение: см. ЗапросВСервис
Функция ЗарегистрироватьБазуЧерезСервис(АдресПубликацииСервисаУправления, КодУправления, ИмяБазы) Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.ЗарегистрироватьБазуЧерезСервис(АдресПубликацииСервисаУправления, КодУправления, ИмяБазы)
```
</details>
## ИспользуетсяИнтеграцияССистемойВзаимодействияВМоделиСервиса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Используется интеграция с системой взаимодействия в модели сервиса.
//
// Возвращаемое значение:
// Булево
Функция ИспользуетсяИнтеграцияССистемойВзаимодействияВМоделиСервиса() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.ИспользуетсяИнтеграцияССистемойВзаимодействияВМоделиСервиса()
```
</details>
## ОбъектСистемыВзаимодействия
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Объект системы взаимодействия.
//
// Возвращаемое значение:
// МенеджерСистемыВзаимодействия
Функция ОбъектСистемыВзаимодействия() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.ОбъектСистемыВзаимодействия()
```
</details>
## ПолучитьДанныеОПользователяхСервиса
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Получить данные о пользователях сервиса.
//
// Параметры:
// АдресПубликацииСервисаУправления - Строка
// КодУправления - Строка
//
// Возвращаемое значение: см. ЗапросВСервис
//
Функция ПолучитьДанныеОПользователяхСервиса(АдресПубликацииСервисаУправления, КодУправления) Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.ПолучитьДанныеОПользователяхСервиса(АдресПубликацииСервисаУправления, КодУправления)
```
</details>
## РасшифроватьДанныеДляУправления
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает расшифрованные данные, предназначенные для управления системой взаимодействия через HTTP-сервис.
//
// Параметры:
// ДанныеДляУправления - Строка - зашифрованные данные
//
// Возвращаемое значение:
// Структура - результат расшифровки с полями:
// * ТекстСообщения - Строка - сообщение, сформированное при расшифровке
// * Расшифровано - Булево - признак успешной расшифровки
// * Данные - Структура - расшифрованные данные:
// ** АдресПубликацииСервисаУправления - Строка
// ** КодУправления - Строка
//
Функция РасшифроватьДанныеДляУправления(ДанныеДляУправления) Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.РасшифроватьДанныеДляУправления(ДанныеДляУправления)
```
</details>
## ТипКоллекцияИдентификаторовПриложений
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Тип коллекция идентификаторов приложений.
//
// Возвращаемое значение:
// Тип - Тип
Функция ТипКоллекцияИдентификаторовПриложений() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.ТипКоллекцияИдентификаторовПриложений()
```
</details>
## ТипПараметрыРегистрацииИБ
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Тип параметры регистрации ИБ.
//
// Возвращаемое значение:
// Тип - Тип
Функция ТипПараметрыРегистрацииИБ() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.ТипПараметрыРегистрацииИБ()
```
</details>
## ТипСовместноеИспользованиеПриложений
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Тип совместное использование приложений.
//
// Возвращаемое значение:
// Тип - Тип
Функция ТипСовместноеИспользованиеПриложений() Экспорт
```
Пример вызова
```bsl
Результат = ИнтеграцияССистемойВзаимодействия.ТипСовместноеИспользованиеПриложений()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

290
src/content/docs/bsp/ИнтернетПоддержкаПользователей.md Normal file
View File

@ -0,0 +1,290 @@
---
title: Интернет поддержка пользователей
slug: bsp/интернет-поддержка-пользователей
---
## ИмяПрограммы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает имя, по которому программа идентифицируется в
// сервисах Интернет-поддержки.
//
// Возвращаемое значение:
// Строка - имя программы. <Пустая строка>, если имя программы не заполнено.
//
Функция ИмяПрограммы() Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователей.ИмяПрограммы()
```
</details>
## НастройкиСоединенияССерверами
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает настройки соединения с серверами Интернет-поддержки.
//
// Возвращаемое значение:
// Структура - настройки соединения. Поля структуры:
// * УстанавливатьПодключениеНаСервере - Булево - Истина, если подключение
// устанавливается на сервере 1С:Предприятие;
// * ТаймаутПодключения - Число - таймаут подключения к серверам в секундах;
// * ДоменРасположенияСерверовИПП - Число - если 0, устанавливать подключение
// к серверам ИПП в доменной зоне 1c.ru, если 1 - в доменной зоне 1c.eu.
//
Функция НастройкиСоединенияССерверами() Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователей.НастройкиСоединенияССерверами()
```
</details>
## ДанныеАутентификацииПользователяИнтернетПоддержки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает логин и пароль пользователя Интернет-поддержки, сохраненные в информационной базе.
// Перед вызовом вызывающий код должен устанавливать привилегированный режим.
//
// Возвращаемое значение:
// Структура - Структура - логин и пароль пользователя Интернет-поддержки:
// * Логин - Строка - логин пользователя Интернет-поддержки;
// * Пароль - Строка - пароль пользователя Интернет-поддержки.
// Неопределено - при отсутствии сохраненных данных аутентификации.
//
Функция ДанныеАутентификацииПользователяИнтернетПоддержки() Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователей.ДанныеАутентификацииПользователяИнтернетПоддержки()
```
</details>
## ТикетАутентификацииНаПорталеПоддержки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает тикет аутентификации пользователя на портале поддержки.
// Возвращенный тикет может быть проверен вызовом операции check
// сервиса https://login.1c.ru или https://login.1c.eu
//
// Подробнее см. https://login.1c.ru/rest/public/swagger-ui.html.
//
// Получение тикета выполняется в соответствии с настройками
// библиотеки:
// - доменная зона серверов (1c.ru или 1c.eu);
// Перед вызовом вызывающий код должен устанавливать привилегированный режим.
//
// Параметры:
// ВладелецТикета - Строка - произвольное имя сервиса, для которого
// выполняется аутентификация пользователя. Это же имя должно
// использоваться при вызове операции checkTicket;
// Не допускается незаполненное значение параметра.
//
// Возвращаемое значение:
// Структура - результат получения тикета. Поля структуры:
// * Тикет - Строка - полученный тикет аутентификации. Если при получении
// тикета произошла ошибка (неверный логин или пароль или другая ошибка),
// значение поля - пустая строка.
// * КодОшибки - Строка - строковый код возникшей ошибки, который
// может быть обработан вызывающим функционалом:
// - <Пустая строка> - получение тикета выполнено успешно;
// - "НеверныйЛогинИлиПароль" - неверный логин или пароль;
// - "ПревышеноКоличествоПопыток" - превышено количество попыток
// получения тикета с некорректным логином и паролем;
// - "ОшибкаПодключения" - ошибка при подключении к сервису;
// - "ОшибкаСервиса" - внутренняя ошибка сервиса;
// - "НеизвестнаяОшибка" - при получении тикета возникла
// неизвестная (не обрабатываемая) ошибка;
// - "ОперацияНеПоддерживается" - сервис не интегрирован с Порталом 1С:ИТС.
// Ошибка может возникнуть при работе в модели сервиса.
// * СообщениеОбОшибке - Строка - краткое описание ошибки, которое
// может быть отображено пользователю;
// * ИнформацияОбОшибке - Строка - подробное описание ошибки, которое
// может быть записано в журнал регистрации.
//
Функция ТикетАутентификацииНаПорталеПоддержки(ВладелецТикета) Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователей.ТикетАутентификацииНаПорталеПоддержки(ВладелецТикета)
```
</details>
## ЗаполненыДанныеАутентификацииПользователяИнтернетПоддержки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет заполнение данных аутентификации пользователя
// Интернет-поддержки.
//
// Возвращаемое значение:
// Булево - признак заполнения данных аутентификации.
// Истина - данные аутентификации заполнены,
// Ложь - в противном случае.
//
Функция ЗаполненыДанныеАутентификацииПользователяИнтернетПоддержки() Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователей.ЗаполненыДанныеАутентификацииПользователяИнтернетПоддержки()
```
</details>
## ПроверитьЛогинИПароль
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Проверяет данные аутентификации пользователя
// Интернет-поддержки.
//
// Параметры:
// Логин - Строка - логин пользователя Интернет-поддержки;
// Пароль - Строка - пароль пользователя Интернет-поддержки.
//
// Возвращаемое значение:
// Структура - результат проверки данных аутентификации:
// *Результат - Булево - результат проверки, если Истина, логин и пароль ведены верно,
// *КодОшибки - Строка - идентификатор ошибки в случае если логин и пароль ведены верно
// или в процессе проверки возникли ошибки;
// *СообщениеОбОшибке - Строка - описание ошибки проверки данных аутентификации.
//
Функция ПроверитьЛогинИПароль(Логин, Пароль) Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователей.ПроверитьЛогинИПароль(Логин, Пароль)
```
</details>
## СохранитьДанныеАутентификации
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Сохраняет логин и пароль пользователя в подсистеме Интернет-поддержки
// в безопасном хранилище. В вызывающем коде перед записью данных необходимо
// выполнить:
// - Проверку доступности подключения Интернет-поддержки, вызвав
// метод ИнтернетПоддержкаПользователей.ДоступноПодключениеИнтернетПоддержки;
// - Вызвать метод ИнтернетПоддержкаПользователейКлиентСервер.ПроверитьДанныеАутентификации
// или ИнтернетПоддержкаПользователей.ПроверитьЛогинИПароль для проверки наличия
// не корректных символов в данных аутентификации;
// - Установить привилегированный режим.
//
// В случае реализации собственной формы подключения Интернет-поддержки, необходимо
// после сохранения данных аутентификации, удалить значения введенные пользователем
// для того, чтобы минимизировать время хранения секретных данных на клиенте.
//
// Параметры:
// ДанныеАутентификации - Структура, Неопределено - структура, содержащая логин
// и пароль пользователя и пароль пользователя Интернет-поддержки.
// Если передано значение Неопределено, данные аутентификации удаляются.
// * Логин - Строка - логин пользователя Интернет-поддержки;
// * Пароль - Строка - пароль пользователя Интернет-поддержки.
//
Процедура СохранитьДанныеАутентификации(ДанныеАутентификации) Экспорт
```
Пример вызова
```bsl
ИнтернетПоддержкаПользователей.СохранитьДанныеАутентификации(ДанныеАутентификации)
```
</details>
## ДоступноПодключениеИнтернетПоддержки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет, доступно ли текущему пользователю выполнение интерактивного
// подключения Интернет-поддержки в соответствии с текущим режимом работы
// и правами пользователя.
//
// Возвращаемое значение:
// Булево - Истина - интерактивное подключение доступно,
// Ложь - в противном случае.
//
Функция ДоступноПодключениеИнтернетПоддержки() Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователей.ДоступноПодключениеИнтернетПоддержки()
```
</details>
## URLДляПереходаНаСтраницуИнтегрированногоСайта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает URL для перехода на страницу сайта, система аутентификации
// которого интегрирована с Порталом 1С:ИТС.
// В зависимости от текущего режима работы информационной базы и наличия у
// текущего пользователя информационной базы соответствующих прав
// переданный URL страницы сайта трансформируется таким образом, что открытие
// страницы происходит с учетными данными пользователя Портала 1С:ИТС.
// При отсутствии прав, несоответствии режима работы или возникновении ошибок
// переданный URL возвращается без изменений.
//
// Важно. Полученный URL необходимо использовать сразу после получения, т.к.
// URL действителен ограниченное время (исчисляется секундами).
//
// Параметры:
// URLСтраницыСайта - Строка - URL страницы сайта;
//
// Возвращаемое значение:
// Строка - URL для перехода на страницу сайта.
//
Функция URLДляПереходаНаСтраницуИнтегрированногоСайта(URLСтраницыСайта) Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователей.URLДляПереходаНаСтраницуИнтегрированногоСайта(URLСтраницыСайта)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

60
src/content/docs/bsp/ИнтернетПоддержкаПользователейВМоделиСервиса.md Normal file
View File

@ -0,0 +1,60 @@
---
title: Интернет поддержка пользователей в модели сервиса
slug: bsp/интернет-поддержка-пользователей-в-модели-сервиса
---
## ТикетАутентификацииНаПорталеПоддержкиВНеразделенномСеансе
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает тикет аутентификации пользователя на портале поддержки
// при работе в модели сервиса в неразделенном сеансе.
// Возвращенный тикет может быть проверен вызовом операции check
// сервиса https://login.1c.ru или https://login.1c.eu
//
// Подробнее см. https://login.1c.ru/rest/public/swagger-ui.html.
//
// Параметры:
// ВладелецТикета - Строка - произвольное имя сервиса, для которого
// выполняется аутентификация пользователя. Это же имя должно
// использоваться при вызове операции checkTicket();
// Не допускается незаполненное значение параметра;
// ОбластьДанных - Число - номер области данных (абонент), для которой
// выполняется получение тикета.
//
// Возвращаемое значение:
// Структура - результат получения тикета. Поля структуры:
// * Тикет - Строка - полученный тикет аутентификации. Если при получении
// тикета произошла ошибка, значение поля - пустая строка.
// * КодОшибки - Строка - строковый код возникшей ошибки, который
// может быть обработан вызывающим функционалом:
// - <Пустая строка> - получение тикета выполнено успешно;
// - "ОшибкаПодключения" - ошибка при подключении к сервису;
// - "ОшибкаСервиса" - внутренняя ошибка сервиса;
// - "НеизвестнаяОшибка" - при получении тикета возникла
// неизвестная (необрабатываемая) ошибка;
// * СообщениеОбОшибке - Строка - краткое описание ошибки, которое
// может быть отображено пользователю;
// * ИнформацияОбОшибке - Строка - подробное описание ошибки, которое
// может быть записано в журнал регистрации.
//
Функция ТикетАутентификацииНаПорталеПоддержкиВНеразделенномСеансе(ВладелецТикета, ОбластьДанных) Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователейВМоделиСервиса.ТикетАутентификацииНаПорталеПоддержкиВНеразделенномСеансе(ВладелецТикета, ОбластьДанных)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

38
src/content/docs/bsp/ИнтернетПоддержкаПользователейВызовСервера.md Normal file
View File

@ -0,0 +1,38 @@
---
title: Интернет поддержка пользователей вызов сервера
slug: bsp/интернет-поддержка-пользователей-вызов-сервера
---
## ДоступноПодключениеИнтернетПоддержки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет, доступно ли текущему пользователю выполнение подключения
// Интернет-поддержки: авторизация/регистрация пользователя, регистрация
// программного продукта в соответствии с текущим режимом работы
// и правами пользователя.
//
// Возвращаемое значение:
// Булево - Истина - подключение Интернет-поддержки доступно,
// Ложь - в противном случае.
//
Функция ДоступноПодключениеИнтернетПоддержки() Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователейВызовСервера.ДоступноПодключениеИнтернетПоддержки()
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

199
src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиент.md Normal file
View File

@ -0,0 +1,199 @@
---
title: Интернет поддержка пользователей клиент
slug: bsp/интернет-поддержка-пользователей-клиент
---
## НастройкиСоединенияССерверами
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Возвращает настройки соединения с серверами Интернет-поддержки.
//
// Возвращаемое значение:
// Структура - настройки соединения. Поля структуры:
// * УстанавливатьПодключениеНаСервере - Булево - Истина, если подключение
// устанавливается на сервере 1С:Предприятие;
// * ТаймаутПодключения - Число - таймаут подключения к серверам в секундах;
// * ДоменРасположенияСерверовИПП - Число - если 0, устанавливать подключение
// к серверам ИПП в доменной зоне 1c.ru, если 1 - в доменной зоне 1c.eu.
//
Функция НастройкиСоединенияССерверами() Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователейКлиент.НастройкиСоединенияССерверами()
```
</details>
## ПодключитьИнтернетПоддержкуПользователей
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Выполняет подключение к сервису Интернет-поддержки: ввод данных
// аутентификации (логина и пароля) для подключения к сервисам
// Интернет-поддержки.
// При успешном завершении возвращается введенный логин через
// объект ОписаниеОповещения.
//
// Параметры:
// ОповещениеОЗавершении - ОписаниеОповещения - обработчик оповещения о
// завершении. В обработчик оповещения возвращается значение:
// Неопределено - при нажатии пользователем кнопки Отмена;
// Структура, при успешном вводе логина и пароля.
// Поля структуры:
// * Логин - Строка - введенный логин;
// ВладелецФормы - ФормаКлиентскогоПриложения - владелец формы подключения
// Интернет-поддержки. Т.к. форма подключения Интернет-поддержки открывается
// в режиме "Блокировать окно владельца", рекомендуется заполнять
// значение этого параметра;
//
Процедура ПодключитьИнтернетПоддержкуПользователей( Экспорт
```
Пример вызова
```bsl
ИнтернетПоддержкаПользователейКлиент.ПодключитьИнтернетПоддержкуПользователей();
```
</details>
## ДоступноПодключениеИнтернетПоддержки
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Определяет, доступно ли текущему пользователю выполнение интерактивного
// подключения Интернет-поддержки в соответствии с текущим режимом работы
// и правами пользователя.
//
// Возвращаемое значение:
// Булево - Истина - интерактивное подключение доступно,
// Ложь - в противном случае.
//
Функция ДоступноПодключениеИнтернетПоддержки() Экспорт
```
Пример вызова
```bsl
Результат = ИнтернетПоддержкаПользователейКлиент.ДоступноПодключениеИнтернетПоддержки()
```
</details>
## ОткрытьСтраницуИнтегрированногоСайта
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает страницу сайта, система аутентификации которого интегрирована с
// Порталом 1С:ИТС.
// В зависимости от текущего режима работы информационной базы и наличия у
// текущего пользователя информационной базы соответствующих прав
// страница сайта может быть открыта с учетными данными пользователя Портала 1С:ИТС,
// для которого подключена Интернет-поддержка.
//
// Параметры:
// URLСтраницыСайта - Строка - URL страницы сайта;
// ЗаголовокОкна - Строка - заголовок окна для методов:
// - ИнтернетПоддержкаПользователейКлиентПереопределяемый.ОткрытьИнтернетСтраницу()
// - ИнтеграцияПодсистемБИПКлиент.ОткрытьИнтернетСтраницу(),
// если используется.
//
Процедура ОткрытьСтраницуИнтегрированногоСайта(URLСтраницыСайта, ЗаголовокОкна = "") Экспорт
```
Пример вызова
```bsl
ИнтернетПоддержкаПользователейКлиент.ОткрытьСтраницуИнтегрированногоСайта(URLСтраницыСайта, ЗаголовокОкна);
```
</details>
## ОткрытьГлавнуюСтраницуПортала
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает главную страницу Портала.
//
Процедура ОткрытьГлавнуюСтраницуПортала() Экспорт
```
Пример вызова
```bsl
ИнтернетПоддержкаПользователейКлиент.ОткрытьГлавнуюСтраницуПортала()
```
</details>
## ОткрытьСтраницуРегистрацииНовогоПользователя
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает страницу Портала для регистрации нового пользователя.
//
Процедура ОткрытьСтраницуРегистрацииНовогоПользователя() Экспорт
```
Пример вызова
```bsl
ИнтернетПоддержкаПользователейКлиент.ОткрытьСтраницуРегистрацииНовогоПользователя()
```
</details>
## ОткрытьСтраницуВосстановленияПароля
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Открывает страницу Портала для восстановления пароля.
//
Процедура ОткрытьСтраницуВосстановленияПароля() Экспорт
```
Пример вызова
```bsl
ИнтернетПоддержкаПользователейКлиент.ОткрытьСтраницуВосстановленияПароля()
```
</details>
## ПриНачалеРаботыСистемы
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// См. процедуру ОбщегоНазначенияКлиентПереопределяемый.ПриНачалеРаботыСистемы.
//
Процедура ПриНачалеРаботыСистемы(Параметры) Экспорт
```
Пример вызова
```bsl
ИнтернетПоддержкаПользователейКлиент.ПриНачалеРаботыСистемы(Параметры)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

46
src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиентПереопределяемый.md Normal file
View File

@ -0,0 +1,46 @@
---
title: Интернет поддержка пользователей клиент переопределяемый
slug: bsp/интернет-поддержка-пользователей-клиент-переопределяемый
---
## ОткрытьИнтернетСтраницу
<details style="margin: 1em 0; padding: 0.5em; border: 1px solid #ccc; border-radius: 6px;">
<summary style="font-weight: bold; cursor: pointer;">Описание, пример вызова</summary>
```bsl
// Переопределяет открытие Интернет-страницы в конфигурации, если для открытия
// Интернет-страниц в конфигурации предусмотрены собственные механизмы.
// Если в конфигурации не используются собственные механизмы для открытия
// Интернет-страниц, тогда необходимо оставить тело процедуры пустым, в
// противном случае параметру СтандартнаяОбработка необходимо присвоить
// значение Ложь.
//
// Параметры:
// АдресСтраницы - Строка - URL-адрес открываемой Интернет-страницы;
// ЗаголовокОкна - Строка - заголовок окна, в котором отображается
// Интернет-страница, если для открытия Интернет-страницы
// используется внутренняя форма конфигурации;
// СтандартнаяОбработка - Булево - в параметре возвращается признак
// необходимости открытия Интернет-страницы стандартным способом.
// Значение по умолчанию - Истина.
//
//@skip-warning
Процедура ОткрытьИнтернетСтраницу(АдресСтраницы, ЗаголовокОкна, СтандартнаяОбработка) Экспорт
```
Пример вызова
```bsl
ИнтернетПоддержкаПользователейКлиентПереопределяемый.ОткрытьИнтернетСтраницу(АдресСтраницы, ЗаголовокОкна, СтандартнаяОбработка)
```
</details>
---
© 2024, **ООО 1С-Софт**
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode).
---

Some files were not shown because too many files have changed in this diff Show More