commit 1587f32ca80013c48828e26c3880977006484b9b Author: wakadakawaka Date: Fri Apr 25 21:42:06 2025 +0500 first diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6240da8 --- /dev/null +++ b/.gitignore @@ -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 diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..22a1505 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,4 @@ +{ + "recommendations": ["astro-build.astro-vscode"], + "unwantedRecommendations": [] +} diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..d642209 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "command": "./node_modules/.bin/astro dev", + "name": "Development server", + "request": "launch", + "type": "node-terminal" + } + ] +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..f9f6d31 --- /dev/null +++ b/README.md @@ -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). diff --git a/astro.config.mjs b/astro.config.mjs new file mode 100644 index 0000000..2ea4eb4 --- /dev/null +++ b/astro.config.mjs @@ -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' }, + }, + ], + }), + ], +}); diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..28508e5 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,6660 @@ +{ + "name": "starlight", + "version": "0.0.1", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "starlight", + "version": "0.0.1", + "dependencies": { + "@astrojs/starlight": "^0.33.1", + "astro": "^5.6.1", + "sharp": "^0.32.5" + } + }, + "node_modules/@astrojs/compiler": { + "version": "2.11.0", + "resolved": "https://registry.npmjs.org/@astrojs/compiler/-/compiler-2.11.0.tgz", + "integrity": "sha512-zZOO7i+JhojO8qmlyR/URui6LyfHJY6m+L9nwyX5GiKD78YoRaZ5tzz6X0fkl+5bD3uwlDHayf6Oe8Fu36RKNg==", + "license": "MIT" + }, + "node_modules/@astrojs/internal-helpers": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/@astrojs/internal-helpers/-/internal-helpers-0.6.1.tgz", + "integrity": "sha512-l5Pqf6uZu31aG+3Lv8nl/3s4DbUzdlxTWDof4pEpto6GUJNhhCbelVi9dEyurOVyqaelwmS9oSyOWOENSfgo9A==", + "license": "MIT" + }, + "node_modules/@astrojs/markdown-remark": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/@astrojs/markdown-remark/-/markdown-remark-6.3.1.tgz", + "integrity": "sha512-c5F5gGrkczUaTVgmMW9g1YMJGzOtRvjjhw6IfGuxarM6ct09MpwysP10US729dy07gg8y+ofVifezvP3BNsWZg==", + "license": "MIT", + "dependencies": { + "@astrojs/internal-helpers": "0.6.1", + "@astrojs/prism": "3.2.0", + "github-slugger": "^2.0.0", + "hast-util-from-html": "^2.0.3", + "hast-util-to-text": "^4.0.2", + "import-meta-resolve": "^4.1.0", + "js-yaml": "^4.1.0", + "mdast-util-definitions": "^6.0.0", + "rehype-raw": "^7.0.0", + "rehype-stringify": "^10.0.1", + "remark-gfm": "^4.0.1", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.1.1", + "remark-smartypants": "^3.0.2", + "shiki": "^3.0.0", + "smol-toml": "^1.3.1", + "unified": "^11.0.5", + "unist-util-remove-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "unist-util-visit-parents": "^6.0.1", + "vfile": "^6.0.3" + } + }, + "node_modules/@astrojs/mdx": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/@astrojs/mdx/-/mdx-4.2.3.tgz", + "integrity": "sha512-oteB88udzzZmix5kWWUMeMJfeB2Dj8g7jy9LVNuTzGlBh3mEkGhQr6FsIR43p0JKCN11fl5J7P/Ev4Q0Nf0KQQ==", + "license": "MIT", + "dependencies": { + "@astrojs/markdown-remark": "6.3.1", + "@mdx-js/mdx": "^3.1.0", + "acorn": "^8.14.1", + "es-module-lexer": "^1.6.0", + "estree-util-visit": "^2.0.0", + "hast-util-to-html": "^9.0.5", + "kleur": "^4.1.5", + "rehype-raw": "^7.0.0", + "remark-gfm": "^4.0.1", + "remark-smartypants": "^3.0.2", + "source-map": "^0.7.4", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.3" + }, + "engines": { + "node": "^18.17.1 || ^20.3.0 || >=22.0.0" + }, + "peerDependencies": { + "astro": "^5.0.0" + } + }, + "node_modules/@astrojs/prism": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/@astrojs/prism/-/prism-3.2.0.tgz", + "integrity": "sha512-GilTHKGCW6HMq7y3BUv9Ac7GMe/MO9gi9GW62GzKtth0SwukCu/qp2wLiGpEujhY+VVhaG9v7kv/5vFzvf4NYw==", + "license": "MIT", + "dependencies": { + "prismjs": "^1.29.0" + }, + "engines": { + "node": "^18.17.1 || ^20.3.0 || >=22.0.0" + } + }, + "node_modules/@astrojs/sitemap": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/@astrojs/sitemap/-/sitemap-3.3.0.tgz", + "integrity": "sha512-nYE4lKQtk+Kbrw/w0G0TTgT724co0jUsU4tPlHY9au5HmTBKbwiCLwO/15b1/y13aZ4Kr9ZbMeMHlXuwn0ty4Q==", + "license": "MIT", + "dependencies": { + "sitemap": "^8.0.0", + "stream-replace-string": "^2.0.0", + "zod": "^3.24.2" + } + }, + "node_modules/@astrojs/starlight": { + "version": "0.33.1", + "resolved": "https://registry.npmjs.org/@astrojs/starlight/-/starlight-0.33.1.tgz", + "integrity": "sha512-YBu9tDOBoEmRZWLoI8jAfO+pON2lEFOcViZrxwv8kpbLn3CDRkcDoP+UeO/Utwb+XVpDGrvjgmyEsqcsq54b2g==", + "license": "MIT", + "dependencies": { + "@astrojs/mdx": "^4.0.5", + "@astrojs/sitemap": "^3.2.1", + "@pagefind/default-ui": "^1.3.0", + "@types/hast": "^3.0.4", + "@types/js-yaml": "^4.0.9", + "@types/mdast": "^4.0.4", + "astro-expressive-code": "^0.40.0", + "bcp-47": "^2.1.0", + "hast-util-from-html": "^2.0.1", + "hast-util-select": "^6.0.2", + "hast-util-to-string": "^3.0.0", + "hastscript": "^9.0.0", + "i18next": "^23.11.5", + "js-yaml": "^4.1.0", + "klona": "^2.0.6", + "mdast-util-directive": "^3.0.0", + "mdast-util-to-markdown": "^2.1.0", + "mdast-util-to-string": "^4.0.0", + "pagefind": "^1.3.0", + "rehype": "^13.0.1", + "rehype-format": "^5.0.0", + "remark-directive": "^3.0.0", + "unified": "^11.0.5", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.2" + }, + "peerDependencies": { + "astro": "^5.1.5" + } + }, + "node_modules/@astrojs/telemetry": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/@astrojs/telemetry/-/telemetry-3.2.0.tgz", + "integrity": "sha512-wxhSKRfKugLwLlr4OFfcqovk+LIFtKwLyGPqMsv+9/ibqqnW3Gv7tBhtKEb0gAyUAC4G9BTVQeQahqnQAhd6IQ==", + "license": "MIT", + "dependencies": { + "ci-info": "^4.1.0", + "debug": "^4.3.7", + "dlv": "^1.1.3", + "dset": "^3.1.4", + "is-docker": "^3.0.0", + "is-wsl": "^3.1.0", + "which-pm-runs": "^1.1.0" + }, + "engines": { + "node": "^18.17.1 || ^20.3.0 || >=22.0.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.25.9.tgz", + "integrity": "sha512-4A/SCr/2KLd5jrtOMFzaKjVtAei3+2r/NChoBNoZ3EyP/+GlhoaEGoWOZUmFmoITP7zOJyHIMm+DYRd8o3PvHA==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.25.9.tgz", + "integrity": "sha512-Ed61U6XJc3CVRfkERJWDz4dJwKe7iLmmJsbOGu9wSloNSFttHV0I8g6UAgb7qnK5ly5bGLPd4oXZlxCdANBOWQ==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.27.0", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.27.0.tgz", + "integrity": "sha512-iaepho73/2Pz7w2eMS0Q5f83+0RKI7i4xmiYeBmDzfRVbQtTOG7Ts0S4HzJVsTMGI9keU8rNfuZr8DKfSt7Yyg==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.27.0" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/runtime": { + "version": "7.27.0", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.27.0.tgz", + "integrity": "sha512-VtPOkrdPHZsKc/clNqyi9WUA8TINkZ4cGk63UUE3u4pmB2k+ZMQRDuIOagv8UVd6j7k0T3+RRIb7beKTebNbcw==", + "license": "MIT", + "dependencies": { + "regenerator-runtime": "^0.14.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/types": { + "version": "7.27.0", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.27.0.tgz", + "integrity": "sha512-H45s8fVLYjbhFH62dIJ3WtmJ6RSPt/3DRO0ZcT2SUiYiQyz3BLVb9ADEnLl91m74aQPS3AzzeajZHYOalWe3bg==", + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.25.9", + "@babel/helper-validator-identifier": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@ctrl/tinycolor": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@ctrl/tinycolor/-/tinycolor-4.1.0.tgz", + "integrity": "sha512-WyOx8cJQ+FQus4Mm4uPIZA64gbk3Wxh0so5Lcii0aJifqwoVOlfFtorjLE0Hen4OYyHZMXDWqMmaQemBhgxFRQ==", + "license": "MIT", + "engines": { + "node": ">=14" + } + }, + "node_modules/@emnapi/runtime": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.4.1.tgz", + "integrity": "sha512-LMshMVP0ZhACNjQNYXiU1iZJ6QCcv0lUdPDPugqGvCGXt5xtRVBPdtA0qU12pEXZzpWAhWlZYptfdAFq10DOVQ==", + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.2.tgz", + "integrity": "sha512-wCIboOL2yXZym2cgm6mlA742s9QeJ8DjGVaL39dLN4rRwrOgOyYSnOaFPhKZGLb2ngj4EyfAFjsNJwPXZvseag==", + "cpu": [ + "ppc64" + ], + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.2.tgz", + "integrity": "sha512-NQhH7jFstVY5x8CKbcfa166GoV0EFkaPkCKBQkdPJFvo5u+nGXLEH/ooniLb3QI8Fk58YAx7nsPLozUWfCBOJA==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.2.tgz", + "integrity": "sha512-5ZAX5xOmTligeBaeNEPnPaeEuah53Id2tX4c2CVP3JaROTH+j4fnfHCkr1PjXMd78hMst+TlkfKcW/DlTq0i4w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.2.tgz", + "integrity": "sha512-Ffcx+nnma8Sge4jzddPHCZVRvIfQ0kMsUsCMcJRHkGJ1cDmhe4SsrYIjLUKn1xpHZybmOqCWwB0zQvsjdEHtkg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.2.tgz", + "integrity": "sha512-MpM6LUVTXAzOvN4KbjzU/q5smzryuoNjlriAIx+06RpecwCkL9JpenNzpKd2YMzLJFOdPqBpuub6eVRP5IgiSA==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.2.tgz", + "integrity": "sha512-5eRPrTX7wFyuWe8FqEFPG2cU0+butQQVNcT4sVipqjLYQjjh8a8+vUTfgBKM88ObB85ahsnTwF7PSIt6PG+QkA==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.2.tgz", + "integrity": "sha512-mLwm4vXKiQ2UTSX4+ImyiPdiHjiZhIaE9QvC7sw0tZ6HoNMjYAqQpGyui5VRIi5sGd+uWq940gdCbY3VLvsO1w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.2.tgz", + "integrity": "sha512-6qyyn6TjayJSwGpm8J9QYYGQcRgc90nmfdUb0O7pp1s4lTY+9D0H9O02v5JqGApUyiHOtkz6+1hZNvNtEhbwRQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.2.tgz", + "integrity": "sha512-UHBRgJcmjJv5oeQF8EpTRZs/1knq6loLxTsjc3nxO9eXAPDLcWW55flrMVc97qFPbmZP31ta1AZVUKQzKTzb0g==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.2.tgz", + "integrity": "sha512-gq/sjLsOyMT19I8obBISvhoYiZIAaGF8JpeXu1u8yPv8BE5HlWYobmlsfijFIZ9hIVGYkbdFhEqC0NvM4kNO0g==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.2.tgz", + "integrity": "sha512-bBYCv9obgW2cBP+2ZWfjYTU+f5cxRoGGQ5SeDbYdFCAZpYWrfjjfYwvUpP8MlKbP0nwZ5gyOU/0aUzZ5HWPuvQ==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.2.tgz", + "integrity": "sha512-SHNGiKtvnU2dBlM5D8CXRFdd+6etgZ9dXfaPCeJtz+37PIUlixvlIhI23L5khKXs3DIzAn9V8v+qb1TRKrgT5w==", + "cpu": [ + "loong64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.2.tgz", + "integrity": "sha512-hDDRlzE6rPeoj+5fsADqdUZl1OzqDYow4TB4Y/3PlKBD0ph1e6uPHzIQcv2Z65u2K0kpeByIyAjCmjn1hJgG0Q==", + "cpu": [ + "mips64el" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.2.tgz", + "integrity": "sha512-tsHu2RRSWzipmUi9UBDEzc0nLc4HtpZEI5Ba+Omms5456x5WaNuiG3u7xh5AO6sipnJ9r4cRWQB2tUjPyIkc6g==", + "cpu": [ + "ppc64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.2.tgz", + "integrity": "sha512-k4LtpgV7NJQOml/10uPU0s4SAXGnowi5qBSjaLWMojNCUICNu7TshqHLAEbkBdAszL5TabfvQ48kK84hyFzjnw==", + "cpu": [ + "riscv64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.2.tgz", + "integrity": "sha512-GRa4IshOdvKY7M/rDpRR3gkiTNp34M0eLTaC1a08gNrh4u488aPhuZOCpkF6+2wl3zAN7L7XIpOFBhnaE3/Q8Q==", + "cpu": [ + "s390x" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.2.tgz", + "integrity": "sha512-QInHERlqpTTZ4FRB0fROQWXcYRD64lAoiegezDunLpalZMjcUcld3YzZmVJ2H/Cp0wJRZ8Xtjtj0cEHhYc/uUg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.2.tgz", + "integrity": "sha512-talAIBoY5M8vHc6EeI2WW9d/CkiO9MQJ0IOWX8hrLhxGbro/vBXJvaQXefW2cP0z0nQVTdQ/eNyGFV1GSKrxfw==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.2.tgz", + "integrity": "sha512-voZT9Z+tpOxrvfKFyfDYPc4DO4rk06qamv1a/fkuzHpiVBMOhpjK+vBmWM8J1eiB3OLSMFYNaOaBNLXGChf5tg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.2.tgz", + "integrity": "sha512-dcXYOC6NXOqcykeDlwId9kB6OkPUxOEqU+rkrYVqJbK2hagWOMrsTGsMr8+rW02M+d5Op5NNlgMmjzecaRf7Tg==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.2.tgz", + "integrity": "sha512-t/TkWwahkH0Tsgoq1Ju7QfgGhArkGLkF1uYz8nQS/PPFlXbP5YgRpqQR3ARRiC2iXoLTWFxc6DJMSK10dVXluw==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.2.tgz", + "integrity": "sha512-cfZH1co2+imVdWCjd+D1gf9NjkchVhhdpgb1q5y6Hcv9TP6Zi9ZG/beI3ig8TvwT9lH9dlxLq5MQBBgwuj4xvA==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.2.tgz", + "integrity": "sha512-7Loyjh+D/Nx/sOTzV8vfbB3GJuHdOQyrOryFdZvPHLf42Tk9ivBU5Aedi7iyX+x6rbn2Mh68T4qq1SDqJBQO5Q==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.2.tgz", + "integrity": "sha512-WRJgsz9un0nqZJ4MfhabxaD9Ft8KioqU3JMinOTvobbX6MOSUigSBlogP8QB3uxpJDsFS6yN+3FDBdqE5lg9kg==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.2.tgz", + "integrity": "sha512-kM3HKb16VIXZyIeVrM1ygYmZBKybX8N4p754bw390wGO3Tf2j4L2/WYL+4suWujpgf6GBYs3jv7TyUivdd05JA==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@expressive-code/core": { + "version": "0.40.2", + "resolved": "https://registry.npmjs.org/@expressive-code/core/-/core-0.40.2.tgz", + "integrity": "sha512-gXY3v7jbgz6nWKvRpoDxK4AHUPkZRuJsM79vHX/5uhV9/qX6Qnctp/U/dMHog/LCVXcuOps+5nRmf1uxQVPb3w==", + "license": "MIT", + "dependencies": { + "@ctrl/tinycolor": "^4.0.4", + "hast-util-select": "^6.0.2", + "hast-util-to-html": "^9.0.1", + "hast-util-to-text": "^4.0.1", + "hastscript": "^9.0.0", + "postcss": "^8.4.38", + "postcss-nested": "^6.0.1", + "unist-util-visit": "^5.0.0", + "unist-util-visit-parents": "^6.0.1" + } + }, + "node_modules/@expressive-code/plugin-frames": { + "version": "0.40.2", + "resolved": "https://registry.npmjs.org/@expressive-code/plugin-frames/-/plugin-frames-0.40.2.tgz", + "integrity": "sha512-aLw5IlDlZWb10Jo/TTDCVsmJhKfZ7FJI83Zo9VDrV0OBlmHAg7klZqw68VDz7FlftIBVAmMby53/MNXPnMjTSQ==", + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.40.2" + } + }, + "node_modules/@expressive-code/plugin-shiki": { + "version": "0.40.2", + "resolved": "https://registry.npmjs.org/@expressive-code/plugin-shiki/-/plugin-shiki-0.40.2.tgz", + "integrity": "sha512-t2HMR5BO6GdDW1c1ISBTk66xO503e/Z8ecZdNcr6E4NpUfvY+MRje+LtrcvbBqMwWBBO8RpVKcam/Uy+1GxwKQ==", + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.40.2", + "shiki": "^1.26.1" + } + }, + "node_modules/@expressive-code/plugin-shiki/node_modules/@shikijs/core": { + "version": "1.29.2", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.29.2.tgz", + "integrity": "sha512-vju0lY9r27jJfOY4Z7+Rt/nIOjzJpZ3y+nYpqtUZInVoXQ/TJZcfGnNOGnKjFdVZb8qexiCuSlZRKcGfhhTTZQ==", + "license": "MIT", + "dependencies": { + "@shikijs/engine-javascript": "1.29.2", + "@shikijs/engine-oniguruma": "1.29.2", + "@shikijs/types": "1.29.2", + "@shikijs/vscode-textmate": "^10.0.1", + "@types/hast": "^3.0.4", + "hast-util-to-html": "^9.0.4" + } + }, + "node_modules/@expressive-code/plugin-shiki/node_modules/@shikijs/engine-javascript": { + "version": "1.29.2", + "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-1.29.2.tgz", + "integrity": "sha512-iNEZv4IrLYPv64Q6k7EPpOCE/nuvGiKl7zxdq0WFuRPF5PAE9PRo2JGq/d8crLusM59BRemJ4eOqrFrC4wiQ+A==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "1.29.2", + "@shikijs/vscode-textmate": "^10.0.1", + "oniguruma-to-es": "^2.2.0" + } + }, + "node_modules/@expressive-code/plugin-shiki/node_modules/@shikijs/engine-oniguruma": { + "version": "1.29.2", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-1.29.2.tgz", + "integrity": "sha512-7iiOx3SG8+g1MnlzZVDYiaeHe7Ez2Kf2HrJzdmGwkRisT7r4rak0e655AcM/tF9JG/kg5fMNYlLLKglbN7gBqA==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "1.29.2", + "@shikijs/vscode-textmate": "^10.0.1" + } + }, + "node_modules/@expressive-code/plugin-shiki/node_modules/@shikijs/langs": { + "version": "1.29.2", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-1.29.2.tgz", + "integrity": "sha512-FIBA7N3LZ+223U7cJDUYd5shmciFQlYkFXlkKVaHsCPgfVLiO+e12FmQE6Tf9vuyEsFe3dIl8qGWKXgEHL9wmQ==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "1.29.2" + } + }, + "node_modules/@expressive-code/plugin-shiki/node_modules/@shikijs/themes": { + "version": "1.29.2", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-1.29.2.tgz", + "integrity": "sha512-i9TNZlsq4uoyqSbluIcZkmPL9Bfi3djVxRnofUHwvx/h6SRW3cwgBC5SML7vsDcWyukY0eCzVN980rqP6qNl9g==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "1.29.2" + } + }, + "node_modules/@expressive-code/plugin-shiki/node_modules/@shikijs/types": { + "version": "1.29.2", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-1.29.2.tgz", + "integrity": "sha512-VJjK0eIijTZf0QSTODEXCqinjBn0joAHQ+aPSBzrv4O2d/QSbsMw+ZeSRx03kV34Hy7NzUvV/7NqfYGRLrASmw==", + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.1", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@expressive-code/plugin-shiki/node_modules/oniguruma-to-es": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/oniguruma-to-es/-/oniguruma-to-es-2.3.0.tgz", + "integrity": "sha512-bwALDxriqfKGfUufKGGepCzu9x7nJQuoRoAFp4AnwehhC2crqrDIAP/uN2qdlsAvSMpeRC3+Yzhqc7hLmle5+g==", + "license": "MIT", + "dependencies": { + "emoji-regex-xs": "^1.0.0", + "regex": "^5.1.1", + "regex-recursion": "^5.1.1" + } + }, + "node_modules/@expressive-code/plugin-shiki/node_modules/regex": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/regex/-/regex-5.1.1.tgz", + "integrity": "sha512-dN5I359AVGPnwzJm2jN1k0W9LPZ+ePvoOeVMMfqIMFz53sSwXkxaJoxr50ptnsC771lK95BnTrVSZxq0b9yCGw==", + "license": "MIT", + "dependencies": { + "regex-utilities": "^2.3.0" + } + }, + "node_modules/@expressive-code/plugin-shiki/node_modules/regex-recursion": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/regex-recursion/-/regex-recursion-5.1.1.tgz", + "integrity": "sha512-ae7SBCbzVNrIjgSbh7wMznPcQel1DNlDtzensnFxpiNpXt1U2ju/bHugH422r+4LAVS1FpW1YCwilmnNsjum9w==", + "license": "MIT", + "dependencies": { + "regex": "^5.1.1", + "regex-utilities": "^2.3.0" + } + }, + "node_modules/@expressive-code/plugin-shiki/node_modules/shiki": { + "version": "1.29.2", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-1.29.2.tgz", + "integrity": "sha512-njXuliz/cP+67jU2hukkxCNuH1yUi4QfdZZY+sMr5PPrIyXSu5iTb/qYC4BiWWB0vZ+7TbdvYUCeL23zpwCfbg==", + "license": "MIT", + "dependencies": { + "@shikijs/core": "1.29.2", + "@shikijs/engine-javascript": "1.29.2", + "@shikijs/engine-oniguruma": "1.29.2", + "@shikijs/langs": "1.29.2", + "@shikijs/themes": "1.29.2", + "@shikijs/types": "1.29.2", + "@shikijs/vscode-textmate": "^10.0.1", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@expressive-code/plugin-text-markers": { + "version": "0.40.2", + "resolved": "https://registry.npmjs.org/@expressive-code/plugin-text-markers/-/plugin-text-markers-0.40.2.tgz", + "integrity": "sha512-/XoLjD67K9nfM4TgDlXAExzMJp6ewFKxNpfUw4F7q5Ecy+IU3/9zQQG/O70Zy+RxYTwKGw2MA9kd7yelsxnSmw==", + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.40.2" + } + }, + "node_modules/@img/sharp-darwin-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-arm64/-/sharp-darwin-arm64-0.33.5.tgz", + "integrity": "sha512-UT4p+iz/2H4twwAoLCqfA9UH5pI6DggwKEGuaPy7nCVQ8ZsiY5PIcrRvD1DzuY3qYL07NtIQcWnBSY/heikIFQ==", + "cpu": [ + "arm64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-darwin-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-x64/-/sharp-darwin-x64-0.33.5.tgz", + "integrity": "sha512-fyHac4jIc1ANYGRDxtiqelIbdWkIuQaI84Mv45KvGRRxSAa7o7d1ZKAOBaYbnepLC1WqxfpimdeWfvqqSGwR2Q==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-libvips-darwin-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-arm64/-/sharp-libvips-darwin-arm64-1.0.4.tgz", + "integrity": "sha512-XblONe153h0O2zuFfTAbQYAX2JhYmDHeWikp1LM9Hul9gVPjFY427k6dFEcOL72O01QxQsWi761svJ/ev9xEDg==", + "cpu": [ + "arm64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-darwin-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-x64/-/sharp-libvips-darwin-x64-1.0.4.tgz", + "integrity": "sha512-xnGR8YuZYfJGmWPvmlunFaWJsb9T/AO2ykoP3Fz/0X5XV2aoYBPkX6xqCQvUTKKiLddarLaxpzNe+b1hjeWHAQ==", + "cpu": [ + "x64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-arm": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm/-/sharp-libvips-linux-arm-1.0.5.tgz", + "integrity": "sha512-gvcC4ACAOPRNATg/ov8/MnbxFDJqf/pDePbBnuBDcjsI8PssmjoKMAz4LtLaVi+OnSb5FK/yIOamqDwGmXW32g==", + "cpu": [ + "arm" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm64/-/sharp-libvips-linux-arm64-1.0.4.tgz", + "integrity": "sha512-9B+taZ8DlyyqzZQnoeIvDVR/2F4EbMepXMc/NdVbkzsJbzkUjhXv/70GQJ7tdLA4YJgNP25zukcxpX2/SueNrA==", + "cpu": [ + "arm64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-s390x": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-s390x/-/sharp-libvips-linux-s390x-1.0.4.tgz", + "integrity": "sha512-u7Wz6ntiSSgGSGcjZ55im6uvTrOxSIS8/dgoVMoiGE9I6JAfU50yH5BoDlYA1tcuGS7g/QNtetJnxA6QEsCVTA==", + "cpu": [ + "s390x" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-x64/-/sharp-libvips-linux-x64-1.0.4.tgz", + "integrity": "sha512-MmWmQ3iPFZr0Iev+BAgVMb3ZyC4KeFc3jFxnNbEPas60e1cIfevbtuyf9nDGIzOaW9PdnDciJm+wFFaTlj5xYw==", + "cpu": [ + "x64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linuxmusl-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-arm64/-/sharp-libvips-linuxmusl-arm64-1.0.4.tgz", + "integrity": "sha512-9Ti+BbTYDcsbp4wfYib8Ctm1ilkugkA/uscUn6UXK1ldpC1JjiXbLfFZtRlBhjPZ5o1NCLiDbg8fhUPKStHoTA==", + "cpu": [ + "arm64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linuxmusl-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-x64/-/sharp-libvips-linuxmusl-x64-1.0.4.tgz", + "integrity": "sha512-viYN1KX9m+/hGkJtvYYp+CCLgnJXwiQB39damAO7WMdKWlIhmYTfHjwSbQeUK/20vY154mwezd9HflVFM1wVSw==", + "cpu": [ + "x64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-linux-arm": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm/-/sharp-linux-arm-0.33.5.tgz", + "integrity": "sha512-JTS1eldqZbJxjvKaAkxhZmBqPRGmxgu+qFKSInv8moZ2AmT5Yib3EQ1c6gp493HvrvV8QgdOXdyaIBrhvFhBMQ==", + "cpu": [ + "arm" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm": "1.0.5" + } + }, + "node_modules/@img/sharp-linux-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm64/-/sharp-linux-arm64-0.33.5.tgz", + "integrity": "sha512-JMVv+AMRyGOHtO1RFBiJy/MBsgz0x4AWrT6QoEVVTyh1E39TrCUpTRI7mx9VksGX4awWASxqCYLCV4wBZHAYxA==", + "cpu": [ + "arm64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-linux-s390x": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-s390x/-/sharp-linux-s390x-0.33.5.tgz", + "integrity": "sha512-y/5PCd+mP4CA/sPDKl2961b+C9d+vPAveS33s6Z3zfASk2j5upL6fXVPZi7ztePZ5CuH+1kW8JtvxgbuXHRa4Q==", + "cpu": [ + "s390x" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-s390x": "1.0.4" + } + }, + "node_modules/@img/sharp-linux-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-x64/-/sharp-linux-x64-0.33.5.tgz", + "integrity": "sha512-opC+Ok5pRNAzuvq1AG0ar+1owsu842/Ab+4qvU879ippJBHvyY5n2mxF1izXqkPYlGuP/M556uh53jRLJmzTWA==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-linuxmusl-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-arm64/-/sharp-linuxmusl-arm64-0.33.5.tgz", + "integrity": "sha512-XrHMZwGQGvJg2V/oRSUfSAfjfPxO+4DkiRh6p2AFjLQztWUuY/o8Mq0eMQVIY7HJ1CDQUJlxGGZRw1a5bqmd1g==", + "cpu": [ + "arm64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-linuxmusl-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-x64/-/sharp-linuxmusl-x64-0.33.5.tgz", + "integrity": "sha512-WT+d/cgqKkkKySYmqoZ8y3pxx7lx9vVejxW/W4DOFMYVSkErR+w7mf2u8m/y4+xHe7yY9DAXQMWQhpnMuFfScw==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-wasm32": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-wasm32/-/sharp-wasm32-0.33.5.tgz", + "integrity": "sha512-ykUW4LVGaMcU9lu9thv85CbRMAwfeadCJHRsg2GmeRa/cJxsVY9Rbd57JcMxBkKHag5U/x7TSBpScF4U8ElVzg==", + "cpu": [ + "wasm32" + ], + "license": "Apache-2.0 AND LGPL-3.0-or-later AND MIT", + "optional": true, + "dependencies": { + "@emnapi/runtime": "^1.2.0" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-ia32": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-ia32/-/sharp-win32-ia32-0.33.5.tgz", + "integrity": "sha512-T36PblLaTwuVJ/zw/LaH0PdZkRz5rd3SmMHX8GSmR7vtNSP5Z6bQkExdSK7xGWyxLw4sUknBuugTelgw2faBbQ==", + "cpu": [ + "ia32" + ], + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-x64/-/sharp-win32-x64-0.33.5.tgz", + "integrity": "sha512-MpY/o8/8kj+EcnxwvrP4aTJSWw/aZ7JIGR4aBeZkZw5B7/Jn+tY9/VNwtcoGmdT7GfggGIU4kygOMSbYnOrAbg==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", + "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==", + "license": "MIT" + }, + "node_modules/@mdx-js/mdx": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@mdx-js/mdx/-/mdx-3.1.0.tgz", + "integrity": "sha512-/QxEhPAvGwbQmy1Px8F899L5Uc2KZ6JtXwlCgJmjSTBedwOZkByYcBG4GceIGPXRDsmfxhHazuS+hlOShRLeDw==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdx": "^2.0.0", + "collapse-white-space": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "estree-util-scope": "^1.0.0", + "estree-walker": "^3.0.0", + "hast-util-to-jsx-runtime": "^2.0.0", + "markdown-extensions": "^2.0.0", + "recma-build-jsx": "^1.0.0", + "recma-jsx": "^1.0.0", + "recma-stringify": "^1.0.0", + "rehype-recma": "^1.0.0", + "remark-mdx": "^3.0.0", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.0.0", + "source-map": "^0.7.0", + "unified": "^11.0.0", + "unist-util-position-from-estree": "^2.0.0", + "unist-util-stringify-position": "^4.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/@oslojs/encoding": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@oslojs/encoding/-/encoding-1.1.0.tgz", + "integrity": "sha512-70wQhgYmndg4GCPxPPxPGevRKqTIJ2Nh4OkiMWmDAVYsTQ+Ta7Sq+rPevXyXGdzr30/qZBnyOalCszoMxlyldQ==", + "license": "MIT" + }, + "node_modules/@pagefind/darwin-arm64": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@pagefind/darwin-arm64/-/darwin-arm64-1.3.0.tgz", + "integrity": "sha512-365BEGl6ChOsauRjyVpBjXybflXAOvoMROw3TucAROHIcdBvXk9/2AmEvGFU0r75+vdQI4LJdJdpH4Y6Yqaj4A==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@pagefind/darwin-x64": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@pagefind/darwin-x64/-/darwin-x64-1.3.0.tgz", + "integrity": "sha512-zlGHA23uuXmS8z3XxEGmbHpWDxXfPZ47QS06tGUq0HDcZjXjXHeLG+cboOy828QIV5FXsm9MjfkP5e4ZNbOkow==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@pagefind/default-ui": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@pagefind/default-ui/-/default-ui-1.3.0.tgz", + "integrity": "sha512-CGKT9ccd3+oRK6STXGgfH+m0DbOKayX6QGlq38TfE1ZfUcPc5+ulTuzDbZUnMo+bubsEOIypm4Pl2iEyzZ1cNg==", + "license": "MIT" + }, + "node_modules/@pagefind/linux-arm64": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@pagefind/linux-arm64/-/linux-arm64-1.3.0.tgz", + "integrity": "sha512-8lsxNAiBRUk72JvetSBXs4WRpYrQrVJXjlRRnOL6UCdBN9Nlsz0t7hWstRk36+JqHpGWOKYiuHLzGYqYAqoOnQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@pagefind/linux-x64": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@pagefind/linux-x64/-/linux-x64-1.3.0.tgz", + "integrity": "sha512-hAvqdPJv7A20Ucb6FQGE6jhjqy+vZ6pf+s2tFMNtMBG+fzcdc91uTw7aP/1Vo5plD0dAOHwdxfkyw0ugal4kcQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@pagefind/windows-x64": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@pagefind/windows-x64/-/windows-x64-1.3.0.tgz", + "integrity": "sha512-BR1bIRWOMqkf8IoU576YDhij1Wd/Zf2kX/kCI0b2qzCKC8wcc2GQJaaRMCpzvCCrmliO4vtJ6RITp/AnoYUUmQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/pluginutils": { + "version": "5.1.4", + "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-5.1.4.tgz", + "integrity": "sha512-USm05zrsFxYLPdWWq+K3STlWiT/3ELn3RcV5hJMghpeAIhxfsUIg6mt12CBJBInWMV4VneoV7SfGv8xIwo2qNQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-walker": "^2.0.2", + "picomatch": "^4.0.2" + }, + "engines": { + "node": ">=14.0.0" + }, + "peerDependencies": { + "rollup": "^1.20.0||^2.0.0||^3.0.0||^4.0.0" + }, + "peerDependenciesMeta": { + "rollup": { + "optional": true + } + } + }, + "node_modules/@rollup/pluginutils/node_modules/estree-walker": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", + "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", + "license": "MIT" + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.40.0.tgz", + "integrity": "sha512-+Fbls/diZ0RDerhE8kyC6hjADCXA1K4yVNlH0EYfd2XjyH0UGgzaQ8MlT0pCXAThfxv3QUAczHaL+qSv1E4/Cg==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.40.0.tgz", + "integrity": "sha512-PPA6aEEsTPRz+/4xxAmaoWDqh67N7wFbgFUJGMnanCFs0TV99M0M8QhhaSCks+n6EbQoFvLQgYOGXxlMGQe/6w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.40.0.tgz", + "integrity": "sha512-GwYOcOakYHdfnjjKwqpTGgn5a6cUX7+Ra2HeNj/GdXvO2VJOOXCiYYlRFU4CubFM67EhbmzLOmACKEfvp3J1kQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.40.0.tgz", + "integrity": "sha512-CoLEGJ+2eheqD9KBSxmma6ld01czS52Iw0e2qMZNpPDlf7Z9mj8xmMemxEucinev4LgHalDPczMyxzbq+Q+EtA==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.40.0.tgz", + "integrity": "sha512-r7yGiS4HN/kibvESzmrOB/PxKMhPTlz+FcGvoUIKYoTyGd5toHp48g1uZy1o1xQvybwwpqpe010JrcGG2s5nkg==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.40.0.tgz", + "integrity": "sha512-mVDxzlf0oLzV3oZOr0SMJ0lSDd3xC4CmnWJ8Val8isp9jRGl5Dq//LLDSPFrasS7pSm6m5xAcKaw3sHXhBjoRw==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.40.0.tgz", + "integrity": "sha512-y/qUMOpJxBMy8xCXD++jeu8t7kzjlOCkoxxajL58G62PJGBZVl/Gwpm7JK9+YvlB701rcQTzjUZ1JgUoPTnoQA==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.40.0.tgz", + "integrity": "sha512-GoCsPibtVdJFPv/BOIvBKO/XmwZLwaNWdyD8TKlXuqp0veo2sHE+A/vpMQ5iSArRUz/uaoj4h5S6Pn0+PdhRjg==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.40.0.tgz", + "integrity": "sha512-L5ZLphTjjAD9leJzSLI7rr8fNqJMlGDKlazW2tX4IUF9P7R5TMQPElpH82Q7eNIDQnQlAyiNVfRPfP2vM5Avvg==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.40.0.tgz", + "integrity": "sha512-ATZvCRGCDtv1Y4gpDIXsS+wfFeFuLwVxyUBSLawjgXK2tRE6fnsQEkE4csQQYWlBlsFztRzCnBvWVfcae/1qxQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loongarch64-gnu": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.40.0.tgz", + "integrity": "sha512-wG9e2XtIhd++QugU5MD9i7OnpaVb08ji3P1y/hNbxrQ3sYEelKJOq1UJ5dXczeo6Hj2rfDEL5GdtkMSVLa/AOg==", + "cpu": [ + "loong64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.40.0.tgz", + "integrity": "sha512-vgXfWmj0f3jAUvC7TZSU/m/cOE558ILWDzS7jBhiCAFpY2WEBn5jqgbqvmzlMjtp8KlLcBlXVD2mkTSEQE6Ixw==", + "cpu": [ + "ppc64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.40.0.tgz", + "integrity": "sha512-uJkYTugqtPZBS3Z136arevt/FsKTF/J9dEMTX/cwR7lsAW4bShzI2R0pJVw+hcBTWF4dxVckYh72Hk3/hWNKvA==", + "cpu": [ + "riscv64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.40.0.tgz", + "integrity": "sha512-rKmSj6EXQRnhSkE22+WvrqOqRtk733x3p5sWpZilhmjnkHkpeCgWsFFo0dGnUGeA+OZjRl3+VYq+HyCOEuwcxQ==", + "cpu": [ + "riscv64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.40.0.tgz", + "integrity": "sha512-SpnYlAfKPOoVsQqmTFJ0usx0z84bzGOS9anAC0AZ3rdSo3snecihbhFTlJZ8XMwzqAcodjFU4+/SM311dqE5Sw==", + "cpu": [ + "s390x" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.40.0.tgz", + "integrity": "sha512-RcDGMtqF9EFN8i2RYN2W+64CdHruJ5rPqrlYw+cgM3uOVPSsnAQps7cpjXe9be/yDp8UC7VLoCoKC8J3Kn2FkQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.40.0.tgz", + "integrity": "sha512-HZvjpiUmSNx5zFgwtQAV1GaGazT2RWvqeDi0hV+AtC8unqqDSsaFjPxfsO6qPtKRRg25SisACWnJ37Yio8ttaw==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.40.0.tgz", + "integrity": "sha512-UtZQQI5k/b8d7d3i9AZmA/t+Q4tk3hOC0tMOMSq2GlMYOfxbesxG4mJSeDp0EHs30N9bsfwUvs3zF4v/RzOeTQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.40.0.tgz", + "integrity": "sha512-+m03kvI2f5syIqHXCZLPVYplP8pQch9JHyXKZ3AGMKlg8dCyr2PKHjwRLiW53LTrN/Nc3EqHOKxUxzoSPdKddA==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.40.0.tgz", + "integrity": "sha512-lpPE1cLfP5oPzVjKMx10pgBmKELQnFJXHgvtHCtuJWOv8MxqdEIMNtgHgBFf7Ea2/7EuVwa9fodWUfXAlXZLZQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@shikijs/core": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-3.2.2.tgz", + "integrity": "sha512-yvlSKVMLjddAGBa2Yu+vUZxuu3sClOWW1AG+UtJkvejYuGM5BVL35s6Ijiwb75O9QdEx6IkMxinHZSi8ZyrBaA==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.2.2", + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4", + "hast-util-to-html": "^9.0.5" + } + }, + "node_modules/@shikijs/engine-javascript": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-3.2.2.tgz", + "integrity": "sha512-tlDKfhWpF4jKLUyVAnmL+ggIC+0VyteNsUpBzh1iwWLZu4i+PelIRr0TNur6pRRo5UZIv3ss/PLMuwahg9S2hg==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.2.2", + "@shikijs/vscode-textmate": "^10.0.2", + "oniguruma-to-es": "^4.1.0" + } + }, + "node_modules/@shikijs/engine-oniguruma": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.2.2.tgz", + "integrity": "sha512-vyXRnWVCSvokwbaUD/8uPn6Gqsf5Hv7XwcW4AgiU4Z2qwy19sdr6VGzMdheKKN58tJOOe5MIKiNb901bgcUXYQ==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.2.2", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.2.2.tgz", + "integrity": "sha512-NY0Urg2dV9ETt3JIOWoMPuoDNwte3geLZ4M1nrPHbkDS8dWMpKcEwlqiEIGqtwZNmt5gKyWpR26ln2Bg2ecPgw==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.2.2" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.2.2.tgz", + "integrity": "sha512-Zuq4lgAxVKkb0FFdhHSdDkALuRpsj1so1JdihjKNQfgM78EHxV2JhO10qPsMrm01FkE3mDRTdF68wfmsqjt6HA==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.2.2" + } + }, + "node_modules/@shikijs/types": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.2.2.tgz", + "integrity": "sha512-a5TiHk7EH5Lso8sHcLHbVNNhWKP0Wi3yVnXnu73g86n3WoDgEra7n3KszyeCGuyoagspQ2fzvy4cpSc8pKhb0A==", + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@shikijs/vscode-textmate": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", + "license": "MIT" + }, + "node_modules/@types/debug": { + "version": "4.1.12", + "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.12.tgz", + "integrity": "sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==", + "license": "MIT", + "dependencies": { + "@types/ms": "*" + } + }, + "node_modules/@types/estree": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.7.tgz", + "integrity": "sha512-w28IoSUCJpidD/TGviZwwMJckNESJZXFu7NBZ5YJ4mEUnNraUn9Pm8HSZm/jDF1pDWYKspWE7oVphigUPRakIQ==", + "license": "MIT" + }, + "node_modules/@types/estree-jsx": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree-jsx/-/estree-jsx-1.0.5.tgz", + "integrity": "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg==", + "license": "MIT", + "dependencies": { + "@types/estree": "*" + } + }, + "node_modules/@types/hast": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", + "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/js-yaml": { + "version": "4.0.9", + "resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-4.0.9.tgz", + "integrity": "sha512-k4MGaQl5TGo/iipqb2UDG2UwjXziSWkh0uysQelTlJpX1qGlpUZYm8PnO4DxG1qBomtJUdYJ6qR6xdIah10JLg==", + "license": "MIT" + }, + "node_modules/@types/mdast": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.4.tgz", + "integrity": "sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/mdx": { + "version": "2.0.13", + "resolved": "https://registry.npmjs.org/@types/mdx/-/mdx-2.0.13.tgz", + "integrity": "sha512-+OWZQfAYyio6YkJb3HLxDrvnx6SWWDbC0zVPfBRzUk0/nqoDyf6dNxQi3eArPe8rJ473nobTMQ/8Zk+LxJ+Yuw==", + "license": "MIT" + }, + "node_modules/@types/ms": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@types/ms/-/ms-2.1.0.tgz", + "integrity": "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==", + "license": "MIT" + }, + "node_modules/@types/nlcst": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@types/nlcst/-/nlcst-2.0.3.tgz", + "integrity": "sha512-vSYNSDe6Ix3q+6Z7ri9lyWqgGhJTmzRjZRqyq15N0Z/1/UnVsno9G/N40NBijoYx2seFDIl0+B2mgAb9mezUCA==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/node": { + "version": "22.14.1", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.14.1.tgz", + "integrity": "sha512-u0HuPQwe/dHrItgHHpmw3N2fYCR6x4ivMNbPHRkBVP4CvN+kiRrKHWk3i8tXiO/joPwXLMYvF9TTF0eqgHIuOw==", + "license": "MIT", + "dependencies": { + "undici-types": "~6.21.0" + } + }, + "node_modules/@types/sax": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.7.tgz", + "integrity": "sha512-rO73L89PJxeYM3s3pPPjiPgVVcymqU490g0YO5n5By0k2Erzj6tay/4lr1CHAAU4JyOWd1rpQ8bCf6cZfHU96A==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/unist": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "license": "MIT" + }, + "node_modules/@ungap/structured-clone": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.0.tgz", + "integrity": "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==", + "license": "ISC" + }, + "node_modules/acorn": { + "version": "8.14.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.1.tgz", + "integrity": "sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg==", + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "license": "MIT", + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/ansi-align": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", + "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", + "license": "ISC", + "dependencies": { + "string-width": "^4.1.0" + } + }, + "node_modules/ansi-align/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-align/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/ansi-align/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-align/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-regex": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz", + "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/ansi-styles": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", + "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/anymatch": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", + "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "license": "ISC", + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/anymatch/node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/arg": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz", + "integrity": "sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==", + "license": "MIT" + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" + }, + "node_modules/aria-query": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.2.tgz", + "integrity": "sha512-COROpnaoap1E2F000S62r6A60uHZnmlvomhfyT2DlTcrY1OrBKn2UhH7qn5wTC9zMvD0AY7csdPSNwKP+7WiQw==", + "license": "Apache-2.0", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/array-iterate": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/array-iterate/-/array-iterate-2.0.1.tgz", + "integrity": "sha512-I1jXZMjAgCMmxT4qxXfPXa6SthSoE8h6gkSI9BGGNv8mP8G/v0blc+qFnZu6K42vTOiuME596QaLO0TP3Lk0xg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/astring": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/astring/-/astring-1.9.0.tgz", + "integrity": "sha512-LElXdjswlqjWrPpJFg1Fx4wpkOCxj1TDHlSV4PlaRxHGWko024xICaa97ZkMfs6DRKlCguiAI+rbXv5GWwXIkg==", + "license": "MIT", + "bin": { + "astring": "bin/astring" + } + }, + "node_modules/astro": { + "version": "5.6.1", + "resolved": "https://registry.npmjs.org/astro/-/astro-5.6.1.tgz", + "integrity": "sha512-aQ2TV7wIf+q2Oi6gGWMINHWEAZqoP0eH6/mihodfTJYATPWyd03JIGVfjtYUJlkNdNSKxDXwEe/r/Zx4CZ1FPg==", + "license": "MIT", + "dependencies": { + "@astrojs/compiler": "^2.11.0", + "@astrojs/internal-helpers": "0.6.1", + "@astrojs/markdown-remark": "6.3.1", + "@astrojs/telemetry": "3.2.0", + "@oslojs/encoding": "^1.1.0", + "@rollup/pluginutils": "^5.1.4", + "acorn": "^8.14.1", + "aria-query": "^5.3.2", + "axobject-query": "^4.1.0", + "boxen": "8.0.1", + "ci-info": "^4.2.0", + "clsx": "^2.1.1", + "common-ancestor-path": "^1.0.1", + "cookie": "^1.0.2", + "cssesc": "^3.0.0", + "debug": "^4.4.0", + "deterministic-object-hash": "^2.0.2", + "devalue": "^5.1.1", + "diff": "^5.2.0", + "dlv": "^1.1.3", + "dset": "^3.1.4", + "es-module-lexer": "^1.6.0", + "esbuild": "^0.25.0", + "estree-walker": "^3.0.3", + "flattie": "^1.1.1", + "github-slugger": "^2.0.0", + "html-escaper": "3.0.3", + "http-cache-semantics": "^4.1.1", + "js-yaml": "^4.1.0", + "kleur": "^4.1.5", + "magic-string": "^0.30.17", + "magicast": "^0.3.5", + "mrmime": "^2.0.1", + "neotraverse": "^0.6.18", + "p-limit": "^6.2.0", + "p-queue": "^8.1.0", + "package-manager-detector": "^1.1.0", + "picomatch": "^4.0.2", + "prompts": "^2.4.2", + "rehype": "^13.0.2", + "semver": "^7.7.1", + "shiki": "^3.2.1", + "tinyexec": "^0.3.2", + "tinyglobby": "^0.2.12", + "tsconfck": "^3.1.5", + "ultrahtml": "^1.6.0", + "unist-util-visit": "^5.0.0", + "unstorage": "^1.15.0", + "vfile": "^6.0.3", + "vite": "^6.2.4", + "vitefu": "^1.0.6", + "xxhash-wasm": "^1.1.0", + "yargs-parser": "^21.1.1", + "yocto-spinner": "^0.2.1", + "zod": "^3.24.2", + "zod-to-json-schema": "^3.24.5", + "zod-to-ts": "^1.2.0" + }, + "bin": { + "astro": "astro.js" + }, + "engines": { + "node": "^18.17.1 || ^20.3.0 || >=22.0.0", + "npm": ">=9.6.5", + "pnpm": ">=7.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/astrodotbuild" + }, + "optionalDependencies": { + "sharp": "^0.33.3" + } + }, + "node_modules/astro-expressive-code": { + "version": "0.40.2", + "resolved": "https://registry.npmjs.org/astro-expressive-code/-/astro-expressive-code-0.40.2.tgz", + "integrity": "sha512-yJMQId0yXSAbW9I6yqvJ3FcjKzJ8zRL7elbJbllkv1ZJPlsI0NI83Pxn1YL1IapEM347EvOOkSW2GL+2+NO61w==", + "license": "MIT", + "dependencies": { + "rehype-expressive-code": "^0.40.2" + }, + "peerDependencies": { + "astro": "^4.0.0-beta || ^5.0.0-beta || ^3.3.0" + } + }, + "node_modules/astro/node_modules/sharp": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.33.5.tgz", + "integrity": "sha512-haPVm1EkS9pgvHrQ/F3Xy+hgcuMV0Wm9vfIBSiwZ05k+xgb0PkBQpGsAA/oWdDobNaZTH5ppvHtzCFbnSEwHVw==", + "hasInstallScript": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "color": "^4.2.3", + "detect-libc": "^2.0.3", + "semver": "^7.6.3" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-darwin-arm64": "0.33.5", + "@img/sharp-darwin-x64": "0.33.5", + "@img/sharp-libvips-darwin-arm64": "1.0.4", + "@img/sharp-libvips-darwin-x64": "1.0.4", + "@img/sharp-libvips-linux-arm": "1.0.5", + "@img/sharp-libvips-linux-arm64": "1.0.4", + "@img/sharp-libvips-linux-s390x": "1.0.4", + "@img/sharp-libvips-linux-x64": "1.0.4", + "@img/sharp-libvips-linuxmusl-arm64": "1.0.4", + "@img/sharp-libvips-linuxmusl-x64": "1.0.4", + "@img/sharp-linux-arm": "0.33.5", + "@img/sharp-linux-arm64": "0.33.5", + "@img/sharp-linux-s390x": "0.33.5", + "@img/sharp-linux-x64": "0.33.5", + "@img/sharp-linuxmusl-arm64": "0.33.5", + "@img/sharp-linuxmusl-x64": "0.33.5", + "@img/sharp-wasm32": "0.33.5", + "@img/sharp-win32-ia32": "0.33.5", + "@img/sharp-win32-x64": "0.33.5" + } + }, + "node_modules/axobject-query": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-4.1.0.tgz", + "integrity": "sha512-qIj0G9wZbMGNLjLmg1PT6v2mE9AH2zlnADJD/2tC6E00hgmhUOfEB6greHPAfLRSufHqROIUTkw6E+M3lH0PTQ==", + "license": "Apache-2.0", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/b4a": { + "version": "1.6.7", + "resolved": "https://registry.npmjs.org/b4a/-/b4a-1.6.7.tgz", + "integrity": "sha512-OnAYlL5b7LEkALw87fUVafQw5rVR9RjwGd4KUwNQ6DrrNmaVaUCgLipfVlzrPQ4tWOR9P0IXGNOx50jYCCdSJg==", + "license": "Apache-2.0" + }, + "node_modules/bail": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/bail/-/bail-2.0.2.tgz", + "integrity": "sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/bare-events": { + "version": "2.5.4", + "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.5.4.tgz", + "integrity": "sha512-+gFfDkR8pj4/TrWCGUGWmJIkBwuxPS5F+a5yWjOHQt2hHvNZd5YLzadjmDUtFmMM4y429bnKLa8bYBMHcYdnQA==", + "license": "Apache-2.0", + "optional": true + }, + "node_modules/bare-fs": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/bare-fs/-/bare-fs-4.1.2.tgz", + "integrity": "sha512-8wSeOia5B7LwD4+h465y73KOdj5QHsbbuoUfPBi+pXgFJIPuG7SsiOdJuijWMyfid49eD+WivpfY7KT8gbAzBA==", + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "bare-events": "^2.5.4", + "bare-path": "^3.0.0", + "bare-stream": "^2.6.4" + }, + "engines": { + "bare": ">=1.16.0" + }, + "peerDependencies": { + "bare-buffer": "*" + }, + "peerDependenciesMeta": { + "bare-buffer": { + "optional": true + } + } + }, + "node_modules/bare-os": { + "version": "3.6.1", + "resolved": "https://registry.npmjs.org/bare-os/-/bare-os-3.6.1.tgz", + "integrity": "sha512-uaIjxokhFidJP+bmmvKSgiMzj2sV5GPHaZVAIktcxcpCyBFFWO+YlikVAdhmUo2vYFvFhOXIAlldqV29L8126g==", + "license": "Apache-2.0", + "optional": true, + "engines": { + "bare": ">=1.14.0" + } + }, + "node_modules/bare-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/bare-path/-/bare-path-3.0.0.tgz", + "integrity": "sha512-tyfW2cQcB5NN8Saijrhqn0Zh7AnFNsnczRcuWODH0eYAXBsJ5gVxAUuNr7tsHSC6IZ77cA0SitzT+s47kot8Mw==", + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "bare-os": "^3.0.1" + } + }, + "node_modules/bare-stream": { + "version": "2.6.5", + "resolved": "https://registry.npmjs.org/bare-stream/-/bare-stream-2.6.5.tgz", + "integrity": "sha512-jSmxKJNJmHySi6hC42zlZnq00rga4jjxcgNZjY9N5WlOe/iOoGRtdwGsHzQv2RlH2KOYMwGUXhf2zXd32BA9RA==", + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "streamx": "^2.21.0" + }, + "peerDependencies": { + "bare-buffer": "*", + "bare-events": "*" + }, + "peerDependenciesMeta": { + "bare-buffer": { + "optional": true + }, + "bare-events": { + "optional": true + } + } + }, + "node_modules/base-64": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/base-64/-/base-64-1.0.0.tgz", + "integrity": "sha512-kwDPIFCGx0NZHog36dj+tHiwP4QMzsZ3AgMViUBKI0+V5n4U0ufTCUMhnQ04diaRI8EX/QcPfql7zlhZ7j4zgg==", + "license": "MIT" + }, + "node_modules/base64-js": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/bcp-47": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/bcp-47/-/bcp-47-2.1.0.tgz", + "integrity": "sha512-9IIS3UPrvIa1Ej+lVDdDwO7zLehjqsaByECw0bu2RRGP73jALm6FYbzI5gWbgHLvNdkvfXB5YrSbocZdOS0c0w==", + "license": "MIT", + "dependencies": { + "is-alphabetical": "^2.0.0", + "is-alphanumerical": "^2.0.0", + "is-decimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/bcp-47-match": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/bcp-47-match/-/bcp-47-match-2.0.3.tgz", + "integrity": "sha512-JtTezzbAibu8G0R9op9zb3vcWZd9JF6M0xOYGPn0fNCd7wOpRB1mU2mH9T8gaBGbAAyIIVgB2G7xG0GP98zMAQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/bl": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", + "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", + "license": "MIT", + "dependencies": { + "buffer": "^5.5.0", + "inherits": "^2.0.4", + "readable-stream": "^3.4.0" + } + }, + "node_modules/boolbase": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", + "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==", + "license": "ISC" + }, + "node_modules/boxen": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-8.0.1.tgz", + "integrity": "sha512-F3PH5k5juxom4xktynS7MoFY+NUWH5LC4CnH11YB8NPew+HLpmBLCybSAEyb2F+4pRXhuhWqFesoQd6DAyc2hw==", + "license": "MIT", + "dependencies": { + "ansi-align": "^3.0.1", + "camelcase": "^8.0.0", + "chalk": "^5.3.0", + "cli-boxes": "^3.0.0", + "string-width": "^7.2.0", + "type-fest": "^4.21.0", + "widest-line": "^5.0.0", + "wrap-ansi": "^9.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/buffer": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz", + "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "base64-js": "^1.3.1", + "ieee754": "^1.1.13" + } + }, + "node_modules/camelcase": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-8.0.0.tgz", + "integrity": "sha512-8WB3Jcas3swSvjIeA2yvCJ+Miyz5l1ZmB6HFb9R1317dt9LCQoswg/BGrmAmkWVEszSrrg4RwmO46qIm2OEnSA==", + "license": "MIT", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ccount": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz", + "integrity": "sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/chalk": { + "version": "5.4.1", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.4.1.tgz", + "integrity": "sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w==", + "license": "MIT", + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/character-entities": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-2.0.2.tgz", + "integrity": "sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-html4": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-2.1.0.tgz", + "integrity": "sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-legacy": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz", + "integrity": "sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-reference-invalid": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz", + "integrity": "sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/chokidar": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-4.0.3.tgz", + "integrity": "sha512-Qgzu8kfBvo+cA4962jnP1KkS6Dop5NS6g7R5LFYJr4b8Ub94PPQXUksCw9PvXoeXPRRddRNC5C1JQUR2SMGtnA==", + "license": "MIT", + "dependencies": { + "readdirp": "^4.0.1" + }, + "engines": { + "node": ">= 14.16.0" + }, + "funding": { + "url": "https://paulmillr.com/funding/" + } + }, + "node_modules/chownr": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/chownr/-/chownr-1.1.4.tgz", + "integrity": "sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg==", + "license": "ISC" + }, + "node_modules/ci-info": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-4.2.0.tgz", + "integrity": "sha512-cYY9mypksY8NRqgDB1XD1RiJL338v/551niynFTGkZOO2LHuB2OmOYxDIe/ttN9AHwrqdum1360G3ald0W9kCg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/sibiraj-s" + } + ], + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/cli-boxes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", + "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/clsx": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz", + "integrity": "sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/collapse-white-space": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/collapse-white-space/-/collapse-white-space-2.1.0.tgz", + "integrity": "sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/color": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/color/-/color-4.2.3.tgz", + "integrity": "sha512-1rXeuUUiGGrykh+CeBdu5Ie7OJwinCgQY0bc7GCRxy5xVHy+moaqkpL/jqQq0MtQOeYcrqEz4abc5f0KtU7W4A==", + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1", + "color-string": "^1.9.0" + }, + "engines": { + "node": ">=12.5.0" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "license": "MIT" + }, + "node_modules/color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "license": "MIT", + "dependencies": { + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" + } + }, + "node_modules/comma-separated-tokens": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", + "integrity": "sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/common-ancestor-path": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/common-ancestor-path/-/common-ancestor-path-1.0.1.tgz", + "integrity": "sha512-L3sHRo1pXXEqX8VU28kfgUY+YGsk09hPqZiZmLacNib6XNTCM8ubYeT7ryXQw8asB1sKgcU5lkB7ONug08aB8w==", + "license": "ISC" + }, + "node_modules/cookie": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-1.0.2.tgz", + "integrity": "sha512-9Kr/j4O16ISv8zBBhJoi4bXOYNTkFLOqSL3UDB0njXxCXNezjeyVrJyGOWtgfs/q2km1gwBcfH8q1yEGoMYunA==", + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/cookie-es": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/cookie-es/-/cookie-es-1.2.2.tgz", + "integrity": "sha512-+W7VmiVINB+ywl1HGXJXmrqkOhpKrIiVZV6tQuV54ZyQC7MMuBt81Vc336GMLoHBq5hV/F9eXgt5Mnx0Rha5Fg==", + "license": "MIT" + }, + "node_modules/crossws": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/crossws/-/crossws-0.3.4.tgz", + "integrity": "sha512-uj0O1ETYX1Bh6uSgktfPvwDiPYGQ3aI4qVsaC/LWpkIzGj1nUYm5FK3K+t11oOlpN01lGbprFCH4wBlKdJjVgw==", + "license": "MIT", + "dependencies": { + "uncrypto": "^0.1.3" + } + }, + "node_modules/css-selector-parser": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/css-selector-parser/-/css-selector-parser-3.1.2.tgz", + "integrity": "sha512-WfUcL99xWDs7b3eZPoRszWVfbNo8ErCF15PTvVROjkShGlAfjIkG6hlfj/sl6/rfo5Q9x9ryJ3VqVnAZDA+gcw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/mdevils" + }, + { + "type": "patreon", + "url": "https://patreon.com/mdevils" + } + ], + "license": "MIT" + }, + "node_modules/cssesc": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz", + "integrity": "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==", + "license": "MIT", + "bin": { + "cssesc": "bin/cssesc" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/debug": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz", + "integrity": "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==", + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/decode-named-character-reference": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.1.0.tgz", + "integrity": "sha512-Wy+JTSbFThEOXQIR2L6mxJvEs+veIzpmqD7ynWxMXGpnk3smkHQOp6forLdHsKpAMW9iJpaBBIxz285t1n1C3w==", + "license": "MIT", + "dependencies": { + "character-entities": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/decompress-response": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz", + "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==", + "license": "MIT", + "dependencies": { + "mimic-response": "^3.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/deep-extend": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "license": "MIT", + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/defu": { + "version": "6.1.4", + "resolved": "https://registry.npmjs.org/defu/-/defu-6.1.4.tgz", + "integrity": "sha512-mEQCMmwJu317oSz8CwdIOdwf3xMif1ttiM8LTufzc3g6kR+9Pe236twL8j3IYT1F7GfRgGcW6MWxzZjLIkuHIg==", + "license": "MIT" + }, + "node_modules/dequal": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", + "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/destr": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/destr/-/destr-2.0.5.tgz", + "integrity": "sha512-ugFTXCtDZunbzasqBxrK93Ik/DRYsO6S/fedkWEMKqt04xZ4csmnmwGDBAb07QWNaGMAmnTIemsYZCksjATwsA==", + "license": "MIT" + }, + "node_modules/detect-libc": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.0.3.tgz", + "integrity": "sha512-bwy0MGW55bG41VqxxypOsdSdGqLwXPI/focwgTYCFMbdUiBAxLg9CFzG08sz2aqzknwiX7Hkl0bQENjg8iLByw==", + "license": "Apache-2.0", + "engines": { + "node": ">=8" + } + }, + "node_modules/deterministic-object-hash": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/deterministic-object-hash/-/deterministic-object-hash-2.0.2.tgz", + "integrity": "sha512-KxektNH63SrbfUyDiwXqRb1rLwKt33AmMv+5Nhsw1kqZ13SJBRTgZHtGbE+hH3a1mVW1cz+4pqSWVPAtLVXTzQ==", + "license": "MIT", + "dependencies": { + "base-64": "^1.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/devalue": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/devalue/-/devalue-5.1.1.tgz", + "integrity": "sha512-maua5KUiapvEwiEAe+XnlZ3Rh0GD+qI1J/nb9vrJc3muPXvcF/8gXYTWF76+5DAqHyDUtOIImEuo0YKE9mshVw==", + "license": "MIT" + }, + "node_modules/devlop": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", + "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", + "license": "MIT", + "dependencies": { + "dequal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/diff": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-5.2.0.tgz", + "integrity": "sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/direction": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/direction/-/direction-2.0.1.tgz", + "integrity": "sha512-9S6m9Sukh1cZNknO1CWAr2QAWsbKLafQiyM5gZ7VgXHeuaoUwffKN4q6NC4A/Mf9iiPlOXQEKW/Mv/mh9/3YFA==", + "license": "MIT", + "bin": { + "direction": "cli.js" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/dlv": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/dlv/-/dlv-1.1.3.tgz", + "integrity": "sha512-+HlytyjlPKnIG8XuRG8WvmBP8xs8P71y+SKKS6ZXWoEgLuePxtDoUEiH7WkdePWrQ5JBpE6aoVqfZfJUQkjXwA==", + "license": "MIT" + }, + "node_modules/dset": { + "version": "3.1.4", + "resolved": "https://registry.npmjs.org/dset/-/dset-3.1.4.tgz", + "integrity": "sha512-2QF/g9/zTaPDc3BjNcVTGoBbXBgYfMTTceLaYcFJ/W9kggFUkhxD/hMEeuLKbugyef9SqAx8cpgwlIP/jinUTA==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/emoji-regex": { + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.4.0.tgz", + "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==", + "license": "MIT" + }, + "node_modules/emoji-regex-xs": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex-xs/-/emoji-regex-xs-1.0.0.tgz", + "integrity": "sha512-LRlerrMYoIDrT6jgpeZ2YYl/L8EulRTt5hQcYjy5AInh7HWXKimpqx68aknBFpGL2+/IcogTcaydJEgaTmOpDg==", + "license": "MIT" + }, + "node_modules/end-of-stream": { + "version": "1.4.4", + "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", + "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", + "license": "MIT", + "dependencies": { + "once": "^1.4.0" + } + }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/es-module-lexer": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.6.0.tgz", + "integrity": "sha512-qqnD1yMU6tk/jnaMosogGySTZP8YtUgAffA9nMN+E/rjxcfRQ6IEk7IiozUjgxKoFHBGjTLnrHB/YC45r/59EQ==", + "license": "MIT" + }, + "node_modules/esast-util-from-estree": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/esast-util-from-estree/-/esast-util-from-estree-2.0.0.tgz", + "integrity": "sha512-4CyanoAudUSBAn5K13H4JhsMH6L9ZP7XbLVe/dKybkxMO7eDyLsT8UHl9TRNrU2Gr9nz+FovfSIjuXWJ81uVwQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-visit": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/esast-util-from-js": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/esast-util-from-js/-/esast-util-from-js-2.0.1.tgz", + "integrity": "sha512-8Ja+rNJ0Lt56Pcf3TAmpBZjmx8ZcK5Ts4cAzIOjsjevg9oSXJnl6SUQ2EevU8tv3h6ZLWmoKL5H4fgWvdvfETw==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "acorn": "^8.0.0", + "esast-util-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/esbuild": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.2.tgz", + "integrity": "sha512-16854zccKPnC+toMywC+uKNeYSv+/eXkevRAfwRD/G9Cleq66m8XFIrigkbvauLLlCfDL45Q2cWegSg53gGBnQ==", + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.25.2", + "@esbuild/android-arm": "0.25.2", + "@esbuild/android-arm64": "0.25.2", + "@esbuild/android-x64": "0.25.2", + "@esbuild/darwin-arm64": "0.25.2", + "@esbuild/darwin-x64": "0.25.2", + "@esbuild/freebsd-arm64": "0.25.2", + "@esbuild/freebsd-x64": "0.25.2", + "@esbuild/linux-arm": "0.25.2", + "@esbuild/linux-arm64": "0.25.2", + "@esbuild/linux-ia32": "0.25.2", + "@esbuild/linux-loong64": "0.25.2", + "@esbuild/linux-mips64el": "0.25.2", + "@esbuild/linux-ppc64": "0.25.2", + "@esbuild/linux-riscv64": "0.25.2", + "@esbuild/linux-s390x": "0.25.2", + "@esbuild/linux-x64": "0.25.2", + "@esbuild/netbsd-arm64": "0.25.2", + "@esbuild/netbsd-x64": "0.25.2", + "@esbuild/openbsd-arm64": "0.25.2", + "@esbuild/openbsd-x64": "0.25.2", + "@esbuild/sunos-x64": "0.25.2", + "@esbuild/win32-arm64": "0.25.2", + "@esbuild/win32-ia32": "0.25.2", + "@esbuild/win32-x64": "0.25.2" + } + }, + "node_modules/escape-string-regexp": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", + "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/estree-util-attach-comments": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-attach-comments/-/estree-util-attach-comments-3.0.0.tgz", + "integrity": "sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-build-jsx": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/estree-util-build-jsx/-/estree-util-build-jsx-3.0.1.tgz", + "integrity": "sha512-8U5eiL6BTrPxp/CHbs2yMgP8ftMhR5ww1eIKoWRMlqvltHF8fZn5LRDvTKuxD3DUn+shRbLGqXemcP51oFCsGQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "estree-walker": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-is-identifier-name": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-is-identifier-name/-/estree-util-is-identifier-name-3.0.0.tgz", + "integrity": "sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-scope": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/estree-util-scope/-/estree-util-scope-1.0.0.tgz", + "integrity": "sha512-2CAASclonf+JFWBNJPndcOpA8EMJwa0Q8LUFJEKqXLW6+qBvbFZuF5gItbQOs/umBUkjviCSDCbBwU2cXbmrhQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-to-js": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/estree-util-to-js/-/estree-util-to-js-2.0.0.tgz", + "integrity": "sha512-WDF+xj5rRWmD5tj6bIqRi6CkLIXbbNQUcxQHzGysQzvHmdYG2G7p/Tf0J0gpxGgkeMZNTIjT/AoSvC9Xehcgdg==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "astring": "^1.8.0", + "source-map": "^0.7.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-visit": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/estree-util-visit/-/estree-util-visit-2.0.0.tgz", + "integrity": "sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/eventemitter3": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-5.0.1.tgz", + "integrity": "sha512-GWkBvjiSZK87ELrYOSESUYeVIc9mvLLf/nXalMOS5dYrgZq9o5OVkbZAVM06CVxYsCwH9BDZFPlQTlPA1j4ahA==", + "license": "MIT" + }, + "node_modules/expand-template": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/expand-template/-/expand-template-2.0.3.tgz", + "integrity": "sha512-XYfuKMvj4O35f/pOXLObndIRvyQ+/+6AhODh+OKWj9S9498pHHn/IMszH+gt0fBCRWMNfk1ZSp5x3AifmnI2vg==", + "license": "(MIT OR WTFPL)", + "engines": { + "node": ">=6" + } + }, + "node_modules/expressive-code": { + "version": "0.40.2", + "resolved": "https://registry.npmjs.org/expressive-code/-/expressive-code-0.40.2.tgz", + "integrity": "sha512-1zIda2rB0qiDZACawzw2rbdBQiWHBT56uBctS+ezFe5XMAaFaHLnnSYND/Kd+dVzO9HfCXRDpzH3d+3fvOWRcw==", + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.40.2", + "@expressive-code/plugin-frames": "^0.40.2", + "@expressive-code/plugin-shiki": "^0.40.2", + "@expressive-code/plugin-text-markers": "^0.40.2" + } + }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", + "license": "MIT" + }, + "node_modules/fast-fifo": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/fast-fifo/-/fast-fifo-1.3.2.tgz", + "integrity": "sha512-/d9sfos4yxzpwkDkuN7k2SqFKtYNmCTzgfEpz82x34IM9/zc8KGxQoXg1liNC/izpRM/MBdt44Nmx41ZWqk+FQ==", + "license": "MIT" + }, + "node_modules/fdir": { + "version": "6.4.3", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.3.tgz", + "integrity": "sha512-PMXmW2y1hDDfTSRc9gaXIuCCRpuoz3Kaz8cUelp3smouvfT632ozg2vrT6lJsHKKOF59YLbOGfAWGUcKEfRMQw==", + "license": "MIT", + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/flattie": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/flattie/-/flattie-1.1.1.tgz", + "integrity": "sha512-9UbaD6XdAL97+k/n+N7JwX46K/M6Zc6KcFYskrYL8wbBV/Uyk0CTAMY0VT+qiK5PM7AIc9aTWYtq65U7T+aCNQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/fs-constants": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs-constants/-/fs-constants-1.0.0.tgz", + "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==", + "license": "MIT" + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/get-east-asian-width": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.3.0.tgz", + "integrity": "sha512-vpeMIQKxczTD/0s2CdEWHcb0eeJe6TFjxb+J5xgX7hScxqrGuyjmv4c1D4A/gelKfyox0gJJwIHF+fLjeaM8kQ==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/github-from-package": { + "version": "0.0.0", + "resolved": "https://registry.npmjs.org/github-from-package/-/github-from-package-0.0.0.tgz", + "integrity": "sha512-SyHy3T1v2NUXn29OsWdxmK6RwHD+vkj3v8en8AOBZ1wBQ/hCAQ5bAQTD02kW4W9tUp/3Qh6J8r9EvntiyCmOOw==", + "license": "MIT" + }, + "node_modules/github-slugger": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-2.0.0.tgz", + "integrity": "sha512-IaOQ9puYtjrkq7Y0Ygl9KDZnrf/aiUJYUpVf89y8kyaxbRG7Y1SrX/jaumrv81vc61+kiMempujsM3Yw7w5qcw==", + "license": "ISC" + }, + "node_modules/h3": { + "version": "1.15.1", + "resolved": "https://registry.npmjs.org/h3/-/h3-1.15.1.tgz", + "integrity": "sha512-+ORaOBttdUm1E2Uu/obAyCguiI7MbBvsLTndc3gyK3zU+SYLoZXlyCP9Xgy0gikkGufFLTZXCXD6+4BsufnmHA==", + "license": "MIT", + "dependencies": { + "cookie-es": "^1.2.2", + "crossws": "^0.3.3", + "defu": "^6.1.4", + "destr": "^2.0.3", + "iron-webcrypto": "^1.2.1", + "node-mock-http": "^1.0.0", + "radix3": "^1.1.2", + "ufo": "^1.5.4", + "uncrypto": "^0.1.3" + } + }, + "node_modules/hast-util-embedded": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-embedded/-/hast-util-embedded-3.0.0.tgz", + "integrity": "sha512-naH8sld4Pe2ep03qqULEtvYr7EjrLK2QHY8KJR6RJkTUjPGObe1vnx585uzem2hGra+s1q08DZZpfgDVYRbaXA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-is-element": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-format": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/hast-util-format/-/hast-util-format-1.1.0.tgz", + "integrity": "sha512-yY1UDz6bC9rDvCWHpx12aIBGRG7krurX0p0Fm6pT547LwDIZZiNr8a+IHDogorAdreULSEzP82Nlv5SZkHZcjA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-embedded": "^3.0.0", + "hast-util-minify-whitespace": "^1.0.0", + "hast-util-phrasing": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "html-whitespace-sensitive-tag-names": "^3.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-from-html": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/hast-util-from-html/-/hast-util-from-html-2.0.3.tgz", + "integrity": "sha512-CUSRHXyKjzHov8yKsQjGOElXy/3EKpyX56ELnkHH34vDVw1N1XSQ1ZcAvTyAPtGqLTuKP/uxM+aLkSPqF/EtMw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "devlop": "^1.1.0", + "hast-util-from-parse5": "^8.0.0", + "parse5": "^7.0.0", + "vfile": "^6.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-from-parse5": { + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/hast-util-from-parse5/-/hast-util-from-parse5-8.0.3.tgz", + "integrity": "sha512-3kxEVkEKt0zvcZ3hCRYI8rqrgwtlIOFMWkbclACvjlDw8Li9S2hk/d51OI0nr/gIpdMHNepwgOKqZ/sy0Clpyg==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "hastscript": "^9.0.0", + "property-information": "^7.0.0", + "vfile": "^6.0.0", + "vfile-location": "^5.0.0", + "web-namespaces": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-has-property": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-has-property/-/hast-util-has-property-3.0.0.tgz", + "integrity": "sha512-MNilsvEKLFpV604hwfhVStK0usFY/QmM5zX16bo7EjnAEGofr5YyI37kzopBlZJkHD4t887i+q/C8/tr5Q94cA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-is-body-ok-link": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/hast-util-is-body-ok-link/-/hast-util-is-body-ok-link-3.0.1.tgz", + "integrity": "sha512-0qpnzOBLztXHbHQenVB8uNuxTnm/QBFUOmdOSsEn7GnBtyY07+ENTWVFBAnXd/zEgd9/SUG3lRY7hSIBWRgGpQ==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-is-element": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-is-element/-/hast-util-is-element-3.0.0.tgz", + "integrity": "sha512-Val9mnv2IWpLbNPqc/pUem+a7Ipj2aHacCwgNfTiK0vJKl0LF+4Ba4+v1oPHFpf3bLYmreq0/l3Gud9S5OH42g==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-minify-whitespace": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/hast-util-minify-whitespace/-/hast-util-minify-whitespace-1.0.1.tgz", + "integrity": "sha512-L96fPOVpnclQE0xzdWb/D12VT5FabA7SnZOUMtL1DbXmYiHJMXZvFkIZfiMmTCNJHUeO2K9UYNXoVyfz+QHuOw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-embedded": "^3.0.0", + "hast-util-is-element": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-parse-selector": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/hast-util-parse-selector/-/hast-util-parse-selector-4.0.0.tgz", + "integrity": "sha512-wkQCkSYoOGCRKERFWcxMVMOcYE2K1AaNLU8DXS9arxnLOUEWbOXKXiJUNzEpqZ3JOKpnha3jkFrumEjVliDe7A==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-phrasing": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/hast-util-phrasing/-/hast-util-phrasing-3.0.1.tgz", + "integrity": "sha512-6h60VfI3uBQUxHqTyMymMZnEbNl1XmEGtOxxKYL7stY2o601COo62AWAYBQR9lZbYXYSBoxag8UpPRXK+9fqSQ==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-embedded": "^3.0.0", + "hast-util-has-property": "^3.0.0", + "hast-util-is-body-ok-link": "^3.0.0", + "hast-util-is-element": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-raw": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/hast-util-raw/-/hast-util-raw-9.1.0.tgz", + "integrity": "sha512-Y8/SBAHkZGoNkpzqqfCldijcuUKh7/su31kEBp67cFY09Wy0mTRgtsLYsiIxMJxlu0f6AA5SUTbDR8K0rxnbUw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "@ungap/structured-clone": "^1.0.0", + "hast-util-from-parse5": "^8.0.0", + "hast-util-to-parse5": "^8.0.0", + "html-void-elements": "^3.0.0", + "mdast-util-to-hast": "^13.0.0", + "parse5": "^7.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0", + "web-namespaces": "^2.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-select": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/hast-util-select/-/hast-util-select-6.0.4.tgz", + "integrity": "sha512-RqGS1ZgI0MwxLaKLDxjprynNzINEkRHY2i8ln4DDjgv9ZhcYVIHN9rlpiYsqtFwrgpYU361SyWDQcGNIBVu3lw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "bcp-47-match": "^2.0.0", + "comma-separated-tokens": "^2.0.0", + "css-selector-parser": "^3.0.0", + "devlop": "^1.0.0", + "direction": "^2.0.0", + "hast-util-has-property": "^3.0.0", + "hast-util-to-string": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "nth-check": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "unist-util-visit": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-estree": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/hast-util-to-estree/-/hast-util-to-estree-3.1.3.tgz", + "integrity": "sha512-48+B/rJWAp0jamNbAAf9M7Uf//UVqAoMmgXhBdxTDJLGKY+LRnZ99qcG+Qjl5HfMpYNzS5v4EAwVEF34LeAj7w==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-attach-comments": "^3.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-js": "^1.0.0", + "unist-util-position": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-html": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/hast-util-to-html/-/hast-util-to-html-9.0.5.tgz", + "integrity": "sha512-OguPdidb+fbHQSU4Q4ZiLKnzWo8Wwsf5bZfbvu7//a9oTYoqD/fWpe96NuHkoS9h0ccGOTe0C4NGXdtS0iObOw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "comma-separated-tokens": "^2.0.0", + "hast-util-whitespace": "^3.0.0", + "html-void-elements": "^3.0.0", + "mdast-util-to-hast": "^13.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "stringify-entities": "^4.0.0", + "zwitch": "^2.0.4" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-jsx-runtime": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz", + "integrity": "sha512-zl6s8LwNyo1P9uw+XJGvZtdFF1GdAkOg8ujOw+4Pyb76874fLps4ueHXDhXWdk6YHQ6OgUtinliG7RsYvCbbBg==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-js": "^1.0.0", + "unist-util-position": "^5.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-parse5": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/hast-util-to-parse5/-/hast-util-to-parse5-8.0.0.tgz", + "integrity": "sha512-3KKrV5ZVI8if87DVSi1vDeByYrkGzg4mEfeu4alwgmmIeARiBLKCZS2uw5Gb6nU9x9Yufyj3iudm6i7nl52PFw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "property-information": "^6.0.0", + "space-separated-tokens": "^2.0.0", + "web-namespaces": "^2.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-parse5/node_modules/property-information": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/property-information/-/property-information-6.5.0.tgz", + "integrity": "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/hast-util-to-string": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/hast-util-to-string/-/hast-util-to-string-3.0.1.tgz", + "integrity": "sha512-XelQVTDWvqcl3axRfI0xSeoVKzyIFPwsAGSLIsKdJKQMXDYJS4WYrBNF/8J7RdhIcFI2BOHgAifggsvsxp/3+A==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-text": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/hast-util-to-text/-/hast-util-to-text-4.0.2.tgz", + "integrity": "sha512-KK6y/BN8lbaq654j7JgBydev7wuNMcID54lkRav1P0CaE1e47P72AWWPiGKXTJU271ooYzcvTAn/Zt0REnvc7A==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "hast-util-is-element": "^3.0.0", + "unist-util-find-after": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-whitespace": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz", + "integrity": "sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hastscript": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/hastscript/-/hastscript-9.0.1.tgz", + "integrity": "sha512-g7df9rMFX/SPi34tyGCyUBREQoKkapwdY/T04Qn9TDWfHhAYt4/I0gMVirzK5wEzeUqIjEB+LXC/ypb7Aqno5w==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "hast-util-parse-selector": "^4.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/html-escaper": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-3.0.3.tgz", + "integrity": "sha512-RuMffC89BOWQoY0WKGpIhn5gX3iI54O6nRA0yC124NYVtzjmFWBIiFd8M0x+ZdX0P9R4lADg1mgP8C7PxGOWuQ==", + "license": "MIT" + }, + "node_modules/html-void-elements": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/html-void-elements/-/html-void-elements-3.0.0.tgz", + "integrity": "sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/html-whitespace-sensitive-tag-names": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/html-whitespace-sensitive-tag-names/-/html-whitespace-sensitive-tag-names-3.0.1.tgz", + "integrity": "sha512-q+310vW8zmymYHALr1da4HyXUQ0zgiIwIicEfotYPWGN0OJVEN/58IJ3A4GBYcEq3LGAZqKb+ugvP0GNB9CEAA==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/http-cache-semantics": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz", + "integrity": "sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==", + "license": "BSD-2-Clause" + }, + "node_modules/i18next": { + "version": "23.16.8", + "resolved": "https://registry.npmjs.org/i18next/-/i18next-23.16.8.tgz", + "integrity": "sha512-06r/TitrM88Mg5FdUXAKL96dJMzgqLE5dv3ryBAra4KCwD9mJ4ndOTS95ZuymIGoE+2hzfdaMak2X11/es7ZWg==", + "funding": [ + { + "type": "individual", + "url": "https://locize.com" + }, + { + "type": "individual", + "url": "https://locize.com/i18next.html" + }, + { + "type": "individual", + "url": "https://www.i18next.com/how-to/faq#i18next-is-awesome.-how-can-i-support-the-project" + } + ], + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.23.2" + } + }, + "node_modules/ieee754": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", + "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "BSD-3-Clause" + }, + "node_modules/import-meta-resolve": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/import-meta-resolve/-/import-meta-resolve-4.1.0.tgz", + "integrity": "sha512-I6fiaX09Xivtk+THaMfAwnA3MVA5Big1WHF1Dfx9hFuvNIWpXnorlkzhcQf6ehrqQiiZECRt1poOAkPmer3ruw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" + }, + "node_modules/ini": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", + "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", + "license": "ISC" + }, + "node_modules/inline-style-parser": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/inline-style-parser/-/inline-style-parser-0.2.4.tgz", + "integrity": "sha512-0aO8FkhNZlj/ZIbNi7Lxxr12obT7cL1moPfE4tg1LkX7LlLfC6DeX4l2ZEud1ukP9jNQyNnfzQVqwbwmAATY4Q==", + "license": "MIT" + }, + "node_modules/iron-webcrypto": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/iron-webcrypto/-/iron-webcrypto-1.2.1.tgz", + "integrity": "sha512-feOM6FaSr6rEABp/eDfVseKyTMDt+KGpeB35SkVn9Tyn0CqvVsY3EwI0v5i8nMHyJnzCIQf7nsy3p41TPkJZhg==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/brc-dd" + } + }, + "node_modules/is-alphabetical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz", + "integrity": "sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-alphanumerical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz", + "integrity": "sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw==", + "license": "MIT", + "dependencies": { + "is-alphabetical": "^2.0.0", + "is-decimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-arrayish": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.2.tgz", + "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==", + "license": "MIT" + }, + "node_modules/is-decimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-2.0.1.tgz", + "integrity": "sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-docker": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-3.0.0.tgz", + "integrity": "sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==", + "license": "MIT", + "bin": { + "is-docker": "cli.js" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-hexadecimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz", + "integrity": "sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-inside-container": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-inside-container/-/is-inside-container-1.0.0.tgz", + "integrity": "sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA==", + "license": "MIT", + "dependencies": { + "is-docker": "^3.0.0" + }, + "bin": { + "is-inside-container": "cli.js" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-plain-obj": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", + "integrity": "sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-wsl": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-3.1.0.tgz", + "integrity": "sha512-UcVfVfaK4Sc4m7X3dUSoHoozQGBEFeDC+zVo06t98xe8CzHSZZBekNXH+tu0NalHolcJ/QAGqS46Hef7QXBIMw==", + "license": "MIT", + "dependencies": { + "is-inside-container": "^1.0.0" + }, + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/kleur": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz", + "integrity": "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/klona": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/klona/-/klona-2.0.6.tgz", + "integrity": "sha512-dhG34DXATL5hSxJbIexCft8FChFXtmskoZYnoPWjXQuebWYCNkVeV3KkGegCK9CP1oswI/vQibS2GY7Em/sJJA==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/longest-streak": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-3.1.0.tgz", + "integrity": "sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/lru-cache": { + "version": "10.4.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", + "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", + "license": "ISC" + }, + "node_modules/magic-string": { + "version": "0.30.17", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.17.tgz", + "integrity": "sha512-sNPKHvyjVf7gyjwS4xGTaW/mCnF8wnjtifKBEhxfZ7E/S8tQ0rssrwGNn6q8JH/ohItJfSQp9mBtQYuTlH5QnA==", + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0" + } + }, + "node_modules/magicast": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/magicast/-/magicast-0.3.5.tgz", + "integrity": "sha512-L0WhttDl+2BOsybvEOLK7fW3UA0OQ0IQ2d6Zl2x/a6vVRs3bAY0ECOSHHeL5jD+SbOpOCUEi0y1DgHEn9Qn1AQ==", + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.25.4", + "@babel/types": "^7.25.4", + "source-map-js": "^1.2.0" + } + }, + "node_modules/markdown-extensions": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-2.0.0.tgz", + "integrity": "sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==", + "license": "MIT", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/markdown-table": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-3.0.4.tgz", + "integrity": "sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/mdast-util-definitions": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-definitions/-/mdast-util-definitions-6.0.0.tgz", + "integrity": "sha512-scTllyX6pnYNZH/AIp/0ePz6s4cZtARxImwoPJ7kS42n+MnVsI4XbnG6d4ibehRIldYMWM2LD7ImQblVhUejVQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "unist-util-visit": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-directive": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-directive/-/mdast-util-directive-3.1.0.tgz", + "integrity": "sha512-I3fNFt+DHmpWCYAT7quoM6lHf9wuqtI+oCOfvILnoicNIqjh5E3dEJWiXuYME2gNe8vl1iMQwyUHa7bgFmak6Q==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-find-and-replace": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/mdast-util-find-and-replace/-/mdast-util-find-and-replace-3.0.2.tgz", + "integrity": "sha512-Tmd1Vg/m3Xz43afeNxDIhWRtFZgM2VLyaf4vSTYwudTyeuTneoL3qtWMA5jeLyz/O1vDJmmV4QuScFCA2tBPwg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "escape-string-regexp": "^5.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-from-markdown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.2.tgz", + "integrity": "sha512-uZhTV/8NBuw0WHkPTrCqDOl0zVe1BIng5ZtHoDk49ME1qqcjYmmLmOf0gELgcRMxN4w2iuIeVso5/6QymSrgmA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark": "^4.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm/-/mdast-util-gfm-3.1.0.tgz", + "integrity": "sha512-0ulfdQOM3ysHhCJ1p06l0b0VKlhU0wuQs3thxZQagjcjPrlFRqY215uZGHHJan9GEAXd9MbfPjFJz+qMkVR6zQ==", + "license": "MIT", + "dependencies": { + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-gfm-autolink-literal": "^2.0.0", + "mdast-util-gfm-footnote": "^2.0.0", + "mdast-util-gfm-strikethrough": "^2.0.0", + "mdast-util-gfm-table": "^2.0.0", + "mdast-util-gfm-task-list-item": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-autolink-literal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-autolink-literal/-/mdast-util-gfm-autolink-literal-2.0.1.tgz", + "integrity": "sha512-5HVP2MKaP6L+G6YaxPNjuL0BPrq9orG3TsrZ9YXbA3vDw/ACI4MEsnoDpn6ZNm7GnZgtAcONJyPhOP8tNJQavQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "ccount": "^2.0.0", + "devlop": "^1.0.0", + "mdast-util-find-and-replace": "^3.0.0", + "micromark-util-character": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-footnote": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-2.1.0.tgz", + "integrity": "sha512-sqpDWlsHn7Ac9GNZQMeUzPQSMzR6Wv0WKRNvQRg0KqHh02fpTz69Qc1QSseNX29bhz1ROIyNyxExfawVKTm1GQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-strikethrough": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-strikethrough/-/mdast-util-gfm-strikethrough-2.0.0.tgz", + "integrity": "sha512-mKKb915TF+OC5ptj5bJ7WFRPdYtuHv0yTRxK2tJvi+BDqbkiG7h7u/9SI89nRAYcmap2xHQL9D+QG/6wSrTtXg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-table": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-table/-/mdast-util-gfm-table-2.0.0.tgz", + "integrity": "sha512-78UEvebzz/rJIxLvE7ZtDd/vIQ0RHv+3Mh5DR96p7cS7HsBhYIICDBCu8csTNWNO6tBWfqXPWekRuj2FNOGOZg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "markdown-table": "^3.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-task-list-item": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-task-list-item/-/mdast-util-gfm-task-list-item-2.0.0.tgz", + "integrity": "sha512-IrtvNvjxC1o06taBAVJznEnkiHxLFTzgonUdy8hzFVeDun0uTjxxrRGVaNFqkU1wJR3RBPEfsxmU6jDWPofrTQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx/-/mdast-util-mdx-3.0.0.tgz", + "integrity": "sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w==", + "license": "MIT", + "dependencies": { + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx-expression": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.1.tgz", + "integrity": "sha512-J6f+9hUp+ldTZqKRSg7Vw5V6MqjATc+3E4gf3CFNcuZNWD8XdyI6zQ8GqH7f8169MM6P7hMBRDVGnn7oHB9kXQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx-jsx": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-jsx/-/mdast-util-mdx-jsx-3.2.0.tgz", + "integrity": "sha512-lj/z8v0r6ZtsN/cGNNtemmmfoLAFZnjMbNyLzBafjzikOM+glrjNHPlf6lQDOTccj9n5b0PPihEBbhneMyGs1Q==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-stringify-position": "^4.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdxjs-esm": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdxjs-esm/-/mdast-util-mdxjs-esm-2.0.1.tgz", + "integrity": "sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-phrasing": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-phrasing/-/mdast-util-phrasing-4.1.0.tgz", + "integrity": "sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-hast": { + "version": "13.2.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-hast/-/mdast-util-to-hast-13.2.0.tgz", + "integrity": "sha512-QGYKEuUsYT9ykKBCMOEDLsU5JRObWQusAolFMeko/tYPufNkRffBAQjIE+99jbA87xv6FgmjLtwjh9wBWajwAA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@ungap/structured-clone": "^1.0.0", + "devlop": "^1.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "trim-lines": "^3.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-markdown": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.2.tgz", + "integrity": "sha512-xj68wMTvGXVOKonmog6LwyJKrYXZPvlwabaryTjLh9LuvovB/KAH+kvi8Gjj+7rJjsFi23nkUxRQv1KqSroMqA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "longest-streak": "^3.0.0", + "mdast-util-phrasing": "^4.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "unist-util-visit": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz", + "integrity": "sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz", + "integrity": "sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/debug": "^4.0.0", + "debug": "^4.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz", + "integrity": "sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-destination": "^2.0.0", + "micromark-factory-label": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-title": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-html-tag-name": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-directive": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/micromark-extension-directive/-/micromark-extension-directive-3.0.2.tgz", + "integrity": "sha512-wjcXHgk+PPdmvR58Le9d7zQYWy+vKEU9Se44p2CrCDPiLr2FMyiT4Fyb5UFKFC66wGB3kPlgD7q3TnoqPS7SZA==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "parse-entities": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm/-/micromark-extension-gfm-3.0.0.tgz", + "integrity": "sha512-vsKArQsicm7t0z2GugkCKtZehqUm31oeGBV/KVSorWSy8ZlNAv7ytjFhvaryUiCUJYqs+NoE6AFhpQvBTM6Q4w==", + "license": "MIT", + "dependencies": { + "micromark-extension-gfm-autolink-literal": "^2.0.0", + "micromark-extension-gfm-footnote": "^2.0.0", + "micromark-extension-gfm-strikethrough": "^2.0.0", + "micromark-extension-gfm-table": "^2.0.0", + "micromark-extension-gfm-tagfilter": "^2.0.0", + "micromark-extension-gfm-task-list-item": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-autolink-literal/-/micromark-extension-gfm-autolink-literal-2.1.0.tgz", + "integrity": "sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw==", + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-footnote": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-footnote/-/micromark-extension-gfm-footnote-2.1.0.tgz", + "integrity": "sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-strikethrough": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-strikethrough/-/micromark-extension-gfm-strikethrough-2.1.0.tgz", + "integrity": "sha512-ADVjpOOkjz1hhkZLlBiYA9cR2Anf8F4HqZUO6e5eDcPQd0Txw5fxLzzxnEkSkfnD0wziSGiv7sYhk/ktvbf1uw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-table": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.1.tgz", + "integrity": "sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-tagfilter": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-tagfilter/-/micromark-extension-gfm-tagfilter-2.0.0.tgz", + "integrity": "sha512-xHlTOmuCSotIA8TW1mDIM6X2O1SiX5P9IuDtqGonFhEK0qgRI4yeC6vMxEV2dgyr2TiD+2PQ10o+cOhdVAcwfg==", + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-task-list-item": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-task-list-item/-/micromark-extension-gfm-task-list-item-2.1.0.tgz", + "integrity": "sha512-qIBZhqxqI6fjLDYFTBIa4eivDMnP+OZqsNwmQ3xNLE4Cxwc+zfQEfbs6tzAo2Hjq+bh6q5F+Z8/cksrLFYWQQw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdx-expression": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-expression/-/micromark-extension-mdx-expression-3.0.1.tgz", + "integrity": "sha512-dD/ADLJ1AeMvSAKBwO22zG22N4ybhe7kFIZ3LsDI0GlsNr2A3KYxb0LdC1u5rj4Nw+CHKY0RVdnHX8vj8ejm4Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-mdx-expression": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-jsx": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-jsx/-/micromark-extension-mdx-jsx-3.0.2.tgz", + "integrity": "sha512-e5+q1DjMh62LZAJOnDraSSbDMvGJ8x3cbjygy2qFEi7HCeUT4BDKCvMozPozcD6WmOt6sVvYDNBKhFSz3kjOVQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "micromark-factory-mdx-expression": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdx-md": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-md/-/micromark-extension-mdx-md-2.0.0.tgz", + "integrity": "sha512-EpAiszsB3blw4Rpba7xTOUptcFeBFi+6PY8VnJ2hhimH+vCQDirWgsMpz7w1XcZE7LVrSAUGb9VJpG9ghlYvYQ==", + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs/-/micromark-extension-mdxjs-3.0.0.tgz", + "integrity": "sha512-A873fJfhnJ2siZyUrJ31l34Uqwy4xIFmvPY1oj+Ean5PHcPBYzEsvqvWGaWcfEIr11O5Dlw3p2y0tZWpKHDejQ==", + "license": "MIT", + "dependencies": { + "acorn": "^8.0.0", + "acorn-jsx": "^5.0.0", + "micromark-extension-mdx-expression": "^3.0.0", + "micromark-extension-mdx-jsx": "^3.0.0", + "micromark-extension-mdx-md": "^2.0.0", + "micromark-extension-mdxjs-esm": "^3.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs-esm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs-esm/-/micromark-extension-mdxjs-esm-3.0.0.tgz", + "integrity": "sha512-DJFl4ZqkErRpq/dAPyeWp15tGrcrrJho1hKK5uBS70BCtfrIFg81sqcTVu3Ta+KD1Tk5vAtBNElWxtAa+m8K9A==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-factory-destination": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-2.0.1.tgz", + "integrity": "sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-label": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-2.0.1.tgz", + "integrity": "sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-mdx-expression": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-factory-mdx-expression/-/micromark-factory-mdx-expression-2.0.3.tgz", + "integrity": "sha512-kQnEtA3vzucU2BkrIa8/VaSAsP+EJ3CKOvhMuJgOEGg9KDC6OAY6nSnNDVRiVNRqj7Y4SlSzcStaH/5jge8JdQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + } + }, + "node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-2.0.1.tgz", + "integrity": "sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.1.tgz", + "integrity": "sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-chunked": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-2.0.1.tgz", + "integrity": "sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-classify-character": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-2.0.1.tgz", + "integrity": "sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-combine-extensions": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.1.tgz", + "integrity": "sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-chunked": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-numeric-character-reference": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.2.tgz", + "integrity": "sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-string": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-decode-string/-/micromark-util-decode-string-2.0.1.tgz", + "integrity": "sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-encode": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz", + "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-events-to-acorn": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-util-events-to-acorn/-/micromark-util-events-to-acorn-2.0.3.tgz", + "integrity": "sha512-jmsiEIiZ1n7X1Rr5k8wVExBQCg5jy4UXVADItHmNk1zkwEVhBuIUKRu3fqv+hs4nxLISi2DQGlqIOGiFxgbfHg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "estree-util-visit": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "vfile-message": "^4.0.0" + } + }, + "node_modules/micromark-util-html-tag-name": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.1.tgz", + "integrity": "sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-normalize-identifier": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.1.tgz", + "integrity": "sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-resolve-all": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.1.tgz", + "integrity": "sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz", + "integrity": "sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-subtokenize": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-2.1.0.tgz", + "integrity": "sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-types": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.2.tgz", + "integrity": "sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/mimic-response": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz", + "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/mkdirp-classic": { + "version": "0.5.3", + "resolved": "https://registry.npmjs.org/mkdirp-classic/-/mkdirp-classic-0.5.3.tgz", + "integrity": "sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==", + "license": "MIT" + }, + "node_modules/mrmime": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-2.0.1.tgz", + "integrity": "sha512-Y3wQdFg2Va6etvQ5I82yUhGdsKrcYox6p7FfL1LbK2J4V01F9TGlepTIhnK24t7koZibmg82KGglhA1XK5IsLQ==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/napi-build-utils": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/napi-build-utils/-/napi-build-utils-2.0.0.tgz", + "integrity": "sha512-GEbrYkbfF7MoNaoh2iGG84Mnf/WZfB0GdGEsM8wz7Expx/LlWf5U8t9nvJKXSp3qr5IsEbK04cBGhol/KwOsWA==", + "license": "MIT" + }, + "node_modules/neotraverse": { + "version": "0.6.18", + "resolved": "https://registry.npmjs.org/neotraverse/-/neotraverse-0.6.18.tgz", + "integrity": "sha512-Z4SmBUweYa09+o6pG+eASabEpP6QkQ70yHj351pQoEXIs8uHbaU2DWVmzBANKgflPa47A50PtB2+NgRpQvr7vA==", + "license": "MIT", + "engines": { + "node": ">= 10" + } + }, + "node_modules/nlcst-to-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/nlcst-to-string/-/nlcst-to-string-4.0.0.tgz", + "integrity": "sha512-YKLBCcUYKAg0FNlOBT6aI91qFmSiFKiluk655WzPF+DDMA02qIyy8uiRqI8QXtcFpEvll12LpL5MXqEmAZ+dcA==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/node-abi": { + "version": "3.74.0", + "resolved": "https://registry.npmjs.org/node-abi/-/node-abi-3.74.0.tgz", + "integrity": "sha512-c5XK0MjkGBrQPGYG24GBADZud0NCbznxNx0ZkS+ebUTrmV1qTDxPxSL8zEAPURXSbLRWVexxmP4986BziahL5w==", + "license": "MIT", + "dependencies": { + "semver": "^7.3.5" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/node-addon-api": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-6.1.0.tgz", + "integrity": "sha512-+eawOlIgy680F0kBzPUNFhMZGtJ1YmqM6l4+Crf4IkImjYrO/mqPwRMh352g23uIaQKFItcQ64I7KMaJxHgAVA==", + "license": "MIT" + }, + "node_modules/node-fetch-native": { + "version": "1.6.6", + "resolved": "https://registry.npmjs.org/node-fetch-native/-/node-fetch-native-1.6.6.tgz", + "integrity": "sha512-8Mc2HhqPdlIfedsuZoc3yioPuzp6b+L5jRCRY1QzuWZh2EGJVQrGppC6V6cF0bLdbW0+O2YpqCA25aF/1lvipQ==", + "license": "MIT" + }, + "node_modules/node-mock-http": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/node-mock-http/-/node-mock-http-1.0.0.tgz", + "integrity": "sha512-0uGYQ1WQL1M5kKvGRXWQ3uZCHtLTO8hln3oBjIusM75WoesZ909uQJs/Hb946i2SS+Gsrhkaa6iAO17jRIv6DQ==", + "license": "MIT" + }, + "node_modules/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/nth-check": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", + "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0" + }, + "funding": { + "url": "https://github.com/fb55/nth-check?sponsor=1" + } + }, + "node_modules/ofetch": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/ofetch/-/ofetch-1.4.1.tgz", + "integrity": "sha512-QZj2DfGplQAr2oj9KzceK9Hwz6Whxazmn85yYeVuS3u9XTMOGMRx0kO95MQ+vLsj/S/NwBDMMLU5hpxvI6Tklw==", + "license": "MIT", + "dependencies": { + "destr": "^2.0.3", + "node-fetch-native": "^1.6.4", + "ufo": "^1.5.4" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "license": "ISC", + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/oniguruma-parser": { + "version": "0.11.0", + "resolved": "https://registry.npmjs.org/oniguruma-parser/-/oniguruma-parser-0.11.0.tgz", + "integrity": "sha512-9M+tFRnJWtRxsgh4XFlkw+AVFtzEtI8UfTifx6sDbtt47SpEl/K65PunQyp/jvfp0xwLGjtbE5aKQcL8j6AXYw==", + "license": "MIT" + }, + "node_modules/oniguruma-to-es": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/oniguruma-to-es/-/oniguruma-to-es-4.2.0.tgz", + "integrity": "sha512-MDPs6KSOLS0tKQ7joqg44dRIRZUyotfTy0r+7oEEs6VwWWP0+E2PPDYWMFN0aqOjRyWHBYq7RfKw9GQk2S2z5g==", + "license": "MIT", + "dependencies": { + "emoji-regex-xs": "^1.0.0", + "oniguruma-parser": "^0.11.0", + "regex": "^6.0.1", + "regex-recursion": "^6.0.2" + } + }, + "node_modules/p-limit": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-6.2.0.tgz", + "integrity": "sha512-kuUqqHNUqoIWp/c467RI4X6mmyuojY5jGutNU0wVTmEOOfcuwLqyMVoAi9MKi2Ak+5i9+nhmrK4ufZE8069kHA==", + "license": "MIT", + "dependencies": { + "yocto-queue": "^1.1.1" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-queue": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/p-queue/-/p-queue-8.1.0.tgz", + "integrity": "sha512-mxLDbbGIBEXTJL0zEx8JIylaj3xQ7Z/7eEVjcF9fJX4DBiH9oqe+oahYnlKKxm0Ci9TlWTyhSHgygxMxjIB2jw==", + "license": "MIT", + "dependencies": { + "eventemitter3": "^5.0.1", + "p-timeout": "^6.1.2" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-timeout": { + "version": "6.1.4", + "resolved": "https://registry.npmjs.org/p-timeout/-/p-timeout-6.1.4.tgz", + "integrity": "sha512-MyIV3ZA/PmyBN/ud8vV9XzwTrNtR4jFrObymZYnZqMmW0zA8Z17vnT0rBgFE/TlohB+YCHqXMgZzb3Csp49vqg==", + "license": "MIT", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/package-manager-detector": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/package-manager-detector/-/package-manager-detector-1.1.0.tgz", + "integrity": "sha512-Y8f9qUlBzW8qauJjd/eu6jlpJZsuPJm2ZAV0cDVd420o4EdpH5RPdoCv+60/TdJflGatr4sDfpAL6ArWZbM5tA==", + "license": "MIT" + }, + "node_modules/pagefind": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/pagefind/-/pagefind-1.3.0.tgz", + "integrity": "sha512-8KPLGT5g9s+olKMRTU9LFekLizkVIu9tes90O1/aigJ0T5LmyPqTzGJrETnSw3meSYg58YH7JTzhTTW/3z6VAw==", + "license": "MIT", + "bin": { + "pagefind": "lib/runner/bin.cjs" + }, + "optionalDependencies": { + "@pagefind/darwin-arm64": "1.3.0", + "@pagefind/darwin-x64": "1.3.0", + "@pagefind/linux-arm64": "1.3.0", + "@pagefind/linux-x64": "1.3.0", + "@pagefind/windows-x64": "1.3.0" + } + }, + "node_modules/parse-entities": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-4.0.2.tgz", + "integrity": "sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^2.0.0", + "character-entities-legacy": "^3.0.0", + "character-reference-invalid": "^2.0.0", + "decode-named-character-reference": "^1.0.0", + "is-alphanumerical": "^2.0.0", + "is-decimal": "^2.0.0", + "is-hexadecimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/parse-entities/node_modules/@types/unist": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.11.tgz", + "integrity": "sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==", + "license": "MIT" + }, + "node_modules/parse-latin": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/parse-latin/-/parse-latin-7.0.0.tgz", + "integrity": "sha512-mhHgobPPua5kZ98EF4HWiH167JWBfl4pvAIXXdbaVohtK7a6YBOy56kvhCqduqyo/f3yrHFWmqmiMg/BkBkYYQ==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "@types/unist": "^3.0.0", + "nlcst-to-string": "^4.0.0", + "unist-util-modify-children": "^4.0.0", + "unist-util-visit-children": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/parse5": { + "version": "7.2.1", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.2.1.tgz", + "integrity": "sha512-BuBYQYlv1ckiPdQi/ohiivi9Sagc9JG+Ozs0r7b/0iK3sKmrb0b9FdWdBbOdx6hBCM/F9Ir82ofnBhtZOjCRPQ==", + "license": "MIT", + "dependencies": { + "entities": "^4.5.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", + "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/postcss": { + "version": "8.5.3", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.3.tgz", + "integrity": "sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.8", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/postcss-nested": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/postcss-nested/-/postcss-nested-6.2.0.tgz", + "integrity": "sha512-HQbt28KulC5AJzG+cZtj9kvKB93CFCdLvog1WFLf1D+xmMvPGlBstkpTEZfK5+AN9hfJocyBFCNiqyS48bpgzQ==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^6.1.1" + }, + "engines": { + "node": ">=12.0" + }, + "peerDependencies": { + "postcss": "^8.2.14" + } + }, + "node_modules/postcss-selector-parser": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz", + "integrity": "sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/prebuild-install": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/prebuild-install/-/prebuild-install-7.1.3.tgz", + "integrity": "sha512-8Mf2cbV7x1cXPUILADGI3wuhfqWvtiLA1iclTDbFRZkgRQS0NqsPZphna9V+HyTEadheuPmjaJMsbzKQFOzLug==", + "license": "MIT", + "dependencies": { + "detect-libc": "^2.0.0", + "expand-template": "^2.0.3", + "github-from-package": "0.0.0", + "minimist": "^1.2.3", + "mkdirp-classic": "^0.5.3", + "napi-build-utils": "^2.0.0", + "node-abi": "^3.3.0", + "pump": "^3.0.0", + "rc": "^1.2.7", + "simple-get": "^4.0.0", + "tar-fs": "^2.0.0", + "tunnel-agent": "^0.6.0" + }, + "bin": { + "prebuild-install": "bin.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/prebuild-install/node_modules/tar-fs": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.2.tgz", + "integrity": "sha512-EsaAXwxmx8UB7FRKqeozqEPop69DXcmYwTQwXvyAPF352HJsPdkVhvTaDPYqfNgruveJIJy3TA2l+2zj8LJIJA==", + "license": "MIT", + "dependencies": { + "chownr": "^1.1.1", + "mkdirp-classic": "^0.5.2", + "pump": "^3.0.0", + "tar-stream": "^2.1.4" + } + }, + "node_modules/prebuild-install/node_modules/tar-stream": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-2.2.0.tgz", + "integrity": "sha512-ujeqbceABgwMZxEJnk2HDY2DlnUZ+9oEcb1KzTVfYHio0UE6dG71n60d8D2I4qNvleWrrXpmjpt7vZeF1LnMZQ==", + "license": "MIT", + "dependencies": { + "bl": "^4.0.3", + "end-of-stream": "^1.4.1", + "fs-constants": "^1.0.0", + "inherits": "^2.0.3", + "readable-stream": "^3.1.1" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/prismjs": { + "version": "1.30.0", + "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.30.0.tgz", + "integrity": "sha512-DEvV2ZF2r2/63V+tK8hQvrR2ZGn10srHbXviTlcv7Kpzw8jWiNTqbVgjO3IY8RxrrOUF8VPMQQFysYYYv0YZxw==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/prompts": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", + "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", + "license": "MIT", + "dependencies": { + "kleur": "^3.0.3", + "sisteransi": "^1.0.5" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/prompts/node_modules/kleur": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", + "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/property-information": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/property-information/-/property-information-7.0.0.tgz", + "integrity": "sha512-7D/qOz/+Y4X/rzSB6jKxKUsQnphO046ei8qxG59mtM3RG3DHgTK81HrxrmoDVINJb8NKT5ZsRbwHvQ6B68Iyhg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/pump": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.2.tgz", + "integrity": "sha512-tUPXtzlGM8FE3P0ZL6DVs/3P58k9nk8/jZeQCurTJylQA8qFYzHFfhBJkuqyE0FifOsQ0uKWekiZ5g8wtr28cw==", + "license": "MIT", + "dependencies": { + "end-of-stream": "^1.1.0", + "once": "^1.3.1" + } + }, + "node_modules/radix3": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/radix3/-/radix3-1.1.2.tgz", + "integrity": "sha512-b484I/7b8rDEdSDKckSSBA8knMpcdsXudlE/LNL639wFoHKwLbEkQFZHWEYwDC0wa0FKUcCY+GAF73Z7wxNVFA==", + "license": "MIT" + }, + "node_modules/rc": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", + "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", + "license": "(BSD-2-Clause OR MIT OR Apache-2.0)", + "dependencies": { + "deep-extend": "^0.6.0", + "ini": "~1.3.0", + "minimist": "^1.2.0", + "strip-json-comments": "~2.0.1" + }, + "bin": { + "rc": "cli.js" + } + }, + "node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "license": "MIT", + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/readdirp": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-4.1.2.tgz", + "integrity": "sha512-GDhwkLfywWL2s6vEjyhri+eXmfH6j1L7JE27WhqLeYzoh/A3DBaYGEj2H/HFZCn/kMfim73FXxEJTw06WtxQwg==", + "license": "MIT", + "engines": { + "node": ">= 14.18.0" + }, + "funding": { + "type": "individual", + "url": "https://paulmillr.com/funding/" + } + }, + "node_modules/recma-build-jsx": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-build-jsx/-/recma-build-jsx-1.0.0.tgz", + "integrity": "sha512-8GtdyqaBcDfva+GUKDr3nev3VpKAhup1+RvkMvUxURHpW7QyIvk9F5wz7Vzo06CEMSilw6uArgRqhpiUcWp8ew==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-util-build-jsx": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/recma-jsx": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-jsx/-/recma-jsx-1.0.0.tgz", + "integrity": "sha512-5vwkv65qWwYxg+Atz95acp8DMu1JDSqdGkA2Of1j6rCreyFUE/gp15fC8MnGEuG1W68UKjM6x6+YTWIh7hZM/Q==", + "license": "MIT", + "dependencies": { + "acorn-jsx": "^5.0.0", + "estree-util-to-js": "^2.0.0", + "recma-parse": "^1.0.0", + "recma-stringify": "^1.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/recma-parse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-parse/-/recma-parse-1.0.0.tgz", + "integrity": "sha512-OYLsIGBB5Y5wjnSnQW6t3Xg7q3fQ7FWbw/vcXtORTnyaSFscOtABg+7Pnz6YZ6c27fG1/aN8CjfwoUEUIdwqWQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "esast-util-from-js": "^2.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/recma-stringify": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-stringify/-/recma-stringify-1.0.0.tgz", + "integrity": "sha512-cjwII1MdIIVloKvC9ErQ+OgAtwHBmcZ0Bg4ciz78FtbT8In39aAYbaA7zvxQ61xVMSPE8WxhLwLbhif4Js2C+g==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-util-to-js": "^2.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/regenerator-runtime": { + "version": "0.14.1", + "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.14.1.tgz", + "integrity": "sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==", + "license": "MIT" + }, + "node_modules/regex": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/regex/-/regex-6.0.1.tgz", + "integrity": "sha512-uorlqlzAKjKQZ5P+kTJr3eeJGSVroLKoHmquUj4zHWuR+hEyNqlXsSKlYYF5F4NI6nl7tWCs0apKJ0lmfsXAPA==", + "license": "MIT", + "dependencies": { + "regex-utilities": "^2.3.0" + } + }, + "node_modules/regex-recursion": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/regex-recursion/-/regex-recursion-6.0.2.tgz", + "integrity": "sha512-0YCaSCq2VRIebiaUviZNs0cBz1kg5kVS2UKUfNIx8YVs1cN3AV7NTctO5FOKBA+UT2BPJIWZauYHPqJODG50cg==", + "license": "MIT", + "dependencies": { + "regex-utilities": "^2.3.0" + } + }, + "node_modules/regex-utilities": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/regex-utilities/-/regex-utilities-2.3.0.tgz", + "integrity": "sha512-8VhliFJAWRaUiVvREIiW2NXXTmHs4vMNnSzuJVhscgmGav3g9VDxLrQndI3dZZVVdp0ZO/5v0xmX516/7M9cng==", + "license": "MIT" + }, + "node_modules/rehype": { + "version": "13.0.2", + "resolved": "https://registry.npmjs.org/rehype/-/rehype-13.0.2.tgz", + "integrity": "sha512-j31mdaRFrwFRUIlxGeuPXXKWQxet52RBQRvCmzl5eCefn/KGbomK5GMHNMsOJf55fgo3qw5tST5neDuarDYR2A==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "rehype-parse": "^9.0.0", + "rehype-stringify": "^10.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-expressive-code": { + "version": "0.40.2", + "resolved": "https://registry.npmjs.org/rehype-expressive-code/-/rehype-expressive-code-0.40.2.tgz", + "integrity": "sha512-+kn+AMGCrGzvtH8Q5lC6Y5lnmTV/r33fdmi5QU/IH1KPHKobKr5UnLwJuqHv5jBTSN/0v2wLDS7RTM73FVzqmQ==", + "license": "MIT", + "dependencies": { + "expressive-code": "^0.40.2" + } + }, + "node_modules/rehype-format": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/rehype-format/-/rehype-format-5.0.1.tgz", + "integrity": "sha512-zvmVru9uB0josBVpr946OR8ui7nJEdzZobwLOOqHb/OOD88W0Vk2SqLwoVOj0fM6IPCCO6TaV9CvQvJMWwukFQ==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-format": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-parse": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/rehype-parse/-/rehype-parse-9.0.1.tgz", + "integrity": "sha512-ksCzCD0Fgfh7trPDxr2rSylbwq9iYDkSn8TCDmEJ49ljEUBxDVCzCHv7QNzZOfODanX4+bWQ4WZqLCRWYLfhag==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-from-html": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-raw": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/rehype-raw/-/rehype-raw-7.0.0.tgz", + "integrity": "sha512-/aE8hCfKlQeA8LmyeyQvQF3eBiLRGNlfBJEvWH7ivp9sBqs7TNqBL5X3v157rM4IFETqDnIOO+z5M/biZbo9Ww==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-raw": "^9.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-recma": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/rehype-recma/-/rehype-recma-1.0.0.tgz", + "integrity": "sha512-lqA4rGUf1JmacCNWWZx0Wv1dHqMwxzsDWYMTowuplHF3xH0N/MmrZ/G3BDZnzAkRmxDadujCjaKM2hqYdCBOGw==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/hast": "^3.0.0", + "hast-util-to-estree": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-stringify": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/rehype-stringify/-/rehype-stringify-10.0.1.tgz", + "integrity": "sha512-k9ecfXHmIPuFVI61B9DeLPN0qFHfawM6RsuX48hoqlaKSF61RskNjSm1lI8PhBEM0MRdLxVVm4WmTqJQccH9mA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-to-html": "^9.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-directive": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/remark-directive/-/remark-directive-3.0.1.tgz", + "integrity": "sha512-gwglrEQEZcZYgVyG1tQuA+h58EZfq5CSULw7J90AFuCTyib1thgHPoqQ+h9iFvU6R+vnZ5oNFQR5QKgGpk741A==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-directive": "^3.0.0", + "micromark-extension-directive": "^3.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-gfm": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/remark-gfm/-/remark-gfm-4.0.1.tgz", + "integrity": "sha512-1quofZ2RQ9EWdeN34S79+KExV1764+wCUGop5CPL1WGdD0ocPpu91lzPGbwWMECpEpd42kJGQwzRfyov9j4yNg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-gfm": "^3.0.0", + "micromark-extension-gfm": "^3.0.0", + "remark-parse": "^11.0.0", + "remark-stringify": "^11.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-mdx": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/remark-mdx/-/remark-mdx-3.1.0.tgz", + "integrity": "sha512-Ngl/H3YXyBV9RcRNdlYsZujAmhsxwzxpDzpDEhFBVAGthS4GDgnctpDjgFl/ULx5UEDzqtW1cyBSNKqYYrqLBA==", + "license": "MIT", + "dependencies": { + "mdast-util-mdx": "^3.0.0", + "micromark-extension-mdxjs": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-parse": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-11.0.0.tgz", + "integrity": "sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-rehype": { + "version": "11.1.2", + "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-11.1.2.tgz", + "integrity": "sha512-Dh7l57ianaEoIpzbp0PC9UKAdCSVklD8E5Rpw7ETfbTl3FqcOOgq5q2LVDhgGCkaBv7p24JXikPdvhhmHvKMsw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "mdast-util-to-hast": "^13.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-smartypants": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/remark-smartypants/-/remark-smartypants-3.0.2.tgz", + "integrity": "sha512-ILTWeOriIluwEvPjv67v7Blgrcx+LZOkAUVtKI3putuhlZm84FnqDORNXPPm+HY3NdZOMhyDwZ1E+eZB/Df5dA==", + "license": "MIT", + "dependencies": { + "retext": "^9.0.0", + "retext-smartypants": "^6.0.0", + "unified": "^11.0.4", + "unist-util-visit": "^5.0.0" + }, + "engines": { + "node": ">=16.0.0" + } + }, + "node_modules/remark-stringify": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-11.0.0.tgz", + "integrity": "sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-to-markdown": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/retext": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/retext/-/retext-9.0.0.tgz", + "integrity": "sha512-sbMDcpHCNjvlheSgMfEcVrZko3cDzdbe1x/e7G66dFp0Ff7Mldvi2uv6JkJQzdRcvLYE8CA8Oe8siQx8ZOgTcA==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "retext-latin": "^4.0.0", + "retext-stringify": "^4.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/retext-latin": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/retext-latin/-/retext-latin-4.0.0.tgz", + "integrity": "sha512-hv9woG7Fy0M9IlRQloq/N6atV82NxLGveq+3H2WOi79dtIYWN8OaxogDm77f8YnVXJL2VD3bbqowu5E3EMhBYA==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "parse-latin": "^7.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/retext-smartypants": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/retext-smartypants/-/retext-smartypants-6.2.0.tgz", + "integrity": "sha512-kk0jOU7+zGv//kfjXEBjdIryL1Acl4i9XNkHxtM7Tm5lFiCog576fjNC9hjoR7LTKQ0DsPWy09JummSsH1uqfQ==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "nlcst-to-string": "^4.0.0", + "unist-util-visit": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/retext-stringify": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/retext-stringify/-/retext-stringify-4.0.0.tgz", + "integrity": "sha512-rtfN/0o8kL1e+78+uxPTqu1Klt0yPzKuQ2BfWwwfgIUSayyzxpM1PJzkKt4V8803uB9qSy32MvI7Xep9khTpiA==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "nlcst-to-string": "^4.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rollup": { + "version": "4.40.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.40.0.tgz", + "integrity": "sha512-Noe455xmA96nnqH5piFtLobsGbCij7Tu+tb3c1vYjNbTkfzGqXqQXG3wJaYXkRZuQ0vEYN4bhwg7QnIrqB5B+w==", + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.7" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.40.0", + "@rollup/rollup-android-arm64": "4.40.0", + "@rollup/rollup-darwin-arm64": "4.40.0", + "@rollup/rollup-darwin-x64": "4.40.0", + "@rollup/rollup-freebsd-arm64": "4.40.0", + "@rollup/rollup-freebsd-x64": "4.40.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.40.0", + "@rollup/rollup-linux-arm-musleabihf": "4.40.0", + "@rollup/rollup-linux-arm64-gnu": "4.40.0", + "@rollup/rollup-linux-arm64-musl": "4.40.0", + "@rollup/rollup-linux-loongarch64-gnu": "4.40.0", + "@rollup/rollup-linux-powerpc64le-gnu": "4.40.0", + "@rollup/rollup-linux-riscv64-gnu": "4.40.0", + "@rollup/rollup-linux-riscv64-musl": "4.40.0", + "@rollup/rollup-linux-s390x-gnu": "4.40.0", + "@rollup/rollup-linux-x64-gnu": "4.40.0", + "@rollup/rollup-linux-x64-musl": "4.40.0", + "@rollup/rollup-win32-arm64-msvc": "4.40.0", + "@rollup/rollup-win32-ia32-msvc": "4.40.0", + "@rollup/rollup-win32-x64-msvc": "4.40.0", + "fsevents": "~2.3.2" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/sax": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.4.1.tgz", + "integrity": "sha512-+aWOz7yVScEGoKNd4PA10LZ8sk0A/z5+nXQG5giUO5rprX9jgYsTdov9qCchZiPIZezbZH+jRut8nPodFAX4Jg==", + "license": "ISC" + }, + "node_modules/semver": { + "version": "7.7.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.1.tgz", + "integrity": "sha512-hlq8tAfn0m/61p4BVRcPzIGr6LKiMwo4VM6dGi6pt4qcRkmNzTcWq6eCEjEh+qXjkMDvPlOFFSGwQjoEa6gyMA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/sharp": { + "version": "0.32.6", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.32.6.tgz", + "integrity": "sha512-KyLTWwgcR9Oe4d9HwCwNM2l7+J0dUQwn/yf7S0EnTtb0eVS4RxO0eUSvxPtzT4F3SY+C4K6fqdv/DO27sJ/v/w==", + "hasInstallScript": true, + "license": "Apache-2.0", + "dependencies": { + "color": "^4.2.3", + "detect-libc": "^2.0.2", + "node-addon-api": "^6.1.0", + "prebuild-install": "^7.1.1", + "semver": "^7.5.4", + "simple-get": "^4.0.1", + "tar-fs": "^3.0.4", + "tunnel-agent": "^0.6.0" + }, + "engines": { + "node": ">=14.15.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/shiki": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-3.2.2.tgz", + "integrity": "sha512-0qWBkM2t/0NXPRcVgtLhtHv6Ak3Q5yI4K/ggMqcgLRKm4+pCs3namgZlhlat/7u2CuqNtlShNs9lENOG6n7UaQ==", + "license": "MIT", + "dependencies": { + "@shikijs/core": "3.2.2", + "@shikijs/engine-javascript": "3.2.2", + "@shikijs/engine-oniguruma": "3.2.2", + "@shikijs/langs": "3.2.2", + "@shikijs/themes": "3.2.2", + "@shikijs/types": "3.2.2", + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/simple-concat": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/simple-concat/-/simple-concat-1.0.1.tgz", + "integrity": "sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/simple-get": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/simple-get/-/simple-get-4.0.1.tgz", + "integrity": "sha512-brv7p5WgH0jmQJr1ZDDfKDOSeWWg+OVypG99A/5vYGPqJ6pxiaHLy8nxtFjBA7oMa01ebA9gfh1uMCFqOuXxvA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "decompress-response": "^6.0.0", + "once": "^1.3.1", + "simple-concat": "^1.0.0" + } + }, + "node_modules/simple-swizzle": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.2.tgz", + "integrity": "sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg==", + "license": "MIT", + "dependencies": { + "is-arrayish": "^0.3.1" + } + }, + "node_modules/sisteransi": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", + "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", + "license": "MIT" + }, + "node_modules/sitemap": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/sitemap/-/sitemap-8.0.0.tgz", + "integrity": "sha512-+AbdxhM9kJsHtruUF39bwS/B0Fytw6Fr1o4ZAIAEqA6cke2xcoO2GleBw9Zw7nRzILVEgz7zBM5GiTJjie1G9A==", + "license": "MIT", + "dependencies": { + "@types/node": "^17.0.5", + "@types/sax": "^1.2.1", + "arg": "^5.0.0", + "sax": "^1.2.4" + }, + "bin": { + "sitemap": "dist/cli.js" + }, + "engines": { + "node": ">=14.0.0", + "npm": ">=6.0.0" + } + }, + "node_modules/sitemap/node_modules/@types/node": { + "version": "17.0.45", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.45.tgz", + "integrity": "sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw==", + "license": "MIT" + }, + "node_modules/smol-toml": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/smol-toml/-/smol-toml-1.3.1.tgz", + "integrity": "sha512-tEYNll18pPKHroYSmLLrksq233j021G0giwW7P3D24jC54pQ5W5BXMsQ/Mvw1OJCmEYDgY+lrzT+3nNUtoNfXQ==", + "license": "BSD-3-Clause", + "engines": { + "node": ">= 18" + }, + "funding": { + "url": "https://github.com/sponsors/cyyynthia" + } + }, + "node_modules/source-map": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.4.tgz", + "integrity": "sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==", + "license": "BSD-3-Clause", + "engines": { + "node": ">= 8" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/space-separated-tokens": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", + "integrity": "sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/stream-replace-string": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/stream-replace-string/-/stream-replace-string-2.0.0.tgz", + "integrity": "sha512-TlnjJ1C0QrmxRNrON00JvaFFlNh5TTG00APw23j74ET7gkQpTASi6/L2fuiav8pzK715HXtUeClpBTw2NPSn6w==", + "license": "MIT" + }, + "node_modules/streamx": { + "version": "2.22.0", + "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.22.0.tgz", + "integrity": "sha512-sLh1evHOzBy/iWRiR6d1zRcLao4gGZr3C1kzNz4fopCOKJb6xD9ub8Mpi9Mr1R6id5o43S+d93fI48UC5uM9aw==", + "license": "MIT", + "dependencies": { + "fast-fifo": "^1.3.2", + "text-decoder": "^1.1.0" + }, + "optionalDependencies": { + "bare-events": "^2.2.0" + } + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/string-width": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", + "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/stringify-entities": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-4.0.4.tgz", + "integrity": "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==", + "license": "MIT", + "dependencies": { + "character-entities-html4": "^2.0.0", + "character-entities-legacy": "^3.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/strip-ansi": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/style-to-js": { + "version": "1.1.16", + "resolved": "https://registry.npmjs.org/style-to-js/-/style-to-js-1.1.16.tgz", + "integrity": "sha512-/Q6ld50hKYPH3d/r6nr117TZkHR0w0kGGIVfpG9N6D8NymRPM9RqCUv4pRpJ62E5DqOYx2AFpbZMyCPnjQCnOw==", + "license": "MIT", + "dependencies": { + "style-to-object": "1.0.8" + } + }, + "node_modules/style-to-object": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/style-to-object/-/style-to-object-1.0.8.tgz", + "integrity": "sha512-xT47I/Eo0rwJmaXC4oilDGDWLohVhR6o/xAQcPQN8q6QBuZVL8qMYL85kLmST5cPjAorwvqIA4qXTRQoYHaL6g==", + "license": "MIT", + "dependencies": { + "inline-style-parser": "0.2.4" + } + }, + "node_modules/tar-fs": { + "version": "3.0.8", + "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-3.0.8.tgz", + "integrity": "sha512-ZoROL70jptorGAlgAYiLoBLItEKw/fUxg9BSYK/dF/GAGYFJOJJJMvjPAKDJraCXFwadD456FCuvLWgfhMsPwg==", + "license": "MIT", + "dependencies": { + "pump": "^3.0.0", + "tar-stream": "^3.1.5" + }, + "optionalDependencies": { + "bare-fs": "^4.0.1", + "bare-path": "^3.0.0" + } + }, + "node_modules/tar-stream": { + "version": "3.1.7", + "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-3.1.7.tgz", + "integrity": "sha512-qJj60CXt7IU1Ffyc3NJMjh6EkuCFej46zUqJ4J7pqYlThyd9bO0XBTmcOIhSzZJVWfsLks0+nle/j538YAW9RQ==", + "license": "MIT", + "dependencies": { + "b4a": "^1.6.4", + "fast-fifo": "^1.2.0", + "streamx": "^2.15.0" + } + }, + "node_modules/text-decoder": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.3.tgz", + "integrity": "sha512-3/o9z3X0X0fTupwsYvR03pJ/DjWuqqrfwBgTQzdWDiQSm9KitAyz/9WqsT2JQW7KV2m+bC2ol/zqpW37NHxLaA==", + "license": "Apache-2.0", + "dependencies": { + "b4a": "^1.6.4" + } + }, + "node_modules/tinyexec": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", + "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", + "license": "MIT" + }, + "node_modules/tinyglobby": { + "version": "0.2.12", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.12.tgz", + "integrity": "sha512-qkf4trmKSIiMTs/E63cxH+ojC2unam7rJ0WrauAzpT3ECNTxGRMlaXxVbfxMUC/w0LaYk6jQ4y/nGR9uBO3tww==", + "license": "MIT", + "dependencies": { + "fdir": "^6.4.3", + "picomatch": "^4.0.2" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/trim-lines": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", + "integrity": "sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/trough": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/trough/-/trough-2.2.0.tgz", + "integrity": "sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/tsconfck": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/tsconfck/-/tsconfck-3.1.5.tgz", + "integrity": "sha512-CLDfGgUp7XPswWnezWwsCRxNmgQjhYq3VXHM0/XIRxhVrKw0M1if9agzryh1QS3nxjCROvV+xWxoJO1YctzzWg==", + "license": "MIT", + "bin": { + "tsconfck": "bin/tsconfck.js" + }, + "engines": { + "node": "^18 || >=20" + }, + "peerDependencies": { + "typescript": "^5.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD", + "optional": true + }, + "node_modules/tunnel-agent": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", + "integrity": "sha512-McnNiV1l8RYeY8tBgEpuodCC1mLUdbSN+CYBL7kJsJNInOP8UjDDEwdk6Mw60vdLLrr5NHKZhMAOSrR2NZuQ+w==", + "license": "Apache-2.0", + "dependencies": { + "safe-buffer": "^5.0.1" + }, + "engines": { + "node": "*" + } + }, + "node_modules/type-fest": { + "version": "4.39.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.39.1.tgz", + "integrity": "sha512-uW9qzd66uyHYxwyVBYiwS4Oi0qZyUqwjU+Oevr6ZogYiXt99EOYtwvzMSLw1c3lYo2HzJsep/NB23iEVEgjG/w==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/typescript": { + "version": "5.8.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz", + "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", + "license": "Apache-2.0", + "peer": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/ufo": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.6.1.tgz", + "integrity": "sha512-9a4/uxlTWJ4+a5i0ooc1rU7C7YOw3wT+UGqdeNNHWnOF9qcMBgLRS+4IYUqbczewFx4mLEig6gawh7X6mFlEkA==", + "license": "MIT" + }, + "node_modules/ultrahtml": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/ultrahtml/-/ultrahtml-1.6.0.tgz", + "integrity": "sha512-R9fBn90VTJrqqLDwyMph+HGne8eqY1iPfYhPzZrvKpIfwkWZbcYlfpsb8B9dTvBfpy1/hqAD7Wi8EKfP9e8zdw==", + "license": "MIT" + }, + "node_modules/uncrypto": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/uncrypto/-/uncrypto-0.1.3.tgz", + "integrity": "sha512-Ql87qFHB3s/De2ClA9e0gsnS6zXG27SkTiSJwjCc9MebbfapQfuPzumMIUMi38ezPZVNFcHI9sUIepeQfw8J8Q==", + "license": "MIT" + }, + "node_modules/undici-types": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz", + "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==", + "license": "MIT" + }, + "node_modules/unified": { + "version": "11.0.5", + "resolved": "https://registry.npmjs.org/unified/-/unified-11.0.5.tgz", + "integrity": "sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "bail": "^2.0.0", + "devlop": "^1.0.0", + "extend": "^3.0.0", + "is-plain-obj": "^4.0.0", + "trough": "^2.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-find-after": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-find-after/-/unist-util-find-after-5.0.0.tgz", + "integrity": "sha512-amQa0Ep2m6hE2g72AugUItjbuM8X8cGQnFoHk0pGfrFeT9GZhzN5SW8nRsiGKK7Aif4CrACPENkA6P/Lw6fHGQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-is": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.0.tgz", + "integrity": "sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-modify-children": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-modify-children/-/unist-util-modify-children-4.0.0.tgz", + "integrity": "sha512-+tdN5fGNddvsQdIzUF3Xx82CU9sMM+fA0dLgR9vOmT0oPT2jH+P1nd5lSqfCfXAw+93NhcXNY2qqvTUtE4cQkw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "array-iterate": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position/-/unist-util-position-5.0.0.tgz", + "integrity": "sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position-from-estree": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position-from-estree/-/unist-util-position-from-estree-2.0.0.tgz", + "integrity": "sha512-KaFVRjoqLyF6YXCbVLNad/eS4+OfPQQn2yOd7zF/h5T/CSL2v8NpN6a5TPvtbXthAGw5nG+PuTtq+DdIZr+cRQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-remove-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-remove-position/-/unist-util-remove-position-5.0.0.tgz", + "integrity": "sha512-Hp5Kh3wLxv0PHj9m2yZhhLt58KzPtEYKQQ4yxfYFEO7EvHwzyDYnduhHnY1mDxoqr7VUwVuHXk9RXKIiYS1N8Q==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-visit": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-stringify-position": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", + "integrity": "sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-5.0.0.tgz", + "integrity": "sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit-children": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/unist-util-visit-children/-/unist-util-visit-children-3.0.0.tgz", + "integrity": "sha512-RgmdTfSBOg04sdPcpTSD1jzoNBjt9a80/ZCzp5cI9n1qPzLZWF9YdvWGN2zmTumP1HWhXKdUWexjy/Wy/lJ7tA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit-parents": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz", + "integrity": "sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unstorage": { + "version": "1.15.0", + "resolved": "https://registry.npmjs.org/unstorage/-/unstorage-1.15.0.tgz", + "integrity": "sha512-m40eHdGY/gA6xAPqo8eaxqXgBuzQTlAKfmB1iF7oCKXE1HfwHwzDJBywK+qQGn52dta+bPlZluPF7++yR3p/bg==", + "license": "MIT", + "dependencies": { + "anymatch": "^3.1.3", + "chokidar": "^4.0.3", + "destr": "^2.0.3", + "h3": "^1.15.0", + "lru-cache": "^10.4.3", + "node-fetch-native": "^1.6.6", + "ofetch": "^1.4.1", + "ufo": "^1.5.4" + }, + "peerDependencies": { + "@azure/app-configuration": "^1.8.0", + "@azure/cosmos": "^4.2.0", + "@azure/data-tables": "^13.3.0", + "@azure/identity": "^4.6.0", + "@azure/keyvault-secrets": "^4.9.0", + "@azure/storage-blob": "^12.26.0", + "@capacitor/preferences": "^6.0.3", + "@deno/kv": ">=0.9.0", + "@netlify/blobs": "^6.5.0 || ^7.0.0 || ^8.1.0", + "@planetscale/database": "^1.19.0", + "@upstash/redis": "^1.34.3", + "@vercel/blob": ">=0.27.1", + "@vercel/kv": "^1.0.1", + "aws4fetch": "^1.0.20", + "db0": ">=0.2.1", + "idb-keyval": "^6.2.1", + "ioredis": "^5.4.2", + "uploadthing": "^7.4.4" + }, + "peerDependenciesMeta": { + "@azure/app-configuration": { + "optional": true + }, + "@azure/cosmos": { + "optional": true + }, + "@azure/data-tables": { + "optional": true + }, + "@azure/identity": { + "optional": true + }, + "@azure/keyvault-secrets": { + "optional": true + }, + "@azure/storage-blob": { + "optional": true + }, + "@capacitor/preferences": { + "optional": true + }, + "@deno/kv": { + "optional": true + }, + "@netlify/blobs": { + "optional": true + }, + "@planetscale/database": { + "optional": true + }, + "@upstash/redis": { + "optional": true + }, + "@vercel/blob": { + "optional": true + }, + "@vercel/kv": { + "optional": true + }, + "aws4fetch": { + "optional": true + }, + "db0": { + "optional": true + }, + "idb-keyval": { + "optional": true + }, + "ioredis": { + "optional": true + }, + "uploadthing": { + "optional": true + } + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "license": "MIT" + }, + "node_modules/vfile": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/vfile/-/vfile-6.0.3.tgz", + "integrity": "sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-location": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/vfile-location/-/vfile-location-5.0.3.tgz", + "integrity": "sha512-5yXvWDEgqeiYiBe1lbxYF7UMAIm/IcopxMHrMQDq3nvKcjPKIhZklUKL+AE7J7uApI4kwe2snsK+eI6UTj9EHg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-message": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-4.0.2.tgz", + "integrity": "sha512-jRDZ1IMLttGj41KcZvlrYAaI3CfqpLpfpf+Mfig13viT6NKvRzWZ+lXz0Y5D60w6uJIBAOGq9mSHf0gktF0duw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vite": { + "version": "6.2.6", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.2.6.tgz", + "integrity": "sha512-9xpjNl3kR4rVDZgPNdTL0/c6ao4km69a/2ihNQbcANz8RuCOK3hQBmLSJf3bRKVQjVMda+YvizNE8AwvogcPbw==", + "license": "MIT", + "dependencies": { + "esbuild": "^0.25.0", + "postcss": "^8.5.3", + "rollup": "^4.30.1" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "jiti": ">=1.21.0", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "sass-embedded": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vitefu": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/vitefu/-/vitefu-1.0.6.tgz", + "integrity": "sha512-+Rex1GlappUyNN6UfwbVZne/9cYC4+R2XDk9xkNXBKMw6HQagdX9PgZ8V2v1WUSK1wfBLp7qbI1+XSNIlB1xmA==", + "license": "MIT", + "workspaces": [ + "tests/deps/*", + "tests/projects/*" + ], + "peerDependencies": { + "vite": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0" + }, + "peerDependenciesMeta": { + "vite": { + "optional": true + } + } + }, + "node_modules/web-namespaces": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/web-namespaces/-/web-namespaces-2.0.1.tgz", + "integrity": "sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/which-pm-runs": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/which-pm-runs/-/which-pm-runs-1.1.0.tgz", + "integrity": "sha512-n1brCuqClxfFfq/Rb0ICg9giSZqCS+pLtccdag6C2HyufBrh3fBOiy9nb6ggRMvWOVH5GrdJskj5iGTZNxd7SA==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/widest-line": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-5.0.0.tgz", + "integrity": "sha512-c9bZp7b5YtRj2wOe6dlj32MK+Bx/M/d+9VB2SHM1OtsUHR0aV0tdP6DWh/iMt0kWi1t5g1Iudu6hQRNd1A4PVA==", + "license": "MIT", + "dependencies": { + "string-width": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/wrap-ansi": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.0.tgz", + "integrity": "sha512-G8ura3S+3Z2G+mkgNRq8dqaFZAuxfsxpBB8OCTGRTCtp+l/v9nbFNmCUP1BZMts3G1142MsZfn6eeUKrr4PD1Q==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^6.2.1", + "string-width": "^7.0.0", + "strip-ansi": "^7.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "license": "ISC" + }, + "node_modules/xxhash-wasm": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/xxhash-wasm/-/xxhash-wasm-1.1.0.tgz", + "integrity": "sha512-147y/6YNh+tlp6nd/2pWq38i9h6mz/EuQ6njIrmW8D1BS5nCqs0P6DG+m6zTGnNz5I+uhZ0SHxBs9BsPrwcKDA==", + "license": "MIT" + }, + "node_modules/yargs-parser": { + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "license": "ISC", + "engines": { + "node": ">=12" + } + }, + "node_modules/yocto-queue": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.1.tgz", + "integrity": "sha512-AyeEbWOu/TAXdxlV9wmGcR0+yh2j3vYPGOECcIj2S7MkrLyC7ne+oye2BKTItt0ii2PHk4cDy+95+LshzbXnGg==", + "license": "MIT", + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/yocto-spinner": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/yocto-spinner/-/yocto-spinner-0.2.1.tgz", + "integrity": "sha512-lHHxjh0bXaLgdJy3cNnVb/F9myx3CkhrvSOEVTkaUgNMXnYFa2xYPVhtGnqhh3jErY2gParBOHallCbc7NrlZQ==", + "license": "MIT", + "dependencies": { + "yoctocolors": "^2.1.1" + }, + "engines": { + "node": ">=18.19" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/yoctocolors": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/yoctocolors/-/yoctocolors-2.1.1.tgz", + "integrity": "sha512-GQHQqAopRhwU8Kt1DDM8NjibDXHC8eoh1erhGAJPEyveY9qqVeXvVikNKrDz69sHowPMorbPUrH/mx8c50eiBQ==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/zod": { + "version": "3.24.2", + "resolved": "https://registry.npmjs.org/zod/-/zod-3.24.2.tgz", + "integrity": "sha512-lY7CDW43ECgW9u1TcT3IoXHflywfVqDYze4waEz812jR/bZ8FHDsl7pFQoSZTz5N+2NqRXs8GBwnAwo3ZNxqhQ==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/colinhacks" + } + }, + "node_modules/zod-to-json-schema": { + "version": "3.24.5", + "resolved": "https://registry.npmjs.org/zod-to-json-schema/-/zod-to-json-schema-3.24.5.tgz", + "integrity": "sha512-/AuWwMP+YqiPbsJx5D6TfgRTc4kTLjsh5SOcd4bLsfUg2RcEXrFMJl1DGgdHy2aCfsIA/cr/1JM0xcB2GZji8g==", + "license": "ISC", + "peerDependencies": { + "zod": "^3.24.1" + } + }, + "node_modules/zod-to-ts": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/zod-to-ts/-/zod-to-ts-1.2.0.tgz", + "integrity": "sha512-x30XE43V+InwGpvTySRNz9kB7qFU8DlyEy7BsSTCHPH1R0QasMmHWZDCzYm6bVXtj/9NNJAZF3jW8rzFvH5OFA==", + "peerDependencies": { + "typescript": "^4.9.4 || ^5.0.2", + "zod": "^3" + } + }, + "node_modules/zwitch": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", + "integrity": "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..2782f72 --- /dev/null +++ b/package.json @@ -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" + } +} \ No newline at end of file diff --git a/public/favicon.svg b/public/favicon.svg new file mode 100644 index 0000000..cba5ac1 --- /dev/null +++ b/public/favicon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/assets/houston.webp b/src/assets/houston.webp new file mode 100644 index 0000000..930c164 Binary files /dev/null and b/src/assets/houston.webp differ diff --git a/src/content.config.ts b/src/content.config.ts new file mode 100644 index 0000000..d9ee8c9 --- /dev/null +++ b/src/content.config.ts @@ -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() }), +}; diff --git a/src/content/docs/bsp/ZipАрхивы.md b/src/content/docs/bsp/ZipАрхивы.md new file mode 100644 index 0000000..cc8125d --- /dev/null +++ b/src/content/docs/bsp/ZipАрхивы.md @@ -0,0 +1,221 @@ +--- +title: Zip архивы +slug: bsp/zip-архивы +--- + + +## Создать +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ИмяФайла - Строка +// +// Возвращаемое значение: +// Структура - Описание: +// * ИмяФайла - Строка +// * Размер - Число +// * РазмерКаталога - Число +// * Файлы - Массив Из см. ПрочитатьЗаписьКаталога +// * Поток - ФайловыйПоток +// +Функция Создать(ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ZipАрхивы.Создать(ИмяФайла) +``` +
+ +## ДобавитьФайл +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Архив - см. Создать +// ИмяФайла - Строка +// +Процедура ДобавитьФайл(Архив, ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +ZipАрхивы.ДобавитьФайл(Архив, ИмяФайла) +``` +
+ +## Размер +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Архив - см. Создать +// +// Возвращаемое значение: +// Число +Функция Размер(Архив) Экспорт +``` + +Пример вызова +```bsl +Результат = ZipАрхивы.Размер(Архив) +``` +
+ +## ОтделитьЧасть +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Архив - см. Создать +// ИмяФайла - Строка +// +Процедура ОтделитьЧасть(Архив, ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +ZipАрхивы.ОтделитьЧасть(Архив, ИмяФайла) +``` +
+ +## Завершить +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Архив - см. Создать +// +Процедура Завершить(Архив) Экспорт +``` + +Пример вызова +```bsl +ZipАрхивы.Завершить(Архив) +``` +
+ +## ПрочитатьАрхив +
+ +Описание, пример вызова + +```bsl + +// Прочитать архив. +// +// Параметры: +// Источник - ФайловыйПоток, ПотокВПамяти, УникальныйИдентификатор - +// источник архива, если УникальныйИдентификатор - то это файл в томе. +// +// Возвращаемое значение: +// Структура: +// * КаталогФайлов - Соответствие из КлючИЗначение: +// ** Ключ - строка - имя файла. +// ** Значение - см. ПрочитатьЗаписьКаталога +// * Источник - ФайловыйПоток, ПотокВПамяти, УникальныйИдентификатор - +// * КонецКаталога - см. КонецКаталога +// * Смещение - Число +// * Размер - Число +// - Неопределено +Функция ПрочитатьАрхив(Источник) Экспорт +``` + +Пример вызова +```bsl +Результат = ZipАрхивы.ПрочитатьАрхив(Источник) +``` +
+ +## ПрочитатьВложенныйНесжатыйАрхив +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ДанныеАрхива - см. ZipАрхивы.ПрочитатьАрхив +// ИмяФайла - Строка - имя файла в архиве +// +// Возвращаемое значение: +// см. ПрочитатьАрхив +Функция ПрочитатьВложенныйНесжатыйАрхив(ДанныеАрхива, ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ZipАрхивы.ПрочитатьВложенныйНесжатыйАрхив(ДанныеАрхива, ИмяФайла) +``` +
+ +## ИзвлечьФайл +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ДанныеАрхива - см. ZipАрхивы.ПрочитатьАрхив +// ИмяФайла - Строка +// Каталог - Строка +// +// Возвращаемое значение: +// Булево +Функция ИзвлечьФайл(ДанныеАрхива, ИмяФайла, Каталог) Экспорт +``` + +Пример вызова +```bsl +Результат = ZipАрхивы.ИзвлечьФайл(ДанныеАрхива, ИмяФайла, Каталог) +``` +
+ +## ПрочитатьФайл +
+ +Описание, пример вызова + +```bsl + +// Прочитать файл +// +// Параметры: +// ДанныеАрхива - см. ZipАрхивы.ПрочитатьАрхив +// ИмяФайла - Строка +// +// Возвращаемое значение: +// ДвоичныеДанные, Неопределено - Прочитать файл +Функция ПрочитатьФайл(ДанныеАрхива, ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ZipАрхивы.ПрочитатьФайл(ДанныеАрхива, ИмяФайла) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/АвтономнаяРабота.md b/src/content/docs/bsp/АвтономнаяРабота.md new file mode 100644 index 0000000..a9d5dd9 --- /dev/null +++ b/src/content/docs/bsp/АвтономнаяРабота.md @@ -0,0 +1,142 @@ +--- +title: Автономная работа +slug: bsp/автономная-работа +--- + + +## ОбъектПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик события формы ПриЧтенииНаСервере, который +// встраивается в формы элементов данных +// (элементов справочников, документов, записей регистров, и др.), +// чтобы заблокировать форму, если это попытка изменения неразделенных данных, +// получаемых из приложения, в автономном рабочем месте. +// +// Параметры: +// ТекущийОбъект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект +// - РегистрСведенийМенеджерЗаписи - менеджер записи. +// ТолькоПросмотр - Булево - свойство ТолькоПросмотр формы. +// +Процедура ОбъектПриЧтенииНаСервере(ТекущийОбъект, ТолькоПросмотр) Экспорт +``` + +Пример вызова +```bsl +АвтономнаяРабота.ОбъектПриЧтенииНаСервере(ТекущийОбъект, ТолькоПросмотр) +``` +
+ +## ОтключитьАвтоматическуюСинхронизациюДанныхСПриложениемВИнтернете +
+ +Описание, пример вызова + +```bsl + +// Отключает автоматическую синхронизацию между приложением в интернете +// и автономным рабочим местом в случаях когда, не задан пароль для установки подключения. +// +// Параметры: +// Источник - Справочник.НастройкиТранспортаСообщенийОбмена - запись справочника настроек транспорта, +// которая была изменена. +// +Процедура ОтключитьАвтоматическуюСинхронизациюДанныхСПриложениемВИнтернете(Источник) Экспорт +``` + +Пример вызова +```bsl +АвтономнаяРабота.ОтключитьАвтоматическуюСинхронизациюДанныхСПриложениемВИнтернете(Источник) +``` +
+ +## ФлагНастройкиВопросаОДолгойСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Читает и устанавливает настройку предупреждения о продолжительной синхронизации АРМ. +// +// Параметры: +// ЗначениеФлага - Булево - устанавливаемое значение флага +// ОписаниеНастройки - Структура - принимает значение для описания настройки. +// +// Возвращаемое значение: +// Булево, Неопределено - значение настройки отображения предупреждения о долгой синхронизации. +// +Функция ФлагНастройкиВопросаОДолгойСинхронизации(ЗначениеФлага = Неопределено, ОписаниеНастройки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АвтономнаяРабота.ФлагНастройкиВопросаОДолгойСинхронизации(ЗначениеФлага, ОписаниеНастройки); +``` +
+ +## АдресДляВосстановленияПароляУчетнойЗаписи +
+ +Описание, пример вызова + +```bsl + +// Возвращает адрес для восстановления пароля учетной записи приложения в интернете. +// +// Возвращаемое значение: +// Строка - адрес восстановления пароля учетной записи. +// +Функция АдресДляВосстановленияПароляУчетнойЗаписи() Экспорт +``` + +Пример вызова +```bsl +Результат = АвтономнаяРабота.АдресДляВосстановленияПароляУчетнойЗаписи() +``` +
+ +## ПродолжитьНастройкуАвтономногоРабочегоМеста +
+ +Описание, пример вызова + +```bsl + +// Настраивает автономное рабочее место при первом запуске. +// Заполняет состав пользователей и другие настройки. +// Вызывается перед авторизацией пользователя. Может потребоваться перезапуск. +// +// Параметры: +// Параметры - Структура - структура параметров. +// +// Возвращаемое значение: +// Булево - признак возможности продолжения настройки автономного рабочего места. +// +Функция ПродолжитьНастройкуАвтономногоРабочегоМеста(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = АвтономнаяРабота.ПродолжитьНастройкуАвтономногоРабочегоМеста(Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/АдминистрированиеКластера.md b/src/content/docs/bsp/АдминистрированиеКластера.md new file mode 100644 index 0000000..4f3e967 --- /dev/null +++ b/src/content/docs/bsp/АдминистрированиеКластера.md @@ -0,0 +1,1509 @@ +--- +title: Администрирование кластера +slug: bsp/администрирование-кластера +--- + + +## ПараметрыАдминистрированияКластера +
+ +Описание, пример вызова + +```bsl + +// Параметры подключения к администрируемому кластеру серверов. +// +// Возвращаемое значение: +// Структура: +// * ТипПодключения - Строка - возможные значения: +// "COM" - при подключении к агенту сервера с использованием COM-объекта V8*.ComConnector; +// "RAS" - при подключении к серверу администрирования (ras) с использованием консольного +// клиента сервера администрирования (rac); +// * АдресАгентаСервера - Строка - сетевой адрес агента сервера (только при ТипПодключения = "COM"); +// * ПортАгентаСервера - Число - сетевой порт агента сервера (только при ТипПодключения = "COM"), +// типичное значение 1540; +// * АдресСервераАдминистрирования - Строка - сетевой адрес сервера администрирования ras (только. +// При ТипПодключения = "RAS"); +// * ПортСервераАдминистрирования - Число - сетевой порт сервера администрирования ras (только при. +// ТипПодключения = "RAS"), типичное значение 1545; +// * ПортКластера - Число - сетевой порт менеджера администрируемого кластера, типичное значение 1541; +// * ИмяАдминистратораКластера - Строка - имя учетной записи администратора кластера (если для кластера +// не задан список администраторов - используется пустая строка); +// * ПарольАдминистратораКластера - Строка - пароль учетной записи администратора кластера (если +// для кластера не задан список администраторов или для учетной записи не установлен пароль - +// используется пустая строка). +// +Функция ПараметрыАдминистрированияКластера() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ПараметрыАдминистрированияКластера() +``` +
+ +## ПараметрыАдминистрированияИнформационнойБазыКластера +
+ +Описание, пример вызова + +```bsl + +// Параметры подключения к администрируемой информационной базе кластера. +// +// Возвращаемое значение: +// Структура: +// * ИмяВКластере - Строка - имя администрируемой информационной базы в кластере серверов, +// * ИмяАдминистратораИнформационнойБазы - Строка - имя пользователя информационной базы с правами +// администратора (если для информационной базы не задан список пользователей ИБ - используется +// пустая строка), +// * ПарольАдминистратораИнформационнойБазы - Строка - пароль пользователя информационной базы +// с правами администратора (если для информационной базы не задан список пользователей ИБ или +// для пользователя ИБ не установлен пароль - используется пустая строка). +// +Функция ПараметрыАдминистрированияИнформационнойБазыКластера() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера() +``` +
+ +## ПроверитьПараметрыАдминистрирования +
+ +Описание, пример вызова + +```bsl + +// Проверяет корректность параметров администрирования. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// ПроверятьПараметрыАдминистрированияКластера - Булево - флаг необходимости проверки параметров администрирования +// кластера. +// ПроверятьПараметрыАдминистрированияИнформационнойБазы - Булево - флаг необходимости проверки параметров +// администрирования кластера. +// +Процедура ПроверитьПараметрыАдминистрирования(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.ПроверитьПараметрыАдминистрирования(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, ); +``` +
+ +## СвойстваБлокировкиСеансовИРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// Свойства блокировки сеансов и регламентных заданий информационной базы. +// +// Возвращаемое значение: +// Структура: +// * БлокировкаСеансов - Булево - флаг установки блокировки новых сеансов с информационной базой, +// * ДатаС - Дата - момент начала блокировки новых сеансов с информационной базой, +// * ДатаПо - Дата - момент окончания блокировки новых сеансов с информационной базой, +// * Сообщение - Строка - сообщение, отображаемое пользователю при попытке установки нового сеанса +// с информационной базой при установленной блокировке новых сеансов, +// * КодРазрешения - Строка - код обхода блокировки новых сеансов с информационной базой, +// * БлокировкаРегламентныхЗаданий - Булево - флаг блокировки выполнения регламентных заданий информационной базы. +// +Функция СвойстваБлокировкиСеансовИРегламентныхЗаданий() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваБлокировкиСеансовИРегламентныхЗаданий() +``` +
+ +## БлокировкаСеансовИЗаданийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущее состояние блокировки сеансов и регламентных заданий для информационной базы. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// +// Возвращаемое значение: +// см. АдминистрированиеКластера.СвойстваБлокировкиСеансовИРегламентныхЗаданий +// +Функция БлокировкаСеансовИЗаданийИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.БлокировкаСеансовИЗаданийИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ); +``` +
+ +## УстановитьБлокировкуСеансовИЗаданийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устанавливает новое состояние блокировки сеансов и регламентных заданий для информационной базы. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// СвойстваБлокировкиСеансовИЗаданий - см. АдминистрированиеКластера.СвойстваБлокировкиСеансовИРегламентныхЗаданий +// +Процедура УстановитьБлокировкуСеансовИЗаданийИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ, Знач СвойстваБлокировкиСеансовИЗаданий) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.УстановитьБлокировкуСеансовИЗаданийИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, СвойстваБлокировкиСеансовИЗаданий) +``` +
+ +## СнятьБлокировкуСеансовИЗаданийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Снимает блокировку сеансов и регламентных заданий для информационной базы. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// +Процедура СнятьБлокировкуСеансовИЗаданийИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.СнятьБлокировкуСеансовИЗаданийИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ); +``` +
+ +## БлокировкаРегламентныхЗаданийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущее состояние блокировки регламентных заданий для информационной базы. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// +// Возвращаемое значение: +// Булево - блокировка установлена. +// +Функция БлокировкаРегламентныхЗаданийИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.БлокировкаРегламентныхЗаданийИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ); +``` +
+ +## УстановитьБлокировкуРегламентныхЗаданийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устанавливает новое состояние блокировки регламентных заданий для информационной базы. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// БлокировкаРегламентныхЗаданий - Булево - флаг установки блокировки регламентных заданий информационной базы. +// +Процедура УстановитьБлокировкуРегламентныхЗаданийИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ, Знач БлокировкаРегламентныхЗаданий) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.УстановитьБлокировкуРегламентныхЗаданийИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, БлокировкаРегламентныхЗаданий) +``` +
+ +## СвойстваСеанса +
+ +Описание, пример вызова + +```bsl + +// Свойства сеанса информационной базы. +// +// Возвращаемое значение: +// Структура: +// * Номер - Число - номер сеанса. Уникален среди всех сеансов информационной базы, +// * ИмяПользователя - Строка - имя аутентифицированного пользователя информационной базы, +// * ИмяКлиентскогоКомпьютера - Строка - имя или сетевой адрес компьютера, установившего +// сеанс с информационной базой, +// * ИдентификаторКлиентскогоПриложения - Строка - идентификатор приложения, установившего сеанс. +// Возможные значения - см. описание к функции глобального контекста ПредставлениеПриложения(), +// * ИдентификаторЯзыка - Строка - идентификатор языка интерфейса, +// * МоментСозданияСеанса - Дата - момент установки сеанса, +// * МоментПоследнейАктивностиСеанса - Дата - момент последней активности сеанса, +// * Блокировка - Число - номер сеанса, который является причиной ожидания управляемой транзакционной +// блокировки в том случае, если сеанс выполняет установку управляемых транзакционных блокировок +// и ожидает снятия блокировок, установленных другим сеансом (иначе - значение равно 0), +// * БлокировкаСУБД - Число - номер сеанса, который является причиной ожидания транзакционной +// блокировки в том случае, если сеанс исполняет запрос к СУБД и ожидает транзакционную +// блокировку, установленную другим сеансом (иначе - значение равно 0), +// * Передано - Число - объем данных, переданных меду сервером "1С:Предприятия" и клиентским приложением +// данного сеанса с момента начала сеанса (в байтах), +// * ПереданоЗа5Минут - Число - объем данных, переданных между сервером "1С:Предприятия" и клиентским +// приложением данного сеанса за последние 5 минут (в байтах), +// * СерверныхВызовов - Число - количество вызовов сервера "1С:Предприятия" от имена данного сеанса с +// момента начала сеанса, +// * СерверныхВызововЗа5Минут - Число - количество вызовов сервера "1С:Предприятия" от имени данного сеанса +// за последние 5 минут, +// * ДлительностьСерверныхВызовов - Число - время исполнения вызовов сервера "1С:Предприятия" от имени +// данного сеанса с момента начала сеанса (в секундах), +// * ДлительностьТекущегоСерверногоВызова - Число - интервал времени в миллисекундах, прошедший с момента начала +// обращения, в случае, если сеанс выполняется вызов сервера "1С:Предприятия" (иначе - значение равно 0), +// * ДлительностьСерверныхВызововЗа5Минут - Число - время исполнения вызовов сервера 1С:Предприятия от имени +// данного сеанса за последние 5 минут (в миллисекундах), +// * ПереданоСУБД - Число - количество данных, переданных и полученных от СУБД от имени данного сеанса с +// момента начала сеанса (в байтах), +// * ПереданоСУБДЗа5Минут - Число - количество данных, переданных и полученных от СУБД от имени данного сеанса +// за последние 5 минут (в байтах), +// * ДлительностьВызововСУБД - Число - время исполнения запросов к СУБД от имени данного сеанса с момента начала +// сеанса (в миллисекундах), +// * ДлительностьТекущегоВызоваСУБД - Число - интервал времени в миллисекундах, прошедший с начала выполнения +// запроса в случае, если сеанс выполняет запрос к СУБД (иначе - значение равно 0), +// * ДлительностьВызововСУБДЗа5Минут - Число - суммарное время исполнения запросов к СУБД от имени данного сеанса +// за последние 5 минут (в миллисекундах). +// * СоединениеСУБД - Строка - номер соединения с СУБД в терминах СУБД в том случае, если в момент получения списка +// сеансов выполняется запрос к СУБД, открыта транзакция или определены временные таблицы (т.е. захвачено +// соединение с СУБД). Если соединение с СУБД не захвачено - значение равно пустой строке, +// * ВремяСоединенияСУБД - Число - время соединения с СУБД с момента захвата (в миллисекундах). Если соединение с. +// СУБД не захвачено - значение равно 0, +// * МоментЗахватаСоединенияСУБД - Дата - момент времени, когда соединение с СУБД было последний раз +// захвачено другим сеансом. +// * ОписаниеСоединения - Структура +// - Неопределено - содержит описание соединения, которому назначен сеанс, +// описание полей см. АдминистрированиеКластера.СвойстваОписанияСоединения. Иначе - Неопределено. +// * Спящий - Булево - сеанс находится в спящем режиме. +// * ЗавершитьЧерез - Число - интервал времени в секундах, по истечении которого спящий сеанс завершается. +// * ЗаснутьЧерез - Число - интервал времени в секундах, по истечении которого неактивный сеанс переводится в спящий +// режим. +// * ПрочитаноСДиска - Число - содержит количество данных в байтах, прочитанных с диска сеансом с момента начала сеанса. +// * ПрочитаноСДискаВТекущемВызове - Число - содержит количество данных в байтах, прочитанных с диска с начала +// выполнения текущего вызова. +// * ПрочитаноСДискаЗа5Минут - Число - содержит количество данных в байтах, прочитанных с диска сеансом за последние +// 5 минут. +// * Лицензия - Структура +// - Неопределено - содержит информацию о клиентской лицензии, используемой этим сеансом, +// описание полей см. АдминистрированиеКластера.СвойстваЛицензии. +// Неопределено, если сеанс не использует лицензию. +// * ЗанятоПамяти - Число - содержит объем памяти в байтах, занятый в процессе вызовов с момента начала сеанса. +// * ЗанятоПамятиВТекущемВызове - Число - содержит объем памяти в байтах, занятый с начала выполнения текущего вызова. +// Если в данный момент вызов не выполняется, содержит 0. +// * ЗанятоПамятиЗа5Минут - Число - содержит объем памяти в байтах, занятый в процессе вызовов за последние 5 минут. +// * ЗаписаноНаДиск - Число - содержит количество данных в байтах, записанных на диск сеансом с момента начала сеанса. +// * ЗаписаноНаДискВТекущемВызове - Число - содержит количество данных в байтах, записанных на диск с начала +// выполнения текущего вызова. +// * ЗаписаноНаДискЗа5Минут - Число - содержит количество данных в байтах, записанных на диск сеансом за последние 5 +// минут. +// * РабочийПроцесс - Структура +// - Неопределено - содержит рабочий процесс, с которым установлено соединение, если +// сеанс назначен соединению, описание полей см. АдминистрированиеКластера.СвойстваРабочегоПроцесса. +// Иначе - Неопределено. +// +Функция СвойстваСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваСеанса() +``` +
+ +## СвойстваЛицензии +
+ +Описание, пример вызова + +```bsl + +// Свойства лицензии. +// +// Возвращаемое значение: +// Структура: +// * ИмяФайла - Строка - содержит полное имя используемого файла программной лицензии. +// * ПолноеПредставление - Строка - содержит локализованное строковое представление лицензии, как в свойстве +// "Лицензия" диалога свойств сеанса или свойств рабочего процесса консоли кластера +// * КраткоеПредставление - Строка - содержит локализованное строковое представление лицензии, как в колонке +// "Лицензия" списка сеансов или рабочих процессов. +// * ВыданаСервером - Булево - Истина - лицензия получена сервером "1С:Предприятия" и выдана клиентскому приложению. +// Ложь - лицензия получена клиентским приложением. +// * ТипЛицензии - Число - содержит тип лицензии: +// 0 - программная лицензия платформы; +// 1 - аппаратная лицензия (ключ защиты программы). +// * МаксимальноеКоличествоПользователейДляКомплекта - Число - содержит максимальное количество пользователей, +// допустимое для данного комплекта, если используется программная лицензия платформы. Иначе совпадает +// с значением свойства MaxUsersCur. +// * МаксимальноеКоличествоПользователейВКлюче - Число - содержит максимальное количество пользователей в +// используемом ключе защиты программы или в используемом файле программной лицензии. +// * ЛицензияПолученаЧерезAladdinLicenseManager - Булево - Истина, если для аппаратной лицензии ключ защиты программы +// является сетевым, лицензия получена через менеджер лицензий Aladdin License Manager; Ложь в +// противном случае. +// * АдресПроцесса - Строка - содержит адрес сервера, на котором запущен процесс, получивший лицензию. +// * ИдентификаторПроцесса - Строка - содержит идентификатор процесса, получившего лицензию, присвоенный ему +// операционной системой. +// * ПортПроцесса - Число - содержит номер IP-порта серверного процесса, получившего лицензию. +// * СерияКлюча - Строка - содержит серию ключа защиты программы для аппаратной лицензии или регистрационный номер +// комплекта для программной лицензии платформы. +// +Функция СвойстваЛицензии() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваЛицензии() +``` +
+ +## СвойстваОписанияСоединения +
+ +Описание, пример вызова + +```bsl + +// Свойства описания соединения. +// +// Возвращаемое значение: +// Структура: +// * ИмяПриложения - Строка - содержит имя приложения, установившего соединение с фермой серверов "1С:Предприятия". +// * Блокировка - Число - содержит идентификатор соединения, блокирующего работу данного соединения (в Сервисе +// транзакционных блокировок). +// * МоментУстановкиСоединения - Дата - содержит момент времени, когда соединение было установлено. +// * Номер - Число - содержит идентификатор соединения. Позволяет различить разные соединения, установленные одним +// и тем же приложением с одного и того же клиентского компьютера +// * ИмяКлиентскогоКомпьютера - Строка - содержит имя пользовательского компьютера, с которого установлено соединение. +// * НомерСеанса - Число - содержит номер сеанса, если соединению назначен сеанс, иначе - 0. +// * РабочийПроцесс - Структура - содержит интерфейс объекта с описанием серверного процесса, с которым установлено +// данное соединение. +// +Функция СвойстваОписанияСоединения() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваОписанияСоединения() +``` +
+ +## СвойстваРабочегоПроцесса +
+ +Описание, пример вызова + +```bsl + +// Свойства рабочего процесса. +// +// Возвращаемое значение: +// Структура: +// * ДоступнаяПроизводительность - Число - средняя за последние 5 минут доступная производительность. Определяется +// по времени реакции рабочего процесса на эталонный запрос. В соответствии с доступной +// производительностью кластер серверов принимает решение о распределении клиентов между рабочими +// процессами. +// * ЗатраченоКлиентом - Число - показывает среднее время, затрачиваемое рабочим процессом на обратные вызовы +// методов клиентского приложения при выполнении одного клиентского обращения +// * РеакцияСервера - Число - показывает среднее время обслуживания рабочим процессом одного клиентского обращения. +// Оно складывается из: значений свойств ЗатраченоСервером, ЗатраченоСУБД, ЗатраченоМенеджеромБлокировок, +// ЗатраченоКлиентом. +// * ЗатраченоСУБД - Число - показывает среднее время, затрачиваемое рабочим процессом на обращения к серверу баз +// данных при выполнении одного клиентского обращения. +// * ЗатраченоМенеджеромБлокировок - Число - показывает среднее время обращения к менеджеру блокировок. +// * ЗатраченоСервером - Число - показывает среднее время, затрачиваемое самим рабочим процессом на выполнение +// одного клиентского обращения. +// * КлиентскихПотоков - Число - показывает среднее количество клиентских потоков, исполняемых рабочим процессом кластера. +// * ОтносительнаяПроизводительность - Число - относительная производительность процесса. Может находиться в +// диапазоне от 1 до 1000. Используется в процессе выбора рабочего процесса, к которому будет +// подсоединен очередной клиент. Клиенты распределяются между рабочими процессами пропорционально +// производительности рабочих процессов. +// * Соединений - Число - количество соединений рабочего процесса с пользовательскими приложениями. +// * ИмяКомпьютера - Строка - содержит имя или IP-адрес компьютера, на котором должен быть запущен рабочий процесс. +// * Включен - Булево - устанавливается кластером при необходимости запустить или остановить рабочий процесс. +// Истина - процесс должен быть запущен и будет запущен при возможности. +// Ложь - процесс должен быть остановлен и будет остановлен после отсоединения всех пользователей или +// после истечения времени, заданного настройками кластера. +// * Порт - Число - содержит номер основного IP-порта рабочего процесса. Этот порт выделяется динамически при старте +// рабочего процесса из диапазонов портов, определенных для соответствующего рабочего сервера. +// * ПревышениеНадКритическимЗначением - Число - содержит время, в течение которого объем виртуальной памяти +// рабочего процесса превышает критическое значение, установленное для кластера, в секундах. +// * ЗанятоПамяти - Число - содержит объем виртуальной памяти, занимаемой рабочим процессом, в килобайтах. +// * Идентификатор - Строка - идентификатор активного рабочего процесса в терминах операционной системы. +// * Запущен - Число - состояние рабочего процесса. +// 0 - процесс неактивен (либо не загружен в память, либо не может выполнять клиентские запросы); +// 1 - процесс активен (работает). +// * КоличествоВызововПоКоторымПосчитанаСтатистика - Число - количество вызовов, по которым посчитана статистика. +// * МоментЗапуска - Дата - содержит момент запуска рабочего процесса. Если процесс не запущен, то пустая дата. +// * Использование - Число - определяет использование рабочего процесса кластером. Устанавливается администратором. +// Возможные значения: +// 0 - не использовать, процесс не должен быть запущен; +// 1 - использовать, процесс должен быть запущен; +// 2 - использовать как резервный, процесс должен быть запущен только при невозможности запуска +// процесса со значением 1 этого свойства. +// * Лицензия - Структура +// - Неопределено - содержит информацию о серверной лицензии, используемой рабочим процессом. +// Неопределено - рабочий процесс не использует серверную лицензию. +// +Функция СвойстваРабочегоПроцесса() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваРабочегоПроцесса() +``` +
+ +## СеансыИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания сеансов информационной базы. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// Если в параметре Фильтр задана структура (см. АдминистрированиеКластера.ФильтрСеансов), то +// сравнение всегда выполняется на равенство. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// Фильтр - Массив из см. АдминистрированиеКластера.ФильтрСеансов +// - см. АдминистрированиеКластера.ФильтрСеансов +// +// Возвращаемое значение: +// Массив из см. АдминистрированиеКластера.СвойстваСеанса +// +Функция СеансыИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СеансыИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, ); +``` +
+ +## УдалитьСеансыИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Удаляет сеансы с информационной базой по фильтру. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// Если в параметре Фильтр задана структура (см. АдминистрированиеКластера.ФильтрСеансов), то +// сравнение всегда выполняется на равенство. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// Фильтр - Массив из см. АдминистрированиеКластера.ФильтрСеансов +// - см. АдминистрированиеКластера.ФильтрСеансов +// +Процедура УдалитьСеансыИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.УдалитьСеансыИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, ); +``` +
+ +## ФильтрСеансов +
+ +Описание, пример вызова + +```bsl + +// Свойства фильтра сеансов. +// Для использования в функциях СеансыИнформационнойБазы, УдалитьСеансыИнформационнойБазы и аналогичных. +// +// Возвращаемое значение: +// Структура: +// * Свойство - Строка - имя свойства, по которому осуществляется фильтрация. +// Допустимые значения - см. возвращаемое значение функции АдминистрированиеКластера.СвойстваСеанса. +// * ВидСравнения - ВидСравнения - вид сравнения значений сеансов с указанным в условии фильтра. +// Допустимые значения: +// ВидСравнения.Равно, +// ВидСравнения.НеРавно, +// ВидСравнения.Больше (только для числовых значений), +// ВидСравнения.БольшеИлиРавно (только для числовых значений), +// ВидСравнения.Меньше (только для числовых значений), +// ВидСравнения.МеньшеИлиРавно (только для числовых значений), +// ВидСравнения.ВСписке, +// ВидСравнения.НеВСписке, +// ВидСравнения.Интервал (только для числовых значений), +// ВидСравнения.ИнтервалВключаяГраницы (только для числовых значений), +// ВидСравнения.ИнтервалВключаяНачало (только для числовых значений), +// ВидСравнения.ИнтервалВключаяОкончание (только для числовых значений). +// * Значение - Число +// - Строка +// - Дата +// - Булево +// - СписокЗначений +// - Массив +// - Структура - значение, с которым +// сравнивается значение соответствующего свойства сеанса. При ВидСравнения.ВСписке и ВидСравнения.НеВСписке +// в качестве значения должны передаваться СписокЗначений или Массив, содержащие набор значений, с которыми +// будет выполняться сравнение. При ВидСравнения.Интервал, ВидСравнения.ИнтервалВключаяГраницы, +// ВидСравнения.ИнтервалВключаяНачало и ВидСравнения.ИнтервалВключаяОкончание в качестве значения должны +// передаваться структуры с полями С и По, значения которых образуют интервал, с которым будет выполняться +// соответствующее сравнение. +// +Функция ФильтрСеансов() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ФильтрСеансов() +``` +
+ +## СвойстваСоединения +
+ +Описание, пример вызова + +```bsl + +// Свойства соединения с информационной базой. +// +// Возвращаемое значение: +// Структура: +// * Номер - Число - номер соединения с информационной базой. +// * ИмяПользователя - Строка - имя пользователя 1С:Предприятия, подсоединенного к информационной базе. +// * ИмяКлиентскогоКомпьютера - Строка - имя компьютера, с которого установлено соединение. +// * ИдентификаторКлиентскогоПриложения - Строка - идентификатор приложения, установившего соединение. +// Возможные значения - см. описание к функции глобального контекста ПредставлениеПриложения(), +// * МоментУстановкиСоединения - Дата - момент установки соединения. +// * РежимСоединенияСИнформационнойБазой - Число - режим соединения с информационной базой (0 - +// разделяемый, 1 - монопольный), +// * РежимСоединенияСБазойДанных - Число - режим соединения с базой данных (0 - соединение не установлено, +// 1 - разделяемый, 2 - монопольный). +// * БлокировкаСУБД - Число - идентификатор соединения, блокирующего работу данного соединения в СУБД. +// * Передано - Число - объем данных, полученных и отправленных соединением. +// * ПереданоЗа5Минут - Число - объем данных, полученных и отправленных соединением за последние 5 минут. +// * СерверныхВызовов - Число - количество серверных вызовов. +// * СерверныхВызововЗа5Минут - Число - количество серверных вызовов соединения за последние 5 минут. +// * ПереданоСУБД - Число - объем данных, переданных между сервером 1С:Предприятия и сервером баз данных, +// с момента установки данного соединения, +// * ПереданоСУБДЗа5Минут - Число - объем данных, переданных между сервером 1С:Предприятия и сервером баз +// данных за последние 5 минут, +// * СоединениеСУБД - Строка - идентификатор процесса соединения с СУБД (если на момент получения списка +// соединений данное соединение выполняло обращение к серверу СУБД, в противном случае - значение равно +// пустой строке). Идентификатор возвращается в терминах сервера СУБД. +// * ВремяСУБД - Число - время в секундах, в течении которого выполняется обращение к серверу СУБД (если на момент +// получения списка соединений данное соединение выполняло обращение к серверу СУБД, в противном случае +// значение равно 0). +// * МоментЗахватаСоединенияСУБД - Дата - момент последнего захвата соединения с сервером СУБД. +// * ДлительностьСерверныхВызовов - Число - длительность всех серверных вызовов соединения. +// * ДлительностьВызововСУБД - Число - время вызовов СУБД, инициированных соединением. +// * ДлительностьТекущегоСерверногоВызова - Число - длительность текущего серверного вызова. +// * ДлительностьТекущегоВызоваСУБД - Число - длительность текущего вызова сервера СУБД. +// * ДлительностьСерверныхВызововЗа5Минут - Число - длительность серверных вызовов соединения за последние 5 минут. +// * ДлительностьВызововСУБДЗа5Минут - Число - длительность вызовов соединения СУБД за последние 5 минут. +// * ПрочитаноСДиска - Число - содержит количество данных в байтах, прочитанных с диска сеансом с момента начала сеанса. +// * ПрочитаноСДискаВТекущемВызове - Число - содержит количество данных в байтах, прочитанных с диска с начала +// выполнения текущего вызова. +// * ПрочитаноСДискаЗа5Минут - Число - содержит количество данных в байтах, прочитанных с диска сеансом за +// последние 5 минут. +// * ЗанятоПамяти - Число - содержит объем памяти в байтах, занятый в процессе вызовов с момента начала сеанса. +// * ЗанятоПамятиВТекущемВызове - Число - содержит объем памяти в байтах, занятый с начала выполнения текущего +// вызова. Если в данный момент вызов не выполняется, содержит 0. +// * ЗанятоПамятиЗа5Минут - Число - содержит объем памяти в байтах, занятый в процессе вызовов за последние 5 минут. +// * ЗаписаноНаДиск - Число - содержит количество данных в байтах, записанных на диск сеансом с момента начала сеанса. +// * ЗаписаноНаДискВТекущемВызове - Число - содержит количество данных в байтах, записанных на диск с начала +// выполнения текущего вызова. +// * ЗаписаноНаДискЗа5Минут - Число - содержит количество данных в байтах, записанных на диск сеансом за +// последние 5 минут. +// * УправлениеНаходитсяНаСервере - Число - указывает, находится ли управление на сервере (0 - не находится, 1 - находится). +// +Функция СвойстваСоединения() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваСоединения() +``` +
+ +## СоединенияСИнформационнойБазой +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания соединений с информационной базой. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// Если в параметре Фильтр задана структура (см. АдминистрированиеКластера.ФильтрСеансов), то +// сравнение всегда выполняется на равенство. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// Фильтр - см. АдминистрированиеКластера.ФильтрСоединений +// - Массив из см. АдминистрированиеКластера.ФильтрСоединений +// +// Возвращаемое значение: +// Массив из см. АдминистрированиеКластера.СвойстваСоединения +// +Функция СоединенияСИнформационнойБазой(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СоединенияСИнформационнойБазой(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, ); +``` +
+ +## РазорватьСоединенияСИнформационнойБазой +
+ +Описание, пример вызова + +```bsl + +// Разрывает соединения с информационной базой по фильтру. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// Если в параметре Фильтр задана структура (см. АдминистрированиеКластера.ФильтрСоединений), то +// сравнение всегда выполняется на равенство. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// Фильтр - Массив из см. АдминистрированиеКластера.ФильтрСоединений +// - см. АдминистрированиеКластера.ФильтрСоединений +// +Процедура РазорватьСоединенияСИнформационнойБазой(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.РазорватьСоединенияСИнформационнойБазой(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, ); +``` +
+ +## ФильтрСоединений +
+ +Описание, пример вызова + +```bsl + +// Свойства фильтра соединений. +// Для использования в функциях СоединенияСИнформационнойБазой, РазорватьСоединенияСИнформационнойБазой и аналогичных. +// +// Возвращаемое значение: +// Структура: +// * Свойство - Строка - имя свойства, по которому осуществляется фильтрация. +// Допустимые значения - см. возвращаемое значение функции АдминистрированиеКластера.СвойстваСоединения. +// * ВидСравнения - ВидСравнения - вид сравнения значений сеансов с указанным в условии фильтра. +// Допустимые значения: +// ВидСравнения.Равно, +// ВидСравнения.НеРавно, +// ВидСравнения.Больше (только для числовых значений), +// ВидСравнения.БольшеИлиРавно (только для числовых значений), +// ВидСравнения.Меньше (только для числовых значений), +// ВидСравнения.МеньшеИлиРавно (только для числовых значений), +// ВидСравнения.ВСписке, +// ВидСравнения.НеВСписке, +// ВидСравнения.Интервал (только для числовых значений), +// ВидСравнения.ИнтервалВключаяГраницы (только для числовых значений), +// ВидСравнения.ИнтервалВключаяНачало (только для числовых значений), +// ВидСравнения.ИнтервалВключаяОкончание (только для числовых значений). +// * Значение - Число +// - Строка +// - Дата +// - Булево +// - СписокЗначений +// - Массив +// - Структура - значение, с которым +// сравнивается значение соответствующего свойства сеанса. При ВидСравнения.ВСписке и ВидСравнения.НеВСписке +// в качестве значения должны передаваться СписокЗначений или Массив, содержащие набор значений, с которыми +// будет выполняться сравнение. При ВидСравнения.Интервал, ВидСравнения.ИнтервалВключаяГраницы, +// ВидСравнения.ИнтервалВключаяНачало и ВидСравнения.ИнтервалВключаяОкончание в качестве значения должны +// передаваться структуры с полями С и По, значения которых образуют интервал, с которым будет выполняться +// соответствующее сравнение. +// +Функция ФильтрСоединений() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ФильтрСоединений() +``` +
+ +## ПрофильБезопасностиИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя профиля безопасности, назначенного для информационной базы. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// +// Возвращаемое значение: +// Строка - имя профиля безопасности, назначенного для информационной базы. Если для информационной базы не назначен +// профиль безопасности - возвращается пустая строка. +// +Функция ПрофильБезопасностиИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ПрофильБезопасностиИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ); +``` +
+ +## ПрофильБезопасностиБезопасногоРежимаИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя профиля безопасности, назначенного для информационной базы в качестве профиля безопасности +// безопасного режима. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// +// Возвращаемое значение: +// Строка - имя профиля безопасности, назначенного для информационной базы в качестве профиля безопасности безопасного +// режима. Если для информационной базы не назначен профиль безопасности - возвращается пустая строка. +// +Функция ПрофильБезопасностиБезопасногоРежимаИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ПрофильБезопасностиБезопасногоРежимаИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ); +``` +
+ +## УстановитьПрофильБезопасностиИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Назначает для информационной базы использование профиля безопасности. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// ИмяПрофиля - Строка - имя профиля безопасности. Если передана пустая строка - для информационной базы будет +// отключено использование профиля безопасности. +// +Процедура УстановитьПрофильБезопасностиИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.УстановитьПрофильБезопасностиИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, ); +``` +
+ +## УстановитьПрофильБезопасностиБезопасногоРежимаИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Назначает для информационной базы использование профиля безопасности безопасного режима. +// +// Параметр ПараметрыАдминистрированияИБ может быть опущен в том случае, если аналогичные поля указаны +// в параметре ПараметрыАдминистрированияКластера. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// ИмяПрофиля - Строка - имя профиля безопасности. Если передана пустая строка - для информационной базы будет +// отключено использование профиля безопасности безопасного режима. +// +Процедура УстановитьПрофильБезопасностиБезопасногоРежимаИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Знач ИмяПрофиля = "") Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.УстановитьПрофильБезопасностиБезопасногоРежимаИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, ИмяПрофиля); +``` +
+ +## ПрофильБезопасностиСуществует +
+ +Описание, пример вызова + +```bsl + +// Проверяет существование в кластере серверов профиля безопасности. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера. +// ИмяПрофиля - Строка - имя профиля безопасности, существование которого проверяется. +// +// Возвращаемое значение: +// Булево +// +Функция ПрофильБезопасностиСуществует(Знач ПараметрыАдминистрированияКластера, Знач ИмяПрофиля) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ПрофильБезопасностиСуществует(ПараметрыАдминистрированияКластера, ИмяПрофиля) +``` +
+ +## СвойстваПрофиляБезопасности +
+ +Описание, пример вызова + +```bsl + +// Свойства профиля безопасности. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя профиля безопасности, +// * Описание - Строка - описание профиля безопасности, +// * ПрофильБезопасногоРежима - Булево - определяет возможность использования профиля безопасности +// в качестве профиля безопасности безопасного режима (как при указании в качестве профиля +// безопасного режима для информационной базы, так и при вызове. +// УстановитьБезопасныйРежим(<Имя профиля>) из кода конфигурации. +// * ПолныйДоступКПривилегированномуРежиму - Булево - определяет возможность установки +// привилегированного режима из безопасного режима данного профиля безопасности. +// * ПолныйДоступКФункциямКриптографии - Булево - определяет разрешение на использование криптографического +// функционала (подпись, проверка подписи, шифрование, расшифрование, работа с хранилищем сертификатов, +// проверка сертификатов, извлечение сертификатов из подписи) при работе на сервере. +// На клиенте функции криптографии не блокируются. +// Истина - исполнение разрешено. Ложь - исполнение запрещено. +// * ПолныйДоступКРасширениюВсехМодулей - Булево - определяет, разрешено ли изменение всех модулей в расширении +// конфигурации: +// Истина - разрешено расширять любой модуль. +// Ложь - разрешено расширять модули из списка разрешенных. +// * ДоступныеДляРасширенияМодули - Строка - используется, когда расширение всех модулей не разрешено. +// Содержит список полных имен объектов конфигурации или модулей, расширение которых разрешено, +// разделенных ";". Указание полного имени объекта конфигурации разрешает расширение всех модулей +// объекта. Указанием полного имени модуля разрешает расширение конкретного модуля. +// * НедоступныеДляРасширенияМодули - Строка - используется, когда расширение всех модулей разрешено. +// Содержит список полных имен объектов конфигурации или модулей, расширение которых не разрешено, +// разделенных ";". Указание полного имени объекта конфигурации запрещает расширение всех модулей +// объекта. +// * ПолныйДоступКРасширениюПравДоступа - Булево - определяет, разрешено ли повышение прав на объекты конфигурации +// расширениями, ограниченными профилем безопасности: +// Истина - повышение прав разрешено. +// Ложь - повышение прав не разрешено. +// Если указан список ролей расширяемой конфигурации, допускается повышение права, если хотя бы одна +// роль из списка включает в себя требуемое право. +// * РолиОграничивающиеРасширениеПравДоступа - Строка - содержит список имен ролей, влияющих на изменение прав +// доступа из расширения. При изменении списка ролей изменения в составе ролей учитываются только после +// перезапуска текущих сеансов и для новых сеансов. +// * ПолныйДоступКФайловойСистеме - Булево - определяет наличие ограничений на доступ к файловой +// системе. При установке значения Ложь доступ будет предоставлен только к каталогам файловой +// системы, перечисленным в свойстве ВиртуальныеКаталоги. +// * ПолныйДоступКCOMОбъектам - Булево - определяет наличие ограничений на доступ к использованию. +// COM-объектов. При установке значения равным Ложь, доступ будет предоставлен только к COM-классам, +// перечисленным в свойстве COM-классы. +// * ПолныйДоступКВнешнимКомпонентам - Булево - определяет наличие ограничений на доступ к использованию +// внешних компонент. При установке значения равным Ложь, доступ будет предоставлен только к внешним +// компонентам, перечисленным в свойстве ВнешниеКомпоненты. +// * ПолныйДоступКВнешнимМодулям - Булево - определяет наличие ограничений на доступ к использованию внешних +// модулей (внешние отчеты и обработки, вызовы Выполнить() и Вычислить()) в небезопасном режиме. +// При установке значения равным Ложь, будет предоставлена возможность использовать в небезопасном +// режиме только внешние модули, перечисленные в свойстве ВнешниеМодули. +// * ПолныйДоступКПриложениямОперационнойСистемы - Булево - определяет наличие ограничений на доступ к +// использованию приложений операционной системы. При установке значения равным Ложь, будет +// предоставлена возможность использовать только приложения операционной системы, перечисленные в +// свойстве ПриложенияОС. +// * ПолныйДоступКИнтернетРесурсам - Булево - определяет наличие ограничений на доступ к использованию +// интернет-ресурсов. При установке значения равным Ложь, будет предоставлена возможность использовать +// только интернет-ресурсы, перечисленные в свойстве интернетРесурсы. +// * ВиртуальныеКаталоги - Массив из см. АдминистрированиеКластера.СвойстваВиртуальногоКаталога +// * COMКлассы - Массив из см. АдминистрированиеКластера.СвойстваCOMКласса +// * ВнешниеКомпоненты - Массив из см. АдминистрированиеКластера.СвойстваВнешнейКомпоненты +// * ВнешниеМодули - Массив из см. АдминистрированиеКластера.СвойстваВнешнегоМодуля +// * ПриложенияОС - Массив из см. АдминистрированиеКластера.СвойстваПриложенияОС +// * ИнтернетРесурсы - Массив из см. АдминистрированиеКластера.СвойстваИнтернетРесурса +// +Функция СвойстваПрофиляБезопасности() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваПрофиляБезопасности() +``` +
+ +## СвойстваВиртуальногоКаталога +
+ +Описание, пример вызова + +```bsl + +// Свойства виртуального каталога, к которому предоставляется доступ. +// +// Возвращаемое значение: +// Структура: +// * ЛогическийURL - Строка - логический URL каталога. +// * ФизическийURL - Строка - физический URL каталога на сервере для размещения данных виртуального каталога. +// * Описание - Строка - описание виртуального каталога. +// * ЧтениеДанных - Булево - флаг разрешения чтения данных из виртуального каталога. +// * ЗаписьДанных - Булево - флаг разрешения записи данных в виртуальный каталог. +// +Функция СвойстваВиртуальногоКаталога() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваВиртуальногоКаталога() +``` +
+ +## СвойстваCOMКласса +
+ +Описание, пример вызова + +```bsl + +// Свойства COM-класса, к которому предоставляется доступ. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя COM-класса, используется в качестве ключа при поиске. +// * Описание - Строка - описание COM-класса. +// * ФайлМоникер - Строка - имя файла, по которому создается объект методом глобального контекста +// ПолучитьCOMОбъект() с пустым значением второго параметра. +// * CLSID - Строка - представление идентификатора COM-класса в формате системного реестра MS Windows +// без фигурных скобок, по которому он может быть создан операционной системой. +// * Компьютер - Строка - имя компьютера, на котором может быть создан COM-объект. +// +Функция СвойстваCOMКласса() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваCOMКласса() +``` +
+ +## СвойстваВнешнейКомпоненты +
+ +Описание, пример вызова + +```bsl + +// Свойства внешней компоненты, к которой предоставляется доступ. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя внешней компоненты, используется в качестве ключа для поиска. +// * Описание - Строка - описание внешней компоненты. +// * ХешСумма - Строка - контрольная сумма разрешенной внешней компоненты, вычисленная алгоритмом SHA-1 и +// преобразованная к строке base64. +// +Функция СвойстваВнешнейКомпоненты() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваВнешнейКомпоненты() +``` +
+ +## СвойстваВнешнегоМодуля +
+ +Описание, пример вызова + +```bsl + +// Свойства внешнего модуля, к которому предоставляется доступ. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя внешнего модуля, используется в качестве ключа для поиска. +// * Описание - Строка - описание внешнего модуля. +// * ХешСумма - Строка - контрольная сумма разрешенного внешнего модуля, вычисленная алгоритмом SHA-1 и +// преобразованная к строке base64. +// +Функция СвойстваВнешнегоМодуля() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваВнешнегоМодуля() +``` +
+ +## СвойстваПриложенияОС +
+ +Описание, пример вызова + +```bsl + +// Свойства приложения операционной системы, к которому предоставляется доступ. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя приложения операционной системы, используется в качестве ключа для поиска. +// * Описание - Строка - описание приложения операционной системы. +// * ШаблонСтрокиЗапуска - Строка - шаблон строки запуска приложения (состоит из последовательности шаблонных слов, +// разделенных пробелами). +// +Функция СвойстваПриложенияОС() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваПриложенияОС() +``` +
+ +## СвойстваИнтернетРесурса +
+ +Описание, пример вызова + +```bsl + +// Свойства Интернет-ресурса, к которому предоставляется доступ. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя интернет-ресурса, используется в качестве ключа для поиска. +// * Описание - Строка - описание интернет-ресурса. +// * Протокол - Строка - разрешаемый сетевой протокол. Возможные значения: +// HTTP, +// HTTPS, +// FTP, +// FTPS, +// POP3, +// SMTP, +// IMAP. +// * Адрес - Строка - сетевой адрес Интернет-ресурса без указания протокола и порта. +// * Порт - Число - сетевой порт Интернет-ресурса. +// +Функция СвойстваИнтернетРесурса() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваИнтернетРесурса() +``` +
+ +## ПрофильБезопасности +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства профиля безопасности. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ИмяПрофиля - Строка - имя профиля безопасности. +// +// Возвращаемое значение: +// см. АдминистрированиеКластера.СвойстваПрофиляБезопасности +// +Функция ПрофильБезопасности(Знач ПараметрыАдминистрированияКластера, Знач ИмяПрофиля) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ПрофильБезопасности(ПараметрыАдминистрированияКластера, ИмяПрофиля) +``` +
+ +## СоздатьПрофильБезопасности +
+ +Описание, пример вызова + +```bsl + +// Создает профиль безопасности по переданному описанию. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// СвойстваПрофиляБезопасности - см. АдминистрированиеКластера.СвойстваПрофиляБезопасности +// +Процедура СоздатьПрофильБезопасности(Знач ПараметрыАдминистрированияКластера, Знач СвойстваПрофиляБезопасности) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.СоздатьПрофильБезопасности(ПараметрыАдминистрированияКластера, СвойстваПрофиляБезопасности) +``` +
+ +## УстановитьСвойстваПрофиляБезопасности +
+ +Описание, пример вызова + +```bsl + +// Устанавливает свойства для существующего профиля безопасности по переданному описанию. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// СвойстваПрофиляБезопасности - см. АдминистрированиеКластера.СвойстваПрофиляБезопасности +// +Процедура УстановитьСвойстваПрофиляБезопасности(Знач ПараметрыАдминистрированияКластера, Знач СвойстваПрофиляБезопасности) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.УстановитьСвойстваПрофиляБезопасности(ПараметрыАдминистрированияКластера, СвойстваПрофиляБезопасности) +``` +
+ +## УдалитьПрофильБезопасности +
+ +Описание, пример вызова + +```bsl + +// Удаляет профиль безопасности. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ИмяПрофиля - Строка - имя профиля безопасности. +// +Процедура УдалитьПрофильБезопасности(Знач ПараметрыАдминистрированияКластера, Знач ИмяПрофиля) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластера.УдалитьПрофильБезопасности(ПараметрыАдминистрированияКластера, ИмяПрофиля) +``` +
+ +## ИдентификаторИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутренний идентификатор информационной базы. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов. +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИнформационнойБазы - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// +// Возвращаемое значение: +// Строка +// +Функция ИдентификаторИнформационнойБазы(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИнформационнойБазы) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ИдентификаторИнформационнойБазы(ИдентификаторКластера, ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИнформационнойБазы) +``` +
+ +## СвойстваИнформационныхБаз +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания информационных баз. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов. +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// Фильтр - Структура - параметры фильтрации информационных баз. +// +// Возвращаемое значение: +// Массив из Структура +// +Функция СвойстваИнформационныхБаз(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваИнформационныхБаз(ИдентификаторКластера, ПараметрыАдминистрированияКластера, Фильтр); +``` +
+ +## ИдентификаторКластера +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутренний идентификатор кластера серверов. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера. +// +// Возвращаемое значение: +// Строка +// +Функция ИдентификаторКластера(Знач ПараметрыАдминистрированияКластера) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ИдентификаторКластера(ПараметрыАдминистрированияКластера) +``` +
+ +## СвойстваКластеров +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания кластеров серверов. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// Фильтр - Структура - параметры фильтрации кластеров серверов. +// +// Возвращаемое значение: +// Массив из Структура +// +Функция СвойстваКластеров(Знач ПараметрыАдминистрированияКластера, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваКластеров(ПараметрыАдминистрированияКластера, Фильтр); +``` +
+ +## СвойстваРабочихПроцессов +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания рабочих процессов. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов. +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// Фильтр - Структура - параметры фильтрации рабочих процессов. +// +// Возвращаемое значение: +// Массив из Структура +// +Функция СвойстваРабочихПроцессов(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваРабочихПроцессов(ИдентификаторКластера, ПараметрыАдминистрированияКластера, Фильтр); +``` +
+ +## СвойстваРабочихСерверов +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания рабочих серверов. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов. +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// Фильтр - Структура - параметры фильтрации рабочих серверов. +// +// Возвращаемое значение: +// Массив из Структура +// +Функция СвойстваРабочихСерверов(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваРабочихСерверов(ИдентификаторКластера, ПараметрыАдминистрированияКластера, Фильтр); +``` +
+ +## СвойстваСеансов +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания сеансов информационной базы. +// +// Если в параметре Фильтр задана структура (см. АдминистрированиеКластера.ФильтрСеансов), то +// сравнение всегда выполняется на равенство. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов. +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ИдентификаторИнформационнойБазы - Строка - внутренний идентификатор информационной базы. +// Фильтр - см. АдминистрированиеКластера.ФильтрСеансов +// - Массив из см. АдминистрированиеКластера.ФильтрСеансов +// ИспользоватьСловарь - Булево - если Истина - возвращаемый результат будет заполнен с использованием словаря. +// +// Возвращаемое значение: +// - Массив из см. АдминистрированиеКластера.СвойстваСеанса +// - Массив из Соответствие - свойства сеансов в нотации утилиты rac (при ИспользоватьСловарь = Ложь). +// +Функция СвойстваСеансов(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач ИдентификаторИнформационнойБазы, Знач Фильтр = Неопределено, Знач ИспользоватьСловарь = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваСеансов(ИдентификаторКластера, ПараметрыАдминистрированияКластера, ИдентификаторИнформационнойБазы, Фильтр, ИспользоватьСловарь); +``` +
+ +## СвойстваСоединений +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания соединений с информационной базой. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов. +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// ИдентификаторИнформационнойБазы - Строка - внутренний идентификатор информационной базы. +// ПараметрыАдминистрированияИнформационнойБазы - см. АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера +// Фильтр - см. АдминистрированиеКластера.ФильтрСоединений +// - Массив из см. АдминистрированиеКластера.ФильтрСоединений +// ИспользоватьСловарь - Булево - если Истина - возвращаемый результат будет заполнен с использованием словаря. +// +// Возвращаемое значение: +// - Массив из см. АдминистрированиеКластера.СвойстваСоединения +// - Массив из Соответствие - свойства соединений в нотации утилиты rac (при ИспользоватьСловарь = Ложь). +// +Функция СвойстваСоединений(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач ИдентификаторИнформационнойБазы, Знач ПараметрыАдминистрированияИнформационнойБазы, Знач Фильтр = Неопределено, Знач ИспользоватьСловарь = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.СвойстваСоединений(ИдентификаторКластера, ПараметрыАдминистрированияКластера, ИдентификаторИнформационнойБазы, ПараметрыАдминистрированияИнформационнойБазы, Фильтр, ИспользоватьСловарь); +``` +
+ +## ПутьККлиентуСервераАдминистрирования +
+ +Описание, пример вызова + +```bsl + +// Возвращает путь к консольному клиенту сервера администрирования. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластера.ПараметрыАдминистрированияКластера +// +// Возвращаемое значение: +// Строка +// +Функция ПутьККлиентуСервераАдминистрирования(Знач ПараметрыАдминистрированияКластера) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластера.ПутьККлиентуСервераАдминистрирования(ПараметрыАдминистрированияКластера) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/АдминистрированиеКластераКлиентСервер.md b/src/content/docs/bsp/АдминистрированиеКластераКлиентСервер.md new file mode 100644 index 0000000..8b644cc --- /dev/null +++ b/src/content/docs/bsp/АдминистрированиеКластераКлиентСервер.md @@ -0,0 +1,1260 @@ +--- +title: Администрирование кластера клиент сервер +slug: bsp/администрирование-кластера-клиент-сервер +--- + + +## ПараметрыАдминистрированияКластера +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.ПараметрыАдминистрированияКластера. +// Конструктор структуры, описывающей параметры подключения к администрируемому +// кластеру серверов. +// +// Возвращаемое значение: +// Структура: +// * ТипПодключения - Строка - возможные значения: +// "COM" - при подключении к агенту сервера с использованием COM-объекта V8*.ComConnector, +// "RAS" - при подключении к серверу администрирования (ras) с использованием консольного +// клиента сервера администрирования (rac), +// * АдресАгентаСервера - Строка - сетевой адрес агента сервера (только при ТипПодключения = "COM"), +// * ПортАгентаСервера - Число - сетевой порт агента сервера (только при ТипПодключения = "COM"), +// типичное значение - 1540, +// * АдресСервераАдминистрирования - Строка - сетевой адрес сервера администрирования ras (только +// при ТипПодключения = "RAS"), +// * ПортСервераАдминистрирования - Число - сетевой порт сервера администрирования ras (только при +// ТипПодключения = "RAS"), типичное значение - 1545, +// * ПортКластера - Число - сетевой порт менеджера администрируемого кластера, типичное значение -1541, +// * ИмяАдминистратораКластера - Строка - имя учетной записи администратора кластера (если для кластера +// не задан список администраторов - используется пустая строка), +// * ПарольАдминистратораКластера - Строка - пароль учетной записи администратора кластера (если +// для кластера не задан список администраторов или для учетной записи не установлен пароль - +// используется пустая строка). +// +Функция ПараметрыАдминистрированияКластера() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера() +``` +
+ +## ПараметрыАдминистрированияИнформационнойБазыКластера +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.ПараметрыАдминистрированияИнформационнойБазыКластера. +// Конструктор структуры, описывающей параметры подключения к администрируемой информационной +// базе кластера. +// +// Возвращаемое значение: +// Структура: +// * ИмяВКластере - Строка - имя администрируемой информационной базы в кластере серверов, +// * ИмяАдминистратораИнформационнойБазы - Строка - имя пользователя информационной базы с правами +// администратора (если для информационной базы не задан список пользователей ИБ - используется +// пустая строка), +// * ПарольАдминистратораИнформационнойБазы - Строка - пароль пользователя информационной базы +// с правами администратора (если для информационной базы не задан список пользователей ИБ или +// для пользователя ИБ не установлен пароль - используется пустая строка). +// +Функция ПараметрыАдминистрированияИнформационнойБазыКластера() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера() +``` +
+ +## ПроверитьПараметрыАдминистрирования +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.ПроверитьПараметрыАдминистрирования. +// Проверяет корректность параметров администрирования. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// ПроверятьПараметрыАдминистрированияКластера - Булево - флаг необходимости проверки параметров администрирования кластера, +// ПроверятьПараметрыАдминистрированияИнформационнойБазы - Булево - флаг необходимости проверки параметров +// администрирования кластера. +// +Процедура ПроверитьПараметрыАдминистрирования(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.ПроверитьПараметрыАдминистрирования(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, ); +``` +
+ +## СвойстваБлокировкиСеансовИРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваБлокировкиСеансовИРегламентныхЗаданий. +// Конструктор структуры, описывающей свойства блокировки сеансов и регламентных заданий +// информационной базы. +// +// Возвращаемое значение: +// Структура: +// * БлокировкаСеансов - Булево - флаг установки блокировки новых сеансов с информационной базой, +// * ДатаС - Дата - (Дата и время) момент начала блокировки новых сеансов с информационной базой, +// * ДатаПо - Дата - (Дата и время) момент окончания блокировки новых сеансов с информационной базой, +// * Сообщение - Строка - сообщение, отображаемое пользователю при попытке установки нового сеанса +// с информационной базой при установленной блокировке новых сеансов, +// * КодРазрешения - Строка - код обхода блокировки новых сеансов с информационной базой, +// * БлокировкаРегламентныхЗаданий - Булево - флаг блокировки выполнения регламентных заданий +// информационной базы. +// +Функция СвойстваБлокировкиСеансовИРегламентныхЗаданий() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваБлокировкиСеансовИРегламентныхЗаданий() +``` +
+ +## БлокировкаСеансовИЗаданийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.БлокировкаСеансовИЗаданийИнформационнойБазы. +// Возвращает текущее состояние блокировки сеансов и регламентных заданий для информационной базы. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// +// Возвращаемое значение: +// см. АдминистрированиеКластераКлиентСервер.СвойстваБлокировкиСеансовИРегламентныхЗаданий. +// +Функция БлокировкаСеансовИЗаданийИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.БлокировкаСеансовИЗаданийИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ); +``` +
+ +## УстановитьБлокировкуСеансовИЗаданийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.УстановитьБлокировкуСеансовИЗаданийИнформационнойБазы. +// Устанавливает новое состояние блокировки сеансов и регламентных заданий для информационной базы. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// СвойстваБлокировкиСеансовИЗаданий - см. АдминистрированиеКластераКлиентСервер.СвойстваБлокировкиСеансовИРегламентныхЗаданий. +// +Процедура УстановитьБлокировкуСеансовИЗаданийИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ, Знач СвойстваБлокировкиСеансовИЗаданий) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.УстановитьБлокировкуСеансовИЗаданийИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, СвойстваБлокировкиСеансовИЗаданий) +``` +
+ +## СнятьБлокировкуСеансовИЗаданийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СнятьБлокировкуСеансовИЗаданийИнформационнойБазы. +// Снимает блокировку сеансов и регламентных заданий для информационной базы. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// +Процедура СнятьБлокировкуСеансовИЗаданийИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.СнятьБлокировкуСеансовИЗаданийИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ); +``` +
+ +## БлокировкаРегламентныхЗаданийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.БлокировкаРегламентныхЗаданийИнформационнойБазы. +// Возвращает текущее состояние блокировки регламентных заданий для информационной базы. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// +// Возвращаемое значение: +// Булево - Истина, если удалось заблокировать регламентные задания, Ложь - иначе. +// +Функция БлокировкаРегламентныхЗаданийИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.БлокировкаРегламентныхЗаданийИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ); +``` +
+ +## УстановитьБлокировкуРегламентныхЗаданийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.УстановитьБлокировкуРегламентныхЗаданийИнформационнойБазы. +// Устанавливает новое состояние блокировки регламентных заданий для информационной базы. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера +// БлокировкаРегламентныхЗаданий - Булево - флаг установки блокировки регламентных заданий информационной базы. +// +Процедура УстановитьБлокировкуРегламентныхЗаданийИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ, Знач БлокировкаРегламентныхЗаданий) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.УстановитьБлокировкуРегламентныхЗаданийИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, БлокировкаРегламентныхЗаданий) +``` +
+ +## СвойстваСеанса +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваСеанса. +// Конструктор структуры, описывающей свойства сеанса информационной базы. +// +// Возвращаемое значение: +// Структура: +// * Номер - Число - номер сеанса. Уникален среди всех сеансов информационной базы, +// * ИмяПользователя - Строка - имя аутентифицированного пользователя информационной базы, +// * ИмяКлиентскогоКомпьютера - Строка - имя или сетевой адрес компьютера, установившего +// сеанс с информационной базой, +// * ИдентификаторКлиентскогоПриложения - Строка - идентификатор приложения, установившего сеанс +// (см. описание к функции глобального контекста ПредставлениеПриложения), +// * ИдентификаторЯзыка - Строка - идентификатор языка интерфейса, +// * МоментСозданияСеанса - Дата - (Дата и время) момент установки сеанса, +// * МоментПоследнейАктивностиСеанса - Дата - (Дата и время) момент последней активности сеанса, +// * Блокировка - Число - номер сеанса, который является причиной ожидания управляемой транзакционной +// блокировки, в том случае, если сеанс выполняет установку управляемых транзакционных блокировок +// и ожидает снятия блокировок, установленных другим сеансом (иначе - значение равно 0), +// * БлокировкаСУБД - Число - номер сеанса, который является причиной ожидания транзакционной +// блокировки, в том случае, если сеанс исполняет запрос к СУБД и ожидает транзакционную +// блокировку, установленную другим сеансом (иначе - значение равно 0), +// * Передано - Число - объем данных, переданных меду сервером 1С:Предприятия и клиентским приложением +// данного сеанса с момента начала сеанса (в байтах), +// * ПереданоЗа5Минут - Число - объем данных, переданных между сервером 1С:Предприятия и клиентским +// приложением данного сеанса за последние 5 минут (в байтах), +// * СерверныхВызовов - Число - количество вызовов сервера 1С:Предприятия от имена данного сеанса с +// момента начала сеанса, +// * СерверныхВызововЗа5Минут - Число - количество вызовов сервера 1С:Предприятия от имени данного сеанса +// за последние 5 минут, +// * ДлительностьСерверныхВызовов - Число - время исполнения вызовов сервера 1С:Предприятия от имени +// данного сеанса с момента начала сеанса (в секундах), +// * ДлительностьТекущегоСерверногоВызова - Число - интервал времени в миллисекундах, прошедший с момента начала +// обращения, в случае, если сеанс выполняется вызов сервера 1С:Предприятия (иначе - значение равно 0), +// * ДлительностьСерверныхВызововЗа5Минут - Число - время исполнения вызовов сервера 1С:Предприятия от имени +// данного сеанса за последние 5 минут (в миллисекундах), +// * ПереданоСУБД - Число - количество данных, переданных и полученных от СУБД от имени данного сеанса с +// момента начала сеанса (в байтах), +// * ПереданоСУБДЗа5Минут - Число - количество данных, переданных и полученных от СУБД от имени данного сеанса +// за последние 5 минут (в байтах), +// * ДлительностьВызововСУБД - Число - время исполнения запросов к СУБД от имени данного сеанса с момента начала +// сеанса (в миллисекундах), +// * ДлительностьТекущегоВызоваСУБД - Число - интервал времени в миллисекундах, прошедший с начала выполнения +// запроса в случае, если сеанс выполняет запрос к СУБД (иначе - значение равно 0), +// * ДлительностьВызововСУБДЗа5Минут - Число - суммарное время исполнения запросов к СУБД от имени данного сеанса +// за последние 5 минут (в миллисекундах), +// * СоединениеСУБД - Строка - номер соединения с СУБД в терминах СУБД в том случае, если в момент получения списка +// сеансов выполняется запрос к СУБД, открыта транзакция или определены временные таблицы (т.е. захвачено +// соединение с СУБД). Если соединение с СУБД не захвачено - значение равно пустой строке, +// * ВремяСоединенияСУБД - Число - время соединения с СУБД с момента захвата (в миллисекундах). Если соединение с. +// СУБД не захвачено - значение равно 0, +// * МоментЗахватаСоединенияСУБД - Дата - (Дата и время) момент времени, когда соединение с СУБД было последний раз +// захвачено другим сеансом. +// +Функция СвойстваСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваСеанса() +``` +
+ +## СеансыИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СеансыИнформационнойБазы. +// Возвращает описания сеансов информационной базы. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// Фильтр - Массив из Структура: +// * Свойство - см. АдминистрированиеКластераКлиентСервер.СвойстваСеанса +// * ВидСравнения - ВидСравнения - значение системного перечисления ВидСравнения, +// * Значение - Число +// - Строка +// - Дата +// - Булево +// - СписокЗначений +// - Массив +// - Структура - значение, с которым +// сравнивается значение соответствующего свойства сеанса. +// - Структура - структура: ключ - Имя свойства сеанса (см. выше), значение - значение, с которым +// выполняется сеанс. При использовании данного варианта описания фильтра сравнение всегда выполняется на +// равенство. +// +// Возвращаемое значение: +// Массив из см. АдминистрированиеКластераКлиентСервер.СвойстваСеанса +// +Функция СеансыИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СеансыИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, Фильтр); +``` +
+ +## УдалитьСеансыИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.УдалитьСеансыИнформационнойБазы. +// Удаляет сеансы с информационной базой по фильтру. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// Фильтр - Массив из Структура: +// * Свойство - см. АдминистрированиеКластераКлиентСервер.СвойстваСеанса +// * ВидСравнения - ВидСравнения - значение системного перечисления ВидСравнения, +// * Значение - Число +// - Строка +// - Дата +// - Булево +// - СписокЗначений +// - Массив +// - Структура - значение, с которым +// сравнивается значение соответствующего свойства сеанса, +// - Структура - структура: ключ - Имя свойства сеанса (см. выше), значение - значение, с которым +// выполняется сеанс. При использовании данного варианта описания фильтра сравнение всегда выполняется на равенство. +// +Процедура УдалитьСеансыИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.УдалитьСеансыИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, Фильтр); +``` +
+ +## СвойстваСоединения +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваСоединения. +// Конструктор структуры, описывающей свойства соединения с информационной базой. +// +// Возвращаемое значение: +// Структура: +// * Номер - Число - номер соединения с информационной базой, +// * ИмяПользователя - Строка - имя пользователя 1С:Предприятия, подсоединенного к информационной базе, +// * ИмяКлиентскогоКомпьютера - Строка - имя компьютера, с которого установлено соединение, +// * ИдентификаторКлиентскогоПриложения - Строка - идентификатор приложения, установившего соединение (см. описание к +// функции глобального контекста ПредставлениеПриложения), +// * МоментУстановкиСоединения - Дата - (Дата и время) момент установки соединения, +// * РежимСоединенияСИнформационнойБазой - Число - режим соединения с информационной базой (0 - +// разделяемый, 1 - монопольный), +// * РежимСоединенияСБазойДанных - Число - режим соединения с базой данных (0 - соединение не установлено, +// 1 - разделяемый, 2 - монопольный), +// * БлокировкаСУБД - Число - идентификатор соединения, блокирующего работу данного соединения в СУБД, +// * Передано - Число - объем данных, полученных и отправленных соединением, +// * ПереданоЗа5Минут - Число - объем данных, полученных и отправленных соединением за последние 5 минут, +// * СерверныхВызовов - Число - количество серверных вызовов, +// * СерверныхВызововЗа5Минут - Число - количество серверных вызовов соединения за последние 5 минут, +// * ПереданоСУБД - Число - объем данных, переданных между сервером 1С:Предприятия и сервером баз данных, +// с момента установки данного соединения, +// * ПереданоСУБДЗа5Минут - Число - объем данных, переданных между сервером 1С:Предприятия и сервером баз +// данных за последние 5 минут, +// * СоединениеСУБД - Строка - идентификатор процесса соединения с СУБД (если на момент получения списка +// соединений данное соединение выполняло обращение к серверу СУБД, в противном случае - значение равно пустой +// строке). Идентификатор возвращается в терминах сервера СУБД, +// * ВремяСУБД - Число - время в секундах, в течении которого выполняется обращение к серверу СУБД (если на момент +// получения списка соединений данное соединение выполняло обращение к серверу СУБД, в противном случае - значение +// равно 0), +// * МоментЗахватаСоединенияСУБД - Дата - (Дата и время) момент последнего захвата соединения с сервером СУБД, +// * ДлительностьСерверныхВызовов - Число - длительность всех серверных вызовов соединения, +// * ДлительностьВызововСУБД - Число - время вызовов СУБД, инициированных соединением, +// * ДлительностьТекущегоСерверногоВызова - Число - длительность текущего серверного вызова, +// * ДлительностьТекущегоВызоваСУБД - Число - длительность текущего вызова сервера СУБД, +// * ДлительностьСерверныхВызововЗа5Минут - Число - длительность серверных вызовов соединения за последние 5 минут, +// * ДлительностьВызововСУБДЗа5Минут - Число - длительность вызовов соединения СУБД за последние 5 минут. +// +Функция СвойстваСоединения() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваСоединения() +``` +
+ +## СоединенияСИнформационнойБазой +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СоединенияСИнформационнойБазой. +// Возвращает описания соединений с информационной базой. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// Фильтр - Массив из Структура: +// * Свойство - см. АдминистрированиеКластераКлиентСервер.СвойстваСоединения +// * ВидСравнения - ВидСравнения - значение системного перечисления ВидСравнения, вид сравнения значений +// соединений с указанным в условии фильтра, +// * Значение - Число +// - Строка +// - Дата +// - Булево +// - СписокЗначений +// - Массив +// - Структура - значение, с которым +// сравнивается значение соответствующего свойства соединения, +// - Структура - структура: ключ - Имя свойства соединения (см. выше), значение - значение, с которым +// выполняется сравнение. При использовании данного варианта описания фильтра сравнение всегда выполняется на равенство. +// +// Возвращаемое значение: +// Массив из см. АдминистрированиеКластераКлиентСервер.СвойстваСоединения. +// +Функция СоединенияСИнформационнойБазой(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СоединенияСИнформационнойБазой(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, Фильтр); +``` +
+ +## РазорватьСоединенияСИнформационнойБазой +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.РазорватьСоединенияСИнформационнойБазой. +// Разрывает соединения с информационной базой по фильтру. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// Фильтр - Массив из Структура: +// * Свойство - см. АдминистрированиеКластераКлиентСервер.СвойстваСоединения +// * ВидСравнения - ВидСравнения - значение системного перечисления ВидСравнения, вид сравнения значений +// соединений с указанным в условии фильтра, +// * Значение - Число +// - Строка +// - Дата +// - Булево +// - СписокЗначений +// - Массив +// - Структура - значение, с которым +// сравнивается значение соответствующего свойства соединения, +// - Структура - структура: ключ - Имя свойства соединения (см. выше), значение - значение, с которым +// выполняется сравнение. При использовании данного варианта описания фильтра сравнение всегда выполняется на равенство. +// +Процедура РазорватьСоединенияСИнформационнойБазой(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.РазорватьСоединенияСИнформационнойБазой(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, Фильтр); +``` +
+ +## ПрофильБезопасностиИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.ПрофильБезопасностиИнформационнойБазы. +// Возвращает имя профиля безопасности, назначенного для информационной базы. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// +// Возвращаемое значение: +// Строка - имя профиля безопасности, назначенного для информационной базы. Если +// для информационной базы не назначен профиль безопасности - возвращается пустая строка. +// +Функция ПрофильБезопасностиИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.ПрофильБезопасностиИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ); +``` +
+ +## ПрофильБезопасностиБезопасногоРежимаИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.ПрофильБезопасностиБезопасногоРежимаИнформационнойБазы. +// Возвращает имя профиля безопасности, назначенного для информационной базы в качестве профиля безопасности +// безопасного режима. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// +// Возвращаемое значение: +// Строка - имя профиля безопасности, назначенного для информационной базы в качестве профиля +// безопасности безопасного режима. Если для информационной базы не назначен профиль безопасности - возвращается пустая +// Строка +// +Функция ПрофильБезопасностиБезопасногоРежимаИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.ПрофильБезопасностиБезопасногоРежимаИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ); +``` +
+ +## УстановитьПрофильБезопасностиИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.УстановитьПрофильБезопасностиИнформационнойБазы. +// Назначает для информационной базы использование профиля безопасности. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// ИмяПрофиля - Строка - имя профиля безопасности. Если передана пустая строка - для информационной базы будет +// отключено использование профиля безопасности. +// +Процедура УстановитьПрофильБезопасностиИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Знач ИмяПрофиля = "") Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.УстановитьПрофильБезопасностиИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, ИмяПрофиля); +``` +
+ +## УстановитьПрофильБезопасностиБезопасногоРежимаИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.УстановитьПрофильБезопасностиБезопасногоРежимаИнформационнойБазы. +// Назначает для информационной базы использование профиля безопасности безопасного режима. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИБ - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// ИмяПрофиля - Строка - имя профиля безопасности. Если передана пустая строка - для информационной базы будет +// отключено использование профиля безопасности безопасного режима. +// +Процедура УстановитьПрофильБезопасностиБезопасногоРежимаИнформационнойБазы(Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИБ = Неопределено, Знач ИмяПрофиля = "") Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.УстановитьПрофильБезопасностиБезопасногоРежимаИнформационнойБазы(ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИБ, ИмяПрофиля); +``` +
+ +## ПрофильБезопасностиСуществует +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.ПрофильБезопасностиСуществует. +// Проверяет существование в кластере серверов профиля безопасности. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ИмяПрофиля - Строка - имя профиля безопасности, существование которого проверяется. +// +// Возвращаемое значение: +// Булево - Истина если профиль с указанным именем существует, Ложь - если не существует. +// +Функция ПрофильБезопасностиСуществует(Знач ПараметрыАдминистрированияКластера, Знач ИмяПрофиля) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.ПрофильБезопасностиСуществует(ПараметрыАдминистрированияКластера, ИмяПрофиля) +``` +
+ +## СвойстваПрофиляБезопасности +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваПрофиляБезопасности. +// Конструктор структуры, описывающей свойства профиля безопасности. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя профиля безопасности, +// * Описание - Строка - описание профиля безопасности, +// * ПрофильБезопасногоРежима - Булево - определяет возможность использования профиля безопасности +// в качестве профиля безопасности безопасного режима (как при указании в качестве профиля +// безопасного режима для информационной базы, так и при вызове УстановитьБезопасныйРежим(<Имя профиля>) из кода конфигурации, +// * ПолныйДоступКПривилегированномуРежиму - Булево - определяет возможность установки +// привилегированного режима из безопасного режима данного профиля безопасности, +// * ПолныйДоступКФайловойСистеме - Булево - определяет наличие ограничений на доступ к файловой +// системе. При установке значения равным Ложь, доступ будет предоставлен только к каталогам файловой +// системы, перечисленным в свойстве ВиртуальныеКаталоги, +// * ПолныйДоступКCOMОбъектам - Булево - определяет наличие ограничений на доступ к использованию +// COMОбъектов. При установке значения равным Ложь, доступ будет предоставлен только к COM-классам, +// перечисленным в свойстве COMКлассы, +// * ПолныйДоступКВнешнимКомпонентам - Булево - определяет наличие ограничений на доступ к использованию +// внешних компонент. При установке значения равным Ложь, доступ будет предоставлен только к внешним +// компонентам, перечисленным в свойстве ВнешниеКомпоненты, +// * ПолныйДоступКВнешнимМодулям - Булево - определяет наличие ограничений на доступ к использованию +// внешних модулей (внешние отчеты и обработки, вызовы Выполнить() и Вычислить()) в небезопасном режиме. +// При установке значения равным Ложь, будет предоставлена возможность использовать в небезопасном +// режиме только внешние модули, перечисленные в свойстве ВнешниеМодули, +// * ПолныйДоступКПриложениямОперационнойСистемы - Булево - определяет наличие ограничений на доступ к +// использованию приложений операционной системы. При установке значения равным Ложь, будет предоставлена +// возможность использовать только приложения операционной системы, перечисленные в свойстве ПриложенияОС, +// * ПолныйДоступКИнтернетРесурсам - Булево - определяет наличие ограничений на доступ к использованию +// Интернет-ресурсов. При установке значения равным Ложь, будет предоставлена возможность использовать +// только Интернет-ресурсы, перечисленные в свойстве ИнтернетРесурсы, +// * ВиртуальныеКаталоги - Массив из см. АдминистрированиеКластераКлиентСервер.СвойстваВиртуальногоКаталога +// * COMКлассы - Массив из см. АдминистрированиеКластераКлиентСервер.СвойстваCOMКласса +// * ВнешниеКомпоненты - Массив из см. АдминистрированиеКластераКлиентСервер.СвойстваВнешнейКомпоненты +// * ВнешниеМодули - Массив из см. АдминистрированиеКластераКлиентСервер.СвойстваВнешнегоМодуля +// * ПриложенияОС - Массив из см. АдминистрированиеКластераКлиентСервер.СвойстваПриложенияОС +// * ИнтернетРесурсы - Массив из см. АдминистрированиеКластераКлиентСервер.СвойстваИнтернетРесурса +// +Функция СвойстваПрофиляБезопасности() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваПрофиляБезопасности() +``` +
+ +## СвойстваВиртуальногоКаталога +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваВиртуальногоКаталога. +// Конструктор структуры, описывающей свойства виртуального каталога. +// +// Возвращаемое значение: +// Структура: +// * ЛогическийURL - Строка - логический URL каталога, +// * ФизическийURL - Строка - физический URL каталога на сервере для размещения данных +// виртуального каталога, +// * Описание - Строка - описание виртуального каталога, +// * ЧтениеДанных - Булево - флаг разрешения чтения данных из виртуального каталога, +// * ЗаписьДанных - Булево - флаг разрешения записи данных в виртуальный каталог. +// +Функция СвойстваВиртуальногоКаталога() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваВиртуальногоКаталога() +``` +
+ +## СвойстваCOMКласса +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваCOMКласса. +// Конструктор структуры, описывающей свойства COM-класса. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя COM-класса, используется в качестве ключа при поиске, +// * Описание - Строка - описание COM-класса, +// * ФайлМоникер - Строка - имя файла, по которому создается объект методом глобального +// контекста ПолучитьCOMОбъект() с пустым значением второго параметра, +// * CLSID - Строка - представление идентификатора COM-класса в формате системного реестра MS Windows +// без фигурных скобок, по которому он может быть создан операционной системой, +// * Компьютер - Строка - имя компьютера, на котором может быть создан COM-объект. +// +Функция СвойстваCOMКласса() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваCOMКласса() +``` +
+ +## СвойстваВнешнейКомпоненты +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваВнешнейКомпоненты. +// Конструктор структуры, описывающей свойства внешней компоненты. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя внешней компоненты, используется в качестве ключа для поиска, +// * Описание - Строка - описание внешней компоненты, +// * ХэшСумма - Строка - контрольная сумма разрешенной внешней компоненты, вычисленная алгоритмом +// SHA-1 и преобразованная к строке base64. +// +Функция СвойстваВнешнейКомпоненты() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваВнешнейКомпоненты() +``` +
+ +## СвойстваВнешнегоМодуля +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваВнешнегоМодуля. +// Конструктор структуры, описывающей свойства внешнего модуля. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя внешнего модуля, используется в качестве ключа для поиска, +// * Описание - Строка - описание внешнего модуля, +// * ХэшСумма - Строка - контрольная сумма разрешенного внешнего модуля, вычисленная алгоритмом +// SHA-1 и преобразованная к строке base64. +// +Функция СвойстваВнешнегоМодуля() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваВнешнегоМодуля() +``` +
+ +## СвойстваПриложенияОС +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваПриложенияОС. +// Конструктор структуры, описывающей свойства приложения операционной системы. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя приложения операционной системы, используется в качестве ключа для поиска, +// * Описание - Строка - описание приложения операционной системы, +// * ШаблонСтрокиЗапуска - Строка - шаблон строки запуска приложения (состоит из последовательности +// шаблонных слов, разделенных пробелами). +// +Функция СвойстваПриложенияОС() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваПриложенияОС() +``` +
+ +## СвойстваИнтернетРесурса +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваИнтернетРесурса. +// Конструктор структуры, описывающей Интернет-ресурс. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя Интернет-ресурса, используется в качестве ключа для поиска, +// * Описание - Строка - описание Интернет-ресурса, +// * Протокол - Строка - разрешаемый сетевой протокол. Возможные значения: +// HTTP, +// HTTPS, +// FTP, +// FTPS, +// POP3, +// SMTP, +// IMAP, +// * Адрес - Строка - сетевой адрес Интернет-ресурса без указания протокола и порта, +// * Порт - Число - сетевой порт Интернет-ресурса. +// +Функция СвойстваИнтернетРесурса() Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваИнтернетРесурса() +``` +
+ +## ПрофильБезопасности +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.ПрофильБезопасности. +// Возвращает свойства профиля безопасности. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ИмяПрофиля - Строка - имя профиля безопасности. +// +// Возвращаемое значение: +// см. АдминистрированиеКластераКлиентСервер.СвойстваПрофиляБезопасности. +// +Функция ПрофильБезопасности(Знач ПараметрыАдминистрированияКластера, Знач ИмяПрофиля) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.ПрофильБезопасности(ПараметрыАдминистрированияКластера, ИмяПрофиля) +``` +
+ +## СоздатьПрофильБезопасности +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СоздатьПрофильБезопасности. +// Создает профиль безопасности по переданному описанию. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// СвойстваПрофиляБезопасности - см. АдминистрированиеКластераКлиентСервер.СвойстваПрофиляБезопасности. +// +Процедура СоздатьПрофильБезопасности(Знач ПараметрыАдминистрированияКластера, Знач СвойстваПрофиляБезопасности) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.СоздатьПрофильБезопасности(ПараметрыАдминистрированияКластера, СвойстваПрофиляБезопасности) +``` +
+ +## УстановитьСвойстваПрофиляБезопасности +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.УстановитьСвойстваПрофиляБезопасности. +// Устанавливает свойства для существующего профиля безопасности по переданному описанию. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// СвойстваПрофиляБезопасности - см. АдминистрированиеКластераКлиентСервер.СвойстваПрофиляБезопасности. +// +Процедура УстановитьСвойстваПрофиляБезопасности(Знач ПараметрыАдминистрированияКластера, Знач СвойстваПрофиляБезопасности) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.УстановитьСвойстваПрофиляБезопасности(ПараметрыАдминистрированияКластера, СвойстваПрофиляБезопасности) +``` +
+ +## УдалитьПрофильБезопасности +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.УдалитьПрофильБезопасности. +// Удаляет профиль безопасности. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ИмяПрофиля - Строка - имя профиля безопасности. +// +Процедура УдалитьПрофильБезопасности(Знач ПараметрыАдминистрированияКластера, Знач ИмяПрофиля) Экспорт +``` + +Пример вызова +```bsl +АдминистрированиеКластераКлиентСервер.УдалитьПрофильБезопасности(ПараметрыАдминистрированияКластера, ИмяПрофиля) +``` +
+ +## ИдентификаторИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.ИдентификаторИнформационнойБазы. +// Возвращает внутренний идентификатор информационной базы. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов, +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ПараметрыАдминистрированияИнформационнойБазы - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// +// Возвращаемое значение: +// Строка - внутренний идентификатор информационной базы. +// +Функция ИдентификаторИнформационнойБазы(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач ПараметрыАдминистрированияИнформационнойБазы) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.ИдентификаторИнформационнойБазы(ИдентификаторКластера, ПараметрыАдминистрированияКластера, ПараметрыАдминистрированияИнформационнойБазы) +``` +
+ +## СвойстваИнформационныхБаз +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваИнформационныхБаз. +// Возвращает описания информационных баз. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов, +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// Фильтр - Структура - параметры фильтрации информационных баз. +// +// Возвращаемое значение: +// Массив из Структура +// +Функция СвойстваИнформационныхБаз(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваИнформационныхБаз(ИдентификаторКластера, ПараметрыАдминистрированияКластера, Фильтр); +``` +
+ +## ИдентификаторКластера +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.ИдентификаторКластера. +// Возвращает внутренний идентификатор кластера серверов. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера. +// +// Возвращаемое значение: +// Строка - внутренний идентификатор кластера серверов. +// +Функция ИдентификаторКластера(Знач ПараметрыАдминистрированияКластера) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.ИдентификаторКластера(ПараметрыАдминистрированияКластера) +``` +
+ +## СвойстваКластеров +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваКластеров. +// Возвращает описания кластеров серверов. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// Фильтр - Структура - параметры фильтрации кластеров серверов. +// +// Возвращаемое значение: +// Массив из Структура +// +Функция СвойстваКластеров(Знач ПараметрыАдминистрированияКластера, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваКластеров(ПараметрыАдминистрированияКластера, Фильтр); +``` +
+ +## СвойстваРабочихПроцессов +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваРабочихПроцессов. +// Возвращает описания рабочих процессов. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов, +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// Фильтр - Структура - параметры фильтрации рабочих процессов. +// +// Возвращаемое значение: +// Массив из Структура +// +Функция СвойстваРабочихПроцессов(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваРабочихПроцессов(ИдентификаторКластера, ПараметрыАдминистрированияКластера, Фильтр); +``` +
+ +## СвойстваРабочихСерверов +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваРабочихСерверов. +// Возвращает описания рабочих серверов. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов, +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// Фильтр - Структура - параметры фильтрации рабочих серверов. +// +// Возвращаемое значение: +// Массив из Структура +// +Функция СвойстваРабочихСерверов(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваРабочихСерверов(ИдентификаторКластера, ПараметрыАдминистрированияКластера, Фильтр); +``` +
+ +## СвойстваСеансов +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваСеансов. +// Возвращает описания сеансов информационной базы. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов, +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ИдентификаторИнформационнойБазы - Строка - внутренний идентификатор информационной базы, +// Фильтр - Массив из Структура: +// * Свойство - см. АдминистрированиеКластераКлиентСервер.СвойстваСеанса +// * ВидСравнения - ВидСравнения - значение системного перечисления ВидСравнения, +// * Значение - Число +// - Строка +// - Дата +// - Булево +// - СписокЗначений +// - Массив +// - Структура - значение, с которым +// сравнивается значение соответствующего свойства сеанса. +// - Структура - структура: ключ - Имя свойства сеанса (см. выше), значение - значение, с которым +// выполняется сеанс. При использовании данного варианта описания фильтра сравнение всегда выполняется на +// равенство. +// ИспользоватьСловарь - Булево - если Истина, то возвращаемый результат будет заполнен с использован словаря, иначе - без +// использования. +// +// Возвращаемое значение: +// - Массив из см. АдминистрированиеКластераКлиентСервер.СвойстваСеанса +// - Массив из Соответствие +// +Функция СвойстваСеансов(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач ИдентификаторИнформационнойБазы, Знач Фильтр = Неопределено, Знач ИспользоватьСловарь = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваСеансов(ИдентификаторКластера, ПараметрыАдминистрированияКластера, ИдентификаторИнформационнойБазы, Фильтр, ИспользоватьСловарь); +``` +
+ +## СвойстваСоединений +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.СвойстваСоединений. +// Возвращает описания соединений с информационной базой. +// +// Параметры: +// ИдентификаторКластера - Строка - внутренний идентификатор кластера серверов, +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// ИдентификаторИнформационнойБазы - Строка - внутренний идентификатор информационной базы, +// ПараметрыАдминистрированияИнформационнойБазы - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// Фильтр - Массив из Структура: +// * Свойство - см. АдминистрированиеКластераКлиентСервер.СвойстваСоединений +// * ВидСравнения - ВидСравнения - значение системного перечисления ВидСравнения, +// * Значение - Число +// - Строка +// - Дата +// - Булево +// - СписокЗначений +// - Массив +// - Структура - значение, с которым +// сравнивается значение соответствующего свойства соединения. +// - Структура - структура: ключ - Имя свойства соединения (см. выше), значение - значение, с которым +// выполняется соединение. При использовании данного варианта описания фильтра сравнение всегда выполняется на +// равенство. +// ИспользоватьСловарь - Булево - если Истина - возвращаемый результат будет заполнен с использованием словаря. +// +// Возвращаемое значение: +// - Массив из см. АдминистрированиеКластераКлиентСервер.СвойстваСоединений +// - Массив из Соответствие +// +Функция СвойстваСоединений(Знач ИдентификаторКластера, Знач ПараметрыАдминистрированияКластера, Знач ИдентификаторИнформационнойБазы, Знач ПараметрыАдминистрированияИнформационнойБазы, Знач Фильтр = Неопределено, Знач ИспользоватьСловарь = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.СвойстваСоединений(ИдентификаторКластера, ПараметрыАдминистрированияКластера, ИдентификаторИнформационнойБазы, ПараметрыАдминистрированияИнформационнойБазы, Фильтр, ИспользоватьСловарь); +``` +
+ +## ПутьККлиентуСервераАдминистрирования +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АдминистрированиеКластера.ПутьККлиентуСервераАдминистрирования. +// Возвращает путь к консольному клиенту сервера администрирования. +// +// Параметры: +// ПараметрыАдминистрированияКластера - см. АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера. +// +// Возвращаемое значение: +// Строка +// +Функция ПутьККлиентуСервераАдминистрирования(Знач ПараметрыАдминистрированияКластера) Экспорт +``` + +Пример вызова +```bsl +Результат = АдминистрированиеКластераКлиентСервер.ПутьККлиентуСервераАдминистрирования(ПараметрыАдминистрированияКластера) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/АдресныйКлассификатор.md b/src/content/docs/bsp/АдресныйКлассификатор.md new file mode 100644 index 0000000..04de645 --- /dev/null +++ b/src/content/docs/bsp/АдресныйКлассификатор.md @@ -0,0 +1,468 @@ +--- +title: Адресный классификатор +slug: bsp/адресный-классификатор +--- + + +## НаименованиеРегионаПоКоду +
+ +Описание, пример вызова + +```bsl + +// Определяет полное наименование региона по его коду. +// +// Параметры: +// КодСубъектаРФ - Число +// - Строка - код региона. Например, 50. +// +// Возвращаемое значение: +// Строка - наименование региона согласно ГАР. Например, "Московская область" или "Московская обл". +// Неопределено - если регион не существует. +// +Функция НаименованиеРегионаПоКоду(КодСубъектаРФ) Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.НаименованиеРегионаПоКоду(КодСубъектаРФ) +``` +
+ +## КодРегионаПоНаименованию +
+ +Описание, пример вызова + +```bsl + +// Возвращает код региона по наименованию. +// +// Параметры: +// Название - Строка - наименование или полное наименование (с сокращением) региона. +// Например, "Московская" или Московская обл". +// +// Возвращаемое значение: +// Число - код региона, например, 50. +// Неопределено - если указанный регион не существует. +// +Функция КодРегионаПоНаименованию(Название) Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.КодРегионаПоНаименованию(Название) +``` +
+ +## СубъектыРФ +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о субъектах РФ определенных в федеральной информационной адресной системе. +// +// Возвращаемое значение: +// ТаблицаЗначений - сведения о субъектах(регионах) РФ: +// * КодСубъектаРФ - Число - код субъекта, например 77 для Москвы. +// * Наименование - Строка - наименование субъекта. Например "Московская". +// * ТипОбъекта - Строка - сокращение субъекта. Например "обл". +// * ПочтовыйИндекс - Число - индекс региона. Если 0 - то индекс не определен. +// * Идентификатор - УникальныйИдентификатор - уникальный идентификационный код адресного объекта. +// * Сокращение - Строка - устарело. Следует использовать свойство ТипОбъекта. +// +Функция СубъектыРФ() Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.СубъектыРФ() +``` +
+ +## КоличествоЗагруженныхРегионов +
+ +Описание, пример вызова + +```bsl + +// Возвращает количество загруженных в адресный классификатор субъектов РФ. +// Из-за проверки доступности веб-сервиса выполнение функции может занимать 7 секунд. +// Поэтому для исключения зависаний пользовательского интерфейса, например при открытии формы, +// следует вызвать в фоновом задании. +// Т.к. при использовании веб-сервиса фирмы "1С" предоставляющего через Интернет сведения об +// адресах РФ в формате адресного классификатора, всегда доступны адресные сведения по всем регионам РФ, +// то возвращает общее количество субъектов РФ. +// +// Возвращаемое значение: +// Число - количество субъектов РФ, содержащих загруженные адресные сведения в адресном классификаторе. +// +Функция КоличествоЗагруженныхРегионов() Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.КоличествоЗагруженныхРегионов() +``` +
+ +## АдресныйКлассификаторЗагружен +
+ +Описание, пример вызова + +```bsl + +// Определяет наличие адресных сведений в адресном классификаторе. +// Из-за проверки доступности веб-сервиса выполнение функции может занимать 7 секунд. +// Поэтому для исключения зависаний пользовательского интерфейса, например при открытии формы, +// функцию следует вызвать в фоновом задании. +// При использовании веб-сервиса фирмы "1С" предоставляющего через Интернет сведения об +// адресах РФ в формате адресного классификатора, всегда возвращает Истина, если подключена интернет-поддержка пользователей. +// +// Возвращаемое значение: +// Булево - Истина, если адресный классификатор содержит сведения хотя бы по одному региону +// или подключен и доступен веб-сервис. +// Ложь, если адресные сведения отсутствуют, а веб-сервис недоступен. +// +Функция АдресныйКлассификаторЗагружен() Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.АдресныйКлассификаторЗагружен() +``` +
+ +## РазрешенДоступВИнтернет +
+ +Описание, пример вызова + +```bsl + +// Возвращает разрешение на доступ к веб-сервису адресов через сеть Интернет. +// Если доступ запрещен, то подбор и проверка адресов использует только загруженные данные в приложение. +// Изменение доступа выполняется в разделе Администрирование - Интернет-поддержка и сервисы. +// +// Возвращаемое значение: +// Булево - если Истина, то доступ к веб-сервису разрешен. +// +Функция РазрешенДоступВИнтернет() Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.РазрешенДоступВИнтернет() +``` +
+ +## ПроверитьАдреса +
+ +Описание, пример вызова + +```bsl + +// Проверяет адреса на соответствие адресному классификатору +// и возвращает подходящие варианты, содержащие сведения об адресе. +// При проверке адреса через веб-сервиса выполнение функции может занимать 20 секунд. +// Поэтому для исключения зависаний пользовательского интерфейса, например при открытии формы, +// функцию следует вызвать в фоновом задании. +// +// Параметры: +// Адреса - Массив - проверяемые адреса. Содержит структуры с полями: +// * Адрес - проверяемый адрес во внутреннем формате JSON или в XML, +// соответствующем XDTO-пакету Адрес (HTTP://www.v8.1c.ru/ssl/contactinfo), +// или его XML-сериализация, соответствующая структуре XDTO-пакета. +// +// Возвращаемое значение: +// Массив - результаты анализа. Каждый элемент массива содержит структуры с полями: +// * Ошибки - Массив - описание ошибок поиска в классификаторе. Состоит из массива структур с полями: +// ** Ключ - Строка - служебный идентификатор места ошибки (путь XPath в объекте XDTO). +// ** Текст - Строка - текст ошибки. +// ** Подсказка - Строка - текст возможного исправления ошибки. +// * Варианты - Массив - устарело. Содержит описание найденных вариантов в виде массива структур с полями: +// ** Идентификатор - УникальныйИдентификатор - уникальный идентификационный код адресного объекта. +// ** Индекс - Число - почтовый индекс адресного объекта. +// ** КодКЛАДР - Число - код КЛАДР ближайшего объекта. +// ** OKATO - Число - код общероссийского классификатора объектов административно-территориального деления. +// ** ОКТМО - Число - код общероссийского классификатора территорий муниципальных образований. +// ** КодИФНСФЛ - Строка - код инспекции ФНС обслуживающей физических лиц. +// ** КодИФНСЮЛ - Строка - код инспекции ФНС обслуживающей юридические лица. +// ** КодУчасткаИФНСФЛ - Строка - код территориального участка инспекции ФНС обслуживающей физических лиц. +// ** КодУчасткаИФНСЮЛ - Строка - код территориального участка инспекции ФНС обслуживающей юридические лица. +// +// Пример: +// СтруктураПроверки = Новый Структура("Адрес", Адрес); +// РезультатыПроверки = АдресныйКлассификатор.ПроверитьАдреса(ОбщегоНазначенияКлиентСервер.ЗначениеВМассиве(СтруктураПроверки)); +// +// Если РезультатыПроверки.Количество() > 0 И РезультатыПроверки.Варианты.Количество() > 0 Тогда +// КодКЛАДР = РезультатыПроверки.Варианты[0].КодКЛАДР; +// КонецЕсли; +// +Функция ПроверитьАдреса(Адреса) Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.ПроверитьАдреса(Адреса) +``` +
+ +## ПолноеНаименованиеАдресногоСокращения +
+ +Описание, пример вызова + +```bsl + +// Возвращает полное наименование адресного объекта по его сокращению. +// Если уровень не указан, то возвращает первое найденное совпадение. +// +// Параметры: +// АдресноеСокращение - Строка - сокращение адресного объекта. Например, "г". +// Уровень - Число - код уровня адресного объекта. Например, для уровня города 4. +// +// Возвращаемое значение: +// Строка - полное наименование адресного объекта. Например, "город". +// Неопределено - если указанное сокращение не существует. +// +Функция ПолноеНаименованиеАдресногоСокращения(АдресноеСокращение, Уровень = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.ПолноеНаименованиеАдресногоСокращения(АдресноеСокращение, Уровень); +``` +
+ +## КодыАдреса +
+ +Описание, пример вызова + +```bsl + +// Возвращает коды адрес (ОКТМО, ОКАТО, налоговых инспекций ФНС и др.) и +// уникальные идентификационные коды адресного объекта и дома. +// Кода не будут заполнены, если адрес не соответствует адресному классификатору или содержит адресные поля без идентификаторов. +// При получении кодов через веб-сервиса выполнение функции может занимать 20 секунд. +// Поэтому для исключения зависаний пользовательского интерфейса, например при открытии формы, +// функцию следует вызвать в фоновом задании. +// Если при попытке получения кодов через веб-сервис он оказывается недоступен или доступ к нему запрещен пользователем, +// то функция возвращает структуру с пустыми полями. +// Проверить, разрешен ли администратором доступ к веб-сервису адресов можно с помощью функции РазрешенДоступВИнтернет. +// +// Параметры: +// Адрес - Строка - адрес во внутреннем формате JSON или XML, соответствующий структуре XDTO-пакета Адрес. +// Источник - Строка - источник получения кодов адреса: +// "Сервис1С" - коды будут получены через веб-сервис "1С" предоставляющий сведения об адресах РФ в формате +// адресного классификатора; +// "ЗагруженныеДанные" - сначала будет попытка определить коды по загруженным данным адресного классификатора, +// а затем, если коды не были определены, то они будут получены через веб-сервис "1С". +// Если параметр не указан, то определение кодов будет аналогично параметру ЗагруженныеДанные. +// Возвращаемое значение: +// Структура - коды адреса. Если адрес не существует, то поля структуры содержат пустые значения: +// * Идентификатор - Строка - уникальный идентификационный код адресного объекта. +// * ИдентификаторДома - Строка - уникальный идентификационный код дома(здания) адресного объекта. +// * КодКЛАДР - Строка - код классификатор адресов России (КЛАДР). +// * КодИФНСФЛ - Строка - код инспекции ФНС, обслуживающей физических лиц. +// * КодИФНСЮЛ - Строка - код инспекции ФНС, обслуживающей юридические лица. +// * КодУчасткаИФНСФЛ - Строка - код территориального участка инспекции ФНС, обслуживающей физических лиц. +// * КодУчасткаИФНСЮЛ - Строка - код территориального участка инспекции ФНС, обслуживающей юридические лица. +// * OKATO - Строка - код общероссийского классификатора объектов административно-территориального деления. +// * ОКТМО - Строка - код общероссийского классификатора территорий муниципальных образований. +// * ОКТМОБюджетополучателя- Строка - код бюджетополучателя общероссийского классификатора +// территорий муниципальных образований. +// +Функция КодыАдреса(Адрес, Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.КодыАдреса(Адрес, Источник); +``` +
+ +## СокращенияАдресныхОбъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает соответствие полных наименований адресных объектов и их сокращения. +// +// Параметры: +// НаименованияАдресныхОбъектов - Массив из Строка - полные наименования адресных объектов. +// Если передан пустой массив, то будут возвращен полный список наименований и сокращений. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - полное наименование адресного объекта. +// * Значение - Строка - сокращение адресного объекта. +// +Функция СокращенияАдресныхОбъектов(НаименованияАдресныхОбъектов) Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.СокращенияАдресныхОбъектов(НаименованияАдресныхОбъектов) +``` +
+ +## СведенияПоОКМТО +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения об адресе по коду ОКТМО, который состоит из 8 или 11 цифр. +// +// Параметры: +// ОКТМО - Соответствие - код общероссийского классификатора территорий муниципальных образований. +// +// Возвращаемое значение: +// Структура: +// * КодРегиона - Строка - код региона РФ. +// * Регион - Строка - текстовое представление региона РФ. +// * РегионТипПолный - Строка - полное наименование типа региона. Например: "область". +// * РегионТипКраткий - Строка - краткое наименование типа региона. Например: "обл". +// * ИдентификаторРегиона- УникальныйИдентификатор +// - Неопределено - идентификационный код региона. +// * МуниципальныйРайон - Строка - текстовое представление муниципального района для адреса по муниципальному делению. +// * МуниципальныйРайонТипПолный - Строка - полное наименование типа муниципального района по муниципальному +// делению. Например: "городской округ". +// * МуниципальныйРайонТипКраткий - Строка - краткое наименование типа муниципального района для адреса по +// муниципальному делению. Например: "мун.р-н". +// * ИдентификаторМуниципальногоРайона- УникальныйИдентификатор +// - Неопределено - идентификационный код муниципального район. +// * КодМуниципальногоРайона - Строка - код муниципального района: 1- муниципальный район; 2- городской округ; +// 3 - внутригородская территория города федерального значения; 4 - муниципальный округ. +// Если не удалось определить код, то возвращается пустая строка. +// * Поселение - Строка - текстовое представление поселения у адресов по муниципальному делению. +// * ПоселениеТипПолный - Строка - полное наименование типа сельского поселения по муниципальному делению. +// Например: "сельское поселение". +// * ПоселениеТипКраткий - Строка - краткое наименование типа муниципального района для адреса по муниципальному +// делению. Например: "с. п.". +// * ИдентификаторПоселения- УникальныйИдентификатор +// - Неопределено - идентификационный код поселения. +// * КодПоселения - Строка - код поселения: 1 - городское поселение; 2 - сельское поселение; 3- межселенная +// территория в составе муниципального района; 4 - внутригородской район городского округа; +// * НаселенныйПункт - Строка - текстовое представление населенного пункта. +// * НаселенныйПунктТипПолный - Строка - полное наименование типа населенного пункта. Например: "деревня". +// * НаселенныйПунктТипКраткий - Строка - краткое наименование типа населенного пункта. Например: "д". +// * ИдентификаторНаселенногоПункта- УникальныйИдентификатор +// - Неопределено - идентификационный код населенного пункта. +// * Территория - Строка - текстовое представление территории (элемент планировочной структуры). +// * ТерриторияТипПолный - Строка - полное наименование типа территории. Например: "Гаражно-строительный кооп.". +// * ТерриторияТипКраткий - Строка - краткое наименование типа территории. Например: "гск". +// * ИдентификаторТерритории- УникальныйИдентификатор +// - Неопределено - идентификационный код территории. +// * ПочтовыйИндекс - Число - почтовый индекс. +// * OKATO - Строка - код общероссийского классификатора объектов административно-территориального деления. +// * КодКЛАДР - Строка - код классификатор адресов России (КЛАДР). +// * КодИФНСФЛ - Строка - код инспекции ФНС, обслуживающей физических лиц. +// * КодИФНСЮЛ - Строка - код инспекции ФНС, обслуживающей юридические лица. +// * КодУчасткаИФНСФЛ - Строка - код территориального участка инспекции ФНС, обслуживающей физических лиц. +// * КодУчасткаИФНСЮЛ - Строка - код территориального участка инспекции ФНС, обслуживающей юридические лица. +// +Функция СведенияПоОКМТО(ОКТМО) Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.СведенияПоОКМТО(ОКТМО) +``` +
+ +## ПроверитьОКТМОБюджетополучателя +
+ +Описание, пример вызова + +```bsl + +// Проверяет корректность ОКМТО бюджетополучателей. +// +// Для проверки ОКТМО бюджетополучателей требуется подключение к Интернет-поддержке пользователей и наличие +// постоянного соединения с интернетом, т.к. адресные сведения, загруженные в приложение, не используются. +// Проверка выполняется порциям по 100 значений за один запросу к веб-сервису, поэтому рекомендуется выполнять +// ее в фоновом режиме. +// При получении ответа от веб-сервиса отличного от успешного (код 200 ОК) выполнение функции прерывается +// и возвращается ошибка. Поэтому если в данных результата отсутствует ОКТМО бюджетополучателя, +// то он не было проверен из-за ошибок работы с веб-сервисом. +// +// Параметры: +// ОКТМОБюджетополучателей - Массив из Строка - список ОКТМО бюджетополучателей. +// - Строка - ОКТМО бюджетополучателя. +// +// Возвращаемое значение: +// Структура: +// * Отказ - Булево - если Истина, то при получении ОКТМО бюджетополучателя через веб-сервис возникла ошибка. +// * ПредставлениеОшибкиДляПользователя - Строка - текст ошибки для отображения пользователю. +// * ИнформацияОбОшибке - ИнформацияОбОшибке - структурированная информация об ошибке. +// * Данные - Соответствие из КлючИЗначение: +// ** Ключ - Строка - ОКТМО бюджетополучателя. +// ** Значение - Структура: +// *** Успешно - Булево - если Истина, то код ОКТМО бюджетополучателей корректный; +// *** ТекстОшибки - Строка - текст ошибки, если ОКТМО некорректный; +// *** МуниципальныеОбразования - Массив из Строка - список муниципальных образований, принадлежащих данному ОКТМО. +// +Функция ПроверитьОКТМОБюджетополучателя(ОКТМОБюджетополучателей) Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.ПроверитьОКТМОБюджетополучателя(ОКТМОБюджетополучателей) +``` +
+ +## ИдентификаторыАдреса +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификационный код дома и адресного объекта с помощью веб-сервиса фирмы 1С предоставляющего +// сведения об адресах РФ в формате адресного классификатора. Для получения идентификаторов требуется подключение +// к Интернет-поддержке пользователей и наличие постоянного соединения с интернетом, +// т.к. адресные сведения, загруженные в приложение, не используются. +// +// Параметры: +// Адрес - Строка - XML соответствующий структуре XDTO-пакета Адрес, содержащий адрес, +// для которого требуется определить идентификационные коды. +// Возвращаемое значение: +// Структура: +// * ИдентификаторАдресногоОбъекта - УникальныйИдентификатор - идентификационный код адресного объекта (улицы, +// нас. пункта). +// * ИдентификаторДома - УникальныйИдентификатор - идентификационный код дома адресного объекта. +// * Отказ - Булево - если Истина, то при работе с веб-сервисом возникла ошибка. +// * ПодробноеПредставлениеОшибки - Строка - полное описание ошибки, если при работе с веб-сервисом возникла +// ошибка, иначе Неопределено. +// * КраткоеПредставлениеОшибки - Строка - краткое описание ошибки, если при работе с веб-сервисом возникла +// ошибка, иначе Неопределено. +// +Функция ИдентификаторыАдреса(Адрес) Экспорт +``` + +Пример вызова +```bsl +Результат = АдресныйКлассификатор.ИдентификаторыАдреса(Адрес) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/АдресныйКлассификаторКлиент.md b/src/content/docs/bsp/АдресныйКлассификаторКлиент.md new file mode 100644 index 0000000..501f312 --- /dev/null +++ b/src/content/docs/bsp/АдресныйКлассификаторКлиент.md @@ -0,0 +1,64 @@ +--- +title: Адресный классификатор клиент +slug: bsp/адресный-классификатор-клиент +--- + + +## ЗагрузитьАдресныйКлассификатор +
+ +Описание, пример вызова + +```bsl + +// Открывает форму загрузки классификатора. +// +// Параметры: +// Параметры - ПараметрыВыполненияКоманды +// - Структура - параметры открытия формы. +// +Процедура ЗагрузитьАдресныйКлассификатор(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +АдресныйКлассификаторКлиент.ЗагрузитьАдресныйКлассификатор(Параметры); +``` +
+ +## ПоказатьФормуЗагрузкиАдресногоКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Открывает форму загрузки адресного классификатора. +// +// Параметры: +// ОповещениеОЗакрытие - ОписаниеОповещения - оповещение, которое вызывается при закрытии формы загрузки адресного классификатора. +// ПараметрыФормы - Структура - параметры открытия формы: +// * КодРегионаДляЗагрузки - Число +// - Массив - если указан, то регион будет отмечен для загрузки. +// ПараметрыОткрытия - Структура - параметры открытия формы: +// * Владелец - Произвольный - форма или элемент управления другой формы. +// * Уникальность - Произвольный - ключ, значение которого будет использоваться для поиска уже открытых форм. +// * Окно - ОкноКлиентскогоПриложения - окно приложения, в котором будет открыта форма. +// * НавигационнаяСсылка - Строка - задает навигационную ссылку, возвращаемую формой. +// +Процедура ПоказатьФормуЗагрузкиАдресногоКлассификатора(ОповещениеОЗакрытие = Неопределено, ПараметрыФормы = Неопределено, ПараметрыОткрытия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +АдресныйКлассификаторКлиент.ПоказатьФормуЗагрузкиАдресногоКлассификатора(ОповещениеОЗакрытие, ПараметрыФормы, ПараметрыОткрытия); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/АнализСхемКонфигурации.md b/src/content/docs/bsp/АнализСхемКонфигурации.md new file mode 100644 index 0000000..9f23ec5 --- /dev/null +++ b/src/content/docs/bsp/АнализСхемКонфигурации.md @@ -0,0 +1,29 @@ +--- +title: Анализ схем конфигурации +slug: bsp/анализ-схем-конфигурации +--- + + +## ОписанияРазличийСхемКонфигураций +
+ +Описание, пример вызова + +```bsl + +Функция ОписанияРазличийСхемКонфигураций(ДанныеСхемыКонфигурацииИсточника, ДанныеСхемыКонфигурацииПриемника) Экспорт +``` + +Пример вызова +```bsl +Результат = АнализСхемКонфигурации.ОписанияРазличийСхемКонфигураций(ДанныеСхемыКонфигурацииИсточника, ДанныеСхемыКонфигурацииПриемника) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/АсинхронноеПолучениеДанных.md b/src/content/docs/bsp/АсинхронноеПолучениеДанных.md new file mode 100644 index 0000000..f824be7 --- /dev/null +++ b/src/content/docs/bsp/АсинхронноеПолучениеДанных.md @@ -0,0 +1,135 @@ +--- +title: Асинхронное получение данных +slug: bsp/асинхронное-получение-данных +--- + + +## ИдентификаторХранилища +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификатор хранилища в виде строки. +// @skip-check module-empty-method - особенность реализации. +// @skip-warning - обратная совместимость. +// +// Возвращаемое значение: +// Строка - идентификатор хранилища. +// +Функция ИдентификаторХранилища() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанных.ИдентификаторХранилища() +``` +
+ +## НовыйОписаниеВозвращаемыхДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает новую структуру описания возвращаемых данных. +// @skip-check module-empty-method - особенность реализации. +// @skip-warning - обратная совместимость. +// +// Возвращаемое значение: +// Структура: +// * МодульМенеджер - ОбщийМодуль, СправочникиМенеджер, ОтчетыМенеджер - модуль менеджера получения данных. +// * Наименование - Строка - наименование возвращаемых данных. +// * Описание - Строка - подробное описание возвращаемых данных. +// * ТипыРезультата - Массив из Строка - типы возвращаемых данных. +// +Функция НовыйОписаниеВозвращаемыхДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанных.НовыйОписаниеВозвращаемыхДанных() +``` +
+ +## ДоступныеВозвращаемыеДанные +
+ +Описание, пример вызова + +```bsl + +// Возвращает перечень доступных данных +// @skip-check module-empty-method - особенность реализации. +// @skip-warning - обратная совместимость. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение - перечень доступных возвращаемых данных: +// * Ключ - Строка - идентификатор данных. +// * Значение - см. АсинхронноеПолучениеДанных.НовыйОписаниеВозвращаемыхДанных +// +Функция ДоступныеВозвращаемыеДанные() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанных.ДоступныеВозвращаемыеДанные() +``` +
+ +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков. +// @skip-check module-empty-method - особенность реализации. +// @skip-warning - обратная совместимость. +// +// Параметры: +// СоответствиеИменПсевдонимам - см. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков.СоответствиеИменПсевдонимам +// +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +АсинхронноеПолучениеДанных.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ПодготовитьДанные +
+ +Описание, пример вызова + +```bsl + +// Формирует данные для ответа по полученным параметрам. +// @skip-check module-empty-method - особенность реализации. +// @skip-warning - обратная совместимость. +// +// Параметры: +// ИдентификаторДанных - Строка - идентификатор данных, которые нужно получить. +// ИдентификаторПараметров - УникальныйИдентификатор - идентификатор файла параметров получения данных. +// +Процедура ПодготовитьДанные(ИдентификаторДанных, ИдентификаторПараметров) Экспорт +``` + +Пример вызова +```bsl +АсинхронноеПолучениеДанных.ПодготовитьДанные(ИдентификаторДанных, ИдентификаторПараметров) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/АсинхронноеПолучениеДанныхПереопределяемый.md b/src/content/docs/bsp/АсинхронноеПолучениеДанныхПереопределяемый.md new file mode 100644 index 0000000..2bef3ed --- /dev/null +++ b/src/content/docs/bsp/АсинхронноеПолучениеДанныхПереопределяемый.md @@ -0,0 +1,65 @@ +--- +title: Асинхронное получение данных переопределяемый +slug: bsp/асинхронное-получение-данных-переопределяемый +--- + + +## УстановитьДоступныеВозвращаемыеДанные +
+ +Описание, пример вызова + +```bsl + +// Вызывается при формировании списка доступных возвращаемых данных и при получении данных. +// Определяет список возвращаемых данных, подключенных к подсистеме. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ДоступныеВозвращаемыеДанные - Соответствие из КлючИЗначение - заполняемые доступные возвращаемые данные: +// * Ключ - Строка - идентификатор данных. +// * Значение - см. АсинхронноеПолучениеДанных.НовыйОписаниеВозвращаемыхДанных +// +Процедура УстановитьДоступныеВозвращаемыеДанные(ДоступныеВозвращаемыеДанные) Экспорт +``` + +Пример вызова +```bsl +АсинхронноеПолучениеДанныхПереопределяемый.УстановитьДоступныеВозвращаемыеДанные(ДоступныеВозвращаемыеДанные) +``` +
+ +## АвторизоватьЗапрос +
+ +Описание, пример вызова + +```bsl + +// Вызывается при первичной обработке входящего запроса. Позволяет выполнить прикладную логику, +// связанную с валидацией входящего запроса и при необходимости отказать в обработке запроса. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ИдентификаторДанных - Строка - идентификатор данных. Может быть переопределено при обработке. +// Указывается в качестве имени файла, возвращаемом в результате. +// Параметры - ДвоичныеДанные - переданные параметры получения данных. +// Отказ - Булево - Возвращаемый параметр. Признак отказа в авторизации. При отказе в авторизации устанавливать в Отказ = Истина. +// СообщениеОбОшибке - Строка - Возвращаемый параметр. Текст сообщения об ошибке при отказе в авторизации. +// +Процедура АвторизоватьЗапрос(ИдентификаторДанных, Параметры, Отказ, СообщениеОбОшибке) Экспорт +``` + +Пример вызова +```bsl +АсинхронноеПолучениеДанныхПереопределяемый.АвторизоватьЗапрос(ИдентификаторДанных, Параметры, Отказ, СообщениеОбОшибке) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/АсинхронноеПолучениеДанныхСловарь.md b/src/content/docs/bsp/АсинхронноеПолучениеДанныхСловарь.md new file mode 100644 index 0000000..d4a1770 --- /dev/null +++ b/src/content/docs/bsp/АсинхронноеПолучениеДанныхСловарь.md @@ -0,0 +1,233 @@ +--- +title: Асинхронное получение данных словарь +slug: bsp/асинхронное-получение-данных-словарь +--- + + +## КодВозвратаОшибкаДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает код ошибки данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаОшибкаДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаОшибкаДанных() +``` +
+ +## КодВозвратаОтказАвторизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает код отказа авторизации. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаОтказАвторизации() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаОтказАвторизации() +``` +
+ +## КодВозвратаВнутренняяОшибка +
+ +Описание, пример вызова + +```bsl + +// Возвращает код внутренней ошибки. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаВнутренняяОшибка() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаВнутренняяОшибка() +``` +
+ +## КодВозвратаВыполненоСПредупреждениями +
+ +Описание, пример вызова + +```bsl + +// Возвращает код выполнения с предупреждениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаВыполненоСПредупреждениями() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаВыполненоСПредупреждениями() +``` +
+ +## КодВозвратаВыполнено +
+ +Описание, пример вызова + +```bsl + +// Возвращает код успешного выполнения. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаВыполнено() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаВыполнено() +``` +
+ +## КодСостоянияОжидание +
+ +Описание, пример вызова + +```bsl + +// Возвращает код ожидания данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодСостоянияОжидание() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанныхСловарь.КодСостоянияОжидание() +``` +
+ +## КодВозвратаНеНайдено +
+ +Описание, пример вызова + +```bsl + +// Возвращает код отсутствия данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаНеНайдено() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанныхСловарь.КодВозвратаНеНайдено() +``` +
+ +## ТипJSON +
+ +Описание, пример вызова + +```bsl + +// Возвращает строку с типом файла JSON +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - "json" +// +Функция ТипJSON() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанныхСловарь.ТипJSON() +``` +
+ +## ТипXLSX +
+ +Описание, пример вызова + +```bsl + +// Возвращает строку с типом файла XLSX +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - "xlsx" +// +Функция ТипXLSX() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанныхСловарь.ТипXLSX() +``` +
+ +## ТипPDF +
+ +Описание, пример вызова + +```bsl + +// Возвращает строку с типом файла PDF +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - "PDF" +// +Функция ТипPDF() Экспорт +``` + +Пример вызова +```bsl +Результат = АсинхронноеПолучениеДанныхСловарь.ТипPDF() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/БТС.md b/src/content/docs/bsp/БТС.md new file mode 100644 index 0000000..f302855 --- /dev/null +++ b/src/content/docs/bsp/БТС.md @@ -0,0 +1,38 @@ +--- +title: БТС +slug: bsp/бтс +--- + + +## ЗафиксироватьСобытиеСтатистикиРасширения +
+ +Описание, пример вызова + +```bsl + +// Выполняет фиксацию события работы расширения, в группе событий "Пользовательское" +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторСобытия - Строка - идентификатор события полученный в личном кабинете Менеджера сервиса (длина 36). +// +// Пример: +// БТС.ЗафиксироватьСобытиеСтатистикиРасширения("2f1df77a-9f07-11e9-9d8c-0242ac1d0004") +// +Процедура ЗафиксироватьСобытиеСтатистикиРасширения(Знач ИдентификаторСобытия) Экспорт +``` + +Пример вызова +```bsl +БТС.ЗафиксироватьСобытиеСтатистикиРасширения(ИдентификаторСобытия) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/БТСКлиент.md b/src/content/docs/bsp/БТСКлиент.md new file mode 100644 index 0000000..62bb9e2 --- /dev/null +++ b/src/content/docs/bsp/БТСКлиент.md @@ -0,0 +1,38 @@ +--- +title: БТС клиент +slug: bsp/бтс-клиент +--- + + +## ЗафиксироватьСобытиеСтатистикиРасширения +
+ +Описание, пример вызова + +```bsl + +// Выполняет фиксацию события работы расширения, в группе событий "Пользовательское" +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторСобытия - Строка - идентификатор события полученный в личном кабинете Менеджера сервиса (длина 36). +// +// Пример: +// БТСКлиент.ЗафиксироватьСобытиеСтатистикиРасширения("2f1df77a-9f07-11e9-9d8c-0242ac1d0004") +// +Процедура ЗафиксироватьСобытиеСтатистикиРасширения(Знач ИдентификаторСобытия) Экспорт +``` + +Пример вызова +```bsl +БТСКлиент.ЗафиксироватьСобытиеСтатистикиРасширения(ИдентификаторСобытия) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/БизнесПроцессыИЗадачиВызовСервера.md b/src/content/docs/bsp/БизнесПроцессыИЗадачиВызовСервера.md new file mode 100644 index 0000000..e8fc76b --- /dev/null +++ b/src/content/docs/bsp/БизнесПроцессыИЗадачиВызовСервера.md @@ -0,0 +1,143 @@ +--- +title: Бизнес процессы и задачи вызов сервера +slug: bsp/бизнес-процессы-и-задачи-вызов-сервера +--- + + +## ФормаВыполненияЗадачи +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать БизнесПроцессыИЗадачиСервер.ФормаВыполненияЗадачи. +// Получить структуру с описанием формы выполнения задачи. +// +// Параметры: +// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя +// +// Возвращаемое значение: +// см. БизнесПроцессыИЗадачиПереопределяемый.ПриПолученииФормыВыполненияЗадачи.ПараметрыФормы +// +Функция ФормаВыполненияЗадачи(Знач ЗадачаСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиВызовСервера.ФормаВыполненияЗадачи(ЗадачаСсылка) +``` +
+ +## ЭтоЗадачаИсполнителю +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать БизнесПроцессыИЗадачиСервер.ЭтоЗадачаИсполнителю. +// Проверяет, находится ли в ячейке отчета ссылка на задачу и в параметре +// ЗначениеРасшифровки возвращает значение расшифровки. +// +// Параметры: +// Расшифровка - Строка - имя ячейки. +// ДанныеРасшифровкиОтчета - Строка - адрес во временном хранилище. +// ЗначениеРасшифровки - ЗадачаСсылка.ЗадачаИсполнителя +// - Произвольный - значение расшифровки из ячейки. +// +// Возвращаемое значение: +// Булево - Истина, если это задача исполнителю. +// +Функция ЭтоЗадачаИсполнителю(Знач Расшифровка, Знач ДанныеРасшифровкиОтчета, ЗначениеРасшифровки) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиВызовСервера.ЭтоЗадачаИсполнителю(Расшифровка, ДанныеРасшифровкиОтчета, ЗначениеРасшифровки) +``` +
+ +## ВыполнитьЗадачу +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать БизнесПроцессыИЗадачиСервер.ВыполнитьЗадачу. +// Выполнить задачу ЗадачаСсылка, при необходимости выполнив обработчик. +// ОбработкаВыполненияПоУмолчанию модуля менеджера бизнес-процесса, +// к которому относится задача ЗадачаСсылка. +// +// Параметры: +// ЗадачаСсылка - ЗадачаСсылка +// ДействиеПоУмолчанию - Булево - признак необходимости вызова процедуры +// ОбработкаВыполненияПоУмолчанию у бизнес-процесса задачи. +// +Процедура ВыполнитьЗадачу(ЗадачаСсылка, ДействиеПоУмолчанию = Ложь) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиВызовСервера.ВыполнитьЗадачу(ЗадачаСсылка, ДействиеПоУмолчанию); +``` +
+ +## ЭтоВедущаяЗадача +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать БизнесПроцессыИЗадачиСервер.ЭтоВедущаяЗадача. +// Проверяет, является ли указанная задача ведущей. +// +// Параметры: +// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоВедущаяЗадача(Знач ЗадачаСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиВызовСервера.ЭтоВедущаяЗадача(ЗадачаСсылка) +``` +
+ +## СформироватьДанныеВыбораИсполнителя +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать БизнесПроцессыИЗадачиСервер.СформироватьДанныеВыбораИсполнителя. +// Формирует список подбора для указания исполнителя в полях ввода составного типа (Пользователь и Роль). +// +// Параметры: +// Текст - Строка - фрагмент текста для поиска возможных исполнителей. +// +// Возвращаемое значение: +// СписокЗначений - список подбора, содержащий возможных исполнителей. +// +Функция СформироватьДанныеВыбораИсполнителя(Знач Текст) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиВызовСервера.СформироватьДанныеВыбораИсполнителя(Текст) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/БизнесПроцессыИЗадачиКлиент.md b/src/content/docs/bsp/БизнесПроцессыИЗадачиКлиент.md new file mode 100644 index 0000000..7af2e36 --- /dev/null +++ b/src/content/docs/bsp/БизнесПроцессыИЗадачиКлиент.md @@ -0,0 +1,464 @@ +--- +title: Бизнес процессы и задачи клиент +slug: bsp/бизнес-процессы-и-задачи-клиент +--- + + +## Остановить +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанные бизнес-процессы как остановленные. +// +// Параметры: +// ПараметрКоманды - Массив из ОпределяемыйТип.БизнесПроцесс +// - ОпределяемыйТип.БизнесПроцесс +// +Процедура Остановить(Знач ПараметрКоманды) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.Остановить(ПараметрКоманды) +``` +
+ +## ОстановитьБизнесПроцессИзФормыОбъекта +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанный бизнес-процесс как остановленный. +// Предназначена для вызова из формы бизнес-процесса. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОбъектов - форма бизнес-процесса, где: +// * Объект - ОпределяемыйТип.БизнесПроцессОбъект - бизнес-процесс. +// +Процедура ОстановитьБизнесПроцессИзФормыОбъекта(Форма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ОстановитьБизнесПроцессИзФормыОбъекта(Форма) +``` +
+ +## СделатьАктивным +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанные бизнес-процессы как активные. +// +// Параметры: +// ПараметрКоманды - Массив из ОпределяемыйТип.БизнесПроцесс +// - СтрокаГруппировкиДинамическогоСписка +// - ОпределяемыйТип.БизнесПроцесс - бизнес процесс. +// +Процедура СделатьАктивным(Знач ПараметрКоманды) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.СделатьАктивным(ПараметрКоманды) +``` +
+ +## ПродолжитьБизнесПроцессИзФормыОбъекта +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанный бизнес-процесс как активный. +// Предназначена для вызова из формы бизнес-процесса. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОбъектов - форма бизнес-процесса, где: +// * Объект - ОпределяемыйТип.БизнесПроцессОбъект - бизнес-процесс. +// +Процедура ПродолжитьБизнесПроцессИзФормыОбъекта(Форма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ПродолжитьБизнесПроцессИзФормыОбъекта(Форма) +``` +
+ +## ПринятьЗадачиКИсполнению +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанные задачи как принятые к исполнению. +// +// Параметры: +// МассивЗадач - Массив из ЗадачаСсылка.ЗадачаИсполнителя +// +Процедура ПринятьЗадачиКИсполнению(Знач МассивЗадач) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ПринятьЗадачиКИсполнению(МассивЗадач) +``` +
+ +## ПринятьЗадачуКИсполнению +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанную задачу как принятую к исполнению. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОбъектов - форма задачи, где: +// * Объект - ЗадачаОбъект - задача. +// ТекущийПользователь - СправочникСсылка.ВнешниеПользователи +// - СправочникСсылка.Пользователи - ссылка на текущего +// пользователя приложения. +// +Процедура ПринятьЗадачуКИсполнению(Форма, ТекущийПользователь) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ПринятьЗадачуКИсполнению(Форма, ТекущийПользователь) +``` +
+ +## ОтменитьПринятиеЗадачКИсполнению +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанные задачи как не принятые к исполнению. +// +// Параметры: +// МассивЗадач - Массив из ЗадачаСсылка.ЗадачаИсполнителя +// +Процедура ОтменитьПринятиеЗадачКИсполнению(Знач МассивЗадач) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ОтменитьПринятиеЗадачКИсполнению(МассивЗадач) +``` +
+ +## ОтменитьПринятиеЗадачиКИсполнению +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанную задачу как не принятую к исполнению. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОбъектов - форма задачи, где: +// * Объект - ЗадачаОбъект - задача. +// +Процедура ОтменитьПринятиеЗадачиКИсполнению(Форма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ОтменитьПринятиеЗадачиКИсполнению(Форма) +``` +
+ +## ОбновитьДоступностьКомандПринятияКИсполнению +
+ +Описание, пример вызова + +```bsl + +// Устанавливает доступность команд принятия к исполнению. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма задачи, где: +// * Элементы - ВсеЭлементыФормы - элементы формы. Содержит: +// ** ФормаПринятьКИсполнению - ПолеВвода - кнопка команды на форме. +// ** ФормаОтменитьПринятиеКИсполнению - ПолеВвода - кнопка команды на форме. +// +Процедура ОбновитьДоступностьКомандПринятияКИсполнению(Форма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ОбновитьДоступностьКомандПринятияКИсполнению(Форма) +``` +
+ +## НастроитьОтложенныйСтарт +
+ +Описание, пример вызова + +```bsl + +// Открывает форму для настройки отложенного старта бизнес процесса. +// +// Параметры: +// БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс +// СрокИсполнения - Дата +// +Процедура НастроитьОтложенныйСтарт(БизнесПроцесс, СрокИсполнения) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.НастроитьОтложенныйСтарт(БизнесПроцесс, СрокИсполнения) +``` +
+ +## ФормаЗадачиОбработкаОповещения +
+ +Описание, пример вызова + +```bsl + +// Стандартный обработчик оповещения для форм выполнения задач. +// Для вызова из обработчика события формы ОбработкаОповещения. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма выполнения задачи, где: +// * Объект - ЗадачаОбъект - задача объекта. +// ИмяСобытия - Строка - имя события. +// Параметр - Произвольный - параметр события. +// Источник - Произвольный - источник события. +// +Процедура ФормаЗадачиОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ФормаЗадачиОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) +``` +
+ +## СписокЗадачПередНачаломДобавления +
+ +Описание, пример вызова + +```bsl + +// Стандартный обработчик ПередНачаломДобавления для списков задач. +// Для вызова из обработчика события таблицы формы ПередНачаломДобавления. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма задачи. +// Элемент - ТаблицаФормы - элементы таблицы формы. +// Отказ - Булево - признак отказа от добавления объекта. Если в теле процедуры-обработчика установить данному +// параметру значение Истина, то добавление объекта выполнено не будет. +// Копирование - Булево - определяет режим копирования. Если установлено Истина, то происходит копирование строки. +// Родитель - Неопределено +// - СправочникСсылка +// - ПланСчетовСсылка - ссылка на элемент, который будет использован при +// добавлении в качестве родителя. +// Группа - Булево - признак добавления группы. Истина - будет добавлена группа. +// +Процедура СписокЗадачПередНачаломДобавления(Форма, Элемент, Отказ, Копирование, Родитель, Группа) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.СписокЗадачПередНачаломДобавления(Форма, Элемент, Отказ, Копирование, Родитель, Группа) +``` +
+ +## ЗаписатьИЗакрытьВыполнить +
+ +Описание, пример вызова + +```bsl + +// Записать и закрыть форму выполнения задачи. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма выполнения задачи, где: +// * Объект - ЗадачаОбъект - задача бизнес-процесса. +// ВыполнитьЗадачу - Булево - задача записывается в режиме выполнения. +// ПараметрыОповещения - Структура - дополнительные параметры оповещения. +// +// Возвращаемое значение: +// Булево - Истина, если запись прошла успешно. +// +Функция ЗаписатьИЗакрытьВыполнить(Форма, ВыполнитьЗадачу = Ложь, ПараметрыОповещения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиКлиент.ЗаписатьИЗакрытьВыполнить(Форма, ВыполнитьЗадачу, ПараметрыОповещения); +``` +
+ +## СоздатьЗадание +
+ +Описание, пример вызова + +```bsl + +// Открыть форму для ввода нового задания. +// +// Параметры: +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, которая должна быть владельцем для открываемой. +// ПараметрыФормы - Структура - параметры открываемой формы. +// +Процедура СоздатьЗадание(Знач ФормаВладелец = Неопределено, Знач ПараметрыФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.СоздатьЗадание(ФормаВладелец, ПараметрыФормы); +``` +
+ +## ПеренаправитьЗадачи +
+ +Описание, пример вызова + +```bsl + +// Открыть форму для перенаправления одной или нескольких задач другому исполнителю. +// +// Параметры: +// ПеренаправляемыеЗадачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, которая должна быть владельцем для открываемой +// формы перенаправления задач. +// +Процедура ПеренаправитьЗадачи(ПеренаправляемыеЗадачи, ФормаВладелец) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ПеренаправитьЗадачи(ПеренаправляемыеЗадачи, ФормаВладелец) +``` +
+ +## ОткрытьДопИнформациюОЗадаче +
+ +Описание, пример вызова + +```bsl + +// Открыть форму с дополнительной информацией о задаче. +// +// Параметры: +// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя +// +Процедура ОткрытьДопИнформациюОЗадаче(Знач ЗадачаСсылка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ОткрытьДопИнформациюОЗадаче(ЗадачаСсылка) +``` +
+ +## ОткрытьСписокРолейИИсполнителейЗадач +
+ +Описание, пример вызова + +```bsl + +// Открывает список ролей и исполнителей задач. +// +Процедура ОткрытьСписокРолейИИсполнителейЗадач() Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ОткрытьСписокРолейИИсполнителейЗадач() +``` +
+ +## ОткрытьФормуВыбораРолиИсполнителя +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора роли исполнителя. +// +// Параметры: +// ПараметрыФормы - см. ПараметрыФормыВыбораРолиИсполнителя +// Владелец - Неопределено +// - ФормаКлиентскогоПриложения - форма из которой открывается форма выбора роли исполнителя. +// +Процедура ОткрытьФормуВыбораРолиИсполнителя(ПараметрыФормы, Владелец) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиент.ОткрытьФормуВыбораРолиИсполнителя(ПараметрыФормы, Владелец) +``` +
+ +## ПараметрыФормыВыбораРолиИсполнителя +
+ +Описание, пример вызова + +```bsl + +// Параметры открытия формы выбора роли исполнителя. +// +// Параметры: +// РольИсполнителя - СправочникСсылка.РолиИсполнителей - роль для ролевой адресации задачи участникам бизнес-процессов. +// ОсновнойОбъектАдресации - Произвольный - основной объект адресации для направления задачи. +// ДополнительныйОбъектАдресации - Произвольный - дополнительный объект адресации для направления задачи +// +// Возвращаемое значение: +// Структура: +// * РольИсполнителя - СправочникСсылка.РолиИсполнителей - роль для ролевой адресации задачи участникам бизнес-процессов. +// * ОсновнойОбъектАдресации - Произвольный - основной объект адресации для направления задачи +// * ДополнительныйОбъектАдресации - Произвольный - дополнительный объект адресации для направления задачи +// * ВыборОбъектаАдресации - Булево - если Истина, то в списке будет выбран основной объект адресации. +// +Функция ПараметрыФормыВыбораРолиИсполнителя(РольИсполнителя, ОсновнойОбъектАдресации = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиКлиент.ПараметрыФормыВыбораРолиИсполнителя(РольИсполнителя, ОсновнойОбъектАдресации, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/БизнесПроцессыИЗадачиКлиентПереопределяемый.md b/src/content/docs/bsp/БизнесПроцессыИЗадачиКлиентПереопределяемый.md new file mode 100644 index 0000000..a3e1e75 --- /dev/null +++ b/src/content/docs/bsp/БизнесПроцессыИЗадачиКлиентПереопределяемый.md @@ -0,0 +1,42 @@ +--- +title: Бизнес процессы и задачи клиент переопределяемый +slug: bsp/бизнес-процессы-и-задачи-клиент-переопределяемый +--- + + +## ПриВыбореИсполнителя +
+ +Описание, пример вызова + +```bsl + +// Вызывается при открытии формы выбор исполнителя. +// Позволяет переопределить стандартную форму выбора. +// +// Параметры: +// ЭлементИсполнитель - ПолеФормы - элемент формы, в которой выбирается исполнитель. +// РеквизитИсполнитель - СправочникСсылка.Пользователи - выбранный ранее исполнитель. +// Используется для установки текущей строки в форме выбора исполнителя. +// ТолькоПростыеРоли - Булево - если Истина, то указывает что для выбора нужно +// использовать только роли без объектов адресации. +// БезВнешнихРолей - Булево - если Истина, то указывает, что для выбора надо использовать только роли, +// у которых не установлен признак ВнешняяРоль. +// СтандартнаяОбработка - Булево - если Ложь, то не требуется выводить стандартную форму выбора исполнителя. +// +Процедура ПриВыбореИсполнителя(ЭлементИсполнитель, РеквизитИсполнитель, ТолькоПростыеРоли, Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиентПереопределяемый.ПриВыбореИсполнителя(ЭлементИсполнитель, РеквизитИсполнитель, ТолькоПростыеРоли, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/БизнесПроцессыИЗадачиКлиентСервер.md b/src/content/docs/bsp/БизнесПроцессыИЗадачиКлиентСервер.md new file mode 100644 index 0000000..e653e2b --- /dev/null +++ b/src/content/docs/bsp/БизнесПроцессыИЗадачиКлиентСервер.md @@ -0,0 +1,67 @@ +--- +title: Бизнес процессы и задачи клиент сервер +slug: bsp/бизнес-процессы-и-задачи-клиент-сервер +--- + + +## ОбработкаПолученияПолейПредставленияБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обработчики подписок на события. + +// Добавление полей, на основании которых будет формироваться представление бизнес-процесса. +// +// Параметры: +// МенеджерОбъекта - БизнесПроцессМенеджер - менеджер бизнес процесса. +// Поля - Массив - поля, из которых формируется представление бизнес-процесса. +// СтандартнаяОбработка - Булево - если установить Ложь, то стандартная обработка заполнения не будет +// выполнена. +// +Процедура ОбработкаПолученияПолейПредставленияБизнесПроцесса(МенеджерОбъекта, Поля, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиентСервер.ОбработкаПолученияПолейПредставленияБизнесПроцесса(МенеджерОбъекта, Поля, СтандартнаяОбработка) +``` +
+ +## ОбработкаПолученияПредставленияБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// АПК:547-выкл Вызывается в подписке на событие ПолучитьПредставлениеБизнесПроцесса + +// Обработка получения представления бизнес-процесса на основании полей данных. +// +// Параметры: +// МенеджерОбъекта - БизнесПроцессМенеджер - менеджер бизнес процесса. +// Данные - Структура - поля, из которых формируется представление бизнес процесса: +// Представление - Строка - представление бизнес процесса. +// СтандартнаяОбработка - Булево - если установить Ложь, то стандартная обработка заполнения не будет +// выполнена. +// +Процедура ОбработкаПолученияПредставленияБизнесПроцесса(МенеджерОбъекта, Данные, Представление, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиКлиентСервер.ОбработкаПолученияПредставленияБизнесПроцесса(МенеджерОбъекта, Данные, Представление, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/БизнесПроцессыИЗадачиПереопределяемый.md b/src/content/docs/bsp/БизнесПроцессыИЗадачиПереопределяемый.md new file mode 100644 index 0000000..b1c9190 --- /dev/null +++ b/src/content/docs/bsp/БизнесПроцессыИЗадачиПереопределяемый.md @@ -0,0 +1,280 @@ +--- +title: Бизнес процессы и задачи переопределяемый +slug: bsp/бизнес-процессы-и-задачи-переопределяемый +--- + + +## ПриЗаписиСпискаБизнесПроцессов +
+ +Описание, пример вызова + +```bsl + +// Вызывается для обновления данных бизнес-процесса в регистре сведений ДанныеБизнесПроцессов. +// +// Параметры: +// Запись - РегистрСведенийЗапись.ДанныеБизнесПроцессов - запись данных бизнес-процесса. +// +Процедура ПриЗаписиСпискаБизнесПроцессов(Запись) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиПереопределяемый.ПриЗаписиСпискаБизнесПроцессов(Запись) +``` +
+ +## ПриПроверкеПравНаОстановкуБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Вызывается для проверки прав на остановку и продолжение бизнес-процесса +// у текущего пользователя. +// +// Параметры: +// БизнесПроцесс - ОпределяемыйТип.БизнесПроцессОбъект +// ЕстьПрава - Булево - если установить Ложь, то прав нет. +// СтандартнаяОбработка - Булево - если установить Ложь, то стандартная проверка прав не будет выполнена. +// +Процедура ПриПроверкеПравНаОстановкуБизнесПроцесса(БизнесПроцесс, ЕстьПрава, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиПереопределяемый.ПриПроверкеПравНаОстановкуБизнесПроцесса(БизнесПроцесс, ЕстьПрава, СтандартнаяОбработка) +``` +
+ +## ПриЗаполненииГлавнойЗадачиБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Вызывается для заполнения реквизита ГлавнаяЗадача из данных заполнения. +// +// Параметры: +// БизнесПроцессОбъект - ОпределяемыйТип.БизнесПроцессОбъект +// ДанныеЗаполнения - Произвольный - данные заполнения, которые передаются в обработчик заполнения. +// СтандартнаяОбработка - Булево - если установить Ложь, то стандартная обработка заполнения не будет +// выполнена. +// +Процедура ПриЗаполненииГлавнойЗадачиБизнесПроцесса(БизнесПроцессОбъект, ДанныеЗаполнения, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиПереопределяемый.ПриЗаполненииГлавнойЗадачиБизнесПроцесса(БизнесПроцессОбъект, ДанныеЗаполнения, СтандартнаяОбработка) +``` +
+ +## ПриПолученииФормыВыполненияЗадачи +
+ +Описание, пример вызова + +```bsl + +// Вызывается для заполнения параметров формы задачи. +// +// Параметры: +// ИмяБизнесПроцесса - Строка - название бизнес-процесса. +// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя +// ТочкаМаршрутаБизнесПроцесса - ТочкаМаршрутаБизнесПроцессаСсылка.Задание - действие. +// ПараметрыФормы - Структура: +// * ИмяФормы - имя формы, передаваемое в метод ОткрытьФорму. +// * ПараметрыФормы - содержит параметры открываемой формы. +// +// Пример: +// Если ИмяБизнесПроцесса = "Задание" Тогда +// ИмяФормы = "БизнесПроцесс.Задание.Форма.ВнешнееДействие" + ТочкаМаршрутаБизнесПроцесса.Имя; +// ПараметрыФормы.Вставить("ИмяФормы", ИмяФормы); +// КонецЕсли; +// +Процедура ПриПолученииФормыВыполненияЗадачи(ИмяБизнесПроцесса, ЗадачаСсылка, Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиПереопределяемый.ПриПолученииФормыВыполненияЗадачи(ИмяБизнесПроцесса, ЗадачаСсылка, ); +``` +
+ +## ПриОпределенииБизнесПроцессов +
+ +Описание, пример вызова + +```bsl + +// Заполняет список бизнес-процессов, которые подключены к подсистеме +// и модули менеджеров которых содержат следующие экспортные процедуры и функции: +// - ПриПеренаправленииЗадачи. +// - ФормаВыполненияЗадачи. +// - ОбработкаВыполненияПоУмолчанию. +// +// Параметры: +// ПодключенныеБизнесПроцессы - Соответствие из КлючИЗначение: +// * Ключ - Строка - полное имя объекта метаданных, подключенного к подсистеме; +// * Значение - Строка - пустая строка. +// +// Пример: +// ПодключенныеБизнесПроцессы.Вставить(Метаданные.БизнесПроцессы.ЗаданиеСРолевойАдресацией.ПолноеИмя(), ""); +// +Процедура ПриОпределенииБизнесПроцессов(ПодключенныеБизнесПроцессы) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиПереопределяемый.ПриОпределенииБизнесПроцессов(ПодключенныеБизнесПроцессы) +``` +
+ +## ПриЗаполненииНаборовЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Вызывается из модулей объектов подсистемы БизнесПроцессыИЗадачи для +// возможности настройки логики ограничения в прикладном решении. +// +// Пример заполнения наборов значений доступа см. в комментарии +// к процедуре УправлениеДоступом.ЗаполнитьНаборыЗначенийДоступа. +// +// Параметры: +// Объект - БизнесПроцессОбъект.Задание - объект, для которого нужно заполнить наборы. +// Таблица - см. УправлениеДоступом.ТаблицаНаборыЗначенийДоступа +// +Процедура ПриЗаполненииНаборовЗначенийДоступа(Объект, Таблица) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиПереопределяемый.ПриЗаполненииНаборовЗначенийДоступа(Объект, Таблица) +``` +
+ +## ПриНачальномЗаполненииРолейИсполнителей +
+ +Описание, пример вызова + +```bsl + +// Вызывается из модуля менеджера справочника РолиИсполнителей при начальном заполнении +// ролей исполнителей в прикладном решении. +// +// Параметры: +// КодыЯзыков - Массив из Строка - список языков конфигурации. Актуально для мультиязычных конфигураций. +// Элементы - ТаблицаЗначений - данные заполнения. Состав колонок соответствует набору реквизитов +// справочника РолиИсполнителей. +// ТабличныеЧасти - Структура - описание табличных частей объекта, где: +// * Ключ - Строка - имя табличной части; +// * Значение - ТаблицаЗначений - табличная часть в виде таблицы значений, структуру которой +// необходимо скопировать перед заполнением. Например: +// Элемент.Ключи = ТабличныеЧасти.Ключи.Скопировать(); +// ЭлементТЧ = Элемент.Ключи.Добавить(); +// ЭлементТЧ.ИмяКлюча = "Первичный"; +// +Процедура ПриНачальномЗаполненииРолейИсполнителей(КодыЯзыков, Элементы, ТабличныеЧасти) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиПереопределяемый.ПриНачальномЗаполненииРолейИсполнителей(КодыЯзыков, Элементы, ТабличныеЧасти) +``` +
+ +## ПриНачальномЗаполненииРолиИсполнителя +
+ +Описание, пример вызова + +```bsl + +// Вызывается из модуля менеджера справочника РолиИсполнителей при начальном заполнении +// элемента роль исполнителя в прикладном решении. +// +// Параметры: +// Объект - СправочникОбъект.РолиИсполнителей - заполняемый объект. +// Данные - СтрокаТаблицыЗначений - данные заполнения. +// ДополнительныеПараметры - Структура +// +Процедура ПриНачальномЗаполненииРолиИсполнителя(Объект, Данные, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиПереопределяемый.ПриНачальномЗаполненииРолиИсполнителя(Объект, Данные, ДополнительныеПараметры) +``` +
+ +## ПриНачальномЗаполненииОбъектовАдресацииЗадач +
+ +Описание, пример вызова + +```bsl + +// Вызывается из модуля менеджера ПВХ ОбъектыАдресацииЗадач при начальном заполнении +// объектов адресации задача в прикладном решении. +// Стандартный реквизит ТипЗначения следует заполнять в процедуре ПриНачальномЗаполненииЭлементаОбъектаАдресацииЗадачи. +// +// Параметры: +// КодыЯзыков - Массив из Строка - список языков конфигурации. Актуально для мультиязычных конфигураций. +// Элементы - ТаблицаЗначений - данные заполнения. Состав колонок соответствует набору реквизитов объекта ПВХ ОбъектыАдресацииЗада. +// ТабличныеЧасти - Структура - описание табличных частей объекта, где: +// * Ключ - Строка - имя табличной части; +// * Значение - ТаблицаЗначений - табличная часть в виде таблицы значений, структуру которой +// необходимо скопировать перед заполнением. Например: +// Элемент.Ключи = ТабличныеЧасти.Ключи.Скопировать(); +// ЭлементТЧ = Элемент.Ключи.Добавить(); +// ЭлементТЧ.ИмяКлюча = "Первичный"; +// +Процедура ПриНачальномЗаполненииОбъектовАдресацииЗадач(КодыЯзыков, Элементы, ТабличныеЧасти) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиПереопределяемый.ПриНачальномЗаполненииОбъектовАдресацииЗадач(КодыЯзыков, Элементы, ТабличныеЧасти) +``` +
+ +## ПриНачальномЗаполненииЭлементаОбъектаАдресацииЗадачи +
+ +Описание, пример вызова + +```bsl + +// Вызывается из модуля менеджера ПВХ ОбъектыАдресацииЗадач при начальном заполнении +// элемента адресации задача в прикладном решении. +// +// Параметры: +// Объект - ПланВидовХарактеристикОбъект.ОбъектыАдресацииЗадач - заполняемый объект. +// Данные - СтрокаТаблицыЗначений - данные заполнения. +// ДополнительныеПараметры - Структура +// +Процедура ПриНачальномЗаполненииЭлементаОбъектаАдресацииЗадачи(Объект, Данные, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиПереопределяемый.ПриНачальномЗаполненииЭлементаОбъектаАдресацииЗадачи(Объект, Данные, ДополнительныеПараметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/БизнесПроцессыИЗадачиСервер.md b/src/content/docs/bsp/БизнесПроцессыИЗадачиСервер.md new file mode 100644 index 0000000..1c9a2a6 --- /dev/null +++ b/src/content/docs/bsp/БизнесПроцессыИЗадачиСервер.md @@ -0,0 +1,874 @@ +--- +title: Бизнес процессы и задачи сервер +slug: bsp/бизнес-процессы-и-задачи-сервер +--- + + +## ФормаЗадачиПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Инициализирует общие параметры формы выполнения задачи. +// +// Параметры: +// ФормаЗадачи - ФормаКлиентскогоПриложения - форма выполнения задачи. +// ЗадачаОбъект - ЗадачаОбъект - объект задачи. +// ЭлементГруппаСостояние - ГруппаФормы - группа с информации о состоянии задачи. +// ЭлементДатаИсполнения - ПолеФормы - поле с датой исполнения задачи. +// +Процедура ФормаЗадачиПриСозданииНаСервере(ФормаЗадачи, ЗадачаОбъект, Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ФормаЗадачиПриСозданииНаСервере(ФормаЗадачи, ЗадачаОбъект, ); +``` +
+ +## УстановитьОформлениеЗадач +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании формы списка задач на сервере. +// +// Параметры: +// СписокЗадачИлиЕгоУсловноеОформление - ДинамическийСписок +// - УсловноеОформлениеКомпоновкиДанных - условное оформление списка задач. +// +Процедура УстановитьОформлениеЗадач(Знач СписокЗадачИлиЕгоУсловноеОформление) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.УстановитьОформлениеЗадач(СписокЗадачИлиЕгоУсловноеОформление) +``` +
+ +## УстановитьОформлениеБизнесПроцессов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании формы списка бизнес-процессов на сервере. +// +// Параметры: +// УсловноеОформлениеБизнесПроцессов - УсловноеОформлениеКомпоновкиДанных - условное оформление списка бизнес-процессов. +// +Процедура УстановитьОформлениеБизнесПроцессов(Знач УсловноеОформлениеБизнесПроцессов) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.УстановитьОформлениеБизнесПроцессов(УсловноеОформлениеБизнесПроцессов) +``` +
+ +## ИсполнительСтрокой +
+ +Описание, пример вызова + +```bsl + +// Возвращает строковое представление исполнителя задачи Исполнитель, +// либо указанного в параметрах РольИсполнителя, ОсновнойОбъектАдресации и ДополнительныйОбъектАдресации. +// +// Параметры: +// Исполнитель - СправочникСсылка.Пользователи - исполнитель задачи. +// РольИсполнителя - СправочникСсылка.РолиИсполнителей - роль. +// ОсновнойОбъектАдресации - ЛюбаяСсылка - ссылка на основной объект адресации. +// ДополнительныйОбъектАдресации - ЛюбаяСсылка - ссылка на дополнительный объект адресации. +// +// Возвращаемое значение: +// Строка - строковое представление исполнителя задачи, например: +// "Иванов Иван Иванович" - исполнитель, как указано в параметре Исполнитель; +// "Главный бухгалтер" - роль исполнителя, указанная в параметре РольИсполнителя; +// "Главный бухгалтер (ООО Солнышко)" - если роль указана вместе с основным объектом адресации; +// "Главный бухгалтер (ОАО Солнышко, Филиал в г.Москва)" - если роль указана вместе с обоими объектами +// адресации. +// +Функция ИсполнительСтрокой(Знач Исполнитель, Знач РольИсполнителя, Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.ИсполнительСтрокой(Исполнитель, РольИсполнителя, ); +``` +
+ +## РольСтрокой +
+ +Описание, пример вызова + +```bsl + +// Возвращает строковое представление роли РольИсполнителя и ее объектов адресации, если они заданы. +// +// Параметры: +// РольИсполнителя - СправочникСсылка.РолиИсполнителей - роль. +// ОсновнойОбъектАдресации - ЛюбаяСсылка - ссылка на основной объект адресации. +// ДополнительныйОбъектАдресации - ЛюбаяСсылка - ссылка на дополнительный объект адресации. +// +// Возвращаемое значение: +// Строка - строковое представление роли, например: +// "Главный бухгалтер" - роль исполнителя, указанная в параметре РольИсполнителя; +// "Главный бухгалтер (ООО Солнышко)" - если роль указана вместе с основным объектом адресации; +// "Главный бухгалтер (ОАО Солнышко, Филиал в г.Москва)" - если роль указана вместе с обоими объектами +// адресации. +// +Функция РольСтрокой(Знач РольИсполнителя, Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.РольСтрокой(РольИсполнителя, ); +``` +
+ +## УстановитьПометкуУдаленияЗадач +
+ +Описание, пример вызова + +```bsl + +// Помечает на удаление все задачи указанного бизнес-процесса (или снимает отметку). +// +// Параметры: +// БизнесПроцессСсылка - ОпределяемыйТип.БизнесПроцесс - бизнес-процесс, задачи которого нужно пометить на удаление. +// ПометкаУдаления - Булево - значение свойства ПометкаУдаления для задач. +// +Процедура УстановитьПометкуУдаленияЗадач(БизнесПроцессСсылка, ПометкаУдаления) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.УстановитьПометкуУдаленияЗадач(БизнесПроцессСсылка, ПометкаУдаления) +``` +
+ +## УстановитьФорматДаты +
+ +Описание, пример вызова + +```bsl + +// Установить формат отображения и редактирования поля формы типа Дата +// в зависимости от настроек подсистемы. +// +// Параметры: +// ПолеДаты - ПолеФормы - элемент управления формы, поле со значением типа Дата. +// +Процедура УстановитьФорматДаты(ПолеДаты) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.УстановитьФорматДаты(ПолеДаты) +``` +
+ +## БизнесПроцессыВедущейЗадачи +
+ +Описание, пример вызова + +```bsl + +// Получить бизнес-процессы ведущей задачи ЗадачаСсылка. +// +// Параметры: +// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя - ведущая задача. +// ДляИзменения - Булево - если Истина, то следует установить исключительную управляемую блокировку +// на все бизнес-процессы указанной ведущей задачи. По умолчанию, Ложь. +// Возвращаемое значение: +// Массив из ОпределяемыйТип.БизнесПроцесс +// +Функция БизнесПроцессыВедущейЗадачи(ЗадачаСсылка, ДляИзменения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.БизнесПроцессыВедущейЗадачи(ЗадачаСсылка, ДляИзменения); +``` +
+ +## ДатаЗавершенияБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Возвращает дату завершения указанного бизнес-процесса, +// полученную как максимальная дата исполнения задач бизнес-процесса. +// +// Параметры: +// БизнесПроцессСсылка - ОпределяемыйТип.БизнесПроцесс +// +// Возвращаемое значение: +// Дата +// +Функция ДатаЗавершенияБизнесПроцесса(БизнесПроцессСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.ДатаЗавершенияБизнесПроцесса(БизнесПроцессСсылка) +``` +
+ +## БизнесПроцессыГлавнойЗадачи +
+ +Описание, пример вызова + +```bsl + +// Возвращает бизнес-процессы, подчиненные указанной задаче. +// +// Параметры: +// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя +// ДляИзменения - Булево - если Истина, то следует установить исключительную управляемую блокировку +// на все бизнес-процессы, подчиненные указанной задаче. По умолчанию, Ложь. +// +// Возвращаемое значение: +// Массив из ОпределяемыйТип.БизнесПроцесс +// +Функция БизнесПроцессыГлавнойЗадачи(ЗадачаСсылка, ДляИзменения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.БизнесПроцессыГлавнойЗадачи(ЗадачаСсылка, ДляИзменения); +``` +
+ +## ПроверитьПраваНаИзменениеСостоянияБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Проверяет у текущего пользователя наличие прав на изменение состояния бизнес-процесса. +// +// Параметры: +// БизнесПроцессОбъект - ОпределяемыйТип.БизнесПроцессОбъект +// +Процедура ПроверитьПраваНаИзменениеСостоянияБизнесПроцесса(БизнесПроцессОбъект) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ПроверитьПраваНаИзменениеСостоянияБизнесПроцесса(БизнесПроцессОбъект) +``` +
+ +## ЗаблокироватьБизнесПроцессы +
+ +Описание, пример вызова + +```bsl + +// Установить исключительную управляемую блокировку на указанные бизнес-процессы. +// Для вызова из обработчиков команд в динамических списках. +// Строки группировки динамического списка игнорируются. +// +// Параметры: +// БизнесПроцессы - ОпределяемыйТип.БизнесПроцесс +// - Массив из ОпределяемыйТип.БизнесПроцесс +// +Процедура ЗаблокироватьБизнесПроцессы(БизнесПроцессы) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ЗаблокироватьБизнесПроцессы(БизнесПроцессы) +``` +
+ +## ЗаблокироватьЗадачи +
+ +Описание, пример вызова + +```bsl + +// Установить исключительную управляемую блокировку на указанные задачи. +// Для вызова из обработчиков команд в динамических списках. +// Строки группировки динамического списка игнорируются. +// +// Параметры: +// Задачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя +// - ЗадачаСсылка.ЗадачаИсполнителя +// +Процедура ЗаблокироватьЗадачи(Задачи) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ЗаблокироватьЗадачи(Задачи) +``` +
+ +## ЗаполнитьГлавнуюЗадачу +
+ +Описание, пример вызова + +```bsl + +// Заполняет реквизит ГлавнаяЗадача при создании бизнес-процесса на основании другого бизнес-процесса. +// См. также БизнесПроцессыИЗадачиПереопределяемый.ПриЗаполненииГлавнойЗадачиБизнесПроцесса. +// +// Параметры: +// БизнесПроцессОбъект - ОпределяемыйТип.БизнесПроцессОбъект +// ДанныеЗаполнения - ЗадачаСсылка +// - Произвольный - данные заполнения, которые передаются в обработчик заполнения. +// +Процедура ЗаполнитьГлавнуюЗадачу(БизнесПроцессОбъект, ДанныеЗаполнения) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ЗаполнитьГлавнуюЗадачу(БизнесПроцессОбъект, ДанныеЗаполнения) +``` +
+ +## ГруппаИсполнителейЗадач +
+ +Описание, пример вызова + +```bsl + +// Получить группу исполнителей задач, которая соответствует реквизитам адресации. +// Если группа еще не существует, то создается и возвращается новая. +// +// Параметры: +// РольИсполнителя - СправочникСсылка.РолиИсполнителей - роль исполнителя. +// ОсновнойОбъектАдресации - Характеристика.ОбъектыАдресацииЗадач - ссылка на основной объект адресации. +// ДополнительныйОбъектАдресации - Характеристика.ОбъектыАдресацииЗадач - ссылка на дополнительный объект адресации. +// +// Возвращаемое значение: +// СправочникСсылка.ГруппыИсполнителейЗадач +// +Функция ГруппаИсполнителейЗадач(РольИсполнителя, ОсновнойОбъектАдресации, ДополнительныйОбъектАдресации) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.ГруппаИсполнителейЗадач(РольИсполнителя, ОсновнойОбъектАдресации, ДополнительныйОбъектАдресации) +``` +
+ +## ФормаВыполненияЗадачи +
+ +Описание, пример вызова + +```bsl + +// Получить структуру с описанием формы выполнения задачи. +// +// Параметры: +// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя +// +// Возвращаемое значение: +// см. БизнесПроцессыИЗадачиПереопределяемый.ПриПолученииФормыВыполненияЗадачи.ПараметрыФормы +// +Функция ФормаВыполненияЗадачи(Знач ЗадачаСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.ФормаВыполненияЗадачи(ЗадачаСсылка) +``` +
+ +## ЭтоЗадачаИсполнителю +
+ +Описание, пример вызова + +```bsl + +// Проверяет, находится ли в ячейке отчета ссылка на задачу и в параметре +// ЗначениеРасшифровки возвращает значение расшифровки. +// +// Параметры: +// Расшифровка - Строка - имя ячейки. +// ДанныеРасшифровкиОтчета - Строка - адрес во временном хранилище. +// ЗначениеРасшифровки - ЗадачаСсылка.ЗадачаИсполнителя +// - Произвольный - значение расшифровки из ячейки. +// +// Возвращаемое значение: +// Булево - Истина, если это задача исполнителю. +// +Функция ЭтоЗадачаИсполнителю(Знач Расшифровка, Знач ДанныеРасшифровкиОтчета, ЗначениеРасшифровки) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.ЭтоЗадачаИсполнителю(Расшифровка, ДанныеРасшифровкиОтчета, ЗначениеРасшифровки) +``` +
+ +## ВыполнитьЗадачу +
+ +Описание, пример вызова + +```bsl + +// Выполнить задачу ЗадачаСсылка, при необходимости выполнив обработчик. +// ОбработкаВыполненияПоУмолчанию модуля менеджера бизнес-процесса, +// к которому относится задача ЗадачаСсылка. +// +// Параметры: +// ЗадачаСсылка - ЗадачаСсылка +// ДействиеПоУмолчанию - Булево - признак необходимости вызова процедуры +// ОбработкаВыполненияПоУмолчанию у бизнес-процесса задачи. +// +Процедура ВыполнитьЗадачу(ЗадачаСсылка, ДействиеПоУмолчанию = Ложь) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ВыполнитьЗадачу(ЗадачаСсылка, ДействиеПоУмолчанию); +``` +
+ +## ПеренаправитьЗадачи +
+ +Описание, пример вызова + +```bsl + +// Перенаправить задачи МассивЗадач новому исполнителю, указанному в структуре ИнфоОПеренаправлении. +// +// Параметры: +// ПеренаправляемыеЗадачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя +// ИнфоОПеренаправлении - Структура - новые значения реквизитов адресации задачи. +// ТолькоПроверка - Булево - если Истина, то функция не будет выполнять +// физического перенаправления задач, а только +// проверит возможность перенаправления. +// ПеренаправленныеЗадачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя - перенаправленные задачи. +// Может отличаться по составу элементов от массива +// ПеренаправляемыеЗадачи, если не все задачи удалось перенаправить. +// +// Возвращаемое значение: +// Булево - Истина, если перенаправление выполнено успешно. +// +Функция ПеренаправитьЗадачи(Знач ПеренаправляемыеЗадачи, Знач ИнфоОПеренаправлении, Знач ТолькоПроверка = Ложь, Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.ПеренаправитьЗадачи(ПеренаправляемыеЗадачи, ИнфоОПеренаправлении, ТолькоПроверка, ); +``` +
+ +## ЭтоВедущаяЗадача +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли указанная задача ведущей. +// +// Параметры: +// ЗадачаСсылка - ЗадачаСсылка.ЗадачаИсполнителя +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоВедущаяЗадача(ЗадачаСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.ЭтоВедущаяЗадача(ЗадачаСсылка) +``` +
+ +## СформироватьДанныеВыбораИсполнителя +
+ +Описание, пример вызова + +```bsl + +// Формирует список подбора для указания исполнителя в полях ввода составного типа (Пользователь и Роль). +// +// Параметры: +// Текст - Строка - фрагмент текста для поиска возможных исполнителей. +// +// Возвращаемое значение: +// СписокЗначений - список подбора, содержащий возможных исполнителей. +// +Функция СформироватьДанныеВыбораИсполнителя(Текст) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.СформироватьДанныеВыбораИсполнителя(Текст) +``` +
+ +## СделатьАктивнымБизнесПроцессы +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанные бизнес-процессы как активные. +// +// Параметры: +// БизнесПроцессы - Массив из ОпределяемыйТип.БизнесПроцесс +// +Процедура СделатьАктивнымБизнесПроцессы(БизнесПроцессы) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.СделатьАктивнымБизнесПроцессы(БизнесПроцессы) +``` +
+ +## СделатьАктивнымБизнесПроцесс +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанный бизнес-процесс как активный. +// +// Параметры: +// БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс +// +Процедура СделатьАктивнымБизнесПроцесс(БизнесПроцесс) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.СделатьАктивнымБизнесПроцесс(БизнесПроцесс) +``` +
+ +## ОстановитьБизнесПроцессы +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанные бизнес-процессы как остановленные. +// +// Параметры: +// БизнесПроцессы - Массив из ОпределяемыйТип.БизнесПроцесс +// +Процедура ОстановитьБизнесПроцессы(БизнесПроцессы) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ОстановитьБизнесПроцессы(БизнесПроцессы) +``` +
+ +## ОстановитьБизнесПроцесс +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанный бизнес-процесс как остановленный. +// +// Параметры: +// БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс +// +Процедура ОстановитьБизнесПроцесс(БизнесПроцесс) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ОстановитьБизнесПроцесс(БизнесПроцесс) +``` +
+ +## ПринятьЗадачиКИсполнению +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанные задачи как принятые к исполнению. +// +// Параметры: +// Задачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя +// +Процедура ПринятьЗадачиКИсполнению(Задачи) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ПринятьЗадачиКИсполнению(Задачи) +``` +
+ +## ОтменитьПринятиеЗадачКИсполнению +
+ +Описание, пример вызова + +```bsl + +// Отмечает указанные задачи как не принятые к исполнению. +// +// Параметры: +// Задачи - Массив из ЗадачаСсылка.ЗадачаИсполнителя +// +Процедура ОтменитьПринятиеЗадачКИсполнению(Задачи) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ОтменитьПринятиеЗадачКИсполнению(Задачи) +``` +
+ +## ДобавитьПроцессДляОтложенногоСтарта +
+ +Описание, пример вызова + +```bsl + +// Добавляет процесс в очередь для отложенного старта. +// +// Параметры: +// Процесс - ОпределяемыйТип.БизнесПроцесс +// ДатаСтарта - Дата - дата отложенного старта. +// +Процедура ДобавитьПроцессДляОтложенногоСтарта(Процесс, ДатаСтарта) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ДобавитьПроцессДляОтложенногоСтарта(Процесс, ДатаСтарта) +``` +
+ +## ОтключитьОтложенныйСтартПроцесса +
+ +Описание, пример вызова + +```bsl + +// Отключает отложенный старт процесса. +// +// Параметры: +// Процесс - ОпределяемыйТип.БизнесПроцесс +// +Процедура ОтключитьОтложенныйСтартПроцесса(Процесс) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ОтключитьОтложенныйСтартПроцесса(Процесс) +``` +
+ +## СтартоватьОтложенныйПроцесс +
+ +Описание, пример вызова + +```bsl + +// Стартует отложенный бизнес-процесс, устанавливая признак старта. +// +// Параметры: +// БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс +// +Процедура СтартоватьОтложенныйПроцесс(БизнесПроцесс) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.СтартоватьОтложенныйПроцесс(БизнесПроцесс) +``` +
+ +## ПараметрыОтложенногоПроцесса +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения о запуске для процесса. +// +// Параметры: +// Процесс - ОпределяемыйТип.БизнесПроцесс +// +// Возвращаемое значение: +// - Неопределено - если сведений нет. +// - Структура: +// * БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс. +// * ДатаОтложенногоСтарта - Дата +// * Состояние - ПеречислениеСсылка.СостоянияПроцессовДляЗапуска. +// * ПричинаОтменыСтарта - Строка - причина отмены старта. +// +Функция ПараметрыОтложенногоПроцесса(Процесс) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.ПараметрыОтложенногоПроцесса(Процесс) +``` +
+ +## ДатаОтложенногоСтартаПроцесса +
+ +Описание, пример вызова + +```bsl + +// Возвращает дату старта отложенного бизнес-процесса в том случае, когда БизнесПроцесс +// ожидает отложенного старта. В противном случае возвращает пустую дату. +// +// Параметры: +// БизнесПроцесс - ОпределяемыйТип.БизнесПроцесс +// +// Возвращаемое значение: +// Дата +// +Функция ДатаОтложенногоСтартаПроцесса(БизнесПроцесс) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыИЗадачиСервер.ДатаОтложенногоСтартаПроцесса(БизнесПроцесс) +``` +
+ +## УведомитьИсполнителейОНовыхЗадачах +
+ +Описание, пример вызова + +```bsl + +// Выполняет рассылку уведомлений исполнителям о новых задачах за период с момента предыдущей рассылки. +// Рассылка выполняется по почте от системной учетной записи. +// Также является обработчиком регламентного задания УведомлениеИсполнителейОНовыхЗадачах. +// +Процедура УведомитьИсполнителейОНовыхЗадачах() Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.УведомитьИсполнителейОНовыхЗадачах() +``` +
+ +## ПроконтролироватьЗадачи +
+ +Описание, пример вызова + +```bsl + +// Выполняет рассылку уведомлений исполнителям и авторам задач о задачах, не выполненных в срок. +// Рассылка выполняется по почте от системной учетной записи. +// Если задача направлена "в никуда", т.е. роли с пустым списком исполнителей, +// то создается новая задача ответственным за настройку ролей. +// +// Также является обработчиком регламентного задания МониторингЗадач. +// +Процедура ПроконтролироватьЗадачи() Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ПроконтролироватьЗадачи() +``` +
+ +## НачатьОбновлениеПорцииНаборовЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Подготовить первую порцию объектов для отложенной обработки прав доступа. +// Для вызова из отложенных обработчиков обновления при изменении логики формирования наборов значений доступа. +// +// Параметры: +// Параметры - Структура - структура параметров отложенного обработчика обновления. +// БизнесПроцесс - ОбъектМетаданныхБизнесПроцесс - метаданные бизнес-процесса, наборы значений доступа +// которого требуется обновить. +// ИмяПроцедуры - Строка - имя процедуры отложенного обработчика обновления для журнала регистрации. +// РазмерПорции - Число - количество объектов, обрабатываемых за один вызов. +// +Процедура НачатьОбновлениеПорцииНаборовЗначенийДоступа(Параметры, БизнесПроцесс, ИмяПроцедуры, РазмерПорции = 1000) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.НачатьОбновлениеПорцииНаборовЗначенийДоступа(Параметры, БизнесПроцесс, ИмяПроцедуры, РазмерПорции); +``` +
+ +## ЗавершитьОбновлениеПорцииНаборовЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Завершить обработку первой порции объектов для отложенной обработки прав доступа. +// Для вызова из отложенных обработчиков обновления при изменении логики формирования наборов значений доступа. +// +// Параметры: +// Параметры - Структура - параметры отложенного обработчика обновления. +// +Процедура ЗавершитьОбновлениеПорцииНаборовЗначенийДоступа(Параметры) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыИЗадачиСервер.ЗавершитьОбновлениеПорцииНаборовЗначенийДоступа(Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/БлокировкаРаботыСВнешнимиРесурсамиПереопределяемый.md b/src/content/docs/bsp/БлокировкаРаботыСВнешнимиРесурсамиПереопределяемый.md new file mode 100644 index 0000000..68e85c4 --- /dev/null +++ b/src/content/docs/bsp/БлокировкаРаботыСВнешнимиРесурсамиПереопределяемый.md @@ -0,0 +1,54 @@ +--- +title: Блокировка работы с внешними ресурсами переопределяемый +slug: bsp/блокировка-работы-с-внешними-ресурсами-переопределяемый +--- + + +## ПриРазрешенииРаботыСВнешнимиРесурсами +
+ +Описание, пример вызова + +```bsl + +// Вызывается при снятии блокировки работы с внешними ресурсами. +// Для включения работы механизмов, отключенных в процедуре ПриЗапретеРаботыСВнешнимиРесурсами. +// +Процедура ПриРазрешенииРаботыСВнешнимиРесурсами() Экспорт +``` + +Пример вызова +```bsl +БлокировкаРаботыСВнешнимиРесурсамиПереопределяемый.ПриРазрешенииРаботыСВнешнимиРесурсами() +``` +
+ +## ПриЗапретеРаботыСВнешнимиРесурсами +
+ +Описание, пример вызова + +```bsl + +// Вызывается при установке блокировки работы с внешними ресурсами, +// при старте регламентного задания в копии информационной базы или интерактивно. +// +// Позволяет отключить произвольные механизмы, работа +// которых в копии информационной базы недопустима. +// +Процедура ПриЗапретеРаботыСВнешнимиРесурсами() Экспорт +``` + +Пример вызова +```bsl +БлокировкаРаботыСВнешнимиРесурсамиПереопределяемый.ПриЗапретеРаботыСВнешнимиРесурсами() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВариантыОтчетов.md b/src/content/docs/bsp/ВариантыОтчетов.md new file mode 100644 index 0000000..4aee8a9 --- /dev/null +++ b/src/content/docs/bsp/ВариантыОтчетов.md @@ -0,0 +1,1088 @@ +--- +title: Варианты отчетов +slug: bsp/варианты-отчетов +--- + + +## ВариантОтчета +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на вариант отчета. +// +// Параметры: +// Отчет - СправочникСсылка.ИдентификаторыОбъектовРасширений +// - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ДополнительныеОтчетыИОбработки +// - Строка - ссылка на отчет или полное имя внешнего отчета. +// КлючВарианта - Строка - имя варианта отчета. +// +// Возвращаемое значение: +// СправочникСсылка.ВариантыОтчетов, Неопределено - вариант отчета, +// либо Неопределено, если отчет отсутствует или недоступен по правам. +// +Функция ВариантОтчета(Отчет, КлючВарианта) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.ВариантОтчета(Отчет, КлючВарианта) +``` +
+ +## ОтчетыТекущегоПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает отчеты (СправочникСсылка.ВариантыОтчетов), доступные текущему пользователю. +// Их следует использовать во всех запросах к таблице +// справочника "ВариантыОтчетов" как отбор по реквизиту "Отчет", +// кроме случаев выборки вариантов из внешних отчетов. +// +// Возвращаемое значение: +// Массив - отчеты, доступные текущему пользователю (СправочникСсылка.ИдентификаторыОбъектовРасширений, +// Строка, СправочникСсылка.ДополнительныеОтчетыИОбработки, +// СправочникСсылка.ИдентификаторыОбъектовМетаданных). +// Тип элементов совпадает с типом реквизита Справочники.ВариантыОтчетов.Реквизиты.Отчет. +// +Функция ОтчетыТекущегоПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.ОтчетыТекущегоПользователя() +``` +
+ +## КлючиВариантовОтчета +
+ +Описание, пример вызова + +```bsl + +// Возвращает список вариантов отчета из хранилища настроек ХранилищеВариантовОтчетов. +// См. также СтандартноеХранилищеНастроекМенеджер.ПолучитьСписок в синтакс-помощнике. +// В отличие от метода платформы, вместо права "АдминистрированиеДанных" проверяются права доступа к отчету. +// +// Параметры: +// КлючОтчета - Строка - полное имя отчета с точкой. +// Пользователь - Строка +// - УникальныйИдентификатор +// - ПользовательИнформационнойБазы +// - Неопределено +// - СправочникСсылка.Пользователи - имя, идентификатор или ссылка на пользователя, +// настройки которого требуется получить. +// Если Неопределено, то текущий пользователь. +// +// Возвращаемое значение: +// СписокЗначений - список вариантов отчета, где: +// * Значение - Строка - ключ варианта отчета. +// * Представление - Строка - представление варианта отчета. +// +// +Функция КлючиВариантовОтчета(КлючОтчета, Знач Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.КлючиВариантовОтчета(КлючОтчета, Пользователь); +``` +
+ +## УдалитьВариантОтчета +
+ +Описание, пример вызова + +```bsl + +// Удаляет варианты указанного отчета или всех отчетов. +// См. также СтандартноеХранилищеНастроекМенеджер.Удалить в синтакс-помощнике. +// +// Параметры: +// КлючОтчета - Строка +// - Неопределено - полное имя отчета с точкой. +// Если Неопределено, то удаляются настройки всех отчетов. +// КлючВарианта - Строка +// - Неопределено - ключ удаляемого варианта отчета. +// Если Неопределено, то удаляются все варианты отчета. +// Пользователь - Строка +// - УникальныйИдентификатор +// - ПользовательИнформационнойБазы +// - Неопределено +// - СправочникСсылка.Пользователи - имя, идентификатор или ссылка на пользователя, +// настройки которого удаляются. +// Если Неопределено, то удаляются настройки всех пользователей. +// +Процедура УдалитьВариантОтчета(КлючОтчета, КлючВарианта, Знач Пользователь) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.УдалитьВариантОтчета(КлючОтчета, КлючВарианта, Пользователь) +``` +
+ +## НастроитьОтчетВМодулеМенеджера +
+ +Описание, пример вызова + +```bsl + +// Вызывает модуль менеджера отчета для заполнения его настроек. +// Для вызова из процедуры ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов. +// +// Параметры: +// Настройки - см. ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов.Настройки. +// ОтчетМетаданные - ОбъектМетаданных - метаданные отчета, в модуле менеджера которого расположена +// экспортная процедура НастроитьВариантыОтчета(Настройки, НастройкиОтчета). +// +Процедура НастроитьОтчетВМодулеМенеджера(Настройки, ОтчетМетаданные) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.НастроитьОтчетВМодулеМенеджера(Настройки, ОтчетМетаданные) +``` +
+ +## ОписаниеОтчета +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки указанного отчета. Используется для настройки размещения и общих параметров отчета +// в ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов. +// +// Параметры: +// Настройки - см. ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов.Настройки. +// Отчет - ОбъектМетаданныхОтчет +// - СправочникСсылка.ИдентификаторыОбъектовМетаданных - метаданные или ссылка отчета. +// +// Возвращаемое значение: +// СтрокаДереваЗначений - настройки отчета и настройки "по умолчанию" для вариантов этого отчета, где: +// * Включен - Булево - если Ложь, то вариант отчета не выводится в панели отчетов. +// * ВидимостьПоУмолчанию - Булево - если Ложь, то вариант отчета по умолчанию скрыт в панели отчетов. +// * ПоказыватьВПодменюВариантов - Булево - если Ложь, то вариант отчета не отображается в подменю выбора вариантов +// отчета в форме отчета. Используется, когда Включен - Ложь. +// * Размещение - Соответствие из КлючИЗначение - настройки размещения варианта отчета в разделах, где: +// ** Ключ - ОбъектМетаданных - подсистема, в которой размещается отчет или вариант отчета. +// ** Значение - Строка - настройки размещения в подсистеме (группе), с вариантами значений: +// "" - вывод отчета в подсистеме без специального выделение. +// "Важный" - вывод отчета в подсистеме с выделением жирным шрифтом. +// "СмТакже" - вывод отчета в группе "См. также". +// * ФункциональныеОпции - Массив из Строка - имена функциональных опций варианта отчета. +// * НастройкиДляПоиска - Структура - дополнительные настройки для поиска этого варианта отчета, где: +// ** НаименованияПолей - Строка - имена полей варианта отчета. +// ** НаименованияПараметровИОтборов - Строка - имена настроек варианта отчета. +// ** КлючевыеСлова - Строка - дополнительная терминология (в т.ч. специализированная или устаревшая). +// ** ИменаМакетов - Строка - используется вместо НаименованияПолей. +// * ФорматНастроекСКД - Булево - отчет использует типовой формат хранения настроек на механике СКД, +// а его основные формы поддерживают стандартную схему взаимодействия между формами (параметры и тип +// возвращаемого значения). +// Если Ложь, тогда для отчета отключаются проверки консистентности и некоторые механизмы, которые +// рассчитывают на типовой формат. +// * ОпределитьНастройкиФормы - Булево - отчет имеет программный интерфейс для тесной интеграции с формой отчета, +// в том числе может переопределять некоторые настройки формы и подписываться на ее события. +// Если Истина и отчет подключен к общей форме ФормаОтчета, +// тогда в модуле объекта отчета следует определить процедуру по шаблону: +// +// // Задать настройки формы отчета. +// // +// // Параметры: +// // Форма - ФормаКлиентскогоПриложения, Неопределено +// // КлючВарианта - Строка, Неопределено +// // Настройки - см. ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию +// // +// Процедура ОпределитьНастройкиФормы(Форма, КлючВарианта, Настройки) Экспорт +// // Код процедуры. +// КонецПроцедуры +// +// * Отчет - СправочникСсылка.ИдентификаторыОбъектовРасширений +// - СправочникСсылка.ДополнительныеОтчетыИОбработки +// - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - Строка - полное имя или ссылка на отчет. +// * Метаданные - ОбъектМетаданныхОтчет - метаданные отчета. +// * КлючВарианта - Строка - имя варианта отчета. +// * ОписаниеПолучено - Булево - флажок что описание строки уже получено. +// Описание получается методом ОписаниеВарианта(). +// * СистемнаяИнформация - Структура - другая служебная информация. +// При этом колонки Отчет, Метаданные, КлючВарианта, ОписаниеПолучено, СистемнаяИнформация +// являются служебными и предназначены только для чтения. +// +Функция ОписаниеОтчета(Настройки, Отчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.ОписаниеОтчета(Настройки, Отчет) +``` +
+ +## ОписаниеВарианта +
+ +Описание, пример вызова + +```bsl + +// Находит настройки варианта отчета. Используется для настройки размещения. +// Для использования в ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов. +// +// Параметры: +// Настройки - см. ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов.Настройки. +// Отчет - СтрокаДереваЗначений +// - ОбъектМетаданных - описание настроек, метаданные или ссылка отчета. +// КлючВарианта - Строка - имя варианта отчета как оно задано в схеме компоновки данных. +// +// Возвращаемое значение: +// СтрокаДереваЗначений - настройки варианта отчета, где: +// * Включен - Булево - если Ложь, то вариант отчета не выводится в панели отчетов. +// * ВидимостьПоУмолчанию - Булево - если Ложь, то вариант отчета по умолчанию скрыт в панели отчетов. +// * ПоказыватьВПодменюВариантов - Булево - если Ложь, то вариант отчета не отображается в подменю выбора вариантов +// отчета в форме отчета. Используется, когда Включен - Ложь. +// * Наименование - Строка - наименование варианта отчета. +// * Описание - Строка - подсказка к варианту отчета. +// * Размещение - Соответствие из КлючИЗначение - настройки размещения варианта отчета в разделах, где: +// ** Ключ - ОбъектМетаданных - подсистема, в которой размещается отчет или вариант отчета. +// ** Значение - Строка - настройки размещения в подсистеме (группе), с вариантами значений: +// "" - вывод варианта в подсистеме без специального выделение. +// "Важный" - вывод варианта в подсистеме с выделением жирным шрифтом. +// "СмТакже" - вывод варианта в группе "См. также". +// * ФункциональныеОпции - Массив из Строка - имена функциональных опций варианта отчета. +// * НастройкиДляПоиска - Структура - дополнительные настройки для поиска этого варианта отчета, где: +// ** НаименованияПолей - Строка - имена полей варианта отчета. +// ** НаименованияПараметровИОтборов - Строка - имена настроек варианта отчета. +// ** КлючевыеСлова - Строка - дополнительная терминология (в т.ч. специализированная или устаревшая). +// ** ИменаМакетов - Строка - используется вместо НаименованияПолей. +// * ФорматНастроекСКД - Булево - отчет использует типовой формат хранения настроек на механике СКД, +// а его основные формы поддерживают стандартную схему взаимодействия между формами (параметры и тип +// возвращаемого значения). +// Если Ложь, тогда для отчета отключаются проверки консистентности и некоторые механизмы, которые +// рассчитывают на типовой формат. +// * ОпределитьНастройкиФормы - Булево - отчет имеет программный интерфейс для тесной интеграции с формой отчета, +// в том числе может переопределять некоторые настройки формы и подписываться на ее события. +// Если Истина и отчет подключен к общей форме ФормаОтчета, +// тогда в модуле объекта отчета следует определить процедуру по шаблону: +// +// // Задать настройки формы отчета. +// // +// // Параметры: +// // Форма - ФормаКлиентскогоПриложения, Неопределено +// // КлючВарианта - Строка, Неопределено +// // Настройки - см. значение ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию +// // +// Процедура ОпределитьНастройкиФормы(Форма, КлючВарианта, Настройки) Экспорт +// // Код процедуры. +// КонецПроцедуры +// +// * Отчет - СправочникСсылка.ИдентификаторыОбъектовРасширений +// - СправочникСсылка.ДополнительныеОтчетыИОбработки +// - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - Строка - полное имя или ссылка на отчет. +// * Описание - Строка +// * Метаданные - ОбъектМетаданныхОтчет - метаданные отчета. +// * КлючВарианта - Строка - имя варианта отчета. +// * Назначение - ПеречислениеСсылка.НазначенияВариантовОтчетов - назначение использования варианта отчета (по +// умолчанию - ДляКомпьютеровИПланшетов) +// * ОписаниеПолучено - Булево - флажок что описание строки уже получено. +// Описание получается методом ОписаниеВарианта(). +// * СистемнаяИнформация - Структура - другая служебная информация. +// При этом колонки Отчет, Метаданные, КлючВарианта, ОписаниеПолучено, СистемнаяИнформация +// являются служебными и предназначены только для чтения. +// +Функция ОписаниеВарианта(Настройки, Отчет, КлючВарианта) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.ОписаниеВарианта(Настройки, Отчет, КлючВарианта) +``` +
+ +## УстановитьРежимВыводаВПанеляхОтчетов +
+ +Описание, пример вызова + +```bsl + +// Устанавливает режим вывода Отчетов и Вариантов в панелях отчетов. +// Для вызова из процедуры ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов переопределяемого модуля +// и из процедуры НастроитьВариантыОтчета модуля объекта отчета. +// +// Параметры: +// Настройки - см. ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов.Настройки. +// ОтчетИлиПодсистема - СтрокаДереваЗначений +// - ОбъектМетаданныхОтчет +// - ОбъектМетаданныхПодсистема - описание отчета или +// подсистемы, для которой устанавливается режим вывода. Когда передана подсистема режим +// устанавливается рекурсивно для всех отчетов из ее состава. +// ГруппироватьПоОтчетам - Булево +// - Строка - режим вывода гиперссылок этого отчета в панели отчетов: +// Если Истина, "ПоОтчетам" - варианты группируются по отчету. +// По умолчанию в панелях отчетов выводится только основной вариант отчета, +// а все прочие варианты этого отчета выводятся "под" основным и по умолчанию скрыты +// (но могут быть найдены поиском или включены при помощи флажков в режиме настройки). +// Основным вариантом считается первый предопределенный вариант в схеме отчета. +// Этот режим появился в версии 2.2.2 и позволяет уменьшить количество гиперссылок, выводимых в +// панелях отчетов. Если Ложь, "ПоВариантам" - все варианты отчета считаются самостоятельными, +// по умолчанию видны и выводятся независимо в панелях отчетов. +// Этот режим использовался в версии 2.2.1 и ранее. +// +Процедура УстановитьРежимВыводаВПанеляхОтчетов(Настройки, ОтчетИлиПодсистема, ГруппироватьПоОтчетам) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.УстановитьРежимВыводаВПанеляхОтчетов(Настройки, ОтчетИлиПодсистема, ГруппироватьПоОтчетам) +``` +
+ +## ПриСохраненииПользовательскихНастроекНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обновляет состав справочника ПользовательскиеНастройкиОтчетов после сохранения новой настройки. +// Вызывается в одноименном обработчике формы отчета после выполнения кода формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма отчета. +// Настройки - ПользовательскиеНастройкиКомпоновкиДанных - передается "как есть" из процедуры ПриСохраненииПользовательскихНастроекНаСервере. +// +Процедура ПриСохраненииПользовательскихНастроекНаСервере(Форма, Настройки) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.ПриСохраненииПользовательскихНастроекНаСервере(Форма, Настройки) +``` +
+ +## ИспользуемыеТаблицы +
+ +Описание, пример вызова + +```bsl + +// Извлекает информацию о таблицах, используемых в схеме или запросе. +// Обработка исключений (например, в случае передачи некорректного текста запроса) выполняется вызывающим кодом. +// +// Параметры: +// Объект - СхемаКомпоновкиДанных +// - Строка - схема отчета или текст запроса. +// +// Возвращаемое значение: +// Массив - имена таблиц, используемые в схеме или запросе. +// +// Пример: +// // Вызов из собственной формы отчета, использующего СКД. +// ИспользуемыеТаблицы = ВариантыОтчетов.ИспользуемыеТаблицы(РеквизитФормыВЗначение("Отчет").СхемаКомпоновкиДанных); +// ВариантыОтчетов.ПроверитьИспользуемыеТаблицы(ИспользуемыеТаблицы); +// // Вызов из обработчика ПриКомпоновкеРезультата отчета, использующего СКД. +// ИспользуемыеТаблицы = ВариантыОтчетов.ИспользуемыеТаблицы(СхемаКомпоновкиДанных); +// ВариантыОтчетов.ПроверитьИспользуемыеТаблицы(ИспользуемыеТаблицы); +// // Вызов из обработчика ПриКомпоновкеРезультата отчета, использующего запрос. +// ИспользуемыеТаблицы = ВариантыОтчетов.ИспользуемыеТаблицы(ТекстЗапроса); +// ВариантыОтчетов.ПроверитьИспользуемыеТаблицы(ИспользуемыеТаблицы); +// +Функция ИспользуемыеТаблицы(Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.ИспользуемыеТаблицы(Объект) +``` +
+ +## ИспользуемыеТаблицыОтчета +
+ +Описание, пример вызова + +```bsl + +// Извлекает информацию о таблицах, используемых в схеме или запросе. +// +// Параметры: +// Отчет - ОбъектМетаданныхОтчет +// - ОтчетОбъект +// +// Возвращаемое значение: +// Массив из см. ИспользуемыеТаблицы +// +Функция ИспользуемыеТаблицыОтчета(Отчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.ИспользуемыеТаблицыОтчета(Отчет) +``` +
+ +## ПроверитьИспользуемыеТаблицы +
+ +Описание, пример вызова + +```bsl + +// Проверяет что таблицы, используемые в схеме или запросе, еще обновляются, и сообщает об этом пользователю. +// Проверка выполняется методом ОбновлениеИнформационнойБазы.ОбъектОбработан(). +// Обработка исключений (например, в случае передачи некорректного текста запроса) выполняется вызывающим кодом. +// +// Параметры: +// Объект - СхемаКомпоновкиДанных - схема отчета. +// - Строка - текст запроса. +// - Массив - имена таблиц, используемые отчетом: +// * Строка - имя таблицы. +// Сообщать - Булево - когда Истина и таблицы, используемые отчетом, еще не обновлены, +// то будет выведено сообщение вида "Отчет может содержать некорректные данные". +// Необязательный. По умолчанию Истина. +// +// Возвращаемое значение: +// Булево - Истина когда в списке таблиц есть таблицы, которые еще не обновлены. +// +// Пример: +// // Вызов из собственной формы отчета. +// ВариантыОтчетов.ПроверитьИспользуемыеТаблицы(РеквизитФормыВЗначение("Отчет").СхемаКомпоновкиДанных); +// // Вызов из обработчика ПриКомпоновкеРезультата отчета. +// ВариантыОтчетов.ПроверитьИспользуемыеТаблицы(СхемаКомпоновкиДанных); +// // Вызов при выполнении запроса. +// ВариантыОтчетов.ПроверитьИспользуемыеТаблицы(ТекстЗапроса); +// +Функция ПроверитьИспользуемыеТаблицы(Объект, Сообщать = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.ПроверитьИспользуемыеТаблицы(Объект, Сообщать); +``` +
+ +## СброситьПользовательскиеНастройки +
+ +Описание, пример вызова + +```bsl + +// Сбрасывает пользовательские настройки указанных отчетов. +// +// Параметры: +// Ключ - ОбъектМетаданныхОтчет - метаданные отчета, для которого требуется сбросить настройки. +// - СправочникСсылка.ВариантыОтчетов - вариант отчета, для которого требуется сбросить настройки. +// - Строка - полное имя варианта отчета, для которого требуется сбросить настройки. +// Заполняется в формате "<ИмяОтчета>/<ИмяВарианта>". +// Если передать "*", то будут сброшены настройки всех отчетов конфигурации. +// ТипыНастроек - Структура - типы пользовательских настроек, которые требуется сбросить. +// Ключи структуры тоже являются необязательными. Значение по умолчанию указано в скобках: +// * ЭлементОтбора - Булево - (Ложь) сбрасывать настройку "ЭлементОтбораКомпоновкиДанных". +// * ЗначениеПараметраНастроек - Булево - (Ложь) сбрасывать настройку "ЗначениеПараметраНастроекКомпоновкиДанных". +// * ВыбранныеПоля - Булево - (берется из ключа Прочие) сбрасывать настройку "ВыбранныеПоляКомпоновкиДанных". +// * Порядок - Булево - (берется из ключа Прочие) сбрасывать настройку "ПорядокКомпоновкиДанных". +// * ЭлементУсловногоОформления - Булево - (берется из ключа Прочие) сбрасывать настройку "ЭлементУсловногоОформленияКомпоновкиДанных". +// * Прочие - Булево - (Истина) сбрасывать прочие настройки, не описанные в структуре явно. +// +Процедура СброситьПользовательскиеНастройки(Ключ, ТипыНастроек = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.СброситьПользовательскиеНастройки(Ключ, ТипыНастроек); +``` +
+ +## ПеренестиПользовательскиеИзСтандартногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Переносит пользовательские варианты из стандартного хранилища вариантов в хранилище подсистемы. +// Используется при частичном внедрении - когда ХранилищеВариантовОтчетов установлено не для всей конфигурации, +// а в свойствах конкретных отчетов, подключенных к подсистеме. +// Рекомендуется использовать в обработчиках обновления на конкретную версию. +// +// Параметры: +// ИменаОтчетов - Строка - имена отчетов, разделенные запятыми. +// Если параметр не указан, то переносятся все отчеты +// стандартного хранилища, после чего оно полностью очищается. +// +// Пример: +// // Перенос всех пользовательских вариантов отчетов при обновлении. +// ВариантыОтчетов.ПеренестиПользовательскиеИзСтандартногоХранилища(); +// // Перенос пользовательских вариантов отчетов, переведенных в хранилище подсистемы "Варианты отчетов". +// ВариантыОтчетов.ПеренестиПользовательскиеИзСтандартногоХранилища("АнализЖурналаРегистрации, ЗадачиИстекающиеНаДату"); +// +Процедура ПеренестиПользовательскиеИзСтандартногоХранилища(ИменаОтчетов = "") Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.ПеренестиПользовательскиеИзСтандартногоХранилища(ИменаОтчетов); +``` +
+ +## ЗагрузитьПользовательские +
+ +Описание, пример вызова + +```bsl + +// Загружает в хранилище подсистемы варианты отчетов, предварительно сохраненные +// из системного хранилища вариантов в хранилище общих настроек. +// Используется для загрузки вариантов отчетов при полном или частичном внедрении. +// При полном внедрении может вызваться из обработки "ПереносВариантовОтчетов". +// Рекомендуется использовать в обработчиках обновления на конкретную версию. +// +// Параметры: +// ПользовательскиеВарианты - ТаблицаЗначений +// - Неопределено - необязательный. Используется в служебных сценариях: +// * Отчет - Строка - полное имя отчета в формате "Отчет.<ИмяОтчета>". +// * Вариант - Строка - имя варианта отчета. +// * Автор - Строка - имя пользователя. +// * Настройка - ХранилищеЗначения - пользовательскиеНастройкиКомпоновкиДанных. +// * ПредставлениеОтчета - Строка - представление отчета. +// * ПредставлениеВарианта - Строка - представление варианта. +// * ИдентификаторАвтора - УникальныйИдентификатор - идентификатор пользователя. +// +Процедура ЗагрузитьПользовательские(ПользовательскиеВарианты = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.ЗагрузитьПользовательские(ПользовательскиеВарианты); +``` +
+ +## ПоделитьсяПользовательскимиНастройками +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ВыбранныеПользователи - СписокЗначений: +// * Значение - СправочникСсылка.Пользователи +// - СправочникСсылка.ГруппыПользователей +// - СправочникСсылка.ГруппыВнешнихПользователей +// ШаблонОписанияНастроек - Структура - параметры открытия формы выбора пользователей, (групп) пользователей, где: +// * Настройки - ПользовательскиеНастройкиКомпоновкиДанных - настройки, которыми обмениваются. +// * ВариантОтчета - СправочникСсылка.ВариантыОтчетов - ссылка на хранилище свойств варианта отчета. +// * КлючОбъекта - Строка - измерение хранения настроек. +// * КлючНастроек - Строка - измерение - идентификатор пользовательских настроек. +// * Представление - Строка - наименование пользовательских настроек. +// * ВариантМодифицирован - Булево - признак того, что вариант отчета изменен. +// +Процедура ПоделитьсяПользовательскимиНастройками(ВыбранныеПользователи, ШаблонОписанияНастроек) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.ПоделитьсяПользовательскимиНастройками(ВыбранныеПользователи, ШаблонОписанияНастроек) +``` +
+ +## СвойстваПользователейНастроек +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ВыбранныеПользователи - СписокЗначений: +// * Значение - СправочникСсылка.Пользователи +// - СправочникСсылка.ГруппыПользователей +// - СправочникСсылка.ГруппыВнешнихПользователей +// ТекущийПользователь - СправочникСсылка.ВнешниеПользователи +// - СправочникСсылка.Пользователи +// +// Возвращаемое значение: +// Структура: +// * Недействительных - Массив из Структура +// * Действительных - Массив из Структура +// +Функция СвойстваПользователейНастроек(ВыбранныеПользователи, ТекущийПользователь) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.СвойстваПользователейНастроек(ВыбранныеПользователи, ТекущийПользователь)); +``` +
+ +## СвойстваПользователя +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Ссылка - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// ИмяПользователяИБ - Строка +// ИдентификаторПользователяИБ - УникальныйИдентификатор +// +// Возвращаемое значение: +// Структура: +// * Ссылка - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// * Имя - Строка +// * ИдентификаторПользователяИБ - УникальныйИдентификатор +// +Функция СвойстваПользователя(Ссылка, ИмяПользователяИБ, ИдентификаторПользователяИБ) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.СвойстваПользователя(Ссылка, ИмяПользователяИБ, ИдентификаторПользователяИБ)); +``` +
+ +## ПроверитьДоступностьВариантаОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьДоступностьВариантаОтчета(ВариантОтчета, ВыбранныеПользователи) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.ПроверитьДоступностьВариантаОтчета(ВариантОтчета, ВыбранныеПользователи)); +``` +
+ +## НормализоватьШаблонОписанияНастроек +
+ +Описание, пример вызова + +```bsl + +Процедура НормализоватьШаблонОписанияНастроек(ШаблонОписанияНастроек, ТекущийПользователь) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.НормализоватьШаблонОписанияНастроек(ШаблонОписанияНастроек, ТекущийПользователь)); +``` +
+ +## УстановитьПредставлениеПользовательскихНастроек +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьПредставлениеПользовательскихНастроек(ШаблонОписанияНастроек, ТекущийПользователь) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.УстановитьПредставлениеПользовательскихНастроек(ШаблонОписанияНастроек, ТекущийПользователь)); +``` +
+ +## ОбновитьСлужебнуюИнформациюПользовательскихНастроек +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьСлужебнуюИнформациюПользовательскихНастроек(Пользователь, ОписаниеНастроек, Настройки) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.ОбновитьСлужебнуюИнформациюПользовательскихНастроек(Пользователь, ОписаниеНастроек, Настройки)); +``` +
+ +## ОповеститьПользователейНастроекОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ОповеститьПользователейНастроекОтчета(СвойстваПользователей, ОписаниеНастроек) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетов.ОповеститьПользователейНастроекОтчета(СвойстваПользователей, ОписаниеНастроек)); +``` +
+ +## КоллекцияПредопределенныхВариантовОтчетов +
+ +Описание, пример вызова + +```bsl + +// Конструктор коллекции предопределенных вариантов отчетов. +// +// Возвращаемое значение: +// см. ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов.Настройки. +// +Функция КоллекцияПредопределенныхВариантовОтчетов() Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.КоллекцияПредопределенныхВариантовОтчетов()); +``` +
+ +## ОписаниеОтчетаПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание указанного отчета по умолчанию. +// +// Параметры: +// ОписанияОтчетов - см. КоллекцияПредопределенныхВариантовОтчетов +// МетаданныеОтчета - ОбъектМетаданныхОтчет +// СсылкаОтчета - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// ТипОтчета - см. ТипОтчетаСтрокой +// ГруппироватьПоОтчетам - см. ГлобальныеНастройки +// +// Возвращаемое значение: +// СтрокаТаблицыЗначений - см. КоллекцияПредопределенныхВариантовОтчетов +// +Функция ОписаниеОтчетаПоУмолчанию(ОписанияОтчетов, МетаданныеОтчета, СсылкаОтчета, Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.ОписаниеОтчетаПоУмолчанию(ОписанияОтчетов, МетаданныеОтчета, СсылкаОтчета, ); +``` +
+ +## НайденныеОписанияОтчета +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив с одним элементом - описание по умолчанию указанного отчета. +// +// Параметры: +// Отчет - ОбъектМетаданныхОтчет +// - СправочникСсылка.ИдентификаторыОбъектовМетаданных - метаданные или ссылка отчета. +// +// Возвращаемое значение: +// Массив из см. КоллекцияПредопределенныхВариантовОтчетов +// +Функция НайденныеОписанияОтчета(Отчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.НайденныеОписанияОтчета(Отчет)); +``` +
+ +## РезультатАктуализацииВариантовОтчетов +
+ +Описание, пример вызова + +```bsl + +// Конструктор результата актуализации вариантов отчетов. +// +// Возвращаемое значение: +// Структура - коллекция свойств результата актуализации вариантов отчетов, где: +// * ЕстьИзменения - Булево - признак наличия изменений в вариантах отчетов. +// * ЕстьВажныеИзменения - Булево - признак наличия важных изменений в вариантах отчетов. +// * ПустаяСсылка - СправочникСсылка.ВариантыОтчетов - ссылка на пустой вариант отчета. +// * ОбработанныеПредопределенные - Соответствие - индекс обработанных вариантов отчетов. +// * ОсновныеВарианты - см. КоллекцияОсновныхВариантовОтчетов +// +Функция РезультатАктуализацииВариантовОтчетов() Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.РезультатАктуализацииВариантовОтчетов()); +``` +
+ +## КоллекцияОсновныхВариантовОтчетов +
+ +Описание, пример вызова + +```bsl + +// Конструктор коллекции основных вариантов отчетов. +// +// Возвращаемое значение: +// ТаблицаЗначений - коллекция основных вариантов отчетов, где: +// * Отчет - СправочникСсылка.ИдентификаторыОбъектовРасширений +// - СправочникСсылка.ДополнительныеОтчетыИОбработки +// - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - Строка - ссылка на идентификатор метаданных отчета. +// * Вариант - СправочникСсылка.ВариантыОтчетов - ссылка на вариант отчета. +// +Функция КоллекцияОсновныхВариантовОтчетов() Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.КоллекцияОсновныхВариантовОтчетов()); +``` +
+ +## РезультатОбновленияОбщихДанных +
+ +Описание, пример вызова + +```bsl + +// Конструктор результата обновления общих данных. +// +// Параметры: +// Режим - Строка - вид обновления данных. +// РазделенныеОбработчики - Структура +// +// Возвращаемое значение: +// Структура - свойства результата обновления общих данных, где: +// * ОбновлятьКонфигурацию - Булево - признак необходимости обновления данных конфигурации. +// * ОбновлятьРасширения - Булево - признак необходимости обновления данных расширений. +// * РазделенныеОбработчики - Структура +// * ЕстьИзменения - Булево - признак наличия изменений в вариантах отчетов. +// * ЕстьВажныеИзменения - Булево - признак наличия важных изменений в вариантах отчетов. +// * ВариантыОтчетов - ТаблицаЗначений +// * ОбновлятьЗамеры - Булево - признак наличия подсистемы ОценкаПроизводительности. +// * ТаблицаЗамеров - см. ТаблицаЗамеров +// * МодельСервиса - Булево - признак работы в модели сервиса. +// +Функция РезультатОбновленияОбщихДанных(Знач Режим, Знач РазделенныеОбработчики) Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.РезультатОбновленияОбщихДанных(Режим, РазделенныеОбработчики)); +``` +
+ +## ТаблицаЗамеров +
+ +Описание, пример вызова + +```bsl + +// Конструктор таблицы замеров. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * СтароеИмя - Строка - не актуальный ключ замеров. +// * АктуальноеИмя - Строка - текущий ключ замеров. +// * АктуальноеНаименование - Строка - текущее наименование отчета. +// +Функция ТаблицаЗамеров() Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.ТаблицаЗамеров()); +``` +
+ +## ВариантыОтчетовДляВывода +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, содержащей результат поиск доступных вариантов отчетов. +// +// Возвращаемое значение: +// Структура: +// * ТолькоТекущийРаздел - Булево +// * ТаблицаПодсистем - ТаблицаЗначений: +// ** Ссылка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// ** Представление - Строка +// ** Имя - Строка +// ** ПолноеИмя - Строка +// ** Приоритет - Строка +// ** НомерЭлемента - Число +// ** ИмяЭлемента - Строка +// ** РодительСсылка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// ** РазделСсылка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// ** ВидимыхВариантов - Число +// * ДругиеРазделы - Массив +// * Варианты - ТаблицаЗначений: +// ** Ссылка - СправочникСсылка.ВариантыОтчетов +// ** Подсистема - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// ** ПодсистемаПредставление - Строка +// ** ПодсистемаПриоритет - Строка +// ** РазделСсылка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// ** БезГруппы - Булево +// ** Важный - Булево +// ** СмТакже - Булево +// ** Дополнительный - Булево +// ** Видимость - Булево +// ** БыстрыйДоступ - Булево +// ** ИмяОтчета - Строка +// ** Наименование - Строка +// ** Описание - Строка +// ** Автор - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// ** Отчет - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// - СправочникСсылка.ДополнительныеОтчетыИОбработки +// - Строка +// ** ТипОтчета - ПеречислениеСсылка.ТипыОтчетов +// ** КлючВарианта - Строка +// ** Родитель - СправочникСсылка.ВариантыОтчетов +// ** ВерхнийУровень - Булево +// ** КлючЗамеров - Строка +// * ВариантыРаздела - см. ВариантыОтчетовДляВывода.Варианты +// * ИспользоватьПодсветку - Булево +// * РезультатПоиска - см. НайтиВариантыОтчетов +// * МассивСлов - Массив +// * ИмяГруппы - Строка +// * ДобавляемыеРеквизиты - Массив из РеквизитФормы +// * ДобавленоПустыхДекораций - Число +// * ПределВывода - Число +// * ОсталосьВывести - Число +// * НеВыведено - Число +// * ВыведеноЭлементовВариантов - Число +// * ПоискВариантов - Соответствие +// * Шаблоны - Структура: +// ** ГруппаВарианта - Структура: +// *** Вид - ВидГруппыФормы +// *** РастягиватьПоГоризонтали - Булево +// *** Отображение - ОтображениеОбычнойГруппы +// *** Группировка - ГруппировкаПодчиненныхЭлементовФормы +// *** ОтображатьЗаголовок - Булево +// ** КартинкаБыстрогоДоступа - Структура: +// *** Вид - ВидДекорацииФормы +// *** Ширина - Число +// *** Высота - Число +// *** Картинка - Картинка +// *** РастягиватьПоГоризонтали - Булево +// *** РастягиватьПоВертикали - Булево +// ** КартинкаОтступа - Структура: +// *** Вид - ВидДекорацииФормы +// *** Ширина - Число +// *** Высота - Число +// *** РастягиватьПоГоризонтали - Булево +// *** РастягиватьПоВертикали - Булево +// ** НадписьВарианта - Структура: +// *** Вид - ВидДекорацииФормы +// *** Гиперссылка - Булево +// *** ЦветТекста - Цвет +// *** РастягиватьПоВертикали - Булево +// *** Высота - Число +// *** РастягиватьПоГоризонтали - Булево +// *** АвтоМаксимальнаяШирина - Булево +// *** МаксимальнаяШирина - Число +// * КонтекстноеМеню - Структура: +// ** УбратьИзБыстрогоДоступа - Структура: +// *** Видимость - Булево +// ** ПереместитьВБыстрыйДоступ - Структура: +// *** Видимость - Булево +// ** Изменить - Структура: +// *** Видимость - Булево +// * ГруппыВажности - Массив из Строка +// * БыстрыйДоступ - Структура: +// ** Отбор - Структура: +// *** БыстрыйДоступ - Булево +// ** Варианты - Массив из СтрокаТаблицыЗначений +// ** Количество - Число +// * БезГруппы - Структура: +// ** Отбор - Структура: +// *** БыстрыйДоступ - Булево +// *** БезГруппы - Булево +// ** Варианты - Массив из СтрокаТаблицыЗначений +// ** Количество - Число +// * СГруппой - Структура: +// ** Отбор - Структура: +// *** БыстрыйДоступ - Булево +// *** БезГруппы - Булево +// *** СмТакже - Булево +// ** Варианты - Массив из СтрокаТаблицыЗначений +// ** Количество - Число +// * СмТакже - Структура: +// ** Отбор - Структура: +// *** БыстрыйДоступ - Булево +// *** БезГруппы - Булево +// *** СмТакже - Булево +// ** Варианты - Массив из СтрокаТаблицыЗначений +// ** Количество - Число +// * ВыводятсяВариантыТекущегоРаздела - Булево +// * ВариантыКоличество - Число +// * ПодсистемыРаздела - ТаблицаЗначений: +// ** Ссылка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// ** Представление - Строка +// ** Имя - Строка +// ** ПолноеИмя - Строка +// ** Приоритет - Строка +// ** НомерЭлемента - Число +// ** ИмяЭлемента - Строка +// ** РодительСсылка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// ** РазделСсылка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// ** ВидимыхВариантов - Число +// +Функция ВариантыОтчетовДляВывода() Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетов.ВариантыОтчетовДляВывода() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВариантыОтчетовКлиент.md b/src/content/docs/bsp/ВариантыОтчетовКлиент.md new file mode 100644 index 0000000..8f88b39 --- /dev/null +++ b/src/content/docs/bsp/ВариантыОтчетовКлиент.md @@ -0,0 +1,86 @@ +--- +title: Варианты отчетов клиент +slug: bsp/варианты-отчетов-клиент +--- + + +## ОткрытьФормуОтчета +
+ +Описание, пример вызова + +```bsl + +// Открывает форму указанного отчета. +// +// Параметры: +// ФормаВладелец - ФормаКлиентскогоПриложения +// - Неопределено - форма, из которой открывается отчет. +// Вариант - СправочникСсылка.ВариантыОтчетов +// - СправочникСсылка.ДополнительныеОтчетыИОбработки - вариант +// отчета, форму которого требуется открыть. Если передан тип СправочникСсылка.ДополнительныеОтчетыИОбработки, +// то открывается дополнительный отчет, подключенный к программе. +// ДополнительныеПараметры - Структура - служебный параметр, не предназначен для использования. +// +Процедура ОткрытьФормуОтчета(Знач ФормаВладелец, Знач Вариант, Знач ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетовКлиент.ОткрытьФормуОтчета(ФормаВладелец, Вариант, ДополнительныеПараметры); +``` +
+ +## ПоказатьПанельОтчетов +
+ +Описание, пример вызова + +```bsl + +// Открывает панель отчетов. Для использования из модулей общих команд. +// +// Параметры: +// ПутьКПодсистеме - Строка - имя раздела или путь к подсистеме, для которой открывается панель отчетов. +// Задается в формате: "ИмяРаздела[.ИмяВложеннойПодсистемы1][.ИмяВложеннойПодсистемы2][...]". +// Раздел должен быть описан в ВариантыОтчетовПереопределяемый.ОпределитьРазделыСВариантамиОтчетов. +// ПараметрыВыполненияКоманды - ПараметрыВыполненияКоманды - параметры обработчика общей команды. +// +Процедура ПоказатьПанельОтчетов(ПутьКПодсистеме, ПараметрыВыполненияКоманды) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетовКлиент.ПоказатьПанельОтчетов(ПутьКПодсистеме, ПараметрыВыполненияКоманды) +``` +
+ +## ОбновитьОткрытыеФормы +
+ +Описание, пример вызова + +```bsl + +// Оповещает открытые панели отчетов, формы списков и элементов об изменениях варианта отчета. +// +// Параметры: +// КлючВарианта - Строка - если открыта форма отчета, установить в ней указанный вариант отчета. +// Источник - СправочникСсылка.ВариантыОтчетов +// +Процедура ОбновитьОткрытыеФормы(Знач КлючВарианта = "", Знач Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетовКлиент.ОбновитьОткрытыеФормы(КлючВарианта, Источник); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВариантыОтчетовКлиентСервер.md b/src/content/docs/bsp/ВариантыОтчетовКлиентСервер.md new file mode 100644 index 0000000..25d4cdc --- /dev/null +++ b/src/content/docs/bsp/ВариантыОтчетовКлиентСервер.md @@ -0,0 +1,34 @@ +--- +title: Варианты отчетов клиент сервер +slug: bsp/варианты-отчетов-клиент-сервер +--- + + +## ИдентификаторНачальнойСтраницы +
+ +Описание, пример вызова + +```bsl + +// Идентификатор, который используется для начальной страницы в модуле ВариантыОтчетовПереопределяемый. +// +// Возвращаемое значение: +// Строка - идентификатор, который используется для начальной страницы в модуле ВариантыОтчетовПереопределяемый. +// +Функция ИдентификаторНачальнойСтраницы() Экспорт +``` + +Пример вызова +```bsl +Результат = ВариантыОтчетовКлиентСервер.ИдентификаторНачальнойСтраницы() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВариантыОтчетовПереопределяемый.md b/src/content/docs/bsp/ВариантыОтчетовПереопределяемый.md new file mode 100644 index 0000000..36b37a3 --- /dev/null +++ b/src/content/docs/bsp/ВариантыОтчетовПереопределяемый.md @@ -0,0 +1,364 @@ +--- +title: Варианты отчетов переопределяемый +slug: bsp/варианты-отчетов-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Задает настройки, применяемые как стандартные для объектов подсистемы. +// +// Параметры: +// Настройки - Структура - коллекция настроек подсистемы. Реквизиты: +// * ВыводитьОтчетыВместоВариантов - Булево - умолчание для вывода гиперссылок в панели отчетов: +// Истина - варианты отчетов по умолчанию скрыты, а отчеты включены и видимы. +// Ложь - варианты отчетов по умолчанию видимы, а отчеты отключены. +// Значение по умолчанию: Ложь. +// * ВыводитьОписания - Булево - умолчание для вывода описаний в панели отчетов: +// Истина - значение по умолчанию. Выводить описания в виде подписей под гиперссылками вариантов +// Ложь - выводить описания в виде всплывающих подсказок +// Значение по умолчанию: Истина. +// * Поиск - Структура - настройки поиска вариантов отчетов: +// ** ПодсказкаВвода - Строка - текст подсказки выводится в поле поиска когда поиск не задан. +// В качестве примера рекомендуется указывать часто используемые термины прикладной конфигурации. +// * ДругиеОтчеты - Структура - настройки формы "Другие отчеты": +// ** ЗакрыватьПослеВыбора - Булево - закрывать ли форму после выбора гиперссылки отчета. +// Истина - закрывать "Другие отчеты" после выбора. +// Ложь - не закрывать. +// Значение по умолчанию: Истина. +// ** ПоказыватьФлажок - Булево - показывать ли флажок ЗакрыватьПослеВыбора. +// Истина - показывать флажок "Закрывать это окно после перехода к другому отчету". +// Ложь - не показывать флажок. +// Значение по умолчанию: Ложь. +// * РазрешеноИзменятьВарианты - Булево - показывать расширенные настройки отчета +// и команды изменения варианта отчета. +// +// Пример: +// Настройки.Поиск.ПодсказкаВвода = НСтр("ru = 'Например, себестоимость'"); +// Настройки.ДругиеОтчеты.ЗакрыватьПослеВыбора = Ложь; +// Настройки.ДругиеОтчеты.ПоказыватьФлажок = Истина; +// Настройки.РазрешеноИзменятьВарианты = Ложь; +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетовПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ОпределитьРазделыСВариантамиОтчетов +
+ +Описание, пример вызова + +```bsl + +// Определяет разделы командного интерфейса, в которых предусмотрены панели отчетов. +// В Разделы необходимо добавить метаданные тех подсистем первого уровня, +// в которых размещены команды вызова панелей отчетов. +// +// Параметры: +// Разделы - СписокЗначений - разделы, в которые выведены команды открытия панели отчетов: +// * Значение - ОбъектМетаданныхПодсистема +// - Строка - подсистема раздела глобального командного интерфейса, +// либо ВариантыОтчетовКлиентСервер.ИдентификаторНачальнойСтраницы для начальной страницы. +// * Представление - Строка - заголовок панели отчетов в этом разделе. +// +// Пример: +// Разделы.Добавить(Метаданные.Подсистемы.Анкетирование, НСтр("ru = 'Отчеты по анкетированию'")); +// Разделы.Добавить(ВариантыОтчетовКлиентСервер.ИдентификаторНачальнойСтраницы(), НСтр("ru = 'Основные отчеты'")); +// +Процедура ОпределитьРазделыСВариантамиОтчетов(Разделы) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетовПереопределяемый.ОпределитьРазделыСВариантамиОтчетов(Разделы) +``` +
+ +## НастроитьВариантыОтчетов +
+ +Описание, пример вызова + +```bsl + +// Задает расширенные настройки отчетов конфигурации, такие как: +// - описание отчета; +// - поля поиска: наименования полей, параметров и отборов (для отчетов не на базе СКД); +// - размещение в разделах командного интерфейса +// (начальная настройка размещения отчетов по подсистемам автоматически определяется из метаданных, +// ее дублирование не требуется); +// - признак Включен (для контекстных отчетов); +// - режима вывода в панелях отчетов (с группировкой по отчету или без); +// - и другие. +// +// В процедуре задаются только настройки отчетов (и вариантов отчетов) конфигурации. +// Для настройки отчетов из расширений конфигурации следует включать их в подсистему ПодключаемыеОтчетыИОбработки. +// +// Для задания настроек следует использовать следующие вспомогательные процедуры и функции: +// ВариантыОтчетов.ОписаниеОтчета, +// ВариантыОтчетов.ОписаниеВарианта, +// ВариантыОтчетов.УстановитьРежимВыводаВПанеляхОтчетов, +// ВариантыОтчетов.НастроитьОтчетВМодулеМенеджера. +// +// Изменяя настройки отчета, можно изменить настройки всех его вариантов. +// Однако, если явно получить настройки варианта отчета, то они станут самостоятельными, +// т.е. более не будут наследовать изменения настроек от отчета. +// +// Функциональные опции предопределенного варианта отчета объединяются с функциональными опциями этого отчета по правилам: +// (ФО1_Отчета ИЛИ ФО2_Отчета) И (ФО3_Варианта ИЛИ ФО4_Варианта). +// При этом для пользовательских вариантов отчета действуют только функциональные опции отчета +// - они отключаются только с отключением всего отчета. +// +// Параметры: +// Настройки - ТаблицаЗначений - коллекция предопределенных вариантов отчетов, где: +// * Отчет - СправочникСсылка.ИдентификаторыОбъектовРасширений +// - СправочникСсылка.ДополнительныеОтчетыИОбработки +// - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - Строка - полное имя или ссылка на идентификатор отчета. +// * Метаданные - ОбъектМетаданныхОтчет - метаданные отчета. +// * ИспользуетСКД - Булево - признак использования в отчете основной СКД. +// * КлючВарианта - Строка - идентификатор варианта отчета. +// * ОписаниеПолучено - Булево - признак того, что описание строки уже получено. +// * Включен - Булево - если Ложь, то вариант отчета не выводится в панели отчетов. +// * ВидимостьПоУмолчанию - Булево - если Ложь, то вариант отчета по умолчанию скрыт в панели отчетов. +// * ПоказыватьВПодменюВариантов - Булево - если Ложь, то вариант отчета не отображается в подменю выбора вариантов +// отчета в форме отчета. Используется, когда Включен - Ложь. +// * Наименование - Строка - наименование варианта отчета. +// * Описание - Строка - пояснение назначения отчета. +// * Размещение - Соответствие из КлючИЗначение - настройки размещения варианта отчета в разделах (подсистемах), где: +// ** Ключ - ОбъектМетаданных - подсистема, в которой размещается отчет или вариант отчета. +// ** Значение - Строка - настройки размещения в подсистеме (группе) - "", "Важный", "СмТакже". +// * НастройкиДляПоиска - Структура - дополнительные настройки для поиска этого варианта отчета, где: +// ** НаименованияПолей - Строка - имена полей варианта отчета. +// ** НаименованияПараметровИОтборов - Строка - имена настроек варианта отчета. +// ** КлючевыеСлова - Строка - дополнительная терминология (в т.ч. специализированная или устаревшая). +// ** ИменаМакетов - Строка - используется вместо НаименованияПолей. +// * СистемнаяИнформация - Структура - другая служебная информация. +// * Тип - Строка - перечень идентификаторов типов. +// * ЭтоВариант - Булево - признак того, что описание отчета относится к варианту отчета. +// * ФункциональныеОпции - Массив из Строка - коллекция идентификаторов функциональных опций, где: +// * ГруппироватьПоОтчету - Булево - признак необходимости группировки вариантов по отчету-основанию. +// * КлючЗамеров - Строка - идентификатор замера производительности отчета. +// * ОсновнойВариант - Строка - идентификатор основного варианта отчета. +// * ФорматНастроекСКД - Булево - признак хранения настроек в формате СКД. +// * ОпределитьНастройкиФормы - Булево - отчет имеет программный интерфейс для тесной интеграции с формой отчета, +// в том числе может переопределять некоторые настройки формы и подписываться на ее события. +// Если Истина и отчет подключен к общей форме ФормаОтчета, +// тогда в модуле объекта отчета следует определить процедуру по шаблону: +// +// // Задать настройки формы отчета. +// // +// // Параметры: +// // Форма - ФормаКлиентскогоПриложения, Неопределено +// // КлючВарианта - Строка, Неопределено +// // Настройки - см. ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию +// // +// Процедура ОпределитьНастройкиФормы(Форма, КлючВарианта, Настройки) Экспорт +// // Код процедуры. +// КонецПроцедуры +// +// Пример: +// +// // Добавление варианта отчета в подсистему. +// НастройкиВарианта = ВариантыОтчетов.ОписаниеВарианта(Настройки, Метаданные.Отчеты.ИмяОтчета, "<ИмяВарианта>"); +// НастройкиВарианта.Размещение.Вставить(Метаданные.Подсистемы.ИмяРаздела.Подсистемы.ИмяПодсистемы); +// +// // Отключение варианта отчета. +// НастройкиВарианта = ВариантыОтчетов.ОписаниеВарианта(Настройки, Метаданные.Отчеты.ИмяОтчета, "<ИмяВарианта>"); +// НастройкиВарианта.Включен = Ложь; +// +// // Отключение всех вариантов отчета, кроме одного. +// НастройкиОтчета = ВариантыОтчетов.ОписаниеОтчета(Настройки, Метаданные.Отчеты.ИмяОтчета); +// НастройкиОтчета.Включен = Ложь; +// НастройкиВарианта = ВариантыОтчетов.ОписаниеВарианта(Настройки, НастройкиОтчета, "<ИмяВарианта>"); +// НастройкиВарианта.Включен = Истина; +// +// // Заполнение настроек для поиска - наименования полей, параметров и отборов: +// НастройкиВарианта = ВариантыОтчетов.ОписаниеВарианта(Настройки, Метаданные.Отчеты.ИмяОтчетаБезСхемы, ""); +// НастройкиВарианта.НастройкиДляПоиска.НаименованияПолей = +// НСтр("ru = 'Контрагент +// |Договор +// |Ответственный +// |Скидка +// |Дата'"); +// НастройкиВарианта.НастройкиДляПоиска.НаименованияПараметровИОтборов = +// НСтр("ru = 'Период +// |Ответственный +// |Контрагент +// |Договор'"); +// +// // Переключение режима вывода в панелях отчетов: +// // Группировка вариантов отчета по этому отчету: +// ВариантыОтчетов.УстановитьРежимВыводаВПанеляхОтчетов(Настройки, Метаданные.Отчеты.ИмяОтчета, Истина); +// // Без группировки по отчету: +// Отчет = ВариантыОтчетов.ОписаниеОтчета(Настройки, Метаданные.Отчеты.ИмяОтчета); +// ВариантыОтчетов.УстановитьРежимВыводаВПанеляхОтчетов(Настройки, Отчет, Ложь); +// +Процедура НастроитьВариантыОтчетов(Настройки) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов(Настройки) +``` +
+ +## ЗарегистрироватьИзмененияКлючейВариантовОтчетов +
+ +Описание, пример вызова + +```bsl + +// Регистрирует изменения в именах вариантов отчетов. +// Используется при обновлении в целях сохранения ссылочной целостности, +// в частности для сохранения пользовательских настроек и настроек рассылок отчетов. +// Старое имя варианта резервируется и не может быть использовано в дальнейшем. +// Если изменений было несколько, то каждое изменение необходимо зарегистрировать, +// указывая в актуальном имени варианта последнее (текущее) имя варианта отчета. +// Поскольку имена вариантов отчетов не выводятся в пользовательском интерфейсе, +// то рекомендуется задавать их таким образом, что бы затем не менять. +// В Изменения необходимо добавить описания изменений имен вариантов +// отчетов, подключенных к подсистеме. +// +// Параметры: +// Изменения - ТаблицаЗначений - таблица изменений имен вариантов. Колонки: +// * Отчет - ОбъектМетаданных - метаданные отчета, в схеме которого изменилось имя варианта. +// * СтароеИмяВарианта - Строка - старое имя варианта, до изменения. +// * АктуальноеИмяВарианта - Строка - текущее (последнее актуальное) имя варианта. +// +// Пример: +// Изменение = Изменения.Добавить(); +// Изменение.Отчет = Метаданные.Отчеты.<ИмяОтчета>; +// Изменение.СтароеИмяВарианта = "<СтароеИмяВарианта>"; +// Изменение.АктуальноеИмяВарианта = "<АктуальноеИмяВарианта>"; +// +Процедура ЗарегистрироватьИзмененияКлючейВариантовОтчетов(Изменения) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетовПереопределяемый.ЗарегистрироватьИзмененияКлючейВариантовОтчетов(Изменения) +``` +
+ +## ОпределитьОбъектыСКомандамиОтчетов +
+ +Описание, пример вызова + +```bsl + +// Определяет объекты конфигурации, в модулях менеджеров которых предусмотрена процедура ДобавитьКомандыОтчетов, +// описывающая команды открытия контекстных отчетов. +// Синтаксис процедуры ДобавитьКомандыОтчетов см. в документации. +// +// Параметры: +// Объекты - Массив - объекты метаданных (ОбъектМетаданных) с командами отчетов. +// +Процедура ОпределитьОбъектыСКомандамиОтчетов(Объекты) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетовПереопределяемый.ОпределитьОбъектыСКомандамиОтчетов(Объекты) +``` +
+ +## ПередДобавлениемКомандОтчетов +
+ +Описание, пример вызова + +```bsl + +// Определение списка глобальных команд отчетов. +// Событие возникает в процессе вызова модуля повторного использования. +// +// Параметры: +// КомандыОтчетов - ТаблицаЗначений - таблица команд для вывода в подменю, где: +// * Идентификатор - Строка - идентификатор команды. +// * Представление - Строка - представление команды в форме. +// * Важность - Строка - суффикс группы в подменю, в которой следует вывести эту команду. +// Допустимо использовать: "Важное", "Обычное" и "СмТакже". +// * Порядок - Число - порядок размещения команды в группе. Используется для настройки под конкретное +// рабочее место. +// * Картинка - Картинка - картинка команды. +// * СочетаниеКлавиш - СочетаниеКлавиш - сочетание клавиш для быстрого вызова команды. +// * ТипПараметра - ОписаниеТипов - типы объектов, для которых предназначена эта команда. +// * ВидимостьВФормах - Строка - имена форм через запятую, в которых должна отображаться команда. +// Используется когда состав команд отличается для различных форм. +// * ФункциональныеОпции - Строка - имена функциональных опций через запятую, определяющих видимость команды. +// * УсловияВидимости - Массив - определяет видимость команды в зависимости от контекста. +// Для регистрации условий следует использовать процедуру +// ПодключаемыеКоманды.ДобавитьУсловиеВидимостиКоманды(). +// Условия объединяются по "И". +// * ИзменяетВыбранныеОбъекты - Булево - определяет доступность команды в ситуации, +// когда у пользователя нет прав на изменение объекта. +// Если Истина, то в описанной выше ситуации кнопка будет недоступна. +// Необязательный. Значение по умолчанию: Ложь. +// * МножественныйВыбор - Булево +// - Неопределено - если Истина, то команда поддерживает множественный выбор. +// В этом случае в параметре выполнения будет передан список ссылок. +// Необязательный. Значение по умолчанию: Истина. +// * Неконтекстный - Булево - если Истина, то будут доступны для выбора другие варианты этого отчета, +// возможность добавления в избранное, получение ссылки на вариант отчета. +// * РежимЗаписи - Строка - действия, связанные с записью объекта, которые выполняются перед обработчиком команды, где: +// "НеЗаписывать" - объект не записывается, а в параметрах обработчика вместо ссылок передается +// вся форма. В этом режиме рекомендуется работать напрямую с формой, +// которая передается в структуре 2 параметра обработчика команды. +// "ЗаписыватьТолькоНовые" - записывать новые объекты. +// "Записывать" - записывать новые и модифицированные объекты. +// "Проводить" - проводить документы. +// Перед записью и проведением у пользователя запрашивается подтверждение. +// Необязательный. Значение по умолчанию: "Записывать". +// * ТребуетсяРаботаСФайлами - Булево - если Истина, то в веб-клиенте предлагается +// установить расширение для работы с 1С:Предприятием. +// Необязательный. Значение по умолчанию: Ложь. +// * Менеджер - Строка - полное имя объекта метаданных, отвечающего за выполнение команды. +// Например, "Отчет.КнигаПокупок". +// * ИмяФормы - Строка - имя формы, которую требуется открыть или получить для выполнения команды. +// Если Обработчик не указан, то у формы вызывается метод "Открыть". +// * КлючВарианта - Строка - имя варианта отчета, открываемого при выполнении команды. +// * ИмяПараметраФормы - Строка - имя параметра формы, в который следует передать ссылку или массив ссылок. +// * ПараметрыФормы - Неопределено +// - Структура - параметры формы, указанной в ИмяФормы. +// * Обработчик - Строка - описание процедуры, обрабатывающей основное действие команды. +// Формат "<ИмяОбщегоМодуля>.<ИмяПроцедуры>" используется когда процедура размещена в общем модуле. +// Формат "<ИмяПроцедуры>" используется в следующих случаях: +// 1) если ИмяФормы заполнено то в модуле указанной формы ожидается клиентская процедура, +// 2) если ИмяФормы не заполнено то в модуле менеджера этого объекта ожидается серверная процедура. +// * ДополнительныеПараметры - Структура - параметры обработчика, указанного в Обработчик. +// +// Параметры - Структура - сведения о контексте исполнения, где: +// * ИмяФормы - Строка - полное имя формы. +// +// СтандартнаяОбработка - Булево - если установить в Ложь, то событие "ДобавитьКомандыОтчетов" менеджера объекта не +// будет вызвано. +// +Процедура ПередДобавлениемКомандОтчетов(КомандыОтчетов, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ВариантыОтчетовПереопределяемый.ПередДобавлениемКомандОтчетов(КомандыОтчетов, Параметры, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВерсионированиеОбъектов.md b/src/content/docs/bsp/ВерсионированиеОбъектов.md new file mode 100644 index 0000000..912ef11 --- /dev/null +++ b/src/content/docs/bsp/ВерсионированиеОбъектов.md @@ -0,0 +1,184 @@ +--- +title: Версионирование объектов +slug: bsp/версионирование-объектов +--- + + +## ЗаписатьНастройкуВерсионированияПоОбъекту +
+ +Описание, пример вызова + +```bsl + +// Записывает настройку версионирования объекта. +// +// Параметры: +// ТипОбъекта - Строка +// - Тип +// - ОбъектМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовМетаданных - объект метаданных; +// ВариантВерсионирования - ПеречислениеСсылка.ВариантыВерсионированияОбъектов - условие записи версий; +// СрокХраненияВерсий - ПеречислениеСсылка.СрокиХраненияВерсий - срок, после которого версии подлежат очистке. +// +Процедура ЗаписатьНастройкуВерсионированияПоОбъекту(Знач ТипОбъекта, Знач ВариантВерсионирования, Знач СрокХраненияВерсий = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектов.ЗаписатьНастройкуВерсионированияПоОбъекту(ТипОбъекта, ВариантВерсионирования, СрокХраненияВерсий); +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Выполняет с формой действия, необходимые для подключения подсистемы версионирования. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма для подключения механизма версионирования. +// +Процедура ПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектов.ПриСозданииНаСервере(Форма) +``` +
+ +## ВключеноВерсионированиеОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак использования версионирования для указанного объекта метаданных. +// +// Параметры: +// ИмяОбъекта - Строка - полный путь к объекту метаданных. Например, "Справочник.Номенклатура". +// +// Возвращаемое значение: +// Булево - Истина, если включено. +// +Функция ВключеноВерсионированиеОбъекта(ИмяОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ВерсионированиеОбъектов.ВключеноВерсионированиеОбъекта(ИмяОбъекта) +``` +
+ +## ВключеноВерсионированиеОбъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак использования версионирования для списка объектов. +// +// Параметры: +// СписокОбъектов - Массив - список имен объектов метаданных. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - имя объекта метаданных. +// * Значение - Булево - включено или выключено версионирование. +// +Функция ВключеноВерсионированиеОбъектов(СписокОбъектов) Экспорт +``` + +Пример вызова +```bsl +Результат = ВерсионированиеОбъектов.ВключеноВерсионированиеОбъектов(СписокОбъектов) +``` +
+ +## ВключитьВерсионированиеОбъекта +
+ +Описание, пример вызова + +```bsl + +// Включает запись истории изменения для указанного объекта метаданных. +// +// Параметры: +// ИмяОбъекта - Строка - полный путь к объекту метаданных. Например, "Справочник.Номенклатура". +// ВариантВерсионирования - ПеречислениеСсылка.ВариантыВерсионированияОбъектов - вариант версионирования объекта. +// +Процедура ВключитьВерсионированиеОбъекта(ИмяОбъекта, Знач ВариантВерсионирования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектов.ВключитьВерсионированиеОбъекта(ИмяОбъекта, ВариантВерсионирования); +``` +
+ +## ВключитьВерсионированиеОбъектов +
+ +Описание, пример вызова + +```bsl + +// Включает запись истории изменения для указанных объектов метаданных. +// +// Параметры: +// Объекты - Соответствие из КлючИЗначение - объекты, для которых надо включить версионирование: +// * Ключ - Строка - полный путь к объекту метаданных. Например, "Справочник.Номенклатура". +// * Значение - ПеречислениеСсылка.ВариантыВерсионированияОбъектов - вариант версионирования объекта. +// +Процедура ВключитьВерсионированиеОбъектов(Объекты) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектов.ВключитьВерсионированиеОбъектов(Объекты) +``` +
+ +## ЗначениеФлажкаХранитьИсторию +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак хранения истории для формы настроек версионирования объекта. +// +// Возвращаемое значение: +// Булево +// +// Пример: +// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ВерсионированиеОбъектов") Тогда +// МодульВерсионированиеОбъектов = ОбщегоНазначения.ОбщийМодуль("ВерсионированиеОбъектов"); +// ИспользоватьВерсионированиеОбъектов = МодульВерсионированиеОбъектов.ЗначениеФлажкаХранитьИсторию(); +// Иначе +// Элементы.ГруппаУправлениеВерсионированиемОбъектов.Видимость = Ложь; +// КонецЕсли; +// +Функция ЗначениеФлажкаХранитьИсторию() Экспорт +``` + +Пример вызова +```bsl +Результат = ВерсионированиеОбъектов.ЗначениеФлажкаХранитьИсторию() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВерсионированиеОбъектовКлиент.md b/src/content/docs/bsp/ВерсионированиеОбъектовКлиент.md new file mode 100644 index 0000000..9817e92 --- /dev/null +++ b/src/content/docs/bsp/ВерсионированиеОбъектовКлиент.md @@ -0,0 +1,142 @@ +--- +title: Версионирование объектов клиент +slug: bsp/версионирование-объектов-клиент +--- + + +## ОткрытьОтчетПоИзменениям +
+ +Описание, пример вызова + +```bsl + +// Открывает отчет по версиям объекта в режиме сравнения версий. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - ссылка на версионируемый объект; +// АдресСериализованногоОбъекта - Строка - адрес двоичных данных сравниваемой версии +// объекта во временном хранилище. +// +Процедура ОткрытьОтчетПоИзменениям(Ссылка, АдресСериализованногоОбъекта) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовКлиент.ОткрытьОтчетПоИзменениям(Ссылка, АдресСериализованногоОбъекта) +``` +
+ +## ОткрытьОтчетПоВерсииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Показывает сохраненную версию объекта. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - ссылка на версионируемый объект; +// АдресСериализованногоОбъекта - Строка - адрес двоичных данных версии объекта во временном хранилище. +// +Процедура ОткрытьОтчетПоВерсииОбъекта(Ссылка, АдресСериализованногоОбъекта) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовКлиент.ОткрытьОтчетПоВерсииОбъекта(Ссылка, АдресСериализованногоОбъекта) +``` +
+ +## ОбработкаОповещенияИзмененияФлажкаХранитьИсторию +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ОбработкаОповещения для формы, на которой требуется отобразить флажок хранения истории изменения. +// +// Параметры: +// ИмяСобытия - Строка - имя события, которое было получено обработчиком события на форме. +// ХранитьИсториюИзменений - Число - реквизит, в который будет помещено значение. +// +// Пример: +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ВерсионированиеОбъектов") Тогда +// МодульВерсионированиеОбъектовКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ВерсионированиеОбъектовКлиент"); +// МодульВерсионированиеОбъектовКлиент.ОбработкаОповещенияИзмененияФлажкаХранитьИсторию( +// ИмяСобытия, +// ХранитьИсториюИзменений); +// КонецЕсли; +// +Процедура ОбработкаОповещенияИзмененияФлажкаХранитьИсторию(Знач ИмяСобытия, ХранитьИсториюИзменений) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовКлиент.ОбработкаОповещенияИзмененияФлажкаХранитьИсторию(ИмяСобытия, ХранитьИсториюИзменений) +``` +
+ +## ПриИзмененииФлажкаХранитьИсторию +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриИзменении для флажка, выполняющего переключение режима хранения истории изменений. +// Флажок должен быть связан с реквизитом типа Булево. +// +// Параметры: +// ЗначениеФлажкаХранитьИсториюИзменений - Булево - новое значение флажка, которое требуется обработать. +// +// Пример: +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ВерсионированиеОбъектов") Тогда +// МодульВерсионированиеОбъектовКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ВерсионированиеОбъектовКлиент"); +// МодульВерсионированиеОбъектовКлиент.ПриИзмененииФлажкаХранитьИсторию(ХранитьИсториюИзменений); +// КонецЕсли; +// +Процедура ПриИзмененииФлажкаХранитьИсторию(ЗначениеФлажкаХранитьИсториюИзменений) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовКлиент.ПриИзмененииФлажкаХранитьИсторию(ЗначениеФлажкаХранитьИсториюИзменений) +``` +
+ +## ПоказатьНастройку +
+ +Описание, пример вызова + +```bsl + +// Открывает форму управления версионированием объектов. +// Не забудьте команду, выполняющую вызов процедуры, +// установить зависимой от функциональной опции ИспользоватьВерсионированиеОбъектов. +// +// Пример: +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ВерсионированиеОбъектов") Тогда +// МодульВерсионированиеОбъектовКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ВерсионированиеОбъектовКлиент"); +// МодульВерсионированиеОбъектовКлиент.ПоказатьНастройку(); +// КонецЕсли; +// +Процедура ПоказатьНастройку() Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовКлиент.ПоказатьНастройку() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВерсионированиеОбъектовПереопределяемый.md b/src/content/docs/bsp/ВерсионированиеОбъектовПереопределяемый.md new file mode 100644 index 0000000..27154a7 --- /dev/null +++ b/src/content/docs/bsp/ВерсионированиеОбъектовПереопределяемый.md @@ -0,0 +1,176 @@ +--- +title: Версионирование объектов переопределяемый +slug: bsp/версионирование-объектов-переопределяемый +--- + + +## ПриПолученииТабличныхДокументовОбъекта +
+ +Описание, пример вызова + +```bsl + +// Вызывается для получения версионируемых табличных документов во время записи версии объекта. +// Табличный документ прикладывается к версии объекта в случае, когда в отчете по версии объекта требуется +// заменить "техногенную" табличную часть объекта на ее представление в виде табличного документа. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - версионируемый объект конфигурации. +// ТабличныеДокументы - Структура: +// * Ключ - Строка - имя табличного документа; +// * Значение - Структура: +// ** Наименование - Строка - наименование табличного документа; +// ** Данные - ТабличныйДокумент - версионируемый табличный документ. +// +Процедура ПриПолученииТабличныхДокументовОбъекта(Ссылка, ТабличныеДокументы) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовПереопределяемый.ПриПолученииТабличныхДокументовОбъекта(Ссылка, ТабличныеДокументы) +``` +
+ +## ПослеРазбораВерсииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Вызывается после разбора прочитанной из регистра версии объекта, +// может использоваться для дополнительной обработки результата разбора версии. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - версионируемый объект конфигурации. +// Результат - Структура - результат разбора версии подсистемой версионирования. +// +Процедура ПослеРазбораВерсииОбъекта(Ссылка, Результат) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовПереопределяемый.ПослеРазбораВерсииОбъекта(Ссылка, Результат) +``` +
+ +## ПриВыбореРеквизитовОбъекта +
+ +Описание, пример вызова + +```bsl + +// Вызывается после определения реквизитов объекта из формы +// РегистрСведений.ВерсииОбъектов.ВыборРеквизитовОбъекта. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - версионируемый объект конфигурации. +// ДеревоРеквизитов - ДанныеФормыДерево - дерево реквизитов объектов. +// +Процедура ПриВыбореРеквизитовОбъекта(Ссылка, ДеревоРеквизитов) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовПереопределяемый.ПриВыбореРеквизитовОбъекта(Ссылка, ДеревоРеквизитов) +``` +
+ +## ПриОпределенииНаименованияРеквизитаОбъекта +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении представления реквизита объекта. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - версионируемый объект конфигурации. +// ИмяРеквизита - Строка - ИмяРеквизита, как оно задано в конфигураторе. +// НаименованиеРеквизита - Строка - выходной параметр, можно переопределить полученный синоним. +// Видимость - Булево - выводить реквизит в отчетах по версиям. +// +Процедура ПриОпределенииНаименованияРеквизитаОбъекта(Ссылка, ИмяРеквизита, НаименованиеРеквизита, Видимость) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовПереопределяемый.ПриОпределенииНаименованияРеквизитаОбъекта(Ссылка, ИмяРеквизита, НаименованиеРеквизита, Видимость) +``` +
+ +## ПриПодготовкеДанныхОбъекта +
+ +Описание, пример вызова + +```bsl + +// Дополняет объект реквизитами, хранящимися отдельно от объекта либо в служебной части самого объекта, +// не предназначенной для вывода в отчетах. +// +// Параметры: +// Объект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовРасчетаОбъект +// - ПланСчетовОбъект +// - ПланВидовХарактеристикОбъект - +// версионируемый объект. +// ДополнительныеРеквизиты - ТаблицаЗначений - коллекция дополнительных реквизитов, которые требуется сохранить вместе +// с версией объекта: +// * Идентификатор - Произвольный - уникальный идентификатор реквизита. Требуется при восстановлении из версии +// объекта в случае, когда значение реквизита хранится отдельно от объекта. +// * Наименование - Строка - название реквизита. +// * Значение - Произвольный - значение реквизита. +// +Процедура ПриПодготовкеДанныхОбъекта(Объект, ДополнительныеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовПереопределяемый.ПриПодготовкеДанныхОбъекта(Объект, ДополнительныеРеквизиты) +``` +
+ +## ПриВосстановленииВерсииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Восстанавливает значения реквизитов объекта, хранящихся отдельно от объекта. +// +// Параметры: +// Объект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовРасчетаОбъект +// - ПланСчетовОбъект +// - ПланВидовХарактеристикОбъект - +// версионируемый объект: +// * Ссылка - ЛюбаяСсылка +// ДополнительныеРеквизиты - ТаблицаЗначений - коллекция дополнительных реквизитов, которые были сохранены вместе с +// версией объекта: +// * Идентификатор - Произвольный - уникальный идентификатор реквизита. +// * Наименование - Строка - название реквизита. +// * Значение - Произвольный - значение реквизита. +// +Процедура ПриВосстановленииВерсииОбъекта(Объект, ДополнительныеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовПереопределяемый.ПриВосстановленииВерсииОбъекта(Объект, ДополнительныеРеквизиты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВерсионированиеОбъектовСобытия.md b/src/content/docs/bsp/ВерсионированиеОбъектовСобытия.md new file mode 100644 index 0000000..a01b014 --- /dev/null +++ b/src/content/docs/bsp/ВерсионированиеОбъектовСобытия.md @@ -0,0 +1,61 @@ +--- +title: Версионирование объектов события +slug: bsp/версионирование-объектов-события +--- + + +## ЗаписатьВерсиюОбъекта +
+ +Описание, пример вызова + +```bsl + +// Записывает версию объекта (кроме документов) в информационную базу. +// +// Параметры: +// Источник - СправочникОбъект - записываемый объект ИБ; +// Отказ - Булево - признак отказа от записи объекта. +// +Процедура ЗаписатьВерсиюОбъекта(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовСобытия.ЗаписатьВерсиюОбъекта(Источник, Отказ) +``` +
+ +## ЗаписатьВерсиюДокумента +
+ +Описание, пример вызова + +```bsl + +// Записывает версию документа в информационную базу. +// +// Параметры: +// Источник - ДокументОбъект - записываемый документ ИБ; +// Отказ - Булево - признак отказа от записи документа. +// РежимЗаписи - РежимЗаписиДокумента - позволяет определить выполняется запись, проведение или отмена проведения. +// Изменение значения параметра позволяет изменить режим записи. +// РежимПроведения - РежимПроведенияДокумента - позволяет определить, выполняется оперативное проведение или нет. +// Изменение значения параметра позволяет изменить режим проведения. +// +Процедура ЗаписатьВерсиюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +ВерсионированиеОбъектовСобытия.ЗаписатьВерсиюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/Взаимодействия.md b/src/content/docs/bsp/Взаимодействия.md new file mode 100644 index 0000000..a83420e --- /dev/null +++ b/src/content/docs/bsp/Взаимодействия.md @@ -0,0 +1,292 @@ +--- +title: Взаимодействия +slug: bsp/взаимодействия +--- + + +## УстановитьИспользованиеПочтовогоКлиента +
+ +Описание, пример вызова + +```bsl + +// Включает или выключает почтовый клиент. +// +// Параметры: +// Значение - Булево +// +Процедура УстановитьИспользованиеПочтовогоКлиента(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Взаимодействия.УстановитьИспользованиеПочтовогоКлиента(Значение) +``` +
+ +## ИспользуетсяПочтовыйКлиент +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность использования почтового клиента. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользуетсяПочтовыйКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = Взаимодействия.ИспользуетсяПочтовыйКлиент() +``` +
+ +## УстановитьИспользованиеОтправкиПисемВФорматеHTML +
+ +Описание, пример вызова + +```bsl + +// Включает или выключает возможность отправки писем в формате HTML. +// Если выключить, то будет доступна отправка только в текстовом формате. +// +// Параметры: +// Значение - Булево +// +Процедура УстановитьИспользованиеОтправкиПисемВФорматеHTML(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Взаимодействия.УстановитьИспользованиеОтправкиПисемВФорматеHTML(Значение) +``` +
+ +## ИспользуетсяОтправкаПисемВФорматеHTML +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность использования отправки писем в формате HTML. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользуетсяОтправкаПисемВФорматеHTML() Экспорт +``` + +Пример вызова +```bsl +Результат = Взаимодействия.ИспользуетсяОтправкаПисемВФорматеHTML() +``` +
+ +## УстановитьИспользованиеПрочегоВзаимодействия +
+ +Описание, пример вызова + +```bsl + +// Включает или выключает возможность учета телефонных звонков, SMS-сообщений, +// встреч и планирования взаимодействий. +// +// Параметры: +// Значение - Булево +// +Процедура УстановитьИспользованиеПрочегоВзаимодействия(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Взаимодействия.УстановитьИспользованиеПрочегоВзаимодействия(Значение) +``` +
+ +## ИспользуютсяПрочиеВзаимодействия +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность использования учета телефонных звонков, SMS-сообщений, встреч и планирования взаимодействий. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользуютсяПрочиеВзаимодействия() Экспорт +``` + +Пример вызова +```bsl +Результат = Взаимодействия.ИспользуютсяПрочиеВзаимодействия() +``` +
+ +## ЗаполнитьРеквизитыПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчиков заполнения документов - взаимодействий и предметов заполнения. +// Выполняет необходимые действия по заполнению реквизитов по умолчанию. +// +// Параметры: +// Объект - ДокументОбъект - документ, для которого выполняется заполнение. +// ДанныеЗаполнения - Произвольный - значение,которое используется как основание для заполнения. +// +Процедура ЗаполнитьРеквизитыПоУмолчанию(Объект, ДанныеЗаполнения) Экспорт +``` + +Пример вызова +```bsl +Взаимодействия.ЗаполнитьРеквизитыПоУмолчанию(Объект, ДанныеЗаполнения) +``` +
+ +## ПриЗаписиПредметаИзФормы +
+ +Описание, пример вызова + +```bsl + +// Устанавливает во всей цепочке взаимодействий в качестве предмета созданный объект. +// +// Параметры: +// Предмет - ОпределяемыйТип.ПредметВзаимодействия - созданный предмет взаимодействий. +// Взаимодействие - ДокументСсылка - взаимодействие, по которому создан предмет. +// Отказ - Булево - флаг отказа от операции. +// +Процедура ПриЗаписиПредметаИзФормы(Предмет, Взаимодействие, Отказ) Экспорт +``` + +Пример вызова +```bsl +Взаимодействия.ПриЗаписиПредметаИзФормы(Предмет, Взаимодействие, Отказ) +``` +
+ +## ПодготовитьОповещения +
+ +Описание, пример вызова + +```bsl + +// Выполняет подготовку оповещения при создании на сервере документа взаимодействий. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой будет отправлено оповещение. +// Параметры - Структура - параметры создания формы документа взаимодействий. +// ИспользоватьВзаимодействиеОснование - Булево - признак необходимости учитывать документ-основание. +// +Процедура ПодготовитьОповещения(Форма, Параметры, ИспользоватьВзаимодействиеОснование = Истина) Экспорт +``` + +Пример вызова +```bsl +Взаимодействия.ПодготовитьОповещения(Форма, Параметры, ИспользоватьВзаимодействиеОснование); +``` +
+ +## УстановитьПризнакАктивен +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак активности предмета. +// +// Параметры: +// Предмет - ДокументСсылка +// - СправочникСсылка - предмет, для которого выполняется запись. +// Активен - Булево - признак активности предмета. +// +Процедура УстановитьПризнакАктивен(Предмет, Активен) Экспорт +``` + +Пример вызова +```bsl +Взаимодействия.УстановитьПризнакАктивен(Предмет, Активен) +``` +
+ +## ЗаполнитьНаборыЗначенийДоступаПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Заполняет наборы значений доступа к документам подсистемы значениями по умолчанию. +// Для использования в процедуре ВзаимодействияПереопределяемый.ПриЗаполненииНаборовЗначенийДоступа. +// С ее помощью можно объединять прикладной набор значений доступа к документам подсистемы +// со стандартным заполнением по умолчанию. +// +// Параметры: +// Объект - ДокументОбъект.Встреча +// - ДокументОбъект.ЗапланированноеВзаимодействие +// - ДокументОбъект.СообщениеSMS +// - ДокументОбъект.ТелефонныйЗвонок +// - ДокументОбъект.ЭлектронноеПисьмоВходящее +// - ДокументОбъект.ЭлектронноеПисьмоИсходящее - объект, для которого заполняются наборы. +// Таблица - см. УправлениеДоступом.ТаблицаНаборыЗначенийДоступа +// +Процедура ЗаполнитьНаборыЗначенийДоступаПоУмолчанию(Объект, Таблица) Экспорт +``` + +Пример вызова +```bsl +Взаимодействия.ЗаполнитьНаборыЗначенийДоступаПоУмолчанию(Объект, Таблица) +``` +
+ +## ПредметВзаимодействия +
+ +Описание, пример вызова + +```bsl + +// Возвращает предмет взаимодействия. +// +// Параметры: +// Взаимодействие - ДокументСсылка.Встреча, +// - ДокументСсылка.ЗапланированноеВзаимодействие, +// - ДокументСсылка.ТелефонныйЗвонок, +// - ДокументСсылка.СообщениеSMS, +// - ДокументСсылка.ЭлектронноеПисьмоВходящее, +// - ДокументСсылка.ЭлектронноеПисьмоИсходящее +// +// Возвращаемое значение: +// ОпределяемыйТип.ПредметВзаимодействия +// +Функция ПредметВзаимодействия(Взаимодействие) Экспорт +``` + +Пример вызова +```bsl +Результат = Взаимодействия.ПредметВзаимодействия(Взаимодействие) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВзаимодействияКлиент.md b/src/content/docs/bsp/ВзаимодействияКлиент.md new file mode 100644 index 0000000..1e13ddc --- /dev/null +++ b/src/content/docs/bsp/ВзаимодействияКлиент.md @@ -0,0 +1,192 @@ +--- +title: Взаимодействия клиент +slug: bsp/взаимодействия-клиент +--- + + +## ОткрытьФормуОтправкиSMS +
+ +Описание, пример вызова + +```bsl + +// Открывает форму нового документа "Сообщение SMS" с переданными параметрами. +// +// Параметры: +// ПараметрыФормы - см. ВзаимодействияКлиент.ПараметрыФормыОтправкиSMS. +// УдалитьТекст - Строка - не используется. +// УдалитьПредмет - ЛюбаяСсылка - не используется. +// УдалитьОтправлятьВТранслите - Булево - не используется. +// +Процедура ОткрытьФормуОтправкиSMS(Знач ПараметрыФормы = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияКлиент.ОткрытьФормуОтправкиSMS(ПараметрыФормы, ); +``` +
+ +## ПараметрыФормыОтправкиSMS +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры для передачи в ВзаимодействияКлиент.ОткрытьФормуОтправкиSMS. +// +// Возвращаемое значение: +// Структура: +// * Адресаты - Строка +// - СписокЗначений +// - Массив - список получателей письма. +// * Текст - Строка - текст письма. +// * Предмет - ЛюбаяСсылка - предмет письма. +// * ОтправлятьВТранслите - Булево - признак того, что сообщение при отправке должно быть преобразовано в латинские +// символы. +// +Функция ПараметрыФормыОтправкиSMS() Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаимодействияКлиент.ПараметрыФормыОтправкиSMS() +``` +
+ +## КонтактПослеЗаписи +
+ +Описание, пример вызова + +```bsl + +// Обработчик для события формы ПослеЗаписиНаСервере. Вызывается для контакта. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, для которой обрабатывается событие. +// Объект - ДанныеФормыКоллекция - данные объекта хранимые в форме. +// ПараметрыЗаписи - Структура - структура, в которую добавляются параметры, которые потом будут +// посланы с оповещением. +// ИмяОбъектаОтправителяСообщения - Строка - имя объекта метаданных, для формы которого обрабатывается событие. +// ПосылатьОповещение - Булево - признак необходимости отправки оповещения из этой процедуры. +// +Процедура КонтактПослеЗаписи(Форма,Объект,ПараметрыЗаписи,ИмяОбъектаОтправителяСообщения,ПосылатьОповещение = Истина) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияКлиент.КонтактПослеЗаписи(Форма, Объект, ПараметрыЗаписи, ИмяОбъектаОтправителяСообщения, ПосылатьОповещение); +``` +
+ +## ВзаимодействиеПредметПослеЗаписи +
+ +Описание, пример вызова + +```bsl + +// Обработчик для события формы ПослеЗаписиНаСервере. Вызывается для взаимодействия или предмета взаимодействия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, для которой обрабатывается событие. +// Объект - ОпределяемыйТип.ПредметВзаимодействия - данные объекта хранимые в форме. +// ПараметрыЗаписи - Структура - структура, в которую добавляются параметры, которые потом будут +// посланы с оповещением. +// ИмяОбъектаОтправителяСообщения - Строка - имя объекта метаданных, для формы которого обрабатывается событие. +// ПосылатьОповещение - Булево - признак необходимости отправки оповещения из этой процедуры. +// +Процедура ВзаимодействиеПредметПослеЗаписи(Форма,Объект,ПараметрыЗаписи,ИмяОбъектаОтправителяСообщения = "",ПосылатьОповещение = Истина) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияКлиент.ВзаимодействиеПредметПослеЗаписи(Форма, Объект, ПараметрыЗаписи, ИмяОбъектаОтправителяСообщения, ПосылатьОповещение); +``` +
+ +## СписокПредметПроверкаПеретаскивания +
+ +Описание, пример вызова + +```bsl + +// Обработчик для события формы ПроверкаПеретаскивания. Вызывается для списка предметов при перетаскивании в него взаимодействий. +// +// Параметры: +// Элемент - ТаблицаФормы - таблица, для которой обрабатывается событие. +// ПараметрыПеретаскивания - ПараметрыПеретаскивания - содержит перетаскиваемое значение, тип действия и возможные +// действия при перетаскивании. +// СтандартнаяОбработка - Булево - признак стандартной обработки события. +// СтрокаТаблицы - ДанныеФормыЭлементКоллекции - строка таблицы, над которой находится курсор. +// Поле - Поле - элемент управляемой формы, с которым связана данная колонка таблицы. +// +Процедура СписокПредметПроверкаПеретаскивания(Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка, СтрокаТаблицы, Поле) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияКлиент.СписокПредметПроверкаПеретаскивания(Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка, СтрокаТаблицы, Поле) +``` +
+ +## СписокПредметПеретаскивание +
+ +Описание, пример вызова + +```bsl + +// Обработчик для события формы Перетаскивание. Вызывается для списка предметов при перетаскивании в него взаимодействий. +// +// Параметры: +// Элемент - ТаблицаФормы - таблица, для которой обрабатывается событие. +// ПараметрыПеретаскивания - ПараметрыПеретаскивания - содержит перетаскиваемое значение, тип действия и возможные +// действия при перетаскивании. +// СтандартнаяОбработка - Булево - признак стандартной обработки события. +// СтрокаТаблицы - ДанныеФормыЭлементКоллекции - строка таблицы, над которой находится курсор. +// Поле - Поле - элемент управляемой формы, с которым связана данная колонка таблицы. +// +Процедура СписокПредметПеретаскивание(Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка, СтрокаТаблицы, Поле) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияКлиент.СписокПредметПеретаскивание(Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка, СтрокаТаблицы, Поле) +``` +
+ +## СохранитьПисьмоНаДиск +
+ +Описание, пример вызова + +```bsl + +// Сохраняет письмо на компьютер. +// +// Параметры: +// Письмо - ДокументСсылка.ЭлектронноеПисьмоВходящее +// - ДокументСсылка.ЭлектронноеПисьмоИсходящее - письмо, которое будет сохранено. +// УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор формы, из которой была вызвана команда сохранения. +// +Процедура СохранитьПисьмоНаДиск(Письмо, УникальныйИдентификатор) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияКлиент.СохранитьПисьмоНаДиск(Письмо, УникальныйИдентификатор) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВзаимодействияКлиентПереопределяемый.md b/src/content/docs/bsp/ВзаимодействияКлиентПереопределяемый.md new file mode 100644 index 0000000..c7d13d9 --- /dev/null +++ b/src/content/docs/bsp/ВзаимодействияКлиентПереопределяемый.md @@ -0,0 +1,52 @@ +--- +title: Взаимодействия клиент переопределяемый +slug: bsp/взаимодействия-клиент-переопределяемый +--- + + +## СоздатьКонтактНестандартнаяФорма +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВзаимодействияКлиентСерверПереопределяемый.ПриОпределенииВозможныхКонтактов. +// См. свойство ИмяФормыНовогоКонтакта параметра ТипыКонтактов. +// +// Вызывается при создании нового контакта. +// Используется, если для одного или нескольких видов контактов требуется, +// чтобы вместо основной формы при их создании открывалась другая форма. +// Например, это может быть форма помощника создания нового элемента справочника. +// +// Параметры: +// ТипКонтакта - Строка - имя справочника контакта. +// ПараметрФормы - Структура - параметр, который передается при открытии. +// +// Возвращаемое значение: +// Булево - Ложь, если открытие нестандартной формы не выполнено, Истина в обратном случае. +// +// Пример: +// Если ТипКонтакта = "Партнеры" Тогда +// ОткрытьФорму("Справочник.Партнеры.Форма.ПомощникНового", ПараметрФормы); +// Возврат Истина; +// КонецЕсли; +// +// Возврат Ложь; +// +Функция СоздатьКонтактНестандартнаяФорма(ТипКонтакта, ПараметрФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаимодействияКлиентПереопределяемый.СоздатьКонтактНестандартнаяФорма(ТипКонтакта, ПараметрФормы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВзаимодействияКлиентСервер.md b/src/content/docs/bsp/ВзаимодействияКлиентСервер.md new file mode 100644 index 0000000..9671da4 --- /dev/null +++ b/src/content/docs/bsp/ВзаимодействияКлиентСервер.md @@ -0,0 +1,90 @@ +--- +title: Взаимодействия клиент сервер +slug: bsp/взаимодействия-клиент-сервер +--- + + +## НовоеОписаниеКонтакта +
+ +Описание, пример вызова + +```bsl + +// Возвращает новое описание контакта взаимодействий. +// Для использования в ВзаимодействияКлиентСерверПереопределяемый.ПриОпределенииВозможныхКонтактов. +// +// Возвращаемое значение: +// Структура - свойства контакта взаимодействий: +// * Тип - Тип - тип ссылки контакта. +// * Имя - Строка - имя типа контакта , как оно определено в метаданных. +// * Представление - Строка - представление типа контакта для отображения пользователю. +// * Иерархический - Булево - признак того, является ли справочник иерархическим. +// * ЕстьВладелец - Булево - признак того, что у контакта есть владелец. +// * ИмяВладельца - Строка - имя владельца контакта, как оно определено в метаданных. +// * ИскатьПоДомену - Булево - признак того, что контакты данного типа будет подбираться +// по совпадению домена, а не по полному адресу электронной почты. +// * Связь - Строка - описывает возможную связь данного контакта с другим контактом, в +// случае когда текущий контакт является реквизитом другого контакта. +// Описывается следующей строкой "ИмяТаблицы.ИмяРеквизита". +// * ИмяРеквизитаПредставлениеКонтакта - Строка - имя реквизита контакта, из которого будет получено +// представление контакта. Если не указано, то используется +// стандартный реквизит Наименование. +// * ВозможностьИнтерактивногоСоздания - Булево - признак возможности интерактивного создания контакта из +// документов - взаимодействий. +// * ИмяФормыНовогоКонтакта - Строка - полное имя формы для создания нового контакта, +// например, "Справочник.Партнеры.Форма.ПомощникНового". +// Если не заполнено, то открывается форма элемента по умолчанию. +// +Функция НовоеОписаниеКонтакта() Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаимодействияКлиентСервер.НовоеОписаниеКонтакта() +``` +
+ +## ДобавитьЭлементМассиваОписанияВозможныхТиповКонтактов +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВзаимодействияКлиентСервер.НовоеОписаниеКонтакта. +// Добавляет элемент в массив структур контакта. +// +// Параметры: +// МассивОписания - Массив - массив, в который будут добавлена структура описания контакта. +// Тип - Тип - тип ссылки контакта. +// ВозможностьИнтерактивногоСоздания - Булево - признак возможности интерактивного создания контакта из документов - +// взаимодействий. +// Имя - Строка - имя типа контакта , как оно определено в метаданных. +// Представление - Строка - представление типа контакта для отображения пользователю. +// Иерархический - Булево - признак того, является ли справочник иерархическим. +// ЕстьВладелец - Булево - признак того, что у контакта есть владелец. +// ИмяВладельца - Строка - имя владельца контакта, как оно определено в метаданных. +// ИскатьПоДомену - Булево - признак того, что по данному типу контакта будет осуществляться +// поиск по домену. +// Связь - Строка - описывает возможную связь данного контакта с другим контактом, в +// случае когда текущий контакт является реквизитом другого контакта. +// Описывается следующей строкой "ИмяТаблицы.ИмяРеквизита". +// ИмяРеквизитаПредставлениеКонтакта - Строка - имя реквизита контакта, из которого будет получено представление контакта. +// +Процедура ДобавитьЭлементМассиваОписанияВозможныхТиповКонтактов( Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияКлиентСервер.ДобавитьЭлементМассиваОписанияВозможныхТиповКонтактов(); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВзаимодействияКлиентСерверПереопределяемый.md b/src/content/docs/bsp/ВзаимодействияКлиентСерверПереопределяемый.md new file mode 100644 index 0000000..3e9933e --- /dev/null +++ b/src/content/docs/bsp/ВзаимодействияКлиентСерверПереопределяемый.md @@ -0,0 +1,78 @@ +--- +title: Взаимодействия клиент сервер переопределяемый +slug: bsp/взаимодействия-клиент-сервер-переопределяемый +--- + + +## ПриОпределенииВозможныхПредметов +
+ +Описание, пример вызова + +```bsl + +// Задает типы предметов взаимодействий, например: заказы, вакансии и т.п. +// Используется, если в конфигурации определен хотя бы один предмет взаимодействий. +// +// Параметры: +// ТипыПредметов - Массив - предметы взаимодействий (Строка), +// например, "ДокументСсылка.ЗаказПокупателя" и т.п. +// +Процедура ПриОпределенииВозможныхПредметов(ТипыПредметов) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияКлиентСерверПереопределяемый.ПриОпределенииВозможныхПредметов(ТипыПредметов) +``` +
+ +## ПриОпределенииВозможныхКонтактов +
+ +Описание, пример вызова + +```bsl + +// Задает описания возможных типов контактов взаимодействий, например: партнеры, контактные лица и т.п. +// Используется, если в конфигурации определен хотя бы один тип контактов взаимодействий, +// помимо справочника Пользователи. +// +// Параметры: +// ТипыКонтактов - Массив - содержит описания типов контактов взаимодействий (Структура) и их свойства: +// * Тип - Тип - тип ссылки контакта. +// * Имя - Строка - имя типа контакта , как оно определено в метаданных. +// * Представление - Строка - представление типа контакта для отображения пользователю. +// * Иерархический - Булево - признак того, является ли справочник иерархическим. +// * ЕстьВладелец - Булево - признак того, что у контакта есть владелец. +// * ИмяВладельца - Строка - имя владельца контакта, как оно определено в метаданных. +// * ИскатьПоДомену - Булево - признак того, что контакты данного типа будет подбираться +// по совпадению домена, а не по полному адресу электронной почты. +// * Связь - Строка - описывает возможную связь данного контакта с другим контактом, в +// случае когда текущий контакт является реквизитом другого контакта. +// Описывается следующей строкой "ИмяТаблицы.ИмяРеквизита". +// * ИмяРеквизитаПредставлениеКонтакта - Строка - имя реквизита контакта, из которого будет получено +// представление контакта. Если не указано, то используется +// стандартный реквизит Наименование. +// * ВозможностьИнтерактивногоСоздания - Булево - признак возможности интерактивного создания контакта из +// документов - взаимодействий. +// * ИмяФормыНовогоКонтакта - Строка - полное имя формы для создания нового контакта. +// Например, "Справочник.Партнеры.Форма.ПомощникНового". +// Если не заполнено, то открывается форма элемента по умолчанию. +// +Процедура ПриОпределенииВозможныхКонтактов(ТипыКонтактов) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияКлиентСерверПереопределяемый.ПриОпределенииВозможныхКонтактов(ТипыКонтактов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВзаимодействияЛокализация.md b/src/content/docs/bsp/ВзаимодействияЛокализация.md new file mode 100644 index 0000000..ac26fe0 --- /dev/null +++ b/src/content/docs/bsp/ВзаимодействияЛокализация.md @@ -0,0 +1,83 @@ +--- +title: Взаимодействия локализация +slug: bsp/взаимодействия-локализация +--- + + +## ПриФорматированииТелефонногоНомераДляОтправки +
+ +Описание, пример вызова + +```bsl + +// Возможность преобразовать указанный пользователем телефонный номер, в формат, который принимает провайдер отправки SMS +// +// Параметры: +// Номер - Строка - телефонный номер, указанный пользователем, +// НомерДляОтправки - Строка - в данный параметр помещается результат преобразования +// +Процедура ПриФорматированииТелефонногоНомераДляОтправки(Номер, НомерДляОтправки) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияЛокализация.ПриФорматированииТелефонногоНомераДляОтправки(Номер, НомерДляОтправки) +``` +
+ +## ПриОпределенииИгнорируемыхИменПапокПриЗагрузкеПисем +
+ +Описание, пример вызова + +```bsl + +// Возможность дополнить массив имен папок, которые будут игнорироваться при загрузке писем с почтового сервера по +// протоколу IMAP. +// +// Параметры: +// ИменаПапок - Массив из Строка - массив имен игнорируемых папок. +// +Процедура ПриОпределенииИгнорируемыхИменПапокПриЗагрузкеПисем(ИменаПапок) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияЛокализация.ПриОпределенииИгнорируемыхИменПапокПриЗагрузкеПисем(ИменаПапок) +``` +
+ +## ПриОпределенииСинонимовДоменовЭлектроннойПочты +
+ +Описание, пример вызова + +```bsl + +// Дополняет соответствие идентичных (подменяемых) доменов электронной почты. +// Используется при определении того, что письмо отправлено на почтовый ящик отправителя. +// Может потребоваться при загрузке исходящего письма по протоколу IMAP. +// При отправке такого письма почтовый сервер мог указать в адресе отправителя другой домен. +// +// Параметры: +// СинонимыДоменовЭлектроннойПочты - Соответствие из КлючИЗначение: +// * Ключ - имя, которое нужно заменить +// * Значение - имя домена, на который нужно заменить +// +Процедура ПриОпределенииСинонимовДоменовЭлектроннойПочты(СинонимыДоменовЭлектроннойПочты) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияЛокализация.ПриОпределенииСинонимовДоменовЭлектроннойПочты(СинонимыДоменовЭлектроннойПочты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВзаимодействияПереопределяемый.md b/src/content/docs/bsp/ВзаимодействияПереопределяемый.md new file mode 100644 index 0000000..4a0d093 --- /dev/null +++ b/src/content/docs/bsp/ВзаимодействияПереопределяемый.md @@ -0,0 +1,154 @@ +--- +title: Взаимодействия переопределяемый +slug: bsp/взаимодействия-переопределяемый +--- + + +## ПриПоискеКонтактов +
+ +Описание, пример вызова + +```bsl + +// Вызывается для получения контактов (участников) по указанному предмету взаимодействия. +// Используется, если в конфигурации определен хотя бы один предмет взаимодействий. +// +// Параметры: +// ИмяТаблицыКонтактов - Строка - имя таблицы предмета взаимодействий, в котором требуется выполнить поиск. +// Например, "Документы.ЗаказПокупателя". +// ТекстЗапросаДляПоиска - Строка - в этот параметр указать фрагмент запроса для поиска. При выполнении запроса +// в параметр запроса &Предмет подставляется ссылка на предмет взаимодействия. +// +Процедура ПриПоискеКонтактов(Знач ИмяТаблицыКонтактов, ТекстЗапросаДляПоиска) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияПереопределяемый.ПриПоискеКонтактов(ИмяТаблицыКонтактов, ТекстЗапросаДляПоиска) +``` +
+ +## ПриПолученииПрисоединенныхФайлов +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить владельца присоединенных файлов для письма. +// Такая необходимость может возникнуть, например, при массовых рассылках, когда имеет смысл +// хранить одни и те же присоединенные файлы в одном месте, а не тиражировать их на все письма рассылки. +// +// Параметры: +// Письмо - ДокументСсылка.ЭлектронноеПисьмоВходящее +// - ДокументСсылка.ЭлектронноеПисьмоИсходящее - электронное письмо, +// для которого необходимо получить вложения. +// ПрисоединенныеФайлы - Структура - задать сведения о файлах, присоединенных к письму: +// * ВладелецФайлов - ОпределяемыйТип.ПрисоединенныйФайл - владелец присоединенных файлов. +// * ИмяСправочникаПрисоединенныхФайлов - Строка - имя объекта метаданных присоединенных файлов. +// +Процедура ПриПолученииПрисоединенныхФайлов(Письмо, ПрисоединенныеФайлы) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияПереопределяемый.ПриПолученииПрисоединенныхФайлов(Письмо, ПрисоединенныеФайлы) +``` +
+ +## ПриЗаполненииНаборовЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Вызывается для настройки логики ограничения доступа к взаимодействиям. +// Пример заполнения наборов значений доступа см. в комментарии +// к процедуре УправлениеДоступом.ЗаполнитьНаборыЗначенийДоступа. +// +// Параметры: +// Объект - ДокументОбъект.Встреча +// - ДокументОбъект.ЗапланированноеВзаимодействие +// - ДокументОбъект.СообщениеSMS +// - ДокументОбъект.ТелефонныйЗвонок +// - ДокументОбъект.ЭлектронноеПисьмоВходящее +// - ДокументОбъект.ЭлектронноеПисьмоИсходящее - объект, для которого нужно заполнить наборы. +// Таблица - см. УправлениеДоступом.ТаблицаНаборыЗначенийДоступа +// +Процедура ПриЗаполненииНаборовЗначенийДоступа(Объект, Таблица) Экспорт +``` + +Пример вызова +```bsl +ВзаимодействияПереопределяемый.ПриЗаполненииНаборовЗначенийДоступа(Объект, Таблица) +``` +
+ +## ТекстЗапросаПоискКонтактовПоПредмету +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВзаимодействияПереопределяемый.ПриПоискеКонтактов. +// Возвращает текст запроса, отбирающего контакты (участников) предмета взаимодействия. +// Используется, если в конфигурации определен хотя бы один предмет взаимодействий. +// +// Параметры: +// УдалитьПомещатьВоВременнуюТаблицу - Булево - всегда Ложь. +// ИмяТаблицы - Строка - имя таблицы предмета взаимодействий, в котором будет выполнен поиск. +// УдалитьОбъединить - Булево - всегда Истина. +// +// Возвращаемое значение: +// Строка - текст запроса. +// +Функция ТекстЗапросаПоискКонтактовПоПредмету(УдалитьПомещатьВоВременнуюТаблицу, ИмяТаблицы, УдалитьОбъединить = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаимодействияПереопределяемый.ТекстЗапросаПоискКонтактовПоПредмету(УдалитьПомещатьВоВременнуюТаблицу, ИмяТаблицы, УдалитьОбъединить); +``` +
+ +## ДанныеОбъектаМетаданныхПрисоединенныхФайловПисьма +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВзаимодействияПереопределяемый.ПриПолученииПрисоединенныхФайлов. +// Возможность переопределить владельца присоединенных файлов для письма. +// Такая необходимость может возникнуть например при массовых рассылках. В этом случае имеет смысл +// хранить одни и те же присоединенные файлы в одном месте, а не тиражировать их на все письма рассылки. +// +// Параметры: +// Письмо - ДокументСсылка +// - ДокументОбъект - документ электронное письмо, для которого необходимо получить вложения. +// +// Возвращаемое значение: +// Структура, Неопределено - Неопределено, если присоединенные файлы хранятся при письме. +// Структура, если присоединенные файлы хранятся в другом объекте: +// * Владелец - ОпределяемыйТип.ПрисоединенныйФайл - владелец присоединенных файлов. +// * ИмяСправочникаПрисоединенныеФайлы - Строка - имя объекта метаданных присоединенных файлов. +// +Функция ДанныеОбъектаМетаданныхПрисоединенныхФайловПисьма(Письмо) Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаимодействияПереопределяемый.ДанныеОбъектаМетаданныхПрисоединенныхФайловПисьма(Письмо) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВидыПриложенийПереопределяемый.md b/src/content/docs/bsp/ВидыПриложенийПереопределяемый.md new file mode 100644 index 0000000..1159445 --- /dev/null +++ b/src/content/docs/bsp/ВидыПриложенийПереопределяемый.md @@ -0,0 +1,277 @@ +--- +title: Виды приложений переопределяемый +slug: bsp/виды-приложений-переопределяемый +--- + + +## ПриОпределенииВидовПриложенийКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Формирует таблицу видов приложений конфигурации. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ВидыПриложений - см. ВидыПриложенийСервер.НоваяТаблицаВидовПриложений. +// +Процедура ПриОпределенииВидовПриложенийКонфигурации(ВидыПриложений) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПриОпределенииВидовПриложенийКонфигурации(ВидыПриложений) +``` +
+ +## ПриОпределенииДопСвойствБазовогоВидаПриложения +
+ +Описание, пример вызова + +```bsl + +// Определяет дополнительные свойства базового вида приложения +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ДополнительныеСвойства - Структура. +// +Процедура ПриОпределенииДопСвойствБазовогоВидаПриложения(ДополнительныеСвойства) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПриОпределенииДопСвойствБазовогоВидаПриложения(ДополнительныеСвойства) +``` +
+ +## ПриОпределенииВидаПриложенияПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Возвращает вид приложения, который будет установлен по умолчанию, +// если, например, не удалось определить вид приложения по имени или услугам. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ВидПриложения - Структура - см. ВидыПриложенийСервер.НовыйВидПриложения (возвращаемые данные). +// +Процедура ПриОпределенииВидаПриложенияПоУмолчанию(ВидПриложения) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПриОпределенииВидаПриложенияПоУмолчанию(ВидПриложения) +``` +
+ +## ПриДобавленииОбработчиковПереходаВидовПриложений +
+ +Описание, пример вызова + +```bsl + +// Добавляет в таблицу процедуры-обработчики перехода от одного вида приложения к другому. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Обработчики - ТаблицаЗначений: +// * ИсходноеИмяВидаПриложения - Строка - имя вида приложения, с которого выполняется переход. +// * ИмяВидаПриложения - Строка - имя вида приложения, на который выполняется переход. +// * Процедура - Строка - полное имя процедуры-обработчика перехода. +// Обязательно должна быть экспортной. +// Примечание: +// Если отсутствует хотя бы один обработчик с предыдущего до целевого вида приложения, переход будет невозможен +// +Процедура ПриДобавленииОбработчиковПереходаВидовПриложений(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПриДобавленииОбработчиковПереходаВидовПриложений(Обработчики) +``` +
+ +## ПриУстановкеБазовогоВидаПриложения +
+ +Описание, пример вызова + +```bsl + +// Вызывается при установке базового вида приложения. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки. По умолчанию = Ложь. +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПриУстановкеБазовогоВидаПриложения(РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПриУстановкеБазовогоВидаПриложения(РезультатОбработки) +``` +
+ +## ПриОтменеУстановкиБазовогоВидаПриложения +
+ +Описание, пример вызова + +```bsl + +// Вызывается при отмене установки базового вида приложения. +// Отмена установки базового вида приложения происходит, если выполняется установка постоянного вида приложения. +// Процедура должна вернуть данные, измененные при установке базового вида приложения, в исходное состояние. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки. По умолчанию = Ложь. +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПриОтменеУстановкиБазовогоВидаПриложения(РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПриОтменеУстановкиБазовогоВидаПриложения(РезультатОбработки) +``` +
+ +## ПослеУстановкиВидаПриложения +
+ +Описание, пример вызова + +```bsl + +// Вызывается после установки вида приложения. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ВидПриложения - Строка - имя вида приложения. +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки. По умолчанию = Ложь. +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПослеУстановкиВидаПриложения(ВидПриложения, РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПослеУстановкиВидаПриложения(ВидПриложения, РезультатОбработки) +``` +
+ +## ПередПереходомНаВидПриложения +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед процедурами-обработчиками перехода на новый вид приложения. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ВидПриложения - Строка - имя вида приложения, с которого выполняется переход. +// ЦелевойВидПриложения - Строка - имя вида приложения, на который выполняется переход. +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки. По умолчанию = Ложь. +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПередПереходомНаВидПриложения(ВидПриложения, ЦелевойВидПриложения, РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПередПереходомНаВидПриложения(ВидПриложения, ЦелевойВидПриложения, РезультатОбработки) +``` +
+ +## ПослеПереходаНаВидПриложения +
+ +Описание, пример вызова + +```bsl + +// Вызывается после завершения перехода на новый вид приложения. +// @skip-warning ПустойМетод - переопределяемый метод. +// Параметры: +// ВидПриложения - Строка - имя вида приложения, с которого выполнен переход. +// ЦелевойВидПриложения - Строка - имя вида приложения, на который выполнен переход. +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки. По умолчанию = Ложь. +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПослеПереходаНаВидПриложения(ВидПриложения, ЦелевойВидПриложения, РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПослеПереходаНаВидПриложения(ВидПриложения, ЦелевойВидПриложения, РезультатОбработки) +``` +
+ +## ПриОпределенииПараметровУведомления +
+ +Описание, пример вызова + +```bsl + +// Определяет параметры уведомления об обновлении вида приложения. +// @skip-warning ПустойМетод - переопределяемый метод. +// Параметры: +// ПараметрыУведомления - см. ВидыПриложенийСервер.НовыйПараметрыУведомленияОбОбновлении. +// +Процедура ПриОпределенииПараметровУведомления(ПараметрыУведомления) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПриОпределенииПараметровУведомления(ПараметрыУведомления) +``` +
+ +## ПриОпределенииИменРасширенийВидовПриложений +
+ +Описание, пример вызова + +```bsl + +// Определяет массив имен расширений видов приложений, которые будут исключены из выгрузки +// +// @skip-warning ПустойМетод - переопределяемый метод. +// Параметры: +// ИменаРасширений - Массив из Строка +// +Процедура ПриОпределенииИменРасширенийВидовПриложений(ИменаРасширений) Экспорт +``` + +Пример вызова +```bsl +ВидыПриложенийПереопределяемый.ПриОпределенииИменРасширенийВидовПриложений(ИменаРасширений) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВидыПриложенийСервер.md b/src/content/docs/bsp/ВидыПриложенийСервер.md new file mode 100644 index 0000000..19c3fae --- /dev/null +++ b/src/content/docs/bsp/ВидыПриложенийСервер.md @@ -0,0 +1,233 @@ +--- +title: Виды приложений сервер +slug: bsp/виды-приложений-сервер +--- + + +## ВидыПриложенийКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу видов приложений конфигурации. +// +// Параметры: +// ВключаяБазовый - Булево - Истина, если нужно включать базовый вид приложения в таблицу. +// По умолчанию = Истина. +// +// Возвращаемое значение: +// ТаблицаЗначений - см. НоваяТаблицаВидовПриложений +// +Функция ВидыПриложенийКонфигурации(ВключаяБазовый = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ВидыПриложенийСервер.ВидыПриложенийКонфигурации(ВключаяБазовый); +``` +
+ +## ОбработчикиПереходов +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу обработчиков переходов видов приложений конфигурации +// +// Возвращаемое значение: +// ТаблицаЗначений - см. НоваяТаблицаОбработчиковПерехода +// +Функция ОбработчикиПереходов() Экспорт +``` + +Пример вызова +```bsl +Результат = ВидыПриложенийСервер.ОбработчикиПереходов() +``` +
+ +## ОбработчикиПереходаВидаПриложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу обработчиков перехода с вида приложения +// +// Параметры: +// ИсходноеИмяВидаПриложения - Строка - имя предыдущего вида приложения +// ИмяВидаПриложения - Строка, Неопределено - имя нового вида приложения. Неопределено - если новый вид приложения любой. +// По умолчанию, Неопределено +// +// Возвращаемое значение: +// ТаблицаЗначений - см. НоваяТаблицаОбработчиковПерехода +// +Функция ОбработчикиПереходаВидаПриложения(ИсходноеИмяВидаПриложения, ИмяВидаПриложения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ВидыПриложенийСервер.ОбработчикиПереходаВидаПриложения(ИсходноеИмяВидаПриложения, ИмяВидаПриложения); +``` +
+ +## ИмяТекущегоВидаПриложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя вида приложения конфигурации, автономного рабочего места (АРМ) или области данных, если включено разделение +// +// Возвращаемое значение: +// Строка - имя текущего вида приложения +// +// Примечание: +// Имя вида приложения для АРМ может отличаться от итогового, если обращение к функции было до завершения загрузки данных в АРМ +// +Функция ИмяТекущегоВидаПриложения() Экспорт +``` + +Пример вызова +```bsl +Результат = ВидыПриложенийСервер.ИмяТекущегоВидаПриложения() +``` +
+ +## ПредставлениеТекущегоВидаПриложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление вида приложения конфигурации, автономного рабочего места (АРМ) или области данных, если включено разделение +// +// Возвращаемое значение: +// Строка - представление вида приложения +// +// Примечание: +// Представление вида приложения для АРМ может отличаться от итогового, если обращение к функции было до завершения загрузки данных в АРМ +// +Функция ПредставлениеТекущегоВидаПриложения() Экспорт +``` + +Пример вызова +```bsl +Результат = ВидыПриложенийСервер.ПредставлениеТекущегоВидаПриложения() +``` +
+ +## СвойстваВидаПриложенияПоИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства вида приложения по имени. +// +// Параметры: +// Имя - Строка - имя вида приложения, свойства которого нужно получить. +// ВызыватьИсключение - Булево - если Ложь, то в случае отсутствия свойств вида приложения по имени +// исключение не будет вызвано. По умолчанию = Истина. +// +// Возвращаемое значение: +// Неопределено, ФиксированнаяСтруктура - Свойства вида приложения. +// Если свойства не найдены и ВызыватьИсключение = Ложь, возвращается Неопределено. +// Состав свойств см. в ВидыПриложенийСервер.НовыйВидПриложения. +// +Функция СвойстваВидаПриложенияПоИмени(Имя, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ВидыПриложенийСервер.СвойстваВидаПриложенияПоИмени(Имя, ВызыватьИсключение); +``` +
+ +## СвойстваВидаПриложенияПоУслугам +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства вида приложения по услугам. +// Поиск происходит по полному соответствию услуг в переданном параметре и описании вида приложения +// +// Параметры: +// Услуги - ТаблицаЗначений - описание см.НоваяТаблицаУслуг +// ВызыватьИсключение - Булево - если Ложь, то в случае отсутствия свойств вида приложения по услугам +// исключение не будет вызвано. По умолчанию, Истина. +// +// Возвращаемое значение: +// Неопределено, ФиксированнаяСтруктура - Свойства вида приложения. +// Если свойства не найдены и ВызыватьИсключение = Ложь, возвращается Неопределено. +// Состав свойств см. в ВидыПриложенийСервер.НовыйВидПриложения. +// +Функция СвойстваВидаПриложенияПоУслугам(Услуги, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ВидыПриложенийСервер.СвойстваВидаПриложенияПоУслугам(Услуги, ВызыватьИсключение); +``` +
+ +## БазовыйВидПриложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает вид приложения, соответствующий конфигурации. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - см. НовыйВидПриложения +// +Функция БазовыйВидПриложения() Экспорт +``` + +Пример вызова +```bsl +Результат = ВидыПриложенийСервер.БазовыйВидПриложения() +``` +
+ +## ВидПриложенияПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Возвращает вид приложения, который будет установлен по умолчанию, +// если, например, не удалось определить вид приложения по имени или услугам. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - см. НовыйВидПриложения +// +Функция ВидПриложенияПоУмолчанию() Экспорт +``` + +Пример вызова +```bsl +Результат = ВидыПриложенийСервер.ВидПриложенияПоУмолчанию() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВнешниеКомпонентыВызовСервера.md b/src/content/docs/bsp/ВнешниеКомпонентыВызовСервера.md new file mode 100644 index 0000000..6dfc43a --- /dev/null +++ b/src/content/docs/bsp/ВнешниеКомпонентыВызовСервера.md @@ -0,0 +1,57 @@ +--- +title: Внешние компоненты вызов сервера +slug: bsp/внешние-компоненты-вызов-сервера +--- + + +## ИнформацияОКомпоненте +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВнешниеКомпонентыСервер.ИнформацияОКомпоненте. +// Возвращает информацию о внешней компоненте по идентификатору и версии. +// +// Параметры: +// Идентификатор - Строка - идентификатор объекта внешней компоненты. +// Версия - Строка - версия компоненты. +// +// Возвращаемое значение: +// Структура: +// * Существует - Булево - признак отсутствия компоненты. +// * ДоступноРедактирование - Булево - признак того, что компоненту может изменить администратор области. +// * ОписаниеОшибки - Строка - краткое описание ошибки. +// * Идентификатор - Строка - идентификатор объекта внешней компоненты. +// * Версия - Строка - версия компоненты. +// * Наименование - Строка - наименование и краткая информация о компоненте. +// +// Пример: +// +// Результат = ВнешниеКомпонентыВызовСервера.ИнформацияОКомпоненте("InputDevice", "8.1.7.10"); +// +// Если Результат.Существует Тогда +// Идентификатор = Результат.Идентификатор; +// Версия = Результат.Версия; +// Наименование = Результат.Наименование; +// Иначе +// ОбщегоНазначенияКлиентСервер.СообщитьПользователю(Результат.ОписаниеОшибки); +// КонецЕсли; +// +Функция ИнформацияОКомпоненте(Знач Идентификатор, Знач Версия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеКомпонентыВызовСервера.ИнформацияОКомпоненте(Идентификатор, Версия); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВнешниеКомпонентыКлиент.md b/src/content/docs/bsp/ВнешниеКомпонентыКлиент.md new file mode 100644 index 0000000..a6f73c4 --- /dev/null +++ b/src/content/docs/bsp/ВнешниеКомпонентыКлиент.md @@ -0,0 +1,371 @@ +--- +title: Внешние компоненты клиент +slug: bsp/внешние-компоненты-клиент +--- + + +## ПараметрыПодключения +
+ +Описание, пример вызова + +```bsl + +// Параметры для вызова процедуры ВнешниеКомпонентыКлиент.ПодключитьКомпоненту. +// +// Возвращаемое значение: +// Структура: +// * Кэшировать - Булево - (по умолчанию Истина) использовать механизм кэширования компонент на клиенте. +// * ПредложитьУстановить - Булево - (по умолчанию Истина) предлагать устанавливать компоненту. +// * ПредложитьЗагрузить - Булево - (по умолчанию Истина) предлагать загрузить компоненту с сайта ИТС. +// * ТекстПояснения - Строка - для чего нужна компонента и что не будет работать, если ее не устанавливать. +// * ИдентификаторыСозданияОбъектов - Массив - массив строк идентификаторов создания экземпляров модуля объекта, +// используется только для компонент, у которых есть несколько идентификаторов создания объектов, +// при задании параметр Идентификатор будет использоваться только для определения компоненты. +// * Изолированно - Булево, Неопределено - (по умолчанию Неопределено) если Истина, компонента будет подключена +// изолированно, в этом случае внешняя компонента загружается в отдельный процесс операционной системы; +// Ложь - в этом случае внешняя компонента будет выполняться в том же процессе операционной системы, +// который выполняет код встроенного языка; Неопределено - поддерживается поведение платформы по умолчанию: +// изолированно - если компонентой поддерживается только этот режим, не изолированно - в остальных случаях. +// См. https://its.1c.eu/db/v83doc#bookmark:dev:TI000001866 +// * ОбновлятьАвтоматически - Булево - (по умолчанию Истина) при загрузке внешней компоненты устанавливать +// признак ОбновлятьСПортала1СИТС +// +// Пример: +// +// ПараметрыПодключения = ВнешниеКомпонентыКлиент.ПараметрыПодключения(); +// ПараметрыПодключения.ТекстПояснения = +// НСтр("ru = 'Для использования сканера штрихкодов требуется +// |внешняя компонента ""1С:Сканеры штрихкода (NativeApi)"".'"); +// +Функция ПараметрыПодключения() Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеКомпонентыКлиент.ПараметрыПодключения() +``` +
+ +## ПодключитьКомпоненту +
+ +Описание, пример вызова + +```bsl + +// Подключает компоненту, выполненную по технологии Native API или COM на клиентском компьютере. +// Для веб-клиента предлагается диалог, подсказывающий пользователю действия по установке. +// Выполняет проверку возможности исполнения компоненты на текущем клиенте пользователя. +// +// Параметры: +// Оповещение - ОписаниеОповещения - описание оповещения о подключении со следующими параметрами: +// * Результат - Структура - результат подключения компоненты: +// ** Подключено - Булево - признак подключения; +// ** ПодключаемыйМодуль - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты; +// - ФиксированноеСоответствие из КлючИЗначение - экземпляры объектов внешней компоненты, +// указанные в ПараметрыПодключения.ИдентификаторыСозданияОбъектов: +// *** Ключ - Строка - идентификатор внешней компоненты; +// *** Значение - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты. +// ** ОписаниеОшибки - Строка - краткое описание ошибки. При отмене пользователем пустая строка. +// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения. +// Идентификатор - Строка - идентификатор объекта внешней компоненты. +// Версия - Строка - версия компоненты. +// ПараметрыПодключения - см. ВнешниеКомпонентыКлиент.ПараметрыПодключения. +// +// Пример: +// +// Оповещение = Новый ОписаниеОповещения("ПодключитьКомпонентуЗавершение", ЭтотОбъект); +// +// ПараметрыПодключения = ВнешниеКомпонентыКлиент.ПараметрыПодключения(); +// ПараметрыПодключения.ТекстПояснения = +// НСтр("ru = 'Для использования сканера штрихкодов требуется +// |внешняя компонента ""1С:Сканеры штрихкода (NativeApi)"".'"); +// +// ВнешниеКомпонентыКлиент.ПодключитьКомпоненту(Оповещение, "InputDevice",, ПараметрыПодключения); +// +// &НаКлиенте +// Процедура ПодключитьКомпонентуЗавершение(Результат, ДополнительныеПараметры) Экспорт +// +// ПодключаемыйМодуль = Неопределено; +// +// Если Результат.Подключено Тогда +// ПодключаемыйМодуль = Результат.ПодключаемыйМодуль; +// Иначе +// Если Не ПустаяСтрока(Результат.ОписаниеОшибки) Тогда +// ПоказатьПредупреждение(, Результат.ОписаниеОшибки); +// КонецЕсли; +// КонецЕсли; +// +// Если ПодключаемыйМодуль <> Неопределено Тогда +// // ПодключаемыйМодуль содержит созданный экземпляр подключенной компоненты. +// КонецЕсли; +// +// ПодключаемыйМодуль = Неопределено; +// +// КонецПроцедуры +// +Процедура ПодключитьКомпоненту(Оповещение, Идентификатор, Версия = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ВнешниеКомпонентыКлиент.ПодключитьКомпоненту(Оповещение, Идентификатор, Версия, ); +``` +
+ +## ПодключитьКомпонентуИзРеестраWindows +
+ +Описание, пример вызова + +```bsl + +// Подключает компоненту, выполненную по технологии COM, из реестра Windows в асинхронном режиме. +// (не рекомендуется, для обратной совместимости с компонентами 1С 7.7). +// +// Параметры: +// Оповещение - ОписаниеОповещения - описание оповещения о подключении со следующими параметрами: +// * Результат - Структура - результат подключения компоненты: +// ** Подключено - Булево - признак подключения. +// ** ПодключаемыйМодуль - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты. +// ** ОписаниеОшибки - Строка - краткое описание ошибки. +// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения. +// Идентификатор - Строка - идентификатор объекта внешней компоненты. +// ИдентификаторСозданияОбъекта - Строка - идентификатор создания экземпляра модуля объекта +// (только для компонент, у которых идентификатор создания объекта отличается от ProgID). +// +// Пример: +// +// Оповещение = Новый ОписаниеОповещения("ПодключитьКомпонентуЗавершение", ЭтотОбъект); +// ВнешниеКомпонентыКлиент.ПодключитьКомпонентуИзРеестраWindows(Оповещение, "SBRFCOMObject", "SBRFCOMExtension"); +// +// &НаКлиенте +// Процедура ПодключитьКомпонентуЗавершение(Результат, ДополнительныеПараметры) Экспорт +// +// ПодключаемыйМодуль = Неопределено; +// +// Если Результат.Подключено Тогда +// ПодключаемыйМодуль = Результат.ПодключаемыйМодуль; +// Иначе +// ПоказатьПредупреждение(, Результат.ОписаниеОшибки); +// КонецЕсли; +// +// Если ПодключаемыйМодуль <> Неопределено Тогда +// // ПодключаемыйМодуль содержит созданный экземпляр подключенной компоненты. +// КонецЕсли; +// +// ПодключаемыйМодуль = Неопределено; +// +// КонецПроцедуры +// +Процедура ПодключитьКомпонентуИзРеестраWindows(Оповещение, Идентификатор, Экспорт +``` + +Пример вызова +```bsl +ВнешниеКомпонентыКлиент.ПодключитьКомпонентуИзРеестраWindows(Оповещение, Идентификатор, ); +``` +
+ +## ПараметрыУстановки +
+ +Описание, пример вызова + +```bsl + +// Структура параметров для процедуры ВнешниеКомпонентыКлиент.УстановитьКомпоненту. +// +// Возвращаемое значение: +// Структура: +// * ТекстПояснения - Строка - для чего нужна компонента и что не будет работать, если ее не устанавливать. +// * ПредложитьЗагрузить - Булево - предложить загрузить компоненту с сайта ИТС +// * ПредложитьУстановить - Булево - (по умолчанию Ложь) предлагать устанавливать компоненту. +// +// Пример: +// +// ПараметрыУстановки = ВнешниеКомпонентыКлиент.ПараметрыУстановки(); +// ПараметрыУстановки.ТекстПояснения = +// НСтр("ru = 'Для использования сканера штрихкодов требуется +// |внешняя компонента ""1С:Сканеры штрихкода (NativeApi)"".'"); +// +Функция ПараметрыУстановки() Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеКомпонентыКлиент.ПараметрыУстановки() +``` +
+ +## УстановитьКомпоненту +
+ +Описание, пример вызова + +```bsl + +// Устанавливает компоненту, выполненную по технологии Native API и COM асинхронном режиме. +// Выполняет проверку возможности исполнения компоненты на текущем клиенте пользователя. +// +// Параметры: +// Оповещение - ОписаниеОповещения - описание оповещения об установке внешней компоненты: +// * Результат - Структура - результат установки компоненты: +// ** Установлено - Булево - признак установки. +// ** ОписаниеОшибки - Строка - краткое описание ошибки. При отмене пользователем пустая строка. +// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения. +// Идентификатор - Строка - идентификатор объекта внешней компоненты. +// Версия - Строка - версия компоненты. +// ПараметрыУстановки - см. ПараметрыУстановки. +// +// Пример: +// +// Оповещение = Новый ОписаниеОповещения("УстановитьКомпонентуЗавершение", ЭтотОбъект); +// +// ПараметрыУстановки = ВнешниеКомпонентыКлиент.ПараметрыУстановки(); +// ПараметрыУстановки.ТекстПояснения = +// НСтр("ru = 'Для использования сканера штрихкодов требуется +// |внешняя компонента ""1С:Сканеры штрихкода (NativeApi)"".'"); +// +// ВнешниеКомпонентыКлиент.УстановитьКомпоненту(Оповещение, "InputDevice",, ПараметрыУстановки); +// +// &НаКлиенте +// Процедура УстановитьКомпонентуЗавершение(Результат, ДополнительныеПараметры) Экспорт +// +// Если Не Результат.Установлено И Не ПустаяСтрока(Результат.ОписаниеОшибки) Тогда +// ПоказатьПредупреждение(, Результат.ОписаниеОшибки); +// КонецЕсли; +// +// КонецПроцедуры +// +Процедура УстановитьКомпоненту(Оповещение, Идентификатор, Версия = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ВнешниеКомпонентыКлиент.УстановитьКомпоненту(Оповещение, Идентификатор, Версия, ); +``` +
+ +## ПараметрыПоискаДополнительнойИнформации +
+ +Описание, пример вызова + +```bsl + + +// Возвращает структуру параметров для описания правил поиска дополнительной информации в составе внешней компоненты, +// см. процедуру ЗагрузитьКомпонентуИзФайла. +// +// Возвращаемое значение: +// Структура: +// * ИмяФайлаXML - Строка - (необязательный) имя файла в составе компоненты, из которого будет извлечена информация. +// * ВыражениеXPath - Строка - (необязательный) XPath путь до информации в файле. +// +// Пример: +// +// ПараметрыЗагрузки = ВнешниеКомпонентыКлиент.ПараметрыПоискаДополнительнойИнформации(); +// ПараметрыЗагрузки.ИмяФайлаXML = "INFO.XML"; +// ПараметрыЗагрузки.ВыражениеXPath = "//drivers/component/@type"; +// +Функция ПараметрыПоискаДополнительнойИнформации() Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеКомпонентыКлиент.ПараметрыПоискаДополнительнойИнформации() +``` +
+ +## ПараметрыЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Структура параметров для процедуру ВнешниеКомпонентыКлиент.ЗагрузитьКомпонентуИзФайла. +// +// Возвращаемое значение: +// Структура: +// * Идентификатор - Строка -(необязательный) идентификатор объекта внешней компоненты. +// * Версия - Строка - (необязательный) версия компоненты. +// * ПараметрыПоискаДополнительнойИнформации - Соответствие из КлючИЗначение - (необязательный) параметры: +// ** Ключ - Строка - идентификатор дополнительной запрошенной информации. +// ** Значение - см. ПараметрыПоискаДополнительнойИнформации. +// Пример: +// +// ПараметрыЗагрузки = ВнешниеКомпонентыКлиент.ПараметрыЗагрузки(); +// ПараметрыЗагрузки.Идентификатор = "InputDevice"; +// ПараметрыЗагрузки.Версия = "8.1.7.10"; +// +Функция ПараметрыЗагрузки() Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеКомпонентыКлиент.ПараметрыЗагрузки() +``` +
+ +## ЗагрузитьКомпонентуИзФайла +
+ +Описание, пример вызова + +```bsl + +// Загружает файл компоненты в справочник внешних компонент в асинхронном режиме. +// +// Параметры: +// Оповещение - ОписаниеОповещения - описание оповещения об установке внешней компоненты: +// * Результат - Структура - результат загрузки компоненты: +// ** Загружена - Булево - признак загрузки. +// ** Идентификатор - Строка - идентификатор объекта внешней компоненты. +// ** Версия - Строка - версия загруженной компоненты. +// ** Наименование - Строка - наименование загруженной компоненты. +// ** ДополнительнаяИнформация - Соответствие из КлючИЗначение - дополнительная информация о компоненте, +// если не запрашивалась - пустое соответствие: +// *** Ключ - см. ПараметрыПоискаДополнительнойИнформации. +// *** Значение - см. ПараметрыПоискаДополнительнойИнформации. +// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения. +// ПараметрыЗагрузки - см. ПараметрыЗагрузки. +// +// Пример: +// +// ПараметрыЗагрузки = ВнешниеКомпонентыКлиент.ПараметрыЗагрузки(); +// ПараметрыЗагрузки.Идентификатор = "InputDevice"; +// ПараметрыЗагрузки.Версия = "8.1.7.10"; +// +// Оповещение = Новый ОписаниеОповещения("ЗагрузитьКомпонентуИзФайлаПослеЗагрузкиКомпоненты", ЭтотОбъект); +// +// ВнешниеКомпонентыКлиент.ЗагрузитьКомпонентуИзФайла(Оповещение, ПараметрыЗагрузки); +// +// &НаКлиенте +// Процедура ЗагрузитьКомпонентуИзФайлаПослеЗагрузкиКомпоненты(Результат, ДополнительныеПараметры) Экспорт +// +// Если Результат.Загружено Тогда +// Идентификатор = Результат.Идентификатор; +// Версия = Результат.Версия; +// КонецЕсли; +// +// КонецПроцедуры +// +Процедура ЗагрузитьКомпонентуИзФайла(Оповещение, ПараметрыЗагрузки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВнешниеКомпонентыКлиент.ЗагрузитьКомпонентуИзФайла(Оповещение, ПараметрыЗагрузки); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВнешниеКомпонентыКлиентЛокализация.md b/src/content/docs/bsp/ВнешниеКомпонентыКлиентЛокализация.md new file mode 100644 index 0000000..969dd6c --- /dev/null +++ b/src/content/docs/bsp/ВнешниеКомпонентыКлиентЛокализация.md @@ -0,0 +1,61 @@ +--- +title: Внешние компоненты клиент локализация +slug: bsp/внешние-компоненты-клиент-локализация +--- + + +## ПриПоискеКомпонентНаПортале +
+ +Описание, пример вызова + +```bsl + +// Вызывается для открытия формы поиска внешних компонент в Интернете. +// +// Параметры: +// Оповещение - ОписаниеОповещения +// Контекст - Структура: +// * ТекстПояснения - Строка +// * Идентификатор - Строка +// * Версия - Строка +// * ОбновлятьАвтоматически - Булево +// +Процедура ПриПоискеКомпонентНаПортале(Оповещение, Контекст) Экспорт +``` + +Пример вызова +```bsl +ВнешниеКомпонентыКлиентЛокализация.ПриПоискеКомпонентНаПортале(Оповещение, Контекст) +``` +
+ +## ПриОбновленииКомпонентСПортала +
+ +Описание, пример вызова + +```bsl + +// Вызывается для открытия формы обновление внешних компонент через Интернет. +// +// Параметры: +// Оповещение - ОписаниеОповещения +// ОбновляемыеКомпоненты - Массив из СправочникСсылка.ВнешниеКомпоненты +// +Процедура ПриОбновленииКомпонентСПортала(Оповещение, ОбновляемыеКомпоненты) Экспорт +``` + +Пример вызова +```bsl +ВнешниеКомпонентыКлиентЛокализация.ПриОбновленииКомпонентСПортала(Оповещение, ОбновляемыеКомпоненты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВнешниеКомпонентыСервер.md b/src/content/docs/bsp/ВнешниеКомпонентыСервер.md new file mode 100644 index 0000000..d04f10b --- /dev/null +++ b/src/content/docs/bsp/ВнешниеКомпонентыСервер.md @@ -0,0 +1,123 @@ +--- +title: Внешние компоненты сервер +slug: bsp/внешние-компоненты-сервер +--- + + +## ПараметрыПодключения +
+ +Описание, пример вызова + +```bsl + +// Параметры для вызова ВнешниеКомпонентыСервер.ПодключитьКомпоненту. +// +// Возвращаемое значение: +// Структура: +// * ИдентификаторыСозданияОбъектов - Массив из Строка - идентификаторы экземпляров модуля объекта, +// используется только для компонент, у которых есть несколько идентификаторов создания объектов. +// При задании параметр Идентификатор будет использоваться только для определения компоненты. +// * Изолированно - Булево - если Истина, компонента должна подключаться изолированно, +// в этом случае она загружается в отдельный процесс операционной системы. +// Если Ложь, то в этом случае компонента будет выполняться в том же процессе +// операционной системы, который выполняет код встроенного языка. +// - Неопределено - (по умолчанию Неопределено) соответствует поведению платформы: +// не изолированно - если компонентой поддерживается только этот режим, +// изолированно - в остальных случаях. +// См. https://its.1c.eu/db/v83doc#bookmark:dev:TI000001866 +// * ПолноеИмяМакета - Строка - полное имя макета конфигурации с ZIP-архивом, в котором хранится компонента. +// +Функция ПараметрыПодключения() Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеКомпонентыСервер.ПараметрыПодключения() +``` +
+ +## ПодключитьКомпоненту +
+ +Описание, пример вызова + +```bsl + +// Подключает на сервере 1С:Предприятия внешнюю компоненту из хранилища внешних компонент, +// выполненную по технологии Native API или COM. +// В модели сервиса разрешено только подключение общих внешних компонент, одобренных администратором сервиса. +// +// Параметры: +// Идентификатор - Строка - идентификатор объекта внешней компоненты. +// Версия - Строка - версия компоненты. +// ПараметрыПодключения - см. ПараметрыПодключения. +// +// Возвращаемое значение: +// Структура - результат подключения компоненты: +// * Подключено - Булево - признак подключения; +// * ПодключаемыйМодуль - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты; +// - ФиксированноеСоответствие из КлючИЗначение - экземпляры объектов внешней компоненты, +// указанные в ПараметрыПодключения.ИдентификаторыСозданияОбъектов: +// ** Ключ - Строка - идентификатор, +// ** Значение - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты. +// * ОписаниеОшибки - Строка - краткое описание ошибки. +// +Функция ПодключитьКомпоненту(Знач Идентификатор, Версия = Неопределено, ПараметрыПодключения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеКомпонентыСервер.ПодключитьКомпоненту(Идентификатор, Версия, ПараметрыПодключения); +``` +
+ +## ИнформацияОКомпоненте +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о внешней компоненте по идентификатору и версии. +// +// Параметры: +// Идентификатор - Строка - идентификатор объекта внешней компоненты. +// Версия - Строка - версия компоненты. +// +// Возвращаемое значение: +// Структура: +// * Существует - Булево - признак отсутствия компоненты. +// * ДоступноРедактирование - Булево - признак того, что компоненту может изменить администратор области. +// * ОписаниеОшибки - Строка - краткое описание ошибки. +// * Идентификатор - Строка - идентификатор объекта внешней компоненты. +// * Версия - Строка - версия компоненты. +// * Наименование - Строка - наименование и краткая информация о компоненте. +// +// Пример: +// +// Результат = ВнешниеКомпонентыСервер.ИнформацияОКомпоненте("InputDevice", "8.1.7.10"); +// Если Результат.Существует Тогда +// Идентификатор = Результат.Идентификатор; +// Версия = Результат.Версия; +// Наименование = Результат.Наименование; +// Иначе +// ОбщегоНазначенияКлиентСервер.СообщитьПользователю(Результат.ОписаниеОшибки); +// КонецЕсли; +// +Функция ИнформацияОКомпоненте(Знач Идентификатор, Знач Версия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеКомпонентыСервер.ИнформацияОКомпоненте(Идентификатор, Версия); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВнешниеПользователи.md b/src/content/docs/bsp/ВнешниеПользователи.md new file mode 100644 index 0000000..6c07367 --- /dev/null +++ b/src/content/docs/bsp/ВнешниеПользователи.md @@ -0,0 +1,188 @@ +--- +title: Внешние пользователи +slug: bsp/внешние-пользователи +--- + + +## ИспользоватьВнешнихПользователей +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, что в приложение настроен доступ внешним пользователям +// (значение функциональной опции ИспользоватьВнешнихПользователей). +// +// Возвращаемое значение: +// Булево - если Истина, внешние пользователи включены. +// +Функция ИспользоватьВнешнихПользователей() Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеПользователи.ИспользоватьВнешнихПользователей() +``` +
+ +## ТекущийВнешнийПользователь +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущего внешнего пользователя. +// Рекомендуется использовать в коде, который поддерживает только внешних пользователей. +// +// Если вход в сеанс выполнил не внешний пользователь, тогда будет вызвано исключение. +// +// Возвращаемое значение: +// СправочникСсылка.ВнешниеПользователи - внешний пользователь. +// +Функция ТекущийВнешнийПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеПользователи.ТекущийВнешнийПользователь() +``` +
+ +## ГруппаВсеВнешниеПользователи +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на стандартную группу ВсеВнешниеПользователи. +// +// Возвращаемое значение: +// СправочникСсылка.ГруппыВнешнихПользователей +// +Функция ГруппаВсеВнешниеПользователи() Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеПользователи.ГруппаВсеВнешниеПользователи() +``` +
+ +## ПолучитьОбъектАвторизацииВнешнегоПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на объект авторизации внешнего пользователя, полученный из информационной базы. +// Объект авторизации - это ссылка на объект информационной базы, используемый +// для связи с внешним пользователем, например: контрагент, физическое лицо и т.д. +// +// Параметры: +// ВнешнийПользователь - Неопределено - вернуть для текущего внешнего пользователя. +// - СправочникСсылка.ВнешниеПользователи +// +// Возвращаемое значение: +// ОпределяемыйТип.ВнешнийПользователь +// +Функция ПолучитьОбъектАвторизацииВнешнегоПользователя(ВнешнийПользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеПользователи.ПолучитьОбъектАвторизацииВнешнегоПользователя(ВнешнийПользователь); +``` +
+ +## НастроитьОтображениеСпискаВнешнихПользователей +
+ +Описание, пример вызова + +```bsl + +// Используется для настройки отображения состояния внешних пользователей +// в списках справочников (партнеры, респонденты и др.), которые +// являются объектом авторизации в справочнике ВнешниеПользователи. +// +// Когда нет прав к справочнику ВнешниеПользователи или он не используется, тогда +// отключается видимость колонки ВнешнийДоступ и легенды ВнешнийДоступЛегенда. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// ДополнительныеПараметры - см. ПараметрыНастройкиОтображенияСпискаВнешнихПользователей +// +Процедура НастроитьОтображениеСпискаВнешнихПользователей(Форма, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВнешниеПользователи.НастроитьОтображениеСпискаВнешнихПользователей(Форма, ДополнительныеПараметры); +``` +
+ +## ПараметрыНастройкиОтображенияСпискаВнешнихПользователей +
+ +Описание, пример вызова + +```bsl + +// Конструктор дополнительных параметров процедуры НастроитьОтображениеСпискаВнешнихПользователей. +// +// Возвращаемое значение: +// Структура: +// * ИмяСписка - Строка - имя реквизита формы с динамическим списком. +// * ИмяПоля - Строка - имя поля запроса динамического списка. +// * ИмяЭлемента - Строка - имя элемента формы колонки динамического списка. +// * ИмяГруппыЛегенды - Строка - имя элемента формы, содержащую легенду состояний внешнего доступа. +// +Функция ПараметрыНастройкиОтображенияСпискаВнешнихПользователей() Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеПользователи.ПараметрыНастройкиОтображенияСпискаВнешнихПользователей() +``` +
+ +## СписокВнешнихПользователейПриПолученииДанныхНаСервере +
+ +Описание, пример вызова + +```bsl + +// Используется для заполнения значений поля состояния внешних пользователей +// в списках справочников (партнеры, респонденты и др.), которые +// являются объектом авторизации в справочнике ВнешниеПользователи. +// +// Вызов выполняется из события ПриПолученииДанныхНаСервере динамического списка +// справочника, при этом заполняется поле ВнешнийДоступ на основе данных поля Ссылка. +// +// Параметры: +// ИмяЭлемента - Строка +// Настройки - НастройкиКомпоновкиДанных +// Строки - СтрокиДинамическогоСписка +// ИмяПоля - Строка - имя поля номера картинки строк в динамическом списке. +// +Процедура СписокВнешнихПользователейПриПолученииДанныхНаСервере(ИмяЭлемента, Настройки, Строки, Экспорт +``` + +Пример вызова +```bsl +ВнешниеПользователи.СписокВнешнихПользователейПриПолученииДанныхНаСервере(ИмяЭлемента, Настройки, Строки, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВнешниеПользователиКлиент.md b/src/content/docs/bsp/ВнешниеПользователиКлиент.md new file mode 100644 index 0000000..2b4e908 --- /dev/null +++ b/src/content/docs/bsp/ВнешниеПользователиКлиент.md @@ -0,0 +1,30 @@ +--- +title: Внешние пользователи клиент +slug: bsp/внешние-пользователи-клиент +--- + + +## ТекущийВнешнийПользователь +
+ +Описание, пример вызова + +```bsl + +// См. ВнешниеПользователи.ТекущийВнешнийПользователь. +Функция ТекущийВнешнийПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = ВнешниеПользователиКлиент.ТекущийВнешнийПользователь() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВыгрузкаЗагрузкаДанных.md b/src/content/docs/bsp/ВыгрузкаЗагрузкаДанных.md new file mode 100644 index 0000000..02e64b2 --- /dev/null +++ b/src/content/docs/bsp/ВыгрузкаЗагрузкаДанных.md @@ -0,0 +1,314 @@ +--- +title: Выгрузка загрузка данных +slug: bsp/выгрузка-загрузка-данных +--- + + +## ВыгрузитьДанныеТекущейОбластиВАрхив +
+ +Описание, пример вызова + +```bsl + +// Выгружает данные в zip-архив, из которого они в дальнейшем могут быть загружены +// в другую информационную базу или область данных с помощью функции +// ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива(). +// +// Параметры: +// ПараметрыВыгрузки - Структура - содержащая параметры выгрузки данных: +// * ВыгружаемыеТипы - Массив из ОбъектМетаданных - данные которых требуется выгрузить в архив +// * ВыгружатьПользователей - Булево - выгружать информацию о пользователях информационной базы, +// * ВыгружатьНастройкиПользователей - Булево - игнорируется если ВыгружатьПользователей = Ложь. +// Также структура может содержать дополнительные ключи, которые могут быть обработаны внутри +// произвольных обработчиков выгрузки данных. +// +// Возвращаемое значение: +// Структура - с полями: +// * ИмяФайла - Строка - имя файла архива +// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам выгрузки. +// +Функция ВыгрузитьДанныеТекущейОбластиВАрхив(Знач ПараметрыВыгрузки) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаДанных.ВыгрузитьДанныеТекущейОбластиВАрхив(ПараметрыВыгрузки) +``` +
+ +## ЗагрузитьДанныеТекущейОбластиИзАрхива +
+ +Описание, пример вызова + +```bsl + +// Загружает данные из zip архива с XML файлами. +// +// Параметры: +// ИмяАрхива - Строка, УникальныйИдентификатор, Структура - имя файла, идентификатор файла или данные файла полученные с помощью ZipАрхивы.ПрочитатьАрхив(). +// ПараметрыЗагрузки - Структура - содержащая параметры загрузки данных: +// * ЗагружаемыеТипы - Массив Из ОбъектМетаданных - массив объектов метаданных, данные +// которых требуется загрузить из архива. Если значение параметра задано - все прочие +// данные, содержащиеся в файле выгрузки, загружены не будут. Если значение параметра +// не задано - будут загружены все данные, содержащиеся в файле выгрузки. +// * ЗагружатьПользователей - Булево - загружать информацию о пользователях информационной базы, +// * ЗагружатьНастройкиПользователей - Булево - игнорируется, если ЗагружатьПользователей = Ложь. +// * СопоставлениеПользователей - ТаблицаЗначений - таблица с колонками: +// ** Пользователь - СправочникСсылка.Пользователи - идентификатора пользователя из архива. +// ** ИдентификаторПользователяСервиса - УникальныйИдентификатор - идентификатор пользователя сервиса. +// ** СтароеИмяПользователяИБ - Строка - старое имя пользователя базы. +// ** НовоеИмяПользователяИБ - Строка - новое имя пользователя базы. +// Также структура может содержать дополнительные ключи, которые могут быть обработаны внутри +// произвольных обработчиков загрузки данных. +// +// Возвращаемое значение: +// Структура - с полями: +// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам загрузки. +// +Функция ЗагрузитьДанныеТекущейОбластиИзАрхива(Знач ИмяАрхива, Знач ПараметрыЗагрузки) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива(ИмяАрхива, ПараметрыЗагрузки) +``` +
+ +## ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией +
+ +Описание, пример вызова + +```bsl + +// Проверяет совместимость выгрузки из файла с текущей конфигурацией информационной базы. +// +// Параметры: +// ИмяАрхива - Строка - путь к файлу выгрузки. +// +// Возвращаемое значение: +// Булево - Истина если данные из архива могут быть загружены в текущую конфигурацию. +// +Функция ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(Знач ИмяАрхива) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаДанных.ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(ИмяАрхива) +``` +
+ +## ЗаписатьОбъектВФайл +
+ +Описание, пример вызова + +```bsl + +// Записывает объект в файл. +// +// Параметры: +// Объект - Произвольный - записываемый объект. +// ИмяФайла - Строка - путь к файлу. +// Сериализатор - СериализаторXDTO - сериализатор. +// +Процедура ЗаписатьОбъектВФайл(Знач Объект, Знач ИмяФайла, Сериализатор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанных.ЗаписатьОбъектВФайл(Объект, ИмяФайла, Сериализатор); +``` +
+ +## ПрочитатьОбъектИзФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает объект из файла. +// +// Параметры: +// ИмяФайла - Строка - путь к файлу. +// +// Возвращаемое значение: +// Произвольный - объект содержащий прочитанные данные +// +Функция ПрочитатьОбъектИзФайла(Знач ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаДанных.ПрочитатьОбъектИзФайла(ИмяФайла) +``` +
+ +## ДополнитьТипомИсключаемымИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Дополняет массив типов исключаемых из выгрузки-загрузки +// Предназначен для использования в обработчиках ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - Массив из ФиксированнаяСтруктура +// Тип - ОбъектМетаданных - объект метаданных исключаемый из выгрузки-загрузки +// ДействиеСоСсылками - Строка - вариант действия при обнаружении ссылки на объект исключаемый из выгрузки +// Поддерживаются следующие действия: +// ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиНеИзменять() - не будет произведено никаких действий +// ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиОчищать() - будет выполнено очищение ссылки на невыгружаемый объект +// ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиНеВыгружатьОбъект() - объект содержащий ссылку не будет выгружен +// +// Пример использования: +// Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +// ВыгрузкаЗагрузкаДанных.ДополнитьТипомИсключаемымИзВыгрузкиЗагрузки( +// Типы, +// Метаданные.Справочники.ИсторияПроверкиИКорректировкиДанныхПрисоединенныеФайлы, +// ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиНеВыгружатьОбъект()); +// КонецПроцедуры +// +Процедура ДополнитьТипомИсключаемымИзВыгрузкиЗагрузки(Типы, Тип, ДействиеСоСсылками) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанных.ДополнитьТипомИсключаемымИзВыгрузкиЗагрузки(Типы, Тип, ДействиеСоСсылками) +``` +
+ +## ДействиеСоСсылкамиНеИзменять +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Строка - +Функция ДействиеСоСсылкамиНеИзменять() Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиНеИзменять() +``` +
+ +## ДействиеСоСсылкамиОчищать +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Строка - +Функция ДействиеСоСсылкамиОчищать() Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиОчищать() +``` +
+ +## ДействиеСоСсылкамиНеВыгружатьОбъект +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Строка - +Функция ДействиеСоСсылкамиНеВыгружатьОбъект() Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаДанных.ДействиеСоСсылкамиНеВыгружатьОбъект() +``` +
+ +## ВыгрузитьДанныеВАрхив +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВыгрузкаЗагрузкаДанных.ВыгрузитьДанныеТекущейОбластиВАрхив +// Выгружает данные в zip-архив, из которого они в дальнейшем могут быть загружены +// в другую информационную базу или область данных с помощью функции +// ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива(). +// +// Параметры: +// ПараметрыВыгрузки - Структура - содержащая параметры выгрузки данных: +// * ВыгружаемыеТипы - Массив из ОбъектМетаданных - массив объектов метаданных, данные которых требуется выгрузить в архив +// * ВыгружатьПользователей - Булево - выгружать информацию о пользователях информационной базы, +// * ВыгружатьНастройкиПользователей - Булево - игнорируется если ВыгружатьПользователей = Ложь. +// Также структура может содержать дополнительные ключи, которые могут быть обработаны внутри +// произвольных обработчиков выгрузки данных. +// +// Возвращаемое значение: +// Строка - путь к файлу выгрузки. +// +Функция ВыгрузитьДанныеВАрхив(Знач ПараметрыВыгрузки) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаДанных.ВыгрузитьДанныеВАрхив(ПараметрыВыгрузки) +``` +
+ +## ЗагрузитьДанныеИзАрхива +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива +// Загружает данные из zip архива с XML файлами. +// +// Параметры: +// ИмяАрхива - Строка - полное имя файла архива с данными, +// ПараметрыЗагрузки - Структура - содержащая параметры загрузки данных: +// * ЗагружаемыеТипы - Массив Из ОбъектМетаданных - массив объектов метаданных, данные +// которых требуется загрузить из архива. Если значение параметра задано - все прочие +// данные, содержащиеся в файле выгрузки, загружены не будут. Если значение параметра +// не задано - будут загружены все данные, содержащиеся в файле выгрузки. +// * ЗагружатьПользователей - Булево - загружать информацию о пользователях информационной базы, +// * ЗагружатьНастройкиПользователей - Булево - игнорируется, если ЗагружатьПользователей = Ложь. +// * СопоставлениеПользователей - ТаблицаЗначений - таблица с колонками: +// ** Пользователь - СправочникСсылка.Пользователи - идентификатора пользователя из архива. +// ** ИдентификаторПользователяСервиса - УникальныйИдентификатор - идентификатор пользователя сервиса. +// ** СтароеИмяПользователяИБ - Строка - старое имя пользователя базы. +// ** НовоеИмяПользователяИБ - Строка - новое имя пользователя базы. +// Также структура может содержать дополнительные ключи, которые могут быть обработаны внутри +// произвольных обработчиков загрузки данных. +// +Процедура ЗагрузитьДанныеИзАрхива(Знач ИмяАрхива, Знач ПараметрыЗагрузки) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеИзАрхива(ИмяАрхива, ПараметрыЗагрузки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.md b/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.md new file mode 100644 index 0000000..2b9b5f1 --- /dev/null +++ b/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.md @@ -0,0 +1,273 @@ +--- +title: Выгрузка загрузка данных границ последовательностей +slug: bsp/выгрузка-загрузка-данных-границ-последовательностей +--- + + +## ПриРегистрацииОбработчиковВыгрузкиДанных +
+ +Описание, пример вызова + +```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 +ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков) +``` +
+ +## ПередВыгрузкойТипа +
+ +Описание, пример вызова + +```bsl + +// Обработчик события перед выгрузкой типа. +// +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера +// Сериализатор - СериализаторXDTO +// ОбъектМетаданных - ОбъектМетаданных +// Отказ - Булево +// +Процедура ПередВыгрузкойТипа(Контейнер, Сериализатор, ОбъектМетаданных, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.ПередВыгрузкойТипа(Контейнер, Сериализатор, ОбъектМетаданных, Отказ) +``` +
+ +## ПриРегистрацииОбработчиковЗагрузкиДанных +
+ +Описание, пример вызова + +```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 +ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков) +``` +
+ +## ПослеЗагрузкиТипа +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхСлужебныйСобытия.ПриДобавленииСлужебныхСобытий +// +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера +// ОбъектМетаданных - ОбъектМетаданных +// +Процедура ПослеЗагрузкиТипа(Контейнер, ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхГраницПоследовательностей.ПослеЗагрузкиТипа(Контейнер, ОбъектМетаданных) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхДополнительныхОтчетовИОбработок.md b/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхДополнительныхОтчетовИОбработок.md new file mode 100644 index 0000000..454363d --- /dev/null +++ b/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхДополнительныхОтчетовИОбработок.md @@ -0,0 +1,34 @@ +--- +title: Выгрузка загрузка данных дополнительных отчетов и обработок +slug: bsp/выгрузка-загрузка-данных-дополнительных-отчетов-и-обработок +--- + + +## ПриРегистрацииОбработчиковВыгрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при регистрации произвольных обработчиков выгрузки данных. +// в данной процедуре требуется дополнить таблицу обработчиков информацией о регистрируемых произвольных +// обработчиках выгрузки данных. См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриРегистрацииОбработчиковВыгрузкиДанных. +// @skip-check module-empty-method - особенность реализации. +// +Процедура ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхДополнительныхОтчетовИОбработок.ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхКлиент.md b/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхКлиент.md new file mode 100644 index 0000000..fdab3fb --- /dev/null +++ b/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхКлиент.md @@ -0,0 +1,45 @@ +--- +title: Выгрузка загрузка данных клиент +slug: bsp/выгрузка-загрузка-данных-клиент +--- + + +## ПередНачаломРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +Процедура ПередНачаломРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхКлиент.ПередНачаломРаботыСистемы(Параметры) +``` +
+ +## ПоказатьДиалогПрерваннойЗагрузкиПриНеобходимости +
+ +Описание, пример вызова + +```bsl + +Процедура ПоказатьДиалогПрерваннойЗагрузкиПриНеобходимости() Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхКлиент.ПоказатьДиалогПрерваннойЗагрузкиПриНеобходимости() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхПереопределяемый.md b/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхПереопределяемый.md new file mode 100644 index 0000000..ad740d7 --- /dev/null +++ b/src/content/docs/bsp/ВыгрузкаЗагрузкаДанныхПереопределяемый.md @@ -0,0 +1,535 @@ +--- +title: Выгрузка загрузка данных переопределяемый +slug: bsp/выгрузка-загрузка-данных-переопределяемый +--- + + +## ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке +
+ +Описание, пример вызова + +```bsl + +// Заполняет массив типов, для которых при выгрузке необходимо использовать аннотацию +// ссылок в файлах выгрузки. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Типы - Массив Из ОбъектМетаданных - массив типов ОбъектМетаданных. +// +Процедура ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке(Типы) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке(Типы) +``` +
+ +## ПриЗаполненииТиповОбщихДанныхПоддерживающихСопоставлениеСсылокПриЗагрузке +
+ +Описание, пример вызова + +```bsl + +// Заполняет массив типов неразделенных данных, для которых поддерживается сопоставление ссылок +// при загрузке данных в другую информационную базу. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Типы - Массив Из ОбъектМетаданных - массив типов ОбъектМетаданных. +// +Процедура ПриЗаполненииТиповОбщихДанныхПоддерживающихСопоставлениеСсылокПриЗагрузке(Типы) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповОбщихДанныхПоддерживающихСопоставлениеСсылокПриЗагрузке(Типы) +``` +
+ +## ПриЗаполненииТиповОбщихДанныхНеТребующихСопоставлениеСсылокПриЗагрузке +
+ +Описание, пример вызова + +```bsl + +// Заполняет массив типов неразделенных данных, для которых не требуется сопоставление ссылок +// при загрузке данных в другую информационную базу, т.к. корректное сопоставление ссылок +// гарантируется с помощью других механизмов. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Типы - Массив Из ОбъектМетаданных - массив типов ОбъектМетаданных. +// +Процедура ПриЗаполненииТиповОбщихДанныхНеТребующихСопоставлениеСсылокПриЗагрузке(Типы) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповОбщихДанныхНеТребующихСопоставлениеСсылокПриЗагрузке(Типы) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Заполняет массив типов, исключаемых из выгрузки и загрузки данных. +// +// Параметры: +// Типы - Массив из ОбъектМетаданных, ФиксированнаяСтруктура: +// * Тип - ОбъектМетаданных +// * Действие - Строка - +// Для добавления структуры рекомендуется применять ВыгрузкаЗагрузкаДанных.ДополнитьТипомИсключаемымИзВыгрузкиЗагрузки +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ПередВыгрузкойДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед выгрузкой данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый в процессе +// выгрузки данных. См. комментарий к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера. +// +Процедура ПередВыгрузкойДанных(Контейнер) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПередВыгрузкойДанных(Контейнер) +``` +
+ +## ПриРегистрацииОбработчиковВыгрузкиДанных +
+ +Описание, пример вызова + +```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 +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков) +``` +
+ +## ПослеВыгрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается после выгрузки данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый в процессе +// выгрузки данных. См. комментарий к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера. +// +Процедура ПослеВыгрузкиДанных(Контейнер) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПослеВыгрузкиДанных(Контейнер) +``` +
+ +## ПередЗагрузкойДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед загрузкой данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый в процессе +// загрузки данных. См. комментарий к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера. +// +Процедура ПередЗагрузкойДанных(Контейнер) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПередЗагрузкойДанных(Контейнер) +``` +
+ +## ПриРегистрацииОбработчиковЗагрузкиДанных +
+ +Описание, пример вызова + +```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 +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков) +``` +
+ +## ПослеЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается после загрузки данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый в процессе +// загрузки данных. См. комментарий к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера. +// +Процедура ПослеЗагрузкиДанных(Контейнер) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПослеЗагрузкиДанных(Контейнер) +``` +
+ +## ПриЗагрузкеПользователяИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед загрузкой пользователя информационной базы. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер +// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий +// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера, +// Сериализация - ОбъектXDTO - {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}InfoBaseUser, +// сериализация пользователя информационной базы, +// ПользовательИБ - ПользовательИнформационнойБазы - десериализованный из выгрузки, +// Отказ - Булево - при установке значения данного параметра внутри этой процедуры в +// значение Ложь загрузка пользователя информационной базы будет пропущена. +// +Процедура ПриЗагрузкеПользователяИнформационнойБазы(Контейнер, Сериализация, ПользовательИБ, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗагрузкеПользователяИнформационнойБазы(Контейнер, Сериализация, ПользовательИБ, Отказ) +``` +
+ +## ПослеЗагрузкиПользователяИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после загрузки пользователя информационной базы. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер +// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий +// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера, +// Сериализация - ОбъектXDTO - {HTTP://www.1c.ru/1cFresh/Data/Dump/1.0.2.1}InfoBaseUser, +// сериализация пользователя информационной базы, +// ПользовательИБ - ПользовательИнформационнойБазы - десериализованный из выгрузки. +// +Процедура ПослеЗагрузкиПользователяИнформационнойБазы(Контейнер, Сериализация, ПользовательИБ) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПослеЗагрузкиПользователяИнформационнойБазы(Контейнер, Сериализация, ПользовательИБ) +``` +
+ +## ПослеЗагрузкиПользователейИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после загрузки всех пользователей информационной базы. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер +// контейнера, используемый в процессе загрузки данных. Подробнее см. комментарий +// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера. +// +Процедура ПослеЗагрузкиПользователейИнформационнойБазы(Контейнер) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПослеЗагрузкиПользователейИнформационнойБазы(Контейнер) +``` +
+ +## ПриЗаполненииМетаданныхИсключаемыхИзВыгрузкиВРежимеДляТехническойПоддержки +
+ +Описание, пример вызова + +```bsl + +// Заполняет массив метаданных, исключаемых из выгрузки в режиме для технической поддержки. +// Ссылки на исключаемые ссылочные данные так же будут очищены +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Типы - Массив Из ОбъектМетаданных - массив типов ОбъектМетаданных. +// +Процедура ПриЗаполненииМетаданныхИсключаемыхИзВыгрузкиВРежимеДляТехническойПоддержки(Типы) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииМетаданныхИсключаемыхИзВыгрузкиВРежимеДляТехническойПоддержки(Типы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВыгрузкаЗагрузкаОбластейДанных.md b/src/content/docs/bsp/ВыгрузкаЗагрузкаОбластейДанных.md new file mode 100644 index 0000000..166b345 --- /dev/null +++ b/src/content/docs/bsp/ВыгрузкаЗагрузкаОбластейДанных.md @@ -0,0 +1,348 @@ +--- +title: Выгрузка загрузка областей данных +slug: bsp/выгрузка-загрузка-областей-данных +--- + + +## ВыгрузитьТекущуюОбластьВАрхив +
+ +Описание, пример вызова + +```bsl + +// Выгружает данные приложения в zip-архив, из которого они в дальнейшем могут быть загружены +// в другую информационную базу или область данных с помощью функции +// ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзАрхива(). +// +// Параметры: +// АдресДанных - Строка - адрес во временном хранилище, в который нужно поместить результат если данный параметр заполнен +// РежимВыгрузкиДляТехническойПоддержки - Булево - признак выгрузки в режиме для технической поддержки +// ДанныеСхемыКонфигурации - ДвоичныеДанные, Неопределено - двоичные данные схемы конфигурации сформированные методом +// СхемаКонфигурации.ДвоичныеДанныеСхемы(Истина, Ложь) +// ИмяФайлаВыгрузки - Строка, Неопределено - требуемое имя файла выгрузки (zip). Если не указано, для выгрузки будет +// использовано имя нового временного файла +// ВыгружатьДанныеРасширений - Булево - признак выгрузки исходных данных пользовательских расширений +// ПараметрыВыгрузки - Структура, Неопределено - параметры, используемые при выгрузке: +// * ВыгружатьЗарегистрированныеИзмененияДляУзловПланаОбмена - Булево - включение в выгрузку зарегистрированных изменений для узлов плана обмена (по умолчанию: Ложь). +// * ИдентификаторСостояния - УникальныйИдентификатор, Неопределено - если передан, в процессе выполнения будет фиксироваться состояние выполнения и рассчитываться прогресс. Идентификатор будет использоваться как ключ записи в регистре СостоянияВыгрузкиЗагрузкиОбластейДанных. +// +// Возвращаемое значение: +// Структура - с полями: +// * ИмяФайла - Строка - имя файла архива +// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам выгрузки. +// +Функция ВыгрузитьТекущуюОбластьВАрхив(Знач АдресДанных = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьВАрхив(АдресДанных, ); +``` +
+ +## ВыгрузитьТекущуюОбластьДанныхВоВременноеХранилище +
+ +Описание, пример вызова + +```bsl + +// Выгружает данные приложения в zip-архив, который помещает во временное хранилище. +// В дальнейшем данные из архива могут быть загружены +// в другую информационную базу или область данных с помощью функции +// ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзАрхива(). +// +// Параметры: +// АдресХранилища - Строка - адрес во временном хранилище, в который нужно поместить +// zip-архив с данными. +// +Процедура ВыгрузитьТекущуюОбластьДанныхВоВременноеХранилище(АдресХранилища) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьДанныхВоВременноеХранилище(АдресХранилища) +``` +
+ +## ЗагрузитьТекущуюОбластьИзАрхива +
+ +Описание, пример вызова + +```bsl + +// Загружает данные приложения из zip архива с XML файлами. +// +// Параметры: +// Архив - Строка, УникальныйИдентификатор - полное имя файла архива с данными или идентификатор файла в МС. +// ЗагружатьПользователей - Булево - флаг необходимости загрузки пользователей +// СвернутьЭлементыСправочникаПользователи - Булево - признак необходимости сворачивания пользователей +// СопоставлениеПользователей - ТаблицаЗначений - описание см. ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива() +// ДанныеРасширений - Структура - содержит информацию о ключе области и восстанавливаемых расширениях: +// * КлючОбластиДанных - Строка - ключ области данных +// * РасширенияДляВосстановления - Массив - список восстанавливаемых расширений +// ПараметрыЗагрузки - Структура, Неопределено - параметры, используемые при загрузке: +// * ИдентификаторСостояния - УникальныйИдентификатор, Неопределено - если передан, в процессе выполнения будет фиксироваться состояние выполнения и рассчитываться прогресс. Идентификатор будет использоваться как ключ записи в регистре СостоянияВыгрузкиЗагрузкиОбластейДанных. +// * АдресХранилищаРезультата - Строка - если передан, результат загрузки будет помещен во временное хранилище по указанному адресу. +// * ПропуститьВосстановлениеРасширений - Булево - если передано значение Истина, восстановление расширений перед загрузкой выполняться не будет. +// +// Возвращаемое значение: +// Структура - с полями: +// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам загрузки. +// +Функция ЗагрузитьТекущуюОбластьИзАрхива(Знач Архив, Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзАрхива(Архив, ); +``` +
+ +## ЗагрузитьТекущуюОбластьИзТома +
+ +Описание, пример вызова + +```bsl + +// Загружает данные приложения из файла менеджера сервиса. +// +// Параметры: +// ИдентификаторФайла - УникальныйИдентификатор, Структура - полное имя файла архива с данными +// или структура с полями ИдентификаторФайлаПолнойКопии и ИдентификаторФайлаПолнойКопии +// ЗагружатьПользователей - Булево - флаг необходимости загрузки пользователей +// СвернутьЭлементыСправочникаПользователи - Булево - признак необходимости сворачивания пользователей +// СопоставлениеПользователей - ТаблицаЗначений - описание см. ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива() +// ДанныеРасширений - Структура - содержит информацию о ключе области и восстанавливаемых расширениях: +// * КлючОбластиДанных - Строка - ключ области данных +// * РасширенияДляВосстановления - Массив - список восстанавливаемых расширений +// ПараметрыЗагрузки - Структура, Неопределено - параметры, используемые при загрузке: +// * ИдентификаторСостояния - УникальныйИдентификатор, Неопределено - если передан, в процессе выполнения будет фиксироваться состояние выполнения и рассчитываться прогресс. Идентификатор будет использоваться как ключ записи в регистре СостоянияВыгрузкиЗагрузкиОбластейДанных. +// +// Возвращаемое значение: +// Структура - с полями: +// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам загрузки. +// +Функция ЗагрузитьТекущуюОбластьИзТома( Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзТома(); +``` +
+ +## ЗагрузитьДифференциальнуюКопию +
+ +Описание, пример вызова + +```bsl + +// Загружает данные приложения из дифференциальной копии. +// +// Параметры: +// ПолныйАрхив - Строка, УникальныйИдентификатор, Структура - имя файла, идентификатор файла или данные файла полученные с помощью ZipАрхивы.ПрочитатьАрхив(). +// ДифференциальныйАрхив - Строка, УникальныйИдентификатор, Структура - имя файла, идентификатор файла или данные файла полученные с помощью ZipАрхивы.ПрочитатьАрхив(). +// ЗагружатьПользователей - Булево - флаг необходимости загрузки пользователей. +// СвернутьЭлементыСправочникаПользователи - Булево - признак необходимости сворачивания пользователей. +// СопоставлениеПользователей - ТаблицаЗначений - описание см. ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива(). +// ДанныеРасширений - Структура - содержит информацию о ключе области и восстанавливаемых расширениях: +// * КлючОбластиДанных - Строка - ключ области данных +// * РасширенияДляВосстановления - Массив - список восстанавливаемых расширений +// ПараметрыЗагрузки - Структура, Неопределено - параметры, используемые при загрузке: +// * ИдентификаторСостояния - УникальныйИдентификатор, Неопределено - если передан, в процессе выполнения будет фиксироваться состояние выполнения и рассчитываться прогресс. Идентификатор будет использоваться как ключ записи в регистре СостоянияВыгрузкиЗагрузкиОбластейДанных. +// +// Возвращаемое значение: +// Структура - с полями: +// * Предупреждения - Массив Из Строка - предупреждения пользователю по результатам загрузки. +// +Функция ЗагрузитьДифференциальнуюКопию( Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьДифференциальнуюКопию(); +``` +
+ +## ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией +
+ +Описание, пример вызова + +```bsl + +// Проверяет совместимость выгрузки из файла с текущей конфигурацией информационной базы. +// +// Параметры: +// ИмяАрхива - Строка - путь к файлу выгрузки. +// +// Возвращаемое значение: +// Булево - Истина если данные из архива могут быть загружены +// в текущую конфигурацию. +// +Функция ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(Знач ИмяАрхива) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаОбластейДанных.ВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(ИмяАрхива) +``` +
+ +## ПроверитьВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией +
+ +Описание, пример вызова + +```bsl + +// Проверяет совместимость выгрузки из файла с текущей конфигурацией информационной базы. +// +// Параметры: +// ИмяАрхива - Строка - путь к файлу выгрузки. +// +Процедура ПроверитьВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(Знач ИмяАрхива) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаОбластейДанных.ПроверитьВыгрузкаВАрхивеСовместимаСТекущейКонфигурацией(ИмяАрхива) +``` +
+ +## ПолучитьТипыМоделиДанныхОбласти +
+ +Описание, пример вызова + +```bsl + +// Получает модель данных для дальнейшей загрузки/выгрузки данных +// +// Возвращаемое значение: +// Массив Из ОбъектМетаданных - типы. +Функция ПолучитьТипыМоделиДанныхОбласти() Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаОбластейДанных.ПолучитьТипыМоделиДанныхОбласти() +``` +
+ +## ИмяФайлаПолногоАрхива +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя файла полного архива +// +// Возвращаемое значение: +// Строка - наименование файла полного архива. +// +Функция ИмяФайлаПолногоАрхива() Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаОбластейДанных.ИмяФайлаПолногоАрхива() +``` +
+ +## ВыгрузитьТекущуюОбластьДанныхВАрхив +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьВАрхив +// Выгружает данные приложения в zip-архив, из которого они в дальнейшем могут быть загружены +// в другую информационную базу или область данных с помощью функции +// ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзАрхива(). +// +// Параметры: +// АдресДанных - Строка - адрес во временном хранилище, в который нужно поместить результат если данный параметр заполнен +// РежимВыгрузкиДляТехническойПоддержки - Булево - признак выгрузки в режиме для технической поддержки +// +// Возвращаемое значение: +// Строка - путь к файлу выгрузки. +// +Функция ВыгрузитьТекущуюОбластьДанныхВАрхив(Знач АдресДанных = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьДанныхВАрхив(АдресДанных, ); +``` +
+ +## ВыгрузитьТекущуюОбластьДанныхВФайлИРазделитьНаЧасти +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьВАрхив +// Выгружает данные приложения в zip-архив, разбивает, при необходимости, +// на части и помещает результат во временное хранилище. +// +// Параметры: +// АдресХранилища - Строка - адрес во временном хранилище для размещения результата +// АдресХранилищаФайла - Строка - адрес во временном хранилище для размещения файла +// ЭтоВебКлиент - Булево - признак веб клиента +// РазмерЧастиВМегабайтах - Число - размер одной части файла в мегабайтах +// РежимВыгрузкиДляТехническойПоддержки - Булево - признак выгрузки в режиме для технической поддержки +// +Процедура ВыгрузитьТекущуюОбластьДанныхВФайлИРазделитьНаЧасти(АдресХранилища, Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаОбластейДанных.ВыгрузитьТекущуюОбластьДанныхВФайлИРазделитьНаЧасти(АдресХранилища, ); +``` +
+ +## ЗагрузитьТекущуюОбластьДанныхИзАрхива +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьИзАрхива +// Загружает данные приложения из zip архива с XML файлами. +// +// Параметры: +// ИмяАрхива - Строка - полное имя файла архива с данными +// ЗагружатьПользователей - Булево - флаг необходимости загрузки пользователей +// СвернутьЭлементыСправочникаПользователи - Булево - признак необходимости сворачивания пользователей +// СопоставлениеПользователей - ТаблицаЗначений - описание см. ВыгрузкаЗагрузкаДанных.ЗагрузитьДанныеТекущейОбластиИзАрхива() +// ДанныеРасширений - Структура - содержит информацию о ключе области и восстанавливаемых расширениях: +// * КлючОбластиДанных - Строка - ключ области данных +// * РасширенияДляВосстановления - Массив - список восстанавливаемых расширений +// +Процедура ЗагрузитьТекущуюОбластьДанныхИзАрхива(Знач ИмяАрхива, Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаОбластейДанных.ЗагрузитьТекущуюОбластьДанныхИзАрхива(ИмяАрхива, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВыгрузкаЗагрузкаПользователейИнформационнойБазы.md b/src/content/docs/bsp/ВыгрузкаЗагрузкаПользователейИнформационнойБазы.md new file mode 100644 index 0000000..6b4ef5c --- /dev/null +++ b/src/content/docs/bsp/ВыгрузкаЗагрузкаПользователейИнформационнойБазы.md @@ -0,0 +1,61 @@ +--- +title: Выгрузка загрузка пользователей информационной базы +slug: bsp/выгрузка-загрузка-пользователей-информационной-базы +--- + + +## ВыгрузитьПользователейИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +Процедура ВыгрузитьПользователейИнформационнойБазы(Контейнер) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаПользователейИнформационнойБазы.ВыгрузитьПользователейИнформационнойБазы(Контейнер) +``` +
+ +## ЗагрузитьПользователейИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +Процедура ЗагрузитьПользователейИнформационнойБазы(Контейнер) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаПользователейИнформационнойБазы.ЗагрузитьПользователейИнформационнойБазы(Контейнер) +``` +
+ +## СоздатьПользователяСАдминистративнымиПравами +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьПользователяСАдминистративнымиПравами() Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаПользователейИнформационнойБазы.СоздатьПользователяСАдминистративнымиПравами()); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВыгрузкаЗагрузкаПредопределенныхДанных.md b/src/content/docs/bsp/ВыгрузкаЗагрузкаПредопределенныхДанных.md new file mode 100644 index 0000000..1bcfa31 --- /dev/null +++ b/src/content/docs/bsp/ВыгрузкаЗагрузкаПредопределенныхДанных.md @@ -0,0 +1,215 @@ +--- +title: Выгрузка загрузка предопределенных данных +slug: bsp/выгрузка-загрузка-предопределенных-данных +--- + + +## ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке +
+ +Описание, пример вызова + +```bsl + +// Заполняет массив типов, для которых при выгрузке необходимо использовать аннотацию +// ссылок в файлах выгрузки. +// +// Параметры: +// Типы - Массив Из ОбъектМетаданных - объекты метаданных. +// +Процедура ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке(Типы) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаПредопределенныхДанных.ПриЗаполненииТиповТребующихАннотациюСсылокПриВыгрузке(Типы) +``` +
+ +## ПриРегистрацииОбработчиковВыгрузкиДанных +
+ +Описание, пример вызова + +```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 +ВыгрузкаЗагрузкаПредопределенныхДанных.ПриРегистрацииОбработчиковВыгрузкиДанных(ТаблицаОбработчиков) +``` +
+ +## ПослеВыгрузкиОбъекта +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеВыгрузкиОбъекта(Контейнер, МенеджерВыгрузкиОбъекта, Сериализатор, Объект, Артефакты) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаПредопределенныхДанных.ПослеВыгрузкиОбъекта(Контейнер, МенеджерВыгрузкиОбъекта, Сериализатор, Объект, Артефакты) +``` +
+ +## ПриРегистрацииОбработчиковЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ТаблицаОбработчиков - см. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриРегистрацииОбработчиковЗагрузкиДанных.ТаблицаОбработчиков +Процедура ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаПредопределенныхДанных.ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков) +``` +
+ +## ПередСопоставлениемСсылок +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера. +// ОбъектМетаданных - ОбъектМетаданных - объект метаданных. +// ТаблицаИсходныхСсылок - ТаблицаЗначений - таблица ссылок. +// СтандартнаяОбработка - Булево - признак страндартной обработки. +// Отказ - Булево - признак отказа от обработки. +Процедура ПередСопоставлениемСсылок(Контейнер, ОбъектМетаданных, ТаблицаИсходныхСсылок, СтандартнаяОбработка, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаПредопределенныхДанных.ПередСопоставлениемСсылок(Контейнер, ОбъектМетаданных, ТаблицаИсходныхСсылок, СтандартнаяОбработка, Отказ) +``` +
+ +## СопоставитьСсылки +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер контейнера, используемый в процессе +// загрузки данных. Подробнее см. комментарий к программному интерфейсу обработки. +// МенеджерСопоставленияСсылок - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерСопоставленияСсылок - +// ТаблицаИсходныхСсылок - ТаблицаЗначений - содержащая информацию о ссылках, выгруженных из исходной ИБ. Колонки: +// * ИсходнаяСсылка - ЛюбаяСсылка - ссылка объекта исходной ИБ, которую требуется сопоставить c ссылкой в текущей ИБ, +// Остальные колонки равным полям естественного ключа объекта. +// Возвращаемое значение: +// ТаблицаЗначений - колонки: +// * ИсходнаяСсылка - ЛюбаяСсылка - ссылка объекта, выгруженная из исходной ИБ, +// * Ссылка - ЛюбаяСсылка - сопоставленная исходной ссылка в текущей ИБ. +Функция СопоставитьСсылки(Контейнер, МенеджерСопоставленияСсылок, ТаблицаИсходныхСсылок) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаЗагрузкаПредопределенныхДанных.СопоставитьСсылки(Контейнер, МенеджерСопоставленияСсылок, ТаблицаИсходныхСсылок) +``` +
+ +## ПередЗагрузкойОбъекта +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗагрузкойОбъекта(Контейнер, Объект, Артефакты, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВыгрузкаЗагрузкаПредопределенныхДанных.ПередЗагрузкойОбъекта(Контейнер, Объект, Артефакты, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ВыгрузкаОбъектовВФайлы.md b/src/content/docs/bsp/ВыгрузкаОбъектовВФайлы.md new file mode 100644 index 0000000..424ab6e --- /dev/null +++ b/src/content/docs/bsp/ВыгрузкаОбъектовВФайлы.md @@ -0,0 +1,43 @@ +--- +title: Выгрузка объектов в файлы +slug: bsp/выгрузка-объектов-в-файлы +--- + + +## СохранитьПоФорматуВФайл +
+ +Описание, пример вызова + +```bsl + +// Выгружает объекты в требуемом формате и записывает в файлы. +// +// Параметры: +// КомандыВыгрузки - Структура +// - Массив - команда или несколько команд выгрузки, +// см. УправлениеПечатью.КомандыПечатиФормы. +// СписокОбъектов - Массив из СправочникСсылка, ДокументСсылка - ссылки на сохраняемые объекты. +// НастройкиСохранения - см. УправлениеПечатью.НастройкиСохранения. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ИмяФайла - Строка - имя файла; +// * ДвоичныеДанные - ДвоичныеДанные - файл печатной формы. +// +Функция СохранитьПоФорматуВФайл(КомандыВыгрузки, СписокОбъектов, НастройкиСохранения) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыгрузкаОбъектовВФайлы.СохранитьПоФорматуВФайл(КомандыВыгрузки, СписокОбъектов, НастройкиСохранения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ГенерацияШтрихкода.md b/src/content/docs/bsp/ГенерацияШтрихкода.md new file mode 100644 index 0000000..3c181ee --- /dev/null +++ b/src/content/docs/bsp/ГенерацияШтрихкода.md @@ -0,0 +1,155 @@ +--- +title: Генерация штрихкода +slug: bsp/генерация-штрихкода +--- + + +## ПараметрыГенерацииШтрихкода +
+ +Описание, пример вызова + +```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 +Результат = ГенерацияШтрихкода.ПараметрыГенерацииШтрихкода() +``` +
+ +## ИзображениеШтрихкода +
+ +Описание, пример вызова + +```bsl + +// Формирование изображения штрихкода. +// +// Параметры: +// ПараметрыШтрихкода - см. ГенерацияШтрихкода.ПараметрыГенерацииШтрихкода. +// +// Возвращаемое значение: +// Структура: +// Результат - Булево - результат генерации штрихкода. +// ДвоичныеДанные - ДвоичныеДанные - двоичные данные изображения штрихкода. +// Картинка - Картинка - картинка с сформированным штрихкодом или НЕОПРЕДЕЛЕНО. +// +Функция ИзображениеШтрихкода(ПараметрыШтрихкода) Экспорт +``` + +Пример вызова +```bsl +Результат = ГенерацияШтрихкода.ИзображениеШтрихкода(ПараметрыШтрихкода) +``` +
+ +## ДанныеQRКода +
+ +Описание, пример вызова + +```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Строка, УровеньКоррекции, Размер) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ГрафикиРаботы.md b/src/content/docs/bsp/ГрафикиРаботы.md new file mode 100644 index 0000000..5cd3a5b --- /dev/null +++ b/src/content/docs/bsp/ГрафикиРаботы.md @@ -0,0 +1,190 @@ +--- +title: Графики работы +slug: bsp/графики-работы +--- + + +## ДатыПоГрафику +
+ +Описание, пример вызова + +```bsl + +// Возвращает даты, которые отличаются указанной даты ДатаОт на количество дней, +// входящих в указанный график ГрафикРаботы. +// +// Параметры: +// ГрафикРаботы - СправочникСсылка.Календари - график, который необходимо использовать. +// ДатаОт - Дата - дата, от которой нужно рассчитать количество дней. +// МассивДней - Массив - количество дней (Число), на которые нужно увеличить дату начала. +// РассчитыватьСледующуюДатуОтПредыдущей - Булево - нужно ли рассчитывать следующую дату от предыдущей, +// или все даты рассчитываются от переданной даты. +// ВызыватьИсключение - Булево - если Истина, вызывается исключение в случае незаполненного графика. +// +// Возвращаемое значение: +// Массив, Неопределено - даты, увеличенные на количество дней, входящих в график ГрафикРаботы. +// Если график ГрафикРаботы не заполнен, и ВызыватьИсключение = Ложь, возвращается Неопределено. +// +Функция ДатыПоГрафику(Знач ГрафикРаботы, Знач ДатаОт, Знач МассивДней, Экспорт +``` + +Пример вызова +```bsl +Результат = ГрафикиРаботы.ДатыПоГрафику(ГрафикРаботы, ДатаОт, МассивДней, ); +``` +
+ +## ДатаПоГрафику +
+ +Описание, пример вызова + +```bsl + +// Возвращает дату, которая отличается указанной даты ДатаОт на количество дней, +// входящих в указанный график ГрафикРаботы. +// +// Параметры: +// ГрафикРаботы - СправочникСсылка.Календари - график, который необходимо использовать. +// ДатаОт - Дата - дата, от которой нужно рассчитать количество дней. +// КоличествоДней - Число - количество дней, на которые нужно увеличить дату начала ДатаОт. +// ВызыватьИсключение - Булево - если Истина, вызывается исключение в случае незаполненного графика. +// +// Возвращаемое значение: +// Дата, Неопределено - дата, увеличенная на количество дней, входящих в график ГрафикРаботы. +// Если график ГрафикРаботы не заполнен, и ВызыватьИсключение = Ложь, возвращается Неопределено. +// +Функция ДатаПоГрафику(Знач ГрафикРаботы, Знач ДатаОт, Знач КоличествоДней, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ГрафикиРаботы.ДатаПоГрафику(ГрафикРаботы, ДатаОт, КоличествоДней, ВызыватьИсключение); +``` +
+ +## ПараметрыПолученияБлижайшихДатПоГрафику +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров получения ближайших к заданным дат, включенных в график. +// См. БлижайшиеРабочиеДаты. +// +// Возвращаемое значение: +// Структура: +// * ПолучатьПредшествующие - Булево - способ получения ближайшей даты: +// если Истина - определяются рабочие даты, предшествующие переданным в параметре НачальныеДаты, +// если Ложь - получаются ближайшие рабочие даты, следующие за начальными датами. +// Значение по умолчанию - Ложь: +// * ИгнорироватьНезаполненностьГрафика - Булево - если Истина, то в любом случае будет возвращено соответствие. +// Начальные даты, для которых не будет значений из-за незаполненности графика, включены не будут. +// Значение по умолчанию - Ложь: +// * ВызыватьИсключение - Булево - вызов исключения в случае не заполненного графика +// если Истина, вызвать исключение, если график не заполнен. +// если Ложь - даты, по которым не удалось определить ближайшую дату, будут просто пропущены. +// Значение по умолчанию - Истина. +// +Функция ПараметрыПолученияБлижайшихДатПоГрафику() Экспорт +``` + +Пример вызова +```bsl +Результат = ГрафикиРаботы.ПараметрыПолученияБлижайшихДатПоГрафику() +``` +
+ +## БлижайшиеДатыВключенныеВГрафик +
+ +Описание, пример вызова + +```bsl + +// Определяет для каждой даты дату ближайшего к дня, включенного в график. +// +// Параметры: +// ГрафикРаботы - СправочникСсылка.Календари +// НачальныеДаты - Массив из Дата - даты, относительно которых нужно найти ближайшие. +// ПараметрыПолучения - см. ПараметрыПолученияБлижайшихДатПоГрафику. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Дата - начальная дата. +// * Значение - Дата - ближайшая к ней дата, включенная в график. +// +Функция БлижайшиеДатыВключенныеВГрафик(ГрафикРаботы, НачальныеДаты, ПараметрыПолучения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ГрафикиРаботы.БлижайшиеДатыВключенныеВГрафик(ГрафикРаботы, НачальныеДаты, ПараметрыПолучения); +``` +
+ +## РасписанияРаботыНаПериод +
+ +Описание, пример вызова + +```bsl + +// Составляет расписания работы для дат, включенных в указанные графики на указанный период. +// Если расписание на предпраздничный день не задано, то оно определяется так, как если бы этот день был бы рабочим. +// +// Параметры: +// Графики - Массив - массив элементов типа СправочникСсылка.Календари, для которых составляются расписания. +// ДатаНачала - Дата - дата начала периода, за который нужно составить расписания. +// ДатаОкончания - Дата - дата окончания периода. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ГрафикРаботы - СправочникСсылка.Календари - график работы. +// * ДатаГрафика - Дата - дата в графике работы ГрафикРаботы. +// * ВремяНачала - Дата - время начала работы в день ДатаГрафика. +// * ВремяОкончания - Дата - время окончания работы в день ДатаГрафика. +// +Функция РасписанияРаботыНаПериод(Графики, ДатаНачала, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +Результат = ГрафикиРаботы.РасписанияРаботыНаПериод(Графики, ДатаНачала, ДатаОкончания) +``` +
+ +## СоздатьВТРасписанияРаботыНаПериод +
+ +Описание, пример вызова + +```bsl + +// Создает в менеджере временную таблицу ВТРасписанияРаботы с колонками, соответствующими возвращаемому значению +// функции РасписанияРаботыНаПериод. +// +// Параметры: +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - менеджер, в котором будет создана временная таблица. +// Графики - Массив - массив элементов типа СправочникСсылка.Календари, для которых составляются расписания. +// ДатаНачала - Дата - дата начала периода, за который нужно составить расписания. +// ДатаОкончания - Дата - дата окончания периода. +// +Процедура СоздатьВТРасписанияРаботыНаПериод(МенеджерВременныхТаблиц, Графики, ДатаНачала, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ГрафикиРаботы.СоздатьВТРасписанияРаботыНаПериод(МенеджерВременныхТаблиц, Графики, ДатаНачала, ДатаОкончания) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ГрупповоеИзменениеОбъектовКлиент.md b/src/content/docs/bsp/ГрупповоеИзменениеОбъектовКлиент.md new file mode 100644 index 0000000..c332b48 --- /dev/null +++ b/src/content/docs/bsp/ГрупповоеИзменениеОбъектовКлиент.md @@ -0,0 +1,36 @@ +--- +title: Групповое изменение объектов клиент +slug: bsp/групповое-изменение-объектов-клиент +--- + + +## ИзменитьВыделенные +
+ +Описание, пример вызова + +```bsl + +// Открывает диалог группового изменения реквизитов для выбранных в списке объектов. +// +// Параметры: +// СписокЭлемент - ТаблицаФормы +// - Массив из ЛюбаяСсылка - элемент формы со списком. +// СписокРеквизит - ДинамическийСписок - реквизит формы со списком. +// +Процедура ИзменитьВыделенные(СписокЭлемент, Знач СписокРеквизит = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ГрупповоеИзменениеОбъектовКлиент.ИзменитьВыделенные(СписокЭлемент, СписокРеквизит); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ГрупповоеИзменениеОбъектовПереопределяемый.md b/src/content/docs/bsp/ГрупповоеИзменениеОбъектовПереопределяемый.md new file mode 100644 index 0000000..afda6f5 --- /dev/null +++ b/src/content/docs/bsp/ГрупповоеИзменениеОбъектовПереопределяемый.md @@ -0,0 +1,101 @@ +--- +title: Групповое изменение объектов переопределяемый +slug: bsp/групповое-изменение-объектов-переопределяемый +--- + + +## ПриОпределенииОбъектовСКомандойГрупповогоИзмененияОбъектов +
+ +Описание, пример вызова + +```bsl + +// Определить объекты метаданных, в формах списков которых +// будет выведена команда группового изменения выделенных объектов. +// см. ГрупповоеИзменениеОбъектовКлиент.ИзменитьВыделенные +// +// Параметры: +// Объекты - Массив из ОбъектМетаданных +// +// Пример: +// Объекты.Добавить(Метаданные.Справочники.Номенклатура); +// Объекты.Добавить(Метаданные.Справочники.Контрагенты); +// +Процедура ПриОпределенииОбъектовСКомандойГрупповогоИзмененияОбъектов(Объекты) Экспорт +``` + +Пример вызова +```bsl +ГрупповоеИзменениеОбъектовПереопределяемый.ПриОпределенииОбъектовСКомандойГрупповогоИзмененияОбъектов(Объекты) +``` +
+ +## ПриОпределенииОбъектовСРедактируемымиРеквизитами +
+ +Описание, пример вызова + +```bsl + +// Определить объекты метаданных, в модулях менеджеров которых ограничивается возможность +// редактирования реквизитов при групповом изменении. +// +// Параметры: +// Объекты - Соответствие из КлючИЗначение - в качестве ключа указать полное имя объекта метаданных, +// подключенного к подсистеме "Групповое изменение объектов". +// Дополнительно в значении могут быть перечислены имена экспортных функций: +// "РеквизитыНеРедактируемыеВГрупповойОбработке", +// "РеквизитыРедактируемыеВГрупповойОбработке". +// Каждое имя должно начинаться с новой строки. +// Если указано "*", значит, в модуле менеджера определены обе функции. +// +// Пример: +// Объекты.Вставить(Метаданные.Документы.ЗаказПокупателя.ПолноеИмя(), "*"); // определены обе функции. +// Объекты.Вставить(Метаданные.БизнесПроцессы.ЗаданиеСРолевойАдресацией.ПолноеИмя(), "РеквизитыРедактируемыеВГрупповойОбработке"); +// Объекты.Вставить(Метаданные.Справочники.Партнеры.ПолноеИмя(), "РеквизитыРедактируемыеВГрупповойОбработке +// |РеквизитыНеРедактируемыеВГрупповойОбработке"); +// +Процедура ПриОпределенииОбъектовСРедактируемымиРеквизитами(Объекты) Экспорт +``` + +Пример вызова +```bsl +ГрупповоеИзменениеОбъектовПереопределяемый.ПриОпределенииОбъектовСРедактируемымиРеквизитами(Объекты) +``` +
+ +## ПриОпределенииРедактируемыхРеквизитовОбъекта +
+ +Описание, пример вызова + +```bsl + +// Определяет реквизиты объекта, которые разрешается редактировать с помощью обработки группового изменения реквизитов. +// По умолчанию все реквизиты объекта разрешено редактировать. Для ограничения списка реквизитов необходимо заполнить +// одну из коллекций РедактируемыеРеквизиты и НередактируемыеРеквизиты. Если заполнены обе коллекции, то для разрешения +// неоднозначности приоритет отдается в пользу коллекции НередактируемыеРеквизиты. +// +// Параметры: +// Объект - ОбъектМетаданных - объект, для которого устанавливается список редактируемых реквизитов. +// РедактируемыеРеквизиты - Неопределено, Массив из Строка - имена редактируемых групповой обработкой реквизитов объекта. +// Значение игнорируется, если заполнен параметр НередактируемыеРеквизиты. +// НередактируемыеРеквизиты - Неопределено, Массив из Строка - имена не редактируемых групповой обработкой реквизитов объекта. +// +Процедура ПриОпределенииРедактируемыхРеквизитовОбъекта(Объект, РедактируемыеРеквизиты, НередактируемыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ГрупповоеИзменениеОбъектовПереопределяемый.ПриОпределенииРедактируемыхРеквизитовОбъекта(Объект, РедактируемыеРеквизиты, НередактируемыеРеквизиты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ДатыЗапретаИзменения.md b/src/content/docs/bsp/ДатыЗапретаИзменения.md new file mode 100644 index 0000000..74ae687 --- /dev/null +++ b/src/content/docs/bsp/ДатыЗапретаИзменения.md @@ -0,0 +1,582 @@ +--- +title: Даты запрета изменения +slug: bsp/даты-запрета-изменения +--- + + +## ИзменениеЗапрещено +
+ +Описание, пример вызова + +```bsl + +// Проверяет, запрещено ли изменение данных при интерактивном редактировании пользователем +// или при программной загрузке данных из узла плана обмена УзелПроверкиЗапретаЗагрузки. +// +// Параметры: +// ДанныеИлиПолноеИмя - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - проверяемый объект данных. +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - проверяемый набор записей с необязательным +// свойством Замещение (Булево, РежимЗамещения) в структуре ДополнительныеСвойства, +// если свойство Замещение не указано, тогда оно будет вставлено со значением Истина. +// - Строка - полное имя объекта метаданных, данные которого следует проверить в базе данных. +// Например: "Документ.ПриходнаяНакладная". +// В этом случае следует указать в параметре ИдентификаторДанных, +// какие именно данные требуется прочитать из базы и проверить. +// +// ИдентификаторДанных - СправочникСсылка +// - ДокументСсылка +// - ПланВидовХарактеристикСсылка +// - ПланСчетовСсылка +// - ПланВидовРасчетаСсылка +// - БизнесПроцессСсылка +// - ЗадачаСсылка +// - ПланОбменаСсылка +// - Отбор - ссылка на элемент данных или отбор набора записей, который нужно проверить. +// При этом значение для проверки будет получено из базы данных. +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор записей со свойством Замещение (Булево, РежимЗамещения) +// в структуре ДополнительныеСвойства и настроенным свойством Отбор в варианте замены записей, +// как в обработчике ПередЗаписью, для получения заменяемых записей из базы данных. +// - Неопределено - если не требуется получать значение для проверки из базы данных, +// а нужно проверить только данные самого объекта в ДанныеИлиПолноеИмя. +// +// ОписаниеОшибки - Null - значение по умолчанию. Сведения о запретах не требуются. +// - Строка - возвращаемое значение. Вернуть текстовое описание найденных запретов. +// - Структура - возвращаемое значение. вернуть структурное описание найденных запретов, +// подробнее см. функцию ДатыЗапретаИзменения.НайденЗапретИзмененияДанных. +// +// УзелПроверкиЗапретаЗагрузки - Неопределено +// - ПланОбменаСсылка - если Неопределено, то проверить запрет +// изменения данных; иначе - загрузку данных из указанного узла плана обмена. +// +// Возвращаемое значение: +// Булево - Истина, если изменение данных запрещено. +// +// Варианты вызова: +// ИзменениеЗапрещено(СправочникОбъект...) - проверить данные в переданном объекте (наборе записей). +// ИзменениеЗапрещено(Строка, СправочникСсылка...) - проверить данные, полученные из базы данных +// по полному имени объекта метаданных и ссылке (отбору набора записей). +// ИзменениеЗапрещено(СправочникОбъект..., СправочникСсылка...) - проверить одновременно +// данные в переданном объекте и данные в базе (т.е. "до" и "после" записи в базу, если проверка выполняется +// перед записью объекта). +// +Функция ИзменениеЗапрещено(ДанныеИлиПолноеИмя, ИдентификаторДанных = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ДатыЗапретаИзменения.ИзменениеЗапрещено(ДанныеИлиПолноеИмя, ИдентификаторДанных, ); +``` +
+ +## ПроверитьДатыЗапретаЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие запрета загрузки объекта или набора записей Данные. +// При этом выполняется проверка старой и новой версии данных. +// +// Параметры: +// Данные - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект +// - УдалениеОбъекта +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - элемент данных или набор записей. +// +// УзелПроверкиЗапретаЗагрузки - ПланОбменаСсылка - узел, для которого требуется проверка. +// +// Отказ - Булево - возвращаемый параметр: Истина, если загрузка запрещена. +// +// ОписаниеОшибки - Null - значение по умолчанию. Сведения о запретах не требуются. +// - Строка - возвращаемое значение. Вернуть текстовое описание найденных запретов. +// - Структура - возвращаемое значение. Вернуть структурное описание найденных запретов, +// подробнее см. функцию ДатыЗапретаИзменения.НайденЗапретИзмененияДанных. +// +Процедура ПроверитьДатыЗапретаЗагрузкиДанных(Данные, УзелПроверкиЗапретаЗагрузки, Отказ, ОписаниеОшибки = Null) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзменения.ПроверитьДатыЗапретаЗагрузкиДанных(Данные, УзелПроверкиЗапретаЗагрузки, Отказ, ОписаниеОшибки); +``` +
+ +## ОбъектПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик события формы ПриЧтенииНаСервере, который встраивается в формы элементов справочников, +// документов, записей регистров и др., чтобы заблокировать форму, если изменение запрещено. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента объекта или записи регистра. +// +// ТекущийОбъект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект +// - РегистрСведенийМенеджерЗаписи - менеджер записи. +// +// Возвращаемое значение: +// Булево - Истина, если проверка запрета изменения была пропущена программно. +// +Функция ОбъектПриЧтенииНаСервере(Форма, ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = ДатыЗапретаИзменения.ОбъектПриЧтенииНаСервере(Форма, ТекущийОбъект) +``` +
+ +## ДобавитьСтроку +
+ +Описание, пример вызова + +```bsl + +// Добавляет строку описания источника данных для проверки запрета изменения. +// Используется в процедуре ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения +// общего модуля ДатыЗапретаИзмененияПереопределяемый. +// +// Параметры: +// Данные - ТаблицаЗначений - передается в процедуру ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения. +// Таблица - Строка - полное имя объекта метаданных, например "Документ.ПриходнаяНакладная". +// ПолеДаты - Строка - имя реквизита объекта или табличной части, например: "Дата", "Товары.ДатаОтгрузки". +// Раздел - Строка - имя предопределенного элемента ПланВидовХарактеристикСсылка.РазделыДатЗапретаИзменения. +// ПолеОбъекта - Строка - имя реквизита объекта или реквизита табличной части, например: "Организация", "Товары.Склад". +// +Процедура ДобавитьСтроку(Данные, Таблица, ПолеДаты, Раздел = "", ПолеОбъекта = "") Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзменения.ДобавитьСтроку(Данные, Таблица, ПолеДаты, Раздел, ПолеОбъекта); +``` +
+ +## НайденЗапретИзмененияДанных +
+ +Описание, пример вызова + +```bsl + +// Найти даты запрета по проверяемым данным для указанного пользователя или узла плана обмена. +// +// Параметры: +// ДанныеДляПроверки - см. ДатыЗапретаИзменения.ШаблонДанныхДляПроверки +// +// ПараметрыСообщенияОЗапрете - см. ДатыЗапретаИзменения.ПараметрыСообщенияОЗапрете +// - Неопределено - формировать текст сообщения о запрете не требуется. +// +// ОписаниеОшибки - Null - значение по умолчанию. Сведения о запретах не требуются. +// - Строка - возвращаемое значение. Вернуть текстовое описание найденных запретов. +// - Структура - возвращаемое значение. Вернуть структурное описание найденных запретов: +// * ПредставлениеДанных - Строка - представление данных, используемое в заголовке ошибки. +// * ЗаголовокОшибки - Строка - строка, подобная следующей: +// "Заказ 10 от 01.01.2017 невозможно изменить в запрещенном периоде.". +// * Запреты - ТаблицаЗначений - найденные запреты в виде таблицы с колонками: +// ** Дата - Дата - проверяемая дата. +// ** Раздел - Строка - имя раздела, по которому выполнялся поиск запретов, если +// пустая строка, значит, выполнялся поиск даты, действующей для всех разделов. +// ** Объект - ЛюбаяСсылка - ссылка на объект, по которому выполнялся поиск даты запрета. +// - Неопределено - выполнялся поиск даты, действующей для всех объектов. +// ** ДатаЗапрета - Дата - найденная дата запрета. +// ** ОбщаяДата - Булево - если Истина, значит, найденная дата запрета действует для +// всех разделов, а не только для раздела, по которому выполнялся поиск. +// ** ДляВсехОбъектов - Булево - если Истина, значит, найденная дата запрета действует для +// всех объектов, а не только для объекта, по которому выполнялся поиск. +// ** Адресат - ОпределяемыйТип.АдресатЗапретаИзменения - пользователь или узел +// плана обмена, для которого задана найденная дата запрета. +// ** Описание - Строка - строка, подобная следующей: +// "Дате 01.01.2017 по объекту ""Склад программ"" раздела ""Складской учет"" соответствует +// запрет изменения данных для всех пользователей (установлена общая дата запрета)". +// +// УзелПроверкиЗапретаЗагрузки - Неопределено - выполнить проверку изменения данных. +// - ПланОбменаСсылка - выполнить проверку загрузки данных для указанного узла. +// +// Возвращаемое значение: +// Булево - если Истина, то найден хотя бы один запрет изменения. +// +Функция НайденЗапретИзмененияДанных(Знач ДанныеДляПроверки, Экспорт +``` + +Пример вызова +```bsl +Результат = ДатыЗапретаИзменения.НайденЗапретИзмененияДанных(ДанныеДляПроверки, ); +``` +
+ +## ПараметрыСообщенияОЗапрете +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры для формирования сообщение о запрете записи или загрузки данных. +// Для использования в функции ДатыЗапретаИзменения.НайденЗапретИзмененияДанных. +// +// Возвращаемое значение: +// Структура: +// * НоваяВерсия - Булево - если Истина, то сообщение о запрете необходимо +// сформировать для новой версии, иначе для старой версии. +// * Данные - ЛюбаяСсылка +// - СправочникОбъект +// - ДокументОбъект +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - ссылка, объект данных, +// или набор записей регистра, представление которого будет выведено в сообщении о запрете. +// - Структура: +// ** Регистр - Строка - полное имя регистра. +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор записей регистра. +// ** Отбор - Отбор - отбор набора записей. +// - Строка - подготовленное представление данных, +// которое будет выведено в сообщении о запрете. +// +Функция ПараметрыСообщенияОЗапрете() Экспорт +``` + +Пример вызова +```bsl +Результат = ДатыЗапретаИзменения.ПараметрыСообщенияОЗапрете() +``` +
+ +## ШаблонДанныхДляПроверки +
+ +Описание, пример вызова + +```bsl + +// Возвращает новую таблицу значений с колонками Дата, Раздел и Объект +// для заполнения и последующей передачи в функцию ДатыЗапретаИзменения.НайденЗапретИзмененияДанных. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Дата - Дата - дата без времени, которую нужно проверить на принадлежность установленным запретам. +// * Раздел - Строка - одно из имен разделов, указанных в процедуре +// ДатыЗапретаИзмененияПереопределяемый.ПриЗаполненииРазделовДатЗапретаИзменения +// * Объект - ЛюбаяСсылка - один из типов объектов, указанных для раздела в процедуре +// ДатыЗапретаИзмененияПереопределяемый.ПриЗаполненииРазделовДатЗапретаИзменения. +// +Функция ШаблонДанныхДляПроверки() Экспорт +``` + +Пример вызова +```bsl +Результат = ДатыЗапретаИзменения.ШаблонДанныхДляПроверки() +``` +
+ +## ОтключитьПроверкуДатЗапрета +
+ +Описание, пример вызова + +```bsl + +// В текущем сеансе отключает и включает проверку дат запрета изменения и загрузки данных. +// Требуется для реализации специальной логики работы и ускорения пакетной обработки данных +// при записи объекта или набора записей, когда признак ОбменДанными.Загрузка не установлен. +// +// Для использования требуются полные права или привилегированный режим. +// +// Рекомендуется: +// - массовой загрузке данных из файла (если данные не попадают в запрещенный период); +// - массовой загрузке данных при обмене данными (если данные не попадают в запрещенный период); +// - в случае, когда требуется отключить проверку дат запрета не для одного объекта, +// путем вставки свойства ПропуститьПроверкуЗапретаИзменения в ДополнительныеСвойства объекта, +// а для всех объектов, которые будут записываться в рамках записи этого объекта. +// +// Параметры: +// Отключить - Булево - Истина - отключает проверку дат запрета изменения и загрузки данных. +// Ложь - включает проверку дат запрета изменения и загрузки данных. +// +// Пример: +// +// Вариант 1. Запись набора объектов вне транзакции (ТранзакцияАктивна() = Ложь). +// +// ПроверкаДатЗапретаОтключена = ДатыЗапретаИзменения.ПроверкаДатЗапретаОтключена(); +// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(Истина); +// Попытка +// // Запись набора объектов. +// // ... +// Исключение +// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(ПроверкаДатЗапретаОтключена); +// //... +// ВызватьИсключение; +// КонецПопытки; +// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(ПроверкаДатЗапретаОтключена); +// +// Вариант 2. Запись набора объектов в транзакции (ТранзакцияАктивна() = Истина). +// +// ПроверкаДатЗапретаОтключена = ДатыЗапретаИзменения.ПроверкаДатЗапретаОтключена(); +// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(Истина); +// НачатьТранзакцию(); +// Попытка +// БлокировкаДанных.Заблокировать(); +// // ... +// // Запись набора объектов. +// // ... +// ЗафиксироватьТранзакцию(); +// Исключение +// ОтменитьТранзакцию(); +// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(ПроверкаДатЗапретаОтключена); +// //... +// ВызватьИсключение; +// КонецПопытки; +// ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(ПроверкаДатЗапретаОтключена); +// +Процедура ОтключитьПроверкуДатЗапрета(Отключить) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзменения.ОтключитьПроверкуДатЗапрета(Отключить) +``` +
+ +## ПроверкаДатЗапретаОтключена +
+ +Описание, пример вызова + +```bsl + +// Возвращает состояние отключения дат запрета, выполняемое +// процедурой ОтключитьПроверкуДатЗапрета. +// +// Возвращаемое значение: +// Булево +// +Функция ПроверкаДатЗапретаОтключена() Экспорт +``` + +Пример вызова +```bsl +Результат = ДатыЗапретаИзменения.ПроверкаДатЗапретаОтключена() +``` +
+ +## ПроверитьДатуЗапретаИзмененияПередЗаписью +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписью для проверки запрета изменения. +// +// Параметры: +// Источник - СправочникОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - объект данных, передаваемый в подписку на событие ПередЗаписью. +// +// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// +Процедура ПроверитьДатуЗапретаИзмененияПередЗаписью(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередЗаписью(Источник, Отказ) +``` +
+ +## ПроверитьДатуЗапретаИзмененияПередЗаписьюДокумента +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписью для проверки запрета изменения. +// +// Параметры: +// Источник - ДокументОбъект - объект данных, передаваемый в подписку на событие ПередЗаписью. +// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// РежимЗаписи - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// РежимПроведения - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// +Процедура ПроверитьДатуЗапретаИзмененияПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписью для проверки запрета изменения. +// +// Параметры: +// Источник - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей - набор записей, передаваемый в подписку на событие ПередЗаписью. +// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// Замещение - РежимЗамещения, Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// +Процедура ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписей(Источник, Отказ, Замещение) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписей(Источник, Отказ, Замещение) +``` +
+ +## ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраБухгалтерии +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписью для проверки запрета изменения. +// +// Параметры: +// Источник - РегистрБухгалтерииНаборЗаписей - набор записей, передаваемый +// в подписку на событие ПередЗаписью. +// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// Замещение - РежимЗамещения, Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// +Процедура ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраБухгалтерии( Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраБухгалтерии(); +``` +
+ +## ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраРасчета +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписью для проверки запрета изменения. +// +// Параметры: +// Источник - РегистрРасчетаНаборЗаписей - набор записей, передаваемый +// в подписку на событие ПередЗаписью. +// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// Замещение - РежимЗамещения, Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// ТолькоЗапись - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// ЗаписьФактическогоПериодаДействия - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// ЗаписьПерерасчетов - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// +Процедура ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраРасчета( Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередЗаписьюНабораЗаписейРегистраРасчета(); +``` +
+ +## ПроверитьДатуЗапретаИзмененияПередУдалением +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередУдалением для проверки запрета изменения. +// +// Параметры: +// Источник - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - объект данных, передаваемый в подписку на событие ПередЗаписью. +// +// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// +Процедура ПроверитьДатуЗапретаИзмененияПередУдалением(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзменения.ПроверитьДатуЗапретаИзмененияПередУдалением(Источник, Отказ) +``` +
+ +## ОбновитьРазделыДатЗапретаИзменения +
+ +Описание, пример вызова + +```bsl + +// Не требуется вызывать, так как обновление выполняется автоматически. +Процедура ОбновитьРазделыДатЗапретаИзменения() Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзменения.ОбновитьРазделыДатЗапретаИзменения() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ДатыЗапретаИзмененияПереопределяемый.md b/src/content/docs/bsp/ДатыЗапретаИзмененияПереопределяемый.md new file mode 100644 index 0000000..d0a12bf --- /dev/null +++ b/src/content/docs/bsp/ДатыЗапретаИзмененияПереопределяемый.md @@ -0,0 +1,270 @@ +--- +title: Даты запрета изменения переопределяемый +slug: bsp/даты-запрета-изменения-переопределяемый +--- + + +## НастройкаИнтерфейса +
+ +Описание, пример вызова + +```bsl + +// Позволяет изменить работу интерфейса при встраивании. +// +// Параметры: +// НастройкиРаботыИнтерфейса - Структура: +// * ИспользоватьВнешнихПользователей - Булево - начальное значение Ложь, +// если установить Истина, тогда даты запрета можно будет настраивать для внешних пользователей. +// +Процедура НастройкаИнтерфейса(НастройкиРаботыИнтерфейса) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзмененияПереопределяемый.НастройкаИнтерфейса(НастройкиРаботыИнтерфейса) +``` +
+ +## ПриЗаполненииРазделовДатЗапретаИзменения +
+ +Описание, пример вызова + +```bsl + +// Заполняет разделы дат запрета изменения, используемые при настройке дат запрета. +// Если не указать ни одного раздела, тогда будет доступна только настройка общей даты запрета. +// +// Параметры: +// Разделы - ТаблицаЗначений: +// * Имя - Строка - имя, используемое в описании источников данных в +// процедуре ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения. +// +// * Идентификатор - УникальныйИдентификатор - идентификатор ссылки элемента плана видов характеристик. +// Чтобы получить идентификатор, нужно в режиме 1С:Предприятие выполнить метод платформы: +// "ПланыВидовХарактеристик.РазделыДатЗапретаИзменения.ПолучитьСсылку().УникальныйИдентификатор()". +// Не следует указывать идентификаторы, полученные любым другим способом, +// так как это может нарушить их уникальность. +// +// * Представление - Строка - представляет раздел в форме настройки дат запрета. +// +// * ТипыОбъектов - Массив - типы ссылок объектов, в разрезе которых можно настроить даты запрета, +// например Тип("СправочникСсылка.Организации"); если не указано ни одного типа, +// то даты запрета будут настраиваться только с точностью до раздела. +// +Процедура ПриЗаполненииРазделовДатЗапретаИзменения(Разделы) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзмененияПереопределяемый.ПриЗаполненииРазделовДатЗапретаИзменения(Разделы) +``` +
+ +## ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения +
+ +Описание, пример вызова + +```bsl + +// Позволяет задать таблицы и поля объектов для проверки запрета изменения данных. +// Для добавления нового источника в ИсточникиДанных см. ДатыЗапретаИзменения.ДобавитьСтроку. +// +// Вызывается из процедуры ИзменениеЗапрещено общего модуля ДатыЗапретаИзменения, +// используемой в подписке на событие ПередЗаписью объекта для проверки наличия +// запретов и отказа от изменений запрещенного объекта. +// +// Параметры: +// ИсточникиДанных - ТаблицаЗначений: +// * Таблица - Строка - полное имя объекта метаданных, +// например Метаданные.Документы.ПриходнаяНакладная.ПолноеИмя(). +// * ПолеДаты - Строка - имя реквизита объекта или табличной части, +// например: "Дата", "Товары.ДатаОтгрузки". +// * Раздел - Строка - имя раздела дат запрета, указанного в +// процедуре ПриЗаполненииРазделовДатЗапретаИзменения (см. выше). +// * ПолеОбъекта - Строка - имя реквизита объекта или реквизита табличной части, +// например: "Организация", "Товары.Склад". +// +Процедура ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения(ИсточникиДанных) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзмененияПереопределяемый.ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения(ИсточникиДанных) +``` +
+ +## ПередПроверкойЗапретаИзменения +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить выполнение проверки запрета изменения произвольным образом. +// +// Если проверка выполняется в процессе записи документа, то в свойстве ДополнительныеСвойства +// документа Объект имеется свойство РежимЗаписи (РежимЗаписиДокумента). +// Если выполняется проверка набора записей, то в свойстве ДополнительныеСвойства +// набора записей Объект имеется свойство Замещение (Булево, РежимЗамещения). Причем, в варианте +// замены записей настроено свойство Отбор для получения существующих записей из базы данных. +// +// Параметры: +// Объект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - проверяемый элемент данных или набор записей +// (как в обработчиках ПередЗаписью и ПриЧтенииНаСервере). +// +// ПроверкаЗапретаИзменения - Булево - установить в Ложь, чтобы пропустить проверку запрета изменения данных. +// УзелПроверкиЗапретаЗагрузки - ПланОбменаСсылка +// - Неопределено - установить в Неопределено, чтобы +// пропустить проверку запрета загрузки данных. +// ВерсияОбъекта - Строка - установить "СтараяВерсия" или "НоваяВерсия", чтобы +// выполнить проверку только старой версии объекта (в базе данных) +// или только новой версии объекта (в параметре Объект). +// По умолчанию содержит значение "" - проверяются обе версии объекта сразу. +// +Процедура ПередПроверкойЗапретаИзменения(Объект, Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзмененияПереопределяемый.ПередПроверкойЗапретаИзменения(Объект, ); +``` +
+ +## ПередПроверкойСтаройВерсииДанных +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить получение данных для проверки даты запрета старой (существующей) версии данных. +// Если заполнить ДанныеДляПроверки, тогда они не будут автоматически загружаться из +// базы данных по значениям параметров ОбъектМетаданных и ИдентификаторДанных. +// +// Если выполняется проверка набора записей, то в свойстве ДополнительныеСвойства +// набора записей ИдентификаторДанных имеется свойство Замещение (Булево, РежимЗамещения) +// с возможными значениями: Замещение, Обновление, Слияние, Удаление. Причем, в варианте +// замены записей настроено свойство Отбор для получения существующих записей из базы данных. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект метаданных получаемых данных. +// ИдентификаторДанных - СправочникСсылка +// - ДокументСсылка +// - ПланВидовХарактеристикСсылка +// - ПланСчетовСсылка +// - ПланВидовРасчетаСсылка +// - БизнесПроцессСсылка +// - ЗадачаСсылка +// - ПланОбменаСсылка - ссылка на элемент данных. +// - Отбор - отбор набора записей, когда Замещение равно Истина. +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор записей, когда Замещение не Булево. +// +// УзелПроверкиЗапретаЗагрузки - Неопределено +// - ПланОбменаСсылка - если Неопределено, то проверить запрет +// изменения данных; иначе - загрузку данных из указанного узла плана обмена. +// +// ДанныеДляПроверки - см. ДатыЗапретаИзменения.ШаблонДанныхДляПроверки. +// +// Пример: +// Если ТипЗнч(ИдентификаторДанных) = Тип("ДокументСсылка.Заказ") Тогда +// Данные = ОбщегоНазначения.ЗначенияРеквизитовОбъекта(ИдентификаторДанных, "Организация, ДатаОкончанияРабот, ЗаказНаряд"); +// Если Данные.ЗаказНаряд Тогда +// Проверка = ДанныеДляПроверки.Добавить(); +// Проверка.Раздел = "ЗаказНаряды"; +// Проверка.Объект = Данные.Организация; +// Проверка.Дата = Данные.ДатаОкончанияРабот; +// КонецЕсли; +// КонецЕсли; +// +Процедура ПередПроверкойСтаройВерсииДанных(ОбъектМетаданных, ИдентификаторДанных, УзелПроверкиЗапретаЗагрузки, ДанныеДляПроверки) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзмененияПереопределяемый.ПередПроверкойСтаройВерсииДанных(ОбъектМетаданных, ИдентификаторДанных, УзелПроверкиЗапретаЗагрузки, ДанныеДляПроверки) +``` +
+ +## ПередПроверкойНовойВерсииДанных +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить получение данных для проверки даты запрета новой (будущей) версии данных. +// Если заполнить ДанныеДляПроверки, тогда они не будут автоматически извлекаться из объекта и +// дополнительно загружаться из базы данных по значениям параметров ОбъектМетаданных и Данные. +// +// Если проверка выполняется в процессе записи документа, то в свойстве ДополнительныеСвойства +// документа Данные имеется свойство РежимЗаписи (РежимЗаписиДокумента). +// Если выполняется проверка набора записей, то в свойстве ДополнительныеСвойства +// набора записей Данные имеется свойство Замещение (Булево, РежимЗамещения) +// с возможными значениями: Добавление, Замещение, Обновление, Слияние. Причем, в варианте +// замены записей настроено свойство Отбор для получения существующих записей из базы данных. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект метаданных получаемых данных. +// Данные - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - проверяемый элемент данных или набор записей. +// +// УзелПроверкиЗапретаЗагрузки - Неопределено +// - ПланОбменаСсылка - если Неопределено, то проверить запрет +// изменения данных; иначе - загрузку данных из указанного узла плана обмена. +// +// ДанныеДляПроверки - см. ДатыЗапретаИзменения.ШаблонДанныхДляПроверки. +// +// Пример: +// Если ТипЗнч(Данные) = Тип("ДокументОбъект.Заказ") И Данные.ЗаказНаряд Тогда +// +// Проверка = ДанныеДляПроверки.Добавить(); +// Проверка.Раздел = "ЗаказНаряды"; +// Проверка.Объект = Данные.Организация; +// Проверка.Дата = Данные.ДатаОкончанияРабот; +// +// КонецЕсли; +// +Процедура ПередПроверкойНовойВерсииДанных(ОбъектМетаданных, Данные, УзелПроверкиЗапретаЗагрузки, ДанныеДляПроверки) Экспорт +``` + +Пример вызова +```bsl +ДатыЗапретаИзмененияПереопределяемый.ПередПроверкойНовойВерсииДанных(ОбъектМетаданных, Данные, УзелПроверкиЗапретаЗагрузки, ДанныеДляПроверки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ДлительныеОперации.md b/src/content/docs/bsp/ДлительныеОперации.md new file mode 100644 index 0000000..71f9afc --- /dev/null +++ b/src/content/docs/bsp/ДлительныеОперации.md @@ -0,0 +1,854 @@ +--- +title: Длительные операции +slug: bsp/длительные-операции +--- + + +## ВыполнитьФункцию +
+ +Описание, пример вызова + +```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, ); +``` +
+ +## ВыполнитьПроцедуру +
+ +Описание, пример вызова + +```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, ); +``` +
+ +## ВыполнитьФункциюВНесколькоПотоков +
+ +Описание, пример вызова + +```bsl + +// АПК:141-вкл +// АПК:134-вкл +// АПК:142-вкл + +// Запустить выполнение функции в многопоточном фоновом задании, если это возможно. +// Вызываемая процедура может быть с произвольным числом параметров, но не более 7. +// Значения передаваемых параметров процедуры, а также возвращаемое значение должны быть сериализуемыми. +// Параметры процедуры не должны быть возвращаемыми. +// Многопоточные длительные операции в неразделенном сеансе не поддерживаются. +// +// Не следует использовать эту функцию, если необходимо безусловно запускать фоновое задание. +// Рекомендуется применять совместно с функцией ДлительныеОперацииКлиент.ОжидатьЗавершение, +// если невозможно, тогда для проверки завершения операции использовать функцию ЗаданиеВыполнено. +// +// Параметры: +// ИмяФункции - Строка - имя экспортной функции общего модуля, модуля менеджера объекта +// или модуля обработки, которую необходимо выполнить в фоне. +// Например, "МойОбщийМодуль.МояПроцедура", "Отчеты.ЗагруженныеДанные.Сформировать" +// или "Обработки.ЗагрузкаДанных.МодульОбъекта.Загрузить". +// ПараметрыВыполнения - см. ПараметрыВыполненияФункции +// НаборПараметровФункции - Соответствие из КлючИЗначение - произвольный набор параметров вызова функции: +// * Ключ - Произвольный - ключ набора +// * Значение - Массив - параметры вызова функции. Количество параметров может быть от 0 до 7. +// +// Возвращаемое значение: +// Структура: +// * Статус - Строка - "Выполняется", если задание еще не завершилось; +// "Выполнено", если задание было успешно выполнено; +// "Ошибка", если задание завершено с ошибкой; +// "Отменено", если задание отменено пользователем или администратором. +// * ИдентификаторЗадания - УникальныйИдентификатор - если Статус = "Выполняется", то содержит +// идентификатор запущенного фонового задания. +// - Неопределено - если Статус <> "Выполняется" и фоновое задание не запускалось. +// * АдресРезультата - Строка - адрес временного хранилища, в которое будет помещено Соответствие: +// ** Ключ - Произвольный +// ** Значение - см. ВыполнитьФункцию +// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка". +// - Неопределено - если Статус <> "Ошибка". +// * Сообщения - ФиксированныйМассив - если Статус <> "Выполняется", то массив объектов СообщениеПользователю, +// которые были сформированы в фоновом задании. +// * КраткоеПредставлениеОшибки - Строка - устарел. +// * ПодробноеПредставлениеОшибки - Строка - устарел. +// +Функция ВыполнитьФункциюВНесколькоПотоков(ИмяФункции, Знач ПараметрыВыполнения, Знач НаборПараметровФункции = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперации.ВыполнитьФункциюВНесколькоПотоков(ИмяФункции, ПараметрыВыполнения, НаборПараметровФункции); +``` +
+ +## ВыполнитьПроцедуруВНесколькоПотоков +
+ +Описание, пример вызова + +```bsl + +// Запускает выполнение процедуры в многопоточном фоновом задании, если это возможно. +// Вызываемая процедура может быть с произвольным числом параметров, но не более 7. +// Значения передаваемых параметров процедуры, а также возвращаемое значение должны быть сериализуемыми. +// Параметры процедуры не должны быть возвращаемыми. +// Многопоточные длительные операции в неразделенном сеансе не поддерживаются. +// +// Не следует использовать эту функцию, если необходимо безусловно запускать фоновое задание. +// Рекомендуется применять совместно с функцией ДлительныеОперацииКлиент.ОжидатьЗавершение, +// если невозможно, тогда для проверки завершения операции использовать функцию ЗаданиеВыполнено. +// +// Параметры: +// ИмяПроцедуры - Строка - имя экспортной процедуры общего модуля, модуля менеджера объекта +// или модуля обработки, которую необходимо выполнить в фоне. +// ПараметрыВыполнения - см. ПараметрыВыполненияПроцедуры +// НаборПараметровПроцедуры - Соответствие из КлючИЗначение - произвольный набор параметров вызова процедуры: +// * Ключ - Произвольный - ключ набора +// * Значение - Массив - параметры вызова процедуры. Количество параметров может быть от 0 до 7. +// +// Возвращаемое значение: +// Структура: +// * Статус - Строка - "Выполняется", если задание еще не завершилось; +// "Выполнено", если задание было успешно выполнено; +// "Ошибка", если задание завершено с ошибкой; +// "Отменено", если задание отменено пользователем или администратором. +// * ИдентификаторЗадания - УникальныйИдентификатор - если Статус = "Выполняется", то содержит +// идентификатор запущенного фонового задания. +// - Неопределено - если Статус <> "Выполняется" и фоновое задание не запускалось. +// * АдресРезультата - Строка - адрес временного хранилища, в которое будет помещено Соответствие: +// ** Ключ - Произвольный +// ** Значение - см. ВыполнитьПроцедуру +// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка". +// - Неопределено - если Статус <> "Ошибка". +// * Сообщения - ФиксированныйМассив - если Статус <> "Выполняется", то массив объектов СообщениеПользователю, +// которые были сформированы в фоновом задании. +// * КраткоеПредставлениеОшибки - Строка - устарел. +// * ПодробноеПредставлениеОшибки - Строка - устарел. +// +Функция ВыполнитьПроцедуруВНесколькоПотоков(ИмяПроцедуры, Знач ПараметрыВыполнения, Знач НаборПараметровПроцедуры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперации.ВыполнитьПроцедуруВНесколькоПотоков(ИмяПроцедуры, ПараметрыВыполнения, НаборПараметровПроцедуры); +``` +
+ +## ПараметрыВыполненияФункции +
+ +Описание, пример вызова + +```bsl + +// Конструктор коллекции ПараметрыВыполненияФункции для функции ВыполнитьФункцию. +// +// Если ЗапуститьВФоне = Ложь и ЗапуститьНеВФоне = Ложь, то задание будет выполнено в фоне по возможности. +// Запуск с расширениями сеанса выполняется сразу в основном потоке при выполнении любого из следующих условий: +// * если вызов выполняется в файловой базе во внешнем соединении (в этом режиме фоновые задания не поддерживаются); +// * если приложение запущено в режиме отладки (параметр /C РежимОтладки) - для упрощения отладки конфигурации; +// * если в файловой ИБ имеются активные фоновые задания - для снижения времени ожидания пользователя. +// +// Параметры: +// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, +// во временное хранилище которой надо поместить результат выполнения процедуры. +// +// Возвращаемое значение: +// Структура - параметры выполнения длительной операции: +// * ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, +// во временное хранилище которой надо поместить результат выполнения процедуры. +// * ОжидатьЗавершение - Неопределено - ждать до момента завершения фонового задания. +// - Число - таймаут в секундах ожидания завершения фонового задания. +// Если задано 0, то ждать завершения задания не требуется. +// По умолчанию - 0.8 секунды, а для низкой скорости соединения - 4. +// * НаименованиеФоновогоЗадания - Строка - описание фонового задания. По умолчанию - имя процедуры. +// * КлючФоновогоЗадания - Строка - уникальный ключ активных фоновых заданий с одинаковым именем процедуры, +// чтобы в приложении нельзя было запустить более одного задания одновременно. +// По умолчанию не задан. +// * АдресРезультата - Строка - адрес временного хранилища, в которое должен быть помещен результат +// работы процедуры. Если не задан, адрес формируется автоматически. +// * ЗапуститьВФоне - Булево - если Истина, то задание будет всегда выполняться в фоне, кроме ситуаций: +// а) если вызов выполняется в файловой базе во внешнем соединении +// (в этом режиме фоновые задания не поддерживаются); +// б) если выполняется функция модуля внешней обработки или внешнего отчета. +// Кроме того, в файловом варианте при наличии ранее запущенных фоновых заданий, +// новое задание становится в очередь и начинает выполняться после завершения предыдущих. +// Если Ложь, то задание будет выполнено в фоне по возможности. +// * ЗапуститьНеВФоне - Булево - если Истина, задание всегда будет запускаться непосредственно, +// без использования фонового задания. +// * БезРасширений - Булево - если Истина, то фоновое задание будет запущено без подключения +// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне. +// * СРасширениямиБазыДанных - Булево - если Истина, то фоновое задание будет запущено с последней версией +// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне. +// * ВнешнийОтчетОбработка - Неопределено - по умолчанию. +// - ДвоичныеДанные - когда указано имя метода, которое начинается +// с "ВнешнийОтчет." или "ВнешняяОбработка.". +// Для вызова такого метода требуется право интерактивного открытия +// внешнего отчета или обработки соответственно. +// Внешний отчет или обработка подключаются с защитой от опасных действий. +// * ПрерватьВыполнениеЕслиОшибка - Булево - если Истина, то при возникновении ошибки в одном из дочерних фоновых +// заданий, выполнение многопоточного фонового задания будет прервано. +// Выполнение уже запущенных дочерних фоновых задания будет отменно. +// Параметр только для функции ВыполнитьФункциюВНесколькоПотоков. +// * УточнениеОшибки - Строка - если не пустая строка, тогда для пользователя текст ошибки +// будет уточнен указанным начальным текстом. Пример уточнения: +// НСтр("ru = 'Не удалось очистить адресный классификатор по причине:'") +// +Функция ПараметрыВыполненияФункции(Знач ИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперации.ПараметрыВыполненияФункции(ИдентификаторФормы) +``` +
+ +## ПараметрыВыполненияПроцедуры +
+ +Описание, пример вызова + +```bsl + +// Конструктор коллекции ПараметрыВыполненияПроцедуры для функции ВыполнитьПроцедуру. +// +// Если ЗапуститьВФоне = Ложь и ЗапуститьНеВФоне = Ложь, то задание будет выполнено в фоне по возможности. +// Запуск с расширениями сеанса выполняется сразу в основном потоке при выполнении любого из следующих условий: +// * если вызов выполняется в файловой базе во внешнем соединении (в этом режиме фоновые задания не поддерживаются); +// * если приложение запущено в режиме отладки (параметр /C РежимОтладки) - для упрощения отладки конфигурации; +// * если в файловой ИБ имеются активные фоновые задания - для снижения времени ожидания пользователя. +// +// Возвращаемое значение: +// Структура - параметры выполнения длительной операции: +// * ОжидатьЗавершение - Неопределено - ждать до момента завершения фонового задания. +// - Число - таймаут в секундах ожидания завершения фонового задания. +// Если задано 0, то ждать завершения задания не требуется. +// По умолчанию - 0.8 секунды, а для низкой скорости соединения - 4. +// * НаименованиеФоновогоЗадания - Строка - описание фонового задания. По умолчанию - имя процедуры. +// * КлючФоновогоЗадания - Строка - уникальный ключ для активных фоновых заданий, имеющих такое же имя процедуры. +// По умолчанию не задан. +// * ЗапуститьВФоне - Булево - если Истина, то задание будет всегда выполняться в фоне, кроме ситуаций: +// а) если вызов выполняется в файловой базе во внешнем соединении +// (в этом режиме фоновые задания не поддерживаются); +// б) если выполняется функция модуля внешней обработки или внешнего отчета. +// Кроме того, в файловом варианте при наличии ранее запущенных фоновых заданий, +// новое задание становится в очередь и начинает выполняться после завершения предыдущих. +// Если Ложь, то задание будет выполнено в фоне по возможности. +// * ЗапуститьНеВФоне - Булево - если Истина, задание всегда будет запускаться непосредственно, +// без использования фонового задания. +// * БезРасширений - Булево - если Истина, то фоновое задание будет запущено без подключения +// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне. +// * СРасширениямиБазыДанных - Булево - если Истина, то фоновое задание будет запущено с последней версией +// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне. +// * ВнешнийОтчетОбработка - Неопределено - по умолчанию. +// - ДвоичныеДанные - когда указано имя метода, которое начинается +// с "ВнешнийОтчет." или "ВнешняяОбработка.". +// Для вызова такого метода требуется право интерактивного открытия +// внешнего отчета или обработки соответственно. +// Внешний отчет или обработка подключаются с защитой от опасных действий. +// * ПрерватьВыполнениеЕслиОшибка - Булево - если Истина, то при возникновении ошибки в одном из дочерних фоновых +// заданий, выполнение многопоточного фонового задания будет прервано. +// Выполнение уже запущенных дочерних фоновых задания будет отменно. +// Параметр только для функции ВыполнитьПроцедуруВНесколькоПотоков. +// * УточнениеОшибки - Строка - если не пустая строка, тогда для пользователя текст ошибки +// будет уточнен указанным начальным текстом. Пример уточнения: +// НСтр("ru = 'Не удалось очистить адресный классификатор по причине:'") +// +Функция ПараметрыВыполненияПроцедуры() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперации.ПараметрыВыполненияПроцедуры() +``` +
+ +## ВыполнитьВФоне +
+ +Описание, пример вызова + +```bsl + +// Вместо этой функции рекомендуется использовать функции ВыполнитьФункцию и ВыполнитьПроцедуру. +// +// Запустить выполнение процедуры в фоновом задании, если это возможно. +// Не следует использовать эту функцию, если необходимо безусловно запускать фоновое задание. +// Рекомендуется применять совместно с функцией ДлительныеОперацииКлиент.ОжидатьЗавершение, +// если невозможно, тогда для проверки завершения операции использовать функцию ЗаданиеВыполнено. +// +// Параметры: +// ИмяПроцедуры - Строка - имя экспортной процедуры общего модуля, модуля менеджера объекта +// или модуля обработки, которую необходимо выполнить в фоне. +// Например, "МойОбщийМодуль.МояПроцедура", "Отчет.ЗагруженныеДанные.Сформировать" +// или "Обработка.ЗагрузкаДанных.МодульОбъекта.Загрузить". +// У процедуры должно быть два или три формальных параметра: +// * Параметры - Структура - произвольные параметры ПараметрыПроцедуры; +// * АдресРезультата - Строка - адрес временного хранилища, в которое нужно +// поместить результат работы процедуры. Обязательно; +// * АдресДополнительногоРезультата - Строка - если в ПараметрыВыполнения установлен +// параметр ДополнительныйРезультат, то содержит адрес дополнительного временного +// хранилища, в которое нужно поместить результат работы процедуры. Опционально. +// При необходимости выполнить в фоне функцию ее следует обернуть в процедуру, +// а ее результат возвращать через второй параметр АдресРезультата. +// ПараметрыПроцедуры - Структура - произвольные параметры вызова процедуры ИмяПроцедуры. +// ПараметрыВыполнения - см. ДлительныеОперации.ПараметрыВыполненияВФоне +// +// Возвращаемое значение: +// Структура: +// * Статус - Строка - "Выполняется", если задание еще не завершилось; +// "Выполнено", если задание было успешно выполнено; +// "Ошибка", если задание завершено с ошибкой; +// "Отменено", если задание отменено пользователем или администратором. +// * ИдентификаторЗадания - УникальныйИдентификатор - если Статус = "Выполняется", то содержит +// идентификатор запущенного фонового задания. +// - Неопределено - если Статус <> "Выполняется" и фоновое задание не запускалось. +// * АдресРезультата - Строка - адрес временного хранилища, в которое будет помещен результат работы процедуры +// (или уже помещен, если Статус = "Выполнено"). +// * АдресДополнительногоРезультата - Строка - если установлен параметр ДополнительныйРезультат, +// содержит адрес дополнительного временного хранилища, +// в которое будет помещен результат работы процедуры +// (или уже помещен, если Статус = "Выполнено"). +// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка". +// - Неопределено - если Статус <> "Ошибка". +// * Сообщения - ФиксированныйМассив - если Статус <> "Выполняется", то массив объектов СообщениеПользователю, +// которые были сформированы в фоновом задании. +// * КраткоеПредставлениеОшибки - Строка - устарел. +// * ПодробноеПредставлениеОшибки - Строка - устарел. +// +// Пример: +// В общем виде процесс запуска и обработки результата длительной операции выглядит следующим образом: +// +// 1) Процедура, которая будет исполняться в фоне, располагается в модуле менеджера объекта или в серверном общем модуле: +// Процедура ВыполнитьДействие(Параметры, АдресРезультата) Экспорт +// ... +// ПоместитьВоВременноеХранилище(Результат, АдресРезультата); +// КонецПроцедуры +// +// 2) Запуск операции на сервере и подключение обработчика ожидания: +// &НаКлиенте +// Процедура ВыполнитьДействие() +// ДлительнаяОперация = НачатьВыполнениеНаСервере(); +// ПараметрыОжидания = ДлительныеОперацииКлиент.ПараметрыОжидания(ЭтотОбъект); +// ... +// ОповещениеОЗавершении = Новый ОписаниеОповещения("ВыполнитьДействиеЗавершение", ЭтотОбъект); +// ДлительныеОперацииКлиент.ОжидатьЗавершение(ДлительнаяОперация, ОповещениеОЗавершении, ПараметрыОжидания); +// КонецПроцедуры +// +// &НаСервере +// Функция НачатьВыполнениеНаСервере() +// ПараметрыПроцедуры = Новый Структура; +// ... +// ПараметрыВыполнения = ДлительныеОперации.ПараметрыВыполненияВФоне(УникальныйИдентификатор); +// ... +// Возврат ДлительныеОперации.ВыполнитьВФоне("Обработка.МояОбработка.ВыполнитьДействие", +// ПараметрыПроцедуры, ПараметрыВыполнения); +// КонецФункции +// +// 3) Обработка результата выполнения операции: +// &НаКлиенте +// Процедура ВыполнитьДействиеЗавершение(Результат, ДополнительныеПараметры) Экспорт +// Если Результат = Неопределено Тогда +// Возврат; +// КонецЕсли; +// Если Результат.Статус = "Ошибка" Тогда +// СтандартныеПодсистемыКлиент.ВывестиИнформациюОбОшибке(Результат.ИнформацияОбОшибке); +// Возврат; +// КонецЕсли; +// ВывестиРезультат(Результат); +// КонецПроцедуры +// +Функция ВыполнитьВФоне(Знач ИмяПроцедуры, Знач ПараметрыПроцедуры, Знач ПараметрыВыполнения) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперации.ВыполнитьВФоне(ИмяПроцедуры, ПараметрыПроцедуры, ПараметрыВыполнения) +``` +
+ +## ПараметрыВыполненияВФоне +
+ +Описание, пример вызова + +```bsl + +// Возвращает новую структуру для параметра ПараметрыВыполнения функции ВыполнитьВФоне. +// +// Если ЗапуститьВФоне = Ложь и ЗапуститьНеВФоне = Ложь, то задание будет выполнено в фоне по возможности. +// Запуск с расширениями сеанса выполняется сразу в основном потоке при выполнении любого из следующих условий: +// * если вызов выполняется в файловой базе во внешнем соединении (в этом режиме фоновые задания не поддерживаются); +// * если приложение запущено в режиме отладки (параметр /C РежимОтладки) - для упрощения отладки конфигурации; +// * если в файловой ИБ имеются активные фоновые задания - для снижения времени ожидания пользователя. +// +// Параметры: +// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, во временное хранилище которой +// необходимо поместить результат выполнения процедуры. +// - Неопределено - если временное хранилище не нужно создавать автоматически на время жизни +// формы, а его адрес предполагается задавать явно в свойстве АдресРезультата. +// В таком случае, временное хранилище нужно очищать явно при обработке результата +// длительной операции с помощью метода УдалитьИзВременногоХранилища. +// Возвращаемое значение: +// Структура: +// * ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, +// во временное хранилище которой надо поместить результат выполнения процедуры. +// * ДополнительныйРезультат - Булево - признак использования дополнительного временного хранилища для передачи +// результата из фонового задания в родительский сеанс. По умолчанию - Ложь. +// * ОжидатьЗавершение - Неопределено - ждать до момента завершения фонового задания. +// - Число - таймаут в секундах ожидания завершения фонового задания. +// Если задано 0, то ждать завершения задания не требуется. +// По умолчанию - 0.8 секунды, а для низкой скорости соединения - 4. +// * НаименованиеФоновогоЗадания - Строка - описание фонового задания. По умолчанию - имя процедуры. +// * КлючФоновогоЗадания - Строка - уникальный ключ для активных фоновых заданий, имеющих такое же имя процедуры. +// По умолчанию не задан. +// * АдресРезультата - Строка - адрес временного хранилища, в которое должен быть помещен результат +// работы процедуры. Если не задан, адрес формируется автоматически +// на время жизни формы с помощью идентификатора ИдентификаторФормы. +// * ЗапуститьВФоне - Булево - если Истина, то задание будет всегда выполняться в фоне, кроме ситуаций: +// а) если вызов выполняется в файловой базе во внешнем соединении +// (в этом режиме фоновые задания не поддерживаются); +// б) если выполняется функция модуля внешней обработки или внешнего отчета. +// Кроме того, в файловом варианте при наличии ранее запущенных фоновых заданий, +// новое задание становится в очередь и начинает выполняться после завершения предыдущих. +// Если Ложь, то задание будет выполнено в фоне по возможности. +// * ЗапуститьНеВФоне - Булево - если Истина, задание всегда будет запускаться непосредственно, +// без использования фонового задания. +// * БезРасширений - Булево - если Истина, то фоновое задание будет запущено без подключения +// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне. +// * СРасширениямиБазыДанных - Булево - если Истина, то фоновое задание будет запущено с последней версией +// расширений конфигурации. Имеет приоритет над параметром ЗапуститьНеВФоне. +// * ВнешнийОтчетОбработка - Неопределено - по умолчанию. +// - ДвоичныеДанные - когда указано имя метода, которое начинается +// с "ВнешнийОтчет." или "ВнешняяОбработка.". +// Для вызова такого метода требуется право интерактивного открытия +// внешнего отчета или обработки соответственно. +// Внешний отчет или обработка подключаются с защитой от опасных действий. +// * УточнениеОшибки - Строка - если не пустая строка, тогда для пользователя текст ошибки +// будет уточнен указанным начальным текстом. Пример уточнения: +// НСтр("ru = 'Не удалось очистить адресный классификатор по причине:'") +// +Функция ПараметрыВыполненияВФоне(Знач ИдентификаторФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперации.ПараметрыВыполненияВФоне(ИдентификаторФормы); +``` +
+ +## СообщитьПрогресс +
+ +Описание, пример вызова + +```bsl + +// Регистрирует информацию о ходе выполнения длительной операции. +// Не следует использовать для передачи результата работы длительной операции по частям. +// +// Во избежание избыточного потребления памяти и ее утечек при выполнении одной длительной операции +// не следует сообщать прогресс более 100 раз. +// +// Если прогресс сообщается менее чем через 3 сек после предыдущего вызова, то последнее сообщение +// удаляется и заменяется на новое (если используется система взаимодействия, то отправка нового +// сообщения не выполняется, а будет выполнена спустя некоторое время - не быстрее 3 сек). +// +// Перед отправкой прогресса отправляются все сообщения, накопленные в очереди сообщений фонового задания. +// +// Для того чтобы выводить ход выполнения длительной операции для пользователя в стандартной форме ожидания, +// следует установить свойство ВыводитьПрогрессВыполнения в Истина (см. ДлительныеОперацииКлиент.ПараметрыОжидания). +// +// Параметры: +// Процент - Число - процент выполнения. +// Текст - Строка - информация о текущей операции. +// ДополнительныеПараметры - Произвольный - любая дополнительная информация, которую необходимо передать на клиент. +// Значение должно быть простым (сериализуемым в XML-строку). +// Размер данных не должен превышать размер, указанный для параметра Результат +// процедуры СерверныеОповещения.ОтправитьСерверноеОповещение. +// +Процедура СообщитьПрогресс(Знач Процент = Неопределено, Знач Текст = Неопределено, Знач ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДлительныеОперации.СообщитьПрогресс(Процент, Текст, ДополнительныеПараметры); +``` +
+ +## ПрочитатьПрогресс +
+ +Описание, пример вызова + +```bsl + +// Считывает информацию о ходе выполнения длительной операции, +// записанную процедурой ДлительныеОперации.СообщитьПрогресс. +// +// Рекомендуется получать прогресс через обработчик оповещения, +// который подключается с помощью ДлительныеОперацииКлиент.ОжидатьЗавершение. +// +// Параметры: +// ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания. +// +// Возвращаемое значение: +// Неопределено - нет информации о ходе выполнения. +// Структура: +// * Процент - Число - необязательный. Процент выполнения. +// * Текст - Строка - необязательный. Информация о текущей операции. +// * ДополнительныеПараметры - Произвольный - необязательный. Любая дополнительная информация. +// +Функция ПрочитатьПрогресс(Знач ИдентификаторЗадания) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперации.ПрочитатьПрогресс(ИдентификаторЗадания) +``` +
+ +## ОтменитьВыполнениеЗадания +
+ +Описание, пример вызова + +```bsl + +// Отменяет выполнение фонового задания по переданному идентификатору. +// При этом если в длительной операции открывались транзакции, то будет произведен откат последней открытой транзакции. +// +// Таким образом, если длительная операция выполняет обработку (запись) данных, то для полной отмены всей операции +// следует выполнять запись в одной транзакции (в таком случае, будет отменена вся транзакция целиком). +// Если же достаточно, чтобы длительная операция была не отменена целиком, а прервана на достигнутом этапе, +// то, напротив, открывать одну длинную транзакцию не требуется. +// +// Параметры: +// ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания, полученный при запуске +// длительной операции. Смотри ДлительныеОперации.ВыполнитьВФоне. +// +Процедура ОтменитьВыполнениеЗадания(Знач ИдентификаторЗадания) Экспорт +``` + +Пример вызова +```bsl +ДлительныеОперации.ОтменитьВыполнениеЗадания(ИдентификаторЗадания) +``` +
+ +## ЗаданиеВыполнено +
+ +Описание, пример вызова + +```bsl + +// Проверяет состояние фонового задания по переданному идентификатору. +// При аварийном завершении задания вызывает исключение с текстом ошибки, +// возникшим в нем, и уточнением вида "См. также журнал регистрации". +// +// Параметры: +// ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания. +// РасширенныйРезультат - Булево - если Истина, вернуть структуру. +// +// Возвращаемое значение: +// Булево - состояние выполнения задания. +// Структура: +// * Статус - Строка - "Выполняется", если задание еще не завершилось; +// "Выполнено", если задание было успешно выполнено; +// "Ошибка", если задание завершено с ошибкой; +// "Отменено", если задание отменено пользователем или администратором. +// +// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка" или Статус = "Отменено". +// - Неопределено - если Статус <> "Ошибка" и Статус <> "Отменено". +// +// * ИдентификаторЗадания - УникальныйИдентификатор - последний идентификатор задания, +// если были перезапуски (например, при многопоточной длительной операции) +// или тот же идентификатор, что передан в функцию, когда перезапусков не было. +// +// * Задание - Неопределено - задание не найдено. +// - ФоновоеЗадание - когда задание найдено. +// +// * ТекстОшибки - Строка - устарел. +// * КраткоеПредставлениеОшибки - Строка - устарел. +// * ПодробноеПредставлениеОшибки - Строка - устарел. +// +Функция ЗаданиеВыполнено(Знач ИдентификаторЗадания, РасширенныйРезультат = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперации.ЗаданиеВыполнено(ИдентификаторЗадания, РасширенныйРезультат); +``` +
+ +## СообщенияПользователю +
+ +Описание, пример вызова + +```bsl + +// Получает сообщения пользователю из фонового задания длительной операции. +// +// Рекомендуется получать сообщения через обработчик оповещения, +// который подключается с помощью ДлительныеОперацииКлиент.ОжидатьЗавершение. +// +// Параметры: +// УдалятьПолученные - Булево - признак необходимости удаления полученных сообщений. +// ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания, соответствующего длительной +// операции, у которой требуется получить сообщения пользователю. +// Если не задан, то сообщения пользователю возвращаются +// из сеанса текущего пользователя. +// +// Возвращаемое значение: +// ФиксированныйМассив - объекты СообщениеПользователю, которые были сформированы в фоновом задании. +// +// Пример: +// Операция = ДлительныеОперации.ВыполнитьВФоне(...); +// ... +// Сообщения = ДлительныеОперации.СообщенияПользователю(Истина, Операция.ИдентификаторЗадания); +// +Функция СообщенияПользователю(УдалятьПолученные = Ложь, ИдентификаторЗадания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперации.СообщенияПользователю(УдалятьПолученные, ИдентификаторЗадания); +``` +
+ +## ЗапуститьВыполнениеВФоне +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВыполнитьВФоне. +// +// Запускает выполнение процедуры в фоновом задании. +// Является менее функциональным аналогом ВыполнитьВФоне, предусмотрена для обратной совместимости. +// +// Параметры: +// ИдентификаторФормы - УникальныйИдентификатор - идентификатор формы, +// из которой выполняется запуск длительной операции. +// ИмяЭкспортнойПроцедуры - Строка - имя экспортной процедуры, +// которую необходимо выполнить в фоне. +// Параметры - Структура - все необходимые параметры для +// выполнения процедуры ИмяЭкспортнойПроцедуры. +// НаименованиеЗадания - Строка - наименование фонового задания. +// Если не задано, то будет равно ИмяЭкспортнойПроцедуры. +// ИспользоватьДополнительноеВременноеХранилище - Булево - признак использования +// дополнительного временного хранилища для передачи данных +// в родительский сеанс из фонового задания. По умолчанию - Ложь. +// +// Возвращаемое значение: +// Структура - параметры выполнения задания: +// * АдресХранилища - Строка - адрес временного хранилища, в которое будет +// помещен результат работы задания; +// * АдресХранилищаДополнительный - Строка - адрес дополнительного временного хранилища, +// в которое будет помещен результат работы задания (доступно только если +// установлен параметр ИспользоватьДополнительноеВременноеХранилище); +// * ИдентификаторЗадания - УникальныйИдентификатор - уникальный идентификатор запущенного фонового задания; +// - Неопределено - если фоновое задание не запускалось; +// * ЗаданиеВыполнено - Булево - Истина если задание было успешно выполнено за время вызова функции. +// +Функция ЗапуститьВыполнениеВФоне(Знач ИдентификаторФормы, Знач Имя Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперации.ЗапуститьВыполнениеВФоне(ИдентификаторФормы, ИмяЭкспортнойПроцедуры, Параметры, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ДлительныеОперацииКлиент.md b/src/content/docs/bsp/ДлительныеОперацииКлиент.md new file mode 100644 index 0000000..f4a82ae --- /dev/null +++ b/src/content/docs/bsp/ДлительныеОперацииКлиент.md @@ -0,0 +1,284 @@ +--- +title: Длительные операции клиент +slug: bsp/длительные-операции-клиент +--- + + +## ОжидатьЗавершение +
+ +Описание, пример вызова + +```bsl + +// Открыть стандартную форму ожидания завершения длительной операции или использовать собственную форму +// и подключить обработчик оповещения о завершении и прогрессе выполнения процедуры длительной операции. +// +// Применяется совместно с функцией ДлительныеОперации.ВыполнитьВФоне для повышения отзывчивости +// пользовательского интерфейса, заменяя длительный серверный вызов на запуск фонового задания. +// +// Параметры: +// ДлительнаяОперация - см. ДлительныеОперации.ВыполнитьВФоне +// ОповещениеОЗавершении - ОписаниеОповещения - оповещение, которое вызывается после завершения +// длительной операции, в том числе после закрытия окна ожидания, если открывалось. +// Параметры процедуры-обработчика оповещения: +// # Результат - см. НовыйРезультатДлительнойОперации +// - Неопределено - если задание было отменено +// # ДополнительныеПараметры - Произвольный - произвольные данные, переданные в описании оповещения. +// ПараметрыОжидания - см. ДлительныеОперацииКлиент.ПараметрыОжидания +// +Процедура ОжидатьЗавершение(Знач ДлительнаяОперация, Знач ОповещениеОЗавершении = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ДлительныеОперацииКлиент.ОжидатьЗавершение(ДлительнаяОперация, ОповещениеОЗавершении, ); +``` +
+ +## ПараметрыОжидания +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую структуру для параметра ПараметрыОжидания процедуры ДлительныеОперацииКлиент.ОжидатьЗавершение. +// +// Параметры: +// ФормаВладелец - ФормаКлиентскогоПриложения +// - Неопределено - форма, из которой вызывается длительная операция. +// +// Возвращаемое значение: +// Структура - параметры выполнения задания: +// * ФормаВладелец - ФормаКлиентскогоПриложения +// - Неопределено - форма, из которой вызывается длительная операция. +// * Заголовок - Строка - заголовок окна, выводимый на форме ожидания. Если не задан, то не выводится. +// * ТекстСообщения - Строка - текст сообщения, выводимый на форме ожидания. +// Если не задан, то выводится "Пожалуйста, подождите...". +// * ВыводитьОкноОжидания - Булево - если Истина, то открыть окно ожидания с визуальной индикацией длительной операции. +// Если используется собственный механизм индикации, то следует указать Ложь. +// * РежимОткрытияОкнаОжидания - РежимОткрытияОкнаФормы - параметр РежимОткрытияОкна у формы ожидания. +// - Неопределено - значение по умолчанию. +// * ВыводитьПрогрессВыполнения - Булево - выводить прогресс выполнения в процентах на форме ожидания. +// Процедура-обработчик длительной операции может сообщить о ходе своего выполнения +// с помощью вызова процедуры ДлительныеОперации.СообщитьПрогресс. +// * ВыводитьСообщения - Булево - из формы ожидания выводить в ФормаВладелец сообщения, +// сформированные в процедуре-обработчике длительной операции. +// * ЗаголовокКнопкиОтмена - Строка - заголовок кнопки Отмена, если не указано, по умолчанию используется "Отмена" +// * ОповещениеОПрогрессеВыполнения - ОписаниеОповещения - оповещение, которое периодически вызывается при +// проверке готовности фонового задания, если ВыводитьОкноОжидания = Ложь. +// Параметры процедуры-обработчика оповещения: +// # Результат - см. НовоеСостояниеДлительнойОперации +// # ДополнительныеПараметры - Произвольный - произвольные данные, переданные в описании оповещения. +// +// * Интервал - Число - интервал в секундах между проверками готовности длительной операции. +// По умолчанию 0 - после каждой проверки интервал увеличивается с 1 до 15 секунд +// с коэффициентом 1.4. +// * ОповещениеПользователя - Структура: +// ** Показать - Булево - если Истина, то по завершении длительной операции вывести оповещение пользователя. +// ** Текст - Строка - текст оповещения пользователя. +// ** НавигационнаяСсылка - Строка - навигационная ссылка оповещения пользователя. +// ** Пояснение - Строка - пояснение оповещения пользователя. +// ** Картинка - Картинка - картинка, которая будет показана в окне оповещения. Если Неопределено, то +// картинка не выводится. +// ** Важное - Булево - если Истина, то оповещение после автоматического закрытия будет добавлено в +// центр оповещений. +// +// * ОтменятьПриЗакрытииФормыВладельца - Булево - по умолчанию ФормаВладелец.Открыта(), Ложь если форма не указана. +// Если Ложь, тогда длительная операция не будет отменена при закрытии формы владельца и при закрытии окна ожидания. +// +// * ПолучатьРезультат - Булево - служебный параметр. Не предназначен для использования. +// +Функция ПараметрыОжидания(ФормаВладелец) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперацииКлиент.ПараметрыОжидания(ФормаВладелец) +``` +
+ +## НовыйРезультатДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат оповещения, указанного в параметре ОповещениеОЗавершении +// процедуры ДлительныеОперацииКлиент.ОжидатьЗавершение. +// +// Возвращаемое значение: +// Неопределено - передается в результат ОповещениеОЗавершении, если задание отменено пользователем. +// Структура: +// * Статус - Строка - "Выполнено", если задание было успешно выполнено. +// "Ошибка", если задание завершено с ошибкой. +// +// * АдресРезультата - Строка - адрес временного хранилища, в которое будет помещен +// (или уже помещен) результат работы процедуры длительной операции. +// +// * АдресДополнительногоРезультата - Строка - если установлен параметр ДополнительныйРезультат, +// содержит адрес дополнительного временного хранилища, в которое будет помещен +// (или уже помещен) дополнительный результат работы процедуры длительной операции. +// +// * ИнформацияОбОшибке - ИнформацияОбОшибке - если Статус = "Ошибка". +// - Неопределено - если Статус <> "Ошибка". +// +// * Сообщения - ФиксированныйМассив - массив объектов СообщениеПользователю, +// сформированных в процедуре-обработчике длительной операции. +// Массив будет пустым, когда в параметре ПараметрыОжидания +// процедуры процедуры ДлительныеОперацииКлиент.ОжидатьЗавершение +// свойство ВыводитьОкноОжидания = Ложь и +// заполнено свойство ОповещениеОПрогрессеВыполнения. +// +// * ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания, если запускалось. +// - Неопределено - если задание не запускалось (например, выполнение не в фоне). +// +// * КраткоеПредставлениеОшибки - Строка - устарел. +// * ПодробноеПредставлениеОшибки - Строка - устарел. +// +Функция НовыйРезультатДлительнойОперации() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперацииКлиент.НовыйРезультатДлительнойОперации() +``` +
+ +## НовоеСостояниеДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую структуру для передачи как результат оповещения, указанного +// в свойстве ОповещениеОПрогрессеВыполнения параметра ПараметрыОжидания +// процедуры ДлительныеОперацииКлиент.ОжидатьЗавершение. +// +// Возвращаемое значение: +// Структура: +// * Статус - Строка - "Выполняется", если задание еще не завершилось, +// "Выполнено", если задание было успешно выполнено, +// "Ошибка", если задание завершено с ошибкой. +// +// * Прогресс - см. ДлительныеОперации.ПрочитатьПрогресс +// * Сообщения - Неопределено - нет сообщений. +// - ФиксированныйМассив из СообщениеПользователю - порция сообщений, +// отправленных из процедуры длительной операции. +// +// * ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания, если запускалось. +// - Неопределено - если задание не запускалось (например, выполнение не в фоне). +// +Функция НовоеСостояниеДлительнойОперации() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперацииКлиент.НовоеСостояниеДлительнойОперации() +``` +
+ +## ИнициализироватьПараметрыОбработчикаОжидания +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОжидатьЗавершение с параметром ПараметрыОжидания.ВыводитьОкноОжидания = Истина. +// Заполняет структуру параметров значениями по умолчанию. +// +// Параметры: +// ПараметрыОбработчикаОжидания - Структура - заполняется значениями по умолчанию. +// +// +Процедура ИнициализироватьПараметрыОбработчикаОжидания(ПараметрыОбработчикаОжидания) Экспорт +``` + +Пример вызова +```bsl +ДлительныеОперацииКлиент.ИнициализироватьПараметрыОбработчикаОжидания(ПараметрыОбработчикаОжидания) +``` +
+ +## ОбновитьПараметрыОбработчикаОжидания +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОжидатьЗавершение с параметром ПараметрыОжидания.ВыводитьОкноОжидания = Истина. +// Заполняет структуру параметров новыми расчетными значениями. +// +// Параметры: +// ПараметрыОбработчикаОжидания - Структура - заполняется расчетными значениями. +// +// +Процедура ОбновитьПараметрыОбработчикаОжидания(ПараметрыОбработчикаОжидания) Экспорт +``` + +Пример вызова +```bsl +ДлительныеОперацииКлиент.ОбновитьПараметрыОбработчикаОжидания(ПараметрыОбработчикаОжидания) +``` +
+ +## ОткрытьФормуДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОжидатьЗавершение с параметром ПараметрыОжидания.ВыводитьОкноОжидания = Истина. +// Открывает форму-индикатор длительной операции. +// +// Параметры: +// ВладелецФормы - ФормаКлиентскогоПриложения - форма, из которой производится открытие. +// ИдентификаторЗадания - УникальныйИдентификатор - идентификатор фонового задания. +// +// Возвращаемое значение: +// ФормаКлиентскогоПриложения - ссылка на открытую форму. +// +Функция ОткрытьФормуДлительнойОперации(Знач ВладелецФормы, Знач ИдентификаторЗадания) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительныеОперацииКлиент.ОткрытьФормуДлительнойОперации(ВладелецФормы, ИдентификаторЗадания) +``` +
+ +## ЗакрытьФормуДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОжидатьЗавершение с параметром ПараметрыОжидания.ВыводитьОкноОжидания = Истина. +// Закрывает форму-индикатор длительной операции. +// +// Параметры: +// ФормаДлительнойОперации - ФормаКлиентскогоПриложения - ссылка на форму-индикатор длительной операции. +// +Процедура ЗакрытьФормуДлительнойОперации(ФормаДлительнойОперации) Экспорт +``` + +Пример вызова +```bsl +ДлительныеОперацииКлиент.ЗакрытьФормуДлительнойОперации(ФормаДлительнойОперации) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ДополнительныеОтчетыИОбработки.md b/src/content/docs/bsp/ДополнительныеОтчетыИОбработки.md new file mode 100644 index 0000000..9ef4a5b --- /dev/null +++ b/src/content/docs/bsp/ДополнительныеОтчетыИОбработки.md @@ -0,0 +1,380 @@ +--- +title: Дополнительные отчеты и обработки +slug: bsp/дополнительные-отчеты-и-обработки +--- + + +## ПодключитьВнешнююОбработку +
+ +Описание, пример вызова + +```bsl + +// Подключает и возвращает имя, под которым подключен внешний отчет или обработка. +// После подключения отчет или обработка регистрируется в программе под определенным именем, +// используя которое, можно создавать объект или открывать формы отчета или обработки. +// +// Важно: проверка функциональной опции "ИспользоватьДополнительныеОтчетыИОбработки" +// должна выполняться вызывающим кодом. +// +// Параметры: +// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - подключаемая обработка. +// +// Возвращаемое значение: +// Строка - имя подключенного отчета или обработки. +// Неопределено - если передана некорректная ссылка. +// +Функция ПодключитьВнешнююОбработку(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработки.ПодключитьВнешнююОбработку(Ссылка) +``` +
+ +## ОбъектВнешнейОбработки +
+ +Описание, пример вызова + +```bsl + +// Возвращает объект внешнего отчета или обработки. +// +// Важно: проверка функциональной опции "ИспользоватьДополнительныеОтчетыИОбработки" +// должна выполняться вызывающим кодом. +// +// Параметры: +// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - подключаемый отчет или обработка. +// +// Возвращаемое значение: +// ВнешняяОбработка - объект подключенной обработки. +// ВнешнийОтчет - объект подключенного отчета. +// Неопределено - если передана некорректная ссылка. +// +Функция ОбъектВнешнейОбработки(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработки.ОбъектВнешнейОбработки(Ссылка) +``` +
+ +## ПечатьПоВнешнемуИсточнику +
+ +Описание, пример вызова + +```bsl + +// Формирует печатную форму по внешнему источнику. +// +// Параметры: +// ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - внешняя обработка. +// ПараметрыИсточника - Структура: +// * ИдентификаторКоманды - Строка - список макетов, перечисленных через запятую. +// * ОбъектыНазначения - Массив +// КоллекцияПечатныхФорм - ТаблицаЗначений - сформированные табличные документы (возвращаемый параметр). +// ОбъектыПечати - СписокЗначений - соответствие между объектами и именами областей печати +// табличного документа. Значение - Объект, представление - имя области, +// в которой был выведен объект (возвращаемый параметр). +// ПараметрыВывода - Структура - дополнительные параметры сформированных табличных документов +// (возвращаемый параметр). +// +Процедура ПечатьПоВнешнемуИсточнику(ДополнительнаяОбработкаСсылка, ПараметрыИсточника, КоллекцияПечатныхФорм, Экспорт +``` + +Пример вызова +```bsl +ДополнительныеОтчетыИОбработки.ПечатьПоВнешнемуИсточнику(ДополнительнаяОбработкаСсылка, ПараметрыИсточника, КоллекцияПечатныхФорм, ); +``` +
+ +## СведенияОВнешнейОбработке +
+ +Описание, пример вызова + +```bsl + +// Формирует шаблон сведений о внешнем отчете или обработке для последующего заполнения. +// +// Параметры: +// ВерсияБСП - см. СтандартныеПодсистемыСервер.ВерсияБиблиотеки. +// +// Возвращаемое значение: +// Структура - параметры внешнего отчета или обработки: +// * Вид - ПеречислениеСсылка.ВидыДополнительныхОтчетовИОбработок +// - Строка - вид внешнего отчета или обработки. Для указания вида рекомендуется использовать функции +// ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработки<ИмяВида>. +// Также вид можно указать явно: +// "ПечатнаяФорма", +// "ЗаполнениеОбъекта", +// "СозданиеСвязанныхОбъектов", +// "Отчет", +// "ШаблонСообщения", +// "ДополнительнаяОбработка", +// "ДополнительныйОтчет". +// +// * Версия - Строка - версия отчета или обработки (далее - обработки). +// Задается в формате: "<Старший номер>.<Младший номер>". +// +// * Назначение - Массив - полные имена объектов конфигурации (Строка), для которых предназначен эта обработка. +// Необязательное свойство. +// +// * Наименование - Строка - представление для администратора (наименование элемента справочника). +// Если не заполнено, то берется представление объекта метаданных внешней обработки. +// Необязательное свойство. +// +// * БезопасныйРежим - Булево - признак подключения внешней обработки в безопасном режиме. +// Значение по умолчанию Истина (обработка будет выполняться безопасно). +// В безопасном режиме: +// Игнорируется привилегированный режим. +// Запрещены внешние по отношению к платформе 1С:Предприятия действия: +// COM; +// загрузка внешних компонент; +// запуск внешних приложений и команд операционной системы; +// доступ к файловой системе, кроме временных файлов; +// доступ к Интернету. +// Необязательное свойство. +// +// * Разрешения - Массив из ОбъектXDTO - дополнительные разрешения, необходимые внешней обработке при работе в +// безопасном режиме. Элемент массива - ОбъектXDTO - разрешение типа +// {HTTP://www.1c.ru/1cFresh/ApplicationExtensions/Permissions/a.b.c.d}PermissionBase. +// Для формирования описания разрешения рекомендуется использовать функции +// РаботаВБезопасномРежиме.Разрешение<ВидРазрешения>(<ПараметрыРазрешения>). +// Необязательное свойство. +// +// * Информация - Строка - краткая информация о внешней обработке. +// В этом параметре для администратора рекомендуется дать описание ее возможностей. +// Если не заполнено, то берется комментарий объекта метаданных внешней обработки. +// +// * ВерсияБСП - см. СтандартныеПодсистемыСервер.ВерсияБиблиотеки. +// +// * ОпределитьНастройкиФормы - Булево - только для дополнительных отчетов, подключенных к общей форме ФормаОтчета. +// Позволяет переопределять некоторые настройки общей формы отчета и +// подписываться на ее события. +// Если Истина, то в модуле объекта отчета следует определить процедуру по шаблону: +// +// * НазначениеВариантаОтчета - ПеречислениеСсылка.НазначенияВариантовОтчетов - назначение варианта отчета +// (ДляКомпьютеровИПланшетов, ДляСмартфонов, ДляЛюбыхУстройств). +// +// // Задать настройки формы отчета. +// // +// // Параметры: +// // Форма - ФормаКлиентскогоПриложения, Неопределено +// // КлючВарианта - Строка, Неопределено +// // Настройки - см. ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию +// // +// Процедура ОпределитьНастройкиФормы(Форма, КлючВарианта, Настройки) Экспорт +// // Код процедуры. +// КонецПроцедуры +// +// Подробнее см. в документации к подсистемам "Дополнительные отчеты и обработки" и "Варианты отчетов". +// Необязательное свойство. +// +// * Команды - ТаблицаЗначений - настройки команд, поставляемых внешней обработкой (необязательно для отчетов): +// ** Идентификатор - Строка - внутреннее имя команды. Для внешних печатных форм (когда Вид = "ПечатнаяФорма"): +// Идентификатор может содержать имена одной или нескольких команд печати, +// разделенные запятыми. Подробнее см. описание колонки Идентификатор +// в функции УправлениеПечатью.СоздатьКоллекциюКомандПечати. +// ** Представление - Строка - пользовательское представление команды. +// ** Использование - Строка - тип команды: +// "ВызовКлиентскогоМетода", +// "ВызовСерверногоМетода", +// "ЗаполнениеФормы", +// "ОткрытиеФормы" или +// "СценарийВБезопасномРежиме". +// Для получения типов команд рекомендуется использовать функции +// ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКоманды<ИмяТипа>. +// В комментариях к этим функциям также даны шаблоны процедур-обработчиков команд. +// ** ПоказыватьОповещение - Булево - если Истина, то при запуске команды выводится оповещение "Команда выполняется...". +// Действует для всех типов команд, кроме команд по открытию формы (Использование = "ОткрытиеФормы"). +// ** Модификатор - Строка - дополнительная классификация команды. +// Для внешних печатных форм (когда Вид = "ПечатнаяФорма"): +// "ПечатьMXL" - для печатных форм на основе табличных макетов. +// Для загрузки данных из файла (когда Вид = "ПечатнаяФорма" и Использование = "ЗагрузкаДанныхИзФайла"): +// Модификатор является обязательным для заполнения +// и должен содержать полное имя объекта метаданных (справочника), +// для которого выполняется загрузка данных. +// ** Скрыть - Булево - необязательный. Признак того, что это служебная команда. +// Если установить в значение Истина, то команда скрывается в карточке дополнительного объекта. +// +Функция СведенияОВнешнейОбработке(ВерсияБСП = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработки.СведенияОВнешнейОбработке(ВерсияБСП); +``` +
+ +## ВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// Выполняет команду обработки и возвращает результат ее выполнения. +// +// Важно: проверка функциональной опции "ИспользоватьДополнительныеОтчетыИОбработки" +// должна выполняться вызывающим кодом. +// +// Параметры: +// ПараметрыКоманды - Структура - параметры, с которыми выполняется команда: +// * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - элемент справочника. +// * ИдентификаторКоманды - Строка - имя выполняемой команды. +// * ОбъектыНазначения - Массив - ссылки объектов, для которых выполняется обработка. Обязательный для +// назначаемых обработок. +// АдресРезультата - Строка - адрес временного хранилища по которому будет размещен результат +// выполнения. +// +// Возвращаемое значение: +// Структура - результат выполнения, который далее передается на клиент. +// Неопределено - если был передан АдресРезультата. +// +Функция ВыполнитьКоманду(ПараметрыКоманды, АдресРезультата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработки.ВыполнитьКоманду(ПараметрыКоманды, АдресРезультата); +``` +
+ +## ВыполнитьКомандуИзФормыВнешнегоОбъекта +
+ +Описание, пример вызова + +```bsl + +// Выполняет команду обработки напрямую из формы внешнего объекта и возвращает результат ее выполнения. +// Пример использования - см. ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне. +// +// Важно: проверка функциональной опции "ИспользоватьДополнительныеОтчетыИОбработки" +// должна выполняться вызывающим кодом. +// +// Параметры: +// ИдентификаторКоманды - Строка - имя команды, как оно задано в функции СведенияОВнешнейОбработке() модуля объекта. +// ПараметрыКоманды - Структура - параметры выполнения команды. +// См. ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне. +// Форма - ФормаКлиентскогоПриложения - форма, в которую необходимо вернуть результат. +// +// Возвращаемое значение: +// Структура - для служебного использования. +// +Функция ВыполнитьКомандуИзФормыВнешнегоОбъекта(ИдентификаторКоманды, ПараметрыКоманды, Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработки.ВыполнитьКомандуИзФормыВнешнегоОбъекта(ИдентификаторКоманды, ПараметрыКоманды, Форма) +``` +
+ +## РазделыДополнительныхОтчетов +
+ +Описание, пример вызова + +```bsl + +// Формирует список разделов, в которых доступна команда вызова дополнительных отчетов. +// +// Возвращаемое значение: +// Массив - массив объектов метаданных Подсистема - метаданные разделов, в которые выведен список команд +// дополнительных отчетов. +// +Функция РазделыДополнительныхОтчетов() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработки.РазделыДополнительныхОтчетов() +``` +
+ +## РазделыДополнительныхОбработок +
+ +Описание, пример вызова + +```bsl + +// Формирует список разделов, в которых доступна команда вызова дополнительных обработок. +// +// Возвращаемое значение: +// Массив - массив объектов метаданных Подсистема - метаданные разделов, в которые выведен список команд дополнительных +// обработок. +// +Функция РазделыДополнительныхОбработок() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработки.РазделыДополнительныхОбработок() +``` +
+ +## СохранитьНастройки +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройки, требуемые для выполнения обработки. +// С ее помощью, например, в интерактивных обработках можно сохранять +// последние введенные пользователем значения, а для обработок, выполняемых по регламентному заданию, +// позволить администратору задавать значения по умолчанию и различные параметры работы. +// +// Параметры: +// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки +// Настройки - Произвольный - сохраняемые настройки +// +Процедура СохранитьНастройки(Ссылка, Настройки) Экспорт +``` + +Пример вызова +```bsl +ДополнительныеОтчетыИОбработки.СохранитьНастройки(Ссылка, Настройки) +``` +
+ +## ЗагрузитьНастройки +
+ +Описание, пример вызова + +```bsl + +// Возвращает сохраненные параметры дополнительной обработки. +// См. процедуру СохранитьНастройки. +// +// Параметры: +// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки +// +// Возвращаемое значение: +// Произвольный - сохраненные настройки. +// +Функция ЗагрузитьНастройки(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработки.ЗагрузитьНастройки(Ссылка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиент.md b/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиент.md new file mode 100644 index 0000000..419978b --- /dev/null +++ b/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиент.md @@ -0,0 +1,157 @@ +--- +title: Дополнительные отчеты и обработки клиент +slug: bsp/дополнительные-отчеты-и-обработки-клиент +--- + + +## ОткрытьФормуКомандДополнительныхОтчетовИОбработок +
+ +Описание, пример вызова + +```bsl + +// Открывает форму с доступными командами. +// +// Параметры: +// ПараметрКоманды - Произвольный - передается "как есть" из параметров обработчика команды. +// ПараметрыВыполненияКоманды - ПараметрыВыполненияКоманды - передается "как есть" из параметров обработчика команды. +// Вид - Строка - вид обработки, который можно получить из серии функций: +// ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработки<...>. +// ИмяРаздела - Строка - имя раздела командного интерфейса, из которого вызывается команда. +// +Процедура ОткрытьФормуКомандДополнительныхОтчетовИОбработок(ПараметрКоманды, ПараметрыВыполненияКоманды, Вид, ИмяРаздела = "") Экспорт +``` + +Пример вызова +```bsl +ДополнительныеОтчетыИОбработкиКлиент.ОткрытьФормуКомандДополнительныхОтчетовИОбработок(ПараметрКоманды, ПараметрыВыполненияКоманды, Вид, ИмяРаздела); +``` +
+ +## ОткрытьВариантДополнительногоОтчета +
+ +Описание, пример вызова + +```bsl + +// Открывает форму дополнительного отчета с заданным вариантом. +// +// Параметры: +// ДополнительныйОтчет - СправочникСсылка.ДополнительныеОтчетыИОбработки +// КлючВарианта - Строка - имя варианта дополнительного отчета. +// +Процедура ОткрытьВариантДополнительногоОтчета(ДополнительныйОтчет, КлючВарианта) Экспорт +``` + +Пример вызова +```bsl +ДополнительныеОтчетыИОбработкиКлиент.ОткрытьВариантДополнительногоОтчета(ДополнительныйОтчет, КлючВарианта) +``` +
+ +## ПараметрыВыполненияКомандыВФоне +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую структуру параметров выполнения команды в фоне. +// +// Параметры: +// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка выполняемой дополнительной обработки или отчета. +// +// Возвращаемое значение: +// Структура - шаблон параметров выполнения команды в фоне: +// * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - передается "как есть" из +// параметров формы. +// * СопровождающийТекст - Строка - текст длительной операции. +// * ОбъектыНазначения - Массив - ссылки объектов, для которых выполняется команда. +// Используется для назначаемых дополнительных обработок. +// * СозданныеОбъекты - Массив - ссылки объектов, созданных в процессе выполнения команды. +// Используется для назначаемых дополнительных обработок вида "Создание связанных объектов". +// * ФормаВладелец - ФормаКлиентскогоПриложения - форма объекта или списка, из которой была вызвана команда. +// +Функция ПараметрыВыполненияКомандыВФоне(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиент.ПараметрыВыполненияКомандыВФоне(Ссылка) +``` +
+ +## ВыполнитьКомандуВФоне +
+ +Описание, пример вызова + +```bsl + +// Выполняет команду ИдентификаторКоманды в фоне с помощью механизма длительных операций. +// Для использования в формах внешних отчетов и обработок. +// +// Параметры: +// ИдентификаторКоманды - Строка - имя команды, как оно задано в функции СведенияОВнешнейОбработке модуля объекта. +// ПараметрыКоманды - Структура - параметры выполнения команды. +// Состав параметров описан в функции ПараметрыВыполненияКомандыВФоне. +// Также включает в себя служебный параметр, зарезервированный подсистемой: +// * ИдентификаторКоманды - Строка - имя выполняемой команды. Соответствует параметру ИдентификаторКоманды. +// Помимо стандартных параметров может содержать пользовательские для использования в обработчике команды. +// При добавлении собственных параметров рекомендуется использовать префикс в их именах, +// исключающий конфликты со стандартными параметрами, например "Контекст...". +// Обработчик - см. ДлительныеОперацииКлиент.ОжидатьЗавершение.ОповещениеОЗавершении +// +// Пример: +// &НаКлиенте +// Процедура ОбработчикКоманды(Команда) +// ПараметрыКоманды = ДополнительныеОтчетыИОбработкиКлиент.ПараметрыВыполненияКомандыВФоне(Параметры.ДополнительнаяОбработкаСсылка); +// ПараметрыКоманды.СопровождающийТекст = НСтр("ru = 'Выполняется команда...'"); +// Обработчик = Новый ОписаниеОповещения("<ИмяЭкспортнойПроцедуры>", ЭтотОбъект); +// ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне(Команда.Имя, ПараметрыКоманды, Обработчик); +// КонецПроцедуры +// +Процедура ВыполнитьКомандуВФоне(Знач ИдентификаторКоманды, Знач ПараметрыКоманды, Знач Обработчик) Экспорт +``` + +Пример вызова +```bsl +ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне(ИдентификаторКоманды, ПараметрыКоманды, Обработчик) +``` +
+ +## ИмяФормыДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать обработчик оповещения +// (смотри параметр Обработчик в процедуре ВыполнитьКомандуВФоне) +// вместо использования события ОбработкаВыбора формы владельца совместно с анализом источника: +// ИсточникВыбора.ИмяФормы = ДополнительныеОтчетыИОбработкиКлиент.ИмяФормыДлительнойОперации(). +// +// Возвращает имя формы для идентификации результата выполнения длительной операции. +// +// Возвращаемое значение: +// Строка - см. ВыполнитьКомандуВФоне. +// +Функция ИмяФормыДлительнойОперации() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиент.ИмяФормыДлительнойОперации() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиентПереопределяемый.md b/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиентПереопределяемый.md new file mode 100644 index 0000000..8d697dc --- /dev/null +++ b/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиентПереопределяемый.md @@ -0,0 +1,37 @@ +--- +title: Дополнительные отчеты и обработки клиент переопределяемый +slug: bsp/дополнительные-отчеты-и-обработки-клиент-переопределяемый +--- + + +## ПередВыполнениемКомандыПечатиВнешнейПечатнойФормы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатьюПереопределяемый.ПриОпределенииНастроекПечати +// Выполняет дополнительные действия перед формированием печатной формы. +// +// Параметры: +// ПечатаемыеОбъекты - Массив - ссылки на объекты, для которых выполняется команда печати; +// СтандартнаяОбработка - Булево - признак необходимости проверки проведенности печатаемых документов, +// если установить в Ложь, то проверка выполняться не будет. +// +Процедура ПередВыполнениемКомандыПечатиВнешнейПечатнойФормы(ПечатаемыеОбъекты, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ДополнительныеОтчетыИОбработкиКлиентПереопределяемый.ПередВыполнениемКомандыПечатиВнешнейПечатнойФормы(ПечатаемыеОбъекты, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиентСервер.md b/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиентСервер.md new file mode 100644 index 0000000..5897d8c --- /dev/null +++ b/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиКлиентСервер.md @@ -0,0 +1,598 @@ +--- +title: Дополнительные отчеты и обработки клиент сервер +slug: bsp/дополнительные-отчеты-и-обработки-клиент-сервер +--- + + +## ВидОбработкиПечатнаяФорма +
+ +Описание, пример вызова + +```bsl + +// Печатная форма. +// +// Возвращаемое значение: +// Строка - имя вида дополнительных печатных форм. +// +Функция ВидОбработкиПечатнаяФорма() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиПечатнаяФорма() +``` +
+ +## ВидОбработкиЗаполнениеОбъекта +
+ +Описание, пример вызова + +```bsl + +// Заполнение объекта. +// +// Возвращаемое значение: +// Строка - имя вида дополнительных обработок заполнения. +// +Функция ВидОбработкиЗаполнениеОбъекта() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиЗаполнениеОбъекта() +``` +
+ +## ВидОбработкиСозданиеСвязанныхОбъектов +
+ +Описание, пример вызова + +```bsl + +// Создание связанных объектов. +// +// Возвращаемое значение: +// Строка - имя вида дополнительных обработок создания связанных объектов. +// +Функция ВидОбработкиСозданиеСвязанныхОбъектов() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиСозданиеСвязанныхОбъектов() +``` +
+ +## ВидОбработкиОтчет +
+ +Описание, пример вызова + +```bsl + +// Назначаемый отчет. +// +// Возвращаемое значение: +// Строка - имя вида дополнительных контекстных отчетов. +// +Функция ВидОбработкиОтчет() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиОтчет() +``` +
+ +## ВидОбработкиШаблонСообщения +
+ +Описание, пример вызова + +```bsl + +// Создание связанных объектов. +// +// Возвращаемое значение: +// Строка - имя вида дополнительных контекстных отчетов. +// +Функция ВидОбработкиШаблонСообщения() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиШаблонСообщения() +``` +
+ +## ВидОбработкиДополнительнаяОбработка +
+ +Описание, пример вызова + +```bsl + +// Дополнительная обработка. +// +// Возвращаемое значение: +// Строка - имя вида дополнительных глобальных обработок. +// +Функция ВидОбработкиДополнительнаяОбработка() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиДополнительнаяОбработка() +``` +
+ +## ВидОбработкиДополнительныйОтчет +
+ +Описание, пример вызова + +```bsl + +// Дополнительный отчет. +// +// Возвращаемое значение: +// Строка - имя вида дополнительных глобальных отчетов. +// +Функция ВидОбработкиДополнительныйОтчет() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиДополнительныйОтчет() +``` +
+ +## ТипКомандыВызовСерверногоМетода +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя типа команд с вызовом серверного метода. Для выполнения команд такого типа +// в модуле объекта следует определить экспортную процедуру по следующему шаблону. +// +// Для глобальных отчетов и обработок (Вид = "ДополнительнаяОбработка" или Вид = "ДополнительныйОтчет"): +// // Обработчик серверных команд. +// // +// // Параметры: +// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке(). +// // ПараметрыВыполнения - Структура - контекст выполнения команды. +// // * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка обработки. +// // Может использоваться для чтения параметров обработки. +// // Пример см. в комментарии к функции ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы(). +// // * РезультатВыполнения - Структура - результат выполнения команды. +// // Может использоваться для передачи результата с сервера или из фонового задания в исходную точку. +// // В частности, возвращается функциями ДополнительныеОтчетыИОбработки.ВыполнитьКоманду() +// // и ДополнительныеОтчетыИОбработки.ВыполнитьКомандуИзФормыВнешнегоОбъекта(), +// // а также может быть получено из временного хранилища +// // в обработчике ожидания процедуры ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне(). +// // +// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ПараметрыВыполнения) Экспорт +// // Реализация логики команды. +// КонецПроцедуры +// +// Для печатных форм (Вид = "ПечатнаяФорма"): +// // Обработчик печати. +// // +// // Параметры: +// // МассивОбъектов - Массив - ссылки на объекты, которые нужно распечатать. +// // КоллекцияПечатныхФорм - ТаблицаЗначений - информация о табличных документах. +// // Используется для передачи в параметрах функции УправлениеПечатью.СведенияОПечатнойФорме(). +// // ОбъектыПечати - СписокЗначений - соответствие между объектами и именами областей в табличных документах. +// // Используется для передачи в параметрах процедуры УправлениеПечатью.ЗадатьОбластьПечатиДокумента(). +// // ПараметрыВывода - Структура - дополнительные параметры сформированных табличных документов. +// // * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка обработки. +// // Может использоваться для чтения параметров обработки. +// // Пример см. в комментарии к функции ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы(). +// // +// // Пример: +// // ПечатнаяФорма = УправлениеПечатью.СведенияОПечатнойФорме(КоллекцияПечатныхФорм, "<ИдентификаторПечатнойФормы>"); +// // Если ПечатнаяФорма <> Неопределено Тогда +// // ТабличныйДокумент = Новый ТабличныйДокумент; +// // ТабличныйДокумент.КлючПараметровПечати = "<КлючСохраненияПараметровПечатнойФормы>"; +// // Для Каждого Ссылка Из МассивОбъектов Цикл +// // Если ТабличныйДокумент.ВысотаТаблицы > 0 Тогда +// // ТабличныйДокумент.ВывестиГоризонтальныйРазделительСтраниц(); +// // КонецЕсли; +// // НачалоОбласти = ТабличныйДокумент.ВысотаТаблицы + 1; +// // // ... код по формированию табличного документа ... +// // УправлениеПечатью.ЗадатьОбластьПечатиДокумента(ТабличныйДокумент, НачалоОбласти, ОбъектыПечати, Ссылка); +// // КонецЦикла; +// // ПечатнаяФорма.ТабличныйДокумент = ТабличныйДокумент; +// // КонецЕсли; +// // +// Процедура Печать(МассивОбъектов, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) Экспорт +// // Реализация логики команды. +// КонецПроцедуры +// +// Для обработок создания связанных объектов (Вид = "СозданиеСвязанныхОбъектов"): +// // Обработчик серверных команд. +// // +// // Параметры: +// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке(). +// // ОбъектыНазначения - Массив - ссылки объектов, для которых вызвана команда. +// // СозданныеОбъекты - Массив - ссылки новых объектов, созданных в результате выполнения команды. +// // ПараметрыВыполнения - Структура - контекст выполнения команды. +// // * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка обработки. +// // Может использоваться для чтения параметров обработки. +// // Пример см. в комментарии к функции ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы(). +// // * РезультатВыполнения - Структура - результат выполнения команды. +// // Может использоваться для передачи результата с сервера или из фонового задания в исходную точку. +// // В частности, возвращается функциями ДополнительныеОтчетыИОбработки.ВыполнитьКоманду() +// // и ДополнительныеОтчетыИОбработки.ВыполнитьКомандуИзФормыВнешнегоОбъекта(), +// // а также может быть получено из временного хранилища +// // в обработчике ожидания процедуры ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне(). +// // +// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ОбъектыНазначения, СозданныеОбъекты, ПараметрыВыполнения) Экспорт +// // Реализация логики команды. +// КонецПроцедуры +// +// Для обработок заполнения (Вид = "ЗаполнениеОбъекта"): +// // Обработчик серверных команд. +// // +// // Параметры: +// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке(). +// // ОбъектыНазначения - Массив - ссылки объектов, для которых вызвана команда. +// // - Неопределено - для команд "ЗаполнениеФормы". +// // ПараметрыВыполнения - Структура - контекст выполнения команды. +// // * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка обработки. +// // Может использоваться для чтения параметров обработки. +// // Пример см. в комментарии к функции ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы(). +// // * РезультатВыполнения - Структура - результат выполнения команды. +// // Может использоваться для передачи результата с сервера или из фонового задания в исходную точку. +// // В частности, возвращается функциями ДополнительныеОтчетыИОбработки.ВыполнитьКоманду() +// // и ДополнительныеОтчетыИОбработки.ВыполнитьКомандуИзФормыВнешнегоОбъекта(), +// // а также может быть получено из временного хранилища +// // в обработчике ожидания процедуры ДополнительныеОтчетыИОбработкиКлиент.ВыполнитьКомандуВФоне(). +// // +// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ОбъектыНазначения, ПараметрыВыполнения) Экспорт +// // Реализация логики команды. +// КонецПроцедуры +// +// Возвращаемое значение: +// Строка - имя типа команд с вызовом серверного метода. +// +Функция ТипКомандыВызовСерверногоМетода() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыВызовСерверногоМетода() +``` +
+ +## ТипКомандыВызовКлиентскогоМетода +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя типа команд с вызовом клиентского метода. Для выполнения команд такого типа +// в основной форме внешнего объекта следует определить клиентскую экспортную процедуру по следующему шаблону. +// +// Для глобальных отчетов и обработок (Вид = "ДополнительнаяОбработка" или Вид = "ДополнительныйОтчет"): +// &НаКлиенте +// Процедура ВыполнитьКоманду(ИдентификаторКоманды) Экспорт +// // Реализация логики команды. +// КонецПроцедуры +// +// Для печатных форм (Вид = "ПечатнаяФорма"): +// &НаКлиенте +// Процедура Печать(ИдентификаторКоманды, ОбъектыНазначенияМассив) Экспорт +// // Реализация логики команды. +// КонецПроцедуры +// +// Для обработок создания связанных объектов (Вид = "СозданиеСвязанныхОбъектов"): +// &НаКлиенте +// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ОбъектыНазначенияМассив, СозданныеОбъекты) Экспорт +// // Реализация логики команды. +// КонецПроцедуры +// +// Для обработок заполнения и контекстных отчетов (Вид = "ЗаполнениеОбъекта" или Вид = "Отчет"): +// &НаКлиенте +// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ОбъектыНазначенияМассив) Экспорт +// // Реализация логики команды. +// КонецПроцедуры +// +// Дополнительно (для всех видов) в параметре формы "ДополнительнаяОбработкаСсылка" передается ссылка этого объекта +// (элемент справочника ДополнительныеОтчетыИОбработки, соответствующий этому объекту), +// которая может использоваться для фонового выполнения длительных операций. +// Подробнее см. в документации к подсистеме, раздел "Фоновое выполнение длительных операций". +// +// Возвращаемое значение: +// Строка - имя типа команд с вызовом клиентского метода. +// +Функция ТипКомандыВызовКлиентскогоМетода() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыВызовКлиентскогоМетода() +``` +
+ +## ТипКомандыОткрытиеФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя типа команд по открытию формы. При выполнении этих команд +// открывается основная форма внешнего объекта с указанными ниже параметрами. +// +// Общие параметры: +// ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке(). +// ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка этого объекта. +// Может использоваться для чтения и сохранения параметров обработки. +// Также может использоваться для фонового выполнения длительных операций. +// Подробнее см. в документации к подсистеме, раздел "Фоновое выполнение длительных операций". +// ИмяФормы - Строка - имя формы-владельца, из которой вызвана эта команда. +// +// Вспомогательные параметры для обработок создания связанных объектов (Вид = "СозданиеСвязанныхОбъектов"), +// обработок заполнения (Вид = "ЗаполнениеОбъекта") и контекстных отчетов (Вид = "Отчет"): +// ОбъектыНазначения - Массив - Ссылки объектов, для которых вызвана команда. +// +// Пример чтения общих параметров: +// ОбъектСсылка = ОбщегоНазначенияКлиентСервер.СвойствоСтруктуры(Параметры, "ДополнительнаяОбработкаСсылка"); +// ИдентификаторКоманды = ОбщегоНазначенияКлиентСервер.СвойствоСтруктуры(Параметры, "ИдентификаторКоманды"); +// +// Пример чтения значений дополнительных настроек: +// Если ЗначениеЗаполнено(ОбъектСсылка) Тогда +// ХранилищеНастроек = ОбщегоНазначения.ЗначениеРеквизитаОбъекта(ОбъектСсылка, "ХранилищеНастроек"); +// Настройки = ХранилищеНастроек.Получить(); +// Если ТипЗнч(Настройки) = Тип("Структура") Тогда +// ЗаполнитьЗначенияСвойств(ЭтотОбъект, "<ИменаНастроек>"); +// КонецЕсли; +// КонецЕсли; +// +// Пример сохранения значений дополнительных настроек: +// Настройки = Новый Структура("<ИменаНастроек>", <ЗначенияНастроек>); +// ДополнительнаяОбработкаОбъект = ОбъектСсылка.ПолучитьОбъект(); +// ДополнительнаяОбработкаОбъект.ХранилищеНастроек = Новый ХранилищеЗначения(Настройки); +// ДополнительнаяОбработкаОбъект.Записать(); +// +// Возвращаемое значение: +// Строка - имя типа команд по открытию формы. +// +Функция ТипКомандыОткрытиеФормы() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы() +``` +
+ +## ТипКомандыЗаполнениеФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя типа команд по заполнению формы без записи объекта. Данные команды доступны +// только в обработках заполнения (Вид = "ЗаполнениеОбъекта"). +// Для выполнения команд такого типа в модуле объекта следует определить экспортную процедуру по шаблону: +// // Обработчик серверных команд. +// // +// // Параметры: +// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке(). +// // ОбъектыНазначения - Массив - ссылки объектов, для которых вызвана команда. +// // - Неопределено - не передается для команд типа "ЗаполнениеФормы". +// // ПараметрыВыполнения - Структура - контекст выполнения команды. +// // * ЭтаФорма - ФормаКлиентскогоПриложения - заполняемая форма. Передается для команд типа "ЗаполнениеФормы". +// // * ДополнительнаяОбработкаСсылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - ссылка обработки. +// // Может использоваться для чтения параметров обработки. +// // Пример см. в комментарии к функции ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы(). +// // +// Процедура ВыполнитьКоманду(ИдентификаторКоманды, ОбъектыНазначения, ПараметрыВыполнения) Экспорт +// // Реализация логики команды. +// КонецПроцедуры +// +// Возвращаемое значение: +// Строка - имя типа команд по заполнению формы. +// +Функция ТипКомандыЗаполнениеФормы() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыЗаполнениеФормы() +``` +
+ +## ТипКомандыЗагрузкаДанныхИзФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя типа команд по загрузке данных из файла. Данные команды доступны +// только в глобальных обработках (Вид = "ДополнительнаяОбработка") +// при наличии в конфигурации подсистемы "ЗагрузкаДанныхИзФайла". +// Для выполнения команд такого типа в модуле объекта следует определить экспортные процедуры по шаблону: +// // Определяет параметры загрузки данных из файла. +// // +// // Параметры: +// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке(). +// // ПараметрыЗагрузки - Структура - настройки загрузки данных: +// // * ИмяМакетаСШаблоном - Строка - имя макета с шаблоном загружаемых данных. +// // По умолчанию используется макет "ЗагрузкаИзФайла". +// // * ОбязательныеКолонкиМакета - Массив - список имен колонок обязательных для заполнения. +// // +// Процедура ОпределитьПараметрыЗагрузкиДанныхИзФайла(ИдентификаторКоманды, ПараметрыЗагрузки) Экспорт +// // Переопределение настроек загрузки данных из файла. +// КонецПроцедуры +// +// // Сопоставляет загружаемые данные с данными в информационной базе. +// // +// // Параметры: +// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке(). +// // ЗагружаемыеДанные - ТаблицаЗначений - описание загружаемых данных: +// // * СопоставленныйОбъект - СправочникСсылка.Ссылка - ссылка на сопоставленный объект. +// // Заполняется внутри этой процедуры. +// // * <другие колонки> - Строка - данные, загруженные из файла. +// // Состав колонок соответствует макету "ЗагрузкаИзФайла". +// // +// Процедура СопоставитьЗагружаемыеДанныеИзФайла(ИдентификаторКоманды, ЗагружаемыеДанные) Экспорт +// // Реализация логики поиска данных в программе. +// КонецПроцедуры +// +// // Загружает сопоставленные данные в базу. +// // +// // Параметры: +// // ИдентификаторКоманды - Строка - имя команды, определенное в функции СведенияОВнешнейОбработке(). +// // ЗагружаемыеДанные - ТаблицаЗначений - описание загружаемых данных: +// // * СопоставленныйОбъект - СправочникСсылка - ссылка на сопоставленный объект. +// // * РезультатСопоставленияСтроки - Строка - статус загрузки. Возможны варианты: Создан, Обновлен, Пропущен. +// // * ОписаниеОшибки - Строка - расшифровка ошибки загрузки данных. +// // * Идентификатор - Число - уникальный номер строки. +// // * <другие колонки> - Строка - данные, загруженные из файла. +// // Состав колонок соответствует макету "ЗагрузкаИзФайла". +// // ПараметрыЗагрузки - Структура - параметры с пользовательскими установками загрузки данных. +// // * СоздаватьНовые - Булево - требуется ли создавать новые элементы справочника. +// // * ОбновлятьСуществующие - Булево - требуется ли обновлять элементы справочника. +// // Отказ - Булево - признак отмены загрузки. +// // +// Процедура ЗагрузитьИзФайла(ИдентификаторКоманды, ЗагружаемыеДанные, ПараметрыЗагрузки, Отказ) Экспорт +// // Реализация логики загрузки данных в программу. +// КонецПроцедуры +// +// Возвращаемое значение: +// Строка - имя типа команд по загрузке данных из файла. +// +Функция ТипКомандыЗагрузкаДанныхИзФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыЗагрузкаДанныхИзФайла() +``` +
+ +## ТипФормыСписка +
+ +Описание, пример вызова + +```bsl + +// Идентификатор формы списка. +// +// Возвращаемое значение: +// Строка - идентификатор форм списков. +// +Функция ТипФормыСписка() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипФормыСписка() +``` +
+ +## ТипФормыОбъекта +
+ +Описание, пример вызова + +```bsl + +// Идентификатор формы объекта. +// +// Возвращаемое значение: +// Строка - идентификатор форм объектов. +// +Функция ТипФормыОбъекта() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипФормыОбъекта() +``` +
+ +## ФильтрДиалоговВыбораИСохранения +
+ +Описание, пример вызова + +```bsl + +// Фильтр для диалогов выбора или сохранения дополнительных отчетов и обработок. +// +// Возвращаемое значение: +// Строка - фильтр для диалогов выбора или сохранения дополнительных отчетов и обработок. +// +Функция ФильтрДиалоговВыбораИСохранения() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ФильтрДиалоговВыбораИСохранения() +``` +
+ +## ИмяНачальнойСтраницы +
+ +Описание, пример вызова + +```bsl + +// Имя раздела, соответствующего начальной странице. +// +// Возвращаемое значение: +// Строка - имя раздела, соответствующего начальной странице. +// +Функция ИмяНачальнойСтраницы() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ИмяНачальнойСтраницы() +``` +
+ +## ИдентификаторРабочегоСтола +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ДополнительныеОтчетыИОбработкиКлиентСервер.ИмяНачальнойСтраницы. +// Имя раздела, соответствующего начальной странице. +// +// Возвращаемое значение: +// Строка +// +Функция ИдентификаторРабочегоСтола() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиКлиентСервер.ИдентификаторРабочегоСтола() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиПереопределяемый.md b/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиПереопределяемый.md new file mode 100644 index 0000000..bc68baa --- /dev/null +++ b/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиПереопределяемый.md @@ -0,0 +1,63 @@ +--- +title: Дополнительные отчеты и обработки переопределяемый +slug: bsp/дополнительные-отчеты-и-обработки-переопределяемый +--- + + +## ОпределитьРазделыСДополнительнымиОбработками +
+ +Описание, пример вызова + +```bsl + +// Определяет разделы, в которых доступна команда вызова дополнительных обработок. +// В разделы необходимо добавить метаданные тех разделов, +// в которых размещены команды вызова. +// Для начальной страницы указать ДополнительныеОтчетыИОбработкиКлиентСервер.ИмяНачальнойСтраницы. +// +// Параметры: +// Разделы - Массив из ОбъектМетаданных - метаданные раздела (подсистемы). +// - Массив из Строка - для начальной страницы. +// +Процедура ОпределитьРазделыСДополнительнымиОбработками(Разделы) Экспорт +``` + +Пример вызова +```bsl +ДополнительныеОтчетыИОбработкиПереопределяемый.ОпределитьРазделыСДополнительнымиОбработками(Разделы) +``` +
+ +## ОпределитьРазделыСДополнительнымиОтчетами +
+ +Описание, пример вызова + +```bsl + +// Определяет разделы, в которых доступна команда вызова дополнительных отчетов. +// В Разделы необходимо добавить метаданные тех разделов, +// в которых размещены команды вызова. +// Для начальной страницы указать ДополнительныеОтчетыИОбработкиКлиентСервер.ИмяНачальнойСтраницы. +// +// Параметры: +// Разделы - Массив из ОбъектМетаданных - метаданные раздела (подсистемы). +// - Массив из Строка - для начальной страницы. +// +Процедура ОпределитьРазделыСДополнительнымиОтчетами(Разделы) Экспорт +``` + +Пример вызова +```bsl +ДополнительныеОтчетыИОбработкиПереопределяемый.ОпределитьРазделыСДополнительнымиОтчетами(Разделы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.md b/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.md new file mode 100644 index 0000000..2136ca7 --- /dev/null +++ b/src/content/docs/bsp/ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.md @@ -0,0 +1,151 @@ +--- +title: Дополнительные отчеты и обработки регламентные задания в модели сервиса +slug: bsp/дополнительные-отчеты-и-обработки-регламентные-задания-в-модели-сервиса +--- + + +## СоздатьНовоеЗадание +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РегламентныеЗаданияСервер.ДобавитьЗадание(). +// +// Возвращаемое значение: +// Неопределено - следует использовать РегламентныеЗаданияСервер.ДобавитьЗадание(). +// +Функция СоздатьНовоеЗадание() Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.СоздатьНовоеЗадание() +``` +
+ +## ПолучитьИдентификаторЗадания +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РегламентныеЗаданияСервер.УникальныйИдентификатор(). +// +// Параметры: +// Задание - РегламентноеЗадание - регламентное задание. +// +// Возвращаемое значение: +// Неопределено - следует использовать РегламентныеЗаданияСервер.УникальныйИдентификатор(). +// +Функция ПолучитьИдентификаторЗадания(Знач Задание) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.ПолучитьИдентификаторЗадания(Задание) +``` +
+ +## УстановитьПараметрыЗадания +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РегламентныеЗаданияСервер.ИзменитьЗадание(). +// +// Параметры: +// Задание - РегламентноеЗадание - регламентное задание. +// Использование - Булево - флаг использования регламентного задания. +// Параметры - Массив - параметры регламентного задания. +// Расписание - РасписаниеРегламентногоЗадания - расписание регламентного задания. +// +Процедура УстановитьПараметрыЗадания(Задание, Использование, Параметры, Расписание) Экспорт +``` + +Пример вызова +```bsl +ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.УстановитьПараметрыЗадания(Задание, Использование, Параметры, Расписание) +``` +
+ +## ПолучитьПараметрыЗадания +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РегламентныеЗаданияСервер.НайтиЗадания(). +// +// Параметры: +// Задание - РегламентноеЗадание - регламентное задание. +// +// Возвращаемое значение: +// Неопределено - следует использовать РегламентныеЗаданияСервер.НайтиЗадания(). +// +Функция ПолучитьПараметрыЗадания(Знач Задание) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.ПолучитьПараметрыЗадания(Задание) +``` +
+ +## НайтиЗадание +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РегламентныеЗаданияСервер.Задание(). +// +// Параметры: +// Идентификатор - УникальныйИдентификатор - идентификатор регламентного задания. +// +// Возвращаемое значение: +// Неопределено - следует использовать РегламентныеЗаданияСервер.НайтиЗадания(). +// +Функция НайтиЗадание(Знач Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.НайтиЗадание(Идентификатор) +``` +
+ +## УдалитьЗадание +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РегламентныеЗаданияСервер.УдалитьЗадание(). +// +// Параметры: +// Задание - РегламентноеЗадание - регламентное задание. +// +Процедура УдалитьЗадание(Знач Задание) Экспорт +``` + +Пример вызова +```bsl +ДополнительныеОтчетыИОбработкиРегламентныеЗаданияВМоделиСервиса.УдалитьЗадание(Задание) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЖурналРегистрации.md b/src/content/docs/bsp/ЖурналРегистрации.md new file mode 100644 index 0000000..2487c0e --- /dev/null +++ b/src/content/docs/bsp/ЖурналРегистрации.md @@ -0,0 +1,42 @@ +--- +title: Журнал регистрации +slug: bsp/журнал-регистрации +--- + + +## ЗаписатьСобытияВЖурналРегистрации +
+ +Описание, пример вызова + +```bsl + +// Процедура пакетной записи сообщений в журнал регистрации. +// После записи переменная СобытияДляЖурналаРегистрации очищается. +// +// Параметры: +// СобытияДляЖурналаРегистрации - СписокЗначений: +// * Значение - Структура: +// ** ИмяСобытия - Строка - имя записываемого события. +// ** ПредставлениеУровня - Строка - представление значений коллекции УровеньЖурналаРегистрации. +// Доступные значения: "Информация", "Ошибка", "Предупреждение", "Примечание". +// ** Комментарий - Строка - комментарий события. +// ** ДатаСобытия - Дата - дата события, подставляется в комментарий при записи. +// * Представление - Строка - не используется. +// +Процедура ЗаписатьСобытияВЖурналРегистрации(СобытияДляЖурналаРегистрации) Экспорт +``` + +Пример вызова +```bsl +ЖурналРегистрации.ЗаписатьСобытияВЖурналРегистрации(СобытияДляЖурналаРегистрации) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЖурналРегистрацииКлиент.md b/src/content/docs/bsp/ЖурналРегистрацииКлиент.md new file mode 100644 index 0000000..6de2236 --- /dev/null +++ b/src/content/docs/bsp/ЖурналРегистрацииКлиент.md @@ -0,0 +1,105 @@ +--- +title: Журнал регистрации клиент +slug: bsp/журнал-регистрации-клиент +--- + + +## ДобавитьСообщениеДляЖурналаРегистрации +
+ +Описание, пример вызова + +```bsl + +// Записывает сообщение в журнал регистрации. +// Если параметр ЗаписатьСобытия = Истина, то запись выполняется сразу (обращение к серверу). +// Если ЗаписатьСобытия = Ложь (по умолчанию), то сообщение помещается в очередь, которая +// будет записана позднее (обычно в течение 60 сек), либо при следующем вызове этой процедуры +// с признаком ЗаписатьСобытия = Истина, либо при вызове процедуры ЗаписатьСобытияВЖурналРегистрации. +// +// Параметры: +// ИмяСобытия - Строка - имя события для журнала регистрации; +// ПредставлениеУровня - Строка - описание уровня события, по нему будет определен уровень события при записи на +// сервере; +// Например: "Ошибка", "Предупреждение". +// Соответствуют именам элементов перечисления УровеньЖурналаРегистрации. +// Комментарий - Строка - комментарий для события журнала; +// ДатаСобытия - Дата - точная дата возникновения события, описанного в сообщении. Будет добавлена в начало +// комментария; +// ЗаписатьСобытия - Булево - выполнить запись всех ранее накопленных сообщений в журнал регистрации (обращение к +// серверу). +// +// Пример: +// ЖурналРегистрацииКлиент.ДобавитьСообщениеДляЖурналаРегистрации(СобытиеЖурналаРегистрации(), "Предупреждение", +// НСтр("ru = 'Невозможно подключиться к сети Интернет для проверки обновлений.'")); +// +Процедура ДобавитьСообщениеДляЖурналаРегистрации(Знач ИмяСобытия, Знач ПредставлениеУровня = "Информация", Экспорт +``` + +Пример вызова +```bsl +ЖурналРегистрацииКлиент.ДобавитьСообщениеДляЖурналаРегистрации(ИмяСобытия, ПредставлениеУровня, ); +``` +
+ +## ОткрытьЖурналРегистрации +
+ +Описание, пример вызова + +```bsl + +// Открывает форму журнала регистрации с установленным отбором. +// +// Параметры: +// Отбор - Структура: +// * Пользователь - Строка +// - СписокЗначений - имя или список пользователей +// информационной базы. +// * СобытиеЖурналаРегистрации - Строка +// - Массив - идентификатор события. +// * ДатаНачала - Дата - начало интервала отображаемых событий. +// * ДатаОкончания - Дата - конец интервала отображаемых событий. +// * Данные - Произвольный - данные любого типа. +// * Сеанс - СписокЗначений - список выбираемых сеансов. +// * Уровень - Строка +// - Массив - представление уровня важности +// события журнала регистрации. +// * ИмяПриложения - Массив - массив идентификаторов приложения. +// Владелец - ФормаКлиентскогоПриложения - форма, из которой открывается журнал регистрации. +// +Процедура ОткрытьЖурналРегистрации(Знач Отбор = Неопределено, Владелец = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЖурналРегистрацииКлиент.ОткрытьЖурналРегистрации(Отбор, Владелец); +``` +
+ +## ЗаписатьСобытияВЖурналРегистрации +
+ +Описание, пример вызова + +```bsl + +// Записывает накопленные сообщения из очереди в журнал регистрации (обращение к серверу). +// Сообщения добавляются в очередь с помощью процедуры ДобавитьСообщениеДляЖурналаРегистрации. +// +Процедура ЗаписатьСобытияВЖурналРегистрации() Экспорт +``` + +Пример вызова +```bsl +ЖурналРегистрацииКлиент.ЗаписатьСобытияВЖурналРегистрации() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗагрузкаДанныхИзФайла.md b/src/content/docs/bsp/ЗагрузкаДанныхИзФайла.md new file mode 100644 index 0000000..6bb6a6a --- /dev/null +++ b/src/content/docs/bsp/ЗагрузкаДанныхИзФайла.md @@ -0,0 +1,171 @@ +--- +title: Загрузка данных из файла +slug: bsp/загрузка-данных-из-файла +--- + + +## СформироватьОписаниеКолонок +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание колонок табличной части или таблицы значений. +// +// Параметры: +// Таблица - ТаблицаЗначений - ОписаниеТабличнойЧасти с колонками. +// - ДанныеФормыКоллекция - таблица размещенная на форме +// - Строка - для получения списка колонок табличной части +// необходимо указать его полное имя строкой, как в метаданных, например "Документы.СчетНаОплату.ТабличныеЧасти.Товары". +// Колонки - Строка - список извлекаемых колонок, разделенный запятыми. Например: "Номер, Товар, Количество". +// +// Возвращаемое значение: +// Массив из см. ЗагрузкаДанныхИзФайлаКлиентСервер.ОписаниеКолонкиМакета. +// +Функция СформироватьОписаниеКолонок(Таблица, Колонки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗагрузкаДанныхИзФайла.СформироватьОписаниеКолонок(Таблица, Колонки); +``` +
+ +## НастройкиЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Настройки загрузки новых и существующих элементов. +// +// Возвращаемое значение: +// Структура: +// * СоздаватьНовые - Булево +// * ОбновлятьСуществующие - Булево +// +Функция НастройкиЗагрузкиДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗагрузкаДанныхИзФайла.НастройкиЗагрузкиДанных() +``` +
+ +## ОписаниеЗагружаемыхДанныхДляСправочников +
+ +Описание, пример вызова + +```bsl + +// Добавляет в таблицу загружаемых данных служебные колонки. +// Список колонок таблицы динамический и формируется на основе макета загружаемых данных. +// В возвращаемом значении описаны только служебные колонки, которые присутствуют всегда. +// +// Параметры: +// ЗагружаемыеДанные - ТаблицаЗначений +// ОписаниеТипаОбъектаСопоставления - ОписаниеТипов - описание типа объекта сопоставления. +// ЗаголовокКолонкиОбъектаСопоставления - Строка - заголовок колонки объекта сопоставления. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * СопоставленныйОбъект - СправочникСсылка - ссылка на сопоставленный объект. +// * РезультатСопоставленияСтроки - Строка - статус загрузки, возможны варианты: Создан, Обновлен, Пропущен. +// * ОписаниеОшибки - Строка - расшифровка ошибки загрузки данных. +// * Идентификатор - Число - уникальный номер строки +// * СписокНеоднозначностей - СписокЗначений -список неоднозначностей возникших при загрузке данных. +// +Функция ОписаниеЗагружаемыхДанныхДляСправочников(ЗагружаемыеДанные, ОписаниеТипаОбъектаСопоставления, ЗаголовокКолонкиОбъектаСопоставления) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗагрузкаДанныхИзФайла.ОписаниеЗагружаемыхДанныхДляСправочников(ЗагружаемыеДанные, ОписаниеТипаОбъектаСопоставления, ЗаголовокКолонкиОбъектаСопоставления) +``` +
+ +## НовыйСписокНеоднозначностей +
+ +Описание, пример вызова + +```bsl + +// Создать таблицу со списком неоднозначностей для которых в ИБ имеется несколько подходящих вариантов данных. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Колонка - Строка - имя колонки, в которой была обнаружена неоднозначность; +// * Идентификатор - Число - идентификатор строки, в которой была обнаружена неоднозначность. +// +Функция НовыйСписокНеоднозначностей() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗагрузкаДанныхИзФайла.НовыйСписокНеоднозначностей() +``` +
+ +## ТаблицаСопоставления +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу, извлеченную из временного хранилища для сопоставления загружаемых данных с данными в приложении. +// Список колонок извлекаемой таблицы динамический и формируется на основе макета загружаемых данных. +// В возвращаемом значении описана только служебная колонка, которая присутствует всегда. +// +// Параметры: +// АдресРезультата - Строка - адрес во временном хранилища +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * СопоставленныйОбъект - СправочникСсылка - ссылка на сопоставленный объект. Заполняется внутри процедуры. +// +Функция ТаблицаСопоставления(АдресРезультата) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗагрузкаДанныхИзФайла.ТаблицаСопоставления(АдресРезультата) +``` +
+ +## ЗаписатьСвойстваОбъекта +
+ +Описание, пример вызова + +```bsl + +// Сохраняет значения дополнительных реквизитов и свойств из строки таблицы загружаемых данных в объект-владелец. +// Внутри функции код сам находит колонки содержащие значения дополнительных реквизитов или свойств и записывает их. +// Вызывается из процедуры ЗагрузитьИзФайла при прикладной загрузке данных в модуле менеджере объекта. +// +// Параметры: +// СсылкаНаОбъект - ЛюбаяСсылка - ссылка на объект-владельца свойств куда загружаются данные. +// СтрокаТаблицы - СтрокаТаблицыЗначений из см. ЗагрузкаДанныхИзФайла.ОписаниеЗагружаемыхДанныхДляСправочников +// +Процедура ЗаписатьСвойстваОбъекта(СсылкаНаОбъект, СтрокаТаблицы) Экспорт +``` + +Пример вызова +```bsl +ЗагрузкаДанныхИзФайла.ЗаписатьСвойстваОбъекта(СсылкаНаОбъект, СтрокаТаблицы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗагрузкаДанныхИзФайлаКлиент.md b/src/content/docs/bsp/ЗагрузкаДанныхИзФайлаКлиент.md new file mode 100644 index 0000000..d088fc5 --- /dev/null +++ b/src/content/docs/bsp/ЗагрузкаДанныхИзФайлаКлиент.md @@ -0,0 +1,65 @@ +--- +title: Загрузка данных из файла клиент +slug: bsp/загрузка-данных-из-файла-клиент +--- + + +## ПараметрыЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Создает новую структуру параметров для загрузки данных из файла в табличную часть. +// +// Возвращаемое значение: +// Структура - параметры для открытия формы загрузки данных в табличную часть: +// * ПолноеИмяТабличнойЧасти - Строка - полный путь к табличной части документа, +// в виде "ИмяДокумента.ИмяТабличнойЧасти". +// * Заголовок - Строка - заголовок формы загрузки данных из файла. +// * ИмяМакетаСШаблоном - Строка - имя макета с шаблоном для ввода данных. +// * ДополнительныеПараметры - Структура - любые дополнительные сведения, которые будут переданы +// в процедуру сопоставления данных. +// * КолонкиМакета - Массив из см. ЗагрузкаДанныхИзФайлаКлиентСервер.ОписаниеКолонкиМакета +// - Неопределено - если описание колонок для макета загрузки данных из файла отсутствует. +// +Функция ПараметрыЗагрузкиДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗагрузкаДанныхИзФайлаКлиент.ПараметрыЗагрузкиДанных() +``` +
+ +## ПоказатьФормуЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Открывает форму загрузки данных для заполнения табличной части. +// +// Параметры: +// ПараметрыЗагрузки - см. ЗагрузкаДанныхИзФайлаКлиент.ПараметрыЗагрузкиДанных. +// ОповещениеОЗагрузке - ОписаниеОповещения - оповещение, которое будет вызвано для добавления загруженных данных в +// табличную часть. +// +Процедура ПоказатьФормуЗагрузки(ПараметрыЗагрузки, ОповещениеОЗагрузке) Экспорт +``` + +Пример вызова +```bsl +ЗагрузкаДанныхИзФайлаКлиент.ПоказатьФормуЗагрузки(ПараметрыЗагрузки, ОповещениеОЗагрузке) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗагрузкаДанныхИзФайлаКлиентСервер.md b/src/content/docs/bsp/ЗагрузкаДанныхИзФайлаКлиентСервер.md new file mode 100644 index 0000000..f93e5ff --- /dev/null +++ b/src/content/docs/bsp/ЗагрузкаДанныхИзФайлаКлиентСервер.md @@ -0,0 +1,98 @@ +--- +title: Загрузка данных из файла клиент сервер +slug: bsp/загрузка-данных-из-файла-клиент-сервер +--- + + +## ОписаниеКолонкиМакета +
+ +Описание, пример вызова + +```bsl + +// Создает структуру описания колонок для макета загрузки данных из файла. +// +// Параметры: +// Имя -Строка - имя колонки. +// Тип - ОписаниеТипов - тип колонки. +// Заголовок - Строка - заголовок колонки выводимый в бланке для загрузки. +// Ширина - Число - ширина колонки. +// Подсказка - Строка - подсказка, выводимая в заголовке колонки. +// +// Возвращаемое значение: +// Структура - структура с описание колонки: +// * Имя - Строка - имя колонки. +// * Заголовок - Строка - заголовок колонки выводимый в бланке для загрузки. +// * Тип - ОписаниеТипов - тип колонки. +// * Ширина - Число - ширина колонки. +// * Позиция - Число - позиция колонки в таблице +// * Подсказка - Строка - подсказка выводимая в заголовке колонки. +// * ОбязательнаДляЗаполнения - Булево - истина, если колонка обязательно должна содержать значения. +// * Группа - Строка - имя группы колонок. +// * Родитель - Строка - используется для связи динамической колонки с реквизитом табличной части объекта. +// +Функция ОписаниеКолонкиМакета(Имя, Тип, Заголовок = Неопределено, Ширина = 0, Подсказка = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ЗагрузкаДанныхИзФайлаКлиентСервер.ОписаниеКолонкиМакета(Имя, Тип, Заголовок, Ширина, Подсказка); +``` +
+ +## КолонкаМакета +
+ +Описание, пример вызова + +```bsl + +// Возвращает колонку макета по имени. +// +// Параметры: +// Имя - Строка - имя колонки. +// СписокКолонок - Массив из см. ЗагрузкаДанныхИзФайлаКлиентСервер.ОписаниеКолонкиМакета +// +// Возвращаемое значение: +// - см. ОписаниеКолонкиМакета +// - Неопределено - если колонка не существует. +// +Функция КолонкаМакета(Имя, СписокКолонок) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗагрузкаДанныхИзФайлаКлиентСервер.КолонкаМакета(Имя, СписокКолонок) +``` +
+ +## УдалитьКолонкуМакета +
+ +Описание, пример вызова + +```bsl + +// Удаляет колонку макета из массива. +// +// Параметры: +// Имя - Строка - имя колонки. +// СписокКолонок - Массив из см. ЗагрузкаДанныхИзФайлаКлиентСервер.ОписаниеКолонкиМакета +// +Процедура УдалитьКолонкуМакета(Имя, СписокКолонок) Экспорт +``` + +Пример вызова +```bsl +ЗагрузкаДанныхИзФайлаКлиентСервер.УдалитьКолонкуМакета(Имя, СписокКолонок) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗагрузкаДанныхИзФайлаПереопределяемый.md b/src/content/docs/bsp/ЗагрузкаДанныхИзФайлаПереопределяемый.md new file mode 100644 index 0000000..8908c7e --- /dev/null +++ b/src/content/docs/bsp/ЗагрузкаДанныхИзФайлаПереопределяемый.md @@ -0,0 +1,53 @@ +--- +title: Загрузка данных из файла переопределяемый +slug: bsp/загрузка-данных-из-файла-переопределяемый +--- + + +## ПриОпределенииСправочниковДляЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Определяет список справочников, доступных для загрузки с помощью подсистемы "Загрузка данных из файла". +// Если справочник нужно исключить из списка загружаемых, то его следует удалить из таблицы. +// +// Параметры: +// ЗагружаемыеСправочники - ТаблицаЗначений - список справочников, в которые возможна загрузка данных: +// * ПолноеИмя - Строка - полное имя справочника (как в метаданных). +// * Представление - Строка - представление справочника в списке выбора. +// * ПрикладнаяЗагрузка - Булево - если Истина, значит справочник использует собственный алгоритм загрузки и +// в модуле менеджера справочника определены функции. +// +// Пример: +// +// // Собственный алгоритм загрузки в справочник Номенклатуры. +// Сведения = ЗагружаемыеСправочники.Добавить(); +// Сведения.ПолноеИмя = Метаданные.Справочники.Номенклатура.ПолноеИмя(); +// Сведения.Представление = Метаданные.Справочники.Номенклатура.Представление(); +// Сведения.ПрикладнаяЗагрузка = Истина; +// +// //Загрузка в классификатор валюты запрещена. +// СтрокаТаблицы = ЗагружаемыеСправочники.Найти(Метаданные.Справочники.Валюты.ПолноеИмя(), "ПолноеИмя"); +// Если СтрокаТаблицы <> Неопределено Тогда +// ЗагружаемыеСправочники.Удалить(СтрокаТаблицы); +// КонецЕсли; +// +Процедура ПриОпределенииСправочниковДляЗагрузкиДанных(ЗагружаемыеСправочники) Экспорт +``` + +Пример вызова +```bsl +ЗагрузкаДанныхИзФайлаПереопределяемый.ПриОпределенииСправочниковДляЗагрузкиДанных(ЗагружаемыеСправочники) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗаметкиПользователя.md b/src/content/docs/bsp/ЗаметкиПользователя.md new file mode 100644 index 0000000..641b293 --- /dev/null +++ b/src/content/docs/bsp/ЗаметкиПользователя.md @@ -0,0 +1,65 @@ +--- +title: Заметки пользователя +slug: bsp/заметки-пользователя +--- + + +## УстановитьСтатусИзмененияПометкиУдаленияДокумента +
+ +Описание, пример вызова + +```bsl + +// Добавляет признак изменения пометки удаления документа. +// Состав параметров процедуры соответствует подписке на событие ПередЗаписью объекта Документ. +// Описание см. в синтакс-помощнике. +// +// Параметры: +// Источник - ДокументОбъект - источник события подписки. +// Отказ - Булево - признак отказа от записи. Если установить Истина, то запись выполнена не будет +// и будет вызвано исключение. +// РежимЗаписи - РежимЗаписиДокумента - текущий режим записи документа-источника. +// РежимПроведения - РежимПроведенияДокумента - текущий режим проведения документа-источника. +// +Процедура УстановитьСтатусИзмененияПометкиУдаленияДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +ЗаметкиПользователя.УстановитьСтатусИзмененияПометкиУдаленияДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## УстановитьСтатусИзмененияПометкиУдаленияОбъекта +
+ +Описание, пример вызова + +```bsl + +// Добавляет признак изменения пометки удаления объекта. +// Состав параметров процедуры соответствует подписке на событие ПередЗаписью любых объектов, кроме документов. +// Описание см. в синтакс-помощнике. +// +// Параметры: +// Источник - СправочникОбъект - источник события подписки. +// Отказ - Булево - признак отказа от записи. Если установить Истина, то запись выполнена не будет +// и будет вызвано исключение. +// +Процедура УстановитьСтатусИзмененияПометкиУдаленияОбъекта(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ЗаметкиПользователя.УстановитьСтатусИзмененияПометкиУдаленияОбъекта(Источник, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗаполнениеОбъектовПереопределяемый.md b/src/content/docs/bsp/ЗаполнениеОбъектовПереопределяемый.md new file mode 100644 index 0000000..56468df --- /dev/null +++ b/src/content/docs/bsp/ЗаполнениеОбъектовПереопределяемый.md @@ -0,0 +1,114 @@ +--- +title: Заполнение объектов переопределяемый +slug: bsp/заполнение-объектов-переопределяемый +--- + + +## ПриОпределенииОбъектовСКомандамиЗаполнения +
+ +Описание, пример вызова + +```bsl + +// Определяет список объектов конфигурации, в модулях менеджеров которых предусмотрена процедура +// ДобавитьКомандыЗаполнения, формирующая команды заполнения объектов. +// Синтаксис процедуры ДобавитьКомандыЗаполнения см. в документации. +// +// Параметры: +// Объекты - Массив из ОбъектМетаданных - объекты метаданных с командами заполнения. +// +// Пример: +// Объекты.Добавить(Метаданные.Справочники.Организации); +// +Процедура ПриОпределенииОбъектовСКомандамиЗаполнения(Объекты) Экспорт +``` + +Пример вызова +```bsl +ЗаполнениеОбъектовПереопределяемый.ПриОпределенииОбъектовСКомандамиЗаполнения(Объекты) +``` +
+ +## ПередДобавлениемКомандЗаполнения +
+ +Описание, пример вызова + +```bsl + +// Определяет общие команды заполнения. +// +// Параметры: +// КомандыЗаполнения - ТаблицаЗначений - сформированные команды для вывода в подменю: +// +// Общие настройки: +// * Идентификатор - Строка - идентификатор команды. +// +// Настройки внешнего вида: +// * Представление - Строка - представление команды в форме. +// * Важность - Строка - группа в подменю, в которой следует вывести эту команду. +// Варианты: "Важное", "Обычное" и "СмТакже". +// * Порядок - Число - порядок размещения команды в подменю. Используется для настройки под конкретное +// рабочее место. +// * Картинка - Картинка - картинка команды. +// +// Настройки видимости и доступности: +// * ТипПараметра - ОписаниеТипов - типы объектов, для которых предназначена эта команда. +// * ВидимостьВФормах - Строка - имена форм через запятую, в которых должна отображаться команда. +// Используется, когда состав команд отличается для различных форм. +// * ФункциональныеОпции - Строка - имена функциональных опций через запятую, определяющих видимость команды. +// * УсловияВидимости - Массив - определяет видимость команды в зависимости от контекста. +// Для регистрации условий следует использовать процедуру +// ПодключаемыеКоманды.ДобавитьУсловиеВидимостиКоманды. +// Условия объединяются по "И". +// +// Настройки процесса выполнения: +// * МножественныйВыбор - Булево +// - Неопределено - если Истина (по умолчанию), то команда поддерживает множественный выбор. +// В этом случае в параметре выполнения будет передан список ссылок. +// * РежимЗаписи - Строка - действия, связанные с записью объекта, которые выполняются перед обработчиком команды: +// "Записывать" - записывать новые и модифицированные объекты (по умолчанию). +// Перед записью и проведением у пользователя запрашивается подтверждение. +// "НеЗаписывать" - объект не записывается, а в параметрах обработчика вместо ссылок передается +// вся форма. В этом режиме рекомендуется работать напрямую с формой, +// которая передается в структуре 2-го параметра обработчика команды. +// "ЗаписыватьТолькоНовые" - записывать новые объекты. +// "Проводить" - проводить документы. +// * ТребуетсяРаботаСФайлами - Булево - если Истина, то в веб-клиенте предлагается +// установить расширение для работы с 1С:Предприятием. Значение по умолчанию - Ложь. +// +// Настройки обработчика: +// * Менеджер - Строка - объект, отвечающий за выполнение команды. +// * ИмяФормы - Строка - имя формы, которую требуется получить для выполнения команды. +// Если Обработчик не указан, то у формы вызывается метод "Открыть". +// * ПараметрыФормы - Неопределено +// - ФиксированнаяСтруктура - параметры формы, указанной в ИмяФормы. +// * Обработчик - Строка - описание процедуры, обрабатывающей основное действие команды. +// Формат "<ИмяОбщегоМодуля>.<ИмяПроцедуры>" используется, когда процедура размещена в общем модуле. +// Формат "<ИмяПроцедуры>" используется в следующих случаях: +// если ИмяФормы заполнено, то в модуле указанной формы ожидается клиентская процедура; +// если ИмяФормы не заполнено, то в модуле менеджера этого объекта ожидается серверная процедура. +// * ДополнительныеПараметры - ФиксированнаяСтруктура - параметры обработчика, указанного в Обработчик. +// +// Параметры - Структура - сведения о контексте исполнения: +// * ИмяФормы - Строка - полное имя формы. +// СтандартнаяОбработка - Булево - если установить в Ложь, то событие ДобавитьКомандыЗаполнения менеджера объекта не +// будет вызвано. +// +Процедура ПередДобавлениемКомандЗаполнения(КомандыЗаполнения, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗаполнениеОбъектовПереопределяемый.ПередДобавлениемКомандЗаполнения(КомандыЗаполнения, Параметры, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектов.md b/src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектов.md new file mode 100644 index 0000000..0e02d2e --- /dev/null +++ b/src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектов.md @@ -0,0 +1,112 @@ +--- +title: Запрет редактирования реквизитов объектов +slug: bsp/запрет-редактирования-реквизитов-объектов +--- + + +## ЗаблокироватьРеквизиты +
+ +Описание, пример вызова + +```bsl + +// Принимает в качестве параметра форму объекта, к которому подключена подсистема, +// и запрещает редактирование заданных реквизитов, +// а также добавляет во "Все действия" команду для разрешения их редактирования. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОбъектов - форма объекта, где: +// * Объект - ДанныеФормыСтруктура +// - СправочникОбъект +// - ДокументОбъект +// * Элементы - ВсеЭлементыФормы: +// ** РазрешитьРедактированиеРеквизитовОбъекта - КнопкаФормы +// ГруппаДляКнопкиЗапрета - ГруппаФормы - переопределяет стандартное размещение +// кнопки запрета в форме объекта. +// ЗаголовокКнопкиЗапрета - Строка - заголовок кнопки. По умолчанию "Разрешить редактирование реквизитов". +// Объект - Неопределено - взять объект из реквизита формы "Объект". +// - ДанныеФормыСтруктура - по типу объекта. +// - СправочникОбъект +// - ДокументОбъект +// +Процедура ЗаблокироватьРеквизиты(Форма, ГруппаДляКнопкиЗапрета = Неопределено, ЗаголовокКнопкиЗапрета = "", Экспорт +``` + +Пример вызова +```bsl +ЗапретРедактированияРеквизитовОбъектов.ЗаблокироватьРеквизиты(Форма, ГруппаДляКнопкиЗапрета, ЗаголовокКнопкиЗапрета, ); +``` +
+ +## БлокируемыеРеквизитыОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает список реквизитов и табличных частей объекта, по которым установлен запрет редактирования. +// +// Параметры: +// ИмяОбъекта - Строка - полное имя объекта метаданных. +// +// Возвращаемое значение: +// Массив из Строка +// +Функция БлокируемыеРеквизитыОбъекта(ИмяОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗапретРедактированияРеквизитовОбъектов.БлокируемыеРеквизитыОбъекта(ИмяОбъекта) +``` +
+ +## НовыйБлокируемыйРеквизит +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства нового расширенного описания блокируемого реквизита +// для использования в функциях ПолучитьБлокируемыеРеквизитыОбъекта модулей менеджеров объектов. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя реквизита, например, "Объект.Автор", "ПриниматьВыручкуОбщейСуммой". +// Можно оставлять пустым для описания группы отдельно от реквизита. +// * ЭлементыФормы - Массив из Строка - имена элементов формы, соответствующие реквизиту. +// Требуется заполнить, когда их нельзя определить по пути элемента формы к имени реквизита, +// например, "ПриниматьВыручкуОбщейСуммойПереключатель". +// * Предупреждение - Строка - текст предупреждения о последствиях разблокировки, который выводится +// в форме разблокировки над реквизитом или группой реквизитов, если указана. +// * Группа - Строка - имя группы реквизитов, которая используется в форме разблокировки. +// Не требуется заполнять, когда реквизит выводится отдельно. +// Не учитывается при вызове из группового изменения реквизитов, кроме ОбщаяНадпись. +// * ПредставлениеГруппы - Строка - представление группы реквизитов, которое выводится в форме разблокировки. +// Не требуется заполнять, когда реквизит выводится отдельно. +// Не учитывается при вызове из группового изменения реквизитов, кроме ОбщаяНадпись. +// * ПредупреждениеГруппы - Строка - текст предупреждения о последствиях разблокировки, который выводится +// в форме разблокировки только над группой реквизитов, если указана. +// * Предупреждение - Строка - текст предупреждения о последствиях разблокировки, который выводится +// в форме разблокировки над реквизитом или группой реквизитов, если указана. +// +Функция НовыйБлокируемыйРеквизит() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗапретРедактированияРеквизитовОбъектов.НовыйБлокируемыйРеквизит() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектовКлиент.md b/src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектовКлиент.md new file mode 100644 index 0000000..c568ae4 --- /dev/null +++ b/src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектовКлиент.md @@ -0,0 +1,202 @@ +--- +title: Запрет редактирования реквизитов объектов клиент +slug: bsp/запрет-редактирования-реквизитов-объектов-клиент +--- + + +## РазрешитьРедактированиеРеквизитовОбъекта +
+ +Описание, пример вызова + +```bsl + +// Разрешает редактирование заблокированных элементов формы, связанных с заданными реквизитами. +// +// Если в объекте используется прикладная форма РазблокированиеРеквизитов, она будет открыта +// с параметрами Ссылка и ЗаблокированныеРеквизиты, а в описании оповещения закрытия формы +// должно быть возвращено Истина (все реквизиты разблокированы) или Массив имен реквизитов. +// При возврате Неопределено считается, что разблокировка не выполнялась. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОбъектов - форма, в которой требуется разрешить +// редактирование элементов формы, заданных реквизитов, где: +// * Объект - ДанныеФормыСтруктура: +// ** Ссылка - СправочникСсылка, ДокументСсылка +// +// ОбработкаПродолжения - ОписаниеОповещения - оповещение, которое вызывается после выполнения процедуры. +// В обработку оповещения передается параметр типа Булево: +// Истина - ссылок не обнаружено или пользователь решил разрешить редактирование, +// Ложь - видимых заблокированных реквизитов нет или +// ссылки обнаружены и пользователь отказался от продолжения. +// +// ТолькоВидимые - Булево - чтобы получить и разблокировать все реквизиты объекта, нужно указать Ложь. +// +Процедура РазрешитьРедактированиеРеквизитовОбъекта(Знач Форма, ОбработкаПродолжения = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ЗапретРедактированияРеквизитовОбъектовКлиент.РазрешитьРедактированиеРеквизитовОбъекта(Форма, ОбработкаПродолжения, ); +``` +
+ +## УстановитьДоступностьЭлементовФормы +
+ +Описание, пример вызова + +```bsl + +// Устанавливает доступность элементов формы, связанных с заданными реквизитами, +// для которых установлено разрешение изменения. Если передать массив реквизитов, +// тогда сначала будет дополнен состав реквизитов, разрешенных для изменения. +// Если разблокировка элементов формы, связанных с заданными реквизитами, +// снята для всех реквизитов, тогда кнопка разрешения редактирования блокируется. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой требуется разрешить +// редактирование элементов формы, заданных реквизитов. +// +// Реквизиты - Массив из Строка - имена реквизитов, для которых нужно установить разрешенность изменения. +// Указывается, когда функция РазрешитьРедактированиеРеквизитовОбъекта не используется. +// - Неопределено - состав реквизитов, доступных для редактирования, не изменяется, +// а для элементов формы, связанных с реквизитами, изменение которых разрешено, +// устанавливается доступность. +// +Процедура УстановитьДоступностьЭлементовФормы(Знач Форма, Знач Реквизиты = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗапретРедактированияРеквизитовОбъектовКлиент.УстановитьДоступностьЭлементовФормы(Форма, Реквизиты); +``` +
+ +## УстановитьРазрешенностьРедактированияРеквизитов +
+ +Описание, пример вызова + +```bsl + +// Устанавливает разрешенность редактирования для тех реквизитов, описание которых подготовлено в форме. +// Используется, когда доступность элементов формы изменяется самостоятельно, без +// использования функции УстановитьДоступностьЭлементовФормы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой требуется разрешить редактирование реквизитов объекта, где: +// * Элементы - ВсеЭлементыФормы: +// ** РазрешитьРедактированиеРеквизитовОбъекта - КнопкаФормы +// Реквизиты - Массив из Строка - имена реквизитов, которые нужно пометить как разрешенные для изменения. +// РедактированиеРазрешено - Булево - значение разрешенности редактирования реквизитов, которое нужно установить. +// Значение не будет установлено в Истина, если нет права редактирования реквизита. +// - Неопределено - не изменять разрешенность редактирования реквизитов. +// ПравоРедактирования - Булево - позволяет переопределить или доопределить возможность разблокировки +// реквизитов, которая вычисляется автоматически с помощью метода ПравоДоступа. +// - Неопределено - не изменять свойство ПравоРедактирования. +// +Процедура УстановитьРазрешенностьРедактированияРеквизитов(Знач Форма, Знач Реквизиты, Экспорт +``` + +Пример вызова +```bsl +ЗапретРедактированияРеквизитовОбъектовКлиент.УстановитьРазрешенностьРедактированияРеквизитов(Форма, Реквизиты, ); +``` +
+ +## Реквизиты +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив имен реквизитов, заданных в свойстве формы ПараметрыЗапретаРедактированияРеквизитов +// на основе имен реквизитов, указанных в модуле менеджера объекта, исключая реквизиты, +// у которых ПравоРедактирования = Ложь. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта с обязательным стандартным реквизитом "Объект". +// ТолькоЗаблокированные - Булево - для вспомогательных целей можно задать Ложь, чтобы +// получить список всех видимых реквизитов, которые могут разблокироваться. +// ТолькоВидимые - Булево - чтобы получить и разблокировать все реквизиты объекта, нужно указать Ложь. +// +// Возвращаемое значение: +// Массив из Строка - имена реквизитов. +// +Функция Реквизиты(Знач Форма, Знач ТолькоЗаблокированные = Истина, ТолькоВидимые = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗапретРедактированияРеквизитовОбъектовКлиент.Реквизиты(Форма, ТолькоЗаблокированные, ТолькоВидимые); +``` +
+ +## ПоказатьПредупреждениеВсеВидимыеРеквизитыРазблокированы +
+ +Описание, пример вызова + +```bsl + +// Выводит предупреждение о том, что все видимые реквизиты разблокированы. +// Необходимость в предупреждении возникает, когда команда разблокировки +// остается включенной из-за наличия невидимых неразблокированных реквизитов. +// +// Параметры: +// ОбработкаПродолжения - Неопределено - никаких действий после выполнения процедуры. +// - ОписаниеОповещения - оповещение, которое вызывается после выполнения процедуры. +// +Процедура ПоказатьПредупреждениеВсеВидимыеРеквизитыРазблокированы(ОбработкаПродолжения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗапретРедактированияРеквизитовОбъектовКлиент.ПоказатьПредупреждениеВсеВидимыеРеквизитыРазблокированы(ОбработкаПродолжения); +``` +
+ +## ПроверитьСсылкиНаОбъект +
+ +Описание, пример вызова + +```bsl + +// Устарела. Вместо этого вызова теперь проверка в общей форме РазблокированиеРеквизитов +// с длительной операцией. В собственной форме РазблокированиеРеквизитов следует +// самостоятельно реализовать проверку использования объектов с длительной операцией. +// +// Спрашивает у пользователя подтверждение на включение редактирования реквизитов +// и проверяет, есть ли ссылки на объект в информационной базе. +// +// Параметры: +// ОбработкаПродолжения - ОписаниеОповещения - оповещение, которое вызывается после проверки. +// В обработку оповещения передается параметр типа Булево: +// Истина - ссылок не обнаружено или пользователь решил разрешить редактирование, +// Ложь - видимых заблокированных реквизитов нет или +// ссылки обнаружены и пользователь отказался от продолжения. +// МассивСсылок - Массив - значения: +// * Ссылка - искомые ссылки в различных объектах. +// СинонимыРеквизитов - Массив - значения: +// * Строка - синонимы реквизитов, которые показываются пользователю. +// +Процедура ПроверитьСсылкиНаОбъект(Знач ОбработкаПродолжения, Знач МассивСсылок, Знач СинонимыРеквизитов) Экспорт +``` + +Пример вызова +```bsl +ЗапретРедактированияРеквизитовОбъектовКлиент.ПроверитьСсылкиНаОбъект(ОбработкаПродолжения, МассивСсылок, СинонимыРеквизитов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектовПереопределяемый.md b/src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектовПереопределяемый.md new file mode 100644 index 0000000..cb33653 --- /dev/null +++ b/src/content/docs/bsp/ЗапретРедактированияРеквизитовОбъектовПереопределяемый.md @@ -0,0 +1,82 @@ +--- +title: Запрет редактирования реквизитов объектов переопределяемый +slug: bsp/запрет-редактирования-реквизитов-объектов-переопределяемый +--- + + +## ПриОпределенииОбъектовСЗаблокированнымиРеквизитами +
+ +Описание, пример вызова + +```bsl + +// Определить объекты метаданных, в модулях менеджеров которых ограничивается возможность +// редактирования реквизитов с помощью экспортной функции ПолучитьБлокируемыеРеквизитыОбъекта. +// +// Функция ПолучитьБлокируемыеРеквизитыОбъекта должна возвращать значение типа +// см. ЗапретРедактированияРеквизитовОбъектов.ОписаниеБлокируемогоРеквизита +// +// Поле надписи, связанное с реквизитом, не блокируется. Если требуется блокировать, +// имя элемента надписи нужно указать в описании блокируемого реквизита. +// +// Параметры: +// Объекты - Соответствие из КлючИЗначение: +// * Ключ - Строка - полное имя объекта метаданных, подключенного к подсистеме; +// * Значение - Строка - пустая строка. +// +// Пример: +// Объекты.Вставить(Метаданные.Документы.ЗаказПокупателя.ПолноеИмя(), ""); +// +// При этом в модуле менеджера объекта размещается код, подобный: +// // См. ЗапретРедактированияРеквизитовОбъектовПереопределяемый.ПриОпределенииЗаблокированныхРеквизитов.ЗаблокированныеРеквизиты +// Функция ПолучитьБлокируемыеРеквизитыОбъекта() Экспорт +// БлокируемыеРеквизиты = Новый Массив; +// БлокируемыеРеквизиты.Добавить("Организация"); +// БлокируемыеРеквизиты.Добавить("Партнер;Партнер"); +// Реквизит = ЗапретРедактированияРеквизитовОбъектов.НовыйБлокируемыйРеквизит(); +// Реквизит.Имя = "Контрагент"; +// Реквизит.Предупреждение = НСтр("ru = 'Поле не рекомендуется менять, если уже есть введенные документы'"); +// БлокируемыеРеквизиты.Добавить(Реквизит); +// ... +// Возврат БлокируемыеРеквизиты; +// КонецФункции +// +Процедура ПриОпределенииОбъектовСЗаблокированнымиРеквизитами(Объекты) Экспорт +``` + +Пример вызова +```bsl +ЗапретРедактированияРеквизитовОбъектовПереопределяемый.ПриОпределенииОбъектовСЗаблокированнымиРеквизитами(Объекты) +``` +
+ +## ПриОпределенииЗаблокированныхРеквизитов +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить список заблокированных реквизитов, заданных в модуле менеджера объекта. +// +// Параметры: +// ИмяОбъектаМетаданных - Строка - например, "Справочник.Файлы". +// ЗаблокированныеРеквизиты - Массив из см. ЗапретРедактированияРеквизитовОбъектов.ОписаниеБлокируемогоРеквизита +// +Процедура ПриОпределенииЗаблокированныхРеквизитов(ИмяОбъектаМетаданных, ЗаблокированныеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ЗапретРедактированияРеквизитовОбъектовПереопределяемый.ПриОпределенииЗаблокированныхРеквизитов(ИмяОбъектаМетаданных, ЗаблокированныеРеквизиты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗащитаПерсональныхДанных.md b/src/content/docs/bsp/ЗащитаПерсональныхДанных.md new file mode 100644 index 0000000..cc88f91 --- /dev/null +++ b/src/content/docs/bsp/ЗащитаПерсональныхДанных.md @@ -0,0 +1,481 @@ +--- +title: Защита персональных данных +slug: bsp/защита-персональных-данных +--- + + +## ДобавитьКомандуПечатиСогласияНаОбработкуПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Процедура предназначена для использования из метода ДобавитьКомандыПечати +// стандартной подсистемы Печать в объектах, являющимися субъектами персональных данных. +// Добавляет в список команд печати команду перехода к подготовке согласия на обработку персональных данных субъекта. +// +// Параметры: +// КомандыПечати - см. УправлениеПечатью.СоздатьКоллекциюКомандПечати +// +Процедура ДобавитьКомандуПечатиСогласияНаОбработкуПерсональныхДанных(КомандыПечати) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.ДобавитьКомандуПечатиСогласияНаОбработкуПерсональныхДанных(КомандыПечати) +``` +
+ +## ИзменитьНастройкиУничтоженияПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Изменяет настройки уничтожения персональных данных субъектов в соответствии с новыми настройками системы. +// +// Параметры: +// Параметры - Структура - параметры выполнения процедуры: +// * ИспользоватьУничтожениеПерсональныхДанных - Булево - новое значение признака. +// АдресРезультата - Строка - адрес временного хранилища, в которое нужно поместить результат работы процедуры. +// +Процедура ИзменитьНастройкиУничтоженияПерсональныхДанных(Параметры, АдресРезультата = "") Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.ИзменитьНастройкиУничтоженияПерсональныхДанных(Параметры, АдресРезультата); +``` +
+ +## ЭтоОбъектСУничтоженнымиПерсональнымиДанными +
+ +Описание, пример вызова + +```bsl + +// Определяет наличие уничтоженных персональных данных в объекте. В качестве объекта может быть передан и сам субъект. +// +// Параметры: +// Объект - СправочникОбъект, СправочникСсылка, ДокументОбъект, ДокументСсылка, РегистрСведенийНаборЗаписей - +// проверяемый объект. +// Также в качестве значения параметра могут быть указаны наборы записей других регистров. +// +// Возвращаемое значение: +// Булево - признак наличия уничтоженных персональных данных. +// +Функция ЭтоОбъектСУничтоженнымиПерсональнымиДанными(Знач Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗащитаПерсональныхДанных.ЭтоОбъектСУничтоженнымиПерсональнымиДанными(Объект) +``` +
+ +## ПриСозданииНаСервереФормыСписка +
+ +Описание, пример вызова + +```bsl + +// В форме списка добавляет колонку с картинкой, сигнализирующей об отсутствии требуемого согласия +// на обработку персональных данных по субъектам в строках. Добавляет команду показа субъектов со +// скрытыми персональными данными. +// Вызывается из события ПриСозданииНаСервере формы списка. +// У динамических списков должна быть определена основная таблица. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма списка. +// СписокФормы - ТаблицаФормы - элемент формы динамического списка субъектов. +// +Процедура ПриСозданииНаСервереФормыСписка(Форма, СписокФормы) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.ПриСозданииНаСервереФормыСписка(Форма, СписокФормы) +``` +
+ +## ПриПолученииДанныхНаСервере +
+ +Описание, пример вызова + +```bsl + +// В форме списка заполняет колонку с картинкой, сигнализирующей об отсутствии требуемого согласия +// на обработку персональных данных по субъектам в строках. +// Вызывается из события ПриПолученииДанныхНаСервере формы списка. +// +// Параметры: +// Настройки - НастройкиКомпоновкиДанных - содержит копию полных настроек динамического списка. +// Строки - СтрокиДинамическогоСписка - коллекция содержит данные и оформление всех строк, получаемых в списке, +// кроме строк группировок. +// +Процедура ПриПолученииДанныхНаСервере(Настройки, Строки) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.ПриПолученииДанныхНаСервере(Настройки, Строки) +``` +
+ +## ДатаУничтоженияДанныхСубъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает дату уничтожения персональных данных субъекта. +// +// Параметры: +// Субъект - ОпределяемыйТип.СубъектПерсональныхДанных +// +// Возвращаемое значение: +// Дата +// +Функция ДатаУничтоженияДанныхСубъекта(Субъект) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗащитаПерсональныхДанных.ДатаУничтоженияДанныхСубъекта(Субъект) +``` +
+ +## ИспользоватьУничтожениеПерсональныхДанныхСубъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина если используется уничтожение персональных данных, иначе Ложь. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользоватьУничтожениеПерсональныхДанныхСубъектов() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗащитаПерсональныхДанных.ИспользоватьУничтожениеПерсональныхДанныхСубъектов() +``` +
+ +## ДобавитьСубъектыДляРасчетаСроковХранения +
+ +Описание, пример вызова + +```bsl + +// Регистрирует субъекты для расчета срока хранения персональных данных. +// +// Параметры: +// Субъекты - Массив из ОпределяемыйТип.СубъектПерсональныхДанных +// ДатаСобытия - Дата +// ИспользоватьУничтожениеПДн - Булево +// +Процедура ДобавитьСубъектыДляРасчетаСроковХранения(Знач Субъекты, Знач ДатаСобытия, Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.ДобавитьСубъектыДляРасчетаСроковХранения(Субъекты, ДатаСобытия, ); +``` +
+ +## ПриЗаписиФормыНастройкиРегистрацииСобытий +
+ +Описание, пример вызова + +```bsl + +// Выполняет преобразование данных формы настройки системы +// и установку использования события доступ для отмеченных категорий данных. +// В форме должны быть созданы +// - реквизит типа дерево значений, имя которого - "КатегорииПерсональныхДанных", +// - таблица формы, связанная с этим реквизитом, +// имя которой так же - "КатегорииПерсональныхДанных". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма настройки системы. +// +Процедура ПриЗаписиФормыНастройкиРегистрацииСобытий(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.ПриЗаписиФормыНастройкиРегистрацииСобытий(Форма) +``` +
+ +## УстановитьИспользованиеСобытияДоступ +
+ +Описание, пример вызова + +```bsl + +// Устанавливает режим использования события "Доступ. Доступ" +// журнала регистрации, контроль которого предусмотрен требованиями. +// Федерального закона от 27.07.2006 N152-ФЗ "О персональных данных" +// и подзаконных актов. +// Использование события "Доступ.Доступ" устанавливается для категорий персональных данных, +// сведения о которых перечислены в методе ЗаполнитьСведенияОПерсональныхДанных +// общего модуля ЗащитаПерсональныхДанныхПереопределяемый. +// +// Параметры: +// Использование - Булево - если Истина, то события будут регистрироваться. +// КатегорииДанных - Массив - массив категорий персональных данных, для которых производится установка +// использования (необязательный). +// +Процедура УстановитьИспользованиеСобытияДоступ(Использование, КатегорииДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.УстановитьИспользованиеСобытияДоступ(Использование, КатегорииДанных); +``` +
+ +## ИспользованиеСобытияДоступ +
+ +Описание, пример вызова + +```bsl + +// Составляет дерево используемых областей персональных данных. +// +// Возвращаемое значение: +// ДеревоЗначений - дерево областей данных с колонками: +// * Имя - Строка - идентификатор области персональных данных. +// * Представление - Строка - пользовательское представление области данных. +// * Использование - Булево - признак того, что для области данных +// установлена регистрация события "Доступ. Доступ". +// +Функция ИспользованиеСобытияДоступ() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗащитаПерсональныхДанных.ИспользованиеСобытияДоступ() +``` +
+ +## ДействующееСогласиеНаОбработкуПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения о действующем на указанную дату согласии субъекта на обработку персональных данных. +// Получение сведений производится в привилегированном режиме. +// +// Параметры: +// Субъект - ОпределяемыйТип.СубъектПерсональныхДанных - субъект, наличие согласия которого определяется, +// Организация - ОпределяемыйТип.Организация - оператор персональных данных, которому предоставлено согласие, +// Дата - Дата - дата, на которую запрашивается состояние, если не указана, выбирается последняя запись. +// ИсключаемыйРегистратор - ДокументСсылка.СогласиеНаОбработкуПерсональныхДанных - текущий документ; +// передается для того, чтобы при поиске согласия игнорировать выполненные текущим документом движения. +// +// Возвращаемое значение: +// Неопределено, Структура - Неопределено, если согласие не предоставлялось, +// или срок действия предоставленного согласия истек; +// Если обнаружено действующее согласие, то Структура со свойствами: +// * ДатаПолучения - Дата - дата получения согласия. +// * СрокДействия - Дата - дата, до которой будет действовать согласие. +// Если не указана, то согласие действует бессрочно. +// * ДокументОснование - ДокументСсылка.СогласиеНаОбработкуПерсональныхДанных - документ-основание. +// +Функция ДействующееСогласиеНаОбработкуПерсональныхДанных(Субъект, Организация = Неопределено, Знач Дата = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ЗащитаПерсональныхДанных.ДействующееСогласиеНаОбработкуПерсональныхДанных(Субъект, Организация, Дата, ); +``` +
+ +## ЗаполнитьСубъектыДляРасчетаСроковХраненияПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Регистрирует всех субъектов с неуничтоженными персональными данными для расчета сроков хранения персональных данных. +Процедура ЗаполнитьСубъектыДляРасчетаСроковХраненияПерсональныхДанных() Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.ЗаполнитьСубъектыДляРасчетаСроковХраненияПерсональныхДанных() +``` +
+ +## СубъектыСИстекшимСрокомХранения +
+ +Описание, пример вызова + +```bsl + +// Возвращает субъекты с истекшим сроком хранения персональных данных. +// +// Параметры: +// Субъекты - см. РегистрыСведений.СрокиХраненияПерсональныхДанных.СубъектыСИстекшимСрокомХранения.Субъекты +// ДатаАктуальности - см. РегистрыСведений.СрокиХраненияПерсональныхДанных.СубъектыСИстекшимСрокомХранения.ДатаАктуальности +// +// Возвращаемое значение: +// Массив из ОпределяемыйТип.СубъектПерсональныхДанных +// +Функция СубъектыСИстекшимСрокомХранения(Субъекты, ДатаАктуальности = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗащитаПерсональныхДанных.СубъектыСИстекшимСрокомХранения(Субъекты, ДатаАктуальности); +``` +
+ +## УдалитьИнформациюОбУничтоженииПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Удаляет информацию о том, что персональные данные субъекта уничтожены. +// +// Параметры: +// Субъект - ОпределяемыйТип.СубъектПерсональныхДанных +// +Процедура УдалитьИнформациюОбУничтоженииПерсональныхДанных(Субъект) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.УдалитьИнформациюОбУничтоженииПерсональныхДанных(Субъект) +``` +
+ +## СкрытьПерсональныеДанныеСубъектов +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// +// Скрывает персональные данные субъектов. Состав персональных данных определяется программно. +// +// Параметры: +// Субъекты - Массив +// - ОпределяемыйТип.СубъектПерсональныхДанных - ссылка или массив ссылок одного типа на субъекты. +// СообщатьОбИсключениях - Булево - признак необходимости информирования пользователя о добавленных исключениях. +// +Процедура СкрытьПерсональныеДанныеСубъектов(Знач Субъекты, СообщатьОбИсключениях = Ложь) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.СкрытьПерсональныеДанныеСубъектов(Субъекты, СообщатьОбИсключениях); +``` +
+ +## ЭтоОбъектСоСкрытымиПерсональнымиДанными +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЗащитаПерсональныхДанных.ЭтоОбъектСУничтоженнымиПерсональнымиДанными +// +// Определяет наличие уничтоженных персональных данных в объекте. В качестве объекта может быть передан и сам субъект. +// +// Параметры: +// Объект - СправочникОбъект, СправочникСсылка, ДокументОбъект, ДокументСсылка, РегистрСведенийНаборЗаписей - +// проверяемый объект. +// Также в качестве значения параметра могут быть указаны наборы записей других регистров. +// +// Возвращаемое значение: +// Булево - признак наличия уничтоженных персональных данных. +// +Функция ЭтоОбъектСоСкрытымиПерсональнымиДанными(Знач Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗащитаПерсональныхДанных.ЭтоОбъектСоСкрытымиПерсональнымиДанными(Объект) +``` +
+ +## ИзменитьНастройкиСкрытияПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЗащитаПерсональныхДанных.ИзменитьНастройкиУничтоженияПерсональныхДанных +// +// Изменяет настройки уничтожения персональных данных субъектов в соответствии с новыми настройками системы. +// +// Параметры: +// Параметры - Структура - параметры выполнения процедуры: +// * ИспользоватьУничтожениеПерсональныхДанных - Булево - новое значение признака. +// АдресРезультата - Строка - адрес временного хранилища, в которое нужно поместить результат работы процедуры. +// +Процедура ИзменитьНастройкиСкрытияПерсональныхДанных(Параметры, АдресРезультата = "") Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.ИзменитьНастройкиСкрытияПерсональныхДанных(Параметры, АдресРезультата); +``` +
+ +## ПослеЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// +// Параметры: +// Объект - ПланОбменаОбъект - узел плана обмена, для которого выполнялось получение данных. +// +Процедура ПослеЗагрузкиДанных(Объект) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанных.ПослеЗагрузкиДанных(Объект) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗащитаПерсональныхДанныхКлиент.md b/src/content/docs/bsp/ЗащитаПерсональныхДанныхКлиент.md new file mode 100644 index 0000000..e8739d7 --- /dev/null +++ b/src/content/docs/bsp/ЗащитаПерсональныхДанныхКлиент.md @@ -0,0 +1,108 @@ +--- +title: Защита персональных данных клиент +slug: bsp/защита-персональных-данных-клиент +--- + + +## ОткрытьФормуСогласиеНаОбработкуПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Осуществляет переход к форме подготовки согласия на обработку персональных данных, +// используется как клиентский обработчик печати (поэтому является функцией, а не процедурой). +// +// Параметры: +// ПараметрыПечати - Структура - параметры обработки команды печати: +// * ОбъектыПечати - Массив - в первом элементе ожидается субъект персональных данных; +// * Форма - ФормаКлиентскогоПриложения - форма, из которой выполняется печать. +// +// Возвращаемое значение: +// Неопределено - не требуется, т.к. функция является клиентским обработчиком печати. +// +Функция ОткрытьФормуСогласиеНаОбработкуПерсональныхДанных(ПараметрыПечати) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗащитаПерсональныхДанныхКлиент.ОткрытьФормуСогласиеНаОбработкуПерсональныхДанных(ПараметрыПечати) +``` +
+ +## ОбработкаОповещенияФормы +
+ +Описание, пример вызова + +```bsl + +// Определяет, что указанное событие - это событие об уничтожении персональных данных субъектов +// и обновляет объект управляемой формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма субъекта. +// ИмяСобытия - Строка - имя обрабатываемого события. +// +Процедура ОбработкаОповещенияФормы(Форма, ИмяСобытия) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхКлиент.ОбработкаОповещенияФормы(Форма, ИмяСобытия) +``` +
+ +## ОбработкаОповещенияФормыСписка +
+ +Описание, пример вызова + +```bsl + +// Определяет, что указанное событие - это событие об уничтожении персональных данных субъектов +// и обновляет данные в таблице субъектов. +// +// Параметры: +// СписокФормы - ТаблицаФормы - элемент формы динамического списка субъектов. +// ИмяСобытия - Строка - имя обрабатываемого события. +// +Процедура ОбработкаОповещенияФормыСписка(СписокФормы, ИмяСобытия) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхКлиент.ОбработкаОповещенияФормыСписка(СписокФормы, ИмяСобытия) +``` +
+ +## ПоказыватьСоСкрытымиПДн +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды формы списка субъектов персональных данных. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма субъекта. +// Список - ДинамическийСписок - динамический список субъектов. +// +Процедура ПоказыватьСоСкрытымиПДн(Форма, Список) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхКлиент.ПоказыватьСоСкрытымиПДн(Форма, Список) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗащитаПерсональныхДанныхПереопределяемый.md b/src/content/docs/bsp/ЗащитаПерсональныхДанныхПереопределяемый.md new file mode 100644 index 0000000..fce91f9 --- /dev/null +++ b/src/content/docs/bsp/ЗащитаПерсональныхДанныхПереопределяемый.md @@ -0,0 +1,357 @@ +--- +title: Защита персональных данных переопределяемый +slug: bsp/защита-персональных-данных-переопределяемый +--- + + +## ЗаполнитьСведенияОПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Позволяет задать настройки для регистрации событий доступа к персональным данным. +// +// При расширении состава субъектов персональных данных следует иметь в виду, что регистрация событий для них +// не начнется автоматически (это отдельно настраивает администратор программы). Однако если необходимо управлять этим +// при переходе на новую версию программы, то следует реализовать обработчик обновления, вызывающий +// процедуру ЗащитаПерсональныхДанных.УстановитьИспользованиеСобытияДоступ. +// +// Параметры: +// ТаблицаСведений - ТаблицаЗначений: +// * Объект - Строка - полное имя объекта метаданных с персональными данными; +// * ПоляРегистрации - Строка - имена полей, значения которых выводятся в журнал событий доступа к персональным +// данным для идентификации субъекта персональных данных. Для ссылочных типов, +// как правило, это поле "Ссылка". Отдельные поля регистрации отделяются запятой, +// альтернативные - символом "|"; +// * ПоляДоступа - Строка - имена полей доступа через запятую. Обращение (попытка доступа) к этим полям +// приводит к записи журнала; +// * ОбластьДанных - Строка - идентификатор категории данных. +// +// Пример: +// Сведения = ТаблицаСведений.Добавить(); +// Сведения.Объект = "Справочник.ФизическиеЛица"; +// Сведения.ПоляРегистрации = "Ссылка"; +// Сведения.ПоляДоступа = "Наименование"; +// Сведения.ОбластьДанных = "ФИО"; +// +// Сведения = ТаблицаСведений.Добавить(); +// Сведения.Объект = "Справочник.ФизическиеЛица"; +// Сведения.ПоляРегистрации = "Ссылка"; +// Сведения.ПоляДоступа = "СерияДокумента,НомерДокумента,КемВыданДокумент,ДатаВыдачиДокумента"; +// Сведения.ОбластьДанных = "ПаспортныеДанные"; +// +Процедура ЗаполнитьСведенияОПерсональныхДанных(ТаблицаСведений) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьСведенияОПерсональныхДанных(ТаблицаСведений) +``` +
+ +## ЗаполнитьОбластиПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Обеспечивает составление коллекции областей персональных данных. +// +// Параметры: +// КатегорииПерсональныхДанных - ТаблицаЗначений: +// * Имя - Строка - идентификатор категории данных. +// * Представление - Строка - пользовательское представление категории данных. +// * Родитель - Строка - идентификатор родительской категории данных. +// +Процедура ЗаполнитьОбластиПерсональныхДанных(КатегорииПерсональныхДанных) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьОбластиПерсональныхДанных(КатегорииПерсональныхДанных) +``` +
+ +## ДополнитьДанныеСубъектовПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при заполнении формы "Согласие на обработку персональных данных" данными, +// переданных в качестве параметров, субъектов. +// +// Параметры: +// СубъектыПерсональныхДанных - Массив из Структура - содержит сведения о субъектах: +// * Субъект - ОпределяемыйТип.СубъектПерсональныхДанных +// * ФИО - Строка +// * Адрес - Строка +// * ПаспортныеДанные - Строка +// ДатаАктуальности - Дата - дата, на которую нужно заполнить сведения. +// +Процедура ДополнитьДанныеСубъектовПерсональныхДанных(СубъектыПерсональныхДанных, ДатаАктуальности) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхПереопределяемый.ДополнитьДанныеСубъектовПерсональныхДанных(СубъектыПерсональныхДанных, ДатаАктуальности) +``` +
+ +## ДополнитьДанныеОрганизацииОператораПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при заполнении формы "Согласие на обработку персональных данных" данными организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - оператор персональных данных. +// ДанныеОрганизации - Структура - данные об организации (адрес, ФИО ответственного и т.д.). +// ДатаАктуальности - Дата - дата, на которую нужно заполнить сведения. +// +Процедура ДополнитьДанныеОрганизацииОператораПерсональныхДанных(Организация, ДанныеОрганизации, ДатаАктуальности) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхПереопределяемый.ДополнитьДанныеОрганизацииОператораПерсональныхДанных(Организация, ДанныеОрганизации, ДатаАктуальности) +``` +
+ +## ЗаполнитьФИОФизическогоЛица +
+ +Описание, пример вызова + +```bsl + +// Вызывается при заполнении формы "Согласие на обработку персональных данных". +// Предназначена для заполнения поля ФИО ответственного за обработку ПДн. +// +// Параметры: +// ФизическоеЛицо - ОпределяемыйТип.ФизическоеЛицо - ответственный за обработку персональных данных. +// ФИО - Строка - ФИО ответственного, которые нужно заполнить. +// +Процедура ЗаполнитьФИОФизическогоЛица(ФизическоеЛицо, ФИО) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьФИОФизическогоЛица(ФизическоеЛицо, ФИО) +``` +
+ +## ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +/////////////////////////////////////////////////////////////////////////////////////////////////////// +// Уничтожение персональных данных (ПДн) выполняется при проведении документа "Акт об уничтожении персональных данных". +// При этом выполняется поиск объектов информационной базы, в которых содержатся ПДн субъектов. +// Состав таких объектов и их полей описывается в методе ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных. +// В найденных объектах значения реквизитов, содержащих ПДн, очищаются или заменяются случайными значениями. +// Запись объекта с уничтоженными ПДн выполняется в режиме загрузки. В случае необходимости выполнения дополнительных +// действий, при уничтожении ПДн перед записью и после записи объекта можно использовать обработчики +// ПередУничтожениемПерсональныхДанных и ПослеУничтоженияПерсональныхДанных соответственно. + +// Заполняет таблицу значений с описанием объектов метаданных и их полей, в которых содержатся персональные данные +// субъектов, подлежащие уничтожению. +// +// Например, персональные данные физического лицо могут храниться в самом справочнике ФизическиеЛица, +// в регистре сведений ФИОФизическихЛиц, в документе ВедомостьНаВыплатуЗарплатыВБанк и т.д. +// +// Параметры: +// ТаблицаСведений - ТаблицаЗначений: +// * Объект - Строка - полное имя объекта метаданных, в котором содержатся персональные данные субъекта. +// Например, "Справочник.ФизическиеЛица". +// * ПолеСубъект - Строка - имя поля объекта, в котором содержится ссылка на субъекта. +// Для стандартных реквизитов используется имя реквизита, например "Ссылка". +// Для остальных полей используется полное имя объекта метаданных реквизита, например +// "Документ.ВедомостьНаВыплатуЗарплатыВБанк.ТабличнаяЧасть.Состав.Реквизит.ФизическоеЛицо" +// * Поля - Массив из Строка, Строка - имена полей объекта, в которых содержатся персональные данные субъекта +// Для стандартных реквизитов используется имя реквизита, например "Наименование". +// Для остальных полей используется полное имя объекта метаданных реквизита, например +// "Справочник.ФизическиеЛица.Реквизит.ФИО" +// * КатегорияДанных - Строка - категория, к которой относятся персональные данные. +// +// Пример: +// +// НовыеСведения = ТаблицаСведений.Добавить(); +// НовыеСведения.Объект = "Справочник.ФизическиеЛица"; +// НовыеСведения.ПолеСубъект = "Ссылка"; +// НовыеСведения.Поля = ОбщегоНазначенияКлиентСервер.ЗначениеВМассиве("Наименование"); +// НовыеСведения.КатегорияДанных = "ФИО"; +// +// НовыеСведения = ТаблицаСведений.Добавить(); +// НовыеСведения.Объект = "Документ.ВедомостьНаВыплатуЗарплатыВБанк"; +// НовыеСведения.ПолеСубъект = "Документ.ВедомостьНаВыплатуЗарплатыВБанк.ТабличнаяЧасть.Состав.Реквизит.ФизическоеЛицо"; +// НовыеСведения.Поля = ОбщегоНазначенияКлиентСервер.ЗначениеВМассиве( +// "Документ.ВедомостьНаВыплатуЗарплатыВБанк.ТабличнаяЧасть.Состав.Реквизит.СНИЛС"); +// НовыеСведения.КатегорияДанных = "СНИЛС"; +// +Процедура ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных(ТаблицаСведений) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхПереопределяемый.ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных(ТаблицаСведений) +``` +
+ +## ПередСкрытиемПерсональныхДанныхСубъектов +
+ +Описание, пример вызова + +```bsl + +// Позволяет выполнить дополнительные действия перед уничтожением персональных данных субъектов. В том числе, отказаться +// от уничтожения персональных данных, добавив субъекта в таблицу исключений с указанием причины отказа от уничтожения. +// Или же добавить в массив субъектов других субъектов, данные которых тоже должны быть уничтожены. Например, если при +// уничтожении данных физического лица должны быть уничтожены данные связанных с ним кандидатов. +// +// Параметры: +// Субъекты - Массив из ОпределяемыйТип.СубъектПерсональныхДанных - ссылки на объекты данных, чьи персональные данные +// будут уничтожены. +// ТаблицаИсключений - ТаблицаЗначений: +// * Субъект - ОпределяемыйТип.СубъектПерсональныхДанных +// * ПричинаОтменыУничтожения - Строка +// - ТаблицаЗначений - в которую добавляются субъекты и причины отказа уничтожения их данных +// ОтказОтСкрытия - Булево - (по умолчанию Истина) признак отказа от скрытия. Если определены причины отказа +// от скрытия, то параметру необходимо установить значение Ложь. +// +Процедура ПередСкрытиемПерсональныхДанныхСубъектов(Субъекты, ТаблицаИсключений, ОтказОтСкрытия) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхПереопределяемый.ПередСкрытиемПерсональныхДанныхСубъектов(Субъекты, ТаблицаИсключений, ОтказОтСкрытия) +``` +
+ +## ПередУничтожениемПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Позволяет выполнить дополнительные действия при уничтожении персональных данных перед записью объекта, +// а также отказаться от записи объекта. +// +// Параметры: +// Объект - СправочникОбъект,ДокументОбъект +// Субъекты - Массив из ОпределяемыйТип.СубъектПерсональныхДанных +// ВыполнитьЗаписьОбъекта - Булево - если Ложь, то запись объекта не выполняется. +// +Процедура ПередУничтожениемПерсональныхДанных(Объект, Субъекты, ВыполнитьЗаписьОбъекта) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхПереопределяемый.ПередУничтожениемПерсональныхДанных(Объект, Субъекты, ВыполнитьЗаписьОбъекта) +``` +
+ +## ПослеУничтоженияПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// Позволяет выполнить дополнительные действия при уничтожении персональных данных после записи объекта. +// +// Параметры: +// Объект - СправочникОбъект,ДокументОбъект +// Субъекты - Массив из ОпределяемыйТип.СубъектПерсональныхДанных +// +Процедура ПослеУничтоженияПерсональныхДанных(Объект, Субъекты) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхПереопределяемый.ПослеУничтоженияПерсональныхДанных(Объект, Субъекты) +``` +
+ +## ПриРасчетеСроковХраненияПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +/////////////////////////////////////////////////////////////////////////////////////////////////////// +// Срок хранения ПДн - это дата после которой необходимо уничтожить ПДн субъекта. Ранее этой даты уничтожить ПДн нельзя. +// Сроки хранения ПДн рассчитываются автоматически регламентным заданием РасчетСроковХраненияПерсональныхДанных. +// При наступлении события, которое влияет на срок хранения ПДн, необходимо с помощью метода +// ЗащитаПерсональныхДанных.ДобавитьСубъектыДляРасчетаСроковХранения зарегистрировать субъекта для расчета срока хранения. +// Такими событиями могут быть, например, создание нового физического лица, ввод согласия на обработку ПДн или +// прием сотрудника на работу. +// При расчете сроков хранения ПДн, в процедуре ПриРасчетеСроковХраненияПерсональныхДанных заполняется таблица значений, +// в которую различные подсистемы добавляют рассчитанные сроки хранения. Датой, при наступлении которой данные подлежат +// уничтожению, будет определена самая поздняя из всех заполненных для этого субъекта. + +// Позволяет добавить в таблицу значений информацию о сроках хранения персональных данных. +// +// Параметры: +// ДанныеСубъектов - ТаблицаЗначений: +// * Субъект - ОпределяемыйТип.СубъектПерсональныхДанных - ссылка на субъекта. +// * ДатаСобытия - Дата - дата события, которое потребовало обновления срока хранения персональных данных. +// СрокиХранения - ТаблицаЗначений: +// * Субъект - ОпределяемыйТип.СубъектПерсональныхДанных - ссылка на субъекта +// * СрокХранения - Дата - дата, до которой должны храниться персональные данные субъекта и при наступлении которой, +// они должны быть уничтожены. +// * Организация - ОпределяемыйТип.Организация - ссылка на организацию субъекта (если организацию определить +// невозможно, не заполняется) +// * Комментарий - Строка - произвольная строка с пояснением к рассчитанному сроку хранения. +// +Процедура ПриРасчетеСроковХраненияПерсональныхДанных(ДанныеСубъектов, СрокиХранения) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхПереопределяемый.ПриРасчетеСроковХраненияПерсональныхДанных(ДанныеСубъектов, СрокиХранения) +``` +
+ +## ОрганизацияПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует разместить функцию ОрганизацияПоУмолчанию в модуле менеджера справочника, +// указанного в определяемом типе Организация. +// +// Возвращаемое значение: +// ОпределяемыйТип.Организация +// +Функция ОрганизацияПоУмолчанию() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗащитаПерсональныхДанныхПереопределяемый.ОрганизацияПоУмолчанию() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЗаявлениеНаСертификатПереопределяемый.md b/src/content/docs/bsp/ЗаявлениеНаСертификатПереопределяемый.md new file mode 100644 index 0000000..d6946f7 --- /dev/null +++ b/src/content/docs/bsp/ЗаявлениеНаСертификатПереопределяемый.md @@ -0,0 +1,283 @@ +--- +title: Заявление на сертификат переопределяемый +slug: bsp/заявление-на-сертификат-переопределяемый +--- + + +## ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Вызывается в форме добавления заявления на новый сертификат для заполнения реквизитов организации и при ее выборе. +// +// Параметры: +// Параметры - Структура: +// +// * ТипОрганизации - ОписаниеТипов - возвращаемое значение. Содержит ссылочные типы, из которых +// можно сделать выбор. Начальное значение ОпределяемыйТип.Организация. +// - Неопределено - возвращаемое значение. Выбор организации не поддерживается. +// +// * Организация - СправочникСсылка - организация из ТипОрганизации, которую нужно заполнить. +// Если организация уже заполнена, требуется перезаполнить ее свойства - например, +// при повтором вызове, когда пользователь выбрал другую организацию. +// - Неопределено - если ТипОрганизации не настроен. +// Пользователю недоступен выбор организации. +// +// * ЭтоИндивидуальныйПредприниматель - Булево - возвращаемое значение: +// Ложь - начальное значение - указанная организация является юридическим лицом; +// Истина - указанная организация является индивидуальным предпринимателем. +// +// * ЭтоИностраннаяОрганизация - Булево - возвращаемое значение, когда Истина ОГРН не заполняется. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * НаименованиеСокращенное - Строка - возвращаемое значение. Краткое наименование организации. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * НаименованиеПолное - Строка - возвращаемое значение. Краткое наименование организации. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * ИНН - Строка - возвращаемое значение. ИНН организации. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * КПП - Строка - возвращаемое значение. КПП организации. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * ОГРН - Строка - возвращаемое значение. ОГРН организации (кроме иностранных). +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * РасчетныйСчет - Строка - возвращаемое значение. Основной расчетный счет организации для договора. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * БИК - Строка - возвращаемое значение. БИК банка расчетного счета. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * КорреспондентскийСчет - Строка - возвращаемое значение. Корреспондентский счет банка расчетного счета. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * Телефон - Строка - возвращаемое значение. Телефон организации в формате JSON, как его +// возвращает функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// +// * ЮридическийАдрес - Строка - возвращаемое значение. Юридический адрес организации в формате JSON, как его +// возвращает функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +Процедура ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат(Параметры) +``` +
+ +## ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Вызывается в форме добавления заявления на новый сертификат для заполнении реквизитов владельца и при его выборе. +// +// Параметры: +// Параметры - Структура: +// * ЭтоФизическоеЛицо - Булево - если Истина, тогда заявление заполняется для физического лица, иначе для организации. +// +// * Организация - СправочникСсылка - выбранная организация из ТипОрганизации, на которую оформляется сертификат. +// - Неопределено - если ТипОрганизации не настроен или составной и тип организации не выбран. +// +// * ТипВладельца - ОписаниеТипов - возвращаемое значение. Содержит ссылочные типы, из которых можно сделать выбор. +// - Неопределено - возвращаемое значение. Выбор владельца не поддерживается. +// +// * Сотрудник - СправочникСсылка - возвращаемое значение. Владелец сертификата из ТипВладельца, +// которого нужно заполнить. Если уже заполнен (выбран пользователем), его не следует изменять. +// - Неопределено - если ТипВладельца не определен, тогда реквизит недоступен пользователю. +// +// * Директор - СправочникСсылка - возвращаемое значение. Директор из ТипВладельца, который может быть +// выбран, как владелец сертификата. Не учитывается, если заявление для ИП или физического лица. +// - Неопределено - начальное значение - скрыть директора из списка выбора. +// +// * ГлавныйБухгалтер - СправочникСсылка - возвращаемое значение. Главный бухгалтер из ТипВладельца, который может +// быть выбран как владелец сертификата. Не учитывается, если заявление для ИП или физического лица. +// - Неопределено - начальное значение - скрыть главного бухгалтера из списка выбора. +// +// * Пользователь - СправочникСсылка.Пользователи - возвращаемое значение. Пользователь - владелец сертификата. +// В общем случае может быть не заполнено. Рекомендуется заполнить, если есть возможность. +// Записывается в сертификат в поле Пользователь, может быть изменено в дальнейшем. +// +// * Фамилия - Строка - возвращаемое значение. Фамилия сотрудника. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * Имя - Строка - возвращаемое значение. Имя сотрудника. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * Отчество - Строка - возвращаемое значение. Отчество сотрудника. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * ДатаРождения - Дата - возвращаемое значение. Дата рождения сотрудника. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * Пол - Строка - возвращаемое значение. Пол сотрудника "Мужской" или "Женский". +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * МестоРождения - Строка - возвращаемое значение. Описание места рождения сотрудника. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * Гражданство - СправочникСсылка.СтраныМира - возвращаемое значение. Гражданство сотрудника. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * ИНН - Строка - возвращаемое значение. ИНН физического лица. +// Учитывается только в заявлении для физического лица. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * СтраховойНомерПФР - Строка - возвращаемое значение. СНИЛС сотрудника. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * Должность - Строка - возвращаемое значение. Должность сотрудника в организации. +// Не учитывается, если заявление для ИП или физического лица. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * Подразделение - Строка - возвращаемое значение. Обособленное подразделение организации, в котором +// работает сотрудник. Не учитывается, если заявление для ИП или физического лица. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// +// * ДокументВид - Строка - возвращаемое значение. Строки "21" или "91". 21 - паспорт гражданина РФ, +// 91 - иной документ, предусмотренный законодательством РФ (по СПДУЛ). +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * ДокументНомер - Строка - возвращаемое значение. Номер документа сотрудника (серия и +// номер для паспорта гражданина РФ). +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * ДокументКемВыдан - Строка - возвращаемое значение. Кем выдан документ сотрудника. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * ДокументКодПодразделения - Строка - возвращаемое значение. Код подразделения, если вид документа 21. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * ДокументДатаВыдачи - Дата - возвращаемое значение. Дата выдачи документа сотрудника. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * АдресРегистрации - Строка - возвращаемое значение. Адрес постоянной или временной регистрации +// физического лица (минимум регион, населенный пункт) в формате JSON, как его возвращает +// функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// Учитывается только в заявлении для физического лица. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * ЭлектроннаяПочта - Строка - возвращаемое значение. Адрес электронной почты сотрудника в формате JSON, как его +// возвращает функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * Телефон - Строка - возвращаемое значение. Телефон физического лица в формате JSON, как его +// возвращает функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// Учитывается только в заявлении для физического лица. +// +// +Процедура ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат(Параметры) +``` +
+ +## ПриЗаполненииРеквизитовРуководителяВЗаявленииНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Вызывается в форме добавления заявления на новый сертификат для заполнения реквизитов руководителя и при его выборе. +// Только для юридического лица. Для индивидуального предпринимателя и физического лица не требуется. +// +// Параметры: +// Параметры - Структура: +// * Организация - СправочникСсылка - выбранная организация из ТипОрганизации, на которую оформляется сертификат. +// - Неопределено - если ТипОрганизации не настроен. +// +// * ТипРуководителя - ОписаниеТипов - возвращаемое значение. Содержит ссылочные типы, из которых можно сделать выбор. +// - Неопределено - возвращаемое значение. Выбор партнера не поддерживается. +// +// * Руководитель - СправочникСсылка - это значение из ТипРуководителя, выбранное пользователем, +// по которому нужно заполнить должность. +// - Неопределено - ТипРуководителя не определен. +// - ЛюбаяСсылка - возвращаемое значение. Руководитель, который будет подписывать документы. +// +// * Представление - Строка - возвращаемое значение. Представление руководителя. +// - Неопределено - получить представление от значения Руководитель. +// +// * Должность - Строка - возвращаемое значение. Должность руководителя, который будет подписывать документы. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * Основание - Строка - возвращаемое значение. Основание на котором действует +// должностное лицо (устав, доверенность, ...). +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +Процедура ПриЗаполненииРеквизитовРуководителяВЗаявленииНаСертификат(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовРуководителяВЗаявленииНаСертификат(Параметры) +``` +
+ +## ПриЗаполненииРеквизитовПартнераВЗаявленииНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Вызывается в форме добавления заявления на новый сертификат для заполнения реквизитов партнера и при его выборе. +// +// Параметры: +// Параметры - Структура: +// * ЭтоФизическоеЛицо - Булево - если Истина, тогда заявление заполняется для физического лица, иначе для организации. +// +// * Организация - СправочникСсылка - выбранная организация из ТипОрганизации, на которую оформляется сертификат. +// - Неопределено - если ТипОрганизации не настроен. +// +// * ТипПартнера - ОписаниеТипов - содержит ссылочные типы из которых можно сделать выбор. +// - Неопределено - выбор партнера не поддерживается. +// +// * Партнер - СправочникСсылка - это контрагент (обслуживающая организация) из ТипПартнера, +// выбранный пользователем, по которому нужно заполнить реквизиты, описанные ниже. +// - Неопределено - ТипПартнера не определен. +// - ЛюбаяСсылка - возвращаемое значение. Значение, сохраняемое в заявке для истории. +// +// * Представление - Строка - возвращаемое значение. Представление партнера. +// - Неопределено - получить представление от значения Партнер. +// +// * ЭтоИндивидуальныйПредприниматель - Булево - возвращаемое значение: +// Ложь - начальное значение - указанный партнер является юридическим лицом, +// Истина - указанный партнер является индивидуальным предпринимателем. +// +// * ИНН - Строка - возвращаемое значение. ИНН партнера. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +// * КПП - Строка - возвращаемое значение. КПП партнера. +// - Неопределено - значение не указано, не изменять имеющееся значение. +// +Процедура ПриЗаполненииРеквизитовПартнераВЗаявленииНаСертификат(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовПартнераВЗаявленииНаСертификат(Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтеграцияОбъектовОбластейДанных.md b/src/content/docs/bsp/ИнтеграцияОбъектовОбластейДанных.md new file mode 100644 index 0000000..a5bcf4a --- /dev/null +++ b/src/content/docs/bsp/ИнтеграцияОбъектовОбластейДанных.md @@ -0,0 +1,261 @@ +--- +title: Интеграция объектов областей данных +slug: bsp/интеграция-объектов-областей-данных +--- + + +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// СоответствиеИменПсевдонимам - см. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков.СоответствиеИменПсевдонимам +// +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияОбъектовОбластейДанных.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +// +// Параметры: +// Типы - см. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияОбъектовОбластейДанных.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ДобавитьОбъектКОтправке +
+ +Описание, пример вызова + +```bsl + +// Добавляет объект к отправке во внешнюю учетную систему. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных - учетная система. +// ИдентификаторОбъекта - Строка - идентификатор объекта, должен соответствовать +// требованиям к именованию файлов операционной системы (длина - 50). +// Обработчик - Строка - идентификатор обработчика объекта (длина - 50). +// ДанныеОбъекта - ДвоичныеДанные - данные объекта к отправке (если не указано, данные будут запрошены перед отправкой). +// +Процедура ДобавитьОбъектКОтправке(УчетнаяСистема, ИдентификаторОбъекта, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияОбъектовОбластейДанных.ДобавитьОбъектКОтправке(УчетнаяСистема, ИдентификаторОбъекта, ); +``` +
+ +## УдалитьОбъектКОтправке +
+ +Описание, пример вызова + +```bsl + +// Удаляет объект из объектов к отправке в учетную систему. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных - учетная система. +// ИдентификаторОбъекта - Строка - идентификатор объекта (длина - 50). +// Обработчик - Строка - идентификатор обработчика объекта (длина - 50). +// +Процедура УдалитьОбъектКОтправке(УчетнаяСистема, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияОбъектовОбластейДанных.УдалитьОбъектКОтправке(УчетнаяСистема, ); +``` +
+ +## ОповеститьОбИзмененииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Выполняет оповещение внешней учетной системы в соответствие с настройками оповещения. +// @skip-warning ПустойМетод - особеннность реализации. +// +// Параметры: +// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных, СправочникСсылка - учетная система. +// ИдентификаторОбъекта - Строка - идентификатор объекта (длина - 50). +// ВызыватьИсключение - Булево - признак вызова исключения при неудачной отправке оповещения. +// +Процедура ОповеститьОбИзмененииОбъекта(УчетнаяСистема, ИдентификаторОбъекта, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияОбъектовОбластейДанных.ОповеститьОбИзмененииОбъекта(УчетнаяСистема, ИдентификаторОбъекта, ); +``` +
+ +## Настройки +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки внешней учетной системы. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных, СправочникСсылка - учетная система. +// КлючиНастроек - Строка, Массив Из Строка - ключи настроек, по которым нужно вернуть значения. +// +// Возвращаемое значение: +// Структура - Настройки учетной системы: +// * ОповещатьОбИзменениях - Булево - признак использования оповещений при создании/изменении данных в приложении. +// * АдресСервиса - Строка - адрес сервиса приема оповещений об изменениях. +// * СпособАутентификации - ПеречислениеСсылка.СпособыАутентификации - способ аутентификации в сервисе приема оповещений. +// * Логин - Строка - логин аутентификации в сервисе приема оповещений (используется при basic-аутентификации). +// * Пароль - Строка - пароль аутентификации в сервисе приема оповещений (используется при basic-аутентификации). +// * ИспользоватьСертификат - Булево - признак использования сертификата при установке соединения с сервисом приема оповещений. +// * ИмяСертификата - Строка - имя файла сертификата. +// * ПарольСертификата - Строка - пароль сертификата (используется, если задано свойство ИспользоватьСертификат). +// * ДанныеСертификата - ДвоичныеДанные - двоичные данные сертификата в base64 (используется, если задано свойство ИспользоватьСертификат). +// * ПодписыватьДанные - Булево - признак использования подписи данных при отправке их в сервис приема оповещений. +// * КлючПодписи - Строка - секретное слово, для подписи отправляемых данных. Подпись выполняется с помощью алгоритма HMACSHA256. +// +Функция Настройки(УчетнаяСистема, Знач КлючиНастроек = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияОбъектовОбластейДанных.Настройки(УчетнаяСистема, КлючиНастроек); +``` +
+ +## НовыйРезультатыВыполненияКоманды +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон для помещения результатов выполнения команды +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// ТаблицаЗначений - шаблон выполнения команды для возврата результатов: +// * ИдентификаторОбъекта - Строка - идентификатор объекта. +// * Обработчик - Строка - идентификатор обработчика. +// +Функция НовыйРезультатыВыполненияКоманды() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияОбъектовОбластейДанных.НовыйРезультатыВыполненияКоманды() +``` +
+ +## ВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// Выполняет полученную от учетной системы команду. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных - учетная система. +// ИдентификаторПараметров - Строка - идентификатор файла параметров выполнения команды (длина 36). +// +Процедура ВыполнитьКоманду(УчетнаяСистема, ИдентификаторПараметров) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияОбъектовОбластейДанных.ВыполнитьКоманду(УчетнаяСистема, ИдентификаторПараметров) +``` +
+ +## ПодготовитьДанные +
+ +Описание, пример вызова + +```bsl + +// Формирует пакет данных для получения учетной системой. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных - учетная система +// по которой готовятся данные. +// +Процедура ПодготовитьДанные(УчетнаяСистема) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияОбъектовОбластейДанных.ПодготовитьДанные(УчетнаяСистема) +``` +
+ +## ОбработатьДанные +
+ +Описание, пример вызова + +```bsl + +// Обрабатывает полученный от учетной системы пакет данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// УчетнаяСистема - ОпределяемыйТип.УчетныеСистемыИнтеграцииОбластейДанных - учетная система +// по которой готовятся данные. +// ИдентификаторФайла - Строка - идентификатор файла для обработки (длина 36). +// +Процедура ОбработатьДанные(УчетнаяСистема, ИдентификаторФайла) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияОбъектовОбластейДанных.ОбработатьДанные(УчетнаяСистема, ИдентификаторФайла) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтеграцияОбъектовОбластейДанныхСловарь.md b/src/content/docs/bsp/ИнтеграцияОбъектовОбластейДанныхСловарь.md new file mode 100644 index 0000000..9732403 --- /dev/null +++ b/src/content/docs/bsp/ИнтеграцияОбъектовОбластейДанныхСловарь.md @@ -0,0 +1,123 @@ +--- +title: Интеграция объектов областей данных словарь +slug: bsp/интеграция-объектов-областей-данных-словарь +--- + + +## КодВозвратаОшибкаДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает код ошибки данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаОшибкаДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияОбъектовОбластейДанныхСловарь.КодВозвратаОшибкаДанных() +``` +
+ +## КодВозвратаВнутренняяОшибка +
+ +Описание, пример вызова + +```bsl + +// Возвращает код внутренней ошибки. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаВнутренняяОшибка() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияОбъектовОбластейДанныхСловарь.КодВозвратаВнутренняяОшибка() +``` +
+ +## КодВозвратаВыполненоСПредупреждениями +
+ +Описание, пример вызова + +```bsl + +// Возвращает код выполнения с предупреждениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаВыполненоСПредупреждениями() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияОбъектовОбластейДанныхСловарь.КодВозвратаВыполненоСПредупреждениями() +``` +
+ +## КодВозвратаВыполнено +
+ +Описание, пример вызова + +```bsl + +// Возвращает код успешного выполнения. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаВыполнено() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияОбъектовОбластейДанныхСловарь.КодВозвратаВыполнено() +``` +
+ +## КодВозвратаНеНайдено +
+ +Описание, пример вызова + +```bsl + +// Возвращает код отсутствия данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаНеНайдено() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияОбъектовОбластейДанныхСловарь.КодВозвратаНеНайдено() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтеграцияПодсистемБТС.md b/src/content/docs/bsp/ИнтеграцияПодсистемБТС.md new file mode 100644 index 0000000..7813b1a --- /dev/null +++ b/src/content/docs/bsp/ИнтеграцияПодсистемБТС.md @@ -0,0 +1,508 @@ +--- +title: Интеграция подсистем БТС +slug: bsp/интеграция-подсистем-бтс +--- + + +## ПриОпределенииПодписокНаСобытияБСП +
+ +Описание, пример вызова + +```bsl +// Обработка программных событий, возникающих в подсистемах БСП. +// Только для вызовов из библиотеки БСП в БТС. + +// Определяет события, на которые подписана эта библиотека. +// +// Параметры: +// Подписки - Структура - Ключами свойств структуры являются имена событий, на которые +// подписана эта библиотека. +// +Процедура ПриОпределенииПодписокНаСобытияБСП(Подписки) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриОпределенииПодписокНаСобытияБСП(Подписки) +``` +
+ +## ПередЗапускомПрограммы +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияПереопределяемый.ПередЗапускомПрограммы +Процедура ПередЗапускомПрограммы() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПередЗапускомПрограммы() +``` +
+ +## ПриДобавленииПодсистем +
+ +Описание, пример вызова + +```bsl + +// См. ПодсистемыКонфигурацииПереопределяемый.ПриДобавленииПодсистем +// +// Параметры: +// МодулиПодсистем - Массив из Строка - имена модулей. +Процедура ПриДобавленииПодсистем(МодулиПодсистем) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриДобавленииПодсистем(МодулиПодсистем) +``` +
+ +## ПриДобавленииОбработчиковУстановкиПараметровСеанса +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияПереопределяемый.ПриДобавленииОбработчиковУстановкиПараметровСеанса. +Процедура ПриДобавленииОбработчиковУстановкиПараметровСеанса(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриДобавленииОбработчиковУстановкиПараметровСеанса(Обработчики) +``` +
+ +## ПриДобавленииИсключенийПоискаСсылок +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияПереопределяемый.ПриДобавленииИсключенийПоискаСсылок +Процедура ПриДобавленииИсключенийПоискаСсылок(ИсключенияПоискаСсылок) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриДобавленииИсключенийПоискаСсылок(ИсключенияПоискаСсылок) +``` +
+ +## ПриОтправкеДанныхГлавному +
+ +Описание, пример вызова + +```bsl + +// См. ПриОтправкеДанныхГлавномув синтаксис-помощнике +// +// Параметры: +// ЭлементДанных - Произвольный - объект базы данных +// ОтправкаЭлемента - ОтправкаЭлементаДанных +// Получатель - ПланОбменаСсылка +Процедура ПриОтправкеДанныхГлавному(ЭлементДанных, ОтправкаЭлемента, Получатель) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриОтправкеДанныхГлавному(ЭлементДанных, ОтправкаЭлемента, Получатель) +``` +
+ +## ПриОтправкеДанныхПодчиненному +
+ +Описание, пример вызова + +```bsl + +// См. ПриОтправкеДанныхПодчиненномув синтаксис-помощнике +// +// Параметры: +// ЭлементДанных - Произвольный - объект базы данных +// ОтправкаЭлемента - ОтправкаЭлементаДанных +// СозданиеНачальногоОбраза - Булево +// Получатель - ПланОбменаСсылка +Процедура ПриОтправкеДанныхПодчиненному(ЭлементДанных, ОтправкаЭлемента, СозданиеНачальногоОбраза, Получатель) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриОтправкеДанныхПодчиненному(ЭлементДанных, ОтправкаЭлемента, СозданиеНачальногоОбраза, Получатель) +``` +
+ +## ПриПолученииДанныхОтГлавного +
+ +Описание, пример вызова + +```bsl + +// См. ПриПолученииДанныхОтГлавногов синтаксис-помощнике +// +// Параметры: +// ЭлементДанных - Произвольный - объект базы данных +// ПолучениеЭлемента - ПолучениеЭлементаДанных +// ОтправкаНазад - Булево +// Отправитель - ПланОбменаСсылка +Процедура ПриПолученииДанныхОтГлавного(ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад, Отправитель) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриПолученииДанныхОтГлавного(ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад, Отправитель) +``` +
+ +## ПриПолученииДанныхОтПодчиненного +
+ +Описание, пример вызова + +```bsl + +// См. ПриПолученииДанныхОтПодчиненного в синтаксис-помощнике +// +// Параметры: +// ЭлементДанных - Произвольный - объект базы данных +// ПолучениеЭлемента - ПолучениеЭлементаДанных +// ОтправкаНазад - Булево +// Отправитель - ПланОбменаСсылка +Процедура ПриПолученииДанныхОтПодчиненного(ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад, Отправитель) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриПолученииДанныхОтПодчиненного(ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад, Отправитель) +``` +
+ +## ПриВключенииРазделенияПоОбластямДанных +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВМоделиСервисаПереопределяемый.ПриВключенииРазделенияПоОбластямДанных +Процедура ПриВключенииРазделенияПоОбластямДанных() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриВключенииРазделенияПоОбластямДанных() +``` +
+ +## ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияПереопределяемый.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов +// Параметры: +// СтруктураПоддерживаемыхВерсий - Структура - в ключе указывается имя программного интерфейса, +// а в значениях - массив строк с поддерживаемыми версиями этого интерфейса. +Процедура ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(Знач СтруктураПоддерживаемыхВерсий) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(СтруктураПоддерживаемыхВерсий) +``` +
+ +## ПриДобавленииПараметровРаботыКлиентаПриЗапуске +
+ +Описание, пример вызова + +```bsl + +// См. СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиентаПриЗапуске +// Параметры: +// Параметры - Структура - имена и значения параметров работы клиента при запуске, которые необходимо задать. +Процедура ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) +``` +
+ +## ПриДобавленииПараметровРаботыКлиента +
+ +Описание, пример вызова + +```bsl + +// См. СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиента +// +// Параметры: +// Параметры - Структура - имена и значения параметров работы клиента при запуске, которые необходимо задать. +Процедура ПриДобавленииПараметровРаботыКлиента(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриДобавленииПараметровРаботыКлиента(Параметры) +``` +
+ +## ПриОпределенииОбъектовСРедактируемымиРеквизитами +
+ +Описание, пример вызова + +```bsl + +// См. ГрупповоеИзменениеОбъектовПереопределяемый.ПриОпределенииОбъектовСРедактируемымиРеквизитами +// +// Параметры: +// Объекты - Соответствие из КлючИЗначение +Процедура ПриОпределенииОбъектовСРедактируемымиРеквизитами(Объекты) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриОпределенииОбъектовСРедактируемымиРеквизитами(Объекты) +``` +
+ +## ПриУстановкеРежимаПодключенияДополнительногоОтчетаИлиОбработкиВОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Устарела. +Процедура ПриУстановкеРежимаПодключенияДополнительногоОтчетаИлиОбработкиВОбластиДанных(ПоставляемаяОбработка, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриУстановкеРежимаПодключенияДополнительногоОтчетаИлиОбработкиВОбластиДанных(ПоставляемаяОбработка, ); +``` +
+ +## ПриОпределенииСправочниковДляЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗагрузкаДанныхИзФайлаПереопределяемый.ПриОпределенииСправочниковДляЗагрузкиДанных +// +// Параметры: +// ЗагружаемыеСправочники - ТаблицаЗначений +Процедура ПриОпределенииСправочниковДляЗагрузкиДанных(ЗагружаемыеСправочники) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриОпределенииСправочниковДляЗагрузкиДанных(ЗагружаемыеСправочники) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузкиOData +
+ +Описание, пример вызова + +```bsl + +// См. ИнтеграцияПодсистемБСП.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузкиOData +// +// Параметры: +// Типы - Массив из ОбъектМетаданных - объекты метаданных, исключаемые из выгрузки и загрузки. +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузкиOData(Типы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузкиOData(Типы) +``` +
+ +## ПриЗавершенииОбработкиПользователяИБ +
+ +Описание, пример вызова + +```bsl + +// См. ПользователиСлужебныйВМоделиСервиса.ПриЗавершенииОбработкиПользователяИБ +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи +Процедура ПриЗавершенииОбработкиПользователяИБ(Пользователь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриЗавершенииОбработкиПользователяИБ(Пользователь) +``` +
+ +## ПриПроверкеВозможностиНастройкиПрофилейБезопасности +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВБезопасномРежимеПереопределяемый.ПриПроверкеВозможностиНастройкиПрофилейБезопасности +Процедура ПриПроверкеВозможностиНастройкиПрофилейБезопасности(Отказ) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриПроверкеВозможностиНастройкиПрофилейБезопасности(Отказ) +``` +
+ +## ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВБезопасномРежимеПереопределяемый.ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов +Процедура ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов(Знач ПрограммныйМодуль, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов(ПрограммныйМодуль, ); +``` +
+ +## ПриЗапросеСозданияПрофиляБезопасности +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВБезопасномРежимеПереопределяемый.ПриЗапросеСозданияПрофиляБезопасности +Процедура ПриЗапросеСозданияПрофиляБезопасности(Знач ПрограммныйМодуль, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриЗапросеСозданияПрофиляБезопасности(ПрограммныйМодуль, ); +``` +
+ +## ПриЗапросеУдаленияПрофиляБезопасности +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВБезопасномРежимеПереопределяемый.ПриЗапросеУдаленияПрофиляБезопасности +Процедура ПриЗапросеУдаленияПрофиляБезопасности(Знач ПрограммныйМодуль, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриЗапросеУдаленияПрофиляБезопасности(ПрограммныйМодуль, ); +``` +
+ +## ПриПодключенииВнешнегоМодуля +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВБезопасномРежимеПереопределяемый.ПриПодключенииВнешнегоМодуля +Процедура ПриПодключенииВнешнегоМодуля(Знач ВнешнийМодуль, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриПодключенииВнешнегоМодуля(ВнешнийМодуль, ); +``` +
+ +## ПриОпределенииНастроекРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// См. РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроекРегламентныхЗаданий +Процедура ПриОпределенииНастроекРегламентныхЗаданий(Настройки) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриОпределенииНастроекРегламентныхЗаданий(Настройки) +``` +
+ +## ПриЗаполненииПоставляемыхПрофилейГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступомПереопределяемый.ПриЗаполненииПоставляемыхПрофилейГруппДоступа +Процедура ПриЗаполненииПоставляемыхПрофилейГруппДоступа(ОписанияПрофилей, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриЗаполненииПоставляемыхПрофилейГруппДоступа(ОписанияПрофилей, ПараметрыОбновления) +``` +
+ +## ПриПолученииПриоритетаОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ИнтеграцияПодсистемБСП.ПриПолученииПриоритетаОбновления. +Процедура ПриПолученииПриоритетаОбновления(Приоритет) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТС.ПриПолученииПриоритетаОбновления(Приоритет) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтеграцияПодсистемБТСКлиент.md b/src/content/docs/bsp/ИнтеграцияПодсистемБТСКлиент.md new file mode 100644 index 0000000..b872a1b --- /dev/null +++ b/src/content/docs/bsp/ИнтеграцияПодсистемБТСКлиент.md @@ -0,0 +1,110 @@ +--- +title: Интеграция подсистем БТС клиент +slug: bsp/интеграция-подсистем-бтс-клиент +--- + + +## ПриОпределенииПодписокНаСобытияБСП +
+ +Описание, пример вызова + +```bsl +// Обработка программных событий, возникающих в подсистемах БСП. +// Только для вызовов из библиотеки БСП в БТС. + +// Определяет события, на которые подписана эта библиотека. +// +// Параметры: +// Подписки - Структура - Ключами свойств структуры являются имена событий, на которые +// подписана эта библиотека. +// +Процедура ПриОпределенииПодписокНаСобытияБСП(Подписки) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТСКлиент.ПриОпределенииПодписокНаСобытияБСП(Подписки) +``` +
+ +## ПередНачаломРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// См. процедуру ОбщегоНазначенияКлиентПереопределяемый.ПередНачаломРаботыСистемы +// Параметры: +// Параметры - см. ОбщегоНазначенияКлиентПереопределяемый.ПередНачаломРаботыСистемы.Параметры +Процедура ПередНачаломРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТСКлиент.ПередНачаломРаботыСистемы(Параметры) +``` +
+ +## ПриНачалеРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// См. процедуру ОбщегоНазначенияКлиентПереопределяемый.ПриНачалеРаботыСистемы. +// Параметры: +// Параметры - Структура: +// * Модули - Массив - ссылки на модули. +Процедура ПриНачалеРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТСКлиент.ПриНачалеРаботыСистемы(Параметры) +``` +
+ +## ПриЗавершенииСеансов +
+ +Описание, пример вызова + +```bsl + +// См. процедуру УдаленноеАдминистрированиеБТСКлиент.ПриЗавершенииСеансов. +Процедура ПриЗавершенииСеансов(ФормаВладелец, Знач НомераСеансов, СтандартнаяОбработка, Знач ОповещениеПослеЗавершенияСеанса = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТСКлиент.ПриЗавершенииСеансов(ФормаВладелец, НомераСеансов, СтандартнаяОбработка, ОповещениеПослеЗавершенияСеанса); +``` +
+ +## ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов +
+ +Описание, пример вызова + +```bsl + +// См. процедуру РаботаВБезопасномРежимеКлиентПереопределяемый.ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов. +Процедура ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов(Знач ИдентификаторыЗапросов, ФормаВладелец, ОповещениеОЗакрытии, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияПодсистемБТСКлиент.ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов(ИдентификаторыЗапросов, ФормаВладелец, ОповещениеОЗакрытии, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтеграцияССистемойВзаимодействия.md b/src/content/docs/bsp/ИнтеграцияССистемойВзаимодействия.md new file mode 100644 index 0000000..1f9f116 --- /dev/null +++ b/src/content/docs/bsp/ИнтеграцияССистемойВзаимодействия.md @@ -0,0 +1,260 @@ +--- +title: Интеграция с системой взаимодействия +slug: bsp/интеграция-с-системой-взаимодействия +--- + + +## ДанныеДляУправленияСистемойВзаимодействия +
+ +Описание, пример вызова + +```bsl + +// Данные для управления системой взаимодействия. +// +// Возвращаемое значение: +// Строка +Функция ДанныеДляУправленияСистемойВзаимодействия() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.ДанныеДляУправленияСистемойВзаимодействия() +``` +
+ +## ДоступноПодключениеКСистемеВзаимодействияВМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Доступно подключение к системе взаимодействия в модели сервиса. +// +// Возвращаемое значение: +// Булево - Ложь +Функция ДоступноПодключениеКСистемеВзаимодействияВМоделиСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.ДоступноПодключениеКСистемеВзаимодействияВМоделиСервиса() +``` +
+ +## ЗапросВСервис +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат запроса к HTTP-сервису для управления системой взаимодействия +// +// Параметры: +// АдресПубликацииСервисаУправления - Строка +// КодУправления - Строка +// ИмяМетода - Строка +// ПараметрыЗапроса - Структура +// +// Возвращаемое значение: +// Структура - результат запроса в сервис с полями: +// * Успешно - Булево +// * ТекстСообщения - Строка +// * ДанныеРезультата - Структура +// +Функция ЗапросВСервис(АдресПубликацииСервисаУправления, КодУправления, ИмяМетода, ПараметрыЗапроса = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.ЗапросВСервис(АдресПубликацииСервисаУправления, КодУправления, ИмяМетода, ПараметрыЗапроса); +``` +
+ +## ЗарегистрироватьБазуЧерезСервис +
+ +Описание, пример вызова + +```bsl + +// Зарегистрировать базу через сервис +// +// Параметры: +// АдресПубликацииСервисаУправления - Строка +// КодУправления - Строка +// ИмяБазы - Строка +// +// Возвращаемое значение: см. ЗапросВСервис +Функция ЗарегистрироватьБазуЧерезСервис(АдресПубликацииСервисаУправления, КодУправления, ИмяБазы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.ЗарегистрироватьБазуЧерезСервис(АдресПубликацииСервисаУправления, КодУправления, ИмяБазы) +``` +
+ +## ИспользуетсяИнтеграцияССистемойВзаимодействияВМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Используется интеграция с системой взаимодействия в модели сервиса. +// +// Возвращаемое значение: +// Булево +Функция ИспользуетсяИнтеграцияССистемойВзаимодействияВМоделиСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.ИспользуетсяИнтеграцияССистемойВзаимодействияВМоделиСервиса() +``` +
+ +## ОбъектСистемыВзаимодействия +
+ +Описание, пример вызова + +```bsl + +// Объект системы взаимодействия. +// +// Возвращаемое значение: +// МенеджерСистемыВзаимодействия +Функция ОбъектСистемыВзаимодействия() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.ОбъектСистемыВзаимодействия() +``` +
+ +## ПолучитьДанныеОПользователяхСервиса +
+ +Описание, пример вызова + +```bsl + +// Получить данные о пользователях сервиса. +// +// Параметры: +// АдресПубликацииСервисаУправления - Строка +// КодУправления - Строка +// +// Возвращаемое значение: см. ЗапросВСервис +// +Функция ПолучитьДанныеОПользователяхСервиса(АдресПубликацииСервисаУправления, КодУправления) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.ПолучитьДанныеОПользователяхСервиса(АдресПубликацииСервисаУправления, КодУправления) +``` +
+ +## РасшифроватьДанныеДляУправления +
+ +Описание, пример вызова + +```bsl + +// Возвращает расшифрованные данные, предназначенные для управления системой взаимодействия через HTTP-сервис. +// +// Параметры: +// ДанныеДляУправления - Строка - зашифрованные данные +// +// Возвращаемое значение: +// Структура - результат расшифровки с полями: +// * ТекстСообщения - Строка - сообщение, сформированное при расшифровке +// * Расшифровано - Булево - признак успешной расшифровки +// * Данные - Структура - расшифрованные данные: +// ** АдресПубликацииСервисаУправления - Строка +// ** КодУправления - Строка +// +Функция РасшифроватьДанныеДляУправления(ДанныеДляУправления) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.РасшифроватьДанныеДляУправления(ДанныеДляУправления) +``` +
+ +## ТипКоллекцияИдентификаторовПриложений +
+ +Описание, пример вызова + +```bsl + +// Тип коллекция идентификаторов приложений. +// +// Возвращаемое значение: +// Тип - Тип +Функция ТипКоллекцияИдентификаторовПриложений() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.ТипКоллекцияИдентификаторовПриложений() +``` +
+ +## ТипПараметрыРегистрацииИБ +
+ +Описание, пример вызова + +```bsl + +// Тип параметры регистрации ИБ. +// +// Возвращаемое значение: +// Тип - Тип +Функция ТипПараметрыРегистрацииИБ() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.ТипПараметрыРегистрацииИБ() +``` +
+ +## ТипСовместноеИспользованиеПриложений +
+ +Описание, пример вызова + +```bsl + +// Тип совместное использование приложений. +// +// Возвращаемое значение: +// Тип - Тип +Функция ТипСовместноеИспользованиеПриложений() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияССистемойВзаимодействия.ТипСовместноеИспользованиеПриложений() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтернетПоддержкаПользователей.md b/src/content/docs/bsp/ИнтернетПоддержкаПользователей.md new file mode 100644 index 0000000..241f2d3 --- /dev/null +++ b/src/content/docs/bsp/ИнтернетПоддержкаПользователей.md @@ -0,0 +1,290 @@ +--- +title: Интернет поддержка пользователей +slug: bsp/интернет-поддержка-пользователей +--- + + +## ИмяПрограммы +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя, по которому программа идентифицируется в +// сервисах Интернет-поддержки. +// +// Возвращаемое значение: +// Строка - имя программы. <Пустая строка>, если имя программы не заполнено. +// +Функция ИмяПрограммы() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователей.ИмяПрограммы() +``` +
+ +## НастройкиСоединенияССерверами +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки соединения с серверами Интернет-поддержки. +// +// Возвращаемое значение: +// Структура - настройки соединения. Поля структуры: +// * УстанавливатьПодключениеНаСервере - Булево - Истина, если подключение +// устанавливается на сервере 1С:Предприятие; +// * ТаймаутПодключения - Число - таймаут подключения к серверам в секундах; +// * ДоменРасположенияСерверовИПП - Число - если 0, устанавливать подключение +// к серверам ИПП в доменной зоне 1c.ru, если 1 - в доменной зоне 1c.eu. +// +Функция НастройкиСоединенияССерверами() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователей.НастройкиСоединенияССерверами() +``` +
+ +## ДанныеАутентификацииПользователяИнтернетПоддержки +
+ +Описание, пример вызова + +```bsl + +// Возвращает логин и пароль пользователя Интернет-поддержки, сохраненные в информационной базе. +// Перед вызовом вызывающий код должен устанавливать привилегированный режим. +// +// Возвращаемое значение: +// Структура - Структура - логин и пароль пользователя Интернет-поддержки: +// * Логин - Строка - логин пользователя Интернет-поддержки; +// * Пароль - Строка - пароль пользователя Интернет-поддержки. +// Неопределено - при отсутствии сохраненных данных аутентификации. +// +Функция ДанныеАутентификацииПользователяИнтернетПоддержки() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователей.ДанныеАутентификацииПользователяИнтернетПоддержки() +``` +
+ +## ТикетАутентификацииНаПорталеПоддержки +
+ +Описание, пример вызова + +```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 +Результат = ИнтернетПоддержкаПользователей.ТикетАутентификацииНаПорталеПоддержки(ВладелецТикета) +``` +
+ +## ЗаполненыДанныеАутентификацииПользователяИнтернетПоддержки +
+ +Описание, пример вызова + +```bsl + +// Проверяет заполнение данных аутентификации пользователя +// Интернет-поддержки. +// +// Возвращаемое значение: +// Булево - признак заполнения данных аутентификации. +// Истина - данные аутентификации заполнены, +// Ложь - в противном случае. +// +Функция ЗаполненыДанныеАутентификацииПользователяИнтернетПоддержки() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователей.ЗаполненыДанныеАутентификацииПользователяИнтернетПоддержки() +``` +
+ +## ПроверитьЛогинИПароль +
+ +Описание, пример вызова + +```bsl + +// Проверяет данные аутентификации пользователя +// Интернет-поддержки. +// +// Параметры: +// Логин - Строка - логин пользователя Интернет-поддержки; +// Пароль - Строка - пароль пользователя Интернет-поддержки. +// +// Возвращаемое значение: +// Структура - результат проверки данных аутентификации: +// *Результат - Булево - результат проверки, если Истина, логин и пароль ведены верно, +// *КодОшибки - Строка - идентификатор ошибки в случае если логин и пароль ведены верно +// или в процессе проверки возникли ошибки; +// *СообщениеОбОшибке - Строка - описание ошибки проверки данных аутентификации. +// +Функция ПроверитьЛогинИПароль(Логин, Пароль) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователей.ПроверитьЛогинИПароль(Логин, Пароль) +``` +
+ +## СохранитьДанныеАутентификации +
+ +Описание, пример вызова + +```bsl + +// Сохраняет логин и пароль пользователя в подсистеме Интернет-поддержки +// в безопасном хранилище. В вызывающем коде перед записью данных необходимо +// выполнить: +// - Проверку доступности подключения Интернет-поддержки, вызвав +// метод ИнтернетПоддержкаПользователей.ДоступноПодключениеИнтернетПоддержки; +// - Вызвать метод ИнтернетПоддержкаПользователейКлиентСервер.ПроверитьДанныеАутентификации +// или ИнтернетПоддержкаПользователей.ПроверитьЛогинИПароль для проверки наличия +// не корректных символов в данных аутентификации; +// - Установить привилегированный режим. +// +// В случае реализации собственной формы подключения Интернет-поддержки, необходимо +// после сохранения данных аутентификации, удалить значения введенные пользователем +// для того, чтобы минимизировать время хранения секретных данных на клиенте. +// +// Параметры: +// ДанныеАутентификации - Структура, Неопределено - структура, содержащая логин +// и пароль пользователя и пароль пользователя Интернет-поддержки. +// Если передано значение Неопределено, данные аутентификации удаляются. +// * Логин - Строка - логин пользователя Интернет-поддержки; +// * Пароль - Строка - пароль пользователя Интернет-поддержки. +// +Процедура СохранитьДанныеАутентификации(ДанныеАутентификации) Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователей.СохранитьДанныеАутентификации(ДанныеАутентификации) +``` +
+ +## ДоступноПодключениеИнтернетПоддержки +
+ +Описание, пример вызова + +```bsl + +// Определяет, доступно ли текущему пользователю выполнение интерактивного +// подключения Интернет-поддержки в соответствии с текущим режимом работы +// и правами пользователя. +// +// Возвращаемое значение: +// Булево - Истина - интерактивное подключение доступно, +// Ложь - в противном случае. +// +Функция ДоступноПодключениеИнтернетПоддержки() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователей.ДоступноПодключениеИнтернетПоддержки() +``` +
+ +## URLДляПереходаНаСтраницуИнтегрированногоСайта +
+ +Описание, пример вызова + +```bsl + +// Возвращает URL для перехода на страницу сайта, система аутентификации +// которого интегрирована с Порталом 1С:ИТС. +// В зависимости от текущего режима работы информационной базы и наличия у +// текущего пользователя информационной базы соответствующих прав +// переданный URL страницы сайта трансформируется таким образом, что открытие +// страницы происходит с учетными данными пользователя Портала 1С:ИТС. +// При отсутствии прав, несоответствии режима работы или возникновении ошибок +// переданный URL возвращается без изменений. +// +// Важно. Полученный URL необходимо использовать сразу после получения, т.к. +// URL действителен ограниченное время (исчисляется секундами). +// +// Параметры: +// URLСтраницыСайта - Строка - URL страницы сайта; +// +// Возвращаемое значение: +// Строка - URL для перехода на страницу сайта. +// +Функция URLДляПереходаНаСтраницуИнтегрированногоСайта(URLСтраницыСайта) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователей.URLДляПереходаНаСтраницуИнтегрированногоСайта(URLСтраницыСайта) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтернетПоддержкаПользователейВМоделиСервиса.md b/src/content/docs/bsp/ИнтернетПоддержкаПользователейВМоделиСервиса.md new file mode 100644 index 0000000..7520f07 --- /dev/null +++ b/src/content/docs/bsp/ИнтернетПоддержкаПользователейВМоделиСервиса.md @@ -0,0 +1,60 @@ +--- +title: Интернет поддержка пользователей в модели сервиса +slug: bsp/интернет-поддержка-пользователей-в-модели-сервиса +--- + + +## ТикетАутентификацииНаПорталеПоддержкиВНеразделенномСеансе +
+ +Описание, пример вызова + +```bsl + +// Возвращает тикет аутентификации пользователя на портале поддержки +// при работе в модели сервиса в неразделенном сеансе. +// Возвращенный тикет может быть проверен вызовом операции check +// сервиса https://login.1c.ru или https://login.1c.eu +// +// Подробнее см. https://login.1c.ru/rest/public/swagger-ui.html. +// +// Параметры: +// ВладелецТикета - Строка - произвольное имя сервиса, для которого +// выполняется аутентификация пользователя. Это же имя должно +// использоваться при вызове операции checkTicket(); +// Не допускается незаполненное значение параметра; +// ОбластьДанных - Число - номер области данных (абонент), для которой +// выполняется получение тикета. +// +// Возвращаемое значение: +// Структура - результат получения тикета. Поля структуры: +// * Тикет - Строка - полученный тикет аутентификации. Если при получении +// тикета произошла ошибка, значение поля - пустая строка. +// * КодОшибки - Строка - строковый код возникшей ошибки, который +// может быть обработан вызывающим функционалом: +// - <Пустая строка> - получение тикета выполнено успешно; +// - "ОшибкаПодключения" - ошибка при подключении к сервису; +// - "ОшибкаСервиса" - внутренняя ошибка сервиса; +// - "НеизвестнаяОшибка" - при получении тикета возникла +// неизвестная (необрабатываемая) ошибка; +// * СообщениеОбОшибке - Строка - краткое описание ошибки, которое +// может быть отображено пользователю; +// * ИнформацияОбОшибке - Строка - подробное описание ошибки, которое +// может быть записано в журнал регистрации. +// +Функция ТикетАутентификацииНаПорталеПоддержкиВНеразделенномСеансе(ВладелецТикета, ОбластьДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователейВМоделиСервиса.ТикетАутентификацииНаПорталеПоддержкиВНеразделенномСеансе(ВладелецТикета, ОбластьДанных) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтернетПоддержкаПользователейВызовСервера.md b/src/content/docs/bsp/ИнтернетПоддержкаПользователейВызовСервера.md new file mode 100644 index 0000000..fe47231 --- /dev/null +++ b/src/content/docs/bsp/ИнтернетПоддержкаПользователейВызовСервера.md @@ -0,0 +1,38 @@ +--- +title: Интернет поддержка пользователей вызов сервера +slug: bsp/интернет-поддержка-пользователей-вызов-сервера +--- + + +## ДоступноПодключениеИнтернетПоддержки +
+ +Описание, пример вызова + +```bsl + +// Определяет, доступно ли текущему пользователю выполнение подключения +// Интернет-поддержки: авторизация/регистрация пользователя, регистрация +// программного продукта в соответствии с текущим режимом работы +// и правами пользователя. +// +// Возвращаемое значение: +// Булево - Истина - подключение Интернет-поддержки доступно, +// Ложь - в противном случае. +// +Функция ДоступноПодключениеИнтернетПоддержки() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователейВызовСервера.ДоступноПодключениеИнтернетПоддержки() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиент.md b/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиент.md new file mode 100644 index 0000000..b36f55b --- /dev/null +++ b/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиент.md @@ -0,0 +1,199 @@ +--- +title: Интернет поддержка пользователей клиент +slug: bsp/интернет-поддержка-пользователей-клиент +--- + + +## НастройкиСоединенияССерверами +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки соединения с серверами Интернет-поддержки. +// +// Возвращаемое значение: +// Структура - настройки соединения. Поля структуры: +// * УстанавливатьПодключениеНаСервере - Булево - Истина, если подключение +// устанавливается на сервере 1С:Предприятие; +// * ТаймаутПодключения - Число - таймаут подключения к серверам в секундах; +// * ДоменРасположенияСерверовИПП - Число - если 0, устанавливать подключение +// к серверам ИПП в доменной зоне 1c.ru, если 1 - в доменной зоне 1c.eu. +// +Функция НастройкиСоединенияССерверами() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователейКлиент.НастройкиСоединенияССерверами() +``` +
+ +## ПодключитьИнтернетПоддержкуПользователей +
+ +Описание, пример вызова + +```bsl + +// Выполняет подключение к сервису Интернет-поддержки: ввод данных +// аутентификации (логина и пароля) для подключения к сервисам +// Интернет-поддержки. +// При успешном завершении возвращается введенный логин через +// объект ОписаниеОповещения. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - обработчик оповещения о +// завершении. В обработчик оповещения возвращается значение: +// Неопределено - при нажатии пользователем кнопки Отмена; +// Структура, при успешном вводе логина и пароля. +// Поля структуры: +// * Логин - Строка - введенный логин; +// ВладелецФормы - ФормаКлиентскогоПриложения - владелец формы подключения +// Интернет-поддержки. Т.к. форма подключения Интернет-поддержки открывается +// в режиме "Блокировать окно владельца", рекомендуется заполнять +// значение этого параметра; +// +Процедура ПодключитьИнтернетПоддержкуПользователей( Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейКлиент.ПодключитьИнтернетПоддержкуПользователей(); +``` +
+ +## ДоступноПодключениеИнтернетПоддержки +
+ +Описание, пример вызова + +```bsl + +// Определяет, доступно ли текущему пользователю выполнение интерактивного +// подключения Интернет-поддержки в соответствии с текущим режимом работы +// и правами пользователя. +// +// Возвращаемое значение: +// Булево - Истина - интерактивное подключение доступно, +// Ложь - в противном случае. +// +Функция ДоступноПодключениеИнтернетПоддержки() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователейКлиент.ДоступноПодключениеИнтернетПоддержки() +``` +
+ +## ОткрытьСтраницуИнтегрированногоСайта +
+ +Описание, пример вызова + +```bsl + +// Открывает страницу сайта, система аутентификации которого интегрирована с +// Порталом 1С:ИТС. +// В зависимости от текущего режима работы информационной базы и наличия у +// текущего пользователя информационной базы соответствующих прав +// страница сайта может быть открыта с учетными данными пользователя Портала 1С:ИТС, +// для которого подключена Интернет-поддержка. +// +// Параметры: +// URLСтраницыСайта - Строка - URL страницы сайта; +// ЗаголовокОкна - Строка - заголовок окна для методов: +// - ИнтернетПоддержкаПользователейКлиентПереопределяемый.ОткрытьИнтернетСтраницу() +// - ИнтеграцияПодсистемБИПКлиент.ОткрытьИнтернетСтраницу(), +// если используется. +// +Процедура ОткрытьСтраницуИнтегрированногоСайта(URLСтраницыСайта, ЗаголовокОкна = "") Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейКлиент.ОткрытьСтраницуИнтегрированногоСайта(URLСтраницыСайта, ЗаголовокОкна); +``` +
+ +## ОткрытьГлавнуюСтраницуПортала +
+ +Описание, пример вызова + +```bsl + +// Открывает главную страницу Портала. +// +Процедура ОткрытьГлавнуюСтраницуПортала() Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейКлиент.ОткрытьГлавнуюСтраницуПортала() +``` +
+ +## ОткрытьСтраницуРегистрацииНовогоПользователя +
+ +Описание, пример вызова + +```bsl + +// Открывает страницу Портала для регистрации нового пользователя. +// +Процедура ОткрытьСтраницуРегистрацииНовогоПользователя() Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейКлиент.ОткрытьСтраницуРегистрацииНовогоПользователя() +``` +
+ +## ОткрытьСтраницуВосстановленияПароля +
+ +Описание, пример вызова + +```bsl + +// Открывает страницу Портала для восстановления пароля. +// +Процедура ОткрытьСтраницуВосстановленияПароля() Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейКлиент.ОткрытьСтраницуВосстановленияПароля() +``` +
+ +## ПриНачалеРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// См. процедуру ОбщегоНазначенияКлиентПереопределяемый.ПриНачалеРаботыСистемы. +// +Процедура ПриНачалеРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейКлиент.ПриНачалеРаботыСистемы(Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиентПереопределяемый.md b/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиентПереопределяемый.md new file mode 100644 index 0000000..57b6dae --- /dev/null +++ b/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиентПереопределяемый.md @@ -0,0 +1,46 @@ +--- +title: Интернет поддержка пользователей клиент переопределяемый +slug: bsp/интернет-поддержка-пользователей-клиент-переопределяемый +--- + + +## ОткрытьИнтернетСтраницу +
+ +Описание, пример вызова + +```bsl + +// Переопределяет открытие Интернет-страницы в конфигурации, если для открытия +// Интернет-страниц в конфигурации предусмотрены собственные механизмы. +// Если в конфигурации не используются собственные механизмы для открытия +// Интернет-страниц, тогда необходимо оставить тело процедуры пустым, в +// противном случае параметру СтандартнаяОбработка необходимо присвоить +// значение Ложь. +// +// Параметры: +// АдресСтраницы - Строка - URL-адрес открываемой Интернет-страницы; +// ЗаголовокОкна - Строка - заголовок окна, в котором отображается +// Интернет-страница, если для открытия Интернет-страницы +// используется внутренняя форма конфигурации; +// СтандартнаяОбработка - Булево - в параметре возвращается признак +// необходимости открытия Интернет-страницы стандартным способом. +// Значение по умолчанию - Истина. +// +//@skip-warning +Процедура ОткрытьИнтернетСтраницу(АдресСтраницы, ЗаголовокОкна, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейКлиентПереопределяемый.ОткрытьИнтернетСтраницу(АдресСтраницы, ЗаголовокОкна, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиентСервер.md b/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиентСервер.md new file mode 100644 index 0000000..0884d9c --- /dev/null +++ b/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиентСервер.md @@ -0,0 +1,91 @@ +--- +title: Интернет поддержка пользователей клиент сервер +slug: bsp/интернет-поддержка-пользователей-клиент-сервер +--- + + +## ВерсияБиблиотеки +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер версии библиотеки. +// +// Возвращаемое значение: +// Строка - номер версии библиотеки. +// +Функция ВерсияБиблиотеки() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователейКлиентСервер.ВерсияБиблиотеки() +``` +
+ +## ИдентификаторПоставщикаУслугПортал1СИТС +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификатор поставщика услуг "Портал 1С:ИТС" +// для интеграции с подсистемой "Управление тарифами в модели +// сервиса" библиотеки "Технология сервиса". +// +// Возвращаемое значение: +// Строка - идентификатор поставщика услуг. +// +Функция ИдентификаторПоставщикаУслугПортал1СИТС() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователейКлиентСервер.ИдентификаторПоставщикаУслугПортал1СИТС() +``` +
+ +## ПроверитьДанныеАутентификации +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку данных аутентификации Интернет-поддержки пользователей. +// Необходимо вызвать перед выполнением проверки логина и пароля в сервисе +// и сохранением данных в информационной базе. +// +// Параметры: +// ДанныеАутентификации - Структура - структура, содержащая логин и пароль пользователя +// Интернет-поддержки: +// * Логин - Строка - логин пользователя Интернет-поддержки; +// * Пароль - Строка - пароль пользователя Интернет-поддержки. +// +// Возвращаемое значение: +// Структура - результаты проверки данных аутентификации: +// *Отказ - Булево - если Истина, при проверке обнаружены ошибки; +// *СообщениеОбОшибке - Строка - сообщение для пользователя программы; +// *Поле - Строка - идентификатор поля, в котором возникла ошибка: +// - "Логин" - ошибка возникла при проверке данных поля Логин; +// - "Пароль" - ошибка возникла при проверке данных поля Пароль; +// +Функция ПроверитьДанныеАутентификации(ДанныеАутентификации) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтернетПоддержкаПользователейКлиентСервер.ПроверитьДанныеАутентификации(ДанныеАутентификации) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиентСерверПереопределяемый.md b/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиентСерверПереопределяемый.md new file mode 100644 index 0000000..d90fa22 --- /dev/null +++ b/src/content/docs/bsp/ИнтернетПоддержкаПользователейКлиентСерверПереопределяемый.md @@ -0,0 +1,37 @@ +--- +title: Интернет поддержка пользователей клиент сервер переопределяемый +slug: bsp/интернет-поддержка-пользователей-клиент-сервер-переопределяемый +--- + + +## ПриОпределенииНастроекИнтернетПоддержкиПользователей +
+ +Описание, пример вызова + +```bsl + +// Определяет настройки Интернет-поддержки пользователей. +// +// Параметры: +// Настройки - Структура - настройки подсистемы на клиенте: +// *ОтключитьАвторизацию - Булево - отключает авторизацию пользователей +// при переходе на страницы интегрированных ресурсов. +// +//@skip-warning +Процедура ПриОпределенииНастроекИнтернетПоддержкиПользователей(Настройки) Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейКлиентСерверПереопределяемый.ПриОпределенииНастроекИнтернетПоддержкиПользователей(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтернетПоддержкаПользователейПереопределяемый.md b/src/content/docs/bsp/ИнтернетПоддержкаПользователейПереопределяемый.md new file mode 100644 index 0000000..1eaf2d7 --- /dev/null +++ b/src/content/docs/bsp/ИнтернетПоддержкаПользователейПереопределяемый.md @@ -0,0 +1,106 @@ +--- +title: Интернет поддержка пользователей переопределяемый +slug: bsp/интернет-поддержка-пользователей-переопределяемый +--- + + +## ПриОпределенииКодаЯзыкаИнтерфейсаКонфигурации +
+ +Описание, пример вызова + +```bsl + +// В процедуре заполняется код языка интерфейса конфигурации (Метаданные.Языки), +// который передается сервисам Интернет-поддержки. +// Код языка заполняется в формате ISO-639-1. +// Если коды языков интерфейса конфигурации определены в формате ISO-639-1, +// тогда тело метода заполнять не нужно. +// +// Параметры: +// КодЯзыка - Строка - в параметре передается код языка, указанный в +// Метаданные.Языки; +// КодЯзыкаВФорматеISO639_1 - Строка - в параметре возвращается +// код языка в формате ISO-639-1. +// +// Пример: +// Если КодЯзыка = "rus" Тогда +// КодЯзыкаВФорматеISO639_1 = "ru"; +// ИначеЕсли КодЯзыка = "english" Тогда +// КодЯзыкаВФорматеISO639_1 = "en"; +// КонецЕсли; +// +//@skip-warning +Процедура ПриОпределенииКодаЯзыкаИнтерфейсаКонфигурации(КодЯзыка, КодЯзыкаВФорматеISO639_1) Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейПереопределяемый.ПриОпределенииКодаЯзыкаИнтерфейсаКонфигурации(КодЯзыка, КодЯзыкаВФорматеISO639_1) +``` +
+ +## ПриОпределенииНомераВерсииПрограммы +
+ +Описание, пример вызова + +```bsl + +// В процедуре необходимо указать номер версии программы, который будет +// передаваться в сервисы Интернет-поддержки пользователей. Если номер версии +// не указан, информация будет получена из свойств метаданных конфигурации. +// +// Параметры: +// ВерсияПрограммы - Строка - номер версии программы. +// +// Пример: +// КомпонентыВерсии = СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивПодстрок(ВерсияПрограммы, "/"); +// Если ВерсияПрограммы.Количество() > 0 Тогда +// ВерсияПрограммы = КомпонентыВерсии[0]; +// КонецЕсли; +// +//@skip-warning +Процедура ПриОпределенииНомераВерсииПрограммы(ВерсияПрограммы) Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейПереопределяемый.ПриОпределенииНомераВерсииПрограммы(ВерсияПрограммы) +``` +
+ +## ПриИзмененииДанныхАутентификацииИнтернетПоддержки +
+ +Описание, пример вызова + +```bsl + +// Реализует обработку события сохранения в информационной базе данных +// аутентификации пользователя Интернет-поддержки - логина и пароля +// для подключения к сервисам Интернет-поддержки. +// +// Параметры: +// ДанныеПользователя - Структура, Неопределено - структура с полями. Если в метод передано значение +// Неопределено, данные аутентификации были удалены. +// * Логин - Строка - логин пользователя; +// * Пароль - Строка - пароль пользователя; +// +//@skip-warning +Процедура ПриИзмененииДанныхАутентификацииИнтернетПоддержки(ДанныеПользователя) Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейПереопределяемый.ПриИзмененииДанныхАутентификацииИнтернетПоддержки(ДанныеПользователя) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтерфейсODataПереопределяемый.md b/src/content/docs/bsp/ИнтерфейсODataПереопределяемый.md new file mode 100644 index 0000000..15cfc6f --- /dev/null +++ b/src/content/docs/bsp/ИнтерфейсODataПереопределяемый.md @@ -0,0 +1,35 @@ +--- +title: Интерфейс OData переопределяемый +slug: bsp/интерфейс-odata-переопределяемый +--- + + +## ПриЗаполненииЗависимыхТаблицДляВыгрузкиЗагрузкиOData +
+ +Описание, пример вызова + +```bsl + +// Список таблиц, которые не входят в выгрузку и загрузку данных OData, но права на которые +// необходимы для записи таблиц, включенных в интерфейс OData. +// +// Параметры: +// Таблицы - Массив из Строка - полное имя объекта метаданных. +// +Процедура ПриЗаполненииЗависимыхТаблицДляВыгрузкиЗагрузкиOData(Таблицы) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсODataПереопределяемый.ПриЗаполненииЗависимыхТаблицДляВыгрузкиЗагрузкиOData(Таблицы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтерфейсыСообщенийВМоделиСервиса.md b/src/content/docs/bsp/ИнтерфейсыСообщенийВМоделиСервиса.md new file mode 100644 index 0000000..8f74681 --- /dev/null +++ b/src/content/docs/bsp/ИнтерфейсыСообщенийВМоделиСервиса.md @@ -0,0 +1,42 @@ +--- +title: Интерфейсы сообщений в модели сервиса +slug: bsp/интерфейсы-сообщений-в-модели-сервиса +--- + + +## ВерсияИнтерфейсаКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает версии интерфейса сообщений, поддерживаемые ИБ-корреспондентом. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИнтерфейсСообщения - Строка - Имя программного интерфейса сообщений. +// ПараметрыПодключения - Структура - Параметры подключения к ИБ-корреспонденту. +// ПредставлениеПолучателя - Строка - Представление ИБ-корреспондента. +// ИнтерфейсТекущейИБ - Строка - Имя программного интерфейса текущей ИБ (используется +// для обеспечения обратной совместимости с предыдущими версиями БСП). +// +// Возвращаемое значение: +// Строка - максимальная версия интерфейса, поддерживаемая как ИБ-корреспондентом, так и текущей ИБ. +// +Функция ВерсияИнтерфейсаКорреспондента(Знач ИнтерфейсСообщения, Знач ПараметрыПодключения, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыСообщенийВМоделиСервиса.ВерсияИнтерфейсаКорреспондента(ИнтерфейсСообщения, ПараметрыПодключения, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.md b/src/content/docs/bsp/ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.md new file mode 100644 index 0000000..028da7e --- /dev/null +++ b/src/content/docs/bsp/ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.md @@ -0,0 +1,84 @@ +--- +title: Интерфейсы сообщений в модели сервиса переопределяемый +slug: bsp/интерфейсы-сообщений-в-модели-сервиса-переопределяемый +--- + + +## ЗаполнитьОбработчикиПринимаемыхСообщений +
+ +Описание, пример вызова + +```bsl + +// Заполняет переданный массив общими модулями, которые являются обработчиками интерфейсов принимаемых сообщений. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// МассивОбработчиков - Массив Из ОбщийМодуль - элементами массива являются общие модули. +// +Процедура ЗаполнитьОбработчикиПринимаемыхСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.ЗаполнитьОбработчикиПринимаемыхСообщений(МассивОбработчиков) +``` +
+ +## ЗаполнитьОбработчикиОтправляемыхСообщений +
+ +Описание, пример вызова + +```bsl + +// Заполняет переданный массив общими модулями, которые являются обработчиками интерфейсов отправляемых сообщений. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// МассивОбработчиков - Массив Из ОбщийМодуль - Элементами массива являются общие модули. +// +Процедура ЗаполнитьОбработчикиОтправляемыхСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.ЗаполнитьОбработчикиОтправляемыхСообщений(МассивОбработчиков) +``` +
+ +## ПриОпределенииВерсииИнтерфейсаКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при определении версии интерфейса сообщений, поддерживаемой как ИБ-корреспондентом, +// так и текущей ИБ. В данной процедуре предполагается реализовывать механизмы поддержки обратной совместимости со +// старыми версиями ИБ-корреспондентов. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ИнтерфейсСообщения - Строка - Название программного интерфейса сообщения, для которого определяется версия. +// ПараметрыПодключения - Структура - Параметры подключения к ИБ-корреспонденту. +// ПредставлениеПолучателя - Строка - Представление ИБ-корреспондента. +// Результат - Строка - Определяемая версия. Значение данного параметра может быть изменено в данной процедуре. +// +Процедура ПриОпределенииВерсииИнтерфейсаКорреспондента(Знач ИнтерфейсСообщения, Знач ПараметрыПодключения, Знач ПредставлениеПолучателя, Результат) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.ПриОпределенииВерсииИнтерфейсаКорреспондента(ИнтерфейсСообщения, ПараметрыПодключения, ПредставлениеПолучателя, Результат) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнформационныйЦентрВызовСервера.md b/src/content/docs/bsp/ИнформационныйЦентрВызовСервера.md new file mode 100644 index 0000000..c6ad092 --- /dev/null +++ b/src/content/docs/bsp/ИнформационныйЦентрВызовСервера.md @@ -0,0 +1,146 @@ +--- +title: Информационный центр вызов сервера +slug: bsp/информационный-центр-вызов-сервера +--- + + +## ДанныеНастроекИнтеграцииСУСП +
+ +Описание, пример вызова + +```bsl + +// Информация о подключении локальной базы к службе поддержки +// +// Возвращаемое значение: +// Структура - содержит поля: +// * АдресВнешнегоАнонимногоИнтерфейсаУСП - Строка - адрес HTTP-сервиса ext_sd службы поддержки +// * АдресАнонимногоСервисаИнтеграцииСИнформационнымЦентромУСП - Строка - адрес web-сервиса службы поддержки +// * ПодтвержденКодДляИнтеграцииСУСП - Булево - если Истина, то база подключена к службе поддержки +// * АдресПочтыАбонентаДляИнтеграцииСУСП - Строка - E-mail пользователя, +// от имени которого локальной база подключена к службе поддержки +// * КодРегистрацииВУСП - Строка - код, при помощи которого база зарегистрирована в службе поддержки +// +Функция ДанныеНастроекИнтеграцииСУСП() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрВызовСервера.ДанныеНастроекИнтеграцииСУСП() +``` +
+ +## ПроверитьКодПользователя +
+ +Описание, пример вызова + +```bsl + +// Проверяет код пользователя для работы со службой поддержки. +// +// Параметры: +// КодПользователя - Строка - проверяемый код +// Email - Строка - e-mail пользователя, код которого проверяется +// +// Возвращаемое значение: +// Структура - с полями: +// * КодВерный - Булево +// * ТекстСообщения - Строка - заполянется, если код некорректен +// +Функция ПроверитьКодПользователя(КодПользователя, Email) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрВызовСервера.ПроверитьКодПользователя(КодПользователя, Email) +``` +
+ +## EmailПользователя +
+ +Описание, пример вызова + +```bsl + + +// Email пользователя для работы с обращениями +// +// Возвращаемое значение: +// Строка - e-mail +// +Функция EmailПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрВызовСервера.EmailПользователя() +``` +
+ +## СохранитьКодПользователя +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьКодПользователя(Знач ИмяКомпьютера = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрВызовСервера.СохранитьКодПользователя(ИмяКомпьютера, ); +``` +
+ +## ПрочитатьКодПользователя +
+ +Описание, пример вызова + +```bsl + +// Прочитать код пользователя. +// +// Параметры: +// ИмяКомпьютера - Строка - имя компьютера +// +// Возвращаемое значение: +// Строка - код пользователя. +Функция ПрочитатьКодПользователя(Знач ИмяКомпьютера) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрВызовСервера.ПрочитатьКодПользователя(ИмяКомпьютера) +``` +
+ +## ЗаписатьПредупреждение +
+ +Описание, пример вызова + +```bsl + +// Записывает предупреждение в ЖР. +// +Процедура ЗаписатьПредупреждение(ТекстПредупреждения) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрВызовСервера.ЗаписатьПредупреждение(ТекстПредупреждения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнформационныйЦентрКлиент.md b/src/content/docs/bsp/ИнформационныйЦентрКлиент.md new file mode 100644 index 0000000..7cc8713 --- /dev/null +++ b/src/content/docs/bsp/ИнформационныйЦентрКлиент.md @@ -0,0 +1,297 @@ +--- +title: Информационный центр клиент +slug: bsp/информационный-центр-клиент +--- + + +## НажатиеНаИнформационнуюСсылку +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик при нажатии на информационную ссылку. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - контекст управляемой формы. +// Элемент - ГруппаФормы - группа формы. +// +Процедура НажатиеНаИнформационнуюСсылку(Форма, Элемент) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.НажатиеНаИнформационнуюСсылку(Форма, Элемент) +``` +
+ +## НажатиеНаСсылкуВсеИнформационныеСсылки +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик при нажатии на "Все" информационные ссылки. +// +// Параметры: +// ПутьКФорме - Строка - полный путь к форме. +// +Процедура НажатиеНаСсылкуВсеИнформационныеСсылки(ПутьКФорме) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.НажатиеНаСсылкуВсеИнформационныеСсылки(ПутьКФорме) +``` +
+ +## ОткрытьОбращенияВСлужбуПоддержки +
+ +Описание, пример вызова + +```bsl + +// Открывает форму со всеми обращениями в службу поддержки. +// +Процедура ОткрытьОбращенияВСлужбуПоддержки() Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.ОткрытьОбращенияВСлужбуПоддержки() +``` +
+ +## ОткрытьОбсужденияНаФоруме +
+ +Описание, пример вызова + +```bsl + +// Открывает форму с обсуждениями на форуме. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ОткрытьОбсужденияНаФоруме() Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.ОткрытьОбсужденияНаФоруме() +``` +
+ +## ОткрытьЦентрИдей +
+ +Описание, пример вызова + +```bsl + +// Открывает форму с Центром идей. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ОткрытьЦентрИдей() Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.ОткрытьЦентрИдей() +``` +
+ +## ПоказатьВсеСообщения +
+ +Описание, пример вызова + +```bsl + +// Открывает форму отображения всех новостей. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПоказатьВсеСообщения() Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.ПоказатьВсеСообщения() +``` +
+ +## БазаПодключенаКУСП +
+ +Описание, пример вызова + +```bsl + +// Определяет, подключена ли локальная база к службе поддержки +// +// Возвращаемое значение: +// Булево - Истина, если база подключена к УСП +// +Функция БазаПодключенаКУСП() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрКлиент.БазаПодключенаКУСП() +``` +
+ +## ОткрытьВзаимодействиеВСлужбуПоддержки +
+ +Описание, пример вызова + +```bsl + +// Открывает взаимодействие по обращению. +// +// Параметры: +// ИдентификаторОбращения - УникальныйИдентификатор - идентификатор обращения. +// ИдентификаторВзаимодействия - УникальныйИдентификатор - идентификатор взаимодействия. +// ТипВзаимодействия - Строка - тип взаимодействия. +// Входящее - Булево - признак: входящее сообщение или нет. +// Просмотрено - Булево - признак: просмотрено сообщение, или нет. +// +Процедура ОткрытьВзаимодействиеВСлужбуПоддержки(ИдентификаторОбращения, ИдентификаторВзаимодействия, ТипВзаимодействия, Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.ОткрытьВзаимодействиеВСлужбуПоддержки(ИдентификаторОбращения, ИдентификаторВзаимодействия, ТипВзаимодействия, ); +``` +
+ +## ОткрытьФормуОтправкиСообщенияВСлужбуПоддержки +
+ +Описание, пример вызова + +```bsl + +// Открывает форму по отправке сообщения получателю. +// +// Параметры: +// СоздаватьОбращение - Булево - если Истина, будет открыта форма нового обращения. +// если Ложь, будет открыта форма существующего обращения (в этом случае необходимо +// указать следующий параметр ИдентификаторОбращения +// ИдентификаторОбращения - УникальныйИдентификатор - Необязательный параметр. Необходимо указать, если СоздаватьОбращение = Ложь +// КодПользователя - Строка - код, позволяющий определить инициатора обращения +// ПараметрыОбращения - см. ИнформационныйЦентрКлиент.НовыеПараметрыОбращенияВСлужбуПоддержки +// +Процедура ОткрытьФормуОтправкиСообщенияВСлужбуПоддержки(СоздаватьОбращение, Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.ОткрытьФормуОтправкиСообщенияВСлужбуПоддержки(СоздаватьОбращение, ); +``` +
+ +## ОткрытьОбращениеВСлужбуПоддержки +
+ +Описание, пример вызова + +```bsl + +// Открывает форму с обращением в службу поддержки +// +// Параметры: +// ИдентификаторОбращения - УникальныйИдентификатор - идентификатор обращения. +// +Процедура ОткрытьОбращениеВСлужбуПоддержки(ИдентификаторОбращения, КодПользователя = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.ОткрытьОбращениеВСлужбуПоддержки(ИдентификаторОбращения, КодПользователя); +``` +
+ +## ОткрытьСписокОбращенийВУСП +
+ +Описание, пример вызова + +```bsl + +// Открывает форму со списком обращений +// +// Параметры: +// КодПользователя - Строка - код пользователя для работы с обращениями +// +Процедура ОткрытьСписокОбращенийВУСП(КодПользователя) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.ОткрытьСписокОбращенийВУСП(КодПользователя) +``` +
+ +## НовыеПараметрыОбращенияВСлужбуПоддержки +
+ +Описание, пример вызова + +```bsl + +// Функция-конструктор параметра процедуры ИнформационныйЦентрКлиент.ОткрытьФормуНовогоОбращенияВСлужбуПоддержки +// +// Возвращаемое значение: +// Структура - с полями: +// * Тема - Строка - тема обращения +// * Текст - Строка - текст обращения +// * ИспользоватьСтандартныйШаблон - Булево - если Истина, то текст обращения будет заполнен по шаблону +// из метода ИнформационныйЦентрСервер.ШаблонТекстаВТехПоддержку +// * Вложения - Массив из Структура - массив сложения из структур с полями: +// ** ИмяФайла - Строка - имя файла-вложения с расширением, например "file.txt" +// ** АдресВоВременномХранилище - Строка - адрес файла-вложения во временном хранилище +// * ОбработчикЗавершения - ОписаниеОповещения - описание оповещения о закрытии формы нового обращения +// * ДополнительныеДанные - Структура - произвольная структура данных, которую можноп ередать в службу поддержки. +// Эта структура должна быть сериализуемой в JSON. +Функция НовыеПараметрыОбращенияВСлужбуПоддержки() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрКлиент.НовыеПараметрыОбращенияВСлужбуПоддержки() +``` +
+ +## ОткрытьФормуНовогоОбращенияВСлужбуПоддержки +
+ +Описание, пример вызова + +```bsl + +// Открывает форму для редактирования и отправки нового обращения в службу поддержки. +// Форма предварительно может быть заполнена данными. +// +// Параметры: +// ПараметрыОбращения - см. ИнформационныйЦентрКлиент.НовыеПараметрыОбращенияВСлужбуПоддержки +// +Процедура ОткрытьФормуНовогоОбращенияВСлужбуПоддержки(ПараметрыОбращения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрКлиент.ОткрытьФормуНовогоОбращенияВСлужбуПоддержки(ПараметрыОбращения); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнформационныйЦентрКлиентСервер.md b/src/content/docs/bsp/ИнформационныйЦентрКлиентСервер.md new file mode 100644 index 0000000..64794ed --- /dev/null +++ b/src/content/docs/bsp/ИнформационныйЦентрКлиентСервер.md @@ -0,0 +1,65 @@ +--- +title: Информационный центр клиент сервер +slug: bsp/информационный-центр-клиент-сервер +--- + + +## РазделитьКодПользователя +
+ +Описание, пример вызова + +```bsl +// Методы области ШифрованиеКодаПользователя_СлужебныйПрограммныйИнтерфейс заимствованы +// из подсистемы ИнтеграцияС1СДокументооборотом из конфигурации УправлениеПредприятием (1С:ERP) + +// Разделяет код пользователя на две независимые части для последующего восстановления функцией СобратьКодПользователя. +// +// Параметры: +// КодПользователя - Строка - разделяемый код пользователя. +// +// Возвращаемое значение: +// Массив из Строка - массив из двух строк, содержащих шестнадцатиричное представление кода пользователя. +// +Функция РазделитьКодПользователя(КодПользователя) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрКлиентСервер.РазделитьКодПользователя(КодПользователя) +``` +
+ +## СобратьКодПользователя +
+ +Описание, пример вызова + +```bsl + +// Собирает код пользователя из двух частей, ранее разделенных функцией РазделитьКодПользователя. +// В случае повреждения строк возвращает Неопределено. +// +// Параметры: +// РазделенныйКод - Массив - две строки, содержащие разделенный код пользователя. +// +// Возвращаемое значение: +// Строка - собранный код пользователя или +// Неопределено - если строки повреждены. +// +Функция СобратьКодПользователя(Знач РазделенныйКод) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрКлиентСервер.СобратьКодПользователя(РазделенныйКод) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнформационныйЦентрСервер.md b/src/content/docs/bsp/ИнформационныйЦентрСервер.md new file mode 100644 index 0000000..ca4e7bf --- /dev/null +++ b/src/content/docs/bsp/ИнформационныйЦентрСервер.md @@ -0,0 +1,182 @@ +--- +title: Информационный центр сервер +slug: bsp/информационный-центр-сервер +--- + + +## ВывестиКонтекстныеСсылки +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Информационные ссылки + +// Выводит информационные ссылки на форме +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - контекст формы. +// ГруппаФормы - ГруппаФормы - группа формы, в которой выводятся информационные ссылки. +// КоличествоГрупп - Число - количество групп информационных ссылок в форме. +// КоличествоСсылокВГруппе - Число - количество информационных ссылок в группе. +// ВыводитьСсылкуВсе - Булево - выводить или нет ссылку "Все". +// ПутьКФорме - Строка - полный путь к форме. +// +Процедура ВывестиКонтекстныеСсылки(Форма, ГруппаФормы, КоличествоГрупп = 3, КоличествоСсылокВГруппе = 1, Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСервер.ВывестиКонтекстныеСсылки(Форма, ГруппаФормы, КоличествоГрупп, КоличествоСсылокВГруппе, ); +``` +
+ +## ЗаполнитьСтатическиеИнформационныеСсылки +
+ +Описание, пример вызова + +```bsl + +// Заполняет элементы формы информационными ссылками. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма. +// МассивЭлементов - Массив Из ПолеФормы - массив элементов формы. +// ЭлементВсеСсылки - ДекорацияФормы - элемент формы. +// ПутьКФорме - Строка - путь к форме. +// +Процедура ЗаполнитьСтатическиеИнформационныеСсылки(Форма, МассивЭлементов, ЭлементВсеСсылки = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСервер.ЗаполнитьСтатическиеИнформационныеСсылки(Форма, МассивЭлементов, ЭлементВсеСсылки, ); +``` +
+ +## КонтекстнаяСсылкаПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Возвращает информационную ссылку по идентификатору. +// +// Параметры: +// Идентификатор - Строка - идентификатор ссылки. +// +// Возвращаемое значение: +// Структура - контекстная ссылка: +// * Адрес - Строка +// * Наименование - Строка +// +Функция КонтекстнаяСсылкаПоИдентификатору(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрСервер.КонтекстнаяСсылкаПоИдентификатору(Идентификатор) +``` +
+ +## ПространстваИменИнформационныхСсылок +
+ +Описание, пример вызова + +```bsl + +// Возвращает все пространства имен информационных ссылок. +// +// Возвращаемое значение: +// Массив из Строка - массив пространства имен информационных ссылок. +// +Функция ПространстваИменИнформационныхСсылок() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрСервер.ПространстваИменИнформационныхСсылок() +``` +
+ +## СформироватьСписокНовостейНаРабочийСтол +
+ +Описание, пример вызова + +```bsl + +// Формирует список новостей. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ТаблицаНовостей - ТаблицаЗначений - с колонками: +// * Наименование - Строка - заголовок новости. +// * Идентификатор - УникальныйИдентификатор - идентификатор новости. +// * Критичность - Число - критичность новости. +// * ВнешняяСсылка - Строка - адрес внешней ссылки. +// КоличествоВыводимыхНовостей - Число - количество выводимых новостей на рабочем столе. +// +Процедура СформироватьСписокНовостейНаРабочийСтол(ТаблицаНовостей, Знач КоличествоВыводимыхНовостей = 3) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСервер.СформироватьСписокНовостейНаРабочийСтол(ТаблицаНовостей, КоличествоВыводимыхНовостей); +``` +
+ +## НастроенаИнтеграцияСИнформационнымЦентром +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если в базе настроена возможность отправки и получения обращений через Информационный центр служба поддержки +// +// Возвращаемое значение: +// Булево +// +Функция НастроенаИнтеграцияСИнформационнымЦентром() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрСервер.НастроенаИнтеграцияСИнформационнымЦентром() +``` +
+ +## УстановленаИнтеграцияСоСлужбойПоддержки +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ИнформационныйЦентрСервер.НастроенаИнтеграцияСИнформационнымЦентром +// Возвращает Истина, если установлена интеграция с Информационным центром службы поддержки. +// +// Возвращаемое значение: +// Булево - Истина, если установлена интеграция со службой поддержки. +Функция УстановленаИнтеграцияСоСлужбойПоддержки() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнформационныйЦентрСервер.УстановленаИнтеграцияСоСлужбойПоддержки() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнформационныйЦентрСерверПереопределяемый.md b/src/content/docs/bsp/ИнформационныйЦентрСерверПереопределяемый.md new file mode 100644 index 0000000..a69c1b7 --- /dev/null +++ b/src/content/docs/bsp/ИнформационныйЦентрСерверПереопределяемый.md @@ -0,0 +1,83 @@ +--- +title: Информационный центр сервер переопределяемый +slug: bsp/информационный-центр-сервер-переопределяемый +--- + + +## ОпределитьСсылкуПоискаИнформации +
+ +Описание, пример вызова + +```bsl + +// Определяет ссылку поиска информации. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// СсылкаПоискаИнформации - Строка - адрес. +// +// Пример: +// Если к адресу ссылки добавить строку поиска, и перейти по данному адресу, то +// в результате мы должны перейти форму результатов поиска. +// +Процедура ОпределитьСсылкуПоискаИнформации(СсылкаПоискаИнформации) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСерверПереопределяемый.ОпределитьСсылкуПоискаИнформации(СсылкаПоискаИнформации) +``` +
+ +## ОбщиеМакетыСИнформационнымиСсылками +
+ +Описание, пример вызова + +```bsl + +// Определяет общие макеты с информационными ссылками. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// МассивМакетов - Массив Из ТабличныйДокумент - массив общих макетов. +// +Процедура ОбщиеМакетыСИнформационнымиСсылками(МассивМакетов) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСерверПереопределяемый.ОбщиеМакетыСИнформационнымиСсылками(МассивМакетов) +``` +
+ +## ФормыСИнформационнымиСсылками +
+ +Описание, пример вызова + +```bsl + +// Определяет массив полных путей к формам, в которых используются информационные ссылки. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// МассивФорм - Массив Из Строка - массив полных путей к формам. +// +Процедура ФормыСИнформационнымиСсылками(МассивФорм) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСерверПереопределяемый.ФормыСИнформационнымиСсылками(МассивФорм) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнформационныйЦентрСлужебный.md b/src/content/docs/bsp/ИнформационныйЦентрСлужебный.md new file mode 100644 index 0000000..f43c97e --- /dev/null +++ b/src/content/docs/bsp/ИнформационныйЦентрСлужебный.md @@ -0,0 +1,243 @@ +--- +title: Информационный центр служебный +slug: bsp/информационный-центр-служебный +--- + + +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСлужебный.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру массивами поддерживаемых версий всех подлежащих версионированию подсистем, +// используя в качестве ключей названия подсистем. +// Обеспечивает функциональность Web-сервиса InterfaceVersion. +// При внедрении надо поменять тело процедуры так, чтобы она возвращала актуальные наборы версий (см. пример.ниже). +// +// Параметры: +// СтруктураПоддерживаемыхВерсий - Структура - описание: Ключи - названия подсистем, Значения - массивы названий поддерживаемых версий. +// +// Пример: +// // СервисПередачиФайлов +// МассивВерсий = Новый Массив; +// МассивВерсий.Добавить("1.0.1.1"); +// МассивВерсий.Добавить("1.0.2.1"); +// СтруктураПоддерживаемыхВерсий.Вставить("СервисПередачиФайлов", МассивВерсий); +// // Конец СервисПередачиФайлов +// +Процедура ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(Знач СтруктураПоддерживаемыхВерсий) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСлужебный.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(СтруктураПоддерживаемыхВерсий) +``` +
+ +## ПриОпределенииНастроекРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// См. РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроекРегламентныхЗаданий +// Настройки - см. РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроекРегламентныхЗаданий.Настройки +//@skip-warning ПустойМетод - особенность реализации. +// +Процедура ПриОпределенииНастроекРегламентныхЗаданий(Настройки) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСлужебный.ПриОпределенииНастроекРегламентныхЗаданий(Настройки) +``` +
+ +## ПриЗаполненииТаблицыПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// Формирует список параметров ИБ. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ТаблицаПараметров - ТаблицаЗначений: +// * Имя - Строка - имя параметра. +// * Описание - Строка - описание параметра для отображения в пользовательском интерфейсе. +// * ЗапретЧтения - Булево - признак невозможности считывания параметра ИБ. Может быть установлен, например, для +// паролей. +// * ЗапретЗаписи - Булево - признак невозможности изменения параметра ИБ. +// * Тип - ОписаниеТипов - тип значения параметра. Допускается использовать только примитивные типы и +// перечисления, присутствующие в управляющем приложении. +// +Процедура ПриЗаполненииТаблицыПараметровИБ(Знач ТаблицаПараметров) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСлужебный.ПриЗаполненииТаблицыПараметровИБ(ТаблицаПараметров) +``` +
+ +## ПриУстановкеЗначенийПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед попыткой записи значений параметров ИБ в одноименные +// константы. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ЗначенияПараметров - Структура - значения параметров которые требуется установить. +// В случае если значение параметра устанавливается в данной процедуре из структуры +// необходимо удалить соответствующую пару КлючИЗначение. +// +Процедура ПриУстановкеЗначенийПараметровИБ(Знач ЗначенияПараметров) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСлужебный.ПриУстановкеЗначенийПараметровИБ(ЗначенияПараметров) +``` +
+ +## ПриОпределенииОбработчиковКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Получает список обработчиков сообщений, которые обрабатывают подсистемы библиотеки. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Обработчики - ТаблицаЗначений - состав полей см. в ОбменСообщениями.НоваяТаблицаОбработчиковСообщений. +// +Процедура ПриОпределенииОбработчиковКаналовСообщений(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСлужебный.ПриОпределенииОбработчиковКаналовСообщений(Обработчики) +``` +
+ +## РегистрацияИнтерфейсовПринимаемыхСообщений +
+ +Описание, пример вызова + +```bsl + +// Заполняет переданный массив общими модулями, которые являются обработчиками интерфейсов +// принимаемых сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - массив - +// +Процедура РегистрацияИнтерфейсовПринимаемыхСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСлужебный.РегистрацияИнтерфейсовПринимаемыхСообщений(МассивОбработчиков) +``` +
+ +## ПриОпределенииОбработчиковПоставляемыхДанных +
+ +Описание, пример вызова + +```bsl + +// Зарегистрировать обработчики поставляемых данных +// +// При получении уведомления о доступности новых общих данных, вызывается процедуры +// ДоступныНовыеДанные модулей, зарегистрированных через ПолучитьОбработчикиПоставляемыхДанных. +// В процедуру передается Дескриптор - ОбъектXDTO Descriptor. +// +// В случае, если ДоступныНовыеДанные устанавливает аргумент Загружать в значение Истина, +// данные загружаются, дескриптор и путь к файлу с данными передаются в процедуру +// ОбработатьНовыеДанные. Файл будет автоматически удален после завершения процедуры. +// Если в менеджере сервиса не был указан файл - значение аргумента равно Неопределено. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Обработчики- ТаблицаЗначений - таблица для добавления обработчиков. Колонки: +// * ВидДанных - Строка - код вида данных, обрабатываемый обработчиком +// * КодОбработчика - Строка - длинна 20 - будет использоваться при восстановлении обработки данных после сбоя +// * Обработчик - ОбщийМодуль - модуль, содержащий следующие экспортные процедуры: +// ДоступныНовыеДанные(Дескриптор, Загружать) +// ОбработатьНовыеДанные(Дескриптор, ПутьКФайлу) +// ОбработкаДанныхОтменена(Дескриптор) +// +Процедура ПриОпределенииОбработчиковПоставляемыхДанных(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСлужебный.ПриОпределенииОбработчиковПоставляемыхДанных(Обработчики) +``` +
+ +## ЗарегистрироватьОбработчикиОбновления +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список Обработчики процедуры-обработчики обновления, необходимые данной подсистеме. +// +// Параметры: +// Обработчики - см. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления +// +Процедура ЗарегистрироватьОбработчикиОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ИнформационныйЦентрСлужебный.ЗарегистрироватьОбработчикиОбновления(Обработчики) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнформацияПриЗапускеПереопределяемый.md b/src/content/docs/bsp/ИнформацияПриЗапускеПереопределяемый.md new file mode 100644 index 0000000..197854e --- /dev/null +++ b/src/content/docs/bsp/ИнформацияПриЗапускеПереопределяемый.md @@ -0,0 +1,37 @@ +--- +title: Информация при запуске переопределяемый +slug: bsp/информация-при-запуске-переопределяемый +--- + + +## ОпределитьНастройки +
+ +Описание, пример вызова + +```bsl + +// Определение настроек отображения информации при запуске. +// +// Параметры: +// Настройки - Структура: +// * Показывать - Булево - показывать ли информацию в текущем сеансе. +// Истина - Информация будет показана после входа в программу. +// Ложь - Информация не будет показана. +// +Процедура ОпределитьНастройки(Настройки) Экспорт +``` + +Пример вызова +```bsl +ИнформацияПриЗапускеПереопределяемый.ОпределитьНастройки(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнцидентыЦККПереопределяемый.md b/src/content/docs/bsp/ИнцидентыЦККПереопределяемый.md new file mode 100644 index 0000000..144b665 --- /dev/null +++ b/src/content/docs/bsp/ИнцидентыЦККПереопределяемый.md @@ -0,0 +1,66 @@ +--- +title: Инциденты ЦКК переопределяемый +slug: bsp/инциденты-цкк-переопределяемый +--- + + +## СписокТиповИнцидентовПереопределяемый +
+ +Описание, пример вызова + +```bsl + +// Процедура дополняет список типов инцидентов СписокТипов +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// СписокТипов - Соответствие из КлючИЗначение: +// * Ключ - Строка - с именем типа, +// * Значение - Структура: +// ** УровеньИнцидента - Строка +// ** Подсистема - Строка +// ** Теги - Строка +// ** ПроцедураПроверки - Строка +// Пример: +// Здесь следует определить прикладные типы инцидентов и методы их проверки актуальности. +// Подробно см: +// Описание = ИнцидентыЦККСервер.СоздатьОписаниеТипаИнцидента("ОстановиласьОчередьОбменаССайтом"); +// ИнцидентыЦККСервер.СоздатьЗаписьТипа(СписокТипов, Описание); +// +Процедура СписокТиповИнцидентовПереопределяемый(СписокТипов) Экспорт +``` + +Пример вызова +```bsl +ИнцидентыЦККПереопределяемый.СписокТиповИнцидентовПереопределяемый(СписокТипов) +``` +
+ +## ВыполнитьЗадачиМониторингаЦКК +
+ +Описание, пример вызова + +```bsl + +// В процедуре можно вызвать все прикладные проверки, связанные с периодическим мониторингом прикладной конфигурации. +// Процедура вызывается с помощью регламентной процедуры МониторингЦКК раз в минуту, если константа АдресЦКК заполнена. +// @skip-warning ПустойМетод - переопределяемый метод. +// +Процедура ВыполнитьЗадачиМониторингаЦКК() Экспорт +``` + +Пример вызова +```bsl +ИнцидентыЦККПереопределяемый.ВыполнитьЗадачиМониторингаЦКК() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ИнцидентыЦККСервер.md b/src/content/docs/bsp/ИнцидентыЦККСервер.md new file mode 100644 index 0000000..4f1bcdc --- /dev/null +++ b/src/content/docs/bsp/ИнцидентыЦККСервер.md @@ -0,0 +1,187 @@ +--- +title: Инциденты ЦКК сервер +slug: bsp/инциденты-цкк-сервер +--- + + +## СоздатьОписаниеТипаИнцидента +
+ +Описание, пример вызова + +```bsl + +// Создает структуру описания типа инцидента, которую требуется заполнить и передать функции СоздатьЗаписьТипа. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИмяТипа - Строка - Имя типа инцидента. Имя должно быть уникальным, например: Конфигурация1.ПОдсистема1.Инцидент1. +// +// Возвращаемое значение: +// - Структура - поля структуры: +// * ТипИнцидента - Строка - имя типа +// * УровеньИнцидента - Строка - "Информация", "Предупреждение" (по умолчанию), "Ошибка", "КритическаяОшибка" +// * Подсистема - Строка - подсистема с точки зрения ЦКК +// * КонтекстИнформационнойБазы - Булево - определять контекст подключения. По умолчанию нет. +// * ПроцедураПроверки - Строка - имя процедуры, которая будет вызываться периодически, если есть открытые инциденты указанного типа для проверки +// их актуальности. Если указано "Авто", будет использована проверка по полю "Актуален" из регистра открытых инцидентов. +// * МинутМеждуИнцидентами - Число - ограничивать частоту отсылки инцидентов. По умолчанию 0: не ограничивать +// * Теги - Структура - с полями: +// ** Оборудование - Булево - +// ** Доступность - Булево - +// ** Производительность - Булево - +// ** ПрикладнаяОшибка - Булево - +// ** Дополнительные - Строка - в строку можно разместить произвольные теги, разделенные пробелом. +// +Функция СоздатьОписаниеТипаИнцидента(ИмяТипа) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнцидентыЦККСервер.СоздатьОписаниеТипаИнцидента(ИмяТипа) +``` +
+ +## СоздатьЗаписьТипа +
+ +Описание, пример вызова + +```bsl + +// Создает запись типа инцидента и помещает ее в словарь. Если в словаре тип уже зарегистрирован, он будет перезаписан. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// СловарьТипов - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя типа инцидента +// * Значение - см. СоздатьОписаниеТипаИнцидента +// Описание - Структура: +// * ТипИнцидента - Строка +// * УровеньИнцидента - Строка +// * Подсистема - Строка +// * КонтекстИнформационнойБазы - Булево +// * ПроцедураПроверки - Строка +// * МинутМеждуИнцидентами - Число +// * Теги - Структура: +// ** Оборудование - Булево +// ** Доступность - Булево +// ** Производительность - Булево +// ** ПрикладнаяОшибка - Булево +// ** Дополнительные - Строка +Процедура СоздатьЗаписьТипа(Знач СловарьТипов, Знач Описание) Экспорт +``` + +Пример вызова +```bsl +ИнцидентыЦККСервер.СоздатьЗаписьТипа(СловарьТипов, Описание) +``` +
+ +## ЗарегистрироватьТипыИнцидентовВЦКК +
+ +Описание, пример вызова + +```bsl + +// Регистрирует типы инцидентов в ИБ. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ЗарегистрироватьТипыИнцидентовВЦКК() Экспорт +``` + +Пример вызова +```bsl +ИнцидентыЦККСервер.ЗарегистрироватьТипыИнцидентовВЦКК() +``` +
+ +## ОткрытьИнцидент +
+ +Описание, пример вызова + +```bsl + +// Открывает инцидент. Если адрес ЦКК не указан, ничего не делает. Если инцидент отсылается чаще +// указанных в типе ограничений, такая отсылка будет проигнорирована без вызова исключений. +// Если указано Асинхронно=Истина, то метод будет выполнен с помощью менеджера фоновых заданий. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ТипИнцидента - Строка - Идентификатор типа инцидента. Должен быть среди зарегистрированных типов. +// КодИнцидента - Строка - Строковый идентификатор инцидента. Должен быть уникален внутри типа. Если повторяется, +// считается, что инцидент еще раз и счетчик срабатываний его в ЦКК увеличится. +// ТекстСообщения - Строка - текст сообщения инцидента. +// Асинхронно - Булево - флаг асинхронного выполнения. +// +Процедура ОткрытьИнцидент(Знач ТипИнцидента, Знач КодИнцидента, Знач ТекстСообщения, Знач Асинхронно = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнцидентыЦККСервер.ОткрытьИнцидент(ТипИнцидента, КодИнцидента, ТекстСообщения, Асинхронно); +``` +
+ +## ПометитьИнцидентКакНеактуальный +
+ +Описание, пример вызова + +```bsl + +// Помечает инцидент в регистре ИнцидентыОткрытые как неактуальный. +// Инцидент закроется в ЦКК при следующем вызове проверки на актуальность. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ТипИнцидента - Строка - Идентификатор типа инцидента. +// КодИнцидента - Строка - Идентификатор инцидента. +// +Процедура ПометитьИнцидентКакНеактуальный(Знач ТипИнцидента, Знач КодИнцидента) Экспорт +``` + +Пример вызова +```bsl +ИнцидентыЦККСервер.ПометитьИнцидентКакНеактуальный(ТипИнцидента, КодИнцидента) +``` +
+ +## ОтослатьСтатистику +
+ +Описание, пример вызова + +```bsl + +// Отсылает счетчик в ЦКК, используя InputStatistics/InputStatisticsDate (СИНХРОННАЯ ОТСЫЛКА СЧЕТЧИКА). +// Когда указаны массивы в параметрах ИдентификаторСчетчика/ЗначениеСчетчика, происходит передача всего +// массива за один вызов. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторСчетчика - Строка - Идентификатор счетчика для ЦКК, разделенные точками +// ЗначениеСчетчика - Число - Значение счетчика на передаваемый (указанный) момент времени +// Данные - Соответствие из КлючИЗначение: +// * Ключ - Строка - идентификатор счетчика +// * Значение - Число - значение счетчика (если указано, имеет приоритет) +// ДатаСчетчика - Дата - Если указано, используется InputStatisticsDate, иначе - InputStatistics. +// +Процедура ОтослатьСтатистику(Знач ИдентификаторСчетчика, Знач ЗначениеСчетчика, Знач Данные = Неопределено, Знач ДатаСчетчика = неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнцидентыЦККСервер.ОтослатьСтатистику(ИдентификаторСчетчика, ЗначениеСчетчика, Данные, ДатаСчетчика); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КалендарныеГрафики.md b/src/content/docs/bsp/КалендарныеГрафики.md new file mode 100644 index 0000000..430abf4 --- /dev/null +++ b/src/content/docs/bsp/КалендарныеГрафики.md @@ -0,0 +1,354 @@ +--- +title: Календарные графики +slug: bsp/календарные-графики +--- + + +## ДатыПоКалендарю +
+ +Описание, пример вызова + +```bsl + +// Возвращает даты, которые отличаются от указанной даты ДатаОт на количество дней, +// входящих в указанный график ГрафикРаботы. +// +// Параметры: +// ГрафикРаботы - СправочникСсылка.Календари +// - СправочникСсылка.ПроизводственныеКалендари - график или +// производственный календарь, который необходимо использовать для расчета дат. +// ДатаОт - Дата - дата, от которой нужно рассчитать количество дней. +// МассивДней - Массив из Число - количество дней, на которые нужно увеличить дату начала. +// РассчитыватьСледующуюДатуОтПредыдущей - Булево - нужно ли рассчитывать следующую дату от предыдущей или +// все даты рассчитываются от переданной даты. +// ВызыватьИсключение - Булево - если Истина, вызвать исключение в случае незаполненного графика. +// +// Возвращаемое значение: +// Неопределено, Массив - массив дат, увеличенных на количество дней, входящих в график, +// Если график ГрафикРаботы не заполнен, и ВызыватьИсключение = Ложь, возвращается Неопределено. +// +Функция ДатыПоКалендарю(Знач ГрафикРаботы, Знач ДатаОт, Знач МассивДней, Знач РассчитыватьСледующуюДатуОтПредыдущей = Ложь, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = КалендарныеГрафики.ДатыПоКалендарю(ГрафикРаботы, ДатаОт, МассивДней, РассчитыватьСледующуюДатуОтПредыдущей, ВызыватьИсключение); +``` +
+ +## ДатаПоКалендарю +
+ +Описание, пример вызова + +```bsl + +// Возвращает дату, которая отличается указанной даты ДатаОт на количество дней, +// входящих в указанный график или производственный календарь ГрафикРаботы. +// +// Параметры: +// ГрафикРаботы - СправочникСсылка.Календари +// - СправочникСсылка.ПроизводственныеКалендари - график или +// производственный календарь, который необходимо использовать для расчета даты. +// ДатаОт - Дата - дата, от которой нужно рассчитать количество дней. +// КоличествоДней - Число - количество дней, на которые нужно увеличить дату начала. +// ВызыватьИсключение - Булево - если Истина, вызвать исключение в случае незаполненного графика. +// +// Возвращаемое значение: +// Дата, Неопределено - дата, увеличенная на количество дней, входящих в график. +// Если выбранный график не заполнен, и ВызыватьИсключение = Ложь, возвращается Неопределено. +// +Функция ДатаПоКалендарю(Знач ГрафикРаботы, Знач ДатаОт, Знач КоличествоДней, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = КалендарныеГрафики.ДатаПоКалендарю(ГрафикРаботы, ДатаОт, КоличествоДней, ВызыватьИсключение); +``` +
+ +## РазностьДатПоКалендарю +
+ +Описание, пример вызова + +```bsl + +// Определяет количество дней, входящих в график, для указанного периода. +// +// Параметры: +// ГрафикРаботы - СправочникСсылка.Календари +// - СправочникСсылка.ПроизводственныеКалендари - график или +// производственный календарь, который необходимо использовать для расчета дней. +// ДатаНачала - Дата - дата начала периода. +// ДатаОкончания - Дата - дата окончания периода. +// ВызыватьИсключение - Булево - если Истина, вызвать исключение в случае незаполненного графика. +// +// Возвращаемое значение: +// Число - количество дней между датами начала и окончания. +// Если график ГрафикРаботы не заполнен, и ВызыватьИсключение = Ложь, возвращается Неопределено. +// +Функция РазностьДатПоКалендарю(Знач ГрафикРаботы, Знач ДатаНачала, Знач ДатаОкончания, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = КалендарныеГрафики.РазностьДатПоКалендарю(ГрафикРаботы, ДатаНачала, ДатаОкончания, ВызыватьИсключение); +``` +
+ +## ПараметрыПолученияБлижайшихРабочихДат +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров получения ближайших рабочих дат по календарю. +// См. БлижайшиеРабочиеДаты. +// +// Параметры: +// ПроизводственныйКалендарь - СправочникСсылка.ПроизводственныеКалендари - +// если указан, то НерабочиеПериоды будет по умолчанию заполнен как Массив из описаний, +// полученных методом ПериодыНерабочихДней. +// +// Возвращаемое значение: +// Структура: +// * ПолучатьПредшествующие - Булево - способ получения ближайшей даты: +// если Истина - определяются рабочие даты, предшествующие переданным в параметре НачальныеДаты, +// если Ложь - получаются ближайшие рабочие даты, следующие за начальными датами. +// Значение по умолчанию - Ложь: +// * УчитыватьНерабочиеПериоды - Булево - определяет отношение к датам, выпадающим на периоды нерабочих дней календаря, +// если Истина, даты, выпадающие на период нерабочих дней будут считаться нерабочими, +// если Ложь, периоды нерабочих дней будут игнорироваться. +// Значение по умолчанию - Истина: +// * НерабочиеПериоды - Неопределено - уточняет периоды нерабочих дней, которые нужно учитывать, +// можно установить Массив номеров периодов или описаний, полученных методом ПериодыНерабочихДней, +// если Неопределено, будут учтены все периоды, +// если заполнен параметр ПроизводственныйКалендарь, то все периоды этого календаря будут заполнены в НерабочиеПериоды. +// Значение по умолчанию - Неопределено: +// * ВызыватьИсключение - Булево - вызов исключения в случае не заполненного графика +// если Истина, вызвать исключение, если график не заполнен. +// если Ложь - даты, по которым не удалось определить ближайшую дату, будут просто пропущены. +// Значение по умолчанию - Истина. +// * ПолучатьДатыЕслиКалендарьНеЗаполнен - Булево - если Истина и календарь не заполнен, то даты будут получены из +// данных заполнения календаря по умолчанию. +// +Функция ПараметрыПолученияБлижайшихРабочихДат(ПроизводственныйКалендарь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КалендарныеГрафики.ПараметрыПолученияБлижайшихРабочихДат(ПроизводственныйКалендарь); +``` +
+ +## БлижайшиеРабочиеДаты +
+ +Описание, пример вызова + +```bsl + +// Определяет для каждой даты дату ближайшего к ней рабочего дня. +// +// Параметры: +// ПроизводственныйКалендарь - СправочникСсылка.ПроизводственныеКалендари - календарь, используемый для расчета. +// НачальныеДаты - Массив из Дата - даты, относительно которых будет выполнен поиск ближайших. +// ПараметрыПолучения - см. ПараметрыПолученияБлижайшихРабочихДат. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Дата - начальная дата, +// * Значение - Дата - ближайшая к ней рабочая дата (если передана рабочая дата, то она же и возвращается). +// +Функция БлижайшиеРабочиеДаты(ПроизводственныйКалендарь, НачальныеДаты, ПараметрыПолучения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КалендарныеГрафики.БлижайшиеРабочиеДаты(ПроизводственныйКалендарь, НачальныеДаты, ПараметрыПолучения); +``` +
+ +## РасписанияРаботыНаПериод +
+ +Описание, пример вызова + +```bsl + +// Составляет расписания работы для дат, включенных в указанные графики на указанный период. +// Если расписание на предпраздничный день не задано, то оно определяется так, как если бы этот день был бы рабочим. +// Необходимо учитывать, что для работы этой функции обязательно наличие подсистемы ГрафикиРаботы. +// +// Параметры: +// Графики - Массив - массив элементов типа СправочникСсылка.Календари, для которых составляются расписания. +// ДатаНачала - Дата - дата начала периода, за который нужно составить расписания. +// ДатаОкончания - Дата - дата окончания периода. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ГрафикРаботы - СправочникСсылка.Календари - график работы. +// * ДатаГрафика - Дата - дата в графике работы ГрафикРаботы. +// * ВремяНачала - Дата - время начала работы в день ДатаГрафика. +// * ВремяОкончания - Дата - время окончания работы в день ДатаГрафика. +// +Функция РасписанияРаботыНаПериод(Графики, ДатаНачала, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +Результат = КалендарныеГрафики.РасписанияРаботыНаПериод(Графики, ДатаНачала, ДатаОкончания) +``` +
+ +## СоздатьВТРасписанияРаботыНаПериод +
+ +Описание, пример вызова + +```bsl + +// Создает в менеджере временную таблицу ВТРасписанияРаботы с колонками, соответствующими возвращаемому значению +// функции РасписанияРаботыНаПериод. +// Необходимо учитывать, что для работы этой функции обязательно наличие подсистемы ГрафикиРаботы. +// +// Параметры: +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - менеджер, в котором будет создана временная таблица. +// Графики - Массив - массив элементов типа СправочникСсылка.Календари, для которых составляются расписания. +// ДатаНачала - Дата - дата начала периода, за который нужно составить расписания. +// ДатаОкончания - Дата - дата окончания периода. +// +Процедура СоздатьВТРасписанияРаботыНаПериод(МенеджерВременныхТаблиц, Графики, ДатаНачала, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +КалендарныеГрафики.СоздатьВТРасписанияРаботыНаПериод(МенеджерВременныхТаблиц, Графики, ДатаНачала, ДатаОкончания) +``` +
+ +## ЗаполнитьПроизводственныйКалендарьВФорме +
+ +Описание, пример вызова + +```bsl + +// Заполняет реквизит в форме, в том случае, если используется единственный производственный календарь. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой требуется заполнить реквизит. +// ПутьРеквизита - Строка - путь к данным, например: "Объект.ПроизводственныйКалендарь". +// КПП - Строка - индивидуальный номер налогоплательщика (код причины постановки на учет) для определения региона. +// +Процедура ЗаполнитьПроизводственныйКалендарьВФорме(Форма, ПутьРеквизита, КПП = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КалендарныеГрафики.ЗаполнитьПроизводственныйКалендарьВФорме(Форма, ПутьРеквизита, КПП); +``` +
+ +## ОсновнойПроизводственныйКалендарь +
+ +Описание, пример вызова + +```bsl + +// Возвращает основной производственный календарь, используемый в учете. +// +// Возвращаемое значение: +// СправочникСсылка.ПроизводственныеКалендари, Неопределено - основной производственный календарь или +// Неопределено, в случае если он не обнаружен. +// +Функция ОсновнойПроизводственныйКалендарь() Экспорт +``` + +Пример вызова +```bsl +Результат = КалендарныеГрафики.ОсновнойПроизводственныйКалендарь() +``` +
+ +## ПериодыНерабочихДней +
+ +Описание, пример вызова + +```bsl + +// Готовит описание особых нерабочих периодов, установленных, например, законодательно. +// Такие периоды могут учитываться графиками, переопределяя заполнение по данным производственного календаря. +// +// Параметры: +// ПроизводственныйКалендарь - СправочникСсылка.ПроизводственныеКалендари - календарь, который является источником. +// ПериодОтбор - СтандартныйПериод - временной интервал, в пределах которого нужно определить нерабочие периоды. +// Возвращаемое значение: +// Массив - массив элементов типа Структура с полями: +// * Номер - Число - порядковый номер периода, может использоваться для идентификации. +// * Период - СтандартныйПериод - нерабочий период. +// * Основание - Строка - нормативный акт, на основании которого установлен нерабочий период. +// * Даты - Массив из Дата - даты, входящие в нерабочий период. +// * Представление - Строка - пользовательское представление периода. +// +Функция ПериодыНерабочихДней(ПроизводственныйКалендарь, ПериодОтбор) Экспорт +``` + +Пример вызова +```bsl +Результат = КалендарныеГрафики.ПериодыНерабочихДней(ПроизводственныйКалендарь, ПериодОтбор) +``` +
+ +## ДатыБлижайшихРабочихДней +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать: +// - КалендарныеГрафики.БлижайшиеРабочиеДаты - для производственного календаря, +// - или ГрафикиРаботы.БлижайшиеДатыВключенныеВГрафик - для графика работы. +// Определяет для каждой даты дату ближайшего к ней рабочего дня. +// +// Параметры: +// График - СправочникСсылка.Календари +// - СправочникСсылка.ПроизводственныеКалендари - график или +// производственный календарь, который необходимо использовать для расчета. +// НачальныеДаты - Массив - массив дат (Дата). +// ПолучатьПредшествующие - Булево - способ получения ближайшей даты: +// если Истина - определяются рабочие даты, предшествующие переданным в параметре НачальныеДаты, +// если Ложь - получаются даты не ранее начальной даты. +// ВызыватьИсключение - Булево - если Истина, вызвать исключение в случае незаполненного графика. +// ИгнорироватьНезаполненностьГрафика - Булево - если Истина, то в любом случае будет возвращено соответствие. +// Начальные даты, для которых не будет значений из-за незаполненности графика, включены не будут. +// +// Возвращаемое значение: +// - Соответствие из КлючИЗначение: +// * Ключ - Дата - дата из переданного массива +// * Значение - Дата - ближайшая к ней рабочая дата (если передана рабочая дата, то она же и возвращается). +// Если выбранный график не заполнен, и ВызыватьИсключение = Ложь, возвращается Неопределено +// - Неопределено +// +Функция ДатыБлижайшихРабочихДней(График, НачальныеДаты, ПолучатьПредшествующие = Ложь, ВызыватьИсключение = Истина, Экспорт +``` + +Пример вызова +```bsl +Результат = КалендарныеГрафики.ДатыБлижайшихРабочихДней(График, НачальныеДаты, ПолучатьПредшествующие, ВызыватьИсключение, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КалендарныеГрафикиЛокализация.md b/src/content/docs/bsp/КалендарныеГрафикиЛокализация.md new file mode 100644 index 0000000..19e131c --- /dev/null +++ b/src/content/docs/bsp/КалендарныеГрафикиЛокализация.md @@ -0,0 +1,42 @@ +--- +title: Календарные графики локализация +slug: bsp/календарные-графики-локализация +--- + + +## ПриПолученииДанныхКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Запрашивает файл с данными классификатора календарей. +// Преобразует полученный файл в структуру с таблицами календарей и их данных. +// Если не удалось получить файл классификатора, вызывается исключение. +// +// Параметры: +// ДанныеКлассификатора - Структура: +// * ПроизводственныеКалендари - Структура: +// * ИмяТаблицы - Строка - имя таблицы. +// * Данные - ТаблицаЗначений - преобразованная из XML таблица календарей. +// * ДанныеПроизводственныхКалендарей - Структура: +// * ИмяТаблицы - Строка - имя таблицы. +// * Данные - ТаблицаЗначений - преобразованная из XML таблица данных календарей. +// +Процедура ПриПолученииДанныхКлассификатора(ДанныеКлассификатора) Экспорт +``` + +Пример вызова +```bsl +КалендарныеГрафикиЛокализация.ПриПолученииДанныхКлассификатора(ДанныеКлассификатора) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КалендарныеГрафикиПереопределяемый.md b/src/content/docs/bsp/КалендарныеГрафикиПереопределяемый.md new file mode 100644 index 0000000..b2f9a71 --- /dev/null +++ b/src/content/docs/bsp/КалендарныеГрафикиПереопределяемый.md @@ -0,0 +1,107 @@ +--- +title: Календарные графики переопределяемый +slug: bsp/календарные-графики-переопределяемый +--- + + +## ПриОбновленииПроизводственныхКалендарей +
+ +Описание, пример вызова + +```bsl + +// Вызывается при изменении данных производственных календарей. +// В случае, если разделение включено, выполняется в не разделенном режиме. +// +// Параметры: +// УсловияОбновления - ТаблицаЗначений: +// * КодПроизводственногоКалендаря - Строка - код производственного календаря, данные которого изменились; +// * Год - Число - календарный год, за который изменились данные. +// +Процедура ПриОбновленииПроизводственныхКалендарей(УсловияОбновления) Экспорт +``` + +Пример вызова +```bsl +КалендарныеГрафикиПереопределяемый.ПриОбновленииПроизводственныхКалендарей(УсловияОбновления) +``` +
+ +## ПриОбновленииДанныхЗависимыхОтПроизводственныхКалендарей +
+ +Описание, пример вызова + +```bsl + +// Вызывается при изменении данных, зависимых от производственных календарей. +// В случае, если разделение включено, выполняется в областях данных. +// +// Параметры: +// УсловияОбновления - ТаблицаЗначений: +// * КодПроизводственногоКалендаря - Строка - код производственного календаря, данные которого изменились; +// * Год - Число - календарный год, за который изменились данные. +// +Процедура ПриОбновленииДанныхЗависимыхОтПроизводственныхКалендарей(УсловияОбновления) Экспорт +``` + +Пример вызова +```bsl +КалендарныеГрафикиПереопределяемый.ПриОбновленииДанныхЗависимыхОтПроизводственныхКалендарей(УсловияОбновления) +``` +
+ +## ПриЗаполненииБлокируемыхОбъектовЗависимыхОтПроизводственныхКалендарей +
+ +Описание, пример вызова + +```bsl + +// Вызывается при регистрации отложенного обработчика обновления данных, зависимых от производственных календарей. +// В БлокируемыеОбъекты следует добавить имена метаданных объектов, +// которые следует заблокировать от использования на период обновления производственных календарей. +// +// Параметры: +// БлокируемыеОбъекты - Массив - имена метаданных блокируемых объектов. +// +Процедура ПриЗаполненииБлокируемыхОбъектовЗависимыхОтПроизводственныхКалендарей(БлокируемыеОбъекты) Экспорт +``` + +Пример вызова +```bsl +КалендарныеГрафикиПереопределяемый.ПриЗаполненииБлокируемыхОбъектовЗависимыхОтПроизводственныхКалендарей(БлокируемыеОбъекты) +``` +
+ +## ПриЗаполненииИзменяемыхОбъектовЗависимыхОтПроизводственныхКалендарей +
+ +Описание, пример вызова + +```bsl + +// Вызывается при регистрации отложенного обработчика обновления данных, зависимых от производственных календарей. +// В ИзменяемыеОбъекты следует добавить имена метаданных объектов, +// которые будут изменяться при обновлении производственных календарей. +// +// Параметры: +// ИзменяемыеОбъекты - Массив - имена метаданных изменяемых объектов. +// +Процедура ПриЗаполненииИзменяемыхОбъектовЗависимыхОтПроизводственныхКалендарей(ИзменяемыеОбъекты) Экспорт +``` + +Пример вызова +```bsl +КалендарныеГрафикиПереопределяемый.ПриЗаполненииИзменяемыхОбъектовЗависимыхОтПроизводственныхКалендарей(ИзменяемыеОбъекты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КаталогРасширений.md b/src/content/docs/bsp/КаталогРасширений.md new file mode 100644 index 0000000..eccd999 --- /dev/null +++ b/src/content/docs/bsp/КаталогРасширений.md @@ -0,0 +1,111 @@ +--- +title: Каталог расширений +slug: bsp/каталог-расширений +--- + + +## Используется +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак использования каталога расширений +// +// Возвращаемое значение: +// Булево +Функция Используется() Экспорт +``` + +Пример вызова +```bsl +Результат = КаталогРасширений.Используется() +``` +
+ +## НаименованиеСсылкиКаталогаРасширений +
+ +Описание, пример вызова + +```bsl + +// Возвращает наименование ссылки для перехода в каталог расширений +// +// Возвращаемое значение: +// Строка +Функция НаименованиеСсылкиКаталогаРасширений() Экспорт +``` + +Пример вызова +```bsl +Результат = КаталогРасширений.НаименованиеСсылкиКаталогаРасширений() +``` +
+ +## СостояниеРасширения +
+ +Описание, пример вызова + +```bsl + +// Возвращает актульное состояние расширения +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ПубличныйИдентификатор - Строка - публичный идентификатор расширения из Менеджера сервиса +// +// Возвращаемое значение: +// ПеречислениеСсылка.СостоянияРасширений +Функция СостояниеРасширения(ПубличныйИдентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = КаталогРасширений.СостояниеРасширения(ПубличныйИдентификатор) +``` +
+ +## ИнформацияОбОценкеПользователя +
+ +Описание, пример вызова + +```bsl + + +// Информация об оценке пользователя. +// +// Параметры: +// ПубличныйИдентификатор - Строка - публичный идентификатор расширения из Менеджера сервиса +// +// Возвращаемое значение: +// Структура - Информация об оценке пользователя: +// * ОценкаВыставлена - Булево - флаг того, что пользователь выставил оценку +// * НаименованиеРасширения - Строка - наименование расширения +// * Оценка - Число - числовое представление оценки +// * ДатаСоздания - Дата - дата создания первой оценки +// * ДатаПоследнегоИзменения - Дата - дата последнего изменения оценки +// * Версия - Строка - версия расширения которая была установлена в момент последнего редактирования оценки +// * ОтветРазработчика - Строка - текст ответа разработчика на оценку +// * ДатаОтветаРазработчика - Дата - дата ответа разработчика на оценку +// * ОшибкаПолученияДанных - Структура - если при получении данных произошла ошибка, тогда данное свойство существует: +// ** ТекстОшибки - Строка - текст информации об ошибке +Функция ИнформацияОбОценкеПользователя(ПубличныйИдентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = КаталогРасширений.ИнформацияОбОценкеПользователя(ПубличныйИдентификатор) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КаталогРасширенийКлиент.md b/src/content/docs/bsp/КаталогРасширенийКлиент.md new file mode 100644 index 0000000..d846f34 --- /dev/null +++ b/src/content/docs/bsp/КаталогРасширенийКлиент.md @@ -0,0 +1,87 @@ +--- +title: Каталог расширений клиент +slug: bsp/каталог-расширений-клиент +--- + + +## ОткрытьОбъектРасширения +
+ +Описание, пример вызова + +```bsl + +// Открывает форму объекта расширения из каталога расширений +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ПубличныйИдентификатор - Строка - публичный идентификатор расширения из Менеджера сервиса +// ОписаниеОповещения - ОписаниеОповещения - необязательный, позволяет обработать закрытие формы. +// Процедура, которая будет обрабатывать вызов описания оповещения, в качестве первого параметра будет получать +// значение типа "ПеречислениеСсылка.СостоянияРасширений", описывающее состояние расширения в момент закрытия формы +// (подробности см. в описании метода "ОткрытьФорму" глобального контекста). +// +Процедура ОткрытьОбъектРасширения(Знач ПубличныйИдентификатор, Знач ОписаниеОповещения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КаталогРасширенийКлиент.ОткрытьОбъектРасширения(ПубличныйИдентификатор, ОписаниеОповещения); +``` +
+ +## ОткрытьКаталогРасширений +
+ +Описание, пример вызова + +```bsl + +// Открывает каталог расширений. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ОткрытьКаталогРасширений() Экспорт +``` + +Пример вызова +```bsl +КаталогРасширенийКлиент.ОткрытьКаталогРасширений() +``` +
+ +## ПредложитьПользователюОценитьРасширение +
+ +Описание, пример вызова + +```bsl + +// Предложить пользователю оценить расширение. +// Использовать можно только после успешного вызова КаталогРасширений.ИнформацияОбОценкеПользователя. +// Полученный результат необходимо проанализировать и в случае необходимости вызвать +// КаталогРасширенийКлиент.ПредложитьПользователюОценитьРасширение. +// При вызове данной процедуры пользователю будет показан вопрос с тремя +// вариантами ответа: "Оценить", "Оценить позже", "Больше не предлагать". +// Если пользователь ранее уже выбрал ответ "Больше не предлагать", диалог вопроса не появится. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ПубличныйИдентификатор - Строка - публичный идентификатор расширения из Менеджера сервиса +// ТекстПредложения - Строка - текст предложения показываемый пользователю. +// Если текст не задан, будет использоваться стандартный +Процедура ПредложитьПользователюОценитьРасширение(ПубличныйИдентификатор, ТекстПредложения = "") Экспорт +``` + +Пример вызова +```bsl +КаталогРасширенийКлиент.ПредложитьПользователюОценитьРасширение(ПубличныйИдентификатор, ТекстПредложения); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КонструкторФормул.md b/src/content/docs/bsp/КонструкторФормул.md new file mode 100644 index 0000000..53fd804 --- /dev/null +++ b/src/content/docs/bsp/КонструкторФормул.md @@ -0,0 +1,414 @@ +--- +title: Конструктор формул +slug: bsp/конструктор-формул +--- + + +## ДобавитьСписокПолейНаФорму +
+ +Описание, пример вызова + +```bsl + +// Создает на форме иерархический список с заданным составом полей и строкой поиска. +// В качестве источника полей используется одна или несколько коллекций доступных полей компоновки данных. +// Для полей ссылочного типа имеется возможность разворачивания на неограниченное количество уровней. +// Для любого поля в списке, в том числе для полей простых типов, имеется возможность дополнения и переопределения +// списка дочерних полей. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой требуется добавить список. +// Параметры - см. ПараметрыДобавленияСпискаПолей +// +Процедура ДобавитьСписокПолейНаФорму(Форма, Параметры) Экспорт +``` + +Пример вызова +```bsl +КонструкторФормул.ДобавитьСписокПолейНаФорму(Форма, Параметры) +``` +
+ +## ПараметрыДобавленияСпискаПолей +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра Параметры процедуры ДобавитьСписокПолейНаФорму. +// +// Возвращаемое значение: +// Структура: +// * МестоРазмещенияСписка - ГруппаФормы +// - ТаблицаФормы +// - ФормаКлиентскогоПриложения +// * ИспользоватьФоновыйПоиск - Булево +// * КоличествоСимволовДляНачалаПоиска - Число +// * ИмяСписка - Строка +// * КоллекцииПолей - Массив из ДоступныеПоляКомпоновкиДанных +// * МестоРазмещенияСтрокиПоиска - ГруппаФормы +// - ТаблицаФормы +// - ФормаКлиентскогоПриложения +// * ПодсказкаВводаСтрокиПоиска - Строка +// * ОбработчикиСписка - Структура +// * ВключатьГруппыВПутьКДанным - Булево +// * СкобкиИдентификаторов - Булево +// * СкобкиПредставлений - Булево +// * ИсточникиДоступныхПолей - ТаблицаЗначений - используется в случае, когда требуется изменить состав подчиненных +// полей у любого поля: +// ** ИсточникДанных - Строка - описание поля в дереве полей, может быть в виде пути в дереве, либо в виде +// имени объекта метаданных. +// Источник может быть указан в виде шаблона, в котором символ "*" обозначает несколько +// произвольных символов. +// Например, +// "*.Наименование" - добавить коллекцию дочерних полей к полям "Наименование", +// "Справочник.Организации" - добавить коллекцию дочерних полей ко всем полям +// типа Организации. +// ** КоллекцияПолей - ДоступныеПоляКомпоновкиДанных - дочерние поля источника данных. +// ** Замещать - Булево - если Истина, то список подчиненных полей будет замещен, если Ложь - дополнен. +// * ИспользоватьИдентификаторыДляФормул - Булево +// * ИмяОсновногоИсточника - Строка - имя объекта метаданных источника полей. +// +Функция ПараметрыДобавленияСпискаПолей() Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормул.ПараметрыДобавленияСпискаПолей() +``` +
+ +## ТаблицаПолей +
+ +Описание, пример вызова + +```bsl + +// Конструктор списка полей для процедуры ДобавитьСписокПолейНаФорму. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Идентификатор - Строка +// * Представление - Строка +// * ТипЗначения - ОписаниеТипов +// * Картинка - Строка +// * Порядок - Число +// +Функция ТаблицаПолей() Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормул.ТаблицаПолей() +``` +
+ +## ДеревоПолей +
+ +Описание, пример вызова + +```bsl + +// Конструктор списка полей для процедуры ДобавитьСписокПолейНаФорму. +// +// Возвращаемое значение: +// ДеревоЗначений: +// * Идентификатор - Строка +// * Представление - Строка +// * ТипЗначения - ОписаниеТипов +// * ИмяКартинки - Строка +// * Порядок - Число +// +Функция ДеревоПолей() Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормул.ДеревоПолей() +``` +
+ +## КоллекцияПолей +
+ +Описание, пример вызова + +```bsl + +// Конструктор списка полей для процедуры ДобавитьСписокПолейНаФорму. +// Преобразует исходную коллекцию полей в коллекцию доступных полей компоновки данных. +// +// Параметры: +// ИсточникПолей - см. ТаблицаПолей +// - ДеревоЗначений - см. ДеревоПолей +// - СхемаКомпоновкиДанных - список полей будет взят из коллекции ДоступныеПоляОтбора +// компоновщика настроек. Имя коллекции может быть переопределено +// в параметре ИмяКоллекцииСКД. +// - Строка - адрес во временном хранилище значения вышеперечисленного типа. +// ИмяКоллекцииСКД - Строка - имя коллекции полей в компоновщике настроек. Параметр необходимо использовать, если в +// параметре ИсточникПолей передана схема компоновки данных. +// Значение по умолчанию - ДоступныеПоляОтбора. +// +// Возвращаемое значение: +// ДоступныеПоляКомпоновкиДанных +// +Функция КоллекцияПолей(ИсточникПолей, Знач ИмяКоллекцииСКД = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормул.КоллекцияПолей(ИсточникПолей, ИмяКоллекцииСКД); +``` +
+ +## ОбновитьКоллекцииПолей +
+ +Описание, пример вызова + +```bsl + +// Используется в случае изменения состава полей, выводимых подключаемом списке. +// Перезаполняет указанный список из переданной коллекции полей. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// КоллекцииПолей - Массив из ДоступныеПоляКомпоновкиДанных +// ИмяСпискаПолей - Строка - имя списка на форме, в котором требуется обновление полей. +// +Процедура ОбновитьКоллекцииПолей(Форма, КоллекцииПолей, ИмяСпискаПолей = "ДоступныеПоля") Экспорт +``` + +Пример вызова +```bsl +КонструкторФормул.ОбновитьКоллекцииПолей(Форма, КоллекцииПолей, ИмяСпискаПолей); +``` +
+ +## ЗаполнитьСписокДоступныхПолей +
+ +Описание, пример вызова + +```bsl + +// Обработчик события разворачивания подключаемого списка на форме. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// ПараметрыЗаполнения - Структура +// +Процедура ЗаполнитьСписокДоступныхПолей(Форма, ПараметрыЗаполнения) Экспорт +``` + +Пример вызова +```bsl +КонструкторФормул.ЗаполнитьСписокДоступныхПолей(Форма, ПараметрыЗаполнения) +``` +
+ +## ВыполнитьПоискВСпискеПолей +
+ +Описание, пример вызова + +```bsl + +// Обработчик события изменения текста редактирования поля поиска подключаемого списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// +Процедура ВыполнитьПоискВСпискеПолей(Форма) Экспорт +``` + +Пример вызова +```bsl +КонструкторФормул.ВыполнитьПоискВСпискеПолей(Форма) +``` +
+ +## ОбработчикКонструктораФормул +
+ +Описание, пример вызова + +```bsl + +// Универсальный обработчик в клиентском контексте. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// Параметр - Произвольный +// ДополнительныеПараметры - Структура: +// * КлючОперации - Строка - выполняемая операция. +// +Процедура ОбработчикКонструктораФормул(Форма, Параметр, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +КонструкторФормул.ОбработчикКонструктораФормул(Форма, Параметр, ДополнительныеПараметры) +``` +
+ +## СписокОператоров +
+ +Описание, пример вызова + +```bsl + +// Подготавливает стандартный список операторов требуемых видов. +// +// Параметры: +// ГруппыОператоров - Строка - перечисление требуемых видов операторов. Возможные значения: +// Разделители, Операторы, ЛогическиеОператорыИКонстанты, +// ЧисловыеФункции, СтроковыеФункции, ПрочиеФункции, +// ОперацииНадСтрокамиСКД, ОперацииСравненияСКД, ЛогическиеОперацииСКД, +// АгрегатныеФункцииСКД, ВсеОператорыСКД. +// +// Возвращаемое значение: +// ДеревоЗначений +// +Функция СписокОператоров(ГруппыОператоров = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормул.СписокОператоров(ГруппыОператоров); +``` +
+ +## ПредставлениеФормулы +
+ +Описание, пример вызова + +```bsl + +// Формирует представление формулы на текущем языке пользователя. +// Операнды и операторы в тексте формулы заменяются на их представления. +// +// Параметры: +// ПараметрыФормулы - см. ПараметрыРедактированияФормулы +// +// Возвращаемое значение: +// Строка +// +Функция ПредставлениеФормулы(ПараметрыФормулы) Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормул.ПредставлениеФормулы(ПараметрыФормулы) +``` +
+ +## ПредставлениеФормулыПоДаннымФормы +
+ +Описание, пример вызова + +```bsl + +// Формирует представление формулы на текущем языке пользователя. +// Операнды и операторы в тексте формулы заменяются на их представления. +// Для использования в форме со встроенными списками операндов (см. ДобавитьСписокПолейНаФорму). +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// Формула - Строка +// +// Возвращаемое значение: +// Строка +// +Функция ПредставлениеФормулыПоДаннымФормы(Форма, Формула) Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормул.ПредставлениеФормулыПоДаннымФормы(Форма, Формула) +``` +
+ +## ПараметрыРедактированияФормулы +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра ПараметрыФормулы для функции ПредставлениеФормулы. +// +// Возвращаемое значение: +// Структура: +// * Формула - Строка +// * Операнды - Строка - адрес во временном хранилище коллекции операндов. Коллекция может быть одного из трех типов: +// ТаблицаЗначений - см. ТаблицаПолей +// ДеревоЗначений - см. ДеревоПолей +// СхемаКомпоновкиДанных - список операндов будет взят из коллекции ДоступныеПоляОтбора +// компоновщика настроек. Имя коллекции может быть переопределено +// в параметре ИмяКоллекцииСКД. +// * Операторы - Строка - адрес во временном хранилище коллекции операторов. Коллекция может быть одного из трех типов: +// ТаблицаЗначений - см. ТаблицаПолей +// ДеревоЗначений - см. ДеревоПолей +// СхемаКомпоновкиДанных - список операндов будет взят из коллекции ДоступныеПоляОтбора +// компоновщика настроек. Имя коллекции может быть переопределено +// в параметре ИмяКоллекцииСКД. +// * ИмяКоллекцииСКДОперандов - Строка - имя коллекции полей в компоновщике настроек. Параметр необходимо +// использовать, если в параметре Операнды передана схема компоновки данных. +// Значение по умолчанию - ДоступныеПоляОтбора. +// * ИмяКоллекцииСКДОператоров - Строка - имя коллекции полей в компоновщике настроек. Параметр необходимо +// использовать, если в параметре Операторы передана схема компоновки данных. +// Значение по умолчанию - ДоступныеПоляОтбора. +// * Наименование - Неопределено - наименование не используется для формулы, соответствующее поле не выводится. +// - Строка - наименование формулы. Если заполнено или пустое, соответствующее поле выводится +// на в форме конструктора. +// * СкобкиОперандов - Булево - выводить операнды формулы в квадратных скобках. +// +Функция ПараметрыРедактированияФормулы() Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормул.ПараметрыРедактированияФормулы() +``` +
+ +## ФормулаИзПредставления +
+ +Описание, пример вызова + +```bsl + +// Заменяет представления операндов формулы на идентификаторы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой размещены списки операторов и операндов. +// ПредставлениеФормулы - Строка - формула. +// +// Возвращаемое значение: +// Строка +// +Функция ФормулаИзПредставления(Форма, ПредставлениеФормулы) Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормул.ФормулаИзПредставления(Форма, ПредставлениеФормулы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КонструкторФормулКлиент.md b/src/content/docs/bsp/КонструкторФормулКлиент.md new file mode 100644 index 0000000..4ad9057 --- /dev/null +++ b/src/content/docs/bsp/КонструкторФормулКлиент.md @@ -0,0 +1,229 @@ +--- +title: Конструктор формул клиент +slug: bsp/конструктор-формул-клиент +--- + + +## НачатьРедактированиеФормулы +
+ +Описание, пример вызова + +```bsl + +// Открывает конструктор формул. +// +// Параметры: +// Параметры - см. ПараметрыРедактированияФормулы +// ОбработчикЗавершения - ОписаниеОповещения +// +Процедура НачатьРедактированиеФормулы(Параметры, ОбработчикЗавершения) Экспорт +``` + +Пример вызова +```bsl +КонструкторФормулКлиент.НачатьРедактированиеФормулы(Параметры, ОбработчикЗавершения) +``` +
+ +## ПараметрыРедактированияФормулы +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра ПараметрыФормулы для функции ПредставлениеФормулы. +// +// Возвращаемое значение: +// Структура: +// * Формула - Строка +// * Операнды - Строка - адрес во временном хранилище коллекции операндов. Коллекция может быть одного из трех типов: +// ТаблицаЗначений - см. ТаблицаПолей +// ДеревоЗначений - см. ДеревоПолей +// СхемаКомпоновкиДанных - список операндов будет взят из коллекции ДоступныеПоляОтбора +// компоновщика настроек. Имя коллекции может быть переопределено +// в параметре ИмяКоллекцииСКД. +// * Операторы - Строка - адрес во временном хранилище коллекции операторов. Коллекция может быть одного из трех типов: +// ТаблицаЗначений - см. ТаблицаПолей +// ДеревоЗначений - см. ДеревоПолей +// СхемаКомпоновкиДанных - список операндов будет взят из коллекции ДоступныеПоляОтбора +// компоновщика настроек. Имя коллекции может быть переопределено +// в параметре ИмяКоллекцииСКД. +// * ИмяКоллекцииСКДОперандов - Строка - имя коллекции полей в компоновщике настроек. Параметр необходимо +// использовать, если в параметре Операнды передана схема компоновки данных. +// Значение по умолчанию - ДоступныеПоляОтбора. +// * ИмяКоллекцииСКДОператоров - Строка - имя коллекции полей в компоновщике настроек. Параметр необходимо +// использовать, если в параметре Операторы передана схема компоновки данных. +// Значение по умолчанию - ДоступныеПоляОтбора. +// * Наименование - Неопределено - наименование не используется для формулы, соответствующее поле не выводится. +// - Строка - наименование формулы. Если заполнено или пустое, соответствующее поле выводится +// на в форме конструктора. +// * ДляЗапроса - Булево - формула предназначена для вставки в запрос. Данный параметр влияет на состав операторов +// по умолчанию, а также на выбор алгоритма проверки формулы. +// +Функция ПараметрыРедактированияФормулы() Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормулКлиент.ПараметрыРедактированияФормулы() +``` +
+ +## СписокПолейПередРазворачиванием +
+ +Описание, пример вызова + +```bsl + +// Обработчик разворачивания подключаемого списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - владелец списка. +// Элемент - ТаблицаФормы - список, в котором выполняется разворачивание строки. +// Строка - Число - идентификатор строки списка. +// Отказ - Булево - признак отказа от разворачивания. +// +Процедура СписокПолейПередРазворачиванием(Форма, Элемент, Строка, Отказ) Экспорт +``` + +Пример вызова +```bsl +КонструкторФормулКлиент.СписокПолейПередРазворачиванием(Форма, Элемент, Строка, Отказ) +``` +
+ +## РазвернутьТекущийЭлементСпискаПолей +
+ +Описание, пример вызова + +```bsl + +// Обработчик разворачивания подключаемого списка. +// Разворачивает текущий элемент списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// +Процедура РазвернутьТекущийЭлементСпискаПолей(Форма) Экспорт +``` + +Пример вызова +```bsl +КонструкторФормулКлиент.РазвернутьТекущийЭлементСпискаПолей(Форма) +``` +
+ +## СписокПолейНачалоПеретаскивания +
+ +Описание, пример вызова + +```bsl + +// Обработчик перетаскивания подключаемого списка +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - владелец списка. +// Элемент - ТаблицаФормы - список, в котором выполняется перетаскивание. +// ПараметрыПеретаскивания - ПараметрыПеретаскивания - содержит перетаскиваемое значение, тип действия +// и возможные действия при перетаскивании. +// Выполнение - Булево - если Ложь, перетаскивание не начнется. +// +Процедура СписокПолейНачалоПеретаскивания(Форма, Элемент, ПараметрыПеретаскивания, Выполнение) Экспорт +``` + +Пример вызова +```bsl +КонструкторФормулКлиент.СписокПолейНачалоПеретаскивания(Форма, Элемент, ПараметрыПеретаскивания, Выполнение) +``` +
+ +## ВыбранноеПолеВСпискеПолей +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание текущего выбранного поля подключаемого списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - владелец списка. +// ИмяСпискаПолей - Строка - имя списка, установленное при вызове КонструкторФормул.ДобавитьСписокПолейНаФорму. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка +// * Заголовок - Строка +// * ПутьКДанным - Строка +// * ПредставлениеПутиКДанным - Строка +// * Тип - ОписаниеТипов +// * Родитель - см. ВыбранноеПолеВСпискеПолей +// +Функция ВыбранноеПолеВСпискеПолей(Форма, ИмяСпискаПолей = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КонструкторФормулКлиент.ВыбранноеПолеВСпискеПолей(Форма, ИмяСпискаПолей); +``` +
+ +## СтрокаПоискаИзменениеТекстаРедактирования +
+ +Описание, пример вызова + +```bsl + +// Обработчик события строки поиска подключаемого списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - владелец списка. +// Элемент - ПолеФормы - строка поиска. +// Текст - Строка - текст в строке поиска. +// СтандартнаяОбработка - Булево - если Ложь, стандартное действие выполнено не будет. +// +Процедура СтрокаПоискаИзменениеТекстаРедактирования(Форма, Элемент, Текст, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +КонструкторФормулКлиент.СтрокаПоискаИзменениеТекстаРедактирования(Форма, Элемент, Текст, СтандартнаяОбработка) +``` +
+ +## СтрокаПоискаОчистка +
+ +Описание, пример вызова + +```bsl + +// Обработчик события строки поиска подключаемого списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - владелец списка. +// Элемент - КнопкаФормы - кнопка очистки. +// УдалитьСтандартнаяОбработка - Булево - параметр устарел +// +Процедура СтрокаПоискаОчистка(Форма, Элемент, УдалитьСтандартнаяОбработка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонструкторФормулКлиент.СтрокаПоискаОчистка(Форма, Элемент, УдалитьСтандартнаяОбработка); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КонтрольВеденияУчета.md b/src/content/docs/bsp/КонтрольВеденияУчета.md new file mode 100644 index 0000000..e5255fe --- /dev/null +++ b/src/content/docs/bsp/КонтрольВеденияУчета.md @@ -0,0 +1,867 @@ +--- +title: Контроль ведения учета +slug: bsp/контроль-ведения-учета +--- + + +## ВыполнитьПроверку +
+ +Описание, пример вызова + +```bsl + +// Выполняет указанную проверку ведения учета с заданными параметрами. +// +// Параметры: +// Проверка - СправочникСсылка.ПравилаПроверкиУчета +// - Строка - правило проверки, +// которая будет выполняться либо строковый идентификатор указанного правила. +// ПараметрыВыполненияПроверки - Структура +// - Массив - произвольные дополнительные параметры проверки, +// которые уточняют, что и как именно проверять. +// См. КонтрольВеденияУчета.ПараметрыВыполненияПроверки. +// - Структура: +// * Свойство1 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - первое значение параметра. +// * Свойство2 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - второе значение параметра. +// * Свойство3 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - третье значение параметра. +// ... +// - Массив - несколько параметров проверки (элементы массива типа Структура, как описано выше). +// ПроверяемыеОбъекты - ЛюбаяСсылка - если передано, то проверка будет выполнена только для данного объекта. +// Проверка должна поддерживать выборочную проверку и у нее должно быть +// установлено свойство ПоддерживаетВыборочнуюПроверку в значение Истина. +// см. КонтрольВеденияУчетаПереопределяемый.ПриОпределенииПроверок. +// - Массив - ссылки на объекты, которые требуется проверить. +// +// Пример: +// 1. Проверка = КонтрольВеденияУчета.ПроверкаПоИдентификатору("ПроверитьСсылочнуюЦелостность"); +// КонтрольВеденияУчета.ВыполнитьПроверку(Проверка); +// 2. ПараметрыВыполненияПроверки = Новый Массив; +// Параметр1 = КонтрольВеденияУчета.ПараметрыВыполненияПроверки("ЗакрытиеМесяца", Организация1, ЗакрываемыйМесяц); +// ПараметрыВыполненияПроверки.Добавить(Параметр1); +// Параметр2 = КонтрольВеденияУчета.ПараметрыВыполненияПроверки("ЗакрытиеМесяца", Организация2, ЗакрываемыйМесяц); +// ПараметрыВыполненияПроверки.Добавить(Параметр2); +// ВыполнитьПроверку("ПроверитьПроведениеДокументов", ПараметрыВыполненияПроверки); +// +Процедура ВыполнитьПроверку(Знач Проверка, Знач ПараметрыВыполненияПроверки = Неопределено, ПроверяемыеОбъекты = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчета.ВыполнитьПроверку(Проверка, ПараметрыВыполненияПроверки, ПроверяемыеОбъекты); +``` +
+ +## ВыполнитьПроверкиВКонтексте +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверки по заданному контексту - общему признаку, связывающему воедино пакет проверок. +// Если указанный признак установлен у группы проверок, то выполняются все проверки этой группы. +// В этом случае наличие (или отсутствие) указанного признака у самой проверки значения не имеет. +// Проверки с флагом Использование, установленным в значение Ложь, пропускаются. +// +// Параметры: +// КонтекстПроверокВеденияУчета - ОпределяемыйТип.КонтекстПроверокВеденияУчета - контекст выполняемых проверок. +// +// Пример: +// КонтрольВеденияУчета.ВыполнитьПроверкиВКонтексте(Перечисления.ХозяйственныеОперации.ЗакрытиеМесяца); +// +Процедура ВыполнитьПроверкиВКонтексте(КонтекстПроверокВеденияУчета) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчета.ВыполнитьПроверкиВКонтексте(КонтекстПроверокВеденияУчета) +``` +
+ +## СводнаяИнформацияПоВидамПроверок +
+ +Описание, пример вызова + +```bsl + +// Возвращает сводку по количеству выявленных проблем указанного вида проверки. +// +// Параметры: +// ВидПроверок - СправочникСсылка.ВидыПроверок - ссылка на вид проверки. +// - Строка - строковый идентификатор вида проверки. +// - Массив из Строка - строковые идентификаторы вида проверки. +// ПоискПоТочномуСоответствию - Булево - регулирует возможности точности. Если Истина, то поиск ведется +// по переданным свойствам на равенство, остальные свойства должны быть равны +// Неопределено (табличная часть дополнительных свойств должна быть пуста). +// Если Ложь, то значения остальных свойств могут быть произвольными, главное +// чтобы соответствующие свойства были равны свойствам структуры. По умолчанию Истина. +// УчитыватьОтветственного - Булево - если Истина, то учитываются только проблемы с незаполненным ответственным +// и те, за которые ответственный текущий пользователь. +// По умолчанию - Ложь. +// +// Возвращаемое значение: +// Структура: +// * Количество - Число - общее количество найденных проблем. +// * ЕстьОшибки - Булево - признак того, имеются ли ошибки среди найденных проблем (с важностью "Ошибка"). +// +// Пример: +// 1) Результат = СводнаяИнформацияПоВидамПроверок("СистемныеПроверки"); +// 2) ВидПроверок = Новый Массив; +// ВидПроверок.Добавить("ЗакрытиеМесяца"); +// ВидПроверок.Добавить(Организация); +// ВидПроверок.Добавить(МесяцЗакрытия); +// Результат = СводнаяИнформацияПоВидамПроверок(ВидПроверок); +// +Функция СводнаяИнформацияПоВидамПроверок(ВидПроверок = Неопределено, ПоискПоТочномуСоответствию = Истина, УчитыватьОтветственного = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.СводнаяИнформацияПоВидамПроверок(ВидПроверок, ПоискПоТочномуСоответствию, УчитыватьОтветственного); +``` +
+ +## ПодробнаяИнформацияПоВидамПроверок +
+ +Описание, пример вызова + +```bsl + +// Возвращает подробные сведения о выявленных проблемах одного или нескольких интересующих видов проверки. +// +// Параметры: +// ВидПроверок - СправочникСсылка.ВидыПроверок - ссылка на вид проверки. +// - Строка - строковый идентификатор вида проверки. +// - Массив из Строка - строковые идентификаторы вида проверки. +// ПоискПоТочномуСоответствию - Булево - если Истина, то вид проверки определяется по точному соответствию со +// всеми переданными значениям свойств в параметре ВидПроверок (см. пример № 2). +// Если Ложь, то вид проверки определяется по указанным значениям свойств +// ИС любыми значениями неуказанных свойств в параметре ВидПроверок (см. пример № 3). +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ПроблемныйОбъект - ЛюбаяСсылка - ссылка на объект, с которым связана проблема. +// * ВажностьПроблемы - ПеречислениеСсылка.ВажностьПроблемыУчета - важность проблемы учета +// "Информация", "Предупреждение", "Ошибка", "ПолезныйСовет" и "ВажнаяИнформация". +// * ПравилоПроверки - СправочникСсылка.ПравилаПроверкиУчета - выполненная проверка с описанием проблемы. +// * ВидПроверок - СправочникСсылка.ВидыПроверок - вид проверки. +// * УточнениеПроблемы - Строка - текстовое уточнение найденной проблемы. +// * Ответственный - СправочникСсылка.Пользователи - заполнен, если по выявленной проблеме +// алгоритм проверки определил конкретного ответственного. +// * Выявлено - Дата - дата и время выявления проблемы. +// * ДополнительнаяИнформация - ХранилищеЗначения - произвольные дополнительные сведения, связанные +// с выявленной проблемой. +// +// Пример: +// 1) Результат = ПодробнаяИнформацияПоВидамПроверок("СистемныеПроверки"); +// 2) ВидПроверок = Новый Массив; +// ВидПроверок.Добавить("ЗакрытиеМесяца"); +// ВидПроверок.Добавить(Организация); +// ВидПроверок.Добавить(МесяцЗакрытия); +// Результат = ПодробнаяИнформацияПоВидамПроверок(ВидПроверок); +// 3) Выбрать все проблемы закрытия месяца по всем периодам для указанной организации: +// ВидПроверок = Новый Массив; +// ВидПроверок.Добавить("ЗакрытиеМесяца"); +// ВидПроверок.Добавить(Организация); +// Результат = ПодробнаяИнформацияПоВидамПроверок(ВидПроверок, Ложь); +// +Функция ПодробнаяИнформацияПоВидамПроверок(ВидПроверок, ПоискПоТочномуСоответствию = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.ПодробнаяИнформацияПоВидамПроверок(ВидПроверок, ПоискПоТочномуСоответствию); +``` +
+ +## ПроверкаПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Возвращает проверку по переданному идентификатору. +// +// Параметры: +// Идентификатор - Строка - строковый идентификатор проверки. Например, "ПроверитьСсылочнуюЦелостность". +// +// Возвращаемое значение: +// СправочникСсылка.ПравилаПроверкиУчета - ссылка на проверку или пустая ссылка, +// если проверка с таким идентификатором не существует. +// +Функция ПроверкаПоИдентификатору(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.ПроверкаПоИдентификатору(Идентификатор) +``` +
+ +## КоличествоПроблемПоОбъекту +
+ +Описание, пример вызова + +```bsl + +// Возвращает количество проблем, выявленных у переданного объекта. +// +// Параметры: +// ПроблемныйОбъект - ЛюбаяСсылка - объект, для которого нужно вычислить количество проблем. +// +// Возвращаемое значение: +// Число +// +Функция КоличествоПроблемПоОбъекту(ПроблемныйОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.КоличествоПроблемПоОбъекту(ПроблемныйОбъект) +``` +
+ +## КоличествоПроблемПоПравилуПроверки +
+ +Описание, пример вызова + +```bsl + +// Вычисляет количество проблем, выявленных переданным правилом проверки. +// +// Параметры: +// ПравилоПроверки - СправочникСсылка.ПравилаПроверкиУчета - правило, для которого +// нужно вычислить количество проблем. +// +// Возвращаемое значение: +// Число +// +Функция КоличествоПроблемПоПравилуПроверки(ПравилоПроверки) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.КоличествоПроблемПоПравилуПроверки(ПравилоПроверки) +``` +
+ +## ПроблемныеОбъекты +
+ +Описание, пример вызова + +```bsl + +// Возвращает проблемные объекты, выявленные указанным правилом проверки. +// +// Параметры: +// ПравилоПроверки - СправочникСсылка.ПравилаПроверкиУчета +// Параметры - см. ПараметрыВыборкиПроблемныхОбъектов +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ПроблемныйОбъект - ЛюбаяСсылка +// * ПравилоПроверки - СправочникСсылка.ПравилаПроверкиУчета +// * ВидПроверки - СправочникСсылка.ВидыПроверок +// * КлючУникальности - УникальныйИдентификатор +// +Функция ПроблемныеОбъекты(Знач ПравилоПроверки, Знач Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.ПроблемныеОбъекты(ПравилоПроверки, Параметры); +``` +
+ +## ПараметрыВыборкиПроблемныхОбъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры выборки проблемных объектов для функции ПроблемныеОбъекты. +// +// Возвращаемое значение: +// Структура: +// * НачальныйПроблемныйОбъект - Неопределено +// * РазмерПорции - Число - по умолчанию 1000. +// * ДополнительныеУсловия - Строка +// * ДополнительныеПараметры - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя параметра запроса. +// ** Значение - Произвольный - значение параметра запроса. +// +Функция ПараметрыВыборкиПроблемныхОбъектов() Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.ПараметрыВыборкиПроблемныхОбъектов() +``` +
+ +## ПараметрыВыполненияПроверки +
+ +Описание, пример вызова + +```bsl + +// Формирует параметры выполнения проверки для передачи в процедуры и функции ВыполнитьПроверку, ОписаниеПроблемы, +// ВидПроверки и другие. +// Параметры содержат уточнение, для чего именно требуется выполнить проверку, +// например, проверить закрытие месяца для конкретной организации по конкретному периоду. +// Порядок следования параметров учитывается. +// +// Параметры: +// Параметр1 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - первый параметр проверки. +// Параметр2 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - второй параметр проверки. +// Параметр3 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - третий параметр проверки. +// Параметр4 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - четвертый параметр проверки. +// Параметр5 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - пятый параметр проверки. +// ДругиеПараметры - Массив - другие параметры проверки (элементы типов ЛюбаяСсылка, Булево, Число, Строка, Дата). +// +// Возвращаемое значение: +// Структура: +// * Наименование - Строка - представление вида проверки. +// * Свойство1 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - первый параметр проверки. +// * Свойство2 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - второй параметр проверки. +// * Свойство3 - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - третий параметр проверки. +// ... +// * СвойствоН - ЛюбаяСсылка +// - Булево +// - Число +// - Строка +// - Дата - последний параметр вида проверки. +// +// Пример: +// 1. Параметры = ПараметрыВыполненияПроверки("СистемныеПроверки"); +// 2. Параметры = ПараметрыВыполненияПроверки("ЗакрытиеМесяца", ОрганизацияСсылка, ЗакрываемыйМесяц); +// +Функция ПараметрыВыполненияПроверки(Знач Параметр1, Знач Параметр2 = Неопределено, Знач Параметр3 = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.ПараметрыВыполненияПроверки(Параметр1, Параметр2, Параметр3, ); +``` +
+ +## ОчиститьРезультатыПредыдущихПроверок +
+ +Описание, пример вызова + +```bsl + +// Очищает результаты предыдущих проверок, оставляя только те проблемы, которые были проигнорированы ранее +// (признак ИгнорироватьПроблему = Истина). +// Для непараметрических проверок предыдущие результаты очищаются автоматически, а затем выполняется алгоритм проверки. +// Для проверок с параметрами предварительную очистку предыдущих результатов следует выполнять явно с помощью +// этой процедуры в самом алгоритме проверки. В противном случае, одна и та же проблема будет регистрироваться +// многократно при нескольких последовательных запусках проверки. +// +// Параметры: +// Проверка - СправочникСсылка.ПравилаПроверкиУчета - проверка, +// результаты которой необходимо очистить. +// ПараметрыВыполненияПроверки - см. КонтрольВеденияУчета.ПараметрыВыполненияПроверки +// - Массив - несколько параметров проверки (элементы массива типа Структура, +// как описано выше). +// +Процедура ОчиститьРезультатыПредыдущихПроверок(Знач Проверка, Знач ПараметрыВыполненияПроверки) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчета.ОчиститьРезультатыПредыдущихПроверок(Проверка, ПараметрыВыполненияПроверки) +``` +
+ +## ОписаниеПроблемы +
+ +Описание, пример вызова + +```bsl + +// Формирует описание проблемы для последующей регистрации +// с помощью процедуры КонтрольВеденияУчета.ЗаписатьПроблему в процедуре-обработчике проверки. +// +// Параметры: +// ПроблемныйОбъект - ЛюбаяСсылка - объект, с которым связана выявленная проблема. +// ПараметрыПроверки - Структура - параметры выполняемой проверки, значение которых следует взять из одноименного +// параметра процедуры-обработчика проверки: +// * Проверка - СправочникСсылка.ПравилаПроверкиУчета - выполненная проверку. +// * ВидПроверки - СправочникСсылка.ВидыПроверок - вид проверки, к которому относится выполненная проверка. +// * ВажностьПроблемы - ПеречислениеСсылка.ВажностьПроблемыУчета - важность, с которой следует +// зарегистрировать выявленную проблемы учета: +// Информация, Предупреждение, Ошибка, ПолезныйСовет или ВажнаяИнформация. +// * Идентификатор - Строка - строковый идентификатор проверки. +// * ДатаНачалаПроверки - Дата - пороговая дата, обозначающая границу проверяемых +// объектов (только для объектов с датой). Объекты, дата которых меньше +// указанной, не следует проверять. По умолчанию не заполнено (т.е. проверять все). +// * ЛимитПроблем - Число - количество проверяемых объектов. +// По умолчанию 1000. Если указано 0, то следует проверить все объекты. +// * ВидПроверки - СправочникСсылка.ВидыПроверок - ссылка на вид проверки, к +// которому относится выполненная проверка. +// +// Возвращаемое значение: +// Структура: +// * ПроблемныйОбъект - ЛюбаяСсылка - ссылка на объект-источник проблемы. +// * Проверка - СправочникСсылка.ПравилаПроверкиУчета - ссылка на выполненную проверку. +// Взято из переданной структуры ПараметрыПроверки. +// * ВидПроверки - СправочникСсылка.ВидыПроверок - ссылка на вид проверки, к которому относится +// выполненная проверка. Взято из переданной структуры ПараметрыПроверки +// * ВажностьПроблемы - СправочникСсылка.ВидыПроверок - ссылка на вид проверки, к которому относится +// выполненная проверка. Взято из переданной структуры ПараметрыПроверки. +// * УточнениеПроблемы - Строка - строка уточнения проблемы. По умолчанию не заполнена. +// * КлючУникальности - УникальныйИдентификатор - ключ уникальности проблемы. +// * Выявлено - Дата - момент обнаружения проблемы. +// * ДополнительнаяИнформация - ХранилищеЗначения +// - Неопределено - произвольные дополнительные сведения, связанные +// с выявленной проблемой. По умолчанию Неопределено. +// * Ответственный - СправочникСсылка.Пользователи +// - Неопределено - заполнен, если за проблемный объект +// имеется конкретный ответственный. По умолчанию Неопределено. +// +// Пример: +// Проблема = КонтрольВеденияУчета.ОписаниеПроблемы(ПроблемныйДокумент, ПараметрыПроверки); +// Проблема.ВидПроверки = ВидПроверки; +// Проблема.УточнениеПроблемы = СтроковыеФункцииКлиентСервер.ПодставитьПараметрыВСтроку( +// НСтр("ru = 'По контрагенту ""%1"" имеется непроведенный документ ""%2""'"), Результат.Контрагент, +// ПроблемныйДокумент); +// КонтрольВеденияУчета.ЗаписатьПроблему(Проблема, ПараметрыПроверки); +// +Функция ОписаниеПроблемы(ПроблемныйОбъект, ПараметрыПроверки) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.ОписаниеПроблемы(ПроблемныйОбъект, ПараметрыПроверки) +``` +
+ +## ЗаписатьПроблему +
+ +Описание, пример вызова + +```bsl + +// Записывает результат выполнения проверки. +// +// Параметры: +// Проблема - см. КонтрольВеденияУчета.ОписаниеПроблемы. +// ПараметрыПроверки - см. КонтрольВеденияУчета.ОписаниеПроблемы.ПараметрыПроверки. +// +Процедура ЗаписатьПроблему(Проблема, ПараметрыПроверки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчета.ЗаписатьПроблему(Проблема, ПараметрыПроверки); +``` +
+ +## ИгнорироватьПроблему +
+ +Описание, пример вызова + +```bsl + +// Устанавливает или снимает признак игнорирования проблемы ведения учета. +// При установке параметра Игнорировать в Истина проблема перестает выводиться пользователям в формах объектов +// и отчете о результатах проверок. Например, это полезно, если пользователь решил, что +// обнаруженная проблема не существенна или ей не планируется заниматься. +// При сбросе в значение Ложь проблема вновь становится актуальной. +// +// Параметры: +// ОписаниеПроблемы - Структура: +// * ПроблемныйОбъект - ЛюбаяСсылка - ссылка на объект, с которым связана проблема. +// * ПравилоПроверки - СправочникСсылка.ПравилаПроверкиУчета - выполненная проверка с описанием проблемы. +// * ВидПроверок - СправочникСсылка.ВидыПроверок - вид проверки. +// * УточнениеПроблемы - Строка - текстовое уточнение найденной проблемы. +// * ДополнительнаяИнформация - ХранилищеЗначения - дополнительная информация об игнорируемой проблеме. +// Игнорировать - Булево - устанавливаемое значение для указанной проблемы. +// +Процедура ИгнорироватьПроблему(Знач ОписаниеПроблемы, Знач Игнорировать) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчета.ИгнорироватьПроблему(ОписаниеПроблемы, Игнорировать) +``` +
+ +## ПриСозданииНаСервереФормыСписка +
+ +Описание, пример вызова + +```bsl + +// В форме списка выводит колонку с картинкой, сигнализирующей о наличии проблем с объектами в строках. +// Вызывается из события ПриСозданииНаСервере формы списка. +// У динамических списков должна быть определена основная таблица. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма списка. +// ИменаСписков - Строка - имена динамических списков через запятую. +// ДополнительныеСвойства - Структура +// - Неопределено - дополнительные свойства: +// * ИмяПоляИндикатораПроблем - Строка - имя поля динамического списка, которое +// будет использовано для вывода индикатора +// наличия проблем у объекта. +// +Процедура ПриСозданииНаСервереФормыСписка(Форма, ИменаСписков, ДополнительныеСвойства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчета.ПриСозданииНаСервереФормыСписка(Форма, ИменаСписков, ДополнительныеСвойства); +``` +
+ +## ПриПолученииДанныхНаСервере +
+ +Описание, пример вызова + +```bsl + +// В форме списка выводит колонку с картинкой, сигнализирующей о наличии проблем с объектами в строках. +// Вызывается из события ПриПолученииДанныхНаСервере формы списка. +// +// Параметры: +// Настройки - НастройкиКомпоновкиДанных - содержит копию полных настроек динамического списка. +// Строки - СтрокиДинамическогоСписка - коллекция содержит данные и оформление всех строк, +// получаемых в списке, кроме строк группировок. +// ИмяКлючевогоПоля - Строка - "Ссылка" или заданное имя колонки, содержащую ссылку объекта. +// ДополнительныеСвойства - Структура +// - Неопределено - содержит дополнительные свойства в случае +// необходимости их использования. +// +Процедура ПриПолученииДанныхНаСервере(Настройки, Строки, ИмяКлючевогоПоля = "Ссылка", ДополнительныеСвойства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчета.ПриПолученииДанныхНаСервере(Настройки, Строки, ИмяКлючевогоПоля, ДополнительныеСвойства); +``` +
+ +## ПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// В форме объекта выводит группу с картинкой и надписью, сигнализирующими о наличии проблем с этим объектом. +// Вызывается из события ПриЧтенииНаСервере формы объекта. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта. +// ТекущийОбъект - ДокументОбъект - объект, который будет прочитан. +// - СправочникОбъект +// - ПланОбменаОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - ЗадачаОбъект +// +Процедура ПриЧтенииНаСервере(Форма, ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчета.ПриЧтенииНаСервере(Форма, ТекущийОбъект) +``` +
+ +## ПослеЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Запускает фоновую проверку переданного объекта. +// Выполняются только те проверки, по которым ранее были найдены ошибки и у которых +// установлено свойство ПоддерживаетВыборочнуюПроверку в значение Истина. +// +// Параметры: +// ТекущийОбъект - ДокументОбъект - <ВидОбъектаМетаданных>Объект.<ИмяОбъектаМетаданных>. +// - СправочникОбъект +// - ПланОбменаОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - ЗадачаОбъект +// +Процедура ПослеЗаписиНаСервере(ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчета.ПослеЗаписиНаСервере(ТекущийОбъект) +``` +
+ +## ПодсистемаДоступна +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если есть права на просмотр проблем ведения учета. +// +// Возвращаемое значение: +// Булево +// +Функция ПодсистемаДоступна() Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.ПодсистемаДоступна() +``` +
+ +## ВидыПроверок +
+ +Описание, пример вызова + +```bsl + +// Возвращает виды проверки по переданным параметрам. +// +// Параметры: +// ВидПроверок - Строка +// - Массив из Строка +// - СправочникСсылка.ВидыПроверок - строковый идентификатор вида проверки, +// либо массив строковых идентификаторов, либо ссылка на вид проверки. +// ПоискПоТочномуСоответствию - Булево - регулирует возможности точности. Если Истина, то поиск ведется +// по переданным свойствам на равенство, остальные свойства должны быть равны +// Неопределено (табличная часть дополнительных свойств должна быть пуста). +// Если Ложь, то значения остальных свойств могут быть произвольными, главное +// чтобы соответствующие свойства были равны свойствам структуры. По умолчанию Истина. +// +// Возвращаемое значение: +// Массив - элементы СправочникСсылка.ВидыПроверок, либо пустой массив, если поиск не дал результата. +// При поиска по точному соответствию массив содержит единственный элемент. +// +Функция ВидыПроверок(ВидПроверок, ПоискПоТочномуСоответствию = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.ВидыПроверок(ВидПроверок, ПоискПоТочномуСоответствию); +``` +
+ +## ВидПроверки +
+ +Описание, пример вызова + +```bsl + +// Возвращает существующий или создает новый элемент справочника ВидыПроверок +// для регистрации или отбора результатов ведения учета. +// +// Параметры: +// ПараметрыВыполненияПроверки - Строка - строковый идентификатор вида проверки (Свойство1) +// - Структура - сведения, идентифицирующие вид проверки. +// ТолькоПоиск - Булево - если Истина и вид проверки с заданными параметрами не существует, +// возвращается пустая ссылка; если Ложь, то создается элемент и возвращается ссылка на него. +// +// Возвращаемое значение: +// СправочникСсылка.ВидыПроверок - найденный существующий или созданный элемент справочника. +// В случае если осуществлялся только поиск (параметр ТолькоПоиск = Истина) +// и элемент не был найден, возвращается пустая ссылка на справочник СправочникСсылка.ВидыПроверок. +// +// Пример: +// ВидПроверки = КонтрольВеденияУчета.ВидПроверки("СистемныеПроверки"); +// +Функция ВидПроверки(Знач ПараметрыВыполненияПроверки, Знач ТолькоПоиск = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.ВидПроверки(ПараметрыВыполненияПроверки, ТолькоПоиск); +``` +
+ +## ОбновитьПараметрыПроверокУчета +
+ +Описание, пример вызова + +```bsl + +// Принудительно обновляет состав проверок ведения учета при изменении метаданных +// или иных настроек. +// +Процедура ОбновитьПараметрыПроверокУчета() Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчета.ОбновитьПараметрыПроверокУчета() +``` +
+ +## ПодробнаяИнформацияПоВидамПроверки +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать функцию ПодробнаяИнформацияПоВидамПроверок. +// Возвращает подробные сведения о выявленных проблемах указанного вида проверки. +// +// Параметры: +// ВидПроверок - СправочникСсылка.ВидыПроверок - ссылка на вид проверки. +// - Строка - строковый идентификатор вида проверки. +// - Массив из Строка - строковые идентификаторы вида проверки. +// ПоискПоТочномуСоответствию - Булево - регулирует возможности точности. Если Истина, то поиск ведется +// по переданным свойствам на равенство, остальные свойства должны быть равны +// Неопределено (табличная часть дополнительных свойств должна быть пуста). +// Если Ложь, то значения остальных свойств могут быть произвольными, главное +// чтобы соответствующие свойства были равны свойствам структуры. По умолчанию Истина. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ПроблемныйОбъект - ЛюбаяСсылка - ссылка на объект "Источник" проблем. +// * ПравилоПроверки - СправочникСсылка.ПравилаПроверкиУчета - ссылка на выполненную проверку. +// * УточнениеПроблемы - Строка - строка-уточнение найденной проблемы. +// * ВажностьПроблемы - ПеречислениеСсылка.ВажностьПроблемыУчета - важность проблемы учета +// "Информация", "Предупреждение", "Ошибка" и "ПолезныйСовет". +// * Ответственный - СправочникСсылка.Пользователи - заполнен если есть возможность +// идентифицировать ответственного в проблемном объекте. +// * ДополнительнаяИнформация - ХранилищеЗначения - служебное свойство с дополнительными +// сведениями, связанными с выявленной проблемой. +// * Выявлено - Дата - серверное время идентификации проблемы. +// +// Пример: +// 1) Результат = ПодробнаяИнформацияПоВидамПроверок("СистемныеПроверки"); +// 2) ВидПроверок = Новый Массив; +// ВидПроверок.Добавить("ЗакрытиеМесяца"); +// ВидПроверок.Добавить(Организация); +// ВидПроверок.Добавить(МесяцЗакрытия); +// Результат = ПодробнаяИнформацияПоВидамПроверок(ВидПроверок); +// +Функция ПодробнаяИнформацияПоВидамПроверки(ВидПроверок, ПоискПоТочномуСоответствию = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.ПодробнаяИнформацияПоВидамПроверки(ВидПроверок, ПоискПоТочномуСоответствию); +``` +
+ +## СводнаяИнформацияПоВидамПроверки +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать функцию СводнаяИнформацияПоВидамПроверок. +// Возвращает сводку по количеству выявленных проблем указанного вида проверки. +// +// Параметры: +// ВидПроверок - СправочникСсылка.ВидыПроверок - ссылка на вид проверки. +// - Строка - строковый идентификатор вида проверки. +// - Массив из Строка - строковые идентификаторы вида проверки. +// ПоискПоТочномуСоответствию - Булево - регулирует возможности точности. Если Истина, то поиск ведется +// по переданным свойствам на равенство, остальные свойства должны быть равны +// Неопределено (табличная часть дополнительных свойств должна быть пуста). +// Если Ложь, то значения остальных свойств могут быть произвольными, главное +// чтобы соответствующие свойства были равны свойствам структуры. По умолчанию Истина. +// +// Возвращаемое значение: +// Структура: +// * Количество - Число - общее количество найденных проблем. +// * ЕстьОшибки - Булево - признак того, имеются ли ошибки среди найденных проблем (с важностью "Ошибка"). +// +// Пример: +// 1) Результат = СводнаяИнформацияПоВидамПроверок("СистемныеПроверки"); +// 2) ВидПроверок = Новый Массив; +// ВидПроверок.Добавить("ЗакрытиеМесяца"); +// ВидПроверок.Добавить(Организация); +// ВидПроверок.Добавить(МесяцЗакрытия); +// Результат = СводнаяИнформацияПоВидамПроверок(ВидПроверок); +// +Функция СводнаяИнформацияПоВидамПроверки(ВидПроверок, ПоискПоТочномуСоответствию = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольВеденияУчета.СводнаяИнформацияПоВидамПроверки(ВидПроверок, ПоискПоТочномуСоответствию); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КонтрольВеденияУчетаКлиент.md b/src/content/docs/bsp/КонтрольВеденияУчетаКлиент.md new file mode 100644 index 0000000..763c4cf --- /dev/null +++ b/src/content/docs/bsp/КонтрольВеденияУчетаКлиент.md @@ -0,0 +1,101 @@ +--- +title: Контроль ведения учета клиент +slug: bsp/контроль-ведения-учета-клиент +--- + + +## ОткрытьОтчетПоПроблемам +
+ +Описание, пример вызова + +```bsl + +// Открывает отчет по всем проблемам переданного вида проблем. +// +// Параметры: +// ВидПроверок - СправочникСсылка.ВидыПроверок - ссылка на вид проверки. +// - Строка - строковый идентификатор вида проверки. +// - Массив из Строка - строковые идентификаторы вида проверки. +// ТочноеСоответствие - Булево - если Истина, то делается отбор только по указанному виду проверки, +// если Ложь, то выбираются все виды проверки, которые связаны с переданным. +// +// Пример: +// ОткрытьОтчетПоПроблемам("СистемныеПроверки"); +// +Процедура ОткрытьОтчетПоПроблемам(ВидПроверок, ТочноеСоответствие = Истина) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаКлиент.ОткрытьОтчетПоПроблемам(ВидПроверок, ТочноеСоответствие); +``` +
+ +## ОткрытьОтчетПоПроблемамОбъекта +
+ +Описание, пример вызова + +```bsl + +// Открывает форму отчета при нажатии на гиперссылку, сигнализирующую о наличии проблем. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма проблемного объекта. +// ПроблемныйОбъект - ЛюбаяСсылка - ссылка на проблемный объект. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения +// стандартной (системной) обработки события. +// +// Пример: +// КонтрольВеденияУчетаКлиент.ОткрытьОтчетПоПроблемамОбъекта(ЭтотОбъект, Объект.Ссылка, СтандартнаяОбработка); +// +Процедура ОткрытьОтчетПоПроблемамОбъекта(Форма, ПроблемныйОбъект, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаКлиент.ОткрытьОтчетПоПроблемамОбъекта(Форма, ПроблемныйОбъект, СтандартнаяОбработка) +``` +
+ +## ОткрытьОтчетПоПроблемамИзСписка +
+ +Описание, пример вызова + +```bsl + +// Открывает форму отчета при двойном нажатии на ячейку таблицы формы списка с картинкой, +// сигнализирующей о наличии проблем с выделенным объектом. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма проблемного объекта. +// ИмяСписка - Строка - имя целевого динамического списка как реквизита формы. +// Поле - ПолеФормы - колонка в которой располагается картинка, +// сигнализирующая о наличии проблем. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения +// стандартной (системной) обработки события. +// ДополнительныеПараметры - Структура +// - Неопределено - содержит дополнительные свойства в случае +// необходимости их использования. +// +// Пример: +// КонтрольВеденияУчетаКлиент.ОткрытьОтчетПоПроблемамИзСписка(ЭтотОбъект, "Список", Поле, СтандартнаяОбработка); +// +Процедура ОткрытьОтчетПоПроблемамИзСписка(Форма, ИмяСписка, Поле, СтандартнаяОбработка, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаКлиент.ОткрытьОтчетПоПроблемамИзСписка(Форма, ИмяСписка, Поле, СтандартнаяОбработка, ДополнительныеПараметры); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КонтрольВеденияУчетаПереопределяемый.md b/src/content/docs/bsp/КонтрольВеденияУчетаПереопределяемый.md new file mode 100644 index 0000000..9abc571 --- /dev/null +++ b/src/content/docs/bsp/КонтрольВеденияУчетаПереопределяемый.md @@ -0,0 +1,311 @@ +--- +title: Контроль ведения учета переопределяемый +slug: bsp/контроль-ведения-учета-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Позволяет задать общие настройки подсистемы. +// +// Параметры: +// Настройки - Структура: +// * КартинкаИндикатораПроблем - Картинка - которая будет выводиться в качестве +// индикатора ошибки в колонке динамического списка +// форм списков и на специальной панели форм объектов. +// * ПояснениеИндикатораПроблем - Строка - поясняющая строка к ошибке. +// * ГиперссылкаИндикатораПроблем - Строка - текст гиперссылки, при нажатии на которую, +// будет сформирован и открыт отчет с ошибками. +// +// Пример: +// Настройки = Новый Структура; +// Настройки.Вставить("КартинкаИндикатораПроблем", БиблиотекаКартинок.Предупреждение); +// Настройки.Вставить("ПояснениеИндикатораПроблем", Неопределено); +// Настройки.Вставить("ГиперссылкаИндикатораПроблем", Неопределено); +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриОпределенииПроверок +
+ +Описание, пример вызова + +```bsl + +// Предназначена для подключения собственных правил проверки ведения учета. +// +// Параметры: +// ГруппыПроверок - ТаблицаЗначений - таблица, в которую добавляются группы проверок: +// * Наименование - Строка - наименование группы проверок. +// * ИдентификаторГруппы - Строка - строковый идентификатор группы проверок, например: +// "СистемныеПроверки", "ЗакрытиеМесяца", "ПроверкиНДС" и т.п. +// Обязателен для заполнения. +// * Идентификатор - Строка - строковый идентификатор группы проверок. Обязателен для заполнения. +// Для уникальности формат идентификатора следует выбирать следующим: +// "<Название программного продукта>.<Идентификатор проверки>". +// Например: "СтандартныеПодсистемы.СистемныеПроверки". +// * КонтекстПроверокВеденияУчета - ОпределяемыйТип.КонтекстПроверокВеденияУчета - значение, дополнительно +// уточняющее принадлежность группы проверок ведения учета к определенной +// категории. +// * Комментарий - Строка - комментарий к группе проверок. +// +// Проверки - ТаблицаЗначений - таблица, в которую добавляются проверки: +// * ИдентификаторГруппы - Строка - строковый идентификатор группы проверок, например: +// "СистемныеПроверки", "ЗакрытиеМесяца", "ПроверкиНДС" и т.п. +// Обязателен для заполнения. +// * Наименование - Строка - наименование проверки, выводимое пользователю. +// * Причины - Строка - описание возможных причин, которые приводят к возникновению проблемы. +// * Рекомендация - Строка - рекомендация по решению возникшей проблемы. +// * Идентификатор - Строка - строковый идентификатор элемента. Обязателен для заполнения. +// Формат идентификатора должен быть следующим: +// <Название программного продукта>.<Идентификатор проверки>. Например: +// СтандартныеПодсистемы.СистемныеПроверки. +// * ДатаНачалаПроверки - Дата - пороговая дата, обозначающая границу проверяемых объектов +// (только для объектов с датой, например, документов). Объекты, дата +// которых меньше указанной, не следует проверять. По умолчанию +// не заполнено (т.е. проверять все). +// * ЛимитПроблем - Число - количество проверяемых объектов. По умолчанию 1000. +// Если указан 0, то следует проверять все объекты. +// * ОбработчикПроверки - Строка - имя экспортной процедуры-обработчика серверного общего модуля +// в виде ИмяМодуля.ИмяПроцедуры. +// * ОбработчикПереходаКИсправлению - Строка - имя экспортной процедуры-обработчика клиентского общего модуля +// для перехода к исправлению проблемы в виде "ИмяМодуля.ИмяПроцедуры" +// или полное имя формы, которую следует открыть для исправления проблемы. +// Процедура-обработчик принимает на вход два параметра: +// ПараметрыИсправления - Структура - со свойствами: +// ИдентификаторПроверки - Строка - строковый идентификатор проверки; +// ВидПроверки - СправочникСсылка.ВидыПроверок - вид проверки, +// дополнительно уточняющий область исправления проблемы; +// ДополнительныеПараметры - Неопределено - параметр не используется. +// При открытии формы в нее передаются такие же параметры, как свойства +// указанной выше структуры ПараметрыИсправления. +// * БезОбработчикаПроверки - Булево - признак служебной проверки, которая не имеет процедуры-обработчика. +// * ЗапрещеноИзменениеВажности - Булево - если Истина, то администратор не сможет перенастраивать +// важность данной проверки. +// * КонтекстПроверокВеденияУчета - ОпределяемыйТип.КонтекстПроверокВеденияУчета - значение, дополнительно +// уточняющее принадлежность проверки ведения учета к определенной группе +// или категории. +// * УточнениеКонтекстаПроверокВеденияУчета - ОпределяемыйТип.УточнениеКонтекстаПроверокВеденияУчета - второе значение, +// дополнительно уточняющее принадлежность проверки ведения учета +// к определенной группе или категории. +// * ДополнительныеПараметры - ХранилищеЗначения - произвольная дополнительная информация о проверке +// для программного использования. +// * Комментарий - Строка - текстовый комментарий к проверке. +// * Отключена - Булево - если Истина, то проверка не будет выполняться в фоне по расписанию. +// * ПоддерживаетВыборочнуюПроверку - Булево - если Истина, то проверку можно вызвать для проверки конкретного объекта. +// +// Пример: +// 1) Добавление проверки +// Проверка = Проверки.Добавить(); +// Проверка.ИдентификаторГруппы = "СистемныеПроверки"; +// Проверка.Наименование = НСтр("ru='Демо: Проверка заполнения комментария в документах ""Демо: Поступление товаров""'"); +// Проверка.Причины = НСтр("ru='Не введен комментарий в документе.'"); +// Проверка.Рекомендация = НСтр("ru='Ввести комментарий в документе.'"); +// Проверка.Идентификатор = "ПроверитьКомментарийВПоступленииТоваров"; +// Проверка.ОбработчикПроверки = "СтандартныеПодсистемы.ПроверитьКомментарийВПоступленииТоваров"; +// Проверка.ДатаНачалаПроверки = Дата('20140101000000'); +// Проверка.ЛимитПроблем = 3; +// 2) Добавление группы проверок +// ГруппаПроверок = ГруппыПроверок.Добавить(); +// ГруппаПроверок.Наименование = НСтр("ru='Системные проверки'"); +// ГруппаПроверок.Идентификатор = "СтандартныеПодсистемы.СистемныеПроверки"; +// ГруппаПроверок.КонтекстПроверокВеденияУчета = "СистемныеПроверки"; +// +Процедура ПриОпределенииПроверок(ГруппыПроверок, Проверки) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаПереопределяемый.ПриОпределенииПроверок(ГруппыПроверок, Проверки) +``` +
+ +## ПриОпределенииПараметровГруппыИндикации +
+ +Описание, пример вызова + +```bsl + +// Позволяет настроить положение индикатора о проблемах в формах объектов. +// +// Параметры: +// ПараметрыГруппыИндикации - Структура - выходные параметры индикатора: +// * ВыводитьСнизу - Булево - если указать Истина, то группа индикатора будет выводиться самой последней +// в форме или в конце указанной группе элементов ИмяРодителяГруппы. +// По умолчанию Ложь - группа выводится в начале указанной группе ИмяРодителяГруппы или +// сразу под командной панелью формы объекта. +// * ИмяРодителяГруппы - Строка - определяет имя группы элементов формы объекта, внутри которой должна +// располагаться группа индикации. +// * ДетальныйВид - Булево - если Истина и у объекта найдена только одна проблема, то в карточке будет +// сразу выводиться ее описание вместо гиперссылки с переходом к списку проблем. +// Значение по умолчанию - Ложь. +// +// ТипПроблемногоОбъекта - Тип - тип ссылки, для которой переопределяются параметры группы индикации. +// Например, Тип("ДокументСсылка.НачислениеЗарплаты"). +// +Процедура ПриОпределенииПараметровГруппыИндикации(ПараметрыГруппыИндикации, Знач ТипПроблемногоОбъекта) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаПереопределяемый.ПриОпределенииПараметровГруппыИндикации(ПараметрыГруппыИндикации, ТипПроблемногоОбъекта) +``` +
+ +## ПриОпределенииПараметровКолонкиИндикации +
+ +Описание, пример вызова + +```bsl + +// Позволяет настроить внешний вид и положение колонки-индикатора о проблемах в формах списков +// (с динамическим списком). +// +// Параметры: +// ПараметрыКолонкиИндикации - Структура - выходные параметры индикатора: +// * ВыводитьПоследней - Булево - если указать Истина, то колонка-индикатор будет выводиться в конце. +// По умолчанию Ложь - колонка выводится в начале. +// * ПоложениеЗаголовка - ПоложениеЗаголовкаЭлементаФормы - задает положение заголовка колонки-индикатора. +// * Ширина - Число - ширина колонки-индикатора. +// +// ПолноеИмя - Строка - полное имя объекта основной таблицы динамического списка. +// Например, Метаданные.Документы.НачислениеЗарплаты.ПолноеИмя(). +// +Процедура ПриОпределенииПараметровКолонкиИндикации(ПараметрыКолонкиИндикации, ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаПереопределяемый.ПриОпределенииПараметровКолонкиИндикации(ПараметрыКолонкиИндикации, ПолноеИмя) +``` +
+ +## ПередЗаписьюПроблемы +
+ +Описание, пример вызова + +```bsl + +// Позволяет дозаполнить информацию о проблеме перед ее регистрацией. +// В частности, можно заполнить дополнительные значения для ограничения доступа на уровне записей +// к списку проблем ведения учета. +// +// Параметры: +// Проблема - Структура - сформированная алгоритмом проверки информация о проблеме: +// * ПроблемныйОбъект - ЛюбаяСсылка - объект, по поводу которого записывается проблема. +// Либо ссылка на элемент справочника ИдентификаторыОбъектовМетаданных +// * ПравилоПроверки - СправочникСсылка.ПравилаПроверкиУчета - ссылка на выполненную проверку. +// * ВидПроверки - СправочникСсылка.ВидыПроверок - ссылка на вид проверки, к которому +// относится выполненная проверка. +// * КлючУникальности - УникальныйИдентификатор - ключ уникальности проблемы. +// * УточнениеПроблемы - Строка - строка-уточнение найденной проблемы. +// * ВажностьПроблемы - ПеречислениеСсылка.ВажностьПроблемыУчета - важность проблемы учета +// Информация, Предупреждение, Ошибка, ПолезныйСовет и ВажнаяИнформация. +// * Ответственный - СправочникСсылка.Пользователи - заполнен если есть возможность +// идентифицировать ответственного в проблемном объекте. +// * ИгнорироватьПроблему - Булево - флаг игнорирования проблемы. Если имеет значение "Истина", +// запись о проблеме игнорируется подсистемой. +// * ДополнительнаяИнформация - ХранилищеЗначения - служебное свойство с дополнительными +// сведениями, связанными с выявленной проблемой. +// * Выявлено - Дата - серверное время идентификации проблемы. +// +// СсылкаНаОбъект - ЛюбаяСсылка - ссылка на объект-источник значения для добавляемых +// дополнительных измерений. +// Реквизиты - КоллекцияОбъектовМетаданных - коллекция, содержащая реквизиты объекта- +// источника проблем. +// +Процедура ПередЗаписьюПроблемы(Проблема, СсылкаНаОбъект, Реквизиты) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаПереопределяемый.ПередЗаписьюПроблемы(Проблема, СсылкаНаОбъект, Реквизиты) +``` +
+ +## ПриОпределенииПрикладныхПроверок +
+ +Описание, пример вызова + +```bsl + +// Устарела: Следует использовать функцию ПриОпределенииПроверок. +// Предназначена для подключения собственных правил проверки ведения учета. +// +// Параметры: +// ГруппыПроверок - ТаблицаЗначений - таблица, в которую добавляются группы проверок: +// * Наименование - Строка - наименование группы проверок, например: "Системные проверки". +// * Идентификатор - Строка - строковый идентификатор группы, например: "СистемныеПроверки". +// +// Проверки - ТаблицаЗначений - таблица, в которую добавляются проверки: +// * Наименование - Строка - наименование элемента проверки. Обязательно для заполнения. +// * Причины - Строка - возможные причины, которые привели к возникновению проблемы. +// Выводятся в отчете о проблемах. Необязательно для заполнения. +// * Рекомендация - Строка - рекомендация по решению возникшей проблемы. +// Выводятся в отчете о проблемах. Необязательно для заполнения. +// * Идентификатор - Строка - строковый идентификатор проверки. Обязателен для заполнения. +// * ИдентификаторРодителя - Строка - строковый идентификатор группы проверок, например: "СистемныеПроверки". +// Обязательно для заполнения. +// * ДатаНачалаПроверки - Дата - пороговая дата, обозначающая границу проверяемых +// объектов (только для объектов с датой). Объекты, дата которых меньше +// указанной, не следует проверять. По умолчанию не заполнено (т.е. проверять все). +// * ЛимитПроблем - Число - максимальное количество проверяемых объектов. +// По умолчанию 0 - следует проверить все объекты. +// * ОбработчикПроверки - Строка - имя экспортной процедуры-обработчика проверки в серверном общем модуле. +// Предназначен для поиска и регистрации проблем ведения учета. +// Параметры обработчика проверки: +// * Проверка - СправочникСсылка.ПравилаПроверкиУчета - исполняемая проверка. +// * ПараметрыПроверки - Структура - параметры проверки, которую необходимо выполнить. +// Подробнее см. в документации. +// * ОбработчикПереходаКИсправлению - Строка - имя экспортной процедуры-обработчика исправления проблемы +// в клиентском общем модуле или полное имя формы, которая будет открыта для +// исправления проблемы. Параметры обработчика исправления проблемы или формы: +// * ИдентификаторПроверки - Строка - идентификатор проверки, +// которая выявила проблему. +// * ВидПроверки - СправочникСсылка.ВидыПроверок - вид проверки +// с дополнительной информацией о проблеме. +// * ДополнительныеПараметры - ХранилищеЗначения - дополнительная информация по проверке. +// +// Пример: +// Проверка = Проверки.Добавить(); +// Проверка.ИдентификаторГруппы = "СистемныеПроверки"; +// Проверка.Наименование = НСтр("ru='Проверка заполнения комментария в документах ""Поступление товаров""'"); +// Проверка.Причины = НСтр("ru='Не введен комментарий в документе.'"); +// Проверка.Рекомендация = НСтр("ru='Ввести комментарий в документе.'"); +// Проверка.Идентификатор = "ПроверитьКомментарийВПоступленииТоваров"; +// Проверка.ОбработчикПроверки = "СтандартныеПодсистемы.ПроверитьКомментарийВПоступленииТоваров"; +// Проверка.ДатаНачалаПроверки = Дата('20140101000000'); +// Проверка.ЛимитПроблем = 3; +// +Процедура ПриОпределенииПрикладныхПроверок(ГруппыПроверок, Проверки) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаПереопределяемый.ПриОпределенииПрикладныхПроверок(ГруппыПроверок, Проверки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/КонтрольРаботыПользователей.md b/src/content/docs/bsp/КонтрольРаботыПользователей.md new file mode 100644 index 0000000..ef4b701 --- /dev/null +++ b/src/content/docs/bsp/КонтрольРаботыПользователей.md @@ -0,0 +1,106 @@ +--- +title: Контроль работы пользователей +slug: bsp/контроль-работы-пользователей +--- + + +## РегистрироватьДоступКДанным +
+ +Описание, пример вызова + +```bsl + +// Возвращает значение настройки РегистрироватьДоступКДанным +// панели НастройкиПользователейИПрав. +// +// Возвращаемое значение: +// Булево +// +Функция РегистрироватьДоступКДанным() Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольРаботыПользователей.РегистрироватьДоступКДанным() +``` +
+ +## УстановитьРегистрациюДоступаКДанным +
+ +Описание, пример вызова + +```bsl + +// Устанавливает значение настройки РегистрироватьДоступКДанным +// панели НастройкиПользователейИПрав. +// +// Параметры: +// РегистрироватьДоступКДанным - Булево +// +Процедура УстановитьРегистрациюДоступаКДанным(РегистрироватьДоступКДанным) Экспорт +``` + +Пример вызова +```bsl +КонтрольРаботыПользователей.УстановитьРегистрациюДоступаКДанным(РегистрироватьДоступКДанным) +``` +
+ +## НастройкиРегистрацииСобытийДоступаКДанным +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки регистрации событий, доступные по ссылке Настройки +// панели НастройкиПользователейИПрав. +// +// Возвращаемое значение: +// Структура: +// * Состав - Массив из ОписаниеИспользованияСобытияДоступЖурналаРегистрации +// * Комментарии - Соответствие из КлючИЗначение: +// * Ключ - Строка - полное имя таблицы + имя поля, например "Справочник.ФизическиеЛица.НомерДокумента". +// * Значение - Строка - произвольный текст +// * ОбщийКомментарий - Строка - произвольный текст +// +Функция НастройкиРегистрацииСобытийДоступаКДанным() Экспорт +``` + +Пример вызова +```bsl +Результат = КонтрольРаботыПользователей.НастройкиРегистрацииСобытийДоступаКДанным() +``` +
+ +## УстановитьНастройкиРегистрацииСобытийДоступаКДанным +
+ +Описание, пример вызова + +```bsl + +// Устанавливает настройки регистрации событий, доступные по ссылке Настройки +// панели НастройкиПользователейИПрав. +// +// Параметры: +// Настройки - см. НастройкиРегистрацииСобытийДоступаКДанным +// +Процедура УстановитьНастройкиРегистрацииСобытийДоступаКДанным(Настройки) Экспорт +``` + +Пример вызова +```bsl +КонтрольРаботыПользователей.УстановитьНастройкиРегистрацииСобытийДоступаКДанным(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МанифестКонфигурации.md b/src/content/docs/bsp/МанифестКонфигурации.md new file mode 100644 index 0000000..8771f31 --- /dev/null +++ b/src/content/docs/bsp/МанифестКонфигурации.md @@ -0,0 +1,59 @@ +--- +title: Манифест конфигурации +slug: bsp/манифест-конфигурации +--- + + +## СформироватьМанифестКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Формирует манифест конфигурации (используется для декларации информации о конфигурации +// другим компонентам сервиса). +// +// Возвращаемое значение: +// ОбъектXDTO - {HTTP://www.1c.ru/1cFresh/Application/Manifest/a.b.c.d}ApplicationInfo. +// +Функция СформироватьМанифестКонфигурации() Экспорт +``` + +Пример вызова +```bsl +Результат = МанифестКонфигурации.СформироватьМанифестКонфигурации() +``` +
+ +## ПоместитьМанифестКонфигурацииВоВременноеХранилище +
+ +Описание, пример вызова + +```bsl + +// Формирует манифест конфигурации, записывает его в файл и помещает двоичные данные файла во временное хранилище. +// Обертка над МанифестКонфигурации.СформироватьМанифестКонфигурации() для вызова из длительных +// операций или из внешнего соединения. +// +// Параметры: +// АдресХранилища - Строка - адрес во временном хранилище, по которому требуется поместить двоичные +// данные файла манифеста конфигурации. +// +Процедура ПоместитьМанифестКонфигурацииВоВременноеХранилище(Знач АдресХранилища) Экспорт +``` + +Пример вызова +```bsl +МанифестКонфигурации.ПоместитьМанифестКонфигурацииВоВременноеХранилище(АдресХранилища) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МашиночитаемыеДоверенностиФНС.md b/src/content/docs/bsp/МашиночитаемыеДоверенностиФНС.md new file mode 100644 index 0000000..8c5dcfb --- /dev/null +++ b/src/content/docs/bsp/МашиночитаемыеДоверенностиФНС.md @@ -0,0 +1,292 @@ +--- +title: Машиночитаемые доверенности ФНС +slug: bsp/машиночитаемые-доверенности-фнс +--- + + +## ФайлыДоверенности +
+ +Описание, пример вызова + +```bsl + +// Возвращает машиночитаемую доверенность в виде набора файлов. +// Если файлы доверенности еще не сформированы, то возвращается пустой набор файлов. +// +// Параметры: +// Доверенность - СправочникСсылка.МашиночитаемыеДоверенности +// ДляНалоговыхОрганов - Булево - если Истина, имя файла будет сформировано +// в соответствии с требованиями налоговых органов. +// +// Возвращаемое значение: +// Массив из Структура: +// * ИмяФайла - Строка +// * ТипФайла - Строка - принимает значения "Доверенность" или "Подпись". +// * ДвоичныеДанные - ДвоичныеДанные +// * ОписаниеОшибки - Строка +// +Функция ФайлыДоверенности(Знач Доверенность, Знач ДляНалоговыхОрганов) Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНС.ФайлыДоверенности(Доверенность, ДляНалоговыхОрганов) +``` +
+ +## ФайлыДоверенностей +
+ +Описание, пример вызова + +```bsl + +// Возвращает машиночитаемые доверенности в виде набора файлов. +// Если файлы отдельно взятой доверенности еще не сформированы, то по ней возвращается пустой набор файлов. +// +// Параметры: +// Доверенности - Массив из СправочникСсылка.МашиночитаемыеДоверенности +// ДляНалоговыхОрганов - Булево - если Истина, имена файлов будут сформированы +// в соответствии с требованиями налоговых органов. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.МашиночитаемыеДоверенности +// * Значение - см. ФайлыДоверенности +// +Функция ФайлыДоверенностей(Знач Доверенности, Знач ДляНалоговыхОрганов) Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНС.ФайлыДоверенностей(Доверенности, ДляНалоговыхОрганов) +``` +
+ +## ОтборДляДоверенностейПоСертификату +
+ +Описание, пример вызова + +```bsl + +// Отбор для доверенностей по сертификату. +// +// Параметры: +// Сертификат - СертификатКриптографии +// - ДвоичныеДанные +// - Строка - адрес двоичных данных сертификата во временном хранилище. +// - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования. +// Префикс - Строка +// +// Возвращаемое значение: +// Структура +// +Функция ОтборДляДоверенностейПоСертификату(Знач Сертификат, Префикс) Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНС.ОтборДляДоверенностейПоСертификату(Сертификат, Префикс) +``` +
+ +## ДоверенностиСОтбором +
+ +Описание, пример вызова + +```bsl + +// Доверенности с отбором. Если в отборе не передана доверенность, то отбор производится только по непомеченным на удаление. +// +// Параметры: +// Отбор - Структура - содержит имя и значение поля, по которому надо отобрать доверенности: +// "ПредставительИНН", "ПредставительОГРН", "ПредставительСНИЛС", +// "ДоверительИНН", "ДоверительКПП" и т.п. +// По умолчанию будут подобраны доверенности с признаками Верна, Подписана и статусом Действует. +// Если значение отбора Неопределено, отбор по полю не производится. +// ВыбранныеПоля - Массив из Строка, Строка - массив строк или строка через запятую: поля, которые нужно возвращать. +// НаДату - Дата - по умолчанию - текущая дата сеанса: дата, на которую определяется действительность доверенности. +// Если передана пустая дата, отбор по периоду действия не будет использоваться. +// +// Возвращаемое значение: +// ТаблицаЗначений +// +Функция ДоверенностиСОтбором(Отбор, Знач ВыбранныеПоля, Знач НаДату = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНС.ДоверенностиСОтбором(Отбор, ВыбранныеПоля, НаДату); +``` +
+ +## ДобавитьПодписьКФайлуДоверенности +
+ +Описание, пример вызова + +```bsl + +// Добавляет подпись к доверенности, устанавливает признак, что подписана, если есть все подписи доверенности. +// +// Параметры: +// ФайлДоверенности - СправочникСсылка.МашиночитаемыеДоверенностиПрисоединенныеФайлы +// Подпись - см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи +// - ДвоичныеДанные - данные подписи в формате DER +// - Строка - адрес двоичных данных подписи во временном хранилище. +// Возвращаемое значение: +// Булево - Истина, если удалось добавить подпись +// Строка - текст ошибки, если подпись не соответствует доверенности +// +Функция ДобавитьПодписьКФайлуДоверенности(ФайлДоверенности, Знач Подпись) Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНС.ДобавитьПодписьКФайлуДоверенности(ФайлДоверенности, Подпись) +``` +
+ +## РеквизитыПредставителяОрганизации +
+ +Описание, пример вызова + +```bsl + +// Реквизиты представителя организации. +// +// Параметры: +// ФизическоеЛицо - ОпределяемыйТип.ФизическоеЛицо +// ЭтоИндивидуальныйПредприниматель - Булево - это индивидуальный предприниматель +// Должность - Строка - должность представителя организации +// +// Возвращаемое значение: +// Структура - см. МашиночитаемыеДоверенностиФНСПереопределяемый.ПриЗаполненииРеквизитовФизическогоЛица.Реквизиты +// +Функция РеквизитыПредставителяОрганизации(ФизическоеЛицо, ЭтоИндивидуальныйПредприниматель = Ложь, Должность = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНС.РеквизитыПредставителяОрганизации(ФизическоеЛицо, ЭтоИндивидуальныйПредприниматель, Должность); +``` +
+ +## РезультатПроверкиДоверенности +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат проверки доверенности. +// +// Параметры: +// Доверенность - СправочникСсылка.МашиночитаемыеДоверенности +// ПроверятьВРеестреФНС - Булево, Неопределено - если Неопределено, то в зависимости от признака РегистрироватьВРеестре +// +// Возвращаемое значение: +// Структура: +// * Верна - Булево - подписи доверенности верны и соответствуют доверителям. +// * ТребуетсяПроверка - Булево - если есть подписи, требующие проверки или не удалось получить статус в реестре ФНС. +// * Статус - ПеречислениеСсылка.СтатусыМЧД +// * ЕстьВРеестреФНС - Булево - доверенность удалось проверить в реестре ФНС +// * ТекстОшибки - Строка +// * ЕстьВсеПодписи - Булево - есть все подписи доверителей. +// * РезультатыПроверкиПодписей - Массив из Структура: +// ** Верна - Булево +// ** КомуВыданСертификат - Строка +// ** ДатаПодписи - Дата +// ** ИдентификаторПодписи - УникальныйИдентификатор +// ** ТребуетсяПроверка - Булево +// ** Соответствует - Булево - подпись соответствует доверителю. +// ** ТекстОшибки - Строка +// ** ТекстОшибкиСоответствия - Строка +// ** РезультатПроверки - Неопределено - если подпись не требовалось проверять или не удалось ее проверить. +// - см. ЭлектроннаяПодписьКлиентСервер.РезультатПроверкиПодписи +// +Функция РезультатПроверкиДоверенности(Доверенность, ПроверятьВРеестреФНС = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНС.РезультатПроверкиДоверенности(Доверенность, ПроверятьВРеестреФНС); +``` +
+ +## РезультатПроверкиПодписиПоМЧД +
+ +Описание, пример вызова + +```bsl + +// Проверяет записанную в базу подпись на соответствие подписанту, документу, действие доверенности на дату подписи. +// +// Параметры: +// ПодписанныйОбъект - ОпределяемыйТип.ПодписанныйОбъект - ссылка на подписанный объект. +// ИдентификаторПодписи - УникальныйИдентификатор - см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи.ИдентификаторПодписи +// СертификатПодписи - СертификатКриптографии +// - ДвоичныеДанные +// - Строка - адрес двоичных данных во временном хранилище. +// НаДату - Дата - дата подписи, если не заполнена, проверка будет выполнена на дату сеанса. +// +// Возвращаемое значение: +// Массив из Структура: +// * МашиночитаемаяДоверенность - СправочникСсылка.МашиночитаемыеДоверенности +// * ТребуетсяПроверка - Булево - если Истина, не удалось проверить доверенность. +// * ДатаПроверки - Дата +// * Верна - Булево +// * ПодписантСоответствуетПредставителю - Булево +// * СовместныеПолномочия - Булево +// * СовместныеПолномочияВерны - Булево +// * ПротоколПроверки - Соответствие из КлючИЗначение: +// ** Ключ - Строка - идентификатор проверки +// ** Значение - см. РезультатПроверкиДляПротокола +// +Функция РезультатПроверкиПодписиПоМЧД(ПодписанныйОбъект, ИдентификаторПодписи, СертификатПодписи, НаДату) Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНС.РезультатПроверкиПодписиПоМЧД(ПодписанныйОбъект, ИдентификаторПодписи, СертификатПодписи, НаДату) +``` +
+ +## РезультатПроверкиДляПротокола +
+ +Описание, пример вызова + +```bsl + +// Результат проверки для записи в протокол. +// +// Возвращаемое значение: +// Структура: +// * ЗаголовокПроверки - Строка - например, "Проверка документа". +/// * ТекстПроверки - Строка - например, "Организация не соответствует доверителю". +// * Верна - Неопределено, Булево - если Неопределено - значит, требуется проверка. +// * ДатаПроверки - Дата +// * ДополнительныеДанные - Произвольный - дополнительные сведения о проверке, которые сохраняются в информационной базе. +// +Функция РезультатПроверкиДляПротокола() Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНС.РезультатПроверкиДляПротокола() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МашиночитаемыеДоверенностиФНСКлиент.md b/src/content/docs/bsp/МашиночитаемыеДоверенностиФНСКлиент.md new file mode 100644 index 0000000..b6bca43 --- /dev/null +++ b/src/content/docs/bsp/МашиночитаемыеДоверенностиФНСКлиент.md @@ -0,0 +1,162 @@ +--- +title: Машиночитаемые доверенности ФНС клиент +slug: bsp/машиночитаемые-доверенности-фнс-клиент +--- + + +## ОткрытьСписокМЧД +
+ +Описание, пример вызова + +```bsl + +// Открывает форму списка машиночитаемых доверенностей. +// +// Параметры: +// Отборы - см. ОтборыСпискаДоверенностей +// ОповещениеОЗакрытии - ОписаниеОповещения - оповещение о закрытии формы списка доверенностей. +// Владелец - Форма - владелец открываемой формы. +// +Процедура ОткрытьСписокМЧД(Отборы = Неопределено, ОповещениеОЗакрытии = Неопределено, Владелец = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСКлиент.ОткрытьСписокМЧД(Отборы, ОповещениеОЗакрытии, Владелец); +``` +
+ +## ОтборыСпискаДоверенностей +
+ +Описание, пример вызова + +```bsl + +// Конструктор отборов списка машиночитаемых доверенностей для процедуры ОткрытьСписокМЧД. +// +// Возвращаемое значение: +// Структура - возможные отборы списка доверенностей: +// * ОтборПоСостоянию - Строка +// * Доверитель - Строка, ОпределяемыйТип.СторонаМЧД +// * Представитель - Строка, ОпределяемыйТип.СторонаМЧД +// * ДоверенностиПоРоли - Строка +// * ТолькоДействующие - Булево +// * Полномочия - Массив из Строка - коды полномочий. +// * СертификатДоверителя - см. МашиночитаемыеДоверенностиФНС.ОтборДляДоверенностейПоСертификату +// * СертификатПредставителя - см. МашиночитаемыеДоверенностиФНС.ОтборДляДоверенностейПоСертификату +// * НаДату - Дата - статусы отобразятся на переданную дату. +// +Функция ОтборыСпискаДоверенностей() Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНСКлиент.ОтборыСпискаДоверенностей() +``` +
+ +## СоздатьМЧД +
+ +Описание, пример вызова + +```bsl + +// Показывает форму создания машиночитаемой доверенности. +// +// Параметры: +// ПараметрыФормы - см. ПараметрыСозданияМЧД +// ОповещениеОЗавершении - ОписаниеОповещения +// +Процедура СоздатьМЧД(ПараметрыФормы, ОповещениеОЗавершении = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСКлиент.СоздатьМЧД(ПараметрыФормы, ОповещениеОЗавершении); +``` +
+ +## ПараметрыСозданияМЧД +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры предзаполнения формы новой машиночитаемой доверенности для процедуры СоздатьМЧД. +// +// Возвращаемое значение: +// Структура: +// * Полномочия - Массив из Строка - коды полномочий, которые должны быть выбраны в форме при открытии. +// * Доверитель - ОпределяемыйТип.СторонаМЧД +// * Представитель - ОпределяемыйТип.СторонаМЧД +// +Функция ПараметрыСозданияМЧД() Экспорт +``` + +Пример вызова +```bsl +Результат = МашиночитаемыеДоверенностиФНСКлиент.ПараметрыСозданияМЧД() +``` +
+ +## ПроверитьДоверенность +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат проверки доверенности. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение о результате выполнения: +// Структура: +// # Верна - Булево +// # ТребуетсяПроверка - Булево +// # ЕстьВсеПодписи - Булево - есть все подписи доверителей. +// # Статус - ПеречислениеСсылка.СтатусыМЧД +// # ЕстьВРеестреФНС - Булево +// # ТекстОшибки - Строка - ошибки строкой +// # ОписаниеОшибок - Структура - содержит ошибки выполнения проверок: +// ## ОписаниеОшибки - Строка - полное описание ошибки, когда оно возвращается строкой. +// ## ЗаголовокОшибки - Строка - заголовок ошибки, который соответствует операции +// когда операция одна (не заполнен, когда операций несколько). +// ## Ошибки - Массив из Структура: +// ### ЗаголовокОшибки - Строка - заголовок ошибки, который соответствует операции +// когда операций несколько (не заполнен, когда операция одна). +// ### Описание - Строка - краткое представление ошибки. +// # РезультатыПроверкиПодписей - Массив из Структура: +// ## Верна - Булево +// ## КомуВыданСертификат - Строка +// ## ДатаПодписи - Дата +// ## ИдентификаторПодписи - УникальныйИдентификатор +// ## ТребуетсяПроверка - Булево +// ## Соответствует - Булево - подпись соответствует доверителю. +// ## ТекстОшибки - Строка +// ## ТекстОшибкиСоответствия - Строка +// ## РезультатПроверки - Неопределено - если подпись не требовалось проверять или не удалось ее проверить. +// - см. ЭлектроннаяПодписьКлиентСервер.РезультатПроверкиПодписи +// Доверенность - СправочникСсылка.МашиночитаемыеДоверенности +// ИдентификаторФормы - УникальныйИдентификатор - используется при проверке подписей на клиенте. +// Если не указан, подписи, требующие проверки, не будут проверены на клиенте. +// +Процедура ПроверитьДоверенность(Оповещение, Доверенность, ИдентификаторФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСКлиент.ПроверитьДоверенность(Оповещение, Доверенность, ИдентификаторФормы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.md b/src/content/docs/bsp/МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.md new file mode 100644 index 0000000..0a4a556 --- /dev/null +++ b/src/content/docs/bsp/МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.md @@ -0,0 +1,202 @@ +--- +title: Машиночитаемые доверенности ФНС клиент переопределяемый +slug: bsp/машиночитаемые-доверенности-фнс-клиент-переопределяемый +--- + + +## ПриНачалеВыбораКодаНалоговогоОргана +
+ +Описание, пример вызова + +```bsl + +// При начале выбора кода налогового органа. +// +// Параметры: +// Организации - Массив из ОпределяемыйТип.СторонаМЧД +// Оповещение - ОписаниеОповещения - оповещение, которое вернет результат выбора кодов. +// СтандартнаяОбработка - Булево +// +Процедура ПриНачалеВыбораКодаНалоговогоОргана(Организации, Оповещение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриНачалеВыбораКодаНалоговогоОргана(Организации, Оповещение, СтандартнаяОбработка) +``` +
+ +## ПриНачалеВыбораПолномочий +
+ +Описание, пример вызова + +```bsl + +// При начале выбора полномочий. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение, которое вернет результат выбора полномочий. +// СтандартнаяОбработка - Булево +// +Процедура ПриНачалеВыбораПолномочий(Оповещение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриНачалеВыбораПолномочий(Оповещение, СтандартнаяОбработка) +``` +
+ +## ПриНачалеПодписания +
+ +Описание, пример вызова + +```bsl + +// При начале подписания. +// +// Параметры: +// Организации - Массив из ОпределяемыйТип.СторонаМЧД +// Файл - СправочникСсылка.МашиночитаемыеДоверенностиПрисоединенныеФайлы +// Полномочия - ТабличнаяЧасть - СправочникОбъект.МашиночитаемыеДоверенности.Полномочия. +// Оповещение - ОписаниеОповещения - оповещение, которое вернет результат подписания. +// СтандартнаяОбработка - Булево +// +Процедура ПриНачалеПодписания(Организации, Файл, Полномочия, Оповещение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриНачалеПодписания(Организации, Файл, Полномочия, Оповещение, СтандартнаяОбработка) +``` +
+ +## ПриПроверкеДоверенности +
+ +Описание, пример вызова + +```bsl + +// Для прикладной проверки доверенности. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение о результате выполнения: +// Структура: +// # Верна - Булево +// # ТребуетсяПроверка - Булево +// # ЕстьВсеПодписи - Булево - есть все подписи доверителей. +// # Статус - ПеречислениеСсылка.СтатусыМЧД +// # ЕстьВРеестреФНС - Булево +// # ТекстОшибки - Строка +// # РезультатыПроверкиПодписей - Массив из Структура: +// ## Верна - Булево +// ## КомуВыданСертификат - Строка +// ## ДатаПодписи - Дата +// ## ИдентификаторПодписи - УникальныйИдентификатор +// ## ТребуетсяПроверка - Булево +// ## Соответствует - Булево - подпись соответствует доверителю. +// ## ТекстОшибки - Строка +// ## ТекстОшибкиСоответствия - Строка +// ## РезультатПроверки - Неопределено - если подпись не требовалось проверять или не удалось ее проверить. +// - см. ЭлектроннаяПодписьКлиентСервер.РезультатПроверкиПодписи +// Доверенность - СправочникСсылка.МашиночитаемыеДоверенности +// ИдентификаторФормы - УникальныйИдентификатор - используется при проверке подписей на клиенте. +// Если не указан, подписи, требующие проверки, не будут проверены на клиенте. +// СтандартнаяОбработка - Булево +// +Процедура ПриПроверкеДоверенности(Оповещение, Доверенность, ИдентификаторФормы, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриПроверкеДоверенности(Оповещение, Доверенность, ИдентификаторФормы, СтандартнаяОбработка) +``` +
+ +## ПриОбработкеНавигационнойСсылки +
+ +Описание, пример вызова + +```bsl + +// При обработке навигационной ссылки состояния в другом реестре в форме машиночитаемой доверенности, +// сформированной в МашиночитаемыеДоверенностиФНСПереопределяемый.ПриПолученииСтатусаРегистрации +// +// Параметры: +// Доверенность - СправочникОбъект.МашиночитаемыеДоверенности +// НавигационнаяСсылкаФорматированнойСтроки - Строка +// СтандартнаяОбработка - Булево +// +Процедура ПриОбработкеНавигационнойСсылки(Доверенность, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриОбработкеНавигационнойСсылки(Доверенность, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) +``` +
+ +## ПриИзмененииСтатусаДоверенности +
+ +Описание, пример вызова + +```bsl + +// Вызывается при изменении статуса доверенности, например, когда статус обновляется из реестра ФНС, для обработки +// изменившегося статуса доверенности. К примеру, в процедуре можно сообщить о том, что доверенность готова и +// можно продолжить отправку отчетности или документов по ЭДО. +// +// Параметры: +// СтатусыДоверенностей - Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.МашиночитаемыеДоверенности - доверенность с изменившимся статусом +// * Значение - Структура: +// ** СтатусДоИзменения - ПеречислениеСсылка.ТехническиеСтатусыМЧД +// ** НовыйСтатус - ПеречислениеСсылка.ТехническиеСтатусыМЧД +// +Процедура ПриИзмененииСтатусаДоверенности(СтатусыДоверенностей) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриИзмененииСтатусаДоверенности(СтатусыДоверенностей) +``` +
+ +## ПриРегистрацииДоверенности +
+ +Описание, пример вызова + +```bsl + +// Переопределяет процедуру регистрации в реестре Федеральной таможенной службы или другом. +// +// Параметры: +// Доверенность - СправочникСсылка.МашиночитаемыеДоверенности +// СтандартнаяОбработка - Булево - при установке значения Ложь регистрация доверенности не будет выполнена. +// ОбработчикЗавершения - ОписаниеОповещения - процедура, которую необходимо вызвать для продолжения регистрации +// доверенности в случае, если стандартная обработка +// была прервана при помощи параметра СтандартнаяОбработка; +// +Процедура ПриРегистрацииДоверенности(Доверенность, СтандартнаяОбработка, ОбработчикЗавершения) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриРегистрацииДоверенности(Доверенность, СтандартнаяОбработка, ОбработчикЗавершения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МашиночитаемыеДоверенностиФНСПереопределяемый.md b/src/content/docs/bsp/МашиночитаемыеДоверенностиФНСПереопределяемый.md new file mode 100644 index 0000000..b58a616 --- /dev/null +++ b/src/content/docs/bsp/МашиночитаемыеДоверенностиФНСПереопределяемый.md @@ -0,0 +1,313 @@ +--- +title: Машиночитаемые доверенности ФНС переопределяемый +slug: bsp/машиночитаемые-доверенности-фнс-переопределяемый +--- + + +## ПриЗаполненииНалоговыхОргановДействия +
+ +Описание, пример вызова + +```bsl + +// При заполнении налоговых органов действия. +// +// Параметры: +// Организации - Массив, Неопределено +// НалоговыеОрганыДействия - ТаблицаЗначений +// +Процедура ПриЗаполненииНалоговыхОргановДействия(Организации, НалоговыеОрганыДействия) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСПереопределяемый.ПриЗаполненииНалоговыхОргановДействия(Организации, НалоговыеОрганыДействия) +``` +
+ +## ПриЗаполненииРеквизитовОрганизации +
+ +Описание, пример вызова + +```bsl + +// Вызывается в форме машиночитаемой доверенности для заполнения реквизитов организации при выборе доверителя и представителя, +// если выбран вид представителя/доверителя "Организация". +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - ссылка на организацию, реквизиты которой надо заполнить. +// Реквизиты - Структура: +// * ЭтоИндивидуальныйПредприниматель - Булево +// * ЭтоИностраннаяОрганизация - Булево +// * ЭтоФилиал - Булево +// * НаименованиеПолное - Строка +// * НаименованиеСокращенное - Строка +// * ИНН - Строка +// * КПП - Строка +// * ОГРН - Строка +// * ЭлектроннаяПочта - Строка +// * ЭлектроннаяПочтаЗначение - Строка - в формате JSON, как его возвращает +// функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// * Телефон - Строка +// * ТелефонЗначение - Строка - в формате JSON, как его возвращает +// функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// Заполняются для иностранной организации: +// * НомерЗаписиОбАккредитации - Строка +// * СтранаРегистрации - СправочникСсылка.СтраныМира +// * СтранаРегистрацииКод - Строка +// * РегистрационныйНомерВСтранеРегистрации - Строка +// * НаименованиеРегистрирующегоОргана - Строка +// * КодНалогоплательщикаВСтранеРегистрации - Строка +// * ФактическийАдрес - Строка +// * ФактическийАдресЗначение - Строка - в формате JSON, как его возвращает +// функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// * ЮридическийАдресВСтранеРегистрации - Строка +// * ЮридическийАдресВСтранеРегистрацииЗначение - Строка - в формате JSON, как его возвращает +// функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// Заполняются для российской организации: +// * НаименованиеУчредительногоДокумента - Строка +// * ЮридическийАдрес - Строка +// * ЮридическийАдресЗначение - Строка - в формате JSON, как его возвращает +// функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// Заполняются для филиала: +// * РегистрационныйНомерФилиала - Строка +// Данные о физическом лице с правом действия без доверенности: +// * ЛицоБезДоверенности - ОпределяемыйТип.ФизическоеЛицо +// * РеквизитыЛицаБезДоверенности - см. ПриЗаполненииРеквизитовФизическогоЛица.Реквизиты +// +// СтандартнаяОбработка - Булево - установите в Ложь, если нужно отменить заполнение реквизитов из подсистемы Организации +// +Процедура ПриЗаполненииРеквизитовОрганизации(Организация, Реквизиты, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСПереопределяемый.ПриЗаполненииРеквизитовОрганизации(Организация, Реквизиты, СтандартнаяОбработка) +``` +
+ +## ПриЗаполненииРеквизитовФизическогоЛица +
+ +Описание, пример вызова + +```bsl + +// Вызывается в форме машиночитаемой доверенности для заполнения реквизитов физического лица при выборе доверителя и представителя, +// если выбран вид представителя/доверителя "Физическое лицо". +// +// Параметры: +// ФизическоеЛицо - ОпределяемыйТип.ФизическоеЛицо - ссылка на физлицо, реквизиты которого надо заполнить. +// Реквизиты - Структура: +// * ЭтоИндивидуальныйПредприниматель - Булево +// * ЭтоФизическоеЛицо - Булево +// * ЭтоДолжностноеЛицо - Булево +// * ДолжностьЛицаДоверителя - Строка +// * Фамилия - Строка +// * Имя - Строка +// * Отчество - Строка +// * Пол - Число - 1 - мужской, 2 - женский +// * ИННФЛ - Строка +// * СтраховойНомерПФР - Строка +// * АдресРегистрации - Строка +// * АдресРегистрацииЗначение - Строка - в формате JSON, как его возвращает +// функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// * ЭлектроннаяПочта - Строка +// * ЭлектроннаяПочтаЗначение - Строка - в формате JSON, как его возвращает +// функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// * Телефон - Строка +// * ТелефонЗначение - Строка - в формате JSON, как его возвращает +// функция КонтактнаяИнформацияОбъекта общего модуля УправлениеКонтактнойИнформацией. +// * ДатаРождения - Дата +// * ДокументВид - Строка +// * ДокументНомер - Строка +// * ДокументКемВыдан - Строка +// * ДокументДатаВыдачи - Дата +// * ДокументКодПодразделения - Строка - код подразделения в виде 999-999 +// * ДокументСрокДействия - Дата +// * Гражданство - СправочникСсылка.СтраныМира +// * БезГражданства - Булево +// * МестоРождения - Строка +// * НомерЗаписиЕдиногоРегистраНаселения - Строка +// +Процедура ПриЗаполненииРеквизитовФизическогоЛица(ФизическоеЛицо, Реквизиты) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСПереопределяемый.ПриЗаполненииРеквизитовФизическогоЛица(ФизическоеЛицо, Реквизиты) +``` +
+ +## ПриЗаполненииРеквизитовКонтрагента +
+ +Описание, пример вызова + +```bsl + +// Вызывается в форме машиночитаемой доверенности для заполнения реквизитов контрагента при выборе доверителя и представителя, +// если выбран вид представителя/доверителя "Контрагент". +// +// Параметры: +// Контрагент - ОпределяемыйТип.Контрагент - ссылка на контрагента, реквизиты которого надо заполнить. +// Реквизиты - см. ПриЗаполненииРеквизитовОрганизации.Реквизиты +// +Процедура ПриЗаполненииРеквизитовКонтрагента(Контрагент, Реквизиты) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСПереопределяемый.ПриЗаполненииРеквизитовКонтрагента(Контрагент, Реквизиты) +``` +
+ +## ПриПроверкеДоверенностиПодписи +
+ +Описание, пример вызова + +```bsl + +// Для выполнения прикладной проверки подписи по доверенности. Например, проверка соответствия реквизитов доверителя +// контрагенту, указанному в документе, и полномочий подписанта. Результаты проверки сохраняются в информационной базе. +// +// Параметры: +// ДанныеДоверенности - Структура, ВыборкаИзРезультатаЗапроса: +// * Ссылка - СправочникСсылка.МашиночитаемыеДоверенности +// * ПодписанныйОбъект - ОпределяемыйТип.ПодписанныйОбъект - ссылка на подписанный объект. +// * Полномочия - ТаблицаЗначений, РезультатЗапроса - содержит реквизиты табличной части Полномочия справочника МашиночитаемыеДоверенности. +// * Ограничения - ТаблицаЗначений, РезультатЗапроса - содержит реквизиты табличной части Ограничения справочника МашиночитаемыеДоверенности. +// Сертификат - см. МашиночитаемыеДоверенностиФНС.ОтборДляДоверенностейПоСертификату.Сертификат +// ПротоколПроверки - Соответствие из КлючИЗначение: +// * Ключ - Строка - ключ проверки, для проверки полномочий и документа в протокол добавлены значения +// с ключами "ПроверкаПолномочий" и "ПроверкаДокумента". +// * Значение - см. МашиночитаемыеДоверенностиФНС.РезультатПроверкиДляПротокола +// +Процедура ПриПроверкеДоверенностиПодписи(ДанныеДоверенности, Сертификат, ПротоколПроверки) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСПереопределяемый.ПриПроверкеДоверенностиПодписи(ДанныеДоверенности, Сертификат, ПротоколПроверки) +``` +
+ +## ПриПолученииСтатусаРегистрации +
+ +Описание, пример вызова + +```bsl + +// Переопределяет описание состояния доверенности в реестре Федеральной таможенной службы или другом. +// +// Параметры: +// Доверенность - СправочникСсылка.МашиночитаемыеДоверенности +// РегистрацияВРеестре - Структура: +// * ПоказыватьРегистрироватьВРеестре - Булево - показывать флажок регистрации в реестре. +// * ЗаголовокФлажкаРегистрации - Строка - заголовок флажка регистрации в реестре. +// * ПодсказкаРегистрации - Строка - подсказка флажка регистрации. +// * ЗарегистрированаВРеестре - Неопределено, Булево - признак необходимости регистрации в реестре. +// Если указано Неопределено, требуется заполнить, если Булево - запомнить. +// * СостояниеРегистрации - Строка, ФорматированнаяСтрока +// * ПодсказкаСостояния - Строка - подсказка состояния регистрации. +// * Картинка - Строка - имя картинки статуса в строке состояния. +// * ПолномочияПриОткрытии - Неопределено, Массив из Строка - список кодов полномочий, переданных в параметре при открытии +// формы. Можно анализировать и не отображать флажок регистрации, если полномочия относятся к другой подсистеме. +// * ВыбранныеПолномочия - Структура: +// ** Полномочия - ТаблицаЗначений +// ** Ограничения - ТаблицаЗначений +// * КодыПолномочийДляДобавления - Массив из Строка - коды полномочий, которые предлагать добавить при выборе флажка регистрации. +// Если одно из них уже выбрано, предложение о добавлении не выводится. +// +Процедура ПриПолученииСтатусаРегистрации(Доверенность, РегистрацияВРеестре) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСПереопределяемый.ПриПолученииСтатусаРегистрации(Доверенность, РегистрацияВРеестре) +``` +
+ +## ПриРегистрацииДоверенности +
+ +Описание, пример вызова + +```bsl + +// Переопределяет процедуру регистрации в реестре Федеральной таможенной службы или другом. +// +// Параметры: +// Доверенность - СправочникСсылка.МашиночитаемыеДоверенности +// +Процедура ПриРегистрацииДоверенности(Доверенность) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСПереопределяемый.ПриРегистрацииДоверенности(Доверенность) +``` +
+ +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Переопределяет процедуру настроек формы списка для реестра Федеральной таможенной службы или другого. +// +// Параметры: +// Настройки - Структура: +// * ПоказыватьСтатусВФормеСписка - Булево - показывать статус в реестре в форме списка. +// * ЗаголовокКолонкиСтатуса - Строка - заголовок колонки статуса в форме списка. +// * КартинкаКолонкиСтатуса - Картинка - картинка колонки статуса в форме списка. +// * КоллекцияКартинокДляСтроки - Картинка - коллекция для картинки строки. +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриПолученииСтатусов +
+ +Описание, пример вызова + +```bsl + +// Переопределяет процедуру получения статусов доверенностей для реестра Федеральной таможенной службы или другого. +// +// Параметры: +// Доверенности - Массив из СправочникСсылка.МашиночитаемыеДоверенности +// Статусы - Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.МашиночитаемыеДоверенности +// * Значение - Структура: +// ** ИндексКартинки - Число - картинка колонки статуса в форме списка. +// ** Статус - Строка +// +Процедура ПриПолученииСтатусов(Доверенности, Статусы) Экспорт +``` + +Пример вызова +```bsl +МашиночитаемыеДоверенностиФНСПереопределяемый.ПриПолученииСтатусов(Доверенности, Статусы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МенеджерСервисаКриптографии.md b/src/content/docs/bsp/МенеджерСервисаКриптографии.md new file mode 100644 index 0000000..20b77d8 --- /dev/null +++ b/src/content/docs/bsp/МенеджерСервисаКриптографии.md @@ -0,0 +1,459 @@ +--- +title: Менеджер сервиса криптографии +slug: bsp/менеджер-сервиса-криптографии +--- + + +## ОтправитьЗаявлениеНаПодключение +
+ +Описание, пример вызова + +```bsl + +// Отправить заявление на подключение +// +// Параметры: +// Заявление - Структура - заявление. +// +// Возвращаемое значение: +// Структура - результат: +// * Выполнено - Булево +// * КодОшибки - Строка +// * ОписаниеОшибки - Строка +// +Функция ОтправитьЗаявлениеНаПодключение(Заявление) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.ОтправитьЗаявлениеНаПодключение(Заявление) +``` +
+ +## СформироватьЗаявлениеДляПодписания +
+ +Описание, пример вызова + +```bsl + +// Сформировать заявление для подписания +// +// Параметры: +// Заявление - Структура - заявление. +// +// Возвращаемое значение: +// Структура - результат: +// * Выполнено - Булево +// * КодОшибки - Строка +// * ОписаниеОшибки - Строка +// +Функция СформироватьЗаявлениеДляПодписания(Заявление) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.СформироватьЗаявлениеДляПодписания(Заявление) +``` +
+ +## ОтправитьПодписанноеЗаявление +
+ +Описание, пример вызова + +```bsl + +// Отправить подписанное заявление +// +// Параметры: +// Заявление - Структура - заявление. +// +// Возвращаемое значение: +// Структура - результат: +// * Выполнено - Булево +// * КодОшибки - Строка +// * ОписаниеОшибки - Строка +// +Функция ОтправитьПодписанноеЗаявление(Заявление) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.ОтправитьПодписанноеЗаявление(Заявление) +``` +
+ +## ПолучитьСтатусЗаявленияНаПодключение +
+ +Описание, пример вызова + +```bsl + +// Функция - Получить статус заявления на подключение +// +// Параметры: +// ИдентификаторЗаявления - Строка - идентификатор заявления. +// +// Возвращаемое значение: +// Структура - результат: +// * Выполнено - Булево +// * КодОшибки - Строка +// * ОписаниеОшибки - Строка +/// +Функция ПолучитьСтатусЗаявленияНаПодключение(ИдентификаторЗаявления) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.ПолучитьСтатусЗаявленияНаПодключение(ИдентификаторЗаявления) +``` +
+ +## ПолучитьКодПроверкиТелефона +
+ +Описание, пример вызова + +```bsl + +// Получить код проверки телефона +// +// Параметры: +// Телефон - Строка - телефон, +// Идентификатор - Строка - идентификатор. +// +// Возвращаемое значение: +// Структура - результат, поля: +// * Идентификатор - Строка - +// * НомерКода - Число - +// * ВремяДействияКода - Число - +// * ЗадержкаПередПовторнойОтправкой - Число - +Функция ПолучитьКодПроверкиТелефона(Телефон, Идентификатор = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.ПолучитьКодПроверкиТелефона(Телефон, Идентификатор); +``` +
+ +## ПроверитьТелефонПоКоду +
+ +Описание, пример вызова + +```bsl + +// Проверить телефон по коду +// +// Параметры: +// Идентификатор - Строка - идентификатор, +// Код - Строка - код. +// +// Возвращаемое значение: +// Структура - результат: +// * Выполнено - Булево +// * КодОшибки - Число +// * ОписаниеОшибки - Строка +/// +Функция ПроверитьТелефонПоКоду(Идентификатор, Код) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.ПроверитьТелефонПоКоду(Идентификатор, Код) +``` +
+ +## ПолучитьКодПроверкиЭлектроннойПочты +
+ +Описание, пример вызова + +```bsl + +// Получить код проверки электронной почты +// +// Параметры: +// ЭлектроннаяПочта - Строка - электронная почта, +// Идентификатор - Строка - идентификатор. +// +// Возвращаемое значение: +// Структура - результат: +// * Идентификатор - Строка - +// * НомерКода - Число - +// * ВремяДействияКода - Число - +// * ЗадержкаПередПовторнойОтправкой - Число - +Функция ПолучитьКодПроверкиЭлектроннойПочты(ЭлектроннаяПочта, Идентификатор = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.ПолучитьКодПроверкиЭлектроннойПочты(ЭлектроннаяПочта, Идентификатор); +``` +
+ +## ПроверитьЭлектроннуюПочтуПоКоду +
+ +Описание, пример вызова + +```bsl + +// Проверить электронную почту по коду +// +// Параметры: +// Идентификатор - Строка - идентификатор, +// Код - Строка - код. +// +// Возвращаемое значение: +// Структура - результат: +// * Выполнено - Булево +// * КодОшибки - Число +// * ОписаниеОшибки - Строка +/// +Функция ПроверитьЭлектроннуюПочтуПоКоду(Идентификатор, Код) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.ПроверитьЭлектроннуюПочтуПоКоду(Идентификатор, Код) +``` +
+ +## НапечататьЗаявление +
+ +Описание, пример вызова + +```bsl + +// Напечатать заявление +// +// Параметры: +// ИдентификаторЗаявления - Строка - идентификатор заявления, +// ИдентификаторПроверки - Строка - идентификатор проверки, +// ИдентификаторСертификата - Строка - идентификатор сертификата. +// +// Возвращаемое значение: +// Структура - результат: +// * Выполнено - Булево +// * КодОшибки - Число +// * ОписаниеОшибки - Строка +// +Функция НапечататьЗаявление(ИдентификаторЗаявления, ИдентификаторПроверки, ИдентификаторСертификата) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.НапечататьЗаявление(ИдентификаторЗаявления, ИдентификаторПроверки, ИдентификаторСертификата) +``` +
+ +## ОтправитьЗаявление +
+ +Описание, пример вызова + +```bsl + +// Отправить заявление +// +// Параметры: +// ИдентификаторЗаявления - Строка - идентификатор заявления, +// ФайлЗаявления - Строка - файл заявления. +// +// Возвращаемое значение: +// Структура - результат: +// * Выполнено - Булево +// * КодОшибки - Число +// * ОписаниеОшибки - Строка +// +Функция ОтправитьЗаявление(ИдентификаторЗаявления, ФайлЗаявления) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.ОтправитьЗаявление(ИдентификаторЗаявления, ФайлЗаявления) +``` +
+ +## НачатьИзменениеНастроекПолученияВременныхПаролей +
+ +Описание, пример вызова + +```bsl + +// Начать изменение настроек получения временных паролей +// +// Параметры: +// ИдентификаторСертификата - Строка - идентификатор сертификата, +// Телефон - Строка - телефон, +// ЭлектроннаяПочта - Строка - электронная почта, +// Идентификатор - Строка - идентификатор. +// +// Возвращаемое значение: +// Структура - результат, поля: +// * Идентификатор - Строка - +// * ВремяДействияКода - Число - +// * ЗадержкаПередПовторнойОтправкой - Число - +Функция НачатьИзменениеНастроекПолученияВременныхПаролей(ИдентификаторСертификата, Телефон, ЭлектроннаяПочта, Идентификатор = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.НачатьИзменениеНастроекПолученияВременныхПаролей(ИдентификаторСертификата, Телефон, ЭлектроннаяПочта, Идентификатор); +``` +
+ +## ЗавершитьИзменениеНастроекПолученияВременныхПаролей +
+ +Описание, пример вызова + +```bsl + +// Завершить изменение настроек получения временных паролей +// +// Параметры: +// Идентификатор - Строка - идентификатор, +// Код - Строка - код. +// +// Возвращаемое значение: +// Структура - результат: +// * Выполнено - Булево +// * КодОшибки - Число +// * ОписаниеОшибки - Строка +// +Функция ЗавершитьИзменениеНастроекПолученияВременныхПаролей(Идентификатор, Код) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.ЗавершитьИзменениеНастроекПолученияВременныхПаролей(Идентификатор, Код) +``` +
+ +## СоздатьКонтейнерИЗапросНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Создает контейнер закрытого ключа и запроса на сертификат +// +// Параметры: +// ПараметрыЗаявления - Структура - Содержит поля для формирования заявления на сертификат: +// * ИдентификаторЗаявления - Строка - идентификатор поиска запроса на сертификат. +// * СодержаниеЗапроса - Строка - содержит поля OID. +// * НомерТелефона - Строка - содержит идентификатор подтвержденного телефона +// * ЭлектроннаяПочта - Строка - содержит идентификатор подтвердденной эл. почты +// * НотариусАдвокатГлаваКФХ - Булево - +// * ИдентификаторАбонента - Строка - идентификатор. +// АдресРезультата - Строка - адрес временного хранилища куда выкладывается результат функции Структура. +// +Процедура СоздатьКонтейнерИЗапросНаСертификат(ПараметрыЗаявления, АдресРезультата) Экспорт +``` + +Пример вызова +```bsl +МенеджерСервисаКриптографии.СоздатьКонтейнерИЗапросНаСертификат(ПараметрыЗаявления, АдресРезультата) +``` +
+ +## УстановитьСертификатВКонтейнерИХранилище +
+ +Описание, пример вызова + +```bsl + +// Привязывает сертификат к закрытому ключу в облачном хранилище +// +// Параметры: +// ПараметрыЗаявления - Структура - Содержит поля для формирования заявления на сертификат: +// * ИдентификаторЗаявления - Строка - идентификатор поиска запроса на сертификат +// * ДанныеСертификата - ДвоичныеДанные - содержит данные сертификата в кодировке PEM. +// +// АдресРезультата - Строка - адрес временного хранилища куда выкладывается результат функции Структура. +// +Процедура УстановитьСертификатВКонтейнерИХранилище(ПараметрыЗаявления, АдресРезультата) Экспорт +``` + +Пример вызова +```bsl +МенеджерСервисаКриптографии.УстановитьСертификатВКонтейнерИХранилище(ПараметрыЗаявления, АдресРезультата) +``` +
+ +## СертификатыАбонентаПоИдентификаторуПроверкиИНН +
+ +Описание, пример вызова + +```bsl + +// Сертификаты абонента по идентификатору проверки ИНН +// +// Параметры: +// ИНН - Строка +// Идентификатор - Строка +// ТолькоДействующие - Булево - Только действующие +// +// Возвращаемое значение: +// Структура - Сертификаты абонента по идентификатору проверки ИНН: +// * Сертификаты - Массив Из Структура: +// ** ID - Строка +// или, если ошибка +// * ОписаниеОшибки - Строка +// * КодОшибки - Строка +// * Выполнено - Булево +Функция СертификатыАбонентаПоИдентификаторуПроверкиИНН(ИНН, Идентификатор, ТолькоДействующие = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.СертификатыАбонентаПоИдентификаторуПроверкиИНН(ИНН, Идентификатор, ТолькоДействующие); +``` +
+ +## ПоискСертификатаПоОтпечаткуИлиСерийномуНомеру +
+ +Описание, пример вызова + +```bsl + +// Поиск сертификата по отпечатку или серийному номеру. +// +// Параметры: +// Отпечаток - Строка +// СерийныйНомер - Строка +// Сокращенно - Булево +// +// Возвращаемое значение: +// Структура : +// * Выполнено - Булево +// * КодОшибки - Строка +// * ОписаниеОшибки - Строка +Функция ПоискСертификатаПоОтпечаткуИлиСерийномуНомеру( Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерСервисаКриптографии.ПоискСертификатаПоОтпечаткуИлиСерийномуНомеру(); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МенеджерСервисаКриптографииКлиент.md b/src/content/docs/bsp/МенеджерСервисаКриптографииКлиент.md new file mode 100644 index 0000000..b5f23d2 --- /dev/null +++ b/src/content/docs/bsp/МенеджерСервисаКриптографииКлиент.md @@ -0,0 +1,73 @@ +--- +title: Менеджер сервиса криптографии клиент +slug: bsp/менеджер-сервиса-криптографии-клиент +--- + + +## СоздатьКонтейнерИЗапросНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Создает ключевую пару и формирует данные для запроса на сертификат +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, +// иначе, подробности в ИнформацияОбОшибке. +// ** ОписаниеОшибки - ИнформацияОбОшибке - описание ошибки выполнения, в случае возникновения ошибки, +// нижеописанные поля не формируются. +// ** ЗапросСертификата - ДвоичныеДанные - файлов в формате PKCS10 +// ** ОткрытыйКлюч - ДвоичныеДанные - данные ключа +// ** ИмяПровайдера - Строка - содержит имя провайдера использованный для генерации ключа +// ** ТипПровайдера - Число - тип провайдера использованный для генерации ключа +// ИдентификаторЗаявления - Строка - длина - 36 - обычно уникальный идентификатор, используется для последующей установки сертификата +// СодержаниеЗапроса - Строка - описание полей для запроса на сертификат +// ИдентификаторАбонента - Строка - длина - 36 - уникальный идентификатор +// НотариусАдвокатГлаваКФХ - Булево - используется при формировании ОГРН +// +Процедура СоздатьКонтейнерИЗапросНаСертификат(ОповещениеОЗавершении, Экспорт +``` + +Пример вызова +```bsl +МенеджерСервисаКриптографииКлиент.СоздатьКонтейнерИЗапросНаСертификат(ОповещениеОЗавершении, ); +``` +
+ +## УстановитьСертификатВКонтейнерИХранилище +
+ +Описание, пример вызова + +```bsl + +// Устанавливает сертификат в защищенном хранилище +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ИнформацияОбОшибке. +// ** ОписаниеОшибки - ИнформацияОбОшибке - описание ошибки выполнения, в случае возникновения ошибки. +// ИдентификаторЗаявления - Строка - длина - 36 - обычно уникальный идентификатор, используется сопоставления закрытого ключа. +// ДанныеСертификата - ДвоичныеДанные - в кодировке DER или PEM +// +Процедура УстановитьСертификатВКонтейнерИХранилище(ОповещениеОЗавершении, Экспорт +``` + +Пример вызова +```bsl +МенеджерСервисаКриптографииКлиент.УстановитьСертификатВКонтейнерИХранилище(ОповещениеОЗавершении, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МиграцияПриложенийГлобальный.md b/src/content/docs/bsp/МиграцияПриложенийГлобальный.md new file mode 100644 index 0000000..3e522ae --- /dev/null +++ b/src/content/docs/bsp/МиграцияПриложенийГлобальный.md @@ -0,0 +1,62 @@ +--- +title: Миграция приложений глобальный +slug: bsp/миграция-приложений-глобальный +--- + + +## ОбновитьСтатусПереходаВСервис +
+ +Описание, пример вызова + +```bsl + +// Нужно из-за того что в веб-клиенте в неоткрытой форме не выполняется обработчик ожидания +Процедура ОбновитьСтатусПереходаВСервис() Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложенийГлобальный.ОбновитьСтатусПереходаВСервис() +``` +
+ +## ПодключитьОбработчикОбновленияСтатусаПереходаВСервис +
+ +Описание, пример вызова + +```bsl + +Процедура ПодключитьОбработчикОбновленияСтатусаПереходаВСервис() Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложенийГлобальный.ПодключитьОбработчикОбновленияСтатусаПереходаВСервис() +``` +
+ +## ОтключитьОбработчикОбновленияСтатусаПереходаВСервис +
+ +Описание, пример вызова + +```bsl + +Процедура ОтключитьОбработчикОбновленияСтатусаПереходаВСервис() Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложенийГлобальный.ОтключитьОбработчикОбновленияСтатусаПереходаВСервис() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МиграцияПриложенийКлиентСервер.md b/src/content/docs/bsp/МиграцияПриложенийКлиентСервер.md new file mode 100644 index 0000000..b21eb28 --- /dev/null +++ b/src/content/docs/bsp/МиграцияПриложенийКлиентСервер.md @@ -0,0 +1,166 @@ +--- +title: Миграция приложений клиент сервер +slug: bsp/миграция-приложений-клиент-сервер +--- + + +## ПравоЗапуск +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Строка - Право запуск +Функция ПравоЗапуск() Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложенийКлиентСервер.ПравоЗапуск() +``` +
+ +## ПравоЗапускИАдминистрирование +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Строка - Право запуск и администрирование +Функция ПравоЗапускИАдминистрирование() Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложенийКлиентСервер.ПравоЗапускИАдминистрирование() +``` +
+ +## РольВладелец +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Строка - роль владелец. +Функция РольВладелец() Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложенийКлиентСервер.РольВладелец() +``` +
+ +## РольАдминистратор +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Строка - роль администратор. +Функция РольАдминистратор() Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложенийКлиентСервер.РольАдминистратор() +``` +
+ +## РольПользователь +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Строка - роль пользователь. +Функция РольПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложенийКлиентСервер.РольПользователь() +``` +
+ +## ПредставлениеРоли +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Идентификатор - Строка +// +// Возвращаемое значение: +// Строка +Функция ПредставлениеРоли(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложенийКлиентСервер.ПредставлениеРоли(Идентификатор) +``` +
+ +## ИдентификаторAPIРоли +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Представление - Строка +// +// Возвращаемое значение: +// Строка - Идентификатор API роли +Функция ИдентификаторAPIРоли(Представление) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложенийКлиентСервер.ИдентификаторAPIРоли(Представление) +``` +
+ +## ИдентификаторAPIПрава +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Представление - Строка +// +// Возвращаемое значение: +// Строка +Функция ИдентификаторAPIПрава(Представление) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложенийКлиентСервер.ИдентификаторAPIПрава(Представление) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МиграцияПриложенийПереопределяемый.md b/src/content/docs/bsp/МиграцияПриложенийПереопределяемый.md new file mode 100644 index 0000000..dc939e8 --- /dev/null +++ b/src/content/docs/bsp/МиграцияПриложенийПереопределяемый.md @@ -0,0 +1,87 @@ +--- +title: Миграция приложений переопределяемый +slug: bsp/миграция-приложений-переопределяемый +--- + + +## ПриОпределенииСервисов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при определении сервисов, которые поддерживают миграцию. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Сервисы - СписокЗначений - в качестве значения адрес сервиса, в качестве представления - представление сервиса. +// +Процедура ПриОпределенииСервисов(Сервисы) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложенийПереопределяемый.ПриОпределенииСервисов(Сервисы) +``` +
+ +## ПриВыгрузкеОбъекта +
+ +Описание, пример вызова + +```bsl + +// Обработчик при выгрузке данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект, ПланСчетовОбъект - +// - ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект, РегистрСведенийНаборЗаписей - +// - РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей, РегистрРасчетаНаборЗаписей - +// - ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей, БизнесПроцессОбъект, ЗадачаОбъект - выгружаемый объект. +// Отказ - Булево - если данному параметру установить значение Истина, то объект не будет выгружен. +// +Процедура ПриВыгрузкеОбъекта(Объект, Отказ) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложенийПереопределяемый.ПриВыгрузкеОбъекта(Объект, Отказ) +``` +
+ +## ПриЗагрузкеОбъекта +
+ +Описание, пример вызова + +```bsl + +// Обработчик при загрузке данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект, ПланСчетовОбъект - +// - ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект, РегистрСведенийНаборЗаписей - +// - РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей, РегистрРасчетаНаборЗаписей - +// - ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей, БизнесПроцессОбъект, ЗадачаОбъект - загружаемый объект. +// Отказ - Булево - если данному параметру установить значение Истина, то объект не будет загружен. +// +Процедура ПриЗагрузкеОбъекта(Объект, Отказ) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложенийПереопределяемый.ПриЗагрузкеОбъекта(Объект, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МультиязычностьКлиент.md b/src/content/docs/bsp/МультиязычностьКлиент.md new file mode 100644 index 0000000..90fa3b7 --- /dev/null +++ b/src/content/docs/bsp/МультиязычностьКлиент.md @@ -0,0 +1,38 @@ +--- +title: Мультиязычность клиент +slug: bsp/мультиязычность-клиент +--- + + +## ПриОткрытии +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриОткрытии поля ввода формы для открытия формы ввода значения реквизита на разных языках. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма содержащая мультиязычные реквизиты. +// Объект - ДанныеФормыСтруктура: +// * Ссылка - ЛюбаяСсылка +// Элемент - ПолеФормы - элемент формы, для которого будет открыта форма ввода на разных языках. +// СтандартнаяОбработка - Булево - признак выполнения стандартной (системной) обработки события. +// +Процедура ПриОткрытии(Форма, Объект, Элемент, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МультиязычностьКлиент.ПриОткрытии(Форма, Объект, Элемент, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МультиязычностьКлиентСервер.md b/src/content/docs/bsp/МультиязычностьКлиентСервер.md new file mode 100644 index 0000000..26b3cf2 --- /dev/null +++ b/src/content/docs/bsp/МультиязычностьКлиентСервер.md @@ -0,0 +1,89 @@ +--- +title: Мультиязычность клиент сервер +slug: bsp/мультиязычность-клиент-сервер +--- + + +## СуффиксЯзыка +
+ +Описание, пример вызова + +```bsl + +// Возражает суффикс языка с порядковым номером языка. Например, "Язык1". +// +// Параметры: +// ПорядковыйНомерЯзыка - Число - порядковый номер языка в приложении. +// +// Возвращаемое значение: +// Строка - суффикс языка с порядковым номером языка. +// +Функция СуффиксЯзыка(ПорядковыйНомерЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МультиязычностьКлиентСервер.СуффиксЯзыка(ПорядковыйНомерЯзыка); +``` +
+ +## ОбработкаПолученияПредставления +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении представления объекта или ссылки в зависимости от языка, +// используемого при работе пользователя. +// +// Параметры: +// Данные - Структура - содержит значения полей, из которых формируется представление. +// Представление - Строка - в данный параметр нужно поместить сформированное представление. +// СтандартнаяОбработка - Булево - в данный параметр передается признак формирования стандартного представления. +// ИмяРеквизита - Строка - указывает, в каком реквизите хранится представление на основном языке. +// +Процедура ОбработкаПолученияПредставления(Данные, Представление, СтандартнаяОбработка, ИмяРеквизита = "Наименование") Экспорт +``` + +Пример вызова +```bsl +МультиязычностьКлиентСервер.ОбработкаПолученияПредставления(Данные, Представление, СтандартнаяОбработка, ИмяРеквизита); +``` +
+ +## ОбработкаПолученияПолейПредставления +
+ +Описание, пример вызова + +```bsl + +// Вызывается для формирования состава полей, из которых формируется представление объекта или ссылки. +// Состав полей формируется с учетом текущего языка пользователя. +// +// Параметры: +// Поля - Массив - массив, содержащий имена полей, которые нужны для формирования представления объекта +// или ссылки. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной (системной) обработки события. +// Если в теле процедуры-обработчика установить данному параметру значение Ложь, +// стандартная обработка события производиться не будет. +// ИмяРеквизита - Строка - указывает, в каком реквизите хранится представление на основном языке. +// +Процедура ОбработкаПолученияПолейПредставления(Поля, СтандартнаяОбработка, ИмяРеквизита = "Наименование") Экспорт +``` + +Пример вызова +```bsl +МультиязычностьКлиентСервер.ОбработкаПолученияПолейПредставления(Поля, СтандартнаяОбработка, ИмяРеквизита); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МультиязычностьПереопределяемый.md b/src/content/docs/bsp/МультиязычностьПереопределяемый.md new file mode 100644 index 0000000..6936b1f --- /dev/null +++ b/src/content/docs/bsp/МультиязычностьПереопределяемый.md @@ -0,0 +1,42 @@ +--- +title: Мультиязычность переопределяемый +slug: bsp/мультиязычность-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Задает настройки мультиязычных данных. +// +// Параметры: +// Настройки - Структура - коллекция настроек подсистемы. Реквизиты: +// * КодДополнительногоЯзыка1 - Строка - код первого дополнительного языка по умолчанию. +// * КодДополнительногоЯзыка2 - Строка - код второго дополнительного языка по умолчанию. +// * МультиязычныеДанные - Булево - если Истина, то у реквизитов поддерживающих возможность ввода данных на нескольких +// языках будет автоматически добавлен интерфейс ввода мультиязычных данных. +// +// Пример: +// Настройки.КодДополнительногоЯзыка1 = "en"; +// Настройки.КодДополнительногоЯзыка2 = "it"; +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +МультиязычностьПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/МультиязычностьСервер.md b/src/content/docs/bsp/МультиязычностьСервер.md new file mode 100644 index 0000000..e14a4ae --- /dev/null +++ b/src/content/docs/bsp/МультиязычностьСервер.md @@ -0,0 +1,362 @@ +--- +title: Мультиязычность сервер +slug: bsp/мультиязычность-сервер +--- + + +## ЗаполнитьМультиязычныйРеквизит +
+ +Описание, пример вызова + +```bsl + +// Для вызова из обработчика ПриНачальномЗаполненииЭлементов. +// Заполняет колонки с именами ИмяРеквизита_<КодЯзыка> текстовыми значениями для указанных кодов языков. +// +// Параметры: +// Элемент - СтрокаТаблицыЗначений - заполняемая строка таблицы с колонками ИмяРеквизита_КодЯзыка. +// ИмяРеквизита - Строка - имя реквизита. Например, "Наименование" +// ИсходнаяСтрока - Строка - строка в формате НСтр. Например, "ru = 'Сообщение на русском'; en = 'English message'". +// КодыЯзыков - Массив - коды языков, на которых нужно заполнить строки. +// +// Пример: +// +// МультиязычностьСервер.ЗаполнитьМультиязычныйРеквизит(Элемент, "Наименование", "ru = 'Сообщение на русском'; en = +// 'English message'", КодыЯзыков); +// +Процедура ЗаполнитьМультиязычныйРеквизит(Элемент, ИмяРеквизита, ИсходнаяСтрока, КодыЯзыков = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МультиязычностьСервер.ЗаполнитьМультиязычныйРеквизит(Элемент, ИмяРеквизита, ИсходнаяСтрока, КодыЯзыков); +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ПриСозданииНаСервере формы объекта. Добавляет кнопку открытия в поля ввода +// мультиязычных реквизитов на этой форме. Нажатие кнопки открывает окно ввода значения реквизита на всех +// имеющихся в конфигурации языках. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта. +// Объект - ДанныеФормыСтруктура: +// * Ссылка - ЛюбаяСсылка +// ИмяОбъекта - Строка - для форм списка имя динамического списка на форме. По умолчанию, "Список". +// Для других форм имя основного реквизита на форме. Следует использовать, +// если имя отличается от стандартных: "Объект", "Запись", "Список". +// +Процедура ПриСозданииНаСервере(Форма, Объект = Неопределено, ИмяОбъекта = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МультиязычностьСервер.ПриСозданииНаСервере(Форма, Объект, ИмяОбъекта); +``` +
+ +## ПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ПриЧтениеНаСервере формы объекта для заполнения значений мультиязычных +// реквизитов формы на текущем языке пользователя. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта. +// ТекущийОбъект - Произвольный - объект, который был получен в обработчике формы ПриЧтенииНаСервере. +// ИмяОбъекта - Строка - имя основного реквизита на форме. Следует использовать, +// если имя отличается от стандартных: "Объект", "Запись", "Список". +// +Процедура ПриЧтенииНаСервере(Форма, ТекущийОбъект, ИмяОбъекта = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МультиязычностьСервер.ПриЧтенииНаСервере(Форма, ТекущийОбъект, ИмяОбъекта); +``` +
+ +## ПередЗаписьюНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ПередЗаписьюНаСервере формы объекта или при программной записи объекта +// для записи значений мультиязычных реквизитов в соответствии с текущим языком пользователя. +// +// Параметры: +// ТекущийОбъект - БизнесПроцессОбъект +// - ДокументОбъект +// - ЗадачаОбъект +// - ПланВидовРасчетаОбъект +// - ПланВидовХарактеристикОбъект +// - ПланОбменаОбъект +// - ПланСчетовОбъект +// - СправочникОбъект - записываемый объект. +// +Процедура ПередЗаписьюНаСервере(ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +МультиязычностьСервер.ПередЗаписьюНаСервере(ТекущийОбъект) +``` +
+ +## ПриЧтенииПредставленийНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается из модуля объекта для заполнения значений мультиязычных +// реквизитов объекта на текущем языке пользователя. +// +// Параметры: +// Объект - БизнесПроцессОбъект +// - ДокументОбъект +// - ЗадачаОбъект +// - ПланВидовРасчетаОбъект +// - ПланВидовХарактеристикОбъект +// - ПланОбменаОбъект +// - ПланСчетовОбъект +// - СправочникОбъект - объект данных. +// +Процедура ПриЧтенииПредставленийНаСервере(Объект) Экспорт +``` + +Пример вызова +```bsl +МультиязычностьСервер.ПриЧтенииПредставленийНаСервере(Объект) +``` +
+ +## ОбработкаПолученияДанныхВыбора +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ОбработкаПолученияДанныхВыбора для формирования списка при вводе по строке, +// автоподборе текста и быстром выбора, а также при выполнении метода ПолучитьДанныеВыбора. +// Список содержит варианты на всех языках с учетом реквизитов определенных в свойстве ВводПоСтроке. +// +// Параметры: +// ДанныеВыбора - СписокЗначений - данные для выбора. +// Параметры - Структура - содержит параметры выбора. +// СтандартнаяОбработка - Булево - данный параметр передается признак выполнения стандартной (системной) обработки события. +// ОбъектМетаданных - ОбъектМетаданныхБизнесПроцесс +// - ОбъектМетаданныхДокумент +// - ОбъектМетаданныхЗадача +// - ОбъектМетаданныхПланВидовРасчета +// - ОбъектМетаданныхПланВидовХарактеристик +// - ОбъектМетаданныхПланОбмена +// - ОбъектМетаданныхПланСчетов +// - ОбъектМетаданныхСправочник +// - ОбъектМетаданныхТаблица - объект метаданных, для которого формируется список выбора. +// +Процедура ОбработкаПолученияДанныхВыбора(ДанныеВыбора, Знач Параметры, СтандартнаяОбработка, ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +МультиязычностьСервер.ОбработкаПолученияДанныхВыбора(ДанныеВыбора, Параметры, СтандартнаяОбработка, ОбъектМетаданных) +``` +
+ +## ИзменитьПолеЗапросаПодТекущийЯзык +
+ +Описание, пример вызова + +```bsl + +// Добавляет к имени поля в тексте запроса языковой суффикс текущего языка. +// Примеры конвертации полей: +// - если параметр ИмяПоля равно "Свойства.Заголовок", то поле преобразует в "Свойства.ЗаголовокЯзык1"; +// - если параметр ИмяПоля равно "Свойства.Заголовок КАК Заголовок", +// то поле преобразует в "Свойства.ЗаголовокЯзык1 КАК Заголовок". +// +// Параметры: +// ТекстЗапроса - Строка - текст запроса в котором изменяется имя поля +// ИмяПоля - Строка - имя заменяемого поля +// +Процедура ИзменитьПолеЗапросаПодТекущийЯзык(ТекстЗапроса, ИмяПоля) Экспорт +``` + +Пример вызова +```bsl +МультиязычностьСервер.ИзменитьПолеЗапросаПодТекущийЯзык(ТекстЗапроса, ИмяПоля) +``` +
+ +## СуффиксТекущегоЯзыка +
+ +Описание, пример вызова + +```bsl + +// Возвращает суффикс дополнительного языка для текущего языка интерфейса пользователя. +// +// Возвращаемое значение: +// Строка - суффикс языка, который добавляются к имени реквизита в котором хранится значение на указанном языке. +// Например, суффикс "Язык1", для реквизита "НаименованиеЯзык1" +// +Функция СуффиксТекущегоЯзыка() Экспорт +``` + +Пример вызова +```bsl +Результат = МультиязычностьСервер.СуффиксТекущегоЯзыка() +``` +
+ +## СуффиксЯзыка +
+ +Описание, пример вызова + +```bsl + +// По коду языка возвращает суффикс дополнительного языка. +// +// Параметры: +// КодЯзыка - Строка - короткие буквенные представления языков. Например, "en". +// +// Возвращаемое значение: +// Строка - суффикс языка, который добавляются к имени реквизита в котором хранится значение на указанном языке. +// Например, суффикс "Язык1", для реквизита "НаименованиеЯзык1" +// +Функция СуффиксЯзыка(КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +Результат = МультиязычностьСервер.СуффиксЯзыка(КодЯзыка) +``` +
+ +## ИспользуетсяДополнительныйЯзык +
+ +Описание, пример вызова + +```bsl + +// Определяет используется ли в приложении переданный дополнительный язык. +// +// Параметры: +// ПорядковыйНомерЯзыка - Число - номер языка в суффиксе дополнительного языка. Например, 1 для "Язык1". +// +// Возвращаемое значение: +// Булево - если, Истина, то дополнительный язык включен в приложении и используется. +// +Функция ИспользуетсяДополнительныйЯзык(ПорядковыйНомерЯзыка) Экспорт +``` + +Пример вызова +```bsl +Результат = МультиязычностьСервер.ИспользуетсяДополнительныйЯзык(ПорядковыйНомерЯзыка) +``` +
+ +## ИменаРеквизитовСУчетомКодаЯзыка +
+ +Описание, пример вызова + +```bsl + +// Возвращает имена реквизитов с учетом переданного кода языка. +// +// Параметры: +// ИменаРеквизитов - Строка - список имена реквизитов через запятую. Например, "Наименование,Комментарий" +// КодЯзыка - Строка - код языка, если не указан, то список будет сформирования для текущего языка пользователя. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - имя реквизита, Например, "Наименование" +// * Значение - Строка - имя реквизита с суффиксом языка. Например, "НаименованияЯзык2" +// +Функция ИменаРеквизитовСУчетомКодаЯзыка(ИменаРеквизитов, КодЯзыка = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МультиязычностьСервер.ИменаРеквизитовСУчетомКодаЯзыка(ИменаРеквизитов, КодЯзыка); +``` +
+ +## КоличествоДополнительныхЯзыков +
+ +Описание, пример вызова + +```bsl + +// Возвращает количество дополнительных языков. +// +// Возвращаемое значение: +// Число - количество дополнительных языков в конфигурации +// +Функция КоличествоДополнительныхЯзыков() Экспорт +``` + +Пример вызова +```bsl +Результат = МультиязычностьСервер.КоличествоДополнительныхЯзыков() +``` +
+ +## СведенияОЯзыках +
+ +Описание, пример вызова + +```bsl + +// Возвращает обобщенные сведения о языках. +// Структура содержит свойства вида "Язык + номер языка" (например, Язык1) с кодами языков. +// Количество таких свойств соответствует числу дополнительных языков. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * Язык0 - Строка - код основного языка. +// * КоличествоДополнительныхЯзыков - Число - количество дополнительных языков в конфигурации +// * ОсновнойЯзык - Строка - код основного языка. +// * Используется - ФиксированнаяСтруктура: +// ** Ключ - Строка - суффикса языка +// ** Значение - Булево - Истина, если язык включен в приложении. +// +Функция СведенияОЯзыках() Экспорт +``` + +Пример вызова +```bsl +Результат = МультиязычностьСервер.СведенияОЯзыках() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/НапоминанияПользователя.md b/src/content/docs/bsp/НапоминанияПользователя.md new file mode 100644 index 0000000..ea6dad4 --- /dev/null +++ b/src/content/docs/bsp/НапоминанияПользователя.md @@ -0,0 +1,242 @@ +--- +title: Напоминания пользователя +slug: bsp/напоминания-пользователя +--- + + +## УстановитьНапоминание +
+ +Описание, пример вызова + +```bsl + +// Создает напоминание с произвольным временем или расписанием выполнения. +// +// Параметры: +// Текст - Строка - текст напоминания; +// ВремяСобытия - Дата - дата и время события, о котором надо напомнить. +// - РасписаниеРегламентногоЗадания - расписание периодического события. +// - Строка - имя реквизита Предмета, в котором содержится время наступления события. +// ИнтервалДоСобытия - Число - время в секундах, за которое необходимо напомнить относительно времени события; +// Предмет - ЛюбаяСсылка - предмет напоминания; +// Идентификатор - Строка - уточняет предмет напоминания, например, "ДеньРождения". +// +Процедура УстановитьНапоминание(Текст, ВремяСобытия, ИнтервалДоСобытия = 0, Предмет = Неопределено, Идентификатор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователя.УстановитьНапоминание(Текст, ВремяСобытия, ИнтервалДоСобытия, Предмет, Идентификатор); +``` +
+ +## НайтиНапоминания +
+ +Описание, пример вызова + +```bsl + +// Возвращает список напоминаний текущего пользователя. +// +// Параметры: +// Предмет - ЛюбаяСсылка +// - Массив - предмет или предметы напоминания. +// Идентификатор - Строка - уточняет предмет напоминания, например, "ДеньРождения". +// +// Возвращаемое значение: +// Массив - коллекция напоминаний в виде структур с полями, соответствующими полям регистра сведений НапоминанияПользователя. +// +Функция НайтиНапоминания(Знач Предмет = Неопределено, Идентификатор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = НапоминанияПользователя.НайтиНапоминания(Предмет, Идентификатор); +``` +
+ +## УдалитьНапоминание +
+ +Описание, пример вызова + +```bsl + +// Удаляет напоминание пользователя. +// +// Параметры: +// Напоминание - Структура - элемент коллекции, возвращаемый функцией НайтиНапоминания(). +// +Процедура УдалитьНапоминание(Напоминание) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователя.УдалитьНапоминание(Напоминание) +``` +
+ +## ОбновитьНапоминанияПоПредметам +
+ +Описание, пример вызова + +```bsl + +// Проверяет изменения реквизитов предметов, на которые есть пользовательская подписка, +// изменяет срок напоминания в случае необходимости. +// +// Параметры: +// Предметы - Массив - предметы, по которым необходимо обновить сроки напоминаний. +// +Процедура ОбновитьНапоминанияПоПредметам(Предметы) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователя.ОбновитьНапоминанияПоПредметам(Предметы) +``` +
+ +## ИспользуютсяНапоминанияПользователя +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность использования напоминаний пользователя. +// +// Возвращаемое значение: +// Булево - используются напоминания пользователя +// +Функция ИспользуютсяНапоминанияПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = НапоминанияПользователя.ИспользуютсяНапоминанияПользователя() +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик одноименного события формы, размещает на форме элементы для настройки напоминания. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой необходимо разместить элементы настройки напоминания. +// ПараметрыРазмещения - см. ПараметрыРазмещения +// +Процедура ПриСозданииНаСервере(Форма, ПараметрыРазмещения) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователя.ПриСозданииНаСервере(Форма, ПараметрыРазмещения) +``` +
+ +## ПараметрыРазмещения +
+ +Описание, пример вызова + +```bsl + +// Определяет параметры размещения на форме элементов настройки напоминания. +// +// Возвращаемое значение: +// Структура: +// * Группа - ГруппаФормы - место размещения элементов настройки напоминания. +// * ИмяРеквизитаСДатойСобытия - Строка - реквизит, относительно которого устанавливается время напоминания о событии. +// * ИнтервалВремениНапоминания - Число - интервал времени напоминания по умолчанию, в секундах. По умолчанию - 0. +// * ДобавлятьФлажок - Булево - если Истина, то рядом с полем ввода интервала времени будет добавлен флажок для +// быстрого включения/отключения напоминания. Если Ложь, то флажок выводиться не будет, +// отключение напоминания будет доступно в списке выбора интервалов времени. Значение по +// умолчанию - Ложь. +// +Функция ПараметрыРазмещения() Экспорт +``` + +Пример вызова +```bsl +Результат = НапоминанияПользователя.ПараметрыРазмещения() +``` +
+ +## ПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик одноименного события формы, обновляет на форме элементы, связанные с настройкой напоминания. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой необходимо разместить элементы настройки напоминания. +// ТекущийОбъект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - предмет напоминания. +// +Процедура ПриЧтенииНаСервере(Форма, ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователя.ПриЧтенииНаСервере(Форма, ТекущийОбъект) +``` +
+ +## ПриЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик одноименного события формы, устанавливает напоминание по предмету при записи объекта в форме. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой размещены элементы настройки напоминания. +// Отказ - Булево - признак отказа от записи. +// ТекущийОбъект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - предмет напоминания. +// ПараметрыЗаписи - Структура +// ТекстНапоминания - Строка - текст устанавливаемого напоминания. Если не заполнен, то используется представление +// предмета напоминания. +// +Процедура ПриЗаписиНаСервере(Форма, Отказ, ТекущийОбъект, ПараметрыЗаписи, ТекстНапоминания = "") Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователя.ПриЗаписиНаСервере(Форма, Отказ, ТекущийОбъект, ПараметрыЗаписи, ТекстНапоминания); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/НапоминанияПользователяКлиент.md b/src/content/docs/bsp/НапоминанияПользователяКлиент.md new file mode 100644 index 0000000..9e75704 --- /dev/null +++ b/src/content/docs/bsp/НапоминанияПользователяКлиент.md @@ -0,0 +1,216 @@ +--- +title: Напоминания пользователя клиент +slug: bsp/напоминания-пользователя-клиент +--- + + +## Включить +
+ +Описание, пример вызова + +```bsl + +// Запускает периодическую проверку текущих напоминаний пользователя. +Процедура Включить() Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяКлиент.Включить() +``` +
+ +## Выключить +
+ +Описание, пример вызова + +```bsl + +// Отключает периодическую проверку текущих напоминаний пользователя. +Процедура Выключить() Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяКлиент.Выключить() +``` +
+ +## НапомнитьВУказанноеВремя +
+ +Описание, пример вызова + +```bsl + +// Создает новое напоминание на указанное время. +// +// Параметры: +// Текст - Строка - текст напоминания; +// Время - Дата - дата и время напоминания; +// Предмет - ЛюбаяСсылка - предмет напоминания; +// Идентификатор - Строка - уточняет предмет напоминания, например, "ДеньРождения". +// +Процедура НапомнитьВУказанноеВремя(Текст, Время, Предмет = Неопределено, Идентификатор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяКлиент.НапомнитьВУказанноеВремя(Текст, Время, Предмет, Идентификатор); +``` +
+ +## НапомнитьДоВремениПредмета +
+ +Описание, пример вызова + +```bsl + +// Создает новое напоминание на время, рассчитанное относительно времени в предмете. +// +// Параметры: +// Текст - Строка - текст напоминания; +// Интервал - Число - время в секундах, за которое необходимо напомнить относительно даты в реквизите предмета; +// Предмет - ЛюбаяСсылка - предмет напоминания; +// ИмяРеквизита - Строка - имя реквизита предмета, относительно которого устанавливается срок напоминания. +// +Процедура НапомнитьДоВремениПредмета(Текст, Интервал, Предмет, ИмяРеквизита) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяКлиент.НапомнитьДоВремениПредмета(Текст, Интервал, Предмет, ИмяРеквизита) +``` +
+ +## Напомнить +
+ +Описание, пример вызова + +```bsl + +// Создает напоминание с произвольным временем или расписанием выполнения. +// +// Параметры: +// Текст - Строка - текст напоминания; +// ВремяСобытия - Дата - дата и время события, о котором надо напомнить; +// - РасписаниеРегламентногоЗадания - расписание периодического события; +// - Строка - имя реквизита предмета напоминания, в котором содержится время наступления события. +// ИнтервалДоСобытия - Число - время в секундах, за которое необходимо напомнить относительно времени события; +// Предмет - ЛюбаяСсылка - предмет напоминания; +// Идентификатор - Строка - уточняет предмет напоминания, например, "ДеньРождения". +// +Процедура Напомнить(Текст, ВремяСобытия, ИнтервалДоСобытия = 0, Предмет = Неопределено, Идентификатор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяКлиент.Напомнить(Текст, ВремяСобытия, ИнтервалДоСобытия, Предмет, Идентификатор); +``` +
+ +## НапомнитьОЕжегодномСобытииПредмета +
+ +Описание, пример вызова + +```bsl + +// Создает ежегодное напоминание на дату предмета. +// +// Параметры: +// Текст - Строка - текст напоминания; +// Интервал - Число - время в секундах, за которое необходимо напомнить относительно даты в реквизите предмета; +// Предмет - ЛюбаяСсылка - предмет напоминания; +// ИмяРеквизита - Строка - имя реквизита предмета, относительно которого устанавливается срок напоминания. +// +Процедура НапомнитьОЕжегодномСобытииПредмета(Текст, Интервал, Предмет, ИмяРеквизита) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяКлиент.НапомнитьОЕжегодномСобытииПредмета(Текст, Интервал, Предмет, ИмяРеквизита) +``` +
+ +## ПриИзмененииНастройкиНапоминания +
+ +Описание, пример вызова + +```bsl + +// Обработчик одноименного события формы. +// +// Параметры: +// Элемент - ПолеФормы - форма, в которой размещены элементы настройки напоминания. +// Форма - ФормаКлиентскогоПриложения - форма, в которой размещены элементы настройки напоминания. +// +Процедура ПриИзмененииНастройкиНапоминания(Элемент, Форма) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяКлиент.ПриИзмененииНастройкиНапоминания(Элемент, Форма) +``` +
+ +## ОбработкаОповещения +
+ +Описание, пример вызова + +```bsl + +// Обработчик одноименного события формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой размещены элементы настройки напоминания. +// ИмяСобытия - Строка +// Параметр - Структура: +// * ИмяРеквизитаИсточника - Строка - имя реквизита предмета, относительно которого устанавливается срок напоминания. +// * ИнтервалВремениНапоминания - Число - интервал времени в секундах, за который необходимо напомнить +// относительно даты в реквизите предмета. +// * Предмет - ЛюбаяСсылка - предмет напоминания. +// * СпособУстановкиВремениНапоминания - ПеречислениеСсылка.СпособыУстановкиВремениНапоминания. +// * СрокНапоминания - Дата. +// Источник - ФормаКлиентскогоПриложения +// - Произвольный - источник события. +// +Процедура ОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяКлиент.ОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) +``` +
+ +## ОткрытьНастройки +
+ +Описание, пример вызова + +```bsl + +// Открывает форму настроек напоминаний. +Процедура ОткрытьНастройки() Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяКлиент.ОткрытьНастройки() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/НапоминанияПользователяКлиентСервер.md b/src/content/docs/bsp/НапоминанияПользователяКлиентСервер.md new file mode 100644 index 0000000..9826921 --- /dev/null +++ b/src/content/docs/bsp/НапоминанияПользователяКлиентСервер.md @@ -0,0 +1,37 @@ +--- +title: Напоминания пользователя клиент сервер +slug: bsp/напоминания-пользователя-клиент-сервер +--- + + +## ЕжегодноеРасписание +
+ +Описание, пример вызова + +```bsl + +// Возвращает ежегодное расписание для события на указанную дату. +// +// Параметры: +// ДатаСобытия - Дата - произвольная дата. +// +// Возвращаемое значение: +// РасписаниеРегламентногоЗадания - расписание. +// +Функция ЕжегодноеРасписание(ДатаСобытия) Экспорт +``` + +Пример вызова +```bsl +Результат = НапоминанияПользователяКлиентСервер.ЕжегодноеРасписание(ДатаСобытия) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/НапоминанияПользователяПереопределяемый.md b/src/content/docs/bsp/НапоминанияПользователяПереопределяемый.md new file mode 100644 index 0000000..1ba9d9f --- /dev/null +++ b/src/content/docs/bsp/НапоминанияПользователяПереопределяемый.md @@ -0,0 +1,62 @@ +--- +title: Напоминания пользователя переопределяемый +slug: bsp/напоминания-пользователя-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Переопределяет настройки подсистемы. +// +// Параметры: +// Настройки - Структура: +// * Расписания - Соответствие из КлючИЗначение: +// ** Ключ - Строка - представление расписания; +// ** Значение - РасписаниеРегламентногоЗадания - вариант расписания. +// * СтандартныеИнтервалы - Массив - содержит строковые представления интервалов времени. +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриЗаполненииСпискаРеквизитовИсточникаСДатамиДляНапоминания +
+ +Описание, пример вызова + +```bsl + +// Переопределяет массив реквизитов объекта, относительно которых разрешается устанавливать время напоминания. +// Например, можно скрыть те реквизиты с датами, которые являются служебными или не имеют смысла для +// установки напоминаний: дата документа или задачи и прочие. +// +// Параметры: +// Источник - ЛюбаяСсылка - ссылка на объект, для которого формируется массив реквизитов с датами; +// РеквизитыСДатами - Массив - имена реквизитов (из метаданных), содержащих даты. +// +Процедура ПриЗаполненииСпискаРеквизитовИсточникаСДатамиДляНапоминания(Источник, РеквизитыСДатами) Экспорт +``` + +Пример вызова +```bsl +НапоминанияПользователяПереопределяемый.ПриЗаполненииСпискаРеквизитовИсточникаСДатамиДляНапоминания(Источник, РеквизитыСДатами) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/НастройкаПорядкаЭлементов.md b/src/content/docs/bsp/НастройкаПорядкаЭлементов.md new file mode 100644 index 0000000..ded06ba --- /dev/null +++ b/src/content/docs/bsp/НастройкаПорядкаЭлементов.md @@ -0,0 +1,84 @@ +--- +title: Настройка порядка элементов +slug: bsp/настройка-порядка-элементов +--- + + +## УстановитьЗначениеРеквизитаУпорядочивания +
+ +Описание, пример вызова + +```bsl + +// Заполняет значение реквизита дополнительного упорядочивания у объекта. +// +// Параметры: +// Объект - СправочникОбъект +// - ПланВидовХарактеристикОбъект - объект, у которого необходимо установить значение +// реквизита упорядочивания. +// +Процедура УстановитьЗначениеРеквизитаУпорядочивания(Объект) Экспорт +``` + +Пример вызова +```bsl +НастройкаПорядкаЭлементов.УстановитьЗначениеРеквизитаУпорядочивания(Объект) +``` +
+ +## СброситьЗначениеРеквизитаУпорядочивания +
+ +Описание, пример вызова + +```bsl + +// Обнуляет значение реквизита дополнительного упорядочивания у объекта. +// +// Параметры: +// Источник - СправочникОбъект +// - ПланВидовХарактеристикОбъект - объект, создаваемый копированием; +// ОбъектКопирования - СправочникСсылка +// - ПланВидовХарактеристикСсылка - исходный объект, который является источником копирования. +// +Процедура СброситьЗначениеРеквизитаУпорядочивания(Источник, ОбъектКопирования) Экспорт +``` + +Пример вызова +```bsl +НастройкаПорядкаЭлементов.СброситьЗначениеРеквизитаУпорядочивания(Источник, ОбъектКопирования) +``` +
+ +## ПолучитьИнформациюДляПеремещения +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру с информацией о метаданных объекта. +// +// Параметры: +// МетаданныеОбъекта - ОбъектМетаданных - метаданные перемещаемого объекта. +// +// Возвращаемое значение: +// Структура - информация из метаданных объекта. +// +Функция ПолучитьИнформациюДляПеремещения(МетаданныеОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = НастройкаПорядкаЭлементов.ПолучитьИнформациюДляПеремещения(МетаданныеОбъекта) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/НастройкиПрограммыБИПКлиент.md b/src/content/docs/bsp/НастройкиПрограммыБИПКлиент.md new file mode 100644 index 0000000..bb77a5a --- /dev/null +++ b/src/content/docs/bsp/НастройкиПрограммыБИПКлиент.md @@ -0,0 +1,34 @@ +--- +title: Настройки программы БИП клиент +slug: bsp/настройки-программы-бип-клиент +--- + + +## ОткрытьНастройкиИнтернетПоддержкаИСервисы +
+ +Описание, пример вызова + +```bsl + +// Открывает настройку интернет-поддержки и сервисов БИП. +// +// Параметры: +// ПараметрыВыполненияКоманды - ПараметрыВыполненияКоманды +// +Процедура ОткрытьНастройкиИнтернетПоддержкаИСервисы(ПараметрыВыполненияКоманды) Экспорт +``` + +Пример вызова +```bsl +НастройкиПрограммыБИПКлиент.ОткрытьНастройкиИнтернетПоддержкаИСервисы(ПараметрыВыполненияКоманды) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/НастройкиПрограммыБИППереопределяемый.md b/src/content/docs/bsp/НастройкиПрограммыБИППереопределяемый.md new file mode 100644 index 0000000..4711422 --- /dev/null +++ b/src/content/docs/bsp/НастройкиПрограммыБИППереопределяемый.md @@ -0,0 +1,35 @@ +--- +title: Настройки программы БИП переопределяемый +slug: bsp/настройки-программы-бип-переопределяемый +--- + + +## ПриСозданииФормыИнтернетПоддержкаИСервисы +
+ +Описание, пример вызова + +```bsl + +// Предназначена для внесения изменений в форму ИнтернетПоддержкаИСервисы обработки ПанельАдминистрированияБИП без +// снятия формы с поддержки. +// +// Параметры: +// Форма - см. Обработка.ПанельАдминистрированияБИП.Форма.ИнтернетПоддержкаИСервисы +// +Процедура ПриСозданииФормыИнтернетПоддержкаИСервисы(Форма) Экспорт +``` + +Пример вызова +```bsl +НастройкиПрограммыБИППереопределяемый.ПриСозданииФормыИнтернетПоддержкаИСервисы(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/НастройкиПрограммыПереопределяемый.md b/src/content/docs/bsp/НастройкиПрограммыПереопределяемый.md new file mode 100644 index 0000000..8b90e2c --- /dev/null +++ b/src/content/docs/bsp/НастройкиПрограммыПереопределяемый.md @@ -0,0 +1,189 @@ +--- +title: Настройки программы переопределяемый +slug: bsp/настройки-программы-переопределяемый +--- + + +## ОбслуживаниеПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Предназначена для внесения изменений в форму Обслуживание обработки +// ПанельАдминистрированияБСП без снятия формы с поддержки. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - для внесения изменений. +// +Процедура ОбслуживаниеПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +НастройкиПрограммыПереопределяемый.ОбслуживаниеПриСозданииНаСервере(Форма) +``` +
+ +## ОбщиеНастройкиПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Предназначена для внесения изменений в форму ОбщиеНастройки обработки +// ПанельАдминистрированияБСП без снятия формы с поддержки. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - для внесения изменений. +// +Процедура ОбщиеНастройкиПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +НастройкиПрограммыПереопределяемый.ОбщиеНастройкиПриСозданииНаСервере(Форма) +``` +
+ +## НастройкиПользователейИПравПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Предназначена для внесения изменений в форму Обслуживание обработки +// ПанельАдминистрированияБСП без снятия формы с поддержки. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - для внесения изменений. +// +Процедура НастройкиПользователейИПравПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +НастройкиПрограммыПереопределяемый.НастройкиПользователейИПравПриСозданииНаСервере(Форма) +``` +
+ +## ИнтернетПоддержкаИСервисыПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Предназначена для внесения изменений в форму ИнтернетПоддержкаИСервисы обработки +// ПанельАдминистрированияБСП без снятия формы с поддержки. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - для внесения изменений. +// +Процедура ИнтернетПоддержкаИСервисыПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +НастройкиПрограммыПереопределяемый.ИнтернетПоддержкаИСервисыПриСозданииНаСервере(Форма) +``` +
+ +## ОрганайзерПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Предназначена для внесения изменений в форму Органайзер обработки +// ПанельАдминистрированияБСП без снятия формы с поддержки. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - для внесения изменений. +// +Процедура ОрганайзерПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +НастройкиПрограммыПереопределяемый.ОрганайзерПриСозданииНаСервере(Форма) +``` +
+ +## СинхронизацияДанныхПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Предназначена для внесения изменений в форму СинхронизацияДанных обработки +// ПанельАдминистрированияБСП без снятия формы с поддержки. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - для внесения изменений. +// +Процедура СинхронизацияДанныхПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +НастройкиПрограммыПереопределяемый.СинхронизацияДанныхПриСозданииНаСервере(Форма) +``` +
+ +## НастройкиРаботыСФайламиПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Предназначена для внесения изменений в форму НастройкиРаботыСФайлами обработки +// ПанельАдминистрированияБСП без снятия формы с поддержки. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - для внесения изменений. +// +Процедура НастройкиРаботыСФайламиПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +НастройкиПрограммыПереопределяемый.НастройкиРаботыСФайламиПриСозданииНаСервере(Форма) +``` +
+ +## ПечатныеФормыОтчетыИОбработкиПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Предназначена для внесения изменений в форму ПечатныеФормыОтчетыИОбработки обработки +// ПанельАдминистрированияБСП без снятия формы с поддержки. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - для внесения изменений. +// +Процедура ПечатныеФормыОтчетыИОбработкиПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +НастройкиПрограммыПереопределяемый.ПечатныеФормыОтчетыИОбработкиПриСозданииНаСервере(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиXDTOСервер.md b/src/content/docs/bsp/ОбменДаннымиXDTOСервер.md new file mode 100644 index 0000000..3c5fe05 --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиXDTOСервер.md @@ -0,0 +1,881 @@ +--- +title: Обмен данными XDTO сервер +slug: bsp/обмен-данными-xdto-сервер +--- + + +## ИнициализироватьПравилоКонвертацииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Добавляет строку в таблицу правил конвертации и инициализирует значение в колонке "Свойства". +// Используется в модуле менеджера обмена при заполнении таблицы правил конвертации объектов. +// +// Параметры: +// ПравилаКонвертации - см. КоллекцияПравилКонвертации +// +// Возвращаемое значение: +// СтрокаТаблицыЗначений - строка таблицы правил конвертации. +// +Функция ИнициализироватьПравилоКонвертацииОбъекта(ПравилаКонвертации) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ИнициализироватьПравилоКонвертацииОбъекта(ПравилаКонвертации) +``` +
+ +## ИнициализироватьКомпонентыОбмена +
+ +Описание, пример вызова + +```bsl + +// Инициализирует компоненты обмена. +// +// Параметры: +// НаправлениеОбмена - Строка - направление выполнения обмена: "Отправка" | "Получение". +// +// Возвращаемое значение: +// Структура - содержит компоненты обмена (правила обмена и параметры обмена): +// * ВерсияФорматаОбмена - Строка - номер версии формата обмена. +// * XMLСхема - Строка - пространство имен формата обмена. +// * МенеджерОбмена - ОбщийМодуль - модуль с правилами конвертации. +// * УзелКорреспондента - ПланОбменаСсылка - ссылка на узел плана обмена. +// * УзелКорреспондентаОбъект - ПланОбменаОбъект - объект узла плана обмена. +// * ВерсияФорматаМенеджераОбмена - Строка - номер версии формата модуля с правилами конвертации. +// * НаправлениеОбмена - Строка - "Отправка" или "Получение". +// * ЭтоОбменЧерезПланОбмена - Булево - признак выполнения обмена по плану обмена. +// * ФлагОшибки - Булево - признак наличия ошибки при выполнении действия обмена. +// * СтрокаСообщенияОбОшибке - Строка - описание ошибки при выполнении действия обмена. +// * КлючСообщенияЖурналаРегистрации - Строка - имя события для записи информации об ошибках в журнал регистрации. +// * ИспользоватьКвитирование - Булево - признак использования квитирования для удаления регистрации изменений. +// * ВыгруженныеОбъекты - Массив из ЛюбаяСсылка - коллекция выгруженных объектов. +// * НеВыгруженныеОбъекты - Массив из ЛюбаяСсылка - коллекция не выгруженных объектов. +// * ВыгруженныеПоСсылкеОбъекты - Массив из ЛюбаяСсылка - коллекция объектов, выгруженных "по ссылке". +// * ДокументыДляОтложенногоПроведения - ТаблицаЗначений - коллекция документов для отложенного проведения: +// ** ДокументСсылка - ДокументСсылка - ссылка на документ. +// ** ДатаДокумента - Дата - дата документа. +// * ПоддерживаемыеОбъектыXDTO - Массив из Строка - коллекция идентификаторов объектов формата. +// * ЗагруженныеОбъекты - ТаблицаЗначений - коллекция загруженных объектов: +// ** ИмяОбработчика - Строка - имя обработчика. +// ** Объект - СправочникОбъект +// - ДокументОбъект - загруженный объект. +// ** Параметры - Произвольный - произвольные параметры. +// ** СсылкаНаОбъект - ЛюбаяСсылка - ссылка на загруженный объект. +// * ПравилаОбработкиДанных - см. ТаблицаПравилОбработкиДанных +// * СостояниеОбменаДанными - Структура - описание состояния выполнения обмена: +// ** УзелИнформационнойБазы - ПланОбменаСсылка - узел плана обмена. +// ** ДействиеПриОбмене - ПеречислениеСсылка.ДействияПриОбмене - выполняемое действие. +// ** ДатаНачала - Дата - дата начала выполнения действия. +// ** ДатаОкончания - Дата - дата окончания выполнения действия. +// ** РезультатВыполненияОбмена - ПеречислениеСсылка.РезультатыВыполненияОбмена +// - Неопределено - результат +// выполнения действия. +// * ТаблицаДанныхЗаголовкаПакета - см. НоваяТаблицаДанныхЗаголовкаПакета +// +Функция ИнициализироватьКомпонентыОбмена(НаправлениеОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ИнициализироватьКомпонентыОбмена(НаправлениеОбмена) +``` +
+ +## ИнициализироватьТаблицыПравилОбмена +
+ +Описание, пример вызова + +```bsl + +// Инициализирует таблицы значений с правилами обмена и помещает их в КомпонентыОбмена. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// +Процедура ИнициализироватьТаблицыПравилОбмена(КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ИнициализироватьТаблицыПравилОбмена(КомпонентыОбмена) +``` +
+ +## ИнициализироватьТаблицуСвойствДляПравилаКонвертации +
+ +Описание, пример вызова + +```bsl + +// Инициализирует таблицу значений для хранения правил конвертации свойств объекта. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица для хранения правил конвертации свойств: +// * СвойствоКонфигурации - Строка +// * СвойствоФормата - Строка +// * ПравилоКонвертацииСвойства - Строка +// * ИспользуетсяАлгоритмКонвертации - Булево +// * ОбработкаКлючевогоСвойства - Булево +// * ОбработкаПоисковогоСвойства - Булево +// * ИмяТЧ - Строка +// +Функция ИнициализироватьТаблицуСвойствДляПравилаКонвертации() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ИнициализироватьТаблицуСвойствДляПравилаКонвертации() +``` +
+ +## ИнициализироватьСвойстваТабличныхЧастей +
+ +Описание, пример вызова + +```bsl + +// Заполняет колонку со свойствами табличных частей пустой таблицей значений с определенными колонками. +// Используется в текущем модуле, а также в модуле менеджера обмена при заполнении таблицы правил конвертации объектов. +// +// Параметры: +// ПравилоКонвертации - СтрокаТаблицыЗначений - правило конвертации объектов. +// ИмяКолонки - Строка - имя заполняемой колонки таблицы правил конвертации. +// +Процедура ИнициализироватьСвойстваТабличныхЧастей(ПравилоКонвертации, ИмяКолонки = "СвойстваТабличныхЧастей") Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ИнициализироватьСвойстваТабличныхЧастей(ПравилоКонвертации, ИмяКолонки); +``` +
+ +## ИнициализироватьВедениеПротоколаОбмена +
+ +Описание, пример вызова + +```bsl +// Создает объект для записи протокола обмена и помещает его в КомпонентыОбмена. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// ИмяФайлаПротоколаОбмена - Строка - содержит полное имя файла протокола. +// +Процедура ИнициализироватьВедениеПротоколаОбмена(КомпонентыОбмена, ИмяФайлаПротоколаОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ИнициализироватьВедениеПротоколаОбмена(КомпонентыОбмена, ИмяФайлаПротоколаОбмена) +``` +
+ +## ЗавершитьВедениеПротоколаОбмена +
+ +Описание, пример вызова + +```bsl + +// Завершает запись в протокол обмена. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// +Процедура ЗавершитьВедениеПротоколаОбмена(КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ЗавершитьВедениеПротоколаОбмена(КомпонентыОбмена) +``` +
+ +## ЗаписатьВПротоколВыполнения +
+ +Описание, пример вызова + +```bsl + +// Сохраняет в протокол выполнения (или выводит на экран) сообщения указанной структуры. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// КодОшибки - Число +// - Строка +// - Структура - информация об ошибке. +// Число - код ошибки, см. ОбменДаннымиПовтИсп.СообщенияОбОшибках(). +// Строка - описание ошибки: +// Структура - структура с кратким и подробным описанием ошибки: +// * КраткоеПредставлениеОшибки - описание ошибки для протокола (для пользователя). +// * ПодробноеПредставлениеОшибки - описание ошибки для журнала регистрации. +// * Уровень - УровеньЖурналаРегистрации - уровень важности ошибки. +// СтруктураЗаписи - Структура - структура записи протокола. +// ВзвестиФлагОшибок - Булево - если истина, то - это сообщение об ошибке. Взводится ФлагОшибки. +// Уровень - Число - отступ слева, количество табуляций. +// Выравнивание - Число - отступ в тексте, для выравнивания текста выводимого в виде Ключ - Значение. +// БезусловнаяЗаписьВПротоколОбмена - Булево - флаг безусловной записи информации в протокол. +// +// Возвращаемое значение: +// Строка - текст ошибки, которая была записана в протокол. +// +Функция ЗаписатьВПротоколВыполнения(КомпонентыОбмена, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ЗаписатьВПротоколВыполнения(КомпонентыОбмена, ); +``` +
+ +## ПКОПоИмени +
+ +Описание, пример вызова + +```bsl +// Выполняет поиск правила конвертации объекта по имени. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// Имя - Строка - имя правила. +// +// Возвращаемое значение: +// СтрокаТаблицыЗначений - строка таблицы правил обмена, в которой содержится искомое правило. +// +Функция ПКОПоИмени(КомпонентыОбмена, Имя) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ПКОПоИмени(КомпонентыОбмена, Имя) +``` +
+ +## ПроизвестиВыгрузкуДанных +
+ +Описание, пример вызова + +```bsl + +// Выполняет выгрузку данных в соответствии с правилами и параметрами обмена. +// +// Параметры: +// КомпонентыОбмена - см. ИнициализироватьКомпонентыОбмена +// +Процедура ПроизвестиВыгрузкуДанных(КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ПроизвестиВыгрузкуДанных(КомпонентыОбмена) +``` +
+ +## ВыгрузкаОбъектаВыборки +
+ +Описание, пример вызова + +```bsl + +// Выполняет выгрузку объекта информационной базы. +// +// Параметры: +// КомпонентыОбмена - см. ОбменДаннымиXDTOСервер.ИнициализироватьКомпонентыОбмена +// Объект - ЛюбаяСсылка - ссылка на объект информационной базы. +// ПравилоОбработки - СтрокаТаблицыЗначений - строка таблицы правил обработки данных, +// соответствующая правилу обработки типа выгружаемого объекта. +// Если параметр не задан, правило будет найдено по объекту метаданных выгружаемого объекта. +// +Процедура ВыгрузкаОбъектаВыборки(КомпонентыОбмена, Объект, ПравилоОбработки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ВыгрузкаОбъектаВыборки(КомпонентыОбмена, Объект, ПравилоОбработки); +``` +
+ +## ОбъектXDTOИзДанныхXDTO +
+ +Описание, пример вызова + +```bsl + +// Выполняет преобразование структуры с данными в объект XDTO указанного типа в соответствии с правилами. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// Источник - Структура - источник данных, которые необходимо преобразовать в объект XDTO. +// ТипXDTO - Строка - тип объекта или тип значения XDTO, к которому надо преобразовать данные. +// СсылкиИзОбъекта - Массив из ЛюбаяСсылка - содержит общий список выгруженных по ссылкам объектов. +// ПроведеноЗаполнениеСвойств - Булево - параметр для определения заполненности общих составных свойств. +// Расширения - Структура - для служебного использования. +// +// Возвращаемое значение: +// ОбъектXDTO - результат преобразования. +// +Функция ОбъектXDTOИзДанныхXDTO(КомпонентыОбмена, Знач Источник, Знач ТипXDTO, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ОбъектXDTOИзДанныхXDTO(КомпонентыОбмена, Источник, ТипXDTO, ); +``` +
+ +## ДанныеXDTOИзДанныхИБ +
+ +Описание, пример вызова + +```bsl + +// Выполняет преобразование данных информационной базы в структуру с данными в соответствии с правилами. +// +// Параметры: +// КомпонентыОбмена - см. ИнициализироватьКомпонентыОбмена +// Источник - ЛюбаяСсылка - ссылка на выгружаемый объект информационной базы. +// ПравилоКонвертации - СтрокаТаблицыЗначений - строка таблицы правил конвертации объектов, +// в соответствии с которой выполняется преобразование. +// СтекВыгрузки - Массив из ЛюбаяСсылка - ссылки на выгружаемые объекты с учетом вложенности. +// +// Возвращаемое значение: +// Структура - результат преобразования. +// +Функция ДанныеXDTOИзДанныхИБ(КомпонентыОбмена, Источник, Знач ПравилоКонвертации, СтекВыгрузки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ДанныеXDTOИзДанныхИБ(КомпонентыОбмена, Источник, ПравилоКонвертации, СтекВыгрузки); +``` +
+ +## ВыгрузитьСвойство +
+ +Описание, пример вызова + +```bsl + +// Выгружает свойство объекта информационной базы в соответствии с правилами. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// ДанныеИБ - ЛюбаяСсылка - ссылка на выгружаемый объект информационной базы. +// ПолучательСвойства - Структура - получатель данных типа Структура, в которой должно храниться значение выгруженного свойства. +// - СтрокаТаблицыЗначений. +// ПКС - СтрокаТаблицыЗначений - строка таблицы правил конвертации свойств, в соответствии с которой +// выполняется преобразование. +// СтекВыгрузки - Массив из ЛюбаяСсылка - ссылки на выгружаемые объекты с учетом вложенности. +// ЭтапВыгрузки - Число - содержит информацию об этапе выгрузки: +// 1 - выгрузка до выполнения алгоритма ПриОтправкеДанных, +// 2 - выгрузка после выполнения алгоритма ПриОтправкеДанных. +// +Процедура ВыгрузитьСвойство(КомпонентыОбмена, ДанныеИБ, ПолучательСвойства, ПКС, СтекВыгрузки, ЭтапВыгрузки = 1) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ВыгрузитьСвойство(КомпонентыОбмена, ДанныеИБ, ПолучательСвойства, ПКС, СтекВыгрузки, ЭтапВыгрузки); +``` +
+ +## ОткрытьФайлВыгрузки +
+ +Описание, пример вызова + +```bsl + +// Открывает файл выгрузки данных, записывает заголовок файла в соответствие с форматом обмена. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// ИмяФайлаОбмена - Строка - имя файла обмена. +// +Процедура ОткрытьФайлВыгрузки(КомпонентыОбмена, ИмяФайлаОбмена = "") Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ОткрытьФайлВыгрузки(КомпонентыОбмена, ИмяФайлаОбмена); +``` +
+ +## ТипСвойстваПоИмениИЗначениюСвойства +
+ +Описание, пример вызова + +```bsl + +// Определяет тип объекта формата перед конвертацией свойства +// +Процедура ТипСвойстваПоИмениИЗначениюСвойства(ТипXDTO, СвойствоНайдено, Свойство, ЗначениеСвойства, ТипСвойства) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ТипСвойстваПоИмениИЗначениюСвойства(ТипXDTO, СвойствоНайдено, Свойство, ЗначениеСвойства, ТипСвойства)); +``` +
+ +## СтруктураОбъектаXDTOВДанныеИБ +
+ +Описание, пример вызова + +```bsl + +// Возвращает объект информационной базы, соответствующий полученным данным. +// +// Параметры: +// КомпонентыОбмена - см. ОбменДаннымиXDTOСервер.ИнициализироватьКомпонентыОбмена +// ДанныеXDTO - Структура - структура, имитирующая объект XDTO. +// +// ПравилоКонвертации - СтрокаТаблицыЗначений +// - Структура - параметры текущего правила конвертации: +// СтрокаТаблицыЗначений - строка таблицы правил конвертации объектов. +// Структура - описание правила конвертации объекта: +// * ПравилоКонвертации - СтрокаТаблицыЗначений - строка таблицы правил конвертации объектов. +// Обязательное свойство. +// * УдалятьСозданныеПоКлючевымСвойствам - Булево - признак необходимости удаления объектов, +// созданных только по значениям ключевых свойств. +// Необязательное свойство, по умолчанию Ложь. +// +// Действие - Строка - определяет цель получения объекта ИБ: +// "ПолучитьСсылку" - идентификация объекта, +// "КонвертироватьИЗаписать" - полноценная загрузка объекта. +// +// Возвращаемое значение: +// - Объект - объект ИБ, если передано действие "КонвертироватьИЗаписать", +// либо если передано действие "ПолучитьСсылку" и в процессе ее получения был создан объект. +// - ЛюбаяСсылка - ссылка на объект ИБ или пустая ссылка заданного типа, если было передано действие "ПолучитьСсылку" +// и в процессе ее получения объект не был создан. +// +Функция СтруктураОбъектаXDTOВДанныеИБ(КомпонентыОбмена, ДанныеXDTO, Знач ПравилоКонвертации, Действие = "КонвертироватьИЗаписать") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.СтруктураОбъектаXDTOВДанныеИБ(КомпонентыОбмена, ДанныеXDTO, ПравилоКонвертации, Действие); +``` +
+ +## ПроизвестиЧтениеДанных +
+ +Описание, пример вызова + +```bsl + +// Выполняет чтение файла данных при загрузке. +// +// Параметры: +// КомпонентыОбмена - см. ИнициализироватьКомпонентыОбмена +// ТаблицыДляЗагрузки - ТаблицаЗначений - таблица, в которую следует загрузить данные (при интерактивном сопоставлении данных). +// +Процедура ПроизвестиЧтениеДанных(КомпонентыОбмена, ТаблицыДляЗагрузки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ПроизвестиЧтениеДанных(КомпонентыОбмена, ТаблицыДляЗагрузки); +``` +
+ +## ПроизвестиЧтениеДанныхВРежимеАнализа +
+ +Описание, пример вызова + +```bsl + +// Выполняет чтение файла данных при загрузке в режиме анализа (при интерактивной синхронизации данных). +// +// Параметры: +// КомпонентыОбмена - см. ИнициализироватьКомпонентыОбмена +// ПараметрыАнализа - Структура - параметры интерактивной загрузки данных. +// +Процедура ПроизвестиЧтениеДанныхВРежимеАнализа(КомпонентыОбмена, ПараметрыАнализа = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ПроизвестиЧтениеДанныхВРежимеАнализа(КомпонентыОбмена, ПараметрыАнализа); +``` +
+ +## ОткрытьФайлЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Открывает файл загрузки данных, записывает заголовок файла в соответствие с форматом обмена. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// ИмяФайлаОбмена - Строка - имя файла обмена. +// +Процедура ОткрытьФайлЗагрузки(КомпонентыОбмена, ИмяФайлаОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ОткрытьФайлЗагрузки(КомпонентыОбмена, ИмяФайлаОбмена) +``` +
+ +## ОбъектXDTOВСтруктуру +
+ +Описание, пример вызова + +```bsl + +// Выполняет преобразование объекта XDTO в структуру с данными. +// +// Параметры: +// ОбъектXDTO - ОбъектXDTO - значение, которое необходимо преобразовать. +// КомпонентыОбмена - см. ИнициализироватьКомпонентыОбмена +// +// Возвращаемое значение: +// Структура - структура, имитирующая объект XDTO. +// Ключи структуры соответствуют свойствам объекта XDTO. +// Значения соответствуют значениям свойств объекта XDTO. +// +Функция ОбъектXDTOВСтруктуру(ОбъектXDTO, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ОбъектXDTOВСтруктуру(ОбъектXDTO, КомпонентыОбмена) +``` +
+ +## СсылкаОбъектаПоУИДОбъектаXDTO +
+ +Описание, пример вызова + +```bsl + +// Преобразует строковое представление УИД в ссылку на объект текущей информационной базы. +// Сначала выполняется поиск УИД в регистре публичных идентификаторов. +// При удачном поиске возвращается ссылка из регистра, при неудачном +// возвращается либо ссылка с исходным УИД (если она еще не сопоставлена), +// либо выполняется генерация новой ссылки со случайным УИД. +// И в том и в другом случае в регистре публичных идентификаторов создается запись. +// +// Параметры: +// УИДОбъектаXDTO - Строка - уникальный идентификатор объекта XDTO, для которого необходимо +// получить ссылку соответствующего объекта информационной базы. +// +// ТипЗначенияОбъектаИБ - Тип - тип объекта информационной базы, которому должна соответствовать +// получаемая ссылка. +// +// КомпонентыОбмена - Структура - содержит все необходимые данные, инициализированные при начале +// выполнения обмена (ПКО, ПКПД, ПОД и т.д.). +// +// Возвращаемое значение: +// ЛюбаяСсылка - ссылка на объект информационной базы. +// +Функция СсылкаОбъектаПоУИДОбъектаXDTO(УИДОбъектаXDTO, ТипЗначенияОбъектаИБ, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.СсылкаОбъектаПоУИДОбъектаXDTO(УИДОбъектаXDTO, ТипЗначенияОбъектаИБ, КомпонентыОбмена) +``` +
+ +## ЗаписатьОбъектВИБ +
+ +Описание, пример вызова + +```bsl + +// Записывает объект в информационную базу. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все необходимые данные, +// инициализированные при начале выполнения обмена (ПКО, ПКПД, ПОД и т.д.). +// Объект - Произвольный - СправочникОбъект, ДокументОбъект и др записываемый объект. +// Тип - Строка - тип объекта строкой. +// ЗаписатьОбъект - Булево - переменная принимает значение Ложь если запись объекта не была выполнена. +// ОтправкаНазад - Булево - служебный флаг для установки соответствующего параметра обмена данными объекта. +// УникальныйИдентификаторСтрокой - Строка - уникальный идентификатор объекта в виде строки. +// +Процедура ЗаписатьОбъектВИБ(КомпонентыОбмена, Объект, Тип, ЗаписатьОбъект = Ложь, Знач ОтправкаНазад = Ложь, УникальныйИдентификаторСтрокой = "") Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ЗаписатьОбъектВИБ(КомпонентыОбмена, Объект, Тип, ЗаписатьОбъект, ОтправкаНазад, УникальныйИдентификаторСтрокой); +``` +
+ +## ВыполнитьОтложенноеПроведениеДокументов +
+ +Описание, пример вызова + +```bsl + +// Выполняет отложенное проведение загруженных документов после загрузки всех данных. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// +Процедура ВыполнитьОтложенноеПроведениеДокументов(КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ВыполнитьОтложенноеПроведениеДокументов(КомпонентыОбмена) +``` +
+ +## ВыполнитьПроведениеДокументаПриЗагрузке +
+ +Описание, пример вызова + +```bsl + +// Выполняет проведение документа при его загрузке в информационную базу. +// +// Параметры: +// КомпонентыОбмена - Структура - содержит все правила и параметры обмена. +// Объект - ДокументОбъект - загруженный документ. +// РегистрироватьПроблемыВРезультатахОбмена - Булево - необходимо регистрировать проблемы. +// +Процедура ВыполнитьПроведениеДокументаПриЗагрузке( Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ВыполнитьПроведениеДокументаПриЗагрузке(); +``` +
+ +## ОтменитьПроведениеОбъектаВИБ +
+ +Описание, пример вызова + +```bsl + +// Отменяет проведение объекта в информационной базе. +// +// Параметры: +// Объект - ДокументОбъект - документ для отмены проведения. +// Отправитель - ПланОбменаСсылка - ссылка на узел плана обмена, который является отправителем данных. +// КомпонентыОбмена - см. ИнициализироватьКомпонентыОбмена +// +// Возвращаемое значение: +// Булево - признак успешной отмены проведения. +// +Функция ОтменитьПроведениеОбъектаВИБ(Объект, Отправитель, КомпонентыОбмена = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ОтменитьПроведениеОбъектаВИБ(Объект, Отправитель, КомпонентыОбмена); +``` +
+ +## ЗаполнитьТабличнуюЧастьОбъектаНачальнымиДанными +
+ +Описание, пример вызова + +```bsl + +// Процедура заполняет табличную часть объекта с учетом предыдущей версии табличной части (до загрузки данных). +// +// Параметры: +// ТабличнаяЧастьОбъектаПослеОбработки - ТабличнаяЧасть - табличная часть, которая содержит измененные данные. +// ТабличнаяЧастьОбъектаДоОбработки - ТаблицаЗначений - таблица значений, содержимое табличной части объекта до +// загрузки данных. +// КлючевыеПоля - Строка - колонки, по которым происходит поиск строк в табличной части (строка через +// запятую). +// КолонкиДляВключения - Строка - другие колонки (кроме ключевых), значения которых должны измениться (строка +// через запятую). +// КолонкиДляИсключения - Строка - колонки, значения которых не должны измениться (строка через запятую). +// +Процедура ЗаполнитьТабличнуюЧастьОбъектаНачальнымиДанными( Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиXDTOСервер.ЗаполнитьТабличнуюЧастьОбъектаНачальнымиДанными(); +``` +
+ +## ПоддерживаемыеОбъектыФормата +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу поддерживаемых в обмене объектов формата для указанного плана обмена. +// Перечень формируется на основании правил обмена из модулей менеджера обмена по соответствующим версиям. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена XDTO. +// Режим - Строка - вид запрашиваемой информации: "Отправка" | "Получение" | "ОтправкаПолучение". +// "Отправка" - будут возвращены все объекты, для которых поддерживается отправка; +// "Получение" - будут возвращены все объекты, для которых поддерживается получение; +// "ОтправкаПолучение" - будут возвращены все поддерживаемые объекты. +// По умолчанию "ОтправкаПолучение". +// УзелОбмена - ПланОбменаСсылка +// - Неопределено - узел плана обмена, соответствующий корреспонденту. +// +// Возвращаемое значение: +// ТаблицаЗначений - состав поддерживаемых объектов формата в разрезе версий: +// * Версия - Строка - версия формата, например, "1.5". +// * Объект - Строка - имя объекта формата, например, "Справочник.Номенклатура". +// * Отправка - Булево - признак поддержки отправки данного объекта формата. +// * Получение - Булево - признак поддержки получения данного объекта формата. +// +Функция ПоддерживаемыеОбъектыФормата(ИмяПланаОбмена, Режим = "ОтправкаПолучение", УзелОбмена = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ПоддерживаемыеОбъектыФормата(ИмяПланаОбмена, Режим, УзелОбмена); +``` +
+ +## ПоддерживаемыеОбъектыФорматаКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу поддерживаемых в обмене объектов формата для указанного корреспондента. +// +// Параметры: +// УзелОбмена - ПланОбменаСсылка - узел плана обмена XDTO соответствующего корреспондента. +// Режим - Строка - вид запрашиваемой информации: "Отправка" | "Получение" | "ОтправкаПолучение". +// "Отправка" - будут возвращены все объекты, для которых поддерживается отправка; +// "Получение" - будут возвращены все объекты, для которых поддерживается получение; +// "ОтправкаПолучение" - будут возвращены все поддерживаемые объекты. +// По умолчанию "ОтправкаПолучение". +// +// Возвращаемое значение: +// ТаблицаЗначений - состав поддерживаемых объектов формата в разрезе версий: +// * Версия - Строка - версия формата, например, "1.5". +// * Объект - Строка - имя объекта формата, например, "Справочник.Номенклатура". +// * Отправка - Булево - признак поддержки корреспондентом отправки данного объекта формата. +// * Получение - Булево - признак поддержки корреспондентом получения данного объекта формата. +// +Функция ПоддерживаемыеОбъектыФорматаКорреспондента(УзелОбмена, Режим = "ОтправкаПолучение") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ПоддерживаемыеОбъектыФорматаКорреспондента(УзелОбмена, Режим); +``` +
+ +## ПропускатьОбъектыСОшибкамиПроверкиПоСхеме +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак режима пропуска при выгрузке объектов формата, не прошедших проверку по схеме. +// Может быть использована для установки нового значения режима. +// +// Параметры: +// УзелИнформационнойБазы - ПланОбменаСсылка - узел плана обмена, соответствующий корреспонденту. +// НовоеЗначение - Булево +// - Неопределено - новое значение режима для установки. +// Если Неопределено, то значение режима не изменяется. +// +// Возвращаемое значение: +// Булево - Истина, если при отправке данных необходимо пропускать объекты формата. +// +Функция ПропускатьОбъектыСОшибкамиПроверкиПоСхеме(УзелИнформационнойБазы, НовоеЗначение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.ПропускатьОбъектыСОшибкамиПроверкиПоСхеме(УзелИнформационнойБазы, НовоеЗначение); +``` +
+ +## КлассКлючевыеСвойства +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя свойства, которое содержит ключевые свойства объекта +// +// Возвращаемое значение: +// Строка - "КлючевыеСвойства". +// +Функция КлассКлючевыеСвойства() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.КлассКлючевыеСвойства() +``` +
+ +## КлассКлючевыеСвойстваФормата +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя свойства, которое содержит ключевые свойства объекта пакета XDTO +// +// Возвращаемое значение: +// Строка - "КлючевыеСвойства". +// +Функция КлассКлючевыеСвойстваФормата() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиXDTOСервер.КлассКлючевыеСвойстваФормата() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиВМоделиСервиса.md b/src/content/docs/bsp/ОбменДаннымиВМоделиСервиса.md new file mode 100644 index 0000000..cfbc403 --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиВМоделиСервиса.md @@ -0,0 +1,378 @@ +--- +title: Обмен данными в модели сервиса +slug: bsp/обмен-данными-в-модели-сервиса +--- + + +## ПослеОпределенияПолучателей +
+ +Описание, пример вызова + +```bsl + +// Обработчик "После определения получателей". +// Вызывается при регистрации объектов в плане обмена. +// Устанавливает константу-признак изменения данных +// и отсылает менеджеру сервиса сообщение об изменении с номером текущей области. +// +// Параметры: +// Данные - СправочникОбъект +// - ДокументОбъект - объект для получения значений реквизитов и других свойств. +// Получатели - Массив из ПланОбменаСсылка - узлы плана обмена. +// ИмяПланаОбмена - Строка - имя плана обмена, как оно задано в конфигураторе. +// +Процедура ПослеОпределенияПолучателей(Данные, Получатели, ИмяПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПослеОпределенияПолучателей(Данные, Получатели, ИмяПланаОбмена) +``` +
+ +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// Заполняет соответствие имен методов их псевдонимам для вызова из очереди заданий. +// +// Параметры: +// СоответствиеИменПсевдонимам - Соответствие из КлючИЗначение - имена методов и соответствующие им псевдонимы: +// Ключ - псевдоним метода, например ОчиститьОбластьДанных +// Значение - имя метода для вызова, например РаботаВМоделиСервиса.ОчиститьОбластьДанных +// В качестве значения можно указать Неопределено, в этом случае считается что имя +// совпадает с псевдонимом. +// +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ПриЗаполненииТаблицыПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// Формирует список параметров ИБ. +// +// Параметры: +// ТаблицаПараметров - ТаблицаЗначений - таблица описания параметров. Описание и состав колонок +// см. РаботаВМоделиСервиса.ПолучитьТаблицуПараметровИБ(). +// +Процедура ПриЗаполненииТаблицыПараметровИБ(Знач ТаблицаПараметров) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриЗаполненииТаблицыПараметровИБ(ТаблицаПараметров) +``` +
+ +## ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру массивами поддерживаемых версий всех подлежащих версионированию подсистем, +// используя в качестве ключей названия подсистем. +// Обеспечивает функциональность Web-сервиса InterfaceVersion. +// При внедрении надо поменять тело процедуры так, чтобы она возвращала актуальные наборы версий (см. пример.ниже). +// +// Параметры: +// СтруктураПоддерживаемыхВерсий - Структура - имена подсистем и соответствующие им наборы поддерживаемых версий. +// В качестве ключа структуры выступает название подсистемы, +// а в качестве значения - массив названий поддерживаемых версий. +// +// Пример: +// // СервисПередачиФайлов +// МассивВерсий = Новый Массив; +// МассивВерсий.Добавить("1.0.1.1"); +// МассивВерсий.Добавить("1.0.2.1"); +// СтруктураПоддерживаемыхВерсий.Вставить("СервисПередачиФайлов", МассивВерсий); +// // Конец СервисПередачиФайлов +// +Процедура ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(Знач СтруктураПоддерживаемыхВерсий) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(СтруктураПоддерживаемыхВерсий) +``` +
+ +## ПриОпределенииОбработчиковКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Получает список обработчиков сообщений, которые обрабатывают подсистемы библиотеки. +// +// Параметры: +// Обработчики - ТаблицаЗначений - состав полей см. в ОбменСообщениями.НоваяТаблицаОбработчиковСообщений. +// +Процедура ПриОпределенииОбработчиковКаналовСообщений(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриОпределенииОбработчиковКаналовСообщений(Обработчики) +``` +
+ +## ПриДобавленииПараметровРаботыКлиентаПриЗапуске +
+ +Описание, пример вызова + +```bsl + +// Добавляет параметры работы клиентской логики при запуске системы для подсистемы обмена данными в модели сервиса. +// +// Параметры: +// Параметры - Структура - имена и значения параметров работы клиента при запуске, которые необходимо задать. +// Подробнее см. ОбщегоНазначенияПереопределяемый.ПриДобавленииПараметровРаботыКлиентаПриЗапуске. +// +Процедура ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) +``` +
+ +## ПриДобавленииПараметровРаботыКлиента +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров, необходимых для работы клиентского кода +// конфигурации. +// +// Параметры: +// Параметры - Структура - структура параметров. +// +Процедура ПриДобавленииПараметровРаботыКлиента(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриДобавленииПараметровРаботыКлиента(Параметры) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Заполняет массив типов, исключаемых из выгрузки и загрузки данных. +// +// Параметры: +// Типы - Массив из ОбъектМетаданных - объекты метаданных, исключаемые из выгрузки и загрузки. +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ПриУдаленииНеактуальныхСообщенийОбмена +
+ +Описание, пример вызова + +```bsl + +// Выполняет удаление файлов сообщений обмена, которые не были удалены из-за сбоев в работе системы. +// Удалению подлежат файлы с датой размещения более суток от текущей универсальной даты. +// Анализируется РС.СообщенияОбменаДаннымиОбластейДанных. +// +Процедура ПриУдаленииНеактуальныхСообщенийОбмена() Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриУдаленииНеактуальныхСообщенийОбмена() +``` +
+ +## ПриПолученииФайлаИзХранилища +
+ +Описание, пример вызова + +```bsl + +// Получение имени файла по его идентификатору из хранилища. +// Если файла с указанным идентификатором нет, то вызывается исключение. +// Если файл найден, то возвращается его имя, при этом удаляется информация об этом файле из хранилища. +// +// Параметры: +// ИдентификаторФайла - УникальныйИдентификатор - идентификатор получаемого файла. +// ИмяФайла - Строка - имя файла, из хранилища. +// +Процедура ПриПолученииФайлаИзХранилища(Знач ИдентификаторФайла, ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриПолученииФайлаИзХранилища(ИдентификаторФайла, ИмяФайла) +``` +
+ +## ПриПомещенииФайлаВХранилище +
+ +Описание, пример вызова + +```bsl + +// Помещение файла в хранилище +// +// Параметры: +// СтруктураЗаписи - Структура - имена и значения измерений регистра сведений "СообщенияОбменаДаннымиОбластейДанных". +// +Процедура ПриПомещенииФайлаВХранилище(Знач СтруктураЗаписи) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриПомещенииФайлаВХранилище(СтруктураЗаписи) +``` +
+ +## ПриУдаленииФайлаИзХранилища +
+ +Описание, пример вызова + +```bsl + +// Удаление файла из хранилища +// +// Параметры: +// СтруктураЗаписи - Структура - имена и значения измерений регистра сведений "СообщенияОбменаДаннымиОбластейДанных". +// +Процедура ПриУдаленииФайлаИзХранилища(Знач СтруктураЗаписи) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриУдаленииФайлаИзХранилища(СтруктураЗаписи) +``` +
+ +## ПриОпределенииОбработчиковПоставляемыхДанных +
+ +Описание, пример вызова + +```bsl + +// Зарегистрировать обработчики поставляемых данных +// +// При получении уведомления о доступности новых общих данных, вызывается процедуры +// ДоступныНовыеДанные модулей, зарегистрированных через ПолучитьОбработчикиПоставляемыхДанных. +// В процедуру передается Дескриптор - ОбъектXDTO Descriptor. +// +// В случае, если ДоступныНовыеДанные устанавливает аргумент Загружать в значение Истина, +// данные загружаются, дескриптор и путь к файлу с данными передаются в процедуру +// ОбработатьНовыеДанные. Файл будет автоматически удален после завершения процедуры. +// Если в менеджере сервиса не был указан файл - значение аргумента равно Неопределено. +// +// Параметры: +// Обработчики - ТаблицаЗначений - таблица для добавления обработчиков. Колонки: +// * ВидДанных - Строка - код вида данных, обрабатываемый обработчиком. +// * КодОбработчика - Строка - строка(20) - будет использоваться при восстановлении обработки данных после сбоя. +// * Обработчик - ОбщийМодуль - модуль, содержащий следующие процедуры: +// ДоступныНовыеДанные(Дескриптор, Загружать) Экспорт +// ОбработатьНовыеДанные(Дескриптор, ПутьКФайлу) Экспорт +// ОбработкаДанныхОтменена(Дескриптор) Экспорт +// +Процедура ПриОпределенииОбработчиковПоставляемыхДанных(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриОпределенииОбработчиковПоставляемыхДанных(Обработчики) +``` +
+ +## ПриОтключенииСинхронизацииДанных +
+ +Описание, пример вызова + +```bsl + +// Обработчик снятия константы ИспользоватьСинхронизациюДанных. +// +// Параметры: +// Отказ - Булево - флаг отказа отключения синхронизации данных. +// Если установить в значение Истина, то синхронизация отключена не будет. +// +Процедура ПриОтключенииСинхронизацииДанных(Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПриОтключенииСинхронизацииДанных(Отказ) +``` +
+ +## ПередЗаписьюОбщихДанных +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность записи неразделенных данных в Автономном рабочем месте. +// Объект нельзя записать в Автономном рабочем месте, если он одновременно соответствует следующим условиям: +// 1. Это автономное рабочее место. +// 2. Это неразделенный объект метаданных. +// 3. Этот объект входит в состав плана обмена автономной работы. +// 4. Не входит в список исключений. +// +// Параметры: +// Объект - Произвольный - объект-источник данных +// Отказ - Булево - флаг отказа +// +Процедура ПередЗаписьюОбщихДанных(Объект, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервиса.ПередЗаписьюОбщихДанных(Объект, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиВМоделиСервисаПереопределяемый.md b/src/content/docs/bsp/ОбменДаннымиВМоделиСервисаПереопределяемый.md new file mode 100644 index 0000000..3d43f81 --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиВМоделиСервисаПереопределяемый.md @@ -0,0 +1,61 @@ +--- +title: Обмен данными в модели сервиса переопределяемый +slug: bsp/обмен-данными-в-модели-сервиса-переопределяемый +--- + + +## ПриОпределенииТребуемойВерсииПриложения +
+ +Описание, пример вызова + +```bsl + +// Определяет версию приложения 1С:Предприятия, которая требуется для работы автономного рабочего +// места. Приложение этой версии должно быть установлено на локальном компьютере пользователя. +// Если возвращаемое значение функции не задано, то в качестве требуемой версии приложения +// будет использоваться значение по умолчанию: первые три цифры версии текущего приложения, +// расположенного в Интернете, например, "8.3.3". +// Используется в помощнике создания автономного рабочего места. +// +// Параметры: +// Версия - Строка - версия требуемого приложения 1С:Предприятия в формате +// "<основная версия>.<младшая версия>.<релиз>.<дополнительный номер релиза>". +// Например, "8.3.3.715". +// +Процедура ПриОпределенииТребуемойВерсииПриложения(Версия) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервисаПереопределяемый.ПриОпределенииТребуемойВерсииПриложения(Версия) +``` +
+ +## ПриСозданииАвтономногоРабочегоМеста +
+ +Описание, пример вызова + +```bsl + +// Вызывается в момент начала создания пользователем автономного рабочего места. +// В обработчиках события могут быть реализованы дополнительные проверки возможности +// создания автономного рабочего места (при невозможности - сгенерировано исключение). +// +Процедура ПриСозданииАвтономногоРабочегоМеста() Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВМоделиСервисаПереопределяемый.ПриСозданииАвтономногоРабочегоМеста() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиВнешнееСоединение.md b/src/content/docs/bsp/ОбменДаннымиВнешнееСоединение.md new file mode 100644 index 0000000..e87dd3a --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиВнешнееСоединение.md @@ -0,0 +1,87 @@ +--- +title: Обмен данными внешнее соединение +slug: bsp/обмен-данными-внешнее-соединение +--- + + +## ПолучитьОбъектыТаблицы +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные списка объектов заданного объекта метаданных в виде системного представления. +// +// Параметры: +// ПолноеИмяТаблицы - Строка - имя таблицы, соответствующей объекту метаданных. +// +// Возвращаемое значение: +// Строка - системное представление таблицы значений, содержащей данные заданного объекта метаданных. +// +Функция ПолучитьОбъектыТаблицы(ПолноеИмяТаблицы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиВнешнееСоединение.ПолучитьОбъектыТаблицы(ПолноеИмяТаблицы) +``` +
+ +## ПолучитьОбъектыТаблицы_2_0_1_6 +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные списка объектов заданного объекта метаданных в виде XML-строки. +// +// Параметры: +// ПолноеИмяТаблицы - Строка - имя таблицы, соответствующей объекту метаданных. +// +// Возвращаемое значение: +// Строка - XML-строка сериализованного представления таблицы значений, содержащей данные заданного объекта метаданных. +// +Функция ПолучитьОбъектыТаблицы_2_0_1_6(ПолноеИмяТаблицы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиВнешнееСоединение.ПолучитьОбъектыТаблицы_2_0_1_6(ПолноеИмяТаблицы) +``` +
+ +## СвойстваОбъектаМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает заданные свойства (Синоним, Иерархический) объекта метаданных. +// +// Параметры: +// ПолноеИмяТаблицы - Строка - имя таблицы, соответствующей объекту метаданных. +// +// Возвращаемое значение: +// Структура - свойства объекта метаданных: +// * Синоним - Строка - синоним. +// * Иерархический - Строка - признак Иерархический. +// +Функция СвойстваОбъектаМетаданных(ПолноеИмяТаблицы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиВнешнееСоединение.СвойстваОбъектаМетаданных(ПолноеИмяТаблицы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиВызовСервера.md b/src/content/docs/bsp/ОбменДаннымиВызовСервера.md new file mode 100644 index 0000000..8a994d2 --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиВызовСервера.md @@ -0,0 +1,34 @@ +--- +title: Обмен данными вызов сервера +slug: bsp/обмен-данными-вызов-сервера +--- + + +## СброситьКэшМеханизмаРегистрацииОбъектов +
+ +Описание, пример вызова + +```bsl + +// Устанавливает значение константы ДатаОбновленияПовторноИспользуемыхЗначенийМРО. +// В качестве устанавливаемого значения используется текущая дата компьютера (сервера). +// В момент изменения значения этой константы повторно-используемые значения +// для подсистемы обмена данными становятся неактуальными и требуют повторной инициализации. +// +Процедура СброситьКэшМеханизмаРегистрацииОбъектов() Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВызовСервера.СброситьКэшМеханизмаРегистрацииОбъектов() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиКлиент.md b/src/content/docs/bsp/ОбменДаннымиКлиент.md new file mode 100644 index 0000000..b62b823 --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиКлиент.md @@ -0,0 +1,373 @@ +--- +title: Обмен данными клиент +slug: bsp/обмен-данными-клиент +--- + + +## ФормаНастройкиУзловКомандаЗакрытьФорму +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик закрытия формы настройки узлов плана обмена. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана процедура. +// +Процедура ФормаНастройкиУзловКомандаЗакрытьФорму(Форма) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ФормаНастройкиУзловКомандаЗакрытьФорму(Форма) +``` +
+ +## ФормаНастройкиУзлаКомандаЗакрытьФорму +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик закрытия формы настройки узла плана обмена. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана процедура. +// +Процедура ФормаНастройкиУзлаКомандаЗакрытьФорму(Форма) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ФормаНастройкиУзлаКомандаЗакрытьФорму(Форма) +``` +
+ +## ФормаНастройкиЗначенийПоУмолчаниюКомандаЗакрытьФорму +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик закрытия формы настройки значений по умолчанию узла плана обмена. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана процедура. +// +Процедура ФормаНастройкиЗначенийПоУмолчаниюКомандаЗакрытьФорму(Форма) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ФормаНастройкиЗначенийПоУмолчаниюКомандаЗакрытьФорму(Форма) +``` +
+ +## ФормаНастройкиПередЗакрытием +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик закрытия формы настройки узла плана обмена. +// +// Параметры: +// Отказ - Булево - признак отказа от закрытия формы. +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана процедура. +// ЗавершениеРаботы - Булево - признак того, что форма закрывается в процессе завершения работы приложения. +// +// Пример: +// +// &НаКлиенте +// Процедура ПередЗакрытием(Отказ, ЗавершениеРаботы, ТекстПредупреждения, СтандартнаяОбработка) +// ОбменДаннымиКлиент.ФормаНастройкиПередЗакрытием(Отказ, ЭтотОбъект, ЗавершениеРаботы); +// КонецПроцедуры +// +Процедура ФормаНастройкиПередЗакрытием(Отказ, Форма, ЗавершениеРаботы) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ФормаНастройкиПередЗакрытием(Отказ, Форма, ЗавершениеРаботы) +``` +
+ +## ОбработчикВыбораЭлементовБазыКорреспондентаНачалоВыбора +
+ +Описание, пример вызова + +```bsl + +// Обработчик начала выбора элемента для формы задания настроек узла базы-корреспондента при настройке обмена через +// внешнее соединение. +// +// Параметры: +// ИмяРеквизита - Строка - имя реквизита формы. +// ИмяТаблицы - Строка - полное имя объекта метаданных. +// Владелец - ФормаКлиентскогоПриложения - форма выбора элементов базы-корреспондента. +// СтандартнаяОбработка - Булево - признак выполнения стандартной (системной) обработки события. +// ПараметрыВнешнегоСоединения - Структура +// ПараметрыВыбора - Структура - структура параметров выбора. +// +Процедура ОбработчикВыбораЭлементовБазыКорреспондентаНачалоВыбора(Знач ИмяРеквизита, Знач ИмяТаблицы, Знач Владелец, Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ОбработчикВыбораЭлементовБазыКорреспондентаНачалоВыбора(ИмяРеквизита, ИмяТаблицы, Владелец, ); +``` +
+ +## ОбработчикВыбораЭлементовБазыКорреспондентаПодбор +
+ +Описание, пример вызова + +```bsl + +// Обработчик подбора элементов для формы задания настроек узла базы-корреспондента при настройке обмена через внешнее +// соединение. +// +// Параметры: +// ИмяРеквизита - Строка - имя реквизита формы. +// ИмяТаблицы - Строка - полное имя объекта метаданных. +// Владелец - ФормаКлиентскогоПриложения - форма выбора элементов базы-корреспондента. +// ПараметрыВнешнегоСоединения - Структура +// ПараметрыВыбора - Структура - структура параметров выбора. +// +Процедура ОбработчикВыбораЭлементовБазыКорреспондентаПодбор(Знач ИмяРеквизита, Знач ИмяТаблицы, Знач Владелец, Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ОбработчикВыбораЭлементовБазыКорреспондентаПодбор(ИмяРеквизита, ИмяТаблицы, Владелец, ); +``` +
+ +## ОбработчикВыбораЭлементовБазыКорреспондентаОбработкаВыбора +
+ +Описание, пример вызова + +```bsl + +// Обработчик обработки выбора элемента для формы задания настроек узла базы-корреспондента при настройке обмена через +// внешнее соединение. +// +// Параметры: +// Элемент - ФормаКлиентскогоПриложения +// - ТаблицаФормы - элемент для обработки выбора. +// ВыбранноеЗначение - Произвольный - см. описание параметра ВыбранноеЗначение события ОбработкаВыбора. +// ДанныеФормыКоллекция - ДанныеФормыКоллекция - для режима подбора из списка. +// +Процедура ОбработчикВыбораЭлементовБазыКорреспондентаОбработкаВыбора(Знач Элемент, Знач ВыбранноеЗначение, Знач ДанныеФормыКоллекция=Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ОбработчикВыбораЭлементовБазыКорреспондентаОбработкаВыбора(Элемент, ВыбранноеЗначение, ДанныеФормыКоллекция); +``` +
+ +## ВТаблицеОтмеченыВсеЭлементы +
+ +Описание, пример вызова + +```bsl + +// Проверяет установку флага "Использовать" для всех строк таблицы. +// +// Параметры: +// Таблица - ТаблицаЗначений - проверяемая таблица. +// +// Возвращаемое значение: +// Булево - признак использования всех элементов. +// +Функция ВТаблицеОтмеченыВсеЭлементы(Таблица) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиКлиент.ВТаблицеОтмеченыВсеЭлементы(Таблица) +``` +
+ +## УдалитьНастройкуСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Выполняет удаление настройки синхронизации данных. +// +// Параметры: +// УзелИнформационнойБазы - ПланОбменаСсылка - узел плана обмена, соответствующий отключаемому обмену. +// +Процедура УдалитьНастройкуСинхронизации(Знач УзелИнформационнойБазы) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.УдалитьНастройкуСинхронизации(УзелИнформационнойБазы) +``` +
+ +## ПередЗаписью +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик записи узла плана обмена. При необходимости выполняет запись узла при помощи длительной операции +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - узел плана обмена. +// Отказ - Булево - признак отказа от записи узла плана обмена. +// ПараметрыЗаписи - Структура - произвольные параметры записи. См. описание события ПослеЗаписи в синтакс-помощнике. +// +Процедура ПередЗаписью(Форма, Отказ, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ПередЗаписью(Форма, Отказ, ПараметрыЗаписи) +``` +
+ +## ОбработкаНавигационнойСсылкиВФормеУзла +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик навигационной ссылки в форме узла для элементов созданных программно. +// Только при работе в модели сервиса. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - узел плана обмена. +// Элемент - ЭлементыФормы +// НавигационнаяСсылка - Строка - сформированная навигационная ссылка +// СтандартнаяОбработка - Булево +// +Процедура ОбработкаНавигационнойСсылкиВФормеУзла(Форма, Элемент, НавигационнаяСсылка, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ОбработкаНавигационнойСсылкиВФормеУзла(Форма, Элемент, НавигационнаяСсылка, СтандартнаяОбработка) +``` +
+ +## ОткрытьПанельСинхронизацииДанных +
+ +Описание, пример вызова + +```bsl + +// Открывает панель настройки синхронизации данных. +// +// Параметры: +// ПараметрКоманды - Структура +// - Неопределено +// ПараметрыВыполненияКоманды - ПараметрыВыполненияКоманды +// +Процедура ОткрытьПанельСинхронизацииДанных(ПараметрКоманды, ПараметрыВыполненияКоманды) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ОткрытьПанельСинхронизацииДанных(ПараметрКоманды, ПараметрыВыполненияКоманды) +``` +
+ +## ОткрытьФормуИзмененияПрефиксаИБ +
+ +Описание, пример вызова + +```bsl + +// Открывает форму изменения префикса ИБ. +// +// Параметры: +// ПрефиксИБ - Строка - текущий префикс ИБ. +// +Процедура ОткрытьФормуИзмененияПрефиксаИБ(Знач ПрефиксИБ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ОткрытьФормуИзмененияПрефиксаИБ(ПрефиксИБ) +``` +
+ +## ОткрытьФормуУдаленияПредупрежденийСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Открывает форму очистки предупреждений синхронизации. +// +// Параметры: +// ПараметрыОткрытия - Структура - структура с отборами предупреждений, где: +// * МассивУзловПланаОбмена - Массив из ПланОбменаСсылка - массив с узлами плана обмена, которые можно использовать. +// * ОтборПоДатеВозникновения - Дата - дата, по которую выбираем предупреждения синхронизации. +// * ОтборУзловПланаОбмена - Массив из ПланОбменаСсылка - массив узлов планов обменов, +// по которым выполняется удаление предупреждений. +// * ОтборТипыПредупреждений - Массив из ПеречислениеСсылка.ТипыПроблемОбменаДанными +// ПеречислениеСсылка.ТипыВерсийОбъекта - типы удаляемых предупреждений. +// * ТолькоСкрытыеЗаписи - Булево - отбирать к удалению только скрытые записи предупреждений. +// ОписаниеОповещения - ОписаниеОповещения +// +Процедура ОткрытьФормуУдаленияПредупрежденийСинхронизации(ПараметрыОткрытия, ОписаниеОповещения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ОткрытьФормуУдаленияПредупрежденийСинхронизации(ПараметрыОткрытия, ОписаниеОповещения); +``` +
+ +## ОткрытьПомощникНастройкиОбменаДанными +
+ +Описание, пример вызова + +```bsl + +// Устарела. Открывает форму помощника настройки обмена данными для заданного плана обмена. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, как объекта метаданных, +// для которого необходимо открыть помощник. +// ИдентификаторНастройки - Строка - идентификатор варианта настройки обмена данными. +// +Процедура ОткрытьПомощникНастройкиОбменаДанными(Знач ИмяПланаОбмена, Знач ИдентификаторНастройки) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиКлиент.ОткрытьПомощникНастройкиОбменаДанными(ИмяПланаОбмена, ИдентификаторНастройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиПереопределяемый.md b/src/content/docs/bsp/ОбменДаннымиПереопределяемый.md new file mode 100644 index 0000000..bb2f157 --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиПереопределяемый.md @@ -0,0 +1,473 @@ +--- +title: Обмен данными переопределяемый +slug: bsp/обмен-данными-переопределяемый +--- + + +## ПриОпределенииПрефиксаИнформационнойБазыПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Определяет префикс кодов и номеров объектов информационной базы по умолчанию. +// +// Параметры: +// Префикс - Строка, 2 - префикс кодов и номеров объектов информационной базы по умолчанию. +// +Процедура ПриОпределенииПрефиксаИнформационнойБазыПоУмолчанию(Префикс) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриОпределенииПрефиксаИнформационнойБазыПоУмолчанию(Префикс) +``` +
+ +## ПолучитьПланыОбмена +
+ +Описание, пример вызова + +```bsl + +// Определяет список планов обмена, которые используют функционал подсистемы обмена данными. +// +// Параметры: +// ПланыОбменаПодсистемы - Массив из ОбъектМетаданныхПланОбмена - массив планов обмена конфигурации, +// которые используют функционал подсистемы обмена данными. +// Элементами массива являются объекты метаданных планов обмена. +// +// Пример: +// ПланыОбменаПодсистемы.Добавить(Метаданные.ПланыОбмена.ОбменБезИспользованияПравилКонвертации); +// ПланыОбменаПодсистемы.Добавить(Метаданные.ПланыОбмена.ОбменСБиблиотекойСтандартныхПодсистем); +// ПланыОбменаПодсистемы.Добавить(Метаданные.ПланыОбмена.РаспределеннаяИнформационнаяБаза); +// +Процедура ПолучитьПланыОбмена(ПланыОбменаПодсистемы) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПолучитьПланыОбмена(ПланыОбменаПодсистемы) +``` +
+ +## ПриВыгрузкеДанных +
+ +Описание, пример вызова + +```bsl + +// Обработчик при выгрузке данных. +// Используется для переопределения стандартной обработки выгрузки данных. +// В данном обработчике должна быть реализована логика выгрузки данных: +// выборка данных для выгрузки, сериализация данных в файл сообщения или сериализация данных в поток. +// После выполнения обработчика выгруженные данные будут отправлены получателю подсистемой обмена данными. +// Формат сообщения для выгрузки может быть произвольным. +// В случае ошибок при отправке данных следует прерывать выполнение обработчика +// методом ВызватьИсключение с описанием ошибки. +// +// Параметры: +// +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной (системной) обработки +// события. +// Если в теле процедуры-обработчика установить данному параметру значение Ложь, стандартная +// обработка события производиться не будет. Отказ от стандартной обработки не отменяет действие. +// Значение по умолчанию - Истина. +// +// Получатель - ПланОбменаСсылка - узел плана обмена, для которого выполняется выгрузка данных. +// +// ИмяФайлаСообщения - Строка - имя файла, в который необходимо выполнить выгрузку данных. +// Если этот параметр заполнен, то система ожидает, +// что данные будут выгружены в файл. После выгрузки система выполнит отправку данных из этого файла. +// Если параметр пустой, то система ожидает, что данные будут выгружены в параметр ДанныеСообщения. +// +// ДанныеСообщения - Произвольный - если параметр ИмяФайлаСообщения пустой, +// то система ожидает, что данные будут выгружены в этот параметр. +// +// КоличествоЭлементовВТранзакции - Число - определяет максимальное число элементов данных, +// которые помещаются в сообщение в рамках одной транзакции базы данных. +// При необходимости в обработчике следует реализовать логику +// установки транзакционных блокировок на выгружаемые данные. +// Значение параметра задается в настройках подсистемы обмена данными. +// +// ИмяСобытияЖурналаРегистрации - Строка - имя события журнала регистрации текущего сеанса обмена данными. +// Используется для записи в журнал регистрации данных (ошибок, предупреждений, информации) с заданным именем события. +// Соответствует параметру ИмяСобытия метода глобального контекста ЗаписьЖурналаРегистрации. +// +// КоличествоОтправленныхОбъектов - Число - счетчик отправленных объектов. +// Используется для определения количества отправленных объектов +// для последующей фиксации в протоколе обмена. +// +Процедура ПриВыгрузкеДанных(СтандартнаяОбработка, Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриВыгрузкеДанных(СтандартнаяОбработка, ); +``` +
+ +## ПриЗагрузкеДанных +
+ +Описание, пример вызова + +```bsl + +// Обработчик при загрузке данных. +// Используется для переопределения стандартной обработки загрузки данных. +// В данном обработчике должна быть реализована логика загрузки данных: +// необходимые проверки перед загрузкой данных, сериализация данных из файла сообщения или сериализация данных из +// потока. +// Формат сообщения для загрузки может быть произвольным. +// В случае ошибок при получении данных следует прерывать выполнение обработчика +// методом ВызватьИсключение с описанием ошибки. +// +// Параметры: +// +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения +// стандартной (системной) обработки события. +// Если в теле процедуры-обработчика установить данному параметру значение Ложь, +// стандартная обработка события производиться не будет. +// Отказ от стандартной обработки не отменяет действие. +// Значение по умолчанию: Истина. +// +// Отправитель - ПланОбменаСсылка - узел плана обмена, для которого выполняется загрузка данных. +// +// ИмяФайлаСообщения - Строка - имя файла, из которого требуется выполнить загрузку данных. +// Если параметр не заполнен, то данные для загрузки передаются через параметр ДанныеСообщения. +// +// ДанныеСообщения - Произвольный - параметр содержит данные, которые необходимо загрузить. +// Если параметр ИмяФайлаСообщения пустой, +// то данные для загрузки передаются через этот параметр. +// +// КоличествоЭлементовВТранзакции - Число - определяет максимальное число элементов данных, +// которые читаются из сообщения и записываются в базу данных в рамках одной транзакции. +// При необходимости в обработчике следует реализовать логику записи данных в транзакции. +// Значение параметра задается в настройках подсистемы обмена данными. +// +// ИмяСобытияЖурналаРегистрации - Строка - имя события журнала регистрации текущего сеанса обмена данными. +// Используется для записи в журнал регистрации данных (ошибок, предупреждений, информации) с заданным именем события. +// Соответствует параметру ИмяСобытия метода глобального контекста ЗаписьЖурналаРегистрации. +// +// КоличествоПолученныхОбъектов - Число -счетчик полученных объектов. +// Используется для определения количества загруженных объектов +// для последующей фиксации в протоколе обмена. +// +Процедура ПриЗагрузкеДанных(СтандартнаяОбработка, Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриЗагрузкеДанных(СтандартнаяОбработка, ); +``` +
+ +## РегистрацияИзмененийНачальнойВыгрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Обработчик регистрации изменений для начальной выгрузки данных. +// Используется для переопределения стандартной обработки регистрации изменений. +// При стандартной обработке будут зарегистрированы изменения всех данных из состава плана обмена. +// Если для плана обмена предусмотрены фильтры ограничения миграции данных, +// то использование этого обработчика позволит повысить производительность начальной выгрузки данных. +// В обработчике следует реализовать регистрацию изменений с учетом фильтров ограничения миграции данных. +// Если для плана обмена используются ограничения миграции по дате или по дате и организациям, +// то можно воспользоваться универсальной процедурой +// ОбменДаннымиСервер.ЗарегистрироватьДанныеПоДатеНачалаВыгрузкиИОрганизациям. +// Обработчик используется только для универсального обмена данными с использованием правил обмена +// и для универсального обмена данными без правил обмена и не используется для обменов в РИБ. +// Использование обработчика позволяет повысить производительность +// начальной выгрузки данных в среднем в 2-4 раза. +// +// Параметры: +// +// Получатель - ПланОбменаСсылка - узел плана обмена, в который требуется выгрузить данные. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной +// (системной) обработки события. +// Если в теле процедуры-обработчика установить данному параметру значение Ложь, +// стандартная обработка события производиться не будет. +// Отказ от стандартной обработки не отменяет действие. +// Значение по умолчанию - Истина. +// Отбор - Массив из ОбъектМетаданных +// - ОбъектМетаданных - определяет отбор по объектам метаданных, +// для которых следует выполнить регистрацию изменений. +// +Процедура РегистрацияИзмененийНачальнойВыгрузкиДанных(Знач Получатель, СтандартнаяОбработка, Отбор) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.РегистрацияИзмененийНачальнойВыгрузкиДанных(Получатель, СтандартнаяОбработка, Отбор) +``` +
+ +## ПриКоллизииИзмененийДанных +
+ +Описание, пример вызова + +```bsl + +// Обработчик при коллизии изменений данных. +// Событие возникает при получении данных, если в текущей информационной базе изменен тот же объект, +// что получен из сообщения обмена и эти объекты различаются. +// Используется для переопределения стандартной обработки коллизий изменений данных. +// Стандартная обработка коллизий предполагает получение изменений от главного узла +// и игнорирование изменений, полученных от подчиненного узла. +// В данном обработчике должен быть переопределен параметр ПолучениеЭлемента, +// если требуется изменить поведение по умолчанию. +// В данном обработчике можно задать поведение системы при возникновении коллизии изменений данных в разрезе данных, +// в разрезе свойств данных, в разрезе отправителей или для всей информационной базы в целом, или для всех данных в +// целом. +// Обработчик вызывается как в обмене в распределенной информационной базе (РИБ), +// так и во всех остальных обменах, в том числе в обменах по правилам обмена. +// +// Параметры: +// ЭлементДанных - Произвольный - элемент данных, прочитанный из сообщения обмена данными. +// Элементами данных могут быть КонстантаМенеджерЗначения.<Имя константы>, +// объекты базы данных (кроме объекта "Удаление объекта"), наборы записей регистров, +// последовательностей или перерасчетов. +// +// ПолучениеЭлемента - ПолучениеЭлементаДанных - определяет, будет ли прочитанный элемент данных записан в базу данных +// или нет в случае коллизии. +// При вызове обработчика параметр имеет значение Авто, что означает действия по умолчанию +// (принимать от главного, игнорировать от подчиненного). +// Значение данного параметра может быть переопределено в обработчике. +// +// Отправитель - ПланОбменаСсылка - узел плана обмена, от имени которого выполняется получение данных. +// +// ПолучениеОтГлавного - Булево - в распределенной информационной базе обозначает признак получения данных от главного +// узла. +// Истина - выполняется получение данных от главного узла, Ложь - от подчиненного. +// В обменах по правилам обмена принимает значение Истина - если в правилах обмена приоритет объекта +// при коллизии установлен в значение "Выше" (значение по умолчанию) или не указан; +// Ложь - если в правилах обмена приоритет объекта при коллизии установлен в значение "Ниже" или "Совпадает". +// Во всех остальных типах обмена данными параметр принимает значение Истина. +// +Процедура ПриКоллизииИзмененийДанных(Знач ЭлементДанных, ПолучениеЭлемента, Знач Отправитель, Знач ПолучениеОтГлавного) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриКоллизииИзмененийДанных(ЭлементДанных, ПолучениеЭлемента, Отправитель, ПолучениеОтГлавного) +``` +
+ +## ПриНастройкеПодчиненногоУзлаРИБ +
+ +Описание, пример вызова + +```bsl + +// Обработчик начальной настройки ИБ после создания узла РИБ. +// Вызывается в момент первого запуска подчиненного узла РИБ (в том числе АРМ). +// +Процедура ПриНастройкеПодчиненногоУзлаРИБ() Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриНастройкеПодчиненногоУзлаРИБ() +``` +
+ +## ПриПолученииДоступныхВерсийФормата +
+ +Описание, пример вызова + +```bsl + +// Получает доступные для использования версии универсального формата EnterpriseData. +// +// Параметры: +// ВерсииФормата - Соответствие - соответствие номера версии формата, +// общему модулю, в котором находятся обработчики выгрузки/загрузки для данной версии. +// +// Пример: +// ВерсииФормата.Вставить("1.2", <ИмяОбщегоМодуляСПравиламиКонвертации>); +// +Процедура ПриПолученииДоступныхВерсийФормата(ВерсииФормата) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриПолученииДоступныхВерсийФормата(ВерсииФормата) +``` +
+ +## ПриПолученииДоступныхРасширенийФормата +
+ +Описание, пример вызова + +```bsl + +// Получает доступные для использования расширения универсального формата EnterpriseData. +// +// Параметры: +// РасширенияФормата - Соответствие из КлючИЗначение: +// * Ключ - Строка - URI пространства имен схемы расширения формата. +// * Значение - Строка - номер расширяемой версии формата. +// +Процедура ПриПолученииДоступныхРасширенийФормата(РасширенияФормата) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриПолученииДоступныхРасширенийФормата(РасширенияФормата) +``` +
+ +## ПриИзмененииОпцииАвтономногоРежимаРаботы +
+ +Описание, пример вызова + +```bsl + +// Вызывается в событии ПриЗаписи константы ЭтоАвтономноеРабочееМесто. +// Позволяет переопределить стандартную обработку при изменении значения. +// +// Параметры: +// ПредыдущееЗначение - Булево - значение константы ЭтоАвтономноеРабочееМесто до изменения. +// НовоеТекущее - Булево - записываемое значение константы ЭтоАвтономноеРабочееМесто до изменения. +// СтандартнаяОбработка - Булево - отключение стандартного поведения системы при записи константы +// (значение по-умолчанию Истина). +// +Процедура ПриИзмененииОпцииАвтономногоРежимаРаботы(ПредыдущееЗначение, НовоеТекущее, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриИзмененииОпцииАвтономногоРежимаРаботы(ПредыдущееЗначение, НовоеТекущее, СтандартнаяОбработка) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзПроверкиУстраненияПроблемы +
+ +Описание, пример вызова + +```bsl + +// Заполняет массив типов, исключаемых из проверки устранения проблемы +// (см. РегистрыСведений.РезультатыОбменаДанными.ЗарегистрироватьУстранениеПроблемы). +// +// Параметры: +// Типы - Массив из ОбъектМетаданных +// +Процедура ПриЗаполненииТиповИсключаемыхИзПроверкиУстраненияПроблемы(Типы) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриЗаполненииТиповИсключаемыхИзПроверкиУстраненияПроблемы(Типы) +``` +
+ +## ПриПоискеИмениПланаОбменаЧерезУниверсальныйФормат +
+ +Описание, пример вызова + +```bsl + +// Вызывается в функции ОбменДаннымиСервер.НайтиИмяПланаОбменаЧерезУниверсальныйФормат +// Позволяет переопределить имя плана обмена, которое будет использоваться при обмене с корреспондирующее базой. +// Только для обмена через EnterpriseData +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена корреспондирующей базы, +// для которого подбираем соответствие из метаданных конфигурации. +// ИдентификаторНастройки- Строка - идентификатор варианта настройки (ВариантНастройки), корреспондирующей базы. +// НайденноеИмяПланаОбмена - Строка - если информационная база уже содержит план обмена с именем ИмяПланаОбмена, +// то параметр будет равен ИмяПланаОбмена. +// Иначе параметр будет содержать имя Глобального плана обмена. +// Параметр может быть переопределен +// +Процедура ПриПоискеИмениПланаОбменаЧерезУниверсальныйФормат( Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриПоискеИмениПланаОбменаЧерезУниверсальныйФормат(); +``` +
+ +## ПриПереопределенииРеквизитовСсылочногоТипаУзлаПланаОбмена +
+ +Описание, пример вызова + +```bsl + +// Вызывается в Модуле ОбменДаннымиСобытия. +// Позволяет переопределить стандартную обработку РеквизитыСсылочногоТипаУзлаПланаОбмена. +// +// Параметры: +// УзелПланаОбменаОбъект - ПланОбменаОбъект - ссылка на план обмена. +// Результат - ТаблицаЗначений - данные заполненные в процедуре ОбменДаннымиСобытия.РеквизитыСсылочногоТипаУзлаПланаОбмена: +// * Порядок - Число. +// * ИмяОбъекта - Строка - полное имя объекта метаданных. +// * ТипОбъектаСтрокой - Строка. +// * ИмяПланаОбмена - Строка. +// * ИмяТабличнойЧасти - Строка - имя табличной части плана обмена. +// * РеквизитыРегистрации - Строка - ключ объектов регистрации. +// * СтруктураРеквизитовРегистрации - Структура: +// * Ключ - Строка - имя реквизита или имя колонки плана обмена. +// * Значение - ЛюбаяСсылка - ссылка на регистрируемый объект +// +Процедура ПриПереопределенииРеквизитовСсылочногоТипаУзлаПланаОбмена(УзелПланаОбменаОбъект, Результат) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриПереопределенииРеквизитовСсылочногоТипаУзлаПланаОбмена(УзелПланаОбменаОбъект, Результат) +``` +
+ +## ПриПроверкеКорректностиИмениПланаОбменаEnterpriseData +
+ +Описание, пример вызова + +```bsl + +// Устарела. В процедуре нет необходимости. Теперь для поиска плана обмена используется параметр Глобальный +// (см процедуру ПриПолученииНастроек в менеджере универсального плана обмена) +// Вызывается при проверке имени плана обмена универсального формата. +// Допускает настройку синхронизацию между планами обменов EnterpriseData с отличающимися имена. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена универсального формата, +// для которого подбираем соответствие из метаданных конфигурации. +// ВариантНастройки - Строка - идентификатор варианта настройки, используется для уточнения поиска. +// Может быть не заполнен, например, при проверке формата полученного сообщения обмена. +// ПланОбменаРаспознан - Булево - признак того, что переданное имя плана обмена распознано и работу можно продолжить. +// +Процедура ПриПроверкеКорректностиИмениПланаОбменаEnterpriseData(ИмяПланаОбмена, ВариантНастройки, ПланОбменаРаспознан) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиПереопределяемый.ПриПроверкеКорректностиИмениПланаОбменаEnterpriseData(ИмяПланаОбмена, ВариантНастройки, ПланОбменаРаспознан) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиПовтИсп.md b/src/content/docs/bsp/ОбменДаннымиПовтИсп.md new file mode 100644 index 0000000..d418ea6 --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиПовтИсп.md @@ -0,0 +1,61 @@ +--- +title: Обмен данными повт исп +slug: bsp/обмен-данными-повт-исп +--- + + +## ЭтоАвтономноеРабочееМесто +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать новую +// См. ОбменДаннымиСервер.ЭтоАвтономноеРабочееМесто. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоАвтономноеРабочееМесто() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиПовтИсп.ЭтоАвтономноеРабочееМесто() +``` +
+ +## НайтиУзелПланаОбменаПоКоду +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать новую +// См. ОбменДаннымиСервер.УзелПланаОбменаПоКоду. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена +// КодУзла - Строка - код узла +// +// Возвращаемое значение: +// см. ОбменДаннымиСервер.УзелПланаОбменаПоКоду +// +Функция НайтиУзелПланаОбменаПоКоду(ИмяПланаОбмена, КодУзла) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиПовтИсп.НайтиУзелПланаОбменаПоКоду(ИмяПланаОбмена, КодУзла) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиРегистрацияСервер.md b/src/content/docs/bsp/ОбменДаннымиРегистрацияСервер.md new file mode 100644 index 0000000..d131a61 --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиРегистрацияСервер.md @@ -0,0 +1,81 @@ +--- +title: Обмен данными регистрация сервер +slug: bsp/обмен-данными-регистрация-сервер +--- + + +## РежимВыборочнойРегистрацииОтключен +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификатор режима выборочной регистрации, при котором данная функциональность отключена, +// т.е. все записываемые объекты считаются измененными. +// +// Возвращаемое значение: +// Строка - идентификатор режима выборочной регистрации "Отключен". +// +Функция РежимВыборочнойРегистрацииОтключен() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиРегистрацияСервер.РежимВыборочнойРегистрацииОтключен() +``` +
+ +## РежимВыборочнойРегистрацииМодифицированность +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификатор режима выборочной регистрации, при котором изменение объекта проверяется по +// свойству "Модифицированность" объекта информационной базы. +// +// Возвращаемое значение: +// Строка - идентификатор режима выборочной регистрации "Модифицированность". +// +Функция РежимВыборочнойРегистрацииМодифицированность() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиРегистрацияСервер.РежимВыборочнойРегистрацииМодифицированность() +``` +
+ +## РежимВыборочнойРегистрацииСогласноПравиламXML +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификатор режима выборочной регистрации, при котором изменение объекта проверяется +// сравнением значений реквизитов до и после записи. Список реквизитов готовиться по свойствам объектов, +// описанных в правилах конвертации. +// Режим поддерживается только для планов обменов УОП (см. документацию its.1c.ru). +// +// Возвращаемое значение: +// Строка - идентификатор режима выборочной регистрации "СогласноПравиламXML". +// +Функция РежимВыборочнойРегистрацииСогласноПравиламXML() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиРегистрацияСервер.РежимВыборочнойРегистрацииСогласноПравиламXML() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиСервер.md b/src/content/docs/bsp/ОбменДаннымиСервер.md new file mode 100644 index 0000000..03eef34 --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиСервер.md @@ -0,0 +1,1528 @@ +--- +title: Обмен данными сервер +slug: bsp/обмен-данными-сервер +--- + + +## ЗначениеНастройкиПланаОбмена +
+ +Описание, пример вызова + +```bsl + +// Получает значение настройки плана обмена по ее имени. +// Для несуществующих настроек возвращается Неопределено. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена из метаданных. +// ИмяПараметра - Строка - имя параметра плана обмена или список параметров, разделенных запятыми. +// Список допустимых значений см. в функциях НастройкиПланаОбменаПоУмолчанию, +// ОписаниеВариантаНастройкиОбменаПоУмолчанию. +// ИдентификаторНастройки - Строка - имя предопределенной настройки плана обмена. +// ВерсияКорреспондента - Строка - версия конфигурации корреспондента. +// +// Возвращаемое значение: +// Произвольный, Структура - тип возвращаемого значения зависит от типа значения получаемой настройки. +// Произвольный, если в качестве ИмяПараметра был передан единичный параметр +// Структура, если в качестве параметра ИмяПараметра была передан список параметров через запятую. +// +Функция ЗначениеНастройкиПланаОбмена(ИмяПланаОбмена, ИмяПараметра, ИдентификаторНастройки = "", ВерсияКорреспондента = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ЗначениеНастройкиПланаОбмена(ИмяПланаОбмена, ИмяПараметра, ИдентификаторНастройки, ВерсияКорреспондента); +``` +
+ +## ФормаУзлаПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПриСозданииНаСервере" для формы узла плана обмена. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана процедура: +// * Объект - ДанныеФормыСтруктура: +// ** Ссылка - ПланОбменаСсылка - узел плана обмена. +// Отказ - Булево - признак отказа от создания формы. Если установить в Истина, то форма создана не будет. +// +Процедура ФормаУзлаПриСозданииНаСервере(Форма, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ФормаУзлаПриСозданииНаСервере(Форма, Отказ) +``` +
+ +## ФормаУзлаПриЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПриЗаписиНаСервере" для формы узла плана обмена. +// +// Параметры: +// ТекущийОбъект - ПланОбменаОбъект - записываемый узел плана обмена. +// Отказ - Булево - входящий, признак отказа от записи узла обмена. +// Если установлен в Истина, то для узла не будет +// зафиксировано завершение настройки синхронизации. +// +Процедура ФормаУзлаПриЗаписиНаСервере(ТекущийОбъект, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ФормаУзлаПриЗаписиНаСервере(ТекущийОбъект, Отказ) +``` +
+ +## ФормаНастройкиУзлаПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПриСозданииНаСервере" для формы настройки узла. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана процедура. +// ИмяПланаОбмена - Строка - имя плана обмена, для которого создана форма. +// +Процедура ФормаНастройкиУзлаПриСозданииНаСервере(Форма, ИмяПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ФормаНастройкиУзлаПриСозданииНаСервере(Форма, ИмяПланаОбмена) +``` +
+ +## НадоВыполнитьОбработчикПослеВыгрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Определяет необходимость выполнения обработчика события "ПослеВыгрузкиДанных" при обмене в РИБ. +// +// Параметры: +// Объект - ПланОбменаОбъект - узел плана обмена, для которого выполняется обработчик. +// Ссылка - ПланОбменаСсылка - ссылка на узел плана обмена, для которого выполняется обработчик. +// +// Возвращаемое значение: +// Булево - если Истина, то необходимо выполнить обработчик "ПослеВыгрузкиДанных"; Ложь - нет. +// +Функция НадоВыполнитьОбработчикПослеВыгрузкиДанных(Объект, Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.НадоВыполнитьОбработчикПослеВыгрузкиДанных(Объект, Ссылка) +``` +
+ +## НадоВыполнитьОбработчикПослеЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Определяет необходимость выполнения обработчика события "ПослеЗагрузкиДанных" при обмене в РИБ. +// +// Параметры: +// Объект - ПланОбменаОбъект - узел плана обмена, для которого выполняется обработчик. +// Ссылка - ПланОбменаСсылка - ссылка на узел плана обмена, для которого выполняется обработчик. +// +// Возвращаемое значение: +// Булево - если Истина, то необходимо выполнить обработчик "ПослеЗагрузкиДанных"; Ложь - нет. +// +Функция НадоВыполнитьОбработчикПослеЗагрузкиДанных(Объект, Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.НадоВыполнитьОбработчикПослеЗагрузкиДанных(Объект, Ссылка) +``` +
+ +## ПрефиксИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает префикс этой информационной базы. +// +// Возвращаемое значение: +// Строка - префикс этой информационной базы. +// +Функция ПрефиксИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПрефиксИнформационнойБазы() +``` +
+ +## ВерсияКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию конфигурации корреспондента. +// Если версия конфигурации корреспондента не определена, то возвращает пустую версию - "0.0.0.0". +// +// Параметры: +// Корреспондент - ПланОбменаСсылка - узел плана обмена, для которого необходимо получить версию конфигурации. +// +// Возвращаемое значение: +// Строка - версия конфигурации корреспондента. +// +// Пример: +// Если ОбщегоНазначенияКлиентСервер.СравнитьВерсии(ОбменДаннымиСервер.ВерсияКорреспондента(Корреспондент), "2.1.5.1") +// >= 0 Тогда ... +// +Функция ВерсияКорреспондента(Знач Корреспондент) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ВерсияКорреспондента(Корреспондент) +``` +
+ +## УстановитьПрефиксИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устанавливает префикс этой информационной базы. +// +// Параметры: +// Префикс - Строка - новое значение префикса информационной базы. +// +Процедура УстановитьПрефиксИнформационнойБазы(Знач Префикс) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.УстановитьПрефиксИнформационнойБазы(Префикс) +``` +
+ +## ПараметрыРезервнойКопии +
+ +Описание, пример вызова + +```bsl + +// Проверяет факт восстановления этой базы из резервной копии. +// Если база была восстановлена из резервной копии, то необходимо выполнить синхронизацию номеров отправленных и +// полученных сообщений для двух баз (номеру отправленного сообщения в этой базе присваивается значение номера +// принятого сообщения из базы-корреспондента). +// Если база была восстановлена из резервной копии, то рекомендуется не снимать с регистрации изменения данных на +// текущем узле, т.к. эти данные могли быть еще не отправлены. +// +// Параметры: +// Отправитель - ПланОбменаСсылка - узел, от имени которого было сформировано и отправлено сообщение обмена. +// НомерПринятого - Число - номер принятого сообщения в базе-корреспонденте. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * Отправитель - ПланОбменаСсылка - см. выше параметр Отправитель. +// * НомерПринятого - Число - см. выше параметр НомерПринятого. +// * ВосстановленаРезервнаяКопия - Булево - Истина, если обнаружен факт восстановления этой базы из резервной копии. +// +Функция ПараметрыРезервнойКопии(Знач Отправитель, Знач НомерПринятого) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПараметрыРезервнойКопии(Отправитель, НомерПринятого) +``` +
+ +## ПриВосстановленииРезервнойКопии +
+ +Описание, пример вызова + +```bsl + +// Выполняет синхронизацию номеров отправленных и полученных сообщений +// для двух баз (номеру отправленного сообщения в этой базе присваивается значение номера принятого сообщения из +// базы-корреспондента). +// +// Параметры: +// ПараметрыРезервнойКопии - ФиксированнаяСтруктура: +// * Отправитель - ПланОбменаСсылка - узел, от имени которого было сформировано и отправлено +// сообщение обмена. +// * НомерПринятого - Число - номер принятого сообщения в базе-корреспонденте. +// * ВосстановленаРезервнаяКопия - Булево - признак восстановления этой базы из резервной копии. +// +Процедура ПриВосстановленииРезервнойКопии(Знач ПараметрыРезервнойКопии) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ПриВосстановленииРезервнойКопии(ПараметрыРезервнойКопии) +``` +
+ +## СохраненныйВариантНастройкиУзлаПланаОбмена +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификатор сохраненного варианта настройки плана обмена. +// Параметры: +// УзелПланаОбмена - ПланОбменаСсылка - узел плана обмена, для которого необходимо получить переопределяемое +// имя. +// +// Возвращаемое значение: +// Строка - идентификатор сохраненной настройки как он задан в конфигураторе. +// +Функция СохраненныйВариантНастройкиУзлаПланаОбмена(УзелПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.СохраненныйВариантНастройкиУзлаПланаОбмена(УзелПланаОбмена) +``` +
+ +## ДанныеТаблицКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные таблиц для реквизитов узла обмена. +// +// Параметры: +// Таблицы - Массив из Строка - имена реквизитов узла плана обмена. +// ИмяПланаОбмена - Строка - имя плана обмена. +// +// Возвращаемое значение: +// Соответствие - соответствие таблиц и их данных. +// +Функция ДанныеТаблицКорреспондента(Таблицы, Знач ИмяПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ДанныеТаблицКорреспондента(Таблицы, ИмяПланаОбмена) +``` +
+ +## УстановитьКоличествоЭлементовВТранзакцииЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Выполняет установку в константе количества элементов в транзакции загрузки данных. +// +// Параметры: +// Количество - Число - количество элементов в транзакции. +// +Процедура УстановитьКоличествоЭлементовВТранзакцииЗагрузкиДанных(Количество) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.УстановитьКоличествоЭлементовВТранзакцииЗагрузкиДанных(Количество) +``` +
+ +## ПредставлениеДатыСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление даты синхронизации. +// +// Параметры: +// ДатаСинхронизации - Дата - абсолютная дата синхронизации данных. +// +// Возвращаемое значение: +// Строка - строковое представление даты. +// +Функция ПредставлениеДатыСинхронизации(Знач ДатаСинхронизации) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПредставлениеДатыСинхронизации(ДатаСинхронизации) +``` +
+ +## ОтносительнаяДатаСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление относительной даты синхронизации. +// +// Параметры: +// ДатаСинхронизации - Дата - абсолютная дата синхронизации данных. +// +// Возвращаемое значение: +// Строка - представление относительной даты синхронизации: +// *Никогда (Т = пустая дата). +// *Сейчас (Т < 5 мин) +// *5 минут назад (5 мин < Т < 15 мин) +// *15 минут назад (15 мин < Т < 30 мин) +// *30 минут назад (30 мин < Т < 1 час) +// *1 час назад (1 час < Т < 2 час) +// *2 часа назад (2 час < Т < 3 час). +// *Сегодня, 12:44:12 (3 час < Т < вчера). +// *Вчера, 22:30:45 (вчера < Т < позавчера). +// *Позавчера, 21:22:54 (позавчера < Т < поза-позавчера). +// *<12 Марта 2012г.> (поза-позавчера < Т). +// +Функция ОтносительнаяДатаСинхронизации(Знач ДатаСинхронизации) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ОтносительнаяДатаСинхронизации(ДатаСинхронизации) +``` +
+ +## ПрофильДоступаСинхронизацияДанныхСДругимиПрограммами +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификатор поставляемого профиля групп доступа "Синхронизация данных с другими программами". +// +// Возвращаемое значение: +// Строка - идентификатор поставляемого профиля групп доступа. +// +Функция ПрофильДоступаСинхронизацияДанныхСДругимиПрограммами() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПрофильДоступаСинхронизацияДанныхСДругимиПрограммами() +``` +
+ +## ЕстьПраваНаАдминистрированиеОбменов +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие возможности администрирования обменов у текущего пользователя. +// +// Возвращаемое значение: +// Булево - если Истина - права есть, Ложь - прав нет. +// +Функция ЕстьПраваНаАдминистрированиеОбменов() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ЕстьПраваНаАдминистрированиеОбменов() +``` +
+ +## ПолучитьWSПрокси +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает объект WSПрокси веб-сервиса Exchange, созданный с переданными параметрами. +// +// Параметры: +// СтруктураНастроек - Структура: +// * WSURLВебСервиса - Строка - месторасположение wsdl. +// * WSИмяСервиса - Строка - имя сервиса. +// * WSURLПространстваИменСервиса - Строка - URI пространства имен web-сервиса. +// * WSИмяПользователя - Строка - имя пользователя для входа на сервер. +// * WSПароль - Строка - пароль пользователя. +// * WSТаймаут - Число - таймаут на операции выполняемые через полученное прокси. +// СтрокаСообщенияОбОшибке - Строка - содержит подробное описание ошибки в случае неуспешного подключения; +// СообщениеПользователю - Строка - содержит краткое описание ошибки в случае неуспешного подключения. +// +// Возвращаемое значение: +// WSПрокси - объект WSПрокси веб-сервиса Exchange. +// +Функция ПолучитьWSПрокси(СтруктураНастроек, СтрокаСообщенияОбОшибке = "", СообщениеПользователю = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПолучитьWSПрокси(СтруктураНастроек, СтрокаСообщенияОбОшибке, СообщениеПользователю); +``` +
+ +## ПолучитьWSПрокси_2_0_1_6 +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает объект WSПрокси веб-сервиса Exchange_2_0_1_6, созданный с переданными параметрами. +// +// Параметры: +// СтруктураНастроек - Структура: +// * WSURLВебСервиса - Строка - месторасположение wsdl. +// * WSИмяСервиса - Строка - имя сервиса. +// * WSURLПространстваИменСервиса - Строка - URI пространства имен web-сервиса. +// * WSИмяПользователя - Строка - имя пользователя для входа на сервер. +// * WSПароль - Строка - пароль пользователя. +// * WSТаймаут - Число - таймаут на операции выполняемые через полученное прокси. +// СтрокаСообщенияОбОшибке - Строка - содержит подробное описание ошибки в случае неуспешного подключения; +// СообщениеПользователю - Строка - содержит краткое описание ошибки в случае неуспешного подключения. +// +// Возвращаемое значение: +// WSПрокси - объект WSПрокси веб-сервиса Exchange_2_0_1_6. +// +Функция ПолучитьWSПрокси_2_0_1_6(СтруктураНастроек, СтрокаСообщенияОбОшибке = "", СообщениеПользователю = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПолучитьWSПрокси_2_0_1_6(СтруктураНастроек, СтрокаСообщенияОбОшибке, СообщениеПользователю); +``` +
+ +## ПолучитьWSПрокси_2_1_1_7 +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает объект WSПрокси веб-сервиса Exchange_2_0_1_7, созданный с переданными параметрами. +// +// Параметры: +// СтруктураНастроек - Структура: +// * WSURLВебСервиса - Строка - месторасположение wsdl. +// * WSИмяСервиса - Строка - имя сервиса. +// * WSURLПространстваИменСервиса - Строка - URI пространства имен web-сервиса. +// * WSИмяПользователя - Строка - имя пользователя для входа на сервер. +// * WSПароль - Строка - пароль пользователя. +// * WSТаймаут - Число - таймаут на операции выполняемые через полученное прокси. +// СтрокаСообщенияОбОшибке - Строка - содержит подробное описание ошибки в случае неуспешного подключения; +// СообщениеПользователю - Строка - содержит краткое описание ошибки в случае неуспешного подключения. +// Таймаут - Число - таймаут. +// +// Возвращаемое значение: +// WSПрокси - объект WSПрокси веб-сервиса Exchange_2_0_1_7. +// +Функция ПолучитьWSПрокси_2_1_1_7(СтруктураНастроек, СтрокаСообщенияОбОшибке = "", СообщениеПользователю = "", Таймаут = 600) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПолучитьWSПрокси_2_1_1_7(СтруктураНастроек, СтрокаСообщенияОбОшибке, СообщениеПользователю, Таймаут); +``` +
+ +## ПолучитьWSПрокси_3_0_1_1 +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает объект WSПрокси веб-сервиса Exchange_3_0_1_1, созданный с переданными параметрами. +// +// Параметры: +// СтруктураНастроек - Структура: +// * WSURLВебСервиса - Строка - месторасположение wsdl. +// * WSИмяСервиса - Строка - имя сервиса. +// * WSURLПространстваИменСервиса - Строка - URI пространства имен web-сервиса. +// * WSИмяПользователя - Строка - имя пользователя для входа на сервер. +// * WSПароль - Строка - пароль пользователя. +// * WSТаймаут - Число - таймаут на операции выполняемые через полученное прокси. +// СтрокаСообщенияОбОшибке - Строка - содержит подробное описание ошибки в случае неуспешного подключения; +// СообщениеПользователю - Строка - содержит краткое описание ошибки в случае неуспешного подключения. +// Таймаут - Число - таймаут. +// +// Возвращаемое значение: +// WSПрокси - объект WSПрокси веб-сервиса Exchange_3_0_1_1. +// +Функция ПолучитьWSПрокси_3_0_1_1(СтруктураНастроек, СтрокаСообщенияОбОшибке = "", СообщениеПользователю = "", Таймаут = 600) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПолучитьWSПрокси_3_0_1_1(СтруктураНастроек, СтрокаСообщенияОбОшибке, СообщениеПользователю, Таймаут); +``` +
+ +## ПолучитьWSПрокси_3_0_2_1 +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает объект WSПрокси веб-сервиса Exchange_3_0_1_1, созданный с переданными параметрами. +// +// Параметры: +// СтруктураНастроек - Структура: +// * WSURLВебСервиса - Строка - месторасположение wsdl. +// * WSИмяСервиса - Строка - имя сервиса. +// * WSURLПространстваИменСервиса - Строка - URI пространства имен web-сервиса. +// * WSИмяПользователя - Строка - имя пользователя для входа на сервер. +// * WSПароль - Строка - пароль пользователя. +// * WSТаймаут - Число - таймаут на операции выполняемые через полученное прокси. +// СтрокаСообщенияОбОшибке - Строка - содержит подробное описание ошибки в случае неуспешного подключения; +// СообщениеПользователю - Строка - содержит краткое описание ошибки в случае неуспешного подключения. +// Таймаут - Число - таймаут. +// +// Возвращаемое значение: +// WSПрокси - объект WSПрокси веб-сервиса Exchange_3_0_2_1. +// +Функция ПолучитьWSПрокси_3_0_2_1(СтруктураНастроек, СтрокаСообщенияОбОшибке = "", СообщениеПользователю = "", Таймаут = 600) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПолучитьWSПрокси_3_0_2_1(СтруктураНастроек, СтрокаСообщенияОбОшибке, СообщениеПользователю, Таймаут); +``` +
+ +## ПолучитьWSПрокси_3_0_2_2 +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает объект WSПрокси веб-сервиса Exchange_3_0_1_1, созданный с переданными параметрами. +// +// Параметры: +// СтруктураНастроек - Структура: +// * WSURLВебСервиса - Строка - месторасположение wsdl. +// * WSИмяСервиса - Строка - имя сервиса. +// * WSURLПространстваИменСервиса - Строка - URI пространства имен web-сервиса. +// * WSИмяПользователя - Строка - имя пользователя для входа на сервер. +// * WSПароль - Строка - пароль пользователя. +// * WSТаймаут - Число - таймаут на операции выполняемые через полученное прокси. +// СтрокаСообщенияОбОшибке - Строка - содержит подробное описание ошибки в случае неуспешного подключения; +// СообщениеПользователю - Строка - содержит краткое описание ошибки в случае неуспешного подключения. +// Таймаут - Число - таймаут. +// +// Возвращаемое значение: +// WSПрокси - объект WSПрокси веб-сервиса Exchange_3_0_2_1. +// +Функция ПолучитьWSПрокси_3_0_2_2(СтруктураНастроек, СтрокаСообщенияОбОшибке = "", СообщениеПользователю = "", Таймаут = 600) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПолучитьWSПрокси_3_0_2_2(СтруктураНастроек, СтрокаСообщенияОбОшибке, СообщениеПользователю, Таймаут); +``` +
+ +## КоличествоЭлементовВТранзакцииЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает допустимое количество элементов, обрабатываемых в одной транзакции загрузки данных. +// +// Возвращаемое значение: +// Число - допустимое количество элементов, обрабатываемых в одной транзакции загрузки данных. +// +Функция КоличествоЭлементовВТранзакцииЗагрузкиДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.КоличествоЭлементовВТранзакцииЗагрузкиДанных() +``` +
+ +## КоличествоЭлементовВТранзакцииВыгрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает допустимое количество элементов, обрабатываемых в одной транзакции выгрузки данных. +// +// Возвращаемое значение: +// Число - допустимое количество элементов, обрабатываемых в одной транзакции выгрузки данных. +// +Функция КоличествоЭлементовВТранзакцииВыгрузкиДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.КоличествоЭлементовВТранзакцииВыгрузкиДанных() +``` +
+ +## УзлыОбменаБСП +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу с данными узлов всех настроенных обменов БСП. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * УзелИнформационнойБазы - ПланОбменаСсылка - ссылка на узел плана обмена. +// * Наименование - Строка - наименование узла плана обмена. +// * ИмяПланаОбмена - Строка - имя плана обмена. +// +Функция УзлыОбменаБСП() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.УзлыОбменаБСП() +``` +
+ +## ИспользуютсяТиповыеПравила +
+ +Описание, пример вызова + +```bsl + +// Определяет, используются ли типовых правила конвертации для плана обмена. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, для которого загружаются правила. +// +// Возвращаемое значение: +// Булево - если Истина, то используются; Ложь - нет. +// +Функция ИспользуютсяТиповыеПравила(ИмяПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ИспользуютсяТиповыеПравила(ИмяПланаОбмена) +``` +
+ +## ВнешнееСоединениеСБазой +
+ +Описание, пример вызова + +```bsl + +// Устанавливает внешнее соединение с информационной базой и возвращает описание соединения. +// +// Параметры: +// Параметры - Структура - параметры для установки внешнего соединения с информационной базой. +// Свойства см. в функции +// ОбщегоНазначенияКлиентСервер.СтруктураПараметровДляУстановкиВнешнегоСоединения: +// +// * ВариантРаботыИнформационнойБазы - Число - вариант работы информационной базы: 0 - файловый; 1 - +// клиент-серверный; +// * КаталогИнформационнойБазы - Строка - каталог информационной базы для файлового режима работы; +// * ИмяСервера1СПредприятия - Строка - имя сервера1С:Предприятия; +// * ИмяИнформационнойБазыНаСервере1СПредприятия - Строка - имя информационной базы на сервере1С:Предприятия; +// * АутентификацияОперационнойСистемы - Булево - признак аутентификации операционной системы при создании +// внешнего подключения к информационной базе; +// * ИмяПользователя - Строка - имя пользователя информационной базы; +// * ПарольПользователя - Строка - пароль пользователя информационной базы. +// +// Возвращаемое значение: +// Структура: +// * Соединение - COMОбъект +// - Неопределено - указатель на COM-объект соединения или Неопределено в +// случае ошибки; +// * КраткоеОписаниеОшибки - Строка - краткое описание ошибки; +// * ПодробноеОписаниеОшибки - Строка - подробное описание ошибки; +// * ОшибкаПодключенияКомпоненты - Булево - флаг ошибки подключения COM. +// +Функция ВнешнееСоединениеСБазой(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ВнешнееСоединениеСБазой(Параметры) +``` +
+ +## ВыполнитьОбменДаннымиСВнешнейСистемой +
+ +Описание, пример вызова + +```bsl + +// Точка входа для выполнения итерации обмена данными (загрузки и выгрузки) с внешней системой по узлу плана обмена. +// +// Параметры: +// Корреспондент - ПланОбменаСсылка - узел плана обмена, соответствующий внешней системе. +// ПараметрыОбмена - Структура - должна содержать следующие параметры: +// * ВыполнятьЗагрузку - Булево - флаг необходимости выполнять загрузку данных. +// * ВыполнятьОтправкуНастроек - Булево - флаг необходимости выполнять отправку настроек XDTO. +// ФлагОшибка - Булево - Истина, в случае возникновения ошибки при выполнении обмена. +// Подробная информация об ошибке фиксируется в журнале регистрации. +// +Процедура ВыполнитьОбменДаннымиСВнешнейСистемой(Корреспондент, ПараметрыОбмена, ФлагОшибка) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ВыполнитьОбменДаннымиСВнешнейСистемой(Корреспондент, ПараметрыОбмена, ФлагОшибка) +``` +
+ +## НастройкиПланаОбменаПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Определяет настройки по умолчанию для плана обмена, которые затем могут быть переопределены +// в модуле менеджера плана обмена в процедуре ПриПолученииНастроек(). +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена из метаданных. +// +// Возвращаемое значение: +// Структура: +// * ВариантыНастроекОбмена - см. КоллекцияВариантовНастроекОбмена +// * ВидГруппыДляВариантовНастроек - ВидГруппыФормы - вариант вида группы для отображения в +// дереве команд создания обмена вариантов настроек. +// * ИмяКонфигурацииИсточника - Строка - имя конфигурации источника, выводимое в +// пользовательском интерфейсе. +// * ИмяКонфигурацииПриемника - Структура - перечень идентификаторов конфигураций-корреспондентов, +// обмен с которыми возможен через данный план обмена. +// * ВерсииФорматаОбмена - Соответствие из КлючИЗначение - номеров поддерживаемых версий формата +// и ссылок на общие модули с логикой обмена через формат. +// Используется только для обменов через универсальный формат: +// ** Ключ - Число - версия формата. +// ** Значение - ОбщийМодуль - ссылка на общий модуль. +// * ФорматОбмена - Строка - пространство имен XDTO пакета, в котором содержится +// универсальный формат, без указания версии формата. +// Используется только для обменов через универсальный формат. +// * РасширенияФорматаОбмена - Соответствие из КлючИЗначение: +// ** Ключ - Строка - URI пространства имен схемы расширения формата. +// ** Значение - Строка - номер расширяемой версии формата. +// * ПланОбменаИспользуетсяВМоделиСервиса - Булево - признак использования плана обмена для организации +// обмена в модели сервиса. +// * ЭтоПланОбменаXDTO - Булево - признак того, что это план обмена через +// универсальный формат. +// * ПредупреждатьОНесоответствииВерсийПравилОбмена - Булево - признак необходимости проверки на +// расхождение версий в правилах конвертации. +// Проверка выполняется при загрузке комплекта +// правил, при отправке данных и при получении данных. +// * ИмяПланаОбменаДляПереходаНаНовыйОбмен - Строка - если для плана обмена свойство установлено, в +// рабочих местах управления настройками не будет +// предлагаться настроить этот вид обмена. +// Существующие обмены этого вида будут продолжать +// отображаться в списке настроенных обменов. +// Получении сообщения обмена в новом формате будет +// инициировать переход на новый вид обмена. +// * НазначениеПланаОбмена - Строка - вариант назначения плана обмена. +// * Алгоритмы - Структура - перечень экспортных процедур и функций, которые +// объявлены в модуле менеджера плана обмена +// и используются подсистемой обмена данными. +// *ПравилаРегистрацииВМенеджере - Булево - признак использования правил регистрации, +// расположенных в общем модуле (менеджере регистрации) +// *ИмяМенеджераРегистрации - Строка - имя модуля с правилами регистрации +// *ИспользоватьКешПубличныхИдентификаторов - Булево - признак того, что при загрузке данных будет +// использован кеш для поиска ссылок +// *Глобальный - Булево - если установлено Истина, то план обмена может быть +// использован для обмена с планами обмена с другими наименованиями. +// Только для обмена через EnterpriseData +// +Функция НастройкиПланаОбменаПоУмолчанию(ИмяПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.НастройкиПланаОбменаПоУмолчанию(ИмяПланаОбмена) +``` +
+ +## ОписаниеВариантаНастройкиОбменаПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Определяет настройки по умолчанию варианта настройки обмена, которые затем могут быть переопределены +// в модуле менеджера плана обмена в процедуре ПриПолученииОписанияВариантаНастройки(). +// +// Параметры: +// ИмяПланаОбмена - Строка - содержит имя плана обмена. +// +// Возвращаемое значение: +// Структура: +// * Отборы - Структура - отборы на узле плана обмена, +// подлежат заполнению значениями по умолчанию. +// * ЗначенияПоУмолчанию - Структура - значения по умолчанию на узле плана обмена. +// * ОбщиеДанныеУзлов - Строка - имена реквизитов и табличных частей плана обмена, +// через запятую, которые являются общими для пары +// обменивающихся конфигураций. +// * ИспользоватьПомощникСозданияОбменаДанными - Булево - признак, будет ли использоваться помощник для +// создания новых узлов плана обмена. +// * ИмяФормыСозданияНачальногоОбраза - Строка - имя используемой формы создания начального +// образа распределенной ИБ. +// * ИмяФормыПомощникаНастройкиСинхронизацииДанных - Строка - имя формы, которая будет использована для настройки +// правил отправки и получения данных вместо +// стандартной формы. +// * ПояснениеДляНастройкиПараметровУчета - Строка - пояснение о последовательности действий пользователя +// для настройки параметров учета в текущей +// информационной базе. +// * ПутьКФайлуКомплектаПравилНаПользовательскомСайте - Строка - путь к файлу комплекта правил в виде архива +// на пользовательском сайте в разделе конфигурации. +// * ПутьКФайлуКомплектаПравилВКаталогеШаблонов - Строка - относительный путь к файлу комплекта правил в +// каталоге шаблонов. +// * ЗаголовокКомандыДляСозданияНовогоОбменаДанными - Строка - представление команды, выводимое в пользовательском +// интерфейсе при создании новой настройки +// обмена данными. +// * ЗаголовокПомощникаСозданияОбмена - Строка - представление заголовка формы помощника +// создания обмена данными выводимое в +// пользовательском интерфейсе. +// * ЗаголовокУзлаПланаОбмена - Строка - представление узла плана обмена +// выводимое в пользовательском интерфейсе. +// * ИмяКонфигурацииКорреспондента - Строка - идентификатор конфигурации корреспондента. +// * НаименованиеКонфигурацииКорреспондента - Строка - представление наименования конфигурации корреспондента +// выводимое в пользовательском интерфейсе. +// * ИспользуемыеТранспортыСообщенийОбмена - Массив из ПеречислениеСсылка.ВидыТранспортаСообщенийОбмена +// - Перечень используемых транспортов сообщений. Если не заполнен, +// будут доступны все возможные виды транспорта. +// * КраткаяИнформацияПоОбмену - Строка - краткое описание обмена данными, которое +// выводится на первой странице помощника +// создания обмена. +// * ПодробнаяИнформацияПоОбмену - Строка - ссылка на веб-страницу или полный путь к +// форме внутри конфигурации строкой, для +// отображения в помощнике создания обмена. +// * ИмяФайлаНастроекДляПриемника - Строка - имя файла для сохранения настроек подключения +// при настройке обмена через OFFLINE-каналы. +// * ПоддерживаетсяСопоставлениеДанных - Булево - Истина, если для данного варианта настройки +// поддерживается +// интерактивное сопоставление данных. В +// противном случае полученные сообщения обмена +// будут сразу загружаться в информационную базу. +// * РасширениеФормата - Строка - имя расширения формата, применимое для +// данного варианта настройки. Образуется из URI +// пространства имен схемы расширения формата, +// без учета версии. Напр., для пространства +// имен "HTTP://v8.1c.ru/EDI/edi_stnd/_DemoEnterpriseDataExt/1.1" +// имя расширение формата будет +// "HTTP://v8.1c.ru/EDI/edi_stnd/_DemoEnterpriseDataExt"; +// * ИмяПланаОбменаКорреспондента - Строка - имя метаданных плана обмена корреспондирующей базы +// +Функция ОписаниеВариантаНастройкиОбменаПоУмолчанию(ИмяПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ОписаниеВариантаНастройкиОбменаПоУмолчанию(ИмяПланаОбмена) +``` +
+ +## ПараметрыКонтекстаПолученияОписанияВариантаНастройки +
+ +Описание, пример вызова + +```bsl + +// Предназначена для подготовки структуры, для последующей передачи в обработчик получения описания варианта. +// +// Параметры: +// ИмяКорреспондента - Строка - имя конфигурации-корреспондента. +// ВерсияКорреспондента - Строка - версия конфигурации-корреспондента. +// +// Возвращаемое значение: +// Структура: +// * ИмяКорреспондента - Строка - имя конфигурации корреспондента. +// * ВерсияКорреспондента - Строка - номер версии конфигурации корреспондента. +// +Функция ПараметрыКонтекстаПолученияОписанияВариантаНастройки(ИмяКорреспондента, ВерсияКорреспондента) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПараметрыКонтекстаПолученияОписанияВариантаНастройки(ИмяКорреспондента, ВерсияКорреспондента) +``` +
+ +## ПриСохраненииНастроекПодключенияВнешнейСистемы +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройки подключения для обмена с внешней системой через EnterpriseData. +// +// Параметры: +// Контекст - Структура - контекст выполнения операции: +// * Режим - Строка - режим, в котором вызывается обработчик. +// Возможные значения: "НовоеПодключение" | "РедактированиеПараметровПодключения". +// * Корреспондент - ПланОбменаСсылка +// - Неопределено - узел обмена, соответствующий корреспонденту. +// Для режима "НовоеПодключение" равен Неопределено; +// * ИмяПланаОбмена - Строка +// - Неопределено - имя плана обмена, на котором создается узел. +// * ИдентификаторНастройки - Строка +// - Неопределено - идентификатор варианта настройки, +// как он указан в модуле менеджера плана обмена. +// ПараметрыПодключения - Структура - структура параметров подключения: +// * ИдентификаторКорреспондента - Строка - строка длиной 36 символов +// - Неопределено - уникальный идентификатор корреспондента. +// * НаименованиеКорреспондента - Строка +// - Неопределено - название корреспондента, как он будет отображаться +// в списке настроенных синхронизаций. +// * НастройкиТранспорта - Произвольный +// - Неопределено - произвольное значение, описывающее параметры подключения. +// * РасписаниеСинхронизации - РасписаниеРегламентногоЗадания +// - Неопределено - расписание запуска синхронизации. +// * НастройкиXDTO - Структура +// - Неопределено - структура настроек XDTO корреспондента: +// ** ПоддерживаемыеВерсии - Массив - перечень поддерживаемых корреспондентом версий формата. +// ** ПоддерживаемыеОбъекты - см. ОбменДаннымиXDTOСервер.ПоддерживаемыеОбъектыФормата +// Результат - Структура: +// * УзелОбмена - ПланОбменаСсылка - узел плана обмена, соответствующий корреспонденту. +// * ИдентификаторКорреспондента - Строка - уникальный идентификатор корреспондента. +// +Процедура ПриСохраненииНастроекПодключенияВнешнейСистемы(Контекст, ПараметрыПодключения, Результат) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ПриСохраненииНастроекПодключенияВнешнейСистемы(Контекст, ПараметрыПодключения, Результат) +``` +
+ +## ПриПолученииНастроекПодключенияВнешнейСистемы +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру сохраненных параметров подключения к внешней системе. +// +// Параметры: +// Контекст - Структура - контекст выполнения операции: +// * Корреспондент - ПланОбменаСсылка - узел обмена, соответствующий корреспонденту. +// ПараметрыПодключения - Структура - структура параметров подключения: +// * ИдентификаторКорреспондента - Строка - строка длиной 36 символов, уникальный идентификатор корреспондента. +// * НаименованиеКорреспондента - Строка - название корреспондента, как он отображается +// в списке настроенных синхронизаций. +// * НастройкиТранспорта - Произвольный - сохраненные настройки транспорта сообщений обмена внешней системы. +// * РасписаниеСинхронизации - РасписаниеРегламентногоЗадания - расписание автоматического запуска обмена. +// * НастройкиXDTO - Структура +// - Неопределено - структура настроек XDTO корреспондента: +// ** ПоддерживаемыеВерсии - Массив - перечень поддерживаемых корреспондентом версий формата. +// ** ПоддерживаемыеОбъекты - см. ОбменДаннымиXDTOСервер.ПоддерживаемыеОбъектыФормата. +// +Процедура ПриПолученииНастроекПодключенияВнешнейСистемы(Контекст, ПараметрыПодключения) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ПриПолученииНастроекПодключенияВнешнейСистемы(Контекст, ПараметрыПодключения) +``` +
+ +## ВсеНастройкиТранспортаОбменаСВнешнимиСистемами +
+ +Описание, пример вызова + +```bsl + +// Таблица настроек транспорта обмена для всех настроенных обменов данными с внешними системами. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Корреспондент - ПланОбменаСсылка - узел обмена, соответствующий корреспонденту. +// * НастройкиТранспорта - Произвольный - сохраненные настройки транспорта сообщений обмена внешней системы. +// +Функция ВсеНастройкиТранспортаОбменаСВнешнимиСистемами() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ВсеНастройкиТранспортаОбменаСВнешнимиСистемами() +``` +
+ +## ПриНачалеСохраненияНастроекСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Начинает сохранение настроек синхронизации данных в длительной операции. +// При сохранении настроек выполняется перенос на узел обмена переданных данных заполнения, +// и устанавливается признак, что настройка синхронизации завершена. +// Рекомендуется использовать в помощнике настройки синхронизации данных. +// +// Параметры: +// НастройкиСинхронизации - Структура - структура параметров для сохранения настроек: +// * УзелОбмена - ПланОбменаСсылка - узел плана обмена, для которого выполняется сохранение настроек синхронизации. +// * ДанныеЗаполнения - Структура - произвольная структура для заполнения настроек на узле. +// Будет передана в алгоритм "ПриСохраненииНастроекСинхронизацииДанных" (при его наличии). +// ПараметрыОбработчика - Структура - исходящий служебный параметр. Зарезервирован для внутреннего использования. +// Применяется для отслеживания состояния длительной операции. +// На вход следует передавать реквизит формы типа "Произвольный", +// не используемый ни в каких других операциях. +// ПродолжитьОжидание - Булево - исходящий параметр. Истина, если сохранение настройки запущено в длительной операции. +// Для отслеживания состояния в этом случае следует использовать процедуру +// ОбменДаннымиСервер.ПриОжиданииСохраненияНастроекСинхронизации. +// +Процедура ПриНачалеСохраненияНастроекСинхронизации(НастройкиСинхронизации, ПараметрыОбработчика, ПродолжитьОжидание = Истина) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ПриНачалеСохраненияНастроекСинхронизации(НастройкиСинхронизации, ПараметрыОбработчика, ПродолжитьОжидание); +``` +
+ +## ПриОжиданииСохраненияНастроекСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Используется при ожидании завершения настройки синхронизации данных. +// Проверяет статус выполнения длительной операции по сохранению настройки, и возвращает признак +// необходимости продолжения ожидания, либо сообщает, что операция сохранения настройки завершена. +// +// Параметры: +// ПараметрыОбработчика - Структура - входящий/исходящий служебный параметр. Зарезервирован для внутреннего использования. +// Применяется для отслеживания состояния длительной операции. +// На вход следует передавать реквизит формы типа "Произвольный", +// который был использован при запуске настройки синхронизации +// вызовом метода ОбменДаннымиСервер.ПриНачалеСохраненияНастроекСинхронизации. +// ПродолжитьОжидание - Булево - исходящий параметр. Истина, если необходимо продолжить ожидание завершения +// операции сохранения настройки синхронизации, Ложь - если настройка +// синхронизации завершена. +// +Процедура ПриОжиданииСохраненияНастроекСинхронизации(ПараметрыОбработчика, ПродолжитьОжидание) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ПриОжиданииСохраненияНастроекСинхронизации(ПараметрыОбработчика, ПродолжитьОжидание) +``` +
+ +## ПриЗавершенииСохраненияНастроекСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Получает статус завершения операции настройки синхронизации. Вызывается, когда процедуры +// ОбменДаннымиСервер.ПриНачалеСохраненияНастроекСинхронизации или ОбменДаннымиСервер.ПриОжиданииСохраненияНастроекСинхронизации +// устанавливают флаг ПродолжитьОжидание в значение Ложь. +// +// Параметры: +// ПараметрыОбработчика - Структура - входящий служебный параметр. Зарезервирован для внутреннего использования. +// Применяется для получения состояния длительной операции. +// На вход следует передавать реквизит формы типа "Произвольный", +// который был использован при запуске настройки синхронизации +// вызовом метода ОбменДаннымиСервер.ПриНачалеСохраненияНастроекСинхронизации. +// СтатусЗавершения - Структура - исходящий параметр, возвращает состояние завершения длительной операции: +// * Отказ - Булево - Истина, если при запуске, или в ходе выполнения длительной операции произошла ошибка. +// * СообщениеОбОшибке - Строка - текст ошибки, произошедшей при выполнении длительной операции, если Отказ = Истина. +// * Результат - Структура - состояние сохранения настройки синхронизации: +// ** НастройкиСохранены - Булево - Истина, если настройка синхронизации успешно завершена. +// ** СообщениеОбОшибке - Строка - текст ошибки, возникшей непосредственно в транзакции сохранения настройки синхронизации. +// +Процедура ПриЗавершенииСохраненияНастроекСинхронизации(ПараметрыОбработчика, СтатусЗавершения) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ПриЗавершенииСохраненияНастроекСинхронизации(ПараметрыОбработчика, СтатусЗавершения) +``` +
+ +## ЗавершитьНастройкуСинхронизацииДанных +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак завершения настройки синхронизации данных. +// +// Параметры: +// УзелОбмена - ПланОбменаСсылка - узел обмена, для которого необходимо установить признак. +// +Процедура ЗавершитьНастройкуСинхронизацииДанных(УзелОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ЗавершитьНастройкуСинхронизацииДанных(УзелОбмена) +``` +
+ +## НастройкаСинхронизацииЗавершена +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак завершения настройки синхронизации для узла обмена. +// +// Параметры: +// УзелОбмена - ПланОбменаСсылка - узел обмена, для которого необходимо получить признак. +// +// Возвращаемое значение: +// Булево - Истина, если настройка синхронизации для переданного узла завершена. +// +Функция НастройкаСинхронизацииЗавершена(УзелОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.НастройкаСинхронизацииЗавершена(УзелОбмена) +``` +
+ +## ЗавершитьСозданиеНачальногоОбраза +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак успешного создания начального образа узла РИБ. +// +// Параметры: +// УзелОбмена - ПланОбменаСсылка - узел обмена, для которого необходимо установить признак. +// +Процедура ЗавершитьСозданиеНачальногоОбраза(УзелОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ЗавершитьСозданиеНачальногоОбраза(УзелОбмена) +``` +
+ +## ДополнитьНастройкиТранспортаКоличествомЭлементовВТранзакции +
+ +Описание, пример вызова + +```bsl + +// Устарела. Выполняет добавление информации об установленном в константе количестве элементов в транзакции +// в структуру, содержащую параметры транспорта сообщений обмена. +// +// Параметры: +// Результат - Структура - содержит параметры транспорта сообщений обмена. +// +Процедура ДополнитьНастройкиТранспортаКоличествомЭлементовВТранзакции(Результат) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ДополнитьНастройкиТранспортаКоличествомЭлементовВТранзакции(Результат) +``` +
+ +## НомерОбластиИзКодаУзлаПланаОбмена +
+ +Описание, пример вызова + +```bsl + +// Устарела. Возвращает номер области по коду узла плана обмена (обмен сообщениями). +// +// Параметры: +// КодУзла - Строка - код узла плана обмена. +// +// Возвращаемое значение: +// Число - номер области. +// +Функция НомерОбластиИзКодаУзлаПланаОбмена(Знач КодУзла) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.НомерОбластиИзКодаУзлаПланаОбмена(КодУзла) +``` +
+ +## РезультатЗапросаВСтруктуру +
+ +Описание, пример вызова + +```bsl + +// Устарела. Возвращает данные первой записи результата запроса в виде структуры. +// +// Параметры: +// РезультатЗапроса - РезультатЗапроса - результат запроса, содержащий данные для обработки. +// +// Возвращаемое значение: +// Структура - структура с результатом. +// +Функция РезультатЗапросаВСтруктуру(Знач РезультатЗапроса) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.РезультатЗапросаВСтруктуру(РезультатЗапроса) +``` +
+ +## ПереопределяемоеИмяУзлаПланаОбмена +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать функцию ЗначениеНастройкиПланаОбмена, +// установив параметру ИмяПараметра одно из следующих значений: +// - ЗаголовокКомандыДляСозданияНовогоОбменаДанными; +// - ЗаголовокПомощникаСозданияОбмена; +// - ЗаголовокУзлаПланаОбмена; +// - НаименованиеКонфигурацииКорреспондента. +// +// Возвращает, если оно задано, переопределяемое имя плана обмена, +// в зависимости от предопределенной настройки обмена. +// Параметры: +// УзелПланаОбмена - ПланОбменаСсылка - узел плана обмена, для которого необходимо получить переопределяемое +// имя. +// ИмяПараметраСИменемУзла - Строка - имя параметра, в настройках по умолчанию, из которого необходимо получить имя узла. +// ВариантНастройки - Строка - вариант настройки обмена. +// +// Возвращаемое значение: +// Строка - переопределяемое имя плана обмена как оно заданно в конфигураторе. +// +Функция ПереопределяемоеИмяУзлаПланаОбмена(Знач УзелПланаОбмена, ИмяПараметраСИменемУзла, ВариантНастройки = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ПереопределяемоеИмяУзлаПланаОбмена(УзелПланаОбмена, ИмяПараметраСИменемУзла, ВариантНастройки); +``` +
+ +## КоличествоНерассмотренныхПроблем +
+ +Описание, пример вызова + +```bsl + +// Устарела. Возвращает количество нерассмотренных проблем обмена данными. Используется для отображения +// количества проблем обмена в пользовательском интерфейсе. Например, для использования в заголовке +// гиперссылки для перехода к монитору проблем обмена. +// +// Параметры: +// Узлы - Массив из ПланОбменаСсылка - узлы обмена. +// +// Возвращаемое значение: +// Число - количество нерассмотренных проблем обмена данными. +// +Функция КоличествоНерассмотренныхПроблем(Узлы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.КоличествоНерассмотренныхПроблем(Узлы); +``` +
+ +## СтруктураЗаголовкаГиперссылкиМонитораПроблем +
+ +Описание, пример вызова + +```bsl + +// Устарела. Возвращает структуру заголовка гиперссылки для перехода к монитору проблем обмена данными. +// +// Параметры: +// Узлы - Массив из ПланОбменаСсылка - узлы обмена. +// +// Возвращаемое значение: +// Структура: +// * Заголовок - Строка - заголовок гиперссылки. +// * Картинка - Картинка - картинка для гиперссылки. +// +Функция СтруктураЗаголовкаГиперссылкиМонитораПроблем(Узлы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.СтруктураЗаголовкаГиперссылкиМонитораПроблем(Узлы); +``` +
+ +## ВыполнитьДействиеОбменаДляУзлаИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устарела.Выполняет отправку или получение данных для узла информационной базы используя любой из +// доступных для плана обмена канал связи, кроме COM-соединения и web-сервиса. +// +// Параметры: +// Отказ - Булево - флаг отказа, устанавливается в Истина в случае +// не успешного выполнения процедуры. +// УзелИнформационнойБазы - УзелОбменаСсылка - ПланОбменаСсылка - узел плана обмена, +// для которого выполняется действие обмена данными. +// ДействиеПриОбмене - ПеречислениеСсылка.ДействияПриОбмене - выполняемое действие обмена данными. +// ВидТранспортаСообщенийОбмена - ПеречислениеСсылка.Перечисления.ВидыТранспортаСообщенийОбмена - вид транспорта, +// который будет использоваться в процессе обмена данными. Если не указан, +// определяется из параметров транспорта, заданных для узла плана обмена при +// настройке обмена. Необязательный, значение по умолчанию Неопределено. +// ТолькоПараметры - Булево - содержит признак выборочной загрузки данных при обмене РИБ. +// ДополнительныеПараметры - Структура - зарезервировано для служебного использования. +// +Процедура ВыполнитьДействиеОбменаДляУзлаИнформационнойБазы( Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ВыполнитьДействиеОбменаДляУзлаИнформационнойБазы(); +``` +
+ +## FTPКаталогСуществует +
+ +Описание, пример вызова + +```bsl + +// Устарела. Определяет, существует ли каталог на FTP-сервере. +// +// Параметры: +// Путь - Строка - путь к каталогу. +// ИмяКаталога - Строка - имя каталога. +// FTPСоединение - FTPСоединение - FTPСоединение, используемое для подключения к FTP-серверу. +// +// Возвращаемое значение: +// Булево - если Истина, то каталог существует; Ложь - нет. +// +Функция FTPКаталогСуществует(Знач Путь, Знач ИмяКаталога, Знач FTPСоединение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.FTPКаталогСуществует(Путь, ИмяКаталога, FTPСоединение) +``` +
+ +## ВсеТранспортыСообщенийОбменаКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Устарела. Возвращает массив всех видов транспорта сообщений обмена, определенных в конфигурации. +// +// Возвращаемое значение: +// Массив из ПеречислениеСсылка.ВидыТранспортаСообщенийОбмена - все виды транспорта сообщений обмена. +// +Функция ВсеТранспортыСообщенийОбменаКонфигурации() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСервер.ВсеТранспортыСообщенийОбменаКонфигурации() +``` +
+ +## ВыполнитьДействиеОбмена +
+ +Описание, пример вызова + +```bsl + +// Выполняет отправку или получение данных для узла информационной базы используя любой из +// доступных для плана обмена канал связи, кроме COM-соединения и web-сервиса. +// +// Параметры: +// Отказ - Булево - флаг отказа, устанавливается в Истина в случае +// не успешного выполнения процедуры. +// УзелИнформационнойБазы - УзелОбменаСсылка - ПланОбменаСсылка - узел плана обмена, +// для которого выполняется действие обмена данными. +// ДействиеПриОбмене - ПеречислениеСсылка.ДействияПриОбмене - выполняемое действие обмена данными. +// ИдентификаторТранспорта - Строка, Неопределено - тип транспорта, который будет использоваться в процессе обмена +// данными. +// ДополнительныеПараметры - Структура - зарезервировано для служебного использования. +// +Процедура ВыполнитьДействиеОбмена( Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСервер.ВыполнитьДействиеОбмена(); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменДаннымиСобытия.md b/src/content/docs/bsp/ОбменДаннымиСобытия.md new file mode 100644 index 0000000..97fe6ee --- /dev/null +++ b/src/content/docs/bsp/ОбменДаннымиСобытия.md @@ -0,0 +1,395 @@ +--- +title: Обмен данными события +slug: bsp/обмен-данными-события +--- + + +## МеханизмРегистрацииОбъектовПередЗаписьюДокумента +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПередЗаписью" документов для механизма регистрации объектов на узлах. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, для которого выполняется механизм регистрации. +// Источник - ДокументОбъект - источник события. +// Отказ - Булево - флаг отказа от выполнения обработчика. +// РежимЗаписи - РежимЗаписиДокумента - см. в синтакс-помощнике РежимЗаписиДокумента. +// РежимПроведения - РежимПроведенияДокумента - см. в синтакс-помощнике РежимПроведенияДокумента. +// +Процедура МеханизмРегистрацииОбъектовПередЗаписьюДокумента(ИмяПланаОбмена, Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытия.МеханизмРегистрацииОбъектовПередЗаписьюДокумента(ИмяПланаОбмена, Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## МеханизмРегистрацииОбъектовПередЗаписью +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПередЗаписью" ссылочных типов данных (кроме документов) для механизма регистрации +// объектов на узлах. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, для которого выполняется механизм регистрации. +// Источник - СправочникОбъект +// - ПланВидовХарактеристикОбъект - источник события, кроме типа ДокументОбъект. +// Отказ - Булево - флаг отказа от выполнения обработчика. +// +Процедура МеханизмРегистрацииОбъектовПередЗаписью(ИмяПланаОбмена, Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытия.МеханизмРегистрацииОбъектовПередЗаписью(ИмяПланаОбмена, Источник, Отказ) +``` +
+ +## МеханизмРегистрацииОбъектовПередЗаписьюРегистра +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПередЗаписью" регистров для механизма регистрации объектов на узлах. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, для которого выполняется механизм регистрации. +// Источник - НаборЗаписейРегистра - источник события. +// Отказ - Булево - флаг отказа от выполнения обработчика. +// Замещение - Булево - признак замещения существующего набора записей. +// +Процедура МеханизмРегистрацииОбъектовПередЗаписьюРегистра(ИмяПланаОбмена, Источник, Отказ, Замещение) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытия.МеханизмРегистрацииОбъектовПередЗаписьюРегистра(ИмяПланаОбмена, Источник, Отказ, Замещение) +``` +
+ +## МеханизмРегистрацииОбъектовПередЗаписьюКонстанты +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПередЗаписью" константы для механизма регистрации объектов на узлах. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, для которого выполняется механизм регистрации. +// Источник - КонстантаМенеджерЗначения - источник события. +// Отказ - Булево - флаг отказа от выполнения обработчика. +// +Процедура МеханизмРегистрацииОбъектовПередЗаписьюКонстанты(ИмяПланаОбмена, Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытия.МеханизмРегистрацииОбъектовПередЗаписьюКонстанты(ИмяПланаОбмена, Источник, Отказ) +``` +
+ +## МеханизмРегистрацииОбъектовПередУдалением +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПередУдалением" ссылочных типов данных для механизма регистрации объектов на узлах. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, для которого выполняется механизм регистрации. +// Источник - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект - источник события. +// Отказ - Булево - флаг отказа от выполнения обработчика. +// +Процедура МеханизмРегистрацииОбъектовПередУдалением(ИмяПланаОбмена, Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытия.МеханизмРегистрацииОбъектовПередУдалением(ИмяПланаОбмена, Источник, Отказ) +``` +
+ +## ДополнитьПолучателей +
+ +Описание, пример вызова + +```bsl + +// Процедура дополняет список узлов-получателей объекта переданными значениями. +// +// Параметры: +// Объект - СправочникОбъект +// - ДокументОбъект - объект, для которого выполняется правило регистрации. +// Узлы - Массив из ПланОбменаСсылка - узлы плана обмена, которые необходимо добавить в список узлов-получателей объекта. +// +Процедура ДополнитьПолучателей(Объект, Узлы) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытия.ДополнитьПолучателей(Объект, Узлы) +``` +
+ +## СократитьПолучателей +
+ +Описание, пример вызова + +```bsl + +// Процедура вычитает из списка узлов-получателей объекта переданные значения. +// +// Параметры: +// Объект - СправочникОбъект +// - ДокументОбъект - объект, для которого выполняется правило регистрации. +// Узлы - Массив из ПланОбменаСсылка - узлы плана обмена, которые необходимо вычесть из списка узлов-получателей объекта. +// +Процедура СократитьПолучателей(Объект, Узлы) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытия.СократитьПолучателей(Объект, Узлы) +``` +
+ +## ВыполнитьПравилаРегистрацииДляОбъекта +
+ +Описание, пример вызова + +```bsl + +// Определяет массив узлов-получателей для объекта при заданном плане обмена и выполняет регистрацию объекта на +// полученных узлах. +// +// Параметры: +// Объект - Произвольный - СправочникОбъект, ДокументОбъект и т.п. объект, для которого необходимо выполнить +// правила регистрации, и выполнить регистрацию на узлах. +// ИмяПланаОбмена - Строка - имя плана обмена как оно задано в конфигураторе. +// Отправитель - ПланОбменаСсылка - узел плана обмена от которого принимается сообщение обмена. +// Если задан, то регистрация объекта не этом узле выполнятся не будет. +// +Процедура ВыполнитьПравилаРегистрацииДляОбъекта(Объект, ИмяПланаОбмена, Отправитель = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытия.ВыполнитьПравилаРегистрацииДляОбъекта(Объект, ИмяПланаОбмена, Отправитель); +``` +
+ +## СократитьМассив +
+ +Описание, пример вызова + +```bsl + +// Вычитает один массив элементов из другого массива. Возвращает результат вычитания. +// +// Параметры: +// Массив - Массив из Произвольный - исходный массив. +// МассивВычитания - Массив из Произвольный - массив, вычитаемый из исходного массива. +// +// Возвращаемое значение: +// Массив из Произвольный - результат вычитания. +// +Функция СократитьМассив(Массив, МассивВычитания) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСобытия.СократитьМассив(Массив, МассивВычитания) +``` +
+ +## ВсеУзлыПланаОбмена +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает список всех узлов заданного плана обмена кроме предопределенного узла. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, как оно задано в конфигураторе, +// список узлов для которого необходимо получить. +// +// Возвращаемое значение: +// Массив из ПланОбменаСсылка - список всех узлов заданного плана обмена. +// +Функция ВсеУзлыПланаОбмена(ИмяПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСобытия.ВсеУзлыПланаОбмена(ИмяПланаОбмена) +``` +
+ +## ОпределитьПолучателей +
+ +Описание, пример вызова + +```bsl + +// Функция определяет массив узлов-получателей для объекта при заданном плане обмена. +// +// Параметры: +// Объект - Произвольный - СправочникОбъект, ДокументОбъект и т.п. объект, для которого необходимо выполнить +// правила регистрации, и определить список узлов-получателей. +// ИмяПланаОбмена - Строка - имя плана обмена как оно задано в конфигураторе. +// +// Возвращаемое значение: +// Массив из ПланОбменаСсылка - массив узлов-получателей для объекта. +// +Функция ОпределитьПолучателей(Объект, ИмяПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСобытия.ОпределитьПолучателей(Объект, ИмяПланаОбмена) +``` +
+ +## АвтоРегистрацияРазрешена +
+ +Описание, пример вызова + +```bsl + +// Определяет признак авторегистрации объекта метаданных в составе плана обмена. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого требуется получить признак авторегистрации. +// ИмяПланаОбмена - Строка - имя плана обмена, как оно задано в конфигураторе, в состав которого входит +// объект метаданных. +// +// Возвращаемое значение: +// Булево - признак наличия авторегистрации в плане обмена: +// * Истина - объект метаданных имеет признак авторегистрации "Разрешена" в составе плана обмена; +// * Ложь - объект метаданных имеет признак авторегистрации "Запрещена" в составе плана обмена +// или объект метаданных не входит в состав плана обмена. +// +Функция АвтоРегистрацияРазрешена(ОбъектМетаданных, ИмяПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСобытия.АвтоРегистрацияРазрешена(ОбъектМетаданных, ИмяПланаОбмена) +``` +
+ +## ЗагрузкаЗапрещена +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие запрета загрузки элемента данных. +// Для работы функции требуется настройка процедуры ДанныеДляПроверкиЗапретаИзменения +// модуля ДатыЗапретаИзмененияПереопределяемый. +// +// Параметры: +// Данные - Произвольный - СправочникОбъект.<Имя>, +// ДокументОбъект.<Имя>, +// ПланВидовХарактеристикОбъект.<Имя>, +// ПланСчетовОбъект.<Имя>, +// ПланВидовРасчетаОбъект.<Имя>, +// БизнесПроцессОбъект.<Имя>, +// ЗадачаОбъект.<Имя>, +// ПланОбменаОбъект.<Имя>, +// УдалениеОбъекта - объект данных. +// РегистрСведенийНаборЗаписей.<Имя>, +// РегистрНакопленияНаборЗаписей.<Имя>, +// РегистрБухгалтерииНаборЗаписей.<Имя>, +// РегистрРасчетаНаборЗаписей.<Имя> - набор записей. +// +// УзелПланаОбмена - ПланыОбменаОбъект - узел, +// для которого будет выполнена проверка. +// +// Возвращаемое значение: +// Булево - если Истина, загрузка запрещена. +// +Функция ЗагрузкаЗапрещена(Данные, Знач УзелПланаОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиСобытия.ЗагрузкаЗапрещена(Данные, УзелПланаОбмена) +``` +
+ +## ПриРегистрацииОбработчиковЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриРегистрацииОбработчиковЗагрузкиДанных. +Процедура ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытия.ПриРегистрацииОбработчиковЗагрузкиДанных(ТаблицаОбработчиков) +``` +
+ +## ПослеЗагрузкиОбъекта +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработчики после загрузки объекта. +// +// Параметры: +// Контейнер - ОбработкаОбъект.ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера - менеджер +// контейнера, используемый в процессе выгрузи данных. Подробнее см. комментарий +// к программному интерфейсу обработки ВыгрузкаЗагрузкаДанныхМенеджерКонтейнера. +// Объект - Произвольный - объект загружаемых данных. +// Артефакты - Массив из ОбъектXDTO - массив артефактов (объектов XDTO). +// +Процедура ПослеЗагрузкиОбъекта(Контейнер, Объект, Артефакты) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытия.ПослеЗагрузкиОбъекта(Контейнер, Объект, Артефакты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменСообщениями.md b/src/content/docs/bsp/ОбменСообщениями.md new file mode 100644 index 0000000..cc0efac --- /dev/null +++ b/src/content/docs/bsp/ОбменСообщениями.md @@ -0,0 +1,250 @@ +--- +title: Обмен сообщениями +slug: bsp/обмен-сообщениями +--- + + +## ОтправитьСообщение +
+ +Описание, пример вызова + +```bsl + +// Выполняет отправку сообщения в адресный канал сообщений. +// Соответствует типу отправки "Конечная точка/Конечная точка". +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КаналСообщений - Строка - Идентификатор адресного канала сообщений. +// ТелоСообщения - Произвольный - Тело сообщения системы, которое необходимо отправить. +// Получатель - Неопределено - получатель сообщения не указан. Сообщение будет отправлено конечным +// точкам, которые определяются настройками текущей информационной системы: +// в обработчике ОбменСообщениямиПереопределяемый.ПолучателиСообщения +// (программно) и в +// регистре сведений НастройкиОтправителя (настройка системы). +// - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, который соответствует +// конечной точке, для которой предназначено сообщение. +// Сообщение будет отправлено только +// этой конечной точке. +// - Массив - массив получателей сообщения; элементы массива должны +// иметь тип ПланОбменаСсылка.ОбменСообщениями. +// Сообщение будет отправлено всем конечным точкам, указанным в массиве. +// +Процедура ОтправитьСообщение(КаналСообщений, ТелоСообщения = Неопределено, Получатель = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениями.ОтправитьСообщение(КаналСообщений, ТелоСообщения, Получатель); +``` +
+ +## ОтправитьСообщениеСейчас +
+ +Описание, пример вызова + +```bsl + +// Выполняет отправку сообщения в адресный канал сообщений. +// Соответствует типу отправки "Конечная точка/Конечная точка". +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КаналСообщений - Строка - Идентификатор адресного канала сообщений. +// ТелоСообщения - Произвольный - Тело сообщения системы, которое необходимо отправить. +// Получатель - Неопределено - получатель сообщения не указан. Сообщение будет отправлено +// конечным точкам, которые определяются настройками текущей +// информационной системы: в обработчике +// ОбменСообщениямиПереопределяемый.ПолучателиСообщения (программно) и +// в регистре сведений НастройкиОтправителя (настройка системы). +// - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, который соответствует +// конечной точке, для которой предназначено +// сообщение. Сообщение будет отправлено +// только этой конечной точке. +// - Массив - массив получателей сообщения; элементы массива должны +// иметь тип ПланОбменаСсылка.ОбменСообщениями. Сообщение будет отправлено +// всем конечным точкам, указанным в массиве. +// +Процедура ОтправитьСообщениеСейчас(КаналСообщений, ТелоСообщения = Неопределено, Получатель = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениями.ОтправитьСообщениеСейчас(КаналСообщений, ТелоСообщения, Получатель); +``` +
+ +## ОтправитьСообщениеПодписчикам +
+ +Описание, пример вызова + +```bsl + +// Выполняет отправку сообщения в широковещательный канал сообщений. +// Соответствует типу отправки "Публикация/Подписка". +// Сообщение будет доставлено конечным точкам, которые подписаны на широковещательный канал. +// Настройка подписок на широковещательный канал выполняется через регистр сведений ПодпискиПолучателей. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КаналСообщений - Строка - Идентификатор широковещательного канала сообщений. +// ТелоСообщения - Произвольный - Тело сообщения системы, которое необходимо отправить. +// +Процедура ОтправитьСообщениеПодписчикам(КаналСообщений, ТелоСообщения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениями.ОтправитьСообщениеПодписчикам(КаналСообщений, ТелоСообщения); +``` +
+ +## ОтправитьСообщениеПодписчикамСейчас +
+ +Описание, пример вызова + +```bsl + +// Выполняет отправку быстрого сообщения в широковещательный канал сообщений. +// Соответствует типу отправки "Публикация/Подписка". +// Сообщение будет доставлено конечным точкам, которые подписаны на широковещательный канал. +// Настройка подписок на широковещательный канал выполняется через регистр сведений ПодпискиПолучателей. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КаналСообщений - Строка - Идентификатор широковещательного канала сообщений. +// ТелоСообщения - Произвольный - Тело сообщения системы, которое необходимо отправить. +// +Процедура ОтправитьСообщениеПодписчикамСейчас(КаналСообщений, ТелоСообщения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениями.ОтправитьСообщениеПодписчикамСейчас(КаналСообщений, ТелоСообщения); +``` +
+ +## ДоставитьСообщения +
+ +Описание, пример вызова + +```bsl + +// Выполняет немедленную отправку быстрых сообщений из общей очереди сообщений. +// Отправка сообщений выполняется в цикле до тех пор, пока из очереди сообщений +// не будут отправлены все быстрые сообщения. +// На время отправки сообщений блокируется немедленная отправка сообщений из других сеансов. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ДоставитьСообщения() Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениями.ДоставитьСообщения() +``` +
+ +## ПодключитьКонечнуюТочку +
+ +Описание, пример вызова + +```bsl + +// Выполняет подключение конечной точки. +// Перед подключением конечной точки выполняется проверка установки соединения +// отправителя к получателю и получателя к отправителю. +// Также проверяется то, что настройки подключения получателя указывают на текущего отправителя. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Отказ - Булево - Флаг выполнения операции; поднимается в случае ошибок +// при подключении конечной точки. +// НастройкиПодключенияОтправителя - Структура - Параметры подключения отправителя. Содержит свойства: +// Для инициализации используется функция ОбменДаннымиСервер.СтруктураПараметровWS. +// * WSURLВебСервиса - Строка - Веб-адрес подключаемой конечной точки. +// * WSИмяПользователя - Строка - Пользователь для аутентификации в подключаемой конечной точке +// при работе через web-сервис подсистемы обмена сообщениями. +// * WSПароль - Строка - Пароль пользователя в подключаемой конечной точке. +// НастройкиПодключенияПолучателя - Структура - Параметры подключения получателя. Содержит свойства: +// Для инициализации используется функция ОбменДаннымиСервер.СтруктураПараметровWS. +// * WSURLВебСервиса - Строка - Веб-адрес этой информационной базы со стороны +// подключаемой конечной точки. +// * WSИмяПользователя - Строка - Пользователь для аутентификации в этой информационной базе +// при работе через web-сервис подсистемы обмена сообщениями. +// * WSПароль - Строка - Пароль пользователя в этой информационной базе. +// КонечнаяТочка - ПланОбменаСсылка.ОбменСообщениями, Неопределено - Если подключение конечной +// точки завершилось успешно, то в этот параметр возвращается ссылка на узел плана обмена, +// который соответствует подключенной конечной точке. +// Если подключить конечную точку не удалось, то возвращается Неопределено. +// НаименованиеКонечнойТочкиПолучателя - Строка - Наименование подключаемой конечной точки. +// Если значение не задано, то в качестве наименования используется синоним +// конфигурации подключаемой конечной точки. +// НаименованиеКонечнойТочкиОтправителя - Строка - Наименование конечной точки, которая соответствует +// этой информационной базе. Если значение не задано, то в качестве +// наименования используется синоним конфигурации этой информационной базы. +// +Процедура ПодключитьКонечнуюТочку(Отказ, НастройкиПодключенияОтправителя, НастройкиПодключенияПолучателя, Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениями.ПодключитьКонечнуюТочку(Отказ, НастройкиПодключенияОтправителя, НастройкиПодключенияПолучателя, ); +``` +
+ +## ОбновитьНастройкиПодключенияКонечнойТочки +
+ +Описание, пример вызова + +```bsl + +// Выполняет обновление настроек подключения для конечной точки. +// Обновляются настройки подключения этой информационной базы к указанной конечной точке +// и настройки подключения конечной точки к этой информационной базе. +// Перед применением настроек выполняется проверка подключения на правильность задания настроек. +// Также проверяется то, что настройки подключения получателя указывают на текущего отправителя. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Отказ - Булево - Флаг выполнения операции; поднимается в случае ошибок. +// КонечнаяТочка - ПланОбменаСсылка.ОбменСообщениями - Ссылка на узел плана обмена, +// который соответствует конечной точке. +// +// НастройкиПодключенияОтправителя - Структура - Параметры подключения отправителя. Содержит свойства: +// Для инициализации используется функция ОбменДаннымиСервер.СтруктураПараметровWS. +// * WSURLВебСервиса - Строка - Веб-адрес подключаемой конечной точки. +// * WSИмяПользователя - Строка - Пользователь для аутентификации в подключаемой конечной точке +// при работе через web-сервис подсистемы обмена сообщениями. +// * WSПароль - Строка - Пароль пользователя в подключаемой конечной точке. +// НастройкиПодключенияПолучателя - Структура - Параметры подключения получателя. Содержит свойства: +// Для инициализации используется функция ОбменДаннымиСервер.СтруктураПараметровWS. +// * WSURLВебСервиса - Строка - Веб-адрес этой информационной базы со стороны подключаемой +// конечной точки. +// * WSИмяПользователя - Строка - Пользователь для аутентификации в этой информационной базе +// при работе через web-сервис подсистемы обмена сообщениями. +// * WSПароль - Строка - Пароль пользователя в этой информационной базе. +// +Процедура ОбновитьНастройкиПодключенияКонечнойТочки(Отказ, КонечнаяТочка, Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениями.ОбновитьНастройкиПодключенияКонечнойТочки(Отказ, КонечнаяТочка, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменСообщениямиВнутренний.md b/src/content/docs/bsp/ОбменСообщениямиВнутренний.md new file mode 100644 index 0000000..9781b57 --- /dev/null +++ b/src/content/docs/bsp/ОбменСообщениямиВнутренний.md @@ -0,0 +1,195 @@ +--- +title: Обмен сообщениями внутренний +slug: bsp/обмен-сообщениями-внутренний +--- + + +## ЭтотУзел +
+ +Описание, пример вызова + +```bsl + +// @skip-warning ПустойМетод - особенность реализации. +// Возвращаемое значение: +// ПланОбменаСсылка.ОбменСообщениями - ссылка на узел. +Функция ЭтотУзел() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСообщениямиВнутренний.ЭтотУзел() +``` +
+ +## ПриВыгрузкеДанных +
+ +Описание, пример вызова + +```bsl + +// См. ОбменДаннымиПереопределяемый.ПриВыгрузкеДанных +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПриВыгрузкеДанных(СтандартнаяОбработка, Получатель, ИмяФайлаСообщения, Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиВнутренний.ПриВыгрузкеДанных(СтандартнаяОбработка, Получатель, ИмяФайлаСообщения, ); +``` +
+ +## ПриЗагрузкеДанных +
+ +Описание, пример вызова + +```bsl + +// См. ОбменДаннымиПереопределяемый.ПриЗагрузкеДанных +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПриЗагрузкеДанных(СтандартнаяОбработка, Отправитель, Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиВнутренний.ПриЗагрузкеДанных(СтандартнаяОбработка, Отправитель, ); +``` +
+ +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазыБСП.ПриДобавленииОбработчиковОбновления +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Обработчики - см. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления +// +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиВнутренний.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ПриОпределенииОбъектовСРедактируемымиРеквизитами +
+ +Описание, пример вызова + +```bsl + +// См. ГрупповоеИзменениеОбъектовПереопределяемый.ПриОпределенииОбъектовСРедактируемымиРеквизитами +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Объекты - см. ГрупповоеИзменениеОбъектовПереопределяемый.ПриОпределенииОбъектовСРедактируемымиРеквизитами.Объекты +// +Процедура ПриОпределенииОбъектовСРедактируемымиРеквизитами(Объекты) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиВнутренний.ПриОпределенииОбъектовСРедактируемымиРеквизитами(Объекты) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +// +// Параметры: +// Типы - см. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиВнутренний.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияПереопределяемый.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов.ПоддерживаемыеВерсии +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// СтруктураПоддерживаемыхВерсий - см. ОбщегоНазначенияПереопределяемый.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов.ПоддерживаемыеВерсии +// +Процедура ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(Знач СтруктураПоддерживаемыхВерсий) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиВнутренний.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(СтруктураПоддерживаемыхВерсий) +``` +
+ +## УстановитьКодЭтойКонечнойТочки +
+ +Описание, пример вызова + +```bsl + +// Устанавливает код этой конечной точки, если не установлен. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура УстановитьКодЭтойКонечнойТочки() Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиВнутренний.УстановитьКодЭтойКонечнойТочки() +``` +
+ +## ПеренестиНастройкиТранспортаОбменаСообщениями +
+ +Описание, пример вызова + +```bsl + +// Переносит настройки транспорта обмена сообщениями в новый регистр. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПеренестиНастройкиТранспортаОбменаСообщениями() Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиВнутренний.ПеренестиНастройкиТранспортаОбменаСообщениями() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбменСообщениямиПереопределяемый.md b/src/content/docs/bsp/ОбменСообщениямиПереопределяемый.md new file mode 100644 index 0000000..ca7b849 --- /dev/null +++ b/src/content/docs/bsp/ОбменСообщениямиПереопределяемый.md @@ -0,0 +1,136 @@ +--- +title: Обмен сообщениями переопределяемый +slug: bsp/обмен-сообщениями-переопределяемый +--- + + +## ПолучитьОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Получает список обработчиков сообщений, которые обрабатывает данная информационная система. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Обработчики - ТаблицаЗначений - с колонками: +// * Канал - Строка - Канал сообщения. +// * Обработчик - ОбщийМодуль - Обработчик сообщения. +// +Процедура ПолучитьОбработчикиКаналовСообщений(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиПереопределяемый.ПолучитьОбработчикиКаналовСообщений(Обработчики) +``` +
+ +## ПолучателиСообщения +
+ +Описание, пример вызова + +```bsl + +// Обработчик получения динамического списка конечных точек сообщений. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// КаналСообщений - Строка - Идентификатор канала сообщений, для которого необходимо определить +// конечные точки. +// Получатели - Массив - Массив конечных точек, в которые следует адресовать сообщение, +// должен быть заполнен элементами типа ПланОбменаСсылка.ОбменСообщениями. +// Этот параметр необходимо определить в теле обработчика. +// +Процедура ПолучателиСообщения(Знач КаналСообщений, Получатели) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиПереопределяемый.ПолучателиСообщения(КаналСообщений, Получатели) +``` +
+ +## ПриОтправкеСообщения +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обработчики событий отправки и получения сообщений. + +// Обработчик события при отправке сообщения. +// Обработчик данного события вызывается перед помещением сообщения в XML-поток. +// Обработчик вызывается для каждого отправляемого сообщения. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// КаналСообщений - Строка - Идентификатор канала сообщений, в который отправляется сообщение. +// ТелоСообщения - Произвольный - Тело отправляемого сообщения. В обработчике события тело сообщения +// может быть изменено, например, дополнено информацией. +// +Процедура ПриОтправкеСообщения(КаналСообщений, ТелоСообщения) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиПереопределяемый.ПриОтправкеСообщения(КаналСообщений, ТелоСообщения) +``` +
+ +## ПриПолученииСообщения +
+ +Описание, пример вызова + +```bsl + +// Обработчик события при получении сообщения. +// Обработчик данного события вызывается при получении сообщения из XML-потока. +// Обработчик вызывается для каждого получаемого сообщения. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// КаналСообщений - Строка - Идентификатор канала сообщений, из которого получено сообщение. +// ТелоСообщения - Произвольный - Тело полученного сообщения. В обработчике события тело сообщения +// может быть изменено, например, дополнено информацией. +// +Процедура ПриПолученииСообщения(КаналСообщений, ТелоСообщения) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиПереопределяемый.ПриПолученииСообщения(КаналСообщений, ТелоСообщения) +``` +
+ +## ПриИсчерпанииПопытокОбработкиСообщения +
+ +Описание, пример вызова + +```bsl + +// см. ОбменСообщениямиВнутренний.ПриИсчерпанииПопытокОбработкиСообщения +// @skip-check module-empty-method - особенность реализации. +Процедура ПриИсчерпанииПопытокОбработкиСообщения(КаналСообщений, ТелоСообщения, Отправитель, ПодробноеПредставлениеОшибки) Экспорт +``` + +Пример вызова +```bsl +ОбменСообщениямиПереопределяемый.ПриИсчерпанииПопытокОбработкиСообщения(КаналСообщений, ТелоСообщения, Отправитель, ПодробноеПредставлениеОшибки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбновлениеИнформационнойБазы.md b/src/content/docs/bsp/ОбновлениеИнформационнойБазы.md new file mode 100644 index 0000000..78c3cde --- /dev/null +++ b/src/content/docs/bsp/ОбновлениеИнформационнойБазы.md @@ -0,0 +1,2354 @@ +--- +title: Обновление информационной базы +slug: bsp/обновление-информационной-базы +--- + + +## ЗаписатьДанные +
+ +Описание, пример вызова + +```bsl + +// Записывает изменения в переданном объекте. +// Для использования в обработчиках обновления. +// +// Параметры: +// Данные - Произвольный - объект, набор записей или менеджер константы, который +// необходимо записать. +// РегистрироватьНаУзлахПлановОбмена - Булево - включает регистрацию на узлах планов обмена при записи объекта. +// ВключитьБизнесЛогику - Булево - включает бизнес-логику при записи объекта. +// +Процедура ЗаписатьДанные(Знач Данные, Знач РегистрироватьНаУзлахПлановОбмена = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ЗаписатьДанные(Данные, РегистрироватьНаУзлахПлановОбмена, ); +``` +
+ +## ЗаписатьОбъект +
+ +Описание, пример вызова + +```bsl + +// Записывает изменения в переданном объекте ссылочного типа. +// Для использования в обработчиках обновления. +// +// Параметры: +// Объект - Произвольный - записываемый объект ссылочного типа. Например, СправочникОбъект. +// РегистрироватьНаУзлахПлановОбмена - Булево - включает регистрацию на узлах планов обмена при записи объекта. +// ВключитьБизнесЛогику - Булево - включает бизнес-логику при записи объекта. +// ДокументРежимЗаписи - РежимЗаписиДокумента - имеет смысл только для данных типа ДокументОбъект - режим +// записи документа. +// Если параметр не передан, то документ записывается в режиме "Запись". +// +Процедура ЗаписатьОбъект(Знач Объект, Знач РегистрироватьНаУзлахПлановОбмена = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ЗаписатьОбъект(Объект, РегистрироватьНаУзлахПлановОбмена, ); +``` +
+ +## ЗаписатьНаборЗаписей +
+ +Описание, пример вызова + +```bsl + +// Записывает изменения в переданном наборе записей. +// Для использования в обработчиках обновления. +// +// Параметры: +// НаборЗаписей - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор записей, который необходимо записать. +// Замещать - Булево - определяет режим замещения существующей записи в соответствии с +// текущими установками отбора. Истина - перед записью существующие +// записи будут удалены. Ложь - записи будут дописаны к уже существующим +// в информационной базе записям. +// РегистрироватьНаУзлахПлановОбмена - Булево - включает регистрацию на узлах планов обмена при записи объекта. +// ВключитьБизнесЛогику - Булево - включает бизнес-логику при записи объекта. +// +Процедура ЗаписатьНаборЗаписей(Знач НаборЗаписей, Замещать = Истина, Знач РегистрироватьНаУзлахПлановОбмена = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ЗаписатьНаборЗаписей(НаборЗаписей, Замещать, РегистрироватьНаУзлахПлановОбмена, ); +``` +
+ +## УдалитьДанные +
+ +Описание, пример вызова + +```bsl + +// Удаляет переданный объект. +// Для использования в обработчиках обновления. +// +// Параметры: +// Данные - Произвольный - объект, который необходимо удалить. +// РегистрироватьНаУзлахПлановОбмена - Булево - включает регистрацию на узлах планов обмена при записи объекта. +// ВключитьБизнесЛогику - Булево - включает бизнес-логику при записи объекта. +// +Процедура УдалитьДанные(Знач Данные, Знач РегистрироватьНаУзлахПлановОбмена = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.УдалитьДанные(Данные, РегистрироватьНаУзлахПлановОбмена, ); +``` +
+ +## СобытиеЖурналаРегистрации +
+ +Описание, пример вызова + +```bsl + +// Возвращает строковую константу для формирования сообщений журнала регистрации. +// +// Возвращаемое значение: +// Строка - текст события журнала регистрации. +// +Функция СобытиеЖурналаРегистрации() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.СобытиеЖурналаРегистрации() +``` +
+ +## ПроверитьОбъектОбработан +
+ +Описание, пример вызова + +```bsl + +// Вызывает исключение или блокирует форму от редактирования, если +// имеются незавершенные отложенные обработчики обновления, +// которые в данный момент обрабатывают переданный объект Данные. +// +// При вызове из отложенного обработчика обновления (случай проверки в программном интерфейсе) +// проверка не выполняется, если не указан параметр ИмяОтложенногоОбработчика, так как +// предполагается, что порядок обновления уже учтен при построении очередей. +// +// Параметры: +// Данные - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей +// - ЛюбаяСсылка +// - ДанныеФормыСтруктура +// - Строка - ссылка на объект, сам объект, набор записей или полное имя объекта +// метаданных, обработку которого необходимо проверить. +// Форма - ФормаКлиентскогоПриложения - если объект не обработан, то у переданной формы +// будет установлено свойство ТолькоПросмотр. Если форма не была +// передана, то будет вызвано исключение. +// +// ИмяОтложенногоОбработчика - Строка - если заполнено, тогда при вызове из другого отложенного обработчика +// проверяется, что указанный отложенный обработчик имеет номер очереди меньше, чем текущий. +// Если это не так, тогда вызывается исключение о недопустимости использования +// программного интерфейса, указанного в параметре ИмяПроцедурыПрограммногоИнтерфейса. +// +// ИмяПроцедурыПрограммногоИнтерфейса - Строка - имя процедуры программного интерфейса, +// которое выводится в тексте исключения, вызываемого при проверке номера очереди +// отложенного обработчика обновления, указанного в параметре ИмяОтложенногоОбработчика. +// +// Пример: +// Блокировка формы объекта в обработчике ПриСозданииНаСервере модуля формы: +// ОбновлениеИнформационнойБазы.ПроверитьОбъектОбработан(Объект, ЭтотОбъект); +// +// Блокировка записи объекта в обработчике ПередЗаписью модуля объекта (набора записей): +// ОбновлениеИнформационнойБазы.ПроверитьОбъектОбработан(ЭтотОбъект); +// +// Проверить, что обновлен конкретный объект и вызвать исключение о недопустимости вызова +// процедуры ЭлектроннаяПодпись.ОбновитьПодпись, если он еще не обработан указанным обработчиком +// Справочник.ЭлектронныеПодписи.ОбработатьДанныеДляПереходаНаНовуюВерсию: +// +// ОбновлениеИнформационнойБазы.ПроверитьОбъектОбработан(ПодписанныйОбъект,, +// "Справочник.ЭлектронныеПодписи.ОбработатьДанныеДляПереходаНаНовуюВерсию", +// "ЭлектроннаяПодпись.ОбновитьПодпись"); +// +// Проверить и вызвать исключение, если обновлены не все объекты требуемого типа: +// ОбновлениеИнформационнойБазы.ПроверитьОбъектОбработан("Документ.ЗаказПокупателя"); +// +Процедура ПроверитьОбъектОбработан(Данные, Форма = Неопределено, ИмяОтложенногоОбработчика = "", ИмяПроцедурыПрограммногоИнтерфейса = "") Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ПроверитьОбъектОбработан(Данные, Форма, ИмяОтложенногоОбработчика, ИмяПроцедурыПрограммногоИнтерфейса); +``` +
+ +## ОбъектОбработан +
+ +Описание, пример вызова + +```bsl + +// Проверяет, имеются ли отложенные обработчики обновления, +// которые в данный момент обрабатывают переданный объект Данные. +// +// Параметры: +// Данные - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей +// - ЛюбаяСсылка +// - ДанныеФормыСтруктура +// - Строка - ссылка на объект, сам объект, набор записей или полное имя объекта метаданных, +// блокировку которого необходимо проверить. +// +// Возвращаемое значение: +// Структура: +// * Обработан - Булево - признак того, что переданный объект обработан. +// * ТекстИсключения - Строка - текст исключения, если объект еще не обработан, +// содержит список незавершенных обработчиков. +// +// Пример: +// Проверить, что обновлены все объекты требуемого типа: +// ВсеЗаказыОбработаны = ОбновлениеИнформационнойБазы.ОбъектОбработан("Документ.ЗаказПокупателя"); +// +Функция ОбъектОбработан(Данные) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ОбъектОбработан(Данные) +``` +
+ +## ОтметитьВыполнениеОбработки +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для использования в отложенных обработчиках обновления +// с режимом выполнения "Параллельно". +// + +// Отмечает, что переданные данные обновлены. +// +// Параметры: +// Данные - ЛюбаяСсылка +// - Массив +// - РегистрСведенийНаборЗаписей, РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - данные, по которым нужно зарегистрировать изменения. +// - ТаблицаЗначений - значения измерений независимого регистра сведений. Требования: +// а) все измерения регистра должны входить в основной отбор; +// б) в таблице должны быть только колонки, соответствующие по именам измерениям регистра, +// по которым ранее регистрировалась необходимость обработки; +// в) запись наборов в процессе обновления должна проходить с тем же отбором, +// что и регистрация необходимости обработки; +// г) в ДополнительныеПараметры нужно передать соответствующий признак и полное имя регистра. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыОтметкиОбработки. +// Очередь - Число +// - Неопределено - очередь обработки, в которой выполняется текущий обработчик. По умолчанию очередь передавать +// не нужно, т.к. она будет взята из параметров сеанса, в котором запущен обработчик обновления. +// +Процедура ОтметитьВыполнениеОбработки(Данные, ДополнительныеПараметры = Неопределено, Очередь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ОтметитьВыполнениеОбработки(Данные, ДополнительныеПараметры, Очередь); +``` +
+ +## ДополнительныеПараметрыОтметкиОбработки +
+ +Описание, пример вызова + +```bsl + +// Дополнительные параметры функций ОтметитьКОбработке и ОтметитьВыполнениеОбработки. +// +// Возвращаемое значение: +// Структура: +// * ЭтоДвижения - Булево - в параметре Данные функции переданы ссылки на регистраторы, по которым нужно обновить движения. +// Значение по умолчанию - Ложь. +// * ПолноеИмяРегистра - Строка - полное имя регистра, по которому нужно обновить данные. Например, РегистрНакопления.ТоварыНаСкладах. +// * ОтметитьВсеРегистраторы - Булево - необходимо отметить к обработке все проведенные документы переданного во +// втором параметре типа. +// В этом случае в параметре Данные процедуры можно передавать +// ОбъектМетаданных:Документ или ДокументСсылка. +// * ЭтоНезависимыйРегистрСведений - Булево - в параметре Данные функции передана таблица со значениями измерений, +// по которым нужно обновлять данные, значение по умолчанию - Ложь. +// +Функция ДополнительныеПараметрыОтметкиОбработки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ДополнительныеПараметрыОтметкиОбработки() +``` +
+ +## ОсновныеПараметрыОтметкиКОбработке +
+ +Описание, пример вызова + +```bsl + +// Основные параметры процедуры ОбновлениеИнформационнойБазы.ОтметитьКОбработке, +// которые инициализируются механизмом регистрации изменений +// и не должны переопределяться в коде процедур отметки к обработке обработчиков обновления. +// +// Возвращаемое значение: +// Структура: +// * Очередь - Число - очередь обработки, в которой выполняется текущий обработчик. +// * ЗаписьИзмененийДляПодчиненногоУзлаРИБСФильтрами - ЗаписьFastInfoset - параметр +// существует, только если внедрена подсистема ОбменДанными. +// * ПараметрыВыборки - см. ДополнительныеПараметрыВыборкиДанныхДляМногопоточнойОбработки +// +Функция ОсновныеПараметрыОтметкиКОбработке() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ОсновныеПараметрыОтметкиКОбработке() +``` +
+ +## МетаданныеИОтборПоДанным +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о переданных данных в нормализованном виде. +// Для использования в процедурах проверки блокировки данных отложенных обработчиков обновления. +// +// Параметры: +// Данные - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей +// - ЛюбаяСсылка +// - ДанныеФормыСтруктура - значение входящего параметра Данные. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыОтметкиОбработки +// +// Возвращаемое значение: +// Структура: +// * Данные - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей +// - ЛюбаяСсылка +// - ДанныеФормыСтруктура - данные, которые нужно проанализировать. +// * МетаданныеОбъекта - ОбъектМетаданных - объект метаданных, соответствующий параметру Данные. +// * ПолноеИмя - Строка - полное имя объекта метаданных (см. метод ОбъектМетаданных.ПолноеИмя). +// * Отбор - ЛюбаяСсылка - если Данные - это ссылочный объект, то значение ссылки, +// если регистр подчиненный регистратору, - значение отбора по регистратору. +// - Структура - если Данные - это независимый регистр сведений, то структура, соответствующая +// установленным отборам по измерениям. +// * ЭтоНовый - Булево - если Данные - это ссылочный объект, то признак нового объекта. +// Для других типов - всегда Ложь. +// +Функция МетаданныеИОтборПоДанным(Данные, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.МетаданныеИОтборПоДанным(Данные, ДополнительныеПараметры); +``` +
+ +## ОтметитьКОбработке +
+ +Описание, пример вызова + +```bsl + +// Отмечает, что переданные данные необходимо обновить. +// Важно: не рекомендуется передавать в параметр Данные сразу все данные, которые +// необходимо зарегистрировать к обработке, т.к. большие коллекции типа Массив +// или ТаблицаЗначений могут занять существенный объем памяти сервера и привести +// к сильному снижению производительности системы. Рекомендуется получать и передавать +// данные небольшими порциями, например по 1000 объектов. +// +// Параметры: +// ОсновныеПараметры - см. ОбновлениеИнформационнойБазы.ОсновныеПараметрыОтметкиКОбработке. +// Данные - ЛюбаяСсылка +// - Массив +// - РегистрСведенийНаборЗаписей, РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - данные, по которым нужно зарегистрировать изменения. +// - ТаблицаЗначений - значения измерений независимого регистра сведений. Требования: +// а) нет измерений с именем "Узел"; +// б) все измерения регистра должны входить в основной отбор; +// в) в таблице должны быть только колонки, соответствующие по именам измерениям регистра, +// по которым нужно регистрировать необходимость обработки; +// г) запись наборов в процессе обновления должна проходить с тем же отбором, +// что и регистрация необходимости обработки; +// д) в ДополнительныеПараметры нужно передать соответствующий признак и полное имя регистра. +// - РезультатЗапроса - для ссылочных объектов (требуется колонка Ссылка) и независимых регистров +// сведений (см. ограничения выше) +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыОтметкиОбработки. +// +Процедура ОтметитьКОбработке(ОсновныеПараметры, Данные, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ОтметитьКОбработке(ОсновныеПараметры, Данные, ДополнительныеПараметры); +``` +
+ +## ОтметитьРегистраторыКОбработке +
+ +Описание, пример вызова + +```bsl + +// Отмечает, что по переданным регистраторам нужно переформировать движения. +// +// Параметры: +// Параметры - см. ОбновлениеИнформационнойБазы.ОсновныеПараметрыОтметкиКОбработке. +// Регистраторы - Массив - массив ссылок регистраторов. +// ПолноеИмяРегистра - Строка - полное имя регистра, для которого необходимо обновить движения. +// +Процедура ОтметитьРегистраторыКОбработке(Параметры, Регистраторы, ПолноеИмяРегистра) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ОтметитьРегистраторыКОбработке(Параметры, Регистраторы, ПолноеИмяРегистра) +``` +
+ +## ДополнительныеПараметрыВыборкиДанныхДляОбработки +
+ +Описание, пример вызова + +```bsl + +// Дополнительные параметры выборки данных для обработки. +// +// Возвращаемое значение: +// Структура: +// * ВыбиратьПорциями - Булево - выбирать данные для обработки порциями. +// Если выбираются документы, то порция определяется с учетом упорядочивания по убыванию +// по дате документа. Если выбираются регистраторы регистра, то порция определяется с +// учетом упорядочивания по убыванию по дате регистратора, если передано полное имя документа. +// Если полное имя документа не передано - упорядочивание происходит по периоду регистра: +// а) берется максимальная дата по каждому регистратору; +// б) если по регистратору нет записей, он в топе. +// * ИмяВременнойТаблицы - Строка - параметр актуален для методов, создающих временные таблицы. Если имя не задано +// (поведение по умолчанию), то временная таблица будет создана с именем, указанным +// в описании каждого метода. +// * ДополнительныеИсточникиДанных - Соответствие из КлючИЗначение - параметр актуален для методов, выбирающих +// регистраторы и ссылки для обработки. В ключах соответствия может быть только один +// из следующих видов данных: +// 1. Пути к реквизитам шапки документа или реквизитам табличных частей, которые +// участвуют в соединениях с другими таблицами (в т.ч. неявных соединениях при +// обращении "через точку"). +// 2. Имена ссылочных объектов метаданных (Строка), в значениях которых находится +// соответствие, в котором ключ - это имя регистра (Строка), а в значении +// соответствие в ключах которого то же, что и в п. 1, т.е. +// иерархия соответствий "Объект" -> "Регистр" -> "Источники". +// Процедуры проверяют блокировку данных этих таблиц обработчиками меньших +// очередей. Формат имен источников: <ИмяРеквизита> или +// <ИмяТабличной>.<ИмяРеквизитаТабличнойЧасти>. Для удобства заполнения +// см. УстановитьИсточникДанных(). +// * ПоляУпорядочивания - Массив - имена полей независимого регистра сведений, используется для упорядочивания +// результата запроса. +// * МаксимумВыборки - Число - максимальное количество выбираемых записей. +// * ИмяИзмеренияДляОтбора - Строка - имя измерения независимого регистра сведений, которому подчинены записи набора, +// (аналог регистратора для регистров, подчиненных регистраторам). +// +Функция ДополнительныеПараметрыВыборкиДанныхДляОбработки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляОбработки() +``` +
+ +## ПараметрыВыборкиАктуальныхДанных +
+ +Описание, пример вызова + +```bsl + +// Параметры, используемые для выборки актуальных данных обработчика при выполнении обновления. +// Используется для обработчиков с обычным порядком. Данные, которые не удовлетворяют условию +// будут обрабатываться в порядке некритичных обработчиков. +// +// Возвращаемое значение: +// Структура: +// * ПолеОтбора - Строка - имя реквизита, по которому устанавливается отбор. +// * ВидСравнения - ВидСравнения - допустимые значения - Больше, Меньше, Равно, +// БольшеИлиРавно, МеньшеИлиРавно. +// * Значение - Произвольный - значение, по которому будет выполняться сравнение. +// +Функция ПараметрыВыборкиАктуальныхДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ПараметрыВыборкиАктуальныхДанных() +``` +
+ +## ДополнительныеПараметрыВыборкиДанныхДляМногопоточнойОбработки +
+ +Описание, пример вызова + +```bsl + +// Дополнительные параметры выборки данных для многопоточной обработки. +// +// Возвращаемое значение: +// Структура - поля из ДополнительныеПараметрыВыборкиДанныхДляОбработки(), дополненные следующими полями: +// * ПолныеИменаОбъектов - Строка - полные имена обновляемых объектов (например, документов), разделенные запятыми. +// * ПолныеИменаРегистров - Строка - полные имена регистров, разделенные запятыми. +// * ПоляУпорядочиванияПриРаботеПользователей - Массив - поля упорядочивания, используемые при обновлении +// с приоритетом работы пользователей. +// * ПоляУпорядочиванияПриОбработкеДанных - Массив - поля упорядочивания, используемые при обновлении +// с приоритетом обработки данных. +// * СпособВыборки - Строка - один из способов выборки: +// ОбновлениеИнформационнойБазы.СпособВыборкиИзмеренияНезависимогоРегистраСведений(), +// ОбновлениеИнформационнойБазы.СпособВыборкиРегистраторыРегистра(), +// ОбновлениеИнформационнойБазы.СпособВыборкиСсылки(). +// * ПоследняяВыбраннаяЗапись - СписокЗначений - конец предыдущей выборки (служебное поле). +// * ПерваяЗапись - СписокЗначений - начало выборки (служебное поле). +// * ПоследняяЗапись - СписокЗначений - конец выборки (служебное поле). +// * ОптимизироватьВыборкуПоСтраницам - Булево - если Истина, то выборка выполняется без ИЛИ, значение Ложь может +// быть полезно, если исходный запрос не оптимален, тогда с ИЛИ будет быстрее. +// +Функция ДополнительныеПараметрыВыборкиДанныхДляМногопоточнойОбработки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляМногопоточнойОбработки() +``` +
+ +## УстановитьИсточникДанных +
+ +Описание, пример вызова + +```bsl + +// Установить параметр ДополнительныеИсточникиДанных в структуре, возвращаемой функцией +// ДополнительныеПараметрыВыборкиДанныхДляОбработки(). +// +// Используется, когда источники данных нужно установить в разрезе документов и регистров. +// Применяется при многопоточном обновлении. +// +// Параметры: +// ДополнительныеИсточникиДанных - см. ДополнительныеПараметрыВыборкиДанныхДляОбработки +// Источник - см. ДополнительныеПараметрыВыборкиДанныхДляОбработки +// Объект - Строка - имя документа (полное или короткое). +// Регистр - Строка - имя регистра (полное или короткое). +// +Процедура УстановитьИсточникДанных(ДополнительныеИсточникиДанных, Источник, Объект = "", Регистр = "") Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.УстановитьИсточникДанных(ДополнительныеИсточникиДанных, Источник, Объект, Регистр); +``` +
+ +## ИсточникиДанных +
+ +Описание, пример вызова + +```bsl + +// Получить значение параметра ДополнительныеИсточникиДанных из структуры, возвращаемой +// функцией ДополнительныеПараметрыВыборкиДанныхДляОбработки(). +// +// Можно использовать, когда источники данных нужно получить в разрезе документов и регистров. +// Применяется при многопоточном обновлении. +// +// Параметры: +// ДополнительныеИсточникиДанных - см. ДополнительныеПараметрыВыборкиДанныхДляОбработки +// Объект - Строка - имя документа (полное или короткое). +// Регистр - Строка - имя регистра (полное или короткое). +// +// Возвращаемое значение: +// Соответствие - источники данных для указанного документа и регистра. +// +Функция ИсточникиДанных(ДополнительныеИсточникиДанных, Объект = "", Регистр = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ИсточникиДанных(ДополнительныеИсточникиДанных, Объект, Регистр); +``` +
+ +## СоздатьВременнуюТаблицуРегистраторовРегистраДляОбработки +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу ссылок, которые не обработаны в текущей очереди +// и не заблокированы меньшими очередями. +// Имя таблицы: ВТДляОбработки<ИмяРегистра>, например ВТДляОбработкиТоварыНаСкладах. +// Колонки таблицы: +// Регистратор - ДокументСсылка. +// +// Параметры: +// Очередь - Число - очередь обработки, в которой выполняется текущий обработчик. +// ПолноеИмяДокумента - Строка - имя документа, движения по которому нужно переформировать. +// Если движения формируются не по данным документа, то нужно передать Неопределено - +// тогда не будет проверяться блокировка таблицы документа. +// Например, "Документ.ПриходныйОрдерНаТовары". +// ПолноеИмяРегистра - Строка - имя регистра, движения по которому нужно переформировать. +// Например, "РегистрНакопления.ТоварыНаСкладах". +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - менеджер, в котором будет создана временная таблица. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляОбработки. +// +// Возвращаемое значение: +// Структура - результат формирования временной таблицы: +// * ЕстьЗаписиВоВременнойТаблице - Булево - в создаваемой таблице есть хотя бы одна запись. +// Записей может не быть по двум причинам: +// все обработано или все, что нужно обработать, еще заблокировано +// обработчиками с меньшей очередью. +// * ЕстьДанныеДляОбработки - Булево - в очереди есть ссылки для обработки, т.е. еще не все обработано. +// * ИмяВременнойТаблицы - Строка - имя созданной временной таблицы. +// +Функция СоздатьВременнуюТаблицуРегистраторовРегистраДляОбработки(Очередь, ПолноеИмяДокумента, ПолноеИмяРегистра, МенеджерВременныхТаблиц, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.СоздатьВременнуюТаблицуРегистраторовРегистраДляОбработки(Очередь, ПолноеИмяДокумента, ПолноеИмяРегистра, МенеджерВременныхТаблиц, ДополнительныеПараметры); +``` +
+ +## ВыбратьРегистраторыРегистраДляОбработки +
+ +Описание, пример вызова + +```bsl + +// Возвращает порцию регистраторов, по которым нужно переформировать движения. +// Данные берутся из зарегистрированных в очереди, учитываются заблокированные более приоритетными очередями данные. +// Блокировка по другим очередям делается по документу и по регистру. +// Регистраторы в выборке упорядочены по дате регистратора по убыванию, если передано полное имя документа. +// Если полное имя документа не передано - упорядочивание происходит по периоду регистра: +// - берется максимальная дата по каждому регистратору; +// - если по регистратору нет записей - он в топе. +// Параметры: +// Очередь - Число - очередь, к которой отнесен обработчик и в которой зарегистрированы данные, которые он будет обрабатывать. +// ПолноеИмяДокумента - Строка - имя документа, движения по которому нужно переформировать. Если движения формируются не по данным +// документа, то нужно передать Неопределено - тогда не будет проверяться блокировка таблицы документа. +// Например, Документ.ПриходныйОрдерНаТовары. +// ПолноеИмяРегистра - Строка - имя регистра, движения по которому нужно переформировать. +// Например, РегистрНакопления.ТоварыНаСкладах. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляОбработки. +// +// Возвращаемое значение: +// ВыборкаИзРезультатаЗапроса - выборка регистраторов, которые нужно обработать, поля выборки: +// * Регистратор - ДокументСсылка. +// * Период - Дата - дата документа, если передано полное имя документа, максимальный период по регистратору, +// если полное имя документа не передано. +// * Проведен - Булево +// - Неопределено - значение реквизита Проведен документа, если передано полное имя документа, +// или Неопределено, если имя документа не передано. +// ТаблицаЗначений - данные, которые нужно обработать, имена колонок соответствуют именам измерений регистра. +// +Функция ВыбратьРегистраторыРегистраДляОбработки(Очередь, ПолноеИмяДокумента, ПолноеИмяРегистра, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ВыбратьРегистраторыРегистраДляОбработки(Очередь, ПолноеИмяДокумента, ПолноеИмяРегистра, ДополнительныеПараметры); +``` +
+ +## ВыбратьСсылкиДляОбработки +
+ +Описание, пример вызова + +```bsl + +// Возвращает порцию ссылок, по которым нужно произвести обработку. +// Данные берутся из зарегистрированных в очереди, учитываются заблокированные более приоритетными очередями данные. +// Ссылки на документы возвращаются упорядоченными по убыванию по дате. +// +// Параметры: +// Очередь - Число - очередь, к которой отнесен обработчик и в которой зарегистрированы данные, которые он будет +// обрабатывать. +// ПолноеИмяОбъекта - Строка - имя объекта, который нужно обработать. Например, Документ.ПриходныйОрдерНаТовары. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляОбработки. +// +// Возвращаемое значение: +// ВыборкаИзРезультатаЗапроса - выборка ссылок, которые нужно обработать, поля выборки: +// * Ссылка - ЛюбаяСсылка. +// ТаблицаЗначений - данные, которые нужно обработать, имена колонок соответствуют именам измерений регистра. +// +Функция ВыбратьСсылкиДляОбработки(Очередь, ПолноеИмяОбъекта, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ВыбратьСсылкиДляОбработки(Очередь, ПолноеИмяОбъекта, ДополнительныеПараметры); +``` +
+ +## СоздатьВременнуюТаблицуСсылокДляОбработки +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу ссылок, которые не обработаны в текущей очереди +// и не заблокированы меньшими очередями. +// Имя таблицы: ВТДляОбработки<ИмяОбъекта>, например ВТДляОбработкиНоменклатура. +// Колонки таблицы: +// Ссылка - ЛюбаяСсылка. +// +// Параметры: +// Очередь - Число - очередь обработки, в которой выполняется текущий обработчик. +// ПолноеИмяОбъекта - Строка - полное имя объекта, для которого выполняется проверка, например Справочник.Номенклатура. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - менеджер, в котором будет создана временная таблица. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляОбработки. +// +// Возвращаемое значение: +// Структура - результат формирования временной таблицы: +// * ЕстьЗаписиВоВременнойТаблице - Булево - в создаваемой таблице есть хотя бы одна запись. Записей может не быть по +// двум причинам: +// все обработано или все, что нужно обработать, еще заблокировано +// обработчиками с меньшей очередью. +// * ЕстьДанныеДляОбработки - Булево - в очереди есть ссылки для обработки, т.е. еще не все обработано. +// * ИмяВременнойТаблицы - Строка - имя созданной временной таблицы. +// +Функция СоздатьВременнуюТаблицуСсылокДляОбработки(Очередь, ПолноеИмяОбъекта, МенеджерВременныхТаблиц, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.СоздатьВременнуюТаблицуСсылокДляОбработки(Очередь, ПолноеИмяОбъекта, МенеджерВременныхТаблиц, ДополнительныеПараметры); +``` +
+ +## ВыбратьИзмеренияНезависимогоРегистраСведенийДляОбработки +
+ +Описание, пример вызова + +```bsl + +// Возвращает значения измерений независимого регистра сведений для обработки. +// Данные берутся из зарегистрированных в очереди, учитываются заблокированные более приоритетными очередями данные. +// +// Параметры: +// Очередь - Число - очередь, к которой отнесен обработчик и в которой зарегистрированы данные, которые он будет +// обрабатывать. +// ПолноеИмяОбъекта - Строка - имя объекта, который нужно обработать. Например, РегистрСведений.ШтрихкодыНоменклатуры. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляОбработки. +// +// Возвращаемое значение: +// ВыборкаИзРезультатаЗапроса - выборка значений измерений, которые нужно обработать, имена полей соответствует именам +// измерений регистра. Если по измерению не регистрировалась необходимость обработки, +// то в выборке по этому измерению будет пустое значение. +// ТаблицаЗначений - данные, которые нужно обработать, имена колонок соответствуют именам измерений регистра. +// +Функция ВыбратьИзмеренияНезависимогоРегистраСведенийДляОбработки(Очередь, ПолноеИмяОбъекта, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ВыбратьИзмеренияНезависимогоРегистраСведенийДляОбработки(Очередь, ПолноеИмяОбъекта, ДополнительныеПараметры); +``` +
+ +## СоздатьВременнуюТаблицуИзмеренийНезависимогоРегистраСведенийДляОбработки +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу значения измерений независимого регистра сведений для обработки. +// Имя таблицы: ВТДляОбработки<ИмяОбъекта>, например ВТДляОбработкиШтрихкодыНоменклатуры. +// Колонки таблицы соответствуют измерениям регистра. Если по измерению не регистрировалась +// необходимость обработки, то в выборке по этому измерению будет пустое значение. +// +// Параметры: +// Очередь - Число - очередь обработки, в которой выполняется текущий обработчик. +// ПолноеИмяОбъекта - Строка - полное имя объекта, для которого выполняется проверка, +// например Справочник.Номенклатура. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - менеджер, в котором будет создана временная таблица. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляОбработки. +// +// Возвращаемое значение: +// Структура - результат формирования временной таблицы: +// * ЕстьЗаписиВоВременнойТаблице - Булево - в создаваемой таблице есть хотя бы одна запись. Записей может не быть по +// двум причинам: +// все обработано или все, что нужно обработать, еще заблокировано +// обработчиками с меньшей очередью. +// * ЕстьДанныеДляОбработки - Булево - в очереди есть данные для обработки, т.е. еще не все обработано. +// * ИмяВременнойТаблицы - Строка - имя созданной временной таблицы. +// +Функция СоздатьВременнуюТаблицуИзмеренийНезависимогоРегистраСведенийДляОбработки(Очередь, ПолноеИмяОбъекта, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.СоздатьВременнуюТаблицуИзмеренийНезависимогоРегистраСведенийДляОбработки(Очередь, ПолноеИмяОбъекта, ); +``` +
+ +## ЕстьДанныеДляОбработки +
+ +Описание, пример вызова + +```bsl + +// Проверяет, есть ли еще необработанные данные. +// +// Параметры: +// Очередь - Число - очередь, к которой отнесен обработчик и в которой зарегистрированы данные, +// которые он будет обрабатывать. +// - Неопределено - проверить, завершена ли обработка в целом. +// - Массив из Число - проверить, есть данные для обработки в списке очередей. +// ПолноеИмяМетаданныеОбъекта - Строка +// - ОбъектМетаданных - полное имя обрабатываемого объекта или его метаданные. +// Например, "Документ.ПриходныйОрдерНаТовары" +// - Массив из Строка +// - Массив из ОбъектМетаданных - полные имена объектов или объекты метаданных. +// В массиве не должно быть независимых регистров сведений. +// Отбор - ЛюбаяСсылка +// - Структура +// - Неопределено +// - Массив - отбор данных для проверки. +// Если передано Неопределено - проверяется по всему типу объекта. +// Если объект - регистр, подчиненный регистратору, то в отборе - ссылка +// на регистратор или массив ссылок. +// Если объект ссылочного типа, то в отборе - или ссылка, или массив ссылок. +// Если объект - независимый регистр сведений, то в отборе - структура со значениями измерений. +// Ключ структуры - имя измерения, значение - значение отбора (можно передать массив значений). +// +// Возвращаемое значение: +// Булево - Истина, если еще не все данные обработаны. +// +Функция ЕстьДанныеДляОбработки(Очередь, ПолноеИмяМетаданныеОбъекта, Отбор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ЕстьДанныеДляОбработки(Очередь, ПолноеИмяМетаданныеОбъекта, Отбор); +``` +
+ +## ОбработкаДанныхЗавершена +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что все данные обработаны. +// +// Параметры: +// Очередь - Число - очередь, к которой отнесен обработчик и в которой зарегистрированы данные, +// которые он будет обрабатывать. +// - Неопределено - проверяется, завершена ли обработка в целом. +// - Массив из Число - проверяется, есть ли данные для обработки в списке очередей. +// ПолноеИмяМетаданныеОбъекта - Строка +// - ОбъектМетаданных - для обработчиков, которые изменяют данные нескольких объектов метаданных, +// полное имя или метаданные обрабатываемого объекта. +// Например, "Документ.ПриходныйОрдерНаТовары". +// Если не указано, то используется значение свойства обработчика +// ИзменяемыеОбъекты. +// - Массив из Строка +// - Массив из ОбъектМетаданных - полные имена объектов или объекты метаданных. +// В массиве не должно быть независимых регистров сведений. +// Отбор - ЛюбаяСсылка +// - Структура +// - Неопределено +// - Массив - отбор данных для проверки. +// Если передано Неопределено - проверяется по всему типу объекта. +// Если объект - регистр, подчиненный регистратору, то в отборе - ссылка +// на регистратор или массив ссылок. +// Если объект ссылочного типа, то в отборе - или ссылка, или массив ссылок. +// Если объект - независимый регистр сведений, то в отборе - структура со значениями измерений. +// Ключ структуры - имя измерения, значение - значение отбора (можно передать массив значений). +// +// Возвращаемое значение: +// Булево - Истина, если все данные обработаны. +// +Функция ОбработкаДанныхЗавершена(Очередь, ПолноеИмяМетаданныеОбъекта = "", Отбор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ОбработкаДанныхЗавершена(Очередь, ПолноеИмяМетаданныеОбъекта, Отбор); +``` +
+ +## ЕстьЗаблокированныеПредыдущимиОчередямиДанные +
+ +Описание, пример вызова + +```bsl + +// Проверяет, есть ли заблокированные меньшими очередями обработки данные. +// +// Параметры: +// Очередь - Число +// - Неопределено - очередь, к которой отнесен обработчик и в которой +// зарегистрированы данные, которые он будет обрабатывать. +// ПолноеИмяМетаданныеОбъекта - Строка +// - ОбъектМетаданных - полное имя обрабатываемого объекта или его метаданные. +// Например, "Документ.ПриходныйОрдерНаТовары" +// - Массив из Строка +// - Массив из ОбъектМетаданных - полные имена или объекты метаданных. +// В массиве не должно быть независимых регистров сведений. +// +// Возвращаемое значение: +// Булево - Истина, если данный объект заблокирован для обработки меньшими очередями. +// +Функция ЕстьЗаблокированныеПредыдущимиОчередямиДанные(Очередь, ПолноеИмяМетаданныеОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ЕстьЗаблокированныеПредыдущимиОчередямиДанные(Очередь, ПолноеИмяМетаданныеОбъекта) +``` +
+ +## МожноЧитатьИМенять +
+ +Описание, пример вызова + +```bsl + +// Проверяет, завершилась ли обработка данных обработчиками, отнесенными на более раннюю очередь. +// +// Параметры: +// Очередь - Число - очередь, к которой отнесен обработчик и в которой зарегистрированы данные, +// которые он будет обрабатывать. +// - Неопределено - проверяется, завершена ли обработка в целом; +// - Массив - проверяется, есть ли данные для обработки в списке очередей. +// Данные - ЛюбаяСсылка +// - РегистрСведенийНаборЗаписей, РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей, РегистрРасчетаНаборЗаписей +// - СправочникОбъект, ДокументОбъект, ПланВидовХарактеристикОбъект, БизнесПроцессОбъект, ЗадачаОбъект +// - ДанныеФормыСтруктура - ссылка на объект, сам объект +// или набор записей, который необходимо проверить. +// Если ДополнительныеПараметры.ЭтоДвижения = Истина, то Данные - это регистратор +// указанного в ДополнительныеПараметры регистра. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыОтметкиОбработки. +// МетаданныеИОтбор - см. ОбновлениеИнформационнойБазы.МетаданныеИОтборПоДанным. +// +// Возвращаемое значение: +// Булево - Истина, если переданный объект обновлен на новую версию и его можно изменять. +// +Функция МожноЧитатьИМенять(Очередь, Данные, ДополнительныеПараметры = Неопределено, МетаданныеИОтбор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.МожноЧитатьИМенять(Очередь, Данные, ДополнительныеПараметры, МетаданныеИОтбор); +``` +
+ +## СоздатьВременнуюТаблицуЗаблокированныхДляЧтенияИИзмененияДанных +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу заблокированных данных. +// Имя таблицы: ВТЗаблокированы<ИмяОбъекта>, например ВТЗаблокированоНоменклатура. +// Колонки таблицы: +// для объектов ссылочного типа +// * Ссылка; +// для регистров, подчиненных регистратору +// * Регистратор; +// для регистров с непосредственной записью +// * колонки, соответствующие измерениям регистра. +// +// Параметры: +// Очередь - Число +// - Неопределено - очередь обработки, в которой выполняется текущий обработчик. +// Если передано Неопределено, то проверяется во всех очередях. +// ПолноеИмяОбъекта - Строка - полное имя объекта, для которого выполняется проверка, +// например Справочник.Номенклатура. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - менеджер, в котором будет создана временная таблица. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляОбработки +// +// Возвращаемое значение: +// Структура: +// * ЕстьЗаписиВоВременнойТаблице - Булево - в создаваемой таблице есть хотя бы одна запись. +// * ИмяВременнойТаблицы - Строка - имя созданной временной таблицы. +// +Функция СоздатьВременнуюТаблицуЗаблокированныхДляЧтенияИИзмененияДанных(Очередь, ПолноеИмяОбъекта, МенеджерВременныхТаблиц, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.СоздатьВременнуюТаблицуЗаблокированныхДляЧтенияИИзмененияДанных(Очередь, ПолноеИмяОбъекта, МенеджерВременныхТаблиц, ДополнительныеПараметры); +``` +
+ +## СоздатьВременнуюТаблицуЗаблокированныхДляЧтенияИИзмененияСсылок +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу заблокированных ссылок. +// Имя таблицы: ВТЗаблокировано. +// Колонки таблицы: +// * Ссылка. +// +// Параметры: +// Очередь - Число +// - Неопределено - очередь обработки, в которой выполняется +// текущий обработчик. Если передано Неопределено, то проверяется во всех очередях. +// ПолныеИменаОбъектов - Строка +// - Массив - полные имена объектов, для которых выполняется проверка, +// например Справочник.Номенклатура. +// Могут быть переданы объекты ссылочного типа, или регистры, подчиненные регистратору. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - менеджер, в котором будет создана временная таблица. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляОбработки +// +// Возвращаемое значение: +// Структура: +// * ЕстьЗаписиВоВременнойТаблице - Булево - в создаваемой таблице есть хотя бы одна запись. +// * ИмяВременнойТаблицы - Строка - имя созданной временной таблицы. +// +Функция СоздатьВременнуюТаблицуЗаблокированныхДляЧтенияИИзмененияСсылок(Очередь, ПолныеИменаОбъектов, МенеджерВременныхТаблиц, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.СоздатьВременнуюТаблицуЗаблокированныхДляЧтенияИИзмененияСсылок(Очередь, ПолныеИменаОбъектов, МенеджерВременныхТаблиц, ДополнительныеПараметры); +``` +
+ +## СоздатьВременнуюТаблицуЗначенийЗаблокированныхИзмерений +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу измерений регистров, подчиненных регистраторам, по которым еще есть не обработанные регистраторы. +// Алгоритм вычисления: +// - берутся заблокированные регистраторы; +// - по ним соединяется с основной таблицей регистра; +// - из основной таблицы получаются значения изменений; +// - делается группировка. +// Имя таблицы: ВТЗаблокированы<ИмяОбъекта>, например ВТЗаблокированоТоварыНаСкладах. +// Колонки таблицы соответствуют переданным измерениям. +// +// Параметры: +// Очередь - Число +// - Неопределено - очередь обработки, в которой выполняется +// текущий обработчик. Если передано Неопределено, +// то проверяется во всех очередях. +// ПолноеИмяРегистра - Строка - имя регистра, движения по которому нужно переформировать. +// Например, РегистрНакопления.ТоварыНаСкладах +// Измерения - Строка +// - Массив - имена измерений, по которым нужно проверить блокировку, +// перечисленные через запятую, или массив имен. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - менеджер, в котором будет создана временная таблица. +// ДополнительныеПараметры - см. ОбновлениеИнформационнойБазы.ДополнительныеПараметрыВыборкиДанныхДляОбработки +// +// Возвращаемое значение: +// Структура: +// * ЕстьЗаписиВоВременнойТаблице - Булево - в создаваемой таблице есть хотя бы одна запись. +// * ИмяВременнойТаблицы - Строка - имя созданной временной таблицы. +// +Функция СоздатьВременнуюТаблицуЗначенийЗаблокированныхИзмерений(Очередь, ПолноеИмяРегистра, Измерения, МенеджерВременныхТаблиц, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.СоздатьВременнуюТаблицуЗначенийЗаблокированныхИзмерений(Очередь, ПолноеИмяРегистра, Измерения, МенеджерВременныхТаблиц, ДополнительныеПараметры); +``` +
+ +## ДанныеОбновленыНаНовуюВерсиюПрограммы +
+ +Описание, пример вызова + +```bsl + +// Функция для проверки объектов при открытии форм и перед записью. +// Может использоваться как функция проверки по умолчанию, если +// достаточно логики - заблокированные объекты зарегистрированы на узлах плана обмена ОбновлениеИнформационнойБазы. +// +// Параметры: +// МетаданныеИОтбор - см. ОбновлениеИнформационнойБазы.МетаданныеИОтборПоДанным. +// +// Возвращаемое значение: +// Булево - Истина, если объект обновлен и доступен для изменения. +// +Функция ДанныеОбновленыНаНовуюВерсиюПрограммы(МетаданныеИОтбор) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ДанныеОбновленыНаНовуюВерсиюПрограммы(МетаданныеИОтбор) +``` +
+ +## СпособВыборкиИзмеренияНезависимогоРегистраСведений +
+ +Описание, пример вызова + +```bsl + +// Выборка данных через ВыбратьИзмеренияНезависимогоРегистраСведенийДляОбработки(). +// +// Возвращаемое значение: +// Строка - константа "ИзмеренияНезависимогоРегистраСведений". +// +Функция СпособВыборкиИзмеренияНезависимогоРегистраСведений() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.СпособВыборкиИзмеренияНезависимогоРегистраСведений() +``` +
+ +## СпособВыборкиРегистраторыРегистра +
+ +Описание, пример вызова + +```bsl + +// Выборка данных через ВыбратьРегистраторыРегистраДляОбработки(). +// +// Возвращаемое значение: +// Строка - константа "РегистраторыРегистра". +// +Функция СпособВыборкиРегистраторыРегистра() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.СпособВыборкиРегистраторыРегистра() +``` +
+ +## СпособВыборкиСсылки +
+ +Описание, пример вызова + +```bsl + +// Выборка данных через ВыбратьСсылкиДляОбработки(). +// +// Возвращаемое значение: +// Строка - константа "Ссылки". +// +Функция СпособВыборкиСсылки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.СпособВыборкиСсылки() +``` +
+ +## НеобходимоОбновлениеИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Проверить необходимость обновления информационной базы при смене версии конфигурации. +// +// Возвращаемое значение: +// Булево - Истина, если требуется обновление. +// +Функция НеобходимоОбновлениеИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.НеобходимоОбновлениеИнформационнойБазы() +``` +
+ +## ВыполняетсяОбновлениеИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если в данный момент выполняется обновление ИБ. +// +// Возвращаемое значение: +// Булево - Истина, если обновление выполняется. +// +Функция ВыполняетсяОбновлениеИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ВыполняетсяОбновлениеИнформационнойБазы() +``` +
+ +## ОтложенноеОбновлениеЗавершено +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак завершения отложенного обновления. +// +// Параметры: +// ИменаПодсистем - Строка - если передано, будет проверяться результат завершения +// обновления для переданной подсистемы, а не для всей конфигурации. +// - Массив - если требуется проверить завершение обновления сразу нескольких +// подсистем. +// +// Возвращаемое значение: +// Булево - Истина, если обновление завершено. +// +Функция ОтложенноеОбновлениеЗавершено(Знач ИменаПодсистем = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ОтложенноеОбновлениеЗавершено(ИменаПодсистем); +``` +
+ +## ЭтоВызовИзОбработчикаОбновления +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если вызов функции выполняется из обработчика обновления. +// Для любого вида обработчика обновления - монопольного, оперативного и отложенного. +// +// Параметры: +// РежимВыполненияОбработчика - Строка - Отложенно, Оперативно, Монопольно или комбинация данных +// вариантов через запятую. Если указано, то проверяется только +// вызов из обработчиков обновления с данным режимом выполнения. +// +// Возвращаемое значение: +// Булево - Истина, если вызов функции выполняется из обработчика обновления. +// +Функция ЭтоВызовИзОбработчикаОбновления(РежимВыполненияОбработчика = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ЭтоВызовИзОбработчикаОбновления(РежимВыполненияОбработчика); +``` +
+ +## НоваяТаблицаОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую таблицу обработчиков обновления и первоначального заполнения ИБ. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица с колонками: +// 1) Для всех типов обработчиков обновления: +// +// * НачальноеЗаполнение - Булево - если Истина, то обработчик должен срабатывать при запуске на "пустой" базе. +// * Версия - Строка - например, "2.1.3.39". Номер версии конфигурации, при переходе +// на которую должна быть выполнена процедура-обработчик обновления. +// Если указана пустая строка, то это обработчик только для начального заполнения +// (должно быть указано свойство НачальноеЗаполнение). +// * Процедура - Строка - полное имя процедуры-обработчика обновления/начального заполнения. +// Например, "ОбновлениеИнформационнойБазыУПП.ЗаполнитьНовыйРеквизит" +// Обязательно должна быть экспортной. +// * РежимВыполнения - Строка - режим выполнения обработчика обновления. Допустимые значения: +// Монопольно, Отложенно, Оперативно. Если значение не заполнено, обработчик +// считается монопольным. +// +// 2) Для обработчиков обновления в модели сервиса: +// +// * ОбщиеДанные - Булево - если Истина, то обработчик должен срабатывать до +// выполнения любых обработчиков, использующих разделенные данные. +// Допустимо указывать только для обработчиков с режимом выполнения Монопольно и Оперативно. +// Если указать значение Истина для обработчика с режимом +// выполнения Отложенно, будет выдано исключение. +// * УправлениеОбработчиками - Булево - если Истина, то обработчик должен иметь параметр типа Структура, в котором +// есть свойство РазделенныеОбработчики - таблица значений со структурой, +// возвращаемой этой функцией. +// При этом колонка Версия игнорируется. В случае необходимости выполнения +// разделенного обработчика в данную таблицу необходимо добавить строку с +// описанием процедуры обработчика. +// Имеет смысл только для обязательных (Версия = *) обработчиков обновления +// с установленным флагом ОбщиеДанные. +// +// 3) Для отложенных обработчиков обновления: +// +// * Комментарий - Строка - описание действий, выполняемых обработчиком обновления. +// * Идентификатор - УникальныйИдентификатор - необходимо заполнять для обработчиков отложенного обновления, +// для остальных заполнение не требуется. Требуется для идентификации +// обработчика в случае его переименования. +// +// * БлокируемыеОбъекты - Строка - необходимо заполнять для обработчиков отложенного обновления, +// для остальных заполнение не требуется. Полные имена объектов через запятую, +// которые следует блокировать от изменения до завершения процедуры обработки данных. +// Если заполнено, то также требуется заполнить и свойство ПроцедураПроверки. +// * НовыеОбъекты - Строка - необходимо заполнять для обработчиков отложенного обновления, +// для остальных заполнение не требуется. Полные имена объектов через запятую, +// которые создаются при работе обработчика обновления. +// * ПроцедураПроверки - Строка - необходимо заполнять для обработчиков отложенного обновления, +// для остальных заполнение не требуется. Имя функции, которая для переданного объекта +// определяет, завершена ли для него процедура обработки данных. +// Если переданный объект обработан, то следует вернуть значение Истина. +// Вызывается из процедуры ОбновлениеИнформационнойБазы.ПроверитьОбъектОбработан. +// Параметры, передаваемые в функцию: +// Параметры - см. ОбновлениеИнформационнойБазы.МетаданныеИОтборПоДанным. +// +// 4) Для обработчиков обновления в библиотеках (конфигурации) с параллельным режимом выполнения отложенных обработчиков: +// +// * ПроцедураЗаполненияДанныхОбновления - Строка - указывается процедура, которая регистрирует данные, +// подлежащие обновлению данным обработчиком. +// * ЗапускатьТолькоВГлавномУзле - Булево - только для обработчиков отложенного обновления с режимом выполнения Параллельно. +// Указать Истина, если обработчик обновления должен выполняться только в главном +// узле РИБ. +// * ЗапускатьИВПодчиненномУзлеРИБСФильтрами - Булево - только для обработчиков отложенного обновления с режимом +// выполнения Параллельно. +// Указать Истина, если обработчик обновления должен также выполняться в +// подчиненном узле РИБ с фильтрами. +// * ЧитаемыеОбъекты - Строка - объекты, которые обработчик обновления будет читать при обработке данных. +// * ИзменяемыеОбъекты - Строка - объекты, которые обработчик обновления будет изменять при обработке данных. +// * ПриоритетыВыполнения - ТаблицаЗначений - таблица приоритетов выполнения между отложенными обработчиками, +// изменяющими или читающими одни и те же данные. Подробнее см. в комментарии +// к функции ОбновлениеИнформационнойБазы.ПриоритетыВыполненияОбработчика. +// * Многопоточный - Булево - Истина, если обработчик адаптирован для обработки данных в несколько потоков. +// * Порядок - ПеречислениеСсылка.ПорядокОбработчиковОбновления +// +// 5) Для оперативных и монопольных обработчиков начального заполнения: +// * НеВыполнятьПриПереходеСДругойПрограммы - Булево - при переходе с другой программы обработчики начального +// заполнения новых подсистем выполняются автоматически. Если установить +// Истина, такой обработчик не будет выполнен. +// +// 6) Для внутреннего использования: +// +// * ВыполнятьВГруппеОбязательных - Булево - следует указывать, если обработчик требуется +// выполнять в одной группе с обработчиками на версии "*". +// При этом возможно менять порядок выполнения обработчика +// относительно других путем изменения приоритета. +// * Приоритет - Число - для внутреннего использования. +// +// 7) Устарели, используются для обратной совместимости (для новых обработчиков не указывать): +// +// * МонопольныйРежим - Неопределено +// - Булево - если указано Неопределено, то обработчик +// должен безусловно выполняться в монопольном режиме. +// Для обработчиков перехода на конкретную версию (версия <> *): +// Ложь - обработчик не требует монопольного режима для выполнения. +// Истина - обработчик требует монопольного режима для выполнения. +// Для обязательных обработчиков обновления (Версия = "*"): +// Ложь - обработчик не требует монопольного режима. +// Истина - обработчик может требовать монопольного режима для выполнения. +// В такие обработчики передается параметр типа структура +// со свойством МонопольныйРежим (типа Булево). +// При запуске обработчика в монопольном режиме передается +// значение Истина. В этом случае обработчик должен выполнить +// требуемые действия по обновлению. Изменение параметра +// в теле обработчика игнорируется. +// При запуске обработчика в немонопольном режиме передается +// значение Ложь. В этом случае обработчик не должен вносить никакие +// изменения в ИБ. +// Если в результате анализа выясняется, что обработчику требуется +// изменить данные ИБ, следует установить значение параметра в Истина +// и прекратить выполнение обработчика. +// В этом случае оперативное (немонопольное) обновление ИБ будет +// отменено и будет выдана ошибка с требованием выполнить обновление в +// монопольном режиме. +// +Функция НоваяТаблицаОбработчиковОбновления() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления() +``` +
+ +## ПриоритетыВыполненияОбработчика +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую таблицу приоритетов выполнения между отложенными обработчиками, +// изменяющими или читающими одни и те же данные. Для использования в описании обработчиков обновления. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Порядок - Строка - порядок выполнения обработчика относительно указанной процедуры. +// Допустимые варианты: "До", "После", "Любой". +// * Идентификатор - УникальныйИдентификатор - идентификатор процедуры, с которой настраивается взаимосвязь. +// * Процедура - Строка - полное имя процедуры, относительно которой выполняется обработчик. +// +// Пример: +// Приоритет = ПриоритетыВыполненияОбработчика().Добавить(); +// Приоритет.Порядок = "До"; // порядок выполнения обработчика относительно процедуры ниже. +// Приоритет.Процедура = "Документ.ЗаказПокупателя.ОбновитьДанныеДляПереходаНаНовуюВерсию"; +// +Функция ПриоритетыВыполненияОбработчика() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ПриоритетыВыполненияОбработчика() +``` +
+ +## ВыполнитьИтерациюОбновления +
+ +Описание, пример вызова + +```bsl + +// Выполнить обработчики обновления из списка ОбработчикиОбновления +// для библиотеки ИдентификаторБиблиотеки до версии ВерсияМетаданныхИБ. +// +// Параметры: +// ИдентификаторБиблиотеки - Строка - имя конфигурации или идентификатор библиотеки. +// ВерсияМетаданныхИБ - Строка - версия метаданных, до которой необходимо выполнить обновление. +// ОбработчикиОбновления - Соответствие - список обработчиков обновления. +// ХодВыполненияОбработчиков - Структура: +// * ВсегоОбработчиков - Строка - общее количество выполняемых обработчиков. +// * ВыполненоОбработчиков - Булево - количество выполненных обработчиков. +// ОперативноеОбновление - Булево - Истина, если обновление оперативное. +// +// Возвращаемое значение: +// ДеревоЗначений - выполненные обработчики обновления. +// +Функция ВыполнитьИтерациюОбновления(Знач ИдентификаторБиблиотеки, Знач ВерсияМетаданныхИБ, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ВыполнитьИтерациюОбновления(ИдентификаторБиблиотеки, ВерсияМетаданныхИБ, ); +``` +
+ +## ВыполнитьОбновлениеИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Выполнить неинтерактивное обновление данных ИБ. +// Для вызова через внешнее соединение. +// При вызове метода с подключенными расширениями, модифицирующими роли конфигурации, будет вызвано исключение. +// Важно: Перед вызовом метода необходимо запустить удаление устаревших патчей, +// см. функцию ОбновлениеКонфигурации.ИсправленияИзменены(). +// +// Для использования в других библиотеках и конфигурациях. +// +// Параметры: +// ВыполнятьОтложенныеОбработчики - Булево - если Истина, отложенное обновление будет выполнено +// в основном цикле обновления. Только для клиент-серверного режима работы. +// +// Возвращаемое значение: +// Строка - признак выполнения обработчиков обновления: +// "Успешно", "НеТребуется", "ОшибкаУстановкиМонопольногоРежима". +// +Функция ВыполнитьОбновлениеИнформационнойБазы(ВыполнятьОтложенныеОбработчики = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ВыполнитьОбновлениеИнформационнойБазы(ВыполнятьОтложенныеОбработчики); +``` +
+ +## ВерсииПодсистем +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу с версиями подсистем конфигурации. +// Для пакетной выгрузки/загрузки сведений о версиях подсистем. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ИмяПодсистемы - Строка - имя подсистемы. +// * Версия - Строка - версия подсистемы. +// +Функция ВерсииПодсистем() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ВерсииПодсистем() +``` +
+ +## УстановитьВерсииПодсистем +
+ +Описание, пример вызова + +```bsl + +// Устанавливает версии всех подсистем. +// Для пакетной выгрузки/загрузки сведений о версиях подсистем. +// +// Параметры: +// ВерсииПодсистем - ТаблицаЗначений: +// * ИмяПодсистемы - Строка - имя подсистемы. +// * Версия - Строка - версия подсистемы. +// +Процедура УстановитьВерсииПодсистем(ВерсииПодсистем) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.УстановитьВерсииПодсистем(ВерсииПодсистем) +``` +
+ +## ВерсияИБ +
+ +Описание, пример вызова + +```bsl + +// Получает версию конфигурации или родительской конфигурации (библиотеки), +// которая хранится в информационной базе. +// +// Параметры: +// ИдентификаторБиблиотеки - Строка - имя конфигурации или идентификатор библиотеки. +// +// Возвращаемое значение: +// Строка - версия. +// +// Пример: +// ВерсияКонфигурацииИБ = ОбновлениеИнформационнойБазы.ВерсияИБ(Метаданные.Имя); +// +Функция ВерсияИБ(Знач ИдентификаторБиблиотеки) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ВерсияИБ(ИдентификаторБиблиотеки) +``` +
+ +## УстановитьВерсиюИБ +
+ +Описание, пример вызова + +```bsl + +// Записывает в информационную базу версию конфигурации или родительской конфигурации (библиотеки). +// +// Параметры: +// ИдентификаторБиблиотеки - Строка - имя конфигурации или родительской конфигурации (библиотеки). +// НомерВерсии - Строка - номер версии. +// ЭтоОсновнаяКонфигурация - Булево - признак, что ИдентификаторБиблиотеки соответствует имени конфигурации. +// +Процедура УстановитьВерсиюИБ(Знач ИдентификаторБиблиотеки, Знач НомерВерсии, Знач ЭтоОсновнаяКонфигурация) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.УстановитьВерсиюИБ(ИдентификаторБиблиотеки, НомерВерсии, ЭтоОсновнаяКонфигурация) +``` +
+ +## ЗарегистрироватьНовуюПодсистему +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию новой подсистемы в регистре сведений ВерсииПодсистем. +// Необходима, например, в тех случаях, когда новая подсистема создается на +// основе уже существующих метаданных и не требуется выполнять обработчики начального заполнения. +// Если подсистема уже зарегистрирована, то повторная регистрация не выполняется. +// Вызывать данный метод следует из процедуры ПередОбновлениемИнформационнойБазы общего +// модуля ОбновлениеИнформационнойБазыПереопределяемый. +// +// Параметры: +// ИмяПодсистемы - Строка - имя подсистемы в том виде, в котором оно задано в общем модуле +// ОбновлениеИнформационнойБазыХХХ. +// Например - "СтандартныеПодсистемы". +// НомерВерсии - Строка - полный номер версии, на которую необходимо зарегистрировать подсистему. +// Если не указан, то регистрируется на версию "0.0.0.1". Следует указывать, +// если нужно, чтобы выполнились не все обработчики, а только последние. +// +Процедура ЗарегистрироватьНовуюПодсистему(ИмяПодсистемы, НомерВерсии = "") Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ЗарегистрироватьНовуюПодсистему(ИмяПодсистемы, НомерВерсии); +``` +
+ +## ОчередьОтложенногоОбработчикаОбновления +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер очереди отложенного обработчика обновления по его полному +// имени или уникальному идентификатору. +// +// Параметры: +// ИмяИлиИдентификатор - Строка +// - УникальныйИдентификатор - полное имя отложенного обработчика +// или его идентификатор. Подробнее см. НоваяТаблицаОбработчиковОбновления, +// описание свойств Процедура и Идентификатор. +// +// Возвращаемое значение: +// Число, Неопределено - номер очереди переданного обработчика, если +// обработчик не найден - будет возвращено Неопределено. +// +Функция ОчередьОтложенногоОбработчикаОбновления(ИмяИлиИдентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ОчередьОтложенногоОбработчикаОбновления(ИмяИлиИдентификатор) +``` +
+ +## МаксимальноеКоличествоЗаписейВВыборке +
+ +Описание, пример вызова + +```bsl + +// Максимальное количество записей в выборке данных для обновления. +// +// Возвращаемое значение: +// Число - константа 1000. +// +Функция МаксимальноеКоличествоЗаписейВВыборке() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.МаксимальноеКоличествоЗаписейВВыборке() +``` +
+ +## ДанныеДляОбновленияВМногопоточномОбработчике +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу с данными, которые нужно обновить. +// Используется в многопоточных обработчиках обновления. +// +// Параметры: +// Параметры - Структура - тот параметр, который передается в обработчик обновления. +// +// Возвращаемое значение: +// ТаблицаЗначений - для ссылочного объекта с колонками: +// * Ссылка - ЛюбаяСсылка - ссылка на обновляемый объект. +// * Дата - Дата - колонка присутствует только для документов. +// +// ТаблицаЗначений - для регистра состав колонок зависит от состава измерений +// обновляемого объекта. +// +Функция ДанныеДляОбновленияВМногопоточномОбработчике(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ДанныеДляОбновленияВМногопоточномОбработчике(Параметры) +``` +
+ +## ПриоритетОтложеннойОбработки +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущее значение приоритета отложенной обработки данных. +// +// Возвращаемое значение: +// Строка - возможные значения - "ОбработкаДанных" и "РаботаПользователей". +// +Функция ПриоритетОтложеннойОбработки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ПриоритетОтложеннойОбработки() +``` +
+ +## УстановитьПриоритетОтложеннойОбработки +
+ +Описание, пример вызова + +```bsl + +// Позволяет изменить приоритет отложенной обработки данных. +// +// Параметры: +// Приоритет - Строка - значение приоритета. Допустимые значения - "ОбработкаДанных" или "РаботаПользователей". +// +Процедура УстановитьПриоритетОтложеннойОбработки(Приоритет) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.УстановитьПриоритетОтложеннойОбработки(Приоритет) +``` +
+ +## КоличествоПотоковОбновления +
+ +Описание, пример вызова + +```bsl + +// Возвращает количество потоков обновления информационной базы. +// +// Если количество указано в параметре запуска "ЧислоПотоковОбновления", то возвращается оно. +// Иначе, если значение константы КоличествоПотоковОбновленияИнформационнойБазы установлено, то возвращается оно. +// Иначе возвращается значение по умолчанию, см. КоличествоПотоковОбновленияИнформационнойБазыПоУмолчанию. +// +// Возвращаемое значение: +// Число - количество потоков. +// +Функция КоличествоПотоковОбновления() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.КоличествоПотоковОбновления() +``` +
+ +## УстановитьКоличествоПотоковОбновления +
+ +Описание, пример вызова + +```bsl + +// Позволяет установить количество потоков отложенной обработки данных. +// +// Параметры: +// Количество - Число - число потоков. +// +Процедура УстановитьКоличествоПотоковОбновления(Количество) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.УстановитьКоличествоПотоковОбновления(Количество) +``` +
+ +## РазрешеноМногопоточноеОбновление +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак разрешения использования многопоточного обновления. +// Многопоточное обновление можно включить в ОбновлениеИнформационнойБазыПереопределяемый.ПриОпределенииНастроек(). +// +// Возвращаемое значение: +// Булево - если Истина, многопоточное обновление разрешено. По умолчанию - Ложь (для обратной совместимости). +// +Функция РазрешеноМногопоточноеОбновление() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.РазрешеноМногопоточноеОбновление() +``` +
+ +## ПрогрессОбновленияОбластейДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает прогресс обновления областей данных. +// +// Параметры: +// РежимОбновления - Строка - определяет, по какому этапу обновления необходимо получить данные. +// Доступные значения: "Оперативное", "Отложенное". +// +// Возвращаемое значение: +// Структура: +// * Обновлено - Число - количество областей, этап обновления которых завершен. +// * Выполняется - Число - количество областей, по которым обновление выполняется. +// * Ожидают - Число - количество областей, ожидающих начало этапа обновления. +// * Проблемы - Число - количество областей, в процессе обновления которых произошли ошибки. +// * ОбластиСПроблемами - Массив из Число - номера областей, в процессе обновления которых произошли ошибки. +// * ОбластиВыполняется - Массив из Число - номера областей, по которым обновление выполняется. +// * ОбластиОжидает - Массив из Число - номера областей, ожидающих начало этапа обновления. +// * ОбластиОбновлено - Массив из Число - номера областей, этап обновления которых завершен. +// +Функция ПрогрессОбновленияОбластейДанных(РежимОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ПрогрессОбновленияОбластейДанных(РежимОбновления) +``` +
+ +## ОбработчикиОбновления +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу обработчиков обновления по указанному отбору. +// В режиме сервиса, если не задан отбор по областям данных, +// возвращаются все обработчики - разделенные и неразделенные. +// +// Параметры: +// Отбор - Структура: +// * РежимыВыполнения - Массив из Строка - доступные значения соответствуют именам значений +// перечисления РежимыВыполненияОбработчиков. +// * Статусы - Массив из Строка - доступные значения соответствуют именам значений +// перечисления СтатусыОбработчиковОбновления. +// * ОбластиДанных - Массив из Число - номера областей, по которым нужно получить обработчики. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ИмяОбработчика - Строка +// * РежимВыполнения - Строка - имя соответствующего значения перечисления РежимыВыполненияОбработчиков +// * ИмяБиблиотеки - Строка +// * Версия - Строка +// * Статус - Строка - имя соответствующего значения перечисления СтатусыОбработчиковОбновления +// * ДлительностьОбработки - Число +// * ИнформацияОбОшибке - Строка +// * ОбластьДанных - Число +// +Функция ОбработчикиОбновления(Отбор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ОбработчикиОбновления(Отбор); +``` +
+ +## ОбновляемыеОбъекты +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу обновляемых объектов конфигурации со списком обработчиков, +// которые их обрабатывают на текущую версию. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - полное имя объекта. +// * Значение - Массив из Строка - имена выполняемых обработчиков обновления. +// +Функция ОбновляемыеОбъекты() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ОбновляемыеОбъекты() +``` +
+ +## ДобавитьОбъектПланируемыйКУдалению +
+ +Описание, пример вызова + +```bsl + +// Добавляет очередной устаревший объект в список объектов, которые +// планируются к удалению в будущих версиях программы. +// +// Параметры: +// Объекты - Соответствие из КлючИЗначение: +// * Ключ - Строка - смотри ниже параметр Объект. +// * Значение - Булево, Соответствие - смотри ниже параметр Уточнение. +// +// Объект - Строка - полное имя объекта метаданных с данными, который следует очистить. +// Либо объект метаданных с основной таблицей, например, "Справочник.УдалитьОчередьЗаданий". +// Либо значение перечисления, например, "Перечисление.ХозяйственныеОперации.УдалитьСписаниеТоваровПереданныхПартнерам". +// Либо точка маршрута, например, "БизнесПроцесс.Задание.ТочкаМаршрута.УдалитьВернутьИсполнителю". +// Либо все точки маршрута, например, "БизнесПроцесс.Задание.Точки". +// Либо поле регистра, входящее в уникальный индекс, +// например, измерение "РегистрСведений.ОтветственныеЛица.Склад". +// +// Уточнение - Булево - когда в параметре Объект указан удаляемый в будущем объект. +// Имя объекта должно начинаться с Удалить. +// По умолчанию Ложь, если указано Истина, то данные объекта будут удалены. +// - ОписаниеТипов, Тип, ПеречислениеСсылка, ТочкаМаршрутаБизнесПроцессаСсылка - когда +// в параметре Объект указано поле тип которого сокращается +// на список указанных ссылочных типов или один тип +// или значение перечисления или значение точки маршрута бизнес-процесса. +// +Процедура ДобавитьОбъектПланируемыйКУдалению(Объекты, Объект, Уточнение = Ложь) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ДобавитьОбъектПланируемыйКУдалению(Объекты, Объект, Уточнение); +``` +
+ +## ЗарегистрироватьПредопределенныеЭлементыДляОбновления +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Прочие процедуры и функции. + +// Зарегистрировать предопределенные элементы для отложенного обработчика обновления, в котором +// заполняются или обновляются предопределенные элементы справочника или плана видов характеристик. +// Используется совместно с процедурами ЗаполнитьЭлементыНачальнымиДанными или ОбновитьПредопределенныеЭлементы. +// +// Параметры: +// Параметры - Структура - служебные параметры обработчика обновления. +// ОбъектМетаданных - ОбъектМетаданных +// - Неопределено - обновляемые объекты. +// ДополнительныеПараметры - Структура: +// * РежимОбновления - Строка - определяет вариант регистрация предопределенных элементов для обновления. Варианты: +// "Все" - нужно зарегистрировать все предопределенные элементы; +// "НовыеИИзмененные" - обновить только новые и измененные; +// "МультиязычныеСтроки" - обновить, если были изменения в мультиязычных реквизитах. +// * ПропускатьПустые - Булево - если Истина, то пустые строки в поставляемых данных исключаются из проверки на изменение. +// Например, объект не будет зарегистрирован, когда в ИБ реквизит заполнен, а в коде пустая строка. +// * СравниватьТабличныеЧасти - Булево - если Ложь, то табличные части игнорируются и не будут сравниваться на различие. +// +Процедура ЗарегистрироватьПредопределенныеЭлементыДляОбновления(Параметры, ОбъектМетаданных = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ЗарегистрироватьПредопределенныеЭлементыДляОбновления(Параметры, ОбъектМетаданных, ); +``` +
+ +## ЗаполнитьЭлементыНачальнымиДанными +
+ +Описание, пример вызова + +```bsl + +// Заполняет предопределенные элементы объекта в соответствие с начальным заполнением в обработчике +// ПриНачальномЗаполненииЭлементов модуля менеджера объекта. +// Для вызова из отложенного обработчика обновления. +// +// Параметры: +// Параметры - Структура- служебные параметры обработчика обновления. +// ОбъектМетаданных - ОбъектМетаданных - заполняемый объект. +// НастройкиЗаполнения - см. НастройкиЗаполнения +// +Процедура ЗаполнитьЭлементыНачальнымиДанными(Параметры, ОбъектМетаданных, НастройкиЗаполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ЗаполнитьЭлементыНачальнымиДанными(Параметры, ОбъектМетаданных, НастройкиЗаполнения); +``` +
+ +## ЗаполнитьОбъектНачальнымиДанными +
+ +Описание, пример вызова + +```bsl + +// Заполнить объект в соответствие с начальным заполнением в обработчике ПриНачальномЗаполненииЭлементов модуля +// менеджера объекта. +// +// Параметры: +// ЗаполняемыйОбъект - СправочникОбъект +// - ПланВидовХарактеристикОбъект - заполняемый объект. +// НастройкиЗаполнения - см. НастройкиЗаполнения +// +Процедура ЗаполнитьОбъектНачальнымиДанными(ЗаполняемыйОбъект, НастройкиЗаполнения) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ЗаполнитьОбъектНачальнымиДанными(ЗаполняемыйОбъект, НастройкиЗаполнения) +``` +
+ +## ОбновитьПредопределенныеЭлементы +
+ +Описание, пример вызова + +```bsl + +// Обновляет предопределенные элементы данными в соответствие с начальным заполнением в обработчике +// ПриНачальномЗаполненииЭлементов модуля менеджера объекта ОбъектМетаданных. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - обновляемый справочник или план видов характеристик. +// ПараметрыОбновления - см. ПараметрыОбновленияПредопределенныхЭлементов +// - Неопределено - необходимо обновить все предопределенные элементы. +// +Процедура ОбновитьПредопределенныеЭлементы(ОбъектМетаданных, ПараметрыОбновления = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ОбновитьПредопределенныеЭлементы(ОбъектМетаданных, ПараметрыОбновления); +``` +
+ +## ПараметрыОбновленияПредопределенныхЭлементов +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров для процедуры ОбновитьПредопределенныеЭлементы +// +// Возвращаемое значение: +// Структура: +// * Реквизиты - Строка - список реквизитов через запятую. Если указано, то эти реквизиты будут принудительно обновлены. +// * Элементы - Массив - набор ссылок предопределенных элементов, которые следует обновить. +// Будет обновлены все элементы, если пустой. +// * ОбновитьТолькоМультиязычныеСтроки - Булево - если Истина, то будет обновлены только мультиязычные реквизиты. +// По умолчанию - Ложь. +// Свойство актуально, только для мультиязычных конфигураций. +// +Функция ПараметрыОбновленияПредопределенныхЭлементов() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.ПараметрыОбновленияПредопределенныхЭлементов() +``` +
+ +## НастройкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +// Настройки заполнения предопределенных и поставляемых элементов. +// +// Возвращаемое значение: +// Структура: +// * ОбновитьТолькоМультиязычныеСтроки - Булево - если Истина, то будет обновлены только мультиязычные строки. +// * Реквизиты - Строка - список реквизитов через запятую, которые будут обновлены. Например, "Наименование,Комментарий". +// +Функция НастройкиЗаполнения() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеИнформационнойБазы.НастройкиЗаполнения() +``` +
+ +## ЗаписатьОшибкуВЖурналРегистрации +
+ +Описание, пример вызова + +```bsl + +// Записывает в журнал регистрации событие при выполнении обработчика обновления. +// При записи ошибки или предупреждения сохраняет эту информацию в сведениях об обработчике +// обновления для дальнейшей индикации в интерфейсах механизма обновления. +// +// Параметры: +// СсылкаМетаданные - ЛюбаяСсылка, ОбъектМетаданных - для ссылочных объектов ссылка, для остальных метаданные +// Представление - Строка - строковое представление обрабатываемых данных. Для ссылок необходимо получать его до +// начала обработки, т.к. получение в блоке исключения может приводить к ошибке. +// ИнформацияОбОшибке - ИнформацияОбОшибке, Строка - можно передавать объект ИнформацияОбОшибке для записи +// стандартной ошибки в журнал регистрации. Для уточнения текста проблемы +// стоит передавать строковый комментарий. +// Уровень - УровеньЖурналаРегистрации - уровень важности события. Если не указано, то записывается событие с уровнем Предупреждение. +// +Процедура ЗаписатьОшибкуВЖурналРегистрации(СсылкаМетаданные, Знач Представление, ИнформацияОбОшибке = Неопределено, Уровень = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ЗаписатьОшибкуВЖурналРегистрации(СсылкаМетаданные, Представление, ИнформацияОбОшибке, Уровень); +``` +
+ +## ЗаписатьСобытиеВЖурналРегистрации +
+ +Описание, пример вызова + +```bsl + +// Записывает в журнал регистрации событие при выполнении обработчика обновления. +// При записи ошибки или предупреждения сохраняет эту информацию в сведениях об обработчике +// обновления для дальнейшей индикации в интерфейсах механизма обновления. +// +// Параметры: +// Комментарий - Строка - текст сообщения, записываемый в журнал регистрации. +// Уровень - УровеньЖурналаРегистрации - уровень важности события. +// Если не указано, то записывается событие с уровнем Ошибка. +// Параметры - Структура - параметры, переданные на вход обработчика обновления. +// +Процедура ЗаписатьСобытиеВЖурналРегистрации(Комментарий, Уровень = Неопределено, Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ЗаписатьСобытиеВЖурналРегистрации(Комментарий, Уровень, Параметры); +``` +
+ +## ПерезапуститьОтложенноеОбновление +
+ +Описание, пример вызова + +```bsl + +// Выполняет перезапуск отложенного обновления в базе, где уже выполнились +// монопольные и оперативные обработчики обновления. +// Может быть применимо для случаев, когда вносились исправления в процедурах +// регистрации или самих обработчиках обновления и нужно запустить отложенное обновление +// с начала. +// +// Выполняет следующие действия: +// - останавливает выполнение регламентного задания по отложенному обновлению. +// - делает повторную регистрацию обновляемых данных: +// - (по умолчанию)для обработчиков которые еще не выполнились на момент перезапуска. +// - для переданных обработчиков обновления из списка зарегистрированных к обновлению +// на текущую версию. Для этого требуется передать в отборе параметр Обработчики. +// - обработчиков подсистем с указанной версии, в т.ч. тех, которые уже выполнены. +// Для этого необходимо передать в отборе параметр Подсистемы, в котором указать имя подсистемы +// и номер версии, с которого требуется отобрать обработчики обновления. +// - включает регламентное задание отложенного обновления. +// +// Параметры: +// Отбор - Структура: +// * Ключ - Строка - имя подсистемы. +// * Значение - Строка - номер версии +// - Массив - имена обработчиков обновления, которые требуется перезапустить. +// +Процедура ПерезапуститьОтложенноеОбновление(Отбор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ПерезапуститьОтложенноеОбновление(Отбор); +``` +
+ +## ПерезапуститьМонопольноеОбновление +
+ +Описание, пример вызова + +```bsl + +// Выполняет перезапуск монопольных и оперативных обработчиков обновления в базе, где уже выполнилась +// монопольная (оперативная) часть обновления. +// +// Параметры: +// Отбор - Структура: +// * Ключ - Строка - имя подсистемы. +// * Значение - Строка - номер версии. +// +Процедура ПерезапуститьМонопольноеОбновление(Отбор) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ПерезапуститьМонопольноеОбновление(Отбор) +``` +
+ +## ЗарегистрироватьПроблемуСДанными +
+ +Описание, пример вызова + +```bsl + +// Регистрирует проблему с данными, выявленную при выполнении обработчика обновления, в подсистеме КонтрольВеденияУчета. +// +// Параметры: +// ПроблемныйОбъект - ЛюбаяСсылка - объект, в котором обнаружена проблема. +// УточнениеПроблемы - Строка - описание выявленной проблемы. +// Параметры - Структура - параметры, переданные на вход обработчика обновления. +// +Процедура ЗарегистрироватьПроблемуСДанными(ПроблемныйОбъект, УточнениеПроблемы, Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ЗарегистрироватьПроблемуСДанными(ПроблемныйОбъект, УточнениеПроблемы, Параметры); +``` +
+ +## ВключитьОтключитьОтложенноеОбновление +
+ +Описание, пример вызова + +```bsl + +// Позволяет включить или отключить отложенное обновление. В коробке управляет флагом Использование +// у регламентного задания ОтложенноеОбновлениеИБ, в в модели сервиса заданием очереди. +// +// Параметры: +// Использование - Булево - Истина, если требуется включить отложенное обновление. +// +Процедура ВключитьОтключитьОтложенноеОбновление(Использование) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.ВключитьОтключитьОтложенноеОбновление(Использование) +``` +
+ +## УдалитьОтложенныйОбработчикИзОчереди +
+ +Описание, пример вызова + +```bsl + +// Устарела: больше не требуется, т.к. данные действия выполняются автоматически механизмом обновления. +// +// Удаляет отложенный обработчик из очереди выполняемых обработчиков на новую версию. +// Следует использовать, например, при переводе отложенного обработчика +// на монопольный (оперативный) режим выполнения. +// Для этого необходимо добавить новый разделенный обработчик обновления с режимом выполнения +// "Оперативно" и признаком "ОбщиеДанные = Ложь", после чего разместить в нем вызов данного метода. +// +// Параметры: +// ИмяОбработчика - Строка - полное имя процедуры отложенного обработчика. +// +Процедура УдалитьОтложенныйОбработчикИзОчереди(ИмяОбработчика) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазы.УдалитьОтложенныйОбработчикИзОчереди(ИмяОбработчика) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбновлениеИнформационнойБазыБИП.md b/src/content/docs/bsp/ОбновлениеИнформационнойБазыБИП.md new file mode 100644 index 0000000..d045969 --- /dev/null +++ b/src/content/docs/bsp/ОбновлениеИнформационнойБазыБИП.md @@ -0,0 +1,248 @@ +--- +title: Обновление информационной базы БИП +slug: bsp/обновление-информационной-базы-бип +--- + + +## ПриДобавленииПодсистемы +
+ +Описание, пример вызова + +```bsl + +// Заполняет основные сведения о библиотеке или основной конфигурации. +// Библиотека, имя которой имя совпадает с именем конфигурации в метаданных, определяется как основная конфигурация. +// +// Параметры: +// Описание - Структура - сведения о библиотеке: +// +// * Имя - Строка - имя библиотеки, например, "СтандартныеПодсистемы". +// * Версия - Строка - версия в формате из 4-х цифр, например, "2.1.3.1". +// +// * ТребуемыеПодсистемы - Массив - имена других библиотек (Строка), от которых зависит данная библиотека. +// Обработчики обновления таких библиотек должны быть вызваны ранее +// обработчиков обновления данной библиотеки. +// При циклических зависимостях или, напротив, отсутствии каких-либо зависимостей, +// порядок вызова обработчиков обновления определяется порядком добавления модулей +// в процедуре ПриДобавленииПодсистем общего модуля +// ПодсистемыКонфигурацииПереопределяемый. +// * РежимВыполненияОтложенныхОбработчиков - Строка - "Последовательно" - отложенные обработчики обновления выполняются +// последовательно в интервале от номера версии информационной базы до номера +// версии конфигурации включительно или "Параллельно" - отложенный обработчик после +// обработки первой порции данных передает управление следующему обработчику, а после +// выполнения последнего обработчика цикл повторяется заново. +// +Процедура ПриДобавленииПодсистемы(Описание) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИП.ПриДобавленииПодсистемы(Описание) +``` +
+ +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обработчики обновления информационной базы. + +// Добавляет в список процедуры-обработчики обновления данных ИБ +// для всех поддерживаемых версий библиотеки или конфигурации. +// Вызывается перед началом обновления данных ИБ для построения плана обновления. +// +// Параметры: +// Обработчики - ТаблицаЗначений - описание полей, см. в процедуре +// ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления(). +// +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИП.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ПередОбновлениемИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед обработчиками обновления данных ИБ. +// +//@skip-warning +Процедура ПередОбновлениемИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИП.ПередОбновлениемИнформационнойБазы() +``` +
+ +## ПослеОбновленияИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после завершения обновления данных ИБ. +// +// Параметры: +// ПредыдущаяВерсияИБ - Строка - версия до обновления. "0.0.0.0" для "пустой" ИБ. +// ТекущаяВерсияИБ - Строка - версия после обновления. +// ВыполненныеОбработчики - ДеревоЗначений - список выполненных процедур-обработчиков обновления, +// сгруппированных по номеру версии. +// ВыводитьОписаниеОбновлений - Булево - если установить Истина, то будет выведена форма +// с описанием обновлений. По умолчанию, Истина. +// Возвращаемое значение. +// МонопольныйРежим - Булево - Истина, если обновление выполнялось в монопольном режиме. +// +//@skip-warning +Процедура ПослеОбновленияИнформационнойБазы(Знач ПредыдущаяВерсияИБ, Знач ТекущаяВерсияИБ, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИП.ПослеОбновленияИнформационнойБазы(ПредыдущаяВерсияИБ, ТекущаяВерсияИБ, ); +``` +
+ +## ПриПодготовкеМакетаОписанияОбновлений +
+ +Описание, пример вызова + +```bsl + +// Вызывается при подготовке табличного документа с описанием изменений системы. +// +// Параметры: +// Макет - ТабличныйДокумент - описание обновлений. См. также общий макет ОписаниеИзмененийСистемы. +// +//@skip-warning +Процедура ПриПодготовкеМакетаОписанияОбновлений(Знач Макет) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИП.ПриПодготовкеМакетаОписанияОбновлений(Макет) +``` +
+ +## ПриОпределенииРежимаОбновленияДанных +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить режим обновления данных информационной базы. +// Для использования в редких (нештатных) случаях перехода, не предусмотренных в +// стандартной процедуре определения режима обновления. +// +// Параметры: +// РежимОбновленияДанных - Строка - в обработчике можно присвоить одно из значений: +// "НачальноеЗаполнение" - если это первый запуск пустой базы (области данных); +// "ОбновлениеВерсии" - если выполняется первый запуск после обновление конфигурации базы данных; +// "ПереходСДругойПрограммы" - если выполняется первый запуск после обновление конфигурации базы данных, +// в которой изменилось имя основной конфигурации. +// +// СтандартнаяОбработка - Булево - если присвоить Ложь, то стандартная процедура +// определения режима обновления не выполняется, +// а используется значение РежимОбновленияДанных. +// +//@skip-warning +Процедура ПриОпределенииРежимаОбновленияДанных(РежимОбновленияДанных, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИП.ПриОпределенииРежимаОбновленияДанных(РежимОбновленияДанных, СтандартнаяОбработка) +``` +
+ +## ПриДобавленииОбработчиковПереходаСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список процедуры-обработчики перехода с другой программы (с другим именем конфигурации). +// Например, для перехода между разными, но родственными конфигурациями: базовая -> проф -> корп. +// Вызывается перед началом обновления данных ИБ. +// +// Параметры: +// Обработчики - ТаблицаЗначений - с колонками: +// * ПредыдущееИмяКонфигурации - Строка - имя конфигурации, с которой выполняется переход; +// или "*", если нужно выполнять при переходе с любой конфигурации. +// * Процедура - Строка - полное имя процедуры-обработчика перехода с программы ПредыдущееИмяКонфигурации. +// Например, "ОбновлениеИнформационнойБазыУПП.ЗаполнитьУчетнуюПолитику" +// Обязательно должна быть экспортной. +// +// Пример: +// Обработчик = Обработчики.Добавить(); +// Обработчик.ПредыдущееИмяКонфигурации = "УправлениеТорговлей"; +// Обработчик.Процедура = "ОбновлениеИнформационнойБазыУПП.ЗаполнитьУчетнуюПолитику"; +// +//@skip-warning +Процедура ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИП.ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) +``` +
+ +## ПриЗавершенииПереходаСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после выполнения всех процедур-обработчиков перехода с другой программы (с другим именем конфигурации), +// и до начала выполнения обновления данных ИБ. +// +// Параметры: +// ПредыдущееИмяКонфигурации - Строка - имя конфигурации до перехода. +// ПредыдущаяВерсияКонфигурации - Строка - имя предыдущей конфигурации (до перехода). +// Параметры - Структура - : +// * ВыполнитьОбновлениеСВерсии - Булево - по умолчанию Истина. Если установить Ложь, +// то будут выполнена только обязательные обработчики обновления (с версией "*"). +// * ВерсияКонфигурации - Строка - номер версии после перехода. +// По умолчанию, равен значению версии конфигурации в свойствах метаданных. +// Для того чтобы выполнить, например, все обработчики обновления с версии ПредыдущаяВерсияКонфигурации, +// следует установить значение параметра в ПредыдущаяВерсияКонфигурации. +// Для того чтобы выполнить вообще все обработчики обновления, установить значение "0.0.0.1". +// * ОчиститьСведенияОПредыдущейКонфигурации - Булево - по умолчанию Истина. +// Для случаев когда предыдущая конфигурация совпадает по имени с подсистемой текущей конфигурации, следует указать Ложь. +// +//@skip-warning +Процедура ПриЗавершенииПереходаСДругойПрограммы(Знач ПредыдущееИмяКонфигурации, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИП.ПриЗавершенииПереходаСДругойПрограммы(ПредыдущееИмяКонфигурации, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбновлениеИнформационнойБазыБТС.md b/src/content/docs/bsp/ОбновлениеИнформационнойБазыБТС.md new file mode 100644 index 0000000..5127308 --- /dev/null +++ b/src/content/docs/bsp/ОбновлениеИнформационнойБазыБТС.md @@ -0,0 +1,250 @@ +--- +title: Обновление информационной базы БТС +slug: bsp/обновление-информационной-базы-бтс +--- + + +## ПриДобавленииПодсистемы +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазыБСП.ПриДобавленииПодсистемы +// Параметры: +// Описание - см. ОбновлениеИнформационнойБазыБСП.ПриДобавленииПодсистемы.Описание +Процедура ПриДобавленииПодсистемы(Описание) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБТС.ПриДобавленииПодсистемы(Описание) +``` +
+ +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список процедуры-обработчики обновления данных ИБ +// для всех поддерживаемых версий библиотеки или конфигурации. +// Вызывается перед началом обновления данных ИБ для построения плана обновления. +// +// Параметры: +// Обработчики - см. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления +// +// Пример: +// // Добавление процедуры-обработчика в список: +// Обработчик = Обработчики.Добавить(); +// Обработчик.Версия = "1.0.0.0"; +// Обработчик.Процедура = "ОбновлениеИБ.ПерейтиНаВерсию_1_0_0_0"; +// Обработчик.МонопольныйРежим = Ложь; +// Обработчик.Опциональный = Истина; +// +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБТС.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ПередОбновлениемИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед процедурами-обработчиками обновления данных ИБ. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПередОбновлениемИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБТС.ПередОбновлениемИнформационнойБазы() +``` +
+ +## ПослеОбновленияИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после завершения обновления данных ИБ. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ПредыдущаяВерсия - Строка - версия до обновления. "0.0.0.0" для "пустой" ИБ. +// ТекущаяВерсия - Строка - версия после обновления. +// ВыполненныеОбработчики - ДеревоЗначений - список выполненных процедур-обработчиков обновления, +// сгруппированных по номеру версии. +// ВыводитьОписаниеОбновлений - Булево - (возвращаемое значение) если установить Истина, +// то будет выдана форма с описанием обновлений. По умолчанию, Истина. +// МонопольныйРежим - Булево - Истина, если обновление выполнялось в монопольном режиме. +// +// Пример: +// +// // Обход выполненных обработчиков обновления. +// Для Каждого Версия Из ВыполненныеОбработчики.Строки Цикл +// +// Если Версия.Версия = "*" Тогда +// // Обработчик, который может выполнятся при каждой смене версии. +// Иначе +// // Обработчик, который выполняется для определенной версии. +// КонецЕсли; +// +// Для Каждого Обработчик Из Версия.Строки Цикл +// ... +// КонецЦикла; +// +// КонецЦикла; +// +Процедура ПослеОбновленияИнформационнойБазы(Знач ПредыдущаяВерсия, Знач ТекущаяВерсия, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБТС.ПослеОбновленияИнформационнойБазы(ПредыдущаяВерсия, ТекущаяВерсия, ); +``` +
+ +## ПриПодготовкеМакетаОписанияОбновлений +
+ +Описание, пример вызова + +```bsl + +// Вызывается при подготовке табличного документа с описанием изменений в программе. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Макет - ТабличныйДокумент - описание обновления всех библиотек и конфигурации. +// Макет можно дополнить или заменить. +// См. также общий макет ОписаниеИзмененийСистемы. +// +Процедура ПриПодготовкеМакетаОписанияОбновлений(Знач Макет) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБТС.ПриПодготовкеМакетаОписанияОбновлений(Макет) +``` +
+ +## ПриДобавленииОбработчиковПереходаСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список процедуры-обработчики перехода с другой программы (с другим именем конфигурации). +// Например, для перехода между разными, но родственными конфигурациями: базовая -> проф -> корп. +// Вызывается перед началом обновления данных ИБ. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Обработчики - ТаблицаЗначений - с колонками: +// * ПредыдущееИмяКонфигурации - Строка - имя конфигурации, с которой выполняется переход; +// * Процедура - Строка - полное имя процедуры-обработчика перехода с программы ПредыдущееИмяКонфигурации. +// Например, "ОбновлениеИнформационнойБазыУПП.ЗаполнитьУчетнуюПолитику" +// Обязательно должна быть экспортной. +// +// Пример: +// Обработчик = Обработчики.Добавить(); +// Обработчик.ПредыдущееИмяКонфигурации = "УправлениеТорговлей"; +// Обработчик.Процедура = "ОбновлениеИнформационнойБазыУПП.ЗаполнитьУчетнуюПолитику"; +// +Процедура ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБТС.ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) +``` +
+ +## ПриОпределенииРежимаОбновленияДанных +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить режим обновления данных информационной базы. +// Для использования в редких (нештатных) случаях перехода, не предусмотренных в +// стандартной процедуре определения режима обновления. +// +// Параметры: +// РежимОбновленияДанных - Строка - в обработчике можно присвоить одно из значений: +// "НачальноеЗаполнение" - если это первый запуск пустой базы (области данных); +// "ОбновлениеВерсии" - если выполняется первый запуск после обновление конфигурации базы данных; +// "ПереходСДругойПрограммы" - если выполняется первый запуск после обновление конфигурации базы данных, +// в которой изменилось имя основной конфигурации. +// +// СтандартнаяОбработка - Булево - если присвоить Ложь, то стандартная процедура +// определения режима обновления не выполняется, +// а используется значение РежимОбновленияДанных. +// +Процедура ПриОпределенииРежимаОбновленияДанных(РежимОбновленияДанных, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБТС.ПриОпределенииРежимаОбновленияДанных(РежимОбновленияДанных, СтандартнаяОбработка) +``` +
+ +## ПриЗавершенииПереходаСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после выполнения всех процедур-обработчиков перехода с другой программы (с другим именем конфигурации), +// и до начала выполнения обновления данных ИБ. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ПредыдущееИмяКонфигурации - Строка - имя конфигурации до перехода. +// ПредыдущаяВерсияКонфигурации - Строка - имя предыдущей конфигурации (до перехода). +// Параметры - Структура - со свойствами: +// * ВыполнитьОбновлениеСВерсии - Булево - по умолчанию Истина. Если установить Ложь, +// то будут выполнена только обязательные обработчики обновления (с версией "*"). +// * ВерсияКонфигурации - Строка - номер версии после перехода. +// По умолчанию, равен значению версии конфигурации в свойствах метаданных. +// Для того чтобы выполнить, например, все обработчики обновления с версии ПредыдущаяВерсияКонфигурации, +// следует установить значение параметра в ПредыдущаяВерсияКонфигурации. +// Для того чтобы выполнить вообще все обработчики обновления, установить значение "0.0.0.1". +// * ОчиститьСведенияОПредыдущейКонфигурации - Булево - по умолчанию Истина. +// Для случаев когда предыдущая конфигурация совпадает по имени с подсистемой текущей конфигурации, следует +// указать Ложь. +// +Процедура ПриЗавершенииПереходаСДругойПрограммы(Знач ПредыдущееИмяКонфигурации, Знач ПредыдущаяВерсияКонфигурации, Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБТС.ПриЗавершенииПереходаСДругойПрограммы(ПредыдущееИмяКонфигурации, ПредыдущаяВерсияКонфигурации, Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбновлениеИнформационнойБазыКлиентПереопределяемый.md b/src/content/docs/bsp/ОбновлениеИнформационнойБазыКлиентПереопределяемый.md new file mode 100644 index 0000000..03d134b --- /dev/null +++ b/src/content/docs/bsp/ОбновлениеИнформационнойБазыКлиентПереопределяемый.md @@ -0,0 +1,59 @@ +--- +title: Обновление информационной базы клиент переопределяемый +slug: bsp/обновление-информационной-базы-клиент-переопределяемый +--- + + +## ПриНажатииНаГиперссылкуВДокументеОписанияОбновлений +
+ +Описание, пример вызова + +```bsl + +// Вызывается при нажатии на гиперссылку или двойном щелчке на ячейке +// табличного документа с описанием изменений системы (общий макет ОписаниеИзмененийСистемы). +// +// Параметры: +// Область - ОбластьЯчеекТабличногоДокумента - область документа, на +// которой произошло нажатие. +// +Процедура ПриНажатииНаГиперссылкуВДокументеОписанияОбновлений(Знач Область) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыКлиентПереопределяемый.ПриНажатииНаГиперссылкуВДокументеОписанияОбновлений(Область) +``` +
+ +## ПриОпределенииВозможностиОбновления +
+ +Описание, пример вызова + +```bsl + +// Вызывается в обработчике ПередНачаломРаботыСистемы, проверяет возможность +// обновления на текущую версию программы. +// +// Параметры: +// ВерсияДанных - Строка - версия данных основной конфигурации, с которой выполняется обновление +// (из регистра сведений ВерсииПодсистем). +// +Процедура ПриОпределенииВозможностиОбновления(Знач ВерсияДанных) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыКлиентПереопределяемый.ПриОпределенииВозможностиОбновления(ВерсияДанных) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбновлениеИнформационнойБазыПереопределяемый.md b/src/content/docs/bsp/ОбновлениеИнформационнойБазыПереопределяемый.md new file mode 100644 index 0000000..64adb41 --- /dev/null +++ b/src/content/docs/bsp/ОбновлениеИнформационнойБазыПереопределяемый.md @@ -0,0 +1,478 @@ +--- +title: Обновление информационной базы переопределяемый +slug: bsp/обновление-информационной-базы-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Позволяет задать общие настройки подсистемы, в том числе, список объектов начального заполнения, тексты сообщений для +// пользователя и другое. +// +// Параметры: +// Параметры - Структура: +// * ПоясненияДляРезультатовОбновления - Строка - текст подсказки, указывающий путь +// к форме "Результаты обновления приложения". +// * ПараметрыСообщенияОНевыполненныхОтложенныхОбработчиках - Структура - сообщение о +// наличии невыполненных отложенных обработчиков обновления +// на прошлую версию при попытке обновления: +// * ТекстСообщения - Строка - текст сообщения, выводимый пользователю. По умолчанию +// текст сообщения построен с учетом того, что обновление можно +// продолжить, т.е. параметр ЗапрещатьПродолжение = Ложь. +// * КартинкаСообщения - Картинка - картинка, выводимая слева от сообщения. +// * ЗапрещатьПродолжение - Булево - если Истина, продолжить обновление будет невозможно. По умолчанию Ложь. +// * РасположениеОписанияИзмененийПрограммы - Строка - описывает расположение команды, по которой можно +// открыть форму с описанием изменений в новой версии программы. +// * МногопоточноеОбновление - Булево - если Истина, то в один момент времени могут выполняться сразу +// несколько обработчиков обновления. По умолчанию - Ложь. +// Это влияет как на количество потоков выполнения обработчиков обновления, +// так и количество потоков регистрации данных для обновления. +// ВАЖНО: перед включением ознакомьтесь с документацией. +// * КоличествоПотоковОбновленияИнформационнойБазыПоУмолчанию - Строка - количество потоков отложенного обновления +// используемое, когда не задано значение для константы +// КоличествоПотоковОбновленияИнформационнойБазы. По умолчанию равно 1. +// * ОбъектыСНачальнымЗаполнением - Массив - объекты, содержащие в модуле менеджере код начального заполнения +// в процедуре ПриНачальномЗаполненииЭлементов. +// +Процедура ПриОпределенииНастроек(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПриОпределенииНастроек(Параметры) +``` +
+ +## ПередОбновлениемИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед процедурами-обработчиками обновления данных ИБ. +// Здесь можно разместить любую нестандартную логику обновления данных - например, +// иначе проинициализировать сведения о версиях тех или иных подсистем +// с помощью ОбновлениеИнформационнойБазы.ВерсияИБ, ОбновлениеИнформационнойБазы.УстановитьВерсиюИБ, +// и ОбновлениеИнформационнойБазы.ЗарегистрироватьНовуюПодсистему. +// +// Пример: +// Для того чтобы отменить штатную процедуру перехода с другой программы, регистрируем +// сведения о том, что основная конфигурации уже актуальной версии: +// ВерсииПодсистем = ОбновлениеИнформационнойБазы.ВерсииПодсистем(); +// Если ВерсииПодсистем.Количество() > 0 И ВерсииПодсистем.Найти(Метаданные.Имя, "ИмяПодсистемы") = Неопределено Тогда +// ОбновлениеИнформационнойБазы.ЗарегистрироватьНовуюПодсистему(Метаданные.Имя, Метаданные.Версия); +// КонецЕсли; +// +Процедура ПередОбновлениемИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПередОбновлениемИнформационнойБазы() +``` +
+ +## ПослеОбновленияИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после завершения обновления данных ИБ. +// В зависимости от тех или иных условий можно отключить штатное открытие формы +// с описанием изменений в новой версии программы при первом входе в нее (после обновления), +// а также выполнить другие действия. +// +// Не рекомендуется выполнять в данной процедуре какую-либо обработку данных. +// Такие процедуры следует оформлять штатными обработчиками обновления, выполняемыми на каждую версию "*". +// +// Параметры: +// ПредыдущаяВерсияИБ - Строка - версия до обновления. "0.0.0.0" для "пустой" ИБ. +// ТекущаяВерсияИБ - Строка - версия после обновления. Как правило, соответствует Метаданные.Версия. +// ИтерацииОбновления - Массив - массив структур, описывающих сведения об обновлении каждой +// библиотеки и конфигурации, с ключами: +// * Подсистема - Строка - имя библиотеки или конфигурации. +// * Версия - Строка - например, "2.1.3.39". Номер версии библиотеки (конфигурации). +// * ЭтоОсновнаяКонфигурация - Булево - Истина, если это основная конфигурация, а не библиотека. +// * Обработчики - ТаблицаЗначений - все обработчики обновления библиотеки, описание колонок +// см. в ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +// * ВыполненныеОбработчики - ДеревоЗначений - выполненные обработчики обновления, сгруппированные по +// библиотеке и номеру версии, описание колонок +// см. в ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +// * ИмяОсновногоСерверногоМодуля - Строка - имя модуля библиотеки (конфигурации), который предоставляет +// основные сведения о ней: имя, версия и т.д. +// * ОсновнойСерверныйМодуль - ОбщийМодуль - общий модуль библиотеки (конфигурации), который предоставляет +// основные сведения о ней: имя, версия и т.д. +// * ПредыдущаяВерсия - Строка - например, "2.1.3.30". Номер версии библиотеки (конфигурации) до обновления. +// ВыводитьОписаниеОбновлений - Булево - если установить Ложь, то не будет открыта форма +// с описанием изменений в новой версии программы. По умолчанию Истина. +// МонопольныйРежим - Булево - признак того, что обновление выполнилось в монопольном режиме. +// +// Пример: +// Для обхода выполненных обработчиков обновления: +// Для Каждого ИтерацияОбновления Из ИтерацииОбновления Цикл +// Для Каждого Версия Из ИтерацияОбновления.ВыполненныеОбработчики.Строки Цикл +// +// Если Версия.Версия = "*" Тогда +// // Группа обработчиков, которые выполняются регулярно при каждой смене версии. +// Иначе +// // Группа обработчиков, которые выполнились для определенной версии. +// КонецЕсли; +// +// Для Каждого Обработчик Из Версия.Строки Цикл +// ... +// КонецЦикла; +// +// КонецЦикла; +// КонецЦикла; +// +Процедура ПослеОбновленияИнформационнойБазы(Знач ПредыдущаяВерсияИБ, Знач ТекущаяВерсияИБ, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПослеОбновленияИнформационнойБазы(ПредыдущаяВерсияИБ, ТекущаяВерсияИБ, ); +``` +
+ +## ПриПодготовкеМакетаОписанияОбновлений +
+ +Описание, пример вызова + +```bsl + +// Вызывается при подготовке документа с описанием изменений в новой версии программы, +// которое выводится пользователю при первом входе в программу (после обновления). +// +// Параметры: +// Макет - ТабличныйДокумент - описание изменений в новой версии программы, автоматически +// сформированное из общего макета ОписаниеИзмененийСистемы. +// Макет можно программно модифицировать или заменить на другой. +// +Процедура ПриПодготовкеМакетаОписанияОбновлений(Знач Макет) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПриПодготовкеМакетаОписанияОбновлений(Макет) +``` +
+ +## ПередФормированиеСпискаОтложенныхОбработчиков +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед формирование списка отложенных обработчиков. +// Позволяет организовать дополнительные проверки списка отложенных обработчиков. +// +// Параметры: +// ИтерацииОбновления - Массив - массив структур, описывающих сведения об обновлении каждой +// библиотеки и конфигурации, с ключами: +// * Подсистема - Строка - имя библиотеки или конфигурации. +// * Версия - Строка - например, "2.1.3.39". Номер версии библиотеки (конфигурации). +// * ЭтоОсновнаяКонфигурация - Булево - Истина, если это основная конфигурация, а не библиотека. +// * Обработчики - ТаблицаЗначений - все обработчики обновления библиотеки, описание колонок +// см. в ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +// * ВыполненныеОбработчики - ДеревоЗначений - выполненные обработчики обновления, сгруппированные по +// библиотеке и номеру версии, описание колонок +// см. в ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +// * ИмяОсновногоСерверногоМодуля - Строка - имя модуля библиотеки (конфигурации), который предоставляет +// основные сведения о ней: имя, версия и т.д. +// * ОсновнойСерверныйМодуль - ОбщийМодуль - общий модуль библиотеки (конфигурации), который предоставляет +// основные сведения о ней: имя, версия и т.д. +// * ПредыдущаяВерсия - Строка - например, "2.1.3.30". Номер версии библиотеки (конфигурации) до обновления. +// +// Пример: +// Обход всех обработчиков обновления: +// Для Каждого ИтерацияОбновления Из ИтерацииОбновления Цикл +// Если ИтерацияОбновления.Подсистема = "ИмяНашейПодсистемы" Тогда +// Для Каждого Обработчик Из ИтерацияОбновления.Обработчики Цикл +// +// Если Обработчик.Версия = "*" Тогда +// // Группа обработчиков, которые выполняются регулярно при каждой смене версии. +// Иначе +// // Группа обработчиков, которые выполняются для определенной версии. +// КонецЕсли; +// +// КонецЦикла; +// КонецЕсли; +// КонецЦикла; +// +Процедура ПередФормированиеСпискаОтложенныхОбработчиков(ИтерацииОбновления) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПередФормированиеСпискаОтложенныхОбработчиков(ИтерацииОбновления) +``` +
+ +## ПриФормированииСпискаРазрабатываемыхПодсистем +
+ +Описание, пример вызова + +```bsl + +// Необходимо для того, чтобы выгружать новые или измененные описания +// обработчиков обновления в код при помощи обработки ОписаниеОбработчиковОбновления +// только по тем подсистемам, разработка которых ведется в данной конфигурации. +// +// +// Параметры: +// РазрабатываемыеПодсистемы - Массив из Строка - имена разрабатываемых подсистемы в текущей конфигурации, +// Имя подсистемы в том виде, в котором оно задано в общем модуле +// ОбновлениеИнформационнойБазыХХХ. +// +Процедура ПриФормированииСпискаРазрабатываемыхПодсистем(РазрабатываемыеПодсистемы) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПриФормированииСпискаРазрабатываемыхПодсистем(РазрабатываемыеПодсистемы) +``` +
+ +## ПриЗаполненииПриоритетовТиповМетаданных +
+ +Описание, пример вызова + +```bsl + +// Вызывается после формирования порядка обновления типов метаданных (Константы, Справочники, Документы и т.д.). +// Используется для переопределения порядка обновления для какого-то конкретного объекта метаданных. +// +// Параметры: +// ПриоритетыТиповМетаданных - Соответствие из КлючИЗначение - порядок обновления типов метаданных: +// * Ключ - имя типа метаданного в единственном числе или полное имя конкретного типа метаданного +// * Значение - Число - порядок обновления +// +// Пример: +// ПриоритетыТиповМетаданных.Вставить("РегистрСведений.РеестрДокументов", 120); +// +Процедура ПриЗаполненииПриоритетовТиповМетаданных(ПриоритетыТиповМетаданных) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПриЗаполненииПриоритетовТиповМетаданных(ПриоритетыТиповМетаданных) +``` +
+ +## ПриВыполненииПроверкиОбъектОбработан +
+ +Описание, пример вызова + +```bsl + +// Вызывается при выполнении функции ОбновлениеИнформационнойБазы.ОбъектОбработан. +// Позволяет написать произвольную логику для блокировки изменения объекта пользователем +// на время выполнения обновления программы. +// +// Параметры: +// ПолноеИмяОбъекта - Строка - имя объекта, для которого вызывается проверка. +// БлокироватьИзменение - Булево - если установить значение Истина, то объект +// будет открыт только для чтения. Значение по умолчанию - Ложь. +// ТекстСообщения - Строка - сообщение, которое будет выведено пользователю при открытии объекта. +// +Процедура ПриВыполненииПроверкиОбъектОбработан(ПолноеИмяОбъекта, БлокироватьИзменение, ТекстСообщения) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПриВыполненииПроверкиОбъектОбработан(ПолноеИмяОбъекта, БлокироватьИзменение, ТекстСообщения) +``` +
+ +## ПриНастройкеНачальногоЗаполненияЭлементов +
+ +Описание, пример вызова + +```bsl + +// Определяет настройки начального заполнения элементов +// Позволяет задать общие настройки заполнение поставляемых данных для объектов, недоступных для изменения, +// стоящих на поддержке у другой библиотеки. +// +// Параметры: +// ПолноеИмяОбъекта - Строка - имя объекта, для которого вызывается заполнение. +// Настройки - Структура: +// * ПриНачальномЗаполненииЭлемента - Булево - если Истина, то для каждого элемента будет +// вызвана процедура индивидуального заполнения ПриНачальномЗаполненииЭлемента. +// * ПредопределенныеДанные - ТаблицаЗначений - данные заполненные в процедуре ПриНачальномЗаполненииЭлементов. +// +Процедура ПриНастройкеНачальногоЗаполненияЭлементов(ПолноеИмяОбъекта, Настройки) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов(ПолноеИмяОбъекта, Настройки) +``` +
+ +## ПриНачальномЗаполненииЭлементов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при начальном заполнении объектов. +// Позволяет описать заполнение поставляемых данных для объектов, +// недоступных для изменения, например стоящих на поддержке у другой библиотеки. +// +// Параметры: +// ПолноеИмяОбъекта - Строка - имя объекта, для которого вызывается заполнение. +// КодыЯзыков - Массив - список языков конфигурации. Актуально для мультиязычных конфигураций. +// Элементы - ТаблицаЗначений - данные заполнения. Состав колонок соответствует набору реквизитов объекта. +// ТабличныеЧасти - Структура - описание табличных частей объекта, где: +// * Ключ - Строка - имя табличной части; +// * Значение - ТаблицаЗначений - табличная часть в виде таблицы значений, структуру которой +// необходимо скопировать перед заполнением. Например: +// Элемент.Ключи = ТабличныеЧасти.Ключи.Скопировать(); +// ЭлементТЧ = Элемент.Ключи.Добавить(); +// ЭлементТЧ.ИмяКлюча = "Первичный"; +// +Процедура ПриНачальномЗаполненииЭлементов(ПолноеИмяОбъекта, КодыЯзыков, Элементы, ТабличныеЧасти) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов(ПолноеИмяОбъекта, КодыЯзыков, Элементы, ТабличныеЧасти) +``` +
+ +## ПриНачальномЗаполненииЭлемента +
+ +Описание, пример вызова + +```bsl + +// Вызывается при начальном заполнении создаваемого объекта. +// Позволяет описать дополнительное заполнение или проверку поставляемого объекта, +// недоступного для изменения, например стоящего на поддержке у другой библиотеки. +// +// Параметры: +// ПолноеИмяОбъекта - Строка - имя объекта, для которого вызывается заполнение. +// Объект - заполняемый объект. +// Данные - СтрокаТаблицыЗначений - данные заполнения объекта. +// ДополнительныеПараметры - Структура: +// * ПредопределенныеДанные - ТаблицаЗначений - данные заполненные в процедуре ПриНачальномЗаполненииЭлементов. +// +Процедура ПриНачальномЗаполненииЭлемента(ПолноеИмяОбъекта, Объект, Данные, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлемента(ПолноеИмяОбъекта, Объект, Данные, ДополнительныеПараметры) +``` +
+ +## ПриЗаполненииОбъектовПланируемыхКУдалению +
+ +Описание, пример вызова + +```bsl + +// Вызывается при выполнении обработчика обновления, +// выполняющего очистку данных устаревших объектов метаданных. +// +// Кроме указанных устаревших объектов Удалить*, объекты метаданных, +// отключенные от подсистем библиотек, по-возможности добавляются +// ими автоматически в сокращение типов в измерениях своих регистров. +// Дополнительные сведения могут быть указаны в документации по внедрению +// подсистемы в подразделе "Удаление прикладных объектов из подсистемы". +// +// Параметры: +// Объекты - см. ОбновлениеИнформационнойБазы.ДобавитьОбъектПланируемыйКУдалению.Объекты +// +// Пример: +// ОбновлениеИнформационнойБазы.ДобавитьОбъектПланируемыйКУдалению(Объекты, +// "Справочник.УдалитьОчередьЗаданий"); +// +// ОбновлениеИнформационнойБазы.ДобавитьОбъектПланируемыйКУдалению(Объекты, +// "Перечисление.УдалитьСовместимостьНоменклатуры"); +// +// ОбновлениеИнформационнойБазы.ДобавитьОбъектПланируемыйКУдалению(Объекты, +// "Перечисление.ХозяйственныеОперации.УдалитьСписаниеТоваровПереданныхПартнерам"); +// +// ОбновлениеИнформационнойБазы.ДобавитьОбъектПланируемыйКУдалению(Объекты, +// "БизнесПроцесс.Задание.ТочкаМаршрута.УдалитьВернутьИсполнителю"); +// +// ОбновлениеИнформационнойБазы.ДобавитьОбъектПланируемыйКУдалению(Объекты, +// "РегистрСведений.ВерсииОбъектов.Объект", +// Новый ОписаниеТипов("СправочникСсылка.ФизическиеЛица, +// |ДокументСсылка.НачислениеЗарплаты")); +// +Процедура ПриЗаполненииОбъектовПланируемыхКУдалению(Объекты) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПриЗаполненииОбъектовПланируемыхКУдалению(Объекты) +``` +
+ +## ПослеЗаписиДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается после записи данных обработчиком обновления, но до отметки обработки. +// +// Параметры: +// Данные - Произвольный - объект, набор записей или менеджер константы. +// +Процедура ПослеЗаписиДанных(Данные) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПослеЗаписиДанных(Данные) +``` +
+ +## ПриФормированиеСпискаРазрабатываемыхПодсистем +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать +// ОбновлениеИнформационнойБазыПереопределяемый.ПриФормированииСпискаРазрабатываемыхПодсистем +// +Процедура ПриФормированиеСпискаРазрабатываемыхПодсистем(РазрабатываемыеПодсистемы) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыПереопределяемый.ПриФормированиеСпискаРазрабатываемыхПодсистем(РазрабатываемыеПодсистемы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбновлениеКонфигурации.md b/src/content/docs/bsp/ОбновлениеКонфигурации.md new file mode 100644 index 0000000..b371faa --- /dev/null +++ b/src/content/docs/bsp/ОбновлениеКонфигурации.md @@ -0,0 +1,42 @@ +--- +title: Обновление конфигурации +slug: bsp/обновление-конфигурации +--- + + +## ИсправленияИзменены +
+ +Описание, пример вызова + +```bsl + +// Удаляет устаревшие исправления, устанавливает корректные +// свойства новым исправлениям. Требуется вызывать перед выполнением обновления +// конфигурации в пакетном режиме (см. ОбновлениеИнформационнойБазы.ВыполнитьОбновлениеИнформационнойБазы). +// Важно: Выполненные действия применятся после перезапуска сеанса. +// +// Параметры: +// ТолькоПроверка - Булево - если Истина, устаревшие патчи не будут удаляться. +// +// Возвращаемое значение: +// Структура: +// * ЕстьИзменения - Булево - истина, если были внесены изменения в составе исправлений. +// * ОписаниеИзменений - Строка - информация о удаленных и измененных патчах. +// +Функция ИсправленияИзменены(ТолькоПроверка = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеКонфигурации.ИсправленияИзменены(ТолькоПроверка); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбновлениеКонфигурацииКлиент.md b/src/content/docs/bsp/ОбновлениеКонфигурацииКлиент.md new file mode 100644 index 0000000..cdb6b0a --- /dev/null +++ b/src/content/docs/bsp/ОбновлениеКонфигурацииКлиент.md @@ -0,0 +1,97 @@ +--- +title: Обновление конфигурации клиент +slug: bsp/обновление-конфигурации-клиент +--- + + +## ПоддерживаетсяУстановкаОбновлений +
+ +Описание, пример вызова + +```bsl + +// Возвращает, поддерживается ли установка обновлений конфигурации на данном компьютере. +// Установка обновления: +// - доступна только в ОС Windows; +// - не доступна при подключении через веб-сервер (т.к. обновление выполняется через пакетный запуск конфигуратора, +// который выполняет прямое подключение к информационной базе); +// - возможна, если установлен конфигуратор (полный дистрибутив технологической платформы 1С:Предприятие для Windows); +// - доступна, если имеются права администрирования. +// - не доступна в модели сервиса (выполняется централизованно через Менеджер сервиса). +// +// Возвращаемое значение: +// Структура: +// * Поддерживается - Булево - Истина, если установка обновлений конфигурации поддерживается. +// * ОписаниеОшибки - Строка - описание ошибки в случае, если не поддерживается. +// +Функция ПоддерживаетсяУстановкаОбновлений() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеКонфигурацииКлиент.ПоддерживаетсяУстановкаОбновлений() +``` +
+ +## ПоказатьПоискИУстановкуОбновлений +
+ +Описание, пример вызова + +```bsl + +// Открывает форму установки обновлений с указанными параметрами. +// +// Параметры: +// ПараметрыУстановкиОбновлений - Структура - дополнительные параметры установки обновлений: +// * ЗавершениеРаботыСистемы - Булево - Истина, если после установки обновления работа программы завершается. +// По умолчанию Ложь. +// * ПолученоОбновлениеКонфигурации - Булево - Истина, если устанавливаемое обновление получено из приложения +// в Интернете. По умолчанию Ложь - обычный режим установки обновления. +// * ВыполнитьОбновление - Булево - Истина, если необходимо пропустить выбор файла обновления и сразу перейти +// к установке обновления. По умолчанию Ложь - предлагать выбор. +// +Процедура ПоказатьПоискИУстановкуОбновлений(ПараметрыУстановкиОбновлений = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеКонфигурацииКлиент.ПоказатьПоискИУстановкуОбновлений(ПараметрыУстановкиОбновлений); +``` +
+ +## ПоказатьРезервноеКопирование +
+ +Описание, пример вызова + +```bsl + +// Отображает форму настроек создания резервной копии. +// +// Параметры: +// ПараметрыРезервногоКопирования - Структура - параметры формы резервного копирования: +// * СоздаватьРезервнуюКопию - Число - 0, Не создавать резервную копию ИБ; +// 1, Создавать временную резервную копию ИБ; +// 2, Создавать резервную копию ИБ. +// * ИмяКаталогаРезервнойКопииИБ - Строка - каталог сохранения резервной копии. +// * ВосстанавливатьИнформационнуюБазу - Булево - выполнять откат при нештатной ситуации. +// ОписаниеОповещения - ОписаниеОповещения - описание оповещения о закрытии формы. +// +Процедура ПоказатьРезервноеКопирование(ПараметрыРезервногоКопирования, ОписаниеОповещения) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеКонфигурацииКлиент.ПоказатьРезервноеКопирование(ПараметрыРезервногоКопирования, ОписаниеОповещения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/Обсуждения.md b/src/content/docs/bsp/Обсуждения.md new file mode 100644 index 0000000..d7de27c --- /dev/null +++ b/src/content/docs/bsp/Обсуждения.md @@ -0,0 +1,338 @@ +--- +title: Обсуждения +slug: bsp/обсуждения +--- + + +## ОтправитьСообщение +
+ +Описание, пример вызова + +```bsl + +// Отправляет сообщение пользователям от другого пользователя. +// Если между пользователями не было обсуждения, +// то будет создано отображаемое обсуждение. +// +// Выбрасывает исключение, если не удалось отправить сообщение. +// +// Параметры: +// Автор - СправочникСсылка.Пользователи +// - ПользовательСистемыВзаимодействия +// Получатели - Массив из СправочникСсылка.Пользователи +// - Массив из ПользовательСистемыВзаимодействия +// Сообщение - см. ОписаниеСообщения +// ОбсуждениеКонтекст - ЛюбаяСсылка - сообщение будет отправлено в контекстное обсуждение. +// - ИдентификаторОбсужденияСистемыВзаимодействия - сообщение будет отправлено в указанное обсуждение. +// - Неопределено - сообщение будет отправлено в негрупповое обсуждение между автором и получателем. +// +// Пример: +// Сообщение = Обсуждения.ОписаниеСообщения("Привет, мир!"); +// Получатель = ОбщегоНазначенияКлиентСервер.ЗначениеВМассиве(Администратор); +// Обсуждения.ОтправитьСообщение(Пользователи.ТекущийПользователь(), Получатель, Сообщение); +// +Процедура ОтправитьСообщение(Знач Автор, Знач Получатели, Сообщение, ОбсуждениеКонтекст = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Обсуждения.ОтправитьСообщение(Автор, Получатели, Сообщение, ОбсуждениеКонтекст); +``` +
+ +## ОтправитьУведомление +
+ +Описание, пример вызова + +```bsl + +// Отправляет сообщение всем участникам неконтекстного обсуждения. +// Если обсуждение контекстное, то будет отправление сообщение без адресатов. +// +// Выбрасывает исключение, если не удалось отправить сообщение. +// +// Параметры: +// Автор - СправочникСсылка.Пользователи +// - ПользовательСистемыВзаимодействия +// Сообщение - см. ОписаниеСообщения. +// ОбсуждениеКонтекст - ЛюбаяСсылка - сообщение будет отправлено в контекстное обсуждение. +// - ИдентификаторОбсужденияСистемыВзаимодействия - сообщение будет отправлено в указанное обсуждение. +// +// Пример: +// Сообщение = Обсуждения.ОписаниеСообщения("Привет, мир!"); +// Обсуждения.ОтправитьУведомление(Пользователи.ТекущийПользователь(), Сообщение, ЗаказКлиента); +// +Процедура ОтправитьУведомление(Знач Автор, Сообщение, ОбсуждениеКонтекст) Экспорт +``` + +Пример вызова +```bsl +Обсуждения.ОтправитьУведомление(Автор, Сообщение, ОбсуждениеКонтекст) +``` +
+ +## СистемаВзаимодействийПодключена +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если метод ИнформационнаяБазаЗарегистрирована +// объекта СистемаВзаимодействия возвращает Истина и +// использование не заблокировано администратором. +// +// Возвращаемое значение: +// Булево +// +Функция СистемаВзаимодействийПодключена() Экспорт +``` + +Пример вызова +```bsl +Результат = Обсуждения.СистемаВзаимодействийПодключена() +``` +
+ +## ОбсужденияДоступны +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если метод ИспользованиеДоступно +// объекта СистемаВзаимодействия возвращает Истина и +// использование не заблокировано администратором. +// +// Возвращаемое значение: +// Булево +// +Функция ОбсужденияДоступны() Экспорт +``` + +Пример вызова +```bsl +Результат = Обсуждения.ОбсужденияДоступны() +``` +
+ +## ПользователиИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Формирует соответствие между идентификаторами пользователей системы взаимодействия +// и элементами справочника Пользователи. +// +// Параметры: +// ПользователиСистемыВзаимодействия - Массив из ИдентификаторПользователяСистемыВзаимодействия +// - КоллекцияИдентификаторовПользователейСистемыВзаимодействия +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ИдентификаторПользователяСистемыВзаимодействия +// * Значение - см. ПользовательИнформационнойБазы +// +Функция ПользователиИнформационнойБазы(ПользователиСистемыВзаимодействия) Экспорт +``` + +Пример вызова +```bsl +Результат = Обсуждения.ПользователиИнформационнойБазы(ПользователиСистемыВзаимодействия) +``` +
+ +## ПользовательИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск элемента справочника Пользователи по идентификатору пользователя Системы Взаимодействия. +// +// Выбрасывает исключение, если пользователь не был найден. +// +// Параметры: +// ПользовательСистемыВзаимодействия - ИдентификаторПользователяСистемыВзаимодействия. +// +// Возвращаемое значение: +// СправочникСсылка.Пользователи +// +Функция ПользовательИнформационнойБазы(ПользовательСистемыВзаимодействия) Экспорт +``` + +Пример вызова +```bsl +Результат = Обсуждения.ПользовательИнформационнойБазы(ПользовательСистемыВзаимодействия) +``` +
+ +## ПользователиСистемыВзаимодействия +
+ +Описание, пример вызова + +```bsl + +// Формирует соответствие между элементами справочника Пользователи +// и идентификаторами пользователей системы взаимодействия. +// +// Если пользователь не найден, то будет попытка создать пользователя системы взаимодействия. +// Если пользователь не найден и при создании нового пользователя было выброшено исключение, +// то возвращается Неопределено. +// +// Параметры: +// ПользователиИнформационнойБазы - Массив из СправочникСсылка.Пользователи +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.Пользователи +// * Значение - ПользовательСистемыВзаимодействия +// +Функция ПользователиСистемыВзаимодействия(ПользователиИнформационнойБазы) Экспорт +``` + +Пример вызова +```bsl +Результат = Обсуждения.ПользователиСистемыВзаимодействия(ПользователиИнформационнойБазы) +``` +
+ +## ПользовательСистемыВзаимодействия +
+ +Описание, пример вызова + +```bsl + +// Получает идентификатор пользователя системы взаимодействия. +// Если пользователь не найден, то будет выполнена попытка создать нового пользователя. +// +// Выбрасывает исключение, если: +// - не удалось получить идентификатор пользователя информационной базы; +// - не удалось создать пользователя системы Взаимодействия. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи +// - СправочникОбъект.Пользователи +// +// ТолькоИдентификатор - Булево - если указать Истина, то возвращается не пользователь, +// а идентификатор пользователя, что быстрее. +// +// Возвращаемое значение: +// ПользовательСистемыВзаимодействия - если ТолькоИдентификатор = Ложь. +// ИдентификаторПользователяСистемыВзаимодействия - если ТолькоИдентификатор = Истина. +// +Функция ПользовательСистемыВзаимодействия(Пользователь, ТолькоИдентификатор = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = Обсуждения.ПользовательСистемыВзаимодействия(Пользователь, ТолькоИдентификатор); +``` +
+ +## ОбновитьПользователяВСистемеВзаимодействия +
+ +Описание, пример вызова + +```bsl + +// Обновляет дополнительную информацию пользователя системы взаимодействия. +// Например, телефон и адрес электронной почты. +// Если пользователь системы взаимодействия еще не создан, то будет создан новый пользователь +// системы взаимодействия. +// +// Выбрасывает исключение, если обновить пользователя системы взаимодействия не удалось. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи +// - СправочникОбъект.Пользователи +// +Процедура ОбновитьПользователяВСистемеВзаимодействия(Пользователь) Экспорт +``` + +Пример вызова +```bsl +Обсуждения.ОбновитьПользователяВСистемеВзаимодействия(Пользователь) +``` +
+ +## ОписаниеСообщения +
+ +Описание, пример вызова + +```bsl + +// Формирует описание сообщение для отправки сообщения через процедуры +// и функции подсистемы Обсуждения. +// +// Параметры: +// Текст - Строка - текст сообщения системы Взаимодействия +// - ФорматированнаяСтрока +// +// Возвращаемое значение: +// Структура: +// * Текст - ФорматированнаяСтрока +// * Вложения - Массив из см. ОписаниеВложения +// * Данные - Неопределено - см. синтакс-помощник СообщениеСистемыВзаимодействия +// * Действия - СписокЗначений - см. синтакс-помощник СообщениеСистемыВзаимодействия +// +Функция ОписаниеСообщения(Знач Текст) Экспорт +``` + +Пример вызова +```bsl +Результат = Обсуждения.ОписаниеСообщения(Текст) +``` +
+ +## ОписаниеВложения +
+ +Описание, пример вызова + +```bsl + +// Формирует описание вложения для отправки сообщения через процедуры +// и функции подсистемы Обсуждения. +// +// Параметры: +// Поток - Поток - поток, из которого будет создано вложение системы Взаимодействия. +// - ПотокВПамяти +// - ФайловыйПоток +// Наименование - Строка - имя вложения. +// +// Возвращаемое значение: +// Структура: +// * Поток - Поток - поток, из которого будет создано вложение системы взаимодействия. +// - ПотокВПамяти +// - ФайловыйПоток +// * Наименование - Строка +// * ТипСодержимого - Строка +// * Отображаемое - Булево - значение по умолчанию Истина +// +Функция ОписаниеВложения(Поток, Наименование) Экспорт +``` + +Пример вызова +```bsl +Результат = Обсуждения.ОписаниеВложения(Поток, Наименование) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбсужденияКлиент.md b/src/content/docs/bsp/ОбсужденияКлиент.md new file mode 100644 index 0000000..bee001b --- /dev/null +++ b/src/content/docs/bsp/ОбсужденияКлиент.md @@ -0,0 +1,81 @@ +--- +title: Обсуждения клиент +slug: bsp/обсуждения-клиент +--- + + +## ПоказатьПодключение +
+ +Описание, пример вызова + +```bsl + +// Начать подключение системы взаимодействия. +// +// Параметры: +// ОписаниеЗавершения - ОписаниеОповещения - оповещение, которое будет выполнено +// после закрытия формы подключения с параметрами: +// * Результат - Неопределено +// * ДополнительныеПараметры - Неопределено +// - Структура. +// +Процедура ПоказатьПодключение(ОписаниеЗавершения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбсужденияКлиент.ПоказатьПодключение(ОписаниеЗавершения); +``` +
+ +## ПоказатьОтключение +
+ +Описание, пример вызова + +```bsl + +// Начать отключение системы взаимодействия. +// +Процедура ПоказатьОтключение() Экспорт +``` + +Пример вызова +```bsl +ОбсужденияКлиент.ПоказатьОтключение() +``` +
+ +## ОбсужденияДоступны +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если система взаимодействия подключена и доступна для использования. +// +// Делает вызов сервера, что гарантирует получение корректного состояния в случае, +// когда данные регистрации информационной базы были изменены методом +// СистемаВзаимодействия.УстановитьДанныеРегистрацииИнформационнойБазы. +// +// Возвращаемое значение: +// Булево +// +Функция ОбсужденияДоступны() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбсужденияКлиент.ОбсужденияДоступны() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбсужденияЛокализация.md b/src/content/docs/bsp/ОбсужденияЛокализация.md new file mode 100644 index 0000000..688484d --- /dev/null +++ b/src/content/docs/bsp/ОбсужденияЛокализация.md @@ -0,0 +1,57 @@ +--- +title: Обсуждения локализация +slug: bsp/обсуждения-локализация +--- + + +## ПриОпределенииДоступныхИнтеграций +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить список доступных интеграций в зависимости от национальной специфики. +// +// Параметры: +// ТипыВнешнихСистем - Массив из Строка - "Telegram", "WebChat", "Webhook", "Webhook" и другие. +// +Процедура ПриОпределенииДоступныхИнтеграций(ТипыВнешнихСистем) Экспорт +``` + +Пример вызова +```bsl +ОбсужденияЛокализация.ПриОпределенииДоступныхИнтеграций(ТипыВнешнихСистем) +``` +
+ +## ПриЗаполненииИнструкцииДляПодключенияИнтеграции +
+ +Описание, пример вызова + +```bsl + +// Позволяет указать пользовательские инструкции для подключения интеграции с той или иной внешней системой +// в конкретной стране или регионе. +// +// Параметры: +// Инструкция - ФорматированнаяСтрока +// ТипВнешнейСистемы - Строка - "Telegram", "WebChat", "Webhook" или "Webhook". +// +Процедура ПриЗаполненииИнструкцииДляПодключенияИнтеграции(Инструкция, Знач ТипВнешнейСистемы) Экспорт +``` + +Пример вызова +```bsl +ОбсужденияЛокализация.ПриЗаполненииИнструкцииДляПодключенияИнтеграции(Инструкция, ТипВнешнейСистемы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбщегоНазначения.md b/src/content/docs/bsp/ОбщегоНазначения.md new file mode 100644 index 0000000..e167038 --- /dev/null +++ b/src/content/docs/bsp/ОбщегоНазначения.md @@ -0,0 +1,5767 @@ +--- +title: Общего назначения +slug: bsp/общего-назначения +--- + + +## СообщитьПользователю +
+ +Описание, пример вызова + +```bsl + +// Формирует и выводит сообщение, которое может быть связано с элементом управления формы. +// +// В фоновом задании длительной операции, если вызов выполнен вне транзакции, +// сообщение записывается в служебный регистр и отправляется сразу на клиент, +// если подключена система взаимодействия. +// В конце фонового задания длительной операции, а также при отправке прогресса, +// все сообщения извлекаются из очереди сообщений фонового задания, +// записываются в служебный регистр и отправляются сразу на клиент, +// если подключена система взаимодействия. +// +// АПК:142-выкл 4 необязательных параметра для совместимости +// с устаревшей процедурой ОбщегоНазначенияКлиентСервер.СообщитьПользователю. +// +// Параметры: +// ТекстСообщенияПользователю - Строка - текст сообщения. +// КлючДанных - Произвольный - объект, ссылка или ключ записи информационной базы, к которому это сообщение относится. +// Поле - Строка - наименование реквизита формы. +// ПутьКДанным - Строка - путь к данным (путь к реквизиту формы). +// Отказ - Булево - выходной параметр, всегда устанавливается в значение Истина. +// +// Пример: +// +// 1. Для вывода сообщения у поля управляемой формы, связанного с реквизитом объекта: +// ОбщегоНазначения.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), , +// "ПолеВРеквизитеФормыОбъект", +// "Объект"); +// +// Альтернативный вариант использования в форме объекта: +// ОбщегоНазначения.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), , +// "Объект.ПолеВРеквизитеФормыОбъект"); +// +// 2. Для вывода сообщения рядом с полем управляемой формы, связанным с реквизитом формы: +// ОбщегоНазначения.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), , +// "ИмяРеквизитаФормы"); +// +// 3. Для вывода сообщения связанного с объектом информационной базы: +// ОбщегоНазначения.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), ОбъектИнформационнойБазы, "Ответственный",,Отказ); +// +// 4. Для вывода сообщения по ссылке на объект информационной базы: +// ОбщегоНазначения.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), Ссылка, , , Отказ); +// +// Случаи некорректного использования: +// 1. Передача одновременно параметров КлючДанных и ПутьКДанным. +// 2. Передача в параметре КлючДанных значения типа отличного от допустимого. +// 3. Установка ссылки без установки поля (и/или пути к данным). +// +Процедура СообщитьПользователю(Знач ТекстСообщенияПользователю, Знач КлючДанных = Неопределено, Знач Поле = "", Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.СообщитьПользователю(ТекстСообщенияПользователю, КлючДанных, Поле, ); +``` +
+ +## ЗначенияРеквизитовОбъекта +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Общие процедуры и функции для работы с данными в базе. + +// Возвращает структуру, содержащую значения реквизитов, прочитанные из информационной базы по ссылке на объект. +// Рекомендуется использовать вместо обращения к реквизитам объекта через точку от ссылки на объект +// для быстрого чтения отдельных реквизитов объекта из базы данных. +// +// Если необходимо зачитать реквизит независимо от прав текущего пользователя, +// то следует использовать предварительный переход в привилегированный режим. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - объект, значения реквизитов которого необходимо получить. +// - Строка - полное имя предопределенного элемента, значения реквизитов которого необходимо получить. +// Реквизиты - Строка - имена реквизитов, перечисленные через запятую, в формате +// требований к свойствам структуры. +// Например, "Код, Наименование, Родитель". +// - Структура +// - ФиксированнаяСтруктура - в качестве ключа передается +// псевдоним поля для возвращаемой структуры с результатом, а в качестве +// значения (опционально) фактическое имя поля в таблице. +// Если ключ задан, а значение не определено, то имя поля берется из ключа. +// Допускается указание имени поля через точку, но при этом параметр КодЯзыка для такого поля +// учитываться не будет. +// - Массив из Строка +// - ФиксированныйМассив из Строка - имена реквизитов в формате требований к свойствам структуры. +// ВыбратьРазрешенные - Булево - если Истина, то запрос к объекту выполняется с учетом прав пользователя; +// если есть ограничение на уровне записей, то все реквизиты вернутся со +// значением Неопределено; если нет прав для работы с таблицей, то возникнет исключение; +// если Ложь, то возникнет исключение при отсутствии прав на таблицу +// или любой из реквизитов. +// КодЯзыка - Строка - код языка для мультиязычного реквизита. Значение по умолчанию - основной язык конфигурации. +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных реквизитов. +// Если в параметр Реквизиты передана пустая строка, то возвращается пустая структура. +// Если в параметр Ссылка передана пустая ссылка, то возвращается структура, +// соответствующая именам реквизитов со значениями Неопределено. +// Если в параметр Ссылка передана ссылка несуществующего объекта (битая ссылка), +// то все реквизиты вернутся со значением Неопределено. +// +Функция ЗначенияРеквизитовОбъекта(Ссылка, Знач Реквизиты, ВыбратьРазрешенные = Ложь, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗначенияРеквизитовОбъекта(Ссылка, Реквизиты, ВыбратьРазрешенные, КодЯзыка); +``` +
+ +## ЗначениеРеквизитаОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает значения реквизита, прочитанного из информационной базы по ссылке на объект. +// Рекомендуется использовать вместо обращения к реквизитам объекта через точку от ссылки на объект +// для быстрого чтения отдельных реквизитов объекта из базы данных. +// +// Если необходимо зачитать реквизит независимо от прав текущего пользователя, +// то следует использовать предварительный переход в привилегированный режим. +// +// Если передано имя несуществующего реквизита, то вызывается исключение "Поле объекта не существует". +// +// Параметры: +// Ссылка - ЛюбаяСсылка - объект, значения реквизитов которого необходимо получить. +// - Строка - полное имя предопределенного элемента, значения реквизитов которого необходимо получить. +// ИмяРеквизита - Строка - имя получаемого реквизита. +// Допускается указание имени реквизита через точку, но при этом параметр КодЯзыка для +// такого реквизита учитываться не будет. +// ВыбратьРазрешенные - Булево - если Истина, то запрос к объекту выполняется с учетом прав пользователя; +// если есть ограничение на уровне записей, то возвращается Неопределено; +// если нет прав для работы с таблицей, то возникнет исключение; +// если Ложь, то возникнет исключение при отсутствии прав на таблицу +// или любой из реквизитов. +// КодЯзыка - Строка - код языка для мультиязычного реквизита. Значение по умолчанию - основной язык конфигурации. +// +// Возвращаемое значение: +// Произвольный - если в параметр Ссылка передана пустая ссылка, то возвращается Неопределено. +// Если в параметр Ссылка передана ссылка несуществующего объекта (битая ссылка), +// то возвращается Неопределено. +// +Функция ЗначениеРеквизитаОбъекта(Ссылка, ИмяРеквизита, ВыбратьРазрешенные = Ложь, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗначениеРеквизитаОбъекта(Ссылка, ИмяРеквизита, ВыбратьРазрешенные, КодЯзыка); +``` +
+ +## ЗначенияРеквизитовОбъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает значения реквизитов, прочитанные из информационной базы для нескольких объектов. +// Рекомендуется использовать вместо обращения к реквизитам объекта через точку от ссылки на объект +// для быстрого чтения отдельных реквизитов объекта из базы данных. +// +// Если необходимо зачитать реквизит независимо от прав текущего пользователя, +// то следует использовать предварительный переход в привилегированный режим. +// +// Если передано имя несуществующего реквизита, то вызывается исключение "Поле объекта не существует". +// +// Параметры: +// Ссылки - Массив из ЛюбаяСсылка +// - ФиксированныйМассив из ЛюбаяСсылка - ссылки на объекты. +// Если массив пуст, то результатом будет пустое соответствие. +// Реквизиты - Строка - имена реквизитов перечисленные через запятую, в формате требований к свойствам +// структуры. Например, "Код, Наименование, Родитель". +// - Массив из Строка +// - ФиксированныйМассив из Строка - имена реквизитов в формате требований к свойствам структуры. +// ВыбратьРазрешенные - Булево - если Истина, то запрос к объектам выполняется с учетом прав пользователя; +// если какой-либо объект будет исключен из выборки по правам, то этот объект +// будет исключен и из результата; +// если Ложь, то возникнет исключение при отсутствии прав на таблицу +// или любой из реквизитов. +// КодЯзыка - Строка - код языка для мультиязычного реквизита. Значение по умолчанию - основной язык конфигурации. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение - список объектов и значений их реквизитов: +// * Ключ - ЛюбаяСсылка - ссылка на объект; +// * Значение - Структура: +// ** Ключ - Строка - имя реквизита; +// ** Значение - Произвольный - значение реквизита. +// +Функция ЗначенияРеквизитовОбъектов(Ссылки, Знач Реквизиты, ВыбратьРазрешенные = Ложь, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗначенияРеквизитовОбъектов(Ссылки, Реквизиты, ВыбратьРазрешенные, КодЯзыка); +``` +
+ +## ЗначениеРеквизитаОбъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает значения реквизита, прочитанного из информационной базы для нескольких объектов. +// Рекомендуется использовать вместо обращения к реквизитам объекта через точку от ссылки на объект +// для быстрого чтения отдельных реквизитов объекта из базы данных. +// +// Если необходимо зачитать реквизит независимо от прав текущего пользователя, +// то следует использовать предварительный переход в привилегированный режим. +// +// Если передано имя несуществующего реквизита, то вызывается исключение "Поле объекта не существует". +// +// Параметры: +// МассивСсылок - Массив из ЛюбаяСсылка +// - ФиксированныйМассив из ЛюбаяСсылка +// ИмяРеквизита - Строка - например, "Код". +// ВыбратьРазрешенные - Булево - если Истина, то запрос к объектам выполняется с учетом прав пользователя; +// если какой-либо объект будет исключен из выборки по правам, то этот объект +// будет исключен и из результата; +// если Ложь, то возникнет исключение при отсутствии прав на таблицу +// или любой из реквизитов. +// КодЯзыка - Строка - код языка для мультиязычного реквизита. Значение по умолчанию - основной язык конфигурации. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ЛюбаяСсылка - ссылка на объект, +// * Значение - Произвольный - значение прочитанного реквизита. +// +Функция ЗначениеРеквизитаОбъектов(МассивСсылок, ИмяРеквизита, ВыбратьРазрешенные = Ложь, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗначениеРеквизитаОбъектов(МассивСсылок, ИмяРеквизита, ВыбратьРазрешенные, КодЯзыка); +``` +
+ +## УстановитьЗначениеРеквизита +
+ +Описание, пример вызова + +```bsl + +// Добавляет или изменяет значение реквизита в объекте. +// +// Если передано имя несуществующего реквизита, то вызывается исключение. +// +// Параметры: +// Объект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - РегистрСведенийЗапись - заполняемый объект. +// ИмяРеквизита - Строка - имя заполняемого реквизита. Например, "Комментарий" +// Значение - Строка - значение помещаемое в реквизит. +// КодЯзыка - Строка - код языка реквизита. Например, "ru". +// +Процедура УстановитьЗначениеРеквизита(Объект, ИмяРеквизита, Значение, КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.УстановитьЗначениеРеквизита(Объект, ИмяРеквизита, Значение, КодЯзыка); +``` +
+ +## УстановитьЗначенияРеквизитов +
+ +Описание, пример вызова + +```bsl + +// Добавляет или изменяет значения реквизитов в объекте. +// +// Если передано имя несуществующего реквизита, то вызывается исключение. +// +// Параметры: +// Объект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - РегистрСведенийЗапись - заполняемый объект. +// Значения - Структура - где ключ это имя реквизита, а значение содержит строку помещаемую в реквизит. +// КодЯзыка - Строка - код языка реквизита. Например, "ru". +// +Процедура УстановитьЗначенияРеквизитов(Объект, Значения, КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.УстановитьЗначенияРеквизитов(Объект, Значения, КодЯзыка); +``` +
+ +## КодОсновногоЯзыка +
+ +Описание, пример вызова + +```bsl + +// Возвращает код основного языка информационной базы, например "ru". +// На котором программно записываются автогенерируемые строки в информационную базу. +// Например, при начальном заполнении информационной базы данными из макета, автогенерации комментария +// к проводке или определении значения параметра ИмяСобытия метода ЗаписьЖурналаРегистрации. +// +// Возвращаемое значение: +// Строка +// +Функция КодОсновногоЯзыка() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.КодОсновногоЯзыка() +``` +
+ +## ЭтоОсновнойЯзык +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, что для пользователя установлен язык интерфейса +// соответствующий основному языку информационной базы. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоОсновнойЯзык() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоОсновнойЯзык() +``` +
+ +## ПредопределенныйЭлемент +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку предопределенного элемента по его полному имени в следующих объектах: +// - справочники; +// - планы видов характеристик; +// - планы счетов; +// - планы видов расчета. +// См. также функцию ОбщегоНазначенияКлиент.ПредопределенныйЭлемент. +// +// Для корректной работы этой функции после изменения состава предопределенных следует вызывать +// метод ОбновитьПовторноИспользуемыеЗначения. +// +// Параметры: +// ПолноеИмяПредопределенного - Строка - полное имя предопределенного элемента. +// Формат аналогичен функции глобального контекста ПредопределенноеЗначение, например: +// "Справочник.ВидыКонтактнойИнформации.EmailПользователя" +// "ПланСчетов.Хозрасчетный.Материалы" +// "ПланВидовРасчета.Начисления.ОплатаПоОкладу". +// +// Возвращаемое значение: +// ЛюбаяСсылка - ссылка на предопределенный элемент. +// Неопределено - если предопределенного элемента нет в метаданных или не создан в информационной базе. +// +Функция ПредопределенныйЭлемент(ПолноеИмяПредопределенного) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПредопределенныйЭлемент(ПолноеИмяПредопределенного) +``` +
+ +## ЭтоПредопределенныеЭлементы +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о том, являются ли переданные элементы предопределенными. +// Если нет прав доступа на уровне записей, то элемент не включается в результат. +// Если нет прав доступа к таблице, то вызывается исключение. +// +// Параметры: +// Элементы - Массив из ЛюбаяСсылка +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение - список объектов и значений их реквизитов: +// * Ключ - ЛюбаяСсылка - ссылка на объект. +// * Значение - Булево - Истина, если это ссылка на предопределенный элемент. +// +Функция ЭтоПредопределенныеЭлементы(Знач Элементы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоПредопределенныеЭлементы(Элементы) +``` +
+ +## ПроверитьПроведенностьДокументов +
+ +Описание, пример вызова + +```bsl + +// Проверяет статус проведения переданных документов и возвращает +// те из них, которые не проведены. +// +// Параметры: +// Документы - Массив из ДокументСсылка - документы, статус проведения которых необходимо проверить. +// +// Возвращаемое значение: +// Массив из ДокументСсылка - непроведенные документы. +// +Функция ПроверитьПроведенностьДокументов(Знач Документы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПроверитьПроведенностьДокументов(Документы) +``` +
+ +## ПровестиДокументы +
+ +Описание, пример вызова + +```bsl + +// Выполняет попытку проведения документов и возвращает информацию о документах, которые не удалось провести. +// +// Параметры: +// Документы - Массив из ДокументСсылка - документы, которые необходимо провести. +// +// Возвращаемое значение: +// Массив из Структура: +// * Ссылка - ДокументСсылка - документ, который не удалось провести, +// * ОписаниеОшибки - Строка - текст описания ошибки при проведении. +// +Функция ПровестиДокументы(Документы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПровестиДокументы(Документы) +``` +
+ +## ЕстьСсылкиНаОбъект +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие ссылок на объект в базе данных. +// При вызове в неразделенном сеансе не выявляет ссылок в разделенных областях. +// +// Параметры: +// СсылкаИлиМассивСсылок - ЛюбаяСсылка +// - Массив из ЛюбаяСсылка - объект или список объектов. +// ИскатьСредиСлужебныхОбъектов - Булево - если Истина, то не будут учитываться +// исключения поиска ссылок, заданные при разработке конфигурации. +// Про исключение поиска ссылок см. подробнее +// ОбщегоНазначенияПереопределяемый.ПриДобавленииИсключенийПоискаСсылок. +// +// Возвращаемое значение: +// Булево - Истина, если есть ссылки на объект. +// +Функция ЕстьСсылкиНаОбъект(Знач СсылкаИлиМассивСсылок, Знач ИскатьСредиСлужебныхОбъектов = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЕстьСсылкиНаОбъект(СсылкаИлиМассивСсылок, ИскатьСредиСлужебныхОбъектов); +``` +
+ +## СлужебныеСвязиДанных +
+ +Описание, пример вызова + +```bsl + +// Определяет, указаны ли места использования в исключениях поиска ссылок. +// +// Параметры: +// МестаИспользования - ТаблицаЗначений - результат функции НайтиПоСсылкам: +// * Ссылка - ЛюбаяСсылка - проверяемая ссылка. +// * Данные - ЛюбаяСсылка - место использования. +// * Метаданные - ОбъектМетаданных - метаданные места использования. +// ИсключенияПоискаСсылок - см. ИсключенияПоискаСсылок +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СтрокаТаблицыЗначений +// * Значение - Булево - всегда Истина. Если это не служебная связь данных, то в соответствии нет элемента. +// +Функция СлужебныеСвязиДанных(Знач МестаИспользования, Знач ИсключенияПоискаСсылок = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СлужебныеСвязиДанных(МестаИспользования, ИсключенияПоискаСсылок); +``` +
+ +## ЭтоСлужебнаяСвязьДанных +
+ +Описание, пример вызова + +```bsl + +// Определяет, указано ли место использования в исключениях поиска ссылок. +// +// Параметры: +// МестоИспользования - Структура: +// * Ссылка - ЛюбаяСсылка - проверяемая ссылка. +// * Данные - ЛюбаяСсылка - место использования. +// * Метаданные - ОбъектМетаданных - метаданные места использования. +// ИсключенияПоискаСсылок - см. ИсключенияПоискаСсылок +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоСлужебнаяСвязьДанных(Знач МестоИспользования, Знач ИсключенияПоискаСсылок = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоСлужебнаяСвязьДанных(МестоИспользования, ИсключенияПоискаСсылок); +``` +
+ +## ЗаменитьСсылки +
+ +Описание, пример вызова + +```bsl + +// Производит замену ссылок во всех данных. После замены неиспользуемые ссылки опционально удаляются. +// Замена ссылок происходит с транзакциями по изменяемому объекту и его связям, не по анализируемой ссылке. +// При вызове в неразделенном сеансе не выявляет ссылок в разделенных областях. +// Если описаны связи подчиненных и основных объектов (см. СвязиПодчиненныхОбъектов), то: +// * при замене основных объектов будет выполнен поиск замен подчиненных объектов; +// * если ВыполнятьАвтоматическийПоискЗамен = Истина, то будет выполнена попытка поиска замен для подчиненных объектов +// по значениям полей связи. В случае, если объект не существует, будет выполнена процедура ПриПоискеЗаменыСсылок; +// * если МетодПоиска в описании связей задан, то если автоматический поиск не нашел замен +// или не выполнялся, будет вызван МетодПоиска для подбора замен. +// +// Параметры: +// ПарыЗамен - Соответствие из КлючИЗначение: +// * Ключ - ЛюбаяСсылка - что ищем (дубль). +// * Значение - ЛюбаяСсылка - на что заменяем (оригинал). +// Ссылки сами на себя и пустые ссылки для поиска будут проигнорированы. +// +// ПараметрыЗамены - см. ОбщегоНазначения.ПараметрыЗаменыСсылок +// +// Возвращаемое значение: +// ТаблицаЗначений - неуспешные замены (ошибки): +// * Ссылка - ЛюбаяСсылка - ссылка, которую заменяли. +// * ОбъектОшибки - Произвольный - объект-причина ошибки. +// * ПредставлениеОбъектаОшибки - Строка - строковое представление объекта ошибки. +// * ТипОшибки - Строка - тип ошибки: +// "ОшибкаБлокировки" - при замене в объекте данные были заблокированы другим сеансом. +// "ДанныеИзменены" - в процессе замены данные были изменены другим пользователем. +// "ОшибкаЗаписи" - не удалось записать объект, или метод ВозможностьЗаменыЭлементов вернул отказ. +// "ОшибкаУдаления" - не удалось удалить объект. +// "НеизвестныеДанные" - при обработке были найдены данные, которые не планировались к замене. +// * ИнформацияОбОшибке - ИнформацияОбОшибке +// * ТекстОшибки - Строка - если свойство ИнформацияОбОшибке содержит Неопределено, то описание причины. +// +Функция ЗаменитьСсылки(Знач ПарыЗамен, Знач ПараметрыЗамены = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗаменитьСсылки(ПарыЗамен, ПараметрыЗамены); +``` +
+ +## ПараметрыЗаменыСсылок +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры для параметра ПараметрыЗамены функции ОбщегоНазначения.ЗаменитьСсылки. +// +// Возвращаемое значение: +// Структура: +// * СпособУдаления - Строка - указывает, что делать с дублем после успешной замены: +// "" - не предпринимать никаких действий (по умолчанию); +// "Пометка" - помечать на удаление; +// "Непосредственно" - удалять непосредственно. +// * УчитыватьПрикладныеПравила - Булево - если Истина, то для каждой пары "дубль-оригинал" +// вызывается функция ВозможностьЗаменыЭлементов модуля менеджера +// (требуется подсистема "Поиск и удаление дублей"). По умолчанию, Ложь. +// * ВключатьБизнесЛогику - Булево - режим записи объектов при замене в них ссылок дублей на оригиналы. +// Если Истина (по умолчанию), то места использования дублей записываются в обычном режиме, +// иначе запись ведется в режиме ОбменДанными.Загрузка = Истина. +// * ЗаменаПарыВТранзакции - Булево - устарел. определяет размер транзакции при замене дублей. +// Если Истина (по умолчанию), то все места использования одного дубля заменяются в одной транзакции. +// Это может быть очень ресурсоемко в случае большого количества мест использований. +// Если Ложь, то замена в каждом месте использования выполняется в отдельной транзакции. +// * ПривилегированнаяЗапись - Булево - если Истина, то устанавливать привилегированный режим перед запись +// объектов при замене в них ссылок дублей на оригиналы. По умолчанию Ложь. +// +Функция ПараметрыЗаменыСсылок() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПараметрыЗаменыСсылок() +``` +
+ +## МестаИспользования +
+ +Описание, пример вызова + +```bsl + +// Получает все места использования ссылок. +// Если какая-либо ссылка нигде не используется, то строк для нее в результирующей таблице не будет. +// При вызове в неразделенном сеансе не выявляет ссылок в разделенных областях. +// +// Параметры: +// НаборСсылок - Массив из ЛюбаяСсылка - ссылки, для которых ищем места использования. +// АдресРезультата - Строка - адрес во временном хранилище, куда будет помещен копия результата замены. +// ДополнительныеПараметры - см. ОбщегоНазначения.ПараметрыПоискаМестИспользования +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Ссылка - ЛюбаяСсылка - ссылка, которая анализируется. +// * Данные - Произвольный - данные, содержащие анализируемую ссылку. +// * Метаданные - ОбъектМетаданных - метаданные найденных данных. +// * ПредставлениеДанных - Строка - представление данных, содержащих анализируемую ссылку. +// * ТипСсылки - Тип - тип анализируемой ссылки. +// * ВспомогательныеДанные - Булево - Истина, если данные используются анализируемой ссылкой как +// вспомогательные данные (ведущее измерение или попали в исключение ПриДобавленииИсключенийПоискаСсылок). +// * ЭтоСлужебныеДанные - Булево - данные попали в исключение ПриДобавленииИсключенийПоискаСсылок +// +Функция МестаИспользования(Знач НаборСсылок, Знач АдресРезультата = "", ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.МестаИспользования(НаборСсылок, АдресРезультата, ДополнительныеПараметры); +``` +
+ +## ПараметрыПоискаМестИспользования +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру для параметра ДополнительныеПараметры функции ОбщегоНазначения.МестаИспользования. +// +// Возвращаемое значение: +// Структура: +// * ДополнительныеИсключенияПоискаСсылок - Соответствие - позволяет расширить исключения поиска ссылок +// см. ОбщегоНазначенияПереопределяемый.ПриДобавленииИсключенийПоискаСсылок +// * ОтменаИсключенийПоискаСсылок - Массив из ОбъектМетаданных - полностью отменяет исключения поиска ссылок для +// объектов метаданных. +// +Функция ПараметрыПоискаМестИспользования() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПараметрыПоискаМестИспользования() +``` +
+ +## ИсключенияПоискаСсылок +
+ +Описание, пример вызова + +```bsl + +// Возвращает исключения при поиске мест использования объектов. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение - исключения поиска ссылок в разрезе объектов метаданных: +// * Ключ - ОбъектМетаданных - объект метаданных, для которого применяются исключения. +// * Значение - Строка +// - Массив из Строка - описание исключенных реквизитов. +// Если "*", то исключены все реквизиты объекта метаданных. +// Если массив строк, то содержит относительные имена исключенных реквизитов. +// +Функция ИсключенияПоискаСсылок() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИсключенияПоискаСсылок() +``` +
+ +## ПодчиненныеОбъекты +
+ +Описание, пример вызова + +```bsl + +// Возвращает связи подчиненных объектов и перечень реквизитов, по которым осуществляется связь. +// +// Есть возможность переопределить процедуру поиска подчиненных объектов. +// Для этого в общем модуле или модуле менеджера необходимо реализовать процедуру +// ПриПоискеЗаменыСсылок с параметрами: +// ПарыЗамен - Соответствие - содержит пары значение оригинал/дубль. +// НеобработанныеЗначенияОригиналов - Массив из Структура - дополнительная информация об обрабатываемых объектах: +// * ЗаменяемоеЗначение - ПроизвольнаяСсылка - оригинальное значение заменяемого объекта. +// * ИспользуемыеСвязи - см. ОбщегоНазначения.СвязиПодчиненныхОбъектовПоТипам +// * ЗначениеКлючевыхРеквизитов - Структура - где Ключ - имя реквизита, значение - значение реквизита. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ПодчиненныйОбъект - ОбъектМетаданных - объект метаданных подчиненного объекта. +// * ПоляСвязей - Строка - имена реквизитов, определяющих связь между основными и подчиненными объектами. +// * ПриПоискеЗаменыСсылок - Строка - опционально. Имя общего модуля или модуля менеджера, в котором определена +// процедура ПриПоискеЗаменыСсылок. +// * ВыполнятьАвтоматическийПоискЗаменСсылок - Булево - если указать Истина, то будет выполнена попытка поиска замен +// для подчиненных объектов по значениям полей связи. В случае, если объект не существует, +// будет выполнена процедура ПриПоискеЗаменыСсылок. См. также ЗаменитьСсылки. +// +Функция ПодчиненныеОбъекты() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПодчиненныеОбъекты() +``` +
+ +## СвязиПодчиненныхОбъектовПоТипам +
+ +Описание, пример вызова + +```bsl + +// Возвращает связи подчиненных объектов с указанием типа поля связи. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Ключ - Строка +// * ТипРеквизита - Тип +// * ИмяРеквизита - Строка +// * Используется - Булево +// * Метаданные - ОбъектМетаданных +// +Функция СвязиПодчиненныхОбъектовПоТипам() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СвязиПодчиненныхОбъектовПоТипам() +``` +
+ +## ПодсистемаСуществует +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для вызова необязательных подсистем. + +// Возвращает Истина, если функциональная подсистема существует в конфигурации. +// Предназначена для вызова необязательной подсистемы (условного вызова) совместно с ОбщегоНазначения.ОбщийМодуль. +// +// У функциональной подсистемы снят флажок "Включать в командный интерфейс". +// См. также ОбщегоНазначенияПереопределяемый.ПриОпределенииОтключенныхПодсистем +// и ОбщегоНазначенияКлиент.ПодсистемаСуществует для вызова из клиентского кода. +// +// Параметры: +// ПолноеИмяПодсистемы - Строка - полное имя объекта метаданных подсистема +// без слов "Подсистема." ИС учетом регистра символов. +// Например: "СтандартныеПодсистемы.ВариантыОтчетов". +// +// Пример: +// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ВариантыОтчетов") Тогда +// МодульВариантыОтчетов = ОбщегоНазначения.ОбщийМодуль("ВариантыОтчетов"); +// МодульВариантыОтчетов.<Имя процедуры>(); +// КонецЕсли; +// +// Возвращаемое значение: +// Булево +// +Функция ПодсистемаСуществует(ПолноеИмяПодсистемы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПодсистемаСуществует(ПолноеИмяПодсистемы) +``` +
+ +## ОбщийМодуль +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на общий модуль или модуль менеджера по имени. +// Применяется для условного вызова процедуры или функции совместно с ОбщегоНазначения.ПодсистемаСуществует. +// См. также ОбщегоНазначенияКлиент.ОбщийМодуль для вызова клиентского кода. +// +// Параметры: +// Имя - Строка - имя общего модуля или модуля менеджера, например "ОбновлениеКонфигурации", +// "Обработка.ПолнотекстовыйПоиск". +// +// Возвращаемое значение: +// ОбщийМодуль +// МодульМенеджераОбъекта +// +// Пример: +// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ОбновлениеКонфигурации") Тогда +// МодульОбновлениеКонфигурации = ОбщегоНазначения.ОбщийМодуль("ОбновлениеКонфигурации"); +// МодульОбновлениеКонфигурации.<Имя процедуры>(); +// КонецЕсли; +// +// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ПолнотекстовыйПоиск") Тогда +// МодульОбработкаПолнотекстовыйПоиск = ОбщегоНазначения.ОбщийМодуль("Обработка.ПолнотекстовыйПоиск"); +// МодульОбработкаПолнотекстовыйПоиск.<Имя процедуры>(); +// КонецЕсли; +// +Функция ОбщийМодуль(Имя) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОбщийМодуль(Имя) +``` +
+ +## ЭтоWindowsКлиент +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции описания текущего окружения клиентского приложения и операционной системы. + +// Возвращает Истина, если клиентское приложение запущено под управлением ОС Windows. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоWindowsКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоWindowsКлиент() +``` +
+ +## ЭтоWindowsСервер +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если текущий сеанс выполняется на сервере, работающем под управлением ОС Windows. +// +// Возвращаемое значение: +// Булево - Истина, если сервер работает под управлением ОС Windows. +// +Функция ЭтоWindowsСервер() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоWindowsСервер() +``` +
+ +## ЭтоLinuxКлиент +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если клиентское приложение запущено под управлением ОС Linux. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоLinuxКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоLinuxКлиент() +``` +
+ +## ЭтоLinuxСервер +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если текущий сеанс выполняется на сервере, работающем под управлением ОС Linux. +// +// Возвращаемое значение: +// Булево - Истина, если сервер работает под управлением ОС Linux. +// +Функция ЭтоLinuxСервер() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоLinuxСервер() +``` +
+ +## ЭтоMacOSКлиент +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если клиентское приложение запущено под управлением macОС. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоMacOSКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоMacOSКлиент() +``` +
+ +## ЭтоВебКлиент +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если клиентское приложение является Веб-клиентом. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоВебКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоВебКлиент() +``` +
+ +## ЭтоМобильныйКлиент +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если клиентское приложение является мобильным клиентом. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоМобильныйКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоМобильныйКлиент() +``` +
+ +## КлиентПодключенЧерезВебСервер +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если клиентское приложение подключено к базе через веб-сервер. +// +// Возвращаемое значение: +// Булево - Истина, если подключен. +// +Функция КлиентПодключенЧерезВебСервер() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.КлиентПодключенЧерезВебСервер() +``` +
+ +## СистемнаяИнформацияКлиента +
+ +Описание, пример вызова + +```bsl + +// Возвращает системную информацию клиента, если есть клиентское приложение. +// До первого серверного вызова с клиента вернет Неопределено. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * ВерсияОС - Строка +// * ВерсияПриложения - Строка +// * ИдентификаторКлиента - УникальныйИдентификатор +// * ИнформацияПрограммыПросмотра - Строка +// * ОперативнаяПамять - Число +// * Процессор - Строка +// * ТипПлатформы - см. ОбщегоНазначенияКлиентСервер.ИмяТипаПлатформы +// Неопределено - если нет клиентского приложения или информация запрашивается +// до первого серверного вызова, например, при первом вызове события +// платформы УстановкаПараметровСеанса в модуле сеанса. +// +Функция СистемнаяИнформацияКлиента() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СистемнаяИнформацияКлиента() +``` +
+ +## ИспользуемыйКлиент +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя используемого клиента, а для веб-браузера название и версию, если есть. +// До первого серверного вызова с клиента вернет Неопределено. +// +// Возвращаемое значение: +// Строка - варианты строк "ВебКлиент.<Название>[.<Версия>]", "ТонкийКлиент", +// "ТолстыйКлиентУправляемоеПриложение", "ТолстыйКлиентОбычноеПриложение", +// где <Название> - варианты строк "Chrome", "Firefox", "Safari", "IE", "Opera" +// или "Другой", когда не определен (ни один из указанных), например "ВебКлиент.Chrome.109". +// Неопределено - если нет клиентского приложения или информация запрашивается +// до первого серверного вызова, например, при первом вызове события +// платформы УстановкаПараметровСеанса в модуле сеанса. +// +Функция ИспользуемыйКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИспользуемыйКлиент() +``` +
+ +## РежимОтладки +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если включен режим отладки. +// +// Возвращаемое значение: +// Булево - Истина, если включен режим отладки. +// +Функция РежимОтладки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.РежимОтладки() +``` +
+ +## ОперативнаяПамятьДоступнаяКлиентскомуПриложению +
+ +Описание, пример вызова + +```bsl + +// Возвращает объем оперативной памяти, доступной клиентскому приложению. +// +// Возвращаемое значение: +// Число - количество гигабайтов оперативной памяти с точностью до десятых долей. +// Неопределено - нет клиентского приложения, то есть ТекущийРежимЗапуска() = Неопределено. +// +Функция ОперативнаяПамятьДоступнаяКлиентскомуПриложению() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОперативнаяПамятьДоступнаяКлиентскомуПриложению() +``` +
+ +## ИнформационнаяБазаФайловая +
+ +Описание, пример вызова + +```bsl + +// Определяет режим эксплуатации информационной базы файловый (Истина) или серверный (Ложь). +// При проверке используется СтрокаСоединенияИнформационнойБазы, которую можно указать явно. +// +// Параметры: +// СтрокаСоединенияИнформационнойБазы - Строка - параметр используется, если +// нужно проверить строку соединения не текущей информационной базы. +// +// Возвращаемое значение: +// Булево - Истина, если файловая. +// +Функция ИнформационнаяБазаФайловая(Знач СтрокаСоединенияИнформационнойБазы = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИнформационнаяБазаФайловая(СтрокаСоединенияИнформационнойБазы); +``` +
+ +## ЭтоАвтономноеРабочееМесто +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если эта информационная база подключена к 1С:Fresh. +// +// Возвращаемое значение: +// Булево - признак автономного рабочего места. +// +Функция ЭтоАвтономноеРабочееМесто() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоАвтономноеРабочееМесто() +``` +
+ +## ЭтоРаспределеннаяИнформационнаяБаза +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, что информационная база является распределенной (РИБ). +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоРаспределеннаяИнформационнаяБаза() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоРаспределеннаяИнформационнаяБаза() +``` +
+ +## ЭтоПодчиненныйУзелРИБ +
+ +Описание, пример вызова + +```bsl + +// Определяет, что эта информационная база является подчиненным узлом +// распределенной информационной базы (РИБ). +// +// Возвращаемое значение: +// Булево - Истина, если эта информационная база является подчиненным узлом РИБ. +// +Функция ЭтоПодчиненныйУзелРИБ() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоПодчиненныйУзелРИБ() +``` +
+ +## ЭтоПодчиненныйУзелРИБСФильтром +
+ +Описание, пример вызова + +```bsl + +// Определяет, что эта информационная база является подчиненным узлом +// распределенной информационной базы (РИБ) с фильтром. +// +// Возвращаемое значение: +// Булево - Истина, если эта информационная база является подчиненным узлом РИБ с фильтром. +// +Функция ЭтоПодчиненныйУзелРИБСФильтром() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоПодчиненныйУзелРИБСФильтром() +``` +
+ +## ТребуетсяОбновлениеКонфигурацииПодчиненногоУзлаРИБ +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина при необходимости обновления конфигурации информационной базы подчиненного узла РИБ. +// В главном узле всегда Ложь. +// +// Возвращаемое значение: +// Булево - Истина, если требуется. +// +Функция ТребуетсяОбновлениеКонфигурацииПодчиненногоУзлаРИБ() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ТребуетсяОбновлениеКонфигурацииПодчиненногоУзлаРИБ() +``` +
+ +## РазделениеВключено +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак работы в режиме разделения данных по областям +// (технически это признак условного разделения). +// +// Возвращает Ложь, если конфигурация не может работать в режиме разделения данных +// (не содержит общих реквизитов, предназначенных для разделения данных). +// +// Возвращаемое значение: +// Булево - Истина, если разделение включено, +// Ложь, если разделение выключено или не поддерживается. +// +Функция РазделениеВключено() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.РазделениеВключено() +``` +
+ +## ДоступноИспользованиеРазделенныхДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак возможности обращения к разделенным данным (которые входят в состав разделителей). +// Признак относится к сеансу, но может меняться во время работы сеанса, если разделение было включено +// в самом сеансе, поэтому проверку следует делать непосредственно перед обращением к разделенным данным. +// +// Возвращает Истина, если конфигурация не может работать в режиме разделения данных +// (не содержит общих реквизитов, предназначенных для разделения данных). +// +// Возвращаемое значение: +// Булево - Истина, если разделение не поддерживается, либо разделение выключено, +// либо разделение включено и разделители установлены. +// Ложь, если разделение включено и разделители не установлены. +// +Функция ДоступноИспользованиеРазделенныхДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ДоступноИспользованиеРазделенныхДанных() +``` +
+ +## АдресПубликацииИнформационнойБазыВИнтернете +
+ +Описание, пример вызова + +```bsl + +// Возвращает адрес публикации информационной базы для формирования прямых ссылок на объекты ИБ +// для возможности перехода к ним пользователей, имеющих доступ к базе через публикацию в сети Интернет. +// Например, если такой адрес включить в электронное письмо, то из письма одним нажатием +// можно перейти к форме объекта в самой программе. +// +// Возвращаемое значение: +// Строка - адрес информационной базы, как он задан в настройке "Адрес в Интернете" в панели администрирования +// (хранится в константе АдресПубликацииИнформационнойБазыВИнтернете). +// Например, "HTTP://1c.com/database". +// +// Пример: +// ОбщегоНазначения.АдресПубликацииИнформационнойБазыВЛокальнойСети() + "/" + e1cib/app/Обработка.ВыгрузкаДанныхПроекта"; +// возвращает прямую ссылку для открытия обработки ВыгрузкаДанныхПроекта. +// +Функция АдресПубликацииИнформационнойБазыВИнтернете() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.АдресПубликацииИнформационнойБазыВИнтернете() +``` +
+ +## АдресПубликацииИнформационнойБазыВЛокальнойСети +
+ +Описание, пример вызова + +```bsl + +// Возвращает адрес публикации информационной базы для формирования прямых ссылок на объекты ИБ +// для возможности перехода к ним пользователей, имеющих доступ к базе через публикацию локальной сети. +// Например, если такой адрес включить в электронное письмо, то из письма за одно нажатие +// можно перейти к форме объекта в самой программе. +// +// При работе в приложении в Интернете возвращает значение функции АдресПубликацииИнформационнойБазыВИнтернете. +// +// Возвращаемое значение: +// Строка - адрес информационной базы, как он задан в настройке "Локальный адрес" в панели администрирования +// (хранится в константе АдресПубликацииИнформационнойБазыВЛокальнойСети). +// Например, "HTTP://localserver/base". +// +// Пример: +// ОбщегоНазначения.АдресПубликацииИнформационнойБазыВЛокальнойСети() + "/" + e1cib/app/Обработка.ВыгрузкаДанныхПроекта"; +// возвращает прямую ссылку для открытия обработки ВыгрузкаДанныхПроекта. +// +Функция АдресПубликацииИнформационнойБазыВЛокальнойСети() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.АдресПубликацииИнформационнойБазыВЛокальнойСети() +``` +
+ +## АдресВходаВПрограмму +
+ +Описание, пример вызова + +```bsl + +// Формирует ссылку для входа в программу для указанного пользователя. +// +// Параметры: +// Пользователь - Строка - логин пользователя для входа в программу; +// Пароль - Строка - пароль пользователя для входа в программу; +// ВидПубликацииИБ - Строка - через какую публикацию пользователь входит в программу: +// "ВИнтернете" или "ВЛокальнойСети". +// +// Возвращаемое значение: +// Строка, Неопределено - адрес входа в программу или Неопределено, если адрес не настроен. +// +Функция АдресВходаВПрограмму(Пользователь, Пароль, ВидПубликацииИБ) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.АдресВходаВПрограмму(Пользователь, Пароль, ВидПубликацииИБ) +``` +
+ +## РедакцияКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Возвращает редакцию конфигурации. +// Редакцией принято называть две первые группы цифр полной версии конфигурации. +// Например, у версии "1.2.3.4" редакция "1.2". +// +// Возвращаемое значение: +// Строка - номер редакции конфигурации. +// +Функция РедакцияКонфигурации() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.РедакцияКонфигурации() +``` +
+ +## ОбщиеПараметрыБазовойФункциональности +
+ +Описание, пример вызова + +```bsl + +// Возвращает общие параметры работы. +// +// Параметры: +// ВернутьЗакешированноеЗначение - Булево - служебный параметр. +// +// Возвращаемое значение: +// см. ОбщегоНазначенияПереопределяемый.ПриОпределенииОбщихПараметровБазовойФункциональности.ОбщиеПараметры +// +Функция ОбщиеПараметрыБазовойФункциональности(ВернутьЗакешированноеЗначение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОбщиеПараметрыБазовойФункциональности(ВернутьЗакешированноеЗначение); +``` +
+ +## ОписанияПодсистем +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания всех библиотек конфигурации, включая +// описание самой конфигурации. +// +// Возвращаемое значение: +// Массив - структур со свойствами: +// * Имя - Строка - имя подсистемы, например, "СтандартныеПодсистемы". +// * ИдентификаторИнтернетПоддержки - Строка - уникальное имя программы в сервисах интернет-поддержки. +// * Версия - Строка - версия в формате из четырех цифр, например "2.3.3.1". +// * ЭтоКонфигурация - Булево - признак того, что данная подсистема является основной конфигурацией. +// +Функция ОписанияПодсистем() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОписанияПодсистем() +``` +
+ +## ИдентификаторИнтернетПоддержкиКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификатор Интернет-поддержки основной конфигурации. +// +// Возвращаемое значение: +// Строка - уникальное имя программы в сервисах Интернет-поддержки. +// +Функция ИдентификаторИнтернетПоддержкиКонфигурации() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИдентификаторИнтернетПоддержкиКонфигурации() +``` +
+ +## ПредставлениеЛокальнойДатыСоСмещением +
+ +Описание, пример вызова + +```bsl + +// Преобразует локальную дату к формату "YYYY-MM-DDThh:mm:ssTZD" согласно ISO 8601. +// +// Параметры: +// ЛокальнаяДата - Дата - дата в часовом поясе сеанса. +// +// Возвращаемое значение: +// Строка - представление даты. +// +Функция ПредставлениеЛокальнойДатыСоСмещением(ЛокальнаяДата) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПредставлениеЛокальнойДатыСоСмещением(ЛокальнаяДата) +``` +
+ +## ИнтервалВремениСтрокой +
+ +Описание, пример вызова + +```bsl + +// Возвращает строковое представление интервала между переданными датами или +// относительно переданной даты и текущей даты сеанса. +// +// Параметры: +// ВремяНачала - Дата - начальная точка интервала. +// ВремяОкончания - Дата - конечная точка интервала. Если не задана, берется текущая дата сеанса. +// +// Возвращаемое значение: +// Строка - представление интервала времени. Пустая строка, если ВремяНачала больше ВремяОкончания. +// +Функция ИнтервалВремениСтрокой(Знач ВремяНачала, Знач ВремяОкончания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИнтервалВремениСтрокой(ВремяНачала, ВремяОкончания); +``` +
+ +## УстановитьРабочуюДатуПользователя +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройку рабочей даты пользователя. +// +// Параметры: +// НоваяРабочаяДата - Дата - дата, которую необходимо установить в качестве рабочей даты пользователя. +// ИмяПользователя - Строка - имя пользователя, для которого устанавливается рабочая дата. +// Если не задано, то устанавливается для текущего пользователя. +// +Процедура УстановитьРабочуюДатуПользователя(НоваяРабочаяДата, ИмяПользователя = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.УстановитьРабочуюДатуПользователя(НоваяРабочаяДата, ИмяПользователя); +``` +
+ +## РабочаяДатаПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает значение настройки рабочей даты для пользователя. +// +// Параметры: +// ИмяПользователя - Строка - имя пользователя, для которого запрашивается рабочая дата. +// Если не задано, то устанавливается для текущего пользователя. +// +// Возвращаемое значение: +// Дата - значение настройки рабочей даты пользователя или пустая дата, если настройка не задана. +// +Функция РабочаяДатаПользователя(ИмяПользователя = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.РабочаяДатаПользователя(ИмяПользователя); +``` +
+ +## ТекущаяДатаПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает значение настройки рабочей даты для пользователя или текущей даты сеанса, +// если рабочая дата пользователя не задана. +// +// Параметры: +// ИмяПользователя - Строка - имя пользователя, для которого запрашивается рабочая дата. +// Если не задано, то устанавливается для текущего пользователя. +// +// Возвращаемое значение: +// Дата - значение настройки рабочей даты пользователя или текущая дата сеанса, если настройка не задана. +// +Функция ТекущаяДатаПользователя(ИмяПользователя = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ТекущаяДатаПользователя(ИмяПользователя); +``` +
+ +## ИмяЗначенияПеречисления +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Общие процедуры и функции для работы с прикладными типами и коллекциями значений. + +// Возвращает строковое имя значения перечисления по его ссылке. +// Вызывает исключение, если передано несуществующее значение перечисления +// (например, удаленное в конфигурации или от отключенного расширения конфигурации). +// +// Параметры: +// Значение - ПеречислениеСсылка - значение, для которого необходимо получить имя перечисления. +// +// Возвращаемое значение: +// Строка +// +// Пример: +// В результат будет помещено строковое значение "ФизическоеЛицо": +// Результат = ОбщегоНазначения.ИмяЗначенияПеречисления(Перечисления.ЮридическоеФизическоеЛицо.ФизическоеЛицо); +// +Функция ИмяЗначенияПеречисления(Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИмяЗначенияПеречисления(Значение) +``` +
+ +## УдалитьНепроверяемыеРеквизитыИзМассива +
+ +Описание, пример вызова + +```bsl + +// Процедура удаляет из массива МассивРеквизитов элементы, соответствующие именам +// реквизитов объекта из массива МассивНепроверяемыхРеквизитов. +// Для использования в обработчиках события ОбработкаПроверкиЗаполнения. +// +// Параметры: +// МассивРеквизитов - Массив - коллекция имен реквизитов объекта. +// МассивНепроверяемыхРеквизитов - Массив - коллекция имен реквизитов объекта, не требующих проверки. +// +Процедура УдалитьНепроверяемыеРеквизитыИзМассива(МассивРеквизитов, МассивНепроверяемыхРеквизитов) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.УдалитьНепроверяемыеРеквизитыИзМассива(МассивРеквизитов, МассивНепроверяемыхРеквизитов) +``` +
+ +## ТаблицаЗначенийВМассив +
+ +Описание, пример вызова + +```bsl + +// Преобразует таблицу значений в массив структур. +// Может использоваться для передачи на клиент данных в том случае, если таблица +// значений содержит только такие значения, которые могут +// быть переданы с сервера на клиент. +// +// Полученный массив содержит структуры, каждая из которых повторяет +// структуру колонок таблицы значений. +// +// Не рекомендуется использовать для преобразования таблиц значений +// с большим количеством строк. +// +// Параметры: +// ТаблицаЗначений - ТаблицаЗначений - исходная таблица значений. +// +// Возвращаемое значение: +// Массив - коллекция строк таблицы в виде структур. +// +Функция ТаблицаЗначенийВМассив(ТаблицаЗначений) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ТаблицаЗначенийВМассив(ТаблицаЗначений) +``` +
+ +## СтрокаТаблицыЗначенийВСтруктуру +
+ +Описание, пример вызова + +```bsl + +// Преобразует строку таблицы значений в структуру. +// Свойства структуры и их значения совпадают с колонками переданной строки. +// +// Параметры: +// СтрокаТаблицыЗначений - СтрокаТаблицыЗначений +// +// Возвращаемое значение: +// Структура - преобразованная строка таблицы значений. +// +Функция СтрокаТаблицыЗначенийВСтруктуру(СтрокаТаблицыЗначений) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СтрокаТаблицыЗначенийВСтруктуру(СтрокаТаблицыЗначений) +``` +
+ +## СтруктураПоМенеджеруЗаписи +
+ +Описание, пример вызова + +```bsl + +// Создает структуру, содержащую имена и значения измерений, ресурсов и реквизитов +// переданного менеджера записи регистра сведений. +// +// Параметры: +// МенеджерЗаписи - РегистрСведенийМенеджерЗаписиИмяРегистраСведений - менеджер записи, из которого надо получить структуру. +// МетаданныеРегистра - ОбъектМетаданныхРегистрСведений - метаданные регистра сведений. +// +// Возвращаемое значение: +// Структура - коллекция измерений ресурсов и реквизитов, переданного менеджеру записи. +// +Функция СтруктураПоМенеджеруЗаписи(МенеджерЗаписи, МетаданныеРегистра) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СтруктураПоМенеджеруЗаписи(МенеджерЗаписи, МетаданныеРегистра) +``` +
+ +## ВыгрузитьКолонку +
+ +Описание, пример вызова + +```bsl + +// Создает массив и копирует в него значения, содержащиеся в колонке объекта, для +// которого доступен обход посредством оператора Для каждого … Из. +// +// Параметры: +// КоллекцияСтрок - ТаблицаЗначений +// - ДеревоЗначений +// - СписокЗначений +// - ТабличнаяЧасть +// - Соответствие +// - Структура - коллекция, колонку которой нужно выгрузить в массив. +// А так же другие объекты, для которых доступен обход +// посредством оператора Для каждого … Из … Цикл. +// ИмяКолонки - Строка - имя поля коллекции, значения которого нужно выгрузить. +// ТолькоУникальныеЗначения - Булево - если Истина, то в массив будут включены +// только различающиеся значения. +// +// Возвращаемое значение: +// Массив - значения колонки. +// +Функция ВыгрузитьКолонку(КоллекцияСтрок, ИмяКолонки, ТолькоУникальныеЗначения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ВыгрузитьКолонку(КоллекцияСтрок, ИмяКолонки, ТолькоУникальныеЗначения); +``` +
+ +## ПрочитатьXMLВТаблицу +
+ +Описание, пример вызова + +```bsl + +// Преобразует текст указанного формата XML в таблицу значений, +// при этом колонки таблицы формируются на основе описания в XML. +// +// Схема XML: +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// Параметры: +// XML - Строка +// - ЧтениеXML - текст в формате XML или ЧтениеXML. +// +// Возвращаемое значение: +// Структура: +// * ИмяТаблицы - Строка - имя таблицы. +// * Данные - ТаблицаЗначений - преобразованная из XML таблица. +// +// Пример: +// КлассификаторТаблица = ОбщегоНазначения.ПрочитатьXMLВТаблицу( +// Обработки.ЗагрузкаКурсовВалют.ПолучитьМакет("ОбщероссийскийКлассификаторВалют").ПолучитьТекст()).Данные; +// +Функция ПрочитатьXMLВТаблицу(Знач XML) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПрочитатьXMLВТаблицу(XML) +``` +
+ +## КоллекцииИдентичны +
+ +Описание, пример вызова + +```bsl + +// Сравнивает две коллекции строк (ТаблицаЗначений, ДеревоЗначений и т.д.), +// для которых доступен обход посредством оператора Для каждого … Из … Цикл. +// Сравниваемые коллекции должны отвечать следующим требованиям: +// - доступен обход посредством оператора Для каждого … Из … Цикл, +// - наличие в обеих коллекциях всех колонок, перечисленных в параметре ИменаКолонок +// (если ИменаКолонок не заполнен - все колонки первой коллекции должны существовать во второй коллекции). +// Также позволяет сравнивать массивы. +// Для сравнения других коллекций, а также для сравнения коллекций с учетом вложенности см. функцию ДанныеСовпадают. +// +// Параметры: +// КоллекцияСтрок1 - ТаблицаЗначений +// - ДеревоЗначений +// - СписокЗначений +// - ТабличнаяЧасть +// - Соответствие +// - Массив +// - ФиксированныйМассив +// - Структура - коллекция, отвечающая вышеописанным требованиям. А также другие +// объекты, для которых доступен обход посредством оператора Для каждого … Из … Цикл. +// КоллекцияСтрок2 - ТаблицаЗначений +// - ДеревоЗначений +// - СписокЗначений +// - ТабличнаяЧасть +// - Соответствие +// - Массив +// - ФиксированныйМассив +// - Структура - коллекция, отвечающая вышеописанным требованиям. А также другие +// объекты, для которых доступен обход посредством оператора Для каждого … Из … Цикл. +// ИменаКолонок - Строка - имена колонок через запятую, по которым производится сравнение. +// Не обязательно для коллекций, состав колонок которых можно определить автоматически: +// ТаблицаЗначений, СписокЗначений, Соответствие, Структура. +// Если не указан, то сравнение производится по колонкам первой коллекции. +// Для коллекций других типов является обязательным. +// Следует также учитывать, что при сравнении коллекций, содержащих вместо строк другие типы +// элементов, в качестве имен колонок можно указывать только имена свойств этих элементов. +// Для соответствий и структур это "Ключ" и "Значение", но не значения ключей. +// Для списков значений это "Значение" и "Представление", но не сами значения. +// +// ИсключаяКолонки - Строка - имена колонок, которые игнорируются при сравнении. +// УчитыватьПоследовательностьСтрок - Булево - если Истина, то коллекции признаются +// идентичными, только если одинаковые строки размещены в коллекциях на одинаковых местах. +// +// Возвращаемое значение: +// Булево - Истина, если идентичны. +// +Функция КоллекцииИдентичны(КоллекцияСтрок1, КоллекцияСтрок2, Знач ИменаКолонок = "", Знач ИсключаяКолонки = "", Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.КоллекцииИдентичны(КоллекцияСтрок1, КоллекцияСтрок2, ИменаКолонок, ИсключаяКолонки, ); +``` +
+ +## ДанныеСовпадают +
+ +Описание, пример вызова + +```bsl + +// Сравнивает данные сложной структуры с учетом вложенности. +// +// Параметры: +// Данные1 - Структура +// - ФиксированнаяСтруктура +// - Соответствие +// - ФиксированноеСоответствие +// - Массив +// - ФиксированныйМассив +// - ХранилищеЗначения +// - ТаблицаЗначений +// - Строка +// - Число +// - Булево - сравниваемые данные. +// Данные2 - Произвольный - те же типы, что и для параметра Данные1. +// +// Возвращаемое значение: +// Булево - Истина, если совпадают. +// +Функция ДанныеСовпадают(Данные1, Данные2) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ДанныеСовпадают(Данные1, Данные2) +``` +
+ +## ФиксированныеДанные +
+ +Описание, пример вызова + +```bsl + +// Фиксирует данные типов Структура, Соответствие, Массив с учетом вложенности. +// +// Параметры: +// Данные - Структура +// - Соответствие +// - Массив - коллекции, значения которых являются примитивными типами, +// хранилищем значения или не могут быть изменены. Поддерживаются типы значений: +// Булево, Строка, Число, Дата, Неопределено, УникальныйИдентификатор, Null, Тип, +// ХранилищеЗначения, ОбщийМодуль, ОбъектМетаданных, ТипЗначенияXDTO, ТипОбъектаXDTO, +// ЛюбаяСсылка. +// +// ВызыватьИсключение - Булево - начальное значение Истина. Когда установлено Ложь, тогда в случае наличия +// нефиксируемых данных исключение не будет вызвано, при этом данные будут +// зафиксированы на сколько возможно. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура, ФиксированноеСоответствие, ФиксированныйМассив - фиксированные данные, аналогичные +// переданным в параметре Данные. +// +Функция ФиксированныеДанные(Данные, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ФиксированныеДанные(Данные, ВызыватьИсключение); +``` +
+ +## КонтрольнаяСуммаСтрокой +
+ +Описание, пример вызова + +```bsl + +// Вычисляет контрольную сумму для произвольных данных по указанному алгоритму. +// +// Параметры: +// Данные - Произвольный - любое сериализуемое значение. +// Алгоритм - ХешФункция - алгоритм расчета контрольной суммы. По умолчанию, MD5. +// +// Возвращаемое значение: +// Строка - контрольная сумма строкой без пробелов (например 32 символа). +// +Функция КонтрольнаяСуммаСтрокой(Знач Данные, Знач Алгоритм = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.КонтрольнаяСуммаСтрокой(Данные, Алгоритм); +``` +
+ +## СократитьСтрокуКонтрольнойСуммой +
+ +Описание, пример вызова + +```bsl + +// Сокращает строку до нужной длины, при этом обрезанная часть хешируется, +// обеспечивая уникальность строки. Проверяет длину строки на входе и, в случае +// превышения максимальной длины, преобразует ее конец по алгоритму MD5 в +// уникальную строку из 32 символов. +// +// Параметры: +// Строка - Строка - исходная строка произвольной длины. +// МаксимальнаяДлина - Число - требуемое максимальное количество символов в строке, +// минимальное значение: 32. +// +// Возвращаемое значение: +// Строка - строка, не превышающая максимальную длину. +// +Функция СократитьСтрокуКонтрольнойСуммой(Строка, МаксимальнаяДлина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СократитьСтрокуКонтрольнойСуммой(Строка, МаксимальнаяДлина) +``` +
+ +## СкопироватьРекурсивно +
+ +Описание, пример вызова + +```bsl + +// Создает полную копию структуры, соответствия, массива, списка или таблицы значений, рекурсивно, +// с учетом типов дочерних элементов. При этом содержимое значений объектных типов +// (СправочникОбъект, ДокументОбъект и т.п.) не копируются, а возвращаются ссылки на исходный объект. +// +// Параметры: +// Источник - Структура +// - ФиксированнаяСтруктура +// - Соответствие +// - ФиксированноеСоответствие +// - Массив +// - ФиксированныйМассив +// - СписокЗначений - объект, который необходимо скопировать. +// ФиксироватьДанные - Булево - если Истина - фиксировать, если Ложь - снять фиксацию. +// - Неопределено - не изменять. +// +// Возвращаемое значение: +// Структура, +// ФиксированнаяСтруктура, +// Соответствие +// ФиксированноеСоответствие +// Массив +// ФиксированныйМассив +// СписокЗначений - копия объекта, переданного в параметре Источник. +// +Функция СкопироватьРекурсивно(Источник, ФиксироватьДанные = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СкопироватьРекурсивно(Источник, ФиксироватьДанные); +``` +
+ +## ПредметСтрокой +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание предмета в виде текстовой строки. +// Для документов возвращается представление, для остальных ссылочных типов возвращается +// представление и тип в скобках, например, "Ножницы (Номенклатура)". +// Для пустых ссылок, Неопределено или незаполненных значений примитивных типов возвращается "не задан". +// +// Параметры: +// СсылкаНаПредмет - Произвольный. +// +// Возвращаемое значение: +// Строка - например, "Ножницы (Номенклатура)", "Заказ клиента № 0001 от 01.01.2001" или "не задан". +// +Функция ПредметСтрокой(СсылкаНаПредмет) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПредметСтрокой(СсылкаНаПредмет) +``` +
+ +## ПредметыСтрокой +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания предметов СсылкиНаПредметы. +// Для документов возвращается представление, для остальных ссылочных типов возвращается +// представление и тип в скобках, например, "Ножницы (Номенклатура)". +// Для пустых ссылок или незаполненных значений примитивных типов возвращается "не задан". +// Значение "удален", если объект не существует в информационной базе. +// Значения Неопределено пропускаются. +// +// Параметры: +// СсылкиНаПредметы - Массив из ЛюбаяСсылка +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ЛюбаяСсылка +// * Значение - Строка - например, "Ножницы (Номенклатура)", "Заказ клиента № 0001 от 01.01.2001" или "не задан". +// +Функция ПредметыСтрокой(Знач СсылкиНаПредметы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПредметыСтрокой(СсылкиНаПредметы) +``` +
+ +## ПредставленияСсылок +
+ +Описание, пример вызова + +```bsl + +// Возвращает представления переданных ссылок. +// +// Параметры: +// ПроверяемыеСсылки - Массив из ЛюбаяСсылка, ЛюбаяСсылка +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ЛюбаяСсылка +// * Значение - Строка - представление ссылки или "удален", если ссылка не существует в информационной базе. +// +Функция ПредставленияСсылок(ПроверяемыеСсылки) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПредставленияСсылок(ПроверяемыеСсылки) +``` +
+ +## СтруктураСвойствДинамическогоСписка +
+ +Описание, пример вызова + +```bsl + +// Создает структуру для второго параметра СвойстваСписка процедуры УстановитьСвойстваДинамическогоСписка. +// +// Возвращаемое значение: +// Структура - любое поле может иметь значение Неопределено, если оно не устанавливается: +// * ТекстЗапроса - Строка - новый текст запроса. +// * ОсновнаяТаблица - Строка - имя основной таблицы. +// * ДинамическоеСчитываниеДанных - Булево - признак использования динамического считывания. +// +Функция СтруктураСвойствДинамическогоСписка() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СтруктураСвойствДинамическогоСписка() +``` +
+ +## УстановитьСвойстваДинамическогоСписка +
+ +Описание, пример вызова + +```bsl + +// Установить текст запроса, основную таблицу или динамическое считывание в динамическом списке. +// Устанавливать эти свойства следует за один вызов этой процедуры, чтобы не снижалась производительность. +// +// Параметры: +// Список - ТаблицаФормы - элемент формы динамического списка, для которого устанавливаются свойства. +// СвойстваСписка - см. СтруктураСвойствДинамическогоСписка +// +Процедура УстановитьСвойстваДинамическогоСписка(Список, СвойстваСписка) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.УстановитьСвойстваДинамическогоСписка(Список, СвойстваСписка) +``` +
+ +## ИдентификаторCOMСоединителя +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для работы с внешним соединением. + +// Возвращает CLSID COM-класса для работы с "1С:Предприятием 8" через COM-соединение. +// +// Параметры: +// ИмяCOMСоединителя - Строка - имя COM-класса для работы с "1С:Предприятием 8" через COM-соединение. +// +// Возвращаемое значение: +// Строка - строковое представление CLSID. +// +Функция ИдентификаторCOMСоединителя(Знач ИмяCOMСоединителя) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИдентификаторCOMСоединителя(ИмяCOMСоединителя) +``` +
+ +## УстановитьВнешнееСоединениеСБазой +
+ +Описание, пример вызова + +```bsl + +// Устанавливает внешнее соединение с информационной базой по переданным параметрам подключения и возвращает указатель +// на это соединение. +// +// Параметры: +// Параметры - см. ОбщегоНазначенияКлиентСервер.СтруктураПараметровДляУстановкиВнешнегоСоединения +// +// Возвращаемое значение: +// Структура: +// * Соединение - COMОбъект +// - Неопределено - COM-объект соединения или Неопределено в случае ошибки; +// * КраткоеОписаниеОшибки - Строка - краткое описание ошибки; +// * ПодробноеОписаниеОшибки - Строка - подробное описание ошибки; +// * ОшибкаПодключенияКомпоненты - Булево - флаг ошибки подключения COM. +// +Функция УстановитьВнешнееСоединениеСБазой(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.УстановитьВнешнееСоединениеСБазой(Параметры) +``` +
+ +## ЭтоДокумент +
+ +Описание, пример вызова + +```bsl + +// Ссылочные типы данных + +// Определяет принадлежность объекта метаданных к общему типу "Документ". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к документам. +// +// Возвращаемое значение: +// Булево - Истина, если объект является документом. +// +Функция ЭтоДокумент(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоДокумент(ОбъектМетаданных) +``` +
+ +## ЭтоСправочник +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Справочник". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является справочником. +// +Функция ЭтоСправочник(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоСправочник(ОбъектМетаданных) +``` +
+ +## ЭтоПеречисление +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Перечисление". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является перечислением. +// +Функция ЭтоПеречисление(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоПеречисление(ОбъектМетаданных) +``` +
+ +## ЭтоПланОбмена +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "План обмена". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является планом обмена. +// +Функция ЭтоПланОбмена(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоПланОбмена(ОбъектМетаданных) +``` +
+ +## ЭтоПланВидовХарактеристик +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "План видов характеристик". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является планом видов характеристик. +// +Функция ЭтоПланВидовХарактеристик(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоПланВидовХарактеристик(ОбъектМетаданных) +``` +
+ +## ЭтоБизнесПроцесс +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Бизнес-процесс". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является бизнес-процессом. +// +Функция ЭтоБизнесПроцесс(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоБизнесПроцесс(ОбъектМетаданных) +``` +
+ +## ЭтоЗадача +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Задача". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является задачей. +// +Функция ЭтоЗадача(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоЗадача(ОбъектМетаданных) +``` +
+ +## ЭтоПланСчетов +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "План счетов". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является планом счетов. +// +Функция ЭтоПланСчетов(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоПланСчетов(ОбъектМетаданных) +``` +
+ +## ЭтоПланВидовРасчета +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "План видов расчета". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является планом видов расчета. +// +Функция ЭтоПланВидовРасчета(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоПланВидовРасчета(ОбъектМетаданных) +``` +
+ +## ЭтоРегистрСведений +
+ +Описание, пример вызова + +```bsl + +// Регистры + +// Определяет принадлежность объекта метаданных к общему типу "Регистр сведений". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является регистром сведений. +// +Функция ЭтоРегистрСведений(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоРегистрСведений(ОбъектМетаданных) +``` +
+ +## ЭтоРегистрНакопления +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Регистр накопления". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является регистром накопления. +// +Функция ЭтоРегистрНакопления(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоРегистрНакопления(ОбъектМетаданных) +``` +
+ +## ЭтоРегистрБухгалтерии +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Регистр бухгалтерии". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является регистром бухгалтерии. +// +Функция ЭтоРегистрБухгалтерии(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоРегистрБухгалтерии(ОбъектМетаданных) +``` +
+ +## ЭтоРегистрРасчета +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Регистр расчета". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является регистром расчета. +// +Функция ЭтоРегистрРасчета(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоРегистрРасчета(ОбъектМетаданных) +``` +
+ +## ЭтоКонстанта +
+ +Описание, пример вызова + +```bsl + +// Константы + +// Определяет принадлежность объекта метаданных к общему типу "Константа". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является константой. +// +Функция ЭтоКонстанта(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоКонстанта(ОбъектМетаданных) +``` +
+ +## ЭтоЖурналДокументов +
+ +Описание, пример вызова + +```bsl + +// Журналы документов + +// Определяет принадлежность объекта метаданных к общему типу "Журнал документов". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является журналом документов. +// +Функция ЭтоЖурналДокументов(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоЖурналДокументов(ОбъектМетаданных) +``` +
+ +## ЭтоПоследовательность +
+ +Описание, пример вызова + +```bsl + +// Последовательности + +// Определяет принадлежность объекта метаданных к общему типу "Последовательности". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является последовательностью. +// +Функция ЭтоПоследовательность(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоПоследовательность(ОбъектМетаданных) +``` +
+ +## ЭтоРегламентноеЗадание +
+ +Описание, пример вызова + +```bsl + +// РегламентныеЗадания + +// Определяет принадлежность объекта метаданных к общему типу "Регламентные задания". +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является регламентным заданием. +// +Функция ЭтоРегламентноеЗадание(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоРегламентноеЗадание(ОбъектМетаданных) +``` +
+ +## ЭтоРегистр +
+ +Описание, пример вызова + +```bsl + +// Общие + +// Определяет принадлежность объекта метаданных к типу регистр. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект является каким-либо регистром. +// +Функция ЭтоРегистр(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоРегистр(ОбъектМетаданных) +``` +
+ +## ЭтоОбъектСсылочногоТипа +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к ссылочному типу. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо определить принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если объект ссылочного типа. +// +Функция ЭтоОбъектСсылочногоТипа(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоОбъектСсылочногоТипа(ОбъектМетаданных) +``` +
+ +## ИменаРеквизитовПоТипу +
+ +Описание, пример вызова + +```bsl + +// Возвращает имена реквизитов объекта заданного типа. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - ссылка на элемент базы данных, для которого требуется получить результат функции; +// Тип - Тип - тип значения реквизита. +// +// Возвращаемое значение: +// Строка - строка реквизитов объекта метаданных конфигурации, разделенных символом ",". +// +// Пример: +// РеквизитыОрганизации = ОбщегоНазначения.ИменаРеквизитовПоТипу(Документ.Ссылка, Тип("СправочникСсылка.Организации")); +// +Функция ИменаРеквизитовПоТипу(Ссылка, Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИменаРеквизитовПоТипу(Ссылка, Тип) +``` +
+ +## ИмяБазовогоТипаПоОбъектуМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя базового типа по переданному значению объекта метаданных. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект метаданных, по которому необходимо определить базовый тип. +// +// Возвращаемое значение: +// Строка - имя базового типа по переданному значению объекта метаданных. +// +// Пример: +// ИмяБазовогоТипа = ОбщегоНазначения.ИмяБазовогоТипаПоОбъектуМетаданных(Метаданные.Справочники.Номенклатура); = "Справочники". +// +Функция ИмяБазовогоТипаПоОбъектуМетаданных(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИмяБазовогоТипаПоОбъектуМетаданных(ОбъектМетаданных) +``` +
+ +## МенеджерОбъектаПоПолномуИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер объекта по полному имени объекта метаданных. +// Ограничение: не обрабатываются точки маршрутов бизнес-процессов. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных. Пример: "Справочник.Организации". +// +// Возвращаемое значение: +// СправочникМенеджер, ДокументМенеджер, ОбработкаМенеджер, РегистрСведенийМенеджер, ПланВидовХарактеристикМенеджер +// +// Пример: +// МенеджерСправочника = ОбщегоНазначения.МенеджерОбъектаПоПолномуИмени("Справочник.Организации"); +// ПустаяСсылка = МенеджерСправочника.ПустаяСсылка(); +// +Функция МенеджерОбъектаПоПолномуИмени(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.МенеджерОбъектаПоПолномуИмени(ПолноеИмя) +``` +
+ +## МенеджерОбъектаПоСсылке +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер объекта по ссылке на объект. +// Ограничение: не обрабатываются точки маршрутов бизнес-процессов. +// См. также ОбщегоНазначения.МенеджерОбъектаПоПолномуИмени. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - объект, менеджер которого требуется получить. +// +// Возвращаемое значение: +// СправочникМенеджер, ДокументМенеджер, ОбработкаМенеджер, РегистрСведенийМенеджер - менеджер объекта. +// +// Пример: +// МенеджерСправочника = ОбщегоНазначения.МенеджерОбъектаПоСсылке(СсылкаНаОрганизацию); +// ПустаяСсылка = МенеджерСправочника.ПустаяСсылка(); +// +Функция МенеджерОбъектаПоСсылке(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.МенеджерОбъектаПоСсылке(Ссылка) +``` +
+ +## ЭтоСсылка +
+ +Описание, пример вызова + +```bsl + +// Проверка того, что переданный тип является ссылочным типом данных. +// Для типа Неопределено возвращается Ложь. +// +// Параметры: +// ПроверяемыйТип - Тип - для проверки на ссылочный тип данных. +// +// Возвращаемое значение: +// Булево - Истина, если это ссылка. +// +Функция ЭтоСсылка(ПроверяемыйТип) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоСсылка(ПроверяемыйТип) +``` +
+ +## СсылкаСуществует +
+ +Описание, пример вызова + +```bsl + +// Проверяет физическое наличие записи в информационной базе данных о переданном значении ссылки. +// +// Параметры: +// ПроверяемаяСсылка - ЛюбаяСсылка - значение любой ссылки информационной базы данных. +// +// Возвращаемое значение: +// Булево - Истина, если существует. +// +Функция СсылкаСуществует(ПроверяемаяСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СсылкаСуществует(ПроверяемаяСсылка) +``` +
+ +## ВидОбъектаПоСсылке +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя вида объектов метаданных по ссылке на объект. +// Ограничение: не обрабатываются точки маршрутов бизнес-процессов. +// См. так же ВидОбъектаПоТипу. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - объект, вид которого требуется получить. +// +// Возвращаемое значение: +// Строка - имя вида объектов метаданных. Например: "Справочник", "Документ". +// +Функция ВидОбъектаПоСсылке(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ВидОбъектаПоСсылке(Ссылка) +``` +
+ +## ВидОбъектаПоТипу +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя вида объектов метаданных по типу объекта. +// Ограничение: не обрабатываются точки маршрутов бизнес-процессов. +// См. так же ВидОбъектаПоСсылке. +// +// Параметры: +// ТипОбъекта - Тип - тип прикладного объекта, определенный в конфигурации. +// +// Возвращаемое значение: +// Строка - имя вида объектов метаданных. Например: "Справочник", "Документ". +// +Функция ВидОбъектаПоТипу(ТипОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ВидОбъектаПоТипу(ТипОбъекта) +``` +
+ +## ИмяТаблицыПоСсылке +
+ +Описание, пример вызова + +```bsl + +// Возвращает полное имя объекта метаданных по переданному значению ссылки. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - объект, для которого необходимо получить имя таблицы ИБ. +// +// Возвращаемое значение: +// Строка - полное имя объекта метаданных для указанного объекта. Например: "Справочник.Номенклатура". +// +Функция ИмяТаблицыПоСсылке(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИмяТаблицыПоСсылке(Ссылка) +``` +
+ +## ЗначениеСсылочногоТипа +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что переданное значение имеет ссылочный тип данных. +// +// Параметры: +// Значение - Произвольный - проверяемое значение. +// +// Возвращаемое значение: +// Булево - Истина, если тип значения ссылочный. +// +Функция ЗначениеСсылочногоТипа(Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗначениеСсылочногоТипа(Значение) +``` +
+ +## ОбъектЯвляетсяГруппой +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли элемент справочника или плана видов характеристик группой элементов. +// +// Параметры: +// Объект - СправочникСсылка +// - ПланВидовХарактеристикСсылка +// - СправочникОбъект +// - ПланВидовХарактеристикОбъект - проверяемый объект. +// +// Возвращаемое значение: +// Булево +// +Функция ОбъектЯвляетсяГруппой(Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОбъектЯвляетсяГруппой(Объект) +``` +
+ +## ИдентификаторОбъектаМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку, соответствующую объекту метаданных, для использования в базе данных. +// См. также ОбщегоНазначения.ИдентификаторыОбъектовМетаданных. +// +// Ссылки возвращаются для следующих объектов метаданных: +// - Подсистемы (см. также ОбщегоНазначенияПереопределяемый.ПриДобавленииПереименованийОбъектовМетаданных); +// - Роли (см. также ОбщегоНазначенияПереопределяемый.ПриДобавленииПереименованийОбъектовМетаданных); +// - ПланыОбмена; +// - Константы; +// - Справочники; +// - Документы; +// - ЖурналыДокументов; +// - Отчеты; +// - Обработки; +// - ПланыВидовХарактеристик; +// - ПланыСчетов; +// - ПланыВидовРасчета; +// - РегистрыСведений; +// - РегистрыНакопления; +// - РегистрыБухгалтерии; +// - РегистрыРасчета; +// - БизнесПроцессы; +// - Задачи. +// +// Параметры: +// ОписаниеОбъектаМетаданных - ОбъектМетаданных - объект метаданных конфигурации; +// - Тип - тип, который можно использовать в функции Метаданные.НайтиПоТипу; +// - Строка - полное имя объекта метаданных, которое можно +// использовать в функции Метаданные.НайтиПоПолномуИмени. +// +// ВызыватьИсключение - Булево - если Ложь, то вместо вызова исключения возвращается Null для несуществующего +// или неподдерживаемого объекта метаданных. +// +// Возвращаемое значение: +// СправочникСсылка.ИдентификаторыОбъектовМетаданных +// СправочникСсылка.ИдентификаторыОбъектовРасширений +// Null +// +// Пример: +// Идентификатор = ОбщегоНазначения.ИдентификаторОбъектаМетаданных(ТипЗнч(Ссылка)); +// Идентификатор = ОбщегоНазначения.ИдентификаторОбъектаМетаданных(ОбъектМетаданных); +// Идентификатор = ОбщегоНазначения.ИдентификаторОбъектаМетаданных("Справочник.Организации"); +// +Функция ИдентификаторОбъектаМетаданных(ОписаниеОбъектаМетаданных, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИдентификаторОбъектаМетаданных(ОписаниеОбъектаМетаданных, ВызыватьИсключение); +``` +
+ +## ИдентификаторыОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылки, соответствующие объектам метаданных, для использования в базе данных. +// См. также ОбщегоНазначения.ИдентификаторОбъектаМетаданных. +// +// Ссылки возвращаются для следующих объектов метаданных: +// - Подсистемы (см. также ОбщегоНазначенияПереопределяемый.ПриДобавленииПереименованийОбъектовМетаданных); +// - Роли (см. также ОбщегоНазначенияПереопределяемый.ПриДобавленииПереименованийОбъектовМетаданных); +// - ПланыОбмена. +// - Константы. +// - Справочники. +// - Документы. +// - ЖурналыДокументов. +// - Отчеты. +// - Обработки. +// - ПланыВидовХарактеристик. +// - ПланыСчетов. +// - ПланыВидовРасчета. +// - РегистрыСведений. +// - РегистрыНакопления. +// - РегистрыБухгалтерии. +// - РегистрыРасчета. +// - БизнесПроцессы. +// - Задачи. +// +// Параметры: +// ОписаниеОбъектовМетаданных - Массив из ОбъектМетаданных - объекты метаданных конфигурации; +// - Массив из Строка - полные имена объектов метаданных, которые можно использовать +// в функции Метаданные.НайтиПоПолномуИмени; +// - Массив из Тип - типы, которые можно использовать в функции Метаданные.НайтиПоТипу. +// ВызыватьИсключение - Булево - если Ложь, то несуществующие и неподдерживаемые объекты метаданных +// будут пропущены в возвращаемом значении. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - полное имя указанного объекта метаданных. +// * Значение - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений - найденный идентификатор. +// +// Пример: +// ПолныеИмена = Новый Массив; +// ПолныеИмена.Добавить(Метаданные.Справочники.Валюты.ПолноеИмя()); +// ПолныеИмена.Добавить(Метаданные.РегистрыСведений.КурсыВалют.ПолноеИмя()); +// Идентификаторы = ОбщегоНазначения.ИдентификаторыОбъектовМетаданных(ПолныеИмена); +// +Функция ИдентификаторыОбъектовМетаданных(ОписаниеОбъектовМетаданных, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИдентификаторыОбъектовМетаданных(ОписаниеОбъектовМетаданных, ВызыватьИсключение); +``` +
+ +## ОбъектМетаданныхПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Возвращает объект метаданных по переданному идентификатору. +// +// Параметры: +// Идентификатор - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений - идентификатор +// объекта метаданных конфигурации или расширения конфигурации. +// +// ВызыватьИсключение - Булево - если Ложь, тогда в случае, когда объект метаданных +// не существует или недоступен, возвращает соответственно +// Null или Неопределено вместо вызова исключения. +// +// Возвращаемое значение: +// ОбъектМетаданных - объект метаданных, соответствующий идентификатору. +// +// Null - возвращается, когда ВызыватьИсключение = Ложь. Обозначает, что +// для указанного идентификатора объект метаданных не существует (идентификатор устарел). +// +// Неопределено - возвращается, когда ВызыватьИсключение = Ложь. Обозначает, +// что идентификатор действующий, но в текущем сеансе ОбъектМетаданных не может быть получен. +// Для расширений конфигурации это значит, что расширение установлено, но не подключено, +// либо потому что перезапуск еще не выполнен, либо при подключении произошла ошибка. +// Для конфигурации это значит, что в новом сеансе (новом динамическом поколении) объект +// метаданных имеется, а в текущем (старом) сеансе нет. +// +Функция ОбъектМетаданныхПоИдентификатору(Идентификатор, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОбъектМетаданныхПоИдентификатору(Идентификатор, ВызыватьИсключение); +``` +
+ +## ОбъектыМетаданныхПоИдентификаторам +
+ +Описание, пример вызова + +```bsl + +// Возвращает объекты метаданных по переданным идентификаторам. +// +// Параметры: +// Идентификаторы - Массив - со значениями: +// * Значение - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений - идентификаторы +// объектов метаданных конфигурации или расширений конфигурации. +// +// ВызыватьИсключение - Булево - если Ложь, тогда в случае, когда объект метаданных +// не существует или недоступен, возвращает соответственно +// Null или Неопределено вместо вызова исключения. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений - переданный идентификатор. +// * Значение - ОбъектМетаданных - объект метаданных, соответствующий идентификатору. +// - Null - возвращается, когда ВызыватьИсключение = Ложь. Обозначает, что +// для указанного идентификатора объект метаданных не существует (идентификатор устарел). +// - Неопределено - возвращается, когда ВызыватьИсключение = Ложь. Обозначает, +// что идентификатор действующий, но в текущем сеансе ОбъектМетаданных не может быть получен. +// Для расширений конфигурации это значит, что расширение установлено, но не подключено, +// либо потому что перезапуск еще не выполнен, либо при подключении произошла ошибка. +// Для конфигурации это значит, что в новом сеансе (новом динамическом поколении) объект +// метаданных имеется, а в текущем (старом) сеансе нет. +// +Функция ОбъектыМетаданныхПоИдентификаторам(Идентификаторы, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОбъектыМетаданныхПоИдентификаторам(Идентификаторы, ВызыватьИсключение); +``` +
+ +## ОбъектМетаданныхПоПолномуИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает ОбъектМетаданных, быстро найденный по полному имени. +// Более производительный аналог метода платформы Метаданные.НайтиПоПолномуИмени +// для корневых объектов метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, например, Справочник.Организации +// +// Возвращаемое значение: +// ОбъектМетаданных - когда найден +// Неопределено - когда не найден +// +Функция ОбъектМетаданныхПоПолномуИмени(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОбъектМетаданныхПоПолномуИмени(ПолноеИмя) +``` +
+ +## ОбъектМетаданныхДоступенПоФункциональнымОпциям +
+ +Описание, пример вызова + +```bsl + +// Определяет доступность объекта метаданных по функциональным опциям. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных +// - Строка - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект доступен. +// +Функция ОбъектМетаданныхДоступенПоФункциональнымОпциям(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОбъектМетаданныхДоступенПоФункциональнымОпциям(ОбъектМетаданных) +``` +
+ +## ДобавитьПереименование +
+ +Описание, пример вызова + +```bsl + +// Позволяет отразить переименование объекта метаданных при переходе на новую версию конфигурации. +// Для вызова в процедуре ОбщегоНазначенияПереопределяемый.ПриДобавленииПереименованийОбъектовМетаданных. +// +// Параметры: +// Переименования - см. ОбщегоНазначенияПереопределяемый.ПриДобавленииПереименованийОбъектовМетаданных.Переименования +// ВерсияИБ - Строка - версия конечной конфигурации, при переходе на которую нужно +// выполнить переименование, например, "2.1.2.14". +// СтароеПолноеИмя - Строка - старое полное имя объекта метаданных, которое нужно переименовать, +// например "Подсистема.СлужебныеПодсистемы". +// НовоеПолноеИмя - Строка - новое полное имя объекта метаданных, на которое нужно переименовать, +// например "Подсистема.СервисныеПодсистемы". +// ИдентификаторБиблиотеки - Строка - внутренний идентификатор библиотеки, к которой относится ВерсияИБ. +// Для основной конфигурации не требуется. +// Например, "СтандартныеПодсистемы" - как указано +// в ОбновлениеИнформационнойБазыБСП.ПриДобавленииПодсистемы. +// Пример: +// ОбщегоНазначения.ДобавитьПереименование(Переименования, "2.1.2.14", +// "Подсистема.СлужебныеПодсистемы", +// "Подсистема.СервисныеПодсистемы"); +// +Процедура ДобавитьПереименование(Переименования, ВерсияИБ, СтароеПолноеИмя, НовоеПолноеИмя, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ДобавитьПереименование(Переименования, ВерсияИБ, СтароеПолноеИмя, НовоеПолноеИмя, ); +``` +
+ +## СтроковоеПредставлениеТипа +
+ +Описание, пример вызова + +```bsl + +// Возвращает строковое представление типа, например, "СправочникСсылка.ИмяОбъекта", "ДокументСсылка.ИмяОбъекта". +// Для остальных типов приводит тип к строке, например "Число". +// +// Параметры: +// Тип - Тип - для которого надо получить представление. +// +// Возвращаемое значение: +// Строка +// +Функция СтроковоеПредставлениеТипа(Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СтроковоеПредставлениеТипа(Тип) +``` +
+ +## ОписаниеСвойствОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений с описанием требуемых свойств всех реквизитов объекта метаданных. +// Получает значения свойств стандартных реквизитов и пользовательских реквизитов (созданных в режиме конфигуратора). +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого необходимо получить значение свойств реквизитов. +// Например: Метаданные.Документ.РеализацияТоваровИУслуг +// Свойства - Строка - свойства реквизитов, перечисленные через запятую, значение которых необходимо получить. +// Например: "Имя, Тип, Синоним, Подсказка". +// +// Возвращаемое значение: +// ТаблицаЗначений - описание требуемых свойств всех реквизитов объекта метаданных. +// +Функция ОписаниеСвойствОбъекта(ОбъектМетаданных, Свойства) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОписаниеСвойствОбъекта(ОбъектМетаданных, Свойства) +``` +
+ +## ЭтоСтандартныйРеквизит +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, что реквизит входит в подмножество стандартных реквизитов. +// +// Параметры: +// СтандартныеРеквизиты - ОписанияСтандартныхРеквизитов - тип и значение, описывающие коллекцию настроек различных +// стандартных реквизитов; +// ИмяРеквизита - Строка - реквизит, который необходимо проверить на принадлежность множеству стандартных +// реквизитов. +// +// Возвращаемое значение: +// Булево - Истина, если реквизит входит в подмножество стандартных реквизитов. +// +Функция ЭтоСтандартныйРеквизит(СтандартныеРеквизиты, ИмяРеквизита) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоСтандартныйРеквизит(СтандартныеРеквизиты, ИмяРеквизита) +``` +
+ +## ЕстьРеквизитОбъекта +
+ +Описание, пример вызова + +```bsl + +// Позволяет определить, есть ли среди реквизитов объекта реквизит с переданным именем. +// +// Параметры: +// ИмяРеквизита - Строка - имя реквизита; +// МетаданныеОбъекта - ОбъектМетаданных - объект, в котором требуется проверить наличие реквизита. +// +// Возвращаемое значение: +// Булево - Истина, если есть. +// +Функция ЕстьРеквизитОбъекта(ИмяРеквизита, МетаданныеОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЕстьРеквизитОбъекта(ИмяРеквизита, МетаданныеОбъекта) +``` +
+ +## ОписаниеТипаСостоитИзТипа +
+ +Описание, пример вызова + +```bsl + +// Проверить, что описание типа состоит из единственного типа значения и +// совпадает с нужным типом. +// +// Параметры: +// ОписаниеТипа - ОписаниеТипов - проверяемая коллекция типов; +// ТипЗначения - Тип - проверяемый тип. +// +// Возвращаемое значение: +// Булево - Истина, если совпадает. +// +// Пример: +// Если ОбщегоНазначения.ОписаниеТипаСостоитИзТипа(ТипЗначенияСвойства, Тип("Булево") Тогда +// // Выводим поле в виде флажка. +// КонецЕсли; +// +Функция ОписаниеТипаСостоитИзТипа(ОписаниеТипа, ТипЗначения) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОписаниеТипаСостоитИзТипа(ОписаниеТипа, ТипЗначения) +``` +
+ +## ОписаниеТипаСтрока +
+ +Описание, пример вызова + +```bsl + +// Создает объект ОписаниеТипов, содержащий тип Строка. +// +// Параметры: +// ДлинаСтроки - Число - длина строки. +// +// Возвращаемое значение: +// ОписаниеТипов - описание типа Строка. +// +Функция ОписаниеТипаСтрока(ДлинаСтроки) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОписаниеТипаСтрока(ДлинаСтроки) +``` +
+ +## ОписаниеТипаЧисло +
+ +Описание, пример вызова + +```bsl + +// Создает объект ОписаниеТипов, содержащий тип Число. +// +// Параметры: +// Разрядность - Число - общее количество разрядов числа (количество разрядов +// целой части плюс количество разрядов дробной части). +// РазрядностьДробнойЧасти - Число - число разрядов дробной части. +// ЗнакЧисла - ДопустимыйЗнак - допустимый знак числа. +// +// Возвращаемое значение: +// ОписаниеТипов - описание типа Число. +// +Функция ОписаниеТипаЧисло(Разрядность, РазрядностьДробнойЧасти = 0, Знач ЗнакЧисла = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОписаниеТипаЧисло(Разрядность, РазрядностьДробнойЧасти, ЗнакЧисла); +``` +
+ +## ОписаниеТипаДата +
+ +Описание, пример вызова + +```bsl + +// Создает объект ОписаниеТипов, содержащий тип Дата. +// +// Параметры: +// ЧастиДаты - ЧастиДаты - набор вариантов использования значений типа Дата. +// +// Возвращаемое значение: +// ОписаниеТипов - описание типа Дата. +// +Функция ОписаниеТипаДата(ЧастиДаты) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОписаниеТипаДата(ЧастиДаты) +``` +
+ +## ОписаниеТипаВсеСсылки +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание типа, включающего в себя все возможные ссылочные типы конфигурации. +// +// Возвращаемое значение: +// ОписаниеТипов - все ссылочные типы конфигурации. +// +Функция ОписаниеТипаВсеСсылки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОписаниеТипаВсеСсылки() +``` +
+ +## ПредставлениеСписка +
+ +Описание, пример вызова + +```bsl + +// Возвращает строковое представление списка, заданное в свойствах объекта метаданных. +// В зависимости от того, какие свойства объекта метаданных заполнены, функция возвращают одно из них в указанном +// порядке: Расширенное представление списка, Представление списка, Синоним или Имя. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - произвольный объект. +// +// Возвращаемое значение: +// Строка - представление списка. +// +Функция ПредставлениеСписка(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПредставлениеСписка(ОбъектМетаданных) +``` +
+ +## ПредставлениеОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает строковое представление объекта, заданное в свойствах объекта метаданных. +// В зависимости от того, какие свойства объекта метаданных заполнены, функция возвращают одно из них в указанном +// порядке: Расширенное представление объекта, Представление объекта, Синоним или Имя. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - произвольный объект. +// +// Возвращаемое значение: +// Строка - представление объекта. +// +Функция ПредставлениеОбъекта(ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПредставлениеОбъекта(ОбъектМетаданных) +``` +
+ +## ОтборЗаписейНабораИзБазыДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает условие отбора и параметры запроса для выбора записей из базы данных +// по указанному набору записей с учетом режима замещения. +// +// Если Замещение равно Истина или РежимЗамещения.Замещение, тогда +// записи будут извлекаться из базы данных по настройке свойства Отбор, +// в противном случае по ключам строк записей в наборе записей. +// +// Параметры: +// НаборЗаписей - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор записей, который используется +// для подготовки условия и параметров для запроса. +// - Отбор - отбор набора записей (в этом случае Замещение считается Истина). +// +// Замещение - РежимЗамещения, Булево - как передается в подписку на событие ПередЗаписью. +// - Неопределено - получить и установить в этот параметр значение из свойства +// Замещение структуры ДополнительныеСвойства указанного набора записей +// (если свойства нет, тогда устанавливается Истина). +// +// Запрос - Запрос - установить параметры в указанный запрос и заменить на возвращаемое +// УсловиеЗапроса строку "&УсловиеОтбора" в тексте запроса, если есть. +// - Неопределено +// +// ДополнительныеПараметры - см. НовыеПараметрыОтбораЗаписейНабораИзБазыДанных +// +// Возвращаемое значение: +// Структура: +// * УсловиеЗапроса - Строка - условие для подстановки в текст запроса. +// * ПараметрыЗапроса - Структура из КлючИЗначение: +// ** Ключ - Строка - имя поля отбора или ЗначенияПолейОтбораСтрок с указанным префиксом. +// ** Значение - Произвольный - значение поля отбора или таблица значений. +// +// Пример: +// Запрос = Новый Запрос; +// Запрос.Текст = +// "ВЫБРАТЬ РАЗЛИЧНЫЕ +// | ТекущаяТаблица.Пользователь КАК Пользователь, +// | ТекущаяТаблица.ПотребоватьСменуПароляПриВходе КАК ПотребоватьСменуПароляПриВходе, +// | ТекущаяТаблица.СрокДействияНеОграничен КАК СрокДействияНеОграничен, +// | ТекущаяТаблица.СрокДействия КАК СрокДействия, +// | ТекущаяТаблица.ПросрочкаРаботыВПрограммеДоЗапрещенияВхода КАК ПросрочкаРаботыВПрограммеДоЗапрещенияВхода +// |ИЗ +// | РегистрСведений.СведенияОПользователях КАК ТекущаяТаблица +// |ГДЕ +// | &УсловиеОтбора"; +// ОбщегоНазначения.ОтборЗаписейНабораИзБазыДанных(НаборЗаписей, Замещение, Запрос); +// СуществующиеЗаписи = Запрос.Выполнить().Выгрузить(); +// +Функция ОтборЗаписейНабораИзБазыДанных(НаборЗаписей, Замещение = Неопределено, Запрос = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОтборЗаписейНабораИзБазыДанных(НаборЗаписей, Замещение, Запрос, ); +``` +
+ +## НовыеПараметрыОтбораЗаписейНабораИзБазыДанных +
+ +Описание, пример вызова + +```bsl + +// Дополнительные параметры для функции ОтборЗаписейНабораИзБазыДанных. +// +// Возвращаемое значение: +// Структура: +// * ПсевдонимТаблицы - Строка - префикс, добавляемый к именам полей +// (начальное значение "ТекущаяТаблица."). +// +// * ПрефиксИменПолейВПараметрах - Строка - префикс, добавляемый к именам +// полей отбора в условии и параметрах запроса (начальное значение без префикса). +// +// * ИмяПараметраТаблицыКлючевыхПолей - Строка - начальное значение ЗначенияПолейОтбораСтрок. +// +Функция НовыеПараметрыОтбораЗаписейНабораИзБазыДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.НовыеПараметрыОтбораЗаписейНабораИзБазыДанных() +``` +
+ +## ЗаписиНабораИзБазыДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает указанные поля строк регистра из базы данных, которые будут +// записаны при записи указанного набора записей с учетом режима замещения. +// +// Параметры: +// НаборЗаписей - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор записей, +// который используется вычисления изменений. +// +// Замещение - РежимЗамещения, Булево - как передается в подписку на событие ПередЗаписью. +// - Неопределено - получить и установить в этот параметр значение из свойства +// Замещение структуры ДополнительныеСвойства указанного набора записей +// (если свойства нет, тогда устанавливается Истина). +// +// СписокПолей - Строка - список полей набора записей через запятую. +// Если не указан, значит все поля набора записей. +// +// Возвращаемое значение: +// ТаблицаЗначений - поля из параметра СписокПолей, +// строки без повторений для указанного списка полей. +// +Функция ЗаписиНабораИзБазыДанных(НаборЗаписей, Замещение = Неопределено, СписокПолей = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗаписиНабораИзБазыДанных(НаборЗаписей, Замещение, СписокПолей); +``` +
+ +## ИзменениеЗаписейНабора +
+ +Описание, пример вызова + +```bsl + +// Возвращает удаленные и добавленные строки регистра +// для указанного набора записей с учетом режима замещения. +// +// Параметры: +// ЗаписиИзБазыДанных - см. ЗаписиНабораИзБазыДанных +// +// НаборЗаписей - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор записей, +// который используется вычисления изменений. +// +// Замещение - РежимЗамещения, Булево - как передается в подписку на событие ПередЗаписью. +// +// ТолькоИзменения - Булево - если установить Истина, тогда в результате +// не будет строк без изменений (ВидИзмененияСтроки = 0). +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ВидИзмененияСтроки - Число - если 1, то строка добавлена, +// если -1, то удалена, если 0, то не изменилась. +// Далее поля из таблицы ЗаписиИзБазыДанных. +// +Функция ИзменениеЗаписейНабора(ЗаписиИзБазыДанных, НаборЗаписей, Замещение, ТолькоИзменения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИзменениеЗаписейНабора(ЗаписиИзБазыДанных, НаборЗаписей, Замещение, ТолькоИзменения); +``` +
+ +## ХранилищеОбщихНастроекСохранить +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Сохранение, чтение и удаление настроек из хранилищ. + +// Сохраняет настройку в хранилище общих настроек, как метод платформы Сохранить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// Настройки - Произвольный - см. синтакс-помощник платформы. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеОбщихНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ХранилищеОбщихНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, ); +``` +
+ +## ХранилищеОбщихНастроекСохранитьМассив +
+ +Описание, пример вызова + +```bsl + +// Сохраняет несколько настроек в хранилище общих настроек, как метод платформы Сохранить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// Параметры: +// НесколькоНастроек - Массив - со значениями: +// * Значение - Структура: +// * Объект - Строка - см. параметр КлючОбъекта в синтакс-помощнике платформы. +// * Настройка - Строка - см. параметр КлючНастроек в синтакс-помощнике платформы. +// * Значение - Произвольный - см. параметр Настройки в синтакс-помощнике платформы. +// +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеОбщихНастроекСохранитьМассив(НесколькоНастроек, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ХранилищеОбщихНастроекСохранитьМассив(НесколькоНастроек, ); +``` +
+ +## ХранилищеОбщихНастроекЗагрузить +
+ +Описание, пример вызова + +```bsl + +// Загружает настройку из хранилища общих настроек, как метод платформы Загрузить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют. +// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки. +// +// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно +// - возвращаемая ссылка заменяется на указанное значение по умолчанию; +// - из данных типа Массив ссылки удаляются; +// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено; +// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно. +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// ЗначениеПоУмолчанию - Произвольный - значение, которое возвращается, если настройки не существуют. +// Если не указано, возвращается значение Неопределено. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// +// Возвращаемое значение: +// Произвольный - см. синтакс-помощник платформы. +// +Функция ХранилищеОбщихНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ХранилищеОбщихНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, ); +``` +
+ +## ХранилищеОбщихНастроекУдалить +
+ +Описание, пример вызова + +```bsl + +// Удаляет настройку из хранилища общих настроек, как метод платформы Удалить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки. +// +// Параметры: +// КлючОбъекта - Строка +// - Неопределено - см. синтакс-помощник платформы. +// КлючНастроек - Строка +// - Неопределено - см. синтакс-помощник платформы. +// ИмяПользователя - Строка +// - Неопределено - см. синтакс-помощник платформы. +// +Процедура ХранилищеОбщихНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ХранилищеОбщихНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) +``` +
+ +## ХранилищеСистемныхНастроекСохранить +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройку в хранилище системных настроек, как метод платформы Сохранить +// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек +// более 128 символов путем хеширования части, которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// Настройки - Произвольный - см. синтакс-помощник платформы. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеСистемныхНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ХранилищеСистемныхНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, ); +``` +
+ +## ХранилищеСистемныхНастроекЗагрузить +
+ +Описание, пример вызова + +```bsl + +// Загружает настройку из хранилища системных настроек, как метод платформы Загрузить, +// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек +// более 128 символов путем хеширования части, которая превышает 96 символов. +// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют. +// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки. +// +// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно: +// - возвращаемая ссылка заменяется на указанное значение по умолчанию; +// - из данных типа Массив ссылки удаляются; +// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено; +// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно. +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// ЗначениеПоУмолчанию - Произвольный - значение, которое возвращается, если настройки не существуют. +// Если не указано, возвращается значение Неопределено. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// +// Возвращаемое значение: +// Произвольный - см. синтакс-помощник платформы. +// +Функция ХранилищеСистемныхНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ХранилищеСистемныхНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, ); +``` +
+ +## ХранилищеСистемныхНастроекУдалить +
+ +Описание, пример вызова + +```bsl + +// Удаляет настройку из хранилища системных настроек, как метод платформы Удалить, +// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек +// более 128 символов путем хеширования части, которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки. +// +// Параметры: +// КлючОбъекта - Строка +// - Неопределено - см. синтакс-помощник платформы. +// КлючНастроек - Строка +// - Неопределено - см. синтакс-помощник платформы. +// ИмяПользователя - Строка +// - Неопределено - см. синтакс-помощник платформы. +// +Процедура ХранилищеСистемныхНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ХранилищеСистемныхНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) +``` +
+ +## ХранилищеНастроекДанныхФормСохранить +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройку в хранилище настроек данных форм, как метод платформы Сохранить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// Настройки - Произвольный - см. синтакс-помощник платформы. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеНастроекДанныхФормСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ХранилищеНастроекДанныхФормСохранить(КлючОбъекта, КлючНастроек, Настройки, ); +``` +
+ +## ХранилищеНастроекДанныхФормЗагрузить +
+ +Описание, пример вызова + +```bsl + +// Загружает настройку из хранилища настроек данных форм, как метод платформы Загрузить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют. +// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки. +// +// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно +// - возвращаемая ссылка заменяется на указанное значение по умолчанию; +// - из данных типа Массив ссылки удаляются; +// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено; +// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно. +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// ЗначениеПоУмолчанию - Произвольный - значение, которое возвращается, если настройки не существуют. +// Если не указано, возвращается значение Неопределено. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// +// Возвращаемое значение: +// Произвольный - см. синтакс-помощник платформы. +// +Функция ХранилищеНастроекДанныхФормЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ХранилищеНастроекДанныхФормЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, ); +``` +
+ +## ХранилищеНастроекДанныхФормУдалить +
+ +Описание, пример вызова + +```bsl + +// Удаляет настройку из хранилища настроек данных форм, как метод платформы Удалить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки. +// +// Параметры: +// КлючОбъекта - Строка +// - Неопределено - см. синтакс-помощник платформы. +// КлючНастроек - Строка +// - Неопределено - см. синтакс-помощник платформы. +// ИмяПользователя - Строка +// - Неопределено - см. синтакс-помощник платформы. +// +Процедура ХранилищеНастроекДанныхФормУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ХранилищеНастроекДанныхФормУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) +``` +
+ +## ЗначениеВСтрокуXML +
+ +Описание, пример вызова + +```bsl + +// Преобразует (сериализует) любое значение в XML-строку. +// Преобразованы в могут быть только те объекты, для которых в синтакс-помощнике указано, что они сериализуются. +// См. также ЗначениеИзСтрокиXML. +// +// Параметры: +// Значение - Произвольный - значение, которое необходимо сериализовать в XML-строку. +// +// Возвращаемое значение: +// Строка - XML-строка. +// +Функция ЗначениеВСтрокуXML(Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗначениеВСтрокуXML(Значение) +``` +
+ +## ЗначениеИзСтрокиXML +
+ +Описание, пример вызова + +```bsl + +// Выполняет преобразование (десериализацию) XML-строки в значение. +// См. также ЗначениеВСтрокуXML. +// +// Параметры: +// СтрокаXML - Строка - XML-строка, с сериализованным объектом.. +// +// Возвращаемое значение: +// Произвольный - значение, полученное из переданной XML-строки. +// +Функция ЗначениеИзСтрокиXML(СтрокаXML) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗначениеИзСтрокиXML(СтрокаXML) +``` +
+ +## ОбъектXDTOВСтрокуXML +
+ +Описание, пример вызова + +```bsl + +// Возвращает XML-представление XDTO-объекта. +// +// Параметры: +// ОбъектXDTO - ОбъектXDTO - объект, для которого требуется сформировать XML-представление. +// Фабрика - ФабрикаXDTO - фабрика, с использованием которой требуется формировать XML-представление. +// Если параметр не указан - будет использоваться глобальная фабрика XDTO. +// +// Возвращаемое значение: +// Строка - XML-представление XDTO-объекта. +// +Функция ОбъектXDTOВСтрокуXML(Знач ОбъектXDTO, Знач Фабрика = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОбъектXDTOВСтрокуXML(ОбъектXDTO, Фабрика); +``` +
+ +## ОбъектXDTOИзСтрокиXML +
+ +Описание, пример вызова + +```bsl + +// Формирует XDTO-объект по XML-представлению. +// +// Параметры: +// СтрокаXML - Строка - XML-представление XDTO-объекта, +// Фабрика - ФабрикаXDTO - фабрика, с использованием которой требуется формировать XDTO-объект. +// Если параметр не указан - будет использоваться глобальная фабрика XDTO. +// +// Возвращаемое значение: +// ОбъектXDTO - XDTO-объект. +// +Функция ОбъектXDTOИзСтрокиXML(Знач СтрокаXML, Знач Фабрика = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОбъектXDTOИзСтрокиXML(СтрокаXML, Фабрика); +``` +
+ +## ЗначениеВJSON +
+ +Описание, пример вызова + +```bsl + +// Преобразует значение в строку JSON при помощи метода глобального контекста ЗаписатьJSON. +// Допускаются не все типы значений, подробности см. в синтакс-помощнике. +// Даты преобразуются в формат ISO (YYYY-MM-DDThh:mm:ssZ). +// +// Параметры: +// Значение - Произвольный +// +// Возвращаемое значение: +// Строка +// +Функция ЗначениеВJSON(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗначениеВJSON(Значение) +``` +
+ +## JSONВЗначение +
+ +Описание, пример вызова + +```bsl + +// Преобразует строку в формате JSON в значение при помощи метода глобального контекста ПрочитатьJSON. +// См. ограничения в синтакс-помощнике. +// Объекты JSON по умолчанию преобразует в значения типа Соответствие. +// Имена свойств со значением типа Дата необходимо явно указывать, чтобы было выполнено преобразование. +// Ожидаемый формат дат - ISO (YYYY-MM-DDThh:mm:ssZ). +// +// Параметры: +// Строка - Строка - значение в формате JSON. +// ИменаСвойствСоЗначениямиДата - Строка - имя свойства, содержащее значение типа Дата. Допустимо указывать несколько +// свойств через запятую. +// - Массив из Строка +// ПрочитатьВСоответствие - Булево - если Ложь, то объекты JSON будут преобразованы в значение типа Структура. +// +// Возвращаемое значение: +// Произвольный +// +Функция JSONВЗначение(Знач Строка, Знач ИменаСвойствСоЗначениямиДата = Неопределено, Знач ПрочитатьВСоответствие = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.JSONВЗначение(Строка, ИменаСвойствСоЗначениямиДата, ПрочитатьВСоответствие); +``` +
+ +## РазрешенДоступКИнтернетСервисам +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что разрешена работа с Интернет-сервисами из приложения. +// Параметры: +// ПоказатьОшибку - Булево - вызвать исключение. +// +// Возвращаемое значение: +// Булево +// +Функция РазрешенДоступКИнтернетСервисам(ПоказатьОшибку = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.РазрешенДоступКИнтернетСервисам(ПоказатьОшибку); +``` +
+ +## ЗапрещенДоступКИнтернетСервисамТекстСообщения +
+ +Описание, пример вызова + +```bsl + +// Текст ошибки при отключенном доступе к сервисам интернета. +// +// Возвращаемое значение: +// Строка +// +Функция ЗапрещенДоступКИнтернетСервисамТекстСообщения() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЗапрещенДоступКИнтернетСервисамТекстСообщения() +``` +
+ +## НастроитьРаботуСИнтернетСервисами +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак разрешения работа с Интернет-сервисами из приложения. После вызова на клиенте рекомендуется +// вызвать оповещение о записи константы. +// +// Параметры: +// Разрешить - Булево +// +Процедура НастроитьРаботуСИнтернетСервисами(Разрешить) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.НастроитьРаботуСИнтернетСервисами(Разрешить) +``` +
+ +## ПараметрыПодключенияWSПрокси +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров для функции СоздатьWSПрокси. +// +// Возвращаемое значение: +// см. СоздатьWSПрокси.ПараметрыПодключенияWSПрокси +// +Функция ПараметрыПодключенияWSПрокси() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПараметрыПодключенияWSПрокси() +``` +
+ +## СоздатьWSПрокси +
+ +Описание, пример вызова + +```bsl + +// Конструктор объекта WSПрокси с дополнительными возможностями по сравнению с конструктором Новый WSПрокси: +// - создает WSОпределения; +// - кэширует файл WSDL для ускорения работы с веб-сервисом; +// - не требуется указание ИнтернетПрокси (используется автоматически, если настроен); +// - позволяет делать быструю проверку доступности сервиса с помощью операции Ping. +// +// Параметры: +// ПараметрыПодключенияWSПрокси - Структура: +// * АдресWSDL - Строка - месторасположение wsdl, например, "HTTP://webservice.net/webservice.asmx?wsdl". +// * URIПространстваИмен - Строка - URI пространства имен web-сервиса, например, "HTTP://www.webservice.net/WebService/1.0.0.1". +// * ИмяСервиса - Строка - имя сервиса, например, "WebService_1_0_0_1". +// * ИмяТочкиПодключения - Строка - необязательный параметр. Если не задано, образуется как "<ИмяСервиса>Soap". +// * ИмяПользователя - Строка - необязательный параметр. Имя пользователя для входа на сервер. +// * Пароль - Строка - необязательный параметр. Пароль пользователя. +// * Таймаут - Число - необязательный параметр. Таймаут на операции веб-сервиса, выполняемые +// через прокси. В секундах. +// * Местоположение - Строка - необязательный параметр. Фактический адрес сервиса. Используется, если +// адрес реального расположения сервиса отличается от адреса, который указан +// в WSDL-файле. +// * ИспользоватьАутентификациюОС - Булево - необязательный параметр. Включает использование авторизации NTLM или +// Negotiate на сервере. +// * ДелатьКонтрольныйВызов - Булево - необязательный параметр. Выполнять проверку доступности сервиса (требуется +// поддержка команды Ping в веб-сервисе). По умолчанию, Ложь. +// * ЗащищенноеСоединение - ЗащищенноеСоединениеOpenSSL +// - Неопределено - необязательные параметры защищенного соединения. +// * ПроверятьДоставкуПакетовПриОшибке - см. ПолучениеФайловИзИнтернета.ДиагностикаСоединения.ПроверятьДоставкуПакетов. +// * ПроверятьДоступКИнтернетСервисам - Булево - необязательный параметр, по умолчанию Истина - выполняется проверка +// разрешения доступа к Интернет-сервисам из приложения. +// +// Возвращаемое значение: +// WSПрокси +// +// Пример: +// ПараметрыПодключения = ОбщегоНазначения.ПараметрыПодключенияWSПрокси(); +// ПараметрыПодключения.АдресWSDL = "HTTP://webservice.net/webservice.asmx?wsdl"; +// ПараметрыПодключения.URIПространстваИмен = "HTTP://www.webservice.net/WebService/1.0.0.1"; +// ПараметрыПодключения.ИмяСервиса = "WebService_1_0_0_1"; +// ПараметрыПодключения.Таймаут = 20; +// Прокси = ОбщегоНазначения.СоздатьWSПрокси(ПараметрыПодключения); +// +Функция СоздатьWSПрокси(Знач ПараметрыПодключенияWSПрокси) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СоздатьWSПрокси(ПараметрыПодключенияWSПрокси) +``` +
+ +## ПолучитьВерсииИнтерфейса +
+ +Описание, пример вызова + +```bsl + +// Возвращает номера версий программных интерфейсов удаленной системы, доступной через веб-сервис. +// Позволяет обеспечивать полную обратную совместимость при изменениях в программных интерфейсах +// с помощью их явного версионирования. Например, если программный интерфейс выше определенной версии, +// то только в этом случае допустимо вызывать у него новую функцию. +// +// В целях экономии трафика при интенсивном взаимодействии между вызывающей и вызываемой сторонами +// сведения о версиях кэшируются на одни сутки. Если для целей отладки требуется сбросить кэш раньше этого времени, +// следует удалить соответствующие записи из регистра сведений КэшПрограммныхИнтерфейсов. +// +// Параметры: +// Адрес - Строка - адрес веб-сервиса версионирования интерфейсов InterfaceVersion; +// Пользователь - Строка - имя пользователя веб-сервиса; +// Пароль - Строка - пароль пользователя веб-сервиса; +// Интерфейс - Строка - имя запрашиваемого программного интерфейса, например, "СервисПередачиФайлов"; +// ПроверятьДоставкуПакетовПриОшибке - см. ПолучениеФайловИзИнтернета.ДиагностикаСоединения.ПроверятьДоставкуПакетов +// +// Возвращаемое значение: +// ФиксированныйМассив - массив строк, каждая строка является представлением номера версии интерфейса. +// Например, "1.0.2.1". +// +// Пример: +// Версии = ПолучитьВерсииИнтерфейса("HTTP://vsrvx/sm", "ivanov",, "СервисПередачиФайлов"); +// +// Также для обратной совместимости поддерживается устаревший вариант вызова: +// ПараметрыПодключения = Новый Структура; +// ПараметрыПодключения.Вставить("URL", "HTTP://vsrvx/sm"); +// ПараметрыПодключения.Вставить("UserName", "ivanov"); +// ПараметрыПодключения.Вставить("Password", ""); +// Версии = ПолучитьВерсииИнтерфейса(ПараметрыПодключения, "СервисПередачиФайлов"); +// +Функция ПолучитьВерсииИнтерфейса(Знач Адрес, Знач Пользователь, Знач Пароль = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПолучитьВерсииИнтерфейса(Адрес, Пользователь, Пароль, ); +``` +
+ +## ПолучитьВерсииИнтерфейсаЧерезВнешнееСоединение +
+ +Описание, пример вызова + +```bsl + +// Возвращает номера версий программных интерфейсов удаленной системы, подключенной через внешнее соединение. +// Позволяет обеспечивать полную обратную совместимость при изменениях в программных интерфейсах +// с помощью их явного версионирования. Например, если программный интерфейс выше определенной версии, +// то только в этом случае допустимо вызывать у него новую функцию. +// +// Параметры: +// ВнешнееСоединение - COMОбъект - внешнее соединение, которое используется для работы с удаленной системой. +// ИмяИнтерфейса - Строка - имя запрашиваемого программного интерфейса, например "СервисПередачиФайлов". +// +// Возвращаемое значение: +// ФиксированныйМассив - массив строк, каждая строка является представлением номера версии интерфейса. +// Например "1.0.2.1". +// +// Пример: +// Версии = ОбщегоНазначения.ПолучитьВерсииИнтерфейсаЧерезВнешнееСоединение(ВнешнееСоединение, "СервисПередачиФайлов"); +// +Функция ПолучитьВерсииИнтерфейсаЧерезВнешнееСоединение(ВнешнееСоединение, Знач ИмяИнтерфейса) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПолучитьВерсииИнтерфейсаЧерезВнешнееСоединение(ВнешнееСоединение, ИмяИнтерфейса) +``` +
+ +## УдалитьЗаписиКэшаВерсий +
+ +Описание, пример вызова + +```bsl + +// Удаляет записи кэша версий программных интерфейсов, содержащих в идентификаторе указанную подстроку. +// В качестве подстроки может использоваться, например, имя интерфейса, более не используемого в конфигурации. +// +// Параметры: +// ПодстрокаПоискаИдентификаторов - Строка - подстрока поиска идентификаторов. +// Не может содержать символов %, _ и [. +// +Процедура УдалитьЗаписиКэшаВерсий(Знач ПодстрокаПоискаИдентификаторов) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.УдалитьЗаписиКэшаВерсий(ПодстрокаПоискаИдентификаторов) +``` +
+ +## ВерсииИнтерфейсов +
+ +Описание, пример вызова + +```bsl + +// Список версий программных интерфейсов, доступных через web-сервис InterfaceVersions. +// +// Возвращаемое значение: +// Структура: +// * Ключ - Строка - имя программного интерфейса +// * Значение - Массив из Строка - поддерживаемые версии интерфейса. +// +Функция ВерсииИнтерфейсов() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ВерсииИнтерфейсов() +``` +
+ +## ЗаписатьДанныеВБезопасноеХранилище +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для работы с хранилищем паролей. + +// Записывает конфиденциальные данные в безопасное хранилище. +// Вызывающий код должен самостоятельно устанавливать привилегированный режим. +// +// Безопасное хранилище недоступно для чтения пользователям (кроме администраторов), +// а доступно только коду, который делает обращения только к своей части данных и +// в том контексте, который предполагает чтение или запись конфиденциальных данных. +// +// Параметры: +// Владелец - ПланОбменаСсылка +// - СправочникСсылка +// - Строка - ссылка на объект информационной базы, +// представляющий объект-владелец сохраняемого пароля или строка до 128 символов. +// Для объектов других типов в качестве владельца рекомендуется использовать ссылку на +// элемент метаданных этого типа в справочнике ИдентификаторыОбъектовМетаданных +// или ключ в виде строки с учетом имен подсистем. +// Например, для БСП: +// Владелец = ОбщегоНазначения.ИдентификаторОбъектаМетаданных("РегистрСведений.АдресныеОбъекты"); +// если нужно 1 хранилище на подсистему БСП: +// Владелец = "СтандартныеПодсистемы.УправлениеДоступом"; +// если нужно более 1 хранилища на подсистему БСП: +// Владелец = "СтандартныеПодсистемы.УправлениеДоступом.<Уточнение>"; +// Данные - Произвольный - данные помещаемые в безопасное хранилище. Неопределенно - удаляет все данные. +// Для удаления данных по ключу следует использовать процедуру УдалитьДанныеИзБезопасногоХранилища. +// - Структура - если параметр Ключ содержит Неопределено. Подробнее см. описание параметра Ключ +// Ключ - Строка - ключ сохраняемых настроек, по умолчанию "Пароль". +// Ключ должен соответствовать правилам имен идентификаторов: +// 1. Первым символом ключа должна быть буква или символ подчеркивания (_). +// 2. Каждый из последующих символов может быть буквой, цифрой или символом подчеркивания (_). +// Неопределено - для добавления набора данных структурой, где ключ структуры - это имя ключа данных, +// а значение - сохраняемые данные. Пример использования см. ниже. +// +// Пример: +// +// Процедура ПриЗаписиНаСервере(Отказ, ТекущийОбъект, ПараметрыЗаписи) +// Если ТекущийПользовательМожетИзменятьПароль Тогда +// УстановитьПривилегированныйРежим(Истина); +// ОбщегоНазначения.ЗаписатьДанныеВБезопасноеХранилище(ТекущийОбъект.Ссылка, Логин, "Логин"); +// ОбщегоНазначения.ЗаписатьДанныеВБезопасноеХранилище(ТекущийОбъект.Ссылка, Пароль); +// УстановитьПривилегированныйРежим(Ложь); +// КонецЕсли; +// КонецПроцедуры +// +// Процедура ПриЗаписиНаСервере(Отказ, ТекущийОбъект, ПараметрыЗаписи) +// Если ТекущийПользовательМожетИзменятьПароль Тогда +// ЛогинИПароль = Новый Структура; +// ЛогинИПароль.Вставить("Логин", Логин); +// ЛогинИПароль.Вставить("Пароль", Пароль); +// УстановитьПривилегированныйРежим(Истина); +// ОбщегоНазначения.ЗаписатьДанныеВБезопасноеХранилище(ТекущийОбъект.Ссылка, ЛогинИПароль, Неопределено); +// УстановитьПривилегированныйРежим(Ложь); +// КонецЕсли; +// КонецПроцедуры +// +Процедура ЗаписатьДанныеВБезопасноеХранилище(Владелец, Данные, Ключ = "Пароль") Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ЗаписатьДанныеВБезопасноеХранилище(Владелец, Данные, Ключ); +``` +
+ +## ПрочитатьДанныеВладельцевИзБезопасногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные из безопасного хранилища. +// Вызывающий код должен самостоятельно устанавливать привилегированный режим. +// +// Безопасное хранилище недоступно для чтения пользователям (кроме администраторов), +// а доступно только коду, который делает обращения только к своей части данных и +// в том контексте, который предполагает чтение или запись конфиденциальных данных. +// +// Параметры: +// Владельцы - Массив из ПланОбменаСсылка +// - Массив из СправочникСсылка +// - Массив из Строка - ссылки на объекты информационной базы, +// представляющих объекты-владельцы или уникальные строки(до 128 символов) владельцев данных. +// Ключи - Строка - содержит имя ключа данных или список имен ключей, указанных через запятую. +// - Неопределено - будут возвращены все сохраненные данные переданных владельцев. +// ОбщиеДанные - Булево - Истина, если требуется в модели сервиса получить данные из общих данных в разделенном режиме. +// ОбластьДанных - Число - содержит номер области данных для которой необходимо выполнить получение данных из +// безопасного хранилища области данных. Параметр следует передавать только в случае получения +// данных из неразделенного сеанса для области данных. Во всех остальных случаях параметр +// игнорируется. +// Неопределено - режим получения данных из безопасного хранилища определяется автоматический +// по доступности использования разделенных данных. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ПланОбменаСсылка +// - СправочникСсылка +// - Строка - ссылка на объект информационной базы +// или строка до 128 символов идентифицирующая владельца данных. +// * Значение - Произвольный - если в параметре Ключи указан один ключ, +// то возвращается его значение произвольного типа. +// - Структура - если в параметре Ключи указано несколько ключей или Неопределено, +// где ключ структуры - это имя ключа сохраненных данных, +// а значение - данные произвольного типа. Когда для ключа отсутствуют данные, +// то значение содержит Неопределено. +// - Неопределено - если данные по ключу отсутствуют. +// +// Пример: +// Процедура РассылкаПриглашений(Пользователи) +// +// УстановитьПривилегированныйРежим(Истина); +// ДанныеАвторизации = ОбщегоНазначения.ПрочитатьДанныеИзБезопасногоХранилища(Пользователи, "Логин, Пароль"); +// УстановитьПривилегированныйРежим(Ложь); +// +// Для каждого Пользователь Из Пользователи Цикл +// ОтправитьПриглашение(Пользователь, ДанныеАвторизации[Пользователь]); +// КонецЦикла; +// +// КонецПроцедуры +// +Функция ПрочитатьДанныеВладельцевИзБезопасногоХранилища( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПрочитатьДанныеВладельцевИзБезопасногоХранилища(); +``` +
+ +## ПрочитатьДанныеИзБезопасногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные из безопасного хранилища. +// Вызывающий код должен самостоятельно устанавливать привилегированный режим. +// +// Безопасное хранилище недоступно для чтения пользователям (кроме администраторов), +// а доступно только коду, который делает обращения только к своей части данных и +// в том контексте, который предполагает чтение или запись конфиденциальных данных. +// +// Параметры: +// Владелец - ПланОбменаСсылка +// - СправочникСсылка +// - Строка - ссылка на объект информационной базы, +// представляющий объект-владелец сохраняемого пароля или уникальная строка(до 128 символов). +// Ключи - Строка - содержит список имен сохраненных данных, указанных через запятую. +// - Неопределено - будут возвращены все сохраненные данные владельца. +// ОбщиеДанные - Булево - Истина, если требуется в модели сервиса получить данные из общих данных в разделенном режиме. +// ОбластьДанных - Число - содержит номер области данных для которой необходимо выполнить получение данных из +// безопасного хранилища области данных. Параметр следует передавать только в случае получения +// данных из неразделенного сеанса для области данных. Во всех остальных случаях параметр +// игнорируется. +// Неопределено - режим получения данных из безопасного хранилища определяется автоматический +// по доступности использования разделенных данных. +// +// Возвращаемое значение: +// Произвольный, Структура, Неопределено - данные из безопасного хранилища. Если указан один ключ, +// то возвращается его значение, иначе структура. +// Если данные отсутствуют - Неопределенно. +// +// Пример: +// Если ТекущийПользовательМожетИзменятьПароль Тогда +// УстановитьПривилегированныйРежим(Истина); +// Логин = ОбщегоНазначения.ПрочитатьДанныеИзБезопасногоХранилища(ТекущийОбъект.Ссылка, "Логин"); +// Пароль = ОбщегоНазначения.ПрочитатьДанныеИзБезопасногоХранилища(ТекущийОбъект.Ссылка); +// УстановитьПривилегированныйРежим(Ложь); +// Иначе +// Элементы.ГруппаЛогинИПароль.Видимость = Ложь; +// КонецЕсли; +// +// УстановитьПривилегированныйРежим(Истина); +// ЛогинИПароль = ОбщегоНазначения.ПрочитатьДанныеИзБезопасногоХранилища(ТекущийОбъект.Ссылка, Неопределено); +// +Функция ПрочитатьДанныеИзБезопасногоХранилища( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПрочитатьДанныеИзБезопасногоХранилища(); +``` +
+ +## УдалитьДанныеИзБезопасногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Удаляет конфиденциальные данные в безопасное хранилище. +// Вызывающий код должен самостоятельно устанавливать привилегированный режим. +// +// Безопасное хранилище недоступно для чтения пользователям (кроме администраторов), +// а доступно только коду, который делает обращения только к своей части данных и +// в том контексте, который предполагает чтение или запись конфиденциальных данных. +// +// Параметры: +// Владелец - ПланОбменаСсылка +// - СправочникСсылка +// - Строка - ссылка на объект информационной базы, +// представляющий объект-владелец сохраняемого пароля или уникальная строка(до 128 символов). +// - Массив - ссылки на объекты информационной базы для удаления данным по нескольким владельцам. +// Ключи - Строка - содержит список имен удаляемых данных, указанных через запятую. +// Неопределено - удаляет все данные. +// +// Пример: +// Процедура ПередУдалением(Отказ) +// +// // Проверка значения свойства ОбменДанными.Загрузка отсутствует, так как удалять данные +// // из безопасного хранилища нужно даже при удалении объекта при обмене данными. +// +// УстановитьПривилегированныйРежим(Истина); +// ОбщегоНазначения.УдалитьДанныеИзБезопасногоХранилища(Ссылка); +// УстановитьПривилегированныйРежим(Ложь); +// +// КонецПроцедуры +// +Процедура УдалитьДанныеИзБезопасногоХранилища(Знач Владелец, Знач Ключи = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.УдалитьДанныеИзБезопасногоХранилища(Владелец, Ключи); +``` +
+ +## СкопироватьСтрокиВБуферОбмена +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для работы с внутренним буфером обмена. + +// Помещает выделенные строки табличной части во внутренний буфер обмена +// откуда их можно получить с помощью СтрокиИзБуфераОбмена. +// +// Параметры: +// ТабличнаяЧасть - ДанныеФормыКоллекция - табличная часть, строки которой +// необходимо поместить во внутренний буфер обмена. +// ВыделенныеСтроки - Массив - массив идентификаторов выделенных строк. +// Источник - Строка - произвольный строковый идентификатор, например, имя объекта, +// строки табличной части которого помещаются во внутренний буфер обмена. +// +Процедура СкопироватьСтрокиВБуферОбмена(ТабличнаяЧасть, ВыделенныеСтроки, Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.СкопироватьСтрокиВБуферОбмена(ТабличнаяЧасть, ВыделенныеСтроки, Источник); +``` +
+ +## СкопироватьВБуферОбмена +
+ +Описание, пример вызова + +```bsl + +// Помещает произвольные данные во внутренний буфер обмена, откуда их можно получить с помощью СтрокиИзБуфераОбмена. +// +// Параметры: +// Данные - Произвольный - данные, которые необходимо поместить в внутренний буфер обмена. +// Источник - Строка - произвольный строковый идентификатор, например, имя объекта, +// строки табличной части которого помещаются во внутренний буфер обмена. +// +Процедура СкопироватьВБуферОбмена(Данные, Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.СкопироватьВБуферОбмена(Данные, Источник); +``` +
+ +## СтрокиИзБуфераОбмена +
+ +Описание, пример вызова + +```bsl + +// Получает строки табличной части, помещенные во внутренний буфер обмена с помощью СкопироватьСтрокиВБуферОбмена. +// +// Возвращаемое значение: +// Структура: +// * Данные - Произвольный - данные из внутреннего буфера обмена. +// Например, ТаблицаЗначений при вызове СкопироватьСтрокиВБуферОбмена. +// * Источник - Строка - объект, к которому относятся данные. +// Если при помещении во внутренний буфер не был указан, то Неопределено. +// +Функция СтрокиИзБуфераОбмена() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СтрокиИзБуфераОбмена() +``` +
+ +## ПустойБуферОбмена +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие сохраненных данных во внутренний буфере обмена. +// +// Параметры: +// Источник - Строка - если передан, то проверяется наличие данных +// в внутреннем буфере обмена с этим ключом. +// По умолчанию - Неопределено. +// Возвращаемое значение: +// Булево - Истина, если пустой. +// +Функция ПустойБуферОбмена(Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПустойБуферОбмена(Источник); +``` +
+ +## ВыполнитьМетодКонфигурации +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции для поддержки работы конфигурации с профилем безопасности, в котором +// запрещено подключение внешних модулей без установки безопасного режима. +// + +// Выполнить экспортную процедуру по имени с уровнем привилегий конфигурации. +// При включении профилей безопасности для вызова оператора Выполнить() используется +// переход в безопасный режим с профилем безопасности, используемым для информационной базы +// (если выше по стеку не был установлен другой безопасный режим). +// +// Параметры: +// ИмяМетода - Строка - имя экспортной процедуры в формате +// <имя объекта>.<имя процедуры>, где <имя объекта> - это +// общий модуль или модуль менеджера объекта. +// Параметры - Массив - параметры передаются в процедуру <ИмяЭкспортнойПроцедуры> +// в порядке расположения элементов массива. +// +// Пример: +// Параметры = Новый Массив(); +// Параметры.Добавить("1"); +// ОбщегоНазначения.ВыполнитьМетодКонфигурации("МойОбщийМодуль.МояПроцедура", Параметры); +// +Процедура ВыполнитьМетодКонфигурации(Знач ИмяМетода, Знач Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ВыполнитьМетодКонфигурации(ИмяМетода, Параметры); +``` +
+ +## ВыполнитьМетодОбъекта +
+ +Описание, пример вызова + +```bsl + +// Выполнить экспортную процедуру объекта встроенного языка по имени. +// При включении профилей безопасности для вызова оператора Выполнить() используется +// переход в безопасный режим с профилем безопасности, используемым для информационной базы +// (если выше по стеку не был установлен другой безопасный режим). +// +// Параметры: +// Объект - Произвольный - объект встроенного языка 1С:Предприятия, содержащий методы (например, ОбработкаОбъект). +// ИмяМетода - Строка - имя экспортной процедуры модуля объекта обработки. +// Параметры - Массив - параметры передаются в процедуру <ИмяПроцедуры> +// в порядке расположения элементов массива. +// +Процедура ВыполнитьМетодОбъекта(Знач Объект, Знач ИмяМетода, Знач Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ВыполнитьМетодОбъекта(Объект, ИмяМетода, Параметры); +``` +
+ +## ВыполнитьВБезопасномРежиме +
+ +Описание, пример вызова + +```bsl + +// Выполняет произвольный алгоритм на встроенном языке 1С:Предприятия, предварительно устанавливая +// безопасный режим выполнения кода и безопасный режим разделения данных для всех разделителей, +// присутствующих в составе конфигурации. +// +// Для выполняемого кода так же применяются дополнительные ограничения, запрещается: +// +// 1) Вызов методов: +// - Выполнить +// - Вычислить +// - Подключить (для внешних обработок) +// - ЗафиксироватьТранзакцию +// - СократитьЖурналРегистрации +// - УстановитьИспользованиеСобытияЖурналаРегистрации +// - ЗапуститьПриложение +// +// 2) Вызов общих модулей и свойств глобального контекста: +// - ДлительныеОперации +// - ПользователиИнформационнойБазы +// +// Помимо этого рекомендуется вызывать метод вне транзакции, тогда выполняемый код будет +// автоматически выполнен в транзакции с ее отменой по завершении, что позволит более +// надежно защититься от изменения данных выполняемым кодом. +// +// Параметры: +// Алгоритм - Строка - алгоритм на встроенном языке "1С:Предприятия". +// Параметры - Произвольный - контекст, который требуется для выполнения алгоритма. +// В тексте алгоритма обращение к контексту должно происходить по имени "Параметры". +// Например, выражение "Параметры.Значение1 = Параметры.Значение2" обращается к значениям +// "Значение1" и "Значение2", переданным в Параметры, как свойства. +// ПараметрыПроверкиАлгоритма - см. ОбщегоНазначения.ПараметрыПроверкиАлгоритма +// Позволяет указать список методов, модулей и свойств глобального контекста, использование +// которых не допускается при выполнении алгоритма. Дополняет базовую проверку. +// +// Пример: +// +// // Пример 1 +// Параметры = Новый Структура; +// Параметры.Вставить("Значение1", 1); +// Параметры.Вставить("Значение2", 10); +// ОбщегоНазначения.ВыполнитьВБезопасномРежиме("Параметры.Значение1 = Параметры.Значение2", Параметры); +// +// // Пример 2 +// Параметры = Новый Структура; +// Параметры.Вставить("Источник", Источник); +// Параметры.Вставить("Результат", Неопределено); +// ПараметрыПроверкиАлгоритма = ОбщегоНазначения.ПараметрыПроверкиАлгоритма(); +// ПараметрыПроверкиАлгоритма.НедопустимыеМетоды.Добавить("Записать"); +// ПараметрыПроверкиАлгоритма.НедопустимыеМетоды.Добавить("Base64Значение"); +// ОбщегоНазначения.ВыполнитьВБезопасномРежиме(ВычисляемоеВыражение, Параметры, ПараметрыПроверкиАлгоритма); +// +Процедура ВыполнитьВБезопасномРежиме(Знач Алгоритм, Знач Параметры = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ВыполнитьВБезопасномРежиме(Алгоритм, Параметры, ); +``` +
+ +## ВычислитьВБезопасномРежиме +
+ +Описание, пример вызова + +```bsl + +// Вычисляет переданное выражение, предварительно устанавливая безопасный режим выполнения кода +// и безопасный режим разделения данных для всех разделителей, присутствующих в составе конфигурации. +// +// Для выполняемого кода так же применяются дополнительные ограничения, запрещается: +// +// 1) Вызов методов: +// - Выполнить +// - Вычислить +// - Подключить (для внешних обработок) +// - ЗафиксироватьТранзакцию +// - СократитьЖурналРегистрации +// - УстановитьИспользованиеСобытияЖурналаРегистрации +// - ЗапуститьПриложение +// +// 2) Вызов общих модулей и свойств глобального контекста: +// - ДлительныеОперации +// - ПользователиИнформационнойБазы +// +// Помимо этого рекомендуется вызывать метод вне транзакции, тогда выполняемый код будет +// автоматически выполнен в транзакции с ее отменой по завершении, что позволит более +// надежно защититься от изменения данных выполняемым кодом. +// +// Параметры: +// Выражение - Строка - выражение на встроенном языке 1С:Предприятия. +// Параметры - Произвольный - контекст, который требуется для вычисления выражения. +// В тексте выражения обращение к контексту должно происходить по имени "Параметры". +// Например, выражение "Параметры.Значение1 = Параметры.Значение2" обращается к значениям +// "Значение1" и "Значение2" переданные в Параметры, как свойства. +// ПараметрыПроверкиАлгоритма - см. ОбщегоНазначения.ПараметрыПроверкиАлгоритма +// Позволяет указать список методов, модулей и свойств глобального контекста, использование +// которых не допускается при выполнении алгоритма. Дополняет базовую проверку. +// +// Возвращаемое значение: +// Произвольный - результат вычисления выражения. +// +// Пример: +// +// // Пример 1 +// Параметры = Новый Структура; +// Параметры.Вставить("Значение1", 1); +// Параметры.Вставить("Значение2", 10); +// Результат = ОбщегоНазначения.ВычислитьВБезопасномРежиме("Параметры.Значение1 = Параметры.Значение2", Параметры); +// +// // Пример 2 +// Результат = ОбщегоНазначения.ВычислитьВБезопасномРежиме("СтандартныеПодсистемыСервер.ВерсияБиблиотеки()"); +// +Функция ВычислитьВБезопасномРежиме(Знач Выражение, Знач Параметры = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ВычислитьВБезопасномРежиме(Выражение, Параметры, ); +``` +
+ +## ОписаниеЗащитыБезПредупреждений +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание защиты от опасных действий с отключенными предупреждениями. +// +// Возвращаемое значение: +// ОписаниеЗащитыОтОпасныхДействий - со свойством ПредупреждатьОбОпасныхДействиях = Ложь. +// +Функция ОписаниеЗащитыБезПредупреждений() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОписаниеЗащитыБезПредупреждений() +``` +
+ +## ПараметрыПроверкиАлгоритма +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры для параметра ПараметрыПроверкиАлгоритма функций +// ОбщегоНазначения.ВыполнитьВБезопасномРежиме и ОбщегоНазначения.ВычислитьВБезопасномРежиме. +// +// Возвращаемое значение: +// Структура: +// * НедопустимыеМетоды - Массив из Строка - список методов, вызов которых не допускается при +// выполнении алгоритма. +// * ЗапрещенныеСвойстваГлобальногоКонтекста - Массив из Строка - список свойств глобального контекста, +// обращение к которым не допускается при выполнении алгоритма. +// * ЗапрещенныеМодули - Массив из Строка - список модулей, использование которых не допускается при +// выполнении алгоритма. +// +Функция ПараметрыПроверкиАлгоритма() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПараметрыПроверкиАлгоритма() +``` +
+ +## СформироватьСтрокуДляПоискаВЗапросе +
+ +Описание, пример вызова + +```bsl + +// Подготавливает строку для использования в качестве шаблона поиска в запросе с оператором ПОДОБНО. +// Экранирует служебные символы, если они есть в строке. +// +// Параметры: +// СтрокаПоиска - Строка - произвольная строка. +// +// Возвращаемое значение: +// Строка +// +// Пример: +// ВЫБРАТЬ +// Номенклатура.Ссылка КАК Ссылка +// ИЗ +// Справочник.Номенклатура КАК Номенклатура +// ГДЕ +// Номенклатура.Наименование ПОДОБНО &Шаблон СПЕЦСИМВОЛ "~" +// +// Запрос.УстановитьПараметр("Шаблон", ОбщегоНазначения.СформироватьСтрокуДляПоискаВЗапросе(ИскомыйТекст)); +// +Функция СформироватьСтрокуДляПоискаВЗапросе(Знач СтрокаПоиска) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СформироватьСтрокуДляПоискаВЗапросе(СтрокаПоиска) +``` +
+ +## РазделительПакетаЗапросов +
+ +Описание, пример вызова + +```bsl + +// Возвращает фрагмент текста запроса, отделяющего один запрос от другого. +// +// Возвращаемое значение: +// Строка - разделитель запросов. +// +Функция РазделительПакетаЗапросов() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.РазделительПакетаЗапросов() +``` +
+ +## ТекстОбъединитьВсе +
+ +Описание, пример вызова + +```bsl + +// Возвращает фрагмент текста запроса, объединяющего результаты запросов в один запрос. +// +// Возвращаемое значение: +// Строка +// +Функция ТекстОбъединитьВсе() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ТекстОбъединитьВсе() +``` +
+ +## ПриНачалеВыполненияРегламентногоЗадания +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверки перед выполнением обработчика регламентного задания и прерывает выполнение, +// если его запуск в данный момент невозможен, например: +// - еще не завершено обновление программы; +// - запуск через консоль или другим способом, минуя включение функциональной опции +// (если регламентное задание зависит от функциональных опций); +// - попытка выполнения задания, работающего с внешними ресурсами в копии информационной базы. +// +// Параметры: +// РегламентноеЗадание - ОбъектМетаданныхРегламентноеЗадание - регламентное задание, +// из которого вызывается данная процедура. +// +// Пример: +// ОбщегоНазначения.ПриНачалеВыполненияРегламентногоЗадания(Метаданные.РегламентныеЗадания.<ИмяРегламентногоЗадания>); +// +Процедура ПриНачалеВыполненияРегламентногоЗадания(РегламентноеЗадание = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ПриНачалеВыполненияРегламентногоЗадания(РегламентноеЗадание); +``` +
+ +## ОчиститьПараметрыСеанса +
+ +Описание, пример вызова + +```bsl + +// Переводит параметры сеанса в состояние "Не установлено". +// +// Параметры: +// ПараметрыДляОчистки - Строка - имена параметров сеанса для очистки, разделенные ",". +// Исключения - Строка - имена параметров сеанса не предназначенные для очистки, разделенные ",". +// +Процедура ОчиститьПараметрыСеанса(ПараметрыДляОчистки = "", Исключения = "") Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ОчиститьПараметрыСеанса(ПараметрыДляОчистки, Исключения); +``` +
+ +## ПроверитьВыводТабличногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Проверяет, умещаются ли переданные табличные документы на страницу при печати. +// +// Параметры: +// ТабДокумент - ТабличныйДокумент - табличный документ. +// ВыводимыеОбласти - Массив +// - ТабличныйДокумент - массив из проверяемых таблиц или табличный документ. +// РезультатПриОшибке - Булево - какой возвращать результат при возникновении ошибки. +// +// Возвращаемое значение: +// Булево - умещаются или нет переданные документы. +// +Функция ПроверитьВыводТабличногоДокумента(ТабДокумент, ВыводимыеОбласти, РезультатПриОшибке = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПроверитьВыводТабличногоДокумента(ТабДокумент, ВыводимыеОбласти, РезультатПриОшибке); +``` +
+ +## СохранитьПерсональныеНастройки +
+ +Описание, пример вызова + +```bsl + +// Сохраняет персональные настройки пользователя, относящиеся к подсистеме БазоваяФункциональность. +// Для получения настроек предусмотрены следующие функции: +// - СтандартныеПодсистемыСервер.ЗапрашиватьПодтверждениеПриЗавершенииПрограммы, +// - СтандартныеПодсистемыСервер.ПоказыватьПредупреждениеОбУстановленныхОбновленияхПрограммы, +// - ФайловаяСистемаКлиент.ПодключитьРасширениеДляРаботы1СПредприятия. +// +// Параметры: +// Настройки - Структура: +// * НапоминатьОбУстановкеРасширенияРаботыСФайлами - Булево - если Истина, то напоминать об установке +// расширения для работы с 1С:Предприятием в веб-клиенте. +// * ЗапрашиватьПодтверждениеПриЗавершенииПрограммы - Булево - запрашивать подтверждение по завершении работы. +// * ПоказыватьПредупреждениеОбУстановленныхОбновленияхПрограммы - Булево - показывать оповещение при +// динамическом обновлении приложения. +// +Процедура СохранитьПерсональныеНастройки(Настройки) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.СохранитьПерсональныеНастройки(Настройки) +``` +
+ +## РаспределитьСуммуПропорциональноКоэффициентам +
+ +Описание, пример вызова + +```bsl + +// Выполняет пропорциональное распределение суммы в соответствии +// с заданными коэффициентами распределения. +// +// Параметры: +// РаспределяемаяСумма - Число - сумма, которую надо распределить, если сумма равна 0 - то возвращается Неопределено; +// Если передана отрицательная - расчет по модулю и после инверсия знаков результата. +// Коэффициенты - Массив из Число - коэффициенты распределения, должны быть положительны или отрицательными +// одновременно. +// Точность - Число - точность округления при распределении. +// +// Возвращаемое значение: +// Массив из Число - массив размерностью равный массиву коэффициентов, содержит +// суммы в соответствии с весом коэффициента (из массива коэффициентов). +// В случае, если распределить невозможно (кол-во коэффициентов = 0 +// есть коэффициенты с отрицательным значением или суммарный вес коэффициентов = 0), +// тогда будет возвращено Неопределено. +// +// Пример: +// +// Коэффициенты = Новый Массив; +// Коэффициенты.Добавить(1); +// Коэффициенты.Добавить(2); +// Результат = ОбщегоНазначенияКлиентСервер.РаспределитьСуммуПропорциональноКоэффициентам(1, Коэффициенты); +// // Результат = [0.33, 0.67] +// +Функция РаспределитьСуммуПропорциональноКоэффициентам( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.РаспределитьСуммуПропорциональноКоэффициентам(); +``` +
+ +## ЗаполнитьКоллекциюЭлементовДереваДанныхФормы +
+ +Описание, пример вызова + +```bsl + +// Процедура предназначена для заполнения реквизита формы типа ДанныеФормыДерево. +// +// Параметры: +// КоллекцияЭлементовДерева - ДанныеФормыКоллекцияЭлементовДерева - реквизит, который нужно заполнить. +// ДеревоЗначений - ДеревоЗначений - данные для заполнения. +// +Процедура ЗаполнитьКоллекциюЭлементовДереваДанныхФормы(КоллекцияЭлементовДерева, ДеревоЗначений) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.ЗаполнитьКоллекциюЭлементовДереваДанныхФормы(КоллекцияЭлементовДерева, ДеревоЗначений) +``` +
+ +## ПодключитьКомпонентуИзМакета +
+ +Описание, пример вызова + +```bsl + +// Подключает внешнюю компоненту, выполненную по технологии Native API или COM, +// из макета конфигурации (хранится в виде ZIP-архива). +// +// Параметры: +// Идентификатор - Строка - идентификатор объекта внешней компоненты. +// ПолноеИмяМакета - Строка - полное имя макета конфигурации с ZIP-архивом. +// Изолированно - Булево - если Истина, компонента должна подключаться изолированно, +// в этом случае она загружается в отдельный процесс операционной системы. +// Если Ложь, то в этом случае компонента будет выполняться в том же процессе +// операционной системы, который выполняет код встроенного языка. +// - Неопределено - (по умолчанию Неопределено) соответствует поведению платформы: +// не изолированно - если компонентой поддерживается только этот режим, +// изолированно - в остальных случаях. +// См. https://its.1c.eu/db/v83doc#bookmark:dev:TI000001866 +// +// Возвращаемое значение: +// - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты. +// - Неопределено - если не удалось создать. +// +// Пример: +// +// ПодключаемыйМодуль = ОбщегоНазначения.ПодключитьКомпонентуИзМакета( +// "QRCodeExtension", +// "ОбщийМакет.КомпонентаПечатиQRКода"); +// +// Если ПодключаемыйМодуль <> Неопределено Тогда +// // ПодключаемыйМодуль содержит созданный экземпляр подключенной компоненты. +// КонецЕсли; +// +// ПодключаемыйМодуль = Неопределено; +// +Функция ПодключитьКомпонентуИзМакета(Знач Идентификатор, Знач ПолноеИмяМакета, Знач Изолированно = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ПодключитьКомпонентуИзМакета(Идентификатор, ПолноеИмяМакета, Изолированно); +``` +
+ +## ЭтоДобавлениеНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что указанный режим соответствует добавлению набора записей. +// +// Параметры: +// Режим - Булево, РежимЗамещения +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоДобавлениеНабораЗаписей(Режим) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоДобавлениеНабораЗаписей(Режим) +``` +
+ +## ЭтоЗамещениеНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что указанный режим соответствует замещению набора записей. +// +// Параметры: +// Режим - Булево, РежимЗамещения +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоЗамещениеНабораЗаписей(Режим) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоЗамещениеНабораЗаписей(Режим) +``` +
+ +## ЭтоОбновлениеНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что указанный режим соответствует обновлению набора записей. +// +// Параметры: +// Режим - Булево, РежимЗамещения +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоОбновлениеНабораЗаписей(Режим) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоОбновлениеНабораЗаписей(Режим) +``` +
+ +## ЭтоСлияниеНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что указанный режим соответствует слиянию набора записей. +// +// Параметры: +// Режим - Булево, РежимЗамещения +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоСлияниеНабораЗаписей(Режим) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоСлияниеНабораЗаписей(Режим) +``` +
+ +## ЭтоУдалениеНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что указанный режим соответствует удалению набора записей. +// +// Параметры: +// Режим - Булево, РежимЗамещения +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоУдалениеНабораЗаписей(Режим) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоУдалениеНабораЗаписей(Режим) +``` +
+ +## РежимОбновленияНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Возвращает РежимЗамещения.Обновление или Неопределено, +// если не поддерживается в текущей версии 1С:Предприятия. +// +// Возвращаемое значение: +// Неопределено, РежимЗамещения +// +Функция РежимОбновленияНабораЗаписей() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.РежимОбновленияНабораЗаписей() +``` +
+ +## РежимСлиянияНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Возвращает РежимЗамещения.Слияние или Неопределено, +// если не поддерживается в текущей версии 1С:Предприятия. +// +// Возвращаемое значение: +// Неопределено, РежимЗамещения +// +Функция РежимСлиянияНабораЗаписей() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.РежимСлиянияНабораЗаписей() +``` +
+ +## РежимУдаленияНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Возвращает РежимЗамещения.Удаление или Неопределено, +// если не поддерживается в текущей версии 1С:Предприятия. +// +// Возвращаемое значение: +// Неопределено, РежимЗамещения +// +Функция РежимУдаленияНабораЗаписей() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.РежимУдаленияНабораЗаписей() +``` +
+ +## ИспользованиеРазделителяСеанса +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать +// ОбщегоНазначения.РазделениеВключено И ОбщегоНазначения.ДоступноИспользованиеРазделенныхДанных. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользованиеРазделителяСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ИспользованиеРазделителяСеанса() +``` +
+ +## СоздатьВременныйКаталог +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистема.СоздатьВременныйКаталог +// Создает временный каталог. После окончания работы с временным каталогом его необходимо удалить +// с помощью ОбщегоНазначения.УдалитьВременныйКаталог. +// +// Параметры: +// Расширение - Строка - расширение каталога, которое идентифицирует назначение временного каталога +// и подсистему, которая его создала. +// Рекомендуется указывать на английском языке. +// +// Возвращаемое значение: +// Строка - полный путь к каталогу с разделителем пути. +// +Функция СоздатьВременныйКаталог(Знач Расширение = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.СоздатьВременныйКаталог(Расширение); +``` +
+ +## УдалитьВременныйКаталог +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистема.УдалитьВременныйКаталог +// Удаляет временный каталог вместе с его содержимым, если возможно. +// Если временный каталог не может быть удален (например, он занят каким-то процессом), +// то в журнал регистрации записывается соответствующее предупреждение, а процедура завершается. +// +// Для совместного использования с ОбщегоНазначения.СоздатьВременныйКаталог, +// после окончания работы с временным каталогом. +// +// Параметры: +// ПутьККаталогу - Строка - полный путь к временному каталогу. +// +Процедура УдалитьВременныйКаталог(Знач ПутьККаталогу) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначения.УдалитьВременныйКаталог(ПутьККаталогу) +``` +
+ +## ЕстьЗащитаОтОпасныхДействий +
+ +Описание, пример вызова + +```bsl + +// Устарела. Проверяет наличие механизма платформы, предупреждающего об опасных действиях. +// +// Возвращаемое значение: +// Булево - если Истина, тогда работает механизм предупреждений безопасности. +// +Функция ЕстьЗащитаОтОпасныхДействий() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЕстьЗащитаОтОпасныхДействий() +``` +
+ +## ОбъектПоПолномуИмени +
+ +Описание, пример вызова + +```bsl + +// Устарела. Создает и возвращает экземпляр отчета или обработки по полному имени объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных. Пример: "Отчет.БизнесПроцессы". +// +// Возвращаемое значение: +// ОтчетОбъект +// ОбработкаОбъект - экземпляр отчета или обработки. +// +Функция ОбъектПоПолномуИмени(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ОбъектПоПолномуИмени(ПолноеИмя) +``` +
+ +## ЭтоOSXКлиент +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначения.ЭтоMacOSКлиент +// Возвращает Истина, если клиентское приложение запущено под управлением ОС X. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоOSXКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначения.ЭтоOSXКлиент() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбщегоНазначенияБТС.md b/src/content/docs/bsp/ОбщегоНазначенияБТС.md new file mode 100644 index 0000000..a4e7740 --- /dev/null +++ b/src/content/docs/bsp/ОбщегоНазначенияБТС.md @@ -0,0 +1,980 @@ +--- +title: Общего назначения БТС +slug: bsp/общего-назначения-бтс +--- + + +## ЭтоОбъектМетаданныхКонфигурация +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных объектом ОбъектМетаданныхКонфигурация. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является конфигурацией. +// +Функция ЭтоОбъектМетаданныхКонфигурация(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоОбъектМетаданныхКонфигурация(ОбъектМетаданных) +``` +
+ +## ЭтоПодсистема +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных подсистемой. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является подсистемой. +// +Функция ЭтоПодсистема(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоПодсистема(ОбъектМетаданных) +``` +
+ +## ЭтоПараметрСеанса +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных параметром сеанса. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является параметром сеанса. +// +Функция ЭтоПараметрСеанса(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоПараметрСеанса(ОбъектМетаданных) +``` +
+ +## ЭтоОбщийРеквизит +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных общим реквизитом. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является общим реквизитом. +// +Функция ЭтоОбщийРеквизит(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоОбщийРеквизит(ОбъектМетаданных) +``` +
+ +## ЭтоКонстанта +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных константной. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является константой. +// +Функция ЭтоКонстанта(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоКонстанта(ОбъектМетаданных) +``` +
+ +## ЭтоСправочник +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных справочником. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является справочником. +// +Функция ЭтоСправочник(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоСправочник(ОбъектМетаданных) +``` +
+ +## ЭтоДокумент +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных документом. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является документом. +// +Функция ЭтоДокумент(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоДокумент(ОбъектМетаданных) +``` +
+ +## ЭтоПеречисление +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных перечислением. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является перечислением. +// +Функция ЭтоПеречисление(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоПеречисление(ОбъектМетаданных) +``` +
+ +## ЭтоБизнесПроцесс +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных бизнес-процессом. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является бизнес-процессом. +// +Функция ЭтоБизнесПроцесс(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоБизнесПроцесс(ОбъектМетаданных) +``` +
+ +## ЭтоЗадача +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных задачей. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является задачей. +// +Функция ЭтоЗадача(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоЗадача(ОбъектМетаданных) +``` +
+ +## ЭтоПланСчетов +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных планом счетов. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является планом счетов. +// +Функция ЭтоПланСчетов(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоПланСчетов(ОбъектМетаданных) +``` +
+ +## ЭтоПланОбмена +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных планом обмена. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является планом обмена. +// +Функция ЭтоПланОбмена(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоПланОбмена(ОбъектМетаданных) +``` +
+ +## ЭтоПланВидовРасчета +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных планом видов расчета. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является планом видов расчета. +// +Функция ЭтоПланВидовРасчета(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоПланВидовРасчета(ОбъектМетаданных) +``` +
+ +## ЭтоПланВидовХарактеристик +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных планом видов расчета. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является планом видов характеристик. +// +Функция ЭтоПланВидовХарактеристик(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоПланВидовХарактеристик(ОбъектМетаданных) +``` +
+ +## ЭтоСсылочныеДанные +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных ссылочным. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является ссылочным. +// +Функция ЭтоСсылочныеДанные(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоСсылочныеДанные(ОбъектМетаданных) +``` +
+ +## ЭтоСсылочныеДанныеПоддерживающиеПредопределенныеЭлементы +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных ссылочным с поддержкой предопределенных элементов. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект поддерживает предопределенные элементы. +// +Функция ЭтоСсылочныеДанныеПоддерживающиеПредопределенныеЭлементы(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоСсылочныеДанныеПоддерживающиеПредопределенныеЭлементы(ОбъектМетаданных) +``` +
+ +## ЭтоРегистрСведений +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных регистром сведений. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является регистром сведений. +// +Функция ЭтоРегистрСведений(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоРегистрСведений(ОбъектМетаданных) +``` +
+ +## ЭтоРегистрНакопления +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных регистром накопления. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является регистром накопления. +// +Функция ЭтоРегистрНакопления(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоРегистрНакопления(ОбъектМетаданных) +``` +
+ +## ЭтоРегистрБухгалтерии +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных регистром бухгалтерии. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является регистром бухгалтерии. +// +Функция ЭтоРегистрБухгалтерии(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоРегистрБухгалтерии(ОбъектМетаданных) +``` +
+ +## ЭтоРегистрРасчета +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных регистром расчета. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является регистром расчета. +// +Функция ЭтоРегистрРасчета(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоРегистрРасчета(ОбъектМетаданных) +``` +
+ +## ЭтоНаборЗаписейПерерасчета +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных перерасчетом. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является перерасчетом. +// +Функция ЭтоНаборЗаписейПерерасчета(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоНаборЗаписейПерерасчета(ОбъектМетаданных) +``` +
+ +## ЭтоНаборЗаписейПоследовательности +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных последовательности. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является последовательностью. +// +Функция ЭтоНаборЗаписейПоследовательности(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоНаборЗаписейПоследовательности(ОбъектМетаданных) +``` +
+ +## ЭтоНаборЗаписей +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных набором записей. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является набором записей. +// +Функция ЭтоНаборЗаписей(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоНаборЗаписей(ОбъектМетаданных) +``` +
+ +## ЭтоНезависимыйНаборЗаписей +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных независимым набором записей. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является независимым набором записей. +// +Функция ЭтоНезависимыйНаборЗаписей(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоНезависимыйНаборЗаписей(ОбъектМетаданных) +``` +
+ +## ЭтоНаборЗаписейПоддерживающийИтоги +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных набором записей, поддерживающим итоги. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект поддерживает итоги. +// +Функция ЭтоНаборЗаписейПоддерживающийИтоги(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоНаборЗаписейПоддерживающийИтоги(ОбъектМетаданных) +``` +
+ +## ЭтоЖурналДокументов +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных журналом документов. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является журналом документов. +// +Функция ЭтоЖурналДокументов(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоЖурналДокументов(ОбъектМетаданных) +``` +
+ +## ЭтоРегламентноеЗадание +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных регламентным заданием. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является регламентным заданием. +// +Функция ЭтоРегламентноеЗадание(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоРегламентноеЗадание(ОбъектМетаданных) +``` +
+ +## ЭтоВнешнийИсточникДанных +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданный объект метаданных внешним источником данных. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект является внешним источникоам данным. +// +Функция ЭтоВнешнийИсточникДанных(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоВнешнийИсточникДанных(ОбъектМетаданных) +``` +
+ +## ЭтоПримитивныйТип +
+ +Описание, пример вызова + +```bsl + +// Возвращает: примитивный ли это тип или нет. +// +// Параметры: +// ПроверяемыйТип - Тип - проверяемый тип. +// +// Возвращаемое значение: +// Булево - Истина, если тип примитивный. +// +Функция ЭтоПримитивныйТип(Знач ПроверяемыйТип) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоПримитивныйТип(ПроверяемыйТип) +``` +
+ +## ЭтоСсылочныйТип +
+ +Описание, пример вызова + +```bsl + +// Возвращает: ссылочный ли это тип или нет. +// +// Параметры: +// ПроверяемыйТип - Тип - проверяемый тип. +// +// Возвращаемое значение: +// Булево - Истина, если тип примитивный. +// +Функция ЭтоСсылочныйТип(Знач ПроверяемыйТип) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоСсылочныйТип(ПроверяемыйТип) +``` +
+ +## ЭтоНаборТиповСсылок +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что тип содержит набор ссылочных типов. +// +// Параметры: +// ОписаниеТипов - ОписаниеТипов - набор ссылочных типов. +// +// Возвращаемое значение: +// Булево - Истина, если тип содержит набор ссылочных типов. +// +Функция ЭтоНаборТиповСсылок(Знач ОписаниеТипов) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоНаборТиповСсылок(ОписаниеТипов) +``` +
+ +## ОбъектМетаданныхПоТипуСсылки +
+ +Описание, пример вызова + +```bsl + +// Возвращает объект метаданных по типу ссылки +// +// Параметры: +// ТипСсылки - Тип - тип ссылки. +// +// Возвращаемое значение: +// ОбъектМетаданных - объект метаданных +// +Функция ОбъектМетаданныхПоТипуСсылки(Знач ТипСсылки) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ОбъектМетаданныхПоТипуСсылки(ТипСсылки) +``` +
+ +## ЭтоРазделенныйОбъектМетаданных +
+ +Описание, пример вызова + +```bsl + +// Проверяет включение объекта метаданных в состав разделителя в режиме, включающем разделение данных. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных, +// ИмяРазделителя - Строка - имя общего реквизита - разделителя. +// +// Возвращаемое значение: +// Булево - Истина, если объект является разделенным. +// +Функция ЭтоРазделенныйОбъектМетаданных(Знач ОбъектМетаданных, Знач ИмяРазделителя) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЭтоРазделенныйОбъектМетаданных(ОбъектМетаданных, ИмяРазделителя) +``` +
+ +## ЗависимостиОбъектаМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает перечень объектов, ссылки на которые содержатся в исходном объекте метаданных. +// Наборы ссылок и хранение ссылок в хранилище значения не учитываются. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - исходный объект метаданных, +// +// Возвращаемое значение: +// Массив из Строка - массив полных имен объектов метаданных. +// +Функция ЗависимостиОбъектаМетаданных(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ЗависимостиОбъектаМетаданных(ОбъектМетаданных) +``` +
+ +## ОбъектМетаданныхДоступенПоФункциональнымОпциям +
+ +Описание, пример вызова + +```bsl + +// Проверяет доступность объектов метаданных по текущим значениям функциональных опций. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - проверяемый объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если объект доступен по текущим функциональным опциям. +// +Функция ОбъектМетаданныхДоступенПоФункциональнымОпциям(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ОбъектМетаданныхДоступенПоФункциональнымОпциям(ОбъектМетаданных) +``` +
+ +## ПредставлениеОбъектаМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление объекта метаданных. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект метаданных. +// +// Возвращаемое значение: +// Строка - представление объекта метаданных. +// +Функция ПредставлениеОбъектаМетаданных(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ПредставлениеОбъектаМетаданных(ОбъектМетаданных) +``` +
+ +## ДопустимыеПраваДляОбъектаМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает перечень (с классификацией) прав, допустимых для объекта метаданных. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект метаданных. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица допустимых прав: +// * Имя - Строка - имя вида права, которое может использоваться для функции ПравоДоступа(), +// * Интерактивное - Булево - флаг того, что право ограничивает возможность выполнения интерактивных операций, +// * Чтение - Булево - флаг того, что право предоставляет или подразумевает +// возможность чтения данных заданного объекта метаданных. +// * Изменение - Булево - флаг того, что право предоставляет или подразумевает +// возможность изменения данных заданного объекта метаданных. +// * АдминистрированиеИнформационнойБазы - Булево - флаг того, что право +// предоставляет или предполагает возможность администрирования (глобального для информационной базы). +// * АдминистрированиеОбластиДанных - Булево - флаг того, что право предоставляет +// или предполагает возможность администрирования (глобального для +// текущей области данных). +// +Функция ДопустимыеПраваДляОбъектаМетаданных(Знач ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ДопустимыеПраваДляОбъектаМетаданных(ОбъектМетаданных) +``` +
+ +## ПустойУникальныйИдентификатор +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустой уникальный идентификатор. +// +// Возвращаемое значение: +// УникальныйИдентификатор - уникальный идентификатор. +// +Функция ПустойУникальныйИдентификатор() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТС.ПустойУникальныйИдентификатор() +``` +
+ +## Пауза +
+ +Описание, пример вызова + +```bsl + +// Останавливает выполнение кода на заданное время. +// Использовать можно только в фоновом задании. +// +// Параметры: +// Секунд - Число - время ожидания в секундах. +// +Процедура Пауза(Секунд) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияБТС.Пауза(Секунд) +``` +
+ +## ЗаписьТехнологическогоЖурнала +
+ +Описание, пример вызова + +```bsl + +// Записывает событие в технологический журнал. +// +// Параметры: +// Событие - Строка - имя события для фильтрации записей технологического журнала с помощью настроек logcfg.xml. +// Контекст - Структура - Произвольные данные для записи в технологический журнал. +// В значения рекомендуется помещать данные примитивных типов. Это позволит повысить скорость записи. +// +Процедура ЗаписьТехнологическогоЖурнала(Событие, Контекст) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияБТС.ЗаписьТехнологическогоЖурнала(Событие, Контекст) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбщегоНазначенияБТСПовтИсп.md b/src/content/docs/bsp/ОбщегоНазначенияБТСПовтИсп.md new file mode 100644 index 0000000..8921ccd --- /dev/null +++ b/src/content/docs/bsp/ОбщегоНазначенияБТСПовтИсп.md @@ -0,0 +1,144 @@ +--- +title: Общего назначения БТС повт исп +slug: bsp/общего-назначения-бтс-повт-исп +--- + + +## ОписаниеПримитивныхТипов +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание тиров, содержащее примитивные типы. +// +// Возвращаемое значение: +// ОписаниеТипов - описание. +// +Функция ОписаниеПримитивныхТипов() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТСПовтИсп.ОписаниеПримитивныхТипов() +``` +
+ +## ОписаниеСсылочныхТипов +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание типов, содержащее все ссылочные типы объектов метаданных, существующих +// в конфигурации. +// +// Возвращаемое значение: +// ОписаниеТипов - описание. +// +Функция ОписаниеСсылочныхТипов() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТСПовтИсп.ОписаниеСсылочныхТипов() +``` +
+ +## СсылкиТочекМаршрутаБизнесПроцессов +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылки точек маршрута бизнес-процессов. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗнчение: +// * Ключ - Тип - тип ТочкаМаршрутаБизнесПроцессаСсылка, +// * Значение - Строка - имя бизнес-процесса. +// +Функция СсылкиТочекМаршрутаБизнесПроцессов() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТСПовтИсп.СсылкиТочекМаршрутаБизнесПроцессов() +``` +
+ +## МодельКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Модель конфигурации. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - модель конфигурации: +// * ВсеПеречисления - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданныхПеречисление +// ** Значение - Булево +// * ВсеСправочники - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданныхСправочник +// ** Значение - Булево +// * ВсеПланыВидовХарактеристик - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданныхПланВидовХарактеристик +// ** Значение - Булево +// * ВсеПланыСчетов - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданныхПланСчетов +// ** Значение - Булево +// * ВсеПланыВидовРасчета - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданныхПланВидовРасчета +// ** Значение - Булево +// * ВсеПланыОбмена - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданныхПланОбмена +// ** Значение - Булево +// * ВсеНаборыЗаписей - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданных +// ** Значение - Булево +// * ВсеРегистрыСведений - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданныхРегистрСведений +// ** Значение - Булево +// * ВсеРегистрыНакопления - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданныхРегистрНакопления +// ** Значение - Булево +// * ВсеРегистрыБухгалтерии - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданныхРегистрБухгалтерии +// ** Значение - Булево +// * ВсеРегистрыРасчета - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданныхРегистрРасчета +// ** Значение - Булево +// * ВсеНезависимыеНаборыЗаписей - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданных +// ** Значение - Булево +// * ВсеСсылочныеДанныеПоддерживающиеПредопределенныеЭлементы - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданных +// ** Значение - Булево +// * ВсеНаборыЗаписейПоследовательности - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданных +// ** Значение - Булево +// * ВсеНаборыЗаписейПерерасчета - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - ОбъектМетаданных +// ** Значение - Булево +Функция МодельКонфигурации() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияБТСПовтИсп.МодельКонфигурации() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбщегоНазначенияВызовСервера.md b/src/content/docs/bsp/ОбщегоНазначенияВызовСервера.md new file mode 100644 index 0000000..4adde7c --- /dev/null +++ b/src/content/docs/bsp/ОбщегоНазначенияВызовСервера.md @@ -0,0 +1,479 @@ +--- +title: Общего назначения вызов сервера +slug: bsp/общего-назначения-вызов-сервера +--- + + +## ХранилищеОбщихНастроекСохранить +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Сохраняет настройку в хранилище общих настроек, как метод платформы Сохранить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеОбщихНастроекСохранить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// Настройки - Произвольный - см. синтакс-помощник платформы. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеОбщихНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияВызовСервера.ХранилищеОбщихНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, ); +``` +
+ +## ХранилищеОбщихНастроекСохранитьМассив +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Сохраняет несколько настроек в хранилище общих настроек, как метод платформы Сохранить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеОбщихНастроекСохранитьМассив +// +// Параметры: +// НесколькоНастроек - Массив - со значениями: +// * Значение - Структура: +// * Объект - Строка - см. параметр КлючОбъекта в синтакс-помощнике платформы. +// * Настройка - Строка - см. параметр КлючНастроек в синтакс-помощнике платформы. +// * Значение - Произвольный - см. параметр Настройки в синтакс-помощнике платформы. +// +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеОбщихНастроекСохранитьМассив(НесколькоНастроек, ОбновитьПовторноИспользуемыеЗначения = Ложь) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияВызовСервера.ХранилищеОбщихНастроекСохранитьМассив(НесколькоНастроек, ОбновитьПовторноИспользуемыеЗначения); +``` +
+ +## ХранилищеОбщихНастроекЗагрузить +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Загружает настройку из хранилища общих настроек, как метод платформы Загрузить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют. +// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки. +// +// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно +// - возвращаемая ссылка заменяется на указанное значение по умолчанию; +// - из данных типа Массив ссылки удаляются; +// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено; +// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно. +// +// См. ОбщегоНазначения.ХранилищеОбщихНастроекЗагрузить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// ЗначениеПоУмолчанию - Произвольный - значение, которое возвращается, если настройки не существуют. +// Если не указано, возвращается значение Неопределено. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// +// Возвращаемое значение: +// Произвольный - см. синтакс-помощник платформы. +// +Функция ХранилищеОбщихНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияВызовСервера.ХранилищеОбщихНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, ); +``` +
+ +## ХранилищеОбщихНастроекУдалить +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Удаляет настройку из хранилища общих настроек, как метод платформы Удалить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеОбщихНастроекУдалить +// +// Параметры: +// КлючОбъекта - Строка +// - Неопределено - см. синтакс-помощник платформы. +// КлючНастроек - Строка +// - Неопределено - см. синтакс-помощник платформы. +// ИмяПользователя - Строка +// - Неопределено - см. синтакс-помощник платформы. +// +Процедура ХранилищеОбщихНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияВызовСервера.ХранилищеОбщихНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) +``` +
+ +## ХранилищеСистемныхНастроекСохранить +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Сохраняет настройку в хранилище системных настроек, как метод платформы Сохранить +// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек +// более 128 символов путем хеширования части, которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеСистемныхНастроекСохранить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// Настройки - Произвольный - см. синтакс-помощник платформы. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеСистемныхНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияВызовСервера.ХранилищеСистемныхНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, ); +``` +
+ +## ХранилищеСистемныхНастроекЗагрузить +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Загружает настройку из хранилища системных настроек, как метод платформы Загрузить, +// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек +// более 128 символов путем хеширования части, которая превышает 96 символов. +// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют. +// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки. +// +// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно: +// - возвращаемая ссылка заменяется на указанное значение по умолчанию; +// - из данных типа Массив ссылки удаляются; +// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено; +// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно +// +// См. ОбщегоНазначения.ХранилищеСистемныхНастроекЗагрузить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// ЗначениеПоУмолчанию - Произвольный - значение, которое возвращается, если настройки не существуют. +// Если не указано, возвращается значение Неопределено. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// +// Возвращаемое значение: +// Произвольный - см. синтакс-помощник платформы. +// +Функция ХранилищеСистемныхНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияВызовСервера.ХранилищеСистемныхНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, ); +``` +
+ +## ХранилищеСистемныхНастроекУдалить +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Удаляет настройку из хранилища системных настроек, как метод платформы Удалить, +// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек +// более 128 символов путем хеширования части, которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеСистемныхНастроекУдалить +// +// Параметры: +// КлючОбъекта - Строка +// - Неопределено - см. синтакс-помощник платформы. +// КлючНастроек - Строка +// - Неопределено - см. синтакс-помощник платформы. +// ИмяПользователя - Строка +// - Неопределено - см. синтакс-помощник платформы. +// +Процедура ХранилищеСистемныхНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияВызовСервера.ХранилищеСистемныхНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) +``` +
+ +## ХранилищеНастроекДанныхФормСохранить +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Сохраняет настройку в хранилище настроек данных форм, как метод платформы Сохранить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеНастроекДанныхФормСохранить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// Настройки - Произвольный - см. синтакс-помощник платформы. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеНастроекДанныхФормСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияВызовСервера.ХранилищеНастроекДанныхФормСохранить(КлючОбъекта, КлючНастроек, Настройки, ); +``` +
+ +## ХранилищеНастроекДанныхФормЗагрузить +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Загружает настройку из хранилища настроек данных форм, как метод платформы Загрузить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют. +// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки. +// +// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно +// - возвращаемая ссылка заменяется на указанное значение по умолчанию; +// - из данных типа Массив ссылки удаляются; +// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено; +// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно. +// +// См. ОбщегоНазначения.ХранилищеНастроекДанныхФормЗагрузить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// ЗначениеПоУмолчанию - Произвольный - значение, которое возвращается, если настройки не существуют. +// Если не указано, возвращается значение Неопределено. +// ОписаниеНастроек - ОписаниеНастроек - см. синтакс-помощник платформы. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// +// Возвращаемое значение: +// Произвольный - см. синтакс-помощник платформы. +// +Функция ХранилищеНастроекДанныхФормЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияВызовСервера.ХранилищеНастроекДанныхФормЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, ); +``` +
+ +## ХранилищеНастроекДанныхФормУдалить +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Удаляет настройку из хранилища настроек данных форм, как метод платформы Удалить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеНастроекДанныхФормУдалить +// +// Параметры: +// КлючОбъекта - Строка +// - Неопределено - см. синтакс-помощник платформы. +// КлючНастроек - Строка +// - Неопределено - см. синтакс-помощник платформы. +// ИмяПользователя - Строка +// - Неопределено - см. синтакс-помощник платформы. +// +Процедура ХранилищеНастроекДанныхФормУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияВызовСервера.ХранилищеНастроекДанныхФормУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) +``` +
+ +## ЕстьСсылкиНаОбъект +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует открывать форму с длительной операции и вызывать из нее ОбщегоНазначения.ЕстьСсылкиНаОбъект. +// Проверяет наличие ссылок на объект в базе данных. +// При вызове в неразделенном сеансе не выявляет ссылок в разделенных областях. +// +// Параметры: +// СсылкаИлиМассивСсылок - ЛюбаяСсылка +// - Массив - объект или список объектов. +// ИскатьСредиСлужебныхОбъектов - Булево - если Истина, то не будут учитываться +// исключения поиска ссылок, заданные при разработке конфигурации. +// Про исключение поиска ссылок подробнее +// см. ОбщегоНазначенияПереопределяемый.ПриДобавленииИсключенийПоискаСсылок +// +// Возвращаемое значение: +// Булево - Истина, если есть ссылки на объект. +// +Функция ЕстьСсылкиНаОбъект(Знач СсылкаИлиМассивСсылок, Знач ИскатьСредиСлужебныхОбъектов = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияВызовСервера.ЕстьСсылкиНаОбъект(СсылкаИлиМассивСсылок, ИскатьСредиСлужебныхОбъектов); +``` +
+ +## ПроверитьПроведенностьДокументов +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Проверяет статус проведения переданных документов и возвращает +// те из них, которые не проведены. +// +// Параметры: +// Документы - Массив из ДокументСсылка - документы, статус проведения которых необходимо проверить. +// +// Возвращаемое значение: +// Массив из ДокументСсылка - непроведенные документы. +// +Функция ПроверитьПроведенностьДокументов(Знач Документы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияВызовСервера.ПроверитьПроведенностьДокументов(Документы) +``` +
+ +## ПровестиДокументы +
+ +Описание, пример вызова + +```bsl + +// Исключена из программного интерфейса. +// Следует использовать одноименную функцию в общем модуле ОбщегоНазначения или ОбщегоНазначенияКлиент. +// +// Выполняет попытку проведения документов. +// +// См. ОбщегоНазначения.ПровестиДокументы +// +// Параметры: +// Документы - см. ОбщегоНазначения.ПровестиДокументы.Документы +// +// Возвращаемое значение: +// см. ОбщегоНазначения.ПровестиДокументы +// +Функция ПровестиДокументы(Документы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияВызовСервера.ПровестиДокументы(Документы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбщегоНазначенияВызовСервераБТС.md b/src/content/docs/bsp/ОбщегоНазначенияВызовСервераБТС.md new file mode 100644 index 0000000..9b6a559 --- /dev/null +++ b/src/content/docs/bsp/ОбщегоНазначенияВызовСервераБТС.md @@ -0,0 +1,51 @@ +--- +title: Общего назначения вызов сервера БТС +slug: bsp/общего-назначения-вызов-сервера-бтс +--- + + +## ТекстПредупрежденияОбАктивныхРасширенияхИзменяющихСтруктуруДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Строка - Текст предупреждения об активных расширениях изменяющих структуру данных +Функция ТекстПредупрежденияОбАктивныхРасширенияхИзменяющихСтруктуруДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияВызовСервераБТС.ТекстПредупрежденияОбАктивныхРасширенияхИзменяющихСтруктуруДанных() +``` +
+ +## ЗагрузкаПрервана +
+ +Описание, пример вызова + +```bsl + +// Загрузка прервана +// +// Возвращаемое значение: +// Булево +Функция ЗагрузкаПрервана() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияВызовСервераБТС.ЗагрузкаПрервана() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбщегоНазначенияКлиент.md b/src/content/docs/bsp/ОбщегоНазначенияКлиент.md new file mode 100644 index 0000000..9320ca4 --- /dev/null +++ b/src/content/docs/bsp/ОбщегоНазначенияКлиент.md @@ -0,0 +1,1953 @@ +--- +title: Общего назначения клиент +slug: bsp/общего-назначения-клиент +--- + + +## СообщитьПользователю +
+ +Описание, пример вызова + +```bsl + +// АПК:142-выкл 4 необязательных параметра для совместимости +// с устаревшей процедурой ОбщегоНазначенияКлиентСервер.СообщитьПользователю. + +// Формирует и выводит сообщение, которое может быть связано с элементом управления формы. +// +// См. ОбщегоНазначения.СообщитьПользователю +// +// Параметры: +// ТекстСообщенияПользователю - Строка - текст сообщения. +// КлючДанных - ЛюбаяСсылка - объект или ключ записи информационной базы, к которому это сообщение относится. +// Поле - Строка - наименование реквизита формы. +// ПутьКДанным - Строка - путь к данным (путь к реквизиту формы). +// Отказ - Булево - выходной параметр, всегда устанавливается в значение Истина. +// +// Пример: +// +// 1. Для вывода сообщения у поля управляемой формы, связанного с реквизитом объекта: +// ОбщегоНазначенияКлиент.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), , +// "ПолеВРеквизитеФормыОбъект", +// "Объект"); +// +// Альтернативный вариант использования в форме объекта: +// ОбщегоНазначенияКлиент.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), , +// "Объект.ПолеВРеквизитеФормыОбъект"); +// +// 2. Для вывода сообщения рядом с полем управляемой формы, связанным с реквизитом формы: +// ОбщегоНазначенияКлиент.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), , +// "ИмяРеквизитаФормы"); +// +// 3. Для вывода сообщения связанного с объектом информационной базы: +// ОбщегоНазначенияКлиент.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), ОбъектИнформационнойБазы, "Ответственный",,Отказ); +// +// 4. Для вывода сообщения по ссылке на объект информационной базы: +// ОбщегоНазначенияКлиент.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), Ссылка, , , Отказ); +// +// Случаи некорректного использования: +// 1. Передача одновременно параметров КлючДанных и ПутьКДанным. +// 2. Передача в параметре КлючДанных значения типа отличного от допустимого. +// 3. Установка ссылки без установки поля (и/или пути к данным). +// +Процедура СообщитьПользователю(Знач ТекстСообщенияПользователю, Знач КлючДанных = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.СообщитьПользователю(ТекстСообщенияПользователю, КлючДанных, ); +``` +
+ +## ПредопределенныйЭлемент +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Общие процедуры и функции для работы с данными в базе. + +// Возвращает ссылку предопределенного элемента по его полному имени в следующих объектах: +// - справочники; +// - планы видов характеристик; +// - планы счетов; +// - планы видов расчета. +// См. также функцию ОбщегоНазначенияКлиент.ПредопределенныйЭлемент. +// +// Для корректной работы этой функции после изменения состава предопределенных следует вызывать +// метод ОбновитьПовторноИспользуемыеЗначения. +// +// Параметры: +// ПолноеИмяПредопределенного - Строка - полное имя предопределенного элемента. +// Формат аналогичен функции глобального контекста ПредопределенноеЗначение, например: +// "Справочник.ВидыКонтактнойИнформации.EmailПользователя" +// "ПланСчетов.Хозрасчетный.Материалы" +// "ПланВидовРасчета.Начисления.ОплатаПоОкладу". +// +// Возвращаемое значение: +// ЛюбаяСсылка - ссылка на предопределенный элемент. +// Неопределено - если предопределенного элемента нет в метаданных или не создан в информационной базе. +// +Функция ПредопределенныйЭлемент(ПолноеИмяПредопределенного) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ПредопределенныйЭлемент(ПолноеИмяПредопределенного) +``` +
+ +## КодОсновногоЯзыка +
+ +Описание, пример вызова + +```bsl + +// Возвращает код основного языка информационной базы, например "ru". +// На котором программно записываются автогенерируемые строки в информационную базу. +// Например, при начальном заполнении информационной базы данными из макета, автогенерации комментария +// к проводке или определении значения параметра ИмяСобытия метода ЗаписьЖурналаРегистрации. +// +// Возвращаемое значение: +// Строка - код языка. +// +Функция КодОсновногоЯзыка() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.КодОсновногоЯзыка() +``` +
+ +## ПроверитьПроведенностьДокументов +
+ +Описание, пример вызова + +```bsl + +// Проверяет статус проведения переданных документов и возвращает +// те из них, которые не проведены. +// +// Параметры: +// Документы - Массив из ДокументСсылка - документы, статус проведения которых необходимо проверить. +// +// Возвращаемое значение: +// Массив из ДокументСсылка - непроведенные документы. +// +Функция ПроверитьПроведенностьДокументов(Знач Документы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ПроверитьПроведенностьДокументов(Документы) +``` +
+ +## ПровестиДокументы +
+ +Описание, пример вызова + +```bsl + +// Выполняет попытку проведения документов и возвращает информацию о документах, которые не удалось провести. +// +// Параметры: +// Документы - Массив из ДокументСсылка - документы, которые необходимо провести. +// +// Возвращаемое значение: +// Массив из Структура: +// * Ссылка - ДокументСсылка - документ, который не удалось провести, +// * ОписаниеОшибки - Строка - текст описания ошибки при проведении. +// +Функция ПровестиДокументы(Документы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ПровестиДокументы(Документы) +``` +
+ +## ПодсистемаСуществует +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для вызова необязательных подсистем. + +// Возвращает Истина, если функциональная подсистема существует в конфигурации. +// Предназначена для вызова необязательной подсистемы (условного вызова) совместно +// с функцией ОбщегоНазначенияКлиент.ПодсистемаСуществует. +// +// У функциональной подсистемы снят флажок "Включать в командный интерфейс". +// См. также ОбщегоНазначенияПереопределяемый.ПриОпределенииОтключенныхПодсистем, +// и ОбщегоНазначения.ПодсистемаСуществует для вызова из серверного кода. +// +// Параметры: +// ПолноеИмяПодсистемы - Строка - полное имя объекта метаданных подсистема +// без слов "Подсистема." ИС учетом регистра символов. +// Например: "СтандартныеПодсистемы.ВариантыОтчетов". +// +// Пример: +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ВариантыОтчетов") Тогда +// МодульВариантыОтчетовКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ВариантыОтчетовКлиент"); +// МодульВариантыОтчетовКлиент.<Имя процедуры>(); +// КонецЕсли; +// +// Возвращаемое значение: +// Булево +// +Функция ПодсистемаСуществует(ПолноеИмяПодсистемы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ПодсистемаСуществует(ПолноеИмяПодсистемы) +``` +
+ +## ОбщийМодуль +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на общий модуль по имени. +// Применяется для условного вызова процедуры или функции совместно с ОбщегоНазначенияКлиент.ПодсистемаСуществует. +// См. также ОбщегоНазначения.ОбщийМодуль для вызова серверного кода. +// +// Параметры: +// Имя - Строка - имя общего модуля, например "ОбновлениеКонфигурацииКлиент", "ОтчетыВызовСервера". +// +// Возвращаемое значение: +// ОбщийМодуль +// +// Пример: +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ОбновлениеКонфигурации") Тогда +// МодульОбновлениеКонфигурацииКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ОбновлениеКонфигурацииКлиент"); +// МодульОбновлениеКонфигурацииКлиент.<Имя процедуры>(); +// КонецЕсли; +// +Функция ОбщийМодуль(Имя) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ОбщийМодуль(Имя) +``` +
+ +## ЭтоWindowsКлиент +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции описания текущего окружения клиентского приложения и операционной системы. + +// Возвращает Истина, если клиентское приложение запущено под управлением ОС Windows. +// +// См. ОбщегоНазначения.ЭтоWindowsКлиент +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоWindowsКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ЭтоWindowsКлиент() +``` +
+ +## ЭтоLinuxКлиент +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если клиентское приложение запущено под управлением ОС Linux. +// +// См. ОбщегоНазначения.ЭтоLinuxКлиент +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоLinuxКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ЭтоLinuxКлиент() +``` +
+ +## ЭтоMacOSКлиент +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если клиентское приложение запущено под управлением macOS. +// +// См. ОбщегоНазначения.ЭтоMacOSКлиент +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоMacOSКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ЭтоMacOSКлиент() +``` +
+ +## КлиентПодключенЧерезВебСервер +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если клиентское приложение подключено к базе через веб-сервер. +// +// См. ОбщегоНазначения.КлиентПодключенЧерезВебСервер +// +// Возвращаемое значение: +// Булево - Истина, если подключен. +// +Функция КлиентПодключенЧерезВебСервер() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.КлиентПодключенЧерезВебСервер() +``` +
+ +## РежимОтладки +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если включен режим отладки. +// +// См. ОбщегоНазначения.РежимОтладки +// +// Возвращаемое значение: +// Булево - Истина, если включен режим отладки. +// +Функция РежимОтладки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.РежимОтладки() +``` +
+ +## ОперативнаяПамятьДоступнаяКлиентскомуПриложению +
+ +Описание, пример вызова + +```bsl + +// Возвращает объем оперативной памяти, доступной клиентскому приложению. +// +// См. ОбщегоНазначения.ОперативнаяПамятьДоступнаяКлиентскомуПриложению +// +// Возвращаемое значение: +// Число - количество гигабайтов оперативной памяти с точностью до десятых долей. +// Неопределено - нет клиентского приложения, то есть ТекущийРежимЗапуска() = Неопределено. +// +Функция ОперативнаяПамятьДоступнаяКлиентскомуПриложению() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ОперативнаяПамятьДоступнаяКлиентскомуПриложению() +``` +
+ +## ИнформационнаяБазаФайловая +
+ +Описание, пример вызова + +```bsl + +// Определяет режим эксплуатации информационной базы файловый (Истина) или серверный (Ложь). +// При проверке используется СтрокаСоединенияИнформационнойБазы, которую можно указать явно. +// +// См. ОбщегоНазначения.ИнформационнаяБазаФайловая +// +// Параметры: +// СтрокаСоединенияИнформационнойБазы - Строка - параметр используется, если +// нужно проверить строку соединения не текущей информационной базы. +// +// Возвращаемое значение: +// Булево - Истина, если файловая. +// +Функция ИнформационнаяБазаФайловая(Знач СтрокаСоединенияИнформационнойБазы = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ИнформационнаяБазаФайловая(СтрокаСоединенияИнформационнойБазы); +``` +
+ +## ТипПлатформыКлиента +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип платформы клиента. +// +// Возвращаемое значение: +// ТипПлатформы, Неопределено - тип платформы на которой запущен клиент. В режиме веб-клиента, если тип +// платформы иной, чем описан в типе ТипПлатформы, то возвращается Неопределено. +// +Функция ТипПлатформыКлиента() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ТипПлатформыКлиента() +``` +
+ +## РазделениеВключено +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак работы в режиме разделения данных по областям +// (технически это признак условного разделения). +// +// Возвращает Ложь, если конфигурация не может работать в режиме разделения данных +// (не содержит общих реквизитов, предназначенных для разделения данных). +// +// Возвращаемое значение: +// Булево - Истина, если разделение включено, +// Ложь, если разделение выключено или не поддерживается. +// +Функция РазделениеВключено() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.РазделениеВключено() +``` +
+ +## ДоступноИспользованиеРазделенныхДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак возможности обращения к разделенным данным (которые входят в состав разделителей). +// Признак относится к сеансу, но может меняться во время работы сеанса, если разделение было включено +// в самом сеансе, поэтому проверку следует делать непосредственно перед обращением к разделенным данным. +// +// Возвращает Истина, если конфигурация не может работать в режиме разделения данных +// (не содержит общих реквизитов, предназначенных для разделения данных). +// +// Возвращаемое значение: +// Булево - Истина, если разделение не поддерживается, либо разделение выключено, +// либо разделение включено и разделители установлены. +// Ложь, если разделение включено и разделители не установлены. +// +Функция ДоступноИспользованиеРазделенныхДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ДоступноИспользованиеРазделенныхДанных() +``` +
+ +## ДатаСеанса +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции для работы с датами с учетом часового пояса сеанса + +// Возвращает текущую дату, приведенную к часовому поясу сеанса. +// Предназначена для использования вместо функции ТекущаяДата() в клиентском коде +// в тех случаях, когда нет возможности перевести выполнение алгоритма в серверный код. +// +// Функция возвращает время, близкое к результату функции ТекущаяДатаСеанса в серверном коде. +// Погрешность обусловлена временем выполнения серверного вызова. +// Кроме того, если на клиентском компьютере перевести время, то функция учтет это изменение +// не сразу, а только после следующего сброса кеша повторно используемых значений +// (см. также метод ОбновитьПовторноИспользуемыеЗначения). +// Поэтому алгоритмы, для которых точное время критически важно, следует размещать в серверном коде, +// а не в клиентском. +// +// Возвращаемое значение: +// Дата - текущая дата сеанса. +// +Функция ДатаСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ДатаСеанса() +``` +
+ +## ДатаУниверсальная +
+ +Описание, пример вызова + +```bsl + +// Возвращает универсальную дату сеанса, получаемую из текущей даты сеанса. +// +// Функция возвращает время, близкое к результату функции УниверсальноеВремя() в серверном контексте. +// Погрешность обусловлена временем выполнения серверного вызова. +// Предназначена для использования вместо функции УниверсальноеВремя(). +// +// Возвращаемое значение: +// Дата - универсальная дата сеанса. +// +Функция ДатаУниверсальная() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ДатаУниверсальная() +``` +
+ +## ПредставлениеЛокальнойДатыСоСмещением +
+ +Описание, пример вызова + +```bsl + +// Преобразует локальную дату к формату "YYYY-MM-DDThh:mm:ssTZD" согласно ISO 8601. +// +// См. ОбщегоНазначения.ПредставлениеЛокальнойДатыСоСмещением +// +// Параметры: +// ЛокальнаяДата - Дата - дата в часовом поясе сеанса. +// +// Возвращаемое значение: +// Строка - представление даты. +// +Функция ПредставлениеЛокальнойДатыСоСмещением(ЛокальнаяДата) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ПредставлениеЛокальнойДатыСоСмещением(ЛокальнаяДата) +``` +
+ +## СкопироватьРекурсивно +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Общие процедуры и функции для работы с прикладными типами и коллекциями значений. + +// Создает полную копию структуры, соответствия, массива, списка или таблицы значений, рекурсивно, +// с учетом типов дочерних элементов. При этом содержимое значений объектных типов +// (СправочникОбъект, ДокументОбъект и т.п.) не копируются, а возвращаются ссылки на исходный объект. +// +// См. ОбщегоНазначения.СкопироватьРекурсивно +// +// Параметры: +// Источник - Структура +// - ФиксированнаяСтруктура +// - Соответствие +// - ФиксированноеСоответствие +// - Массив +// - ФиксированныйМассив +// - СписокЗначений - объект, который необходимо скопировать. +// ФиксироватьДанные - Булево +// - Неопределено - если Истина - фиксировать, +// если Ложь - снять фиксацию, если Неопределено - не изменять. +// +// Возвращаемое значение: +// Структура +// ФиксированнаяСтруктура +// Соответствие +// ФиксированноеСоответствие +// Массив +// ФиксированныйМассив +// СписокЗначений - копия объекта, переданного в параметре Источник. +// +Функция СкопироватьРекурсивно(Источник, ФиксироватьДанные = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.СкопироватьРекурсивно(Источник, ФиксироватьДанные); +``` +
+ +## ПроверитьТипПараметраКоманды +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что в параметре команды Параметр передан объект ожидаемого типа ОжидаемыйТип. +// В противном случае, выдает стандартное сообщение и возвращает Ложь. +// Такая ситуация возможна, например, если в списке выделена строка группировки. +// +// Для использования в командах, работающих с элементами динамических списков в формах. +// +// Параметры: +// Параметр - Массив +// - ЛюбаяСсылка - параметр команды. +// ОжидаемыйТип - Тип - ожидаемый тип параметра. +// +// Возвращаемое значение: +// Булево - Истина, если параметр ожидаемого типа. +// +// Пример: +// +// Если НЕ ОбщегоНазначенияКлиент.ПроверитьТипПараметраКоманды( +// Элементы.Список.ВыделенныеСтроки, Тип("ЗадачаСсылка.ЗадачаИсполнителя")) Тогда +// Возврат; +// КонецЕсли; +// ... +// +Функция ПроверитьТипПараметраКоманды(Знач Параметр, Знач ОжидаемыйТип) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ПроверитьТипПараметраКоманды(Параметр, ОжидаемыйТип) +``` +
+ +## ПоказатьПодтверждениеЗакрытияФормы +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Клиентские процедуры общего назначения для работы в формами. + +// Задает вопрос о продолжении действия, которое приведет к потере изменений: +// "Данные были изменены. Сохранить изменения?" +// Для использования в обработчиках события ПередЗакрытием модулей форм объектов, +// которые возможно записать в информационную базу. +// Отображение вопроса зависит свойства модифицированности формы. +// +// См. также процедуру ОбщегоНазначенияКлиент.ПоказатьПодтверждениеЗакрытияПроизвольнойФормы. +// +// Параметры: +// ОповещениеСохранитьИЗакрыть - ОписаниеОповещения - содержит имя процедуры, вызываемой при нажатии на кнопку "OK". +// Отказ - Булево - возвращаемый параметр, признак отказа от выполняемого действия. +// ЗавершениеРаботы - Булево - признак того, что форма закрывается в процессе завершения работы приложения. +// ТекстПредупреждения - Строка - текст предупреждения, выводимый пользователю. По умолчанию, выводится текст +// "Данные были изменены. Сохранить изменения?" +// ТекстПредупрежденияПриЗавершении - Строка - возвращаемый параметр с текстом предупреждения, выводимым пользователю +// при завершении приложения. Если параметр указан, то возвращается текст +// "Данные были изменены. Все изменения будут потеряны.". +// +// Пример: +// +// &НаКлиенте +// Процедура ПередЗакрытием(Отказ, ЗавершениеРаботы, ТекстПредупреждения, СтандартнаяОбработка) +// Оповещение = Новый ОписаниеОповещения("ВыбратьИЗакрыть", ЭтотОбъект); +// ОбщегоНазначенияКлиент.ПоказатьПодтверждениеЗакрытияФормы(Оповещение, Отказ, ЗавершениеРаботы); +// КонецПроцедуры +// +// &НаКлиенте +// Процедура ВыбратьИЗакрыть(Результат = Неопределено, ДополнительныеПараметры = Неопределено) Экспорт +// // записываем данные формы. +// // ... +// Модифицированность = Ложь; // не выводить подтверждение о закрытии формы еще раз. +// Закрыть(<РезультатВыбораВФорме>); +// КонецПроцедуры +// +Процедура ПоказатьПодтверждениеЗакрытияФормы( Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ПоказатьПодтверждениеЗакрытияФормы(); +``` +
+ +## ПоказатьПодтверждениеЗакрытияПроизвольнойФормы +
+ +Описание, пример вызова + +```bsl + +// Задает вопрос о продолжении действия, которое приведет к закрытию формы. +// Для использования в обработчиках события ПередЗакрытием модулей форм. +// См. также процедуру ОбщегоНазначенияКлиент.ПоказатьПодтверждениеЗакрытияФормы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, которая вызывает диалог предупреждения. +// Отказ - Булево - возвращаемый параметр, признак отказа от выполняемого действия. +// ЗавершениеРаботы - Булево - признак завершения работы программы. +// ТекстПредупреждения - Строка - текст предупреждения, выводимый пользователю. +// ИмяРеквизитаЗакрытьФормуБезПодтверждения - Строка - имя реквизита, содержащего в себе признак того, нужно +// выводить предупреждение или нет. +// ОписаниеОповещенияЗакрыть - ОписаниеОповещения - содержит имя процедуры, вызываемой при нажатии на кнопку "Да". +// +// Пример: +// ТекстПредупреждения = НСтр("ru = 'Закрыть помощник?'"); +// ОбщегоНазначенияКлиент.ПоказатьПодтверждениеЗакрытияПроизвольнойФормы( +// ЭтотОбъект, Отказ, ЗавершениеРаботы, ТекстПредупреждения, "ЗакрытьФормуБезПодтверждения"); +// +Процедура ПоказатьПодтверждениеЗакрытияПроизвольнойФормы( Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ПоказатьПодтверждениеЗакрытияПроизвольнойФормы(); +``` +
+ +## ОбновитьИнтерфейсПрограммы +
+ +Описание, пример вызова + +```bsl + +// Обновляет интерфейс программы сохраняя текущее активное окно. +// +Процедура ОбновитьИнтерфейсПрограммы() Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ОбновитьИнтерфейсПрограммы() +``` +
+ +## ОповеститьОбИзмененииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Оповещает открытые формы и динамические списки об изменении одного объекта. +// +// Параметры: +// Источник - ЛюбаяСсылка +// - РегистрСведенийКлючЗаписиИмяРегистраСведений +// - РегистрНакопленияКлючЗаписиИмяРегистраНакопления +// - РегистрБухгалтерииКлючЗаписиИмяРегистраБухгалтерии +// - РегистрРасчетаКлючЗаписиИмяРегистраРасчета - ссылка измененного объекта или ключ измененной записи +// регистра, об изменении которых необходимо уведомить динамические списки и формы. +// ДополнительныеПараметры - Произвольный - любые параметры, которые необходимо передать в методе Оповестить. +// +Процедура ОповеститьОбИзмененииОбъекта(Источник, Знач ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ОповеститьОбИзмененииОбъекта(Источник, ДополнительныеПараметры); +``` +
+ +## ОповеститьОбИзмененииОбъектов +
+ +Описание, пример вызова + +```bsl + +// Оповещает открытые формы и динамические списки об изменении сразу нескольких объектов. +// +// Параметры: +// Источник - Тип +// - ОписаниеТипов - тип или типы объектов, об изменении которых необходимо уведомить +// динамические списки и формы; +// - Массив - список измененных ссылок и/или ключей записей регистров, об изменении +// которых необходимо уведомить динамические списки и формы. +// ДополнительныеПараметры - Произвольный - любые параметры, которые необходимо передать в методе Оповестить. +// +Процедура ОповеститьОбИзмененииОбъектов(Источник, Знач ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ОповеститьОбИзмененииОбъектов(Источник, ДополнительныеПараметры); +``` +
+ +## ПоказатьВыборФорматаВложений +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора формата вложений. +// +// Параметры: +// ОписаниеОповещения - ОписаниеОповещения - обработчик результата выбора. +// НастройкиФормата - Структура - настройки по умолчанию в форме: +// * УпаковатьВАрхив - Булево - признак необходимости упаковки вложений в архив. +// * ФорматыСохранения - Массив из Строка - список выбранных форматов вложений. +// * ПереводитьИменаФайловВТранслит - Булево - преобразовывать кириллические символы в латиницу. +// * Подписать - Булево - подписать вложения электронной подписью. +// Владелец - ФормаКлиентскогоПриложения - форма, из которой вызывается форма выбора вложений. +// +Процедура ПоказатьВыборФорматаВложений(ОписаниеОповещения, НастройкиФормата = Неопределено, Владелец = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ПоказатьВыборФорматаВложений(ОписаниеОповещения, НастройкиФормата, Владелец); +``` +
+ +## ПоказатьФормуРедактированияМногострочногоТекста +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции для обработки действий пользователя в процессе редактирования +// многострочного текста, например комментария в документах. + +// Открывает форму редактирования произвольного многострочного текста. +// +// Параметры: +// ОповещениеОЗакрытии - ОписаниеОповещения - содержит описание процедуры, которая будет вызвана +// после закрытия формы ввода текста с теми же параметрами, что и для метода +// ПоказатьВводСтроки. +// МногострочныйТекст - Строка - произвольный текст, который необходимо отредактировать; +// Заголовок - Строка - текст, который необходимо отобразить в заголовке формы. +// +// Пример: +// +// Оповещение = Новый ОписаниеОповещения("КомментарийЗавершениеВвода", ЭтотОбъект); +// ОбщегоНазначенияКлиент.ПоказатьФормуРедактированияМногострочногоТекста(Оповещение, Элемент.ТекстРедактирования); +// +// &НаКлиенте +// Процедура КомментарийЗавершениеВвода(Знач ВведенныйТекст, Знач ДополнительныеПараметры) Экспорт +// Если ВведенныйТекст = Неопределено Тогда +// Возврат; +// КонецЕсли; +// +// Объект.МногострочныйКомментарий = ВведенныйТекст; +// Модифицированность = Истина; +// КонецПроцедуры +// +Процедура ПоказатьФормуРедактированияМногострочногоТекста(Знач ОповещениеОЗакрытии, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ПоказатьФормуРедактированияМногострочногоТекста(ОповещениеОЗакрытии, ); +``` +
+ +## ПоказатьФормуРедактированияКомментария +
+ +Описание, пример вызова + +```bsl + +// Открывает форму редактирования многострочного комментария. +// +// Параметры: +// МногострочныйТекст - Строка - произвольный текст, который необходимо отредактировать. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, в поле которой выполняется ввод комментария. +// ИмяРеквизита - Строка - имя реквизита формы, в который будет помещен введенный пользователем комментарий. +// По умолчанию - "Объект.Комментарий". +// Заголовок - Строка - текст, который необходимо отобразить в заголовке формы. +// По умолчанию - "Комментарий". +// +// Пример: +// ОбщегоНазначенияКлиент.ПоказатьФормуРедактированияКомментария( +// Элемент.ТекстРедактирования, ЭтотОбъект, "Объект.Комментарий"); +// +Процедура ПоказатьФормуРедактированияКомментария( Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ПоказатьФормуРедактированияКомментария(); +``` +
+ +## СохранитьПерсональныеНастройки +
+ +Описание, пример вызова + +```bsl + +// Сохраняет персональные настройки пользователя. +// +// Параметры: +// Настройки - Структура: +// * НапоминатьОбУстановкеРасширенияРаботыСФайлами - Булево - признак необходимости +// напоминания об установке расширения. +// * ЗапрашиватьПодтверждениеПриЗавершенииПрограммы - Булево - запрашивать подтверждение по завершении работы. +// +Процедура СохранитьПерсональныеНастройки(Настройки) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.СохранитьПерсональныеНастройки(Настройки) +``` +
+ +## ЦветСтиля +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции для работы с цветами стиля в клиентском коде. + +// Получает цвет стиля по имени элемента стиля. +// +// Параметры: +// ИмяЦветаСтиля - Строка +// +// Возвращаемое значение: +// Цвет +// +Функция ЦветСтиля(ИмяЦветаСтиля) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ЦветСтиля(ИмяЦветаСтиля) +``` +
+ +## ШрифтСтиля +
+ +Описание, пример вызова + +```bsl + +// Получает шрифт стиля по имени элемента стиля. +// +// Параметры: +// ИмяШрифтаСтиля - Строка +// +// Возвращаемое значение: +// Шрифт +// +Функция ШрифтСтиля(ИмяШрифтаСтиля) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ШрифтСтиля(ИмяШрифтаСтиля) +``` +
+ +## ПараметрыПодключенияКомпоненты +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров для процедуры ПодключитьКомпонентуИзМакета. +// +// Возвращаемое значение: +// Структура: +// * Кэшировать - Булево - (по умолчанию Истина) использовать механизм кэширования компонент на клиенте. +// * ПредложитьУстановить - Булево - (по умолчанию Истина) предлагать устанавливать. +// * ПредложитьЗагрузить - Булево - (по умолчанию Ложь) предлагать загрузить компоненту с сайта ИТС. +// * ТекстПояснения - Строка - для чего нужна компонента и что не будет работать, если ее не устанавливать. +// * ИдентификаторыСозданияОбъектов - Массив - идентификатор создания экземпляра модуля объекта, +// используется только для компонент, у которых есть несколько идентификаторов создания объектов, +// при задании параметр Идентификатор будет игнорироваться. +// * Изолированно - Булево, Неопределено - (по умолчанию Неопределено) если Истина, компонента будет подключена +// изолированно, в этом случае внешняя компонента загружается в отдельный процесс операционной системы; +// Ложь - в этом случае внешняя компонента будет выполняться в том же процессе операционной системы, +// который выполняет код встроенного языка; Неопределено - поддерживается поведение платформы по умолчанию: +// изолированно - если компонентой поддерживается только этот режим, не изолированно - в остальных случаях. +// См. https://its.1c.eu/db/v83doc#bookmark:dev:TI000001866 +// * ОбновлятьАвтоматически - Булево - (по умолчанию Истина) если ПредложитьЗагрузить = Истина, при загрузке +// внешней компоненты устанавливать признак ОбновлятьСПортала1СИТС. +// * ПоказыватьВопросУстановки - Булево - (по умолчанию Истина) если ПредложитьУстановить = Истина, перед установкой +// внешней компоненты будет показан вопрос об установке. +// +// +// Пример: +// +// ПараметрыПодключения = ОбщегоНазначенияКлиент.ПараметрыПодключенияКомпоненты(); +// ПараметрыПодключения.ТекстПояснения = НСтр("ru = 'Для использования сканера штрихкодов требуется +// |внешняя компонента ""1С:Сканеры штрихкода (NativeApi)"".'"); +// +Функция ПараметрыПодключенияКомпоненты() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ПараметрыПодключенияКомпоненты() +``` +
+ +## ПодключитьКомпонентуИзМакета +
+ +Описание, пример вызова + +```bsl + +// Подключает компоненту, выполненную по технологии Native API и COM, в асинхронном режиме. +// Компонента должна храниться в макете конфигурации в виде ZIP-архива. +// Для веб-клиента предлагается диалог, подсказывающий пользователю действия по установке. +// +// Параметры: +// Оповещение - ОписаниеОповещения - описание оповещения о подключении со следующими параметрами: +// * Результат - Структура - результат подключения компоненты: +// ** Подключено - Булево - признак подключения. +// ** ПодключаемыйМодуль - ОбъектВнешнейКомпоненты - экземпляр объекта внешней компоненты; +// - ФиксированноеСоответствие из КлючИЗначение - экземпляры объектов внешней компоненты, +// указанные в ПараметрыПодключения.ИдентификаторыСозданияОбъектов: +// *** Ключ - Строка - идентификатор внешней компоненты; +// *** Значение - ОбъектВнешнейКомпоненты - экземпляр объекта. +// ** Местоположение - Строка - имя макета или навигационная ссылка компоненты из справочника, если она +// более старшей версии, из которых была подключена компонента. +// ** СимволическоеИмя - Строка - символическое имя, с которым была подключена компонента. +// По местоположению и символическому имени из прикладного кода можно проверять подключение компоненты +// методом платформы +// ПроверитьПодключениеВнешнейКомпоненты(Местоположение, Имя) +// ** ОписаниеОшибки - Строка - краткое описание ошибки. При отмене пользователем пустая строка. +// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения. +// Идентификатор - Строка - идентификатор объекта внешней компоненты. +// ПолноеИмяМакета - Строка - полное имя макета, используемое как местоположение компоненты. +// ПараметрыПодключения - Структура +// - Неопределено - см. функцию ПараметрыПодключенияКомпоненты. +// +// Пример: +// +// Оповещение = Новый ОписаниеОповещения("ПодключитьКомпонентуЗавершение", ЭтотОбъект); +// +// ПараметрыПодключения = ОбщегоНазначенияКлиент.ПараметрыПодключенияКомпоненты(); +// ПараметрыПодключения.ТекстПояснения = НСтр("ru = 'Для оформления заявления на выпуск сертификата требуется +// |внешняя компонента ""Криптография (CryptS)"".'"); +// +// ОбщегоНазначенияКлиент.ПодключитьКомпонентуИзМакета(Оповещение, +// "CryptS", +// "Обработка.ЗаявлениеНаВыпускНовогоКвалифицированногоСертификата.Макет.КомпонентаОбмена", +// ПараметрыПодключения); +// +// &НаКлиенте +// Процедура ПодключитьКомпонентуЗавершение(Результат, ДополнительныеПараметры) Экспорт +// +// ПодключаемыйМодуль = Неопределено; +// +// Если Результат.Подключено Тогда +// ПодключаемыйМодуль = Результат.ПодключаемыйМодуль; +// Иначе +// Если Не ПустаяСтрока(Результат.ОписаниеОшибки) Тогда +// ПоказатьПредупреждение(, Результат.ОписаниеОшибки); +// КонецЕсли; +// КонецЕсли; +// +// Если ПодключаемыйМодуль <> Неопределено Тогда +// // ПодключаемыйМодуль содержит созданный экземпляр подключенной компоненты. +// КонецЕсли; +// +// ПодключаемыйМодуль = Неопределено; +// +// КонецПроцедуры +// +Процедура ПодключитьКомпонентуИзМакета(Оповещение, Идентификатор, ПолноеИмяМакета, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ПодключитьКомпонентуИзМакета(Оповещение, Идентификатор, ПолноеИмяМакета, ); +``` +
+ +## ПараметрыУстановкиКомпоненты +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров для процедуры УстановитьКомпонентуИзМакета. +// +// Возвращаемое значение: +// Структура: +// * ТекстПояснения - Строка - для чего нужна компонента и что не будет работать, если ее не устанавливать. +// +// Пример: +// +// ПараметрыУстановки = ОбщегоНазначенияКлиент.ПараметрыУстановкиКомпоненты(); +// ПараметрыУстановки.ТекстПояснения = НСтр("ru = 'Для использования сканера штрихкодов требуется +// |внешняя компонента ""1С:Сканеры штрихкода (NativeApi)"".'"); +// +Функция ПараметрыУстановкиКомпоненты() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ПараметрыУстановкиКомпоненты() +``` +
+ +## УстановитьКомпонентуИзМакета +
+ +Описание, пример вызова + +```bsl + +// Устанавливает компоненту, выполненную по технологии Native API и COM асинхронном режиме. +// Компонента должна храниться в макете конфигурации в виде ZIP-архива. +// +// Параметры: +// Оповещение - ОписаниеОповещения - описание оповещения об установке внешней компоненты: +// * Результат - Структура - результат установки компоненты: +// ** Установлено - Булево - признак установки. +// ** ОписаниеОшибки - Строка - краткое описание ошибки. При отмене пользователем пустая строка. +// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения. +// ПолноеИмяМакета - Строка - полное имя макета, используемое как местоположение компоненты. +// ПараметрыУстановки - Структура +// - Неопределено - см. функцию ПараметрыУстановкиКомпоненты. +// +// Пример: +// +// Оповещение = Новый ОписаниеОповещения("УстановитьКомпонентуЗавершение", ЭтотОбъект); +// +// ПараметрыУстановки = ОбщегоНазначенияКлиент.ПараметрыУстановкиКомпоненты(); +// ПараметрыУстановки.ТекстПояснения = НСтр("ru = 'Для оформления заявления на выпуск сертификата требуется +// |внешняя компонента ""Криптография (CryptS)"".'"); +// +// ОбщегоНазначенияКлиент.УстановитьКомпонентуИзМакета(Оповещение, +// "Обработка.ЗаявлениеНаВыпускНовогоКвалифицированногоСертификата.Макет.КомпонентаОбмена", +// ПараметрыУстановки); +// +// &НаКлиенте +// Процедура УстановитьКомпонентуЗавершение(Результат, ДополнительныеПараметры) Экспорт +// +// Если Не Результат.Установлено И Не ПустаяСтрока(Результат.ОписаниеОшибки) Тогда +// ПоказатьПредупреждение(, Результат.ОписаниеОшибки); +// КонецЕсли; +// +// КонецПроцедуры +// +Процедура УстановитьКомпонентуИзМакета(Оповещение, ПолноеИмяМакета, ПараметрыУстановки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.УстановитьКомпонентуИзМакета(Оповещение, ПолноеИмяМакета, ПараметрыУстановки); +``` +
+ +## ЗарегистрироватьCOMСоединитель +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для работы с внешним соединением. + +// Выполняет регистрацию компоненты "comcntr.dll" для текущей версии платформы. +// В случае успешной регистрации, предлагает пользователю перезапустить клиентский сеанс +// для того чтобы регистрация вступила в силу. +// +// Вызывается перед клиентским кодом, который использует менеджер COM-соединений (V83.COMConnector) +// и инициируется интерактивными действиями пользователя. +// +// Параметры: +// ВыполнитьПерезагрузкуСеанса - Булево - если Истина, то после регистрации COM соединителя +// будет вызван диалог перезапуска сеанса. +// Оповещение - ОписаниеОповещения - оповещение о результате регистрации: +// * Зарегистрировано - Булево - Истина, если COM соединитель зарегистрирован без ошибок. +// * ДополнительныеПараметры - Произвольный - значение, которое было указано +// при создании объекта ОписаниеОповещения. +// +// Пример: +// ЗарегистрироватьCOMСоединитель(); +// +Процедура ЗарегистрироватьCOMСоединитель(Знач ВыполнитьПерезагрузкуСеанса = Истина, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ЗарегистрироватьCOMСоединитель(ВыполнитьПерезагрузкуСеанса, ); +``` +
+ +## УстановитьВнешнееСоединениеСБазой +
+ +Описание, пример вызова + +```bsl + +// Устанавливает внешнее соединение с информационной базой по переданным параметрам подключения и возвращает его. +// +// См. ОбщегоНазначения.УстановитьВнешнееСоединениеСБазой. +// +// Параметры: +// Параметры - см. ОбщегоНазначенияКлиентСервер.СтруктураПараметровДляУстановкиВнешнегоСоединения +// +// Возвращаемое значение: +// Структура: +// * Соединение - COMОбъект +// - Неопределено - COM-объект соединения или Неопределено в случае ошибки; +// * КраткоеОписаниеОшибки - Строка - краткое описание ошибки; +// * ПодробноеОписаниеОшибки - Строка - подробное описание ошибки; +// * ОшибкаПодключенияКомпоненты - Булево - флаг ошибки подключения COM. +// +Функция УстановитьВнешнееСоединениеСБазой(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.УстановитьВнешнееСоединениеСБазой(Параметры) +``` +
+ +## ПредлагатьСоздаватьРезервныеКопии +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для выполнения резервного копирования в пользовательском режиме. + +// Проверяет, возможно ли выполнить резервное копирование в пользовательском режиме. +// +// Возвращаемое значение: +// Булево - Истина, если предлагать. +// +Функция ПредлагатьСоздаватьРезервныеКопии() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ПредлагатьСоздаватьРезервныеКопии() +``` +
+ +## ПредложитьПользователюСоздатьРезервнуюКопию +
+ +Описание, пример вызова + +```bsl + +// Предлагает пользователю создать резервную копию. +Процедура ПредложитьПользователюСоздатьРезервнуюКопию() Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ПредложитьПользователюСоздатьРезервнуюКопию() +``` +
+ +## ХранилищеОбщихНастроекСохранить +
+ +Описание, пример вызова + +```bsl + +// АПК:222-выкл вызываемые процедуры исключены из программного интерфейса. + +// Сохраняет настройку в хранилище общих настроек, как метод платформы Сохранить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеОбщихНастроекСохранить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// Настройки - Произвольный - см. синтакс-помощник платформы. +// ОписаниеНастроек - Неопределено - не используется на клиенте. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеОбщихНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ХранилищеОбщихНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, ); +``` +
+ +## ХранилищеОбщихНастроекСохранитьМассив +
+ +Описание, пример вызова + +```bsl + +// Сохраняет несколько настроек в хранилище общих настроек, как метод платформы Сохранить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеОбщихНастроекСохранитьМассив +// +// Параметры: +// НесколькоНастроек - Массив - со значениями: +// * Значение - Структура: +// * Объект - Строка - см. параметр КлючОбъекта в синтакс-помощнике платформы. +// * Настройка - Строка - см. параметр КлючНастроек в синтакс-помощнике платформы. +// * Значение - Произвольный - см. параметр Настройки в синтакс-помощнике платформы. +// +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеОбщихНастроекСохранитьМассив(НесколькоНастроек, ОбновитьПовторноИспользуемыеЗначения = Ложь) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ХранилищеОбщихНастроекСохранитьМассив(НесколькоНастроек, ОбновитьПовторноИспользуемыеЗначения); +``` +
+ +## ХранилищеОбщихНастроекЗагрузить +
+ +Описание, пример вызова + +```bsl + +// Загружает настройку из хранилища общих настроек, как метод платформы Загрузить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют. +// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки. +// +// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно +// - возвращаемая ссылка заменяется на указанное значение по умолчанию; +// - из данных типа Массив ссылки удаляются; +// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено; +// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно. +// +// См. ОбщегоНазначения.ХранилищеОбщихНастроекЗагрузить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// ЗначениеПоУмолчанию - Произвольный - значение, которое возвращается, если настройки не существуют. +// Если не указано, возвращается значение Неопределено. +// ОписаниеНастроек - Неопределено - не используется на клиенте. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// +// Возвращаемое значение: +// Произвольный - см. синтакс-помощник платформы. +// +Функция ХранилищеОбщихНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ХранилищеОбщихНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, ); +``` +
+ +## ХранилищеОбщихНастроекУдалить +
+ +Описание, пример вызова + +```bsl + +// Удаляет настройку из хранилища общих настроек, как метод платформы Удалить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеОбщихНастроекУдалить +// +// Параметры: +// КлючОбъекта - Строка +// - Неопределено - см. синтакс-помощник платформы. +// КлючНастроек - Строка +// - Неопределено - см. синтакс-помощник платформы. +// ИмяПользователя - Строка +// - Неопределено - см. синтакс-помощник платформы. +// +Процедура ХранилищеОбщихНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ХранилищеОбщихНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) +``` +
+ +## ХранилищеСистемныхНастроекСохранить +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройку в хранилище системных настроек, как метод платформы Сохранить +// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек +// более 128 символов путем хеширования части, которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеСистемныхНастроекСохранить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// Настройки - Произвольный - см. синтакс-помощник платформы. +// ОписаниеНастроек - Неопределено - не используется на клиенте. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеСистемныхНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ХранилищеСистемныхНастроекСохранить(КлючОбъекта, КлючНастроек, Настройки, ); +``` +
+ +## ХранилищеСистемныхНастроекЗагрузить +
+ +Описание, пример вызова + +```bsl + +// Загружает настройку из хранилища системных настроек, как метод платформы Загрузить, +// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек +// более 128 символов путем хеширования части, которая превышает 96 символов. +// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют. +// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки. +// +// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно: +// - возвращаемая ссылка заменяется на указанное значение по умолчанию; +// - из данных типа Массив ссылки удаляются; +// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено; +// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно +// +// См. ОбщегоНазначения.ХранилищеСистемныхНастроекЗагрузить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// ЗначениеПоУмолчанию - Произвольный - значение, которое возвращается, если настройки не существуют. +// Если не указано, возвращается значение Неопределено. +// ОписаниеНастроек - Неопределено - не используется на клиенте. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// +// Возвращаемое значение: +// Произвольный - см. синтакс-помощник платформы. +// +Функция ХранилищеСистемныхНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ХранилищеСистемныхНастроекЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, ); +``` +
+ +## ХранилищеСистемныхНастроекУдалить +
+ +Описание, пример вызова + +```bsl + +// Удаляет настройку из хранилища системных настроек, как метод платформы Удалить, +// объекта СтандартноеХранилищеНастроекМенеджер, но с поддержкой длины ключа настроек +// более 128 символов путем хеширования части, которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеСистемныхНастроекУдалить +// +// Параметры: +// КлючОбъекта - Строка +// - Неопределено - см. синтакс-помощник платформы. +// КлючНастроек - Строка +// - Неопределено - см. синтакс-помощник платформы. +// ИмяПользователя - Строка +// - Неопределено - см. синтакс-помощник платформы. +// +Процедура ХранилищеСистемныхНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ХранилищеСистемныхНастроекУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) +``` +
+ +## ХранилищеНастроекДанныхФормСохранить +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройку в хранилище настроек данных форм, как метод платформы Сохранить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, сохранение пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеНастроекДанныхФормСохранить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// Настройки - Произвольный - см. синтакс-помощник платформы. +// ОписаниеНастроек - Неопределено - не используется на клиенте. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// ОбновитьПовторноИспользуемыеЗначения - Булево - выполнить одноименный метод платформы. +// +Процедура ХранилищеНастроекДанныхФормСохранить(КлючОбъекта, КлючНастроек, Настройки, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ХранилищеНастроекДанныхФормСохранить(КлючОбъекта, КлючНастроек, Настройки, ); +``` +
+ +## ХранилищеНастроекДанныхФормЗагрузить +
+ +Описание, пример вызова + +```bsl + +// Загружает настройку из хранилища настроек данных форм, как метод платформы Загрузить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Кроме того, возвращает указанное значение по умолчанию, если настройки не существуют. +// Если нет права СохранениеДанныхПользователя, возвращается значение по умолчанию без ошибки. +// +// В возвращаемом значении очищаются ссылки на несуществующий объект в базе данных, а именно +// - возвращаемая ссылка заменяется на указанное значение по умолчанию; +// - из данных типа Массив ссылки удаляются; +// - у данных типа Структура и Соответствие ключ не меняется, а значение устанавливается Неопределено; +// - анализ значений в данных типа Массив, Структура, Соответствие выполняется рекурсивно. +// +// См. ОбщегоНазначения.ХранилищеНастроекДанныхФормЗагрузить +// +// Параметры: +// КлючОбъекта - Строка - см. синтакс-помощник платформы. +// КлючНастроек - Строка - см. синтакс-помощник платформы. +// ЗначениеПоУмолчанию - Произвольный - значение, которое возвращается, если настройки не существуют. +// Если не указано, возвращается значение Неопределено. +// ОписаниеНастроек - Неопределено - не используется на клиенте. +// ИмяПользователя - Строка - см. синтакс-помощник платформы. +// +// Возвращаемое значение: +// Произвольный - см. синтакс-помощник платформы. +// +Функция ХранилищеНастроекДанныхФормЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ХранилищеНастроекДанныхФормЗагрузить(КлючОбъекта, КлючНастроек, ЗначениеПоУмолчанию, ); +``` +
+ +## ХранилищеНастроекДанныхФормУдалить +
+ +Описание, пример вызова + +```bsl + +// Удаляет настройку из хранилища настроек данных форм, как метод платформы Удалить, +// объектов СтандартноеХранилищеНастроекМенеджер или ХранилищеНастроекМенеджер.<Имя хранилища>, +// но с поддержкой длины ключа настроек более 128 символов путем хеширования части, +// которая превышает 96 символов. +// Если нет права СохранениеДанныхПользователя, удаление пропускается без ошибки. +// +// См. ОбщегоНазначения.ХранилищеНастроекДанныхФормУдалить +// +// Параметры: +// КлючОбъекта - Строка +// - Неопределено - см. синтакс-помощник платформы. +// КлючНастроек - Строка +// - Неопределено - см. синтакс-помощник платформы. +// ИмяПользователя - Строка +// - Неопределено - см. синтакс-помощник платформы. +// +Процедура ХранилищеНастроекДанныхФормУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ХранилищеНастроекДанныхФормУдалить(КлючОбъекта, КлючНастроек, ИмяПользователя) +``` +
+ +## ПерейтиПоСсылке +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать: +// ФайловаяСистемаКлиент.ОткрытьНавигационнуюСсылку при передачи ссылки на сайт или навигационной ссылки. +// ФайловаяСистемаКлиент.ОткрытьПроводник для открытия каталога в проводнике. +// ФайловаяСистемаКлиент.ОткрытьФайл для открытия файла по расширению при передачи пути к файлу. +// +// Выполняет переход по ссылке на объект информационной базы или внешний объект. +// (например, ссылка на сайт или путь каталога на компьютере). +// +// Параметры: +// Ссылка - Строка - ссылка для перехода. +// +Процедура ПерейтиПоСсылке(Ссылка) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ПерейтиПоСсылке(Ссылка) +``` +
+ +## ПоказатьВопросОбУстановкеРасширенияРаботыСФайлами +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистемаКлиент.ПодключитьРасширениеДляРаботы1СПредприятия +// Предлагает пользователю установить расширение для работы с 1С:Предприятием в веб-клиенте. +// Предназначена для использования в начале участков кода, в которых ведется работа с файлами. +// +// Параметры: +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - описание процедуры, +// которая будет вызвана после закрытия формы со следующими параметрами: +// РасширениеПодключено - Булево - Истина, если расширение было подключено. +// ДополнительныеПараметры - Произвольный - параметры, заданные в +// ОписаниеОповещенияОЗакрытии. +// ТекстПредложения - Строка - текст сообщения. Если не указан, то выводится текст по умолчанию. +// ВозможноПродолжениеБезУстановки - Булево - если Истина, будет показана кнопка ПродолжитьБезУстановки, +// если Ложь, будет показана кнопка Отмена. +// +// Пример: +// +// Оповещение = Новый ОписаниеОповещения("ПечатьДокументаЗавершение", ЭтотОбъект); +// ТекстСообщения = НСтр("ru = 'Для печати документа необходимо установить расширение для работы с 1С:Предприятием.'"); +// ОбщегоНазначенияКлиент.ПоказатьВопросОбУстановкеРасширенияРаботыСФайлами(Оповещение, ТекстСообщения); +// +// Процедура ПечатьДокументаЗавершение(РасширениеПодключено, ДополнительныеПараметры) Экспорт +// Если РасширениеПодключено Тогда +// // код печати документа, рассчитывающий на то, что расширение подключено. +// // ... +// Иначе +// // код печати документа, который работает без подключенного расширения. +// // ... +// КонецЕсли; +// +Процедура ПоказатьВопросОбУстановкеРасширенияРаботыСФайлами(ОписаниеОповещенияОЗакрытии, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ПоказатьВопросОбУстановкеРасширенияРаботыСФайлами(ОписаниеОповещенияОЗакрытии, ); +``` +
+ +## ПроверитьРасширениеРаботыСФайламиПодключено +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистемаКлиент.ПодключитьРасширениеДляРаботы1СПредприятия +// Предлагает пользователю подключить расширение для работы с 1С:Предприятием в веб-клиенте, +// и в случае отказа выдает предупреждение о невозможности продолжения операции. +// Предназначена для использования в начале участков кода, в которых ведется работа с файлами +// только при подключенном расширении. +// +// Параметры: +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - описание процедуры, которая будет вызвана, если расширение +// подключено со следующими параметрами: +// Результат - Булево - всегда Истина. +// ДополнительныеПараметры - Неопределено +// ТекстПредложения - Строка - текст с предложением подключить расширение для работы с 1С:Предприятием. +// Если не указан, то выводится текст по умолчанию. +// ТекстПредупреждения - Строка - текст предупреждения о невозможности продолжения операции. +// Если не указан, то выводится текст по умолчанию. +// +// Пример: +// +// Оповещение = Новый ОписаниеОповещения("ПечатьДокументаЗавершение", ЭтотОбъект); +// ТекстСообщения = НСтр("ru = 'Для печати документа необходимо установить расширение для работы с 1С:Предприятием.'"); +// ОбщегоНазначенияКлиент.ПроверитьРасширениеРаботыСФайламиПодключено(Оповещение, ТекстСообщения); +// +// Процедура ПечатьДокументаЗавершение(Результат, ДополнительныеПараметры) Экспорт +// // код печати документа, рассчитывающий на то, что расширение подключено. +// // ... +// +Процедура ПроверитьРасширениеРаботыСФайламиПодключено(ОписаниеОповещенияОЗакрытии, Знач ТекстПредложения = "", Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ПроверитьРасширениеРаботыСФайламиПодключено(ОписаниеОповещенияОЗакрытии, ТекстПредложения, ); +``` +
+ +## ПредлагатьУстановкуРасширенияРаботыСФайлами +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистемаКлиент.ПодключитьРасширениеДляРаботы1СПредприятия. +// Возвращает пользовательскую настройку "Предлагать установку расширения для работы с 1С:Предприятием". +// +// Возвращаемое значение: +// Булево - Истина, если предлагать. +// +Функция ПредлагатьУстановкуРасширенияРаботыСФайлами() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ПредлагатьУстановкуРасширенияРаботыСФайлами() +``` +
+ +## ОткрытьФайлВПрограммеПросмотра +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистемаКлиент.ОткрытьФайл +// Открывает файл в программе просмотра, ассоциированной с расширением файла в операционной системе. +// Блокирует возможность открытия файлов, расширение которых относятся к исполняемым файлам. +// +// Параметры: +// ПутьКФайлу - Строка - полный путь к файлу, который требуется открыть. +// Оповещение - ОписаниеОповещения - оповещение о результате открытия. +// если оповещение не задано, в случае ошибки будет показано предупреждение: +// * ПриложениеЗапущено - Булево - Истина, если внешнее приложение не вызвало ошибок при открытии. +// * ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// +// Пример: +// ОбщегоНазначенияКлиент.ОткрытьФайлВПрограммеПросмотра(КаталогДокументов() + "test.PDF"); +// ОбщегоНазначенияКлиент.ОткрытьФайлВПрограммеПросмотра(КаталогДокументов() + "test.xlsx"); +// +Процедура ОткрытьФайлВПрограммеПросмотра(ПутьКФайлу, Знач Оповещение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ОткрытьФайлВПрограммеПросмотра(ПутьКФайлу, Оповещение); +``` +
+ +## ОткрытьПроводник +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистемаКлиент.ОткрытьПроводник +// Открывает проводник с указанным путем. +// Если передан путь к файлу, то выполняет позиционирование курсора в проводнике на этом файле. +// +// Параметры: +// ПутьККаталогуИлиФайлу - Строка - полный путь к файлу или каталогу. +// +// Пример: +// // Для Windows +// ОбщегоНазначенияКлиент.ОткрытьПроводник("C:\Users"); +// ОбщегоНазначенияКлиент.ОткрытьПроводник("C:\Program Files\1cv8\common\1cestart.exe"); +// // Для Linux +// ОбщегоНазначенияКлиент.ОткрытьПроводник("/home/"); +// ОбщегоНазначенияКлиент.ОткрытьПроводник("/opt/1C/v8.3/x86_64/1cv8c"); +// +Процедура ОткрытьПроводник(ПутьККаталогуИлиФайлу) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ОткрытьПроводник(ПутьККаталогуИлиФайлу) +``` +
+ +## ОткрытьНавигационнуюСсылку +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистемаКлиент.ОткрытьНавигационнуюСсылку +// Открывает навигационную ссылку в программе, которая ассоциирована с протоколом навигационной ссылки. +// +// Допустимые протоколы: HTTP, https, e1c, v8help, mailto, tel, skype. +// +// Для открытия проводника или файла в программе просмотра не следует формировать ссылку по протоколу file:// +// - для открытия проводника см. ОткрытьПроводник. +// - для открытия файла по расширению см. ОткрытьФайлВПрограммеПросмотра. +// +// Параметры: +// НавигационнаяСсылка - Строка - ссылка, которую требуется открыть. +// Оповещение - ОписаниеОповещения - оповещение о результате открытия. +// если оповещение не задано, в случае ошибки будет показано предупреждение: +// * ПриложениеЗапущено - Булево - Истина, если внешнее приложение не вызвало ошибок при открытии. +// * ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// +// Пример: +// ОбщегоНазначенияКлиент.ОткрытьНавигационнуюСсылку("e1cib/navigationpoint/startpage"); // начальная страница. +// ОбщегоНазначенияКлиент.ОткрытьНавигационнуюСсылку("v8help://1cv8/QueryLanguageFullTextSearchInData"); +// ОбщегоНазначенияКлиент.ОткрытьНавигационнуюСсылку("https://1c.com"); +// ОбщегоНазначенияКлиент.ОткрытьНавигационнуюСсылку("mailto:help@1c.com"); +// ОбщегоНазначенияКлиент.ОткрытьНавигационнуюСсылку("skype:echo123?call"); +// +Процедура ОткрытьНавигационнуюСсылку(НавигационнаяСсылка, Знач Оповещение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.ОткрытьНавигационнуюСсылку(НавигационнаяСсылка, Оповещение); +``` +
+ +## СоздатьВременныйКаталог +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистемаКлиент.СоздатьВременныйКаталог +// Получение имени временного каталога. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение о результате получения: +// * ИмяКаталога - Строка - путь к созданному каталогу. +// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения. +// Расширение - Строка - суффикс в имени каталога, который поможет идентифицировать каталог при анализе. +// +Процедура СоздатьВременныйКаталог(Знач Оповещение, Расширение = "") Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиент.СоздатьВременныйКаталог(Оповещение, Расширение); +``` +
+ +## ЭтоOSXКлиент +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.ЭтоMacOSКлиент +// Возвращает Истина, если клиентское приложение запущено под управлением ОС X. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоOSXКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиент.ЭтоOSXКлиент() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбщегоНазначенияКлиентПереопределяемый.md b/src/content/docs/bsp/ОбщегоНазначенияКлиентПереопределяемый.md new file mode 100644 index 0000000..92739d5 --- /dev/null +++ b/src/content/docs/bsp/ОбщегоНазначенияКлиентПереопределяемый.md @@ -0,0 +1,446 @@ +--- +title: Общего назначения клиент переопределяемый +slug: bsp/общего-назначения-клиент-переопределяемый +--- + + +## ПередНачаломРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Возникает при запуске приложения до открытия главного окна. +// В процедуре-обработчике могут быть выполнены необходимые проверки и, при необходимости, установлен параметр отказа +// от запуска приложения. Соответствует обработчику ПередНачаломРаботыСистемы. +// +// При работе в модели сервиса обработчик вызывается также: +// - при запуске сеанса администратора без установленных значений разделителей; +// - при входе администратора в область данных из сеанса без установленных значений разделителей. +// Для проверки режима запуска см. функцию ОбщегоНазначенияКлиент.ДоступноИспользованиеРазделенныхДанных. +// +// Параметры: +// Параметры - Структура: +// * Отказ - Булево - возвращаемое значение. Если установить Истина, то работа программы будет прекращена. +// * Перезапустить - Булево - возвращаемое значение. Если установить Истина, и параметр Отказ тоже установлен +// в Истина, то выполняется перезапуск программы. +// +// * ДополнительныеПараметрыКоманднойСтроки - Строка - возвращаемое значение. Имеет смысл, когда Отказ +// и Перезапустить установлены Истина. +// +// * ИнтерактивнаяОбработка - ОписаниеОповещения - возвращаемое значение. Для открытия окна, блокирующего вход в +// программу, следует присвоить в этот параметр описание обработчика +// оповещения, который открывает окно. +// +// * ОбработкаПродолжения - ОписаниеОповещения - если открывается окно, блокирующее вход в программу, то в обработке +// закрытия этого окна необходимо выполнить оповещение ОбработкаПродолжения. +// +// * Модули - Массив - ссылки на модули, в которых нужно вызвать эту же процедуру после возврата. +// Модули можно добавлять только в рамках вызова в процедуру переопределяемого модуля. +// Используется для упрощения реализации нескольких последовательных асинхронных вызовов +// в разные подсистемы. См. пример ИнтеграцияПодсистемБСПКлиент.ПередНачаломРаботыСистемы. +// +// Пример: +// Следующий код открывает окно, блокирующее вход в программу. +// +// Если ОткрытьОкноПриЗапуске Тогда +// Параметры.ИнтерактивнаяОбработка = Новый ОписаниеОповещения("ОткрытьОкно", ЭтотОбъект); +// КонецЕсли; +// +// Процедура ОткрытьОкно(Параметры, ДополнительныеПараметры) Экспорт +// // Показываем окно, по закрытию которого вызывается обработчик оповещения ОткрытьОкноЗавершение. +// Оповещение = Новый ОписаниеОповещения("ОткрытьОкноЗавершение", ЭтотОбъект, Параметры); +// Форма = ОткрытьФорму(... ,,, ... Оповещение); +// Если Не Форма.Открыта() Тогда // Если ПриСозданииНаСервере Отказ установлен Истина. +// ВыполнитьОбработкуОповещения(Параметры.ОбработкаПродолжения); +// КонецЕсли; +// КонецПроцедуры +// +// Процедура ОткрытьОкноЗавершение(Результат, Параметры) Экспорт +// ... +// ВыполнитьОбработкуОповещения(Параметры.ОбработкаПродолжения); +// +// КонецПроцедуры +// +Процедура ПередНачаломРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПередНачаломРаботыСистемы(Параметры) +``` +
+ +## ПриНачалеРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Возникает при запуске приложения после открытия главного окна. +// В процедуре-обработчике могут быть выполнены различные действия, необходимые при запуске программы, например, +// открыты некоторые формы. Соответствует обработчику ПриНачалеРаботыСистемы. +// +// При работе в модели сервиса обработчик вызывается также: +// - при запуске сеанса администратора без установленных значений разделителей; +// - при входе администратора в область данных из сеанса без установленных значений разделителей. +// Для проверки режима запуска см. функцию ОбщегоНазначенияКлиент.ДоступноИспользованиеРазделенныхДанных. +// +// Параметры: +// Параметры - Структура: +// * Отказ - Булево - возвращаемое значение. Если установить Истина, то работа программы будет прекращена. +// * Перезапустить - Булево - возвращаемое значение. Если установить Истина и параметр Отказ тоже установлен +// в Истина, то выполняется перезапуск программы. +// +// * ДополнительныеПараметрыКоманднойСтроки - Строка - возвращаемое значение. Имеет смысл +// когда Отказ и Перезапустить установлены Истина. +// +// * ИнтерактивнаяОбработка - ОписаниеОповещения - возвращаемое значение. Для открытия окна, блокирующего вход +// в программу, следует присвоить в этот параметр описание обработчика оповещения, +// который открывает окно. См. пример в ПередНачаломРаботыСистемы. +// +// * ОбработкаПродолжения - ОписаниеОповещения - если открывается окно, блокирующее вход в программу, то в +// обработке закрытия этого окна необходимо выполнить оповещение ОбработкаПродолжения. +// +// * Модули - Массив - ссылки на модули, в которых нужно вызвать эту же процедуру после возврата. +// Модули можно добавлять только в рамках вызова в процедуру переопределяемого модуля. +// Используется для упрощения реализации нескольких последовательных асинхронных вызовов +// в разные подсистемы. См. пример ИнтеграцияПодсистемБСПКлиент.ПередНачаломРаботыСистемы. +// +Процедура ПриНачалеРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПриНачалеРаботыСистемы(Параметры) +``` +
+ +## ПриОбработкеПараметровЗапуска +
+ +Описание, пример вызова + +```bsl + +// Вызывается для обработки собственных параметров запуска программы, +// передаваемых с помощью ключа командной строки /C, например: +// 1cv8.exe /C РежимОтладки;ОткрытьИЗакрыть +// +// Параметры: +// ПараметрыЗапуска - Массив из Строка - строки, разделенные символом ";" в параметре запуска, +// которые переданы в конфигурацию с помощью ключа командной строки /C. +// Отказ - Булево - если установить Истина, то запуск будет прерван. +// +Процедура ПриОбработкеПараметровЗапуска(ПараметрыЗапуска, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПриОбработкеПараметровЗапуска(ПараметрыЗапуска, Отказ) +``` +
+ +## ПослеНачалаРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Выполняется при запуске приложения после завершения действий ПриНачалеРаботыСистемы. +// Используется для подключения обработчиков ожидания, которые не должны вызываться +// перед и при начале работы системы. +// +// Начальная страница (рабочий стол) в этот момент еще не открыта, поэтому запрещено открывать +// формы напрямую, а следует использовать для этих целей обработчик ожидания. +// Запрещено использовать это событие для интерактивного взаимодействия с пользователем +// (ПоказатьВопрос и аналогичные действия). Для этих целей следует размещать код в процедуре ПриНачалеРаботыСистемы. +// +Процедура ПослеНачалаРаботыСистемы() Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПослеНачалаРаботыСистемы() +``` +
+ +## ПередЗавершениемРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Возникает перед завершением работы приложения до закрытия главного окна. +// В процедуре-обработчике могут быть выполнены необходимые проверки и, при необходимости, может быть установлен +// параметр отказа от выхода из программы. +// Позволяет определить список предупреждений, выводимых пользователю перед завершением работы. +// В процессе завершения работы приложения запрещены серверные вызовы и открытие окон. +// Соответствует обработчику ПередЗавершениемРаботыСистемы. +// +// При работе в модели сервиса обработчик вызывается также: +// - при завершении сеанса администратора без установленных значений разделителей; +// - при выходе администратора из области данных в сеанса без установленных значений разделителей. +// Для проверки режима запуска см. функцию ОбщегоНазначенияКлиент.ДоступноИспользованиеРазделенныхДанных. +// +// Параметры: +// Отказ - Булево - если установить данному параметру значение Истина, то работа с программой не будет +// завершена. +// Предупреждения - Массив из см. СтандартныеПодсистемыКлиент.ПредупреждениеПриЗавершенииРаботы - +// можно добавить сведения о внешнем виде предупреждения и дальнейших действиях. +// +Процедура ПередЗавершениемРаботыСистемы(Отказ, Предупреждения) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПередЗавершениемРаботыСистемы(Отказ, Предупреждения) +``` +
+ +## ПриУстановкеЗаголовкаКлиентскогоПриложения +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить заголовок приложения. +// +// Параметры: +// ЗаголовокПриложения - Строка - текст заголовка приложения; +// ПриЗапуске - Булево - Истина, если вызывается при начале работы приложения. +// В этом случае недопустимо вызывать те серверные функции конфигурации, +// которые рассчитывают на то, что запуск уже полностью завершен. +// Например, вместо СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиента +// следует вызывать СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиентаПриЗапуске. +// +// Пример: +// Для того чтобы в начале заголовка приложения вывести название текущего проекта, следует определить параметр +// ТекущийПроект в процедуре ОбщегоНазначенияПереопределяемый.ПриДобавленииПараметровРаботыКлиента и вписать код: +// +// Если Не ОбщегоНазначенияКлиент.ДоступноИспользованиеРазделенныхДанных() Тогда +// Возврат; +// КонецЕсли; +// ПараметрыКлиента = ?(ПриЗапуске, СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиентаПриЗапуске(), +// СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиента()); +// Если ПараметрыКлиента.Свойство("ТекущийПроект") +// И ЗначениеЗаполнено(ПараметрыКлиента.ТекущийПроект) Тогда +// ЗаголовокПриложения = Строка(ПараметрыКлиента.ТекущийПроект) + " / " + ЗаголовокПриложения; +// КонецЕсли; +// +Процедура ПриУстановкеЗаголовкаКлиентскогоПриложения(ЗаголовокПриложения, ПриЗапуске) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПриУстановкеЗаголовкаКлиентскогоПриложения(ЗаголовокПриложения, ПриЗапуске) +``` +
+ +## ПередПериодическойОтправкойДанныхКлиентаНаСервер +
+ +Описание, пример вызова + +```bsl + +// Вызывается из глобального обработчика ожидания каждые 60 сек +// для возможности централизованно передать данные с клиента на сервер. +// Например, для передачи статистики о количестве открытых окон. +// Не рекомендуется делать собственные глобальные обработчики ожидания, +// чтобы минимизировать общее количество серверных вызовов. +// +// Не рекомендуется передавать данные каждые 60 сек, а делать это реже +// в зависимости от реальной необходимости (ориентироваться на один раз в 20 минут). +// Не рекомендуется передавать избыточно большой объем данных, +// так как это уменьшает отзывчивость клиентского приложения. +// +// Для отправки данных с клиента на сервер заполните параметр Параметры, +// который затем будет передан в процедуру +// ОбщегоНазначенияПереопределяемый.ПриПериодическомПолученииДанныхКлиентаНаСервере. +// +// Параметры: +// Параметры - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя параметра, передаваемого на сервер. +// * Значение - Произвольный - значение параметра, передаваемого на сервер. +// +// Пример: +// МоментНачала = ТекущаяУниверсальнаяДатаВМиллисекундах(); +// Попытка +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ЦентрМониторинга") Тогда +// МодульЦентрМониторингаКлиентСлужебный = ОбщегоНазначенияКлиент.ОбщийМодуль("ЦентрМониторингаКлиентСлужебный"); +// МодульЦентрМониторингаКлиентСлужебный.ПередПериодическойОтправкойДанныхКлиентаНаСервер(Параметры); +// КонецЕсли; +// Исключение +// СерверныеОповещенияКлиент.ОбработатьОшибку(ИнформацияОбОшибке()); +// КонецПопытки; +// СерверныеОповещенияКлиент.ДобавитьПоказатель(МоментНачала, +// "ЦентрМониторингаКлиентСлужебный.ПередПериодическойОтправкойДанныхКлиентаНаСервер"); +// +Процедура ПередПериодическойОтправкойДанныхКлиентаНаСервер(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПередПериодическойОтправкойДанныхКлиентаНаСервер(Параметры) +``` +
+ +## ПослеПериодическогоПолученияДанныхКлиентаНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается из глобального обработчика ожидания каждые 60 сек после возврата с сервера. +// Требуется, когда сервер возвращает результат для обработки на клиенте. +// Например, признак дальнейшей передачи статистики с клиента на сервер. +// +// Для получения результатов сервера на клиенте они должны быть заполнены +// в параметре Результаты в процедуре +// ОбщегоНазначенияПереопределяемый.ПриПериодическомПолученииДанныхКлиентаНаСервере. +// +// Параметры: +// Результаты - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя параметра, возвращенного с сервера. +// * Значение - Произвольный - значение параметра, возвращенного с сервера. +// +// Пример: +// МоментНачала = ТекущаяУниверсальнаяДатаВМиллисекундах(); +// Попытка +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ЦентрМониторинга") Тогда +// МодульЦентрМониторингаКлиентСлужебный = ОбщегоНазначенияКлиент.ОбщийМодуль("ЦентрМониторингаКлиентСлужебный"); +// МодульЦентрМониторингаКлиентСлужебный.ПослеПериодическогоПолученияДанныхКлиентаНаСервере(Результаты); +// КонецЕсли; +// Исключение +// СерверныеОповещенияКлиент.ОбработатьОшибку(ИнформацияОбОшибке()); +// КонецПопытки; +// СерверныеОповещенияКлиент.ДобавитьПоказатель(МоментНачала, +// "ЦентрМониторингаКлиентСлужебный.ПослеПериодическогоПолученияДанныхКлиентаНаСервере"); +// +Процедура ПослеПериодическогоПолученияДанныхКлиентаНаСервере(Результаты) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПослеПериодическогоПолученияДанныхКлиентаНаСервере(Результаты) +``` +
+ +## ПриГлобальномПоиске +
+ +Описание, пример вызова + +```bsl + +// Вызывается при вводе в строку глобального поиска (после стандартной задержки). +// При вызове события в параметре ПланПоиска передается копия плана, установленного в менеджере глобального поиска. +// Содержимое параметра ПланПоиска можно модифицировать в коде обработчика. +// +// Параметры: +// СтрокаПоиска - Строка - строка поиска +// ПланПоиска - ПланГлобальногоПоиска - текущий план выполнения глобального поиска +// +Процедура ПриГлобальномПоиске(СтрокаПоиска, ПланПоиска) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПриГлобальномПоиске(СтрокаПоиска, ПланПоиска) +``` +
+ +## ПриВыбореРезультатаГлобальногоПоиска +
+ +Описание, пример вызова + +```bsl + +// Вызывается при выборе результата глобального поиска. +// Если после завершения работы процедуры обработки события СтандартнаяОбработка установлено в Истина, +// то в зависимости от типа значения, используемого в объекте ЭлементРезультатаГлобальногоПоиска, +// выполняется одно из следующих действий: +// Строка - переход по навигационной ссылке. Если строка является ссылкой на страницу справочной +// информации, выполняется открытие справки. +// ИдентификаторОбсужденияСистемыВзаимодействия, ИдентификаторПользователяСистемыВзаимодействия - открытие обсуждения. +// ИдентификаторСообщенияСистемыВзаимодействия - открытие обсуждения и позиционирование на сообщение. +// Другой тип - вызов метода ПоказатьЗначение с указанным значением. +// +// Параметры: +// ЭлементРезультата - ЭлементРезультатаГлобальногоПоиска - выбранный результат поиска. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной (системной) обработки события. +// Если в теле процедуры-обработчика установить данному параметру значение Ложь, +// стандартная обработка события производиться не будет. +// +Процедура ПриВыбореРезультатаГлобальногоПоиска(ЭлементРезультата, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПриВыбореРезультатаГлобальногоПоиска(ЭлементРезультата, СтандартнаяОбработка) +``` +
+ +## ПриВыбореДействияРезультатаГлобальногоПоиска +
+ +Описание, пример вызова + +```bsl + +// Вызывается при нажатии на гиперссылку в элементе результата глобального поиска, заданную в свойстве Действия +// +// Параметры: +// ЭлементРезультата - ЭлементРезультатаГлобальногоПоиска - элемент результата глобального описка, +// в котором нажата гиперссылка действия. +// Действие - Произвольный - значение, заданное для нажатой гиперссылки. +// +Процедура ПриВыбореДействияРезультатаГлобальногоПоиска(ЭлементРезультата, Действие) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ПриВыбореДействияРезультатаГлобальногоПоиска(ЭлементРезультата, Действие) +``` +
+ +## ОбработкаПереходаПоНавигационнойСсылке +
+ +Описание, пример вызова + +```bsl + +// Вызывается при переходе по навигационной ссылке внутри приложения или при переходе в приложение по +// внешней ссылке или ссылке в мобильное приложение. +// +// Параметры: +// ДанныеПереходаПоНавигационнойСсылке - ДанныеПереходаПоНавигационнойСсылке - данные перехода по навигационной ссылке. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной (системной) +// обработки ссылки. Если в теле процедуры-обработчика установить данному параметру значение Ложь, +// стандартная обработка перехода по ссылке производиться не будет. +// +Процедура ОбработкаПереходаПоНавигационнойСсылке(ДанныеПереходаПоНавигационнойСсылке, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентПереопределяемый.ОбработкаПереходаПоНавигационнойСсылке(ДанныеПереходаПоНавигационнойСсылке, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбщегоНазначенияКлиентСервер.md b/src/content/docs/bsp/ОбщегоНазначенияКлиентСервер.md new file mode 100644 index 0000000..97e1ccc --- /dev/null +++ b/src/content/docs/bsp/ОбщегоНазначенияКлиентСервер.md @@ -0,0 +1,3070 @@ +--- +title: Общего назначения клиент сервер +slug: bsp/общего-назначения-клиент-сервер +--- + + +## УточнениеИсключения +
+ +Описание, пример вызова + +```bsl + +// Возвращает уточненный текст исключения для пользователя и +// категорию для вызова исключения с уточненным текстом. +// +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке - исходная информация об ошибке. +// ЗаголовокОшибки - Строка - заголовок, уточняющий ошибку для пользователя и администратора. +// Если не указан, тогда возвращается текст исключения без уточнения. +// +// ОшибкаНаКлиенте - Булево - нужно указать Истина, если уточняется ошибка, +// которая изначально возникла на клиенте, так как для некоторых ошибок, +// например, ОшибкаДоступаКЛокальномуФайлу, ОшибкаРаботыСПринтером платформа +// делает разную обработку (доступ к локальному файлу на клиенте дополняется +// уточнениями, а на сервере не дополняется), соответственно требуется +// по-разному вызывать исключение с уточнением. +// +// Возвращаемое значение: +// Структура: +// * Текст - Строка - текст ошибки с уточнением (без уточнения, если ЗаголовокОшибки пустой). +// * Категория - КатегорияОшибки - категория для вызова исключения с уточнением. +// - Неопределено - если категорию нужно оставить неуказанной +// при вызове исключения с уточнением. +// +// Пример: +// Попытка +// ВыполнитьКоманду(...); +// Исключение +// ИнформацияОбОшибке = ИнформацияОбОшибке(); +// ЗаголовокОшибки = СтроковыеФункцииКлиентСервер.ПодставитьПараметрыВСтроку( +// НСтр("ru = 'Не удалось выполнить команду %1 по причине:'"), ИдентификаторКоманды); +// Уточнение = ОбщегоНазначенияКлиентСервер.УточнениеИсключения(ИнформацияОбОшибке, ЗаголовокОшибки); +// ВызватьИсключение(Уточнение.Текст, Уточнение.Категория,,, ИнформацияОбОшибке); +// КонецПопытки; +// +// Попытка +// СоединениеСИнтернет.Получить(ПутьНаСервере, ПутьДляСохранения); +// Исключение +// ИнформацияОбОшибке = ИнформацияОбОшибке(); +// Уточнение = ОбщегоНазначенияКлиентСервер.УточнениеИсключения(ИнформацияОбОшибке); +// ДляАдминистратора = ДиагностикаСоединенияСИнтернет(...); +// ВызватьИсключение(Уточнение.Текст, Уточнение.Категория,, ДляАдминистратора, ИнформацияОбОшибке); +// КонецПопытки; +// +Функция УточнениеИсключения(ИнформацияОбОшибке, ЗаголовокОшибки = "", ОшибкаНаКлиенте = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.УточнениеИсключения(ИнформацияОбОшибке, ЗаголовокОшибки, ОшибкаНаКлиенте); +``` +
+ +## ЭтоИсключениеСКодомОшибки +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие в ошибке хотя бы одного кода из указанных. +// При проверке учитываются все вложенные причины исключения. +// +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке - ошибка, в которой проверяется наличие кода ошибки. +// КодыОшибок - Строка - многострочная строка кодов ошибок, которые нужно искать в ошибке, например: +// "СтандартныеПодсистемы.БазоваяФункциональность.КонфигурацияИзмененаДинамически +// |СтандартныеПодсистемы.БазоваяФункциональность.РасширенияИзмененыДинамически". +// +// Возвращаемое значение: +// Булево +// +// Пример: +// Попытка +// ВыполнитьОбновление(); +// Исключение +// Если ОбщегоНазначенияКлиентСервер.ЭтоИсключениеСКодомОшибки(ИнформацияОбОшибке(), +// "СтандартныеПодсистемы.БазоваяФункциональность.КонфигурацияИзмененаДинамически +// |СтандартныеПодсистемы.БазоваяФункциональность.РасширенияИзмененыДинамически") Тогда +// ПерезапуститьФоновоеЗадание(); +// Возврат; +// КонецЕсли; +// ВызватьИсключение; +// КонецПопытки; +// +Функция ЭтоИсключениеСКодомОшибки(ИнформацияОбОшибке, КодыОшибок) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЭтоИсключениеСКодомОшибки(ИнформацияОбОшибке, КодыОшибок) +``` +
+ +## ДобавитьОшибкуПользователю +
+ +Описание, пример вызова + +```bsl + +// АПК:142-выкл 4 необязательных параметра для совместимости с предыдущими версиями библиотеки. + +// Добавляет в список ошибок новую ошибку пользователя для дальнейшей отправки с помощью +// процедуры СообщитьОшибкиПользователю(). +// Предназначена для накопления списка ошибок с последующей обработкой этого списка, перед тем как вывести +// пользователю. Полученный список ошибок можно, например, отсортировать по важности, очистить от дублей, +// а также вывести пользователю в ином виде, чем выводит метод СообщитьПользователю, например в табличный документ. +// +// Параметры: +// Ошибки - Неопределено - создать новый список ошибок. +// - Структура: +// * СписокОшибок - Массив из Структура: +// ** ПолеОшибки - Строка +// ** ТекстДляОднойОшибки - Строка +// ** ГруппаОшибок - Произвольный +// ** НомерСтроки - Число +// ** ТекстДляНесколькихОшибок - Строка +// * ГруппыОшибок - Соответствие +// +// ПолеОшибки - Строка - значение, которое задается в свойстве Поле объекта СообщениеПользователю. +// Для автоподстановки номера строки должна содержать "%1". +// Например, "Объект.ИНН" или "Объект.Пользователи[%1].Пользователь". +// ТекстДляОднойОшибки - Строка - текст ошибки для случая, когда ГруппаОшибок в коллекции только одна, +// например НСтр("ru = 'Пользователь не выбран.'"). +// ГруппаОшибок - Произвольный - используется для выбора либо текста для одной ошибки, +// либо текста для нескольких ошибок, например, имя "Объект.Пользователи". +// Если значение не заполнено, тогда используется текст для одной ошибки. +// НомерСтроки - Число - значение от 0 ... , определяющее номер строки, который нужно подставить +// в строку ПолеОшибки и в ТекстДляНесколькихОшибок (подставляется НомерСтроки + 1). +// ТекстДляНесколькихОшибок - Строка - текст ошибки для случая, когда добавлено несколько ошибок с одинаковым +// свойством ГруппаОшибок, например, НСтр("ru = 'Пользователь в строке %1 не выбран.'"). +// ИндексСтроки - Неопределено - совпадает со значением параметра НомерСтроки. +// Число - значение от 0 ... , определяющее номер строки, который нужно подставить +// в строку ПолеОшибки. +// +Процедура ДобавитьОшибкуПользователю( Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.ДобавитьОшибкуПользователю(); +``` +
+ +## СообщитьОшибкиПользователю +
+ +Описание, пример вызова + +```bsl + +// АПК:142-вкл + +// Выводит накопленные методом ДобавитьОшибкуПользователю ошибки, при этом использует нужные шаблоны текстов ошибок +// в зависимости от количества однотипных ошибок. +// Не подходит для отправки сообщений из фонового заданий длительной операции. +// +// Параметры: +// Ошибки - см. ДобавитьОшибкуПользователю.Ошибки +// Отказ - Булево - устанавливается Истина, если ошибки сообщались. +// +Процедура СообщитьОшибкиПользователю(Ошибки, Отказ = Ложь) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.СообщитьОшибкиПользователю(Ошибки, Отказ); +``` +
+ +## ТекстОшибкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +// Формирует текст ошибок заполнения полей и списков. +// +// Параметры: +// ВидПоля - Строка - может принимать значения: Поле, Колонка, Список. +// ВидСообщения - Строка - может принимать значения: Заполнение, Корректность. +// ИмяПоля - Строка - имя поля. +// НомерСтроки - Строка +// - Число - номер строки. +// ИмяСписка - Строка - имя списка. +// ТекстСообщения - Строка - детальная расшифровка ошибки заполнения. +// +// Возвращаемое значение: +// Строка - текст ошибки заполнения. +// +Функция ТекстОшибкиЗаполнения( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ТекстОшибкиЗаполнения(); +``` +
+ +## ПутьКТабличнойЧасти +
+ +Описание, пример вызова + +```bsl + +// Формирует путь к заданной строке НомерСтроки и колонке ИмяРеквизита +// табличной части ИмяТабличнойЧасти для выдачи сообщений в форме. +// Для совместного использования с процедурой СообщитьПользователю +// (для передачи в параметры Поле или ПутьКДанным). +// +// Параметры: +// ИмяТабличнойЧасти - Строка - имя табличной части. +// НомерСтроки - Число - номер строки табличной части. +// ИмяРеквизита - Строка - имя реквизита. +// +// Возвращаемое значение: +// Строка - путь к ячейке таблицы. +// +Функция ПутьКТабличнойЧасти( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПутьКТабличнойЧасти(); +``` +
+ +## КаталогФайловойИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции описания текущего окружения клиентского приложения и операционной системы. + +// Для файлового режима работы возвращает полное имя каталога, в котором расположена информационная база. +// Если режим работы клиент-серверный, то возвращается пустая строка. +// +// Возвращаемое значение: +// Строка - полное имя каталога, в котором расположена файловая информационная база. +// +Функция КаталогФайловойИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.КаталогФайловойИнформационнойБазы() +``` +
+ +## ИмяТипаПлатформы +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя значения перечисления типа платформы. +// +// Параметры: +// ЗначениеТипаПлатформы - Неопределено - вернуть текущее имя типа платформы +// (из объекта СистемнаяИнформация). +// - ТипПлатформы - вернуть имя указанного значения типа платформы. +// Возвращаемое значение: +// Строка - например, Windows_x86_64, Linux_x86_64, MacOS_x86... +// +Функция ИмяТипаПлатформы(Знач ЗначениеТипаПлатформы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ИмяТипаПлатформы(ЗначениеТипаПлатформы); +``` +
+ +## Проверить +
+ +Описание, пример вызова + +```bsl + +// Вызывает исключение с текстом Сообщение, если Условие не равно Истина. +// Применяется для самодиагностики кода. +// +// Параметры: +// Условие - Булево - если не равно Истина, то вызывается исключение. +// Сообщение - Строка - текст сообщения. Если не задан, то исключение вызывается с сообщением по умолчанию. +// КонтекстПроверки - Строка - например, имя процедуры или функции, в которой выполняется проверка. +// +Процедура Проверить(Знач Условие, Знач Сообщение = "", Знач КонтекстПроверки = "") Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.Проверить(Условие, Сообщение, КонтекстПроверки); +``` +
+ +## ПроверитьПараметр +
+ +Описание, пример вызова + +```bsl + +// Вызывает исключение, если тип значения параметра ИмяПараметра процедуры или функции ИмяПроцедурыИлиФункции +// отличается от ожидаемого. +// Для быстрой диагностики типов параметров, передаваемых в процедуры и функции программного интерфейса. +// +// В связи с особенностью реализации ОписанияТипов всегда включает в себя тип <Неопределено>. +// если требуется жесткая проверка типа, используйте в параметре ОжидаемыеТипы +// конкретный тип, массив или соответствие типов. +// +// Параметры: +// ИмяПроцедурыИлиФункции - Строка - имя процедуры или функции, параметр которой проверяется. +// ИмяПараметра - Строка - имя проверяемого параметра процедуры или функции. +// ЗначениеПараметра - Произвольный - фактическое значение параметра. +// ОжидаемыеТипы - ОписаниеТипов +// - Тип +// - Массив +// - ФиксированныйМассив +// - Соответствие +// - ФиксированноеСоответствие - тип(ы) +// параметра процедуры или функции. +// ОжидаемыеТипыСвойств - Структура - если ожидаемый тип - структура, то +// в этом параметре можно указать типы ее свойств. +// ОжидаемыеЗначения - Массив, Строка - допустимые значения параметра в виде массива или строки через запятую. +// +Процедура ПроверитьПараметр(Знач ИмяПроцедурыИлиФункции, Знач ИмяПараметра, Знач ЗначениеПараметра, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.ПроверитьПараметр(ИмяПроцедурыИлиФункции, ИмяПараметра, ЗначениеПараметра, ); +``` +
+ +## ДополнитьТаблицу +
+ +Описание, пример вызова + +```bsl + +// Дополняет таблицу значений - приемник данными из таблицы значений - источника. +// Типы ТаблицаЗначений, ДеревоЗначений, ТабличнаяЧасть не доступны на клиенте. +// +// Параметры: +// ТаблицаИсточник - ТаблицаЗначений +// - ДеревоЗначений +// - ТабличнаяЧасть +// - ДанныеФормыКоллекция - таблица, из которой будут +// браться строки для заполнения; +// ТаблицаПриемник - ТаблицаЗначений +// - ДеревоЗначений +// - ТабличнаяЧасть +// - ДанныеФормыКоллекция - таблица, в которую будут +// добавлены строки из таблицы-источника. +// +Процедура ДополнитьТаблицу(ТаблицаИсточник, ТаблицаПриемник) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.ДополнитьТаблицу(ТаблицаИсточник, ТаблицаПриемник) +``` +
+ +## ДополнитьТаблицуИзМассива +
+ +Описание, пример вызова + +```bsl + +// Дополняет таблицу значений Таблица значениями из массива Массив. +// +// Параметры: +// Таблица - ТаблицаЗначений - таблица, которую необходимо заполнить значениями из массива; +// Массив - Массив - массив значений для заполнения таблицы; +// ИмяПоля - Строка - имя поля таблицы значений, в которое необходимо загрузить значения из массива. +// +Процедура ДополнитьТаблицуИзМассива(Таблица, Массив, ИмяПоля) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.ДополнитьТаблицуИзМассива(Таблица, Массив, ИмяПоля) +``` +
+ +## ДополнитьМассив +
+ +Описание, пример вызова + +```bsl + +// Дополняет массив МассивПриемник значениями из массива МассивИсточник. +// +// Параметры: +// МассивПриемник - Массив - массив, в который необходимо добавить значения. +// МассивИсточник - Массив - массив значений для заполнения. +// ТолькоУникальныеЗначения - Булево - если истина, то в массив будут включены только уникальные значения. +// +Процедура ДополнитьМассив(МассивПриемник, МассивИсточник, ТолькоУникальныеЗначения = Ложь) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.ДополнитьМассив(МассивПриемник, МассивИсточник, ТолькоУникальныеЗначения); +``` +
+ +## ДополнитьСтруктуру +
+ +Описание, пример вызова + +```bsl + +// Дополняет структуру значениями из другой структуры. +// +// Параметры: +// Приемник - Структура - коллекция, в которую будут добавляться новые значения. +// Источник - Структура - коллекция, из которой будут считываться пары Ключ и Значение для заполнения. +// Заменять - Булево +// - Неопределено - что делать в местах пересечения ключей источника и приемника: +// Истина - заменять значения приемника (самый быстрый способ), +// Ложь - не заменять значения приемника (пропускать), +// Неопределено - значение по умолчанию. Бросать исключение. +// +Процедура ДополнитьСтруктуру(Приемник, Источник, Заменять = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.ДополнитьСтруктуру(Приемник, Источник, Заменять); +``` +
+ +## ДополнитьСоответствие +
+ +Описание, пример вызова + +```bsl + +// Дополняет соответствие значениями из другого соответствия. +// +// Параметры: +// Приемник - Соответствие - коллекция, в которую будут добавляться новые значения. +// Источник - Соответствие из КлючИЗначение - коллекция, из которой будут считываться пары Ключ и Значение для заполнения. +// Заменять - Булево +// - Неопределено - что делать в местах пересечения ключей источника и приемника: +// Истина - заменять значения приемника (самый быстрый способ), +// Ложь - не заменять значения приемника (пропускать), +// Неопределено - значение по умолчанию. Бросать исключение. +// +Процедура ДополнитьСоответствие(Приемник, Источник, Заменять = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.ДополнитьСоответствие(Приемник, Источник, Заменять); +``` +
+ +## ДополнитьСписок +
+ +Описание, пример вызова + +```bsl + +// Дополняет список значений СписокПриемник значениями списка СписокИсточник. +// При этом если в списке-приемнике уже есть элемент с добавляемым значением, то у него заменяется представление +// на новое из списка-источника. +// +// Параметры: +// СписокПриемник - СписокЗначений +// СписокИсточник - СписокЗначений +// ПропускатьЗначенияДругихТипов - Булево - если Истина, то не добавлять в список-приемник элементы списка-источника, +// у которых тип значений не совпадает с типами значений в списке-приемнике. +// По умолчанию пропускать. +// ДобавлятьНовые - Булево, Неопределено - если Истина, то добавлять в список-приемник элементы из списка-источника +// с теми значениями, которые отсутствуют в списке-приемнике. +// +// Возвращаемое значение: +// Структура: +// * Всего - Число - общее количество элементов в списке-источнике. +// * Добавлено - Число - если ДобавлятьНовые = Истина, то количество добавленных элементов в список-приемник. +// * Обновлено - Число - количество совпавших по значениям элементов, представления которых были заменены +// в списке-приемнике на новые из списка-источника. +// * Пропущено - Число - количество пропущенных элементов в списке-приемнике. +// +Функция ДополнитьСписок(Знач СписокПриемник, Знач СписокИсточник, Знач ПропускатьЗначенияДругихТипов = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ДополнитьСписок(СписокПриемник, СписокИсточник, ПропускатьЗначенияДругихТипов, ); +``` +
+ +## ЕстьРеквизитИлиСвойствоОбъекта +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие реквизита или свойства у произвольного объекта без обращения к метаданным. +// +// Параметры: +// Объект - Произвольный - объект, у которого нужно проверить наличие реквизита или свойства; +// ИмяРеквизита - Строка - имя реквизита или свойства. +// +// Возвращаемое значение: +// Булево - Истина, если есть. +// +Функция ЕстьРеквизитИлиСвойствоОбъекта(Объект, ИмяРеквизита) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЕстьРеквизитИлиСвойствоОбъекта(Объект, ИмяРеквизита) +``` +
+ +## УдалитьВсеВхожденияЗначенияИзМассива +
+ +Описание, пример вызова + +```bsl + +// Удаляет все вхождения переданного значения из массива. +// +// Параметры: +// Массив - Массив из Произвольный - массив, из которого необходимо удалить значение. +// Значение - Произвольный - удаляемое значение из массива. +// +Процедура УдалитьВсеВхожденияЗначенияИзМассива(Массив, Значение) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УдалитьВсеВхожденияЗначенияИзМассива(Массив, Значение) +``` +
+ +## УдалитьВсеВхожденияТипаИзМассива +
+ +Описание, пример вызова + +```bsl + +// Удаляет все вхождения значений указанного типа. +// +// Параметры: +// Массив - Массив из Произвольный - массив, из которого необходимо удалить значения. +// Тип - Тип - тип значений, которые подлежат удалению из массива. +// +Процедура УдалитьВсеВхожденияТипаИзМассива(Массив, Тип) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УдалитьВсеВхожденияТипаИзМассива(Массив, Тип) +``` +
+ +## УдалитьЗначениеИзМассива +
+ +Описание, пример вызова + +```bsl + +// Удаляет одно значение из массива. +// +// Параметры: +// Массив - Массив из Произвольный - массив, из которого необходимо удалить значение. +// Значение - Произвольный - удаляемое значение из массива. +// +Процедура УдалитьЗначениеИзМассива(Массив, Значение) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УдалитьЗначениеИзМассива(Массив, Значение) +``` +
+ +## СвернутьМассив +
+ +Описание, пример вызова + +```bsl + +// Возвращает копию исходного массива с уникальными значениями. +// +// Параметры: +// Массив - Массив из Произвольный - массив произвольных значений. +// +// Возвращаемое значение: +// Массив из Произвольный +// +Функция СвернутьМассив(Знач Массив) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СвернутьМассив(Массив) +``` +
+ +## РазностьМассивов +
+ +Описание, пример вызова + +```bsl + +// Возвращает разность массивов. Разностью двух массивов является массив, содержащий +// все элементы первого массива, не существующие во втором массиве. +// +// Параметры: +// Массив - Массив из Произвольный - массив элементов, из которого необходимо выполнить вычитание; +// МассивВычитания - Массив из Произвольный - массив элементов, который будет вычитаться. +// +// Возвращаемое значение: +// Массив - разностью двух массивов. +// +// Пример: +// //А = [1, 3, 5, 7]; +// //В = [3, 7, 9]; +// Результат = ОбщегоНазначенияКлиентСервер.РазностьМассивов(А, В); +// //Результат = [1, 5]; +// +Функция РазностьМассивов(Знач Массив, Знач МассивВычитания) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.РазностьМассивов(Массив, МассивВычитания) +``` +
+ +## СпискиЗначенийИдентичны +
+ +Описание, пример вызова + +```bsl + +// Сравнивает элементы списков значений или массивов по значениям. +// +// Параметры: +// Список1 - Массив из Произвольный +// - СписокЗначений - сравниваемая коллекция элементов. +// Список2 - Массив из Произвольный +// - СписокЗначений - сравниваемая коллекция элементов. +// СравниватьКоличествоЗначений - Булево - уточнение способа сравнения: +// Ложь - проверка вхождения значений одной коллекции в другую, +// Истина - проверка вхождения значений одной коллекции в другую +// с учетом количества значений. По умолчанию Ложь. +// +// Возвращаемое значение: +// Булево - Истина, если идентичны. +// +Функция СпискиЗначенийИдентичны(Список1, Список2, СравниватьКоличествоЗначений = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СпискиЗначенийИдентичны(Список1, Список2, СравниватьКоличествоЗначений); +``` +
+ +## ЗначениеВМассиве +
+ +Описание, пример вызова + +```bsl + +// Создает массив и помещает в него переданное значение. +// +// Параметры: +// Значение - Произвольный - любое значение. +// +// Возвращаемое значение: +// Массив из Произвольный - массив из одного элемента. +// +Функция ЗначениеВМассиве(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЗначениеВМассиве(Значение) +``` +
+ +## КлючиСтруктурыВСтроку +
+ +Описание, пример вызова + +```bsl + +// Получает строку, содержащую ключи структуры, разделенные символом разделителя. +// +// Параметры: +// Структура - Структура - структура, ключи которой преобразуются в строку. +// Разделитель - Строка - разделитель, который вставляется в строку между ключами структуры. +// +// Возвращаемое значение: +// Строка - строка, содержащая ключи структуры разделенные разделителем. +// +Функция КлючиСтруктурыВСтроку(Структура, Разделитель = ",") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.КлючиСтруктурыВСтроку(Структура, Разделитель, ") +``` +
+ +## СвойствоСтруктуры +
+ +Описание, пример вызова + +```bsl + +// Возвращает значение свойства структуры. +// +// Параметры: +// Структура - Структура +// - ФиксированнаяСтруктура - объект, из которого необходимо прочитать значение ключа. +// Ключ - Строка - имя свойства структуры, для которого необходимо прочитать значение. +// ЗначениеПоУмолчанию - Произвольный - возвращается когда в структуре нет значения по указанному +// ключу. +// Для скорости рекомендуется передавать только быстро вычисляемые значения (например примитивные типы), +// а инициализацию более тяжелых значений выполнять после проверки полученного значения (только если это +// требуется). +// +// Возвращаемое значение: +// Произвольный - значение свойства структуры. ЗначениеПоУмолчанию если в структуре нет указанного свойства. +// +Функция СвойствоСтруктуры(Структура, Ключ, ЗначениеПоУмолчанию = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СвойствоСтруктуры(Структура, Ключ, ЗначениеПоУмолчанию); +``` +
+ +## ПустойУникальныйИдентификатор +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустой уникальный идентификатор. +// +// Возвращаемое значение: +// УникальныйИдентификатор - 00000000-0000-0000-0000-000000000000 +// +Функция ПустойУникальныйИдентификатор() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПустойУникальныйИдентификатор() +``` +
+ +## ВерсияКонфигурацииБезНомераСборки +
+ +Описание, пример вызова + +```bsl + +// Получает номер версии конфигурации без номера сборки. +// +// Параметры: +// Версия - Строка - версия конфигурации в формате РР.ПП.ЗЗ.СС, +// где СС - номер сборки, который будет удален. +// +// Возвращаемое значение: +// Строка - номер версии конфигурации без номера сборки в формате РР.ПП.ЗЗ. +// +Функция ВерсияКонфигурацииБезНомераСборки(Знач Версия) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ВерсияКонфигурацииБезНомераСборки(Версия) +``` +
+ +## СравнитьВерсии +
+ +Описание, пример вызова + +```bsl + +// Сравнить две строки версий. +// +// Параметры: +// СтрокаВерсии1 - Строка - номер версии в формате РР.{П|ПП}.ЗЗ.СС. +// СтрокаВерсии2 - Строка - второй сравниваемый номер версии. +// +// Возвращаемое значение: +// Число - больше 0, если СтрокаВерсии1 > СтрокаВерсии2; 0, если версии равны. +// +Функция СравнитьВерсии(Знач СтрокаВерсии1, Знач СтрокаВерсии2) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СравнитьВерсии(СтрокаВерсии1, СтрокаВерсии2) +``` +
+ +## СравнитьВерсииБезНомераСборки +
+ +Описание, пример вызова + +```bsl + +// Сравнить две строки версий. +// +// Параметры: +// СтрокаВерсии1 - Строка - номер версии в формате РР.{П|ПП}.ЗЗ. +// СтрокаВерсии2 - Строка - второй сравниваемый номер версии. +// +// Возвращаемое значение: +// Число - больше 0, если СтрокаВерсии1 > СтрокаВерсии2; 0, если версии равны. +// +Функция СравнитьВерсииБезНомераСборки(Знач СтрокаВерсии1, Знач СтрокаВерсии2) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СравнитьВерсииБезНомераСборки(СтрокаВерсии1, СтрокаВерсии2) +``` +
+ +## ПолучитьРеквизитФормыПоПути +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции для работы с управляемыми формами. +// + +// Получает значение реквизита формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма. +// ПутьРеквизита - Строка - путь к данным реквизита формы, например: "Объект.МесяцНачисления". +// +// Возвращаемое значение: +// Произвольный - реквизит формы. +// +Функция ПолучитьРеквизитФормыПоПути(Форма, ПутьРеквизита) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПолучитьРеквизитФормыПоПути(Форма, ПутьРеквизита) +``` +
+ +## УстановитьРеквизитФормыПоПути +
+ +Описание, пример вызова + +```bsl + +// Устанавливает значение реквизиту формы. +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма-владелец реквизита. +// ПутьРеквизита - Строка - путь к данным, например: "Объект.МесяцНачисления". +// Значение - Произвольный - устанавливаемое значение. +// ТолькоЕслиНеЗаполнен - Булево - позволяет не устанавливать значение реквизита, +// если у него уже установлено какое-то значение. +// +Процедура УстановитьРеквизитФормыПоПути(Форма, ПутьРеквизита, Значение, ТолькоЕслиНеЗаполнен = Ложь) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УстановитьРеквизитФормыПоПути(Форма, ПутьРеквизита, Значение, ТолькоЕслиНеЗаполнен); +``` +
+ +## НайтиЭлементОтбораПоПредставлению +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск элемента отбора в коллекции по заданному представлению. +// +// Параметры: +// КоллекцияЭлементов - КоллекцияЭлементовОтбораКомпоновкиДанных - контейнер с элементами и группами отбора, +// например, Список.Отбор.Элементы или группа в отборе. +// Представление - Строка - представление группы. +// +// Возвращаемое значение: +// ЭлементОтбораКомпоновкиДанных - элемент отбора. +// +Функция НайтиЭлементОтбораПоПредставлению(КоллекцияЭлементов, Представление) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.НайтиЭлементОтбораПоПредставлению(КоллекцияЭлементов, Представление) +``` +
+ +## УстановитьСвойствоЭлементаФормы +
+ +Описание, пример вызова + +```bsl + +// Устанавливает свойство ИмяСвойства элемента формы с именем ИмяЭлемента в значение Значение. +// Применяется в тех случаях, когда элемента формы может не быть на форме из-за отсутствия прав у пользователя +// на объект, реквизит объекта или команду. +// +// Параметры: +// ЭлементыФормы - ВсеЭлементыФормы +// - ЭлементыФормы - коллекция элементов управляемой формы. +// ИмяЭлемента - Строка - имя элемента формы. +// ИмяСвойства - Строка - имя устанавливаемого свойства элемента формы. +// Значение - Произвольный - новое значение элемента. +// +Процедура УстановитьСвойствоЭлементаФормы(ЭлементыФормы, ИмяЭлемента, ИмяСвойства, Значение) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УстановитьСвойствоЭлементаФормы(ЭлементыФормы, ИмяЭлемента, ИмяСвойства, Значение) +``` +
+ +## ЗначениеСвойстваЭлементаФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает значение свойства ИмяСвойства элемента формы с именем ИмяЭлемента. +// Применяется в тех случаях, когда элемент формы может не быть на форме из-за отсутствия прав у пользователя +// на объект, реквизит объекта или команду. +// +// Параметры: +// ЭлементыФормы - ВсеЭлементыФормы +// - ЭлементыФормы - коллекция элементов управляемой формы. +// ИмяЭлемента - Строка - имя элемента формы. +// ИмяСвойства - Строка - имя свойства элемента формы. +// +// Возвращаемое значение: +// Произвольный - значение свойства ИмяСвойства элемента формы ИмяЭлемента. +// +Функция ЗначениеСвойстваЭлементаФормы(ЭлементыФормы, ИмяЭлемента, ИмяСвойства) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЗначениеСвойстваЭлементаФормы(ЭлементыФормы, ИмяЭлемента, ИмяСвойства) +``` +
+ +## КартинкаКомментария +
+ +Описание, пример вызова + +```bsl + +// Получает картинку для вывода на странице с комментарием в зависимости +// от наличия текста в комментарии. +// +// Параметры: +// Комментарий - Строка - текст комментария. +// +// Возвращаемое значение: +// Картинка - картинка, которая должна отображаться на странице с комментарием. +// +Функция КартинкаКомментария(Комментарий) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.КартинкаКомментария(Комментарий) +``` +
+ +## НайтиЭлементыИГруппыОтбора +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции для работы с отборами и параметрами динамических списков. +// + +// Найти элемент или группу отбора по заданному имени поля или представлению. +// +// Параметры: +// ОбластьПоиска - ОтборКомпоновкиДанных +// - ГруппаЭлементовОтбораКомпоновкиДанных - контейнер с элементами и группами отбора, +// например Список.Отбор или группа в отборе. +// ИмяПоля - Строка - имя поля компоновки (не используется для групп). +// Представление - Строка - представление поля компоновки. +// +// Возвращаемое значение: +// Массив - коллекция отборов. +// +Функция НайтиЭлементыИГруппыОтбора(Знач ОбластьПоиска, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.НайтиЭлементыИГруппыОтбора(ОбластьПоиска, ); +``` +
+ +## СоздатьГруппуЭлементовОтбора +
+ +Описание, пример вызова + +```bsl + +// Добавить группу отбора в коллекцию КоллекцияЭлементов. +// +// Параметры: +// КоллекцияЭлементов - ОтборКомпоновкиДанных +// - ГруппаЭлементовОтбораКомпоновкиДанных - контейнер с элементами и группами отбора, +// например Список.Отбор или группа в отборе. +// Представление - Строка - представление группы. +// ТипГруппы - ТипГруппыЭлементовОтбораКомпоновкиДанных - тип группы. +// +// Возвращаемое значение: +// ГруппаЭлементовОтбораКомпоновкиДанных - группа отбора. +// +Функция СоздатьГруппуЭлементовОтбора(Знач КоллекцияЭлементов, Представление, ТипГруппы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СоздатьГруппуЭлементовОтбора(КоллекцияЭлементов, Представление, ТипГруппы) +``` +
+ +## ДобавитьЭлементКомпоновки +
+ +Описание, пример вызова + +```bsl + +// Добавить элемент компоновки в контейнер элементов компоновки. +// +// Параметры: +// ОбластьДобавления - ОтборКомпоновкиДанных +// - ГруппаЭлементовОтбораКомпоновкиДанных - контейнер с элементами и группами отбора, +// например, Список.Отбор или группа в отборе. +// ИмяПоля - Строка - имя поля компоновки данных (заполняется всегда). +// ВидСравнения - ВидСравненияКомпоновкиДанных - вид сравнения. +// ПравоеЗначение - Произвольный - сравниваемое значение. +// Представление - Строка - представление элемента компоновки данных. +// Использование - Булево - использование элемента. +// РежимОтображения - РежимОтображенияЭлементаНастройкиКомпоновкиДанных - режим отображения. +// ИдентификаторПользовательскойНастройки - Строка - см. ОтборКомпоновкиДанных.ИдентификаторПользовательскойНастройки +// в синтакс-помощнике. +// Возвращаемое значение: +// ЭлементОтбораКомпоновкиДанных - элемент компоновки. +// +Функция ДобавитьЭлементКомпоновки(ОбластьДобавления, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ДобавитьЭлементКомпоновки(ОбластьДобавления, ); +``` +
+ +## ИзменитьЭлементыОтбора +
+ +Описание, пример вызова + +```bsl + +// Изменить элемент отбора с заданным именем поля или представлением. +// +// Параметры: +// ОбластьПоиска - ОтборКомпоновкиДанных +// - ГруппаЭлементовОтбораКомпоновкиДанных - контейнер с элементами и группами отбора, +// например Список.Отбор или группа в отборе. +// ИмяПоля - Строка - имя поля компоновки данных (заполняется всегда). +// Представление - Строка - представление элемента компоновки данных. +// ПравоеЗначение - Произвольный - сравниваемое значение. +// ВидСравнения - ВидСравненияКомпоновкиДанных - вид сравнения. +// Использование - Булево - использование элемента. +// РежимОтображения - РежимОтображенияЭлементаНастройкиКомпоновкиДанных - режим отображения. +// ИдентификаторПользовательскойНастройки - Строка - см. ОтборКомпоновкиДанных.ИдентификаторПользовательскойНастройки +// в синтакс-помощнике. +// +// Возвращаемое значение: +// Число - количество измененных элементов. +// +Функция ИзменитьЭлементыОтбора(ОбластьПоиска, Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ИзменитьЭлементыОтбора(ОбластьПоиска, ); +``` +
+ +## УдалитьЭлементыГруппыОтбора +
+ +Описание, пример вызова + +```bsl + +// Удалить элементы отбора с заданным именем поля или представлением. +// +// Параметры: +// ОбластьУдаления - КоллекцияЭлементовОтбораКомпоновкиДанных - контейнер с элементами и группами отбора, +// например, Список.Отбор или группа в отборе.. +// ИмяПоля - Строка - имя поля компоновки (не используется для групп). +// Представление - Строка - представление поля компоновки. +// +Процедура УдалитьЭлементыГруппыОтбора(Знач ОбластьУдаления, Знач ИмяПоля = Неопределено, Знач Представление = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УдалитьЭлементыГруппыОтбора(ОбластьУдаления, ИмяПоля, Представление); +``` +
+ +## УстановитьЭлементОтбора +
+ +Описание, пример вызова + +```bsl + +// Добавить или заменить существующий элемент отбора. +// +// Параметры: +// ОбластьПоискаДобавления - ОтборКомпоновкиДанных +// - ГруппаЭлементовОтбораКомпоновкиДанных - контейнер с элементами и группами отбора, +// например, Список.Отбор или группа в отборе. +// ИмяПоля - Строка - имя поля компоновки данных (заполняется всегда). +// ПравоеЗначение - Произвольный - сравниваемое значение. +// ВидСравнения - ВидСравненияКомпоновкиДанных - вид сравнения. +// Представление - Строка - представление элемента компоновки данных. +// Использование - Булево - использование элемента. +// РежимОтображения - РежимОтображенияЭлементаНастройкиКомпоновкиДанных - режим отображения. +// ИдентификаторПользовательскойНастройки - Строка - см. ОтборКомпоновкиДанных.ИдентификаторПользовательскойНастройки +// в синтакс-помощнике. +// +Процедура УстановитьЭлементОтбора(ОбластьПоискаДобавления, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УстановитьЭлементОтбора(ОбластьПоискаДобавления, ); +``` +
+ +## УстановитьЭлементОтбораДинамическогоСписка +
+ +Описание, пример вызова + +```bsl + +// Добавить или заменить существующий элемент отбора динамического списка. +// +// Параметры: +// ДинамическийСписок - ДинамическийСписок - список, в котором требуется установить отбор. +// ИмяПоля - Строка - поле, по которому необходимо установить отбор. +// ПравоеЗначение - Произвольный - значение отбора. +// Необязательный. Значение по умолчанию Неопределено. +// Внимание! Если передать Неопределено, то значение не будет изменено. +// ВидСравнения - ВидСравненияКомпоновкиДанных - условие отбора. +// Представление - Строка - представление элемента компоновки данных. +// Необязательный. Значение по умолчанию Неопределено. +// Если указано, то выводится только флажок использования с указанным представлением (значение не выводится). +// Для очистки (чтобы значение снова выводилось) следует передать пустую строку. +// Использование - Булево - флажок использования этого отбора. +// Необязательный. Значение по умолчанию: Неопределено. +// РежимОтображения - РежимОтображенияЭлементаНастройкиКомпоновкиДанных - способ отображения этого отбора +// пользователю: +// РежимОтображенияЭлементаНастройкиКомпоновкиДанных.БыстрыйДоступ - в группе быстрых настроек над списком. +// РежимОтображенияЭлементаНастройкиКомпоновкиДанных.Обычный - в настройка списка (в подменю Еще). +// РежимОтображенияЭлементаНастройкиКомпоновкиДанных.Недоступный - запретить пользователю менять этот отбор. +// ИдентификаторПользовательскойНастройки - Строка - уникальный идентификатор этого отбора. +// Используется для связи с пользовательскими настройками. +// +Процедура УстановитьЭлементОтбораДинамическогоСписка(ДинамическийСписок, ИмяПоля, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УстановитьЭлементОтбораДинамическогоСписка(ДинамическийСписок, ИмяПоля, ); +``` +
+ +## УдалитьЭлементыГруппыОтбораДинамическогоСписка +
+ +Описание, пример вызова + +```bsl + +// Удалить элемент группы отбора динамического списка. +// +// Параметры: +// ДинамическийСписок - ДинамическийСписок - реквизит формы, для которого требуется установить отбор. +// ИмяПоля - Строка - имя поля компоновки (не используется для групп). +// Представление - Строка - представление поля компоновки. +// +Процедура УдалитьЭлементыГруппыОтбораДинамическогоСписка(ДинамическийСписок, ИмяПоля = Неопределено, Представление = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УдалитьЭлементыГруппыОтбораДинамическогоСписка(ДинамическийСписок, ИмяПоля, Представление); +``` +
+ +## УстановитьПараметрДинамическогоСписка +
+ +Описание, пример вызова + +```bsl + +// Установить или обновить значение параметра ИмяПараметра динамического списка Список. +// +// Параметры: +// Список - ДинамическийСписок - реквизит формы, для которого требуется установить параметр. +// ИмяПараметра - Строка - имя параметра динамического списка. +// Значение - Произвольный - новое значение параметра. +// Использование - Булево - признак использования параметра. +// +Процедура УстановитьПараметрДинамическогоСписка(Список, ИмяПараметра, Значение, Использование = Истина) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УстановитьПараметрДинамическогоСписка(Список, ИмяПараметра, Значение, Использование); +``` +
+ +## ДобавитьКонечныйРазделительПути +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции для работы с файлами. +// + +// Добавляет к переданному пути каталога конечный символ-разделитель, если он отсутствует. +// +// Параметры: +// ПутьКаталога - Строка - путь к каталогу. +// УдалитьПлатформа - ТипПлатформы - параметр устарел, больше не используется. +// +// Возвращаемое значение: +// Строка +// +// Пример: +// Результат = ДобавитьКонечныйРазделительПути("C:\Мой каталог"); // возвращает "C:\Мой каталог\". +// Результат = ДобавитьКонечныйРазделительПути("C:\Мой каталог\"); // возвращает "C:\Мой каталог\". +// Результат = ДобавитьКонечныйРазделительПути("%APPDATA%"); // возвращает "%APPDATA%\". +// +Функция ДобавитьКонечныйРазделительПути(Знач ПутьКаталога, Знач УдалитьПлатформа = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ДобавитьКонечныйРазделительПути(ПутьКаталога, УдалитьПлатформа); +``` +
+ +## ПолучитьПолноеИмяФайла +
+ +Описание, пример вызова + +```bsl + +// Составляет полное имя файла из имени каталога и имени файла. +// +// Параметры: +// ИмяКаталога - Строка - путь к каталогу файла на компьютере (устройстве). +// ИмяФайла - Строка - имя файла, без имени каталога. +// +// Возвращаемое значение: +// Строка +// +Функция ПолучитьПолноеИмяФайла(Знач ИмяКаталога, Знач ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПолучитьПолноеИмяФайла(ИмяКаталога, ИмяФайла) +``` +
+ +## РазложитьПолноеИмяФайла +
+ +Описание, пример вызова + +```bsl + +// Раскладывает полное имя файла на составляющие. +// +// Параметры: +// ПолноеИмяФайла - Строка - полный путь к файлу или каталогу. +// ЭтоКаталог - Булево - признак того, что передано имя каталога. +// +// Возвращаемое значение: +// Структура - имя файла, разложенное на составные части (аналогично свойствам объекта Файл): +// ПолноеИмя - Строка - полный путь к файлу, т.е. полностью соответствует входному параметру ПолноеИмяФайла. +// Путь -Строка - путь к каталогу, в котором находится файл. +// Имя - Строка - имя файла с расширением, без пути к файлу. +// Расширение - Строка - расширение файла с точкой вначале. +// ИмяБезРасширения - Строка - имя файла без расширения и без пути к файлу. +// +// Пример: +// ПолноеИмяФайла = "c:\temp\test.txt"; +// ЧастиИмениФайла = РазложитьПолноеИмяФайла(ПолноеИмяФайла); +// +// В результате структура полей будет заполнена следующим образом: +// ПолноеИмя: "c:\temp\test.txt", +// Путь: "c:\temp\", +// Имя: "test.txt", +// Расширение: ".txt", +// ИмяБезРасширения: "test". +// +Функция РазложитьПолноеИмяФайла(Знач ПолноеИмяФайла, ЭтоКаталог = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.РазложитьПолноеИмяФайла(ПолноеИмяФайла, ЭтоКаталог); +``` +
+ +## РазложитьСтрокуПоТочкамИСлэшам +
+ +Описание, пример вызова + +```bsl + +// Раскладывает строку в массив строк, используя "./\" как разделитель. +// +// Параметры: +// Строка - Строка - исходная строка. +// +// Возвращаемое значение: +// Массив из Строка +// +Функция РазложитьСтрокуПоТочкамИСлэшам(Знач Строка) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.РазложитьСтрокуПоТочкамИСлэшам(Строка) +``` +
+ +## ПолучитьРасширениеИмениФайла +
+ +Описание, пример вызова + +```bsl + +// Выделяет из имени файла его расширение (набор символов после последней точки). +// +// Параметры: +// ИмяФайла - Строка - имя файла с именем каталога или без. +// +// Возвращаемое значение: +// Строка +// +Функция ПолучитьРасширениеИмениФайла(Знач ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПолучитьРасширениеИмениФайла(ИмяФайла) +``` +
+ +## РасширениеБезТочки +
+ +Описание, пример вызова + +```bsl + +// Преобразует расширение файла в нижний регистр без точки. +// +// Параметры: +// Расширение - Строка - расширение для преобразования. +// +// Возвращаемое значение: +// Строка +// +Функция РасширениеБезТочки(Знач Расширение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.РасширениеБезТочки(Расширение) +``` +
+ +## ПолучитьИмяСРасширением +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя файла с расширением. +// Если расширение пустое, тогда точка не добавляется. +// +// Параметры: +// ИмяБезРасширения - Строка - имя файла без расширения. +// Расширение - Строка - расширение. +// +// Возвращаемое значение: +// Строка +// +Функция ПолучитьИмяСРасширением(ИмяБезРасширения, Расширение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПолучитьИмяСРасширением(ИмяБезРасширения, Расширение) +``` +
+ +## ПолучитьНедопустимыеСимволыВИмениФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает строку недопустимых символов в имени файла +// согласно HTTP://en.wikipedia.org/wiki/Filename - в разделе "Reserved characters and words". +// +// Возвращаемое значение: +// Строка +// +Функция ПолучитьНедопустимыеСимволыВИмениФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПолучитьНедопустимыеСимволыВИмениФайла() +``` +
+ +## НайтиНедопустимыеСимволыВИмениФайла +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие недопустимых символов в имени файла. +// +// Параметры: +// ИмяФайла - Строка - имя файла. +// +// Возвращаемое значение: +// Массив из Строка - обнаруженные в имени файла недопустимые символы. +// Если недопустимых символов не обнаружено, то массив пустой. +// +Функция НайтиНедопустимыеСимволыВИмениФайла(ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.НайтиНедопустимыеСимволыВИмениФайла(ИмяФайла) +``` +
+ +## ЗаменитьНедопустимыеСимволыВИмениФайла +
+ +Описание, пример вызова + +```bsl + +// Заменяет недопустимые символы в имени файла. +// +// Параметры: +// ИмяФайла - Строка - исходное имя файла. +// НаЧтоМенять - Строка - строка, на которую необходимо заменить недопустимые символы. +// +// Возвращаемое значение: +// Строка +// +Функция ЗаменитьНедопустимыеСимволыВИмениФайла(Знач ИмяФайла, НаЧтоМенять = " ") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЗаменитьНедопустимыеСимволыВИмениФайла(ИмяФайла, НаЧтоМенять); +``` +
+ +## АдресаЭлектроннойПочтыИзСтроки +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции для работы с почтовыми адресами. +// + +// Разбирает строку с адресами электронной почты. При разборе проверяет корректность адресов. +// +// Параметры: +// СписокАдресов - Строка - адреса электронной почты, разделитель - запятая, либо точка с запятой: +// Получатель1 <Адрес1>, Получатель 2 <Адрес2>,... +// +// Возвращаемое значение: +// Массив из Структура: +// * Псевдоним - Строка - представление адресата. +// * Адрес - Строка - найденный и соответствующий требованиям почтовый адрес. +// Если текст, похожий на адрес найден, но не соответствует требованиям +// стандартов, то такой текст записывается в поле "Псевдоним". +// * ОписаниеОшибки - Строка - текстовое представление ошибки, либо пустая строка, если ошибок нет. +// +Функция АдресаЭлектроннойПочтыИзСтроки(Знач СписокАдресов) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.АдресаЭлектроннойПочтыИзСтроки(СписокАдресов) +``` +
+ +## АдресЭлектроннойПочтыСоответствуетТребованиям +
+ +Описание, пример вызова + +```bsl + +// Проверяет email-адрес на соответствие требованиям стандартов RFC 5321, RFC 5322, +// а также RFC 5335, RFC 5336 и RFC 3696. +// Кроме того, функция ограничивает использование спецсимволов. +// +// Параметры: +// Адрес - Строка - проверяемый email. +// РазрешитьЛокальныеАдреса - Булево - не выдавать ошибку в случае отсутствия зоны домена в адресе. +// +// Возвращаемое значение: +// Булево - Истина, если ошибок нет. +// +Функция АдресЭлектроннойПочтыСоответствуетТребованиям(Знач Адрес, РазрешитьЛокальныеАдреса = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.АдресЭлектроннойПочтыСоответствуетТребованиям(Адрес, РазрешитьЛокальныеАдреса); +``` +
+ +## РазобратьСтрокуСПочтовымиАдресами +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что введенная строка с email-адресами введена правильно. +// +// Формат строки: +// Z = ИмяПользователя|[Имя Пользователя] [<]пользователь@почтовый_сервер[>], Строка = Z[<разделитель*>Z]. +// +// Прим.: разделитель* - имеется ввиду любой разделитель адресов. +// +// Параметры: +// Адреса - Строка - правильная строка с почтовыми адресами. +// ВызыватьИсключение - Булево - передать Ложь, чтобы в случае неуспешного разбора не выдавалось исключение. +// +// Возвращаемое значение: +// Массив из Структура: +// * Адрес - Строка - e-mail получателя. +// * Представление - Строка - имя получателя. +// +Функция РазобратьСтрокуСПочтовымиАдресами(Знач Адреса, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.РазобратьСтрокуСПочтовымиАдресами(Адреса, ВызыватьИсключение); +``` +
+ +## ИмяCOMСоединителя +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для работы с внешним соединением. + +// Возвращает имя COM-класса для работы с 1С:Предприятием 8 через COM-соединение. +// +// Возвращаемое значение: +// Строка +// +Функция ИмяCOMСоединителя() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ИмяCOMСоединителя() +``` +
+ +## СтруктураПараметровДляУстановкиВнешнегоСоединения +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра Параметры функций ОбщегоНазначения.УстановитьВнешнееСоединениеСБазой +// и ОбщегоНазначенияКлиент.УстановитьВнешнееСоединениеСБазой. +// +// Возвращаемое значение: +// Структура: +// * ВариантРаботыИнформационнойБазы - Число - 0, если файловый вариант работы. +// * КаталогИнформационнойБазы - Строка - полный путь каталога информационной базы (для файловой ИБ). +// * ИмяСервера1СПредприятия - Строка - имя сервера (для клиент-серверной ИБ) +// * ИмяИнформационнойБазыНаСервере1СПредприятия - Строка - имя базы на сервере (для клиент-серверной ИБ) +// * АутентификацияОперационнойСистемы - Булево - указать Истина, если аутентификация операционной системы. +// Если Ложь, то нужно указать свойства ИмяПользователя и ПарольПользователя. +// * ИмяПользователя - Строка - имя пользователя для подключения к ИБ. +// * ПарольПользователя - Строка - пароль пользователя для подключения к ИБ. +// +Функция СтруктураПараметровДляУстановкиВнешнегоСоединения() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СтруктураПараметровДляУстановкиВнешнегоСоединения() +``` +
+ +## ПолучитьПараметрыПодключенияИзСтрокиСоединенияИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Извлекает из строки соединения с информационной базой параметры подключения +// и передает параметры в структуру для установки внешнего соединения. +// +// Параметры: +// СтрокаСоединения - Строка - строка соединения ИБ. +// +// Возвращаемое значение: +// см. СтруктураПараметровДляУстановкиВнешнегоСоединения +// +Функция ПолучитьПараметрыПодключенияИзСтрокиСоединенияИнформационнойБазы(Знач СтрокаСоединения) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПолучитьПараметрыПодключенияИзСтрокиСоединенияИнформационнойБазы(СтрокаСоединения) +``` +
+ +## РаспределитьСуммуПропорциональноКоэффициентам +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Математические процедуры и функции. + +// Выполняет пропорциональное распределение суммы в соответствии +// с заданными коэффициентами распределения. +// +// Параметры: +// РаспределяемаяСумма - Число - сумма, которую надо распределить, если сумма равна 0 - то возвращается Неопределено; +// Если передана отрицательная - расчет по модулю и после инверсия знаков результата. +// Коэффициенты - Массив - коэффициенты распределения, должны быть положительны или отрицательными одновременно +// Точность - Число - точность округления при распределении. Необязателен. +// +// Возвращаемое значение: +// Массив - массив размерностью равный массиву коэффициентов, содержит +// суммы в соответствии с весом коэффициента (из массива коэффициентов). +// В случае, если распределить невозможно (кол-во коэффициентов = 0 +// есть коэффициенты с отрицательным значением или суммарный вес коэффициентов = 0), +// тогда будет возвращено Неопределено. +// +// Пример: +// +// Коэффициенты = Новый Массив; +// Коэффициенты.Добавить(1); +// Коэффициенты.Добавить(2); +// Результат = ОбщегоНазначенияКлиентСервер.РаспределитьСуммуПропорциональноКоэффициентам(1, Коэффициенты); +// // Результат = [0.33, 0.67] +// +Функция РаспределитьСуммуПропорциональноКоэффициентам(Знач РаспределяемаяСумма, Знач Коэффициенты, Знач Точность = 2) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.РаспределитьСуммуПропорциональноКоэффициентам(РаспределяемаяСумма, Коэффициенты, Точность); +``` +
+ +## ЗаменитьНедопустимыеСимволыXML +
+ +Описание, пример вызова + +```bsl + +// Заменяет недопустимые символы в XML-строке на заданные символы. +// +// Параметры: +// Текст - Строка - строка, в которой требуется выполнить замену недопустимых символов. +// СимволЗамены - Строка - строка, на которую требуется выполнить замену недопустимого символа в XML-строке. +// +// Возвращаемое значение: +// Строка +// +Функция ЗаменитьНедопустимыеСимволыXML(Знач Текст, СимволЗамены = " ") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЗаменитьНедопустимыеСимволыXML(Текст, СимволЗамены); +``` +
+ +## УдалитьНедопустимыеСимволыXML +
+ +Описание, пример вызова + +```bsl + +// Удаляет недопустимые символы в XML-строке. +// +// Параметры: +// Текст - Строка - строка, в которой требуется удалить недопустимые символы. +// +// Возвращаемое значение: +// Строка +// +Функция УдалитьНедопустимыеСимволыXML(Знач Текст) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.УдалитьНедопустимыеСимволыXML(Текст) +``` +
+ +## УстановитьСостояниеПоляТабличногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Управляет состоянием поля табличного документа. +// +// Параметры: +// ПолеТабличногоДокумента - ПолеФормы - поле формы с видом ПолеТабличногоДокумента, +// для которого необходимо установить состояние. +// Состояние - Строка - вид состояния: "НеИспользовать", "Неактуальность", "ФормированиеОтчета". +// +Процедура УстановитьСостояниеПоляТабличногоДокумента(ПолеТабличногоДокумента, Состояние = "НеИспользовать") Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.УстановитьСостояниеПоляТабличногоДокумента(ПолеТабличногоДокумента, Состояние); +``` +
+ +## РасчетныеПоказателиЯчеек +
+ +Описание, пример вызова + +```bsl + +// Рассчитывает показатели числовых ячеек в табличном документе. +// +// Параметры: +// ТабличныйДокумент - ТабличныйДокумент - документ, числовые показатели которого рассчитываются. +// ПолеТабличногоДокумента - ПолеФормы +// - ПолеТабличногоДокумента - элемент формы, +// данными которого является параметр ТабличныйДокумент. +// ПараметрыРасчета - Неопределено +// - см. ПараметрыРасчетаПоказателейЯчеек +// +// Возвращаемое значение: +// Структура: +// * Количество - Число - количество выделенных ячеек. +// * КоличествоЧисловых - Число - количество числовых ячеек. +// * Сумма - Число - сумма выделенных ячеек с числами. +// * Среднее - Число - сумма выделенных ячеек с числами. +// * Минимум - Число - сумма выделенных ячеек с числами. +// * Максимум - Число - максимум выделенных ячеек с числами. +// +Функция РасчетныеПоказателиЯчеек(Знач ТабличныйДокумент, Знач ПолеТабличногоДокумента, ПараметрыРасчета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.РасчетныеПоказателиЯчеек(ТабличныйДокумент, ПолеТабличногоДокумента, ПараметрыРасчета); +``` +
+ +## ПараметрыРасчетаПоказателейЯчеек +
+ +Описание, пример вызова + +```bsl + +// Формирует описание выделенных областей табличного документа. +// +// Параметры: +// ПолеТабличногоДокумента - ПолеФормы +// - ПолеТабличногоДокумента - Документ +// значения ячеек которого участвуют в расчете. +// +// Возвращаемое значение: +// Структура: +// * ВыделенныеОбласти - Массив - содержит структуры со свойствами: +// * Верх - Число - номер строки верхней границы области. +// * Низ - Число - номер строки нижней границы области. +// * Лево - Число - номер колонки верхней границы области. +// * Право - Число - номер колонки нижней границы области. +// * ТипОбласти - ТипОбластиЯчеекТабличногоДокумента - Колонки, Прямоугольник, Строки, Таблица. +// * РассчитатьНаСервере - Булево - признак того, что расчет должен выполняться на сервере, если +// количество выбранных ячеек более или равно 1000, +// либо количество выделенных областей более или равно 100, +// либо выделено поле табличного документа целиком. +// В таких случаях расчет показателей на клиенте очень затратный. +// +Функция ПараметрыРасчетаПоказателейЯчеек(ПолеТабличногоДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПараметрыРасчетаПоказателейЯчеек(ПолеТабличногоДокумента) +``` +
+ +## РасписаниеВСтруктуру +
+ +Описание, пример вызова + +```bsl + +// Преобразует РасписаниеРегламентногоЗадания в структуру. +// +// Параметры: +// Расписание - РасписаниеРегламентногоЗадания - исходное расписание. +// +// Возвращаемое значение: +// Структура: +// * ВремяЗавершения - Дата +// * ВремяКонца - Дата +// * ВремяНачала - Дата +// * ДатаКонца - Дата +// * ДатаНачала - Дата +// * ДеньВМесяце - Дата +// * ДеньНеделиВМесяце - Число +// * ДниНедели - Число +// * ИнтервалЗавершения - Число +// * Месяцы - Массив из Число +// * ПаузаПовтора - Число +// * ПериодНедель - Число +// * ПериодПовтораВТечениеДня - Число +// * ПериодПовтораДней - Число +// * ДетальныеРасписанияДня - Массив из см. РасписаниеВСтруктуру +// +Функция РасписаниеВСтруктуру(Знач Расписание) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.РасписаниеВСтруктуру(Расписание) +``` +
+ +## СтруктураВРасписание +
+ +Описание, пример вызова + +```bsl + +// Преобразует структуру в РасписаниеРегламентногоЗадания. +// +// Параметры: +// СтруктураРасписания - Структура - расписание в виде структуры. +// +// Возвращаемое значение: +// РасписаниеРегламентногоЗадания - расписание. +// +Функция СтруктураВРасписание(Знач СтруктураРасписания) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СтруктураВРасписание(СтруктураРасписания) +``` +
+ +## РасписанияОдинаковые +
+ +Описание, пример вызова + +```bsl + +// Сравнивает два расписания между собой. +// +// Параметры: +// Расписание1 - РасписаниеРегламентногоЗадания - первое расписание. +// Расписание2 - РасписаниеРегламентногоЗадания - второе расписание. +// +// Возвращаемое значение: +// Булево - Истина, если одинаковые. +// +Функция РасписанияОдинаковые(Знач Расписание1, Знач Расписание2) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.РасписанияОдинаковые(Расписание1, Расписание2) +``` +
+ +## СтруктураURI +
+ +Описание, пример вызова + +```bsl + +// Разбирает строку URI на составные части и возвращает в виде структуры. +// На основе RFC 3986. +// +// Параметры: +// СтрокаURI - Строка - ссылка на ресурс в формате: +// <схема>://<логин>:<пароль>@<хост>:<порт>/<путь>?<параметры>#<якорь>. +// +// Возвращаемое значение: +// Структура - составные части URI согласно формату: +// * Схема - Строка - схема из URI. +// * Логин - Строка - логин из URI. +// * Пароль - Строка - пароль из URI. +// * ИмяСервера - Строка - часть <хост>:<порт> из URI. +// * Хост - Строка - хост из URI. +// * Порт - Строка - порт из URI. +// * ПутьНаСервере - Строка - часть <путь>?<параметры>#<якорь> из URI. +// +Функция СтруктураURI(Знач СтрокаURI) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СтруктураURI(СтрокаURI) +``` +
+ +## НовоеЗащищенноеСоединение +
+ +Описание, пример вызова + +```bsl + +// Создает объект описания защищенного соединения OpenSSL или КриптоПро. +// В веб-клиенте безопасность соединения OpenSSL не обеспечивается, соединение КриптоПро не поддерживается. +// См. также описание объектов ЗащищенноеСоединениеOpenSSL и ЗащищенноеСоединениеКриптоПро в синтаксис-помощнике. +// +// Параметры: +// СертификатКлиента - СертификатКлиентаФайл +// - СертификатКлиентаWindows +// - Неопределено - клиентский сертификат OpenSSL. +// СертификатыУдостоверяющихЦентров - СертификатыУдостоверяющихЦентровФайл +// - СертификатыУдостоверяющихЦентровWindows +// - СертификатыУдостоверяющихЦентровLinux +// - СертификатыУдостоверяющихЦентровОС +// - Неопределено - сертификаты удостоверяющих центров OpenSSL. +// ВидСоединения - Строка, Неопределено - "OpenSSL" (по умолчанию), "КриптоПро" +// +// Возвращаемое значение: +// ЗащищенноеСоединениеOpenSSL, +// ЗащищенноеСоединениеКриптоПро +// +Функция НовоеЗащищенноеСоединение(Знач СертификатКлиента = Неопределено, Знач СертификатыУдостоверяющихЦентров = Неопределено, Знач ВидСоединения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.НовоеЗащищенноеСоединение(СертификатКлиента, СертификатыУдостоверяющихЦентров, ВидСоединения); +``` +
+ +## ТипУстройства +
+ +Описание, пример вызова + +```bsl + +// Возвращает строковое представление типа используемого устройства. +// +// Возвращаемое значение: +// Строка - тип используемого устройства. +// +Функция ТипУстройства() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ТипУстройства() +``` +
+ +## ПараметрыЭкранаУстройства +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры экрана используемого устройства. +// +// Возвращаемое значение: +// Структура: +// * Ширина - Число - ширина экрана в пикселях. +// * Высота - Число - высота экрана в пикселях. +// * DPI - Число - плотность пикселей экрана. +// * Портрет - Булево - если экран в портретной ориентации, тогда Истина, иначе - Ложь. +// +Функция ПараметрыЭкранаУстройства() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПараметрыЭкранаУстройства() +``` +
+ +## ЭтоЧисло +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, что переданное значение является, либо не является, числом. +// +// Параметры: +// ПроверяемоеЗначение - Строка - значение, которое проверяется на соответствие числу. +// +// Возвращаемое значение: +// Булево - признак того, что переданное значение является, либо не является, числом. +// +Функция ЭтоЧисло(Знач ПроверяемоеЗначение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЭтоЧисло(ПроверяемоеЗначение) +``` +
+ +## СтрокаВДату +
+ +Описание, пример вызова + +```bsl + +// Приводит строковое значение к дате. +// +// Параметры: +// Значение - Строка - строковое значение, которое приводится к дате. +// +// Возвращаемое значение: +// Дата - приведенное значение. +// +Функция СтрокаВДату(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СтрокаВДату(Значение) +``` +
+ +## ДатаHTTP +
+ +Описание, пример вызова + +```bsl + +// Преобразует универсальную дату в дату формата rfc1123-date. +// См. https://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html, п. 3.3.1. +// +// Параметры: +// Дата - Дата +// +// Возвращаемое значение: +// Строка +// +// Пример: +// ДатаHTTP(Дата(2021,12,9,9,14,58)) = "Thu, 09 Dec 2021 09:14:58 GMT". +// +Функция ДатаHTTP(Знач Дата) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ДатаHTTP(Дата) +``` +
+ +## ДатаRFC1123 +
+ +Описание, пример вызова + +```bsl + +// Возвращает дату, преобразованную из формата rfc1123-date в тип Дата. +// См. https://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html, п. 3.3.1. +// +// Параметры: +// ДатаСтрокойHTTP - Строка +// +// Возвращаемое значение: +// Дата +// +// Пример: +// ДатаRFC1123("Thu, 09 Dec 2021 09:14:58 GMT") = Дата(2021,12,9,9,14,58). +// +Функция ДатаRFC1123(ДатаСтрокойHTTP) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ДатаRFC1123(ДатаСтрокойHTTP) +``` +
+ +## СнятьУсловноеОформлениеСпискаЗначений +
+ +Описание, пример вызова + +```bsl + +// Снимает один элемент условного оформления, если это список значений. +// +// Параметры: +// УсловноеОформление - УсловноеОформлениеКомпоновкиДанных - условное оформление элемента формы; +// ИдентификаторПользовательскойНастройки - Строка - идентификатор настройки; +// Значение - Произвольный - значение, которое требуется удалить из списка оформления. +// +Процедура СнятьУсловноеОформлениеСпискаЗначений(УсловноеОформление, Знач ИдентификаторПользовательскойНастройки, Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.СнятьУсловноеОформлениеСпискаЗначений(УсловноеОформление, ИдентификаторПользовательскойНастройки, ); +``` +
+ +## ОтмеченныеЭлементы +
+ +Описание, пример вызова + +```bsl + +// Получает массив значений из отмеченных элементов списка значений. +// +// Параметры: +// Список - СписокЗначений - список значений из которого будет формироваться массив значений; +// +// Возвращаемое значение: +// Массив - массив значений из отмеченных элементов списка значений. +// +Функция ОтмеченныеЭлементы(Список) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ОтмеченныеЭлементы(Список) +``` +
+ +## ПолучитьИдентификаторСтрокиДереваПоЗначениюПоля +
+ +Описание, пример вызова + +```bsl + +// Получает идентификатор (метод ПолучитьИдентификатор()) строки дерева значений для заданного значения поля строки +// дерева. +// Используется для позиционирования курсора в иерархических списках. +// +// Параметры: +// ИмяПоля - Строка - имя колонки дерева значений, по которому выполняется поиск. +// ИдентификаторСтроки - Число - полученный в результате поиска идентификатор строки дерева значений. +// КоллекцияЭлементовДерева - ДанныеФормыКоллекцияЭлементовДерева - коллекция, в которой следует выполнять поиск. +// КлючСтроки - Произвольный - искомое значение поля. +// ПрекратитьПоиск - Булево - признак прекращения поиска. +// +Процедура ПолучитьИдентификаторСтрокиДереваПоЗначениюПоля(ИмяПоля, ИдентификаторСтроки, КоллекцияЭлементовДерева, КлючСтроки, ПрекратитьПоиск) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.ПолучитьИдентификаторСтрокиДереваПоЗначениюПоля(ИмяПоля, ИдентификаторСтроки, КоллекцияЭлементовДерева, КлючСтроки, ПрекратитьПоиск) +``` +
+ +## СократитьМассив +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиентСервер.РазностьМассивов +// Вычисляет разность массивов. Разностью массивов А и В является массив, содержащий +// все элементы массива А не существующие в массиве В. +// +// Параметры: +// Массив - Массив - массив элементов, из которого необходимо выполнить вычитание; +// МассивВычитания - Массив - массив элементов, который будет вычитаться. +// +// Возвращаемое значение: +// Массив - дополнение массива В до А. +// +Функция СократитьМассив(Массив, МассивВычитания) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СократитьМассив(Массив, МассивВычитания) +``` +
+ +## СообщитьПользователю +
+ +Описание, пример вызова + +```bsl + +// АПК:547-выкл устаревший программный интерфейс может вызывать устаревшие процедуры и функции. + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.СообщитьПользователю или ОбщегоНазначения.СообщитьПользователю +// Формирует и выводит сообщение, которое может быть связано с элементом +// управления формы. +// +// Параметры: +// ТекстСообщенияПользователю - Строка - текст сообщения. +// КлючДанных - ЛюбаяСсылка - объект или ключ записи информационной базы, к которому это сообщение относится. +// Поле - Строка - наименование реквизита формы. +// ПутьКДанным - Строка - путь к данным (путь к реквизиту формы). +// Отказ - Булево - выходной параметр, всегда устанавливается в значение Истина. +// +// Пример: +// +// 1. Для вывода сообщения у поля управляемой формы, связанного с реквизитом объекта: +// ОбщегоНазначенияКлиентСервер.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), , +// "ПолеВРеквизитеФормыОбъект", +// "Объект"); +// +// Альтернативный вариант использования в форме объекта: +// ОбщегоНазначенияКлиентСервер.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), , +// "Объект.ПолеВРеквизитеФормыОбъект"); +// +// 2. Для вывода сообщения рядом с полем управляемой формы, связанным с реквизитом формы: +// ОбщегоНазначенияКлиентСервер.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), , +// "ИмяРеквизитаФормы"); +// +// 3. Для вывода сообщения связанного с объектом информационной базы: +// ОбщегоНазначенияКлиентСервер.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), ОбъектИнформационнойБазы, "Ответственный",,Отказ); +// +// 4. Для вывода сообщения по ссылке на объект информационной базы: +// ОбщегоНазначенияКлиентСервер.СообщитьПользователю( +// НСтр("ru = 'Сообщение об ошибке.'"), Ссылка, , , Отказ); +// +// Случаи некорректного использования: +// 1. Передача одновременно параметров КлючДанных и ПутьКДанным. +// 2. Передача в параметре КлючДанных значения типа отличного от допустимых. +// 3. Установка ссылки без установки поля (и/или пути к данным). +// +Процедура СообщитьПользователю( Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.СообщитьПользователю(); +``` +
+ +## СкопироватьРекурсивно +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.СкопироватьРекурсивно или ОбщегоНазначения.СкопироватьРекурсивно +// Создает полную копию структуры, соответствия, массива, списка или таблицы значений, рекурсивно, +// с учетом типов дочерних элементов. При этом содержимое значений объектных типов +// (СправочникОбъект, ДокументОбъект и т.п.) не копируются, а возвращаются ссылки на исходный объект. +// +// Параметры: +// Источник - Структура +// - Соответствие +// - Массив +// - СписокЗначений +// - ТаблицаЗначений - объект, который необходимо +// скопировать. +// +// Возвращаемое значение: +// Структура, Соответствие, Массив, СписокЗначений, ТаблицаЗначений - копия объекта, переданного в параметре Источник. +// +Функция СкопироватьРекурсивно(Источник) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СкопироватьРекурсивно(Источник) +``` +
+ +## СкопироватьСтруктуру +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.СкопироватьРекурсивно или ОбщегоНазначения.СкопироватьРекурсивно +// Создает копию значения типа Структура, рекурсивно, с учетом типов значений свойств. +// Если свойства структуры содержат значения объектных типов (СправочникОбъект, ДокументОбъект и т.п.), +// то их содержимое не копируются, а возвращаются ссылки на исходный объект. +// +// Параметры: +// СтруктураИсточник - Структура - копируемая структура. +// +// Возвращаемое значение: +// Структура - копия исходной структуры. +// +Функция СкопироватьСтруктуру(СтруктураИсточник) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СкопироватьСтруктуру(СтруктураИсточник) +``` +
+ +## СкопироватьСоответствие +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.СкопироватьРекурсивно или ОбщегоНазначения.СкопироватьРекурсивно +// Создает копию значения типа Соответствие, рекурсивно, с учетом типов значений. +// Если значения соответствия содержат значения объектных типов (СправочникОбъект, ДокументОбъект и т.п.), +// то их содержимое не копируются, а возвращаются ссылки на исходный объект. +// +// Параметры: +// СоответствиеИсточник - Соответствие - соответствие, копию которого необходимо получить. +// +// Возвращаемое значение: +// Соответствие - копия исходного соответствия. +// +Функция СкопироватьСоответствие(СоответствиеИсточник) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СкопироватьСоответствие(СоответствиеИсточник) +``` +
+ +## СкопироватьМассив +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.СкопироватьРекурсивно или ОбщегоНазначения.СкопироватьРекурсивно +// Создает копию значения типа Массив, рекурсивно, с учетом типов значений элементов массива. +// Если элементы массива содержат значения объектных типов (СправочникОбъект, ДокументОбъект и т.п.), +// то их содержимое не копируются, а возвращаются ссылки на исходный объект. +// +// Параметры: +// МассивИсточник - Массив - массив, копию которого необходимо получить. +// +// Возвращаемое значение: +// Массив - копия исходного массива. +// +Функция СкопироватьМассив(МассивИсточник) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СкопироватьМассив(МассивИсточник) +``` +
+ +## СкопироватьСписокЗначений +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.СкопироватьРекурсивно или ОбщегоНазначения.СкопироватьРекурсивно +// Создает копию значения типа СписокЗначений, рекурсивно, с учетом типов его значений. +// Если в списке значений есть значения объектных типов (СправочникОбъект, ДокументОбъект и т.п.), +// то их содержимое не копируются, а возвращаются ссылки на исходный объект. +// +// Параметры: +// СписокИсточник - СписокЗначений - список значений, копию которого необходимо получить. +// +// Возвращаемое значение: +// СписокЗначений - копия исходного списка значений. +// +Функция СкопироватьСписокЗначений(СписокИсточник) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.СкопироватьСписокЗначений(СписокИсточник) +``` +
+ +## ЗаполнитьКоллекциюСвойств +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиентСервер.ДополнитьТаблицу +// Заполняет коллекцию-приемник значениями из коллекции-источник. +// В качестве коллекций источника и приемника могут выступать типы: +// ТаблицаЗначений; ДеревоЗначений; СписокЗначений и пр. +// +// Параметры: +// КоллекцияИсточник - см. ДополнитьТаблицу.ТаблицаИсточник +// КоллекцияПриемник - см. ДополнитьТаблицу.ТаблицаПриемник +// +Процедура ЗаполнитьКоллекциюСвойств(КоллекцияИсточник, КоллекцияПриемник) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияКлиентСервер.ЗаполнитьКоллекциюСвойств(КоллекцияИсточник, КоллекцияПриемник) +``` +
+ +## УстановитьВнешнееСоединение +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.УстановитьВнешнееСоединениеСБазой +// или ОбщегоНазначения.УстановитьВнешнееСоединениеСБазой. +// Устанавливает внешнее соединение с информационной базой по переданным параметрам подключения и возвращает указатель +// на это соединение. +// +// Параметры: +// Параметры - Структура - параметры для установки внешнего соединения с информационной базой. +// Свойства см. в функции +// ОбщегоНазначенияКлиентСервер.СтруктураПараметровДляУстановкиВнешнегоСоединения): +// +// * ВариантРаботыИнформационнойБазы - Число - вариант работы информационной базы: 0 - файловый; 1 - +// клиент-серверный; +// * КаталогИнформационнойБазы - Строка - каталог информационной базы для файлового режима работы; +// * ИмяСервера1СПредприятия - Строка - имя сервера1С:Предприятия; +// * ИмяИнформационнойБазыНаСервере1СПредприятия - Строка - имя информационной базы на сервере1С:Предприятия; +// * АутентификацияОперационнойСистемы - Булево - признак аутентификации операционной системы при создании +// внешнего подключения к информационной базе; +// * ИмяПользователя - Строка - имя пользователя информационной базы; +// * ПарольПользователя - Строка - пароль пользователя информационной базы. +// +// СтрокаСообщенияОбОшибке - Строка - если в процессе установки внешнего соединения возникает ошибка, +// то подробное описание ошибки помещается в этот параметр. +// ОшибкаПодключенияКомпоненты - Булево - (возвращаемый параметр) устанавливается Истина, если была ошибка при подключении. +// +// Возвращаемое значение: +// COMОбъект, Неопределено - в случае успешной установки внешнего соединения возвращается указатель на COM-объект соединения; +// в случае ошибки возвращается Неопределенно. +// +Функция УстановитьВнешнееСоединение(Параметры, СтрокаСообщенияОбОшибке = "", ОшибкаПодключенияКомпоненты = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.УстановитьВнешнееСоединение(Параметры, СтрокаСообщенияОбОшибке, ОшибкаПодключенияКомпоненты); +``` +
+ +## УстановитьВнешнееСоединениеСБазой +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.УстановитьВнешнееСоединениеСБазой +// или ОбщегоНазначения.УстановитьВнешнееСоединениеСБазой +// Устанавливает внешнее соединение с информационной базой по переданным параметрам подключения и возвращает указатель +// на это соединение. +// +// Параметры: +// Параметры - Структура - параметры для установки внешнего соединения с информационной базой. +// Свойства см. в функции +// ОбщегоНазначенияКлиентСервер.СтруктураПараметровДляУстановкиВнешнегоСоединения): +// +// * ВариантРаботыИнформационнойБазы - Число - вариант работы информационной базы: 0 - файловый; 1 - +// клиент-серверный; +// * КаталогИнформационнойБазы - Строка - каталог информационной базы для файлового режима работы; +// * ИмяСервера1СПредприятия - Строка - имя сервера1С:Предприятия; +// * ИмяИнформационнойБазыНаСервере1СПредприятия - Строка - имя информационной базы на сервере1С:Предприятия; +// * АутентификацияОперационнойСистемы - Булево - признак аутентификации операционной системы при создании +// внешнего подключения к информационной базе; +// * ИмяПользователя - Строка - имя пользователя информационной базы; +// * ПарольПользователя - Строка - пароль пользователя информационной базы. +// +// Возвращаемое значение: +// Структура: +// * Соединение - COMОбъект +// - Неопределено - указатель на COM-объект соединения или Неопределено в +// случае ошибки; +// * КраткоеОписаниеОшибки - Строка - краткое описание ошибки; +// * ПодробноеОписаниеОшибки - Строка - подробное описание ошибки; +// * ОшибкаПодключенияКомпоненты - Булево - флаг ошибки подключения COM. +// +Функция УстановитьВнешнееСоединениеСБазой(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.УстановитьВнешнееСоединениеСБазой(Параметры) +``` +
+ +## КлиентПодключенЧерезВебСервер +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.КлиентПодключенЧерезВебСервер +// или ОбщегоНазначения.КлиентПодключенЧерезВебСервер. +// Возвращает Истина, если клиентское приложение подключено к базе через веб-сервер. +// Если нет клиентского приложения, возвращается Ложь. +// +// Возвращаемое значение: +// Булево - Истина, если подключен. +// +Функция КлиентПодключенЧерезВебСервер() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.КлиентПодключенЧерезВебСервер() +``` +
+ +## ЭтоWindowsКлиент +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.ЭтоWindowsКлиент или ОбщегоНазначения.ЭтоWindowsКлиент +// Возвращает Истина, если клиентское приложение запущено под управлением ОС Windows. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоWindowsКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЭтоWindowsКлиент() +``` +
+ +## ЭтоOSXКлиент +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.ЭтоMacOSКлиент или ОбщегоНазначения.ЭтоMacOSКлиент +// Возвращает Истина, если клиентское приложение запущено под управлением ОС X. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоOSXКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЭтоOSXКлиент() +``` +
+ +## ЭтоLinuxКлиент +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.ЭтоLinuxКлиент или ОбщегоНазначения.ЭтоLinuxКлиент +// Возвращает Истина, если клиентское приложение запущено под управлением ОС Linux. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоLinuxКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЭтоLinuxКлиент() +``` +
+ +## ЭтоВебКлиент +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначения.ЭтоВебКлиент, либо инструкцию препроцессора ВебКлиент +// в клиентском коде. +// Возвращает Истина, если клиентское приложение является веб-клиентом. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоВебКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЭтоВебКлиент() +``` +
+ +## ЭтоВебКлиентПодMacOS +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.ЭтоMacOSКлиент с инструкцией препроцессора ВебКлиент, +// или на сервере (ОбщегоНазначения.ЭтоMacOSКлиент И ОбщегоНазначения.ЭтоВебКлиент). +// Возвращает Истина, если это веб-клиент в ОС X. +// +// Возвращаемое значение: +// Булево - Истина, если сеанс запущен под веб-клиентом и в ОС X. +// +Функция ЭтоВебКлиентПодMacOS() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЭтоВебКлиентПодMacOS() +``` +
+ +## ЭтоМобильныйКлиент +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначения.ЭтоМобильныйКлиент либо инструкцию препроцессора МобильныйКлиент +// в клиентском коде. +// Возвращает Истина, если клиентское приложение является мобильным клиентом. +// +// Возвращаемое значение: +// Булево - если нет клиентского приложения, возвращается Ложь. +// +Функция ЭтоМобильныйКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЭтоМобильныйКлиент() +``` +
+ +## ОперативнаяПамятьДоступнаяКлиентскомуПриложению +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.ОперативнаяПамятьДоступнаяКлиентскомуПриложению +// или ОбщегоНазначения.ОперативнаяПамятьДоступнаяКлиентскомуПриложению +// Возвращает объем оперативной памяти, доступной клиентскому приложению. +// +// Возвращаемое значение: +// Число - количество гигабайт оперативной памяти с точностью до десятых долей. +// Неопределено - нет клиентского приложения, то есть ТекущийРежимЗапуска() = Неопределено. +// +Функция ОперативнаяПамятьДоступнаяКлиентскомуПриложению() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ОперативнаяПамятьДоступнаяКлиентскомуПриложению() +``` +
+ +## РежимОтладки +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.РежимОтладки или ОбщегоНазначения.РежимОтладки +// Возвращает Истина, если включен режим отладки. +// +// Возвращаемое значение: +// Булево - Истина, если включен режим отладки. +// +Функция РежимОтладки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.РежимОтладки() +``` +
+ +## КодОсновногоЯзыка +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.КодОсновногоЯзыка или ОбщегоНазначения.КодОсновногоЯзыка +// Возвращает код основного языка конфигурации, например "ru". +// +// Возвращаемое значение: +// Строка - код языка. +// +Функция КодОсновногоЯзыка() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.КодОсновногоЯзыка() +``` +
+ +## ПредставлениеЛокальнойДатыСоСмещением +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.ПредставлениеЛокальнойДатыСоСмещением +// или ОбщегоНазначения.ПредставлениеЛокальнойДатыСоСмещением +// Преобразует локальную дату к формату "YYYY-MM-DDThh:mm:ssTZD" согласно ISO 8601. +// +// Параметры: +// ЛокальнаяДата - Дата - дата в часовом поясе сеанса. +// +// Возвращаемое значение: +// Строка - представление даты. +// +Функция ПредставлениеЛокальнойДатыСоСмещением(ЛокальнаяДата) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПредставлениеЛокальнойДатыСоСмещением(ЛокальнаяДата) +``` +
+ +## ПредопределенныйЭлемент +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиент.ПредопределенныйЭлемент +// или ОбщегоНазначения.ПредопределенныйЭлемент +// Получает ссылку предопределенного элемента по его полному имени. +// Предопределенные элементы могут содержаться только в следующих объектах: +// - Справочники; +// - Планы видов характеристик; +// - Планы счетов; +// - Планы видов расчета. +// После изменения состава предопределенных следует выполнить метод +// ОбновитьПовторноИспользуемыеЗначения(), который сбросит кэш ПовтИсп в текущем сеансе. +// +// Параметры: +// ПолноеИмяПредопределенного - Строка - полный путь к предопределенному элементу, включая его имя. +// Формат аналогичен функции глобального контекста ПредопределенноеЗначение(). +// Например: +// "Справочник.ВидыКонтактнойИнформации.EmailПользователя" +// "ПланСчетов.Хозрасчетный.Материалы" +// "ПланВидовРасчета.Начисления.ОплатаПоОкладу". +// +// Возвращаемое значение: +// ЛюбаяСсылка - ссылка на предопределенный элемент. +// Неопределено - если предопределенный есть в метаданных, но не создан в ИБ. +// +Функция ПредопределенныйЭлемент(ПолноеИмяПредопределенного) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПредопределенныйЭлемент(ПолноеИмяПредопределенного) +``` +
+ +## ПараметрыЗапускаПрограммы +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистемаКлиент.ПараметрыЗапускаПрограммы +// или ФайловаяСистема.ПараметрыЗапускаПрограммы. +// Возвращает структуру параметров для процедуры ЗапуститьПрограмму. +// +// Возвращаемое значение: +// Структура: +// * ТекущийКаталог - Строка - задает текущий каталог запускаемого приложения. +// * ДождатьсяЗавершения - Булево - дожидаться завершения запущенного приложения перед продолжением работы. +// * ПолучитьПотокВывода - Булево - результат, направленный в поток stdout, +// если не указан ДождатьсяЗавершения - игнорируется. +// * ПолучитьПотокОшибок - Булево - ошибки, направленные в поток stderr, +// если не указан ДождатьсяЗавершения - игнорируется. +// * ВыполнитьСНаивысшимиПравами - Булево - требуется запустить программу с повышением привилегий системы: +// подтверждение UAC для Windows; +// или интерактивный запрос c GUI sudo и перенаправление +// $DISPLAY и $XAUTHORITY текущего пользователя для Linux; +// Не совместим с параметром ДождатьсяЗавершения. В MacOS игнорируется. +// * Кодировка - Строка - код кодировки, устанавливаемый до выполнения пакетной операции. +// В Linux и macOS игнорируется. +// +Функция ПараметрыЗапускаПрограммы() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ПараметрыЗапускаПрограммы() +``` +
+ +## ЗапуститьПрограмму +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ФайловаяСистемаКлиент.ЗапуститьПрограмму или ФайловаяСистема.ЗапуститьПрограмму +// Запускает внешнюю программу в соответствии с параметрами запуска. +// Не доступно в веб-клиенте. +// +// Параметры: +// КомандаЗапуска - Строка +// - Массив - командная строка для запуска программы. +// Если Массив, то: первый элемент массива - путь к исполняемому приложению, остальные - передаваемые параметры, +// массив соответствует тому, который получит вызываемая программа в argv. +// ПараметрыЗапускаПрограммы - см. ПараметрыЗапускаПрограммы +// +// Возвращаемое значение: +// Структура - результат работы программы: +// КодВозврата - Число - код возврата программы. +// ПотокВывода - Строка - результат работы программы, направленный в поток stdout. +// ПотокОшибок - Строка - ошибки исполнения программы, направленные в поток stderr. +// +// Пример: +// ОбщегоНазначенияКлиентСервер.ЗапуститьПрограмму("calc"); +// +// ПараметрыЗапускаПрограммы = ОбщегоНазначенияКлиентСервер.ПараметрыЗапускаПрограммы(); +// ПараметрыЗапускаПрограммы.ВыполнитьСНаивысшимиПравами = Истина; +// ОбщегоНазначенияКлиентСервер.ЗапуститьПрограмму("C:\Program Files\1cv8\common\1cestart.exe", +// ПараметрыЗапускаПрограммы); +// +// ПараметрыЗапускаПрограммы = ОбщегоНазначенияКлиентСервер.ПараметрыЗапускаПрограммы(); +// ПараметрыЗапускаПрограммы.ДождатьсяЗавершения = Истина; +// Результат = ОбщегоНазначенияКлиентСервер.ЗапуститьПрограмму("ping 127.0.0.1 -n 5", ПараметрыЗапускаПрограммы); +// +Функция ЗапуститьПрограмму(Знач КомандаЗапуска, ПараметрыЗапускаПрограммы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ЗапуститьПрограмму(КомандаЗапуска, ПараметрыЗапускаПрограммы); +``` +
+ +## ДиагностикаСоединения +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ПолучениеФайловИзИнтернета.ДиагностикаСоединения +// Запускает диагностику сетевого ресурса. +// Не доступно в веб-клиенте. +// В модели сервиса функциональность ограничена получением описания ошибки. +// +// Параметры: +// URL - Строка - адрес URL ресурса, диагностику которого надо выполнить. +// +// Возвращаемое значение: +// Структура - результат работы программы: +// ОписаниеОшибки - Строка - краткое описание ошибки. +// ЖурналДиагностики - Строка - подробный журнал диагностики с техническими подробностями. +// +// Пример: +// // Диагностика веб-сервиса адресного классификатора. +// Результат = ОбщегоНазначенияКлиентСервер.ДиагностикаСоединения("https://api.orgaddress.1c.com/orgaddress/v1?wsdl"); +// +// ОписаниеОшибки = Результат.ОписаниеОшибки; +// ЖурналДиагностики = Результат.ЖурналДиагностики; +// +Функция ДиагностикаСоединения(URL) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбщегоНазначенияКлиентСервер.ДиагностикаСоединения(URL) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОбщегоНазначенияПереопределяемый.md b/src/content/docs/bsp/ОбщегоНазначенияПереопределяемый.md new file mode 100644 index 0000000..1c24c30 --- /dev/null +++ b/src/content/docs/bsp/ОбщегоНазначенияПереопределяемый.md @@ -0,0 +1,683 @@ +--- +title: Общего назначения переопределяемый +slug: bsp/общего-назначения-переопределяемый +--- + + +## ПриОпределенииОбщихПараметровБазовойФункциональности +
+ +Описание, пример вызова + +```bsl + +// Позволяет настроить общие параметры подсистемы. +// +// Параметры: +// ОбщиеПараметры - Структура: +// * ВыводитьПолныйСтекПриОшибкеДлительнойОперации - Булево - если Истина, то в информацию об ошибке +// для разработчика включается фрагмент стека запуска длительной операции (до старта фонового задания). +// Это повышается информативность ошибок, возникающих в фоновых заданиях длительных операций, +// которые запускаются функциями ДлительныеОперации.ВыполнитьФункцию, ВыполнитьПроцедуру и др. +// По умолчанию Ложь, чтобы не мешать отладке при остановке по ошибке. +// * ЗапрашиватьПодтверждениеПриЗавершенииПрограммы - Булево - по умолчанию Истина. Если установить в Ложь, то +// подтверждение при завершении работы программы не будет запрашиваться, если явно не разрешить в +// персональных настройках программы. +// * ИмяФормыПерсональныхНастроек - Строка - имя формы для редактирования персональных настроек. +// * МинимальнаяВерсияПлатформы - Строка - минимальная версии платформы, требуемая для запуска программы. +// Запуск программы на версии платформы ниже указанной будет невозможен. Например, "8.3.6.1650". +// Допускается указание нескольких версий платформы через точку с запятой. +// В этом случае минимальная версия платформы будет выбрана, исходя из фактически используемой. +// Например, "8.3.14.1694; 8.3.15.2107; 8.3.16.1791" - при запуске на предыдущих релизах 8.3.14 +// будет предложено перейти на 8.3.14.1694, при запуске на 8.3.15 - 8.3.15.2107, и 8.3.16 - +// 8.3.16.1791, соответственно. +// * ОтключитьИдентификаторыОбъектовМетаданных - Булево - отключает заполнение справочников ИдентификаторыОбъектовМетаданных +// и ИдентификаторыОбъектовРасширений, процедуру выгрузки и загрузки в узлах РИБ. +// Для частичного встраивания отдельных функций библиотеки в конфигурации без постановки на поддержку. +// * РекомендуемаяВерсияПлатформы - Строка - рекомендуемая версия платформы для запуска программы. +// Например, "8.3.8.2137". Допускается указание нескольких версий платформы через точку с запятой. +// См. пример в параметре МинимальнаяВерсияПлатформы. +// * РекомендуемыйОбъемОперативнойПамяти - Число - объем памяти в гигабайтах, рекомендуемый +// для комфортной работы в программе. По умолчанию 4 Гб. +// +// Устарели, следует использовать свойства МинимальнаяВерсияПлатформы и РекомендуемаяВерсияПлатформы: +// * МинимальноНеобходимаяВерсияПлатформы - Строка - полный номер версии платформы для запуска программы. +// Например, "8.3.4.365". +// * РаботаВПрограммеЗапрещена - Булево - начальное значение Ложь. +// +Процедура ПриОпределенииОбщихПараметровБазовойФункциональности(ОбщиеПараметры) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриОпределенииОбщихПараметровБазовойФункциональности(ОбщиеПараметры) +``` +
+ +## ПриДобавленииОбработчиковУстановкиПараметровСеанса +
+ +Описание, пример вызова + +```bsl + +// Определяет соответствие имен параметров сеанса и обработчиков для их установки. +// Вызывается для инициализации параметров сеанса из обработчика события модуля сеанса УстановкаПараметровСеанса +// (подробнее о нем см. синтакс-помощник). +// +// В указанных модулях должна быть размещена процедура обработчика, в которую передаются параметры: +// ИмяПараметра - Строка - имя параметра сеанса, который требуется установить. +// УстановленныеПараметры - Массив - имена параметров, которые уже установлены. +// +// Далее пример процедуры обработчика для копирования в указанные модули. +// +//// Параметры: +//// ИмяПараметра - Строка +//// УстановленныеПараметры - Массив из Строка +//// +//Процедура УстановкаПараметровСеанса(ИмяПараметра, УстановленныеПараметры) Экспорт +// +// Если ИмяПараметра = "ТекущийПользователь" Тогда +// ПараметрыСеанса.ТекущийПользователь = Значение; +// УстановленныеПараметры.Добавить("ТекущийПользователь"); +// КонецЕсли; +// +//КонецПроцедуры +// +// Параметры: +// Обработчики - Соответствие из КлючИЗначение: +// * Ключ - Строка - в формате "<ИмяПараметраСеанса>|<НачалоИмениПараметраСеанса*>". +// Символ '*'используется в конце имени параметра сеанса и обозначает, +// что один обработчик будет вызван для инициализации всех параметров сеанса +// с именем, начинающимся на слово НачалоИмениПараметраСеанса. +// +// * Значение - Строка - в формате "<ИмяМодуля>.УстановкаПараметровСеанса". +// +// Пример: +// Обработчики.Вставить("ТекущийПользователь", "ПользователиСлужебный.УстановкаПараметровСеанса"); +// +Процедура ПриДобавленииОбработчиковУстановкиПараметровСеанса(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриДобавленииОбработчиковУстановкиПараметровСеанса(Обработчики) +``` +
+ +## ПриДобавленииПараметровРаботыКлиентаПриЗапуске +
+ +Описание, пример вызова + +```bsl + +// Позволяет задать значения параметров, необходимых для работы клиентского кода +// при запуске конфигурации (в обработчиках событий ПередНачаломРаботыСистемы и ПриНачалеРаботыСистемы) +// без дополнительных серверных вызовов. +// Для получения значений этих параметров из клиентского кода +// см. СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиентаПриЗапуске. +// +// Важно: недопустимо использовать команды сброса кэша повторно используемых модулей, +// иначе запуск может привести к непредсказуемым ошибкам и лишним серверным вызовам. +// +// Параметры: +// Параметры - Структура - имена и значения параметров работы клиента при запуске, которые необходимо задать. +// Для установки параметров работы клиента при запуске: +// Параметры.Вставить(<ИмяПараметра>, <код получения значения параметра>); +// +Процедура ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) +``` +
+ +## ПриДобавленииПараметровРаботыКлиента +
+ +Описание, пример вызова + +```bsl + +// Позволяет задать значения параметров, необходимых для работы клиентского кода +// конфигурации без дополнительных серверных вызовов. +// Для получения этих параметров из клиентского кода +// см. СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиента. +// +// Параметры: +// Параметры - Структура - имена и значения параметров работы клиента, которые необходимо задать. +// Для установки параметров работы клиента: +// Параметры.Вставить(<ИмяПараметра>, <код получения значения параметра>); +// +Процедура ПриДобавленииПараметровРаботыКлиента(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриДобавленииПараметровРаботыКлиента(Параметры) +``` +
+ +## ПередЗапускомПрограммы +
+ +Описание, пример вызова + +```bsl + +// Позволяет выполнить действия перед запуском сеанса программы, которые невозможно отложить на более поздний этап. +// Например, настроить начальную страницу и другие параметры интерфейса в зависимости от режима работы. +// +// Вызывается в клиентских сеансах и в сеансах регламентных заданий после проверки минимальной версии платформы, +// заданной в процедуре ОбщегоНазначенияПереопределяемый.ПриОпределенииОбщихПараметровБазовойФункциональности. +// Не вызывается из сеансов фоновых заданий. +// +// Для определения, что запущен клиентский сеанс, можно проверить ТекущийРежимЗапуска() <> Неопределено. +// Для определения других видов сеанса - условие ПолучитьТекущийСеансИнформационнойБазы().ИмяПриложения = "<имя>", +// например "WSConnection" или "BackgroundJob". +// +// Вызов производится в привилегированном режиме. +// +// Рекомендуется размещать здесь код вместо обработчика события УстановкаПараметровСеанса модуля сеанса +// с проверкой условия ИменаПараметровСеанса = Неопределено. +// При реализации обработчика следует иметь в виду, что в ИБ могут быть не завершены обработчики обновления +// и не выполнена дальнейшая инициализация, которая происходит позже при запуске программы. +// Поэтому может быть небезопасно безусловно вызывать другие процедуры и функции, которые зависят от этого. +// +Процедура ПередЗапускомПрограммы() Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПередЗапускомПрограммы() +``` +
+ +## ПриДобавленииИсключенийПоискаСсылок +
+ +Описание, пример вызова + +```bsl + +// Определяет объекты метаданных и отдельные реквизиты, которые исключаются из результатов поиска ссылок, +// не учитываются при монопольном удалении помеченных, замене ссылок и в отчете по местам использования. +// См. также ОбщегоНазначения.ИсключенияПоискаСсылок. +// +// Пример задачи: к документу "Реализация товаров и услуг" подключены подсистемы "Версионирование объектов" и "Свойства". +// Также этот документ может быть указан в других объектах метаданных - документах или регистрах. +// Часть ссылок имеют значение для бизнес-логики (например движения по регистрам) и должны выводиться пользователю. +// Другая часть ссылок - "техногенные" (ссылки на документ из данных подсистем "Версионирование объектов" и "Свойства") +// и должны скрываться от пользователя при удалении, анализе мест использования или запретов редактирования ключевых реквизитов. +// Список таких "техногенных" объектов нужно перечислить в этой процедуре. +// +// При этом для избежания появления ссылок на несуществующие объекты +// рекомендуется предусмотреть процедуру очистки указанных объектов метаданных. +// * Для измерений регистров сведений - с помощью установки флажка "Ведущее", +// тогда запись регистра сведений будет удалена вместе с удалением ссылки, указанной в измерении. +// * Для других реквизитов указанных объектов - с помощью подписки на событие ПередУдалением всех типов объектов +// метаданных, которые могут быть записаны в реквизиты указанных объектов метаданных. +// В обработчике необходимо найти "техногенные" объекты, в реквизитах которых указана ссылка удаляемого объекта, +// и выбрать, как именно очищать ссылку: очищать значение реквизита, удалять строку таблицы или удалять весь объект. +// Подробнее см. в документации к подсистеме "Удаление помеченных объектов". +// +// При исключении регистров допустимо исключать только Измерения. +// При необходимости исключить из поиска значения в ресурсах +// или в реквизитах регистров требуется исключить регистр целиком. +// +// Параметры: +// ИсключенияПоискаСсылок - Массив - объекты метаданных или их реквизиты (ОбъектМетаданных, Строка), +// которые не должно учитываться в бизнес-логике. +// Стандартные реквизиты и табличные части могут быть указаны только в виде строковых имен (см. пример ниже). +// +// Пример: +// ИсключенияПоискаСсылок.Добавить(Метаданные.РегистрыСведений.ВерсииОбъектов); +// ИсключенияПоискаСсылок.Добавить(Метаданные.РегистрыСведений.ВерсииОбъектов.Измерения.Объект); +// ИсключенияПоискаСсылок.Добавить("ПланВидовРасчета.ОсновныеНачисления.СтандартнаяТабличнаяЧасть.БазовыеВидыРасчета.СтандартныйРеквизит.ВидРасчета"); +// +Процедура ПриДобавленииИсключенийПоискаСсылок(ИсключенияПоискаСсылок) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриДобавленииИсключенийПоискаСсылок(ИсключенияПоискаСсылок) +``` +
+ +## ПриОпределенииПодчиненныхОбъектов +
+ +Описание, пример вызова + +```bsl + +// Позволяет задать список подчиненных объектов и их связи с основными объектами. +// Подчиненные объекты рекомендуется использовать, если в процессе замены ссылок +// нужно создавать часть объектов или подбирать замену из существующих объектов. +// +// Параметры: +// ПодчиненныеОбъекты - см. ОбщегоНазначения.ПодчиненныеОбъекты +// +// Пример: +// СвязиПодчиненногоОбъекта = Новый Соответствие; +// СвязиПодчиненногоОбъекта.Вставить("ПолеСвязи"); +// ПодчиненныйОбъект = ПодчиненныеОбъекты.Добавить(); +// ПодчиненныйОбъект.ПодчиненныйОбъект = Метаданные.Справочники.<ПодчиненныйСправочник>; +// ПодчиненныйОбъект.ПоляСвязей = СвязиПодчиненногоОбъекта; +// ПодчиненныйОбъект.ВыполнятьАвтоматическийПоискЗаменСсылок = Истина; +// +// СвязиПодчиненногоОбъекта = Новый Массив; +// СвязиПодчиненногоОбъекта.Вставить("ПолеСвязи"); +// ПодчиненныйОбъект = ПодчиненныеОбъекты.Добавить(); +// ПодчиненныйОбъект.ПодчиненныйОбъект = Метаданные.Справочники.<ПодчиненныйСправочник>; +// ПодчиненныйОбъект.ПоляСвязей = СвязиПодчиненногоОбъекта; +// ПодчиненныйОбъект.ВыполнятьАвтоматическийПоискЗаменСсылок = Истина; +// +// ПодчиненныйОбъект = ПодчиненныеОбъекты.Добавить(); +// ПодчиненныйОбъект.ПодчиненныйОбъект = Метаданные.Справочники.<ПодчиненныйСправочник>; +// ПодчиненныйОбъект.ПоляСвязей = "ПолеСвязи"; +// ПодчиненныйОбъект.ПриПоискеЗаменыСсылок = "<ОбщийМодуль>"; +// +Процедура ПриОпределенииПодчиненныхОбъектов(ПодчиненныеОбъекты) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриОпределенииПодчиненныхОбъектов(ПодчиненныеОбъекты) +``` +
+ +## ПослеЗаменыСсылок +
+ +Описание, пример вызова + +```bsl + +// Выполняется после замены ссылок перед непосредственным удалением объектов. +// +// Параметры: +// Результат - см. ОбщегоНазначения.ЗаменитьСсылки +// ПараметрыВыполнения - см. ОбщегоНазначения.ПараметрыЗаменыСсылок +// ТаблицаПоиска - см. ОбщегоНазначения.МестаИспользования +// +Процедура ПослеЗаменыСсылок(Результат, ПараметрыВыполнения, ТаблицаПоиска) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПослеЗаменыСсылок(Результат, ПараметрыВыполнения, ТаблицаПоиска) +``` +
+ +## ПриДобавленииПереименованийОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при обновлении информационной базы для учета переименований подсистем в конфигурации. +// В противном случае, возникнет рассинхронизация между метаданными конфигурации и +// элементами справочника ИдентификаторыОбъектовМетаданных, что приведет к различным ошибкам при работе конфигурации. +// Переименования задаются с помощью процедуры ОбщегоНазначения.ДобавитьПереименование. +// +// Если в конфигурации предусмотрен переход с предыдущей версии, в которую включена библиотека версии +// 3.1.5 и меньше, то также необходимо указывать переименования ролей. +// +// Переименования остальных объектов метаданных задавать не следует, т.к. они обрабатываются автоматически. +// См. также ОбщегоНазначения.ИдентификаторОбъектаМетаданных, ОбщегоНазначения.ИдентификаторыОбъектовМетаданных. +// +// Параметры: +// Переименования - Структура - сведения о переименованиях, которые требуется заполнить с помощью процедуры +// ОбщегоНазначения.ДобавитьПереименование. +// +// Пример: +// ОбщегоНазначения.ДобавитьПереименование(Переименования, "2.1.2.14", +// "Подсистема.СлужебныеПодсистемы", "Подсистема.СервисныеПодсистемы"); +// +Процедура ПриДобавленииПереименованийОбъектовМетаданных(Переименования) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриДобавленииПереименованийОбъектовМетаданных(Переименования) +``` +
+ +## ПриОпределенииОтключенныхПодсистем +
+ +Описание, пример вызова + +```bsl + +// Позволяет отключать подсистемы, например, для целей тестирования. +// Если подсистема отключена, то функции ОбщегоНазначения.ПодсистемаСуществует и +// ОбщегоНазначенияКлиент.ПодсистемаСуществует вернут Ложь. +// +// В реализации этой процедуры нельзя использовать функцию ОбщегоНазначения.ПодсистемаСуществует, +// т.к. это приводит к рекурсии. +// +// Параметры: +// ОтключенныеПодсистемы - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя отключаемой подсистемы +// * Значение - Булево - Истина +// +Процедура ПриОпределенииОтключенныхПодсистем(ОтключенныеПодсистемы) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриОпределенииОтключенныхПодсистем(ОтключенныеПодсистемы) +``` +
+ +## ПередЗагрузкойПриоритетныхДанныхВПодчиненномРИБУзле +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед загрузкой приоритетных данных в подчиненном узле РИБ +// и предназначена для заполнения настроек размещения сообщения обмена данными или +// для реализации нестандартной загрузки приоритетных данных из главного узла РИБ. +// +// К приоритетным данным относятся предопределенные элементы, а также +// элементы справочника ИдентификаторыОбъектовМетаданных. +// +// Параметры: +// СтандартнаяОбработка - Булево - начальное значение Истина; если установить Ложь, +// то стандартная загрузка приоритетных данных с помощью подсистемы +// ОбменДанными будет пропущена (так же будет и в том случае, +// если подсистемы ОбменДанными нет в конфигурации). +// +Процедура ПередЗагрузкойПриоритетныхДанныхВПодчиненномРИБУзле(СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПередЗагрузкойПриоритетныхДанныхВПодчиненномРИБУзле(СтандартнаяОбработка) +``` +
+ +## ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов +
+ +Описание, пример вызова + +```bsl + +// Определяет список версий программных интерфейсов, доступных через web-сервис InterfaceVersion. +// +// Параметры: +// ПоддерживаемыеВерсии - Структура - в ключе указывается имя программного интерфейса, +// а в значениях - массив строк с поддерживаемыми версиями этого интерфейса. +// +// Пример: +// +// // СервисПередачиФайлов +// Версии = Новый Массив; +// Версии.Добавить("1.0.1.1"); +// Версии.Добавить("1.0.2.1"); +// ПоддерживаемыеВерсии.Вставить("СервисПередачиФайлов", Версии); +// // Конец СервисПередачиФайлов +// +Процедура ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(ПоддерживаемыеВерсии) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(ПоддерживаемыеВерсии) +``` +
+ +## ПриОпределенииПараметровФункциональныхОпцийИнтерфейса +
+ +Описание, пример вызова + +```bsl + +// Задает параметры функциональных опций, действие которых распространяется на командный интерфейс и рабочий стол. +// Например, если значения функциональной опции хранятся в ресурсах регистра сведений, +// то параметры функциональных опций могут определять условия отборов по измерениям регистра, +// которые будут применяться при чтении значения этой функциональной опции. +// +// См. в синтакс-помощнике методы ПолучитьФункциональнуюОпциюИнтерфейса, +// УстановитьПараметрыФункциональныхОпцийИнтерфейса и ПолучитьПараметрыФункциональныхОпцийИнтерфейса. +// +// Параметры: +// ОпцииИнтерфейса - Структура - значения параметров функциональных опций, установленных для командного интерфейса. +// Ключ элемента структуры определяет имя параметра, а значение элемента - текущее значение параметра. +// +Процедура ПриОпределенииПараметровФункциональныхОпцийИнтерфейса(ОпцииИнтерфейса) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриОпределенииПараметровФункциональныхОпцийИнтерфейса(ОпцииИнтерфейса) +``` +
+ +## ПриДобавленииСерверныхОповещений +
+ +Описание, пример вызова + +```bsl + + +// Вызывается при запуске сеанса для получения списка оповещений +// которые необходимо отправить с сервера на клиент (из регламентного задания). +// Смотри СтандартныеПодсистемыСервер.ПриОтправкеСерверногоОповещения +// и СтандартныеПодсистемыКлиент.ПриПолученииСерверногоОповещения. +// +// Параметры: +// Оповещения - Соответствие из КлючИЗначение: +// * Ключ - Строка - смотри СерверныеОповещения.НовоеСерверноеОповещение.Имя +// * Значение - см. СерверныеОповещения.НовоеСерверноеОповещение +// +// Пример: +// Оповещение = СерверныеОповещения.НовоеСерверноеОповещение( +// "СтандартныеПодсистемы.ЗавершениеРаботыПользователей.БлокировкаСеансов"); +// Оповещение.ИмяМодуляОтправки = "СоединенияИБ"; +// Оповещение.ИмяМодуляПолучения = "СоединенияИБКлиент"; +// Оповещение.ПериодПроверки = 300; +// +// Оповещения.Вставить(Оповещение.Имя, Оповещение); +// +Процедура ПриДобавленииСерверныхОповещений(Оповещения) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриДобавленииСерверныхОповещений(Оповещения) +``` +
+ +## ПриПериодическомПолученииДанныхКлиентаНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается из глобального обработчика ожидания по необходимости, но не чаще раза в 60 сек, +// для получения данных с клиента, а также возврате результата на клиент, если нужно. +// Например, для передачи статистики о количестве открытых окон и +// возврате признака дальнейшей передачи статистики с клиента на сервер. +// +// Для получения данных клиента на сервере они должны быть заполнены в параметре Параметры процедуры +// ОбщегоНазначенияКлиентПереопределяемый.ПередПериодическойОтправкойДанныхКлиентаНаСервер. +// +// Для возврата данных с сервера на клиент заполните параметр Результаты, +// который затем будет передан в процедуру +// ОбщегоНазначенияКлиентПереопределяемый.ПослеПериодическогоПолученияДанныхКлиентаНаСервере. +// +// Параметры: +// Параметры - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя параметра, полученного с клиента. +// * Значение - Произвольный - значение параметра, полученного с клиента. +// Результаты - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя параметра, возвращаемого на клиент. +// * Значение - Произвольный - значение параметра, возвращаемого на клиент. +// +// Пример: +// МоментНачала = ТекущаяУниверсальнаяДатаВМиллисекундах(); +// Попытка +// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ЦентрМониторинга") Тогда +// МодульЦентрМониторингаСлужебный = ОбщегоНазначения.ОбщийМодуль("ЦентрМониторингаСлужебный"); +// МодульЦентрМониторингаСлужебный.ПриПериодическомПолученииДанныхКлиентаНаСервере(Параметры, Результаты); +// КонецЕсли; +// Исключение +// СерверныеОповещения.ОбработатьОшибку(ИнформацияОбОшибке()); +// КонецПопытки; +// СерверныеОповещения.ДобавитьПоказатель(Результаты, МоментНачала, +// "ЦентрМониторингаСлужебный.ПриПериодическомПолученииДанныхКлиентаНаСервере"); +// +Процедура ПриПериодическомПолученииДанныхКлиентаНаСервере(Параметры, Результаты) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриПериодическомПолученииДанныхКлиентаНаСервере(Параметры, Результаты) +``` +
+ +## ПриОтправкеДанныхПодчиненному +
+ +Описание, пример вызова + +```bsl + +// Дополнительный обработчик одноименного события, возникающего при обмене данными в распределенной информационной базе. +// Выполняется после выполнения базовых алгоритмов библиотеки. +// Не выполняется, если отправка элемента данных была проигнорирована ранее. +// +// Параметры: +// Источник - ПланОбменаОбъект - узел, для которого выполняется обмен. +// ЭлементДанных - Произвольный - см. описание одноименного обработчика в синтакс-помощнике. +// ОтправкаЭлемента - ОтправкаЭлементаДанных - см. описание одноименного обработчика в синтакс-помощнике. +// СозданиеНачальногоОбраза - Булево - см. описание одноименного обработчика в синтакс-помощнике. +// +Процедура ПриОтправкеДанныхПодчиненному(Источник, ЭлементДанных, ОтправкаЭлемента, СозданиеНачальногоОбраза) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриОтправкеДанныхПодчиненному(Источник, ЭлементДанных, ОтправкаЭлемента, СозданиеНачальногоОбраза) +``` +
+ +## ПриОтправкеДанныхГлавному +
+ +Описание, пример вызова + +```bsl + +// Дополнительный обработчик одноименного события, возникающего при обмене данными в распределенной информационной базе. +// Выполняется после выполнения базовых алгоритмов библиотеки. +// Не выполняется, если отправка элемента данных была проигнорирована ранее. +// +// Параметры: +// Источник - ПланОбменаОбъект - узел, для которого выполняется обмен. +// ЭлементДанных - Произвольный - см. описание одноименного обработчика в синтакс-помощнике. +// ОтправкаЭлемента - ОтправкаЭлементаДанных - см. описание одноименного обработчика в синтакс-помощнике. +// +Процедура ПриОтправкеДанныхГлавному(Источник, ЭлементДанных, ОтправкаЭлемента) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриОтправкеДанныхГлавному(Источник, ЭлементДанных, ОтправкаЭлемента) +``` +
+ +## ПриПолученииДанныхОтПодчиненного +
+ +Описание, пример вызова + +```bsl + +// Дополнительный обработчик одноименного события, возникающего при обмене данными в распределенной информационной базе. +// Выполняется после выполнения базовых алгоритмов библиотеки. +// Не выполняется, если получение элемента данных было проигнорировано ранее. +// +// Параметры: +// Источник - ПланОбменаОбъект - узел, для которого выполняется обмен. +// ЭлементДанных - Произвольный - см. описание одноименного обработчика в синтакс-помощнике. +// ПолучениеЭлемента - ПолучениеЭлементаДанных - см. описание одноименного обработчика в синтакс-помощнике. +// ОтправкаНазад - Булево - см. описание одноименного обработчика в синтакс-помощнике. +// +Процедура ПриПолученииДанныхОтПодчиненного(Источник, ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриПолученииДанныхОтПодчиненного(Источник, ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад) +``` +
+ +## ПриПолученииДанныхОтГлавного +
+ +Описание, пример вызова + +```bsl + +// Дополнительный обработчик одноименного события, возникающего при обмене данными в распределенной информационной базе. +// Выполняется после выполнения базовых алгоритмов библиотеки. +// Не выполняется, если получение элемента данных было проигнорировано ранее. +// +// Параметры: +// Источник - ПланОбменаОбъект - узел, для которого выполняется обмен. +// ЭлементДанных - Произвольный - см. описание одноименного обработчика в синтакс-помощнике. +// ПолучениеЭлемента - ПолучениеЭлементаДанных - см. описание одноименного обработчика в синтакс-помощнике. +// ОтправкаНазад - Булево - см. описание одноименного обработчика в синтакс-помощнике. +// +Процедура ПриПолученииДанныхОтГлавного(Источник, ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриПолученииДанныхОтГлавного(Источник, ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад) +``` +
+ +## ПриОпределенииПризнакаЭтоБазоваяВерсияКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Позволяет изменить признак того, что версия программы является, либо не является базовой. +// +// Параметры: +// ЭтоБазовая - Булево - признак того, что версия программы является базовой. По умолчанию Истина, если в имени +// программы есть слово "Базовая". +// +Процедура ПриОпределенииПризнакаЭтоБазоваяВерсияКонфигурации(ЭтоБазовая) Экспорт +``` + +Пример вызова +```bsl +ОбщегоНазначенияПереопределяемый.ПриОпределенииПризнакаЭтоБазоваяВерсияКонфигурации(ЭтоБазовая) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОплатаСервиса.md b/src/content/docs/bsp/ОплатаСервиса.md new file mode 100644 index 0000000..c89a766 --- /dev/null +++ b/src/content/docs/bsp/ОплатаСервиса.md @@ -0,0 +1,250 @@ +--- +title: Оплата сервиса +slug: bsp/оплата-сервиса +--- + + +## ВерсияИнтерфейса +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию интерфейса биллинга (версии нумеруются простым натуральным числом). +// +// Возвращаемое значение: +// Число - версия интерфейса. +// +Функция ВерсияИнтерфейса() Экспорт +``` + +Пример вызова +```bsl +Результат = ОплатаСервиса.ВерсияИнтерфейса() +``` +
+ +## ПредставлениеВалютыОплаты +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление валюты оплаты услуг сервиса. +// +// Возвращаемое значение: +// Строка - представление валюты оплаты. +// +Функция ПредставлениеВалютыОплаты() Экспорт +``` + +Пример вызова +```bsl +Результат = ОплатаСервиса.ПредставлениеВалютыОплаты() +``` +
+ +## ПриДобавленииПараметровРаботыКлиентаПриЗапуске +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияПереопределяемый.ПриДобавленииПараметровРаботыКлиентаПриЗапуске +// Метод переопределяется в расширении fresh. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +Процедура ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервиса.ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) +``` +
+ +## СостоянияЗавершенияПодписокНаТарифы +
+ +Описание, пример вызова + +```bsl + +// Возвращает состояния истечения сроков подписок на тарифы поданным менеджера сервиса. +// Данные возвращаются только для пользователей с ролью "Владелец абонента". +// Метод переопределяется в расширении fresh. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +// Возвращаемое значение: +// Структура: +// * ЗавершаетсяТестовых - Число +// * ЗавершаетсяБесплатных - Число +// * ЗавершаетсяПлатных - Число +// * ЗавершаетсяВсего - Число +// * НеЗавершаетсяТестовых - Число +// * НеЗавершаетсяБесплатных - Число +// * НеЗавершаетсяПлатных - Число +// * НеЗавершаетсяВсего - Число +Функция СостоянияЗавершенияПодписокНаТарифы() Экспорт +``` + +Пример вызова +```bsl +Результат = ОплатаСервиса.СостоянияЗавершенияПодписокНаТарифы() +``` +
+ +## ПоддерживаетсяЗагрузкаТарифов +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак поддержки загрузки тарифов сервиса в данные информационной базы. +// +// Возвращаемое значение: +// Булево - если Истина, то загрузка поддерживается. +// +Функция ПоддерживаетсяЗагрузкаТарифов() Экспорт +``` + +Пример вызова +```bsl +Результат = ОплатаСервиса.ПоддерживаетсяЗагрузкаТарифов() +``` +
+ +## ЗагрузитьТарифыСервиса +
+ +Описание, пример вызова + +```bsl + +// Загрузка тарифов в справочники информационной базы из менеджера сервиса. +// +Процедура ЗагрузитьТарифыСервиса() Экспорт +``` + +Пример вызова +```bsl +ОплатаСервиса.ЗагрузитьТарифыСервиса() +``` +
+ +## ОтправитьОтветВУчетнуюСистемуБиллинга +
+ +Описание, пример вызова + +```bsl + +// Отправляет ответ в учетную систему биллинга на адрес счета на оплату. +// +// Параметры: +// ИдентификаторСчета - УникальныйИдентификатор - идентификатор счета на оплату. +// Данные - см. ОплатаСервиса.ШаблонДанныхОтвета +// +// Возвращаемое значение: +// HTTPОтвет - ответ менеджера сервиса. +// +// Пример: +// ... +// Данные = ОплатаСервиса.ШаблонДанныхОтвета(); +// Данные.Вставить("paid", Истина); // Признак оплаты счета. +// ОплатаСервиса.ОтправитьЗапросВУчетнуюСистемуБиллинга(ИдентификаторСчета, Данные); // Отправка. +// +Функция ОтправитьОтветВУчетнуюСистемуБиллинга(ИдентификаторСчета, Данные) Экспорт +``` + +Пример вызова +```bsl +Результат = ОплатаСервиса.ОтправитьОтветВУчетнуюСистемуБиллинга(ИдентификаторСчета, Данные) +``` +
+ +## ШаблонДанныхОтвета +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон данных при отправке информации о состоянии счета на оплату. +// +// Параметры: +// КодОтвета - Число - код ответа. Если параметр не передается, устанавливается 10200. +// Для установки можно использовать методы: +// КодВозвратаОшибкаДанных() - соответствует коду 10400 - используется при обработке известных ошибок. +// КодВозвратаВнутренняяОшибка() - соответствует коду 10500 - используется при возникновении непредвиденных ошибок. +// Сообщение - Строка - сообщение об ошибке. Может быть установлен текст ошибки, который будет возвращен пользователю. +// +// Возвращаемое значение: +// Структура: +// * response - Число - код ответа. +// * error - Булево - признак ошибки. Взводится, если передан код ответа отличный от 102xx. +// * message - Строка - сообщение об ошибке. +// +Функция ШаблонДанныхОтвета(КодОтвета = 10200, Сообщение = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОплатаСервиса.ШаблонДанныхОтвета(КодОтвета, Сообщение); +``` +
+ +## КодВозвратаОшибкаДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает код ошибки данных. +// +// Возвращаемое значение: +// Число - код возврата ошибки данных - 10400. +// +Функция КодВозвратаОшибкаДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ОплатаСервиса.КодВозвратаОшибкаДанных() +``` +
+ +## КодВозвратаВнутренняяОшибка +
+ +Описание, пример вызова + +```bsl + +// Возвращает код внутренней ошибки. +// +// Возвращаемое значение: +// Число - код возврата внутренней ошибки - 10500. +// +Функция КодВозвратаВнутренняяОшибка() Экспорт +``` + +Пример вызова +```bsl +Результат = ОплатаСервиса.КодВозвратаВнутренняяОшибка() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОплатаСервисаКлиент.md b/src/content/docs/bsp/ОплатаСервисаКлиент.md new file mode 100644 index 0000000..25e9a5c --- /dev/null +++ b/src/content/docs/bsp/ОплатаСервисаКлиент.md @@ -0,0 +1,60 @@ +--- +title: Оплата сервиса клиент +slug: bsp/оплата-сервиса-клиент +--- + + +## ОткрытьФормуОплатыСервиса +
+ +Описание, пример вызова + +```bsl + +// Открывает форму форму оплаты сервиса. +// Метод переопределяется в расширении fresh. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +Процедура ОткрытьФормуОплатыСервиса() Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаКлиент.ОткрытьФормуОплатыСервиса() +``` +
+ +## ОткрытьФормуВыбораТарифа +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора тарифа сервиса. +// Метод переопределяется в расширении fresh. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +// Параметры: +// КодОбслуживающейОрганизации - Число - код обслуживающей организации +// Источник -ФормаКлиентскогоПриложения - источник открытия формы +// ОповещениеОЗакрытии - ОписаниеОповещения - оповещение о закрытии формы выбора тарифа. +// +Процедура ОткрытьФормуВыбораТарифа(КодОбслуживающейОрганизации, Источник = Неопределено, ОповещениеОЗакрытии = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаКлиент.ОткрытьФормуВыбораТарифа(КодОбслуживающейОрганизации, Источник, ОповещениеОЗакрытии); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОплатаСервисаКлиентПереопределяемый.md b/src/content/docs/bsp/ОплатаСервисаКлиентПереопределяемый.md new file mode 100644 index 0000000..85d4ff6 --- /dev/null +++ b/src/content/docs/bsp/ОплатаСервисаКлиентПереопределяемый.md @@ -0,0 +1,33 @@ +--- +title: Оплата сервиса клиент переопределяемый +slug: bsp/оплата-сервиса-клиент-переопределяемый +--- + + +## ПриОпределенииФормыНастроекОплатыСервиса +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед открытием формы настроек оплаты сервиса. +// Позволяет переопределить имя открываемой формы. +// @skip-check module-empty-method +// +Процедура ПриОпределенииФормыНастроекОплатыСервиса(ИмяФормы) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаКлиентПереопределяемый.ПриОпределенииФормыНастроекОплатыСервиса(ИмяФормы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОплатаСервисаПереопределяемый.md b/src/content/docs/bsp/ОплатаСервисаПереопределяемый.md new file mode 100644 index 0000000..eeeb93b --- /dev/null +++ b/src/content/docs/bsp/ОплатаСервисаПереопределяемый.md @@ -0,0 +1,316 @@ +--- +title: Оплата сервиса переопределяемый +slug: bsp/оплата-сервиса-переопределяемый +--- + + +## ПриУстановкеПредставленияВалютыОплаты +
+ +Описание, пример вызова + +```bsl + +// Вызывается при определении представления валюты оплаты сервиса. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +// Параметры: +// ПредставлениеВалютыОплаты - Строка - представление валюты оплаты. +// +Процедура ПриУстановкеПредставленияВалютыОплаты(ПредставлениеВалютыОплаты) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриУстановкеПредставленияВалютыОплаты(ПредставлениеВалютыОплаты) +``` +
+ +## ПриПолученииИмениФормыОбработкиОтвета +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении имени формы обработки ответа на запрос счета на оплату. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +// Параметры: +// ИмяФормыОбработкиОтвета - Строка - имя формы обработки ответа. +// +Процедура ПриПолученииИмениФормыОбработкиОтвета(ИмяФормыОбработкиОтвета) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриПолученииИмениФормыОбработкиОтвета(ИмяФормыОбработкиОтвета) +``` +
+ +## ПриУстановкеНастроекОплатыСервиса +
+ +Описание, пример вызова + +```bsl + +// Вызывается при установке настроек оплаты сервиса. +// @skip-check module-empty-method +// +// Параметры: +// КодАбонента - Число - код абонента-владельца учетной системы +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПриУстановкеНастроекОплатыСервиса(КодАбонента, РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриУстановкеНастроекОплатыСервиса(КодАбонента, РезультатОбработки) +``` +
+ +## ПриУдаленииНастроекОплатыСервиса +
+ +Описание, пример вызова + +```bsl + +// Вызывается при удалении настроек оплаты сервиса. +// @skip-check module-empty-method +// +// Параметры: +// КодАбонента - Число - код абонента-владельца учетной системы +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПриУдаленииНастроекОплатыСервиса(КодАбонента, РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриУдаленииНастроекОплатыСервиса(КодАбонента, РезультатОбработки) +``` +
+ +## ПриОпределенииПоддержкиЗагрузкиТарифов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при определении возможности загрузки тарифов сервиса. +// @skip-warning ПустойМетод - переопределяемый метод. +// @skip-check module-empty-method +// +// Параметры: +// Результат - Булево - результат определения возможности загрузки. +// +Процедура ПриОпределенииПоддержкиЗагрузкиТарифов(Результат) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриОпределенииПоддержкиЗагрузкиТарифов(Результат) +``` +
+ +## ПриЗагрузкеТарифов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при загрузке тарифов в информационную базу по данным менеджера сервиса. +// Метод является идемпотентным. Поддерживается повторное выполнение с получением аналогичного результата. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +// Параметры: +// ИсходныеДанные - Структура: +// * ТарифыПровайдера - см. ПрограммныйИнтерфейсСервиса.ТарифыСервиса +// * ТарифыОбслуживающейОрганизации - см. ПрограммныйИнтерфейсСервиса.ТарифыОбслуживающейОрганизации +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПриЗагрузкеТарифов(ИсходныеДанные, РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриЗагрузкеТарифов(ИсходныеДанные, РезультатОбработки) +``` +
+ +## ПриЗаполненииОбязательныхСведенийДляОформленияПодписки +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании на сервере формы сведений абонента, если требуется их заполнение. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +// Параметры: +// ОбязательныеСведения - Структура: +// * ЕстьОшибки - Булево - признак наличия ошибок заполнения. +// * Реквизиты - ТаблицаЗначений - дополнительные реквизиты абонента: +// ** Ключ - Строка - имя дополнительного реквизита +// ** Заголовок - Строка - заголовок дополнительного реквизита +// ** Тип - Строка - тип значения +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +// ** ЗаполнятьОбязательно - Булево - признак обяз +// ** Подсказка - Строка - подсказка заполнения +// ** Ошибка - Булево - признак ошибки заполнения +// ** Сообщение - Строка - сообщение об ошибке +// ** Видимость - Булево - признак отображения на форме заполнения +// * Свойства - ТаблицаЗначений - дополнительные свойства абонента: +// ** Ключ - Строка - имя дополнительного свойства +// ** Заголовок - Строка - заголовок дополнительного реквизита +// ** Тип - Строка - тип значения +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного свойства +// ** ЗаполнятьОбязательно - Булево - признак обяз +// ** Подсказка - Строка - подсказка заполнения +// ** Ошибка - Булево - признак ошибки заполнения +// ** Сообщение - Строка - сообщение об ошибке +// ** Видимость - Булево - признак отображения на форме заполнения +// Абонент - см. ПрограммныйИнтерфейсСервиса.АбонентЭтогоПриложения +Процедура ПриЗаполненииОбязательныхСведенийДляОформленияПодписки(ОбязательныеСведения, Абонент) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриЗаполненииОбязательныхСведенийДляОформленияПодписки(ОбязательныеСведения, Абонент) +``` +
+ +## ПриСозданииСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании счета на оплату по запросу от менеджера сервиса. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +// Параметры: +// ДанныеЗапроса - см. ОплатаСервиса.ДанныеЗапросаСчетаНаОплату +// СчетНаОплату - ДокументСсылка - созданный счет на оплату (возвращаемые данные) +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПриСозданииСчетаНаОплату(ДанныеЗапроса, СчетНаОплату, РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриСозданииСчетаНаОплату(ДанныеЗапроса, СчетНаОплату, РезультатОбработки) +``` +
+ +## ПриПолученииПечатнойФормыСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Устанавливает печатную форму счета на оплату. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +// Параметры: +// ДанныеЗапроса - см. ОплатаСервиса.ДанныеЗапросаСчетаНаОплату +// СчетНаОплату - ДокументСсылка - счет на оплату +// ПечатнаяФорма - ТабличныйДокумент - печатная форма счета на оплату (возвращаемые данные) +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПриПолученииПечатнойФормыСчетаНаОплату(ДанныеЗапроса, СчетНаОплату, ПечатнаяФорма, РезультатОбработки) экспорт Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриПолученииПечатнойФормыСчетаНаОплату(ДанныеЗапроса, СчетНаОплату, ПечатнаяФорма, РезультатОбработки) экспорт); +``` +
+ +## ПриПолученииДанныхСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Устанавливает двоичные данные счета на оплату. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +// Параметры: +// ДанныеЗапроса - см. ОплатаСервиса.ДанныеЗапросаСчетаНаОплату +// СчетНаОплату - ДокументСсылка - счет на оплату +// Данные - ДвоичныеДанные - данные счета на оплату (возвращаемые данные) +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПриПолученииДанныхСчетаНаОплату(ДанныеЗапроса, СчетНаОплату, Данные, РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриПолученииДанныхСчетаНаОплату(ДанныеЗапроса, СчетНаОплату, Данные, РезультатОбработки) +``` +
+ +## ПриПолученииПлатежнойСсылки +
+ +Описание, пример вызова + +```bsl + +// Устанавливает значение платежной ссылки счета на оплату. +// @skip-warning - обратная совместимость. +// @skip-check module-empty-method +// +// Параметры: +// ДанныеЗапроса - см. ОплатаСервиса.ДанныеЗапросаСчетаНаОплату +// СчетНаОплату - ДокументСсылка - счет на оплату +// ПлатежнаяСсылка - Строка - платежная ссылка (возаращаемые данные) +// РезультатОбработки - Структура - результаты обработки метода (возвращаемые данные): +// * Ошибка - Булево - признак ошибки обработки +// * Сообщение - Строка - сообщение об ошибке обработки. +// +Процедура ПриПолученииПлатежнойСсылки(ДанныеЗапроса, СчетНаОплату, ПлатежнаяСсылка, РезультатОбработки) Экспорт +``` + +Пример вызова +```bsl +ОплатаСервисаПереопределяемый.ПриПолученииПлатежнойСсылки(ДанныеЗапроса, СчетНаОплату, ПлатежнаяСсылка, РезультатОбработки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОповещениеПользователейБТСКлиентПереопределяемый.md b/src/content/docs/bsp/ОповещениеПользователейБТСКлиентПереопределяемый.md new file mode 100644 index 0000000..92f15eb --- /dev/null +++ b/src/content/docs/bsp/ОповещениеПользователейБТСКлиентПереопределяемый.md @@ -0,0 +1,53 @@ +--- +title: Оповещение пользователей БТС клиент переопределяемый +slug: bsp/оповещение-пользователей-бтс-клиент-переопределяемый +--- + + +## ПриДобавленииОбработчиковОповещенийПользователейБТС +
+ +Описание, пример вызова + +```bsl + +// При добавлении обработчиков оповещений пользователей БТС. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОбработчикиОповещений - Соответствие - Ключ, идентификатор вида оповещения, +// Значение, клиентский модуль содержащий метод ОбработатьОповещение +// с параметром ОповещениеПользователя. Метод данного модуля будет вызван при получении оповещения +// с указаным идентификатором вида оповещения. +// +// Пример: +// МодульОбработчиков = ОбщегоНазначенияКлиент.ОбщийМодуль("ОповещениеПользователейОНовостях"); +// ОбработчикиОповещений.Вставить( +// "ОповещениеОНовыхНовостяхСайта", +// МодульОбработчиков); +// +// Модуль ОповещениеПользователейОНовостях содержит следующий код: +// Процедура ОбработатьОповещение(ОповещениеПользователя) Экспорт +// +// Если ОповещениеПользователя.ВидОповещения = "ОповещениеОНовыхНовостяхСайта" Тогда +// ОбработатьНовыеНовостиССайта(ОповещениеПользователя); - процедура реализующая логику обработки +// КонецЕсли; +// +// КонецПроцедуры. +// +Процедура ПриДобавленииОбработчиковОповещенийПользователейБТС(ОбработчикиОповещений) Экспорт +``` + +Пример вызова +```bsl +ОповещениеПользователейБТСКлиентПереопределяемый.ПриДобавленииОбработчиковОповещенийПользователейБТС(ОбработчикиОповещений) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОповещениеПользователейБТСПереопределяемый.md b/src/content/docs/bsp/ОповещениеПользователейБТСПереопределяемый.md new file mode 100644 index 0000000..dfe454a --- /dev/null +++ b/src/content/docs/bsp/ОповещениеПользователейБТСПереопределяемый.md @@ -0,0 +1,33 @@ +--- +title: Оповещение пользователей БТС переопределяемый +slug: bsp/оповещение-пользователей-бтс-переопределяемый +--- + + +## ОбработатьСтартСеансаПользователя +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается в момент старта сеанса, после подключения функционала оповещения пользователей. +// Используется для формирования уведомлений пользователям после старта сеанса +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ОбработатьСтартСеансаПользователя() Экспорт +``` + +Пример вызова +```bsl +ОповещениеПользователейБТСПереопределяемый.ОбработатьСтартСеансаПользователя() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОрганизацииПереопределяемый.md b/src/content/docs/bsp/ОрганизацииПереопределяемый.md new file mode 100644 index 0000000..79105fa --- /dev/null +++ b/src/content/docs/bsp/ОрганизацииПереопределяемый.md @@ -0,0 +1,524 @@ +--- +title: Организации переопределяемый +slug: bsp/организации-переопределяемый +--- + + +## ПриОпределенииРегистрационныхДанныхОрганизации +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о регистрационной информации организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// РегистрационныеДанные - см. ОрганизацииСервер.РегистрационныеДанныеОрганизации +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +// Пример: +// СведенияОбОрганизации = ОрганизацииСервер.СведенияОбОрганизации(Организация); +// +// СвойстваОрганизации = СтрРазделить(Поля, ",", Ложь); +// +// Запрос = Новый Запрос; +// Запрос.УстановитьПараметр("Ссылка", Организация); +// Запрос.Текст = +// "ВЫБРАТЬ +// | Организации.Ссылка КАК Ссылка, +// | Организации.ВерсияДанных КАК ВерсияДанных, +// | Организации.ПометкаУдаления КАК ПометкаУдаления, +// | Организации.Код КАК Код, +// | Организации.Наименование КАК Наименование, +// | Организации.БИК КАК БИК, +// | Организации.ГлавныйБухгалтер КАК ГлавныйБухгалтер, +// | Организации.Директор КАК Директор, +// | Организации.ИндивидуальныйПредприниматель КАК ИндивидуальныйПредприниматель, +// | Организации.ИНН КАК ИНН, +// | Организации.ИнформационноеОбслуживание КАК ИнформационноеОбслуживание, +// | Организации.КорреспондентскийСчет КАК КорреспондентскийСчет, +// | Организации.КПП КАК КПП, +// | Организации.НаименованиеПолное КАК НаименованиеПолное, +// | Организации.НаименованиеСокращенное КАК НаименованиеСокращенное, +// | Организации.ОГРН КАК ОГРН, +// | Организации.Префикс КАК Префикс, +// | Организации.РасчетныйСчет КАК РасчетныйСчет, +// | Организации.ГоловнаяОрганизация КАК ГоловнаяОрганизация, +// | Организации.ПроизводственныйКалендарь КАК ПроизводственныйКалендарь, +// | Организации.Предопределенный КАК Предопределенный, +// | Организации.ИмяПредопределенныхДанных КАК ИмяПредопределенныхДанных, +// | Организации.ВАрхиве КАК ВАрхиве +// |ИЗ +// | Справочник.Организации КАК Организации +// |ГДЕ +// | Организации.Ссылка = &Ссылка"; +// +// РезультатЗапроса = Запрос.Выполнить(); +// ВыборкаДетальныеЗаписи = РезультатЗапроса.Выбрать(); +// Если ВыборкаДетальныеЗаписи.Следующий() Тогда +// Для каждого Элемент Из СвойстваОрганизации Цикл +// Если РезультатЗапроса.Колонки.Найти(Элемент) <> Неопределено Тогда +// РегистрационныеДанные.Вставить(Элемент, ВыборкаДетальныеЗаписи[Элемент]); +// КонецЕсли; +// КонецЦикла; +// КонецЕсли; +// +Процедура ПриОпределенииРегистрационныхДанныхОрганизации(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхОрганизации(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) +``` +
+ +## ПриОпределенииДополнительныхСведенийОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о дополнительной информации организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// ДополнительныеСведения - см. ОрганизацииСервер.ДополнительныеСведенияОрганизации. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииДополнительныхСведенийОрганизации(Организация, Поля, Дата, ДополнительныеСведения, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииДополнительныхСведенийОрганизации(Организация, Поля, Дата, ДополнительныеСведения, КодЯзыка) +``` +
+ +## ПриОпределенииКонтактнойИнформацииОрганизации +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о контактной информации организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КонтактнаяИнформация - см. ОрганизацииСервер.КонтактнаяИнформацияОрганизации. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииКонтактнойИнформацииОрганизации(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииОрганизации(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) +``` +
+ +## ПриОпределенииБанковскогоСчетаОрганизации +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о банковской информации организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// БанковскийСчет - см. ОрганизацииСервер.БанковскийСчетОрганизации. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииБанковскогоСчетаОрганизации(Организация, Поля, Дата, БанковскийСчет, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииБанковскогоСчетаОрганизации(Организация, Поля, Дата, БанковскийСчет, КодЯзыка) +``` +
+ +## ПриОпределенииРегистрационныхДанныхОбособленногоПодразделения +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о регистрационных данных обособленного подразделения. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// РегистрационныеДанные - см. ОрганизацииСервер.РегистрационныеДанныеОбособленногоПодразделения. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииРегистрационныхДанныхОбособленногоПодразделения(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхОбособленногоПодразделения(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) +``` +
+ +## ПриОпределенииКонтактнойИнформацииОбособленногоПодразделения +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о контактной информации обособленного подразделения. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КонтактнаяИнформация - см. ОрганизацииСервер.КонтактнаяИнформацияОбособленногоПодразделения. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииКонтактнойИнформацииОбособленногоПодразделения(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииОбособленногоПодразделения(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) +``` +
+ +## ПриОпределенииРегистрационныхДанныхОтделенияИностраннойОрганизации +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о регистрационной информации иностранной организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// РегистрационныеДанные - см. ОрганизацииСервер.РегистрационныеДанныеОтделенияИностраннойОрганизации. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииРегистрационныхДанныхОтделенияИностраннойОрганизации(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхОтделенияИностраннойОрганизации(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) +``` +
+ +## ПриОпределенииКонтактнойИнформацииИностраннойОрганизации +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о контактной информации иностранной организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КонтактнаяИнформация - см. ОрганизацииСервер.КонтактнаяИнформацияОтделенияИностраннойОрганизации. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииКонтактнойИнформацииИностраннойОрганизации(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииИностраннойОрганизации(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) +``` +
+ +## ПриОпределенииРегистрационныхДанныхИндивидуальногоПредпринимателя +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о регистрационной информации индивидуального предпринимателя. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// РегистрационныеДанные - см. ОрганизацииСервер.РегистрационныеДанныеИндивидуальногоПредпринимателя. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииРегистрационныхДанныхИндивидуальногоПредпринимателя(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхИндивидуальногоПредпринимателя(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) +``` +
+ +## ПриОпределенииКонтактнойИнформацииИндивидуальногоПредпринимателя +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о контактной информации индивидуального предпринимателя. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КонтактнаяИнформация - см. ОрганизацииСервер.КонтактнаяИнформацияИндивидуальногоПредпринимателя. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииКонтактнойИнформацииИндивидуальногоПредпринимателя(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииИндивидуальногоПредпринимателя(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) +``` +
+ +## ПриОпределенииРегистрационныхДанныхРуководителяОрганизации +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о регистрационной информации руководителя организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// РегистрационныеДанные - см. ОрганизацииСервер.РегистрационныеДанныеРуководителяОрганизации. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииРегистрационныхДанныхРуководителяОрганизации(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхРуководителяОрганизации(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) +``` +
+ +## ПриОпределенииКонтактнойИнформацииРуководителяОрганизации +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о контактной информации руководителя организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КонтактнаяИнформация - см. ОрганизацииСервер.КонтактнаяИнформацияРуководителяОрганизации. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииКонтактнойИнформацииРуководителяОрганизации(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииРуководителяОрганизации(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) +``` +
+ +## ПриОпределенииРегистрационныхДанныхГлавногоБухгалтера +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о регистрационной информации главного бухгалтера. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// РегистрационныеДанные - см. ОрганизацииСервер.РегистрационныеДанныеГлавногоБухгалтера. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииРегистрационныхДанныхГлавногоБухгалтера(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхГлавногоБухгалтера(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) +``` +
+ +## ПриОпределенииКонтактнойИнформацииГлавногоБухгалтера +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о контактной информации главного бухгалтера. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КонтактнаяИнформация - см. ОрганизацииСервер.КонтактнаяИнформацияГлавногоБухгалтера. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииКонтактнойИнформацииГлавногоБухгалтера(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииГлавногоБухгалтера(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) +``` +
+ +## ПриОпределенииРегистрационныхДанныхУполномоченногоПредставителя +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о регистрационных данных уполномоченного представителя. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// РегистрационныеДанные - см. ОрганизацииСервер.РегистрационныеДанныеУполномоченногоПредставителя. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииРегистрационныхДанныхУполномоченногоПредставителя(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхУполномоченногоПредставителя(Организация, Поля, Дата, РегистрационныеДанные, КодЯзыка) +``` +
+ +## ПриОпределенииКонтактнойИнформацииУполномоченногоПредставителя +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру, содержащую сведения о контактной информации уполномоченного представителя. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения. +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КонтактнаяИнформация - см. ОрганизацииСервер.КонтактнаяИнформацияУполномоченногоПредставителя. +// КодЯзыка - см. ОрганизацииСервер.СведенияОбОрганизации.КодЯзыка +// +Процедура ПриОпределенииКонтактнойИнформацииУполномоченногоПредставителя(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииУполномоченногоПредставителя(Организация, Поля, Дата, КонтактнаяИнформация, КодЯзыка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОрганизацииСервер.md b/src/content/docs/bsp/ОрганизацииСервер.md new file mode 100644 index 0000000..a21b3b8 --- /dev/null +++ b/src/content/docs/bsp/ОрганизацииСервер.md @@ -0,0 +1,846 @@ +--- +title: Организации сервер +slug: bsp/организации-сервер +--- + + +## СведенияОбОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения об организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.*). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - Строка - язык, на котором требуется получить сведения. +// Состоит из кода языка по ISO 639-1 и, опционально, кода страны по ISO 3166-1, разделенных +// символом подчеркивания. Примеры: "en", "en_US", "en_GB", "ru", "ru_RU". +// Значение по умолчанию - язык конфигурации. +// +// Возвращаемое значение: +// Структура - +// см. ОрганизацииСервер.РегистрационныеДанныеОрганизации +// см. ОрганизацииСервер.ДополнительныеСведенияОрганизации +// см. ОрганизацииСервер.КонтактнаяИнформацияОрганизации +// см. ОрганизацииСервер.БанковскийСчетОрганизации +// см. ОрганизацииСервер.РегистрационныеДанныеОбособленногоПодразделения +// см. ОрганизацииСервер.КонтактнаяИнформацияОбособленногоПодразделения +// см. ОрганизацииСервер.РегистрационныеДанныеОтделенияИностраннойОрганизации +// см. ОрганизацииСервер.КонтактнаяИнформацияОтделенияИностраннойОрганизации +// см. ОрганизацииСервер.РегистрационныеДанныеИндивидуальногоПредпринимателя +// см. ОрганизацииСервер.РегистрационныеДанныеРуководителяОрганизации +// см. ОрганизацииСервер.КонтактнаяИнформацияРуководителяОрганизации +// см. ОрганизацииСервер.РегистрационныеДанныеГлавногоБухгалтера +// см. ОрганизацииСервер.КонтактнаяИнформацияГлавногоБухгалтера +// см. ОрганизацииСервер.РегистрационныеДанныеУполномоченногоПредставителя. +// +// Пример: +// СведенияОбОрганизации = ОрганизацииСервер.СведенияОбОрганизации(Организация); +// +Функция СведенияОбОрганизации(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.СведенияОбОрганизации(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## РегистрационныеДанныеОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о регистрационной информации организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхОрганизации). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// Возвращаемое значение: +// Структура - содержит значения затребованных полей: +// * ДатаРегистрации - Дата - дата регистрации юридического лица. +// * ИНН - Строка - ИНН организации. +// * КодНалоговогоОргана - Строка - код налогового органа. +// * КодОКВЭД - Строка - код ОКВЭД. +// * КодОКВЭД2 - Строка - код ОКВЭД2. +// * КодОКФС - Строка - код ОКФС. +// * КодПоОКАТО - Строка - код по ОКАТО. +// * КодПоОКТМО - Строка - код по ОКТМО. +// * КПП - Строка - КПП организации. +// * НаименованиеНалоговогоОргана - Строка - наименование налогового органа. +// * НаименованиеОКВЭД - Строка - наименование ОКВЭД. +// * НаименованиеОКВЭД2 - Строка - наименование ОКВЭД2. +// * НаименованиеПолное - Строка - полное наименование. +// * НаименованиеСокращенное - Строка - сокращенное наименование. +// * ОГРН - Строка - ОГРН. +// * ПризнакНалогоплательщикаКатегория - Строка - признак налогоплательщика категория. +// * ПризнакНалогоплательщикаКод - Число - признак налогоплательщика код. +// * РегистрационныйНомерПФР - Строка - регистрационный номер ПФР. +// * РегистрационныйНомерТФОМС - Строка - регистрационный номер ТФОМС. +// * СвидетельствоДатаВыдачи - Дата - дата выдачи свидетельства. +// * СвидетельствоКодОргана - Строка - код органа выдавшего свидетельство. +// * СвидетельствоНаименованиеОргана - Строка - наименование органа выдавшего свидетельство. +// * СвидетельствоСерияНомер - Строка - серия и номер свидетельства. +// * СтавкаНалогаНаПрибыльМестный - Число - местная ставка налога на прибыль. +// * СтавкаНалогаНаПрибыльСубъектРФ - Число - ставка налога на прибыль субъекта РФ. +// * СтавкаНалогаНаПрибыльФБ - Число - ставка налога на прибыль федерального бюджета. +// * СтавкаНалогаУСН - Число - ставка налога УСН. +// * ЭтоФизическоеЛицо - Булево - признак что это физическое лицо. +// * ЭтоЮридическоеЛицо - Булево - признак что это юридическое лицо. +// * ВАрхиве - Булево - признак неактуальной организации. +// +Функция РегистрационныеДанныеОрганизации(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.РегистрационныеДанныеОрганизации(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## ДополнительныеСведенияОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о дополнительной информации организации. Заполнять только в случае, если организация +// является юридическим лицом (не ИП). +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииДополнительныхСведенийОрганизации). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит значения затребованных полей: +// * АдресЭлектроннойПочтыОрганизации - Строка - email организации. +// * АдресОрганизацииФакт - Строка - адрес организации. +// * АдресОрганизацииФактXML - Строка - адрес организации xml. +// * АдресОрганизацииФактJSON - Строка - адрес организации json. +// * АдресИностраннойОрганизации - Строка - адрес иностранной организации. +// * АдресИностраннойОрганизацииXML - Строка - адрес иностранной организации. +// * АдресИностраннойОрганизацииJSON - Строка - адрес иностранной организации. +// * ВидПлательщикаСтраховыхВзносов - Строка - вид плательщика страховых взносов. +// * ГоловнаяОрганизацияКПП - Строка - КПП головная организация. +// * ГоловнаяОрганизацияНаименование - Строка - наименование головной организации. +// * ДатаПереходаНаУСН - Дата - дата перехода на УСН. +// * ДолжностьОтправителя - Строка - должность отправителя. +// * КодОКОНХ - Строка - код ОКОНХ. +// * КодОрганаПФР - Строка - код органа ПФР. +// * КодОрганаФСГС - Строка - код органа ФСГС. +// * КодПодчиненностиФСС - Строка - код подчиненности ФСС. +// * КодПодчиненностиФССДобрСтрах - Строка - код подчиненности ФСС добр. страх. +// * НаименованиеТерриториальногоОрганаФСС - Строка - наименование территориального органа ФСС. +// * ОбъектНалогообложенияУСН - Число - объект налогообложения УСН. +// * ОтветственноеЛицоСтатистикаФИО - Строка - ФИО ответственного лица за статистическую отчетность. +// * ОтветственноеЛицоСтатистикаДолжность - Строка - должность ответственного лица за статистическую отчетность. +// * ОтветственноеЛицоСтатистикаТелефон - Строка - телефон ответственного лица за статистическую отчетность. +// * ОтветственноеЛицоСтатистикаАдресЭлектроннойПочты - Строка - email ответственного лица за статистическую отчетность. +// * ПочтовыйАдресОрганизации - Строка - почтовый адрес организации. +// * ПочтовыйАдресОрганизацииXML - Строка - почтовый адрес организации в формате xml. +// * ПочтовыйАдресОрганизацииJSON - Строка - почтовый адрес организации в формате json. +// * РегистрационныйНомерФСС - Строка - регистрационный номер ФСС. +// * СведенияОбИсполнителеДолжность - Строка - должность исполнителя. +// * СведенияОбИсполнителеТелефон - Строка - телефон исполнителя. +// * СведенияОбИсполнителеФИО - Строка - ФИО. +// * БухгалтерИмя - Строка - имя бухгалтера. +// * БухгалтерОтчество - Строка - отчество бухгалтера. +// * БухгалтерФамилия - Строка - фамилия бухгалтера. +// * БухгалтерАдресЭлектроннойПочты - Строка - адрес электронной почты бухгалтера. +// * РуководительДолжность - Строка - должность руководителя. +// * РуководительИмя - Строка - имя руководителя. +// * РуководительОтчество - Строка - отчество руководителя. +// * РуководительФамилия - Строка - фамилия руководителя. +// * РуководительАдресЭлектроннойПочты - Строка - адрес электронной почты руководителя. +// * СистемыНалогообложения - Строка - система налогообложения. +// * СтраховойТариф - Число - страховой тариф. +// * ТелефонОрганизации - Строка - телефон организации. +// * ФаксОрганизации - Строка - факс организации. +// * ШифрСтрахователяФСС - Строка - шифр страхователя ФСС. +// * ЭмблемаОрганизацииДляШтампаЭлектроннойПодписи - Картинка - эмблема организации для штампа электронной +// подписи согласно ГОСТ Р 7.0.97-2016. +// +Функция ДополнительныеСведенияОрганизации(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.ДополнительныеСведенияОрганизации(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## КонтактнаяИнформацияОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о контактной информации организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииОрганизации). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит значения затребованных полей: +// * АдресОрганизации - Строка - адрес организации. +// * АдресОрганизацииXML - Строка - адрес организации xml. +// * АдресОрганизацииJSON - Строка - адрес организации json. +// * АдресОрганизацииГород - Строка - город. +// * АдресОрганизацииДом - Строка - дом. +// * АдресОрганизацииИндекс - Строка - индекс. +// * АдресОрганизацииКвартира - Строка - квартира. +// * АдресОрганизацииКодРегиона - Строка - код региона. +// * АдресОрганизацииКорпус - Строка - корпус. +// * АдресОрганизацииНаселенныйПункт - Строка - населенный пункт. +// * АдресОрганизацииРайон - Строка - район. +// * АдресОрганизацииРегион - Строка - регион. +// * АдресОрганизацииУлица - Строка - улица. +// +Функция КонтактнаяИнформацияОрганизации(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.КонтактнаяИнформацияОрганизации(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## БанковскийСчетОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о банковском счете организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииБанковскогоСчетаОрганизации). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит значения затребованных полей: +// * БанковскийСчетБанк - Строка - банк. +// * БанковскийСчетБИК - Строка - БИК. +// * БанковскийСчетКоррСчет - Строка - корреспондентский счет. +// * БанковскийСчетНомерСчета - Строка - номер счета. +// +Функция БанковскийСчетОрганизации(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.БанковскийСчетОрганизации(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## ИспользуетсяАрхив +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если есть неактуальные организации. +// Проверка выполняется по наличию реквизита ВАрхиве у справочника Организации. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользуетсяАрхив() Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.ИспользуетсяАрхив() +``` +
+ +## РегистрационныеДанныеОбособленногоПодразделения +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о регистрационной информации обособленного подразделения. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхОбособленногоПодразделения). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * КППОбособленногоПодразделения - Строка - КПП обособленного подразделения. +// * НаименованиеОбособленногоПодразделенияПолное - Строка - наименование обособленного подразделения. +// +Функция РегистрационныеДанныеОбособленногоПодразделения(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.РегистрационныеДанныеОбособленногоПодразделения(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## КонтактнаяИнформацияОбособленногоПодразделения +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о контактной информации обособленного подразделения. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииОбособленногоПодразделения). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * АдресОбособленногоПодразделения - Строка - адрес обособленного подразделения. +// * АдресОбособленногоПодразделенияXML - Строка - адрес обособленного подразделения в xml. +// * АдресОбособленногоПодразделенияJSON - Строка - адрес обособленного подразделения в json. +// * АдресОбособленногоПодразделенияГород - Строка - город. +// * АдресОбособленногоПодразделенияДом - Строка - дом. +// * АдресОбособленногоПодразделенияИндекс - Строка - индекс. +// * АдресОбособленногоПодразделенияКвартира - Строка - квартира. +// * АдресОбособленногоПодразделенияКодРегиона - Строка - регион. +// * АдресОбособленногоПодразделенияКорпус - Строка - корпус. +// * АдресОбособленногоПодразделенияНаселенныйПункт - Строка - населенный пункт. +// * АдресОбособленногоПодразделенияРайон - Строка - район. +// * АдресОбособленногоПодразделенияРегион - Строка - регион. +// * АдресОбособленногоПодразделенияУлица - Строка - улица. +// +Функция КонтактнаяИнформацияОбособленногоПодразделения(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.КонтактнаяИнформацияОбособленногоПодразделения(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## РегистрационныеДанныеОтделенияИностраннойОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о регистрационной информации иностранной организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхОбособленногоПодразделения). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * ОтделениеИностраннойОрганизацииИНН - Строка - ИНН отделения иностранной организации. +// * ОтделениеИностраннойОрганизацииКПП - Строка - КПП отделения иностранной организации. +// * ОтделениеИностраннойОрганизацииНаименование - Строка - наименование. +// +Функция РегистрационныеДанныеОтделенияИностраннойОрганизации(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.РегистрационныеДанныеОтделенияИностраннойОрганизации(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## КонтактнаяИнформацияОтделенияИностраннойОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о контактной информации иностранной организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииИностраннойОрганизации). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * ОтделениеИностраннойОрганизацииАдресРФ - Строка - адрес иностранной организации. +// * ОтделениеИностраннойОрганизацииАдресРФXML - Строка - адрес иностранной организации. +// * ОтделениеИностраннойОрганизацииАдресРФJSON - Строка - адрес иностранной организации. +// * ОтделениеИностраннойОрганизацииАдресРФГород - Строка - город. +// * ОтделениеИностраннойОрганизацииАдресРФДом - Строка - дом. +// * ОтделениеИностраннойОрганизацииАдресРФИндекс - Строка - индекс. +// * ОтделениеИностраннойОрганизацииАдресРФКвартира - Строка - квартира. +// * ОтделениеИностраннойОрганизацииАдресРФКодРегиона - Строка - код региона. +// * ОтделениеИностраннойОрганизацииАдресРФКорпус - Строка - корпус. +// * ОтделениеИностраннойОрганизацииАдресРФНаселенныйПункт - Строка - населенный пункт. +// * ОтделениеИностраннойОрганизацииАдресРФРайон - Строка - район. +// * ОтделениеИностраннойОрганизацииАдресРФРегион - Строка - регион. +// * ОтделениеИностраннойОрганизацииАдресРФУлица - Строка - улица. +// +Функция КонтактнаяИнформацияОтделенияИностраннойОрганизации(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.КонтактнаяИнформацияОтделенияИностраннойОрганизации(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## РегистрационныеДанныеИндивидуальногоПредпринимателя +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о регистрационной информации ИП. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхИндивидуальногоПредпринимателя). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * ИПВидДокументаУдостоверенияЛичности - Строка - вид документа ИП. +// * ИПГражданствоКод - Строка - гражданство ИП. +// * ИПГражданствоНаименование - Строка - гражданство наименование. +// * ИПДатаВыдачиУдостоверенияЛичности - Дата - дата выдачи удостоверения личности. +// * ИПДатаРождения - Дата - дата рождения. +// * ИндивидуальныйПредпринимательИНН - Строка - ИНН индивидуального предпринимателя. +// * ИПНаименование - Строка - наименование. +// * ИПКемВыданУдостоверенияЛичности - Строка - кем выдано удостоверение личности. +// * ИПКодПодразделенияУдостоверенияЛичности - Строка - код подразделения удостоверение личности. +// * ИПКодУдостоверенияЛичности - Строка - код удостоверения личности. +// * ИПМестоРождения - Строка - место рождения. +// * ИПНомерУдостоверенияЛичности - Строка - номер удостоверения личности. +// * ИПРегистрационныйНомерПФР - Строка - регистрационный номер ПФР. +// * ИПРегистрационныйНомерТФОМС - Строка - регистрационный номер ТФОМС. +// * ИПАдресЭлектроннойПочты - Строка - адрес электронной почты индивидуального предпринимателя. +// * ФизическоеЛицоПол - Число - пол: 1 - Мужской, 2 - Женский. +// * ИПСерияУдостоверенияЛичности - Строка - серия удостоверения личности. +// * ИндивидуальныйПредпринимательСНИЛС - Строка - СНИЛС. +// * ФизическоеЛицоНаименование - Строка - наименование физлица. +// * ЭтоИП - Булево - признак, что это индивидуальный предприниматель. +// +Функция РегистрационныеДанныеИндивидуальногоПредпринимателя(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.РегистрационныеДанныеИндивидуальногоПредпринимателя(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## КонтактнаяИнформацияИндивидуальногоПредпринимателя +
+ +Описание, пример вызова + +```bsl + + +// Возвращает структуру, содержащую сведения о контактной информации ИП. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииИндивидуальногоПредпринимателя). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * АдресМестаЖительства - Строка - адрес места жительства. +// * АдресМестаЖительстваXML - Строка - адрес места жительства в формате xml. +// * АдресМестаЖительстваJSON - Строка - адрес места жительства в формате json. +// * АдресРегистрации - Строка - адрес регистрации. +// * АдресРегистрацииXML - Строка - адрес регистрации xml. +// * АдресРегистрацииJSON - Строка - адрес регистрации json. +// * ГородМестаЖительства - Строка - город. +// * ДомашнийТелефонФизЛица - Строка - телефон. +// * ДомМестаЖительства - Строка - дом. +// * ИндексМестаЖительства - Строка - индекс. +// * КвартираМестаЖительства - Строка - квартира. +// * КодРегионаМестаЖительства - Строка - код региона. +// * КорпусМестаЖительства - Строка - корпус. +// * НаселенныйПунктМестаЖительства - Строка - населенный пункт. +// * РайонМестаЖительства - Строка - район места жительства. +// * РегионМестаЖительства - Строка - регион. +// * ТелефонОрганизации - Строка - телефон организации. +// * УлицаМестаЖительства - Строка - улица. +// +Функция КонтактнаяИнформацияИндивидуальногоПредпринимателя(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.КонтактнаяИнформацияИндивидуальногоПредпринимателя(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## РегистрационныеДанныеРуководителяОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о регистрационной информации руководителя организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхРуководителяОрганизации). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * РуководительГражданствоКод - Строка - код гражданства. +// * РуководительГражданствоНаименование - Строка - наименование гражданства. +// * РуководительДатаРождения - Дата - дата рождения. +// * РуководительИНН - Строка - ИНН. +// * РуководительМестоРождения - Строка - место рождения. +// * РуководительПол - Строка - пол. +// * РуководительТелефон - Строка - телефон. +// * РуководительУдостоверениеЛичностиВидДокумента - Строка - вид документа. +// * РуководительУдостоверениеЛичностиДатаВыдачи - Дата - дата выдачи. +// * РуководительУдостоверениеЛичностиКемВыдан - Строка - кем выдан. +// * РуководительУдостоверениеЛичностиКод - Строка - код. +// * РуководительУдостоверениеЛичностиКодПодразделения - Строка - код подразделения. +// * РуководительУдостоверениеЛичностиНомер - Строка - номер. +// * РуководительУдостоверениеЛичностиСерия - Строка - серия. +// * РуководительФИО - Строка - ФИО. +// +Функция РегистрационныеДанныеРуководителяОрганизации(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.РегистрационныеДанныеРуководителяОрганизации(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## КонтактнаяИнформацияРуководителяОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о контактной информации руководителя организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииРуководителяОрганизации). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * РуководительАдресМестаЖительства - Строка - адрес. +// * РуководительАдресМестаЖительстваXML - Строка - адрес xml. +// * РуководительАдресМестаЖительстваJSON - Строка - адрес json. +// * РуководительАдресМестаЖительстваГород - Строка - город. +// * РуководительАдресМестаЖительстваДом - Строка - дом. +// * РуководительАдресМестаЖительстваИндекс - Строка - индекс. +// * РуководительАдресМестаЖительстваКвартира - Строка - квартира. +// * РуководительАдресМестаЖительстваКодРегиона - Строка - код региона. +// * РуководительАдресМестаЖительстваКорпус - Строка - корпус. +// * РуководительАдресМестаЖительстваНаселенныйПункт - Строка - населенный пункт. +// * РуководительАдресМестаЖительстваРайон - Строка - район. +// * РуководительАдресМестаЖительстваРегион - Строка - регион. +// * РуководительАдресМестаЖительстваУлица - Строка - улица. +// +Функция КонтактнаяИнформацияРуководителяОрганизации(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.КонтактнаяИнформацияРуководителяОрганизации(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## РегистрационныеДанныеГлавногоБухгалтера +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о регистрационной информации главного бухгалтера организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхГлавногоБухгалтера). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * БухгалтерГражданствоКод - Строка - код гражданства бухгалтера. +// * БухгалтерГражданствоНаименование - Строка - наименование гражданства бухгалтера. +// * БухгалтерГражданствоУполномоченногоПредставителя - Строка - гражданство уполномоченного представителя. +// * БухгалтерДатаРождения - Строка - дата рождения. +// * БухгалтерИНН - Строка - ИНН. +// * БухгалтерМестоРождения - Строка - место рождения. +// * БухгалтерПол - Строка - пол. +// * БухгалтерПолУполномоченногоПредставителя - Строка - пол уполномоченного представителя. +// * БухгалтерТелефон - Строка - телефон. +// * БухгалтерУдостоверениеЛичностиВидДокумента - Строка - вид документа. +// * БухгалтерУдостоверениеЛичностиДатаВыдачи - Строка - дата выдачи. +// * БухгалтерУдостоверениеЛичностиКемВыдан - Строка - кем выдан. +// * БухгалтерУдостоверениеЛичностиКод - Строка - код. +// * БухгалтерУдостоверениеЛичностиКодПодразделения - Строка - код подразделения. +// * БухгалтерУдостоверениеЛичностиНомер - Строка - номер. +// * БухгалтерУдостоверениеЛичностиСерия - Строка - серия. +// * БухгалтерУполномоченномПредставителеГражданствоНаименование - Строка - наименование гражданства +// уполномоченного представителя. +// * БухгалтерФИО - Строка - ФИО. +// +Функция РегистрационныеДанныеГлавногоБухгалтера(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.РегистрационныеДанныеГлавногоБухгалтера(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## КонтактнаяИнформацияГлавногоБухгалтера +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о контактной информации главного бухгалтера организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииГлавногоБухгалтера). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * БухгалтерАдресМестаЖительства - Строка - адрес. +// * БухгалтерАдресМестаЖительстваXML - Строка - адрес xml. +// * БухгалтерАдресМестаЖительстваJSON - Строка - адрес json. +// * БухгалтерАдресМестаЖительстваГород - Строка - город. +// * БухгалтерАдресМестаЖительстваДом - Строка - дом. +// * БухгалтерАдресМестаЖительстваИндекс - Строка - индекс. +// * БухгалтерАдресМестаЖительстваКвартира - Строка - квартира. +// * БухгалтерАдресМестаЖительстваКодРегиона - Строка - код региона. +// * БухгалтерАдресМестаЖительстваКорпус - Строка - корпус. +// * БухгалтерАдресМестаЖительстваНаселенныйПункт - Строка - населенный пункт. +// * БухгалтерАдресМестаЖительстваРайон - Строка - район. +// * БухгалтерАдресМестаЖительстваРегион - Строка - регион. +// * БухгалтерАдресМестаЖительстваУлица - Строка - улица. +// +Функция КонтактнаяИнформацияГлавногоБухгалтера(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.КонтактнаяИнформацияГлавногоБухгалтера(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## РегистрационныеДанныеУполномоченногоПредставителя +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о регистрационной информации уполномоченного представителя организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииРегистрационныхДанныхУполномоченногоПредставителя). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * УполномоченныйПредставительДатаРождения - Строка - дата рождения. +// * УполномоченныйПредставительИНН - Строка - ИНН. +// * УполномоченныйПредставительТелефон - Строка - телефон. +// * УполномоченныйПредставительУдостоверениеЛичностиВидДокумента - Строка - вид документа. +// * УполномоченныйПредставительУдостоверениеЛичностиДата - Дата - дата. +// * УполномоченныйПредставительУдостоверениеЛичностиКемВыдан - Строка - кем выдан. +// * УполномоченныйПредставительУдостоверениеЛичностиКод - Строка - код. +// * УполномоченныйПредставительУдостоверениеЛичностиНомер - Строка - номер. +// * УполномоченныйПредставительУдостоверениеЛичностиСерия - Строка - серия. +// * УполномоченныйПредставительФИО - Строка - ФИО. +// +Функция РегистрационныеДанныеУполномоченногоПредставителя(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.РегистрационныеДанныеУполномоченногоПредставителя(Организация, Поля, Дата, КодЯзыка); +``` +
+ +## КонтактнаяИнформацияУполномоченногоПредставителя +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, содержащую сведения о контактной информации уполномоченного представителя организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, сведения по которой необходимо получить. +// Поля - Строка - имена полей, перечисленные через запятую, в формате требований к свойствам структуры. +// Список допустимых имен полей см. в описании возвращаемого значения (это максимально возможный список +// полей, конечный состав определяется в ОрганизацииПереопределяемый.ПриОпределенииКонтактнойИнформацииУполномоченногоПредставителя). +// Если указана пустая строка, то возвращаются значения всех полей. +// Дата - Дата +// - Неопределено - дата, на которую требуется получить данные. Если значение не указано, +// то возвращается значение на текущую дату. +// КодЯзыка - см. СведенияОбОрганизации.КодЯзыка +// +// Возвращаемое значение: +// Структура - содержит имена (ключи) и значения затребованных полей: +// * УполномоченныйПредставительАдресМестаЖительстваНаселенныйПункт - Строка - населенный пункт. +// * УполномоченныйПредставительАдресМестаЖительства - Строка - адрес. +// * УполномоченныйПредставительАдресМестаЖительстваXML - Строка - адрес xml. +// * УполномоченныйПредставительАдресМестаЖительстваJSON - Строка - адрес json. +// * УполномоченныйПредставительАдресМестаЖительстваГород - Строка - город. +// * УполномоченныйПредставительАдресМестаЖительстваДом - Строка - дом. +// * УполномоченныйПредставительАдресМестаЖительстваИндекс - Строка - индекс. +// * УполномоченныйПредставительАдресМестаЖительстваКвартира - Строка - квартира. +// * УполномоченныйПредставительАдресМестаЖительстваКод - Строка - код. +// * УполномоченныйПредставительАдресМестаЖительстваКорпус - Строка - корпус. +// * УполномоченныйПредставительАдресМестаЖительстваРайон - Строка - район. +// * УполномоченныйПредставительАдресМестаЖительстваРегион - Строка - регион. +// * УполномоченныйПредставительАдресМестаЖительстваУлица - Строка - улица. +// * УполномоченныйПредставительМестоРождения - Строка - место рождения. +// +Функция КонтактнаяИнформацияУполномоченногоПредставителя(Знач Организация, Знач Поля = "", Знач Дата = Неопределено, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОрганизацииСервер.КонтактнаяИнформацияУполномоченногоПредставителя(Организация, Поля, Дата, КодЯзыка); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОтправкаSMS.md b/src/content/docs/bsp/ОтправкаSMS.md new file mode 100644 index 0000000..502fdc2 --- /dev/null +++ b/src/content/docs/bsp/ОтправкаSMS.md @@ -0,0 +1,118 @@ +--- +title: Отправка sm s +slug: bsp/отправка-sm-s +--- + + +## ОтправитьSMS +
+ +Описание, пример вызова + +```bsl + +// Отправляет SMS через настроенного поставщика услуги, возвращает идентификатор сообщения. +// +// Параметры: +// НомераПолучателей - Массив из Строка - номера получателей в формате +7ХХХХХХХХХХ; +// Текст - Строка - текст сообщения, максимальная длина у операторов может быть разной; +// ИмяОтправителя - Строка - имя отправителя, которое будет отображаться вместо номера у получателей; +// ПеревестиВТранслит - Булево - Истина, если требуется переводить текст сообщения в транслит перед отправкой. +// +// Возвращаемое значение: +// Структура: +// * ОтправленныеСообщения - Массив из Структура: +// ** НомерПолучателя - Строка - номер получателя SMS. +// ** ИдентификаторСообщения - Строка - идентификатор SMS, присвоенный провайдером для отслеживания доставки. +// * ОписаниеОшибки - Строка - пользовательское представление ошибки, если пустая строка, то ошибки нет. +// +Функция ОтправитьSMS(НомераПолучателей, Знач Текст, ИмяОтправителя = Неопределено, ПеревестиВТранслит = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтправкаSMS.ОтправитьSMS(НомераПолучателей, Текст, ИмяОтправителя, ПеревестиВТранслит); +``` +
+ +## СтатусДоставки +
+ +Описание, пример вызова + +```bsl + +// Запрашивает статус доставки сообщения у поставщика услуг. +// +// Параметры: +// ИдентификаторСообщения - Строка - идентификатор, присвоенный SMS при отправке; +// +// Возвращаемое значение: +// Строка - статус доставки сообщения, который вернул поставщик услуг: +// "НеОтправлялось" - сообщение еще не было обработано поставщиком услуг (в очереди); +// "Отправляется" - сообщение стоит в очереди на отправку у провайдера; +// "Отправлено" - сообщение отправлено, ожидается подтверждение о доставке; +// "НеОтправлено" - сообщение не отправлено (недостаточно средств на счете, перегружена сеть оператора); +// "Доставлено" - сообщение доставлено адресату; +// "НеДоставлено" - сообщение не удалось доставить (абонент недоступен, время ожидания подтверждения +// доставки от абонента истекло); +// "Ошибка" - не удалось получить статус у поставщика услуг (статус неизвестен). +// +Функция СтатусДоставки(Знач ИдентификаторСообщения) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтправкаSMS.СтатусДоставки(ИдентификаторСообщения) +``` +
+ +## НастройкаОтправкиSMSВыполнена +
+ +Описание, пример вызова + +```bsl + +// Проверяет правильность сохраненных настроек отправки SMS. +// +// Возвращаемое значение: +// Булево - Истина, если отправка SMS уже настроена. +// +Функция НастройкаОтправкиSMSВыполнена() Экспорт +``` + +Пример вызова +```bsl +Результат = ОтправкаSMS.НастройкаОтправкиSMSВыполнена() +``` +
+ +## ДоступнаОтправкаSMS +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность отправки SMS для текущего пользователя. +// +// Возвращаемое значение: +// Булево - Истина, если отправка SMS настроена и у текущего пользователя достаточно прав для отправки SMS. +// +Функция ДоступнаОтправкаSMS() Экспорт +``` + +Пример вызова +```bsl +Результат = ОтправкаSMS.ДоступнаОтправкаSMS() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОтправкаSMSКлиент.md b/src/content/docs/bsp/ОтправкаSMSКлиент.md new file mode 100644 index 0000000..ea92f7c --- /dev/null +++ b/src/content/docs/bsp/ОтправкаSMSКлиент.md @@ -0,0 +1,64 @@ +--- +title: Отправка sms клиент +slug: bsp/отправка-sms-клиент +--- + + +## ОтправитьSMS +
+ +Описание, пример вызова + +```bsl + +// Открывает форму для отправки нового SMS. +// +// Параметры: +// НомераПолучателей - Массив из Структура: +// * Телефон - Строка - номер получателя в формате +<КодСтраны><КодDEF><номер>; +// * Представление - Строка - представление номера телефона; +// * ИсточникКонтактнойИнформации - СправочникСсылка - владелец номера телефона. +// +// Текст - Строка - текст сообщения, длиной не более 1000 символов. +// +// ДополнительныеПараметры - Структура - дополнительные параметры отправки SMS: +// * ИмяОтправителя - Строка - имя отправителя, которое будет отображаться вместо номера у получателей; +// * ПеревестиВТранслит - Булево - Истина, если требуется переводить текст сообщения в транслит перед отправкой. +// +Процедура ОтправитьSMS(НомераПолучателей, Текст, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ОтправкаSMSКлиент.ОтправитьSMS(НомераПолучателей, Текст, ДополнительныеПараметры) +``` +
+ +## ОткрытьФормуНастроек +
+ +Описание, пример вызова + +```bsl + +// Открывает форму настроек отправки SMS. +// +// Параметры: +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - процедура, которую нужно выполнить после закрытия формы настроек. +// +Процедура ОткрытьФормуНастроек(ОписаниеОповещенияОЗакрытии = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОтправкаSMSКлиент.ОткрытьФормуНастроек(ОписаниеОповещенияОЗакрытии); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОтправкаSMSКлиентПереопределяемый.md b/src/content/docs/bsp/ОтправкаSMSКлиентПереопределяемый.md new file mode 100644 index 0000000..8bf2631 --- /dev/null +++ b/src/content/docs/bsp/ОтправкаSMSКлиентПереопределяемый.md @@ -0,0 +1,67 @@ +--- +title: Отправка sms клиент переопределяемый +slug: bsp/отправка-sms-клиент-переопределяемый +--- + + +## ПриОтправкеSMS +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед открытием формы отправки SMS. +// +// Параметры: +// НомераПолучателей - Массив из Структура: +// * Телефон - Строка - номер получателя в формате +<КодСтраны><КодDEF><номер>; +// * Представление - Строка - представление номера телефона; +// * ИсточникКонтактнойИнформации - СправочникСсылка - владелец номера телефона. +// +// Текст - Строка - текст сообщения, длиной не более 1000 символов. +// +// ДополнительныеПараметры - Структура - дополнительные параметры отправки SMS: +// * ИмяОтправителя - Строка - имя отправителя, которое будет отображаться вместо номера у получателей; +// * ПеревестиВТранслит - Булево - Истина, если требуется переводить текст сообщения в транслит перед отправкой. +// +// СтандартнаяОбработка - Булево - флаг необходимости выполнения стандартной обработки отправки SMS. +// +Процедура ПриОтправкеSMS(НомераПолучателей, Текст, ДополнительныеПараметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОтправкаSMSКлиентПереопределяемый.ПриОтправкеSMS(НомераПолучателей, Текст, ДополнительныеПараметры, СтандартнаяОбработка) +``` +
+ +## ПриПолученииАдресаПровайдераВИнтернете +
+ +Описание, пример вызова + +```bsl + +// Определяет адрес страницы провайдера в сети Интернет. +// +// Параметры: +// Провайдер - ПеречислениеСсылка.ПровайдерыSMS - поставщик услуги по отправке SMS. +// АдресВИнтернете - Строка - адрес страницы провайдера в Интернете. +// +Процедура ПриПолученииАдресаПровайдераВИнтернете(Провайдер, АдресВИнтернете) Экспорт +``` + +Пример вызова +```bsl +ОтправкаSMSКлиентПереопределяемый.ПриПолученииАдресаПровайдераВИнтернете(Провайдер, АдресВИнтернете) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОтправкаSMSПереопределяемый.md b/src/content/docs/bsp/ОтправкаSMSПереопределяемый.md new file mode 100644 index 0000000..23da2f1 --- /dev/null +++ b/src/content/docs/bsp/ОтправкаSMSПереопределяемый.md @@ -0,0 +1,118 @@ +--- +title: Отправка sms переопределяемый +slug: bsp/отправка-sms-переопределяемый +--- + + +## ОтправитьSMS +
+ +Описание, пример вызова + +```bsl + +// Отправляет SMS через настроенного поставщика услуги. +// +// Параметры: +// ПараметрыОтправки - Структура: +// * Провайдер - ПеречислениеСсылка.ПровайдерыSMS - поставщик услуги по отправке SMS. +// * НомераПолучателей - Массив - массив строк номеров получателей в формате +7ХХХХХХХХХХ; +// * Текст - Строка - текст сообщения, максимальная длина у операторов может быть разной; +// * ИмяОтправителя - Строка - имя отправителя, которое будет отображаться вместо номера у получателей; +// * Логин - Строка - логин для доступа к услуге отправки SMS; +// * Пароль - Строка - пароль для доступа к услуге отправки SMS. +// +// Результат - Структура - возвращаемое значение. Результат отправки: +// * ОтправленныеСообщения - Массив из Структура: +// ** НомерПолучателя - Строка - номер получателя из массива НомераПолучателей; +// ** ИдентификаторСообщения - Строка - идентификатор SMS, по которому можно запросить статус отправки. +// ОписаниеОшибки - Строка - пользовательское представление ошибки, если пустая строка, то ошибки нет. +// +Процедура ОтправитьSMS(ПараметрыОтправки, Результат) Экспорт +``` + +Пример вызова +```bsl +ОтправкаSMSПереопределяемый.ОтправитьSMS(ПараметрыОтправки, Результат) +``` +
+ +## СтатусДоставки +
+ +Описание, пример вызова + +```bsl + +// Запрашивает статус доставки SMS у поставщика услуг. +// +// Параметры: +// ИдентификаторСообщения - Строка - идентификатор, присвоенный SMS при отправке. +// Провайдер - ПеречислениеСсылка.ПровайдерыSMS - провайдер услуги отправки SMS. +// Логин - Строка - логин для доступа к услуге отправки SMS. +// Пароль - Строка - пароль для доступа к услуге отправки SMS. +// Результат - см. ОтправкаSMS.СтатусДоставки. +// +Процедура СтатусДоставки(ИдентификаторСообщения, Провайдер, Логин, Пароль, Результат) Экспорт +``` + +Пример вызова +```bsl +ОтправкаSMSПереопределяемый.СтатусДоставки(ИдентификаторСообщения, Провайдер, Логин, Пароль, Результат) +``` +
+ +## ПриПроверкеНастроекОтправкиSMS +
+ +Описание, пример вызова + +```bsl + +// Проверяет правильность сохраненных настроек отправки SMS. +// +// Параметры: +// НастройкиОтправкиSMS - Структура - описание текущих настроек отправки SMS: +// * Провайдер - ПеречислениеСсылка.ПровайдерыSMS +// * Логин - Строка +// * Пароль - Строка +// * ИмяОтправителя - Строка +// Отказ - Булево - установить этот параметр в Истина, если настройки не заполнены или заполнены неверно. +// +Процедура ПриПроверкеНастроекОтправкиSMS(НастройкиОтправкиSMS, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОтправкаSMSПереопределяемый.ПриПроверкеНастроекОтправкиSMS(НастройкиОтправкиSMS, Отказ) +``` +
+ +## ПриПолученииРазрешений +
+ +Описание, пример вызова + +```bsl + +// Дополняет список разрешений для отправки SMS. +// +// Параметры: +// Разрешения - Массив - массив объектов, возвращаемых одной из функций РаботаВБезопасномРежиме.Разрешение*(). +// +Процедура ПриПолученииРазрешений(Разрешения) Экспорт +``` + +Пример вызова +```bsl +ОтправкаSMSПереопределяемый.ПриПолученииРазрешений(Разрешения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОтчетОДвиженияхДокументаПереопределяемый.md b/src/content/docs/bsp/ОтчетОДвиженияхДокументаПереопределяемый.md new file mode 100644 index 0000000..18efb9c --- /dev/null +++ b/src/content/docs/bsp/ОтчетОДвиженияхДокументаПереопределяемый.md @@ -0,0 +1,84 @@ +--- +title: Отчет о движениях документа переопределяемый +slug: bsp/отчет-о-движениях-документа-переопределяемый +--- + + +## ПриОпределенииРегистровСДвижениями +
+ +Описание, пример вызова + +```bsl + +// Позволяет дополнить регистры с движениями документа дополнительными регистрами. +// +// Параметры: +// Документ - ДокументСсылка - документ коллекцию движений которого необходимо дополнить. +// РегистрыСДвижениями - Соответствие из КлючИЗначение: +// * Ключ - ОбъектМетаданных - регистр как объект метаданных. +// * Значение - Строка - имя поля регистратора. +// +Процедура ПриОпределенииРегистровСДвижениями(Документ, РегистрыСДвижениями) Экспорт +``` + +Пример вызова +```bsl +ОтчетОДвиженияхДокументаПереопределяемый.ПриОпределенииРегистровСДвижениями(Документ, РегистрыСДвижениями) +``` +
+ +## ПриРасчетеКоличестваЗаписей +
+ +Описание, пример вызова + +```bsl + +// Позволяет рассчитать количество записей для дополнительных наборов, добавленных процедурой +// ПриОпределенииРегистровСДвижениями. +// +// Параметры: +// Документ - ДокументСсылка - документ коллекцию движений которого необходимо дополнить. +// РассчитанноеКоличество - Соответствие из КлючИЗначение: +// * Ключ - Строка - полное имя регистра (вместо точек используется символ подчеркивания). +// * Значение - Число - рассчитанное количество записей. +// +Процедура ПриРасчетеКоличестваЗаписей(Документ, РассчитанноеКоличество) Экспорт +``` + +Пример вызова +```bsl +ОтчетОДвиженияхДокументаПереопределяемый.ПриРасчетеКоличестваЗаписей(Документ, РассчитанноеКоличество) +``` +
+ +## ПриПодготовкеНабораДанных +
+ +Описание, пример вызова + +```bsl + +// Позволяет дополнить или переопределить коллекцию наборов данных для вывода движений документа. +// +// Параметры: +// Документ - ДокументСсылка - документ, коллекцию движений которого необходимо дополнить. +// НаборыДанных - Массив - сведения о наборах данных (тип элемента Структура). +// +Процедура ПриПодготовкеНабораДанных(Документ, НаборыДанных) Экспорт +``` + +Пример вызова +```bsl +ОтчетОДвиженияхДокументаПереопределяемый.ПриПодготовкеНабораДанных(Документ, НаборыДанных) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОтчетыКлиент.md b/src/content/docs/bsp/ОтчетыКлиент.md new file mode 100644 index 0000000..9c587ee --- /dev/null +++ b/src/content/docs/bsp/ОтчетыКлиент.md @@ -0,0 +1,38 @@ +--- +title: Отчеты клиент +slug: bsp/отчеты-клиент +--- + + +## СформироватьОтчет +
+ +Описание, пример вызова + +```bsl + +// Запускает процесс формирования отчета в форме отчета. +// После завершения формирования вызывается ОбработчикЗавершения. +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения - форма отчета. +// ОбработчикЗавершения - ОписаниеОповещения - обработчик, который будет вызван после формирования отчета. +// В 1-й параметр процедуры, указанной в ОбработчикЗавершения, +// передается параметр: ОтчетСформирован (Булево) - признак того, что отчет был успешно сформирован. +// +Процедура СформироватьОтчет(ФормаОтчета, ОбработчикЗавершения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОтчетыКлиент.СформироватьОтчет(ФормаОтчета, ОбработчикЗавершения); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОтчетыКлиентПереопределяемый.md b/src/content/docs/bsp/ОтчетыКлиентПереопределяемый.md new file mode 100644 index 0000000..e1f9d85 --- /dev/null +++ b/src/content/docs/bsp/ОтчетыКлиентПереопределяемый.md @@ -0,0 +1,281 @@ +--- +title: Отчеты клиент переопределяемый +slug: bsp/отчеты-клиент-переопределяемый +--- + + +## ПослеФормирования +
+ +Описание, пример вызова + +```bsl + +// Возникает после окончания формирования отчета: после завершения фонового задания. +// Позволяет переопределить обработку результата формирования отчета. +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета - форма отчета: +// * Отчет - ОтчетОбъект - структура данных формы аналогичная объекту отчета. +// +// ОтчетСформирован - Булево - Истина если отчет был успешно сформирован. +// +Процедура ПослеФормирования(ФормаОтчета, ОтчетСформирован) Экспорт +``` + +Пример вызова +```bsl +ОтчетыКлиентПереопределяемый.ПослеФормирования(ФормаОтчета, ОтчетСформирован) +``` +
+ +## ОбработкаРасшифровки +
+ +Описание, пример вызова + +```bsl + +// Обработчик расшифровки табличного документа формы отчета. +// См. "Расширение поля формы для поля табличного документа.ОбработкаРасшифровки" в синтакс-помощнике. +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета - форма отчета: +// * Отчет - ОтчетОбъект - структура данных формы аналогичная объекту отчета. +// +// Элемент - ПолеФормы - табличный документ. +// Расшифровка - Произвольный - значение расшифровки точки, серии или значения диаграммы. +// СтандартнаяОбработка - Булево - признак выполнения стандартной (системной) обработки события. +// +Процедура ОбработкаРасшифровки(ФормаОтчета, Элемент, Расшифровка, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОтчетыКлиентПереопределяемый.ОбработкаРасшифровки(ФормаОтчета, Элемент, Расшифровка, СтандартнаяОбработка) +``` +
+ +## ОбработкаДополнительнойРасшифровки +
+ +Описание, пример вызова + +```bsl + +// Обработчик дополнительной расшифровки (меню табличного документа формы отчета). +// См. "Расширение поля формы для поля табличного документа.ОбработкаДополнительнойРасшифровки" в синтакс-помощнике. +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета - форма отчета: +// * Отчет - ОтчетОбъект - структура данных формы аналогичная объекту отчета. +// +// Элемент - ПолеФормы - табличный документ. +// Расшифровка - Произвольный - значение расшифровки точки, серии или значения диаграммы. +// СтандартнаяОбработка - Булево - признак выполнения стандартной (системной) обработки события. +// +Процедура ОбработкаДополнительнойРасшифровки(ФормаОтчета, Элемент, Расшифровка, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОтчетыКлиентПереопределяемый.ОбработкаДополнительнойРасшифровки(ФормаОтчета, Элемент, Расшифровка, СтандартнаяОбработка) +``` +
+ +## ОбработчикКоманды +
+ +Описание, пример вызова + +```bsl + +// Обработчик команд, добавленных динамически и подключенных к обработчику "Подключаемый_Команда". +// Пример добавления команды см. ОтчетыПереопределяемый.ПриСозданииНаСервере(). +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета - форма отчета: +// * Отчет - ОтчетОбъект - структура данных формы аналогичная объекту отчета. +// +// Команда - КомандаФормы - команда, которая была вызвана. +// Результат - Булево - Истина, если вызов команды обработан. +// +Процедура ОбработчикКоманды(ФормаОтчета, Команда, Результат) Экспорт +``` + +Пример вызова +```bsl +ОтчетыКлиентПереопределяемый.ОбработчикКоманды(ФормаОтчета, Команда, Результат) +``` +
+ +## ПриНачалеВыбораЗначений +
+ +Описание, пример вызова + +```bsl + +// Обработчик переопределения параметров или формы выбора значений. +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета - форма отчета: +// * Отчет - ОтчетОбъект - структура данных формы аналогичная объекту отчета. +// +// УсловияВыбора - Структура: +// * ИмяПоля - Строка - имя параметра или поля элемента компоновки данных. +// * ЭлементКомпоновки - ДоступныйПараметрКомпоновкиДанных +// - ДоступноеПолеОтбораКомпоновкиДанных - элемент выбора. +// * ДоступныеТипы - ОписаниеТипов - типы доступные для выбора. +// * Отмеченные - СписокЗначений - значения выбранные ранее. +// * ПараметрыВыбора - Массив из ПараметрВыбора - настроенные параметры выбора. +// +// ОповещениеОЗакрытии - ОписаниеОповещения - оповещение о результате выбора. Вызывается +// после выбора с результатом типа Массив или СписокЗначений. +// +// СтандартнаяОбработка - Булево - если указать Ложь, то стандартная форма не будет открыта, +// в этом случае нужно открыть свою форму и выполнить ОповещениеОЗакрытии. +// +Процедура ПриНачалеВыбораЗначений(ФормаОтчета, УсловияВыбора, ОповещениеОЗакрытии, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОтчетыКлиентПереопределяемый.ПриНачалеВыбораЗначений(ФормаОтчета, УсловияВыбора, ОповещениеОЗакрытии, СтандартнаяОбработка) +``` +
+ +## ОбработкаВыбора +
+ +Описание, пример вызова + +```bsl + +// Обработчик результата выбора подчиненной формы. +// См. "ФормаКлиентскогоПриложения.ОбработкаВыбора" в синтакс-помощнике. +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета - форма отчета: +// * Отчет - ОтчетОбъект - структура данных формы аналогичная объекту отчета. +// +// ВыбранноеЗначение - Произвольный - результат выбора в подчиненной форме. +// ИсточникВыбора - ФормаКлиентскогоПриложения - форма, где осуществлен выбор. +// Результат - Булево - Истина, если результат выбора обработан. +// +Процедура ОбработкаВыбора(ФормаОтчета, ВыбранноеЗначение, ИсточникВыбора, Результат) Экспорт +``` + +Пример вызова +```bsl +ОтчетыКлиентПереопределяемый.ОбработкаВыбора(ФормаОтчета, ВыбранноеЗначение, ИсточникВыбора, Результат) +``` +
+ +## ОбработкаВыбораТабличногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Обработчик двойного щелчка мыши, нажатия клавиши Enter или гиперссылки в табличном документе формы отчета. +// См. "Расширение поля формы для поля табличного документа.Выбор" в синтакс-помощнике. +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета - форма отчета: +// * Отчет - ОтчетОбъект - структура данных формы аналогичная объекту отчета. +// +// Элемент - ПолеФормы - табличный документ. +// Область - ОбластьЯчеекТабличногоДокумента - выбранное значение. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// +Процедура ОбработкаВыбораТабличногоДокумента(ФормаОтчета, Элемент, Область, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОтчетыКлиентПереопределяемый.ОбработкаВыбораТабличногоДокумента(ФормаОтчета, Элемент, Область, СтандартнаяОбработка) +``` +
+ +## ОбработкаОповещения +
+ +Описание, пример вызова + +```bsl + +// Обработчик широковещательного оповещения формы отчета. +// См. "ФормаКлиентскогоПриложения.ОбработкаОповещения" в синтакс-помощнике. +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета - форма отчета: +// * Отчет - ОтчетОбъект - структура данных формы аналогичная объекту отчета. +// +// ИмяСобытия - Строка - идентификатор события для принимающих форм. +// Параметр - Произвольный - расширенная информация о событии. +// Источник - ФормаКлиентскогоПриложения +// - Произвольный - источник события. +// ОповещениеОбработано - Булево - признак того, что событие обработано. +// +Процедура ОбработкаОповещения(ФормаОтчета, ИмяСобытия, Параметр, Источник, ОповещениеОбработано) Экспорт +``` + +Пример вызова +```bsl +ОтчетыКлиентПереопределяемый.ОбработкаОповещения(ФормаОтчета, ИмяСобытия, Параметр, Источник, ОповещениеОбработано) +``` +
+ +## ПриНажатииКнопкиВыбораПериода +
+ +Описание, пример вызова + +```bsl + +// Обработчик нажатия на кнопку выбора периода в отдельной форме. +// Если в конфигурации используется собственный диалог выбора периода, +// тогда параметр СтандартнаяОбработка следует установить в Ложь, +// а выбранный период следует вернуть в ОбработчикРезультата. +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета - форма отчета: +// * Отчет - ОтчетОбъект - структура данных формы аналогичная объекту отчета. +// +// Период - СтандартныйПериод - значение настройки компоновщика, соответствующей выбранному периоду. +// +// СтандартнаяОбработка - Булево - если Истина, то будет использован стандартный диалог выбора периода. +// Если установить в Ложь то стандартный диалог не откроется. +// +// ОбработчикРезультата - ОписаниеОповещения - обработчик результата выбора периода. +// В качестве результата в ОбработчикРезультата могут быть переданы значения типов: +// Неопределено - пользователь отказался от ввода периода. +// СтандартныйПериод - выбранный период. +// +Процедура ПриНажатииКнопкиВыбораПериода(ФормаОтчета, Период, СтандартнаяОбработка, ОбработчикРезультата) Экспорт +``` + +Пример вызова +```bsl +ОтчетыКлиентПереопределяемый.ПриНажатииКнопкиВыбораПериода(ФормаОтчета, Период, СтандартнаяОбработка, ОбработчикРезультата) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОтчетыКлиентСервер.md b/src/content/docs/bsp/ОтчетыКлиентСервер.md new file mode 100644 index 0000000..e117c23 --- /dev/null +++ b/src/content/docs/bsp/ОтчетыКлиентСервер.md @@ -0,0 +1,280 @@ +--- +title: Отчеты клиент сервер +slug: bsp/отчеты-клиент-сервер +--- + + +## НастройкиОтчетаПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Дополнительные настройки отчета по умолчанию, определяющие: +// * Признак формирования отчета при открытии; +// * Подключаемые обработчики событий; +// * Настройки печати; +// * Использование функции расчетных показателей; +// * Права. +// +// Возвращаемое значение: +// Структура - настройки (дополнительные свойства) отчета, хранящиеся в данных формы: +// +// * ФормироватьСразу - Булево - значение по умолчанию для флажка "Формировать сразу". +// Когда флажок включен, то отчет будет формироваться после открытия, +// после выбора пользовательских настроек, после выбора другого варианта отчета. +// +// * ВыводитьСуммуВыделенныхЯчеек - Булево - если Истина, то в отчете будет выводиться поле автосуммы. +// +// * РазрешеноИзменятьСтруктуру - Булево - если Ложь, то в настройках отчета будет скрыта вкладка "Структура". +// Если Истина, то вкладка "Структура" показывается для отчетов на СКД: в расширенном режиме, +// а также в простом режиме, если в пользовательские настройки выведены флажки использования группировок. +// +// * РазрешеноИзменятьВарианты - Булево - если Ложь, то блокируются кнопки изменения вариантов этого отчета. +// Если у текущего пользователя нет прав "СохранениеДанныхПользователя" и "Добавление" +// справочника ВариантыОтчетов, то принудительно устанавливается в Ложь. +// +// * РазрешеноВыбиратьИНастраиватьВариантыБезСохранения - Булево - если Истина, +// то есть возможность выбора и настройки предопределенных вариантов отчета, но без возможности сохранения +// выполненных настроек. Например, может быть задано для контекстных отчетов (открываемых с параметрами), +// у которых есть несколько вариантов. +// +// * ПараметрыРасположенияЭлементовУправления - Структура +// - Неопределено - варианты: +// - Неопределено - параметры элементов управления общей формы отчетов "по умолчанию". +// - Структура - с именами настройки в коллекции НастройкиКомпоновкиДанных свойства Настройки +// типа КомпоновщикНастроекКомпоновкиДанных: +// ** Отбор - Массив - как у следующего свойства. +// ** ПараметрыДанных - Структура - со свойствами поля формы: +// *** Поле - Строка - имя поля, отображение которого настраивается. +// *** РастягиватьПоГоризонтали - Булево - значение свойства поля формы. +// *** АвтоМаксимальнаяШирина - Булево - значение свойства поля формы. +// *** Ширина - Число - значение свойства поля формы. +// +// Пример определения описываемого параметра: +// +// МассивНастроек = Новый Массив; +// НастройкиЭлементаУправления = Новый Структура; +// НастройкиЭлементаУправления.Вставить("Поле", "СписокРегистров"); +// НастройкиЭлементаУправления.Вставить("РастягиватьПоГоризонтали", Ложь); +// НастройкиЭлементаУправления.Вставить("АвтоМаксимальнаяШирина", Истина); +// НастройкиЭлементаУправления.Вставить("Ширина", 40); +// +// МассивНастроек.Добавить(НастройкиЭлементаУправления); +// +// НастройкиЭлементовУправления = Новый Структура(); +// НастройкиЭлементовУправления.Вставить("ПараметрыДанных", МассивНастроек); +// +// Возврат НастройкиЭлементовУправления; +// +// * ЗагрузитьНастройкиПриИзмененииПараметров - Массив - коллекция параметров компоновки данных, +// изменение которых, приводит к переформированию +// Схемы компоновки данных. +// +// // Пример: +// // 1. Инициализация: +// // Процедура ОпределитьНастройкиФормы(Форма, КлючВарианта, Настройки) Экспорт +// // Настройки.ЗагрузитьНастройкиПриИзмененииПараметров = Отчеты.УниверсальныйОтчет.ЗагрузитьНастройкиПриИзмененииПараметров(); +// // КонецПроцедуры +// +// // Функция ЗагрузитьНастройкиПриИзмененииПараметров() Экспорт +// // Параметры = Новый Массив; +// // Параметры.Добавить(Новый ПараметрКомпоновкиДанных("ТипОбъектаМетаданных")); +// // Параметры.Добавить(Новый ПараметрКомпоновкиДанных("ИмяОбъектаМетаданных")); +// // Параметры.Добавить(Новый ПараметрКомпоновкиДанных("ИмяТаблицы")); +// // +// // Возврат Параметры; +// // КонецФункции +// +// // 2. Использование: +// // Процедура Подключаемый_ЭлементНастройки_ПриИзменении(Элемент) +// // ... +// // Если ТипЗнч(ЭлементПользовательскойНастройки) = Тип("ЗначениеПараметраНастроекКомпоновкиДанных") +// // И НастройкиОтчета.ЗагрузитьНастройкиПриИзмененииПараметров.Найти(ЭлементПользовательскойНастройки.Параметр) <> Неопределено Тогда +// // // Вызов метода переформирования Схемы компоновки данных... +// // КонецЕсли; +// +// * ПоляПоиска - Массив из Строка - коллекция имен полей компоновки данных, которые участвуют в универсальном поиске. +// * ВариантПредставленияПериода - ПеречислениеСсылка.ВариантыПредставленияПериода - определяет вариант +// представления периода на форме отчета. +// * ВариантПериода - ПеречислениеСсылка.ВариантыПериода - определяет вариант формы выбора периода. +// * ОтключитьСтандартноеКонтекстноеМеню - Булево - признак, позволяющий выключить использование +// контекстного меню и настройки колонки отчета. +// * СкрытьКомандыРассылки - Булево - флаг, позволяющий скрыть команды рассылок, у тех отчетов, +// для которых рассылка не имеет смысла. +// * Печать - Структура - параметры печати табличного документа "по умолчанию": +// ** ПолеСверху - Число - отступ сверху при печати (в миллиметрах). +// ** ПолеСлева - Число - отступ слева при печати (в миллиметрах). +// ** ПолеСнизу - Число - отступ снизу при печати (в миллиметрах). +// ** ПолеСправа - Число - отступ справа при печати (в миллиметрах). +// ** ОриентацияСтраницы - ориентацияСтраницы - "Портрет" или "Ландшафт". +// ** АвтоМасштаб - Булево - автоматически подгонять масштаб под размер страницы. +// ** МасштабПечати - Число - масштаб изображения (в процентах). +// * События - Структура - события, для которых определены обработчики в модуле объекта отчета: +// ** ПриСозданииНаСервере - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // См. ОтчетыПереопределяемый.ПриСозданииНаСервере. +// Процедура ПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) Экспорт +// +// КонецПроцедуры +// +// ** ПередЗагрузкойНастроекВКомпоновщик - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // Параметры: +// // Контекст - Произвольный +// // КлючСхемы - Строка +// // КлючВарианта - Строка, Неопределено +// // НовыеНастройкиКД - НастройкиКомпоновкиДанных, Неопределено +// // НовыеПользовательскиеНастройкиКД - ПользовательскиеНастройкиКомпоновкиДанных, Неопределено +// // +// Процедура ПередЗагрузкойНастроекВКомпоновщик(Контекст, КлючСхемы, КлючВарианта, НовыеНастройкиКД, +// НовыеПользовательскиеНастройкиКД) Экспорт +// +// КонецПроцедуры +// +// ** ПослеЗагрузкиНастроекВКомпоновщик - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // Параметры: +// // ДополнительныеПараметры - Структура +// // +// Процедура ПослеЗагрузкиНастроекВКомпоновщик(ДополнительныеПараметры) Экспорт +// +// КонецПроцедуры +// +// ** ПередЗагрузкойВариантаНаСервере - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // См. ОтчетыПереопределяемый.ПередЗагрузкойВариантаНаСервере. +// Процедура ПередЗагрузкойВариантаНаСервере(Форма, НовыеНастройкиКД) Экспорт +// +// КонецПроцедуры +// +// ** ПриЗагрузкеВариантаНаСервере - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // Параметры: +// // Форма - ФормаКлиентскогоПриложения +// // - РасширениеУправляемойФормыДляОтчета: +// // * Отчет - ДанныеФормыСтруктура +// // - ОтчетОбъект +// // НовыеНастройкиКД - НастройкиКомпоновкиДанных +// // +// Процедура ПриЗагрузкеВариантаНаСервере(Форма, НовыеНастройкиКД) Экспорт +// +// КонецПроцедуры +// +// ** ПриЗагрузкеПользовательскихНастроекНаСервере - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // Параметры: +// // Форма - ФормаКлиентскогоПриложения +// // НовыеПользовательскиеНастройкиКД - ПользовательскиеНастройкиКомпоновкиДанных +// // +// Процедура ПриЗагрузкеПользовательскихНастроекНаСервере(Форма, НовыеПользовательскиеНастройкиКД) Экспорт +// +// КонецПроцедуры +// +// ** ПередЗаполнениемПанелиБыстрыхНастроек - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // Параметры: +// // Форма - ФормаКлиентскогоПриложения +// // ПараметрыЗаполнения - Структура +// // +// Процедура ПередЗаполнениемПанелиБыстрыхНастроек(Форма, ПараметрыЗаполнения) Экспорт +// +// КонецПроцедуры +// +// ** ПослеЗаполненияПанелиБыстрыхНастроек - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // Параметры: +// // Форма - ФормаКлиентскогоПриложения +// // ПараметрыЗаполнения - Структура +// // +// Процедура ПослеЗаполненияПанелиБыстрыхНастроек(Форма, ПараметрыЗаполнения) Экспорт +// +// КонецПроцедуры +// +// ** ПриОпределенииПараметровВыбора - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // См. ОтчетыПереопределяемый.ПриОпределенииПараметровВыбора. +// Процедура ПриОпределенииПараметровВыбора(Форма, СвойстваНастройки) Экспорт +// +// КонецПроцедуры +// +// ** ПриОпределенииИспользуемыхТаблиц - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // Параметры: +// // КлючВарианта - Строка, Неопределено +// // ИспользуемыеТаблицы - Массив из Строка +// // +// Процедура ПриОпределенииИспользуемыхТаблиц(КлючВарианта, ИспользуемыеТаблицы) Экспорт +// +// КонецПроцедуры +// +// ** ПриОпределенииОсновныхПолей - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // См. ОтчетыПереопределяемый.ПриОпределенииОсновныхПолей. +// Процедура ПриОпределенииОсновныхПолей(Форма, ОсновныеПоля) Экспорт +// +// КонецПроцедуры +// +// ** ПередФормированиемОтчета - Булево - если Истина, то в модуле объекта отчета +// следует определить обработчик события по шаблону: +// +// // Параметры: +// // ФормаОтчета - ФормаКлиентскогоПриложения +// // ДополнительныеПараметры - Структура: +// // * ТекстПредупреждения - Строка +// // * ИмяПараметраХраненияОтказаОтПредупреждения - Строка +// // +// Процедура Процедура ПередФормированиемОтчета(ФормаОтчета, ДополнительныеПараметры) Экспорт +// +// КонецПроцедуры +// +Функция НастройкиОтчетаПоУмолчанию() Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию() +``` +
+ +## ПолучитьНастройкиОтчетаПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию. +// Настройки формы отчета по умолчанию. +// +// Возвращаемое значение: +// Структура: +// +Функция ПолучитьНастройкиОтчетаПоУмолчанию() Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыКлиентСервер.ПолучитьНастройкиОтчетаПоУмолчанию() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОтчетыПереопределяемый.md b/src/content/docs/bsp/ОтчетыПереопределяемый.md new file mode 100644 index 0000000..f772284 --- /dev/null +++ b/src/content/docs/bsp/ОтчетыПереопределяемый.md @@ -0,0 +1,154 @@ +--- +title: Отчеты переопределяемый +slug: bsp/отчеты-переопределяемый +--- + + +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается в обработчике одноименного события формы отчета после выполнения кода формы. +// См. "ФормаКлиентскогоПриложения.ПриСозданииНаСервере" в синтакс-помощнике и ОтчетыКлиентПереопределяемый.ОбработчикКоманды. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма отчета. +// - РасширениеУправляемойФормыДляОтчета +// - Структура: +// * НастройкиОтчета - см. ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию +// Отказ - Булево - признак отказа от создания формы. +// СтандартнаяОбработка - Булево - признак выполнения стандартной (системной) обработки события. +// +// Пример: +// //Добавление команды с обработчиком в ОтчетыКлиентПереопределяемый.ОбработчикКоманды: +// Команда = ФормаОтчета.Команды.Добавить("МояОсобеннаяКоманда"); +// Команда.Действие = "Подключаемый_Команда"; +// Команда.Заголовок = НСтр("ru = 'Моя команда...'"); +// +// Кнопка = ФормаОтчета.Элементы.Добавить(Команда.Имя, Тип("КнопкаФормы"), ФормаОтчета.Элементы.<ИмяПодменю>); +// Кнопка.ИмяКоманды = Команда.Имя; +// +// ФормаОтчета.ПостоянныеКоманды.Добавить(КомандаСоздать.Имя); +// +Процедура ПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОтчетыПереопределяемый.ПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) +``` +
+ +## ПередЗагрузкойВариантаНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается в обработчике одноименного события формы отчета и формы настройки отчета. +// См. "Расширение управляемой формы для отчета.ПередЗагрузкойВариантаНаСервере" в синтакс-помощнике. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма отчета или настроек отчета. +// НовыеНастройкиКД - НастройкиКомпоновкиДанных - настройки для загрузки в компоновщик настроек. +// +Процедура ПередЗагрузкойВариантаНаСервере(Форма, НовыеНастройкиКД) Экспорт +``` + +Пример вызова +```bsl +ОтчетыПереопределяемый.ПередЗагрузкойВариантаНаСервере(Форма, НовыеНастройкиКД) +``` +
+ +## ПриОпределенииПараметровВыбора +
+ +Описание, пример вызова + +```bsl + +// Вызывается в форме отчета и в форме настройки отчета перед выводом настройки +// для указания дополнительных параметров выбора. +// Это устаревшее событие, вместо него рекомендуется применять событие ПослеЗагрузкиНастроекВКомпоновщик модуля отчета. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета +// - Неопределено - форма отчета. +// СвойстваНастройки - Структура - описание настройки отчета, которая будет выведена в форме отчета, где: +// * ПолеКД - ПолеКомпоновкиДанных - выводимая настройка. +// * ОписаниеТипов - ОписаниеТипов - тип выводимой настройки. +// * ЗначенияДляВыбора - СписокЗначений - указать объекты, которые будут предложены пользователю в списке выбора. +// Дополняет список объектов, уже выбранных пользователем ранее. +// При этом не следует присваивать в этот параметр новый список значений. +// * ЗапросЗначенийВыбора - Запрос - указать запрос для выборки объектов, которыми необходимо дополнить +// ЗначенияДляВыбора. Первой колонкой (с индексом 0) должен выбираться объект, +// который следует добавить в ЗначенияДляВыбора.Значение. +// Для отключения автозаполнения в свойство ЗапросЗначенийВыбора.Текст следует записать +// пустую строку. +// * ОграничиватьВыборУказаннымиЗначениями - Булево - указать Истина, чтобы ограничить выбор пользователя +// значениями, указанными в ЗначенияДляВыбора (его конечным состоянием). +// * Тип - Строка. +// +// Пример: +// 1. Для всех настроек типа СправочникСсылка.Пользователи скрыть и не разрешать выбирать помеченных на удаление, +// недействительных и служебных пользователей. +// +// Если СвойстваНастройки.ОписаниеТипов.СодержитТип(Тип("СправочникСсылка.Пользователи")) Тогда +// СвойстваНастройки.ОграничиватьВыборУказаннымиЗначениями = Истина; +// СвойстваНастройки.ЗначенияДляВыбора.Очистить(); +// СвойстваНастройки.ЗапросЗначенийВыбора.Текст = +// "ВЫБРАТЬ Ссылка ИЗ Справочник.Пользователи +// |ГДЕ НЕ ПометкаУдаления И НЕ Недействителен И НЕ Служебный"; +// КонецЕсли; +// +// 2. Для настройки "Размер" предусмотреть дополнительное значение для выбора. +// +// Если СвойстваНастройки.ПолеКД = Новый ПолеКомпоновкиДанных("ПараметрыДанных.Размер") Тогда +// СвойстваНастройки.ЗначенияДляВыбора.Добавить(10000000, НСтр("ru = 'Больше 10 Мб'")); +// КонецЕсли; +// +Процедура ПриОпределенииПараметровВыбора(Форма, СвойстваНастройки) Экспорт +``` + +Пример вызова +```bsl +ОтчетыПереопределяемый.ПриОпределенииПараметровВыбора(Форма, СвойстваНастройки) +``` +
+ +## ПриОпределенииОсновныхПолей +
+ +Описание, пример вызова + +```bsl + +// Позволяет задать список часто используемых полей, которые будут выводиться в подменю для команд контекстного меню +// "Вставить поле слева", "Вставить группировку ниже" и т.п. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма отчета. +// ОсновныеПоля - Массив из Строка - имена часто используемых полей отчета. +// +Процедура ПриОпределенииОсновныхПолей(Форма, ОсновныеПоля) Экспорт +``` + +Пример вызова +```bsl +ОтчетыПереопределяемый.ПриОпределенииОсновныхПолей(Форма, ОсновныеПоля) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОтчетыСервер.md b/src/content/docs/bsp/ОтчетыСервер.md new file mode 100644 index 0000000..73c6b96 --- /dev/null +++ b/src/content/docs/bsp/ОтчетыСервер.md @@ -0,0 +1,1003 @@ +--- +title: Отчеты сервер +slug: bsp/отчеты-сервер +--- + + +## ПодключитьСхему +
+ +Описание, пример вызова + +```bsl + +// Устанавливает отчету переданную схему и на основании нее, инициализирует компоновщик настроек. +// Если контекстом является форма отчета (настроек), то обновляет основной реквизит формы - Отчет. +// В результате, контекст объекта и формы отчета синхронизируются. +// Вызывается например, из обработчика ПередЗагрузкойНастроекВКомпоновщик объекта универсального отчета +// для установки схемы, программно сформированной на основании другого объекта метаданных. +// +// Параметры: +// Отчет - ОтчетОбъект +// - ВнешнийОтчет - СКД-отчет, которому необходимо установить схему. +// Контекст - ФормаКлиентскогоПриложения - форма отчета или форма настройки отчета. +// Передается "как есть" из одноименного параметра события ПередЗагрузкойНастроекВКомпоновщик. +// - Структура: +// * СсылкаОтчета - Произвольный - ссылка отчета. +// * ПолноеИмя - Строка - полное имя отчета. +// * Метаданные - ОбъектМетаданных - метаданные отчета. +// * Объект - ОтчетОбъект +// - ВнешнийОтчет - объект отчета: +// ** КомпоновщикНастроек - КомпоновщикНастроекКомпоновкиДанных - настройки отчета. +// ** СхемаКомпоновкиДанных - СхемаКомпоновкиДанных - схема отчета. +// * КлючВарианта - Строка - имя предопределенного или идентификатор пользовательского варианта отчета. +// * АдресСхемы - Строка - адрес временного хранилища, по которому размещена схема отчета. +// * Успех - Булево - Истина, если удалось подключить отчет. +// * ТекстОшибки - Строка - текст ошибки. +// +// +// Схема - СхемаКомпоновкиДанных - схема, которую необходимо установить отчету. +// КлючСхемы - Строка - идентификатор новой схемы, который будет записан в дополнительные свойства +// пользовательских настроек. +// +// Пример: +// // В обработчике объекта отчета ПередЗагрузкойНастроекВКомпоновщик компоновщик настроек +// // инициализируется на основании схемы из общих макетов: +// Если КлючСхемы <> "1" Тогда +// КлючСхемы = "1"; +// Схема = ПолучитьОбщийМакет("МояОбщаяСхемаКомпоновки"); +// ОтчетыСервер.ПодключитьСхему(ЭтотОбъект, Контекст, Схема, КлючСхемы); +// КонецЕсли; +// +Процедура ПодключитьСхему(Отчет, Контекст, Схема, КлючСхемы) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ПодключитьСхему(Отчет, Контекст, Схема, КлючСхемы) +``` +
+ +## ИнициализироватьКомпоновщикНастроек +
+ +Описание, пример вызова + +```bsl + +// Инициализирует компоновщик настроек компоновки данных, с обработкой исключения. +// +// Параметры: +// КомпоновщикНастроек - КомпоновщикНастроекКомпоновкиДанных - компоновщик настроек, который необходимо инициализировать. +// Схема - СхемаКомпоновкиДанных +// - Строка. +// Отчет - ОтчетОбъект +// - Неопределено - отчет, чей компоновщик инициализируется. +// ВариантОтчета - СправочникСсылка.ВариантыОтчетов +// - Неопределено - хранилище варианта отчета. +// +Процедура ИнициализироватьКомпоновщикНастроек(КомпоновщикНастроек, Схема, Отчет = Неопределено, ВариантОтчета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ИнициализироватьКомпоновщикНастроек(КомпоновщикНастроек, Схема, Отчет, ВариантОтчета); +``` +
+ +## ВывестиКоманду +
+ +Описание, пример вызова + +```bsl + +// Выводит команду в форму отчета в виде кнопки в указанную группу. +// Также регистрирует команду, защищая ее от удаления при перерисовке формы. +// Для вызова из события ПриСозданииНаСервере формы отчета. +// +// Параметры: +// ФормаОтчета - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета - форма, где: +// * ПостоянныеРеквизиты - СписокЗначений +// * ПостоянныеКоманды - СписокЗначений +// КомандаИлиКоманды - КомандаФормы - команда, с которой будут связаны выводимые кнопки. +// Если в свойстве Действие указана пустая строка, +// то при выполнении команды будет вызвана процедура ОтчетыКлиентПереопределяемый.ОбработчикКоманды. +// Если в свойстве Действие указана строка вида "<ИмяКлиентскогоОбщегоМодуля>.<ИмяЭкспортнойПроцедуры>", +// то при выполнении команды в указанном модуле будет вызвана указанная процедура с двумя параметрами, +// аналогичным двум первым параметрам процедуры ОтчетыКлиентПереопределяемый.ОбработчикКоманды. +// - Массив - набор команд (КомандаФормы), которые будут выведены в указанную группу. +// ТипГруппы - Строка - условное имя группы, в которой требуется вывести кнопку. +// "Главное" - группа с кнопками "Сформировать" и "Формировать сразу". +// "Настройки" - группа с кнопками "Настройки", "Изменить вариант отчета" и т.п. +// "РаботаСТабличнымДокументом" - группа с кнопками "Найти", "Развернуть все группы" и т.п. +// "Интеграция" - группа такими кнопками как "Печать, Сохранить, Отправить" и т.п. +// "ПодменюОтправить" - подменю в группе "Интеграция" для отправки по почте. +// "Прочее" - группа с кнопками "Изменить форму", "Справка" и т.п. +// ВНачалоГруппы - Булево - если Истина, то кнопка будет выведена в начале группы. Иначе в конце группы. +// ТолькоВоВсехДействиях - Булево - если Истина, то кнопка будет выведена только в подменю "Еще". +// Иначе и в подменю "Еще", и в командной панели формы. +// СуффиксПодгруппы - Строка - если заполнен, то команды будут объединены в подгруппу. +// СуффиксПодгруппы добавляется к имени группы справа. +// +Процедура ВывестиКоманду(ФормаОтчета, КомандаИлиКоманды, ТипГруппы, ВНачалоГруппы = Ложь, ТолькоВоВсехДействиях = Ложь, СуффиксПодгруппы = "") Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ВывестиКоманду(ФормаОтчета, КомандаИлиКоманды, ТипГруппы, ВНачалоГруппы, ТолькоВоВсехДействиях, СуффиксПодгруппы); +``` +
+ +## ВывестиГиперссылку +
+ +Описание, пример вызова + +```bsl + +// Оформляет ячейку в виде гиперссылки и заполняет поля адреса и представления ссылки. +// +// Параметры: +// Ячейка - ОбластьЯчеекТабличногоДокумента - область табличного документа. +// АдресСсылки - Строка - адрес ссылки, которую необходимо вывести в указанной ячейке. +// В стандартной форме отчета автоматически открываются ссылки следующих форматов: +// "HTTP://<адрес>", "https://<адрес>", "e1cib/<адрес>", "e1c://<адрес>" +// Такие ссылки открываются при помощи процедуры ОбщегоНазначенияКлиент.ОткрытьНавигационнуюСсылку. +// См. также ПредставлениеНавигационнойСсылки.НавигационнаяСсылка в синтакс-помощнике. +// Для открытия ссылок других форматов следует написать код +// в процедуре ОтчетыКлиентПереопределяемый.ОбработкаВыбораТабличногоДокумента. +// ПредставлениеСсылки - Строка +// - Неопределено - наименование, которую необходимо вывести в указанной ячейке. +// Если Неопределено, то выводится как есть АдресСсылки. +// +Процедура ВывестиГиперссылку(Ячейка, АдресСсылки, ПредставлениеСсылки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ВывестиГиперссылку(Ячейка, АдресСсылки, ПредставлениеСсылки); +``` +
+ +## ОтчетПустой +
+ +Описание, пример вызова + +```bsl + +// Определяет, что отчет пустой. +// +// Параметры: +// ОтчетОбъект - ОтчетОбъект +// - ВнешнийОтчет - проверяемый отчет. +// ПроцессорКД - ПроцессорКомпоновкиДанных - объект, выполняющий компоновку данных в отчете. +// +// Возвращаемое значение: +// Булево - Истина, если отчет пустой. Ложь, если отчет содержит данные. +// +Функция ОтчетПустой(ОтчетОбъект, ПроцессорКД = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ОтчетПустой(ОтчетОбъект, ПроцессорКД); +``` +
+ +## СвойстваЭлементовФормыНастроек +
+ +Описание, пример вызова + +```bsl + +// Возвращает коллекцию свойств элементов формы отчета (настроек отчета), связанные с настройками, +// которые доступны для переопределения в модуле объекта отчета. +// +// Параметры: +// ТипФормы - ТипФормыОтчета +// КомпоновщикНастроек - КомпоновщикНастроекКомпоновкиДанных +// ДополнительныеПараметры - см. ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию +// +// Возвращаемое значение: +// Структура: +// * Группы - см. СвойстваГруппыЭлементовФормы +// * Поля - ТаблицаЗначений: +// ** ИндексНастройки - Число +// ** ИдентификаторНастройки - Строка +// ** Настройки - НастройкиКомпоновкиДанных +// ** ЭлементНастройки - ЭлементОтбораКомпоновкиДанных +// - ЗначениеПараметраНастроекКомпоновкиДанных +// - ВыбранноеПолеКомпоновкиДанных +// - ЭлементПорядкаКомпоновкиДанных +// - ЭлементУсловногоОформления +// ** ОписаниеНастройки - ДоступноеПолеОтбораКомпоновкиДанных +// - ДоступныеПараметрыКомпоновкиДанных +// - ДоступноеПолеКомпоновкиДанных +// ** Представление - Строка +// ** ИдентификаторГруппы - Строка +// ** ПоложениеЗаголовка - ПоложениеЗаголовкаЭлементаФормы +// ** РастягиватьПоГоризонтали - Булево +// - Неопределено +// ** Ширина - Число +// +Функция СвойстваЭлементовФормыНастроек(ТипФормы, КомпоновщикНастроек, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.СвойстваЭлементовФормыНастроек(ТипФормы, КомпоновщикНастроек, ДополнительныеПараметры) +``` +
+ +## СвойстваГруппыЭлементовФормы +
+ +Описание, пример вызова + +```bsl + +// Конструктор свойств группы элементов формы пользовательских настроек. +// +// Возвращаемое значение: +// Структура - содержит значения свойств группы: +// * Отображение - ОтображениеОбычнойГруппы - см. Синтакс-помощник - ОтображениеОбычнойГруппы. +// * Группировка - ГруппировкаПодчиненныхЭлементовФормы - количество групп-колонок элементов: +// ** Вертикальная - ГруппировкаПодчиненныхЭлементовФормы - эквивалентно 1-ой колонке; +// ** ГоризонтальнаяЕслиВозможно - ГруппировкаПодчиненныхЭлементовФормы - эквивалентно 2-м колонкам; +// ** ГоризонтальнаяВсегда - ГруппировкаПодчиненныхЭлементовФормы - количество колонок равно количеству элементов +// в группе. +// * Заголовок - Строка - см. синтакс-помощник - ГруппаФормы.Заголовок +// * ЦветФона - Цвет - см. синтакс-помощник - ГруппаФормы.ЦветФона +// * Подсказка - Строка - см. синтакс-помощник - ГруппаФормы.Подсказка +// * ОтображениеПодсказки - ОтображениеПодсказки - см. синтакс-помощник - ГруппаФормы.ОтображениеПодсказки +// * Высота - Число - см. синтакс-помощник - ГруппаФормы.Высота +// * Ширина - Число - см. синтакс-помощник - ГруппаФормы.Ширина +// * РастягиватьПоВертикали - Неопределено, Булево - см. синтакс-помощник - ГруппаФормы.РастягиватьПоВертикали +// * РастягиватьПоГоризонтали - Неопределено, Булево - см. синтакс-помощник - ГруппаФормы.РастягиватьПоГоризонтали +// +Функция СвойстваГруппыЭлементовФормы() Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.СвойстваГруппыЭлементовФормы() +``` +
+ +## УпорядочитьЭлементыФормыНастроек +
+ +Описание, пример вызова + +```bsl + +Процедура УпорядочитьЭлементыФормыНастроек(ЭлементыНастроек, ДополнительныеСвойства) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.УпорядочитьЭлементыФормыНастроек(ЭлементыНастроек, ДополнительныеСвойства)); +``` +
+ +## РаспределитьСпискиПоКолонкамПропорционально +
+ +Описание, пример вызова + +```bsl + +Процедура РаспределитьСпискиПоКолонкамПропорционально(ЭлементыНастроек, КоличествоКолонок) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.РаспределитьСпискиПоКолонкамПропорционально(ЭлементыНастроек, КоличествоКолонок)); +``` +
+ +## РаспределитьЭлементыФормыНастроек +
+ +Описание, пример вызова + +```bsl + +Процедура РаспределитьЭлементыФормыНастроек(Форма, Знач Группа, ЭлементыНастроек) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.РаспределитьЭлементыФормыНастроек(Форма, Группа, ЭлементыНастроек)); +``` +
+ +## РаспределитьЭлементыФормыНастроекПоСвойствам +
+ +Описание, пример вызова + +```bsl + +Процедура РаспределитьЭлементыФормыНастроекПоСвойствам(Форма, Родитель, ЭлементыНастроек, НомерКолонки, НомерГруппы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.РаспределитьЭлементыФормыНастроекПоСвойствам(Форма, Родитель, ЭлементыНастроек, НомерКолонки, НомерГруппы); +``` +
+ +## ИерархияЭлементовФормыНастроек +
+ +Описание, пример вызова + +```bsl + +Функция ИерархияЭлементовФормыНастроек(Форма, Родитель, Признаки, НомерСтроки, НомерКолонки) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ИерархияЭлементовФормыНастроек(Форма, Родитель, Признаки, НомерСтроки, НомерКолонки)); +``` +
+ +## ГруппаЭлементовФормыНастроек +
+ +Описание, пример вызова + +```bsl + +Функция ГруппаЭлементовФормыНастроек(Форма, Родитель, ИмяГруппы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ГруппаЭлементовФормыНастроек(Форма, Родитель, ИмяГруппы)); +``` +
+ +## ЭтоОсновнаяФорма +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоОсновнаяФорма(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ЭтоОсновнаяФорма(Форма)); +``` +
+ +## ВывестиСтилизованныеЭлементыФормыНастроек +
+ +Описание, пример вызова + +```bsl + +// Вывод стилизованных элементов формы настроек. + +Процедура ВывестиСтилизованныеЭлементыФормыНастроек(Форма, ЭлементыНастроек, ОписаниеНастроек, ИменаРеквизитов, ВидыЭлементов) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ВывестиСтилизованныеЭлементыФормыНастроек(Форма, ЭлементыНастроек, ОписаниеНастроек, ИменаРеквизитов, ВидыЭлементов)); +``` +
+ +## РеквизитыЭлементовНастроекДобавляемые +
+ +Описание, пример вызова + +```bsl + +Функция РеквизитыЭлементовНастроекДобавляемые(ЭлементыНастроек, ВидыЭлементов, ИменаРеквизитов, ПутьКДаннымЭлементов) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.РеквизитыЭлементовНастроекДобавляемые(ЭлементыНастроек, ВидыЭлементов, ИменаРеквизитов, ПутьКДаннымЭлементов)); +``` +
+ +## РеквизитыЭлементовНастроекУдаляемые +
+ +Описание, пример вызова + +```bsl + +Функция РеквизитыЭлементовНастроекУдаляемые(ВидыЭлементов, ИменаРеквизитов, ПутьКДаннымЭлементов) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.РеквизитыЭлементовНастроекУдаляемые(ВидыЭлементов, ИменаРеквизитов, ПутьКДаннымЭлементов)); +``` +
+ +## УдалитьКомандыЭлементовНастроек +
+ +Описание, пример вызова + +```bsl + +Процедура УдалитьКомандыЭлементовНастроек(Форма, РеквизитыУдаляемые) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.УдалитьКомандыЭлементовНастроек(Форма, РеквизитыУдаляемые)); +``` +
+ +## ВывестиПериодыНастроек +
+ +Описание, пример вызова + +```bsl + +// Вывод периодов элементов формы настроек + +Процедура ВывестиПериодыНастроек(Форма, ЭлементыНастроек, ИменаРеквизитов) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ВывестиПериодыНастроек(Форма, ЭлементыНастроек, ИменаРеквизитов)); +``` +
+ +## ГруппаЭлементовПериода +
+ +Описание, пример вызова + +```bsl + +Функция ГруппаЭлементовПериода(Элементы, Родитель, СледующийЭлемент, ШаблонИмени, Заголовок) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ГруппаЭлементовПериода(Элементы, Родитель, СледующийЭлемент, ШаблонИмени, Заголовок)); +``` +
+ +## ДобавитьПолеПериода +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьПолеПериода(Элементы, Группа, ШаблонИмени, Свойство, ЗаголовокЭлементаНастройки, ЭтоСтандартноеПредставление, ВыводитьЗаголовкиПериодов) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ДобавитьПолеПериода(Элементы, Группа, ШаблонИмени, Свойство, ЗаголовокЭлементаНастройки, ЭтоСтандартноеПредставление, ВыводитьЗаголовкиПериодов)); +``` +
+ +## ЗаголовокЭлементаПериода +
+ +Описание, пример вызова + +```bsl + +Функция ЗаголовокЭлементаПериода(Свойство, ЗаголовокЭлементаНастройки, ВыводитьЗаголовкиПериодов) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ЗаголовокЭлементаПериода(Свойство, ЗаголовокЭлементаНастройки, ВыводитьЗаголовкиПериодов)); +``` +
+ +## ДобавитьКомандуСдвигаПериода +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьКомандуСдвигаПериода(Форма, Группа, ШаблонИмени, ЭтоСтандартноеПредставление, НаправлениеСдвига = 1) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ДобавитьКомандуСдвигаПериода(Форма, Группа, ШаблонИмени, ЭтоСтандартноеПредставление, НаправлениеСдвига); +``` +
+ +## ДобавитьКомандуВыбораПериода +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьКомандуВыбораПериода(Форма, Группа, ШаблонИмени, Период, ЭтоСтандартноеПредставление) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ДобавитьКомандуВыбораПериода(Форма, Группа, ШаблонИмени, Период, ЭтоСтандартноеПредставление)); +``` +
+ +## УстановитьСвойстваКнопкиВыбораПериода +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьСвойстваКнопкиВыбораПериода(ЭлементПериода, Период, ЭтоСтандартноеПредставление) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.УстановитьСвойстваКнопкиВыбораПериода(ЭлементПериода, Период, ЭтоСтандартноеПредставление)); +``` +
+ +## ИнициализироватьПериод +
+ +Описание, пример вызова + +```bsl + +// Устанавливает значения свойствам стандартного периода: ДатаНачала, ДатаОкончания +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета: +// * Элементы - ВсеЭлементыФормы +// * Отчет - ОтчетОбъект +// Индекс - Число +// +// Возвращаемое значение: +// СтандартныйПериод +// +Функция ИнициализироватьПериод(Форма, Индекс) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ИнициализироватьПериод(Форма, Индекс)); +``` +
+ +## ВывестиСпискиНастроек +
+ +Описание, пример вызова + +```bsl + +// Вывод списков элементов формы настроек + +Процедура ВывестиСпискиНастроек(Форма, ЭлементыНастроек, ОписаниеНастроек, ИменаРеквизитов) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ВывестиСпискиНастроек(Форма, ЭлементыНастроек, ОписаниеНастроек, ИменаРеквизитов)); +``` +
+ +## ДобавитьЭлементыСписка +
+ +Описание, пример вызова + +```bsl + +// Создает элементы формы типа ТаблицаФормы, ссылающиеся на реквизит типа СписокЗначений +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета: +// * Отчет - ОтчетОбъект +// ЭлементНастройки - СтрокаТаблицыЗначений +// ОписаниеЭлементаНастройки - СтрокаТаблицыЗначений +// - Неопределено +// ИмяСписка - Строка +// ИменаРеквизитов - Структура: +// * Сгенерированных - Структура +// * Предопределенных - Структура +// +Процедура ДобавитьЭлементыСписка(Форма, ЭлементНастройки, ОписаниеЭлементаНастройки, ИмяСписка, ИменаРеквизитов) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ДобавитьЭлементыСписка(Форма, ЭлементНастройки, ОписаниеЭлементаНастройки, ИмяСписка, ИменаРеквизитов)); +``` +
+ +## ДобавитьКомандыСписка +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьКомандыСписка(Форма, ЭлементНастройки, ЭлементыНастроек, ИмяСписка) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ДобавитьКомандыСписка(Форма, ЭлементНастройки, ЭлементыНастроек, ИмяСписка)); +``` +
+ +## ДобавитьКомандуСписка +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьКомандуСписка(Форма, Родитель, ИмяКоманды, Заголовок, Действие, Картинка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ДобавитьКомандуСписка(Форма, Родитель, ИмяКоманды, Заголовок, Действие, Картинка); +``` +
+ +## ИнициализироватьСписок +
+ +Описание, пример вызова + +```bsl + +Процедура ИнициализироватьСписок(Форма, Индекс, Поле, ЭлементНастройки) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ИнициализироватьСписок(Форма, Индекс, Поле, ЭлементНастройки)); +``` +
+ +## ВывестиЗначенияКакПоляФлажков +
+ +Описание, пример вызова + +```bsl + +// Вывод значений как поля флажков. + +Процедура ВывестиЗначенияКакПоляФлажков(Форма, ЭлементыНастроек, ИменаРеквизитов) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ВывестиЗначенияКакПоляФлажков(Форма, ЭлементыНастроек, ИменаРеквизитов)); +``` +
+ +## ИнициализироватьФлажок +
+ +Описание, пример вызова + +```bsl + +// Устанавливает значение флажка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - РасширениеУправляемойФормыДляОтчета: +// * Отчет - ОтчетОбъект +// Индекс - Число +// +Процедура ИнициализироватьФлажок(Форма, Индекс) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ИнициализироватьФлажок(Форма, Индекс)); +``` +
+ +## ЗапомнитьВыделенныеСтроки +
+ +Описание, пример вызова + +```bsl + +// Запоминает состояние формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// ИмяТаблицы - Строка +// КлючевыеКолонки - Строка +// +// Возвращаемое значение: +// Структура: +// * Текущая - Неопределено +// * Выделенные - Массив +// +Функция ЗапомнитьВыделенныеСтроки(Форма, ИмяТаблицы, КлючевыеКолонки) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ЗапомнитьВыделенныеСтроки(Форма, ИмяТаблицы, КлючевыеКолонки) +``` +
+ +## ВосстановитьВыделенныеСтроки +
+ +Описание, пример вызова + +```bsl + +// Восстанавливает состояние формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// ИмяТаблицы - Строка +// КлючевыеКолонки - Строка +// +Процедура ВосстановитьВыделенныеСтроки(Форма, ИмяТаблицы, СтрокиТаблицы) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ВосстановитьВыделенныеСтроки(Форма, ИмяТаблицы, СтрокиТаблицы) +``` +
+ +## ЕстьВнешнийНаборДанных +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие внешних наборов данных. +// +// Параметры: +// НаборыДанных - НаборыДанныхМакетаКомпоновкиДанных - коллекция проверяемых наборов данных. +// +// Возвращаемое значение: +// Булево - Истина, если есть внешние наборы данных. +// +Функция ЕстьВнешнийНаборДанных(НаборыДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ЕстьВнешнийНаборДанных(НаборыДанных)); +``` +
+ +## ЗначенияДляВыбора +
+ +Описание, пример вызова + +```bsl + +Функция ЗначенияДляВыбора(ПараметрыНастройки, ТипИлиТипы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ЗначенияДляВыбора(ПараметрыНастройки, ТипИлиТипы); +``` +
+ +## ДополнитьСтруктуруИзПараметровВыбора +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьСтруктуруИзПараметровВыбора(Структура, МассивПараметровВыбора) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ДополнитьСтруктуруИзПараметровВыбора(Структура, МассивПараметровВыбора)); +``` +
+ +## ДобавитьВыбранноеПоле +
+ +Описание, пример вызова + +```bsl + +// Добавляет выбранное поле компоновки данных. +// +// Параметры: +// Куда - КомпоновщикНастроекКомпоновкиДанных +// - НастройкиКомпоновкиДанных +// - ВыбранныеПоляКомпоновкиДанных - +// Коллекция в которую требуется добавить выбранное поле. +// ИмяИлиПолеКД - Строка +// - ПолеКомпоновкиДанных - имя поля. +// Заголовок - Строка - представление поля. +// +// Возвращаемое значение: +// ВыбранноеПолеКомпоновкиДанных - добавленное выбранное поле. +// +Функция ДобавитьВыбранноеПоле(Куда, ИмяИлиПолеКД, Заголовок = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ДобавитьВыбранноеПоле(Куда, ИмяИлиПолеКД, Заголовок); +``` +
+ +## ДобавитьВариантыКонтекста +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьВариантыКонтекста(Отчет, Варианты, ВариантыКонтекста) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.ДобавитьВариантыКонтекста(Отчет, Варианты, ВариантыКонтекста) +``` +
+ +## РасширенноеОписаниеТипов +
+ +Описание, пример вызова + +```bsl + +Функция РасширенноеОписаниеТипов(ИсходноеОписаниеТипов, ПривестиКФорме, ПараметрыПодбора = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.РасширенноеОписаниеТипов(ИсходноеОписаниеТипов, ПривестиКФорме, ПараметрыПодбора); +``` +
+ +## ЗначениеВМассив +
+ +Описание, пример вызова + +```bsl + +Функция ЗначениеВМассив(Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ЗначениеВМассив(Значение) +``` +
+ +## ПривестиИдентификаторКИмени +
+ +Описание, пример вызова + +```bsl + +Функция ПривестиИдентификаторКИмени(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ПривестиИдентификаторКИмени(Идентификатор) +``` +
+ +## ЭлементНастроекПоПолномуПути +
+ +Описание, пример вызова + +```bsl + +// Находит элемент компоновки данных по полному пути. +// +// Параметры: +// НастройкиКД - НастройкиКомпоновкиДанных - корневой узел настроек, в который вложен искомый элемент. +// ПолныйПутьКЭлементу - Строка - полный путь к элементу. Может быть получена в функции ПолныйПутьКЭлементу(). +// +// Возвращаемое значение: +// - НастройкиКомпоновкиДанных +// - КоллекцияЭлементовСтруктурыНастроекКомпоновкиДанных +// - ГруппировкаКомпоновкиДанных +// - КоллекцияЭлементовСтруктурыТаблицыКомпоновкиДанных +// - ГруппировкаТаблицыКомпоновкиДанных +// - КоллекцияЭлементовСтруктурыДиаграммыКомпоновкиДанных +// - ГруппировкаДиаграммыКомпоновкиДанных - найденный узел настроек. +// +Функция ЭлементНастроекПоПолномуПути(Знач Настройки, Знач ПолныйПутьКЭлементу) Экспорт +``` + +Пример вызова +```bsl +Результат = ОтчетыСервер.ЭлементНастроекПоПолномуПути(Настройки, ПолныйПутьКЭлементу) +``` +
+ +## УстановитьУсловияОтборов +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ПараметрыЗагрузки - см. ОтчетыКлиентСервер.ПараметрыОбновленияФормыОтчета +// КомпоновщикНастроек - КомпоновщикНастроекКомпоновкиДанных +// +Процедура УстановитьУсловияОтборов(ПараметрыЗагрузки, КомпоновщикНастроек) Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.УстановитьУсловияОтборов(ПараметрыЗагрузки, КомпоновщикНастроек) +``` +
+ +## УстановитьДоступныеЗначенияНастроек +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьДоступныеЗначенияНастроек(Форма, Отчет, КомпоновщикНастроек, ЭлементПользовательскойНастройки, Экспорт +``` + +Пример вызова +```bsl +ОтчетыСервер.УстановитьДоступныеЗначенияНастроек(Форма, Отчет, КомпоновщикНастроек, ЭлементПользовательскойНастройки, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОценкаПроизводительности.md b/src/content/docs/bsp/ОценкаПроизводительности.md new file mode 100644 index 0000000..064390e --- /dev/null +++ b/src/content/docs/bsp/ОценкаПроизводительности.md @@ -0,0 +1,261 @@ +--- +title: Оценка производительности +slug: bsp/оценка-производительности +--- + + +## НачатьЗамерВремени +
+ +Описание, пример вызова + +```bsl + +// Начинает замер времени ключевой операции. Закончить замер нужно явно вызовом +// процедуры ЗакончитьЗамерВремени или ЗакончитьЗамерВремениТехнологический. +// +// Возвращаемое значение: +// Число - число длиной 14 символов, время UTC начала с точностью до миллисекунд. +// +Функция НачатьЗамерВремени() Экспорт +``` + +Пример вызова +```bsl +Результат = ОценкаПроизводительности.НачатьЗамерВремени() +``` +
+ +## ЗакончитьЗамерВремени +
+ +Описание, пример вызова + +```bsl + +// Завершает замер времени ключевой операции +// и записывает результат в регистр сведений ЗамерыВремени. +// +// Параметры: +// КлючеваяОперация - СправочникСсылка.КлючевыеОперации +// - Строка - ключевая операция. +// ВремяНачала - Число - универсальная дата в миллисекундах, +// возвращаемая при начале замера функцией ОценкаПроизводительности.НачатьЗамерВремени. +// ВесЗамера - Число - количественный показатель замера, например количество строк в документе. +// Комментарий - Строка +// - Соответствие - произвольная информация замера. +// ВыполненСОшибкой - Булево - признак того, что замер не был выполнен до конца, +// +Процедура ЗакончитьЗамерВремени(КлючеваяОперация, ВремяНачала, ВесЗамера = 1, Комментарий = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительности.ЗакончитьЗамерВремени(КлючеваяОперация, ВремяНачала, ВесЗамера, Комментарий, ); +``` +
+ +## ЗакончитьЗамерВремениТехнологический +
+ +Описание, пример вызова + +```bsl + +// Завершает замер времени ключевой операции +// и записывает результат в регистр сведений ЗамерыВремениТехнологические. +// +// Параметры: +// КлючеваяОперация - СправочникСсылка.КлючевыеОперации +// - Строка - ключевая операция. +// ВремяНачала - Число - универсальная дата в миллисекундах, +// возвращаемая при начале замера функцией ОценкаПроизводительности.НачатьЗамерВремени. +// ВесЗамера - Число - количественный показатель замера, например количество строк в документе. +// Комментарий - Строка +// - Соответствие - произвольная информация замера. +// +Процедура ЗакончитьЗамерВремениТехнологический(КлючеваяОперация, ВремяНачала, ВесЗамера = 1, Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительности.ЗакончитьЗамерВремениТехнологический(КлючеваяОперация, ВремяНачала, ВесЗамера, ); +``` +
+ +## СоздатьКлючевыеОперации +
+ +Описание, пример вызова + +```bsl + +// Создает ключевые операции в случае их отсутствия. +// +// Параметры: +// КлючевыеОперации - Массив - ключевые операции, элемент массива - Структура("ИмяКлючевойОперации, ЦелевоеВремя"). +// +Процедура СоздатьКлючевыеОперации(КлючевыеОперации) Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительности.СоздатьКлючевыеОперации(КлючевыеОперации) +``` +
+ +## УстановитьЦелевоеВремя +
+ +Описание, пример вызова + +```bsl + +// Устанавливает ключевой операции новое целевое время. +// +// Параметры: +// КлючевыеОперации - Массив - ключевые операции, элемент массива - Структура("ИмяКлючевойОперации, ЦелевоеВремя"). +// +Процедура УстановитьЦелевоеВремя(КлючевыеОперации) Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительности.УстановитьЦелевоеВремя(КлючевыеОперации) +``` +
+ +## ИзменитьКлючевыеОперации +
+ +Описание, пример вызова + +```bsl + +// Изменяет ключевые операции. +// +// Параметры: +// КлючевыеОперации - Массив - ключевые операции, +// элемент массива - Структура("ИмяКлючевойОперацииСтарое, ИмяКлючевойОперацииНовое , ЦелевоеВремя") +// или +// элемент массива - Структура("ИмяКлючевойОперацииСтарое, ИмяКлючевойОперацииНовое"), +// целевое время не изменяется. +// +Процедура ИзменитьКлючевыеОперации(КлючевыеОперации) Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительности.ИзменитьКлючевыеОперации(КлючевыеОперации) +``` +
+ +## НачатьЗамерДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Начинает замер времени длительной ключевой операции. Закончить замер нужно явно вызовом +// процедуры ЗакончитьЗамерДлительнойОперации. +// +// Параметры: +// КлючеваяОперация - Строка - ключевая операция. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - Произвольный +// Ключи: +// # КлючеваяОперация - Строка - имя ключевой операции. +// # ВремяНачала - Число - время начала ключевой операции в миллисекундах. +// # ВремяПоследнегоЗамера - Число - время последнего замера ключевой операции в миллисекундах. +// # ВесЗамера - Число - количество данных, обработанных в ходе выполнения действий. +// # ВложенныеЗамеры - Соответствие - коллекция замеров вложенных шагов. +// +Функция НачатьЗамерДлительнойОперации(КлючеваяОперация) Экспорт +``` + +Пример вызова +```bsl +Результат = ОценкаПроизводительности.НачатьЗамерДлительнойОперации(КлючеваяОперация) +``` +
+ +## ЗафиксироватьЗамерДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Фиксирует замер вложенного шага длительной операции. +// Параметры: +// ОписаниеЗамера - Соответствие - должно быть получено вызовом метода НачатьЗамерДлительнойОперации. +// КоличествоДанных - Число - количество данных, например, строк, обработанных в ходе выполнения вложенного шага. +// ИмяШага - Строка - произвольное имя вложенного шага. +// Комментарий - Строка - произвольное дополнительное описание замера. +// +Процедура ЗафиксироватьЗамерДлительнойОперации(ОписаниеЗамера, КоличествоДанных, ИмяШага, Комментарий = "") Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительности.ЗафиксироватьЗамерДлительнойОперации(ОписаниеЗамера, КоличествоДанных, ИмяШага, Комментарий); +``` +
+ +## ЗакончитьЗамерДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Завершает замер длительной операции. +// Если указано имя шага, фиксирует его как отдельный вложенный шаг +// Параметры: +// ОписаниеЗамера - Соответствие - должно быть получено вызовом метода НачатьЗамерДлительнойОперации. +// КоличествоДанных - Число - количество данных, например, строк, обработанных в ходе выполнения вложенного шага. +// ИмяШага - Строка - произвольное имя вложенного шага. +// Комментарий - Строка - произвольное дополнительное описание замера. +// +Процедура ЗакончитьЗамерДлительнойОперации(ОписаниеЗамера, КоличествоДанных, ИмяШага = "", Комментарий = "") Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительности.ЗакончитьЗамерДлительнойОперации(ОписаниеЗамера, КоличествоДанных, ИмяШага, Комментарий); +``` +
+ +## УстановитьПризнакЗавершенияСОшибкой +
+ +Описание, пример вызова + +```bsl + +// Устарела. Будет удалена в следующей редакции библиотеки. +// Устанавливает ключевой операции признака ошибки. +// +// Параметры: +// КлючевыеОперации - Массив - ключевые операции, элемент массива - Структура("ИмяКлючевойОперации, Признак"). +// +Процедура УстановитьПризнакЗавершенияСОшибкой(КлючевыеОперации) Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительности.УстановитьПризнакЗавершенияСОшибкой(КлючевыеОперации) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОценкаПроизводительностиКлиент.md b/src/content/docs/bsp/ОценкаПроизводительностиКлиент.md new file mode 100644 index 0000000..7a245cc --- /dev/null +++ b/src/content/docs/bsp/ОценкаПроизводительностиКлиент.md @@ -0,0 +1,390 @@ +--- +title: Оценка производительности клиент +slug: bsp/оценка-производительности-клиент +--- + + +## ЗамерВремени +
+ +Описание, пример вызова + +```bsl + +// Начинает замер времени ключевой операции. +// Результат замера будет записан в регистр сведений ЗамерыВремени. +// Поскольку клиентские замеры хранятся в клиентском буфере и записываются с периодичностью, +// указанной в константе ОценкаПроизводительностиПериодЗаписи (по умолчанию, каждую минуту), +// в случае завершения сеанса часть замеров может быть потеряна. +// +// Параметры: +// КлючеваяОперация - Строка - имя ключевой операции. Если Неопределено, то ключевую операцию +// необходимо указать явно вызовом процедуры +// УстановитьКлючевуюОперациюЗамера. +// ФиксироватьСОшибкой - Булево - признак автоматической фиксации ошибки. +// Истина - при автоматическом завершении замера, он будет записан +// с признаком "Выполнен с ошибкой". В том месте кода, где ошибка явно +// не может возникнуть, необходимо либо явно завершить замер методом +// ЗавершитьЗамерВремени, либо снять признак ошибки с помощью метода +// УстановитьПризнакОшибкиЗамера. +// Ложь - замер будет считаться корректным при автоматическом завершении. +// АвтоЗавершение - Булево - признак автоматического завершения замера. +// Истина - завершение замера будет выполнено автоматически +// через глобальный обработчик ожидания. +// Ложь - завершить замер необходимо явно вызовом процедуры +// ЗавершитьЗамерВремени. +// +// Возвращаемое значение: +// УникальныйИдентификатор - уникальный идентификатор замера, который позволяет идентифицировать замер. +// +Функция ЗамерВремени(КлючеваяОперация = Неопределено, ФиксироватьСОшибкой = Ложь, АвтоЗавершение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОценкаПроизводительностиКлиент.ЗамерВремени(КлючеваяОперация, ФиксироватьСОшибкой, АвтоЗавершение); +``` +
+ +## НачатьЗамерВремениТехнологический +
+ +Описание, пример вызова + +```bsl + +// Начинает технологический замер времени ключевой операции. +// Результат замера будет записан в РегистрСведений.ЗамерыВремени. +// +// Параметры: +// АвтоЗавершение - Булево - признак автоматического завершения замера. +// Истина - завершение замера будет выполнено автоматически +// через глобальный обработчик ожидания. +// Ложь - завершить замер необходимо явно вызовом процедуры +// ЗавершитьЗамерВремени. +// КлючеваяОперация - Строка - имя ключевой операции. Если Неопределено> то ключевую операцию +// необходимо указать явно вызовом процедуры +// УстановитьКлючевуюОперациюЗамера. +// +// Возвращаемое значение: +// УникальныйИдентификатор - уникальный идентификатор замера, который позволяет идентифицировать замер. +// +Функция НачатьЗамерВремениТехнологический(АвтоЗавершение = Истина, КлючеваяОперация = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОценкаПроизводительностиКлиент.НачатьЗамерВремениТехнологический(АвтоЗавершение, КлючеваяОперация); +``` +
+ +## ЗавершитьЗамерВремени +
+ +Описание, пример вызова + +```bsl + +// Завершает замер времени на клиенте. +// +// Параметры: +// УИДЗамера - УникальныйИдентификатор - уникальный идентификатор замера. +// ВыполненСОшибкой - Булево - признак того, что замер не был выполнен до конца, +// а выполнение ключевой операции завершилось с ошибкой. +// +Процедура ЗавершитьЗамерВремени(УИДЗамера, ВыполненСОшибкой = Ложь) Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительностиКлиент.ЗавершитьЗамерВремени(УИДЗамера, ВыполненСОшибкой); +``` +
+ +## УстановитьПараметрыЗамера +
+ +Описание, пример вызова + +```bsl + +// Устанавливает параметры замера. +// +// Параметры: +// УИДЗамера - УникальныйИдентификатор - уникальный идентификатор замера. +// ПараметрыЗамера - Структура: +// * КлючеваяОперация - Строка - имя ключевой операции. +// * ВесЗамера - Число - количественный показатель сложности замера. +// * Комментарий - Строка +// - Соответствие - дополнительная произвольной информации замера. +// * ВыполненаСОшибкой - Булево - признак выполнения замера с ошибкой, +// см. процедуру УстановитьПризнакОшибкиЗамера. +// +Процедура УстановитьПараметрыЗамера(УИДЗамера, ПараметрыЗамера) Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительностиКлиент.УстановитьПараметрыЗамера(УИДЗамера, ПараметрыЗамера) +``` +
+ +## УстановитьКлючевуюОперациюЗамера +
+ +Описание, пример вызова + +```bsl + +// Устанавливает ключевую операцию замера. +// +// Параметры: +// УИДЗамера - УникальныйИдентификатор - уникальный идентификатор замера. +// КлючеваяОперация - Строка - наименование ключевой операции. +// +// Если на момент начала замера имя ключевой операции еще неизвестно, +// то с помощью этой процедуры в любой момент до завершения замера можно +// доопределить имя ключевой операции. +// Например, при проведении документа, т.к. в момент начала проведения +// мы не можем гарантировать, что проведение документа завершиться и не будет отказа. +// +// &НаКлиенте +// Процедура ПередЗаписью(Отказ, ПараметрыЗаписи) +// Если ПараметрыЗаписи.РежимЗаписи = РежимЗаписиДокумента.Проведение Тогда +// ИдентификаторЗамераПроведение = ОценкаПроизводительностиКлиент.НачатьЗамерВремени(Истина); +// КонецЕсли; +// КонецПроцедуры +// +// &НаКлиенте +// Процедура ПослеЗаписи(ПараметрыЗаписи) +// Если ПараметрыЗаписи.РежимЗаписи = РежимЗаписиДокумента.Проведение Тогда +// ОценкаПроизводительностиКлиент.УстановитьКлючевуюОперациюЗамера(ИдентификаторЗамераПроведение, "ПроведениеДокумента"); +// КонецЕсли; +// КонецПроцедуры +// +Процедура УстановитьКлючевуюОперациюЗамера(УИДЗамера, КлючеваяОперация) Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительностиКлиент.УстановитьКлючевуюОперациюЗамера(УИДЗамера, КлючеваяОперация) +``` +
+ +## УстановитьВесЗамера +
+ +Описание, пример вызова + +```bsl + +// Устанавливает вес операции замера. +// +// Параметры: +// УИДЗамера - УникальныйИдентификатор - уникальный идентификатор замера. +// ВесЗамера - Число - количественный показатель сложности +// замера, например количество строк в документе. +// +Процедура УстановитьВесЗамера(УИДЗамера, ВесЗамера) Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительностиКлиент.УстановитьВесЗамера(УИДЗамера, ВесЗамера) +``` +
+ +## УстановитьКомментарийЗамера +
+ +Описание, пример вызова + +```bsl + +// Устанавливает комментарий операции замера. +// +// Параметры: +// УИДЗамера - УникальныйИдентификатор - уникальный идентификатор замера. +// Комментарий - Строка +// - Соответствие из КлючИЗначение - дополнительная произвольной информации замера. +// В случае указания соответствия: +// * Ключ - Строка - имя дополнительного параметра информации замера. +// * Значение - Строка +// - Число +// - Булево - значение дополнительного параметра замера. +// +Процедура УстановитьКомментарийЗамера(УИДЗамера, Комментарий) Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительностиКлиент.УстановитьКомментарийЗамера(УИДЗамера, Комментарий) +``` +
+ +## УстановитьПризнакОшибкиЗамера +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак ошибки операции замера. +// +// Параметры: +// УИДЗамера - УникальныйИдентификатор - уникальный идентификатор замера. +// Признак - Булево - признак замера. Истина - замер выполнился без ошибок. +// Ложь - при выполнении замера есть ошибка. +// +Процедура УстановитьПризнакОшибкиЗамера(УИДЗамера, Признак) Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительностиКлиент.УстановитьПризнакОшибкиЗамера(УИДЗамера, Признак) +``` +
+ +## НачатьЗамерДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Начинает замер времени выполнения длительной ключевой операции. Закончить замер нужно явно вызовом +// процедуры ЗакончитьЗамерДлительнойОперации. +// Результат замера будет записан в регистр сведений ЗамерыВремени. +// +// Параметры: +// КлючеваяОперация - Строка - имя ключевой операции. +// ФиксироватьСОшибкой - Булево - признак автоматической фиксации ошибки. +// Истина - при автоматическом завершении замера, он будет записан +// с признаком "Выполнен с ошибкой". В том месте кода, где ошибка явно +// не может возникнуть, необходимо либо явно завершить замер методом +// ЗавершитьЗамерВремени, либо снять признак ошибки с помощью метода +// УстановитьПризнакОшибкиЗамера +// Ложь - замер будет считаться корректны при автоматическом завершении. +// ЗавершитьЗамерВремени. +// АвтоЗавершение - Булево - признак автоматического завершения замера. +// Истина - завершение замера будет выполнено автоматически +// через глобальный обработчик ожидания. +// Ложь - завершить замер необходимо явно вызовом процедуры +// ЗавершитьЗамерВремени. +// ИмяПоследнегоШага - Строка - имя последнего шага ключевой операции. Целесообразно использовать, если +// замер запущен с автоматическим завершением. В противным случае последние +// действия, выполненные между ЗафиксироватьЗамерДлительнойОперации и +// срабатыванием обработчика ожидания будет записано под именем "Последний шаг". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - Произвольный +// Ключи: +// # КлючеваяОперация - Строка - имя ключевой операции. +// # ВремяНачала - Число - время начала ключевой операции в миллисекундах. +// # ВремяПоследнегоЗамера - Число - время последнего замера ключевой операции в миллисекундах. +// # ВесЗамера - Число - количество данных, обработанных в ходе выполнения действий. +// # ВложенныеЗамеры - Соответствие - коллекция замеров вложенных шагов. +// +Функция НачатьЗамерДлительнойОперации(КлючеваяОперация, ФиксироватьСОшибкой = Ложь, АвтоЗавершение = Ложь, ИмяПоследнегоШага = "ПоследнийШаг") Экспорт +``` + +Пример вызова +```bsl +Результат = ОценкаПроизводительностиКлиент.НачатьЗамерДлительнойОперации(КлючеваяОперация, ФиксироватьСОшибкой, АвтоЗавершение, ИмяПоследнегоШага); +``` +
+ +## ЗафиксироватьЗамерДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Фиксирует замер вложенного шага длительной операции. +// Параметры: +// ОписаниеЗамера - Соответствие - должно быть получено вызовом метода НачатьЗамерДлительнойОперации. +// КоличествоДанных - Число - количество данных, например, строк, обработанных в ходе выполнения вложенного шага. +// ИмяШага - Строка - произвольное имя вложенного шага. +// Комментарий - Строка - произвольное дополнительное описание замера. +// +Процедура ЗафиксироватьЗамерДлительнойОперации(ОписаниеЗамера, КоличествоДанных, ИмяШага, Комментарий = "") Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительностиКлиент.ЗафиксироватьЗамерДлительнойОперации(ОписаниеЗамера, КоличествоДанных, ИмяШага, Комментарий); +``` +
+ +## ЗакончитьЗамерДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Завершает замер длительной операции. +// Если указано имя шага, фиксирует его как отдельный вложенный шаг +// Параметры: +// ОписаниеЗамера - Соответствие - должно быть получено вызовом метода НачатьЗамерДлительнойОперации. +// КоличествоДанных - Число - количество данных, например, строк, обработанных в ходе выполнения вложенного шага. +// ИмяШага - Строка - произвольное имя вложенного шага. +// Комментарий - Строка - произвольное дополнительное описание замера. +// +Процедура ЗакончитьЗамерДлительнойОперации(ОписаниеЗамера, КоличествоДанных, ИмяШага = "", Комментарий = "") Экспорт +``` + +Пример вызова +```bsl +ОценкаПроизводительностиКлиент.ЗакончитьЗамерДлительнойОперации(ОписаниеЗамера, КоличествоДанных, ИмяШага, Комментарий); +``` +
+ +## НачатьЗамерВремени +
+ +Описание, пример вызова + +```bsl + +// Устарела. Будет удалена в следующей редакции библиотеки. +// Необходимо использовать процедуру +// ОценкаПроизводительностиКлиент.ЗамерВремени +// Начинает замер времени ключевой операции. +// Результат замера будет записан в регистр сведений ЗамерыВремени. +// Поскольку клиентские замеры хранятся в клиентском буфере и записываются с периодичностью, +// указанной в константе ОценкаПроизводительностиПериодЗаписи (по умолчанию, каждую минуту), +// в случае завершения сеанса часть замеров может быть потеряна. +// +// Параметры: +// АвтоЗавершение - Булево - признак автоматического завершения замера. +// Истина - завершение замера будет выполнено автоматически +// через глобальный обработчик ожидания. +// Ложь - завершить замер необходимо явно вызовом процедуры +// ЗавершитьЗамерВремени. +// КлючеваяОперация - Строка - имя ключевой операции. Если Неопределено> то ключевую операцию +// необходимо указать явно вызовом процедуры +// УстановитьКлючевуюОперациюЗамера. +// +// Возвращаемое значение: +// УникальныйИдентификатор - уникальный идентификатор замера, который позволяет идентифицировать замер. +// +Функция НачатьЗамерВремени(АвтоЗавершение = Истина, КлючеваяОперация = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОценкаПроизводительностиКлиент.НачатьЗамерВремени(АвтоЗавершение, КлючеваяОперация); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОчередьЗаданий.md b/src/content/docs/bsp/ОчередьЗаданий.md new file mode 100644 index 0000000..1f8ae18 --- /dev/null +++ b/src/content/docs/bsp/ОчередьЗаданий.md @@ -0,0 +1,255 @@ +--- +title: Очередь заданий +slug: bsp/очередь-заданий +--- + + +## ПолучитьЗадания +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Основные процедуры и функции. + +// Все методы доступные в API оперирует параметрами заданий. Возможность использования +// конкретного параметра зависит от метода и, в некоторых случаях, значений других +// параметров. Подробнее об этом написано в описании конкретных методов. +// Описание параметров - см. НовыйПараметрыЗадания. + +// Получает задания очереди по заданному отбору. +// Возможно получение неконсистентных данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Отбор - Структура - значения, по которым требуется отбирать задания (объединяются по И). Возможные ключи структуры: +// * ОбластьДанных - Число - область данных, +// * ИмяМетода - Строка - имя метода, +// * Идентификатор - УникальныйИдентификатор - идентификатор задания, +// * СостояниеЗадания - ПеречислениеСсылка.СостоянияЗаданий - состояние задания, +// * Ключ - Строка - ключ задания, +// * Шаблон - СправочникСсылка.ШаблоныЗаданийОчереди - шаблон задания, +// * Использование - Булево - использование задания. +// - Массив Из Структура - описание: +// * ВидСравнения - ВидСравнения - допустимыми значениями являются: +// ВидСравнения.Равно, ВидСравнения.НеРавно - для сравнения со значением, +// ВидСравнения.ВСписке, ВидСравнения.НеВСписке - для сравнения с массивом. +// * Значение - Произвольный - значения сравнения для видов сравнения Равно / НеРавно +// - Массив - для видов сравнения ВСписке и НеВСписке +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица найденных заданий. Колонки соответствуют параметрам заданий: +// * Идентификатор - СправочникСсылка.ОчередьЗаданий - ссылка на справочник. +// ... +// +Функция ПолучитьЗадания(Знач Отбор) Экспорт +``` + +Пример вызова +```bsl +Результат = ОчередьЗаданий.ПолучитьЗадания(Отбор) +``` +
+ +## ДобавитьЗадание +
+ +Описание, пример вызова + +```bsl + +// Добавляет новое задание в очередь. +// В случае вызова в транзакции на задание устанавливается объектная блокировка. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ПараметрыЗадания - Структура - параметры добавляемого задания. Описание: +// * ОбластьДанных - Число - номер области данных. +// * Использование - Булево - признак использования. +// * ЗапланированныйМоментЗапуска - Дата - момент запуска (ДатаВремя) +// * ЭксклюзивноеВыполнение - Булево - признак эксклюзивного выполнения. +// * ИмяМетода - Строка - имя метода для задания, обязательно для указания. +// * Параметры - Массив - параметры метода. +// * Ключ - Строка - ключ уникальности задания. +// * ИнтервалПовтораПриАварийномЗавершении - Число - интервал повтора в секундах. +// * Расписание - РасписаниеРегламентногоЗадания - расписания выполнения задания. +// * КоличествоПовторовПриАварийномЗавершении - Число - количество повторов. +// +// Возвращаемое значение: +// СправочникСсылка.ОчередьЗаданий - идентификатор добавленного задания. +// +Функция ДобавитьЗадание(ПараметрыЗадания) Экспорт +``` + +Пример вызова +```bsl +Результат = ОчередьЗаданий.ДобавитьЗадание(ПараметрыЗадания) +``` +
+ +## ИзменитьЗадание +
+ +Описание, пример вызова + +```bsl + +// Изменяет задание с указанным идентификатором. +// В случае вызова в транзакции на задание устанавливается объектная блокировка. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Идентификатор - СправочникСсылка.ОчередьЗаданий - идентификатор задания. +// ПараметрыЗадания - Структура - параметры, которые следует установить заданию, возможные ключи: +// * Использование - Булево - +// * ЗапланированныйМоментЗапуска - Дата - +// * ЭксклюзивноеВыполнение - Булево - +// * ИмяМетода - Строка - +// * Параметры - Массив - +// * Ключ - Строка - +// * ИнтервалПовтораПриАварийномЗавершении - Число - +// * Расписание - РасписаниеРегламентногоЗадания - +// * КоличествоПовторовПриАварийномЗавершении - Число - +// - Структура - в случае если задание создано на основе шаблона, могут быть указаны только следующие ключи: +// * Использование - Булево - +// * ЗапланированныйМоментЗапуска - Дата - +// * ЭксклюзивноеВыполнение - Булево - +// * ИнтервалПовтораПриАварийномЗавершении - Число - +// * Расписание - РасписаниеРегламентногоЗадания - +// * КоличествоПовторовПриАварийномЗавершении - Число - +// +Процедура ИзменитьЗадание(Идентификатор, ПараметрыЗадания) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданий.ИзменитьЗадание(Идентификатор, ПараметрыЗадания) +``` +
+ +## УдалитьЗадание +
+ +Описание, пример вызова + +```bsl + +// Удаляет задание из очереди заданий. +// Удаление заданий с установленным шаблоном запрещено. +// В случае вызова в транзакции на задание устанавливается объектная блокировка. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Идентификатор - СправочникСсылка.ОчередьЗаданий - идентификатор задания. +// +Процедура УдалитьЗадание(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданий.УдалитьЗадание(Идентификатор) +``` +
+ +## ШаблонПоИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон задания очереди по имени предопределенного регламентного задания из которого он создан. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Имя - Строка - имя предопределенного регламентного задания. +// +// Возвращаемое значение: +// СправочникСсылка.ШаблоныЗаданийОчереди - шаблон задания. +// +Функция ШаблонПоИмени(Знач Имя) Экспорт +``` + +Пример вызова +```bsl +Результат = ОчередьЗаданий.ШаблонПоИмени(Имя) +``` +
+ +## ПолучитьТекстИсключенияДублированиеЗаданийСОдинаковымКлючом +
+ +Описание, пример вызова + +```bsl + +// Возвращает текст ошибки при попытке выполнить одновременно два задания с одним ключом. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - текст исключения. +// +Функция ПолучитьТекстИсключенияДублированиеЗаданийСОдинаковымКлючом() Экспорт +``` + +Пример вызова +```bsl +Результат = ОчередьЗаданий.ПолучитьТекстИсключенияДублированиеЗаданийСОдинаковымКлючом() +``` +
+ +## ШаблоныЗаданийОчереди +
+ +Описание, пример вызова + +```bsl + +// Возвращает список шаблонов заданий очереди. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Массив Из Строка - имена предопределенных неразделенных регламентных заданий, которые используются +// в качестве шаблонов для заданий очереди. +// +// +Функция ШаблоныЗаданийОчереди() Экспорт +``` + +Пример вызова +```bsl +Результат = ОчередьЗаданий.ШаблоныЗаданийОчереди() +``` +
+ +## СправочникОчередьЗаданий +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер справочника ОчередьЗаданий. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// СправочникМенеджер.ОчередьЗаданий - менеджер справочника. +// +Функция СправочникОчередьЗаданий() Экспорт +``` + +Пример вызова +```bsl +Результат = ОчередьЗаданий.СправочникОчередьЗаданий() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОчередьЗаданийВнешнийИнтерфейс.md b/src/content/docs/bsp/ОчередьЗаданийВнешнийИнтерфейс.md new file mode 100644 index 0000000..f1fb4b1 --- /dev/null +++ b/src/content/docs/bsp/ОчередьЗаданийВнешнийИнтерфейс.md @@ -0,0 +1,77 @@ +--- +title: Очередь заданий внешний интерфейс +slug: bsp/очередь-заданий-внешний-интерфейс +--- + + +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +// см. ОбновлениеИнформационнойБазыБСП.ПриДобавленииОбработчиковОбновления +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Обработчики - см. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийВнешнийИнтерфейс.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийВнешнийИнтерфейс.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ИдентификаторХранилища +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификатор хранилища в виде строки. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - идентификатор хранилища. +// +Функция ИдентификаторХранилища() Экспорт +``` + +Пример вызова +```bsl +Результат = ОчередьЗаданийВнешнийИнтерфейс.ИдентификаторХранилища() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОчередьЗаданийПереопределяемый.md b/src/content/docs/bsp/ОчередьЗаданийПереопределяемый.md new file mode 100644 index 0000000..24888b7 --- /dev/null +++ b/src/content/docs/bsp/ОчередьЗаданийПереопределяемый.md @@ -0,0 +1,121 @@ +--- +title: Очередь заданий переопределяемый +slug: bsp/очередь-заданий-переопределяемый +--- + + +## ПриПолученииСпискаШаблонов +
+ +Описание, пример вызова + +```bsl + +// Формирует список шаблонов заданий очереди. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ШаблоныЗаданий - Массив Из Строка - В параметр следует добавить имена предопределенных +// неразделенных регламентных заданий, которые должны использоваться в качестве +// шаблонов для заданий очереди. +// +Процедура ПриПолученииСпискаШаблонов(ШаблоныЗаданий) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийПереопределяемый.ПриПолученииСпискаШаблонов(ШаблоныЗаданий) +``` +
+ +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// Заполняет соответствие имен методов их псевдонимам для вызова из очереди заданий. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// СоответствиеИменПсевдонимам - Соответствие из КлючИЗначение: +// * Ключ - Строка - псевдоним метода, например "ОчиститьОбластьДанных". +// * Значение - Строка - Имя метода для вызова, например "РаботаВМоделиСервиса.ОчиститьОбластьДанных". +// В качестве значения можно указать Неопределено, в этом случае считается что имя +// совпадает с псевдонимом. +// +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ПриОпределенииОбработчиковОшибок +
+ +Описание, пример вызова + +```bsl + +// Заполняет соответствие методов обработчиков ошибок псевдонимам методов, при возникновении +// ошибок в которых они вызываются. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ОбработчикиОшибок - Соответствие из КлючИЗначение: +// * Ключ - Строка - Псевдоним метода, например ОчиститьОбластьДанных. +// * Значение - Строка - Имя метода - обработчика ошибок, для вызова при возникновении ошибки. +// Обработчик ошибок вызывается в случае завершения выполнения исходного задания +// с ошибкой. Обработчик ошибок вызывается в той же области данных, что и исходное задание. +// Метод обработчика ошибок считается разрешенным к вызову механизмами очереди. +// Параметры обработчика ошибок: +// ПараметрыЗадания - Структура - параметры задания очереди. +// Параметры +// НомерПопытки +// КоличествоПовторовПриАварийномЗавершении +// ДатаНачалаПоследнегоЗапуска. +// +Процедура ПриОпределенииОбработчиковОшибок(ОбработчикиОшибок) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийПереопределяемый.ПриОпределенииОбработчиковОшибок(ОбработчикиОшибок) +``` +
+ +## ПриОпределенииИспользованияРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// Формирует таблицу регламентных заданий с признаком использования в модели сервиса. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ТаблицаИспользования - ТаблицаЗначений - описание: +// * РегламентноеЗадание - Строка - имя регламентного задания. +// * Использование - Булево - признак использования. +// +Процедура ПриОпределенииИспользованияРегламентныхЗаданий(ТаблицаИспользования) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийПереопределяемый.ПриОпределенииИспользованияРегламентныхЗаданий(ТаблицаИспользования) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОчередьЗаданийРазделениеДанных.md b/src/content/docs/bsp/ОчередьЗаданийРазделениеДанных.md new file mode 100644 index 0000000..233312b --- /dev/null +++ b/src/content/docs/bsp/ОчередьЗаданийРазделениеДанных.md @@ -0,0 +1,46 @@ +--- +title: Очередь заданий разделение данных +slug: bsp/очередь-заданий-разделение-данных +--- + + +## ПриВыбореСправочникаДляЗадания +
+ +Описание, пример вызова + +```bsl + +// Устарела. Выбирает справочник для добавляемого задания очереди заданий. +// +// Параметры: +// ПараметрыЗадания - Структура - Параметры добавляемого задания, возможные ключи: +// * ОбластьДанных - Число - область данных +// * Использование - Булево - факт использования +// * ЗапланированныйМоментЗапуска - Дата - дата начала запуска +// * ЭксклюзивноеВыполнение - Булево - факт эксклюзивного выполнения +// * ИмяМетода - Строка - имя метода для задания (обязательно для указания.) +// * Параметры - Массив - массив параметров задания +// * Ключ - Строка - ключ задания +// * ИнтервалПовтораПриАварийномЗавершении - Число - указывается в секундах +// * Расписание - РасписаниеРегламентногоЗадания - расписания выполнения задания +// * КоличествоПовторовПриАварийномЗавершении - Число - количество повторов. +// +// Возвращаемое значение: +// СправочникМенеджер.ОчередьЗаданий - менеджер. +Функция ПриВыбореСправочникаДляЗадания(Знач ПараметрыЗадания) Экспорт +``` + +Пример вызова +```bsl +Результат = ОчередьЗаданийРазделениеДанных.ПриВыбореСправочникаДляЗадания(ПараметрыЗадания) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ОчередьЗаданийСлужебныйРазделениеДанных.md b/src/content/docs/bsp/ОчередьЗаданийСлужебныйРазделениеДанных.md new file mode 100644 index 0000000..dee8f68 --- /dev/null +++ b/src/content/docs/bsp/ОчередьЗаданийСлужебныйРазделениеДанных.md @@ -0,0 +1,113 @@ +--- +title: Очередь заданий служебный разделение данных +slug: bsp/очередь-заданий-служебный-разделение-данных +--- + + +## ПослеЗагрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПослеЗагрузкиДанных. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПослеЗагрузкиДанных(Контейнер) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийСлужебныйРазделениеДанных.ПослеЗагрузкиДанных(Контейнер) +``` +
+ +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазыБСП.ПриДобавленииОбработчиковОбновления. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Обработчики - см. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления +// +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийСлужебныйРазделениеДанных.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## СоздатьЗаданияОчередиПоШаблонамВТекущейОбласти +
+ +Описание, пример вызова + +```bsl + +// Создает в текущей области данных задания по шаблонам. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура СоздатьЗаданияОчередиПоШаблонамВТекущейОбласти() Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийСлужебныйРазделениеДанных.СоздатьЗаданияОчередиПоШаблонамВТекущейОбласти() +``` +
+ +## ПриВключенииРазделенияПоОбластямДанных +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВМоделиСервисаПереопределяемый.ПриВключенииРазделенияПоОбластямДанных. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПриВключенииРазделенияПоОбластямДанных() Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийСлужебныйРазделениеДанных.ПриВключенииРазделенияПоОбластямДанных() +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - см. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +ОчередьЗаданийСлужебныйРазделениеДанных.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПереводТекстаНаДругиеЯзыки.md b/src/content/docs/bsp/ПереводТекстаНаДругиеЯзыки.md new file mode 100644 index 0000000..4e39493 --- /dev/null +++ b/src/content/docs/bsp/ПереводТекстаНаДругиеЯзыки.md @@ -0,0 +1,119 @@ +--- +title: Перевод текста на другие языки +slug: bsp/перевод-текста-на-другие-языки +--- + + +## ПеревестиТекст +
+ +Описание, пример вызова + +```bsl + +// Переводит текст на другой язык с использованием сервиса перевода текста. +// +// Параметры: +// Текст - Строка - произвольный текст. +// ЯзыкПеревода - Строка - код языка в формате ISO 639-1, на который выполняется перевод. +// Например, "en". +// Если не указан, то перевод выполняется на текущий язык. +// ИсходныйЯзык - Строка - код языка в формате ISO 639-1, с которого выполняется перевод. +// Например, "ru". +// Если не указан, то язык будет установлен сервисом перевода текста. +// +// Возвращаемое значение: +// Строка +// +Функция ПеревестиТекст(Текст, ЯзыкПеревода = Неопределено, ИсходныйЯзык = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПереводТекстаНаДругиеЯзыки.ПеревестиТекст(Текст, ЯзыкПеревода, ИсходныйЯзык); +``` +
+ +## ПеревестиТексты +
+ +Описание, пример вызова + +```bsl + +// Переводит тексты на другой язык с использованием сервиса перевода текста. +// +// Параметры: +// Тексты - Массив из Строка - произвольные тексты. +// ЯзыкПеревода - Строка - код языка в формате ISO 639-1, на который выполняется перевод. +// Например, "en". +// Если не указан, то перевод выполняется на текущий язык. +// ИсходныйЯзык - Строка - код языка в формате ISO 639-1, с которого выполняется перевод. +// Например, "ru". +// Если не указан, то язык будет установлен сервисом перевода текста. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - текст; +// * Значение - Строка - перевод. +// +Функция ПеревестиТексты(Тексты, ЯзыкПеревода = Неопределено, ИсходныйЯзык = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПереводТекстаНаДругиеЯзыки.ПеревестиТексты(Тексты, ЯзыкПеревода, ИсходныйЯзык); +``` +
+ +## ДоступныеЯзыки +
+ +Описание, пример вызова + +```bsl + +// Возвращает список языков, поддерживаемых сервисом перевода текста. +// +// Возвращаемое значение: +// СписокЗначений: +// * Значение - код языка; +// * Представление - представление языка. +// +Функция ДоступныеЯзыки() Экспорт +``` + +Пример вызова +```bsl +Результат = ПереводТекстаНаДругиеЯзыки.ДоступныеЯзыки() +``` +
+ +## ДоступенПереводТекста +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если включена настройка автоперевода текста на другие языки. +// +// Возвращаемое значение: +// Булево +// +Функция ДоступенПереводТекста() Экспорт +``` + +Пример вызова +```bsl +Результат = ПереводТекстаНаДругиеЯзыки.ДоступенПереводТекста() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПереводТекстаНаДругиеЯзыкиЛокализация.md b/src/content/docs/bsp/ПереводТекстаНаДругиеЯзыкиЛокализация.md new file mode 100644 index 0000000..e8e7da7 --- /dev/null +++ b/src/content/docs/bsp/ПереводТекстаНаДругиеЯзыкиЛокализация.md @@ -0,0 +1,34 @@ +--- +title: Перевод текста на другие языки локализация +slug: bsp/перевод-текста-на-другие-языки-локализация +--- + + +## ПриОпределенииСервисПереводаТекста +
+ +Описание, пример вызова + +```bsl + +// При определении сервиса перевода текста по умолчанию. +// +// Параметры: +// СервисПереводаТекста - ПеречислениеСсылка.СервисыПереводаТекста - значение настройки сервиса перевода по умолчанию. +// +Процедура ПриОпределенииСервисПереводаТекста(СервисПереводаТекста) Экспорт +``` + +Пример вызова +```bsl +ПереводТекстаНаДругиеЯзыкиЛокализация.ПриОпределенииСервисПереводаТекста(СервисПереводаТекста) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПередачаДанныхВстраивание.md b/src/content/docs/bsp/ПередачаДанныхВстраивание.md new file mode 100644 index 0000000..5aeee7f --- /dev/null +++ b/src/content/docs/bsp/ПередачаДанныхВстраивание.md @@ -0,0 +1,257 @@ +--- +title: Передача данных встраивание +slug: bsp/передача-данных-встраивание +--- + + +## МенеджерыЛогическихХранилищ +
+ +Описание, пример вызова + +```bsl + +// Определяет менеджеры логических хранилищ. +// +// Параметры: +// ВсеМенеджерыЛогическихХранилищ - Соответствие из Строка - менеджеры логических хранилищ: +// * Ключ - Строка - идентификатор логического хранилища; +// * Значение - ОбщийМодуль - менеджер логического хранилища. +// +//@skip-check module-empty-method +Процедура МенеджерыЛогическихХранилищ(ВсеМенеджерыЛогическихХранилищ) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхВстраивание.МенеджерыЛогическихХранилищ(ВсеМенеджерыЛогическихХранилищ) +``` +
+ +## МенеджерыФизическихХранилищ +
+ +Описание, пример вызова + +```bsl + +// Определяет менеджеры физических хранилищ. +// +// Параметры: +// ВсеМенеджерыФизическихХранилищ - Соответствие из Строка - менеджеры физических хранилищ: +// * Ключ - Строка - идентификатор физического хранилища; +// * Значение - ОбщийМодуль - менеджер физического хранилища. +// +//@skip-check module-empty-method +Процедура МенеджерыФизическихХранилищ(ВсеМенеджерыФизическихХранилищ) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхВстраивание.МенеджерыФизическихХранилищ(ВсеМенеджерыФизическихХранилищ) +``` +
+ +## ПериодДействияВременногоИдентификатора +
+ +Описание, пример вызова + +```bsl + +// Определяет период действия временного идентификатора. +// +// Параметры: +// ПериодДействияВременногоИдентификатора - Число - период действия временного идентификатора. +// +//@skip-check module-empty-method +Процедура ПериодДействияВременногоИдентификатора(ПериодДействияВременногоИдентификатора) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхВстраивание.ПериодДействияВременногоИдентификатора(ПериодДействияВременногоИдентификатора) +``` +
+ +## РазмерБлокаПолученияДанных +
+ +Описание, пример вызова + +```bsl + +// Определяет размер блока получения данных. +// +// Параметры: +// РазмерБлокаПолученияДанных - Число - размер блока получения данных в байтах. +// +//@skip-check module-empty-method +Процедура РазмерБлокаПолученияДанных(РазмерБлокаПолученияДанных) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхВстраивание.РазмерБлокаПолученияДанных(РазмерБлокаПолученияДанных) +``` +
+ +## РазмерБлокаОтправкиДанных +
+ +Описание, пример вызова + +```bsl + +// Определяет размер блока отправки данных. +// +// Параметры: +// РазмерБлокаОтправкиДанных - Число - размер блока отправки данных в байтах. +// +//@skip-check module-empty-method +Процедура РазмерБлокаОтправкиДанных(РазмерБлокаОтправкиДанных) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхВстраивание.РазмерБлокаОтправкиДанных(РазмерБлокаОтправкиДанных) +``` +
+ +## ОшибкаПриПолученииДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при ошибке получения данных. +// +// Параметры: +// Ответ - HTTPСервисОтвет - ответ сервиса при получении данных. +// +//@skip-check module-empty-method +Процедура ОшибкаПриПолученииДанных(Ответ) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхВстраивание.ОшибкаПриПолученииДанных(Ответ) +``` +
+ +## ОшибкаПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при ошибке отправки данных. +// +// Параметры: +// Ответ - HTTPСервисОтвет - ответ сервиса при отправке данных. +// +//@skip-check module-empty-method +Процедура ОшибкаПриОтправкеДанных(Ответ) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхВстраивание.ОшибкаПриОтправкеДанных(Ответ) +``` +
+ +## ПриПолученииИмениВременногоФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении имени временного файла. +// +// Параметры: +// ИмяВременногоФайла - Строка - имя временного файла. +// Расширение - Строка - желаемое расширение имени временного файла. +// ДополнительныеПараметры - Структура - дополнительные параметры временного файла. +// +//@skip-check module-empty-method +Процедура ПриПолученииИмениВременногоФайла(ИмяВременногоФайла, Расширение) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхВстраивание.ПриПолученииИмениВременногоФайла(ИмяВременногоФайла, Расширение) +``` +
+ +## ПриПродленииДействияВременногоИдентификатора +
+ +Описание, пример вызова + +```bsl + +// Вызывается при продлении действия временного идентификатора. +// +// Параметры: +// Идентификатор - Строка - идентификатор запроса. +// Дата - Дата - дата регистрации запроса. +// Запрос - Структура - исходный HTTP-запрос: +// * HTTPМетод - Строка - HTTP-метод; +// * БазовыйURL - Строка - базовая часть URL-запроса, включающая имя сервиса; +// * Заголовки - ФиксированноеСоответствие из Строка - заголовки HTTP-запроса; +// * ОтносительныйURL - Строка - относительную часть URL-адреса (относительно сервиса); +// * ПараметрыURL - ФиксированноеСоответствие из Строка - части URL-адреса, которые были параметризованы в шаблоне; +// * ПараметрыЗапроса - ФиксированноеСоответствие из Строка - параметры запроса (в строке URL-адреса параметры следуют после знака запроса); +// * ИдентификаторЗапроса - Строка - уникальный идентификатор запроса; +// * ТипЗапроса - Строка - тип запроса; +// * ИмяВременногоФайла - Строка - имя используемого временного файла. +// +//@skip-check module-empty-method +Процедура ПриПродленииДействияВременногоИдентификатора(Идентификатор, Дата, Запрос) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхВстраивание.ПриПродленииДействияВременногоИдентификатора(Идентификатор, Дата, Запрос) +``` +
+ +## ПриПолученииПрокси +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении Прокси, используемого для соединения с сервером. +// +// Параметры: +// Прокси - Неопределено, ИнтернетПрокси - Прокси, используемый для соединения с сервером. +// СтруктураURI - Структура - поля: +// * Схема - Строка - схема из URI +// * Логин - Строка - логин из URI +// * Пароль - Строка - пароль из URI +// * Хост - Строка - хост из URI +// * Порт - Число - порт из URI +// * ПутьНаСервере - Строка - часть <путь>?<параметры>#<якорь> из URI +// +//@skip-check module-empty-method +Процедура ПриПолученииПрокси(Прокси, СтруктураURI) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхВстраивание.ПриПолученииПрокси(Прокси, СтруктураURI) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПередачаДанныхКлиентСервер.md b/src/content/docs/bsp/ПередачаДанныхКлиентСервер.md new file mode 100644 index 0000000..2a05eff --- /dev/null +++ b/src/content/docs/bsp/ПередачаДанныхКлиентСервер.md @@ -0,0 +1,59 @@ +--- +title: Передача данных клиент сервер +slug: bsp/передача-данных-клиент-сервер +--- + + +## ПодробныйТекстОшибки +
+ +Описание, пример вызова + +```bsl + +// Подробное представление ошибки +// Используется для обработки предупреждений об устаревшем методе в конфигурациях с режимом совместимости до 8.3.17. +// +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке +// Возвращаемое значение: +// Строка +Функция ПодробныйТекстОшибки(ИнформацияОбОшибке) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхКлиентСервер.ПодробныйТекстОшибки(ИнформацияОбОшибке) +``` +
+ +## КраткийТекстОшибки +
+ +Описание, пример вызова + +```bsl + +// Краткое представление ошибки +// Используется для обработки предупреждений об устаревшем методе в конфигурациях с режимом совместимости до 8.3.17. +// +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке +// Возвращаемое значение: +// Строка +Функция КраткийТекстОшибки(ИнформацияОбОшибке) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхКлиентСервер.КраткийТекстОшибки(ИнформацияОбОшибке) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПередачаДанныхПереопределяемый.md b/src/content/docs/bsp/ПередачаДанныхПереопределяемый.md new file mode 100644 index 0000000..0a56d24 --- /dev/null +++ b/src/content/docs/bsp/ПередачаДанныхПереопределяемый.md @@ -0,0 +1,228 @@ +--- +title: Передача данных переопределяемый +slug: bsp/передача-данных-переопределяемый +--- + + +## МенеджерыЛогическихХранилищ +
+ +Описание, пример вызова + +```bsl + +// Определяет менеджеры логических хранилищ. +// +// Параметры: +// ВсеМенеджерыЛогическихХранилищ - Соответствие из Строка - менеджеры логических хранилищ: +// * Ключ - Строка - идентификатор логического хранилища; +// * Значение - ОбщийМодуль - менеджер логического хранилища. +// +//@skip-check module-empty-method +Процедура МенеджерыЛогическихХранилищ(ВсеМенеджерыЛогическихХранилищ) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхПереопределяемый.МенеджерыЛогическихХранилищ(ВсеМенеджерыЛогическихХранилищ) +``` +
+ +## МенеджерыФизическихХранилищ +
+ +Описание, пример вызова + +```bsl + +// Определяет менеджеры физических хранилищ. +// +// Параметры: +// ВсеМенеджерыФизическихХранилищ - Соответствие из Строка - менеджеры физических хранилищ: +// * Ключ - Строка - идентификатор физического хранилища; +// * Значение - ОбщийМодуль - менеджер физического хранилища. +// +//@skip-check module-empty-method +Процедура МенеджерыФизическихХранилищ(ВсеМенеджерыФизическихХранилищ) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхПереопределяемый.МенеджерыФизическихХранилищ(ВсеМенеджерыФизическихХранилищ) +``` +
+ +## ПериодДействияВременногоИдентификатора +
+ +Описание, пример вызова + +```bsl + +// Определяет период действия временного идентификатора. +// +// Параметры: +// ПериодДействияВременногоИдентификатора - Число - период действия временного идентификатора. +// +//@skip-check module-empty-method +Процедура ПериодДействияВременногоИдентификатора(ПериодДействияВременногоИдентификатора) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхПереопределяемый.ПериодДействияВременногоИдентификатора(ПериодДействияВременногоИдентификатора) +``` +
+ +## РазмерБлокаПолученияДанных +
+ +Описание, пример вызова + +```bsl + +// Определяет размер блока получения данных. +// +// Параметры: +// РазмерБлокаПолученияДанных - Число - размер блока получения данных в байтах. +// +//@skip-check module-empty-method +Процедура РазмерБлокаПолученияДанных(РазмерБлокаПолученияДанных) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхПереопределяемый.РазмерБлокаПолученияДанных(РазмерБлокаПолученияДанных) +``` +
+ +## РазмерБлокаОтправкиДанных +
+ +Описание, пример вызова + +```bsl + +// Определяет размер блока отправки данных. +// +// Параметры: +// РазмерБлокаОтправкиДанных - Число - размер блока отправки данных в байтах. +// +//@skip-check module-empty-method +Процедура РазмерБлокаОтправкиДанных(РазмерБлокаОтправкиДанных) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхПереопределяемый.РазмерБлокаОтправкиДанных(РазмерБлокаОтправкиДанных) +``` +
+ +## ОшибкаПриПолученииДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при ошибке получения данных. +// +// Параметры: +// Ответ - HTTPСервисОтвет - ответ сервиса при получении данных. +// +//@skip-check module-empty-method +Процедура ОшибкаПриПолученииДанных(Ответ) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхПереопределяемый.ОшибкаПриПолученииДанных(Ответ) +``` +
+ +## ОшибкаПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при ошибке отправки данных. +// +// Параметры: +// Ответ - HTTPСервисОтвет - ответ сервиса при отправке данных. +// +//@skip-check module-empty-method +Процедура ОшибкаПриОтправкеДанных(Ответ) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхПереопределяемый.ОшибкаПриОтправкеДанных(Ответ) +``` +
+ +## ПриПолученииИмениВременногоФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении имени временного файла. +// +// Параметры: +// ИмяВременногоФайла - Строка - имя временного файла. +// Расширение - Строка - желаемое расширение имени временного файла. +// ДополнительныеПараметры - Структура - дополнительные параметры временного файла. +// +//@skip-check module-empty-method +Процедура ПриПолученииИмениВременногоФайла(ИмяВременногоФайла, Расширение, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхПереопределяемый.ПриПолученииИмениВременногоФайла(ИмяВременногоФайла, Расширение, ДополнительныеПараметры) +``` +
+ +## ПриПродленииДействияВременногоИдентификатора +
+ +Описание, пример вызова + +```bsl + +// Вызывается при продлении действия временного идентификатора. +// +// Параметры: +// Идентификатор - Строка - идентификатор запроса. +// Дата - Дата - дата регистрации запроса. +// Запрос - Структура - исходный HTTP-запрос: +// * HTTPМетод - Строка - HTTP-метод; +// * БазовыйURL - Строка - базовая часть URL-запроса, включающая имя сервиса; +// * Заголовки - ФиксированноеСоответствие из Строка - заголовки HTTP-запроса; +// * ОтносительныйURL - Строка - относительную часть URL-адреса (относительно сервиса); +// * ПараметрыURL - ФиксированноеСоответствие из Строка - части URL-адреса, которые были параметризованы в шаблоне; +// * ПараметрыЗапроса - ФиксированноеСоответствие из Строка - параметры запроса (в строке URL-адреса параметры следуют после знака запроса); +// * ИдентификаторЗапроса - Строка - уникальный идентификатор запроса; +// * ТипЗапроса - Строка - тип запроса; +// * ИмяВременногоФайла - Строка - имя используемого временного файла. +// +//@skip-check module-empty-method +Процедура ПриПродленииДействияВременногоИдентификатора(Идентификатор, Дата, Запрос) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхПереопределяемый.ПриПродленииДействияВременногоИдентификатора(Идентификатор, Дата, Запрос) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПередачаДанныхПовтИсп.md b/src/content/docs/bsp/ПередачаДанныхПовтИсп.md new file mode 100644 index 0000000..2186763 --- /dev/null +++ b/src/content/docs/bsp/ПередачаДанныхПовтИсп.md @@ -0,0 +1,61 @@ +--- +title: Передача данных повт исп +slug: bsp/передача-данных-повт-исп +--- + + +## МенеджерыЛогическихХранилищ +
+ +Описание, пример вызова + +```bsl + +Функция МенеджерыЛогическихХранилищ() Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхПовтИсп.МенеджерыЛогическихХранилищ() +``` +
+ +## МенеджерыФизическихХранилищ +
+ +Описание, пример вызова + +```bsl + +Функция МенеджерыФизическихХранилищ() Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхПовтИсп.МенеджерыФизическихХранилищ() +``` +
+ +## Соединение +
+ +Описание, пример вызова + +```bsl + +Функция Соединение(СтруктураURI, Пользователь, Пароль, Таймаут) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхПовтИсп.Соединение(СтруктураURI, Пользователь, Пароль, Таймаут) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПередачаДанныхСервер.md b/src/content/docs/bsp/ПередачаДанныхСервер.md new file mode 100644 index 0000000..3588a03 --- /dev/null +++ b/src/content/docs/bsp/ПередачаДанныхСервер.md @@ -0,0 +1,300 @@ +--- +title: Передача данных сервер +slug: bsp/передача-данных-сервер +--- + + +## ВсеМенеджерыЛогическихХранилищ +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджеры логических хранилищ. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из Строка - менеджеры логических хранилищ: +// * Ключ - Строка - идентификатор логического хранилища; +// * Значение - ОбщийМодуль - менеджер логического хранилища. +// +Функция ВсеМенеджерыЛогическихХранилищ() Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСервер.ВсеМенеджерыЛогическихХранилищ() +``` +
+ +## ВсеМенеджерыФизическихХранилищ +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджеры физических хранилищ. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из Строка - менеджеры физических хранилищ: +// * Ключ - Строка - идентификатор физического хранилища; +// * Значение - ОбщийМодуль - менеджер физического хранилища. +// +Функция ВсеМенеджерыФизическихХранилищ() Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСервер.ВсеМенеджерыФизическихХранилищ() +``` +
+ +## ПолучитьИзЛогическогоХранилища +
+ +Описание, пример вызова + +```bsl + +// Получает данные из логического хранилища. +// +// Параметры: +// ПараметрыДоступа - Структура - поля: +// * URL - Строка - URL сервиса, обязательно должно присутствовать и быть заполненным; +// * UserName - Строка - имя пользователя; +// * Password - Строка - пароль пользователя. +// * Кэш - Соответствие из Строка - необязательный, пустое соответствие, если указан, может использоваться для кеширования. +// ИдентификаторХранилища - Строка - идентификатор логического хранилища. +// Идентификатор - Строка - идентификатор данных в логическом хранилище. +// Диапазон - Структура - +// * Начало - Число - первый байт. +// * Конец - Число - последний байт. +// ИмяФайла - Строка, Неопределено - Имя файла для записи данных. +// +// Возвращаемое значение: +// Неопределено, Структура - Получить из логического хранилища: +// * Имя - Строка - имя файла +// * ПолноеИмя - Строка - полное имя файла (включающее путь к файлу) +// +Функция ПолучитьИзЛогическогоХранилища(ПараметрыДоступа, ИдентификаторХранилища, Идентификатор, Диапазон = Неопределено, ИмяФайла = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСервер.ПолучитьИзЛогическогоХранилища(ПараметрыДоступа, ИдентификаторХранилища, Идентификатор, Диапазон, ИмяФайла); +``` +
+ +## ПолучитьРазмерФайлаИзЛогическогоХранилища +
+ +Описание, пример вызова + +```bsl + +// Получает информацию о файле из логического хранилища. +// +// Параметры: +// ПараметрыДоступа - Структура - поля: +// * URL - Строка - URL сервиса, обязательно должно присутствовать и быть заполненным; +// * UserName - Строка - имя пользователя; +// * Password - Строка - пароль пользователя. +// ИдентификаторХранилища - Строка - идентификатор логического хранилища. +// Идентификатор - Строка - идентификатор данных в логическом хранилище. +// +// Возвращаемое значение: +// Число - размер файла в байтах. +// +Функция ПолучитьРазмерФайлаИзЛогическогоХранилища(ПараметрыДоступа, ИдентификаторХранилища, Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСервер.ПолучитьРазмерФайлаИзЛогическогоХранилища(ПараметрыДоступа, ИдентификаторХранилища, Идентификатор) +``` +
+ +## ПолучитьИзФизическогоХранилища +
+ +Описание, пример вызова + +```bsl + +// Получает данные из физического хранилища. +// +// Параметры: +// ПараметрыДоступа - Структура - поля: +// * URL - Строка - URL сервиса, обязательно должно присутствовать и быть заполненным; +// * UserName - Строка - имя пользователя; +// * Password - Строка - пароль пользователя. +// ИдентификаторХранилища - Строка - идентификатор физического хранилища. +// Идентификатор - Строка - идентификатор данных в физическом хранилище. +// ИмяФайла - Строка, Неопределено - Имя файла для записи данных. +// +// Возвращаемое значение: +// Неопределено, Структура - описание файла: +// * Имя - Строка - имя файла; +// * ПолноеИмя - Строка - полное имя файла (включающее путь к файлу). +// +Функция ПолучитьИзФизическогоХранилища(ПараметрыДоступа, ИдентификаторХранилища, Идентификатор, ИмяФайла = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСервер.ПолучитьИзФизическогоХранилища(ПараметрыДоступа, ИдентификаторХранилища, Идентификатор, ИмяФайла); +``` +
+ +## ОтправитьВЛогическоеХранилище +
+ +Описание, пример вызова + +```bsl + +// Отправляет данные в логическое хранилище. +// +// Параметры: +// ПараметрыДоступа - Структура - поля: +// * URL - Строка - URL сервиса, обязательно должно присутствовать и быть заполненным; +// * UserName - Строка - имя пользователя; +// * Password - Строка - пароль пользователя. +// ИдентификаторХранилища - Строка - идентификатор логического хранилища. +// Данные - Строка - адрес данных во временном хранилище; +// - Строка - полное имя файла (включающее путь к файлу); +// - Файл - файловый объект; +// - ДвоичныеДанные - значение в виде двоичных данных. +// ИмяФайла - Строка - имя передаваемого файла. +// ДополнительныеПараметры - Структура - структура со значениями сериализуемыми в json. +// +// Возвращаемое значение: +// Число, Неопределено, Произвольный - +// +Функция ОтправитьВЛогическоеХранилище(ПараметрыДоступа, ИдентификаторХранилища, Данные, Знач ИмяФайла, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСервер.ОтправитьВЛогическоеХранилище(ПараметрыДоступа, ИдентификаторХранилища, Данные, ИмяФайла, ДополнительныеПараметры); +``` +
+ +## НачатьОтправкуВЛогическоеХранилище +
+ +Описание, пример вызова + +```bsl + +// Начинает отправку файла в логическое хранилище +// +// Параметры: +// ПараметрыДоступа - Структура - поля: +// * URL - Строка - URL сервиса, обязательно должно присутствовать и быть заполненным; +// * UserName - Строка - имя пользователя; +// * Password - Строка - пароль пользователя. +// ИдентификаторХранилища - Строка - идентификатор логического хранилища. +// Данные - Строка - адрес данных во временном хранилище; +// - Строка - полное имя файла (включающее путь к файлу); +// - Файл - файловый объект; +// - ДвоичныеДанные - значение в виде двоичных данных. +// ИмяФайла - Строка - имя передаваемого файла. +// ДополнительныеПараметры - Структура - структура со значениями сериализуемыми в json. +// +// Возвращаемое значение: +// Неопределено, Структура - поля: +// * Location - Неопределено, Произвольный - +// * SetCookie - Произвольный, Неопределено - +// * АдресS3 - Произвольный, Неопределено - +// * ИдентификаторФайлаS3 - Произвольный, Неопределено - +// * ПередачаЧастями - Булево +// +Функция НачатьОтправкуВЛогическоеХранилище(ПараметрыДоступа, ИдентификаторХранилища, Данные, Знач ИмяФайла, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСервер.НачатьОтправкуВЛогическоеХранилище(ПараметрыДоступа, ИдентификаторХранилища, Данные, ИмяФайла, ДополнительныеПараметры); +``` +
+ +## ОтправитьЧастьФайлаВЛогическоеХранилище +
+ +Описание, пример вызова + +```bsl + + +// Отправляет очередную часть +// +// Параметры: +// ПараметрыДоступа - Структура - поля: +// * URL - Строка - URL сервиса, обязательно должно присутствовать и быть заполненным; +// * UserName - Строка - имя пользователя; +// * Password - Строка - пароль пользователя. +// ПараметрыОтправки - Структура - поля: +// Location - Строка - +// SetCookie - Строка - +// АдресS3 - Строка - +// ИдентификаторФайлаS3 - Строка - +// ПередачаЧастями - Булево - +// Данные - Произвольный - +// ПоследняяЧасть - Булево - +// Смещение - Число - +// +// Возвращаемое значение: +// Число, Неопределено - Количество байт в случае успешной отправки, или Неопределено, если не получилось отправить +// +Функция ОтправитьЧастьФайлаВЛогическоеХранилище(ПараметрыДоступа, ПараметрыОтправки, Данные, ПоследняяЧасть = Истина, Смещение = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСервер.ОтправитьЧастьФайлаВЛогическоеХранилище(ПараметрыДоступа, ПараметрыОтправки, Данные, ПоследняяЧасть, Смещение); +``` +
+ +## ОтправитьВФизическоеХранилище +
+ +Описание, пример вызова + +```bsl + +// Отправляет данные в физическое хранилище. +// +// Параметры: +// ПараметрыДоступа - Структура - поля: +// * URL - Строка - URL сервиса, обязательно должно присутствовать и быть заполненным; +// * UserName - Строка - имя пользователя; +// * Password - Строка - пароль пользователя. +// ИдентификаторХранилища - Строка - идентификатор физического хранилища. +// Данные - Строка - адрес данных во временном хранилище; +// - Строка - полное имя файла (включающее путь к файлу); +// - Файл - файловый объект; +// - ДвоичныеДанные - значение в виде двоичных данных. +// ИмяФайла - Строка - имя передаваемого файла. +// +// +// Возвращаемое значение: +// Число, Неопределено, Произвольный - +// +Функция ОтправитьВФизическоеХранилище(ПараметрыДоступа, ИдентификаторХранилища, Данные, Знач ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСервер.ОтправитьВФизическоеХранилище(ПараметрыДоступа, ИдентификаторХранилища, Данные, ИмяФайла) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПередачаДанныхСлужебный.md b/src/content/docs/bsp/ПередачаДанныхСлужебный.md new file mode 100644 index 0000000..e7f54fb --- /dev/null +++ b/src/content/docs/bsp/ПередачаДанныхСлужебный.md @@ -0,0 +1,277 @@ +--- +title: Передача данных служебный +slug: bsp/передача-данных-служебный +--- + + +## ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов +
+ +Описание, пример вызова + +```bsl + +Процедура ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(Знач СтруктураПоддерживаемыхВерсий) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхСлужебный.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(СтруктураПоддерживаемыхВерсий) +``` +
+ +## Получить +
+ +Описание, пример вызова + +```bsl + +Функция Получить(ПараметрыДоступа, ИзФизическогоХранилища, ИдентификаторХранилища, Идентификатор, Диапазон = Неопределено, ИмяФайла = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.Получить(ПараметрыДоступа, ИзФизическогоХранилища, ИдентификаторХранилища, Идентификатор, Диапазон, ИмяФайла); +``` +
+ +## ПолучитьРазмерФайла +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьРазмерФайла(ПараметрыДоступа, ИзФизическогоХранилища, ИдентификаторХранилища, Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.ПолучитьРазмерФайла(ПараметрыДоступа, ИзФизическогоХранилища, ИдентификаторХранилища, Идентификатор) +``` +
+ +## Отправить +
+ +Описание, пример вызова + +```bsl + +Функция Отправить(ПараметрыДоступа, ВФизическоеХранилище, ИдентификаторХранилища, Данные, Знач ИмяФайла, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.Отправить(ПараметрыДоступа, ВФизическоеХранилище, ИдентификаторХранилища, Данные, ИмяФайла, ДополнительныеПараметры); +``` +
+ +## НачатьОтправку +
+ +Описание, пример вызова + +```bsl + +// Начинает отправку файла в хранилище +// +// Параметры: +// ПараметрыДоступа - Структура - поля: +// * URL - Строка - URL сервиса, обязательно должно присутствовать и быть заполненным; +// * UserName - Строка - имя пользователя; +// * Password - Строка - пароль пользователя. +// ВФизическоеХранилище - Булево - В физическое хранилище +// ИдентификаторХранилища - Строка - идентификатор логического хранилища. +// Данные - Строка - адрес данных во временном хранилище; +// - Строка - полное имя файла (включающее путь к файлу); +// - Файл - файловый объект; +// - ДвоичныеДанные - значение в виде двоичных данных. +// ИмяФайла - Строка - имя передаваемого файла. +// ДополнительныеПараметры - Структура - структура со значениями сериализуемыми в json. +// +// Возвращаемое значение: +// Неопределено, Структура - Начать отправку: +// * Location - Неопределено, Произвольный - +// * SetCookie - Неопределено, Произвольный - +// * АдресS3 - Неопределено, Произвольный - +// * ИдентификаторФайлаS3 - Неопределено, Произвольный - +// * ПередачаЧастями - Булево - +// +Функция НачатьОтправку(ПараметрыДоступа, ВФизическоеХранилище, ИдентификаторХранилища, Данные, Знач ИмяФайла, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.НачатьОтправку(ПараметрыДоступа, ВФизическоеХранилище, ИдентификаторХранилища, Данные, ИмяФайла, ДополнительныеПараметры); +``` +
+ +## ОтправитьЧастьФайла +
+ +Описание, пример вызова + +```bsl + +Функция ОтправитьЧастьФайла(ПараметрыДоступа, ПараметрыОтправки, Данные, ПоследняяЧасть = Истина, Смещение = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.ОтправитьЧастьФайла(ПараметрыДоступа, ПараметрыОтправки, Данные, ПоследняяЧасть, Смещение); +``` +
+ +## ПолученныйДиапазон +
+ +Описание, пример вызова + +```bsl + +Функция ПолученныйДиапазон(Запрос) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.ПолученныйДиапазон(Запрос) +``` +
+ +## ПериодДействияВременногоИдентификатора +
+ +Описание, пример вызова + +```bsl + +Функция ПериодДействияВременногоИдентификатора() Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.ПериодДействияВременногоИдентификатора() +``` +
+ +## РазмерБлокаПолученияДанных +
+ +Описание, пример вызова + +```bsl + +Функция РазмерБлокаПолученияДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.РазмерБлокаПолученияДанных() +``` +
+ +## РазмерБлокаОтправкиДанных +
+ +Описание, пример вызова + +```bsl + +Функция РазмерБлокаОтправкиДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.РазмерБлокаОтправкиДанных() +``` +
+ +## ОшибкаПриПолученииДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ОшибкаПриПолученииДанных(Ответ) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхСлужебный.ОшибкаПриПолученииДанных(Ответ) +``` +
+ +## ОшибкаПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ОшибкаПриОтправкеДанных(Ответ) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхСлужебный.ОшибкаПриОтправкеДанных(Ответ) +``` +
+ +## ИмяВременногоФайла +
+ +Описание, пример вызова + +```bsl + +Функция ИмяВременногоФайла(Расширение = Неопределено, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.ИмяВременногоФайла(Расширение, ДополнительныеПараметры); +``` +
+ +## ПриПродленииДействияВременногоИдентификатора +
+ +Описание, пример вызова + +```bsl + +Процедура ПриПродленииДействияВременногоИдентификатора(Идентификатор, МенеджерЗаписи) Экспорт +``` + +Пример вызова +```bsl +ПередачаДанныхСлужебный.ПриПродленииДействияВременногоИдентификатора(Идентификатор, МенеджерЗаписи) +``` +
+ +## ПолучитьДвоичныеДанныеИзS3 +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьДвоичныеДанныеИзS3(Адрес, Начало = Неопределено, Конец = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПередачаДанныхСлужебный.ПолучитьДвоичныеДанныеИзS3(Адрес, Начало, Конец); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПодборФИО.md b/src/content/docs/bsp/ПодборФИО.md new file mode 100644 index 0000000..7e093e1 --- /dev/null +++ b/src/content/docs/bsp/ПодборФИО.md @@ -0,0 +1,121 @@ +--- +title: Подбор ФИО +slug: bsp/подбор-фио +--- + + +## Подобрать +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат поиска по классификатору, пустой массив если данные не найдены. +// +// Параметры: +// РежимПоиска - Строка - Режим поиска значения по классификатору, может принимать следующие значения: +// "Фамилия", "Имя", "Отчество", "ФИО". +// ДанныеФИО - Структура, Неопределено - описывает данные ФИО, по которым будет выполняться поиск. +// В случае если значение параметра "Пол" пустое, будет использована для его определения по данным классификатора: +// * Фамилия - Строка, Неопределено - описывает фамилию лица (ее часть когда РежимПоиска = "Фамилия"). +// Свойство может не передаваться. +// * Имя - Строка, Неопределено - описывает имя лица (его часть когда РежимПоиска = "Имя"). +// Свойство может не передаваться. +// * Отчество - Строка, Неопределено - описывает отчество лица (его часть когда РежимПоиска = "Отчество"). +// Свойство может не передаваться. +// * Представление - Строка - описывает ФИО лица (в тех случаях когда РежимПоиска = "ФИО"). +// Свойство может не передаваться. +// Пол - Число - задает значение пола для поиска значения в классификаторе, может принимать значения: +// 0 - не задан(будет определен по данным структуры ДанныеФИО), 1- мужской, 2 - женский, 3 - допустимы оба. +// РазмерВыборки - Число - определяет размер выборки данных классификатора. +// Возвращаемое значение: +// Массив из Строка - данные поиска по классификатору, отсортированные по популярности. +// +Функция Подобрать(РежимПоиска, ДанныеФИО = Неопределено, Пол = 0, РазмерВыборки = 10) Экспорт +``` + +Пример вызова +```bsl +Результат = ПодборФИО.Подобрать(РежимПоиска, ДанныеФИО, Пол, РазмерВыборки); +``` +
+ +## ОпределитьПол +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат определения пола по данным классификатора. +// +// Параметры: +// ДанныеФИО - Структура, Неопределено - описывает данные ФИО, по которым будет выполняться поиск. +// Если передано свойство "Представление", поиск будет выполнятся по нему. +// * Фамилия - Строка - описывает фамилию лица. Свойство может не передаваться. +// * Имя - Строка - описывает имя лица. Свойство может не передаваться. +// * Отчество - Строка - описывает отчество лица. Свойство может не передаваться. +// * Представление - Строка - описывает ФИО лица. Свойство может не передаваться. +// Возвращаемое значение: +// Число - значение пола по данным классификатора, может принимать значения: +// 1- мужской, 2 - женский, 3 - допустимы оба. +// +Функция ОпределитьПол(ДанныеФИО) Экспорт +``` + +Пример вызова +```bsl +Результат = ПодборФИО.ОпределитьПол(ДанныеФИО) +``` +
+ +## НайтиФИО +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск значений в классификатора по переданным частям ФИО. +// +// Параметры: +// ЧастиФИО - Массив из Строка - данные для поиска в классификаторе. +// ПолноеСовпадение - Булево - режим поиска. Если установлено Истина при поиске +// будет проверяться равенство строки поиска с значением классификаторов, +// если Ложь, для сравнения используется ПОДОБНО. Допускается указывать +// параметры не точного поиска, например, Пет%. +// +// Возвращаемое значение: +// Структура - результат поиска: +// * Фамилии - Массив из Структура - найденные фамилии: +// ** Значение - Строка - найденное значение; +// ** ПриоритетОтображения - Число - приоритет значения; +// Свойство может не передаваться. +// * Имена - Массив из Структура - найденные имена: +// ** Значение - Строка - найденное значение; +// ** ПриоритетОтображения - Число - приоритет значения; +// * Отчества - Массив из Структура - найденные отчества: +// ** Значение - Строка - найденное значение; +// +// Пример: +// ЧастиФИО = Новый Массив; +// ЧастиФИО.Добавить("Пет%"); +// Результат = ПодборФИО.НайтиФИО(ЧастиФИО, Ложь); +// +Функция НайтиФИО(ЧастиФИО, ПолноеСовпадение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ПодборФИО.НайтиФИО(ЧастиФИО, ПолноеСовпадение); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПодборФИОВызовСервера.md b/src/content/docs/bsp/ПодборФИОВызовСервера.md new file mode 100644 index 0000000..768797f --- /dev/null +++ b/src/content/docs/bsp/ПодборФИОВызовСервера.md @@ -0,0 +1,42 @@ +--- +title: Подбор ФИО вызов сервера +slug: bsp/подбор-фио-вызов-сервера +--- + + +## ОпределитьПол +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат определения пола по данным классификатора. +// +// Параметры: +// ДанныеФИО - Структура, Неопределено - описывает данные ФИО, по которым будет выполняться поиск. +// Если передано свойство "Представление", поиск будет выполнятся по нему. +// * Фамилия - Строка - описывает фамилию лица. Свойство может не передаваться. +// * Имя - Строка - описывает имя лица. Свойство может не передаваться. +// * Отчество - Строка - описывает отчество лица. Свойство может не передаваться. +// * Представление - Строка - описывает ФИО лица. Свойство может не передаваться. +// Возвращаемое значение: +// Число - значение пола по данным классификатора, может принимать значения: +// 1- мужской, 2 - женский, 3 - допустимы оба. +// +Функция ОпределитьПол(Знач ДанныеФИО) Экспорт +``` + +Пример вызова +```bsl +Результат = ПодборФИОВызовСервера.ОпределитьПол(ДанныеФИО) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПодборФИОКлиент.md b/src/content/docs/bsp/ПодборФИОКлиент.md new file mode 100644 index 0000000..f62f233 --- /dev/null +++ b/src/content/docs/bsp/ПодборФИОКлиент.md @@ -0,0 +1,121 @@ +--- +title: Подбор ФИО клиент +slug: bsp/подбор-фио-клиент +--- + + +## Подобрать +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат поиска по классификатору, пустой массив если данные не найдены. +// +// Параметры: +// РежимПоиска - Строка - Режим поиска значения по классификатору, может принимать следующие значения: +// "Фамилия" "Имя", "Отчество", "ФИО". +// ДанныеФИО - Структура, Неопределено - описывает данные ФИО, по которым будет выполняться поиск. +// В случае если значение параметра "Пол" пустое, будет использована для его определения по данным классификатора: +// * Фамилия - Строка, Неопределено - описывает фамилию лица (ее часть когда РежимПоиска = "Фамилия"). +// Свойство может не передаваться. +// * Имя - Строка, Неопределено - описывает имя лица (его часть когда РежимПоиска = "Имя"). +// Свойство может не передаваться. +// * Отчество - Строка, Неопределено - описывает отчество лица (его часть когда РежимПоиска = "Отчество"). +// Свойство может не передаваться. +// * Представление - Строка - описывает ФИО лица (в тех случаях когда РежимПоиска = "ФИО"). +// Свойство может не передаваться. +// Пол - Число - задает значение пола для поиска значения в классификаторе, может принимать значения: +// 0 - не задан(будет определен по данным структуры ДанныеФИО), 1- мужской, 2 - женский, 3 - допустимы оба. +// РазмерВыборки - Число - определяет размер выборки данных классификатора. +// Возвращаемое значение: +// Массив из Строка - данные поиска по классификатору, отсортированные по популярности. +// +Функция Подобрать( Экспорт +``` + +Пример вызова +```bsl +Результат = ПодборФИОКлиент.Подобрать(); +``` +
+ +## ОпределитьПол +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат определения пола по данным классификатора. +// +// Параметры: +// ДанныеФИО - Структура, Неопределено - описывает данные ФИО, по которым будет выполняться поиск. +// Если передано свойство "Представление", поиск будет выполнятся по нему. +// * Фамилия - Строка - описывает фамилию лица. Свойство может не передаваться. +// * Имя - Строка - описывает имя лица. Свойство может не передаваться. +// * Отчество - Строка - описывает отчество лица. Свойство может не передаваться. +// * Представление - Строка - описывает ФИО лица. Свойство может не передаваться. +// Возвращаемое значение: +// Число - значение пола по данным классификатора, может принимать значения: +// 1- мужской, 2 - женский, 3 - допустимы оба. +// +Функция ОпределитьПол(ДанныеФИО) Экспорт +``` + +Пример вызова +```bsl +Результат = ПодборФИОКлиент.ОпределитьПол(ДанныеФИО) +``` +
+ +## НайтиФИО +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск значений в классификатора по переданным частям ФИО. +// +// Параметры: +// ЧастиФИО - Массив из Строка - данные для поиска в классификаторе. +// ПолноеСовпадение - Булево - режим поиска. Если установлено Истина при поиске +// будет проверяться равенство строки поиска с значением классификаторов, +// если Ложь, для сравнения используется ПОДОБНО. Допускается указывать +// параметры не точного поиска, например, Пет%. +// +// Возвращаемое значение: +// Структура - результат поиска: +// * Фамилии - Массив из Структура - найденные фамилии: +// ** Значение - Строка - найденное значение; +// ** ПриоритетОтображения - Число - приоритет значения; +// Свойство может не передаваться. +// * Имена - Массив из Структура - найденные имена: +// ** Значение - Строка - найденное значение; +// ** ПриоритетОтображения - Число - приоритет значения; +// * Отчества - Массив из Структура - найденные отчества: +// ** Значение - Строка - найденное значение; +// +// Пример: +// ЧастиФИО = Новый Массив; +// ЧастиФИО.Добавить("Пет%"); +// Результат = ПодборФИО.НайтиФИО(ЧастиФИО, Ложь); +// +Функция НайтиФИО( Экспорт +``` + +Пример вызова +```bsl +Результат = ПодборФИОКлиент.НайтиФИО(); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПодключаемыеКоманды.md b/src/content/docs/bsp/ПодключаемыеКоманды.md new file mode 100644 index 0000000..6b77d7d --- /dev/null +++ b/src/content/docs/bsp/ПодключаемыеКоманды.md @@ -0,0 +1,170 @@ +--- +title: Подключаемые команды +slug: bsp/подключаемые-команды +--- + + +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Выводит подключенные команды в форме. +// Для вызова из обработчика формы ПриСозданииНаСервере. +// +// Если в форме несколько списков, то в обработчике формы ПриСозданииНаСервере +// следует разместить несколько вызовов этой процедуры с указанием параметра ПараметрыРазмещения. +// Параметр ПараметрыРазмещения также применяется, когда типы источников зависят от параметров открытия формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой необходимо разместить команды. +// ПараметрыРазмещения - см. ПодключаемыеКоманды.ПараметрыРазмещения +// - Неопределено +// +Процедура ПриСозданииНаСервере(Форма, Знач ПараметрыРазмещения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКоманды.ПриСозданииНаСервере(Форма, ПараметрыРазмещения); +``` +
+ +## ПараметрыРазмещения +
+ +Описание, пример вызова + +```bsl + +// Конструктор одноименного параметра процедуры ПодключаемыеКоманды.ПриСозданииНаСервере. +// +// Возвращаемое значение: +// Структура - параметры размещения подключаемых команд: +// * Источники - ОписаниеТипов +// - Массив из ОбъектМетаданных - источники команд. +// Используется для второстепенных списков, а также в формах объектов, не являющихся поставщиками +// команд (обработки, общие формы). +// * КоманднаяПанель - ГруппаФормы - командная панель или группа команд, в которой выводятся подменю. +// Используется как родитель для создания подменю в случае их отсутствия. +// Если не указан то в первую очередь ищется группа "ПодключаемыеКоманды". +// * ПрефиксГрупп - Строка - добавка к именам подменю и имени командной панели. +// Используется при необходимости префиксации групп с командами (в частности, когда в форме несколько таблиц). +// В качестве префикса рекомендуется использовать имя таблицы формы, для которой выводятся команды. +// Например, если ПрефиксГрупп = "СкладскиеДокументы" (имя второстепенной таблицы формы), +// то используются подменю с именами "СкладскиеДокументыПодменюПечать", "СкладскиеДокументыПодменюОтчеты" и т.д. +// * ВладелецКоманд - ДанныеФормыСтруктура, ТаблицаФормы - объект или элемент формы, для которого выводятся команды. +// +Функция ПараметрыРазмещения() Экспорт +``` + +Пример вызова +```bsl +Результат = ПодключаемыеКоманды.ПараметрыРазмещения() +``` +
+ +## ВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды формы, требующей контекстного вызова сервера. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой выполняется команда. +// ПараметрыВызова - Структура +// Источник - ТаблицаФормы +// - ДанныеФормыСтруктура - объект или список формы с полем "Ссылка". +// Результат - Структура - результат выполнения команды. +// +Процедура ВыполнитьКоманду(Знач Форма, Знач ПараметрыВызова, Знач Источник = Неопределено, Результат = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКоманды.ВыполнитьКоманду(Форма, ПараметрыВызова, Источник, Результат); +``` +
+ +## ДобавитьУсловиеВидимостиКоманды +
+ +Описание, пример вызова + +```bsl + +// Задает условия видимости команды на форме в зависимости от контекста. +// +// Параметры: +// Команда - СтрокаТаблицыЗначений из см. УправлениеПечатью.СоздатьКоллекциюКомандПечати +// Реквизит - Строка - имя реквизита объекта. +// Значение - Произвольный - значение реквизита объекта. Параметр обязательный для всех видов +// сравнения кроме Заполнено и НеЗаполнено. +// ВидСравнения - ВидСравненияКомпоновкиДанных - вид сравнения значений. +// Допустимо использовать следующие виды сравнения: +// ВидСравненияКомпоновкиДанных.Равно, +// ВидСравненияКомпоновкиДанных.НеРавно, +// ВидСравненияКомпоновкиДанных.Заполнено, +// ВидСравненияКомпоновкиДанных.НеЗаполнено, +// ВидСравненияКомпоновкиДанных.ВСписке, +// ВидСравненияКомпоновкиДанных.НеВСписке, +// ВидСравненияКомпоновкиДанных.Больше, +// ВидСравненияКомпоновкиДанных.Меньше, +// ВидСравненияКомпоновкиДанных.БольшеИлиРавно, +// ВидСравненияКомпоновкиДанных.МеньшеИлиРавно. +// Значение по умолчанию - ВидСравненияКомпоновкиДанных.Равно. +// +Процедура ДобавитьУсловиеВидимостиКоманды(Команда, Реквизит, Значение = Неопределено, Знач ВидСравнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКоманды.ДобавитьУсловиеВидимостиКоманды(Команда, Реквизит, Значение, ВидСравнения); +``` +
+ +## ПараметрыВыполненияКоманды +
+ +Описание, пример вызова + +```bsl + +// Свойства второго параметра обработчика подключаемой команды, выполняемой на сервере. +// +// Возвращаемое значение: +// Структура: +// * ОписаниеКоманды - Структура - состав свойств совпадает с колонками таблицы значений параметра Команды процедуры +/// ПодключаемыеКомандыПереопределяемый.ПриОпределенииКомандПодключенныхКОбъекту. +// Ключевые свойства: +// ** Идентификатор - Строка - идентификатор команды. +// ** Представление - Строка - представление команды в форме. +// ** Имя - Строка - имя команды в форме. +// ** ДополнительныеПараметры - Структура - дополнительные свойства, состав которых определяется видом +// конкретной команды. +// * Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана команда. +// * ЭтоФормаОбъекта - Булево - Истина, если команда вызвана из формы объекта. +// * Источник - ТаблицаФормы +// - ДанныеФормыСтруктура - объект или список формы с полем "Ссылка". +// +Функция ПараметрыВыполненияКоманды() Экспорт +``` + +Пример вызова +```bsl +Результат = ПодключаемыеКоманды.ПараметрыВыполненияКоманды() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПодключаемыеКомандыКлиент.md b/src/content/docs/bsp/ПодключаемыеКомандыКлиент.md new file mode 100644 index 0000000..acb4152 --- /dev/null +++ b/src/content/docs/bsp/ПодключаемыеКомандыКлиент.md @@ -0,0 +1,144 @@ +--- +title: Подключаемые команды клиент +slug: bsp/подключаемые-команды-клиент +--- + + +## НачатьВыполнениеКоманды +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой выполняется команда. +// Команда - КомандаФормы - выполняемая команда. +// Источник - ТаблицаФормы +// - ДанныеФормыСтруктура - объект или список формы с полем "Ссылка". +// +Процедура НачатьВыполнениеКоманды(Форма, Команда, Знач Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКомандыКлиент.НачатьВыполнениеКоманды(Форма, Команда, Источник); +``` +
+ +## ВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой выполняется команда. +// Команда - КомандаФормы - выполняемая команда. +// Источник - ТаблицаФормы +// - ДанныеФормыСтруктура +// - ЛюбаяСсылка +// - Массив - объект или список формы с полем "Ссылка", +// Ссылка или массив ссылок. +// +Процедура ВыполнитьКоманду(Форма, Команда, Источник) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКомандыКлиент.ВыполнитьКоманду(Форма, Команда, Источник) +``` +
+ +## НачатьОбновлениеКоманд +
+ +Описание, пример вызова + +```bsl + +// Обновляет список команд в зависимости от текущего контекста формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// +Процедура НачатьОбновлениеКоманд(Форма) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКомандыКлиент.НачатьОбновлениеКоманд(Форма) +``` +
+ +## ПослеЗаписи +
+ +Описание, пример вызова + +```bsl + +// Продолжает выполнение команды, если выполнение было прервано в обработчике события формы ПередЗаписью. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой выполняется команда. +// Объект - ДанныеФормыСтруктура +// - ЛюбаяСсылка - объект формы с полем "Ссылка". +// ПараметрыЗаписи - Структура - произвольные параметры записи. См. описание события ПослеЗаписи в синтакс-помощнике. +// +Процедура ПослеЗаписи(Форма, Объект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКомандыКлиент.ПослеЗаписи(Форма, Объект, ПараметрыЗаписи) +``` +
+ +## ПараметрыВыполненияКоманды +
+ +Описание, пример вызова + +```bsl + +// Свойства второго параметра обработчика подключаемой команды, выполняемой на клиенте. +// +// Возвращаемое значение: +// Структура: +// * ОписаниеКоманды - Структура - состав свойств совпадает с колонками таблицы значений параметра Команды процедуры +/// ПодключаемыеКомандыПереопределяемый.ПриОпределенииКомандПодключенныхКОбъекту. +// Ключевые свойства: +// ** Идентификатор - Строка - идентификатор команды. +// ** Представление - Строка - представление команды в форме. +// ** Имя - Строка - имя команды в форме. +// ** ДополнительныеПараметры - Структура - дополнительные свойства, состав которых определяется видом +// конкретной команды. +// * Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана команда. +// - РасширениеУправляемойФормыДляДокумента +// * ЭтоФормаОбъекта - Булево - Истина, если команда вызвана из формы объекта. +// * Источник - ТаблицаФормы +// - ДанныеФормыСтруктура - объект или список формы с полем "Ссылка": +// ** Ссылка - ЛюбаяСсылка +// +Функция ПараметрыВыполненияКоманды() Экспорт +``` + +Пример вызова +```bsl +Результат = ПодключаемыеКомандыКлиент.ПараметрыВыполненияКоманды() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПодключаемыеКомандыКлиентСервер.md b/src/content/docs/bsp/ПодключаемыеКомандыКлиентСервер.md new file mode 100644 index 0000000..d2bb05e --- /dev/null +++ b/src/content/docs/bsp/ПодключаемыеКомандыКлиентСервер.md @@ -0,0 +1,36 @@ +--- +title: Подключаемые команды клиент сервер +slug: bsp/подключаемые-команды-клиент-сервер +--- + + +## ОбновитьКоманды +
+ +Описание, пример вызова + +```bsl + +// Обновляет список команд в зависимости от текущего контекста. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, для которой требуется обновление команд. +// Источник - ДанныеФормыСтруктура +// - ТаблицаФормы - контекст для проверки условий (Форма.Объект или Форма.Элементы.Список). +// +Процедура ОбновитьКоманды(Форма, Знач Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКомандыКлиентСервер.ОбновитьКоманды(Форма, Источник); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПодключаемыеКомандыПереопределяемый.md b/src/content/docs/bsp/ПодключаемыеКомандыПереопределяемый.md new file mode 100644 index 0000000..9a37870 --- /dev/null +++ b/src/content/docs/bsp/ПодключаемыеКомандыПереопределяемый.md @@ -0,0 +1,213 @@ +--- +title: Подключаемые команды переопределяемый +slug: bsp/подключаемые-команды-переопределяемый +--- + + +## ПриОпределенииВидовПодключаемыхКоманд +
+ +Описание, пример вызова + +```bsl + +// С помощью ПриОпределенииВидовПодключаемыхКоманд можно определить собственные виды подключаемых команд, +// помимо уже предусмотренных в стандартной поставке (печатные формы, отчеты и команды заполнения). +// +// Параметры: +// ВидыПодключаемыхКоманд - ТаблицаЗначений - поддерживаемые виды команд: +// * Имя - Строка - имя вида команд. Должно удовлетворять требованиям именования переменных и +// быть уникальным (не совпадать с именами других видов). +// Может соответствовать имени подсистемы, отвечающей за вывод этих команд. +// Следующие имена зарезервированы: "Печать", "Отчеты", "ЗаполнениеОбъектов". +// * ИмяПодменю - Строка - имя подменю для размещения команд этого вида на формах объектов. +// * Заголовок - Строка - наименование подменю, выводимое пользователю. +// * Картинка - Картинка - картинка подменю. +// * Отображение - ОтображениеКнопки - режим отображения подменю. +// * Порядок - Число - порядок подменю в командной панели формы объекта по отношению +// к другим подменю. Используется при автоматическом создании подменю +// в форме объекта. +// +// Пример: +// +// Вид = ВидыПодключаемыхКоманд.Добавить(); +// Вид.Имя = "Мотиваторы"; +// Вид.ИмяПодменю = "ПодменюМотиваторов"; +// Вид.Заголовок = НСтр("ru = 'Мотиваторы'"); +// Вид.Картинка = БиблиотекаКартинок.Информация; +// Вид.Отображение = ОтображениеКнопки.КартинкаИТекст; +// +Процедура ПриОпределенииВидовПодключаемыхКоманд(ВидыПодключаемыхКоманд) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКомандыПереопределяемый.ПриОпределенииВидовПодключаемыхКоманд(ВидыПодключаемыхКоманд) +``` +
+ +## ПриОпределенииСоставаНастроекПодключаемыхОбъектов +
+ +Описание, пример вызова + +```bsl + +// Позволяет расширить состав параметра Настройки процедуры ПриОпределенииНастроек в модулях менеджеров отчетов и +// обработок, включенных в состав подсистемы ПодключаемыеОтчетыИОбработки, с помощью чего отчеты и обработки могут +// сообщить о себе, что они предоставляют определенные виды команд и взаимодействуют с подсистемами через их +// программный интерфейс. +// +// Параметры: +// НастройкиПрограммногоИнтерфейса - ТаблицаЗначений: +// * Ключ - Строка - имя настройки, например "ДобавитьМотиваторы". +// * ОписаниеТипов - ОписаниеТипов - тип настройки, например: Новый ОписаниеТипов("Булево"). +// * ВидыПодключаемыхОбъектов - Строка - имена видов объектов метаданных, для которых будет доступна эта настройка, +// перечисленные через запятую. Например: "Отчет" или "Отчет, Обработка". +// +// Пример: +// Для того чтобы в ПриОпределенииНастроек модуля обработки предусмотреть собственный признак ДобавитьМотиваторы: +// Процедура ПриОпределенииНастроек(Настройки) Экспорт +// Настройки.ДобавитьМотиваторы = Истина; // вызывается процедура ДобавитьМотиваторы +// Настройки.Размещение.Добавить(Метаданные.Документы.Анкеты); +// КонецПроцедуры +// +// следует реализовать следующий код: +// Настройка = НастройкиПрограммногоИнтерфейса.Добавить(); +// Настройка.Ключ = "ДобавитьМотиваторы"; +// Настройка.ОписаниеТипов = Новый ОписаниеТипов("Булево"); +// Настройка.ВидыПодключаемыхОбъектов = "Обработка"; +// +Процедура ПриОпределенииСоставаНастроекПодключаемыхОбъектов(НастройкиПрограммногоИнтерфейса) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКомандыПереопределяемый.ПриОпределенииСоставаНастроекПодключаемыхОбъектов(НастройкиПрограммногоИнтерфейса) +``` +
+ +## ПриОпределенииКомандПодключенныхКОбъекту +
+ +Описание, пример вызова + +```bsl + +// Вызывается однократно при первом формировании списка команд, выводимых в форме конкретного объекта конфигурации. +// Список добавленных команд следует вернуть в параметре Команды. +// Результат кэшируется с помощью модуля с повторными использованием возвращаемых значений (в разрезе имен форм). +// +// Параметры: +// НастройкиФормы - Структура - сведения о форме, в которой выводятся команды. Для чтения: +// * ИмяФормы - Строка - полное имя формы, в которой выводятся подключаемые команды. +// Например, "Документ.Анкета.ФормаСписка". +// +// Источники - ДеревоЗначений - сведения о поставщиках команд этой формы. +// На втором уровне дерева могут располагаться источники, регистрируемые автоматически при регистрации владельца. +// Например, документы-регистраторы журналов: +// * Метаданные - ОбъектМетаданных - метаданные объекта. +// * ПолноеИмя - Строка - полное имя объекта. Например: "Документ.ИмяДокумента". +// * Вид - Строка - вид объекта в верхнем регистре. Например: "СПРАВОЧНИК". +// * Менеджер - Произвольный - модуль менеджера объекта, или Неопределено, если у объекта +// нет модуля менеджера или если его не удалось получить. +// * Ссылка - СправочникСсылка.ИдентификаторыОбъектовМетаданных - ссылка объекта метаданных. +// * ЭтоЖурналДокументов - Булево - Истина, если объект является журналом документов. +// * ТипСсылкиДанных - Тип +// - ОписаниеТипов - тип ссылки элемента. +// +// ПодключенныеОтчетыИОбработки - ТаблицаЗначений - отчеты и обработки, предоставляющие свои команды +// для объектов Источники: +// * ПолноеИмя - Строка - полное имя объекта метаданных. +// * Менеджер - Произвольный - модуль менеджера объекта метаданных. +// Состав колонок см. в ПодключаемыеКомандыПереопределяемый.ПриОпределенииСоставаНастроекПодключаемыхОбъектов. +// +// Команды - ТаблицаЗначений - записать в этот параметр сформированные команды для вывода в подменю: +// * Вид - Строка - вид команды. +// Подробнее см. ПодключаемыеКомандыПереопределяемый.ПриОпределенииВидовПодключаемыхКоманд. +// * Идентификатор - Строка - идентификатор команды. +// +// 1) Настройки внешнего вида. +// * Представление - Строка - представление команды в форме. +// * Важность - Строка - суффикс подгруппы в меню, в которой следует вывести эту команду. +// Допустимо использовать: "Важное", "Обычное" и "СмТакже". +// * Порядок - Число - порядок размещения команды в группе. Используется для настройки под конкретное +// рабочее место. Допустимо задавать в диапазоне от 1 до 100. По умолчанию порядок 50. +// * Картинка - Картинка - картинка команды. Необязательный. +// * СочетаниеКлавиш - СочетаниеКлавиш - сочетание клавиш для быстрого вызова команды. Необязательный. +// * ТолькоВоВсехДействиях - Булево - отображать команду только в меню Еще. +// * ЗначениеПометки - Строка - путь к реквизиту, где содержится значение пометки команды. Если источником команд является +// Таблица формы, то возможно использовать параметр %Источник%. +// Например: +// "ЗначениеПометок.%Источник%", где ЗначениеПометок - реквизит формы произвольного типа, +// в котором содержится структура. +// "Объект.ПометкаУдаления", где Объект - реквизит формы с типом СправочникОбъект. +// +// 2) Настройки видимости и доступности. +// * ТипПараметра - ОписаниеТипов - типы объектов, для которых предназначена эта команда. +// * ВидимостьВФормах - Строка - имена форм через запятую, в которых должна отображаться команда. +// Используется, когда состав команд отличается для различных форм. +// * Назначение - Строка - определяет вид форм, для которых предназначена команда. +// Принимаемые значения: +// "ДляСписка" - показывать команду только в форме списка, +// "ДляОбъекта" - показывать команду только в форме объекта. +// Если параметр не указан, то команда предназначена для любых видов форм. +// * ФункциональныеОпции - Строка - имена функциональных опций через запятую, определяющих видимость команды. +// * УсловияВидимости - Массив - определяет видимость команды в зависимости от контекста. +// Для регистрации условий следует использовать процедуру +// ПодключаемыеКоманды.ДобавитьУсловиеВидимостиКоманды(). +// Условия объединяются по "И". +// * ИзменяетВыбранныеОбъекты - Булево - определяет доступность команды в ситуации, +// когда у пользователя нет прав на изменение объекта. +// Если Истина, то в описанной выше ситуации кнопка будет недоступна. +// Необязательный. Значение по умолчанию - Ложь. +// +// 3) Настройки процесса выполнения. +// * МножественныйВыбор - Булево - если Истина, то команда поддерживает множественный выбор. +// В этом случае в параметре выполнения будет передан список ссылок. +// Необязательный. Значение по умолчанию - Истина. +// * РежимЗаписи - Строка - действия, связанные с записью объекта, которые выполняются перед обработчиком команды: +// "НеЗаписывать" - объект не записывается, а в параметрах обработчика вместо ссылок передается +// вся форма. В этом режиме рекомендуется работать напрямую с формой, +// которая передается в структуре 2-го параметра обработчика команды. +// "ЗаписыватьТолькоНовые" - записывать новые объекты. +// "Записывать" - записывать новые и модифицированные объекты. +// "Проводить" - проводить документы. +// Перед записью и проведением у пользователя запрашивается подтверждение. +// Необязательный. Значение по умолчанию - "Записывать". +// * ТребуетсяРаботаСФайлами - Булево - если Истина, то в веб-клиенте предлагается +// установить расширение для работы с 1С:Предприятием. Необязательный. Значение по умолчанию - Ложь. +// +// 4) Настройки обработчика. +// * Менеджер - Строка - объект, отвечающий за выполнение команды. +// * ИмяФормы - Строка - имя формы, которую требуется получить для выполнения команды. +// Если Обработчик не указан, то у формы вызывается метод "Открыть". +// * ИмяПараметраФормы - Строка - имя параметра формы, в который следует передать ссылку или массив ссылок. +// * ПараметрыФормы - Неопределено +// - Структура - параметры формы, указанной в ИмяФормы. Необязательный. +// * Обработчик - Строка - описание процедуры, обрабатывающей основное действие команды, в виде: +// "<ИмяОбщегоМодуля>.<ИмяПроцедуры>", если процедура размещена в общем модуле; +// либо "<ИмяПроцедуры>" - в следующих случаях: +// если ИмяФормы заполнено, то в модуле указанной формы ожидается клиентская процедура; +// если ИмяФормы не заполнено, то в модуле менеджера этого объекта ожидается серверная процедура. +// В обработчик передаются два параметра: +// ## ПараметрКоманды - Массив из ЛюбаяСсылка - список объектов, для которых выполняется команда; +// ## ПараметрыВыполненияКоманды - см. ПодключаемыеКомандыКлиент.ПараметрыВыполненияКоманды +// * ДополнительныеПараметры - Структура - параметры обработчика, указанного в Обработчик. Необязательный. +// +Процедура ПриОпределенииКомандПодключенныхКОбъекту(НастройкиФормы, Источники, ПодключенныеОтчетыИОбработки, Команды) Экспорт +``` + +Пример вызова +```bsl +ПодключаемыеКомандыПереопределяемый.ПриОпределенииКомандПодключенныхКОбъекту(НастройкиФормы, Источники, ПодключенныеОтчетыИОбработки, Команды) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПодсистемыКонфигурацииПереопределяемый.md b/src/content/docs/bsp/ПодсистемыКонфигурацииПереопределяемый.md new file mode 100644 index 0000000..172a2ac --- /dev/null +++ b/src/content/docs/bsp/ПодсистемыКонфигурацииПереопределяемый.md @@ -0,0 +1,43 @@ +--- +title: Подсистемы конфигурации переопределяемый +slug: bsp/подсистемы-конфигурации-переопределяемый +--- + + +## ПриДобавленииПодсистем +
+ +Описание, пример вызова + +```bsl + +// Определяет список модулей библиотек и конфигурации, которые предоставляют +// основные сведения о себе: имя, версия, список обработчиков обновления +// а также зависимости от других библиотек. +// +// Состав обязательных процедур такого модуля см. в общем модуле ОбновлениеИнформационнойБазыБСП +// (область ПрограммныйИнтерфейс). +// При этом сам модуль Библиотеки стандартных подсистем ОбновлениеИнформационнойБазыБСП +// не требуется явно добавлять в массив МодулиПодсистем. +// +// Параметры: +// МодулиПодсистем - Массив - имена серверных общих модулей библиотек и конфигурации. +// Например: "ОбновлениеИнформационнойБазыБРО" - библиотека, +// "ОбновлениеИнформационнойБазыБП" - конфигурация. +// +Процедура ПриДобавленииПодсистем(МодулиПодсистем) Экспорт +``` + +Пример вызова +```bsl +ПодсистемыКонфигурацииПереопределяемый.ПриДобавленииПодсистем(МодулиПодсистем) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПоискИУдалениеДублей.md b/src/content/docs/bsp/ПоискИУдалениеДублей.md new file mode 100644 index 0000000..f08716c --- /dev/null +++ b/src/content/docs/bsp/ПоискИУдалениеДублей.md @@ -0,0 +1,136 @@ +--- +title: Поиск и удаление дублей +slug: bsp/поиск-и-удаление-дублей +--- + + +## НайтиДублиЭлемента +
+ +Описание, пример вызова + +```bsl + +// Поиск дублей для указанного значения ЭталонныйОбъект. +// +// Параметры: +// ОбластьПоиска - Строка - имя таблицы данных (полное имя метаданных) области поиска. +// Например, "Справочник.Номенклатура". Поддерживается поиск в справочниках, +// планах видов характеристик, видах расчетов, планах счетов. +// ЭталонныйОбъект - ЛюбаяСсылка, СправочникОбъект - элемент, для которого производится поиск дублей. +// ДополнительныеПараметры - Произвольный - параметр для передачи в обработчики событий менеджера. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Ссылка - ЛюбаяСсылка - ссылка элемента. +// * Код - Строка +// - Число - код элемента. +// * Наименование - Строка - наименование элемента. +// * Родитель - ЛюбаяСсылка - родитель группы дублей. Если Родитель пустой, то элемент является +// родителем группы дублей. +// * ДругиеПоля - Произвольный - значение соответствующего полей отборов и критериев сравнения дублей. +// +Функция НайтиДублиЭлемента(Знач ОбластьПоиска, Знач ЭталонныйОбъект, Знач ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоискИУдалениеДублей.НайтиДублиЭлемента(ОбластьПоиска, ЭталонныйОбъект, ДополнительныеПараметры) +``` +
+ +## ДополнитьДублиСвязаннымиПодчиненнымиОбъектами +
+ +Описание, пример вызова + +```bsl + +// Добавляет к коллекции дублей связанные подчиненные объекты. +// +// Параметры: +// ПарыЗамен - см. ОбщегоНазначения.ЗаменитьСсылки.ПарыЗамен +// ПараметрыЗамены - см. ОбщегоНазначения.ПараметрыЗаменыСсылок +// +Процедура ДополнитьДублиСвязаннымиПодчиненнымиОбъектами(ПарыЗамен, ПараметрыЗамены) Экспорт +``` + +Пример вызова +```bsl +ПоискИУдалениеДублей.ДополнитьДублиСвязаннымиПодчиненнымиОбъектами(ПарыЗамен, ПараметрыЗамены) +``` +
+ +## НайтиПохожиеСтроки +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск всех вхождений заданной строки в переданном массиве строк. +// +// Параметры: +// ИсходнаяСтрока - Строка - набор строк, разделенных символом разделителя (параметр Разделитель), +// в которых выполняется поиск. +// СтрокаПоиска - Строка - строка, вхождение которой необходимо найти. +// Разделитель - Строка - символ, используемый для разделения исходной строки на элементы. +// Требуется передавать, если исходная строка состоит из массива строк. +// ПараметрыПоиска - см. ПараметрыПоискаПохожихСтрок. +// +// Пример: +// ИсходнаяСтрока = "Токарный станок~Вентилятор настольный~Стол обеденный~Стул обеденный"; +// ИндексыПохожихСтрок = ПоискИУдалениеДублей.НайтиПохожиеСтроки(ИсходнаяСтрока, "Стол обеденный"); +// // Для данного набора из четырех строк при поиске строк похожих на "Стол обеденный" +// // результатом будет "2,3", т.е. строки "Стол обеденный" и "Стул обеденный". +// +// Возвращаемое значение: +// Строка - индексы дублей строк, разделенные запятыми. Нумерация начинается с 0. +// +Функция НайтиПохожиеСтроки(ИсходнаяСтрока, СтрокаПоиска, Разделитель = "~", ПараметрыПоиска = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоискИУдалениеДублей.НайтиПохожиеСтроки(ИсходнаяСтрока, СтрокаПоиска, Разделитель, ПараметрыПоиска); +``` +
+ +## ПараметрыПоискаПохожихСтрок +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры для функции НайтиПохожиеСтроки. +// +// Параметры: +// ПодключитьКомпоненту - Булево - если Истина, выполняется подключение компоненты поиска строк. +// Для целей оптимизации, если планируется многократный вызов функции +// поиска похожих строк. +// +// Возвращаемое значение: +// Структура: +// * ПроцентСовпаденияСтрок - Число - по умолчанию 90. +// * ПроцентСовпаденияНебольшихСтрок - Число - по умолчанию 80. +// * ДлинаНебольшихСтрок - Число - по умолчанию 30. +// * СловаИсключения - Массив из Строка +// * КомпонентаПоиска - ОбъектВнешнейКомпоненты +// +Функция ПараметрыПоискаПохожихСтрок(ПодключитьКомпоненту = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоискИУдалениеДублей.ПараметрыПоискаПохожихСтрок(ПодключитьКомпоненту); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПоискИУдалениеДублейКлиент.md b/src/content/docs/bsp/ПоискИУдалениеДублейКлиент.md new file mode 100644 index 0000000..b3a70f3 --- /dev/null +++ b/src/content/docs/bsp/ПоискИУдалениеДублейКлиент.md @@ -0,0 +1,92 @@ +--- +title: Поиск и удаление дублей клиент +slug: bsp/поиск-и-удаление-дублей-клиент +--- + + +## ОбъединитьВыделенные +
+ +Описание, пример вызова + +```bsl + +// Открывает форму объединения элементов справочников, планов видов характеристик, видов расчетов и счетов. +// +// Параметры: +// ОбъединяемыеЭлементы - ТаблицаФормы +// - Массив из ЛюбаяСсылка +// - СписокЗначений - список элементов к объединению. +// Также можно передать произвольную коллекцию элементов с реквизитом "Ссылка". +// ДополнительныеПараметры - см. ПодключаемыеКомандыКлиент.ПараметрыВыполненияКоманды +// +Процедура ОбъединитьВыделенные(Знач ОбъединяемыеЭлементы, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ПоискИУдалениеДублейКлиент.ОбъединитьВыделенные(ОбъединяемыеЭлементы, ДополнительныеПараметры); +``` +
+ +## ЗаменитьВыделенные +
+ +Описание, пример вызова + +```bsl + +// Открывает форму замены и удаления элементов справочников, планов видов характеристик, видов расчетов и счетов. +// +// Параметры: +// ЗаменяемыеЭлементы - ТаблицаФормы +// - Массив +// - СписокЗначений - список элементов, которые нужно заменить и удалить. +// Также можно передать произвольную коллекцию элементов с реквизитом "Ссылка". +// ДополнительныеПараметры - см. ПодключаемыеКомандыКлиент.ПараметрыВыполненияКоманды +// +Процедура ЗаменитьВыделенные(Знач ЗаменяемыеЭлементы, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ПоискИУдалениеДублейКлиент.ЗаменитьВыделенные(ЗаменяемыеЭлементы, ДополнительныеПараметры); +``` +
+ +## ПоказатьМестаИспользования +
+ +Описание, пример вызова + +```bsl + +// Открывает отчет о местах использования ссылок. +// В отчет не включаются вспомогательные данные, такие как наборы записей с ведущим измерением и т.п. +// +// Параметры: +// Элементы - ТаблицаФормы +// - ДанныеФормыКоллекция +// - Массив из ЛюбаяСсылка +// - СписокЗначений - список элементов для анализа. +// Также можно передать произвольную коллекцию элементов с реквизитом "Ссылка". +// ПараметрыОткрытия - Структура - параметры открытия формы. Состоит из необязательных полей Владелец, +// Уникальность, Окно, НавигационнаяСсылка, ОписаниеОповещенияОЗакрытии, РежимОткрытияОкна, +// соответствующих параметрам функции ОткрытьФорму. +// +Процедура ПоказатьМестаИспользования(Знач Элементы, Знач ПараметрыОткрытия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ПоискИУдалениеДублейКлиент.ПоказатьМестаИспользования(Элементы, ПараметрыОткрытия); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПоискИУдалениеДублейПереопределяемый.md b/src/content/docs/bsp/ПоискИУдалениеДублейПереопределяемый.md new file mode 100644 index 0000000..8af0829 --- /dev/null +++ b/src/content/docs/bsp/ПоискИУдалениеДублейПереопределяемый.md @@ -0,0 +1,210 @@ +--- +title: Поиск и удаление дублей переопределяемый +slug: bsp/поиск-и-удаление-дублей-переопределяемый +--- + + +## ПриОпределенииОбъектовСПоискомДублей +
+ +Описание, пример вызова + +```bsl + +// Определить объекты метаданных, в модулях менеджеров которых предусмотрена возможность параметризации +// алгоритма поиска дублей с помощью экспортных процедур ПараметрыПоискаДублей, ПриПоискеДублей +// и ВозможностьЗаменыЭлементов. +// +// Параметры: +// Объекты - Соответствие из КлючИЗначение - объекты, в модулях менеджеров которых размещены экспортные процедуры: +// * Ключ - Строка - полное имя объекта метаданных, подключенного к подсистеме "Поиск и удаление дублей". +// Например, "Справочник.Контрагенты". +// * Значение - Строка - имена экспортных процедур-обработчиков, определенных в модуле менеджера: +// "ПараметрыПоискаДублей", +// "ПриПоискеДублей", +// "ВозможностьЗаменыЭлементов". +// Каждое имя должно начинаться с новой строки. +// Если указана пустая строка, то в модуле менеджера определены все процедуры. +// +// Пример: +// 1. В справочнике определены все процедуры-обработчики: +// Объекты.Вставить(Метаданные.Справочники.Контрагенты.ПолноеИмя(), ""); +// +// 2. Определены только процедуры ПараметрыПоискаДублей и ПриПоискеДублей: +// Объекты.Вставить(Метаданные.Справочники.ЗадачиПроекта.ПолноеИмя(), "ПараметрыПоискаДублей +// |ПриПоискеДублей"); +// +Процедура ПриОпределенииОбъектовСПоискомДублей(Объекты) Экспорт +``` + +Пример вызова +```bsl +ПоискИУдалениеДублейПереопределяемый.ПриОпределенииОбъектовСПоискомДублей(Объекты) +``` +
+ +## ПриОпределенииОбъектовСКомандамиОбъединенияДублейЗаменыСсылок +
+ +Описание, пример вызова + +```bsl + +// Определить объекты, в формах списков которых +// будут выведены команды объединения дублей и замены ссылок +// см. ПоискИУдалениеДублейКлиент.ОбъединитьВыделенные и ПоискИУдалениеДублейКлиент.ЗаменитьВыделенные +// +// Параметры: +// Объекты - Массив из ОбъектМетаданных +// +// Пример: +// Объекты.Добавить(Метаданные.Справочники.Номенклатура); +// Объекты.Добавить(Метаданные.Справочники.Контрагенты); +// +Процедура ПриОпределенииОбъектовСКомандамиОбъединенияДублейЗаменыСсылок(Объекты) Экспорт +``` + +Пример вызова +```bsl +ПоискИУдалениеДублейПереопределяемый.ПриОпределенииОбъектовСКомандамиОбъединенияДублейЗаменыСсылок(Объекты) +``` +
+ +## ПриОпределенииВозможностиЗаменыЭлементов +
+ +Описание, пример вызова + +```bsl + +// Позволяет реализовать дополнительные проверки для пар ссылок на возможность замены одной на другую. +// Например, можно запретить заменять друг на друга номенклатуру разных видов. +// Базовые проверки на запрет замены групп и ссылок разных типов производятся предварительно перед вызовом +// этого обработчика. +// +// Параметры: +// ИмяОбъектаМетаданных - Строка - полное имя ссылочного объекта метаданных, замена элементов которого производится. +// Например, "Справочник.Контрагенты". +// ПарыЗамен - Соответствие из КлючИЗначение: +// * Ключ - ЛюбаяСсылка - что будет заменено +// * Значение - ЛюбаяСсылка - на что будет заменено +// ПараметрыЗамены - Структура - действие с заменяемыми элементами: +// * СпособУдаления - Строка - может принимать значения: +// "Непосредственно" - Если после замены ссылка нигде не используется, +// то она будет удалена непосредственно; +// "Пометка" - Если после замены ссылка не используется, то +// она будет помечена на удаление. +// При других значениях заменяемая ссылка не будет изменена. +// НедопустимыеЗамены - Соответствие из КлючИЗначение: +// * Ключ - ЛюбаяСсылка - заменяемая ссылка +// * Значение - Строка - описание, почему замена недопустима. Если все замены допустимы, то возвращается пустое соответствие +// +Процедура ПриОпределенииВозможностиЗаменыЭлементов(Знач ИмяОбъектаМетаданных, Знач ПарыЗамен, Знач ПараметрыЗамены, НедопустимыеЗамены) Экспорт +``` + +Пример вызова +```bsl +ПоискИУдалениеДублейПереопределяемый.ПриОпределенииВозможностиЗаменыЭлементов(ИмяОбъектаМетаданных, ПарыЗамен, ПараметрыЗамены, НедопустимыеЗамены) +``` +
+ +## ПриОпределенииПараметровПоискаДублей +
+ +Описание, пример вызова + +```bsl + +// Вызывается для определения прикладных параметров поиска дублей. +// Например, для справочника номенклатуры можно запретить замену друг на друга номенклатуры разных видов. +// +// Параметры: +// ИмяОбъектаМетаданных - Строка - полное имя ссылочного объекта метаданных, замена элементов которого производится. +// Например, "Справочник.Контрагенты". +// ПараметрыПоиска - Структура - параметры поиска дублей (выходной параметр): +// * ПравилаПоиска - ТаблицаЗначений - правила сравнения для объектов: +// ** Реквизит - Строка - имя реквизита для сравнения. +// ** Правило - Строка - правило сравнения: "Равно" - на точное равенство, "Подобно" - подобные строки, +// "" - не сравнивать. +// * СравнениеСтрокНаПодобие - Структура - правила нечеткого поиска строк (сравнение строк на подобие): +// ** ПроцентСовпаденияСтрок - Число - минимальный процент совпадения для строк (от 0 до 100). +// Процент совпадения рассчитывается на основе расстояния Левенштейна-Дамерау с учетом распространенных +// видов ошибок: разный регистр символов, случайная вставка, удаление одного символа, +// замена одного символа на другой. Также порядок слов в строках не имеет значения, +// т.е. например строки "первое второе слово" и "слово второе первое" имеют 100% совпадение. +// По умолчанию, 90. +// ** ПроцентСовпаденияНебольшихСтрок - Число - минимальный процент совпадения для небольших строк (от 0 до 100). +// По умолчанию, 80. +// ** ДлинаНебольшихСтрок - Число - если длина строки меньше или равна заданной, то строка считается небольшой. +// По умолчанию, 30. +// ** СловаИсключения - Массив из Строка - список слов, которые следует пропускать при сравнении на подобие. +// Например, для организаций и контрагентов это могут быть: ИП, ГУП, ООО, ОАО и т.д. +// * КомпоновщикОтбора - КомпоновщикНастроекКомпоновкиДанных - инициализированный компоновщик для +// предварительного отбора. Может быть изменен, например, для усиления отборов. +// * ОграниченияСравнения - Массив из Структура - описания прикладных правил-ограничений: +// ** Представление - Строка - текстовое описание правила-ограничения. +// ** ДополнительныеПоля - Строка - список реквизитов через запятую, значения которых +// необходимы для анализа в ПриПоискеДублей. +// * КоличествоЭлементовДляСравнения - Число - количество дублей, передаваемых одним вызовом в параметр ДублиЭлементов +// обработчика ПриПоискеДублей. По умолчанию, 1500. +// ДополнительныеПараметры - Произвольный - значение, переданное при вызове ПоискИУдалениеДублей.НайтиДублиЭлемента. +// При вызове из обработки ПоискИУдалениеДублей равно Неопределено. +// СтандартнаяОбработка - Булево - указать Ложь, если заполнен выходной параметр ПараметрыПоиска и необходим вызов +// обработчика ПриПоискеДублей. По умолчанию Истина. +// +Процедура ПриОпределенииПараметровПоискаДублей(Знач ИмяОбъектаМетаданных, ПараметрыПоиска, Знач ДополнительныеПараметры, Экспорт +``` + +Пример вызова +```bsl +ПоискИУдалениеДублейПереопределяемый.ПриОпределенииПараметровПоискаДублей(ИмяОбъектаМетаданных, ПараметрыПоиска, ДополнительныеПараметры, ); +``` +
+ +## ПриПоискеДублей +
+ +Описание, пример вызова + +```bsl + +// Вызывается при поиске дублей по правилам, заданным в ПриОпределенииПараметровПоискаДублей. +// Можно дополнить список дублей или пересмотреть признак ЭтоДубли у уже найденных кандидатов. +// +// Параметры: +// ИмяОбъектаМетаданных - Строка - полное имя ссылочного объекта метаданных, замена элементов которого производится. +// Например, "Справочник.Контрагенты". +// ДублиЭлементов - ТаблицаЗначений - сведения о найденных вариантах дублей: +// * Ссылка1 - ЛюбаяСсылка - ссылка на первый элемент. +// * Ссылка2 - ЛюбаяСсылка - ссылка на второй элемент. +// * ЭтоДубли - Булево - признак того, что кандидаты являются дублями. По умолчанию Ложь. +// Может быть установлено в Истина, чтобы отметить дубли. +// * Поля1 - Структура - значения реквизитов Код, Наименование и дополнительных полей первого элемента, +// указанные в параметре ПараметрыПоиска.ОграниченияСравнения.ДополнительныеПоля +// обработчика ПриОпределенииПараметровПоискаДублей: +// ** Код - Строка +// ** Наименование - Строка +// ** ПометкаУдаления - Булево +// * Поля2 - Структура - аналогичные реквизиты второго элемента: +// ** Код - Строка +// ** Наименование - Строка +// ** ПометкаУдаления - Булево +// ДополнительныеПараметры - Произвольный - значение, переданное при вызове ПоискИУдалениеДублей.НайтиДублиЭлемента. +// При вызове из обработки ПоискИУдалениеДублей равно Неопределено. +// +Процедура ПриПоискеДублей(Знач ИмяОбъектаМетаданных, Знач ДублиЭлементов, Знач ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ПоискИУдалениеДублейПереопределяемый.ПриПоискеДублей(ИмяОбъектаМетаданных, ДублиЭлементов, ДополнительныеПараметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолнотекстовыйПоискКлиент.md b/src/content/docs/bsp/ПолнотекстовыйПоискКлиент.md new file mode 100644 index 0000000..a43855a --- /dev/null +++ b/src/content/docs/bsp/ПолнотекстовыйПоискКлиент.md @@ -0,0 +1,116 @@ +--- +title: Полнотекстовый поиск клиент +slug: bsp/полнотекстовый-поиск-клиент +--- + + +## ОбработкаОповещенияИзмененияФлажкаИспользоватьПоиск +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ОбработкаОповещения для формы, на которой требуется отобразить флажок использования поиска. +// +// Параметры: +// ИмяСобытия - Строка - имя события, которое было получено обработчиком события на форме. +// ИспользоватьПолнотекстовыйПоиск - Число - реквизит, в который будет помещено значение. +// +// Пример: +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ПолнотекстовыйПоиск") Тогда +// МодульПолнотекстовыйПоискКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ПолнотекстовыйПоискКлиент"); +// МодульПолнотекстовыйПоискКлиент.ОбработкаОповещенияИзмененияФлажкаИспользоватьПоиск( +// ИмяСобытия, +// ИспользоватьПолнотекстовыйПоиск); +// КонецЕсли; +// +Процедура ОбработкаОповещенияИзмененияФлажкаИспользоватьПоиск(Знач ИмяСобытия, ИспользоватьПолнотекстовыйПоиск) Экспорт +``` + +Пример вызова +```bsl +ПолнотекстовыйПоискКлиент.ОбработкаОповещенияИзмененияФлажкаИспользоватьПоиск(ИмяСобытия, ИспользоватьПолнотекстовыйПоиск) +``` +
+ +## ПриИзмененииФлажкаИспользоватьПоиск +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриИзменении для флажка, выполняющего переключение режима полнотекстового поиска. +// Флажок должен быть связан с реквизитом типа Число. +// +// Параметры: +// ЗначениеФлажкаИспользоватьПоиск - Число - новое значение флажка, которое требуется обработать. +// +// Пример: +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ПолнотекстовыйПоиск") Тогда +// МодульПолнотекстовыйПоискКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ПолнотекстовыйПоискКлиент"); +// МодульПолнотекстовыйПоискКлиент.ПриИзмененииФлажкаИспользоватьПоиск(ИспользоватьПолнотекстовыйПоиск); +// КонецЕсли; +// +Процедура ПриИзмененииФлажкаИспользоватьПоиск(ЗначениеФлажкаИспользоватьПоиск) Экспорт +``` + +Пример вызова +```bsl +ПолнотекстовыйПоискКлиент.ПриИзмененииФлажкаИспользоватьПоиск(ЗначениеФлажкаИспользоватьПоиск) +``` +
+ +## ПоказатьНастройку +
+ +Описание, пример вызова + +```bsl + +// Открывает форму управления полнотекстовым поиском и извлечением текстов. +// Не забудьте команду, выполняющую вызов процедуры, +// установить зависимой от функциональной опции ИспользоватьПолнотекстовыйПоиск. +// +// Пример: +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ПолнотекстовыйПоиск") Тогда +// МодульПолнотекстовыйПоискКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ПолнотекстовыйПоискКлиент"); +// МодульПолнотекстовыйПоискКлиент.ПоказатьНастройку(); +// КонецЕсли; +// +Процедура ПоказатьНастройку() Экспорт +``` + +Пример вызова +```bsl +ПолнотекстовыйПоискКлиент.ПоказатьНастройку() +``` +
+ +## ПоказатьУправлениеПолнотекстовымПоискомИИзвлечениемТекстов +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ПоказатьНастройку. +// Открывает форму управления полнотекстовым поиском и извлечения текстов. +// +Процедура ПоказатьУправлениеПолнотекстовымПоискомИИзвлечениемТекстов() Экспорт +``` + +Пример вызова +```bsl +ПолнотекстовыйПоискКлиент.ПоказатьУправлениеПолнотекстовымПоискомИИзвлечениемТекстов() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолнотекстовыйПоискСервер.md b/src/content/docs/bsp/ПолнотекстовыйПоискСервер.md new file mode 100644 index 0000000..f54f51c --- /dev/null +++ b/src/content/docs/bsp/ПолнотекстовыйПоискСервер.md @@ -0,0 +1,98 @@ +--- +title: Полнотекстовый поиск сервер +slug: bsp/полнотекстовый-поиск-сервер +--- + + +## ОбновлениеИндексаППД +
+ +Описание, пример вызова + +```bsl + +// Обновляет индекс полнотекстового поиска. +Процедура ОбновлениеИндексаППД() Экспорт +``` + +Пример вызова +```bsl +ПолнотекстовыйПоискСервер.ОбновлениеИндексаППД() +``` +
+ +## СлияниеИндексаППД +
+ +Описание, пример вызова + +```bsl + +// Выполняет слияние индексов полнотекстового поиска. +Процедура СлияниеИндексаППД() Экспорт +``` + +Пример вызова +```bsl +ПолнотекстовыйПоискСервер.СлияниеИндексаППД() +``` +
+ +## ИндексПоискаАктуален +
+ +Описание, пример вызова + +```bsl + +// Возвращает, актуален ли индекс полнотекстового поиска. +// Проверка функциональной опции "ИспользоватьПолнотекстовыйПоиск" выполняется в вызывающем коде. +// +// Возвращаемое значение: +// Булево - Истина - полнотекстовый поиск содержит актуальные данные. +// +Функция ИндексПоискаАктуален() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолнотекстовыйПоискСервер.ИндексПоискаАктуален() +``` +
+ +## ЗначениеФлажкаИспользоватьПоиск +
+ +Описание, пример вызова + +```bsl + +// Состояние флажка для формы настроек полнотекстового поиска. +// +// Возвращаемое значение: +// Число - 0 - не включен, 1 - включен, - 2 ошибка настройки, рассинхронизация настроек. +// +// Пример: +// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ПолнотекстовыйПоиск") Тогда +// МодульПолнотекстовыйПоискСервер = ОбщегоНазначения.ОбщийМодуль("ПолнотекстовыйПоискСервер"); +// ИспользоватьПолнотекстовыйПоиск = МодульПолнотекстовыйПоискСервер.ЗначениеФлажкаИспользоватьПоиск(); +// Иначе +// Элементы.ГруппаУправлениеПолнотекстовымПоиском.Видимость = Ложь; +// КонецЕсли; +// +Функция ЗначениеФлажкаИспользоватьПоиск() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолнотекстовыйПоискСервер.ЗначениеФлажкаИспользоватьПоиск() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолнотекстовыйПоискСерверПереопределяемый.md b/src/content/docs/bsp/ПолнотекстовыйПоискСерверПереопределяемый.md new file mode 100644 index 0000000..6e72d08 --- /dev/null +++ b/src/content/docs/bsp/ПолнотекстовыйПоискСерверПереопределяемый.md @@ -0,0 +1,57 @@ +--- +title: Полнотекстовый поиск сервер переопределяемый +slug: bsp/полнотекстовый-поиск-сервер-переопределяемый +--- + + +## ПриПолученииРазделовПолнотекстовогоПоиска +
+ +Описание, пример вызова + +```bsl + +// Позволяет внести изменения в дерево с разделами полнотекстового поиска, отображаемое при выборе области поиска. +// По умолчанию дерево разделов формируется на основании состава подсистем конфигурации. +// +// Перед добавлением объекта метаданных убедитесь, что его свойство ПолнотекстовыйПоиск +// установлено в значение Метаданные.СвойстваОбъектов.ИспользованиеПолнотекстовогоПоиска.Использовать. +// +// Параметры: +// РазделыПоиска - ДеревоЗначений - области поиска. Содержит колонки: +// * Раздел - Строка - представление раздела, например, название подсистемы или объекта метаданных. +// * Картинка - Картинка - картинка раздела, рекомендуется только для корневых разделов. +// * ОбъектМД - СправочникСсылка.ИдентификаторыОбъектовМетаданных, +// СправочникСсылка.ИдентификаторыОбъектовРасширений - задается только для объектов метаданных, для +// разделов остается пустым. +// Пример: +// +// РазделГлавное = РазделыПоиска.Строки.Добавить(); +// РазделГлавное.Раздел = "Главное"; +// РазделГлавное.Картинка = БиблиотекаКартинок.РазделГлавное; +// +// СчетНаОплату = Метаданные.Документы.СчетНаОплатуПокупателю; +// Если ПравоДоступа("Просмотр", СчетНаОплату) +// И ОбщегоНазначения.ОбъектМетаданныхДоступенПоФункциональнымОпциям(СчетНаОплату) Тогда +// +// ОбъектРаздела = РазделГлавное.Строки.Добавить(); +// ОбъектРаздела.Раздел = СчетНаОплату.ПредставлениеСписка; +// ОбъектРаздела.ОбъектМД = ОбщегоНазначения.ИдентификаторОбъектаМетаданных(СчетНаОплату); +// КонецЕсли; +// +Процедура ПриПолученииРазделовПолнотекстовогоПоиска(РазделыПоиска) Экспорт +``` + +Пример вызова +```bsl +ПолнотекстовыйПоискСерверПереопределяемый.ПриПолученииРазделовПолнотекстовогоПоиска(РазделыПоиска) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеВнешнихКомпонент.md b/src/content/docs/bsp/ПолучениеВнешнихКомпонент.md new file mode 100644 index 0000000..2ed9c31 --- /dev/null +++ b/src/content/docs/bsp/ПолучениеВнешнихКомпонент.md @@ -0,0 +1,443 @@ +--- +title: Получение внешних компонент +slug: bsp/получение-внешних-компонент +--- + + +## ОписаниеВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Создает таблицу описания внешних компонент, которая используется для обновления из сервиса. +// +// Возвращаемое значение: +// ТаблицаЗначений - описание запроса внешних компонент: +// *Идентификатор - Строка - содержит уникальный идентификатор внешней +// компоненты, который указывается пользователем в базе публикаций; +// *Версия - Строка - содержит версию внешней компоненты; +// *Наименование - Строка - содержит наименование компоненты; +// *ДатаВерсии - Дата - содержит дату версии (сборки) внешней компоненты. +// *ОбновлятьАвтоматически - Булево - признак автоматического обновления внешней компоненты. +// +Функция ОписаниеВнешнихКомпонент() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеВнешнихКомпонент.ОписаниеВнешнихКомпонент() +``` +
+ +## АктуальныеВерсииВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Выполняет загрузку файлов актуальных версий внешних компонент. +// +// Параметры: +// ОписаниеВнешнихКомпонент - ТаблицаЗначений - описание внешних компонент, которые необходимо, +// загрузить в ИБ. См. функцию ПолучениеВнешнихКомпонент.ОписаниеВнешнихКомпонент. +// Если в таблице заполнена версия внешней компоненты, будет выполнена +// проверка номера версии, т.е. если номер версии в сервисе равен номеру версии +// в ИБ, файл не будет загружен и для версии будет установлена ошибка АктуальнаяВерсия. +// +// Возвращаемое значение: +// Структура - содержит результат загрузки внешних компонент: +// * КодОшибки - Строка - строковый код возникшей ошибки, который +// может быть обработан вызывающим функционалом: +// - <Пустая строка> - обновление выполнено успешно; +// - "НеверныйЛогинИлиПароль" - неверный логин или пароль; +// - "ПревышеноКоличествоПопыток" - превышено количество попыток +// получения обновления с некорректным логином и паролем; +// - "ОшибкаПодключения" - ошибка при подключении к сервису; +// - "ОшибкаСервиса" - внутренняя ошибка сервиса; +// - "НеизвестнаяОшибка" - при получении информации возникла +// неизвестная (не обрабатываемая) ошибка; +// - "СервисВременноНеДоступен" - на сервер ведутся регламентные работы; +// - "НетДоступаКПрограмме" - отсутствует доступ к программе на Портале 1С:ИТС; +// *СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для пользователя; +// *ИнформацияОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для администратора. +// *ДанныеВнешнихКомпонент - ТаблицаЗначений, Неопределено - содержит информацию о загруженных +// внешних компонентах: +// **Идентификатор - Строка - содержит идентификатор внешней компоненты, который +// указывается пользователем при создании новой компоненты; +// **Версия - Строка, Неопределено - содержит номер версии загруженного компонента; +// **ДатаВерсии - Дата, Неопределено - содержит дату выхода версии загруженного, +// компонента установленную в при заполнении информации о версии +// внешней компоненты; +// **Наименование - Строка, Неопределено - содержит наименование внешней компоненты, к которой +// относится версия; +// **ИмяФайла - Строка, Неопределено - содержит имя файла, установленное +// в при создании версии внешней компоненты; +// **Размер - Число - размер файла; +// **АдресФайла - Строка, Неопределено - содержит адрес файла внешней +// компоненты во временно хранилище; +// **КодОшибки - Строка - содержит код ошибки загрузки внешней компоненты: +// - <Пустая строка> - обновление загружено успешно; +// - ОтсутствуетКомпонента - в сервисе внешних компонент +// не обнаружена внешняя компонента по переданному идентификатору; +// - ФайлНеЗагружен - при попытке загрузить файл внешней компоненты из сервиса, +// возникла ошибка; +// - АктуальнаяВерсия - при получении последней (актуальной) внешней компоненты +// не обнаружена более новая версия. +// +// Пример: +// // 1. Обновление версии +// +// МодульПолучениеВнешнихКомпонент = ОбщегоНазначения.ОбщийМодуль("ПолучениеВнешнихКомпонент"); +// ОписаниеВнешнихКомпонент = МодульПолучениеВнешнихКомпонент.ОписаниеВнешнихКомпонент(); +// +// СтрокаТаблицы = ОписаниеВнешнихКомпонент.Добавить(); +// СтрокаТаблицы.Идентификатор = "InputDevice"; +// СтрокаТаблицы.Версия = "8_1_7_0"; // Допустимо оставить версию пустой. +// +// Результат = МодульПолучениеВнешнихКомпонент.АктуальныеВерсииВнешнихКомпонент(ОписаниеВнешнихКомпонент); +// +// // Результат загрузки: +// Результат.КодОшибки = ""; +// Результат.СообщениеОбОшибке = ""; +// Результат.ИнформацияОбОшибке = ""; +// +// СтрокаРезультата = Результат.ОписаниеВнешнихКомпонент[0]; +// СтрокаРезультат.Идентификатор = "InputDevice"; +// СтрокаРезультат.Версия = "8_1_8_0"; +// СтрокаРезультат.ДатаВерсии = '10.01.2017 18:00'; +// СтрокаРезультат.Наименование = "1С:Сканеры штрихкода (NativeApi)"; +// СтрокаРезультат.ИмяФайла = "Драйвер1СУстройстваВводаNative_8_1_8_0.zip"; +// СтрокаРезультат.АдресФайла = [uid временного хранилища]; +// СтрокаРезультат.КодОшибки = ""; +// +// // 2. Ошибка работы с сервисом +// +// МодульПолучениеВнешнихКомпонент = ОбщегоНазначения.ОбщийМодуль("ПолучениеВнешнихКомпонент"); +// ОписаниеВнешнихКомпонент = МодульПолучениеВнешнихКомпонент.ОписаниеВнешнихКомпонент(); +// +// СтрокаТаблицы = ОписаниеВнешнихКомпонент.Добавить(); +// СтрокаТаблицы.Идентификатор = "ProtonScanner"; +// СтрокаТаблицы.Версия = "1_1"; +// +// Результат = МодульПолучениеВнешнихКомпонент.АктуальныеВерсииВнешнихКомпонент(ОписаниеВнешнихКомпонент); +// +// // Результат загрузки +// Результат.КодОшибки = "СервисВременноНедоступен"; +// Результат.СообщениеОбОшибке = "Сервис временно не доступен в связи с регламентными работами."; +// Результат.ИнформацияОбОшибке = "Не удалось подключиться к сервису внешних компонент. +// |Сервис временно недоступен."; +// Результат.ОписаниеВнешнихКомпонент = Неопределено; +// +// // 3. Ошибка загрузки внешней компоненты +// +// МодульПолучениеВнешнихКомпонент = ОбщегоНазначения.ОбщийМодуль("ПолучениеВнешнихКомпонент"); +// ОписаниеВнешнихКомпонент = МодульПолучениеВнешнихКомпонент.ОписаниеВнешнихКомпонент(); +// +// СтрокаТаблицы = ОписаниеВнешнихКомпонент.Добавить(); +// СтрокаТаблицы.Идентификатор = "ProtonScanner"; +// СтрокаТаблицы.Версия = "1_2"; +// +// Результат = МодульПолучениеВнешнихКомпонент.АктуальныеВерсииВнешнихКомпонент(ОписаниеВнешнихКомпонент); +// +// // Результат загрузки +// Результат.КодОшибки = ""; +// Результат.СообщениеОбОшибке = ""; +// Результат.ИнформацияОбОшибке = ""; +// Результат.ОписаниеВнешнихКомпонент = Неопределено; +// +// СтрокаРезультата = Результат.ОписаниеВнешнихКомпонент[0]; +// СтрокаРезультат.Идентификатор = "ProtonScanner"; +// СтрокаРезультат.Версия = Неопределено; +// СтрокаРезультат.ДатаВерсии = Неопределено; +// СтрокаРезультат.Наименование = Неопределено; +// СтрокаРезультат.ИмяФайла = Неопределено; +// СтрокаРезультат.АдресФайла = Неопределено; +// СтрокаРезультат.КодОшибки = "АктуальнаяВерсия"; +// +Функция АктуальныеВерсииВнешнихКомпонент(ОписаниеВнешнихКомпонент) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеВнешнихКомпонент.АктуальныеВерсииВнешнихКомпонент(ОписаниеВнешнихКомпонент) +``` +
+ +## ВерсииВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Выполняет загрузка файлов версий внешних компонент. +// +// Параметры: +// ОписаниеВнешнихКомпонент - ТаблицаЗначений - описание внешних компонент, которые необходимо, +// загрузить в ИБ. См. функцию ПолучениеВнешнихКомпонент.ОписаниеВнешнихКомпонент. +// +// Возвращаемое значение: +// Структура - содержит результат загрузки внешних компонент: +// * КодОшибки - Строка - строковый код возникшей ошибки, который +// может быть обработан вызывающим функционалом: +// - <Пустая строка> - обновление выполнено успешно; +// - "НеверныйЛогинИлиПароль" - неверный логин или пароль; +// - "ПревышеноКоличествоПопыток" - превышено количество попыток +// получения обновления с некорректным логином и паролем; +// - "ОшибкаПодключения" - ошибка при подключении к сервису; +// - "ОшибкаСервиса" - внутренняя ошибка сервиса; +// - "НеизвестнаяОшибка" - при получении информации возникла +// неизвестная (не обрабатываемая) ошибка; +// - "СервисВременноНеДоступен" - на сервер ведутся регламентные работы; +// - "НетДоступаКПрограмме" - отсутствует доступ к программе на Портале 1С:ИТС; +// *СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для пользователя; +// *ИнформацияОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для администратора. +// *ДанныеВнешнихКомпонент - ТаблицаЗначений, Неопределено - содержит информацию о загруженных +// внешних компонентах: +// **Идентификатор - Строка - содержит идентификатор внешней компоненты, который +// указывается пользователем при создании новой компоненты; +// **Версия - Строка, Неопределено - содержит номер версии загруженного компонента; +// **ДатаВерсии - Дата, Неопределено - содержит дату выхода версии загруженного, +// компонента установленную в при заполнении информации о версии +// внешней компоненты; +// **Наименование - Строка, Неопределено - содержит наименование внешней компоненты, к которой +// относится версия; +// **ИмяФайла - Строка, Неопределено - содержит имя файла, установленное +// в при создании версии внешней компоненты; +// **Размер - Число - размер файла; +// **АдресФайла - Строка, Неопределено - содержит адрес файла внешней +// компоненты во временно хранилище; +// **КодОшибки - Строка - содержит код ошибки загрузки внешней компоненты: +// - <Пустая строка> - обновление загружено успешно; +// - ОтсутствуетКомпонента - в сервисе внешних компонент +// не обнаружена внешняя компонента по переданному идентификатору; +// - ФайлНеЗагружен - при попытке загрузить файл внешней компоненты из сервиса, +// возникла ошибка; +// - ОтсутствуетВерсия - в сервисе внешних компонент не обнаружена версия +// внешней компонента по переданному номеру версии. +// +// Пример: +// // 1. Обновление версии +// +// МодульПолучениеВнешнихКомпонент = ОбщегоНазначения.ОбщийМодуль("ПолучениеВнешнихКомпонент"); +// ОписаниеВнешнихКомпонент = МодульПолучениеВнешнихКомпонент.ОписаниеВнешнихКомпонент(); +// +// СтрокаТаблицы = ОписаниеВнешнихКомпонент.Добавить(); +// СтрокаТаблицы.Идентификатор = "InputDevice"; +// СтрокаТаблицы.Версия = "8_1_8_0"; +// +// Результат = МодульПолучениеВнешнихКомпонент.АктуальныеВерсииВнешнихКомпонент(ОписаниеВнешнихКомпонент); +// +// // Результат загрузки: +// Результат.КодОшибки = ""; +// Результат.СообщениеОбОшибке = ""; +// Результат.ИнформацияОбОшибке = ""; +// +// СтрокаРезультата = Результат.ОписаниеВнешнихКомпонент[0]; +// СтрокаРезультат.Идентификатор = "InputDevice"; +// СтрокаРезультат.Версия = "8_1_8_0"; +// СтрокаРезультат.ДатаВерсии = '10.01.2017 18:00'; +// СтрокаРезультат.Наименование = "1С:Сканеры штрихкода (NativeApi)"; +// СтрокаРезультат.ИмяФайла = "Драйвер1СУстройстваВводаNative_8_1_8_0.zip"; +// СтрокаРезультат.АдресФайла = [uid временного хранилища]; +// СтрокаРезультат.КодОшибки = ""; +// +// // 2. Ошибка работы с сервисом +// +// МодульПолучениеВнешнихКомпонент = ОбщегоНазначения.ОбщийМодуль("ПолучениеВнешнихКомпонент"); +// ОписаниеВнешнихКомпонент = МодульПолучениеВнешнихКомпонент.ОписаниеВнешнихКомпонент(); +// +// СтрокаТаблицы = ОписаниеВнешнихКомпонент.Добавить(); +// СтрокаТаблицы.Идентификатор = "ProtonScanner"; +// СтрокаТаблицы.Версия = "1_1"; +// +// Результат = МодульПолучениеВнешнихКомпонент.АктуальныеВерсииВнешнихКомпонент(ОписаниеВнешнихКомпонент); +// +// // Результат загрузки +// Результат.КодОшибки = "СервисВременноНедоступен"; +// Результат.СообщениеОбОшибке = "Сервис временно не доступен в связи с регламентными работами."; +// Результат.ИнформацияОбОшибке = "При подключении к сервису ХХХХХХХХ возникли ошибки ХХХХХХХ."; +// Результат.ОписаниеВнешнихКомпонент = Неопределено; +// +// // 3. Ошибка загрузки внешней компоненты +// +// МодульПолучениеВнешнихКомпонент = ОбщегоНазначения.ОбщийМодуль("ПолучениеВнешнихКомпонент"); +// ОписаниеВнешнихКомпонент = МодульПолучениеВнешнихКомпонент.ОписаниеВнешнихКомпонент(); +// +// СтрокаТаблицы = ОписаниеВнешнихКомпонент.Добавить(); +// СтрокаТаблицы.Идентификатор = "ProtonScanner"; +// СтрокаТаблицы.Версия = "1_2"; +// +// Результат = МодульПолучениеВнешнихКомпонент.АктуальныеВерсииВнешнихКомпонент(ОписаниеВнешнихКомпонент); +// +// // Результат загрузки +// Результат.КодОшибки = ""; +// Результат.СообщениеОбОшибке = ""; +// Результат.ИнформацияОбОшибке = ""; +// Результат.ОписаниеВнешнихКомпонент = Неопределено; +// +// СтрокаРезультата = Результат.ОписаниеВнешнихКомпонент[0]; +// СтрокаРезультат.Идентификатор = "ProtonScanner"; +// СтрокаРезультат.Версия = Неопределено; +// СтрокаРезультат.ДатаВерсии = Неопределено; +// СтрокаРезультат.Наименование = Неопределено; +// СтрокаРезультат.ИмяФайла = Неопределено; +// СтрокаРезультат.АдресФайла = Неопределено; +// СтрокаРезультат.КодОшибки = "ОтсутствуетВерсия"; +// +Функция ВерсииВнешнихКомпонент(ОписаниеВнешнихКомпонент) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеВнешнихКомпонент.ВерсииВнешнихКомпонент(ОписаниеВнешнихКомпонент) +``` +
+ +## ДоступнаЗагрузкаВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность загрузки внешних компонент. +// +// Возвращаемое значение: +// Булево - если Истина, загрузка внешних компонент доступна. +// +Функция ДоступнаЗагрузкаВнешнихКомпонент() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеВнешнихКомпонент.ДоступнаЗагрузкаВнешнихКомпонент() +``` +
+ +## ДоступнаИнтерактивнаяЗагрузкаВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность запуска обработки обновления внешних компонент. +// +// Возвращаемое значение: +// Булево - если Истина, обработка обновления внешних компонент доступна. +// +Функция ДоступнаИнтерактивнаяЗагрузкаВнешнихКомпонент() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеВнешнихКомпонент.ДоступнаИнтерактивнаяЗагрузкаВнешнихКомпонент() +``` +
+ +## ДоступноОбновлениеВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание внешних компонент, у которых доступны обновления +// в сервисе внешних компонент. +// +// Параметры: +// Идентификаторы - Массив из Строка, Неопределено - список уникальных идентификаторов +// внешних компонент. +// +// Возвращаемое значение: +// Структура - содержит результат проверки внешних компонент: +// * КодОшибки - Строка - строковый код возникшей ошибки, который +// может быть обработан вызывающим функционалом: +// - <Пустая строка> - ошибок нет; +// - "НеверныйЛогинИлиПароль" - неверный логин или пароль; +// - "ПревышеноКоличествоПопыток" - превышено количество попыток +// получения обновления с некорректным логином и паролем; +// - "ОшибкаПодключения" - ошибка при подключении к сервису; +// - "ОшибкаСервиса" - внутренняя ошибка сервиса; +// - "НеизвестнаяОшибка" - при получении информации возникла +// неизвестная (не обрабатываемая) ошибка; +// - "СервисВременноНеДоступен" - на сервер ведутся регламентные работы; +// - "НетДоступаКПрограмме" - отсутствует доступ к программе на Портале 1С:ИТС; +// *СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для пользователя; +// *ИнформацияОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для администратора. +// *ДанныеВнешнихКомпонент - ТаблицаЗначений, Неопределено - содержит информацию о внешних компонентах, +// см ОписаниеВнешнихКомпонент. +// +Функция ДоступноОбновлениеВнешнихКомпонент(Идентификаторы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеВнешнихКомпонент.ДоступноОбновлениеВнешнихКомпонент(Идентификаторы); +``` +
+ +## НастройкиОбновленияВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки обновления внешних компонент. +// +// Возвращаемое значение: +// Структура - Настройки регламентного задания обновления внешних компонент. +// **ВариантОбновления - Число - вариант обновления внешних компонент; +// 0 - отключено; +// 1 - По расписанию через Интернет; +// 2 - По расписанию через Файл; +// **ФайлВнешнихКомпонент - Строка - путь к файлу внешних компонент; +// **Расписание - РасписаниеРегламентногоЗадания - расписание обновления внешних компонент; +// **ПредставлениеРасписания - Строка - пользовательское представление расписания; +// **ДоступнаЗагрузкаВнешнихКомпонент - Булево - возможность загрузки внешних компонент. +// +Функция НастройкиОбновленияВнешнихКомпонент() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеВнешнихКомпонент.НастройкиОбновленияВнешнихКомпонент() +``` +
+ +## ИзменитьНастройкиОбновленияВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Изменяет настройки обновления внешних компонент. +// +// Параметры: +// Настройки - Структура - Настройки регламентного задания обновления внешних компонент. +// **ВариантОбновления - Число - вариант обновления внешних компонент; +// **ФайлВнешнихКомпонент - Строка - путь к файлу внешних компонент; +// **Расписание - РасписаниеРегламентногоЗадания - расписание обновления внешних компонент. +// +Процедура ИзменитьНастройкиОбновленияВнешнихКомпонент(Настройки) Экспорт +``` + +Пример вызова +```bsl +ПолучениеВнешнихКомпонент.ИзменитьНастройкиОбновленияВнешнихКомпонент(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеВнешнихКомпонентВМоделиСервисаПереопределяемый.md b/src/content/docs/bsp/ПолучениеВнешнихКомпонентВМоделиСервисаПереопределяемый.md new file mode 100644 index 0000000..290c0c4 --- /dev/null +++ b/src/content/docs/bsp/ПолучениеВнешнихКомпонентВМоделиСервисаПереопределяемый.md @@ -0,0 +1,36 @@ +--- +title: Получение внешних компонент в модели сервиса переопределяемый +slug: bsp/получение-внешних-компонент-в-модели-сервиса-переопределяемый +--- + + +## ПриОпределенииИспользуемыхВерсийВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Переопределяются идентификаторы внешних компонент, которые используются в конфигурации. +// Указанные внешние компоненты будут загружены при обработке поставляемых данных. +// +// Параметры: +// Идентификаторы - Массив из Строка - содержит идентификаторы внешних компоненты. +// +//@skip-warning +Процедура ПриОпределенииИспользуемыхВерсийВнешнихКомпонент(Идентификаторы) Экспорт +``` + +Пример вызова +```bsl +ПолучениеВнешнихКомпонентВМоделиСервисаПереопределяемый.ПриОпределенииИспользуемыхВерсийВнешнихКомпонент(Идентификаторы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеВнешнихКомпонентКлиент.md b/src/content/docs/bsp/ПолучениеВнешнихКомпонентКлиент.md new file mode 100644 index 0000000..b5297ce --- /dev/null +++ b/src/content/docs/bsp/ПолучениеВнешнихКомпонентКлиент.md @@ -0,0 +1,106 @@ +--- +title: Получение внешних компонент клиент +slug: bsp/получение-внешних-компонент-клиент +--- + + +## ОбновитьВнешниеКомпоненты +
+ +Описание, пример вызова + +```bsl + +// Открывает помощник обновления внешних компонент. +// Доступно только для пользователей с полными правами. +// +// Параметры: +// Идентификаторы - Массив из Строка, Неопределено - список уникальных идентификаторов +// внешних компонент. +// ФайлОбновления - Строка, Неопределено - путь к файлу с внешними компонентами. +// +Процедура ОбновитьВнешниеКомпоненты( Экспорт +``` + +Пример вызова +```bsl +ПолучениеВнешнихКомпонентКлиент.ОбновитьВнешниеКомпоненты(); +``` +
+ +## ИмяСобытияОповещенияОЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Определяет имя события, которое будет содержать оповещение +// о завершении загрузки внешних компонент. +// +// Возвращаемое значение: +// Строка - Имя события. Может быть использовано для идентификации +// сообщений принимающими их формами. +// +Функция ИмяСобытияОповещенияОЗагрузки() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеВнешнихКомпонентКлиент.ИмяСобытияОповещенияОЗагрузки() +``` +
+ +## НастройкиОбновленияВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Определяет расписание регламентного задания обновления внешних компонент. +// +// Возвращаемое значение: +// Структура - Настройки регламентного задания обновления внешних компонент. +// См ПолучениеВнешнихКомпонент.НастройкиОбновленияВнешнихКомпонент. +// +Функция НастройкиОбновленияВнешнихКомпонент() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеВнешнихКомпонентКлиент.НастройкиОбновленияВнешнихКомпонент() +``` +
+ +## ИзменитьНастройкиОбновленияВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// Изменяет настройки обновления внешних компонент. +// +// Параметры: +// Настройки - Структура - Настройки регламентного задания обновления внешних компонент. +// **ВариантОбновления - Число - вариант обновления внешних компонент; +// **ФайлВнешнихКомпонент - Строка - путь к файлу внешних компонент; +// **Расписание - РасписаниеРегламентногоЗадания - расписание обновления внешних компонент. +// +Процедура ИзменитьНастройкиОбновленияВнешнихКомпонент(Настройки) Экспорт +``` + +Пример вызова +```bsl +ПолучениеВнешнихКомпонентКлиент.ИзменитьНастройкиОбновленияВнешнихКомпонент(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеОбновленийПрограммы.md b/src/content/docs/bsp/ПолучениеОбновленийПрограммы.md new file mode 100644 index 0000000..4fa405b --- /dev/null +++ b/src/content/docs/bsp/ПолучениеОбновленийПрограммы.md @@ -0,0 +1,362 @@ +--- +title: Получение обновлений программы +slug: bsp/получение-обновлений-программы +--- + + +## ПараметрыПолученияОбновлений +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры получения обновлений, определенные для текущей конфигурации. +// +// Возвращаемое значение: +// Структура - содержит настройки обновления информационной базы: +// * ПолучатьОбновленияКонфигурации - Булево - Истина, если для конфигурации задействовано получение обновлений +// конфигурации. +// * ПолучатьИсправления - Булево - Истина, если для конфигурации задействовано получение исправлений (патчей). +// * ПолучатьОбновленияПлатформы - Булево - Истина, если разрешено загружать и устанавливать новые версии платформы. +// +Функция ПараметрыПолученияОбновлений() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммы.ПараметрыПолученияОбновлений() +``` +
+ +## ДоступноИспользованиеОбновленияПрограммы +
+ +Описание, пример вызова + +```bsl + +// Определяет возможность использования автоматического обновления программы в +// текущем режиме работы. +// +// Параметры: +// ПроверитьВозможностьПримененияОбновлений - Булево - проверить для текущего +// пользователя наличие права применения обновления. +// Если Истина - проверяется возможность использования в режиме применения +// обновления, иначе проверить возможность просмотра информации о +// доступных обновлениях; +// ПроверитьОС - Булево - проверить возможность применения обновления +// на текущей операционной системе. +// +// Возвращаемое значение: +// Булево - признак возможности использования: Истина, если использование +// возможно, Ложь - в противном случае. +// +Функция ДоступноИспользованиеОбновленияПрограммы( Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммы.ДоступноИспользованиеОбновленияПрограммы(); +``` +
+ +## КаталогСохраненияПоследнегоПолученногоДистрибутива +
+ +Описание, пример вызова + +```bsl + +// В файловом режиме работы возвращает каталог, в который был сохранен последний +// полученный дистрибутив Платформы 1С:Предприятие. В других режимах работы +// возвращает Неопределено. +// +// Возвращаемое значение: +// Строка - каталог с дистрибутивом Платформы 1С:Предприятие в +// файловом режиме работы; +// Неопределено - в других режимах работы. +// +Функция КаталогСохраненияПоследнегоПолученногоДистрибутива() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммы.КаталогСохраненияПоследнегоПолученногоДистрибутива() +``` +
+ +## ИсправленияРодительскихКонфигураций +
+ +Описание, пример вызова + +```bsl + +// Возвращается список доступных исправлений (патчей) для текущей версии конфигурации и библиотек, встроенных в +// конфигурацию. +// Вызов метода доступен только при работе под пользователем с административными правами или при установленном +// привилегированном режиме, в противном случае, в результате выполнения возвращается ошибка. +// +// Возвращаемое значение: +// Структура - информация о доступных исправлениях (патчах): +// * Исправления - Структура - описание исправлений: +// ** Установить - Массив из Структура - описание доступных исправлений (патчей): +// *** Идентификатор - Строка - идентификатор исправления (патча); +// *** Наименование - Строка - наименование исправления (патча); +// *** ИмяПрограммы - Строка - имя родительской конфигурации, для которой доступно исправление; +// *** ВерсияПрограммы - Строка - версия родительской конфигурации, для которой доступно исправление; +// *** Описание - Строка - описание исправления (патча); +// *** ОписаниеИзмененныхМетаданных - Строка - список метаданных, в которые внесены изменения; +// *** Размер - Число - размер исправления (патча); +// ** Удалить - Массив из Строка - содержит элементы типа Строка, идентификаторы отозванных +// исправлений, которые необходимо удалить; +// * Ошибка - Булево - Истина, если при получении информации об исправлениях возникла ошибка; +// * КраткоеОписаниеОшибки - Строка - краткое описание ошибки, которое может быть отображено пользователю; +// * ПодробноеОписаниеОшибки - Строка - подробное описание ошибки, которое может быть записано в журнал регистрации. +// +Функция ИсправленияРодительскихКонфигураций() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммы.ИсправленияРодительскихКонфигураций() +``` +
+ +## ЗагрузитьИсправления +
+ +Описание, пример вызова + +```bsl + +// Загружает выбранные исправления (патчи) во временное хранилище. +// При возникновении ошибки загрузки файла одного из исправлений: загрузка файлов +// прерывается, вместе с описанием ошибки возвращаются файлы, которые удалось +// загрузить. На вызывающей стороне необходимо повторить вызов для незагруженных +// исправлений. +// Вызов метода доступен только при работе под пользователем с административными +// правами или при установленном привилегированном режиме, в противном случае, +// в результате выполнения возвращается ошибка. +// Работа метода в модели сервиса не поддерживается. +// +// Параметры: +// ИдентификаторыИсправлений - Массив из Строка - идентификаторы загружаемых исправлений; +// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор +// формы, в хранилище которой необходимо поместить загруженные файлы. +// +// Возвращаемое значение: +// Структура - информация о загруженных файлах исправлений: +// * Исправления - Массив из Структура - описание файлов исправлений, которые удалось загрузить: +// ** Идентификатор - УникальныйИдентификатор - идентификатор исправления; +// ** АдресФайла - Строка - адрес полученного файла во временном хранилище; +// * Ошибка - Булево - Истина, если при получении информации об исправлениях +// возникла ошибка; +// * КраткоеОписаниеОшибки - Строка - краткое описание ошибки, +// которое может быть отображено пользователю; +// * ПодробноеОписаниеОшибки - Строка - подробное описание ошибки, +// которое может быть записано в журнал регистрации. +// +Функция ЗагрузитьИсправления(ИдентификаторыИсправлений, ИдентификаторФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммы.ЗагрузитьИсправления(ИдентификаторыИсправлений, ИдентификаторФормы); +``` +
+ +## ДоступнаАвтоматическаяЗагрузкаИсправлений +
+ +Описание, пример вызова + +```bsl + +// Определяет возможность автоматической загрузки и установки исправлений регламентным заданием. +// +// Возвращаемое значение: +// Булево - признак возможности использования: Истина, если использование +// возможно, Ложь - в противном случае. +// +Функция ДоступнаАвтоматическаяЗагрузкаИсправлений() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммы.ДоступнаАвтоматическаяЗагрузкаИсправлений() +``` +
+ +## АвтоматическаяЗагрузкаИсправленийВключена +
+ +Описание, пример вызова + +```bsl + +// Определяет значение настройки автоматической загрузки и установки исправлений. +// При работе в модели сервиса загрузка патчей выполняется через обработку поставляемых данных. +// Функция вернет значение "Истина", если работа с исправлениями в программе разрешена. +// +// Возвращаемое значение: +// Булево - признак включенности автоматической загрузки: Истина, если загрузка +// включена, Ложь - в противном случае. +// +Функция АвтоматическаяЗагрузкаИсправленийВключена() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммы.АвтоматическаяЗагрузкаИсправленийВключена() +``` +
+ +## ВключитьОтключитьАвтоматическуюУстановкуИсправлений +
+ +Описание, пример вызова + +```bsl + +// Изменяет значение настройки автоматической загрузки и установки исправлений. +// Перед вызовом метода необходимо проверить доступность загрузки исправлений +// см. ДоступнаАвтоматическаяЗагрузкаИсправлений. Если автоматическая +// загрузка исправлений не доступна, будет вызвано исключение. +// +// При работе в модели сервиса загрузка исправлений выполняется через обработку +// поставляемых данных. Вызов метода в модели сервиса не имеет смысла. +// +// Параметры: +// ЗначениеНастройки - Булево - если Истина, автоматическая загрузка будет включена. +// +// Пример: +// Если ПолучениеОбновленийПрограммы.ДоступнаАвтоматическаяЗагрузкаИсправлений() Тогда +// ПолучениеОбновленийПрограммы.ВключитьОтключитьАвтоматическуюУстановкуИсправлений(Истина); +// КонецЕсли; +// +Процедура ВключитьОтключитьАвтоматическуюУстановкуИсправлений(Знач ЗначениеНастройки) Экспорт +``` + +Пример вызова +```bsl +ПолучениеОбновленийПрограммы.ВключитьОтключитьАвтоматическуюУстановкуИсправлений(ЗначениеНастройки) +``` +
+ +## ИнформацияОДоступныхИсправлениях +
+ +Описание, пример вызова + +```bsl + +// Возвращает список доступных исправлений (патчей) для текущей версии конфигурации и библиотек, встроенных в +// конфигурацию. +// Вызов метода доступен только при работе под пользователем с административными правами или при установленном +// привилегированном режиме, в противном случае, в результате выполнения возвращается ошибка. +// Работа метода в модели сервиса не поддерживается. +// +// Возвращаемое значение: +// Структура: +// * Исправления - Неопределено - не удалось получить информацию о доступных исправлениях (патчах). +// - ТаблицаЗначений - список доступных исправлений с колонками: +// ** Идентификатор - Строка - идентификатор исправления (патча). +// ** Наименование - Строка - наименование исправления (патча). +// ** Описание - Строка - описание исправления (патча). +// ** ОписаниеИзмененныхМетаданных - Строка - список метаданных, в которые внесены изменения. +// ** Размер - Число - размер исправления (патча). +// * Ошибка - Булево - Истина, если при получении информации об исправлениях возникла ошибка. +// * КраткоеОписаниеОшибки - Строка - краткое описание ошибки, которое может быть отображено пользователю; +// * ПодробноеОписаниеОшибки - Строка - подробное описание ошибки, которое может быть записано в журнал регистрации. +// +Функция ИнформацияОДоступныхИсправлениях() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммы.ИнформацияОДоступныхИсправлениях() +``` +
+ +## ЗагрузитьИУстановитьИсправления +
+ +Описание, пример вызова + +```bsl + +// Производить загрузку доступных исправлений, их установку и удаление отозванных исправлений для текущей версии +// конфигурации и библиотек, встроенных в конфигурацию. +// Вызов метода доступен только при работе под пользователем с административными правами или при установленном +// привилегированном режиме, в противном случае, в результате выполнения возвращается ошибка. +// Работа метода в модели сервиса не поддерживается. +// +// Возвращаемое значение: +// Структура: +// * НеУстановлено - Число - количество неустановленных исправлений. +// * НеУдалено - Число - количество неудаленных исправлений. +// * Ошибка - Булево - Истина, если ни один из доступных исправлений не применен. +// * КраткоеОписаниеОшибки - Строка - краткое описание ошибки, которое может быть отображено пользователю. Может +// быть заполнено даже если параметр Ошибка имеет значение Ложь. +// * ПодробноеОписаниеОшибки - Строка - подробное описание ошибки, которое может быть записано в журнал регистрации. +// Может быть заполнено даже если параметр Ошибка имеет значение Ложь. +// +Функция ЗагрузитьИУстановитьИсправления() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммы.ЗагрузитьИУстановитьИсправления() +``` +
+ +## ИнформацияОВерсияхПлатформы +
+ +Описание, пример вызова + +```bsl + +// Возвращает сохраненный ответ сервиса по получению информации о версиях платформы для текущей конфигурации. +// +// Возвращаемое значение: +// Структура: +// * МинимальнаяВерсияПлатформы - Строка - список минимальных версий платформы, перечисленные через ";". +// * РекомендуемаяВерсияПлатформы - Строка - список рекомендуемых версий платформы, перечисленные через ";". +// +Функция ИнформацияОВерсияхПлатформы() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммы.ИнформацияОВерсияхПлатформы() +``` +
+ +## УдалитьИнформациюОВерсияхПлатформы +
+ +Описание, пример вызова + +```bsl + +// Удаляет ранее сохраненный ответ сервиса по получению информации о версиях платформы для текущей конфигурации. +// +Процедура УдалитьИнформациюОВерсияхПлатформы() Экспорт +``` + +Пример вызова +```bsl +ПолучениеОбновленийПрограммы.УдалитьИнформациюОВерсияхПлатформы() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеОбновленийПрограммыКлиент.md b/src/content/docs/bsp/ПолучениеОбновленийПрограммыКлиент.md new file mode 100644 index 0000000..cca590f --- /dev/null +++ b/src/content/docs/bsp/ПолучениеОбновленийПрограммыКлиент.md @@ -0,0 +1,193 @@ +--- +title: Получение обновлений программы клиент +slug: bsp/получение-обновлений-программы-клиент +--- + + +## ОбновитьПрограмму +
+ +Описание, пример вызова + +```bsl + +// Открывает помощник обновления программы в режиме рабочего обновления: +// обновление версии конфигурации и/или платформы 1С:Предприятие. +// +Процедура ОбновитьПрограмму() Экспорт +``` + +Пример вызова +```bsl +ПолучениеОбновленийПрограммыКлиент.ОбновитьПрограмму() +``` +
+ +## ПерейтиНаНовуюРедакцию +
+ +Описание, пример вызова + +```bsl + +// Открывает помощник обновления программы в режиме перехода на новую редакцию +// конфигурации. +// +// Параметры: +// НомерРедакции - Строка - номер редакции, на которую выполняется переход. +// Заполняется в формате <Номер редакции>.<Номер подредакции>, +// например "3.0", "3.1" или др. +// ДополнительныеПараметры - Структура - дополнительные параметры открытия +// помощника обновления. Поля структуры: +// * ЗаголовокОкна - Строка - заголовок окна помощника обновления; +// * ЗаголовокДоступноОбновление - Строка - заголовок информации о +// доступном обновлении. Если не передан или не заполнен, тогда +// заголовок не отображается; +// * ЗаголовокНетОбновления - Строка - текст заголовка информации о +// доступном обновлении, который должен отображаться при отсутствии обновления. +// Если не передан или не заполнен, тогда +// заголовок не отображается. +// +Процедура ПерейтиНаНовуюРедакцию(НомерРедакции, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ПолучениеОбновленийПрограммыКлиент.ПерейтиНаНовуюРедакцию(НомерРедакции, ДополнительныеПараметры); +``` +
+ +## ПерейтиНаДругуюПрограмму +
+ +Описание, пример вызова + +```bsl + +// Открывает помощник обновления программы в режиме перехода на +// другую программу. +// +// Параметры: +// ИмяНовойПрограммы - Строка - имя программы, на которую выполняется переход +// (см. свойство ИдентификаторИнтернетПоддержки в методе ПриДобавленииПодсистемы()); +// НомерРедакции - Строка - номер редакции другой программы. Заполняется в +// формате <Номер редакции>.<Номер подредакции>, например "3.0", "3.1" или др. +// Если не передан, тогда выполняется переход на версию с наивысшим номером; +// ДополнительныеПараметры - Структура - дополнительные параметры открытия +// помощника обновления. Поля структуры: +// * ЗаголовокОкна - Строка - заголовок окна помощника обновления; +// * ЗаголовокДоступноОбновление - Строка - заголовок информации о +// доступном обновлении. Если не передан или не заполнен, тогда +// заголовок не отображается; +// * ЗаголовокНетОбновления - Строка - текст заголовка информации о +// доступном обновлении, который должен отображаться при отсутствии обновления. +// Если не передан или не заполнен, тогда +// заголовок не отображается. +// +Процедура ПерейтиНаДругуюПрограмму( Экспорт +``` + +Пример вызова +```bsl +ПолучениеОбновленийПрограммыКлиент.ПерейтиНаДругуюПрограмму(); +``` +
+ +## ИнформацияОДоступномОбновлении +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о доступном обновлении +// программы в сценарии рабочего обновления. +// +// Возвращаемое значение: +// Структура - информация о доступном обновлении. +// Поля: +// * Ошибка - Булево - признак возникновения ошибки при получении +// информации о доступном обновлении. Истина - возникла ошибка, +// Ложь - в противном случае; +// * Сообщение - Строка - сообщение об ошибке, которое может быть +// отображено пользователю; +// * ИнформацияОбОшибке - Строка - подробное описание ошибки, которое +// может быть записано в журнал регистрации; +// * ДоступноОбновление - Булево - признак наличия обновлений. +// Истина - доступно по меньшей мере одно обновление, +// Ложь - в противном случае. +// * Конфигурация - Структура - информация о доступном обновлении конфигурации. +// Если обновление отсутствует, тогда значение Неопределено. +// Поля: +// ** Версия - Строка - номер версии конфигурации; +// ** МинимальнаяВерсияПлатформы - Строка - минимальная версия платформы, +// необходимая для перехода на эту версию конфигурации; +// ** РазмерОбновления - Число - размер обновления в байтах; +// ** URLНовоеВВерсии - Строка - URL файла описания "Новое в версии"; +// ** URLПорядокОбновления - Строка - URL файла описания "Порядок обновления"; +// * ИсправленияДляТекущейВерсии - Число - количество доступных исправлений (патчей) для +// текущей версии конфигурации; +// * ИсправленияДляНовойВерсии - Число - количество доступных исправлений (патчей) для +// новой версии конфигурации; +// * Платформа - Структура - информация о доступном обновлении платформы 1С:Предприятие. +// Если обновление отсутствует, тогда значение Неопределено. +// Поля: +// ** Версия - Строка - номер версии платформы; +// ** РазмерОбновления - Число - размер обновления в байтах; +// ** URLОсобенностиПерехода - Строка - URL файла описания "Особенности перехода на +// новую версию платформы 1С:Предприятие"; +// ** URLСтраницыПлатформы - Строка - URL веб-страницы для ручного +// получения дистрибутива; +// ** ОбязательностьУстановки - Число - обязательность применения обновления платформы: +// 0 - обязательно; +// 1 - рекомендуется; +// 2 - не обязательно. +// +Функция ИнформацияОДоступномОбновлении() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеОбновленийПрограммыКлиент.ИнформацияОДоступномОбновлении() +``` +
+ +## ПриПроверкеВерсииПлатформыПриЗапуске +
+ +Описание, пример вызова + +```bsl + +// Отображает при начале работы программы форму помощника "Переход на новую версию платформы 1С:Предприятие" в режиме +// "Используется нерекомендуемая версия платформы 1С:Предприятие". +// Первый шаг помощника - информация о том, что используется версия платформы ниже рекомендуемой. Доступны кнопки: +// "Перейти на новую версию платформы", "Завершить работу", "Продолжить работу на текущей версии" (в зависимости от +// переданных параметров). +// Форма помощника отображается в режиме "Блокировать весь интерфейс". +// Предназначена для Интеграции с библиотекой стандартных подсистем (БСП). +// +// Параметры: +// ОповещениеОЗакрытии - ОписаниеОповещения - обработчик оповещения о завершении работы помощника. В обработчик +// оповещения передается значение: +// "Продолжить", если пользователь нажал кнопку "Продолжить работу на текущей версии", +// Неопределено - во всех остальных случаях; +// СтандартнаяОбработка - Булево - в параметре возвращается значение Ложь, если необходимо выполнить стандартную +// обработку версии платформы, из-за недоступности использования помощника в текущем режиме работы. +// +Процедура ПриПроверкеВерсииПлатформыПриЗапуске(ОповещениеОЗакрытии, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ПолучениеОбновленийПрограммыКлиент.ПриПроверкеВерсииПлатформыПриЗапуске(ОповещениеОЗакрытии, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеОбновленийПрограммыКлиентПереопределяемый.md b/src/content/docs/bsp/ПолучениеОбновленийПрограммыКлиентПереопределяемый.md new file mode 100644 index 0000000..00d6851 --- /dev/null +++ b/src/content/docs/bsp/ПолучениеОбновленийПрограммыКлиентПереопределяемый.md @@ -0,0 +1,39 @@ +--- +title: Получение обновлений программы клиент переопределяемый +slug: bsp/получение-обновлений-программы-клиент-переопределяемый +--- + + +## ПриОпределенииНеобходимостиПоказаОповещенийОДоступныхОбновлениях +
+ +Описание, пример вызова + +```bsl + +// Определяет необходимость показа всплывающего оповещения о +// доступном обновлении программы. Вызывается только при наличии +// встроенной подсистемы СтандартныеПодсистемы.ТекущиеДела. +// +// Параметры: +// Использование - Булево - в параметре возвращается признак необходимости +// показа оповещения. Истина- показать, Ложь - в противном случае. +// Значение по умолчанию - Ложь. +// +//@skip-warning +Процедура ПриОпределенииНеобходимостиПоказаОповещенийОДоступныхОбновлениях(Использование) Экспорт +``` + +Пример вызова +```bsl +ПолучениеОбновленийПрограммыКлиентПереопределяемый.ПриОпределенииНеобходимостиПоказаОповещенийОДоступныхОбновлениях(Использование) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеОбновленийПрограммыПереопределяемый.md b/src/content/docs/bsp/ПолучениеОбновленийПрограммыПереопределяемый.md new file mode 100644 index 0000000..4f8299e --- /dev/null +++ b/src/content/docs/bsp/ПолучениеОбновленийПрограммыПереопределяемый.md @@ -0,0 +1,76 @@ +--- +title: Получение обновлений программы переопределяемый +slug: bsp/получение-обновлений-программы-переопределяемый +--- + + +## ПриОпределенииПараметровПолученияОбновлений +
+ +Описание, пример вызова + +```bsl + +// Определяет параметры функциональности получения обновлений программы. +// +// Параметры: +// ПараметрыПолученияОбновлений - Структура - параметры получения обновлений: +// * ПолучатьОбновленияКонфигурации - Булево - задействовать функциональность получения обновлений конфигурации в +// сценарии рабочего обновления программы. В сценариях перехода на новую редакцию конфигурации или новую +// конфигурацию получение обновления конфигурации используется всегда. +// Значение параметра по умолчанию - Истина. +// * ПолучатьИсправления - Булево - задействовать функциональность получения исправлений конфигурации. +// Значение параметра по умолчанию - Истина. +// * ПолучатьОбновленияПлатформы - Булево - задействовать функциональность получения обновлений платформы в +// сценарии рабочего обновления программы. +// * ВыбиратьКаталогСохраненияДистрибутиваПлатформы - Булево - предлагать в не базовой версии конфигурации сохранять +// дистрибутив платформы 1С:Предприятие в каталог на диске или локальной сети. В базовой версии настройка не +// используется, дистрибутив платформы 1С:Предприятие сохраняется в каталог по умолчанию. +// Значение параметра по умолчанию - Истина. +// +//@skip-warning +Процедура ПриОпределенииПараметровПолученияОбновлений(ПараметрыПолученияОбновлений) Экспорт +``` + +Пример вызова +```bsl +ПолучениеОбновленийПрограммыПереопределяемый.ПриОпределенииПараметровПолученияОбновлений(ПараметрыПолученияОбновлений) +``` +
+ +## ПриОпределенииНастроекЗагрузкиИсправлений +
+ +Описание, пример вызова + +```bsl + +// Переопределяет параметры загружаемых и устанавливаемых исправлений (патчей). +// +// Параметры: +// Настройки - Структура: +// * ОтключитьНапоминания - Булево - Истина, если необходимо отключить создание задачи по включению автоматической +// загрузки исправлений в подсистеме БСП.ТекущиеДела и не показывать оповещение пользователю при старте системы, +// если подсистема БСП.ТекущиеДела отсутствует в конфигурации. +// * Подсистемы - Массив из Структура - список программ, исправления которых необходимо загружать и устанавливать: +// ** ИмяПодсистемы - Строка - имя подсистемы, например, "ИнтернетПоддержкиПользователей". +// ** ИдентификаторИнтернетПоддержки - Строка - имя программы в сервисах Интернет-поддержки. +// ** Версия - Строка - версия программы в формате из 4-х цифр, например, "2.1.3.1". +// +//@skip-warning +Процедура ПриОпределенииНастроекЗагрузкиИсправлений(Настройки) Экспорт +``` + +Пример вызова +```bsl +ПолучениеОбновленийПрограммыПереопределяемый.ПриОпределенииНастроекЗагрузкиИсправлений(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеФайловИзИнтернета.md b/src/content/docs/bsp/ПолучениеФайловИзИнтернета.md new file mode 100644 index 0000000..ea974b0 --- /dev/null +++ b/src/content/docs/bsp/ПолучениеФайловИзИнтернета.md @@ -0,0 +1,236 @@ +--- +title: Получение файлов из интернета +slug: bsp/получение-файлов-из-интернета +--- + + +## СкачатьФайлНаСервере +
+ +Описание, пример вызова + +```bsl + +// Получает файл из Интернета по протоколу HTTP(s), либо ftp и сохраняет его по указанному пути на сервере. +// +// Параметры: +// URL - Строка - url файла в формате [Протокол://]<Сервер>/<Путь к файлу на сервере>. +// ПараметрыПолучения - см. ПолучениеФайловИзИнтернетаКлиентСервер.ПараметрыПолученияФайла +// ЗаписыватьОшибку - Булево - признак необходимости записи ошибки в журнал регистрации при получении файла. +// +// Возвращаемое значение: +// Структура: +// * Статус - Булево - результат получения файла. +// * Путь - Строка - путь к файлу на сервере, ключ используется только если статус Истина. +// * СообщениеОбОшибке - Строка - сообщение об ошибке, если статус Ложь. +// * Заголовки - Соответствие - см. в синтакс-помощнике описание параметра Заголовки объекта HTTPОтвет. +// * КодСостояния - Число - добавляется при возникновении ошибки. +// См. в синтакс-помощнике описание параметра КодСостояния объекта HTTPОтвет. +// +Функция СкачатьФайлНаСервере(Знач URL, ПараметрыПолучения = Неопределено, Знач ЗаписыватьОшибку = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернета.СкачатьФайлНаСервере(URL, ПараметрыПолучения, ЗаписыватьОшибку); +``` +
+ +## СкачатьФайлВоВременноеХранилище +
+ +Описание, пример вызова + +```bsl + +// Получает файл из Интернета по протоколу HTTP(s), либо ftp и сохраняет его во временное хранилище. +// Примечание: после получения файла временное хранилище необходимо самостоятельно очистить +// при помощи метода УдалитьИзВременногоХранилища. Если этого не сделать, то файл будет находиться +// в памяти сервера до конца сеанса. +// +// Параметры: +// URL - Строка - url файла в формате [Протокол://]<Сервер>/<Путь к файлу на сервере>. +// ПараметрыПолучения - см. ПолучениеФайловИзИнтернетаКлиентСервер.ПараметрыПолученияФайла. +// ЗаписыватьОшибку - Булево - признак необходимости записи ошибки в журнал регистрации при получении файла. +// +// Возвращаемое значение: +// Структура: +// * Статус - Булево - результат получения файла. +// * Путь - Строка - адрес временного хранилища с двоичными данными файла, +// ключ используется, только если статус Истина. +// * СообщениеОбОшибке - Строка - сообщение об ошибке, если статус Ложь. +// * Заголовки - Соответствие - см. в синтакс-помощнике описание параметра Заголовки объекта HTTPОтвет. +// * КодСостояния - Число - добавляется при возникновении ошибки. +// См. в синтакс-помощнике описание параметра КодСостояния объекта HTTPОтвет. +// +Функция СкачатьФайлВоВременноеХранилище(Знач URL, ПараметрыПолучения = Неопределено, Знач ЗаписыватьОшибку = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернета.СкачатьФайлВоВременноеХранилище(URL, ПараметрыПолучения, ЗаписыватьОшибку); +``` +
+ +## НастройкиПроксиНаКлиенте +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройку прокси-сервера для доступа в Интернет со стороны +// клиента для текущего пользователя. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - Произвольный +// Ключи: +// # ИспользоватьПрокси - Булево - использовать ли прокси-сервер. +// # НеИспользоватьПроксиДляЛокальныхАдресов - Булево - использовать ли прокси-сервер для локальных адресов. +// # ИспользоватьСистемныеНастройки - Булево - использовать ли системные настройки прокси-сервера. +// # Сервер - Строка - адрес прокси-сервера. +// # Порт - Число - порт прокси-сервера. +// # Пользователь - Строка - имя пользователя для авторизации на прокси-сервере. +// # Пароль - Строка - пароль пользователя. +// +Функция НастройкиПроксиНаКлиенте() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернета.НастройкиПроксиНаКлиенте() +``` +
+ +## НастройкиПроксиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры настройки прокси-сервера на стороне сервера 1С:Предприятия. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - Произвольный +// Ключи: +// # ИспользоватьПрокси - Булево - использовать ли прокси-сервер. +// # НеИспользоватьПроксиДляЛокальныхАдресов - Булево - использовать ли прокси-сервер для локальных адресов. +// # ИспользоватьСистемныеНастройки - Булево - использовать ли системные настройки прокси-сервера. +// # Сервер - Строка - адрес прокси-сервера. +// # Порт - Число - порт прокси-сервера. +// # Пользователь - Строка - имя пользователя для авторизации на прокси-сервере. +// # Пароль - Строка - пароль пользователя. +// +Функция НастройкиПроксиНаСервере() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернета.НастройкиПроксиНаСервере() +``` +
+ +## ПолучитьПрокси +
+ +Описание, пример вызова + +```bsl + +// Возвращает объект ИнтернетПрокси для доступа в Интернет. +// Допустимые протоколы для создания ИнтернетПрокси HTTP, https, ftp и ftps. +// +// Параметры: +// URLИлиПротокол - Строка - url в формате [Протокол://]<Сервер>/<Путь к файлу на сервере>, +// либо идентификатор протокола (HTTP, ftp, ...). +// +// Возвращаемое значение: +// ИнтернетПрокси - описывает параметры прокси-серверов для различных протоколов. +// Если не удалось распознать схему сетевой протокол, +// то будет создать прокси на основании протокола HTTP. +// +Функция ПолучитьПрокси(Знач URLИлиПротокол) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернета.ПолучитьПрокси(URLИлиПротокол) +``` +
+ +## ДиагностикаСоединения +
+ +Описание, пример вызова + +```bsl + +// Запускает диагностику сетевого ресурса. +// В модели сервиса возвращается только описание ошибки. +// +// Параметры: +// URL - Строка - адрес URL ресурса, диагностику которого надо выполнить. +// ЗаписыватьОшибку - Булево - признак необходимости записи ошибок в журнал регистрации. +// ПроверятьДоставкуПакетов - Булево - включать в диагностику команду PING к требуемому ресурсу URL. +// ТекстОшибки - Строка - исходный текст исключения. +// +// Возвращаемое значение: +// Структура: +// * ОписаниеОшибки - Строка - краткое описание ошибки. +// * ЖурналДиагностики - Строка - подробный журнал диагностики с техническими подробностями. +// +// Пример: +// // Диагностика веб-сервиса адресного классификатора. +// Результат = ПолучениеФайловИзИнтернета.ДиагностикаСоединения("https://api.orgaddress.1c.com/orgaddress/v1?wsdl"); +// +// ОписаниеОшибки = Результат.ОписаниеОшибки; +// ЖурналДиагностики = Результат.ЖурналДиагностики; +// +Функция ДиагностикаСоединения(URL, ЗаписыватьОшибку = Истина, ПроверятьДоставкуПакетов = Истина, ТекстОшибки = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернета.ДиагностикаСоединения(URL, ЗаписыватьОшибку, ПроверятьДоставкуПакетов, ТекстОшибки); +``` +
+ +## ТаймаутЗагрузкиФайла +
+ +Описание, пример вызова + +```bsl + +// Определяет значение таймаута в секундах для загрузки файла в зависимости от размера этого файла. +// Если известен размер файла, то размер в мегабайтах * 128, иначе +// предельное время загрузки, но не более 43200. +// Минимальный таймаут - 30, это время необходимое для установки соединения. +// +// Параметры: +// Размер - Число - размер файла в байтах. +// +// Возвращаемое значение: +// Число +// +Функция ТаймаутЗагрузкиФайла(Размер) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернета.ТаймаутЗагрузкиФайла(Размер) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеФайловИзИнтернетаКлиент.md b/src/content/docs/bsp/ПолучениеФайловИзИнтернетаКлиент.md new file mode 100644 index 0000000..be1bffb --- /dev/null +++ b/src/content/docs/bsp/ПолучениеФайловИзИнтернетаКлиент.md @@ -0,0 +1,68 @@ +--- +title: Получение файлов из интернета клиент +slug: bsp/получение-файлов-из-интернета-клиент +--- + + +## СкачатьФайлНаКлиенте +
+ +Описание, пример вызова + +```bsl + +// Получает файл из Интернета по протоколу HTTP(s), либо ftp и сохраняет его по указанному пути на клиенте. +// Недоступно при работе в веб-клиенте. При работе в веб-клиенте необходимо пользоваться аналогичными +// серверными процедурами для скачивания файлов. +// +// Параметры: +// URL - Строка - url файла в формате [Протокол://]<Сервер>/<Путь к файлу на сервере>. +// ПараметрыПолучения - см. ПолучениеФайловИзИнтернетаКлиентСервер.ПараметрыПолученияФайла. +// ЗаписыватьОшибку - Булево - признак необходимости записи ошибки в журнал регистрации при получении файла. +// +// Возвращаемое значение: +// Структура - сведения о полученном файле: +// * Статус - Булево - Истина, если файл получен успешно. +// * Путь - Строка - путь к файлу на клиенте, ключ используется только если статус Истина. +// * СообщениеОбОшибке - Строка - сообщение об ошибке, если статус Ложь. +// * Заголовки - Соответствие - см. в синтакс-помощнике описание параметра Заголовки объекта HTTPОтвет. +// * КодСостояния - Число - добавляется при возникновении ошибки. +// См. в синтакс-помощнике описание параметра КодСостояния объекта HTTPОтвет. +// +Функция СкачатьФайлНаКлиенте(Знач URL, Знач ПараметрыПолучения = Неопределено, Знач ЗаписыватьОшибку = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернетаКлиент.СкачатьФайлНаКлиенте(URL, ПараметрыПолучения, ЗаписыватьОшибку); +``` +
+ +## ОткрытьФормуПараметровПроксиСервера +
+ +Описание, пример вызова + +```bsl + +// Открывает форму для ввода параметров прокси сервера. +// +// Параметры: +// ПараметрыФормы - Структура - параметры открываемой формы. +// +Процедура ОткрытьФормуПараметровПроксиСервера(ПараметрыФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ПолучениеФайловИзИнтернетаКлиент.ОткрытьФормуПараметровПроксиСервера(ПараметрыФормы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеФайловИзИнтернетаКлиентСервер.md b/src/content/docs/bsp/ПолучениеФайловИзИнтернетаКлиентСервер.md new file mode 100644 index 0000000..f85a058 --- /dev/null +++ b/src/content/docs/bsp/ПолучениеФайловИзИнтернетаКлиентСервер.md @@ -0,0 +1,147 @@ +--- +title: Получение файлов из интернета клиент сервер +slug: bsp/получение-файлов-из-интернета-клиент-сервер +--- + + +## ПараметрыПолученияФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров для получения файла из Интернета. +// +// Возвращаемое значение: +// Структура: +// * ПутьДляСохранения - Строка - путь на сервере (включая имя файла) для сохранения скачанного файла. +// Не заполняется при сохранении файла во временное хранилище. +// * Пользователь - Строка - пользователь, от имени которого установлено соединение. +// * Пароль - Строка - пароль, пользователя от которого установлено соединение. +// * Порт - Число - порт сервера, с которым установлено соединение. +// * Таймаут - Число - таймаут на получение файла в секундах. +// * ЗащищенноеСоединение - Булево - признак использования защищенного соединения ftps или https. +// - ЗащищенноеСоединениеOpenSSL +// - Неопределено - в случае, если защищенное соединение не используется. +// * ПроверятьДоставкуПакетовПриОшибке - Булево - при ошибке обращения к URL включать в диагностику команду PING. +// * ПроверятьДоступКИнтернетСервисам - Булево - необязательный параметр, по умолчанию Истина - выполняется проверка +// разрешения доступа к Интернет-сервисам из приложения. +// +// Параметры только для HTTP (https) соединения: +// * Заголовки - Соответствие - см. в синтакс-помощнике описание параметра Заголовки объекта HTTPЗапрос. +// * ИспользоватьАутентификациюОС - Булево - см. в синтакс-помощнике описание параметра +// ИспользоватьАутентификациюОС объекта HTTPСоединение. +// +// Параметры только для ftp (ftps) соединения: +// * ПассивноеСоединение - Булево - флаг указывает, что соединение должно пассивным (или активным). +// * УровеньИспользованияЗащищенногоСоединения - УровеньИспользованияЗащищенногоСоединенияFTP - см. описание +// одноименного свойства в синтакс-помощнике платформы. Значение по умолчанию - Авто. +// +Функция ПараметрыПолученияФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернетаКлиентСервер.ПараметрыПолученияФайла() +``` +
+ +## ПолучитьПрокси +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ПолучениеФайловИзИнтернета.ПолучитьПрокси. +// Возвращает объект ИнтернетПрокси для доступа в Интернет. +// Допустимые протоколы для создания ИнтернетПрокси HTTP, https, ftp и ftps. +// +// Параметры: +// URLИлиПротокол - Строка - url в формате [Протокол://]<Сервер>/<Путь к файлу на сервере>, +// либо идентификатор протокола (HTTP, ftp, ...). +// +// Возвращаемое значение: +// ИнтернетПрокси - описывает параметры прокси-серверов для различных протоколов. +// Если не удалось распознать схему сетевой протокол, +// то будет создать прокси на основании протокола HTTP. +// +Функция ПолучитьПрокси(Знач URLИлиПротокол) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернетаКлиентСервер.ПолучитьПрокси(URLИлиПротокол) +``` +
+ +## РазделитьURL +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиентСервер.СтруктураURI. +// Разделяет URL по составным частям: протокол, сервер, путь к ресурсу. +// +// Параметры: +// URL - Строка - ссылка на ресурс в сети Интернет. +// +// Возвращаемое значение: +// Структура: +// * Протокол - Строка - протокол доступа к ресурсу. +// * ИмяСервера - Строка - сервер, на котором располагается ресурс. +// * ПутьКФайлуНаСервере - Строка - путь к ресурсу на сервере. +// +Функция РазделитьURL(Знач URL) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернетаКлиентСервер.РазделитьURL(URL) +``` +
+ +## СтруктураURI +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбщегоНазначенияКлиентСервер.СтруктураURI. +// Разбирает строку URI на составные части и возвращает в виде структуры. +// На основе RFC 3986. +// +// Параметры: +// СтрокаURI - Строка - ссылка на ресурс в формате: +// <схема>://<логин>:<пароль>@<хост>:<порт>/<путь>?<параметры>#<якорь>. +// +// Возвращаемое значение: +// Структура - составные части URI согласно формату: +// * Схема - Строка - схема URI. +// * Логин - Строка - имя пользователя. +// * Пароль - Строка - пароль пользователя. +// * ИмяСервера - Строка - часть <хост>:<порт> входного параметра. +// * Хост - Строка - имя сервера. +// * Порт - Строка - порт сервера. +// * ПутьНаСервере - Строка - часть <путь>?<параметры>#<якорь> входного параметра. +// +Функция СтруктураURI(Знач СтрокаURI) Экспорт +``` + +Пример вызова +```bsl +Результат = ПолучениеФайловИзИнтернетаКлиентСервер.СтруктураURI(СтрокаURI) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПолучениеФайловИзИнтернетаЛокализация.md b/src/content/docs/bsp/ПолучениеФайловИзИнтернетаЛокализация.md new file mode 100644 index 0000000..818a902 --- /dev/null +++ b/src/content/docs/bsp/ПолучениеФайловИзИнтернетаЛокализация.md @@ -0,0 +1,57 @@ +--- +title: Получение файлов из интернета локализация +slug: bsp/получение-файлов-из-интернета-локализация +--- + + +## ПриПолученииАдресаСервераКонтрольнойПроверки +
+ +Описание, пример вызова + +```bsl + +// Вызывается при проверке доступности Интернета и позволяет указать контрольный адрес. +// +// Параметры: +// АдресаСервера - Строка - установить адрес сервера для контрольной проверки подключения. +// По умолчанию, "google.co)m". +// +Процедура ПриПолученииАдресаСервераКонтрольнойПроверки(АдресаСервера) Экспорт +``` + +Пример вызова +```bsl +ПолучениеФайловИзИнтернетаЛокализация.ПриПолученииАдресаСервераКонтрольнойПроверки(АдресаСервера) +``` +
+ +## ПриФормированииСообщенияОбИзвестнойПроблеме +
+ +Описание, пример вызова + +```bsl + +// Вызывается при проверке доступности Интернета и позволяет дополнить подробную информацию об известной проблеме. +// +// Параметры: +// Описание - Массив из Строка - краткое описание ошибки при проверке доступности Интернета. +// ТекстОшибки - см. ПолучениеФайловИзИнтернета.ДиагностикаСоединения +// +Процедура ПриФормированииСообщенияОбИзвестнойПроблеме(Описание, ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +ПолучениеФайловИзИнтернетаЛокализация.ПриФормированииСообщенияОбИзвестнойПроблеме(Описание, ТекстОшибки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/Пользователи.md b/src/content/docs/bsp/Пользователи.md new file mode 100644 index 0000000..939ca68 --- /dev/null +++ b/src/content/docs/bsp/Пользователи.md @@ -0,0 +1,1332 @@ +--- +title: Пользователи +slug: bsp/пользователи +--- + + +## АвторизованныйПользователь +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущего пользователя или текущего внешнего пользователя, +// в зависимости от того, кто выполнил вход в сеанс. +// Рекомендуется использовать в коде, который поддерживает работу в обоих случаях. +// +// Возвращаемое значение: +// СправочникСсылка.Пользователи, СправочникСсылка.ВнешниеПользователи - пользователь +// или внешний пользователь. +// +Функция АвторизованныйПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.АвторизованныйПользователь() +``` +
+ +## ТекущийПользователь +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущего пользователя. +// Рекомендуется использовать в коде, который не поддерживает работу с внешними пользователями. +// +// Если вход в сеанс выполнил внешний пользователь, тогда будет вызвано исключение. +// +// Возвращаемое значение: +// СправочникСсылка.Пользователи - пользователь. +// +Функция ТекущийПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ТекущийПользователь() +``` +
+ +## ЭтоСеансВнешнегоПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если вход в сеанс выполнил внешний пользователь. +// +// Возвращаемое значение: +// Булево - Истина, если вход в сеанс выполнил внешний пользователь. +// +Функция ЭтоСеансВнешнегоПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ЭтоСеансВнешнегоПользователя() +``` +
+ +## ЭтоПолноправныйПользователь +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли текущий или указанный пользователь полноправным. +// +// Полноправным считается пользователь, который: +// а) при непустом списке пользователей информационной базы +// имеет роль ПолныеПрава и роль для администрирования системы (если ПроверятьПраваАдминистрированияСистемы = Истина); +// б) при пустом списке пользователей информационной базы +// основная роль конфигурации не задана или ПолныеПрава. +// +// Параметры: +// Пользователь - Неопределено - проверяется текущий пользователь ИБ. +// - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи - осуществляется +// поиск пользователя ИБ по уникальному идентификатору, заданному в реквизите +// ИдентификаторПользователяИБ. Если пользователь ИБ не существует, возвращается Ложь. +// - ПользовательИнформационнойБазы - проверяется указанный пользователь ИБ. +// +// ПроверятьПраваАдминистрированияСистемы - Булево - если задано Истина, тогда проверяется наличие +// роли для администрирования системы. +// +// УчитыватьПривилегированныйРежим - Булево - если задано Истина, тогда для текущего пользователя +// функция возвращает Истина, когда установлен привилегированный режим. +// +// Возвращаемое значение: +// Булево - если Истина, пользователь является полноправным. +// +Функция ЭтоПолноправныйПользователь(Пользователь = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ЭтоПолноправныйПользователь(Пользователь, ); +``` +
+ +## РолиДоступны +
+ +Описание, пример вызова + +```bsl + +// Возвращает доступность хотя бы одной из указанных ролей или полноправность +// пользователя (текущего или указанного). +// +// Параметры: +// ИменаРолей - Строка - имена ролей, разделенные запятыми, доступность которых проверяется. +// +// Пользователь - Неопределено - проверяется текущий пользователь ИБ. +// - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи - осуществляется +// поиск пользователя ИБ по уникальному идентификатору, заданному в реквизите. +// ИдентификаторПользователяИБ. Если пользователь ИБ не существует, возвращается Ложь. +// - ПользовательИнформационнойБазы - проверяется указанный пользователь ИБ. +// +// УчитыватьПривилегированныйРежим - Булево - если задано Истина, тогда для текущего пользователя +// функция возвращает Истина, когда установлен привилегированный режим. +// +// Возвращаемое значение: +// Булево - Истина, если хотя бы одна из указанных ролей доступна +// или функция ЭтоПолноправныйПользователь(Пользователь) возвращает Истина. +// +Функция РолиДоступны(ИменаРолей, Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.РолиДоступны(ИменаРолей, ); +``` +
+ +## ВходВПрограммуРазрешен +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие хотя бы одного вида аутентификации у пользователя ИБ. +// Поддерживается вызов из сеанса без установленных разделителей (без обращения к базе данных), +// если параметр ОписаниеПользователяИБ имеет тип ПользовательИнформационнойБазы или Структура. +// +// Параметры: +// ОписаниеПользователяИБ - УникальныйИдентификатор - идентификатор пользователя ИБ. +// - Структура - содержит свойства аутентификации: +// * АутентификацияСтандартная - Булево - аутентификация 1С:Предприятия. +// * АутентификацияОС - Булево - аутентификация операционной системы. +// * АутентификацияOpenID - Булево - аутентификация OpenID. +// * АутентификацияOpenIDConnect - Булево - аутентификация OpenID-Connect. +// * АутентификацияТокеномДоступа - Булево - аутентификация JWT-токеном. +// - ПользовательИнформационнойБазы - пользователь ИБ. +// - СправочникСсылка.Пользователи - пользователь. +// - СправочникСсылка.ВнешниеПользователи - внешний пользователь. +// +// Возвращаемое значение: +// Булево - Истина, если хотя бы одно свойство аутентификации равно Истина. +// +Функция ВходВПрограммуРазрешен(ОписаниеПользователяИБ) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ВходВПрограммуРазрешен(ОписаниеПользователяИБ) +``` +
+ +## ЕстьПраваДляВходаВПрограмму +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что у пользователя ИБ есть права для входа в программу интерактивно или через COM-объект. +// Поддерживается вызов из сеанса без установленных разделителей (без обращения к базе данных). +// +// Параметры: +// ПользовательИБ - ПользовательИнформационнойБазы +// Интерактивно - Булево - когда Истина, тогда не учитываются права, +// например, ВнешнееСоединение, Automation. +// ТолькоПраваНаЗапуск - Булево - если Истина, тогда проверяется только наличие прав на запуск, +// если Ложь, тогда проверяться еще и наличие минимальных прав для входа. +// +// Возвращаемое значение: +// Булево +// +Функция ЕстьПраваДляВходаВПрограмму(ПользовательИБ, Интерактивно = Истина, ТолькоПраваНаЗапуск = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ЕстьПраваДляВходаВПрограмму(ПользовательИБ, Интерактивно, ТолькоПраваНаЗапуск); +``` +
+ +## АвторизоватьТекущегоПользователяПриВходе +
+ +Описание, пример вызова + +```bsl + +// Следует вызывать в начале процедур HTTP-сервисов, веб-сервисов, com-соединений, +// если они используются для удаленного подключения обычных пользователей, +// чтобы обеспечить контроль ограничений на вход (по дате, по активности и т.д.), +// обновить дату последнего входа, а также сразу заполнить параметры сеанса +// АвторизованныйПользователь, ТекущийПользователь, ТекущийВнешнийПользователь. +// +// Процедура вызывается автоматически только при интерактивном входе, +// то есть когда ТекущийРежимЗапуска() <> Неопределено. +// +// Параметры: +// ВызыватьИсключение - Булево - вызывать исключение в случае ошибки авторизации, +// в противном случае возвращать текст ошибки. +// Возвращаемое значение: +// Структура: +// * ОшибкаАвторизации - Строка - текст ошибки, если заполнено. +// * ТребуетсяСменитьПароль - Булево - если Истина, тогда это ошибка устаревания пароля. +// +Функция АвторизоватьТекущегоПользователяПриВходе(ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.АвторизоватьТекущегоПользователяПриВходе(ВызыватьИсключение); +``` +
+ +## ФизическоеЛицоИспользуется +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если определяемый тип ФизическоеЛицо содержит +// тип отличный от Строка и в процедуре ПриОпределенииНастроек +// общего модуля ПользователиПереопределяемый настроено +// использовать реквизит ФизическоеЛицо. +// +// Возвращаемое значение: +// Булево +// +Функция ФизическоеЛицоИспользуется() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ФизическоеЛицоИспользуется() +``` +
+ +## ПодразделениеИспользуется +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если определяемый тип Подразделение содержит +// тип отличный от Строка и в процедуре ПриОпределенииНастроек +// общего модуля ПользователиПереопределяемый настроено +// использовать реквизит Подразделение. +// +// Возвращаемое значение: +// Булево +// +Функция ПодразделениеИспользуется() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ПодразделениеИспользуется() +``` +
+ +## СформироватьДанныеВыбораПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает список пользователей, групп пользователей, внешних пользователей и +// групп внешних пользователей. +// Для использования в обработчиках событий ОкончаниеВводаТекста и АвтоПодбор. +// +// Параметры: +// Текст - Строка - символы, введенные пользователем. +// +// ВключаяГруппы - Булево - если Истина, включать группы пользователей и внешних пользователей. +// Если ФО ИспользоватьГруппыПользователей отключена, параметр игнорируется. +// +// ВключаяВнешнихПользователей - Неопределено +// - Булево - когда Неопределено, используется значение, +// возвращаемое функцией ВнешниеПользователи.ИспользоватьВнешнихПользователей. +// +// БезПользователей - Булево - если Истина, то элементы справочника Пользователи +// исключаются из результата. +// +// Возвращаемое значение: +// СписокЗначений +// +Функция СформироватьДанныеВыбораПользователя(Знач Текст, Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.СформироватьДанныеВыбораПользователя(Текст, ); +``` +
+ +## ЗаполнитьНомераКартинокПользователей +
+ +Описание, пример вызова + +```bsl + +// Заполняет номера картинок пользователей, групп пользователей, внешних пользователей и групп внешних пользователей +// во всех строках или указанной (см. параметр ИдентификаторСтроки) строке коллекции ТаблицаИлиДерево. +// +// Параметры: +// ТаблицаИлиДерево - ДанныеФормыКоллекция +// - ДанныеФормыДерево - коллекция для заполнения. +// ИмяПоляПользователь - Строка - имя колонки в коллекции ТаблицаИлиДерево, содержащей ссылку на пользователя, +// группу пользователей, внешнего пользователя или группу внешних пользователей. +// По ее значению вычисляется номер картинки. +// ИмяПоляНомераКартинки - Строка - имя колонки в коллекции ТаблицаИлиДерево с номером картинки, +// которое требуется заполнить. +// ИдентификаторСтроки - Неопределено +// - Число - идентификатор строки (не порядковый номер), которую требуется +// заполнить (у дерева также будут заполнены и дочерние строки), +// если Неопределено, то картинки будут заполнены во всех строках. +// ОбработатьИерархиюВторогоИТретьегоУровней - Булево - если Истина и в параметре ТаблицаИлиДерево указана +// коллекция типа ДанныеФормыДерево, то +// будут заполнены поля по четвертый уровень дерева включительно, +// иначе будут заполнены поля только на первом и втором уровне дерева. +// +Процедура ЗаполнитьНомераКартинокПользователей(Знач ТаблицаИлиДерево, Экспорт +``` + +Пример вызова +```bsl +Пользователи.ЗаполнитьНомераКартинокПользователей(ТаблицаИлиДерево, ); +``` +
+ +## СоздатьАдминистратора +
+ +Описание, пример вызова + +```bsl + +// Используется при обновлении и начальном заполнении информационной базы. +// 1) Создает первого администратора и сопоставляет его с новым или существующим +// пользователем в справочнике Пользователи. +// 2) Сопоставляет администратора, указанного в параметре ПользовательИБ, с новым или +// существующим пользователем в справочнике Пользователи. +// +// Параметры: +// ПользовательИБ - Неопределено - создать первого администратора, если не существует. +// - ПользовательИнформационнойБазы - используется, когда нужно сопоставить +// существующего администратора с новым или существующим пользователем +// в справочнике Пользователи. +// +// Возвращаемое значение: +// Неопределено - первый администратор уже существует. +// СправочникСсылка.Пользователи - пользователь в справочнике, с которым сопоставлен созданный +// первый администратор или указанный существующий. +// +Функция СоздатьАдминистратора(ПользовательИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.СоздатьАдминистратора(ПользовательИБ); +``` +
+ +## ПриНаличииГруппПользователейУстановитьИспользование +
+ +Описание, пример вызова + +```bsl + +// Устанавливает константу ИспользоватьГруппыПользователей в Истина, +// если существует хотя бы одна группа пользователей в справочнике. +// +// Используется при обновлении информационной базы. +// +Процедура ПриНаличииГруппПользователейУстановитьИспользование() Экспорт +``` + +Пример вызова +```bsl +Пользователи.ПриНаличииГруппПользователейУстановитьИспользование() +``` +
+ +## ГруппаВсеПользователи +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на стандартную группу пользователей ВсеПользователи. +// +// Возвращаемое значение: +// СправочникСсылка.ГруппыПользователей +// +Функция ГруппаВсеПользователи() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ГруппаВсеПользователи() +``` +
+ +## ПолноеИмяНеуказанногоПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает текстовое представление "<Не указан>" для случаев, когда пользователь не указан или не выбран. +// См. также Пользователи.СсылкаНеуказанногоПользователя. +// +// Возвращаемое значение: +// Строка +// +Функция ПолноеИмяНеуказанногоПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ПолноеИмяНеуказанногоПользователя() +``` +
+ +## СсылкаНеуказанногоПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку неуказанного пользователя. +// См. также Пользователи.ПолноеИмяНеуказанногоПользователя. +// +// Параметры: +// СоздатьЕслиНеСуществует - Булево - если Истина, то будет создан пользователь "<Не указан>". +// +// Возвращаемое значение: +// СправочникСсылка.Пользователи +// Неопределено - если неуказанный пользователь не существует в справочнике. +// +Функция СсылкаНеуказанногоПользователя(СоздатьЕслиНеСуществует = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.СсылкаНеуказанногоПользователя(СоздатьЕслиНеСуществует); +``` +
+ +## ПользовательИБЗанят +
+ +Описание, пример вызова + +```bsl + +// Проверяет, сопоставлен ли пользователь ИБ с элементом справочника Пользователи или +// с элементом справочника ВнешниеПользователи. +// +// Параметры: +// ПользовательИБ - Строка - имя пользователя ИБ. +// - УникальныйИдентификатор - уникальный идентификатор пользователя ИБ. +// - ПользовательИнформационнойБазы +// +// УчетнаяЗапись - ПользовательИнформационнойБазы - возвращаемое значение. +// +// Возвращаемое значение: +// Булево - Истина, если пользователь ИБ существует и его идентификатор +// используется либо в справочнике Пользователи, либо в справочнике ВнешниеПользователи. +// +Функция ПользовательИБЗанят(ПользовательИБ, УчетнаяЗапись = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ПользовательИБЗанят(ПользовательИБ, УчетнаяЗапись); +``` +
+ +## НовоеОписаниеПользователяИБ +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую структуру описания пользователя ИБ. +// Назначение свойств структуры соответствует свойствам объекта ПользовательИнформационнойБазы. +// +// Параметры: +// ДляУстановки - Булево - начальное значение Истина. +// Когда Ложь, возвращаются значения свойств для нового пользователя ИБ. +// Когда Истина, тогда свойства структуры заполняются значением Неопределено, чтобы не изменять лишние свойства +// объекта ПользовательИнформационнойБазы при вызове процедуры УстановитьСвойстваПользователяИБ. +// ДляСлужебногоПользователя - Булево - начальное значение Ложь. +// Когда ДляУстановки = Истина И ДляСлужебногоПользователя = Истина, тогда часть свойств инициализируется +// значениями, которые являются обычными для служебного пользователя: свойства аутентификации +// заполняются значениями Ложь, свойству Роли устанавливается пустой массив, включается запрет +// изменения и восстановления пароля, отключается отображение в списке выбора. +// Кроме того, свойство ПарольУстановлен устанавливается Ложь (смотри СлужебныйПользователиИБ). +// +// Возвращаемое значение: +// Структура: +// * УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор пользователя ИБ. +// Пустой идентификатор после инициализации, непустой после успешного чтения. +// * Имя - Строка - имя пользователя информационной базы. Например, "Иванов". +// - Неопределено - означает не менять свойство при установке набора свойств. +// * ПолноеИмя - Строка - полное имя пользователя информационной базы. +// Например, "Иванов Иван Иванович (менеджер по продажам)". +// - Неопределено - означает не менять свойство при установке набора свойств. +// * АдресЭлектроннойПочты - Строка - адрес электронной почты (например, для восстановления пароля). +// - Неопределено - означает не менять свойство при установке набора свойств. +// +// * АутентификацияСтандартная - Булево - разрешена ли стандартная аутентификация (по пользователю и паролю). +// - Неопределено - означает не менять свойство при установке набора свойств. +// * ПоказыватьВСпискеВыбора - Булево - показывать ли полное имя пользователя в списке для выбора при запуске. +// * Пароль - Строка - пароль, используемый при стандартной аутентификации. +// - Неопределено - значение после чтения и при инициализации, также означает +// не менять свойство при установке набора свойств. +// * СохраняемоеЗначениеПароля - Строка - хранимое значение пароля (хеш). +// - Неопределено - означает не менять свойство при установке набора свойств. +// * ПарольУстановлен - Булево - после чтения означает установлен ли пароль у пользователя, +// при установке набора свойств не учитывается. +// - Неопределено - значение при инициализации. +// * ЗапрещеноИзменятьПароль - Булево - определяет возможность пользователя изменять свой пароль. +// - Неопределено - означает не менять свойство при установке набора свойств. +// * ЗапрещеноВосстанавливатьПароль - Булево - определяет возможность пользователя восстанавливать свой пароль. +// - Неопределено - означает не менять свойство при установке набора свойств. +// +// * АутентификацияOpenID - Булево - разрешена ли аутентификация по протоколу OpenID. +// - Неопределено - означает не менять свойство при установке набора свойств. +// * АутентификацияOpenIDConnect - Булево - разрешена ли аутентификация по протоколу OpenID-Connect. +// - Неопределено - означает не менять свойство при установке набора свойств. +// * АутентификацияТокеномДоступа - Булево - разрешена ли аутентификация JWT-токеном. +// - Неопределено - означает не менять свойство при установке набора свойств. +// +// * АутентификацияОС - Булево - разрешена ли аутентификация средствами операционной системы. +// - Неопределено - означает не менять свойство при установке набора свойств. +// * ПользовательОС - Строка - имя соответствующей учетной записи пользователя операционной системы +// (не учитывается в учебной версии платформы). +// - Неопределено - означает не менять свойство при установке набора свойств. +// +// * ОсновнойИнтерфейс - Строка - имя основного интерфейса пользователя информационной базы +// (из коллекции Метаданные.Интерфейсы). +// - Неопределено - означает не менять свойство при установке набора свойств. +// * РежимЗапуска - Строка - "Авто", "ОбычноеПриложение" или "УправляемоеПриложение". +// - Неопределено - означает не менять свойство при установке набора свойств. +// * Язык - Строка - имя языка из коллекции Метаданные.Языки. +// - Неопределено - означает не менять свойство при установке набора свойств. +// * Роли - Массив из Строка - коллекция имен ролей пользователя информационной базы. +// - Неопределено - означает не менять свойство при установке набора свойств. +// +// * ЗащитаОтОпасныхДействий - Булево - соответствует свойству ПредупреждатьОбОпасныхДействиях +// типа ЗащитаОтОпасныхДействий. +// - Неопределено - означает не менять свойство при установке набора свойств. +// +Функция НовоеОписаниеПользователяИБ(ДляУстановки = Истина, ДляСлужебногоПользователя = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.НовоеОписаниеПользователяИБ(ДляУстановки, ДляСлужебногоПользователя); +``` +
+ +## СвойстваПользователяИБ +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства пользователя информационной базы в виде структуры. +// Если пользователь с указанным идентификатором или именем не существует, то возвращается Неопределено. +// +// Параметры: +// ИмяИлиИдентификатор - Строка +// - УникальныйИдентификатор - имя или идентификатор пользователя ИБ. +// +// Возвращаемое значение: +// Структура - см. Пользователи.НовоеОписаниеПользователяИБ +// Неопределено - если пользователь с указанным идентификатором или именем не существует. +// +Функция СвойстваПользователяИБ(Знач ИмяИлиИдентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.СвойстваПользователяИБ(ИмяИлиИдентификатор) +``` +
+ +## УстановитьСвойстваПользователяИБ +
+ +Описание, пример вызова + +```bsl + +// Записывает новые значения свойств указанному пользователю ИБ, либо создает нового пользователя ИБ. +// Если пользователь не существует, а также при попытке создания существующего пользователя будет вызвано исключение. +// +// Параметры: +// ИмяИлиИдентификатор - Строка +// - УникальныйИдентификатор - имя или уникальный идентификатор пользователя ИБ, свойства +// которого нужно установить. Либо имя нового пользователя ИБ. +// ОбновляемыеСвойства - см. Пользователи.НовоеОписаниеПользователяИБ +// +// СоздатьНового - Булево - указать Истина, чтобы создать нового пользователя ИБ с именем ИмяИлиИдентификатор. +// +// ЭтоВнешнийПользователь - Булево - указать Истина, если пользователь ИБ соответствует внешнему пользователю +// (элементу справочника ВнешниеПользователи). +// +Процедура УстановитьСвойстваПользователяИБ(Знач ИмяИлиИдентификатор, Знач ОбновляемыеСвойства, Экспорт +``` + +Пример вызова +```bsl +Пользователи.УстановитьСвойстваПользователяИБ(ИмяИлиИдентификатор, ОбновляемыеСвойства, ); +``` +
+ +## УдалитьПользователяИБ +
+ +Описание, пример вызова + +```bsl + +// Удаляет указанного пользователя информационной базы. +// +// Параметры: +// ИмяИлиИдентификатор - Строка +// - УникальныйИдентификатор - имя или идентификатор удаляемого пользователя ИБ. +// +Процедура УдалитьПользователяИБ(Знач ИмяИлиИдентификатор) Экспорт +``` + +Пример вызова +```bsl +Пользователи.УдалитьПользователяИБ(ИмяИлиИдентификатор) +``` +
+ +## СкопироватьСвойстваПользователяИБ +
+ +Описание, пример вызова + +```bsl + +// Копирует значения свойств пользователя ИБ с преобразованием +// в/из строковых идентификаторов для основного интерфейса, +// языка, режима запуска и ролей. +// +// Несуществующие свойства в источнике или приемнике не копируются. +// Свойства со значением Неопределено в Источнике не копируются, +// кроме Источника типа ПользовательИнформационнойБазы. +// +// Свойства АутентификацияСтандартная, АутентификацияOpenID, +// АутентификацияOpenIDConnect, АутентификацияТокеномДоступа, +// АутентификацияОС, ПользовательОС и СохраняемоеЗначениеПароля не переустанавливаются, +// если совпадают, когда Приемник типа ПользовательИнформационнойБазы. +// +// Свойства УникальныйИдентификатор, ПарольУстановлен, СтарыйПароль +// не копируются, если Приемник типа ПользовательИнформационнойБазы. +// +// Преобразование выполняется только для Источника или Приемника +// с типом ПользовательИнформационнойБазы. +// +// Параметры: +// Приемник - Структура +// - ПользовательИнформационнойБазы +// - ФормаКлиентскогоПриложения - подмножество +// свойств из НовоеОписаниеПользователяИБ(). +// +// Источник - Структура +// - ПользовательИнформационнойБазы +// - ФормаКлиентскогоПриложения - как и приемник, +// но типы обратные, т.е. когда Приемник типа ПользовательИнформационнойБазы, +// тогда в Источник не типа ПользовательИнформационнойБазы. +// +// КопируемыеСвойства - Строка - список свойств через запятую, которые нужно скопировать (без префикса). +// ИсключаемыеСвойства - Строка - список свойств через запятую, которые не нужно копировать (без префикса). +// ПрефиксСвойств - Строка - начальное имя для Источника или Приемника типа НЕ Структура. +// - Соответствие из КлючИЗначение: +// * Ключ - имя свойства без префикса +// * Значение - полное имя свойства с префиксом +// +Процедура СкопироватьСвойстваПользователяИБ(Приемник, Экспорт +``` + +Пример вызова +```bsl +Пользователи.СкопироватьСвойстваПользователяИБ(Приемник, ); +``` +
+ +## НайтиПоИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает пользователя из справочника Пользователи или ВнешниеПользователи, +// с которым сопоставлен пользователь ИБ с указанным именем. +// +// Параметры: +// ИмяДляВхода - Строка - имя пользователя информационной базы, используемое для входа. +// +// Возвращаемое значение: +// СправочникСсылка.Пользователи - если пользователь найден. +// СправочникСсылка.ВнешниеПользователи - если внешний пользователь найден. +// Справочники.Пользователи.ПустаяСсылка() - если пользователь ИБ найден. +// Неопределено - если пользователь ИБ не существует. +// +Функция НайтиПоИмени(Знач ИмяДляВхода) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.НайтиПоИмени(ИмяДляВхода) +``` +
+ +## НайтиПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Возвращает пользователя из справочника Пользователи или ВнешниеПользователи, +// с которым сопоставлен пользователь ИБ с указанным уникальным идентификатором. +// Поиск выполняется без учета существования пользователя информационной базы. +// +// Параметры: +// ИдентификаторПользователяИБ - УникальныйИдентификатор - идентификатор пользователя информационной базы. +// +// Возвращаемое значение: +// СправочникСсылка.Пользователи - если пользователь найден. +// СправочникСсылка.ВнешниеПользователи - если внешний пользователь найден. +// Неопределено - если пользователь не найден ни в одном справочнике. +// +Функция НайтиПоИдентификатору(Знач ИдентификаторПользователяИБ) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.НайтиПоИдентификатору(ИдентификаторПользователяИБ) +``` +
+ +## НайтиПоСсылке +
+ +Описание, пример вызова + +```bsl + +// Возвращает пользователя ИБ по ссылке справочника Пользователи или ВнешниеПользователи. +// Для поиска требуются административные права. Если административных прав нет, +// допустимо искать только пользователя для текущего пользователя ИБ. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// +// Возвращаемое значение: +// ПользовательИнформационнойБазы - если найден. +// Неопределено - если пользователь ИБ не существует. +// +Функция НайтиПоСсылке(Пользователь) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.НайтиПоСсылке(Пользователь) +``` +
+ +## СлужебныйПользовательИБ +
+ +Описание, пример вызова + +```bsl + +// Возвращает пользователя ИБ с указанным именем, +// создает пользователя ИБ и пользователя в справочнике в случае отсутствия. +// Если свойство ПарольУстановлен = Ложь, тогда в незаполненное свойство +// СохраняемоеЗначениеПароля устанавливается новое сгенерированное значение пароля, +// если у найденного пользователя ИБ пароль не установлен или создается новый пользователь ИБ. +// Если у найденного пользователя значения свойств отличаются от указанных, +// тогда они переустанавливаются. +// +// Параметры: +// Свойства - см. Пользователи.НовоеОписаниеПользователяИБ +// СсылкаНового - СправочникСсылка.Пользователи - если пользователь не найден +// в справочнике, тогда создать нового с указанной ссылкой нового. +// Это позволяет избежать дублей пользователей в справочнике в разных узлах РИБ. +// - Неопределено - если пользователь не найден в справочнике, +// тогда создать нового с новой ссылкой. +// +// Возвращаемое значение: +// ПользовательИнформационнойБазы +// Неопределено - если список пользователей ИБ пустой +// +// Пример: +// Свойства = Пользователи.НовоеОписаниеПользователяИБ(, Истина); +// Свойства.Имя = ИмяСлужебногоПользователя(); +// СсылкаНового = Справочники.Пользователи.ПолучитьСсылку( +// Новый УникальныйИдентификатор("<новый УИД, полученный в отладчике с помощью вызова +// |Строка(Справочники.Пользователи.ПолучитьСсылку().УникальныйИдентификатор())>")); +// Свойства.<другие свойства, которые нужно установить> = <значение>; +// ПользовательИБ = СлужебныйПользовательИБ(Свойства, СсылкаНового); +// ... +// +Функция СлужебныйПользовательИБ(Свойства, СсылкаНового = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.СлужебныйПользовательИБ(Свойства, СсылкаНового); +``` +
+ +## НайтиНеоднозначныхПользователейИБ +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск идентификаторов пользователей ИБ, используемых более одного раза, и +// либо вызывает исключение, либо возвращает найденных пользователей ИБ для дальнейшей +// обработки. +// +// Параметры: +// Пользователь - Неопределено - проверка для всех пользователей и внешних пользователей. +// - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи - проверка +// только для указанной ссылки. +// +// УникальныйИдентификатор - Неопределено - проверка всех заданных идентификаторов пользователей ИБ. +// - УникальныйИдентификатор - проверка только для заданного идентификатора. +// +// НайденныеИдентификаторы - Неопределено - при нахождении ошибок вызывается исключение, но если +// передать соответствие, тогда при нахождении ошибок исключение не вызывается, +// а вместо этого заполняется переданное соответствие. +// - Соответствие из КлючИЗначение: +// * Ключ - УникальныйИдентификатор - неоднозначный идентификатор пользователя ИБ. +// * Значение - Массив из СправочникСсылка.Пользователи, СправочникСсылка.ВнешниеПользователи +// +// ИдентификаторПользователяСервиса - Булево - если Ложь, тогда проверять ИдентификаторПользователяИБ, +// если Истина, тогда проверять ИдентификаторПользователяСервиса. +// +Процедура НайтиНеоднозначныхПользователейИБ(Знач Пользователь, Экспорт +``` + +Пример вызова +```bsl +Пользователи.НайтиНеоднозначныхПользователейИБ(Пользователь, ); +``` +
+ +## СохраняемоеЗначениеСтрокиПароля +
+ +Описание, пример вызова + +```bsl + +// Возвращает сохраняемое значение пароля для указанного пароля по алгоритму SHA-1. +// Начиная с версии платформы 8.3.26 следует использовать метод +// платформы ВычислитьСохраняемоеЗначениеПароляПользователя. +// Для проверки пароля необходимо использовать метод платформы +// ПроверитьСоответствиеПароляПользователяСохраняемомуЗначению +// (сравнение на равно подходит только для сохраняемого значения пароля по алгоритму SHA-1). +// +// Параметры: +// Пароль - Строка - пароль, для которого нужно получить сохраняемое значение. +// +// Возвращаемое значение: +// Строка - сохраняемое значение пароля. +// +// Пример: +// Свойства = Новый Структура("ТипАлгоритмаХешированияПароля", Null); +// ЗаполнитьЗначенияСвойств(Свойства, ПользователиИнформационнойБазы.ТекущийПользователь()); +// Если Свойства.ТипАлгоритмаХешированияПароля <> Null Тогда +// // АПК:488-выкл Поддержка новых методов платформы (исполняемый код безопасен) +// ПарольСовпадает = Вычислить("ПроверитьСоответствиеПароляПользователяСохраняемомуЗначению(Пароль, ПользовательИБ)"); +// // АПК:488-вкл +// Иначе +// ПарольСовпадает = ПользовательИБ.СохраняемоеЗначениеПароля +// = Пользователи.СохраняемоеЗначениеСтрокиПароля(Пароль); +// КонецЕсли; +// +Функция СохраняемоеЗначениеСтрокиПароля(Знач Пароль) Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.СохраняемоеЗначениеСтрокиПароля(Пароль) +``` +
+ +## СоздатьПароль +
+ +Описание, пример вызова + +```bsl + +// Создает новый пароль, соответствующий заданным правилам проверки сложности. +// Для облегчения запоминания, пароль формируется из слогов (согласная-гласная). +// +// Параметры: +// СвойстваПароля - см. СвойстваПароля +// - Число - устарел (наименьшая длина) +// УдалитьСложный - Булево - устарел, следует использовать СвойстваПароля. +// УдалитьУчестьНастройки - Строка - устарел, следует использовать СвойстваПароля. +// +// Возвращаемое значение: +// Строка - новый пароль. +// +Функция СоздатьПароль(Знач СвойстваПароля = 7, УдалитьСложный = Ложь, УдалитьУчестьНастройки = "ДляПользователей") Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.СоздатьПароль(СвойстваПароля, УдалитьСложный, УдалитьУчестьНастройки); +``` +
+ +## СвойстваПароля +
+ +Описание, пример вызова + +```bsl + +// Описание свойств пароля, используемых в функции СоздатьПароль. +// С версии 8.3.22 используется ГенераторСлучайныхПаролей. +// +// Возвращаемое значение: +// Структура: +// * НаименьшаяДлина - Число - наименьшая длина пароля. +// * Сложный - Булево - учитывать требования сложности пароля (с 8.3.22 всегда Истина). +// * УчестьНастройки - Строка - +// "НеУчитыватьНастройки" - не учитывать настройки администратора, +// "ДляПользователей" - учесть настройки для пользователей (по умолчанию), +// "ДляВнешнихПользователей" - учесть настройки для внешних пользователей. +// Если настройки администратора учитываются, тогда указанные параметры +// длины и сложности пароля будут увеличены до значений, указанных в настройках. +// * ГСЧ - ГенераторСлучайныхЧисел - если уже используется (с 8.3.22 не используется). +// - Неопределено - создать новый. +// +Функция СвойстваПароля() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.СвойстваПароля() +``` +
+ +## ОбщиеНастройкиВходаИспользуются +
+ +Описание, пример вызова + +```bsl + +// Определяет, предусмотрено ли в конфигурации использование настроек входа, общих для пользователей: +// сложность пароля, смена пароля, ограничения срока работы в программе и другие. +// См. свойство ОбщиеНастройкиВхода в ПользователиПереопределяемый.ПриОпределенииНастроек. +// +// Возвращаемое значение: +// Булево - Истина, если в конфигурации предусмотрены общие настройки входа пользователей. +// +Функция ОбщиеНастройкиВходаИспользуются() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.ОбщиеНастройкиВходаИспользуются() +``` +
+ +## НазначениеРолей +
+ +Описание, пример вызова + +```bsl + +// Возвращает назначение ролей, указанное разработчиками библиотек и прикладных решений. +// Область применения: только для автоматизированной проверки конфигурации. +// +// Возвращаемое значение: +// Структура - смотри одноименный параметр в процедуре ПриОпределенииНазначенияРолей +// общего модуля ПользователиПереопределяемый. +// +Функция НазначениеРолей() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.НазначениеРолей() +``` +
+ +## ПроверитьНазначениеРолей +
+ +Описание, пример вызова + +```bsl + +// Проверяет соответствие прав ролей назначению ролей, указанному +// в процедуре ПриОпределенииНазначенияРолей общего модуля ПользователиПереопределяемый. +// +// Применяется в случаях: +// - проверка безопасности конфигураций перед автоматическим обновлением на новую версию; +// - проверка конфигурации перед сборкой; +// - проверка конфигурации при разработке. +// +// Параметры: +// ПроверитьВсе - Булево - если Ложь, тогда пропускается проверка назначения ролей +// по требованиям технологий сервиса (что быстрее), в противном случае +// проверка выполняется, если разделение включено. +// +// СписокОшибок - Неопределено - если ошибки найдены, формируется текст ошибок и вызывается исключение. +// - СписокЗначений - возвращаемое значение. Найденные ошибки добавляются в список без вызова исключения: +// * Значение - Строка - имя роли. +// - Неопределено - роль, указанная в процедуре, не существует в метаданных. +// * Представление - Строка - текст ошибки. +// +Процедура ПроверитьНазначениеРолей(ПроверитьВсе = Ложь, СписокОшибок = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Пользователи.ПроверитьНазначениеРолей(ПроверитьВсе, СписокОшибок); +``` +
+ +## УстановитьПравоОткрытияВнешнихОтчетовИОбработок +
+ +Описание, пример вызова + +```bsl + +// Добавляет всех администраторов системы в группу доступа, +// связанную с предопределенным профилем ОткрытиеВнешнихОтчетовИОбработок. +// Скрывает предупреждения безопасности, всплывающие при первом открытии сеанса администратора. +// Не для модели сервиса. +// +// Параметры: +// ОткрытиеРазрешено - Булево - если Истина, установить разрешение открытия. +// +Процедура УстановитьПравоОткрытияВнешнихОтчетовИОбработок(ОткрытиеРазрешено) Экспорт +``` + +Пример вызова +```bsl +Пользователи.УстановитьПравоОткрытияВнешнихОтчетовИОбработок(ОткрытиеРазрешено) +``` +
+ +## УстановитьОбщиеНастройкиВхода +
+ +Описание, пример вызова + +```bsl + +// Сохраняет общие настройки входа пользователей. +// Допустимо передавать отдельные свойства. +// +// Параметры: +// ОбщиеСохраняемыеНастройки - см. Пользователи.НовоеОписаниеОбщихНастроекВхода +// +Процедура УстановитьОбщиеНастройкиВхода(ОбщиеСохраняемыеНастройки) Экспорт +``` + +Пример вызова +```bsl +Пользователи.УстановитьОбщиеНастройкиВхода(ОбщиеСохраняемыеНастройки) +``` +
+ +## НовоеОписаниеОбщихНастроекВхода +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру общих настроек входа по умолчанию. +// +// Возвращаемое значение: +// Структура: +// * ОтдельныеНастройкиДляВнешнихПользователей - Булево - если Ложь, +// тогда для внешних пользователей применяются настройки обычных пользователей. +// * ПредупреждатьОбОкончанииСрокаРаботыВПрограмме - Число - количество дней +// до окончания срока действия в программе, когда будет показано предупреждение. +// * ПредупреждатьОЗавершенииСеансаПриБездействии - Число - количество минут перед завершением сеанса. +// * СрокБездействияДоЗавершенияСеанса - Число - количество минут бездействия до завершения сеанса. +// * КоличествоПопытокВводаПароляДоБлокировки - Число - количество попыток +// ошибочного ввода пароля до срабатывания блокировки. +// * ДлительностьБлокировкиВводаПароля - Число - количество минут блокировки ввода пароля. +// * СохранениеПароляПриВходе - Строка - одна из строк +// "" - скрыть флажок сохранения и не сохранять. +// "РазрешеноИОтключено" - показать отключенный флажок сохранения. +// "РазрешеноИВключено" - показать включенный флажок сохранения. +// * ВремяСохраненияПароля - Число - количество минут до очистки сохраненного пароля. +// * ПоказыватьВСпискеВыбора - Строка - одна из строк +// "ВключеноДляНовыхПользователей", "СкрытоИВключеноДляВсехПользователей" +// "ВыключеноДляНовыхПользователей", "СкрытоИВыключеноДляВсехПользователей". +// * ИспользоватьСтандартныйСписокЗапрещенныхПаролей - Булево +// * ИспользоватьДополнительныйСписокЗапрещенныхПаролей - Булево +// * ИспользоватьСервисЗапрещенныхПаролей - Булево +// * АдресСервисаЗапрещенныхПаролей - Строка - например, "https://api.pwnedpasswords.com/range/". +// * МаксимальноеВремяОжиданияСервисаЗапрещенныхПаролей - Число - количество секунд. +// * ПропускатьПроверкуЕслиСервисЗапрещенныхПаролейНеГотов - Булево - если Ложь, +// тогда блокировать вход пользователя и показывать ошибку проверки пароля в сервисе, +// иначе не блокировать вход и не показывать ошибку, считать проверку пройденной. +// +Функция НовоеОписаниеОбщихНастроекВхода() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.НовоеОписаниеОбщихНастроекВхода() +``` +
+ +## УстановитьНастройкиВхода +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройки входа пользователей. +// Допустимо передавать отдельные свойства. +// +// Параметры: +// СохраняемыеНастройки - см. Пользователи.НовоеОписаниеНастроекВхода +// ДляВнешнихПользователей - Булево - Истина, если записываются настройки внешних пользователей +// +Процедура УстановитьНастройкиВхода(СохраняемыеНастройки, ДляВнешнихПользователей = Ложь) Экспорт +``` + +Пример вызова +```bsl +Пользователи.УстановитьНастройкиВхода(СохраняемыеНастройки, ДляВнешнихПользователей); +``` +
+ +## НовоеОписаниеНастроекВхода +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру настроек входа по умолчанию. +// +// Возвращаемое значение: +// Структура: +// * ПарольДолженОтвечатьТребованиямСложности - Булево - должен ли пароль +// отвечать требованиям сложности +// длина не менее 7 символов; +// содержит любые 3 из 4-х типов символов +// заглавные буквы, строчные буквы, цифры, специальные символы; +// не совпадает с именем (для входа). +// * МинимальнаяДлинаПароля - Число - минимальная длина пароля. +// * ПарольДолженОтсутствоватьВСпискеЗапрещенных - Булево - должен ли +// пароль отсутствовать во всех указанных списках запрещенных паролей +// (стандартном, дополнительном и списке сервиса). +// * ДействиеПриВходеЕслиТребованиеНеВыполнено - Строка - действие при входе, +// если одно из требований выше не выполнено. +// Пустая строка - никаких действий (только записать в журнал регистрации), +// "ПредложитьСменуПароля" - пользователю предлагается сменить пароль (можно пропустить), +// "ПотребоватьСменуПароля" - пользователю придется сменить пароль (нельзя пропустить). +// * МаксимальныйСрокДействияПароля - Число - максимальное количество дней действия пароля. +// * МинимальныйСрокДействияПароля - Число - минимальное количество дней действия пароля. +// * ЗапретитьПовторениеПароляСредиПоследних - Число - количество +// последних паролей, которые запрещено использовать повторно. +// * ПредупреждатьОбОкончанииСрокаДействияПароля - Число - количество дней +// до срока окончания действия пароля, начиная с которого нужно начать предупреждать. +// * ПросрочкаРаботыВПрограммеДоЗапрещенияВхода - Число - количество дней +// неактивности пользователя, после чего будет запрещен вход. +// * ПросрочкаРаботыВПрограммеДатаВключения - Дата - служебное, заполняется автоматически +// в момент записи ненулевого количества дней просрочки работы вместо нулевого. +// +Функция НовоеОписаниеНастроекВхода() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.НовоеОписаниеНастроекВхода() +``` +
+ +## ОбновитьНастройкиРегистрацииСобытийДоступаКДанным +
+ +Описание, пример вызова + +```bsl + +// Устанавливает настройки для события "Доступ.Доступ" журнала регистрации +// по настройкам, возвращаемым функцией НастройкиРегистрацииСобытийДоступаКДанным. +// +Процедура ОбновитьНастройкиРегистрацииСобытийДоступаКДанным() Экспорт +``` + +Пример вызова +```bsl +Пользователи.ОбновитьНастройкиРегистрацииСобытийДоступаКДанным() +``` +
+ +## НастройкиРегистрацииСобытийДоступаКДанным +
+ +Описание, пример вызова + +```bsl + +// Собирает актуальные настройки регистрации для события "Доступ.Доступ" +// из обработчиков события ПриОпределенииНастроекРегистрацииСобытийДоступаКДанным. +// Например, для защиты персональных данных, дополнительных настроек, сделанных +// администратором и других целей. +// +// Требуется, чтобы корректно добавлять настройки без необходимости +// сложного объединения и предотвращения потери части настроек, +// когда нужно отключить часть настроек (например, при изменении +// настроек для защиты персональных данных или других). +// +// Возвращаемое значение: +// Массив из ОписаниеИспользованияСобытияДоступЖурналаРегистрации +// +Функция НастройкиРегистрацииСобытийДоступаКДанным() Экспорт +``` + +Пример вызова +```bsl +Результат = Пользователи.НастройкиРегистрацииСобытийДоступаКДанным() +``` +
+ +## ДобавитьИспользованныйПароль +
+ +Описание, пример вызова + +```bsl + +// Больше не требуется, так как использованные пароли хранятся в пользователе информационной базы и +// добавляются автоматически при изменении пароля или сохраняемого значения пароля. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// СохраняемоеЗначениеПароля - Строка +// +Процедура ДобавитьИспользованныйПароль(Пользователь, СохраняемоеЗначениеПароля) Экспорт +``` + +Пример вызова +```bsl +Пользователи.ДобавитьИспользованныйПароль(Пользователь, СохраняемоеЗначениеПароля) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПользователиКлиент.md b/src/content/docs/bsp/ПользователиКлиент.md new file mode 100644 index 0000000..1ad90fc --- /dev/null +++ b/src/content/docs/bsp/ПользователиКлиент.md @@ -0,0 +1,88 @@ +--- +title: Пользователи клиент +slug: bsp/пользователи-клиент +--- + + +## АвторизованныйПользователь +
+ +Описание, пример вызова + +```bsl + +// См. Пользователи.АвторизованныйПользователь. +Функция АвторизованныйПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = ПользователиКлиент.АвторизованныйПользователь() +``` +
+ +## ТекущийПользователь +
+ +Описание, пример вызова + +```bsl + +// См. Пользователи.ТекущийПользователь. +Функция ТекущийПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = ПользователиКлиент.ТекущийПользователь() +``` +
+ +## ЭтоСеансВнешнегоПользователя +
+ +Описание, пример вызова + +```bsl + +// См. Пользователи.ЭтоСеансВнешнегоПользователя. +Функция ЭтоСеансВнешнегоПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = ПользователиКлиент.ЭтоСеансВнешнегоПользователя() +``` +
+ +## ЭтоПолноправныйПользователь +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли текущий пользователь полноправным. +// +// Параметры: +// ПроверятьПраваАдминистрированияСистемы - см. Пользователи.ЭтоПолноправныйПользователь.ПроверятьПраваАдминистрированияСистемы +// +// Возвращаемое значение: +// Булево - если Истина, пользователь является полноправным. +// +Функция ЭтоПолноправныйПользователь(ПроверятьПраваАдминистрированияСистемы = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПользователиКлиент.ЭтоПолноправныйПользователь(ПроверятьПраваАдминистрированияСистемы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПользователиКлиентСервер.md b/src/content/docs/bsp/ПользователиКлиентСервер.md new file mode 100644 index 0000000..9ffd516 --- /dev/null +++ b/src/content/docs/bsp/ПользователиКлиентСервер.md @@ -0,0 +1,93 @@ +--- +title: Пользователи клиент сервер +slug: bsp/пользователи-клиент-сервер +--- + + +## АвторизованныйПользователь +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. Пользователи.АвторизованныйПользователь. +// См. ПользователиКлиент.АвторизованныйПользователь. +// +Функция АвторизованныйПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = ПользователиКлиентСервер.АвторизованныйПользователь() +``` +
+ +## ТекущийПользователь +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. Пользователи.ТекущийПользователь. +// См. ПользователиКлиент.ТекущийПользователь. +// +Функция ТекущийПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = ПользователиКлиентСервер.ТекущийПользователь() +``` +
+ +## ТекущийВнешнийПользователь +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. ВнешниеПользователи.ТекущийВнешнийПользователь. +// См. ВнешниеПользователиКлиент.ТекущийВнешнийПользователь. +// +Функция ТекущийВнешнийПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = ПользователиКлиентСервер.ТекущийВнешнийПользователь() +``` +
+ +## ЭтоСеансВнешнегоПользователя +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. Пользователи.ЭтоСеансВнешнегоПользователя. +// См. ПользователиКлиент.ЭтоСеансВнешнегоПользователя. +// +Функция ЭтоСеансВнешнегоПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = ПользователиКлиентСервер.ЭтоСеансВнешнегоПользователя() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПользователиПереопределяемый.md b/src/content/docs/bsp/ПользователиПереопределяемый.md new file mode 100644 index 0000000..177fd27 --- /dev/null +++ b/src/content/docs/bsp/ПользователиПереопределяемый.md @@ -0,0 +1,410 @@ +--- +title: Пользователи переопределяемый +slug: bsp/пользователи-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Переопределяет стандартное поведение подсистемы Пользователи. +// +// Параметры: +// Настройки - Структура: +// * ОбщиеНастройкиВхода - Булево - определяет, будут ли в панели администрирования +// "Настройки прав и пользователей" доступны настройки входа, и доступность +// настроек ограничения срока действия в формах пользователя и внешнего пользователя. +// По умолчанию - Истина, а для базовых версий конфигурации - всегда Ложь. +// В модели сервиса получается из настроек Менеджера сервиса и не может быть переопределено. +// +// * РедактированиеРолей - Булево - определяет доступность интерфейса изменения ролей +// в карточках пользователя, внешнего пользователя и группы внешних пользователей +// (в том числе для администратора). По умолчанию - Истина. +// +// * ФизическоеЛицоИспользуется - Булево - по умолчанию Истина. Когда Истина, тогда +// используется в подсистеме Пользователи, например, отображается в карточке Пользователя. +// +// * ПодразделениеИспользуется - Булево - по умолчанию Истина. Когда Истина, тогда +// используется в подсистеме Пользователи, например, отображается в карточке Пользователя. +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриОпределенииНазначенияРолей +
+ +Описание, пример вызова + +```bsl + +// Позволяет указать роли, назначение которых будет контролироваться особым образом. +// Большинство ролей конфигурации не требуется здесь указывать, т.к. они предназначены для любых пользователей, +// кроме внешних пользователей. +// +// Параметры: +// НазначениеРолей - Структура: +// * ТолькоДляАдминистраторовСистемы - Массив - имена ролей, которые при выключенном разделении +// предназначены для любых пользователей, кроме внешних пользователей, а в разделенном режиме +// предназначены только для администраторов сервиса, например: +// Администрирование, ОбновлениеКонфигурацииБазыДанных, АдминистраторСистемы, +// а также все роли с правами: +// Администрирование, +// Администрирование расширений конфигурации, +// Обновление конфигурации базы данных. +// Такие роли, как правило, существуют только в БСП и не встречаются в прикладных решениях. +// +// * ТолькоДляПользователейСистемы - Массив - имена ролей, которые при выключенном разделении +// предназначены для любых пользователей, кроме внешних пользователей, а в разделенном режиме +// предназначены только для неразделенных пользователей (сотрудников технической поддержки сервиса и +// администраторов сервиса), например: +// ДобавлениеИзменениеАдресныхСведений, ДобавлениеИзменениеБанков, +// а также все роли с правами изменения неразделенных данных и следующими правами: +// Толстый клиент, +// Внешнее соединение, +// Automation, +// Режим все функции, +// Интерактивное открытие внешних обработок, +// Интерактивное открытие внешних отчетов. +// Такие роли в большей части существует в БСП, но могут встречаться и в прикладных решениях. +// +// * ТолькоДляВнешнихПользователей - Массив - имена ролей, которые предназначены +// только для внешних пользователей (роли со специально разработанным набором прав), например: +// ДобавлениеИзменениеОтветовНаВопросыАнкет, БазовыеПраваВнешнихПользователейБСП. +// Такие роли существуют и в БСП, и в прикладных решениях (если используются внешние пользователи). +// +// * СовместноДляПользователейИВнешнихПользователей - Массив - имена ролей, которые предназначены +// для любых пользователей (и внутренних, и внешних, и неразделенных), например: +// ЧтениеОтветовНаВопросыАнкет, ДобавлениеИзменениеЛичныхВариантовОтчетов. +// Такие роли существуют и в БСП, и в прикладных решениях (если используются внешние пользователи). +// +Процедура ПриОпределенииНазначенияРолей(НазначениеРолей) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ПриОпределенииНазначенияРолей(НазначениеРолей) +``` +
+ +## ИзменитьДействияВФорме +
+ +Описание, пример вызова + +```bsl + +// Переопределяет поведение формы пользователя и формы внешнего пользователя, +// группы внешних пользователей, когда оно должно отличаться от поведения по умолчанию. +// +// Например, требуется скрывать/показывать или разрешать изменять/блокировать +// некоторые свойства в случаях, которые определены прикладной логикой. +// +// Параметры: +// ПользовательИлиГруппа - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// - СправочникСсылка.ГруппыВнешнихПользователей - ссылка на пользователя, +// внешнего пользователя или группу внешних пользователей при создании формы. +// +// ДействияВФорме - Структура: +// * Роли - Строка - "", "Просмотр", "Редактирование". +// Например, когда роли редактируются в другой форме, можно скрыть +// их в этой форме или только блокировать редактирование. +// * КонтактнаяИнформация - Строка - "", "Просмотр", "Редактирование". +// Свойство отсутствует для групп внешних пользователей. +// Например, может потребоваться скрыть контактную информацию +// от пользователя при отсутствии прикладных прав на просмотр КИ. +// * СвойстваПользователяИБ - Строка - "", "Просмотр", "Редактирование". +// Свойство отсутствует для групп внешних пользователей. +// Например, может потребоваться показать свойства пользователя ИБ +// для пользователя, который имеет прикладные права на эти сведения. +// * СвойстваЭлемента - Строка - "", "Просмотр", "Редактирование". +// Например, Наименование является полным именем пользователя ИБ, +// может потребоваться разрешить редактировать наименование +// для пользователя, который имеет прикладные права на кадровые операции. +// +Процедура ИзменитьДействияВФорме(Знач ПользовательИлиГруппа, Знач ДействияВФорме) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ИзменитьДействияВФорме(ПользовательИлиГруппа, ДействияВФорме) +``` +
+ +## ПриЗаписиПользователяИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Доопределяет действия при записи пользователя информационной базы. +// Например, если требуется синхронно обновить запись в соответствующем регистре и т.п. +// Вызывается из процедуры Пользователи.УстановитьСвойстваПользователяИБ, если пользователь был действительно изменен. +// Если поле Имя в структуре СтарыеСвойства не заполнено, то создается новый пользователь ИБ. +// +// Параметры: +// СтарыеСвойства - см. Пользователи.НовоеОписаниеПользователяИБ. +// НовыеСвойства - см. Пользователи.НовоеОписаниеПользователяИБ. +// +Процедура ПриЗаписиПользователяИнформационнойБазы(Знач СтарыеСвойства, Знач НовыеСвойства) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ПриЗаписиПользователяИнформационнойБазы(СтарыеСвойства, НовыеСвойства) +``` +
+ +## ПослеУдаленияПользователяИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Доопределяет действия после удаления пользователя информационной базы. +// Например, если требуется синхронно обновить запись в соответствующем регистре и т.п. +// Вызывается из процедуры УдалитьПользователяИБ, если пользователь был удален. +// +// Параметры: +// СтарыеСвойства - см. Пользователи.НовоеОписаниеПользователяИБ. +// +Процедура ПослеУдаленияПользователяИнформационнойБазы(Знач СтарыеСвойства) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ПослеУдаленияПользователяИнформационнойБазы(СтарыеСвойства) +``` +
+ +## ПриУстановкеНачальныхНастроек +
+ +Описание, пример вызова + +```bsl + +// Переопределяет настройки интерфейса, устанавливаемые для новых пользователей. +// Например, можно установить начальные настройки расположения разделов командного интерфейса. +// +// Параметры: +// НачальныеНастройки - Структура: +// * НастройкиКлиента - НастройкиКлиентскогоПриложения - настройки клиентского приложения. +// * НастройкиИнтерфейса - НастройкиКомандногоИнтерфейса - настройки командного интерфейса (панели +// разделов, панели навигации, панели действий). +// * НастройкиТакси - НастройкиИнтерфейсаКлиентскогоПриложения - настройки интерфейса клиентского приложения +// (состав и размещение панелей). +// +// * ЭтоВнешнийПользователь - Булево - если Истина, то это внешний пользователь. +// +Процедура ПриУстановкеНачальныхНастроек(НачальныеНастройки) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ПриУстановкеНачальныхНастроек(НачальныеНастройки) +``` +
+ +## ПриПолученииПрочихНастроек +
+ +Описание, пример вызова + +```bsl + +// Позволяет добавить произвольную настройку на закладке "Прочее" в интерфейсе +// обработки НастройкиПользователей, чтобы ее можно было удалять и копировать другим пользователям. +// Для возможности управления настройкой нужно написать код ее по копированию (см. ПриСохраненииПрочихНастроек) +// и удалению (см. ПриУдаленииПрочихНастроек), который будет вызываться при интерактивных действиях с настройкой. +// +// Например, признак того, нужно ли показывать предупреждение при завершении работы программы. +// +// Параметры: +// СведенияОПользователе - Структура - строковое и ссылочное представление пользователя: +// * ПользовательСсылка - СправочникСсылка.Пользователи - пользователь, +// у которого нужно получить настройки. +// * ИмяПользователяИнформационнойБазы - Строка - пользователь информационной базы, +// у которого нужно получить настройки. +// Настройки - Структура - прочие пользовательские настройки: +// * Ключ - Строка - строковый идентификатор настройки, используемый в дальнейшем +// для копирования и очистки этой настройки. +// * Значение - Структура: +// ** НазваниеНастройки - Строка - название, которое будет отображаться в дереве настроек. +// ** КартинкаНастройки - Картинка - картинка, которая будет отображаться в дереве настроек. +// ** СписокНастроек - СписокЗначений - список полученных настроек. +// +Процедура ПриПолученииПрочихНастроек(СведенияОПользователе, Настройки) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ПриПолученииПрочихНастроек(СведенияОПользователе, Настройки) +``` +
+ +## ПриСохраненииПрочихНастроек +
+ +Описание, пример вызова + +```bsl + +// Сохраняет произвольную настройку переданному пользователю. +// См. также ПриПолученииПрочихНастроек. +// +// Параметры: +// Настройки - Структура: +// * ИдентификаторНастройки - Строка - строковый идентификатор копируемой настройки. +// * ЗначениеНастройки - СписокЗначений - список значений копируемых настроек. +// СведенияОПользователе - Структура - строковое и ссылочное представление пользователя: +// * ПользовательСсылка - СправочникСсылка.Пользователи - пользователь, +// которому нужно скопировать настройку. +// * ИмяПользователяИнформационнойБазы - Строка - пользователь информационной базы, +// которому нужно скопировать настройку. +// +Процедура ПриСохраненииПрочихНастроек(СведенияОПользователе, Настройки) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ПриСохраненииПрочихНастроек(СведенияОПользователе, Настройки) +``` +
+ +## ПриУдаленииПрочихНастроек +
+ +Описание, пример вызова + +```bsl + +// Очищает произвольную настройку у переданного пользователя. +// См. также ПриПолученииПрочихНастроек. +// +// Параметры: +// Настройки - Структура: +// * ИдентификаторНастройки - Строка - строковый идентификатор очищаемой настройки. +// * ЗначениеНастройки - СписокЗначений - список значений очищаемых настроек. +// СведенияОПользователе - Структура - строковое и ссылочное представление пользователя: +// * ПользовательСсылка - СправочникСсылка.Пользователи - пользователь, +// которому нужно очистить настройку. +// * ИмяПользователяИнформационнойБазы - Строка - пользователь информационной базы, +// которому нужно очистить настройку. +// +Процедура ПриУдаленииПрочихНастроек(СведенияОПользователе, Настройки) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ПриУдаленииПрочихНастроек(СведенияОПользователе, Настройки) +``` +
+ +## ПриОпределенииФормыВыбораПользователей +
+ +Описание, пример вызова + +```bsl + +// Позволяет указать свою форму выбора пользователей. +// +// В разрабатываемой форме необходимо: +// - устанавливать отбор Служебный = Ложь, отбор должен сниматься только под полными правами; +// - устанавливать отбор Недействителен = Ложь, отбор должен сниматься под любым пользователем. +// +// При реализации собственной формы необходимо поддержать параметры формы или использовать стандартную форму: +// - ЗакрыватьПриВыборе +// - МножественныйВыбор +// - ВыборУчастниковОбсуждения +// +// Для работы в качестве формы подбора участников обсуждения необходимо: +// - передавать результат выбора в оповещение о закрытии +// - результат выбора должен быть представлен массивом идентификаторов пользователей +// системы взаимодействия. +// +// Параметры: +// ВыбраннаяФорма - Строка - имя открываемой формы. +// ПараметрыФормы - Структура - параметры формы при открытии, только Чтение: +// * ЗакрыватьПриВыборе - Булево - содержит признак того, что форму +// необходимо закрывать после осуществления выбора. +// Если свойство имеет значение Ложь, можно использовать +// форму для выбора нескольких позиций или элементов. +// * МножественныйВыбор - Булево - разрешает или запрещает выбор нескольких строк из списка. +// * ВыборУчастниковОбсуждения - Булево - если Истина, то формы вызывается как форма выбора участников обсуждения. +// Форма должна возвращать массив идентификаторов пользователей системы +// Взаимодействия. +// +// * ЗаголовокКнопкиЗавершенияПодбора - Строка - заголовок кнопки завершения подбора. +// * СкрытьПользователейБезПользователяИБ - Булево - если Истина, то пользователи без идентификатора +// пользователя ИБ не должны отображаться в списке. +// * ВыборГруппПользователей - Булево - разрешить выбирать группы пользователей. +// Если группы пользователей используются и параметр не поддерживается, +// то для группы пользователей нельзя назначать права через форму подбора. +// * СкрываемыеПользователи - СписокЗначений - пользователи, которые не отображаются в форме подбора. +// - Неопределено +// * ТекущаяСтрока - СправочникСсылка.ГруппыПользователей - строка, на которую будет выполнено +// позиционирование в динамическом списке групп пользователей при открытии формы. +// - Неопределено - будет выполнено позиционирование на группу Все пользователи. +// +// * РасширенныйПодбор - Булево - если Истина, то доступен просмотр Групп пользователей. +// * ПараметрыРасширеннойФормыПодбора - Строка - адрес временного хранилища со структурой: +// ** ВыбранныеПользователи - Массив из СправочникСсылка.Пользователи - пользователи, +// которые должны отображаться в подобранных. +// ** ЗаголовокФормыПодбора - Строка - если заполнен, переопределяет заголовок формы подбора. +// ** ЗаголовокКнопкиЗавершенияПодбора - Строка - если заполнен, переопределяет заголовок кнопки. +// +Процедура ПриОпределенииФормыВыбораПользователей(ВыбраннаяФорма, ПараметрыФормы) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ПриОпределенииФормыВыбораПользователей(ВыбраннаяФорма, ПараметрыФормы) +``` +
+ +## ПриОпределенииНастроекРегистрацииСобытийДоступаКДанным +
+ +Описание, пример вызова + +```bsl + +// Позволяет добавить свои настройки регистрации событий доступа +// к данным при их получении с помощью функции +// Пользователи.НастройкиРегистрацииСобытийДоступаКДанным, +// а также при их установке с помощью процедуры +// Пользователи.ОбновитьНастройкиРегистрацииСобытийДоступаКДанным. +// +// Параметры: +// Настройки - Массив из ОписаниеИспользованияСобытияДоступЖурналаРегистрации +// +Процедура ПриОпределенииНастроекРегистрацииСобытийДоступаКДанным(Настройки) Экспорт +``` + +Пример вызова +```bsl +ПользователиПереопределяемый.ПриОпределенииНастроекРегистрацииСобытийДоступаКДанным(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПользователиСервиса.md b/src/content/docs/bsp/ПользователиСервиса.md new file mode 100644 index 0000000..7e81db1 --- /dev/null +++ b/src/content/docs/bsp/ПользователиСервиса.md @@ -0,0 +1,60 @@ +--- +title: Пользователи сервиса +slug: bsp/пользователи-сервиса +--- + + +## ИспользоватьОбщиеНастройкиВходаПользователейСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак использования в сервисе общих настроек входа пользователей +// @skip-warning +// @skip-check module-empty-method - особенность реализации. +// +// Возвращаемое значение: +// Булево +Функция ИспользоватьОбщиеНастройкиВходаПользователейСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = ПользователиСервиса.ИспользоватьОбщиеНастройкиВходаПользователейСервиса() +``` +
+ +## ОбновитьАктивностьПользователяСервиса +
+ +Описание, пример вызова + +```bsl + +// Обновить активность пользователя сервиса. +// @skip-warning +// @skip-check module-empty-method - особенность реализации. +// +// Параметры: +// ТекущийПользователь - Неопределено - Текущий авторизованный пользователь +// - СправочникСсылка.Пользователи +// ДатаПоследнейАктивности - Неопределено - Начало дня даты текущего сеанса +// - Дата +Процедура ОбновитьАктивностьПользователяСервиса( Экспорт +``` + +Пример вызова +```bsl +ПользователиСервиса.ОбновитьАктивностьПользователяСервиса(); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПоставляемыеДанные.md b/src/content/docs/bsp/ПоставляемыеДанные.md new file mode 100644 index 0000000..1262569 --- /dev/null +++ b/src/content/docs/bsp/ПоставляемыеДанные.md @@ -0,0 +1,457 @@ +--- +title: Поставляемые данные +slug: bsp/поставляемые-данные +--- + + +## ДескрипторыПоставляемыхДанныхИзМенеджера +
+ +Описание, пример вызова + +```bsl + +// Получить дескрипторы данных по заданным условиям. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ВидДанных - Строка - имя вида поставляемых данных. +// Фильтр - Массив - элементы должны содержать поля Код (строка) и Значение (строка). +// +// Возвращаемое значение: +// ОбъектXDTO - типа ArrayOfDescriptor. +// +Функция ДескрипторыПоставляемыхДанныхИзМенеджера(Знач ВидДанных, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанные.ДескрипторыПоставляемыхДанныхИзМенеджера(ВидДанных, Фильтр); +``` +
+ +## ЗагрузитьИОбработатьДанные +
+ +Описание, пример вызова + +```bsl + +// Инициирует обработку данных. +// +// Может использоваться в связке с ДескрипторыПоставляемыхДанныхИзМенеджера для +// ручной инициации процесса обработки данных. После вызова метода система поведет +// себя так, как будто она только что получила уведомление о доступности новых данных, +// с указанным дескриптором - будет вызван ДоступныНовыеДанные, а затем, при необходимости, +// ОбработатьНовыеДанные для соответствующих обработчиков. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Дескриптор - ОбъектXDTO - Descriptor. +// +Процедура ЗагрузитьИОбработатьДанные(Знач Дескриптор) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанные.ЗагрузитьИОбработатьДанные(Дескриптор) +``` +
+ +## СохранитьПоставляемыеДанныеВКэш +
+ +Описание, пример вызова + +```bsl + +// Помещает данные в справочник ПоставляемыеДанные. +// +// Данные сохраняются либо в том на диске, либо в поле таблицы ПоставляемыеДанные в +// зависимости от константы ХранитьФайлыВТомахНаДиске и наличия свободных томов. Данные +// могут быть позднее извлечены при помощи поиска по реквизитам, либо путем указания +// уникального идентификатора, который передавался в поле Дескриптор.FileGUID. Если в базе +// уже есть данные с тем же видом данных и набором ключевых характеристик - новые данные +// замещают старые. При это используется обновление существующего элемента справочника, а +// не удаление и создание нового. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Дескриптор - ОбъектXDTO - Descriptor или структура с полями. +// "ВидДанных, ДатаДобавления, ИдентификаторФайла, Характеристики", +// где Характеристики - массив структур с полями "Код, Значение, Ключевая". +// ПутьКФайлу - Строка - полное имя извлеченного файла. +// +Процедура СохранитьПоставляемыеДанныеВКэш(Знач Дескриптор, Знач ПутьКФайлу) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанные.СохранитьПоставляемыеДанныеВКэш(Дескриптор, ПутьКФайлу) +``` +
+ +## УдалитьПоставляемыеДанныеИзКэша +
+ +Описание, пример вызова + +```bsl + +// Удаляет файл из кэша. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// СсылкаИлиИдентификатор - СправочникСсылка.ПоставляемыеДанные - ссылка на поставляемые данные, +// - УникальныйИдентификатор - уникальный идентификатор. +// +Процедура УдалитьПоставляемыеДанныеИзКэша(Знач СсылкаИлиИдентификатор) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанные.УдалитьПоставляемыеДанныеИзКэша(СсылкаИлиИдентификатор) +``` +
+ +## ДескрипторПоставляемыхДанныхИзКэша +
+ +Описание, пример вызова + +```bsl + +// Получает дескриптор данных из кэша. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// СсылкаИлиИдентификатор - СправочникСсылка.ПоставляемыеДанные - ссылка на поставляемые данные, +// - УникальныйИдентификатор - уникальный идентификатор, +// ВВидеXDTO - Булево - в каком виде возвращать значения. +// +// Возвращаемое значение: +// ОбъектXDTO - типа ArrayOfDescriptor. +// +Функция ДескрипторПоставляемыхДанныхИзКэша(Знач СсылкаИлиИдентификатор, Знач ВВидеXDTO = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанные.ДескрипторПоставляемыхДанныхИзКэша(СсылкаИлиИдентификатор, ВВидеXDTO); +``` +
+ +## ПоставляемыеДанныеИзКэша +
+ +Описание, пример вызова + +```bsl + +// Возвращает двоичные данные присоединенного файла. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// СсылкаИлиИдентификатор - СправочникСсылка.ПоставляемыеДанные - ссылка на поставляемые данные, +// - УникальныйИдентификатор - уникальный идентификатор. +// +// Возвращаемое значение: +// ДвоичныеДанные - двоичные данные поставляемых данных. +// +Функция ПоставляемыеДанныеИзКэша(Знач СсылкаИлиИдентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанные.ПоставляемыеДанныеИзКэша(СсылкаИлиИдентификатор) +``` +
+ +## ЕстьВКеше +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие данных с указанными ключевыми характеристиками в кэше. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Дескриптор - ОбъектXDTO - Descriptor. +// +// Возвращаемое значение: +// Булево - наличие дескриптора в кэше. +// +Функция ЕстьВКеше(Знач Дескриптор) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанные.ЕстьВКеше(Дескриптор) +``` +
+ +## СсылкиПоставляемыхДанныхИзКэша +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив ссылок на данные, удовлетворяющие заданным условиям. +// +// Параметры: +// ВидДанных - Строка - имя вида поставляемых данных. +// Фильтр - Массив - элементы должны содержать поля Код (строка) и Значение (строка). +// +// Возвращаемое значение: +// Массив из ЛюбаяСсылка - массив ссылок на данные. +// +Функция СсылкиПоставляемыхДанныхИзКэша(Знач ВидДанных, Знач Фильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанные.СсылкиПоставляемыхДанныхИзКэша(ВидДанных, Фильтр); +``` +
+ +## ДескрипторыПоставляемыхДанныхИзКэша +
+ +Описание, пример вызова + +```bsl + +// Получить данные по заданным условиям. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ВидДанных - Строка - имя вида поставляемых данных. +// Фильтр - Массив - элементы должны содержать поля Код (строка) и Значение (строка). +// ВВидеXDTO - Булево - в каком виде возвращать значения. +// +// Возвращаемое значение: +// ОбъектXDTO - типа ArrayOfDescriptor или +// Массив структур с полями "ВидДанных, ДатаДобавления, ИдентификаторФайла, Характеристики", +// где Характеристики - массив структур с полями "Код, Значение, Ключевая". +// Для получения самого файла необходимо вызвать ПолучитьПоставляемыеДанныеИзКэша. +// +// +Функция ДескрипторыПоставляемыхДанныхИзКэша(Знач ВидДанных, Знач Фильтр = Неопределено, Знач ВВидеXDTO = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанные.ДескрипторыПоставляемыхДанныхИзКэша(ВидДанных, Фильтр, ВВидеXDTO); +``` +
+ +## ПолучитьОписаниеДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает пользовательское представление дескриптора поставляемых данных. +// Может быть использовано при выводе сообщений в журнал регистрации. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Дескриптор - ОбъектXDTO - типа Descriptor или структура с полями. +// "ВидДанных, ДатаДобавления, ИдентификаторФайла, Характеристики", +// где Характеристики - массив структур с полями "Код, Значение". +// ДескрипторJSON - Булево - признак того, что дескриптор в формате JSON +// +// Возвращаемое значение: +// Строка - пользовательское представление дескриптора. +// +Функция ПолучитьОписаниеДанных(Знач Дескриптор, Знач ДескрипторJSON = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанные.ПолучитьОписаниеДанных(Дескриптор, ДескрипторJSON); +``` +
+ +## ПолучитьОбработчики +
+ +Описание, пример вызова + +```bsl + +// Возвращает зарегистрированные обработчики поставляемых данных. +// Используется для запуска процедур проверки и загрузки новых поставляемых данных. Так же может +// быть использована для получения списка поддерживаемых видов поставляемых данных. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица с колонками: +// * ВидДанных - Строка - код вида данных, обрабатываемый обработчиком. +// * КодОбработчика - Строка - используется при восстановлении обработки данных после сбоя. +// * Обработчик - ОбщийМодуль - модуль, содержащий следующие экспортные процедуры: +// ДоступныНовыеДанные(Дескриптор, Загружать) +// ОбработатьНовыеДанные(Дескриптор, ПутьКФайлу) +// ОбработкаДанныхОтменена(Дескриптор) +// +Функция ПолучитьОбработчики() Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанные.ПолучитьОбработчики() +``` +
+ +## ОбластиТребующиеОбработки +
+ +Описание, пример вызова + +```bsl + +/////////////////////////////////////////////////////////////////////////////////// +// Обновление информации в областях данных. + +// Возвращает список областей данных, в которые еще не были скопированы поставляемые данные. +// @skip-warning ПустойМетод - особенность реализации. +// +// В случае первого вызова функции возвращается полный набор доступных областей. +// При последующем вызове, при восстановлении после сбоя, будут возвращены только +// необработанные области. После копирования данных в область следует вызвать ОбластьОбработана. +// +// Параметры: +// ИдентификаторФайла - УникальныйИдентификатор - идентификатор файла поставляемых данных, +// КодОбработчика - Строка - код обработчика, +// ВключаяНеразделенную - Булево - если Истина, ко всем имеющимся областям добавится область с кодом -1. +// +// Возвращаемое значение: +// Массив из Число - области требующие обработки. +// +Функция ОбластиТребующиеОбработки(Знач ИдентификаторФайла, Знач КодОбработчика, Знач ВключаяНеразделенную = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанные.ОбластиТребующиеОбработки(ИдентификаторФайла, КодОбработчика, ВключаяНеразделенную); +``` +
+ +## ОбластьОбработана +
+ +Описание, пример вызова + +```bsl + +// Удаляет область из списка необработанных. Выключает разделение сеанса (если оно было включено), +// поскольку при включенном разделении запись в неразделенный регистр запрещена. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторФайла - УникальныйИдентификатор - файла поставляемых данных, +// КодОбработчика - Строка - код обработчика, +// ОбластьДанных - Число - идентификатор обработанной области. +// +Процедура ОбластьОбработана(Знач ИдентификаторФайла, Знач КодОбработчика, Знач ОбластьДанных) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанные.ОбластьОбработана(ИдентификаторФайла, КодОбработчика, ОбластьДанных) +``` +
+ +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обработчики событий подсистем конфигурации. + +// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанные.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ПриОпределенииОбработчиковКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// См. ОбменСообщениямиПереопределяемый.ПолучитьОбработчикиКаналовСообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПриОпределенииОбработчиковКаналовСообщений(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанные.ПриОпределенииОбработчиковКаналовСообщений(Обработчики) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанные.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ЗапроситьВсеДанные +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ПоставляемыеДанные.ЗапроситьДанные +// Инициировать уведомление о всех имеющихся в МС поставляемых данных (за исключением тех, +// у которых стоит пометка "Запрет уведомления". +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ЗапроситьВсеДанные() Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанные.ЗапроситьВсеДанные() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПоставляемыеДанныеАбонентов.md b/src/content/docs/bsp/ПоставляемыеДанныеАбонентов.md new file mode 100644 index 0000000..50e60c8 --- /dev/null +++ b/src/content/docs/bsp/ПоставляемыеДанныеАбонентов.md @@ -0,0 +1,60 @@ +--- +title: Поставляемые данные абонентов +slug: bsp/поставляемые-данные-абонентов +--- + + +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанныеАбонентов.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ОбработатьДанные +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку поставляемых данных абонента. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторФайла - Строка - идентификатор файла для обработки (длина 36). +// +// Пример: +// Пример содержимого файла файла: {"upload": [{"file":"base_data.json","handler":"base_data"}]}, где +// - upload - секция с описаниями порядка обработки, может содержать несколько элементов. +// - file - имя файла начальных данных для обработки. +// - handler - идентификатор обработчика файла начальных данных. +// +Процедура ОбработатьДанные(ИдентификаторФайла) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанныеАбонентов.ОбработатьДанные(ИдентификаторФайла) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПоставляемыеДанныеАбонентовПереопределяемый.md b/src/content/docs/bsp/ПоставляемыеДанныеАбонентовПереопределяемый.md new file mode 100644 index 0000000..b870463 --- /dev/null +++ b/src/content/docs/bsp/ПоставляемыеДанныеАбонентовПереопределяемый.md @@ -0,0 +1,40 @@ +--- +title: Поставляемые данные абонентов переопределяемый +slug: bsp/поставляемые-данные-абонентов-переопределяемый +--- + + +## ОбработатьПолученныеДанныеОбласти +
+ +Описание, пример вызова + +```bsl + +// Обработчик полученных данных области. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ПотокДанных - ФайловыйПоток - поток данных для обработки. +// Обработчик - Строка - идентификатор обработчика полученных данных. +// ДанныеОбработаны - Булево - признак обработки данных. Устанавливается = Истина, если данные обработаны. +// Нельзя устанавливать значение = Ложь, т.к. признак = Истина может быть установлен ранее. +// КодВозврата - Число - код возврата обработчика из значений РегистрыСведений.СвойстваЗаданий.КодыСостояний() +// ОписаниеОшибки - Строка - описание ошибки обработки данных, если данные не обработаны. +// +Процедура ОбработатьПолученныеДанныеОбласти(ПотокДанных, Обработчик, ДанныеОбработаны, КодВозврата, ОписаниеОшибки) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанныеАбонентовПереопределяемый.ОбработатьПолученныеДанныеОбласти(ПотокДанных, Обработчик, ДанныеОбработаны, КодВозврата, ОписаниеОшибки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПоставляемыеДанныеАбонентовСловарь.md b/src/content/docs/bsp/ПоставляемыеДанныеАбонентовСловарь.md new file mode 100644 index 0000000..7b8e434 --- /dev/null +++ b/src/content/docs/bsp/ПоставляемыеДанныеАбонентовСловарь.md @@ -0,0 +1,123 @@ +--- +title: Поставляемые данные абонентов словарь +slug: bsp/поставляемые-данные-абонентов-словарь +--- + + +## КодВозвратаОшибкаДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает код ошибки данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаОшибкаДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанныеАбонентовСловарь.КодВозвратаОшибкаДанных() +``` +
+ +## КодВозвратаВнутренняяОшибка +
+ +Описание, пример вызова + +```bsl + +// Возвращает код внутренней ошибки. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаВнутренняяОшибка() Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанныеАбонентовСловарь.КодВозвратаВнутренняяОшибка() +``` +
+ +## КодВозвратаВыполненоСПредупреждениями +
+ +Описание, пример вызова + +```bsl + +// Возвращает код выполнения с предупреждениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаВыполненоСПредупреждениями() Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанныеАбонентовСловарь.КодВозвратаВыполненоСПредупреждениями() +``` +
+ +## КодВозвратаВыполнено +
+ +Описание, пример вызова + +```bsl + +// Возвращает код успешного выполнения. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаВыполнено() Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанныеАбонентовСловарь.КодВозвратаВыполнено() +``` +
+ +## КодВозвратаНеНайдено +
+ +Описание, пример вызова + +```bsl + +// Возвращает код отсутствия данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Число - стандартный код возврата по имени метода. +// +Функция КодВозвратаНеНайдено() Экспорт +``` + +Пример вызова +```bsl +Результат = ПоставляемыеДанныеАбонентовСловарь.КодВозвратаНеНайдено() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПоставляемыеДанныеПереопределяемый.md b/src/content/docs/bsp/ПоставляемыеДанныеПереопределяемый.md new file mode 100644 index 0000000..370ca3a --- /dev/null +++ b/src/content/docs/bsp/ПоставляемыеДанныеПереопределяемый.md @@ -0,0 +1,55 @@ +--- +title: Поставляемые данные переопределяемый +slug: bsp/поставляемые-данные-переопределяемый +--- + + +## ПолучитьОбработчикиПоставляемыхДанных +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для подсистемы ПоставляемыеДанные +// общий модуль ПоставляемыеДанныеПереопределяемый. +// + +// Зарегистрировать обработчики поставляемых данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// При получении уведомления о доступности новых общих данных, вызывается процедуры. +// ДоступныНовыеДанные модулей, зарегистрированных через ПолучитьОбработчикиПоставляемыхДанных. +// В процедуру передается Дескриптор - ОбъектXDTO Descriptor. +// +// В случае, если ДоступныНовыеДанные устанавливает аргумент Загружать в значение Истина, +// данные загружаются, дескриптор и путь к файлу с данными передаются в процедуру. +// ОбработатьНовыеДанные. Файл будет автоматически удален после завершения процедуры. +// Если в менеджере сервиса не был указан файл - значение аргумента равно Неопределено. +// +// Параметры: +// Обработчики - ТаблицаЗначений - таблица для добавления обработчиков с колонками: +// * ВидДанных - Строка - код вида данных, обрабатываемый обработчиком. +// * КодОбработчика - Строка - будет использоваться при восстановлении обработки данных после сбоя. +// * Обработчик - ОбщийМодуль - модуль, содержащий следующие процедуры: +// ДоступныНовыеДанные(Дескриптор, Загружать) Экспорт +// ОбработатьНовыеДанные(Дескриптор, ПутьКФайлу) Экспорт +// ОбработкаДанныхОтменена(Дескриптор) Экспорт +// +Процедура ПолучитьОбработчикиПоставляемыхДанных(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ПоставляемыеДанныеПереопределяемый.ПолучитьОбработчикиПоставляемыхДанных(Обработчики) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПрефиксацияОбъектовКлиентСервер.md b/src/content/docs/bsp/ПрефиксацияОбъектовКлиентСервер.md new file mode 100644 index 0000000..a5a3a5c --- /dev/null +++ b/src/content/docs/bsp/ПрефиксацияОбъектовКлиентСервер.md @@ -0,0 +1,172 @@ +--- +title: Префиксация объектов клиент сервер +slug: bsp/префиксация-объектов-клиент-сервер +--- + + +## УдалитьПрефиксыИзНомераОбъекта +
+ +Описание, пример вызова + +```bsl + +// Удаляет префикс информационной базы и префикс организации из переданной строки НомерОбъекта. +// Переменная НомерОбъекта должна соответствовать шаблону: ООГГ-ХХХ...ХХ или ГГ-ХХХ...ХХ, где: +// ОО - префикс организации; +// ГГ - префикс информационной базы; +// "-" - разделитель; +// ХХХ...ХХ - номер/код объекта. +// Незначащие символы префиксов (символ ноль - "0") также удаляются. +// +// Параметры: +// НомерОбъекта - Строка - номер или код объекта из которого требуется удалить префиксы. +// УдалитьПрефиксОрганизации - Булево - признак удаления префикса организации; +// по умолчанию равен Ложь. +// УдалитьПрефиксИнформационнойБазы - Булево - признак удаления префикса информационной базы; +// по умолчанию равен Ложь. +// +// Возвращаемое значение: +// Строка - номер объекта без префиксов. +// +// Пример: +// УдалитьПрефиксыИзНомераОбъекта("0ФГЛ-000001234", Истина, Истина) = "000001234" +// УдалитьПрефиксыИзНомераОбъекта("0ФГЛ-000001234", Ложь, Истина) = "Ф-000001234" +// УдалитьПрефиксыИзНомераОбъекта("0ФГЛ-000001234", Истина, Ложь) = "ГЛ-000001234" +// УдалитьПрефиксыИзНомераОбъекта("0ФГЛ-000001234", Ложь, Ложь) = "ФГЛ-000001234" +// +Функция УдалитьПрефиксыИзНомераОбъекта(Знач НомерОбъекта, УдалитьПрефиксОрганизации = Ложь, УдалитьПрефиксИнформационнойБазы = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрефиксацияОбъектовКлиентСервер.УдалитьПрефиксыИзНомераОбъекта(НомерОбъекта, УдалитьПрефиксОрганизации, УдалитьПрефиксИнформационнойБазы); +``` +
+ +## УдалитьЛидирующиеНулиИзНомераОбъекта +
+ +Описание, пример вызова + +```bsl + +// Удаляет лидирующие нули из номера объекта. +// Переменная НомерОбъекта должна соответствовать шаблону: ООГГ-ХХХ...ХХ или ГГ-ХХХ...ХХ, где. +// ОО - префикс организации; +// ГГ - префикс информационной базы; +// "-" - разделитель; +// ХХХ...ХХ - номер/код объекта. +// +// Параметры: +// НомерОбъекта - Строка - номер или код объекта из которого требуется лидирующие нули. +// +// Возвращаемое значение: +// Строка - номер объекта без лидирующих нулей. +// +Функция УдалитьЛидирующиеНулиИзНомераОбъекта(Знач НомерОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрефиксацияОбъектовКлиентСервер.УдалитьЛидирующиеНулиИзНомераОбъекта(НомерОбъекта) +``` +
+ +## УдалитьПользовательскиеПрефиксыИзНомераОбъекта +
+ +Описание, пример вызова + +```bsl + +// Удаляет все пользовательские префиксы из номера объекта (все нецифровые символы). +// Переменная НомерОбъекта должна соответствовать шаблону: ООГГ-ХХХ...ХХ или ГГ-ХХХ...ХХ, где. +// ОО - префикс организации; +// ГГ - префикс информационной базы; +// "-" - разделитель; +// ХХХ...ХХ - номер/код объекта. +// +// Параметры: +// НомерОбъекта - Строка - номер или код объекта из которого требуется лидирующие нули. +// +// Возвращаемое значение: +// Строка - номер объекта без пользовательских префиксов. +// +Функция УдалитьПользовательскиеПрефиксыИзНомераОбъекта(Знач НомерОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрефиксацияОбъектовКлиентСервер.УдалитьПользовательскиеПрефиксыИзНомераОбъекта(НомерОбъекта) +``` +
+ +## ПользовательскийПрефикс +
+ +Описание, пример вызова + +```bsl + +// Получает пользовательский префикс номера/кода объекта. +// Переменная НомерОбъекта должна соответствовать шаблону: ООГГ-ААХ...ХХ или ГГ-ААХ...ХХ, где. +// ОО - префикс организации; +// ГГ - префикс информационной базы; +// "-" - разделитель; +// АА - пользовательский префикс; +// ХХ..ХХ - номер/код объекта. +// +// Параметры: +// НомерОбъекта - Строка - номер или код объекта из которого требуется получить пользовательский префикс. +// +// Возвращаемое значение: +// Строка - пользовательский префикс. +// +Функция ПользовательскийПрефикс(Знач НомерОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрефиксацияОбъектовКлиентСервер.ПользовательскийПрефикс(НомерОбъекта) +``` +
+ +## НомерНаПечать +
+ +Описание, пример вызова + +```bsl + +// Получает номер документа для вывода на печать; из номера удаляются префиксы и лидирующие нули. +// Функция: +// отбрасывает префикс организации, +// отбрасывает префикс информационной базы (опционально), +// отбрасывает пользовательские префиксы (опционально), +// удаляет лидирующие нули в номере объекта. +// +// Параметры: +// НомерОбъекта - Строка - номер или код объекта, который преобразуется для вывода на печать. +// УдалитьПрефиксИнформационнойБазы - Булево - признак удаления префикса информационной базы. +// УдалитьПользовательскийПрефикс - Булево - признак удаления пользовательского префикса. +// +// Возвращаемое значение: +// Строка - номер на печать. +// +Функция НомерНаПечать(Знач НомерОбъекта, УдалитьПрефиксИнформационнойБазы = Ложь, УдалитьПользовательскийПрефикс = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрефиксацияОбъектовКлиентСервер.НомерНаПечать(НомерОбъекта, УдалитьПрефиксИнформационнойБазы, УдалитьПользовательскийПрефикс); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПрефиксацияОбъектовКлиентСерверПереопределяемый.md b/src/content/docs/bsp/ПрефиксацияОбъектовКлиентСерверПереопределяемый.md new file mode 100644 index 0000000..bb9a479 --- /dev/null +++ b/src/content/docs/bsp/ПрефиксацияОбъектовКлиентСерверПереопределяемый.md @@ -0,0 +1,48 @@ +--- +title: Префиксация объектов клиент сервер переопределяемый +slug: bsp/префиксация-объектов-клиент-сервер-переопределяемый +--- + + +## ПриПолученииНомераНаПечать +
+ +Описание, пример вызова + +```bsl + +// Обработчик события "При получении номера на печать". +// Событие возникает перед стандартной обработкой получения номера. +// В обработчике можно переопределить стандартное поведение системы при формировании номера на печать. +// +// Параметры: +// НомерОбъекта - Строка - номер или код объекта, который обрабатывается. +// СтандартнаяОбработка - Булево - флаг стандартной обработки; если установить значение флага в Ложь, +// то стандартная обработка формирования номера на печать выполняться +// не будет. +// УдалитьПрефиксИнформационнойБазы - Булево - признак удаления префикса информационной базы; +// по умолчанию равен Ложь. +// УдалитьПользовательскийПрефикс - Булево - признак удаления пользовательского префикса; +// по умолчанию равен Ложь. +// +// Пример: +// +// НомерОбъекта = ПрефиксацияОбъектовКлиентСервер.УдалитьПользовательскиеПрефиксыИзНомераОбъекта(НомерОбъекта); +// СтандартнаяОбработка = Ложь; +// +Процедура ПриПолученииНомераНаПечать(НомерОбъекта, СтандартнаяОбработка, Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовКлиентСерверПереопределяемый.ПриПолученииНомераНаПечать(НомерОбъекта, СтандартнаяОбработка, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПрефиксацияОбъектовПереопределяемый.md b/src/content/docs/bsp/ПрефиксацияОбъектовПереопределяемый.md new file mode 100644 index 0000000..57f2be5 --- /dev/null +++ b/src/content/docs/bsp/ПрефиксацияОбъектовПереопределяемый.md @@ -0,0 +1,114 @@ +--- +title: Префиксация объектов переопределяемый +slug: bsp/префиксация-объектов-переопределяемый +--- + + +## ПриИзмененииНомера +
+ +Описание, пример вызова + +```bsl + +// Обработчик события при изменении номера объекта. +// Обработчик предназначен для вычисления базового номера объекта в случае, +// когда стандартным способом получить базовый номер без потери информации нельзя. +// Обработчик вызывается только для случая, когда обрабатываемые номера и коды объектов +// были сформированы нестандартным образом, не в формате номеров и кодов БСП. +// +// Параметры: +// Объект - ДокументОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект - объект данных, +// для которого необходимо определить базовый номер. +// Номер - Строка - номер текущего объекта, из которого необходимо извлечь базовый номер. +// БазовыйНомер - Строка - базовый номер объекта. +// Под базовым номером объекта подразумевается номер объекта +// за вычетом всех префиксов (префикса ИБ, префикса организации, +// префикса подразделения, пользовательского префикса и пр). +// СтандартнаяОбработка - Булево - флаг стандартной обработки. Значения по умолчанию Истина. +// Если в обработчике установить данному параметру значение Ложь, +// то стандартная обработка выполнена не будет. +// Стандартная обработка получает базовый код справа до первого нечислового символа. +// Например, для кода "АА00005/12/368" стандартная обработка вернет "368". +// Однако базовый код для объекта будет равен "5/12/368". +// +Процедура ПриИзмененииНомера(Объект, Знач Номер, БазовыйНомер, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовПереопределяемый.ПриИзмененииНомера(Объект, Номер, БазовыйНомер, СтандартнаяОбработка) +``` +
+ +## ПриИзмененииКода +
+ +Описание, пример вызова + +```bsl + +// Обработчик события при изменении кода объекта. +// Обработчик предназначен для вычисления базового кода объекта в случае, +// когда стандартным способом получить базовый код без потери информации нельзя. +// Обработчик вызывается только для случая, когда обрабатываемые номера и коды объектов +// были сформированы нестандартным образом, не в формате номеров и кодов БСП. +// +// Параметры: +// Объект - СправочникОбъект +// - ПланВидовХарактеристикОбъект - объект данных, +// для которого необходимо определить базовый код. +// Код - Строка - код текущего объекта, из которого необходимо извлечь базовый код. +// БазовыйКод - Строка - базовый код объекта. Под базовым кодом объекта подразумевается код объекта +// за вычетом всех префиксов (префикса ИБ, префикса организации, +// префикса подразделения, пользовательского префикса и пр). +// СтандартнаяОбработка - Булево - флаг стандартной обработки. Значения по умолчанию Истина. +// Если в обработчике установить данному параметру значение Ложь, +// то стандартная обработка выполнена не будет. +// Стандартная обработка получает базовый код справа до первого нечислового символа. +// Например, для кода "АА00005/12/368" стандартная обработка вернет "368". +// Однако базовый код для объекта будет равен "5/12/368". +// +Процедура ПриИзмененииКода(Объект, Знач Код, БазовыйКод, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовПереопределяемый.ПриИзмененииКода(Объект, Код, БазовыйКод, СтандартнаяОбработка) +``` +
+ +## ПолучитьПрефиксообразующиеРеквизиты +
+ +Описание, пример вызова + +```bsl + +// В процедуре необходимо заполнить параметр "Объекты" для тех объектов метаданных, +// для которых ссылка на организацию располагается в реквизите с именем отличным от стандартного имени "Организация". +// +// Параметры: +// Объекты - ТаблицаЗначений: +// * Объект - ОбъектМетаданных - объект метаданных, для которого указывается реквизит, +// содержащий ссылку на организацию. +// * Реквизит - Строка - имя реквизита, который содержит ссылку на организацию. +// +Процедура ПолучитьПрефиксообразующиеРеквизиты(Объекты) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовПереопределяемый.ПолучитьПрефиксообразующиеРеквизиты(Объекты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПрефиксацияОбъектовСобытия.md b/src/content/docs/bsp/ПрефиксацияОбъектовСобытия.md new file mode 100644 index 0000000..28ea65c --- /dev/null +++ b/src/content/docs/bsp/ПрефиксацияОбъектовСобытия.md @@ -0,0 +1,257 @@ +--- +title: Префиксация объектов события +slug: bsp/префиксация-объектов-события +--- + + +## УстановитьПрефиксОрганизации +
+ +Описание, пример вызова + +```bsl + +// Устанавливает префикс источника подписки в соответствии с префиксом организации. +// Источник подписки должен содержать +// обязательный реквизит шапки "Организация", с типом "СправочникСсылка.Организации". +// +// Параметры: +// Источник - Произвольный - источник события подписки. +// Любой объект из множества [Справочник, Документ, План видов характеристик, Бизнес процесс, Задача]. +// СтандартнаяОбработка - Булево - флаг стандартной обработки подписки. +// Префикс - Строка - префикс объекта, который нужно изменить. +// +Процедура УстановитьПрефиксОрганизации(Источник, СтандартнаяОбработка, Префикс) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовСобытия.УстановитьПрефиксОрганизации(Источник, СтандартнаяОбработка, Префикс) +``` +
+ +## УстановитьПрефиксИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Устанавливает префикс источника подписки в соответствии с префиксом информационной базы. +// Ограничения на реквизиты источника не накладываются. +// +// Параметры: +// Источник - Произвольный - источник события подписки. +// Любой объект из множества [Справочник, Документ, План видов характеристик, Бизнес процесс, Задача]. +// СтандартнаяОбработка - Булево - флаг стандартной обработки подписки. +// Префикс - Строка - префикс объекта, который нужно изменить. +// +Процедура УстановитьПрефиксИнформационнойБазы(Источник, СтандартнаяОбработка, Префикс) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовСобытия.УстановитьПрефиксИнформационнойБазы(Источник, СтандартнаяОбработка, Префикс) +``` +
+ +## УстановитьПрефиксИнформационнойБазыИОрганизации +
+ +Описание, пример вызова + +```bsl + +// Устанавливает префикс источника подписки в соответствии с префиксом информационной базы и префиксом организации. +// Источник подписки должен содержать +// обязательный реквизит шапки "Организация", с типом "СправочникСсылка.Организации". +// +// Параметры: +// Источник - Произвольный - источник события подписки. +// Любой объект из множества [Справочник, Документ, План видов характеристик, Бизнес процесс, Задача]. +// СтандартнаяОбработка - Булево - флаг стандартной обработки подписки. +// Префикс - Строка - префикс объекта, который нужно изменить. +// +Процедура УстановитьПрефиксИнформационнойБазыИОрганизации(Источник, СтандартнаяОбработка, Префикс) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовСобытия.УстановитьПрефиксИнформационнойБазыИОрганизации(Источник, СтандартнаяОбработка, Префикс) +``` +
+ +## ПроверитьКодСправочникаПоОрганизации +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку модифицированности реквизита Организация элемента справочника. +// Если реквизит Организация изменен, то Код элемента обнуляется. +// Это необходимо для назначения нового кода элементу. +// +// Параметры: +// Источник - СправочникОбъект - источник события подписки. +// Отказ - Булево - флаг отказа. +// +Процедура ПроверитьКодСправочникаПоОрганизации(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовСобытия.ПроверитьКодСправочникаПоОрганизации(Источник, Отказ) +``` +
+ +## ПроверитьНомерБизнесПроцессаПоДате +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку модифицированности Даты бизнес процесса. +// Если дата не входит в предыдущий период, то номер бизнес процесса обнуляется. +// Это необходимо для назначения нового номера бизнес процессу. +// +// Параметры: +// Источник - БизнесПроцессОбъект - источник события подписки. +// Отказ - Булево - флаг отказа. +// +Процедура ПроверитьНомерБизнесПроцессаПоДате(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовСобытия.ПроверитьНомерБизнесПроцессаПоДате(Источник, Отказ) +``` +
+ +## ПроверитьНомерБизнесПроцессаПоДатеИОрганизации +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку модифицированности Даты и Организации бизнес процесса. +// Если дата не входит в предыдущий период или изменен реквизит Организация, то номер бизнес процесса обнуляется. +// Это необходимо для назначения нового номера бизнес процессу. +// +// Параметры: +// Источник - БизнесПроцессОбъект - источник события подписки. +// Отказ - Булево - флаг отказа. +// +Процедура ПроверитьНомерБизнесПроцессаПоДатеИОрганизации(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовСобытия.ПроверитьНомерБизнесПроцессаПоДатеИОрганизации(Источник, Отказ) +``` +
+ +## ПроверитьНомерДокументаПоДате +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку модифицированности Даты документа. +// Если дата не входит в предыдущий период, то номер документа обнуляется. +// Это необходимо для назначения нового номера документу. +// +// Параметры: +// Источник - ДокументОбъект - источник события подписки. +// Отказ - Булево - флаг отказа. +// РежимЗаписи - РежимЗаписиДокумента - в параметр передается текущий режим записи документа. +// РежимПроведения - РежимПроведенияДокумента - в данный параметр передается текущий режим проведения. +// +Процедура ПроверитьНомерДокументаПоДате(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовСобытия.ПроверитьНомерДокументаПоДате(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## ПроверитьНомерДокументаПоДатеИОрганизации +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку модифицированности Даты и Организации документа. +// Если дата не входит в предыдущий период или изменен реквизит Организация, то номер документа обнуляется. +// Это необходимо для назначения нового номера документу. +// +// Параметры: +// Источник - ДокументОбъект - источник события подписки. +// Отказ - Булево - флаг отказа. +// РежимЗаписи - РежимЗаписиДокумента - в параметр передается текущий режим записи документа. +// РежимПроведения - РежимПроведенияДокумента - в данный параметр передается текущий режим проведения. +// +Процедура ПроверитьНомерДокументаПоДатеИОрганизации(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовСобытия.ПроверитьНомерДокументаПоДатеИОрганизации(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## ПриОпределенииПрефиксаИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает префикс этой информационной базы. +// +// Параметры: +// ПрефиксИнформационнойБазы - Строка - возвращаемое значение. Содержит префикс информационной базы. +// +Процедура ПриОпределенииПрефиксаИнформационнойБазы(ПрефиксИнформационнойБазы) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовСобытия.ПриОпределенииПрефиксаИнформационнойБазы(ПрефиксИнформационнойБазы) +``` +
+ +## ПриОпределенииПрефиксаОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает префикс организации. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, для которой надо получить префикс. +// ПрефиксОрганизации - Строка - префикс организации. +// +Процедура ПриОпределенииПрефиксаОрганизации(Знач Организация, ПрефиксОрганизации) Экспорт +``` + +Пример вызова +```bsl +ПрефиксацияОбъектовСобытия.ПриОпределенииПрефиксаОрганизации(Организация, ПрефиксОрганизации) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПроверкаИКорректировкаДанных.md b/src/content/docs/bsp/ПроверкаИКорректировкаДанных.md new file mode 100644 index 0000000..ad8d859 --- /dev/null +++ b/src/content/docs/bsp/ПроверкаИКорректировкаДанных.md @@ -0,0 +1,181 @@ +--- +title: Проверка и корректировка данных +slug: bsp/проверка-и-корректировка-данных +--- + + +## Проверки +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу модулей проверки. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ВосстанавливатьНастройки - Булево - требуется или нет восстанавливать сохраненные настройки обработок. +// ПолучатьПрошлыйРезультат - Булево - требуется или нет получать сохраненный результат. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица с колонками: +// * Идентификатор - УникальныйИдентификатор - идентификатор проверки. +// * Пометка - Булево - для выбора проверки значение этого поля должно быть Истина. +// * Имя - Строка - имя модуля. +// * Наименование - Строка - краткое наименование проверки для пользователя. +// * Описание - Строка - описание проверки для пользователя. +// * ФормаНастроек - Строка - имя формы настроек, описание: +// см. ПроверкаИКорректировкаДанныхПереопределяемый.ПриЗаполненииПроверок. +// * Настройки - Структура - структура, содержащая любой сериализуемый тип, описание: +// ** Поля - Произвольный - произвольный набор полей. +// см. ПроверкаИКорректировкаДанныхПереопределяемый.ПриЗаполненииПроверок. +// * ВременныеДанные - Структура - структура, содержащая любой сериализуемый тип, описание: +// ** Поля - Произвольный - произвольный набор полей. +// см. ПроверкаИКорректировкаДанныхПереопределяемый.ПриЗаполненииПроверок. +// * ТребуетсяЗаполнитьНастройки - Булево - в строках, где требуется заполнить настройки, +// значение этого поля будет Истина. +// * Дата - Дата - дата последней проверки. +// * Исправлять - Булево - флаг последней проверки. +// * ОбнаруженыПроблемы - Булево - результат последней проверки. +// * ПредставлениеРезультата - Строка - результат последней проверки. +// * ТабличныйДокумент - Произвольный - файл с результатом последней проверки. +// +Функция Проверки(ВосстанавливатьНастройки = Ложь, Знач ПолучатьПрошлыйРезультат = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПроверкаИКорректировкаДанных.Проверки(ВосстанавливатьНастройки, ПолучатьПрошлыйРезультат); +``` +
+ +## ПроверитьДанные +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск проблем для выбранных строк и заполняет колонку Результат. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Проверки - ТаблицаЗначений - таблица полученная с помощью функции Проверки(). +// Исправлять - Булево - Истина, если требуется исправление. +// СохранятьРезультат - Булево - если Истина, тогда результат будет сохранен в присоединенный файл. +// +// Возвращаемое значение: +// Булево - Истина - проверка выполнена, Ложь - требуется заполнить настройки. +// +Функция ПроверитьДанные(Проверки, Исправлять = Ложь, СохранятьРезультат = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПроверкаИКорректировкаДанных.ПроверитьДанные(Проверки, Исправлять, СохранятьРезультат); +``` +
+ +## ТабличныйДокументИзПрисоединенногоФайла +
+ +Описание, пример вызова + +```bsl + +// Выполняет извлечение табличного документа из zip-архива присоединенного файла. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ПрисоединенныйФайл - СправочникСсылка.ИсторияПроверкиИКорректировкиДанныхПрисоединенныеФайлы - файл из которого +// требуется извлечь табличный документ. +// +// Возвращаемое значение: +// ТабличныйДокумент - табличный документ извлеченный из архива. Если табличный документ не +// найден, то будет вызвано исключение. +// +Функция ТабличныйДокументИзПрисоединенногоФайла(ПрисоединенныйФайл) Экспорт +``` + +Пример вызова +```bsl +Результат = ПроверкаИКорректировкаДанных.ТабличныйДокументИзПрисоединенногоФайла(ПрисоединенныйФайл) +``` +
+ +## ВнедренаБСП +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак внедрения БСП. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Булево - Истина - внедрена, Ложь - нет. +// +Функция ВнедренаБСП() Экспорт +``` + +Пример вызова +```bsl +Результат = ПроверкаИКорректировкаДанных.ВнедренаБСП() +``` +
+ +## Модуль +
+ +Описание, пример вызова + +```bsl + +// Возвращает модуль по имени. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Имя - Строка - имя общего модуля. +// +// Возвращаемое значение: +// ОбщийМодуль - ОбщийМодуль. +// +Функция Модуль(Имя) Экспорт +``` + +Пример вызова +```bsl +Результат = ПроверкаИКорректировкаДанных.Модуль(Имя) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +ПроверкаИКорректировкаДанных.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПроверкаИКорректировкаДанныхПереопределяемый.md b/src/content/docs/bsp/ПроверкаИКорректировкаДанныхПереопределяемый.md new file mode 100644 index 0000000..b73da0c --- /dev/null +++ b/src/content/docs/bsp/ПроверкаИКорректировкаДанныхПереопределяемый.md @@ -0,0 +1,74 @@ +--- +title: Проверка и корректировка данных переопределяемый +slug: bsp/проверка-и-корректировка-данных-переопределяемый +--- + + +## ПриЗаполненииПроверок +
+ +Описание, пример вызова + +```bsl + +// Вызывается при формировании списка доступных пользователю обработок проверки/корректировки, позволяет дополнить +// сформированный список своими обработками. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Обработчики - Соответствие - соответствие, где: +// * Ключ - УникальныйИдентификатор - идентификатор проверки. +// * Значение - Строка - имя модуля проверки, который содержит следующие экспортные процедуры: +// ПроверкаИКорректировкаДанных_ЗаполнитьСведения, параметры процедуры: +// * Сведения - Структура - структура с ключами: +// ** Наименование - Строка - наименование проверки. +// ** Описание - Строка - описание проверки, необязательное. +// ** РазделенныеДанные - Булево - какие данные будут проверяться, в зависимости от этого значения, +// в разных режимах будут показаны разные проверки. +// ** Настройки - Структура - настройки, которые пользователь может редактировать. Имеет смысл заполнять +// если указана форма настроек. Эти настройки будут сохраняться между использованиями. +// ** ФормаНастроек - Строка - полное имя формы настроек, необязательное. +// В форму настроек передаются следующие параметры: +// * Настройки - Строка - адрес во временном хранилище, где хранятся настройки. +// * ВременныеДанные - Строка - адрес во временном хранилище, где хранятся временные данные +// (не сохраняются между использованиями). +// * Исправлять - Булево - если Истина, значит требуется исправление данных. +// В форме настроек после редактирования все настройки нужно поместить во временное хранилище с +// новыми адресами и вернуть структуру с ключами: +// * Настройки - Строка - адрес во временном хранилище, где хранятся настройки. +// * ВременныеДанные - Строка - адрес во временном хранилище, где хранятся временные данные. +// ПроверкаИКорректировкаДанных_ПроверитьНастройки, параметры процедуры: +// * Настройки - Структура - настройки полученные из процедуры ЗаполнитьСведения. +// * ВременныеДанные - Структура - временные настройки, полученные из формы настроек. +// * Исправлять - Булево - Истина, если требуется исправление данных. +// * Отказ - Булево - если присвоить значение Истина, значит настройки содержат ошибки. +// ПроверкаИКорректировкаДанных_ПроверитьДанные, параметры процедуры: +// * Настройки - Структура - настройки полученные из процедуры ЗаполнитьСведения. +// * ВременныеДанные - Структура - временные настройки, полученные из формы настроек. +// * Исправлять - Булево - Истина, если требуется исправление данных. +// * Результат - Структура - структура, значения которой нужно заполнить, ключи: +// ** ОбнаруженыПроблемы - Булево - по умолчанию Ложь. +// ** ПредставлениеРезультата - Строка - краткое представление результата, +// если ОбнаруженыПроблемы = Истина, то обязательно для заполнения. +// ** ТабличныйДокумент - ТабличныйДокумент - подробное представление, необязательное. +// +// Пример: +// Обработчики.Вставить(Новый УникальныйИдентификатор("2b1043e2-9e00-4518-ac0d-1a2befdcce1x"), +// "Обработки.ПроверкаИзмеренийВРегистрахБухгалтерии"); +// +Процедура ПриЗаполненииПроверок(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ПроверкаИКорректировкаДанныхПереопределяемый.ПриЗаполненииПроверок(Обработчики) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПроверкаЛегальностиПолученияОбновленияКлиент.md b/src/content/docs/bsp/ПроверкаЛегальностиПолученияОбновленияКлиент.md new file mode 100644 index 0000000..f63673e --- /dev/null +++ b/src/content/docs/bsp/ПроверкаЛегальностиПолученияОбновленияКлиент.md @@ -0,0 +1,39 @@ +--- +title: Проверка легальности получения обновления клиент +slug: bsp/проверка-легальности-получения-обновления-клиент +--- + + +## ПоказатьПроверкуЛегальностиПолученияОбновления +
+ +Описание, пример вызова + +```bsl + +// Запрашивает у пользователя диалог с подтверждением легальности полученного +// обновления и завершает работу системы, если обновление получено не легально +// (см. параметр ЗавершатьРаботуСистемы). +// +// Параметры: +// Оповещение - ОписаниеОповещения - содержит обработчик, вызываемый после +// подтверждения легальности получения обновления. +// ЗавершатьРаботуСистемы - Булево - завершать работу системы, если пользователь +// указал, что обновление получено не легально. +// +Процедура ПоказатьПроверкуЛегальностиПолученияОбновления(Оповещение, ЗавершатьРаботуСистемы = Ложь) Экспорт +``` + +Пример вызова +```bsl +ПроверкаЛегальностиПолученияОбновленияКлиент.ПоказатьПроверкуЛегальностиПолученияОбновления(Оповещение, ЗавершатьРаботуСистемы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПроверкаЛегальностиПолученияОбновленияПереопределяемый.md b/src/content/docs/bsp/ПроверкаЛегальностиПолученияОбновленияПереопределяемый.md new file mode 100644 index 0000000..17f5188 --- /dev/null +++ b/src/content/docs/bsp/ПроверкаЛегальностиПолученияОбновленияПереопределяемый.md @@ -0,0 +1,38 @@ +--- +title: Проверка легальности получения обновления переопределяемый +slug: bsp/проверка-легальности-получения-обновления-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Переопределяет стандартное поведение подсистемы. +// +// Параметры: +// Настройки - Структура: +// * ТребуетсяПроверитьЛегальностьПолученияОбновления - Булево - по умолчанию Истина для новых версий конфигурации. +// Для базовых версий, режима работы в модели сервиса и подчиненных узлов РИБ принимает значение Ложь. +// Установить Ложь, если требуется отключить проверку легальности обновлений в других случаях, например, +// для арендованных баз. +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +ПроверкаЛегальностиПолученияОбновленияПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПрограммныйИнтерфейсСервиса.md b/src/content/docs/bsp/ПрограммныйИнтерфейсСервиса.md new file mode 100644 index 0000000..faae059 --- /dev/null +++ b/src/content/docs/bsp/ПрограммныйИнтерфейсСервиса.md @@ -0,0 +1,2854 @@ +--- +title: Программный интерфейс сервиса +slug: bsp/программный-интерфейс-сервиса +--- + + +## СвойстваВерсииИнтерфейса +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства версии программного интерфейса менеджера сервиса. +// +// Возвращаемое значение: +// Структура - свойства версии внешнего программного интерфейса: +// * Версия - Число - номер версии внешнего программного интерфейса. +// * ВерсияМенеджераСервиса - Строка - номер версии менеджера сервиса. +// * ЧасовойПоясМенеджераСервиса - Строка - часовой пояс менеджера сервиса. +// +Функция СвойстваВерсииИнтерфейса() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СвойстваВерсииИнтерфейса() +``` +
+ +## ДействующийТокенДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращает действующий токен доступа пользователя. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи - если не указан, используется текущий пользователь. +// ВызыватьИсключениеПриОшибке - Булево - по умолчанию = Истина +// СвойстваОтвета - Структура - возвращаемый параметр: +// * Ошибка - Булево - ошибка при получении токена +// * Сообщение - Строка - сообщение об ошибке. +// +// Возвращаемое значение: +// Строка - токен доступа. +// +Функция ДействующийТокенДоступа(Пользователь = Неопределено, ВызыватьИсключениеПриОшибке = Истина, СвойстваОтвета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ДействующийТокенДоступа(Пользователь, ВызыватьИсключениеПриОшибке, СвойстваОтвета); +``` +
+ +## НовыйТокенДоступа +
+ +Описание, пример вызова + +```bsl + +// Получает новый токен доступа пользователя. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи - если не указан, используется текущий пользователь. +// ВызыватьИсключениеПриОшибке - Булево +// +// Возвращаемое значение: +// Структура - данные нового токена доступа: +// * ТокенДоступа - Строка - если токен получен успешно +// - Неопределено - если при получении токена произошла ошибка +// * ВремяЖизни - Дата - время жизни токена доступа +// * Ошибка - Булево - ошибка при получении токена +// * Сообщение - Строка - сообщение об ошибке +Функция НовыйТокенДоступа(Пользователь = Неопределено, ВызыватьИсключениеПриОшибке = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйТокенДоступа(Пользователь, ВызыватьИсключениеПриОшибке); +``` +
+ +## Абоненты +
+ +Описание, пример вызова + +```bsl + +// Возвращает список абонентов текущего пользователя. +// +// Возвращаемое значение: +// ТаблицаЗначений - список абонентов: +// * Наименование - Строка - наименование абонента +// * Код - Число - код абонента +// * РольПользователя - ПеречислениеСсылка.РолиПользователейАбонентов - роль текущего пользователя абонента. +// +Функция Абоненты() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.Абоненты() +``` +
+ +## ДополнительныеСведенияАбонента +
+ +Описание, пример вызова + +```bsl + +// Возвращает дополнительные сведения (реквизиты и свойства) абонента этого приложения. +// Реализует метод внешнего программного интерфейса - account/attached_info. +// +// Параметры: +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - дополнительные реквизиты и свойства абонента: +// * ПубличныйИдентификатор - Строка - публичный идентификатор абонента +// * Реквизиты - ТаблицаЗначений - дополнительные реквизиты абонента: +// ** Ключ - Строка - имя дополнительного реквизита +// ** Тип - Строка - тип значения +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +// * Свойства - ТаблицаЗначений - дополнительные свойства абонента: +// ** Ключ - Строка - имя дополнительного свойства +// ** Тип - Строка - тип значения +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного свойства +// +Функция ДополнительныеСведенияАбонента(ВызыватьИсключениеПриОшибке = Истина, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ДополнительныеСведенияАбонента(ВызыватьИсключениеПриОшибке, ); +``` +
+ +## ОбновитьДопСведенияАбонента +
+ +Описание, пример вызова + +```bsl + +// Обновляет дополнительные сведения (реквизиты и свойства) абонента. +// Реализует метод внешнего программного интерфейса - account/update_attached_info. +// +// Параметры: +// ДопСведения - см. НовыйДопСведенияАбонента +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - установка доп. сведений: Истина - установлено, Ложь - произошла ошибка. +// +Функция ОбновитьДопСведенияАбонента(ДопСведения, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ОбновитьДопСведенияАбонента(ДопСведения, ); +``` +
+ +## ОбязательныеСведенияДляОформленияПодписки +
+ +Описание, пример вызова + +```bsl + +// Возвращает дополнительные сведения (реквизиты и свойства) указанного абонента, +// необходимые для оформления платной подписки. +// Реализует метод внешнего программного интерфейса - account/attached_info_for_subscribing +// +// Параметры: +// КодАбонента - Число - код абонента, для которого нужно получить доп. сведения. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - дополнительные реквизиты и свойства абонента: +// * ЕстьОшибки - Булево - признак наличия ошибок заполнения. +// * Реквизиты - ТаблицаЗначений - дополнительные реквизиты абонента: +// ** Ключ - Строка - имя дополнительного реквизита +// ** Заголовок - Строка - заголовок дополнительного реквизита +// ** Тип - Строка - тип значения +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +// ** ЗаполнятьОбязательно - Булево - признак обяз +// ** Подсказка - Строка - подсказка заполнения +// ** Ошибка - Булево - признак ошибки заполнения +// ** Сообщение - Строка - сообщение об ошибке. +// * Свойства - ТаблицаЗначений - дополнительные свойства абонента: +// ** Ключ - Строка - имя дополнительного свойства +// ** Заголовок - Строка - заголовок дополнительного реквизита +// ** Тип - Строка - тип значения +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного свойства +// ** ЗаполнятьОбязательно - Булево - признак обяз +// ** Подсказка - Строка - подсказка заполнения +// ** Ошибка - Булево - признак ошибки заполнения +// ** Сообщение - Строка - сообщение об ошибке. +// +Функция ОбязательныеСведенияДляОформленияПодписки(КодАбонента, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ОбязательныеСведенияДляОформленияПодписки(КодАбонента, ); +``` +
+ +## ЗначенияДополнительногоСведения +
+ +Описание, пример вызова + +```bsl + +// Возвращает значения дополнительного сведения. +// +// Параметры: +// ИмяСведения - Строка - имя сведения, для которого нужно получить значения. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - значения дополнительного сведения: +// * Наименование - Строка - длина 100 +// * Вес - Число - точность 10,2 +Функция ЗначенияДополнительногоСведения(ИмяСведения, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ЗначенияДополнительногоСведения(ИмяСведения, ); +``` +
+ +## ПользователиАбонента +
+ +Описание, пример вызова + +```bsl + +// Возвращает список пользователей абонента этого приложения. +// Реализует метод внешнего программного интерфейса - account/users/list. +// +// Параметры: +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - пользователи абонента: +// * Логин - Строка - логин (имя) пользователя +// * ПолноеИмя - Строка - полное имя пользователя +// * Почта - Строка - электронная почта пользователя +// * РольПользователя - ПеречислениеСсылка.РолиПользователейАбонентов - роль пользователя +// * РазрешенноеКоличествоСеансов - Число - разрешенное количество сеансов +// * ВременныйДоступ - Булево - временный доступ +// +Функция ПользователиАбонента(ВызыватьИсключениеПриОшибке = Истина, ОсновныеСвойстваОтвета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ПользователиАбонента(ВызыватьИсключениеПриОшибке, ОсновныеСвойстваОтвета); +``` +
+ +## СвойстваПользователяАбонента +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства пользователя абонента по логину. +// Реализует метод внешнего программного интерфейса - account/users/info. +// Параметры: +// Логин - Строка - Логин (Имя) пользователя. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - свойства пользователя абонента: +// * Логин - Строка - логин (имя) пользователя +// * ПолноеИмя - Строка - полное имя пользователя +// * Почта - Строка - электронная почта пользователя +// * РольПользователя - ПеречислениеСсылка.РолиПользователейАбонентов - роли пользователя +// * РазрешенноеКоличествоСеансов - Число - разрешенное количество сеансов +// * ВременныйДоступ - Булево - временный доступ +// * ДополнительныеРеквизиты - ТаблицаЗначений - дополнительные реквизиты пользователя абонента: +// ** Ключ - Строка - имя дополнительного реквизита +// ** Тип - Строка - тип значения +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +Функция СвойстваПользователяАбонента(Логин, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СвойстваПользователяАбонента(Логин, ); +``` +
+ +## СоздатьПользователяАбонента +
+ +Описание, пример вызова + +```bsl + +// Создает новую учетную запись пользователя сервиса и подключает созданного пользователя к абоненту этого приложения. +// +// Параметры: +// ПараметрыСоздания - см. НовыйПараметрыСозданияПользователя +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - признак добавления пользователя Истина - пользователь добавлен, Ложь - произошла ошибка. +// +Функция СоздатьПользователяАбонента(ПараметрыСоздания, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СоздатьПользователяАбонента(ПараметрыСоздания, ); +``` +
+ +## ДобавитьПользователяАбонента +
+ +Описание, пример вызова + +```bsl + +// Добавляет существующего пользователя сервиса к абоненту этого приложения. +// +// Параметры: +// ПараметрыДобавления - см. НовыйПараметрыДобавленияПользователя +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - признак создания учетной записи Истина - создана, Ложь - произошла ошибка. +// +Функция ДобавитьПользователяАбонента(ПараметрыДобавления, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ДобавитьПользователяАбонента(ПараметрыДобавления, ); +``` +
+ +## УстановитьРольПользователяАбонента +
+ +Описание, пример вызова + +```bsl + +// Устанавливает указанному пользователю абонента этого приложения указанную роль. +// Реализует метод внешнего программного интерфейса - account/users/set_role. +// +// Параметры: +// Логин - Строка - логин (имя) пользователя. +// Роль - ПеречислениеСсылка.РолиПользователейАбонентов - устанавливаемая роль пользователя. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - установки роли Истина - установлено, Ложь - произошла ошибка. +// +Функция УстановитьРольПользователяАбонента(Логин, Роль, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.УстановитьРольПользователяАбонента(Логин, Роль, ); +``` +
+ +## ОбновитьДопРеквизитыПользователяАбонента +
+ +Описание, пример вызова + +```bsl + +// Обновляет дополнительные реквизиты пользователя абонента +// Реализует метод внешнего программного интерфейса - account/users/update_attached_info. +// +// Параметры: +// Логин - Строка - логин (имя) пользователя. +// ДопРеквизиты - ТаблицаЗначений - дополнительные реквизиты пользователя абонента: +// * Ключ - Строка - имя дополнительного реквизита +// * Тип - Строка - тип значения +// * Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - установка доп. реквизитов: Истина - установлено, Ложь - произошла ошибка. +Функция ОбновитьДопРеквизитыПользователяАбонента(Логин, ДопРеквизиты, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ОбновитьДопРеквизитыПользователяАбонента(Логин, ДопРеквизиты, ); +``` +
+ +## НовыйПараметрыСозданияПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон параметров создания пользователя для метода ПрограммныйИнтерфейсСервиса.СоздатьПользователяАбонента. +// +// Возвращаемое значение: +// Структура - шаблон параметров создания пользователя: +// * Логин - Строка - логин (имя пользователя) +// * Пароль - Строка - пароль пользователя +// * ПочтаОбязательна - Булево - признак обязательной установки почты (по умолчанию = Истина) +// * Почта - Строка - электронная почта +// * РольПользователя - ПеречислениеСсылка.РолиПользователейАбонентов - роль (по умолчанию = ПользовательАбонента) +// * ПолноеИмя - Строка - полное имя (наименование) пользователя +// * Телефон - Строка - телефон пользователя +// * ЧасовойПояс - Строка - рабочий часовой пояс пользователя +// * Описание - Строка - описание пользователя +// * ДополнительныеРеквизиты - ТаблицаЗначений - дополнительные реквизиты пользователя абонента: +// ** Ключ - Строка - имя реквизита +// ** Тип - Строка - тип реквизита. +// Простые: string, decimal, date, boolean +// Ссылочные: user, subscriber, tariff, service_provider_tariff, tariff_period, +// subscription, service, additional_value, additional_value_group. +// ** Значение - Строка, Число, Дата, Булево - значение реквизита. +// +Функция НовыйПараметрыСозданияПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйПараметрыСозданияПользователя() +``` +
+ +## НовыйПараметрыДобавленияПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон параметров добавления существующего пользователя для метода ПрограммныйИнтерфейсСервиса.СоздатьПользователяАбонента. +// +// Возвращаемое значение: +// Структура - шаблон параметров создания пользователя: +// * Логин - Строка - логин (имя пользователя) +// * РольПользователя - ПеречислениеСсылка.РолиПользователейАбонентов - роль (по умолчанию = ПользовательАбонента) +// * Описание - Строка - описание пользователя +// * Принудительно - Булево - выполнить даже при наличии предупреждений +// * ДополнительныеРеквизиты - ТаблицаЗначений - дополнительные реквизиты пользователя абонента: +// ** Ключ - Строка - имя реквизита +// ** Тип - Строка - тип реквизита. +// Простые: string, decimal, date, boolean +// Ссылочные: user, subscriber, tariff, service_provider_tariff, tariff_period, +// subscription, service, additional_value, additional_value_group. +// ** Значение - Строка, Число, Дата, Булево - значение реквизита. +// +Функция НовыйПараметрыДобавленияПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйПараметрыДобавленияПользователя() +``` +
+ +## ОбслуживающиеОрганизацииАбонента +
+ +Описание, пример вызова + +```bsl + +// Возвращает список обслуживающих организаций абонента этого приложения. +// Реализует метод внешнего программного интерфейса - account/servants/list +// +// Возвращаемое значение: +// ТаблицаЗначений - обслуживающие организации абонента: +// * Код - Число - код (номер) обслуживающей организации +// * Наименование - Строка - наименование обслуживающей организации +// * Идентификатор - Строка - идентификатор абонента +// * Город - Строка - город +// * Сайт - Строка - сайт +// * Почта - Строка - электронная почта +// * Телефон - Строка - телефон +// * РазрешеноПодписыватьНаТарифы - Булево - разрешено подписывать на тарифы +// * РазрешеноАвтоматическоеВыставлениеСчетов - Булево - разрешено автоматическое выставление счетов +// * РазрешеноПереопределениеТарифов - Булево - разрешено переопределение тарифов +// * ТолькоСтраницаВыбораТарифа - Булево - отображать только страницу выбора тарифа в форме оплаты +// +Функция ОбслуживающиеОрганизацииАбонента() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ОбслуживающиеОрганизацииАбонента() +``` +
+ +## СтраницаВыбораТарифаОбслуживающейОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает HTML-страницу выбора тарифа обслуживающей организации абонента этого приложения. +// Реализует метод внешнего программного интерфейса - account/servants/tariff_selection_page +// Параметры: +// КодОО - Число - код обслуживающей организации. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Строка - HTML-страница выбора тарифа обслуживающей организации. +// +Функция СтраницаВыбораТарифаОбслуживающейОрганизации(КодОО, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СтраницаВыбораТарифаОбслуживающейОрганизации(КодОО, ); +``` +
+ +## РекомендуемыеТарифы +
+ +Описание, пример вызова + +```bsl + +// Возвращает список рекомендуемых тарифов, определенных обслуживающей организацией. +// Реализует метод внешнего программного интерфейса - account/servants/recommended_tariffs +// +// Параметры: +// КодОО - Число - код обслуживающей организации. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - список тарифов: +// * КодТарифаПровайдера - Строка - код тарифа провайдера +// * КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации. +Функция РекомендуемыеТарифы(КодОО, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.РекомендуемыеТарифы(КодОО, ); +``` +
+ +## ТарифыОбслуживающейОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает список тарифов обслуживающей организации. +// Реализует метод внешнего программного интерфейса - account/servant_tariffs/list +// +// Параметры: +// Отбор - см. НовыйОтборСпискаТарифовОбслуживающейОрганизации +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - список тарифов: +// * Код - Строка - код тарифа +// * Наименование - Строка - наименование тарифа +// * КодТарифаПровайдера - Строка - код базового тарифа +// * КраткоеОписание - Строка - краткое описание тарифа +// * ПериодыДействия - ТаблицаЗначений - периоды действия. Заполняется если передан параметр получения ПараметрПолученияПериодыДействия: +// ** Код - Строка - код периода действия +// ** Наименование - Строка - наименование периода действия +// ** Сумма - Число - стоимость тарифа с этим периодом действия +// ** Рекомендуемый - Булево - признак, что период действия является рекомендуемым +// ** Комментарий - Строка - комментарий к периоду действия. +// +Функция ТарифыОбслуживающейОрганизации(Отбор, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ТарифыОбслуживающейОрганизации(Отбор, ); +``` +
+ +## ТарифОбслуживающейОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о тарифе обслуживающей организаций. +// +// Параметры: +// КодОО - Число - код обслуживающей организации. +// КодТарифа - Строка - код тарифа обслуживающей организации. +// +// Возвращаемое значение: +// Структура - информация о тарифе: +// * Код - Строка - код тарифа +// * Наименование - Строка - наименование тарифа +// * КодТарифаПровайдера - Строка - код тарифа провайдера +// * КраткоеОписание - Строка - краткое описание тарифа +// * ОписаниеДляАбонентов - ФорматированныйДокумент - описание тарифа для абонентов. +// * ПериодыДействия - ТаблицаЗначений - периоды действия тарифа: +// ** Код - Строка - код периода действия +// ** Наименование - Строка - наименование периода действия +// ** Сумма - Число - стоимость +// ** Рекомендуемый - Булево - признак того, что период является рекомендуемым к покупке +// ** Комментарий - Строка - комментарий к периоду действия +// +Функция ТарифОбслуживающейОрганизации(КодОО, КодТарифа) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ТарифОбслуживающейОрганизации(КодОО, КодТарифа) +``` +
+ +## ОбслуживаемыеАбоненты +
+ +Описание, пример вызова + +```bsl + +// Возвращает список обслуживаемых абонентов. +// Реализует метод внешнего программного интерфейса - account/customers/list +// +// Параметры: +// КодОО - Число - код (номер) ведущего абонента (если не указан, используется абонент текущего приложения). +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Наименование - Строка - наименование абонента (длина - 64) +// * Код - Строка - код (номер) обслуживаемого абонента (длина - 12). +Функция ОбслуживаемыеАбоненты(КодОО = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ОбслуживаемыеАбоненты(КодОО, ); +``` +
+ +## СвойстваОбслуживаемогоАбонента +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства обслуживаемого абонента. +// Реализует метод внешнего программного интерфейса - account/customers/info +// +// Параметры: +// КодАбонента - Число - код (номер) обслуживаемого абонента. +// КодОО - Число - код (номер) ведущего абонента (если не указан, используется абонент текущего приложения). +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура: +// * Наименование - Строка - наименование абонента (длина - 64) +// * Код - Строка - код (номер) обслуживаемого абонента (длина - 12) +// * Сайт - Строка - сайт из КИ (длина - 500) +// * Город - Строка - город из КИ (длина - 500) +// * Почта - Строка - почта из КИ (длина - 500) +// * Телефон - Строка - телефон из КИ (длина - 500) +// +Функция СвойстваОбслуживаемогоАбонента(КодАбонента, КодОО = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СвойстваОбслуживаемогоАбонента(КодАбонента, КодОО, ); +``` +
+ +## ДопСведенияОбслуживаемогоАбонента +
+ +Описание, пример вызова + +```bsl + +// Возвращает дополнительные сведения (реквизиты и свойства) обслуживаемого абонента. +// Реализует метод внешнего программного интерфейса - account/customers/attached_info +// +// Параметры: +// КодАбонента - Число - код (номер) обслуживаемого абонента. +// КодОО - Число - код (номер) ведущего абонента (если не указан, используется абонент текущего приложения). +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - дополнительные реквизиты и свойства абонента: +// * ПубличныйИдентификатор - Строка - публичный идентификатор абонента +// * Реквизиты - ТаблицаЗначений - дополнительные реквизиты абонента: +// ** Ключ - Строка - имя дополнительного реквизита +// ** Тип - Строка - тип значения +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +// * Свойства - ТаблицаЗначений - дополнительные свойства абонента: +// ** Ключ - Строка - имя дополнительного свойства +// ** Тип - Строка - тип значения +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного свойства +Функция ДопСведенияОбслуживаемогоАбонента(КодАбонента, КодОО = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ДопСведенияОбслуживаемогоАбонента(КодАбонента, КодОО, ); +``` +
+ +## ОбновитьДопСведенияОбслуживаемогоАбонента +
+ +Описание, пример вызова + +```bsl + +// Обновляет дополнительные сведения (реквизиты и свойства) обслуживаемого абонента. +// Реализует метод внешнего программного интерфейса - account/customers/update_attached_info. +// +// Параметры: +// ДопСведения - см. НовыйДопСведенияАбонента +// КодОО - Число - код (номер) ведущего абонента (если не указан, используется абонент текущего приложения). +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - установка доп. сведений: Истина - установлено, Ложь - произошла ошибка. +// +Функция ОбновитьДопСведенияОбслуживаемогоАбонента(ДопСведения, КодОО = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ОбновитьДопСведенияОбслуживаемогоАбонента(ДопСведения, КодОО, ); +``` +
+ +## НовыйДопСведенияАбонента +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон дополнительных сведений абонента. +// +// Возвращаемое значение: +// Структура: +// * КодАбонента - Число - код абонента +// * ПубличныйИдентификатор - Строка - публичный идентификатор абонента (длина - 36), может отсутствовать. +// * Реквизиты - ТаблицаЗначений - дополнительные реквизиты абонента: +// ** Ключ - Строка - имя дополнительного реквизита +// ** Тип - Строка - тип значения (не обязательно, если у доп. реквизита один тип значения) +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +// * Свойства - ТаблицаЗначений - дополнительные свойства абонента: +// ** Ключ - Строка - имя дополнительного свойства +// ** Тип - Строка - тип значения (не обязательно, если у доп. свойства один тип значения) +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного свойства +// +Функция НовыйДопСведенияАбонента() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйДопСведенияАбонента() +``` +
+ +## ПодпискиНаТарифы +
+ +Описание, пример вызова + +```bsl + +// Возвращает список подписок на тарифы обслуживаемых абонентов. +// Реализует метод внешнего программного интерфейса - account/customer_subscriptions/list +// +// Параметры: +// Отбор - см. НовыйОтборПодписокНаТарифы +// КодОО - Число - код (номер) ведущего абонента (если не указан, используется абонент текущего приложения). +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - существующие подписки на тарифы: +// * Номер - Строка - номер подписки +// * Дата - Дата - дата регистрации подписки +// * ДатаПодключения - Дата - дата подключения тарифа по подписке +// * ДатаОтключения - Дата - дата отключения тарифа +// * КодОбслуживаемогоАбонента - Число - код (номер) обслуживаемого абонента +// * КодВедущегоАбонента - Число - код (номер) ведущего абонента +// * КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации +// * КодТарифаПровайдера - Строка - код тарифа в подписке +// * КодПериодаДействия - Строка - код периода действия +// * Количество - Число - количество тарифов в подписке +// * НомерОсновнойПодписки - Строка - номер основной подписки, если текущая подписка на тариф-расширение. +// * ТипПодписки - ПеречислениеСсылка.ТипыПодписокСервиса - тип подписки +// * НомерСчетаНаОплату - Строка - номер счета на оплату +// * ИдентификаторСчетаНаОплату - УникальныйИдентификатор - идентификатор счета на оплату +// +Функция ПодпискиНаТарифы(Отбор, КодОО = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ПодпискиНаТарифы(Отбор, КодОО, ); +``` +
+ +## СвойстваПодпискиНаТариф +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства подписки на тариф обслуживаемого абонента. +// Реализует метод внешнего программного интерфейса - account/customer_subscriptions/info +// +// Параметры: +// НомерПодписки - Строка - номер подписки. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - свойства подписки на тариф: +// * Номер - Строка - номер подписки +// * Дата - Дата - дата регистрации подписки +// * ДатаПодключения - Дата - дата подключения тарифа по подписке +// * ДатаОтключения - Дата - дата отключения тарифа +// * КодОбслуживаемогоАбонента - Число - код (номер) обслуживаемого абонента +// * КодВедущегоАбонента - Число - код (номер) ведущего абонента +// * КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации +// * КодТарифаПровайдера - Строка - код тарифа в подписке +// * КодПериодаДействия - Строка - код периода действия +// * Количество - Число - количество тарифов в подписке +// * НомерОсновнойПодписки - Строка - номер основной подписки, если текущая подписка на тариф-расширение. +// * ТипПодписки - ПеречислениеСсылка.ТипыПодписокСервиса - тип подписки +// * НомерСчетаНаОплату - Строка - номер счета на оплату +// * ИдентификаторСчетаНаОплату - УникальныйИдентификатор - идентификатор счета на оплату +Функция СвойстваПодпискиНаТариф(НомерПодписки, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СвойстваПодпискиНаТариф(НомерПодписки, ); +``` +
+ +## СвойстваПодпискиНаТарифАбонента +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства подписки на тариф абонента. +// Реализует метод внешнего программного интерфейса - subscription/info +// +// Параметры: +// НомерПодписки - Строка - номер подписки. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - свойства подписки на тариф: +// * Номер - Строка - номер подписки +// * Дата - Дата - дата регистрации подписки +// * ДатаПодключения - Дата - дата подключения тарифа по подписке +// * ДатаОтключения - Дата - дата отключения тарифа +// * КодОбслуживаемогоАбонента - Число - код (номер) обслуживаемого абонента +// * КодВедущегоАбонента - Число - код (номер) ведущего абонента +// * КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации +// * КодТарифаПровайдера - Строка - код тарифа в подписке +// * КодПериодаДействия - Строка - код периода действия +// * Количество - Число - количество тарифов в подписке +// * НомерОсновнойПодписки - Строка - номер основной подписки, если текущая подписка на тариф-расширение. +// * ТипПодписки - ПеречислениеСсылка.ТипыПодписокСервиса - тип подписки +// * НомерСчетаНаОплату - Строка - номер счета на оплату +// * ИдентификаторСчетаНаОплату - УникальныйИдентификатор - идентификатор счета на оплату +Функция СвойстваПодпискиНаТарифАбонента(НомерПодписки, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СвойстваПодпискиНаТарифАбонента(НомерПодписки, ); +``` +
+ +## СоздатьПодпискуНаОсновнойТариф +
+ +Описание, пример вызова + +```bsl + +// Создает новую подписку на основной тариф обслуживаемого абонента +// Реализует метод внешнего программного интерфейса - account/customer_subscriptions/create +// +// Параметры: +// ДанныеПодписки - см. НовыйШаблонПодпискиНаОсновнойТариф +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Неопределено, Структура - если оформление подписки успешно выполнено: +// * Номер - Строка - номер созданной подписки. +// * ДатаОтключения - Дата - дата отключения созданной подписки. +Функция СоздатьПодпискуНаОсновнойТариф(ДанныеПодписки, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СоздатьПодпискуНаОсновнойТариф(ДанныеПодписки, ); +``` +
+ +## СоздатьПодпискуНаРасширениеТарифа +
+ +Описание, пример вызова + +```bsl + +// Метод создает новую подписку или несколько подписок на расширение тарифа обслуживаемого абонента. +// Реализует метод внешнего программного интерфейса - account/customer_subscriptions/create_enhanced +// +// Параметры: +// ДанныеРасширенияТарифа - см. НовыйШаблонПодпискиНаРасширениеТарифа +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Неопределено, ТаблицаЗначений - если оформление подписки успешно выполнено: +// * Номер - Строка - номер созданной подписки. +// * ДатаОтключения - Дата - дата отключения созданной подписки. +Функция СоздатьПодпискуНаРасширениеТарифа(ДанныеРасширенияТарифа, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СоздатьПодпискуНаРасширениеТарифа(ДанныеРасширенияТарифа, ); +``` +
+ +## НовыйШаблонПодпискиНаОсновнойТариф +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон новой подписки на основной тариф обслуживаемого абонента. +// +// Возвращаемое значение: +// Структура: +// * КодВедущегоАбонента - Число - код (номер) ведущего абонента +// * КодОбслуживаемогоАбонента - Число - код (номер) обслуживаемого абонента +// * КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации +// * КодТарифаПровайдера - Строка - код тарифа в подписке +// * КодПериодаДействия - Строка - код периода действия подписки +// * ДатаПодключения - Дата - дата подключения тарифа по подписке +// * ДатаОтключения - Дата - дата отключения тарифа +Функция НовыйШаблонПодпискиНаОсновнойТариф() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйШаблонПодпискиНаОсновнойТариф() +``` +
+ +## НовыйШаблонПодпискиНаРасширениеТарифа +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон новой подписки на расширение тарифа обслуживаемого абонента. +// +// Возвращаемое значение: +// Структура: +// * КодВедущегоАбонента - Число - код (номер) ведущего абонента +// * КодОбслуживаемогоАбонента - Число - код (номер) обслуживаемого абонента +// * КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации +// * КодТарифаПровайдера - Строка - код тарифа в подписке +// * КодПериодаДействия - Строка - код периода действия подписки +// * ДатаПодключения - Дата - дата подключения тарифа по подписке +// * ДатаОтключения - Дата - дата отключения тарифа +// * НомерОсновнойПодписки - Строка - номер подписки на основной тариф +// * Количество - Число - количество тарифов в подписке. +Функция НовыйШаблонПодпискиНаРасширениеТарифа() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйШаблонПодпискиНаРасширениеТарифа() +``` +
+ +## СписокУчетныхСистем +
+ +Описание, пример вызова + +```bsl + +// Возвращает список учетных систем, доступных абоненту. +// Реализует метод внешнего программного интерфейса - accounting_system/list +// +// Параметры: +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - список учетных систем абонента: +// * Код - Число - код учетной системы +// * Наименование - Строка - наименование учетной системы +// * КодВладельца - Число - код абонента-владельца учетной системы +// * ЗагружатьДанные - Булево - признак загрузки данных +// * ЛогинПользовательДляЗагрузки - Строка - логин пользователя для загрузки данных +// * ВыгружатьДанные - Булево - признак выгрузки данных +// * АдресДляВыгрузки - Строка - URL-адрес учетной системы для выгрузки данных +// * ЛогинПользователяДляВыгрузки - Строка - логин пользователя для выгрузки данных +// +Функция СписокУчетныхСистем(ВызыватьИсключениеПриОшибке = Истина, ОсновныеСвойстваОтвета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СписокУчетныхСистем(ВызыватьИсключениеПриОшибке, ОсновныеСвойстваОтвета); +``` +
+ +## СвойстваУчетнойСистемы +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства учетной системы абонента по коду учетной системы. +// Реализует метод внешнего программного интерфейса - accounting_system/info +// +// Параметры: +// Код - Число - код учетной системы абонента. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - свойства учетной системы: +// * Код - Число - код учетной системы абонента +// * Наименование - Строка - наименование учетной системы +// * Описание - Строка - описание учетной системы +// * КодВладельца - Число - код абонента-владельца учетной системы +// * ЗагружатьДанные - Булево - признак загрузки данных +// * ЛогинПользователяДляЗагрузки - Строка - логин пользователя для загрузки данных в менеджер сервиса +// * ПравилаЗагрузки - ТаблицаЗначений - правила загрузки данных: +// ** КодПравила - Строка - код правила загрузки данных +// ** Адрес - Строка - адрес объекта для загрузки данных +// * ВыгружатьДанные - Булево - признак выгрузки данных +// * АдресДляВыгрузки - Строка - URL-адрес учетной системы для выгрузки данных в учетную систему +// * ЛогинПользователяДляВыгрузки - Строка - логин пользователя для выгрузки данных +// * ПравилаВыгрузки - ТаблицаЗначений - правила выгрузки данных: +// ** КодПравила - Строка - код правила выгрузки данных +// ** ИдентификаторСтроки - УникальныйИдентификатор - идентификатор строки правила выгрузки +// ** КодУсловия - Строка - код условия использования правила выгрузки +// ** Адрес - Строка - адрес объекта для выгрузки данных +// ** БыстраяОтправка - Булево - признак быстрой отправки +// ** ВыгрузкаПоРасписанию - Булево - признак выгрузки по расписанию +// ** ОтборПоПоставщику - Булево - признак отбора по поставщику +// * ПравилаОбработкиОтветов - ТаблицаЗначений: +// ** ИдентификаторСтрокиПравилаВыгрузки - УникальныйИдентификатор - идентификатор строки правила выгрузки +// ** КодПравила - Строка - код правила обработки ответа +// ** КодыОтветов - Массив Из Число - коды ответов для вызова правила обработки. +// +Функция СвойстваУчетнойСистемы(Код, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СвойстваУчетнойСистемы(Код, ); +``` +
+ +## СоздатьОбновитьУчетнуюСистемуБиллинга +
+ +Описание, пример вызова + +```bsl + +// Создает новую или обновляет существующую учетную систему биллинга. +// Реализует метод внешнего программного интерфейса - accounting_system/create_update_billing +// +// Параметры: +// ПараметрыСозданияОбновления - см. НовыйПараметрыСозданияОбновленияУчетнойСистемыБиллинга +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - свойства учетной системы: +// * Код - Число - код учетной системы абонента +// * Наименование - Строка - наименование учетной системы +// +Функция СоздатьОбновитьУчетнуюСистемуБиллинга(ПараметрыСозданияОбновления, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СоздатьОбновитьУчетнуюСистемуБиллинга(ПараметрыСозданияОбновления, ); +``` +
+ +## НовыйПараметрыСозданияОбновленияУчетнойСистемыБиллинга +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон параметров создания\обновления учетной системы биллинга. +// +// Возвращаемое значение: +// Структура - шаблон параметров: +// * ЛогинПользователяДляЗагрузки - Строка - логин пользователя для загрузки данных в менеджер сервиса +// * ЛогинПользователяДляВыгрузки - Строка - логин пользователя для выгрузки данных в учетную систему +// * АдресДляВыгрузки - Строка - URL-адрес учетной системы для выгрузки данных в учетную систему +// * ПарольДляВыгрузки - Строка - пароль пользователя для выгрузки данных в учетную систему +// * КодУчетнойСистемы - Число - код обновляемой учетной системы абонента. +// Если не указан, создается новая учетная система. +Функция НовыйПараметрыСозданияОбновленияУчетнойСистемыБиллинга() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйПараметрыСозданияОбновленияУчетнойСистемыБиллинга() +``` +
+ +## Конфигурации +
+ +Описание, пример вызова + +```bsl + +// Возвращает список прикладных конфигураций, доступных абоненту этого приложения. +// +// Параметры: +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - доступные конфигурации: +// * Код - Строка - код конфигурации +// * Наименование - Строка - синоним конфигурации +// * Имя - Строка - имя конфигурации (как оно задано в конфигураторе). +// * Описание - Строка - описание конфигурации +// * КодАбонента - Число - код абонента. +// +Функция Конфигурации(ВызыватьИсключениеПриОшибке = Истина, ОсновныеСвойстваОтвета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.Конфигурации(ВызыватьИсключениеПриОшибке, ОсновныеСвойстваОтвета); +``` +
+ +## СписокВариантовПереходаВидовПриложений +
+ +Описание, пример вызова + +```bsl + +// Возвращает список вариантов перехода видов приложений +// Реализует метод внешнего программного интерфейса - apptype/transition_options/list +// +// Параметры: +// Отбор - см. НовыйОтборВариантовПерехода +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Неопределено, ТаблицаЗначений - список обработчиков перехода видов приложения: +// * НомерВерсииКонфигурации - Строка - номер версии конфигурации +// * КодПредыдущегоВидаПриложения - Строка - код предыдущего вида приложения +// * КодВидаПриложения - Строка - код целевого вида приложения +// * ИмяВидаПриложения - Строка - имя целевого вида приложения +// * НаименованиеВидаПриложения - Строка - наименование целевого вида приложения +// +Функция СписокВариантовПереходаВидовПриложений(Отбор = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СписокВариантовПереходаВидовПриложений(Отбор, ); +``` +
+ +## НовыйОтборВариантовПерехода +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон отбора обработчиков перехода. +// +// Возвращаемое значение: +// Структура: +// * КодКонфигурации - Строка - код конфигурации +// * ВерсияКонфигурации - Строка - версия конфигурации +// * КодВидаПриложения - Строка - код вида приложения +Функция НовыйОтборВариантовПерехода() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйОтборВариантовПерехода() +``` +
+ +## СписокСчетовНаОплату +
+ +Описание, пример вызова + +```bsl + +// Возвращает список счетов на оплату +// Реализует метод внешнего программного интерфейса - bill/list +// +// Параметры: +// Отбор - см. НовыйОтборСчетовНаОплату +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - список счетов на оплату: +// * Номер - Строка - номер счета +// * Дата - Дата - дата создания счета +// * ДатаИзменения - Дата - дата изменения счета +// * ИдентификаторСчета - УникальныйИдентификатор - идентификатор счета +// * КодПродавца - Число - код (номер) абонента-продавца +// * КодПокупателя - Число - код (номер) абонента-покупателя +// * Сумма - Число - сумма счета +// * Продление - Булево - признак продления +// * ПлатежнаяСсылка - Строка - платежная ссылка +// * Оплачен - Булево - признак оплаты счета +// * ДополнительнаяИнформация - Строка - дополнительная информация по счету +// * Комментарий - Строка - комментарий счета +Функция СписокСчетовНаОплату(Отбор = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СписокСчетовНаОплату(Отбор, ); +``` +
+ +## ДанныеСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные счета на оплату по номеру или идентификатору счета. +// Реализует метод внешнего программного интерфейса - bill/info +// +// Параметры: +// ИдентификаторСчета - УникальныйИдентификатор - идентификатор счета (не указывается, если передан номер счета) +// НомерСчета - Строка - номер счета (не указывается, если передан идентификатор счета) +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - данные счета: +// * Номер - Строка - номер счета +// * Дата - Дата - дата создания счета +// * ДатаИзменения - Дата - дата изменения счета +// * ИдентификаторСчета - УникальныйИдентификатор - идентификатор счета +// * КодПродавца - Число - код (номер) абонента-продавца +// * КодПокупателя - Число - код (номер) абонента-покупателя +// * Сумма - Число - сумма счета +// * Продление - Булево - признак продления +// * ПлатежнаяСсылка - Строка - платежная ссылка +// * Оплачен - Булево - признак оплаты счета +// * ДополнительнаяИнформация - Строка - дополнительная информация по счету +// * Комментарий - Строка - комментарий счета +// * Тарифы - ТаблицаЗначений - тарифы: +// ** КодТарифаПровайдера - Строка - код тарифа провайдера +// ** КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации +// ** КодПериодаДействия - Строка - код периода действия тарифа +// ** Количество - Число - количество тарифов в подписке +// ** Сумма - Число - стоимость тарифа с учетом периода действия +// ** НомерОснования - Строка - номер подписки-основания +// * Услуги - ТаблицаЗначений - услуги: +// ** Услуга - Строка - наименование услуги +// ** Сумма - Число - стоимость услуги +// * Файлы - ТаблицаЗначений - файлы представления текущего счета на оплату: +// ** Идентификатор - УникальныйИдентификатор - идентификатор файла +// ** Описание - Строка - имя файла представления счета +// * ДополнительныеРеквизиты - ТаблицаЗначений - дополнительные реквизиты счета: +// ** Ключ - Строка - имя дополнительного реквизита +// ** Тип - Строка - тип значения +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +// * Состояние - Структура - данные состояния счета: +// ** Ошибка - Булево - признак ошибки +// ** Описание - Строка - описание состояния +// ** Имя - Строка - имя состояния: +// "created" - создан +// "wait_sending" - ожидание отправки +// "wait_registration" - ожидание оформления +// "wait_payment" - ожидание оплаты +// "paid" - оплачен +// "billing_error" - ошибка выставления счета. +Функция ДанныеСчетаНаОплату(ИдентификаторСчета = Неопределено, НомерСчета = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ДанныеСчетаНаОплату(ИдентификаторСчета, НомерСчета, ); +``` +
+ +## СоздатьСчетНаОплату +
+ +Описание, пример вызова + +```bsl + +// Создает новый счет на оплату. +// Реализует метод внешнего программного интерфейса - bill/create +// +// Параметры: +// ДанныеСчета - Структура: +// * ИдентификаторСчета - УникальныйИдентификатор - идентификатор счета +// * КодПродавца - Число - код (номер) абонента-продавца +// * КодПокупателя - Число - код (номер) абонента-покупателя +// * Сумма - Число - сумма счета +// * Продление - Булево - признак продления +// * ПлатежнаяСсылка - Строка - платежная ссылка +// * Оплачен - Булево - признак оплаты счета +// * ДополнительнаяИнформация - Строка - дополнительная информация по счету +// * Комментарий - Строка - комментарий счета +// * Тарифы - ТаблицаЗначений - тарифы: +// ** КодТарифаПровайдера - Строка - код тарифа провайдера +// ** КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации +// ** КодПериодаДействия - Строка - код периода действия тарифа +// ** Количество - Число - количество тарифов в подписке +// ** Сумма - Число - стоимость тарифа с учетом периода действия +// ** НомерОснования - Строка - номер подписки-основания +// * Услуги - ТаблицаЗначений - услуги: +// ** Услуга - Строка - наименование услуги +// ** Сумма - Число - стоимость услуги +// * Файлы - ТаблицаЗначений - файлы представления текущего счета на оплату: +// ** Идентификатор - УникальныйИдентификатор - идентификатор файла +// ** Описание - Строка - имя файла представления счета +// * ДополнительныеРеквизиты - ТаблицаЗначений - дополнительные реквизиты счета: +// ** Ключ - Строка - имя дополнительного реквизита +// ** Тип - Строка - тип значения (не обязательно, если у доп. реквизита один тип значения) +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура: +// * Номер - Строка - номер созданного счета на оплату +// * ИдентификаторСчета - УникальныйИдентификатор - идентификатор созданного счета на оплату. +Функция СоздатьСчетНаОплату(ДанныеСчета, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СоздатьСчетНаОплату(ДанныеСчета, ); +``` +
+ +## ИзменитьСчетНаОплату +
+ +Описание, пример вызова + +```bsl + +// Изменяет существующий счет на оплату. +// Реализует метод внешнего программного интерфейса - bill/update +// +// Параметры: +// ДанныеСчета - Структура: +// * ИдентификаторСчета - УникальныйИдентификатор - идентификатор счета +// * КодПродавца - Число - код (номер) абонента-продавца +// * КодПокупателя - Число - код (номер) абонента-покупателя +// * Сумма - Число - сумма счета +// * Продление - Булево - признак продления +// * ПлатежнаяСсылка - Строка - платежная ссылка +// * Оплачен - Булево - признак оплаты счета +// * ДополнительнаяИнформация - Строка - дополнительная информация по счету +// * Комментарий - Строка - комментарий счета +// * Тарифы - ТаблицаЗначений - тарифы: +// ** КодТарифаПровайдера - Строка - код тарифа провайдера +// ** КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации +// ** КодПериодаДействия - Строка - код периода действия тарифа +// ** Количество - Число - количество тарифов в подписке +// ** Сумма - Число - стоимость тарифа с учетом периода действия +// ** НомерОснования - Строка - номер подписки-основания +// * Услуги - ТаблицаЗначений - услуги: +// ** Услуга - Строка - наименование услуги +// ** Сумма - Число - стоимость услуги +// * Файлы - ТаблицаЗначений - файлы представления текущего счета на оплату: +// ** Идентификатор - УникальныйИдентификатор - идентификатор файла +// ** Описание - Строка - имя файла представления счета +// * ДополнительныеРеквизиты - ТаблицаЗначений - дополнительные реквизиты счета: +// ** Ключ - Строка - имя дополнительного реквизита +// ** Тип - Строка - тип значения (не обязательно, если у доп. реквизита один тип значения) +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура: +// * Номер - Строка - номер измененного счета на оплату +// * ИдентификаторСчета - УникальныйИдентификатор - идентификатор измененного счета на оплату. +Функция ИзменитьСчетНаОплату(ДанныеСчета, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ИзменитьСчетНаОплату(ДанныеСчета, ); +``` +
+ +## СчетНаОплатуФайлыТалонНаЗагрузку +
+ +Описание, пример вызова + +```bsl + +// Возвращает талон на загрузку файла в существующий счет на оплату +// Реализует метод внешнего программного интерфейса - bill/file_token/upload +// +// Параметры: +// ПараметрыПолучения - см. НовыйПараметрыПолученияТалонаНаЗагрузкуФайла +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура: +// * НомерСчета - Строка - номер счета +// * ИдентификаторСчета - УникальныйИдентификатор - идентификатор счета +// * НаправлениеПередачиДанных - Строка - направление передачи файла = "upload" +// * ТалонНаЗагрузкуФайла - Строка - талон на загрузку файла +// * АдресДляЗагрузки - Строка - URL для загрузки файла методом PUT +Функция СчетНаОплатуФайлыТалонНаЗагрузку(ПараметрыПолучения, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СчетНаОплатуФайлыТалонНаЗагрузку(ПараметрыПолучения, ); +``` +
+ +## СоздатьПодпискиНаТарифыНаОснованииСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Создать подписки на тарифы на основании счета на оплату. +// +// Параметры: +// ПараметрыСоздания - см. НовыйПараметрыСозданияПодписокНаТарифыНаОснованииСчетаНаОплату +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Массив из Строка - номера созданных подписок +Функция СоздатьПодпискиНаТарифыНаОснованииСчетаНаОплату(ПараметрыСоздания, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СоздатьПодпискиНаТарифыНаОснованииСчетаНаОплату(ПараметрыСоздания, ); +``` +
+ +## НовыйОтборСчетовНаОплату +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон отбора счетов на оплату. +// +// Возвращаемое значение: +// Структура: +// * КодПородавца - Число - код абонента-продавца +// * КодПокупателя - Число - код абонента-покупателя +// * НачалоПериода - Дата - дата начала периода +// * КонецПериода - Дата - дата конца периода +// +Функция НовыйОтборСчетовНаОплату() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйОтборСчетовНаОплату() +``` +
+ +## НовыйШаблонСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон нового счета на оплату. +// +// Возвращаемое значение: +// Структура: +// * ИдентификаторСчета - УникальныйИдентификатор - идентификатор счета +// * КодПродавца - Число - код (номер) абонента-продавца +// * КодПокупателя - Число - код (номер) абонента-покупателя +// * Сумма - Число - сумма счета +// * Продление - Булево - признак продления +// * ПлатежнаяСсылка - Строка - платежная ссылка +// * Оплачен - Булево - признак оплаты счета +// * ДополнительнаяИнформация - Строка - дополнительная информация по счету +// * Комментарий - Строка - комментарий счета +// * Тарифы - ТаблицаЗначений - тарифы: +// ** КодТарифаПровайдера - Строка - код тарифа провайдера +// ** КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации +// ** КодПериодаДействия - Строка - код периода действия тарифа +// ** НомерОснования - Строка - номер подписки-основания +// ** Сумма - Число - стоимость тарифа с учетом периода действия +// * Услуги - ТаблицаЗначений - услуги: +// ** Услуга - Строка - наименование услуги +// ** Сумма - Число - стоимость услуги +// * Файлы - ТаблицаЗначений - файлы представления текущего счета на оплату: +// ** Идентификатор - УникальныйИдентификатор - идентификатор файла +// ** Описание - Строка - имя файла представления счета +// * ДополнительныеРеквизиты - ТаблицаЗначений - дополнительные реквизиты счета: +// ** Ключ - Строка - имя дополнительного реквизита +// ** Тип - Строка - тип значения (не обязательно, если у доп. реквизита один тип значения) +// ** Значение - Строка, Число, Дата, Булево - значение дополнительного реквизита +Функция НовыйШаблонСчетаНаОплату() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйШаблонСчетаНаОплату() +``` +
+ +## НовыйПараметрыПолученияТалонаНаЗагрузкуФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон параметров получения талона на загрузку файла. +// +// Возвращаемое значение: +// Структура: +// * НомерСчета - Строка - номер счета (не указывается, если передан идентификатор счета) +// * ИдентификаторСчета - УникальныйИдентификатор - идентификатор счета (не указывается, если передан номер счета) +// * ИмяФайла - Строка - имя файла с расширением +// * Размер - Строка - размер файла в байтах. +Функция НовыйПараметрыПолученияТалонаНаЗагрузкуФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйПараметрыПолученияТалонаНаЗагрузкуФайла() +``` +
+ +## НовыйПараметрыСозданияПодписокНаТарифыНаОснованииСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон параметров создания подписок на тарифы на основании счета на оплату. +// +// Возвращаемое значение: +// Структура: +// * НомерСчета - Строка - номер счета (не указывается, если передан идентификатор счета) +// * ИдентификаторСчета - УникальныйИдентификатор - идентификатор счета (не указывается, если передан номер счета) +// * ДатаПодключения - Дата - дата подключения создаваемых подписок на тарифы. +Функция НовыйПараметрыСозданияПодписокНаТарифыНаОснованииСчетаНаОплату() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйПараметрыСозданияПодписокНаТарифыНаОснованииСчетаНаОплату() +``` +
+ +## НовыйТарифыСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон табличной части "Тарифы" счета на оплату. +// +// Возвращаемое значение: +// ТаблицаЗначений - Новый тарифы счета на оплату: +// * КодТарифаПровайдера - Строка - длина 9 +// * КодТарифаОбслуживающейОрганизации - Строка - длина 9 +// * КодПериодаДействия - Строка - длина 10 +// * Количество - Число - разрядность 10,0 +// * Сумма - Число - разрядность 31,2 +// * НомерОснования - Строка - разрядность 9. +Функция НовыйТарифыСчетаНаОплату() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйТарифыСчетаНаОплату() +``` +
+ +## НовыйУслугиСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон табличной части "Услуги" счета на оплату. +// +// Возвращаемое значение: +// ТаблицаЗначений - Новый услуги счета на оплату: +// * Услуга - Строка - длина 1000 +// * Сумма - Число - разрядность 31,2. +Функция НовыйУслугиСчетаНаОплату() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйУслугиСчетаНаОплату() +``` +
+ +## НовыйФайлыСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон табличной части "Файлы" счета на оплату. +// +// Возвращаемое значение: +// ТаблицаЗначений - Новый файлы счета на оплату: +// * Идентификатор - УникальныйИдентификатор +// * Описание - Строка -длина 150. +Функция НовыйФайлыСчетаНаОплату() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйФайлыСчетаНаОплату() +``` +
+ +## АбонентЭтогоПриложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные абонента этого приложения. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи - пользователь абонента, которого требуется определить. Если не указан, используется текущий. +// Токен - Строка - ключ, выданный администратору ИБ для осуществления операции. +// +// Возвращаемое значение: +// Структура - данные абонента: +// * Наименование - Строка - наименование абонента +// * Код - Число - код абонента +// * РольПользователя - ПеречислениеСсылка.РолиПользователейАбонентов - роль текущего пользователя абонента. +// +Функция АбонентЭтогоПриложения(Знач Пользователь = Неопределено, Знач Токен = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.АбонентЭтогоПриложения(Пользователь, Токен); +``` +
+ +## Приложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает список приложений, доступных пользователю абонента этого приложения. +// +// Параметры: +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - доступные приложения: +// * Код - Число - код (номер) приложения +// * Наименование - Строка - наименование +// * КодАбонентаВладельца - Число - код абонента, владельца приложения +// * КодКонфигурации - Строка - код конфигурации +// * ВерсияКонфигурации - Строка - версия конфигурации +// * НаименованиеКонфигурации - Строка - наименование конфигурации +// * КодВидаПриложения - Строка - код вида приложения +// * ИмяВидаПриложения - Строка - имя вида приложения +// * НаименованиеВидаПриложения - Строка - наименование вида приложения +// * СостояниеПриложения - ПеречислениеСсылка.СостоянияПриложений - состояние приложения +// * АдресПриложения - Строка - URL-адрес приложения +// * ЧасовойПояс - Строка - часовой пояс приложения +// +Функция Приложения(ВызыватьИсключениеПриОшибке = Истина, ОсновныеСвойстваОтвета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.Приложения(ВызыватьИсключениеПриОшибке, ОсновныеСвойстваОтвета); +``` +
+ +## ПриложенияАбонента +
+ +Описание, пример вызова + +```bsl + +// Возвращает список приложений, доступных пользователю абонента этого приложения. +// +// Параметры: +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - доступные приложения: +// * Код - Число - код (номер) приложения +// * Наименование - Строка - наименование +// * КодАбонентаВладельца - Число - код абонента, владельца приложения +// * КодКонфигурации - Строка - код конфигурации +// * ВерсияКонфигурации - Строка - версия конфигурации +// * НаименованиеКонфигурации - Строка - наименование конфигурации +// * КодВидаПриложения - Строка - код вида приложения +// * ИмяВидаПриложения - Строка - имя вида приложения +// * НаименованиеВидаПриложения - Строка - наименование вида приложения +// * СостояниеПриложения - ПеречислениеСсылка.СостоянияПриложений - состояние приложения +// * АдресПриложения - Строка - URL-адрес приложения +// * ЧасовойПояс - Строка - часовой пояс приложения +// +Функция ПриложенияАбонента(КодАбонента, ВызыватьИсключениеПриОшибке = Истина, ОсновныеСвойстваОтвета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ПриложенияАбонента(КодАбонента, ВызыватьИсключениеПриОшибке, ОсновныеСвойстваОтвета); +``` +
+ +## СвойстваПриложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию об указанном приложении. +// +// Параметры: +// КодПриложения - Строка - код приложения (номер области). +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - свойства приложения: +// * Код - Число - код (номер) приложения +// * Наименование - Строка- наименование +// * КодАбонентаВладельца - Число - код абонента, владельца приложения +// * КодКонфигурации - Строка - код конфигурации +// * ВерсияКонфигурации - Строка - версия конфигурации +// * НаименованиеКонфигурации - Строка - наименование конфигурации +// * КодВидаПриложения - Строка - код вида приложения +// * ИмяВидаПриложения - Строка - имя вида приложения +// * НаименованиеВидаПриложения - Строка - наименование вида приложения +// * СостояниеПриложения - ПеречислениеСсылка.СостоянияПриложений - состояние приложения +// * АдресПриложения - Строка - URL-адрес приложения +// * ЧасовойПояс - Строка - часовой пояс приложения +// +Функция СвойстваПриложения(КодПриложения, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СвойстваПриложения(КодПриложения, ); +``` +
+ +## ПользователиПриложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает список пользователей, которым разрешен доступ к указанному приложению. +// +// Параметры: +// КодПриложения - Число - код приложения (номер области) +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// +// Возвращаемое значение: +// ТаблицаЗначений - пользователи, которым разрешен доступ: +// * Логин - Строка - логин (имя) пользователя +// * Роль - ПеречислениеСсылка.ПраваПользователяПриложения - право пользователя на текущее приложение в менеджере сервиса. +// +Функция ПользователиПриложения(КодПриложения, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ПользователиПриложения(КодПриложения, ); +``` +
+ +## ДобавитьПользователяВПриложение +
+ +Описание, пример вызова + +```bsl + +// Устанавливает пользователю с указанным логином доступ к указанному приложению +// и назначает указанную роль для работы в приложении. +// +// Параметры: +// ПараметрыДобавления - см. НовыйПараметрыДобавленияПользователяВПриложение +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - результат установки права доступа к приложению: Истина - право установлено, Ложь - произошла ошибка. +// +Функция ДобавитьПользователяВПриложение(ПараметрыДобавления, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ДобавитьПользователяВПриложение(ПараметрыДобавления, ); +``` +
+ +## УдалитьПользователяИзПриложения +
+ +Описание, пример вызова + +```bsl + +// Отменяет пользователю с указанным логином доступ к указанному приложению. +// +// Параметры: +// Логин - Строка - Логин (Имя) пользователя. +// КодПриложения - Число - код приложения (номер области) +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - результат отмены права доступа к приложению: Истина - право отменено, Ложь - произошла ошибка. +// +Функция УдалитьПользователяИзПриложения(Логин, КодПриложения, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.УдалитьПользователяИзПриложения(Логин, КодПриложения, ); +``` +
+ +## СоздатьПриложение +
+ +Описание, пример вызова + +```bsl + +// Создает новое приложение с указанной прикладной конфигурацией. +// +// Параметры: +// ПараметрыСоздания - см. НовыйПараметрыСозданияПриложения +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - результат создания приложения: +// * Код - Число - код созданного приложения (номер области) +// * СостояниеПриложения - ПеречислениеСсылка.СостоянияПриложений - состояние приложения после создания. +// * АдресПриложения - Строка - адрес созданного приложения. +// +Функция СоздатьПриложение(ПараметрыСоздания, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СоздатьПриложение(ПараметрыСоздания, ); +``` +
+ +## УстановитьНаименованиеПриложения +
+ +Описание, пример вызова + +```bsl + +// Устанавливает новое наименование приложению. +// +// Параметры: +// ПараметрыИзменения - см. НовыйПараметрыУстановкиНаименованияПриложение +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - результат установки наименования приложению: Истина - наименование установлено, Ложь - произошла ошибка. +// +Функция УстановитьНаименованиеПриложения(ПараметрыИзменения, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.УстановитьНаименованиеПриложения(ПараметрыИзменения, ); +``` +
+ +## СписокРезервныхКопийПриложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает список резервных копий приложения. +// Реализует метод внешнего программного интерфейса - tenant/backup/list. +// +// Возвращаемое значение: +// ТаблицаЗначений - список резервных копий: +// * ИдентификаторРК - Строка - идентификатор резервной копии, длина - 36 +// * МоментСозданияРК - Дата - момент создания резервной копии, ДатаВремя +// * ДляТехПоддержки - Булево - признак создания резервной копии для тех. поддержки +// +Функция СписокРезервныхКопийПриложения() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СписокРезервныхКопийПриложения() +``` +
+ +## НовыйПараметрыСозданияПриложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон параметров создания приложения для метода ПрограммныйИнтерфейсСервиса.СоздатьПриложение. +// +// Возвращаемое значение: +// Структура - шаблон параметров создания приложения: +// * Наименование - Строка - наименование создаваемого приложения. +// * КодКонфигурации - Строка - код конфигурации (вид приложения) +// * ЧасовойПояс - Строка - рабочий часовой пояс приложения +Функция НовыйПараметрыСозданияПриложения() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйПараметрыСозданияПриложения() +``` +
+ +## НовыйПараметрыДобавленияПользователяВПриложение +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон параметров добавления пользователя в приложение для метода +// ПрограммныйИнтерфейсСервиса.ДобавитьПользователяВПриложение. +// +// Возвращаемое значение: +// Структура - шаблон параметров добавления пользователя в приложение: +// * КодПриложения - Число - номер приложения. +// * Логин - Строка - логин (имя пользователя) +// * Право - ПеречислениеСсылка.ПраваПользователяПриложения - право пользователя на приложение в менеджере сервиса +// +Функция НовыйПараметрыДобавленияПользователяВПриложение() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйПараметрыДобавленияПользователяВПриложение() +``` +
+ +## НовыйПараметрыУстановкиНаименованияПриложение +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон параметров изменения наименования приложения для метода +// ПрограммныйИнтерфейсСервиса.УстановитьНаименованиеПриложения. +// +// Возвращаемое значение: +// Структура - шаблон параметров добавления пользователя в приложение: +// * КодПриложения - Число - код приложения (номер области) +// * НазваниеПриложения - Строка - новое наименование приложения +// +Функция НовыйПараметрыУстановкиНаименованияПриложение() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйПараметрыУстановкиНаименованияПриложение() +``` +
+ +## ТарифСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о тарифе сервиса по коду тарифа. +// +// Параметры: +// КодТарифа - Строка - код тарифа. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура - информация о тарифе: +// * Код - Строка - код тарифа +// * Наименование - Строка - наименование тарифа +// * ОписаниеДляОбслуживающихОрганизаций - Строка - описание тарифа для обслуживающей организации. +// * ОписаниеДляАбонентов - ФорматированныйДокумент - описание тарифа для абонентов. +// * ДатаНачалаДействия - Дата - дата начала действия тарифа. +// * ДатаОкончанияДействия - Дата - дата окончания действия тарифа. +// * ПериодДействияПродлевающейПодписки - Число - период (в днях), в течение которого действует продлевающая подписка (если разрешено продление). +// * ПериодДействияРасширяющейПодписки - Число - период (в днях), в течение которого действует расширяющая подписка. +// * ПериодДобавленияПродлевающейПодписки - Число - период (в днях) после завершения действия подписки, в течение которого можно создать продлевающую подписку. +// * РасширениеТарифа - Булево - признак, что тариф является расширением +// * Платный - Булево - признак, что тариф является платным (содержит платные периоды действия) +// * Тестовый - Булево - признак, что тариф является тестовым +// * ЕстьУсловие - Булево - признак, что для использования тарифа требуется соблюдение условия использования. +// * ПериодическаяОплата - Булево - признак, что тариф использует периодическую оплату +// * ПериодичностьОплаты - Строка - код периода периодичности оплаты +// * Услуги - ТаблицаЗначений - услуги тарифа: +// ** Код - Строка - код услуги +// ** Наименование - Строка - Наименование услуги +// ** ТипУслуги - ПеречислениеСсылка.ТипыУслуг - тип услуги +// ** Описание - Строка - Описание услуги +// ** КоличествоЛицензий - Число - количество лицензий на услугу, включенное в тариф +// ** КоличествоДопЛицензийРасширяющейПодписки - Число - количество лицензий на услугу, которое может быть предоставлено расширяющей подпиской +// ** ИдентификаторПоставщика - Строка - идентификатор поставщика услуги +// ** НаименованиеПоставщика - Строка - наименование поставщика услуги +// * Расширения - ТаблицаЗначений - расширения тарифа: +// ** Код - Строка - код тарифа-расширения +// ** Наименование - Строка - наименование тарифа-расширения +// * Конфигурации - ТаблицаЗначений - конфигурации тарифа: +// ** Код - Строка - код конфигурации +// ** Наименование - Строка - имя конфигурации +// ** Описание - Строка - описание конфигурации +// * ПериодыДействия - ТаблицаЗначений - периоды действия тарифа: +// ** Код - Строка - код периода действия +// ** Наименование - Строка - наименование периода действия +// ** Сумма - Число - стоимость +// ** Комментарий - Строка - комментарий к периоду действия +// * ПериодыОповещенийОбОкончанииПодписки - ТаблицаЗначений - периоды оповещений об окончании подписки на тариф: +// ** КоличествоДней - Число - количество дней, когда оповещать пользователя. +// +Функция ТарифСервиса(КодТарифа, ВызыватьИсключениеПриОшибке = Истина, ОсновныеСвойстваОтвета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ТарифСервиса(КодТарифа, ВызыватьИсключениеПриОшибке, ОсновныеСвойстваОтвета); +``` +
+ +## ТарифыСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает список тарифов сервиса, доступных абоненту этого приложения. +// Параметры: +// Отбор - см. НовыйОтборСпискаТарифов +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - список тарифов сервиса: +// * Код - Строка - код тарифа +// * Наименование - Строка - наименование тарифа +// * ОписаниеДляОбслуживающихОрганизаций - Строка - описание тарифа для обслуживающей организации. +// * ОписаниеДляАбонентов - ФорматированныйДокумент - описание тарифа для абонентов. +// * ДатаНачалаДействия - Дата - дата начала действия тарифа. +// * ДатаОкончанияДействия - Дата - дата окончания действия тарифа. +// * ПериодДействияПродлевающейПодписки - Число - период (в днях), в течение которого действует продлевающая подписка (если разрешено продление). +// * ПериодДействияРасширяющейПодписки - Число - период (в днях), в течение которого действует расширяющая подписка. +// * ПериодДобавленияПродлевающейПодписки - Число - период (в днях) после завершения действия подписки, в течение которого можно создать продлевающую подписку. +// * РасширениеТарифа - Булево - признак, что тариф является расширением +// * Платный - Булево - признак, что тариф является платным (содержит платные периоды действия) +// * Тестовый - Булево - признак, что тариф является тестовым +// * ЕстьУсловие - Булево - признак, что для использования тарифа требуется соблюдение условия использования. +// * ПериодическаяОплата - Булево - признак, что тариф использует периодическую оплату +// * ПериодичностьОплаты - Строка - код периода периодичности оплаты +// * ПериодыДействия - ТаблицаЗначений - периоды действия. Заполняется если передан параметр получения ПараметрПолученияПериодыДействия: +// ** Код - Строка - код периода действия +// ** Наименование - Строка - наименование периода действия +// ** Сумма - Число - стоимость +// ** Комментарий - Строка - комментарий к периоду действия +// +Функция ТарифыСервиса(Отбор = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ТарифыСервиса(Отбор, ); +``` +
+ +## НовыйОтборСпискаТарифов +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон отбора списка тарифов провайдера. +// +// Возвращаемое значение: +// Структура: +// * Наименование - Строка - отбор по части наименования +// * ДоступныеТарифы - Массив из Строка - отбор тарифов по кодам доступных тарифов +// * ПараметрыПолучения - Массив из Строка - может содержать параметры получения данных, возвращаемые методами +// - см. ПараметрПолученияПериодыДействия +// - см. ПараметрПолученияТолькоПлатные +// - см. ПараметрПолученияТолькоРасширения +Функция НовыйОтборСпискаТарифов() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйОтборСпискаТарифов() +``` +
+ +## НовыйОтборСпискаТарифовОбслуживающейОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон отбора списка тарифов обслуживающей организации. +// +// Возвращаемое значение: +// Структура: +// * КодОбслуживающейОрганизации - Строка - код обслуживающей организации +// * ДоступныеТарифы - Массив из Строка - отбор тарифов по кодам доступных тарифов +// * ПараметрыПолучения - Массив из Строка - может содержать параметры получения данных, возвращаемые методами +// - см. ПараметрПолученияПериодыДействия +// - см. ПараметрПолученияТолькоРасширения +Функция НовыйОтборСпискаТарифовОбслуживающейОрганизации() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйОтборСпискаТарифовОбслуживающейОрганизации() +``` +
+ +## ПараметрПолученияПериодыДействия +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметр получения тарифов "Периоды действия" +// +// Возвращаемое значение: +// Строка +// +Функция ПараметрПолученияПериодыДействия() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ПараметрПолученияПериодыДействия() +``` +
+ +## ПараметрПолученияТолькоПлатные +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметр получения тарифов "Только платные" +// +// Возвращаемое значение: +// Строка +Функция ПараметрПолученияТолькоПлатные() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ПараметрПолученияТолькоПлатные() +``` +
+ +## ПараметрПолученияТолькоРасширения +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметр получения тарифов "Только расширения" +// +// Возвращаемое значение: +// Строка +Функция ПараметрПолученияТолькоРасширения() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ПараметрПолученияТолькоРасширения() +``` +
+ +## ПодпискиАбонента +
+ +Описание, пример вызова + +```bsl + +// Возвращает список существующих подписок абонента текущего приложения. +// +// Параметры: +// Отбор - см. НовыйОтборПодписокНаТарифы +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений - существующие подписки абонента: +// * КодАбонента - Число - код (номер) абонента +// * Номер - Строка - номер подписки +// * Дата - Дата - дата регистрации подписки +// * ТипПодписки - ПеречислениеСсылка.ТипыПодписокСервиса - тип подписки +// * КодОбслуживающейОрганизации - Число - код (номер) абонента обслуживающей организации +// * ДатаПодключения - Дата - дата подключения тарифа по подписке +// * ДатаОтключения - Дата - дата отключения тарифа +// * КодТарифа - Строка - код тарифа в подписке +// * КодТарифаОбслуживающейОрганизации - Строка - код тарифа обслуживающей организации +// * КодПериодаДействия - Строка - код периода действия +// * Количество - Число - количество тарифов в подписке +// * НомерОсновнойПодписки - Строка - номер основной подписки, если текущая подписка на тариф-расширение. +// * НомерСчетаНаОплату - Строка - номер счета на оплату +// * ИдентификаторСчетаНаОплату - УникальныйИдентификатор - идентификатор счета на оплату +// +Функция ПодпискиАбонента(Отбор = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ПодпискиАбонента(Отбор, ); +``` +
+ +## НовыйОтборПодписокНаТарифы +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон отбора подписок на тарифы обслуживаемых абонентов. +// +// Возвращаемое значение: +// Структура: +// * КодОбслуживаемогоАбонента - Число - код (номер) обслуживаемого абонента +// (не используется, если вызывается для метода ПодпискиАбонента) +// * ТолькоАктивные - Булево - получение только активных подписок +// * ТолькоОсновные - Булево - получение только основных подписок +// * НачалоПериода - Дата - дата начала периода +// * КонецПериода - Дата - дата конца периода +Функция НовыйОтборПодписокНаТарифы() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйОтборПодписокНаТарифы() +``` +
+ +## ИспользоватьПромокод +
+ +Описание, пример вызова + +```bsl + +// Выполняет активацию указанного промо-кода для абонента текущего приложения. +// +// Параметры: +// Промокод - Строка - используемый промокод. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - результат использования: Истина - промокод активирован, Ложь - произошла ошибка. +// +Функция ИспользоватьПромокод(Промокод, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ИспользоватьПромокод(Промокод, ); +``` +
+ +## ИспользоватьПромокодСМеткой +
+ +Описание, пример вызова + +```bsl + +// Выполняет активацию указанного промо-кода для абонента текущего приложения. +// +// Параметры: +// Промокод - Строка - используемый промокод. +// Метка - Строка - дополнительная информация о промо-коде +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - результат использования: Истина - промокод активирован, Ложь - произошла ошибка. +// +Функция ИспользоватьПромокодСМеткой(Промокод, Метка, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ИспользоватьПромокодСМеткой(Промокод, Метка, ); +``` +
+ +## ЗавершитьСеансы +
+ +Описание, пример вызова + +```bsl + +// Выполняет завершение сеансов пользователей. +// +// Параметры: +// НомераСеансов - Массив Из Число - номера сеансов, которые требуется завершить. +// Пользователь - СправочникСсылка.Пользователи - пользователь абонента, +// от имени которого выполняется операция или идентификатор администратора ИБ. +// Токен - Строка - секретный ключ, использующийся для выполнения операции от имени администратора ИБ +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +Процедура ЗавершитьСеансы(Знач НомераСеансов, Знач Пользователь = Неопределено, Знач Токен = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ПрограммныйИнтерфейсСервиса.ЗавершитьСеансы(НомераСеансов, Пользователь, Токен, ); +``` +
+ +## Задачи +
+ +Описание, пример вызова + +```bsl + +// Возвращает список активных задач плользователя из МС, относящихся к текущей области пользователя +// +// Параметры: +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * НомерЗадачи - Строка - номер задачи +// * НаименованиеЗадачи - Строка - номер задачи +Функция Задачи(ВызыватьИсключениеПриОшибке = Истина, ОсновныеСвойстваОтвета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.Задачи(ВызыватьИсключениеПриОшибке, ОсновныеСвойстваОтвета); +``` +
+ +## СвойстваЗадачи +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание задачи пользователя. +// +// Параметры: +// НомерЗадачи - Строка - номер задачи, для которой требуется получить данные. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Структура: +// * type - Строка - тип задачи +// * author - Строка - автор задачи +// * description - Строка - описание задачи +// * tenant - Строка - Наименование приложения +// * subscriber - Строка - Наименование ведущего абонента (Абонент ОО или ЛК) +// * backup_type - Строка - вид запрашиваемой резервной копии (Для тех.поддержки или нет) +Функция СвойстваЗадачи(НомерЗадачи, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.СвойстваЗадачи(НомерЗадачи, ); +``` +
+ +## ВыполнитьЗадачу +
+ +Описание, пример вызова + +```bsl + +// Выполнение задачи пользователя, отказ или согласование. +// +// Параметры: +// ПараметрыЗапроса - см. НовыйПараметрыПодтвержденияЗадачи +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке получения данных. +// ОсновныеСвойстваОтвета - Структура - возвращаемый параметр: +// * КодСостояния - Число - код состояния ответа HTTP-сервиса. +// * КодОтвета - Число - заполняется из ответа значением свойства "general.response". +// * Сообщение - Строка - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Булево - результат выполнения задачи: Истина - задача выполнена, Ложь - произошла ошибка. +Функция ВыполнитьЗадачу(ПараметрыЗапроса, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.ВыполнитьЗадачу(ПараметрыЗапроса, ); +``` +
+ +## НовыйПараметрыПодтвержденияЗадачи +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон параметров подтвержения задачи. +// +// Возвращаемое значение: +// Структура: +// * ПолученоСогласие - Булево - признак получения согласия на предоставление доступа. +// * НомерЗадачи - Строка - номер подтверждаемой задачи. +// * ДатаИстеченияДоступа - Дата - дата прекращения доступа к копии. +// * ИдентификаторКопии - Строка - идентификатор существующей копии +// * СуществующаяКопия - Булево - признак использования существующей копии. +Функция НовыйПараметрыПодтвержденияЗадачи() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйПараметрыПодтвержденияЗадачи() +``` +
+ +## НачатьСоставнуюЗагрузку +
+ +Описание, пример вызова + +```bsl + +// Получает параметры для составной загрузки. +// +// Параметры: +// ИмяФайла - Строка +// РазмерФайла - Число +// ТипФайла - Строка +// Владелец - Произвольный +// +// Возвращаемое значение: +// Структура: +// * ИдентификаторФайла - Строка +// * Тип - Строка +// * Адрес - Строка +// * Заголовки - Соответствие из КлючИЗначение: +// ** Ключ - Строка +// ** Значение - Строка +Функция НачатьСоставнуюЗагрузку(ИмяФайла, РазмерФайла, ТипФайла, Владелец) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НачатьСоставнуюЗагрузку(ИмяФайла, РазмерФайла, ТипФайла, Владелец) +``` +
+ +## НоваяЧасть +
+ +Описание, пример вызова + +```bsl + +// Получает параметры для новой части +// +// Параметры: +// ИдентификаторФайла - Строка +// НомерЧасти - Строка +// +// Возвращаемое значение: +// Структура: +// * Тип - Строка +// * Адрес - Строка +// * Заголовки - Соответствие из КлючИЗначение: +// ** Ключ - Строка +// ** Значение - Строка +Функция НоваяЧасть(ИдентификаторФайла, НомерЧасти) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НоваяЧасть(ИдентификаторФайла, НомерЧасти) +``` +
+ +## ЗавершитьСоставнуюЗагрузку +
+ +Описание, пример вызова + +```bsl + +// Завершает составную загрузку +// +// Параметры: +// ИдентификаторФайла - Строка +// Части - Массив из Строка +Процедура ЗавершитьСоставнуюЗагрузку(ИдентификаторФайла, Части) Экспорт +``` + +Пример вызова +```bsl +ПрограммныйИнтерфейсСервиса.ЗавершитьСоставнуюЗагрузку(ИдентификаторФайла, Части) +``` +
+ +## ОтменитьСоставнуюЗагрузку +
+ +Описание, пример вызова + +```bsl + +// Отменяет составную загрузку +// +// Параметры: +// ИдентификаторФайла - Строка +Процедура ОтменитьСоставнуюЗагрузку(ИдентификаторФайла) Экспорт +``` + +Пример вызова +```bsl +ПрограммныйИнтерфейсСервиса.ОтменитьСоставнуюЗагрузку(ИдентификаторФайла) +``` +
+ +## НовыйОсновныеСвойстваОтвета +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон основных свойств ответа на запрос программного интерфейса. +// +// Возвращаемое значение: +// Структура: +// * КодСостояния - Число - код состояния ответа вызова HTTP-сервиса. +// * КодОтвета - Число - код ответа программного интерфейса. +// * Сообщение - Строка - сообщение программного интерфейса. +Функция НовыйОсновныеСвойстваОтвета() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервиса.НовыйОсновныеСвойстваОтвета() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПрограммныйИнтерфейсСервисаКлиент.md b/src/content/docs/bsp/ПрограммныйИнтерфейсСервисаКлиент.md new file mode 100644 index 0000000..72cd684 --- /dev/null +++ b/src/content/docs/bsp/ПрограммныйИнтерфейсСервисаКлиент.md @@ -0,0 +1,37 @@ +--- +title: Программный интерфейс сервиса клиент +slug: bsp/программный-интерфейс-сервиса-клиент +--- + + +## ТипЗначенияДополнительногоСвойстваПоИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание типа значения дополнительного свойства по имени +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИмяТипа - Строка - имя типа значения дополнительного свойства. +// +// Возвращаемое значение: +// ОписаниеТипов - описание типа значения. +Функция ТипЗначенияДополнительногоСвойстваПоИмени(ИмяТипа) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаКлиент.ТипЗначенияДополнительногоСвойстваПоИмени(ИмяТипа) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ПрограммныйИнтерфейсСервисаСлужебный.md b/src/content/docs/bsp/ПрограммныйИнтерфейсСервисаСлужебный.md new file mode 100644 index 0000000..acabede --- /dev/null +++ b/src/content/docs/bsp/ПрограммныйИнтерфейсСервисаСлужебный.md @@ -0,0 +1,1137 @@ +--- +title: Программный интерфейс сервиса служебный +slug: bsp/программный-интерфейс-сервиса-служебный +--- + + +## АдресИсполненияВнешнегоПрограммногоИнтерфейса +
+ +Описание, пример вызова + +```bsl + +// Возвращает адрес для запроса к внешнему программному интерфейсу менеджера сервиса. +// +// Параметры: +// Метод - Строка - имя метода внешнего программного интерфейса менеджера сервиса. +// ТипИнтерфейса - Строка, Неопределено - тип интерфейса метода внешнего программного интерфейса менеджера сервиса. +// Если не указано, принимается значение "usr". +// +// Возвращаемое значение: +// Строка +// +Функция АдресИсполненияВнешнегоПрограммногоИнтерфейса(Метод, ТипИнтерфейса = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.АдресИсполненияВнешнегоПрограммногоИнтерфейса(Метод, ТипИнтерфейса); +``` +
+ +## ВерсияExtAPIМенеджераСервиса +
+ +Описание, пример вызова + +```bsl + +// Версия HTTP сервиса ExtAPI менеджера сервиса, полученная через механизм версий интерфейсов БСП. +// +// Возвращаемое значение: +// Число, Неопределено - Версия ExtAPI. Неопределено возвращается в случае, когда подключение к Менеджеру сервиса не настроено +Функция ВерсияExtAPIМенеджераСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ВерсияExtAPIМенеджераСервиса() +``` +
+ +## МенеджерСервисаПоддерживаетМетодВАдресе +
+ +Описание, пример вызова + +```bsl + +// Менеджер сервиса поддерживает указание метода в адресе HTTP сервиса ExtAPI. +// +// Возвращаемое значение: +// Булево +Функция МенеджерСервисаПоддерживаетМетодВАдресе() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.МенеджерСервисаПоддерживаетМетодВАдресе() +``` +
+ +## ШаблонЗапроса +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон запроса к внешнему программному интерфейсу менеджера сервиса. +// +// Параметры: +// Метод - Строка - имя метода внешнего программного интерфейса менеджера сервиса. +// ТипИнтерфейса - Строка, Неопределено - тип интерфейса метода внешнего программного интерфейса менеджера сервиса. +// Если не указано, принимается значение "usr". +// +// Возвращаемое значение: +// Структура - шаблон запроса: +// * general - Структура: +// ** type - Строка +// ** method - Строка +// +Функция ШаблонЗапроса(Метод, ТипИнтерфейса = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ШаблонЗапроса(Метод, ТипИнтерфейса); +``` +
+ +## ОтправитьДанныеВМенеджерСервиса +
+ +Описание, пример вызова + +```bsl + +// Отправляет запрос к сервису внешнего программного интерфейса менеджера сервиса. +// +// Параметры: +// ДанныеЗапроса - Структура - данные запроса, в соответствующем формате. +// Подробнее см. статью https://its.1c.ru/db/freshsm#content:15205582:hdoc. +// Может содержать раздел auth.account с указанием кода абонента. +// Метод - Строка - имя метода внешнего программного интерфейса менеджера сервиса. +// ТипИнтерфейса - Строка, Неопределено - тип интерфейса метода внешнего программного интерфейса менеджера сервиса. +// Если не указано, принимается значение "usr". +// АвторизоватьАбонента - Булево - признак добавления авторизации абонента текущей области. +// Данные авторизации добавляются непосредственно перед выполнением запроса. +// +// Возвращаемое значение: +// HTTPОтвет - ответ HTTP-сервиса Менеджера сервиса. +// +Функция ОтправитьДанныеВМенеджерСервиса(ДанныеЗапроса, Метод, ТипИнтерфейса = Неопределено, АвторизоватьАбонента = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ОтправитьДанныеВМенеджерСервиса(ДанныеЗапроса, Метод, ТипИнтерфейса, АвторизоватьАбонента); +``` +
+ +## ОтправитьЗапросВМенеджерСервисаПоТокенуДоступа +
+ +Описание, пример вызова + +```bsl + +Функция ОтправитьЗапросВМенеджерСервисаПоТокенуДоступа(Метод, Адрес, ТокенДоступа, Данные = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ОтправитьЗапросВМенеджерСервисаПоТокенуДоступа(Метод, Адрес, ТокенДоступа, Данные, ); +``` +
+ +## ПереименоватьСвойства +
+ +Описание, пример вызова + +```bsl + +// Переименовывает поля данных ответа по соответствию переименований полей. +// +// Параметры: +// ДанныеОтвета - Структура - данные ответа. +// Переименования - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя исходного поля. +// * Значение - см. ОписаниеКолонки +// - Строка - имя колонки. +// Возвращаемое значение: +// см. ПереименоватьСвойства.ДанныеОтвета +Функция ПереименоватьСвойства(ДанныеОтвета, Знач Переименования) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименоватьСвойства(ДанныеОтвета, Переименования) +``` +
+ +## РезультатВыполнения +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные ответа вызова метода программного интерфейса. +// +// Параметры: +// Ответ - HTTPОтвет - HTTP-ответ для обработки. +// ВызыватьИсключениеПриОшибке - Булево - признак вызова исключения при ошибке. Ошибка, когда код состояния не равен 102xx. +// КодСостояния - Число - возвращаемый параметр - код состояния HTTP-ответа. +// КодОтвета - Число - возвращаемый параметр - заполняется из ответа значением свойства "general.response". +// Сообщение - Строка - возвращаемый параметр - заполняется из ответа значением свойства "general.message". +// +// Возвращаемое значение: +// Неопределено, Структура - данные результата: +// * Поля - Произвольный - произвольные поля результата. +Функция РезультатВыполнения(Ответ, ВызыватьИсключениеПриОшибке = Истина, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.РезультатВыполнения(Ответ, ВызыватьИсключениеПриОшибке, ); +``` +
+ +## СвойстваАвторизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства авторизации для запроса к внешнему программному интерфейсу менеджера сервиса. +// +// Параметры: +// КодАбонента - Число +// Пользователь - СправочникСсылка.Пользователи +// Токен - Строка - временный токен служебного пользователя +// +// Возвращаемое значение: +// Структура: +// * account - Число - код (номер) абонента области. +// Если авторизация осуществляется в модели сервиса, дополнительно передаются: +// * type - Строка - тип запроса. Из БТС всегда равен "smtl". +// * host - Строка - хост витрины, где расположено приложение +// * tenant - Число - номер области +// * key - Строка - ключ области +// Если авторизация происходит от служебного пользователя, дополнительно передаются: +// * login - Строка - логин пользователя +// * hash - Строка - хеш пароля пользователя +// +Функция СвойстваАвторизации(КодАбонента = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.СвойстваАвторизации(КодАбонента, ); +``` +
+ +## ТекстИсключенияВыполненияЗапросаОтАдминистратора +
+ +Описание, пример вызова + +```bsl + +Функция ТекстИсключенияВыполненияЗапросаОтАдминистратора() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ТекстИсключенияВыполненияЗапросаОтАдминистратора() +``` +
+ +## ОтправитьЗапросВСервисИзЛокальнойБазы +
+ +Описание, пример вызова + +```bsl + +// Отправить запрос в сервис из локальной базы. +// +// Параметры: +// Метод - Строка +// Адрес - Строка +// Данные - Структура: +// * auth - Структура: +// ** account - Число +// КэшСоединения - Булево +// Таймаут - Число +// +// Возвращаемое значение: +// HTTPОтвет +Функция ОтправитьЗапросВСервисИзЛокальнойБазы(Метод, Адрес, Данные = Неопределено, КэшСоединения = Истина, Таймаут = 60) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ОтправитьЗапросВСервисИзЛокальнойБазы(Метод, Адрес, Данные, КэшСоединения, Таймаут); +``` +
+ +## АдресСервисаИзЛокальнойБазы +
+ +Описание, пример вызова + +```bsl + +// Адрес сервиса из локальной базы. +// +// Возвращаемое значение: +// Строка - адрес сервиса из локальной базы. +Функция АдресСервисаИзЛокальнойБазы() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.АдресСервисаИзЛокальнойБазы() +``` +
+ +## СоединениеСМенеджеромСервисаИзЛокальнойБазы +
+ +Описание, пример вызова + +```bsl + +// Соединение с менеджером сервиса из локальной базы. +// +// Параметры: +// ДанныеСервера - см. ОбщегоНазначенияКлиентСервер.СтруктураURI +// Таймаут - Число +// +// Возвращаемое значение: +// HTTPСоединение +Функция СоединениеСМенеджеромСервисаИзЛокальнойБазы(ДанныеСервера, Таймаут = 60) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.СоединениеСМенеджеромСервисаИзЛокальнойБазы(ДанныеСервера, Таймаут); +``` +
+ +## СоединениеСМенеджеромСервисаБезАвторизации +
+ +Описание, пример вызова + +```bsl + +Функция СоединениеСМенеджеромСервисаБезАвторизации(ДанныеСервера, Таймаут = 60) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.СоединениеСМенеджеромСервисаБезАвторизации(ДанныеСервера, Таймаут); +``` +
+ +## ДанныеАвторизацииВСервисе +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные авторизации в сервисе для указанного пользователя. +// Если пользователь не указан, используется текущий. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи - если не передан, используется текущий пользователь. +// +// Возвращаемое значение: +// Структура: +// * Логин - Строка +// * Пароль - Строка +// * КодАбонента - Число +// +Функция ДанныеАвторизацииВСервисе(Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ДанныеАвторизацииВСервисе(Пользователь); +``` +
+ +## МассивСтруктурВТаблицуЗначений +
+ +Описание, пример вызова + +```bsl + +// Массив структур в таблицу значений. +// +// Параметры: +// МассивСтруктур - Массив Из Структура: +// * Поля - Произвольный - поля соответствуют колонкам таблицы. +// ПереименованияКолонок - Соответствие Из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Поля - Произвольный - набор колонок, соответствует полям структур массива. +Функция МассивСтруктурВТаблицуЗначений(МассивСтруктур, ПереименованияКолонок) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.МассивСтруктурВТаблицуЗначений(МассивСтруктур, ПереименованияКолонок) +``` +
+ +## ТаблицаЗначенийВМассивСтруктур +
+ +Описание, пример вызова + +```bsl + +// Таблица значений в массив структур. +// +// Параметры: +// ТаблицаЗначений - ТаблицаЗначений: +// * Поля - Произвольный - произвольный набор полей. +// ПереименованияСвойств - Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +// +// Возвращаемое значение: +// Массив Из Структура: +// * Поля - Произвольный - поля соответствуют колонкам таблицы. +Функция ТаблицаЗначенийВМассивСтруктур(ТаблицаЗначений, ПереименованияСвойств) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ТаблицаЗначенийВМассивСтруктур(ТаблицаЗначений, ПереименованияСвойств) +``` +
+ +## ПереименованияАбонент +
+ +Описание, пример вызова + +```bsl + +// Возвращает поля переименования абонента. +// +// Параметры: +// КИ - Булево - добавлять поля контактной информации. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - имя поля API +// * Значение - см. ОписаниеКолонки +// +Функция ПереименованияАбонент(КИ = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияАбонент(КИ); +``` +
+ +## ПереименованияПользователиАбонента +
+ +Описание, пример вызова + +```bsl + +// Переименования таблицы "Пользователи абонента". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияПользователиАбонента() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияПользователиАбонента() +``` +
+ +## ПереименованияУчетнаяСистема +
+ +Описание, пример вызова + +```bsl + +// Переименования объекта "Учетная система". +// +// Параметры: +// Метод - Строка - имя метода программного интерфейса +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияУчетнаяСистема(Метод) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияУчетнаяСистема(Метод) +``` +
+ +## ПереименованияУчетнаяСистемаПравилаВыгрузки +
+ +Описание, пример вызова + +```bsl + +// Переименования таб. части "Правила выгрузки" объекта "Учетная система". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияУчетнаяСистемаПравилаВыгрузки() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияУчетнаяСистемаПравилаВыгрузки() +``` +
+ +## ПереименованияУчетнаяСистемаПравилаЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Переименования таб. части "Правила загрузки" объекта "Учетная система". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияУчетнаяСистемаПравилаЗагрузки() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияУчетнаяСистемаПравилаЗагрузки() +``` +
+ +## ПереименованияУчетнаяСистемаПравилаОбработкиОтветов +
+ +Описание, пример вызова + +```bsl + +// Переименования таб. части "Правила обработки ответов" объекта "Учетная система". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияУчетнаяСистемаПравилаОбработкиОтветов() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияУчетнаяСистемаПравилаОбработкиОтветов() +``` +
+ +## ПереименованияПодпискаНаТариф +
+ +Описание, пример вызова + +```bsl + +// Переименования объекта "Подписка на тариф". +// +// Параметры: +// ДляОбслуживающейОрганизации - Булево - признак получения описания для обслуживающих организаций. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияПодпискаНаТариф(ДляОбслуживающейОрганизации) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияПодпискаНаТариф(ДляОбслуживающейОрганизации) +``` +
+ +## ПереименованияОтветСозданияПодпискиНаТариф +
+ +Описание, пример вызова + +```bsl + +// Переименования полей ответа создания подписки на тариф. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияОтветСозданияПодпискиНаТариф() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияОтветСозданияПодпискиНаТариф() +``` +
+ +## ИменаСвойствСозданияПодписки +
+ +Описание, пример вызова + +```bsl + +// Имена свойств создания подписки. +// +// Параметры: +// СвойстваРасширения - Булево - признак добавления свойств расширения подписки. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - Строка +Функция ИменаСвойствСозданияПодписки(СвойстваРасширения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ИменаСвойствСозданияПодписки(СвойстваРасширения); +``` +
+ +## ПереименованияТариф +
+ +Описание, пример вызова + +```bsl + +// Переименования объекта "Тариф". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияТариф() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияТариф() +``` +
+ +## ПереименованияТарифПериодыДействия +
+ +Описание, пример вызова + +```bsl + +// Переименования таб. части "Периоды действия" объекта "Тариф". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияТарифПериодыДействия() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияТарифПериодыДействия() +``` +
+ +## ПереименованияРасширенияТарифа +
+ +Описание, пример вызова + +```bsl + +// Переименования таб. части "Расширения" +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияРасширенияТарифа() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияРасширенияТарифа() +``` +
+ +## ПереименованияРекомендуемыеТарифы +
+ +Описание, пример вызова + +```bsl + +// Переименования полей списка "Рекомендуемые тарифы". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияРекомендуемыеТарифы() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияРекомендуемыеТарифы() +``` +
+ +## ПереименованияТарифОбслуживающейОрганизации +
+ +Описание, пример вызова + +```bsl + +// Переименования объекта "Тариф обслуживающей организации". +// +// Параметры: +// Метод - Строка - имя метода программного интерфейса. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияТарифОбслуживающейОрганизации(Метод) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияТарифОбслуживающейОрганизации(Метод) +``` +
+ +## ПереименованияТарифОбслуживающейОрганизацииПериодыДействия +
+ +Описание, пример вызова + +```bsl + +// Переименования таб. части "Периоды действия" объекта "Тариф обслуживающей организации". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияТарифОбслуживающейОрганизацииПериодыДействия() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияТарифОбслуживающейОрганизацииПериодыДействия() +``` +
+ +## ПереименованияСчет +
+ +Описание, пример вызова + +```bsl + +// Переименования объекта "Счет". +// +// Параметры: +// Метод - Строка +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияСчет(Метод) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияСчет(Метод) +``` +
+ +## ПереименованияСчетТарифы +
+ +Описание, пример вызова + +```bsl + +// Переименования таб. части "Тарифы" объекта "Счет" . +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияСчетТарифы() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияСчетТарифы() +``` +
+ +## ПереименованияСчетУслуги +
+ +Описание, пример вызова + +```bsl + +// Переименования таб. части "Услуги" объекта "Счет" . +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияСчетУслуги() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияСчетУслуги() +``` +
+ +## ПереименованияСчетФайлы +
+ +Описание, пример вызова + +```bsl + +// Переименования таб. части "Файлы" объекта "Счет" . +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияСчетФайлы() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияСчетФайлы() +``` +
+ +## ПереименованияСчетСостояние +
+ +Описание, пример вызова + +```bsl + +// Переименования данных состояния счета. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияСчетСостояние() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияСчетСостояние() +``` +
+ +## ПереименованияСчетРезультатСозданияИзменения +
+ +Описание, пример вызова + +```bsl + +// Переименования результата создания \ изменения счета. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияСчетРезультатСозданияИзменения() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияСчетРезультатСозданияИзменения() +``` +
+ +## ПереименованияСчетТалонНаЗагрузку +
+ +Описание, пример вызова + +```bsl + +// Переименования объекта "Талон на загрузку" объекта "Счет". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияСчетТалонНаЗагрузку() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияСчетТалонНаЗагрузку() +``` +
+ +## ДанныеЗапросаСозданияИзмененияСчетаНаОплату +
+ +Описание, пример вызова + +```bsl + +// Переименования данных запроса создания \ изменения счета. +// Параметры: +// ДанныеСчета - см. ПрограммныйИнтерфейсСервиса.НовыйШаблонСчетаНаОплату +// Метод - Строка - имя метода программного интерфейса +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ДанныеЗапросаСозданияИзмененияСчетаНаОплату(ДанныеСчета, Метод) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ДанныеЗапросаСозданияИзмененияСчетаНаОплату(ДанныеСчета, Метод) +``` +
+ +## ПереименованияПриложение +
+ +Описание, пример вызова + +```bsl + +// Переименования объекта "Приложение". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияПриложение() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияПриложение() +``` +
+ +## ПереименованияРезервныеКопийПриложения +
+ +Описание, пример вызова + +```bsl + +// Переименования объекта "РезервныеКопийПриложения". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияРезервныеКопийПриложения() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияРезервныеКопийПриложения() +``` +
+ +## ПереименованияЗадачаПользователя +
+ +Описание, пример вызова + +```bsl + +// Переименования объекта "Задача пользователя". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияЗадачаПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияЗадачаПользователя() +``` +
+ +## ПереименованияВариантыПереходаВидовПриложений +
+ +Описание, пример вызова + +```bsl + +// Переименования объекта "ВариантыПерехода". +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияВариантыПереходаВидовПриложений() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияВариантыПереходаВидовПриложений() +``` +
+ +## ПереименованияДополнительныхСведений +
+ +Описание, пример вызова + +```bsl + +// Переименования списока дополнительных сведений. +// +// Параметры: +// ДобавлятьЗаголовок - Булево - признак добавления заголовка доп. сведения в параметры переименования. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - см. ОписаниеКолонки +Функция ПереименованияДополнительныхСведений(ДобавлятьЗаголовок = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПереименованияДополнительныхСведений(ДобавлятьЗаголовок); +``` +
+ +## НовыйДополнительныеСведения +
+ +Описание, пример вызова + +```bsl + +// Конструктор данных дополнительных сведений. +// +// Возвращаемое значение: +// ТаблицаЗначений - Новый дополнительные сведения: +// * Ключ - Строка +// * Тип - Строка +// * Значение - см. ОписаниеТиповЗначенийДополнительныхСведений +Функция НовыйДополнительныеСведения() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.НовыйДополнительныеСведения() +``` +
+ +## ПредставленияТиповЗначенийДополнительныхСведений +
+ +Описание, пример вызова + +```bsl + +// Представления типов значений дополнительных сведений. +// +// Возвращаемое значение: +// СписокЗначений Из Строка +Функция ПредставленияТиповЗначенийДополнительныхСведений() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ПредставленияТиповЗначенийДополнительныхСведений() +``` +
+ +## ОписаниеТиповЗначенийДополнительныхСведений +
+ +Описание, пример вызова + +```bsl + +// Описание типов значений дополнительных сведений. +// +// Возвращаемое значение: +// ОписаниеТипов +Функция ОписаниеТиповЗначенийДополнительныхСведений() Экспорт +``` + +Пример вызова +```bsl +Результат = ПрограммныйИнтерфейсСервисаСлужебный.ОписаниеТиповЗначенийДополнительныхСведений() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВБезопасномРежиме.md b/src/content/docs/bsp/РаботаВБезопасномРежиме.md new file mode 100644 index 0000000..bf877f3 --- /dev/null +++ b/src/content/docs/bsp/РаботаВБезопасномРежиме.md @@ -0,0 +1,482 @@ +--- +title: Работа в безопасном режиме +slug: bsp/работа-в-безопасном-режиме +--- + + +## РазрешениеНаИспользованиеКаталогаФайловойСистемы +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутреннее описание разрешения на использование каталога файловой системы. +// Для передачи в качестве параметра в функции: +// РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов и +// РаботаВБезопасномРежиме.ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов. +// +// Параметры: +// Адрес - Строка - адрес ресурса файловой системы, +// ЧтениеДанных - Булево - указывает необходимость предоставления разрешения +// на чтение данных из данного каталога файловой системы. +// ЗаписьДанных - Булево - указывает необходимость предоставления разрешения +// на запись данных в указанный каталог файловой системы. +// Описание - Строка - описание причины, по которой требуется предоставление разрешения. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция РазрешениеНаИспользованиеКаталогаФайловойСистемы(Знач Адрес, Знач ЧтениеДанных = Ложь, Знач ЗаписьДанных = Ложь, Знач Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.РазрешениеНаИспользованиеКаталогаФайловойСистемы(Адрес, ЧтениеДанных, ЗаписьДанных, Описание); +``` +
+ +## РазрешениеНаИспользованиеКаталогаВременныхФайлов +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутреннее описание разрешения на использование каталога временных файлов. +// Для передачи в качестве параметра в функции: +// РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов и +// РаботаВБезопасномРежиме.ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов. +// +// Параметры: +// ЧтениеДанных - Булево - указывает необходимость предоставления разрешения +// на чтение данных из каталога временных файлов. +// ЗаписьДанных - Булево - указывает необходимость предоставления разрешения +// на запись данных в каталог временных файлов. +// Описание - Строка - описание причины, по которой требуется предоставление разрешения. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция РазрешениеНаИспользованиеКаталогаВременныхФайлов(Знач ЧтениеДанных = Ложь, Знач ЗаписьДанных = Ложь, Знач Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.РазрешениеНаИспользованиеКаталогаВременныхФайлов(ЧтениеДанных, ЗаписьДанных, Описание); +``` +
+ +## РазрешениеНаИспользованиеКаталогаПрограммы +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутреннее описание разрешения на использование каталога программы. +// Для передачи в качестве параметра в функции: +// РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов и +// РаботаВБезопасномРежиме.ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов. +// +// Параметры: +// ЧтениеДанных - Булево - указывает необходимость предоставления разрешения +// на чтение данных из каталога программы. +// ЗаписьДанных - Булево - указывает необходимость предоставления разрешения +// на запись данных в каталог программы. +// Описание - Строка - описание причины, по которой требуется предоставление разрешения. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция РазрешениеНаИспользованиеКаталогаПрограммы(Знач ЧтениеДанных = Ложь, Знач ЗаписьДанных = Ложь, Знач Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.РазрешениеНаИспользованиеКаталогаПрограммы(ЧтениеДанных, ЗаписьДанных, Описание); +``` +
+ +## РазрешениеНаСозданиеCOMКласса +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутреннее описание разрешения на использование COM-класса. +// Для передачи в качестве параметра в функции: +// РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов и +// РаботаВБезопасномРежиме.ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов. +// +// Параметры: +// ProgID - Строка - ProgID класса COM, с которым он зарегистрирован в системе. +// Например, "Excel.Application". +// CLSID - Строка - CLSID класса COM, с которым он зарегистрирован в системе. +// ИмяКомпьютера - Строка - имя компьютера, на котором надо создать указанный объект. +// Если не указано, то объект будет создан на компьютере, на котором выполняется +// текущий рабочий процесс. +// Описание - Строка - описание причины, по которой требуется предоставление разрешения. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция РазрешениеНаСозданиеCOMКласса(Знач ProgID, Знач CLSID, Знач ИмяКомпьютера = "", Знач Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.РазрешениеНаСозданиеCOMКласса(ProgID, CLSID, ИмяКомпьютера, Описание); +``` +
+ +## РазрешениеНаИспользованиеВнешнейКомпоненты +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутреннее описание разрешения на использование внешней компоненты, поставляемой +// в общем макете конфигурации. +// Для передачи в качестве параметра в функции: +// РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов и +// РаботаВБезопасномРежиме.ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов. +// +// Параметры: +// ИмяМакета - Строка - имя общего макета в конфигурации, в котором поставляется внешняя компонента. +// Описание - Строка - описание причины, по которой требуется предоставление разрешения. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция РазрешениеНаИспользованиеВнешнейКомпоненты(Знач ИмяМакета, Знач Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.РазрешениеНаИспользованиеВнешнейКомпоненты(ИмяМакета, Описание); +``` +
+ +## РазрешениеНаИспользованиеВнешнегоМодуля +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутреннее описание разрешения на использование расширения конфигурации. +// Для передачи в качестве параметра в функции: +// РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов и +// РаботаВБезопасномРежиме.ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов. +// +// Параметры: +// Имя - Строка - имя расширения конфигурации. +// КонтрольнаяСумма - Строка - контрольная сумма расширения конфигурации. +// Описание - Строка - описание причины, по которой требуется предоставление разрешения. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция РазрешениеНаИспользованиеВнешнегоМодуля(Знач Имя, Знач КонтрольнаяСумма, Знач Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.РазрешениеНаИспользованиеВнешнегоМодуля(Имя, КонтрольнаяСумма, Описание); +``` +
+ +## РазрешениеНаИспользованиеПриложенияОперационнойСистемы +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутреннее описание разрешения на использование приложения операционной системы. +// Для передачи в качестве параметра в функции: +// РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов и +// РаботаВБезопасномРежиме.ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов. +// +// Параметры: +// ШаблонСтрокиЗапуска - Строка - шаблон строки запуска приложения. +// Подробнее см. документацию к платформе. +// Описание - Строка - описание причины, по которой требуется предоставление разрешения. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция РазрешениеНаИспользованиеПриложенияОперационнойСистемы(Знач ШаблонСтрокиЗапуска, Знач Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.РазрешениеНаИспользованиеПриложенияОперационнойСистемы(ШаблонСтрокиЗапуска, Описание); +``` +
+ +## РазрешениеНаИспользованиеИнтернетРесурса +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутреннее описание разрешения на использование интернет-ресурса. +// Для передачи в качестве параметра в функции: +// РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов и +// РаботаВБезопасномРежиме.ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов. +// +// Параметры: +// Протокол - Строка - протокол, по которому выполняется взаимодействие с ресурсом. Допустимые значения: +// IMAP, POP3, SMTP, HTTP, HTTPS, FTP, FTPS, WS, WSS. +// Адрес - Строка - адрес ресурса без указания протокола. +// Порт - Число - номер порта через который выполняется взаимодействие с ресурсом. +// Описание - Строка - описание причины, по которой требуется предоставление разрешения. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция РазрешениеНаИспользованиеИнтернетРесурса(Знач Протокол, Знач Адрес, Знач Порт = Неопределено, Знач Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.РазрешениеНаИспользованиеИнтернетРесурса(Протокол, Адрес, Порт, Описание); +``` +
+ +## РазрешениеНаИспользованиеПривилегированногоРежима +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутреннее описание разрешения на расширенную работу с данными (включая установку +// привилегированного режима) для внешних модулей. +// Для передачи в качестве параметра в функции: +// РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов и +// РаботаВБезопасномРежиме.ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов. +// +// Параметры: +// Описание - Строка - описание причины, по которой требуется предоставление разрешения. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция РазрешениеНаИспользованиеПривилегированногоРежима(Знач Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.РазрешениеНаИспользованиеПривилегированногоРежима(Описание); +``` +
+ +## ЗапросНаИспользованиеВнешнихРесурсов +
+ +Описание, пример вызова + +```bsl + +// Создает запрос на использование внешних ресурсов. +// +// Параметры: +// НовыеРазрешения - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеВнешнегоМодуля +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеВнешнейКомпоненты +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеИнтернетРесурса +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеКаталогаВременныхФайлов +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеКаталогаПрограммы +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеКаталогаФайловойСистемы +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеПривилегированногоРежима +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеПриложенияОперационнойСистемы - +// запрашиваемые разрешения на доступ к внешним ресурсам. +// Владелец - ЛюбаяСсылка - ссылка на объект информационной базы, с которой логически связаны запрашиваемые +// разрешения. Например, все разрешения на доступ к каталогам томов хранения файлов логически связаны +// с соответствующими элементами справочника ТомаХраненияФайлов, все разрешения на доступ к каталогам +// обмена данными (или к другим ресурсам в зависимости от используемого транспорта обмена) логически +// связаны с соответствующими узлами планов обмена и т.д. В том случае, если разрешение является логически +// обособленным (например, предоставление разрешения регулируется значением константы с типом Булево) - +// рекомендуется использовать ссылку на элемент справочника ИдентификаторыОбъектовМетаданных. +// РежимЗамещения - Булево - определяет режим замещения ранее выданных разрешений для данного владельца. При +// значении параметра равным Истина, помимо предоставления запрошенных разрешений в запрос будет добавлена +// очистка всех разрешений, ранее запрошенных для этого же владельца. +// +// Возвращаемое значение: +// УникальныйИдентификатор - ссылка на записанный в ИБ запрос разрешений. После создания +// всех запросов на изменение разрешений требуется применить запрошенные изменения с помощью вызова +// процедуры РаботаВБезопасномРежимеКлиент.ПрименитьЗапросыНаИспользованиеВнешнихРесурсов. +// +Функция ЗапросНаИспользованиеВнешнихРесурсов(Знач НовыеРазрешения, Знач Владелец = Неопределено, Знач РежимЗамещения = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов(НовыеРазрешения, Владелец, РежимЗамещения); +``` +
+ +## ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов +
+ +Описание, пример вызова + +```bsl + +// Создает запрос на отмену разрешений использования внешних ресурсов. +// +// Параметры: +// Владелец - ЛюбаяСсылка - ссылка на объект информационной базы, с которой логически связаны отменяемые +// разрешения. Например, все разрешения на доступ к каталогам томов хранения файлов логически связаны +// с соответствующими элементами справочника ТомаХраненияФайлов, все разрешения на доступ к каталогам +// обмена данными (или к другим ресурсам в зависимости от используемого транспорта обмена) логически +// связаны с соответствующими узлами планов обмена и т.д. В том случае, если разрешение является логически +// обособленным (например, отменяемые разрешения регулируется значением константы с типом Булево) - +// рекомендуется использовать ссылку на элемент справочника ИдентификаторыОбъектовМетаданных. +// ОтменяемыеРазрешения - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеВнешнегоМодуля +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеВнешнейКомпоненты +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеИнтернетРесурса +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеКаталогаВременныхФайлов +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеКаталогаПрограммы +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеКаталогаФайловойСистемы +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеПривилегированногоРежима +// - Массив из см. РаботаВБезопасномРежиме.РазрешениеНаИспользованиеПриложенияОперационнойСистемы - +// отменяемые разрешения на доступ к внешним ресурсам. +// +// Возвращаемое значение: +// УникальныйИдентификатор - ссылка на записанный в ИБ запрос разрешений. После создания +// всех запросов на изменение разрешений требуется применить запрошенные изменения с помощью вызова +// процедуры РаботаВБезопасномРежимеКлиент.ПрименитьЗапросыНаИспользованиеВнешнихРесурсов. +// +Функция ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов(Знач Владелец, Знач ОтменяемыеРазрешения) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.ЗапросНаОтменуРазрешенийИспользованияВнешнихРесурсов(Владелец, ОтменяемыеРазрешения) +``` +
+ +## ЗапросНаОчисткуРазрешенийИспользованияВнешнихРесурсов +
+ +Описание, пример вызова + +```bsl + +// Создает запрос на отмену всех разрешений использования внешних ресурсов, связанных в владельцем. +// +// Параметры: +// Владелец - ЛюбаяСсылка - ссылка на объект информационной базы, с которой логически связаны отменяемые +// разрешения. Например, все разрешения на доступ к каталогам томов хранения файлов логически связаны +// с соответствующими элементами справочника ТомаХраненияФайлов, все разрешения на доступ к каталогам +// обмена данными (или к другим ресурсам в зависимости от используемого транспорта обмена) логически +// связаны с соответствующими узлами планов обмена и т.д. В том случае, если разрешение является логически +// обособленным (например, отменяемые разрешения регулируется значением константы с типом Булево) - +// рекомендуется использовать ссылку на элемент справочника ИдентификаторыОбъектовМетаданных. +// +// Возвращаемое значение: +// УникальныйИдентификатор - ссылка на записанный в ИБ запрос разрешений. После создания +// всех запросов на изменение разрешений требуется применить запрошенные изменения с помощью вызова +// процедуры РаботаВБезопасномРежимеКлиент.ПрименитьЗапросыНаИспользованиеВнешнихРесурсов. +// +Функция ЗапросНаОчисткуРазрешенийИспользованияВнешнихРесурсов(Знач Владелец) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.ЗапросНаОчисткуРазрешенийИспользованияВнешнихРесурсов(Владелец) +``` +
+ +## УстановленБезопасныйРежим +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции для поддержки работы конфигурации с профилем безопасности, в котором +// запрещено подключение внешних модулей без установки безопасного режима. +// + +// Проверят установленность безопасного режима, игнорируя безопасный режим профиля безопасности, +// использующегося в качестве профиля безопасности с уровнем привилегий конфигурации. +// +// Возвращаемое значение: +// Булево - Истина, если безопасный режим установлен. +// +Функция УстановленБезопасныйРежим() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.УстановленБезопасныйРежим() +``` +
+ +## ЗапросыОбновленияРазрешенийКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Создает запросы на обновление разрешений конфигурации. +// +// Параметры: +// ВключаяЗапросСозданияПрофиляИБ - Булево - включать в результат запрос на создание профиля безопасности +// для текущей информационной базы. +// +// Возвращаемое значение: +// Массив - идентификаторы запросов для обновления разрешений +// конфигурации до требуемых в настоящий момент. +// +Функция ЗапросыОбновленияРазрешенийКонфигурации(Знач ВключаяЗапросСозданияПрофиляИБ = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.ЗапросыОбновленияРазрешенийКонфигурации(ВключаяЗапросСозданияПрофиляИБ); +``` +
+ +## КонтрольныеСуммыФайловКомплектаВнешнейКомпоненты +
+ +Описание, пример вызова + +```bsl + +// Возвращает контрольные суммы файлов комплекта внешней компоненты, поставляемого в макете конфигурации. +// +// Параметры: +// ИмяМакета - Строка - имя макета конфигурации, в составе которого поставляется комплект внешней компоненты. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение - контрольные суммы файлов: +// * Ключ - Строка - имя файла, +// * Значение - Строка - контрольная сумма. +// +Функция КонтрольныеСуммыФайловКомплектаВнешнейКомпоненты(Знач ИмяМакета) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежиме.КонтрольныеСуммыФайловКомплектаВнешнейКомпоненты(ИмяМакета) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВБезопасномРежимеВМоделиСервиса.md b/src/content/docs/bsp/РаботаВБезопасномРежимеВМоделиСервиса.md new file mode 100644 index 0000000..33c17ce --- /dev/null +++ b/src/content/docs/bsp/РаботаВБезопасномРежимеВМоделиСервиса.md @@ -0,0 +1,37 @@ +--- +title: Работа в безопасном режиме в модели сервиса +slug: bsp/работа-в-безопасном-режиме-в-модели-сервиса +--- + + +## РежимИсполненияВнешнегоМодуля +
+ +Описание, пример вызова + +```bsl + +// Возвращает режим исполнения внешнего модуля в модели сервиса. +// +// Параметры: +// ВнешнийМодуль - ЛюбаяСсылка - ссылка +// +// Возвращаемое значение: +// Строка - режим исполнения внешнего модуля. +// +Функция РежимИсполненияВнешнегоМодуля(Знач ВнешнийМодуль) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВБезопасномРежимеВМоделиСервиса.РежимИсполненияВнешнегоМодуля(ВнешнийМодуль) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВБезопасномРежимеКлиент.md b/src/content/docs/bsp/РаботаВБезопасномРежимеКлиент.md new file mode 100644 index 0000000..6ced147 --- /dev/null +++ b/src/content/docs/bsp/РаботаВБезопасномРежимеКлиент.md @@ -0,0 +1,76 @@ +--- +title: Работа в безопасном режиме клиент +slug: bsp/работа-в-безопасном-режиме-клиент +--- + + +## ПрименитьЗапросыНаИспользованиеВнешнихРесурсов +
+ +Описание, пример вызова + +```bsl + +// Применяет ранее сохраненные в информационной базе запросы на использование внешних ресурсов. +// +// Параметры: +// Идентификаторы - Массив - идентификаторы запросов, которые требуется применить, +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, которая должна блокироваться до окончания применения разрешений, +// ОповещениеОЗакрытии - ОписаниеОповещения - которое будет вызвано при успешном предоставлении разрешений. +// +Процедура ПрименитьЗапросыНаИспользованиеВнешнихРесурсов(Знач Идентификаторы, ФормаВладелец, ОповещениеОЗакрытии) Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеКлиент.ПрименитьЗапросыНаИспользованиеВнешнихРесурсов(Идентификаторы, ФормаВладелец, ОповещениеОЗакрытии) +``` +
+ +## ОткрытьДиалогНастройкиИспользованияПрофилейБезопасности +
+ +Описание, пример вызова + +```bsl + +// Открывает диалог настройки режима использования профилей безопасности для +// текущей информационной базы. +// +Процедура ОткрытьДиалогНастройкиИспользованияПрофилейБезопасности() Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеКлиент.ОткрытьДиалогНастройкиИспользованияПрофилейБезопасности() +``` +
+ +## ОткрытьВнешнююОбработкуИлиОтчет +
+ +Описание, пример вызова + +```bsl + +// Позволяет администратору открыть внешнюю обработку или отчет с выбором безопасного режима. +// +// Параметры: +// Владелец - ФормаКлиентскогоПриложения - форма-владелец формы внешней обработки или отчета. +// +Процедура ОткрытьВнешнююОбработкуИлиОтчет(Владелец) Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеКлиент.ОткрытьВнешнююОбработкуИлиОтчет(Владелец) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВБезопасномРежимеКлиентПереопределяемый.md b/src/content/docs/bsp/РаботаВБезопасномРежимеКлиентПереопределяемый.md new file mode 100644 index 0000000..a7c09a2 --- /dev/null +++ b/src/content/docs/bsp/РаботаВБезопасномРежимеКлиентПереопределяемый.md @@ -0,0 +1,40 @@ +--- +title: Работа в безопасном режиме клиент переопределяемый +slug: bsp/работа-в-безопасном-режиме-клиент-переопределяемый +--- + + +## ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при подтверждении запросов на использование внешних ресурсов. +// +// Параметры: +// ИдентификаторыЗапросов - Массив - идентификаторы запросов, которые требуется применить, +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, которая должна блокироваться до окончания применения разрешений, +// ОповещениеОЗакрытии - ОписаниеОповещения - которое будет вызвано при успешном предоставлении разрешений. +// СтандартнаяОбработка - Булево - флаг выполнения стандартной обработки применения разрешений на использование +// внешних ресурсов (подключение к агенту сервера через COM-соединение или сервер администрирования с +// запросом параметров подключения к кластеру у текущего пользователя). Может быть установлен в значение Ложь +// внутри обработчика события, в этом случае стандартная обработка завершения сеанса выполняться не будет. +// +Процедура ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов(Знач ИдентификаторыЗапросов, ФормаВладелец, ОповещениеОЗакрытии, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеКлиентПереопределяемый.ПриПодтвержденииЗапросовНаИспользованиеВнешнихРесурсов(ИдентификаторыЗапросов, ФормаВладелец, ОповещениеОЗакрытии, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВБезопасномРежимеПереопределяемый.md b/src/content/docs/bsp/РаботаВБезопасномРежимеПереопределяемый.md new file mode 100644 index 0000000..be0abe6 --- /dev/null +++ b/src/content/docs/bsp/РаботаВБезопасномРежимеПереопределяемый.md @@ -0,0 +1,204 @@ +--- +title: Работа в безопасном режиме переопределяемый +slug: bsp/работа-в-безопасном-режиме-переопределяемый +--- + + +## ПриПроверкеВозможностиИспользованияПрофилейБезопасности +
+ +Описание, пример вызова + +```bsl + +// Вызывается при проверке возможности использования профилей безопасности. +// +// Параметры: +// Отказ - Булево - если конфигурация не адаптирована к использованию +// профилей безопасности, значение параметра в данной процедуры необходимо +// установить равным Истина. +// +Процедура ПриПроверкеВозможностиИспользованияПрофилейБезопасности(Отказ) Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеПереопределяемый.ПриПроверкеВозможностиИспользованияПрофилейБезопасности(Отказ) +``` +
+ +## ПриПроверкеВозможностиНастройкиПрофилейБезопасности +
+ +Описание, пример вызова + +```bsl + +// Вызывается при проверке возможности настройки профилей безопасности. +// +// Параметры: +// Отказ - Булево - если для информационной базы недоступно использование профилей безопасности +// значение данного параметра нужно установить равным Истина. +// +Процедура ПриПроверкеВозможностиНастройкиПрофилейБезопасности(Отказ) Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеПереопределяемый.ПриПроверкеВозможностиНастройкиПрофилейБезопасности(Отказ) +``` +
+ +## ПриВключенииИспользованияПрофилейБезопасности +
+ +Описание, пример вызова + +```bsl + +// Вызывается при включении использования для информационной базы профилей безопасности. +// +Процедура ПриВключенииИспользованияПрофилейБезопасности() Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеПереопределяемый.ПриВключенииИспользованияПрофилейБезопасности() +``` +
+ +## ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам +
+ +Описание, пример вызова + +```bsl + +// Заполняет перечень запросов внешних разрешений, которые обязательно должны быть предоставлены +// при создании информационной базы или обновлении программы. +// +// Параметры: +// ЗапросыРазрешений - Массив из см. РаботаВБезопасномРежиме.ЗапросНаИспользованиеВнешнихРесурсов +// +Процедура ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам(ЗапросыРазрешений) Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеПереопределяемый.ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам(ЗапросыРазрешений) +``` +
+ +## ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании запроса разрешений на использование внешних ресурсов. +// +// Параметры: +// ПрограммныйМодуль - ЛюбаяСсылка - ссылка на объект информационной базы, представляющий программный +// модуль, для которого выполняется запрос разрешений, +// Владелец - ЛюбаяСсылка - ссылка на объект информационной базы, представляющий объект-владелец запрашиваемых +// разрешений на использование внешних ресурсов, +// РежимЗамещения - Булево - флаг замещения ранее предоставленных разрешений по владельцу, +// ДобавляемыеРазрешения - Массив - массив ОбъектXDTO добавляемых разрешений, +// УдаляемыеРазрешения - Массив - массив ОбъектXDTO удаляемых разрешений, +// СтандартнаяОбработка - Булево - флаг выполнения стандартной обработки создания запроса на использование +// внешних ресурсов. +// Результат - УникальныйИдентификатор - идентификатор запроса (в том случае, если внутри обработчика +// значение параметра СтандартнаяОбработка установлено в значение Ложь). +// +Процедура ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов(Знач ПрограммныйМодуль, Знач Владелец, Знач РежимЗамещения, Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеПереопределяемый.ПриЗапросеРазрешенийНаИспользованиеВнешнихРесурсов(ПрограммныйМодуль, Владелец, РежимЗамещения, ); +``` +
+ +## ПриЗапросеСозданияПрофиляБезопасности +
+ +Описание, пример вызова + +```bsl + +// Вызывается при запросе создания профиля безопасности. +// +// Параметры: +// ПрограммныйМодуль - ЛюбаяСсылка - ссылка на объект информационной базы, представляющий программный +// модуль, для которого выполняется запрос разрешений, +// СтандартнаяОбработка - Булево - флаг выполнения стандартной обработки, +// Результат - УникальныйИдентификатор - идентификатор запроса (в том случае, если внутри обработчика +// значение параметра СтандартнаяОбработка установлено в значение Ложь). +// +Процедура ПриЗапросеСозданияПрофиляБезопасности(Знач ПрограммныйМодуль, СтандартнаяОбработка, Результат) Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеПереопределяемый.ПриЗапросеСозданияПрофиляБезопасности(ПрограммныйМодуль, СтандартнаяОбработка, Результат) +``` +
+ +## ПриЗапросеУдаленияПрофиляБезопасности +
+ +Описание, пример вызова + +```bsl + +// Вызывается при запросе удаления профиля безопасности. +// +// Параметры: +// ПрограммныйМодуль - ЛюбаяСсылка - ссылка на объект информационной базы, представляющий программный +// модуль, для которого выполняется запрос разрешений, +// СтандартнаяОбработка - Булево - флаг выполнения стандартной обработки, +// Результат - УникальныйИдентификатор - идентификатор запроса (в том случае, если внутри обработчика +// значение параметра СтандартнаяОбработка установлено в значение Ложь). +// +Процедура ПриЗапросеУдаленияПрофиляБезопасности(Знач ПрограммныйМодуль, СтандартнаяОбработка, Результат) Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеПереопределяемый.ПриЗапросеУдаленияПрофиляБезопасности(ПрограммныйМодуль, СтандартнаяОбработка, Результат) +``` +
+ +## ПриПодключенииВнешнегоМодуля +
+ +Описание, пример вызова + +```bsl + +// Вызывается при подключении внешнего модуля. В теле процедуры-обработчика может быть изменен +// безопасный режим, в котором будет выполняться подключение. +// +// Параметры: +// ВнешнийМодуль - ЛюбаяСсылка - ссылка на объект информационной базы, представляющий подключаемый +// внешний модуль, +// БезопасныйРежим - ОпределяемыйТип.БезопасныйРежим - безопасный режим, в котором внешний +// модуль будет подключен к информационной базе. Может быть изменен внутри данной процедуры. +// +Процедура ПриПодключенииВнешнегоМодуля(Знач ВнешнийМодуль, БезопасныйРежим) Экспорт +``` + +Пример вызова +```bsl +РаботаВБезопасномРежимеПереопределяемый.ПриПодключенииВнешнегоМодуля(ВнешнийМодуль, БезопасныйРежим) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВМоделиСервиса.md b/src/content/docs/bsp/РаботаВМоделиСервиса.md new file mode 100644 index 0000000..c7b4484 --- /dev/null +++ b/src/content/docs/bsp/РаботаВМоделиСервиса.md @@ -0,0 +1,2370 @@ +--- +title: Работа в модели сервиса +slug: bsp/работа-в-модели-сервиса +--- + + +## РазделительОсновныхДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя общего реквизита, который является разделителем основных данных. +// +// Возвращаемое значение: +// Строка - имя общего реквизита, который является разделителем основных данных. +// +Функция РазделительОсновныхДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.РазделительОсновныхДанных() +``` +
+ +## РазделительВспомогательныхДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя общего реквизита, который является разделителем вспомогательных данных. +// +// Возвращаемое значение: +// Строка - имя общего реквизита, который является разделителем вспомогательных данных. +// +Функция РазделительВспомогательныхДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.РазделительВспомогательныхДанных() +``` +
+ +## РазделениеВключено +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак работы в режиме разделения данных по областям +// (технически это признак условного разделения). +// +// Возвращает Ложь, если конфигурация не может работать в режиме разделения данных +// (не содержит общих реквизитов, предназначенных для разделения данных). +// +// Возвращаемое значение: +// Булево - Истина, если разделение включено. +// Булево - Ложь, если разделение выключено или не поддерживается. +// +Функция РазделениеВключено() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.РазделениеВключено() +``` +
+ +## ДоступноИспользованиеРазделенныхДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак возможности обращения к разделенным данным (которые входят в состав разделителей). +// Признак относится к сеансу, но может меняться во время работы сеанса, если разделение было включено +// в самом сеансе, поэтому проверку следует делать непосредственно перед обращением к разделенным данным. +// +// Возвращает Истина, если конфигурация не может работать в режиме разделения данных +// (не содержит общих реквизитов, предназначенных для разделения данных). +// +// Возвращаемое значение: +// Булево - Истина, если разделение не поддерживается, либо разделение выключено, +// либо разделение включено и разделители установлены. +// Булево - Ложь, если разделение включено и разделители не установлены. +// +Функция ДоступноИспользованиеРазделенныхДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ДоступноИспользованиеРазделенныхДанных() +``` +
+ +## ОчиститьВсеПараметрыСеансаКромеРазделителей +
+ +Описание, пример вызова + +```bsl + +// Очищает все параметры сеанса, кроме связанных с общим +// реквизитом ОбластьДанных. +// +Процедура ОчиститьВсеПараметрыСеансаКромеРазделителей() Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ОчиститьВсеПараметрыСеансаКромеРазделителей() +``` +
+ +## ОбластьДанныхЗаблокирована +
+ +Описание, пример вызова + +```bsl + +// Проверяет блокировку области данных. +// +// Параметры: +// ОбластьДанных - Число - значение разделителя области данных, +// блокировку которой требуется проверить. +// +// Возвращаемое значение: +// Булево - если Истина, область данных заблокирована, иначе нет. +// +Функция ОбластьДанныхЗаблокирована(Знач ОбластьДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ОбластьДанныхЗаблокирована(ОбластьДанных) +``` +
+ +## ПодготовитьОбластьДанныхКИспользованию +
+ +Описание, пример вызова + +```bsl + +// Подготавливает область данных к использованию. Запускает процедура обновления ИБ, +// при необходимости заполняет демонстрационными данными, устанавливает новый статус в регистре ОбластиДанных. +// +// Параметры: +// ОбластьДанных - Число - значение разделителя области данных, которую необходимо подготовить к использованию. +// ИДФайлаВыгрузки - УникальныйИдентификатор - идентификатор файла. +// Вариант - Строка - вариант начальных данных. +// +Процедура ПодготовитьОбластьДанныхКИспользованию(Знач ОбластьДанных, Знач ИДФайлаВыгрузки, Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ПодготовитьОбластьДанныхКИспользованию(ОбластьДанных, ИДФайлаВыгрузки, ); +``` +
+ +## СкопироватьДанныеОбласти +
+ +Описание, пример вызова + +```bsl + +// Копирует данные области данных в другую область данных. +// +// Параметры: +// ОбластьИсточник - Число - значение разделителя области данных источника данных. +// ОбластьПриемник - Число - значение разделителя области данных приемника данных. +// +Процедура СкопироватьДанныеОбласти(Знач ОбластьИсточник, Знач ОбластьПриемник) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.СкопироватьДанныеОбласти(ОбластьИсточник, ОбластьПриемник) +``` +
+ +## ОбслуживаниеОбластейДанных +
+ +Описание, пример вызова + +```bsl + +// Процедура одноименного регламентного задания. +// Находит все области данных со статусами, требующими обработки +// прикладным приложением, и при необходимости планирует запуск ФЗ +// по их обслуживанию. +// +Процедура ОбслуживаниеОбластейДанных() Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ОбслуживаниеОбластейДанных() +``` +
+ +## ПолучитьПроксиМенеджераСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает прокси web-сервиса для синхронизации административных действий в сервисе. +// Вызывающий код должен самостоятельно устанавливать привилегированный режим. +// +// Параметры: +// ПарольПользователя - Строка - пароль для подключения. +// +// Возвращаемое значение: +// WSПрокси - прокси менеджера сервиса. +// +Функция ПолучитьПроксиМенеджераСервиса(Знач ПарольПользователя = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПолучитьПроксиМенеджераСервиса(ПарольПользователя); +``` +
+ +## УстановитьРазделениеСеанса +
+ +Описание, пример вызова + +```bsl + +// Устарела. В зависимости от потребности следует использовать одну из следующих процедур: +// см. РаботаВМоделиСервиса.ВойтиВОбластьДанных +// см. РаботаВМоделиСервиса.ВыйтиИзОбластиДанных +// +// Параметры: +// Использование - Булево - использование разделителя ОбластьДанных в сеансе. +// ОбластьДанных - Число - значение разделителя ОбластьДанных. +// +Процедура УстановитьРазделениеСеанса(Знач Использование = Неопределено, Знач ОбластьДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.УстановитьРазделениеСеанса(Использование, ОбластьДанных); +``` +
+ +## ВойтиВОбластьДанных +
+ +Описание, пример вызова + +```bsl + +// Выполняет вход в область данных. Входить в область можно только из неразделенного сеанса. +// +// Параметры: +// ОбластьДанных - Число - +Процедура ВойтиВОбластьДанных(Знач ОбластьДанных) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ВойтиВОбластьДанных(ОбластьДанных) +``` +
+ +## ВыйтиИзОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Выполняет выход из области данных. +// +Процедура ВыйтиИзОбластиДанных() Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ВыйтиИзОбластиДанных() +``` +
+ +## ЗначениеРазделителяСеанса +
+ +Описание, пример вызова + +```bsl + +// Возвращает значение разделителя текущей области данных. +// В случае если значение не установлено, выдается ошибка. +// +// Возвращаемое значение: +// Число - значение разделителя текущей области данных. +// +Функция ЗначениеРазделителяСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЗначениеРазделителяСеанса() +``` +
+ +## ИспользованиеРазделителяСеанса +
+ +Описание, пример вызова + +```bsl + +// Возвращает флаг использования разделителя ОбластьДанных для текущего сеанса. +// +// Возвращаемое значение: +// Булево - если Истина, разделение используется, иначе нет. +// +Функция ИспользованиеРазделителяСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ИспользованиеРазделителяСеанса() +``` +
+ +## ДобавитьКонстантуВТаблицуПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// Добавляет описание параметра по имени константы в таблицу параметров. +// Возвращает добавленный параметр. +// +// Параметры: +// ТаблицаПараметров - см. ПараметрыИБ +// ИмяКонстанты - Строка - имя константы, которую необходимо добавить в параметры ИБ. +// +// Возвращаемое значение: +// СтрокаТаблицыЗначений - описание добавленного параметра: +// * Имя - Строка +// * Описание - Строка +// * Тип - ОписаниеТипов +// +Функция ДобавитьКонстантуВТаблицуПараметровИБ(Знач ТаблицаПараметров, Знач ИмяКонстанты) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ДобавитьКонстантуВТаблицуПараметровИБ(ТаблицаПараметров, ИмяКонстанты) +``` +
+ +## ПолучитьИмяПриложения +
+ +Описание, пример вызова + +```bsl + +// Получает имя приложения - так, как его задал абонент. +// +// Возвращаемое значение: +// Строка - имя приложения. +// +Функция ПолучитьИмяПриложения() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПолучитьИмяПриложения() +``` +
+ +## ПолучитьРазмерБлокаПередачиФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает размер блоков в Мб для передачи больших файлов частями. +// +// Возвращаемое значение: +// Число - размер блока передачи файлов в мегабайтах. +// +Функция ПолучитьРазмерБлокаПередачиФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПолучитьРазмерБлокаПередачиФайла() +``` +
+ +## ЗаписатьСтруктурныйОбъектXDTOВСтроку +
+ +Описание, пример вызова + +```bsl + +// Сериализует объект структурного типа. +// +// Параметры: +// ЗначениеСтруктурногоТипа - Массив, Структура, Соответствие - сериализуемый объект. +// +// Возвращаемое значение: +// Строка - сериализованное значение объекта структурного типа. +// +Функция ЗаписатьСтруктурныйОбъектXDTOВСтроку(Знач ЗначениеСтруктурногоТипа) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЗаписатьСтруктурныйОбъектXDTOВСтроку(ЗначениеСтруктурногоТипа) +``` +
+ +## СтрокаВBase64 +
+ +Описание, пример вызова + +```bsl + +// Кодирует строковое значение по алгоритму base64. +// +// Параметры: +// Строка - Строка - исходная строка, которую необходимо закодировать. +// +// Возвращаемое значение: +// Строка - закодированная строка. +// +Функция СтрокаВBase64(Знач Строка) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СтрокаВBase64(Строка) +``` +
+ +## Base64ВСтроку +
+ +Описание, пример вызова + +```bsl + +// Декодирует base64-представление строки в исходное значение. +// +// Параметры: +// СтрокаBase64 - Строка - исходная строка, которую необходимо декодировать. +// +// Возвращаемое значение: +// Строка - декодированная строка. +// +Функция Base64ВСтроку(Знач СтрокаBase64) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.Base64ВСтроку(СтрокаBase64) +``` +
+ +## ПолучитьЧасовойПоясОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает часовой пояс области данных. +// Предназначена для вызова из сеансов с неустановленным использованием +// разделителей. В сеансах с установленным использованием разделителей +// следует использовать ПолучитьЧасовойПоясИнформационнойБазы(). +// +// Параметры: +// ОбластьДанных - Число - значение разделителя области данных, часовой +// пояс которой требуется получить. +// +// Возвращаемое значение: +// Строка, Неопределено - часовой пояс области данных, Неопределено, +// если часовой пояс не задан. +// +Функция ПолучитьЧасовойПоясОбластиДанных(Знач ОбластьДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПолучитьЧасовойПоясОбластиДанных(ОбластьДанных) +``` +
+ +## КонечнаяТочкаМенеджераСервисаНастроена +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак наличия настройки конечной точки менеджера сервиса +// +// Возвращаемое значение: +// Булево - Истина, если конечная точка менеджера сервиса установлена и в настройках транспорта заполнено имя пользователя. +// +Функция КонечнаяТочкаМенеджераСервисаНастроена() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.КонечнаяТочкаМенеджераСервисаНастроена() +``` +
+ +## ВнутреннийАдресМенеджераСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает внутренний адрес менеджера сервиса. +// +// Возвращаемое значение: +// Строка - внутренний адрес менеджера сервиса. +// +Функция ВнутреннийАдресМенеджераСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ВнутреннийАдресМенеджераСервиса() +``` +
+ +## АдресПровайдераАутентификации +
+ +Описание, пример вызова + +```bsl + +// Возвращает адрес провайдера аутентификации. +// +// Возвращаемое значение: +// Строка - адрес провайдера аутентификации. +// +Функция АдресПровайдераАутентификации() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.АдресПровайдераАутентификации() +``` +
+ +## АутентификацияТокеномДоступаВнутреннихВызововПрограммногоИнтерфейса +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак аутентификации токеном доступа внутренних вызовов программного интерфейса. +// +// Возвращаемое значение: +// Булево +Функция АутентификацияТокеномДоступаВнутреннихВызововПрограммногоИнтерфейса() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.АутентификацияТокеномДоступаВнутреннихВызововПрограммногоИнтерфейса() +``` +
+ +## ИмяСлужебногоПользователяМенеджераСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя служебного пользователя менеджера сервиса. +// Вызывающий код должен самостоятельно устанавливать привилегированный режим. +// +// Возвращаемое значение: +// Строка - имя служебного пользователя менеджера сервиса. +// +Функция ИмяСлужебногоПользователяМенеджераСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ИмяСлужебногоПользователяМенеджераСервиса() +``` +
+ +## ПарольСлужебногоПользователяМенеджераСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает пароль служебного пользователя менеджера сервиса. +// Вызывающий код должен самостоятельно устанавливать привилегированный режим. +// +// Возвращаемое значение: +// Строка - пароль служебного пользователя менеджера сервиса. +// +Функция ПарольСлужебногоПользователяМенеджераСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПарольСлужебногоПользователяМенеджераСервиса() +``` +
+ +## ОбработатьИнформациюОбОшибкеWebСервиса +
+ +Описание, пример вызова + +```bsl + +// Обрабатывает информацию об ошибке, полученную из web-сервиса. +// В случае если передана не пустая информация об ошибке, записывает +// подробное представление ошибки в журнал регистрации и вызывает +// исключение с текстом краткого представления об ошибке. +// +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке - информация об ошибке, +// ИмяПодсистемы - Строка - имя подсистемы, +// ИмяВебСервиса - Строка - имя web-сервиса, +// ИмяОперации - Строка - имя операции. +// +Процедура ОбработатьИнформациюОбОшибкеWebСервиса(Знач ИнформацияОбОшибке, Знач ИмяПодсистемы = "", Знач ИмяВебСервиса = "", Знач ИмяОперации = "") Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ОбработатьИнформациюОбОшибкеWebСервиса(ИнформацияОбОшибке, ИмяПодсистемы, ИмяВебСервиса, ИмяОперации); +``` +
+ +## ПсевдонимПользователяИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает псевдоним пользователя, который должен использоваться в интерфейсе. +// +// Параметры: +// ИдентификаторПользователя - УникальныйИдентификатор - идентификатор пользователя. +// +// Возвращаемое значение: +// Строка - псевдоним пользователя информационной базы для отображения в интерфейсе. +// +Функция ПсевдонимПользователяИнформационнойБазы(Знач ИдентификаторПользователя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПсевдонимПользователяИнформационнойБазы(ИдентификаторПользователя) +``` +
+ +## ПолучитьМенеджерЗаписиОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Получает в транзакции менеджер записи для регистра ОбластиДанных. +// +// Параметры: +// ОбластьДанных - Число - номер области данных. +// Статус - ПеречислениеСсылка.СтатусыОбластейДанных - ожидаемый статус области. +// +// Возвращаемое значение: +// РегистрСведенийМенеджерЗаписи.ОбластиДанных - менеджер записи области данных. +// +Функция ПолучитьМенеджерЗаписиОбластиДанных(Знач ОбластьДанных, Знач Статус) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПолучитьМенеджерЗаписиОбластиДанных(ОбластьДанных, Статус) +``` +
+ +## ПодготовитьОбластьДанныхКИспользованиюИзЭталонной +
+ +Описание, пример вызова + +```bsl + +// Загружает данные в "типовую" область. +// +// Параметры: +// ОбластьДанных - Число - номер заполняемой области. +// ИДФайлаВыгрузки - УникальныйИдентификатор - ид файла начальных данных. +// Вариант - Строка - вариант начальных данных. +// СообщениеОбОшибке - Строка - возвращаемая, описание ошибки. +// +// Возвращаемое значение: +// Строка - один из вариантов "Успех", "ФатальнаяОшибка". +// +Функция ПодготовитьОбластьДанныхКИспользованиюИзЭталонной(Знач ОбластьДанных, Знач ИДФайлаВыгрузки, Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПодготовитьОбластьДанныхКИспользованиюИзЭталонной(ОбластьДанных, ИДФайлаВыгрузки, ); +``` +
+ +## КонтрольНеразделенныхОбъектовПриЗаписи +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Контроль неразделенных данных. + +// Обработчик подписки на событие КонтрольНеразделенныхОбъектовПриЗаписи. +// +Процедура КонтрольНеразделенныхОбъектовПриЗаписи(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.КонтрольНеразделенныхОбъектовПриЗаписи(Источник, Отказ) +``` +
+ +## КонтрольНеразделенныхНаборовЗаписейПриЗаписи +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие КонтрольНеразделенныхНаборовЗаписейПриЗаписи. +// +Процедура КонтрольНеразделенныхНаборовЗаписейПриЗаписи(Источник, Отказ, Замещение) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.КонтрольНеразделенныхНаборовЗаписейПриЗаписи(Источник, Отказ, Замещение) +``` +
+ +## ПолучитьФайлИзХранилищаМенеджераСервиса +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Работа с файлами + +// Возвращает полное имя файла, полученного из файлового хранилища МС по его идентификатору. +// +// Параметры: +// ИДФайла - УникальныйИдентификатор - идентификатор файла в файловом хранилище МС. +// +// Возвращаемое значение: +// Строка - полное имя извлеченного файла. +// +Функция ПолучитьФайлИзХранилищаМенеджераСервиса(Знач ИДФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПолучитьФайлИзХранилищаМенеджераСервиса(ИДФайла) +``` +
+ +## ПоместитьФайлВХранилищеМенеджераСервиса +
+ +Описание, пример вызова + +```bsl + +// Добавляет файл в хранилище менеджера сервиса. +// +// Параметры: +// АдресДанныеФайл - Строка - адрес файла во временном хранилище, +// - ДвоичныеДанные - двоичные данные файла, +// - Файл - файл. +// ИмяФайла - Строка - хранимое имя файла. +// ДополнительныеПараметры - Структура - сериализуемыt в json данные. +// +// Возвращаемое значение: +// УникальныйИдентификатор - Идентификатор файла в хранилище. +// +Функция ПоместитьФайлВХранилищеМенеджераСервиса(Знач АдресДанныеФайл, Знач ИмяФайла = "", Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПоместитьФайлВХранилищеМенеджераСервиса(АдресДанныеФайл, ИмяФайла, ); +``` +
+ +## ЭтоПолноеИмяДокумента +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции определения типов объектов метаданных по полному имени объекта +// метаданных. + +// Ссылочные типы данных + +// Определяет принадлежность объекта метаданных к общему типу "Документ" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если документ. +// +Функция ЭтоПолноеИмяДокумента(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяДокумента(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяСправочника +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Справочник" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если справочник. +// +Функция ЭтоПолноеИмяСправочника(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяСправочника(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяПеречисления +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Перечисление" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если перечисление. +// +Функция ЭтоПолноеИмяПеречисления(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяПеречисления(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяПланаОбмена +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "План обмена" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если план обмена. +// +Функция ЭтоПолноеИмяПланаОбмена(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяПланаОбмена(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяПланаВидовХарактеристик +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "План видов характеристик" по +// полному имени объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина если план видов характеристик. +// +Функция ЭтоПолноеИмяПланаВидовХарактеристик(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяПланаВидовХарактеристик(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Бизнес-процесс" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если бизнес-процесс. +// +Функция ЭтоПолноеИмяБизнесПроцесса(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяБизнесПроцесса(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяЗадачи +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Задача" по полному имени объекта +// метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если задача. +// +Функция ЭтоПолноеИмяЗадачи(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяЗадачи(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяПланаСчетов +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "План счетов" по полному имени объекта +// метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если план счетов. +// +Функция ЭтоПолноеИмяПланаСчетов(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяПланаСчетов(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяПланаВидовРасчета +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "План видов расчета" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если план видов расчета. +// +Функция ЭтоПолноеИмяПланаВидовРасчета(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяПланаВидовРасчета(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяРегистраСведений +
+ +Описание, пример вызова + +```bsl + +// Регистры + +// Определяет принадлежность объекта метаданных к общему типу "Регистр сведений" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина если регистр сведений. +// +Функция ЭтоПолноеИмяРегистраСведений(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяРегистраСведений(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяРегистраНакопления +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Регистр накопления" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если регистр накопления. +// +Функция ЭтоПолноеИмяРегистраНакопления(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяРегистраНакопления(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяРегистраБухгалтерии +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Регистр бухгалтерии" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если регистр бухгалтерии. +// +Функция ЭтоПолноеИмяРегистраБухгалтерии(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяРегистраБухгалтерии(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяРегистраРасчета +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к общему типу "Регистр расчета" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если регистр расчета. +// +Функция ЭтоПолноеИмяРегистраРасчета(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяРегистраРасчета(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяПерерасчета +
+ +Описание, пример вызова + +```bsl + +// Перерасчеты + +// Определяет принадлежность объекта метаданных к типу "Перерасчет" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина если перерасчет. +// +Функция ЭтоПолноеИмяПерерасчета(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяПерерасчета(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяКонстанты +
+ +Описание, пример вызова + +```bsl + +// Константы + +// Определяет принадлежность объекта метаданных к общему типу "Константа" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если константа. +// +Функция ЭтоПолноеИмяКонстанты(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяКонстанты(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяЖурналаДокументов +
+ +Описание, пример вызова + +```bsl + +// Журналы документов + +// Определяет принадлежность объекта метаданных к общему типу "Журнал документов" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если журнал документов. +// +Функция ЭтоПолноеИмяЖурналаДокументов(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяЖурналаДокументов(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяПоследовательности +
+ +Описание, пример вызова + +```bsl + +// Последовательности + +// Определяет принадлежность объекта метаданных к общему типу "Последовательности" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если последовательность. +// +Функция ЭтоПолноеИмяПоследовательности(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяПоследовательности(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяРегламентногоЗадания +
+ +Описание, пример вызова + +```bsl + +// РегламентныеЗадания + +// Определяет принадлежность объекта метаданных к общему типу "Регламентные задания" по полному имени +// объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если регламентное задание. +// +Функция ЭтоПолноеИмяРегламентногоЗадания(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяРегламентногоЗадания(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяРегистра +
+ +Описание, пример вызова + +```bsl + +// Общие + +// Определяет принадлежность объекта метаданных к типу регистр по полному имени объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если регистр. +// +Функция ЭтоПолноеИмяРегистра(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяРегистра(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяОбъектаСсылочногоТипа +
+ +Описание, пример вызова + +```bsl + +// Определяет принадлежность объекта метаданных к ссылочному типу по полному имени объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// принадлежность к заданному типу. +// +// Возвращаемое значение: +// Булево - Истина, если ссылочный тип. +// +Функция ЭтоПолноеИмяОбъектаСсылочногоТипа(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяОбъектаСсылочногоТипа(ПолноеИмя) +``` +
+ +## ЭтоПолноеИмяОбъектаСПредопределеннымиДанными +
+ +Описание, пример вызова + +```bsl + +// Определяет поддержку предопределенных данных объектом метаданных по полному имени объекта метаданных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта метаданных, для которого необходимо определить +// поддержку предопределенных данных. +// +// Возвращаемое значение: +// Булево - Истина, если объект метаданных поддерживает предопределенные данные. +// +Функция ЭтоПолноеИмяОбъектаСПредопределеннымиДанными(Знач ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоПолноеИмяОбъектаСПредопределеннымиДанными(ПолноеИмя) +``` +
+ +## ПараметрыВыборки +
+ +Описание, пример вызова + +```bsl + +// Параметры выборки по полному имени объекта метаданных. +// +// Параметры: +// ПолноеИмяОбъектаМетаданных - Строка - полное имя объекта метаданных. +// +// Возвращаемое значение: +// Структура - параметры выборки: +// * Таблица - Строка - имя объекта метаданных. +// * ИмяПоляРегистратор - Строка - имя поля регистратора. +Функция ПараметрыВыборки(Знач ПолноеИмяОбъектаМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПараметрыВыборки(ПолноеИмяОбъектаМетаданных) +``` +
+ +## СобытиеЖурналаРегистрацииКопированиеОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Имя события журнала регистрации для записи ошибок копирования области данных. +// +// Возвращаемое значение: +// Строка - имя события ошибки. +// +Функция СобытиеЖурналаРегистрацииКопированиеОбластиДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СобытиеЖурналаРегистрацииКопированиеОбластиДанных() +``` +
+ +## СобытиеЖурналаРегистрацииБлокировкаОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Имя события журнала регистрации для записи ошибок блокировки области данных. +// +// Возвращаемое значение: +// Строка - имя события ошибки. +// +Функция СобытиеЖурналаРегистрацииБлокировкаОбластиДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СобытиеЖурналаРегистрацииБлокировкаОбластиДанных() +``` +
+ +## СобытиеЖурналаРегистрацииПодготовкаОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Имя события журнала регистрации для записи ошибок подготовки области данных. +// +// Возвращаемое значение: +// Строка - имя события ошибки. +// +Функция СобытиеЖурналаРегистрацииПодготовкаОбластиДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СобытиеЖурналаРегистрацииПодготовкаОбластиДанных() +``` +
+ +## СобытиеЖурналаРегистрацииПолучениеФайлаИзХранилища +
+ +Описание, пример вызова + +```bsl + +// Имя события журнала регистрации для записи ошибок получения файла из хранилища. +// +// Возвращаемое значение: +// Строка - имя события ошибки. +// +Функция СобытиеЖурналаРегистрацииПолучениеФайлаИзХранилища() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СобытиеЖурналаРегистрацииПолучениеФайлаИзХранилища() +``` +
+ +## СобытиеЖурналаРегистрацииДобавлениеФайлаОбменЧерезФС +
+ +Описание, пример вызова + +```bsl + +// Имя события журнала регистрации для записи ошибок добавления файла при обмене через файловую систему. +// +// Возвращаемое значение: +// Строка - имя события ошибки. +// +Функция СобытиеЖурналаРегистрацииДобавлениеФайлаОбменЧерезФС() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СобытиеЖурналаРегистрацииДобавлениеФайлаОбменЧерезФС() +``` +
+ +## СобытиеЖурналаРегистрацииДобавлениеФайлаОбменНеЧерезФС +
+ +Описание, пример вызова + +```bsl + +// Имя события журнала регистрации для записи ошибок добавления файла при обмене не через файловую систему. +// +// Возвращаемое значение: +// Строка - имя события ошибки. +// +Функция СобытиеЖурналаРегистрацииДобавлениеФайлаОбменНеЧерезФС() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СобытиеЖурналаРегистрацииДобавлениеФайлаОбменНеЧерезФС() +``` +
+ +## СобытиеЖурналаРегистрацииУдалениеВременногоФайла +
+ +Описание, пример вызова + +```bsl + +// Имя события журнала регистрации для записи ошибок удаления временного файла. +// +// Возвращаемое значение: +// Строка - имя события ошибки. +// +Функция СобытиеЖурналаРегистрацииУдалениеВременногоФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СобытиеЖурналаРегистрацииУдалениеВременногоФайла() +``` +
+ +## ПриЗаполненииТаблицыПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// Прочее + +// См. РаботаВМоделиСервисаПереопределяемый.ПриЗаполненииТаблицыПараметровИБ. +// Параметры: +// ТаблицаПараметров - см. ПараметрыИБ +Процедура ПриЗаполненииТаблицыПараметровИБ(Знач ТаблицаПараметров) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ПриЗаполненииТаблицыПараметровИБ(ТаблицаПараметров) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзПроверкиУстраненияПроблемы +
+ +Описание, пример вызова + +```bsl + +// См. ОбменДаннымиПереопределяемый.ПриЗаполненииТиповИсключаемыхИзПроверкиУстраненияПроблемы. +// +// Параметры: +// Типы - См. ОбменДаннымиПереопределяемый.ПриЗаполненииТиповИсключаемыхИзПроверкиУстраненияПроблемы.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзПроверкиУстраненияПроблемы(Типы) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ПриЗаполненииТиповИсключаемыхИзПроверкиУстраненияПроблемы(Типы) +``` +
+ +## ЗаписатьПробныйФайл +
+ +Описание, пример вызова + +```bsl + +// Записывает тестовый файл на диск, возвращая его имя и размер. +// Файл должна удалять вызывающая сторона. +// +// Возвращаемое значение: +// Строка - имя пробного файла без пути. +// +Функция ЗаписатьПробныйФайл() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЗаписатьПробныйФайл() +``` +
+ +## ПриИзмененииОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Дополнительные действия, выполняемые при изменении разделения сеанса. +// +Процедура ПриИзмененииОбластиДанных() Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ПриИзмененииОбластиДанных() +``` +
+ +## ЗарегистрироватьОбработчикиПоставляемыхДанных +
+ +Описание, пример вызова + +```bsl + +// Регистрирует обработчики поставляемых данных за день и за все время. +// +// Параметры: +// Обработчики - ТаблицаЗначений - таблица обработчиков. +// +Процедура ЗарегистрироватьОбработчикиПоставляемыхДанных(Знач Обработчики) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ЗарегистрироватьОбработчикиПоставляемыхДанных(Обработчики) +``` +
+ +## ДоступныНовыеДанные +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении уведомления о новых данных. +// В теле следует проверить, необходимы ли эти данные приложению, +// и если да - установить флажок Загружать. +// +// Параметры: +// Дескриптор - ОбъектXDTO, Структура - Дескриптор. +// Загружать - Булево - Истина, если загружать, Ложь - иначе. +// ДескрипторJSON - Булево - флаг обозначающий что дескриптор пришел в формате JSON +// +Процедура ДоступныНовыеДанные(Знач Дескриптор, Загружать, Знач ДескрипторJSON = Ложь) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ДоступныНовыеДанные(Дескриптор, Загружать, ДескрипторJSON); +``` +
+ +## ДоступныНовыеДанныеJSON +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении уведомления о новых данных. +// В теле следует проверить, необходимы ли эти данные приложению, +// и если да - установить флажок Загружать. +// +// Параметры: +// Дескриптор - Структура - Дескриптор. +// Загружать - Булево - Истина, если загружать, Ложь - иначе. +// +Процедура ДоступныНовыеДанныеJSON(Знач Дескриптор, Загружать) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ДоступныНовыеДанныеJSON(Дескриптор, Загружать) +``` +
+ +## ОбработатьНовыеДанные +
+ +Описание, пример вызова + +```bsl + +// Вызывается после вызова ДоступныНовыеДанные, позволяет разобрать данные. +// +// Параметры: +// Дескриптор - ОбъектXDTO, Структура - Дескриптор. +// ПутьКФайлу - Строка - полное имя извлеченного файла. Файл будет автоматически удален +// после завершения процедуры. Если в менеджере сервиса не был +// указан файл - значение аргумента равно Неопределено. +// ДескрипторJSON - Булево - флаг обозначающий что дескриптор пришел в формате JSON +// +Процедура ОбработатьНовыеДанные(Знач Дескриптор, Знач ПутьКФайлу, Знач ДескрипторJSON = Ложь) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ОбработатьНовыеДанные(Дескриптор, ПутьКФайлу, ДескрипторJSON); +``` +
+ +## ОбработатьНовыеДанныеJSON +
+ +Описание, пример вызова + +```bsl + +// Вызывается после вызова ДоступныНовыеДанные, позволяет разобрать данные. +// +// Параметры: +// Дескриптор - Структура - Дескриптор. +// ПутьКФайлу - Строка - полное имя извлеченного файла. Файл будет автоматически удален +// после завершения процедуры. Если в менеджере сервиса не был +// указан файл - значение аргумента равно Неопределено. +// +Процедура ОбработатьНовыеДанныеJSON(Знач Дескриптор, Знач ПутьКФайлу) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ОбработатьНовыеДанныеJSON(Дескриптор, ПутьКФайлу) +``` +
+ +## ОбработкаДанныхОтменена +
+ +Описание, пример вызова + +```bsl + +// Вызывается при отмене обработки данных в случае сбоя. +// +// Параметры: +// Дескриптор - ОбъектXDTO - Дескриптор. +// +Процедура ОбработкаДанныхОтменена(Знач Дескриптор) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ОбработкаДанныхОтменена(Дескриптор) +``` +
+ +## СеансЗапущенБезРазделителей +
+ +Описание, пример вызова + +```bsl + +// Для общего модуля РаботаВМоделиСервисаПовтИсп. + +// Определяет, запущен сеанс с разделителями или без. +// +// Возвращаемое значение: +// Булево - Истина, если сеанс запущен без разделителей. +// +Функция СеансЗапущенБезРазделителей() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СеансЗапущенБезРазделителей() +``` +
+ +## ЭтоРазделеннаяКонфигурация +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак наличия в конфигурации общих реквизитов-разделителей. +// +// Возвращаемое значение: +// Булево - Истина, если это разделенная конфигурация. +// +Функция ЭтоРазделеннаяКонфигурация() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоРазделеннаяКонфигурация() +``` +
+ +## ЭтоРазделенныйОбъектМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, что объект метаданных используется в общих реквизитах-разделителях. +// +// Параметры: +// ОбъектМетаданных - Строка - имя объекта метаданных. +// Разделитель - Строка - имя общего реквизита-разделителя, на разделение которыми проверяется объект метаданных. +// +// Возвращаемое значение: +// Булево - Истина, если это разделенный объект. +// +Функция ЭтоРазделенныйОбъектМетаданных(Знач ОбъектМетаданных, Знач Разделитель = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ЭтоРазделенныйОбъектМетаданных(ОбъектМетаданных, Разделитель); +``` +
+ +## СериализуемыеСтруктурныеТипы +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив сериализуемых структурных типов, поддерживаемых в настоящее время. +// +// Возвращаемое значение: +// ФиксированныйМассив из Тип - массив из типа Тип. +// +Функция СериализуемыеСтруктурныеТипы() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СериализуемыеСтруктурныеТипы() +``` +
+ +## КонечнаяТочкаМенеджераСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает конечную точку для отправки сообщений в менеджер сервиса. +// +// Возвращаемое значение: +// ПланОбменаСсылка.ОбменСообщениями - узел соответствующий менеджеру сервиса. +// +Функция КонечнаяТочкаМенеджераСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.КонечнаяТочкаМенеджераСервиса() +``` +
+ +## СоответствиеВидовКИПользователяXDTO +
+ +Описание, пример вызова + +```bsl + +// Возвращает соответствие видов контактной информации пользователя видам. +// КИ используемой в XDTO модели сервиса. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение- соответствие видов КИ: +// * Ключ - СправочникСсылка.ВидыКонтактнойИнформации +// * Значение - Строка +// +Функция СоответствиеВидовКИПользователяXDTO() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СоответствиеВидовКИПользователяXDTO() +``` +
+ +## СоответствиеВидовКИXDTOВидамКИПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает соответствие видов контактной информации XDTO видам КИ пользователя. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение -- соответствие видов КИ: +// * Ключ - Строка +// * Значение - СправочникСсылка.ВидыКонтактнойИнформации +Функция СоответствиеВидовКИXDTOВидамКИПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СоответствиеВидовКИXDTOВидамКИПользователя() +``` +
+ +## СоответствиеПравXDTOДействиямСПользователемСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает соответствие прав XDTO используемым в модели сервиса возможным +// действиям с пользователем сервиса. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение - соответствие прав действиям: +// * Ключ - Строка +// * Значение - Строка +// +Функция СоответствиеПравXDTOДействиямСПользователемСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СоответствиеПравXDTOДействиямСПользователемСервиса() +``` +
+ +## ПолучитьМодельДанныхОбласти +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание модели данных, относящихся к области данных. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение - модель данных области: +// * Ключ - ОбъектМетаданных - объект метаданных, +// * Значение - Строка - имя общего реквизита-разделителя. +// +Функция ПолучитьМодельДанныхОбласти() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПолучитьМодельДанныхОбласти() +``` +
+ +## РазделителиКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив существующих в конфигурации разделителей. +// +// Возвращаемое значение: +// ФиксированныйМассив из Строка - массив имен общих реквизитов, которые +// являются разделителями. +// +Функция РазделителиКонфигурации() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.РазделителиКонфигурации() +``` +
+ +## СоставОбщегоРеквизита +
+ +Описание, пример вызова + +```bsl + +// Возвращает состав общего реквизита с заданным именем. +// +// Параметры: +// Имя - Строка - имя общего реквизита. +// +// Возвращаемое значение: +// СоставОбщегоРеквизита - список объектов метаданных, в которые входит общий реквизит. +// +Функция СоставОбщегоРеквизита(Знач Имя) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СоставОбщегоРеквизита(Имя) +``` +
+ +## СтатусОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает статус области данных. +// +// Параметры: +// ОбластьДанных - Число - значение разделителя области данных, +// статус которой требуется получить. +// +// Возвращаемое значение: +// ПеречислениеСсылка.СтатусыОбластейДанных - статус области данных. +// +Функция СтатусОбластиДанных(ОбластьДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СтатусОбластиДанных(ОбластьДанных) +``` +
+ +## ПараметрыИБ +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу описания параметров ИБ. +// +// Возвращаемое значение: +// ТаблицаЗначений - параметры ИБ. Содержит колонки: +// * Имя - Строка - имя параметра. +// * Описание - Строка - описание параметра для отображения в пользовательском интерфейсе. +// * ЗапретЧтения - Булево - признак невозможности считывания параметра ИБ. Может быть установлен, например, для +// паролей. +// * ЗапретЗаписи - Булево - признак невозможности изменения параметра ИБ. +// * Тип - ОписаниеТипов - тип значения параметра. Допускается использовать только примитивные типы и +// перечисления, присутствующие в управляющем приложении. +// +Функция ПараметрыИБ() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПараметрыИБ() +``` +
+ +## ДоступноИзменениеПользователей +
+ +Описание, пример вызова + +```bsl + +// Возвращает флаг доступности действий изменения пользователей. +// +// Возвращаемое значение: +// Булево - Истина, если изменение пользователей доступно, иначе Ложь. +// +Функция ДоступноИзменениеПользователей() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ДоступноИзменениеПользователей() +``` +
+ +## ИспользуемыеОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает коллекцию используемых областей данных. +// +// Возвращаемое значение: +// РезультатЗапроса - результат запроса, содержащего список областей данных. +// +Функция ИспользуемыеОбластиДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ИспользуемыеОбластиДанных() +``` +
+ +## СоздатьКлючЗаписиРегистраСведенийВспомогательныхДанных +
+ +Описание, пример вызова + +```bsl + +// Создает ключ записи для регистра сведений, включенного в состав разделителя ОбластьДанныхВспомогательныеДанные. +// +// Параметры: +// Менеджер - РегистрСведенийМенеджер - менеджер регистра сведений, для которого требуется получить ключ записи, +// ЗначенияКлюча - Структура - содержащая значения для заполнения свойств ключа записи. +// Имена элементов структуры должны соответствовать именам ключевых полей. +// +// Возвращаемое значение: +// РегистрСведенийКлючЗаписиИмяРегистраСведений - ключ записи. +// +Функция СоздатьКлючЗаписиРегистраСведенийВспомогательныхДанных(Знач Менеджер, Знач ЗначенияКлюча) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.СоздатьКлючЗаписиРегистраСведенийВспомогательныхДанных(Менеджер, ЗначенияКлюча) +``` +
+ +## УстановитьФлагАктивностиПользователяВОбласти +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак активности пользователя в текущей области. +// Признаком является значение совместно разделенной константы ДатаПоследнегоСтартаКлиентскогоСеанса. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура УстановитьФлагАктивностиПользователяВОбласти() Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.УстановитьФлагАктивностиПользователяВОбласти() +``` +
+ +## ЗаблокироватьТекущуюОбластьДанных +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать метод платформы УстановитьМонопольныйРежим(Истина). +// +// Параметры: +// ПроверитьОтсутствиеДругихСеансов - Булево - проверять отсутствие других сеансов или нет. +// РазделяемаяБлокировка - Булево - это разделяемая блокировка. +// +Процедура ЗаблокироватьТекущуюОбластьДанных(Знач ПроверитьОтсутствиеДругихСеансов = Ложь, Знач РазделяемаяБлокировка = Ложь) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ЗаблокироватьТекущуюОбластьДанных(ПроверитьОтсутствиеДругихСеансов, РазделяемаяБлокировка); +``` +
+ +## РазблокироватьТекущуюОбластьДанных +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать метод платформы УстановитьМонопольныйРежим(Ложь). +Процедура РазблокироватьТекущуюОбластьДанных() Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.РазблокироватьТекущуюОбластьДанных() +``` +
+ +## ЗаписатьВспомогательныеДанные +
+ +Описание, пример вызова + +```bsl + +// Устарела. Выполняет запись значения ссылочного типа, разделенных разделителем РазделительВспомогательныхДанных +// с переключением разделения сеанса на время записи. +// +// Параметры: +// ОбъектВспомогательныхДанных - СправочникОбъект +// - ПланВидовХарактеристикОбъект +// - ДокументОбъект - объект ссылочного типа или УдалениеОбъекта. +// +Процедура ЗаписатьВспомогательныеДанные(ОбъектВспомогательныхДанных) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ЗаписатьВспомогательныеДанные(ОбъектВспомогательныхДанных) +``` +
+ +## УдалитьВспомогательныеДанные +
+ +Описание, пример вызова + +```bsl + +// Устарела. Выполняет удаление значения ссылочного типа, разделенных разделителем РазделительВспомогательныхДанных +// с переключением разделения сеанса на время записи. +// +// Параметры: +// ОбъектВспомогательныхДанных - СправочникОбъект +// - ПланВидовХарактеристикОбъект +// - ДокументОбъект - объект ссылочного типа. +// +Процедура УдалитьВспомогательныеДанные(ОбъектВспомогательныхДанных) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.УдалитьВспомогательныеДанные(ОбъектВспомогательныхДанных) +``` +
+ +## ПолучитьФайлИзХранилища +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РаботаВМоделиСервиса.ПолучитьФайлИзХранилищаМенеджераСервиса +// Получает описание файла по его идентификатору в регистре Файлы. +// Если хранение на диске и ПутьВместоДанных = Истина, +// в выходной структуре Данные = Неопределено, ПолноеИмя = Полное имя файла, +// иначе Данные - двоичные данные файла, ПолноеИмя - Неопределено. +// Значение ключа Имя всегда содержит имя в хранилище. +// +// Параметры: +// ИдентификаторФайла - УникальныйИдентификатор - уникальный идентификатор файла, +// ПараметрыПодключения - Структура - поля: +// * URL - Строка - URL сервиса, обязательно должно присутствовать и быть заполненным, +// * UserName - Строка - имя пользователя сервиса, +// * Password - Строка - пароль пользователя сервиса, +// ПутьВместоДанных - Булево - что возвращать, +// ПроверятьСуществование - Булево - проверять ли существование файла в случае ошибки его получения. +// +// Возвращаемое значение: +// Структура - описание файла: +// * Имя - Строка - имя файла в хранилище. +// * Данные - ДвоичныеДанные - данные файла. +// * ПолноеИмя - Строка - полное имя файла (файл будет удален автоматически по истечении срока хранения временных файлов). +// +Функция ПолучитьФайлИзХранилища(Знач ИдентификаторФайла, Знач ПараметрыПодключения, Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПолучитьФайлИзХранилища(ИдентификаторФайла, ПараметрыПодключения, ); +``` +
+ +## ПоместитьФайлВХранилище +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РаботаВМоделиСервиса.ПоместитьФайлВХранилищеМенеджераСервиса +// Добавляет файл в хранилище менеджера сервиса. +// +// Параметры: +// АдресДанныеФайл - Строка, ДвоичныеДанные, Файл - Строка/ДвоичныеДанные/Файл - Адрес временного хранилища/Данные файла/Файл. +// ПараметрыПодключения - Структура - с полями: +// * URL - Строка - URL сервиса. Обязательно должно присутствовать и быть заполненным. +// * UserName - Строка - Имя пользователя сервиса. +// * Password - Строка - Пароль пользователя сервиса. +// ИмяФайла - Строка - Хранимое имя файла. +// +// Возвращаемое значение: +// УникальныйИдентификатор - идентификатор файла в хранилище. +// +Функция ПоместитьФайлВХранилище(Знач АдресДанныеФайл, Знач ПараметрыПодключения, Знач ИмяФайла = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервиса.ПоместитьФайлВХранилище(АдресДанныеФайл, ПараметрыПодключения, ИмяФайла); +``` +
+ +## ПриПроверкеБлокировкиОбластиДанныхПриЗапуске +
+ +Описание, пример вызова + +```bsl + +// Проверка заблокированности области данных при запуске. +// Только для вызова из СтандартныеПодсистемыСервер.ДобавитьПараметрыРаботыКлиентаПриЗапуске(). +// +// Параметры: +// ОписаниеОшибки - Строка - Текст с описанием ошибки +Процедура ПриПроверкеБлокировкиОбластиДанныхПриЗапуске(ОписаниеОшибки) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервиса.ПриПроверкеБлокировкиОбластиДанныхПриЗапуске(ОписаниеОшибки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВМоделиСервисаБСП.md b/src/content/docs/bsp/РаботаВМоделиСервисаБСП.md new file mode 100644 index 0000000..a5deaae --- /dev/null +++ b/src/content/docs/bsp/РаботаВМоделиСервисаБСП.md @@ -0,0 +1,60 @@ +--- +title: Работа в модели сервиса БСП +slug: bsp/работа-в-модели-сервиса-бсп +--- + + +## КонтрольНеразделенныхОбъектовПриЗаписи +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие КонтрольНеразделенныхОбъектовПриЗаписи. +// +// Параметры: +// Источник - ЛюбаяСсылка - источник события. +// Отказ - Булево - признак отказа от записи. +// +Процедура КонтрольНеразделенныхОбъектовПриЗаписи(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаБСП.КонтрольНеразделенныхОбъектовПриЗаписи(Источник, Отказ) +``` +
+ +## КонтрольНеразделенныхНаборовЗаписейПриЗаписи +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие КонтрольНеразделенныхНаборовЗаписейПриЗаписи. +// +// Параметры: +// Источник - РегистрСведенийНаборЗаписей - источник события. +// Отказ - Булево - признак отказа от записи набора в базу данных. +// Замещение - Булево - режим записи набора. Истина - запись осуществляется с заменой +// существующих в базе данных записей набора. Ложь - запись осуществляется с +// "дописыванием" текущего набора записей. +// +Процедура КонтрольНеразделенныхНаборовЗаписейПриЗаписи(Источник, Отказ, Замещение) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаБСП.КонтрольНеразделенныхНаборовЗаписейПриЗаписи(Источник, Отказ, Замещение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВМоделиСервисаБТС.md b/src/content/docs/bsp/РаботаВМоделиСервисаБТС.md new file mode 100644 index 0000000..e4a46ba --- /dev/null +++ b/src/content/docs/bsp/РаботаВМоделиСервисаБТС.md @@ -0,0 +1,38 @@ +--- +title: Работа в модели сервиса БТС +slug: bsp/работа-в-модели-сервиса-бтс +--- + + +## Подпись +
+ +Описание, пример вызова + +```bsl + +// Формирует подпись переданных данных с помощью переданного ключа алгоритмом HMAC-SHA256. +// +// Параметры: +// Ключ - ДвоичныеДанные - двоичные данные ключа подписи. +// Данные - Строка - подписываемые данные. +// +// Возвращаемое значение: +// Строка - подпись в формате Base64. +// +Функция Подпись(Ключ, Данные) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаВМоделиСервисаБТС.Подпись(Ключ, Данные) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВМоделиСервисаБТСПереопределяемый.md b/src/content/docs/bsp/РаботаВМоделиСервисаБТСПереопределяемый.md new file mode 100644 index 0000000..c8cae28 --- /dev/null +++ b/src/content/docs/bsp/РаботаВМоделиСервисаБТСПереопределяемый.md @@ -0,0 +1,66 @@ +--- +title: Работа в модели сервиса БТС переопределяемый +slug: bsp/работа-в-модели-сервиса-бтс-переопределяемый +--- + + +## УстановитьПраваПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Устанавливает пользователю права по умолчанию. +// Вызывается при работе в модели сервиса, в случае обновления в менеджере +// сервиса прав пользователя без прав администрирования. +// @skip-check module-empty-method - переопределяемый метод. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи - пользователь, +// которому требуется установить права по умолчанию. +// ДоступРазрешен - Булево - признак разрешения доступа. +// Если Истина - доступ разрешается, если Ложь - доступ запрещается. +// +Процедура УстановитьПраваПоУмолчанию(Пользователь, ДоступРазрешен = Истина) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаБТСПереопределяемый.УстановитьПраваПоУмолчанию(Пользователь, ДоступРазрешен); +``` +
+ +## УстановитьДоступКAPIОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Устанавливает пользователю права доступа к API области данных. +// Вызывается при работе в модели сервиса, в случае обновления в менеджере +// сервиса прав пользователя без прав администрирования. +// @skip-check module-empty-method - переопределяемый метод. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи - пользователь, которому требуется установить права доступа к API. +// ДоступРазрешен - Булево - признак разрешения доступа. +// Если Истина - доступ разрешается, если Ложь - доступ запрещается. +// +Процедура УстановитьДоступКAPIОбластиДанных(Пользователь, ДоступРазрешен = Истина) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаБТСПереопределяемый.УстановитьДоступКAPIОбластиДанных(Пользователь, ДоступРазрешен); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВМоделиСервисаКлиент.md b/src/content/docs/bsp/РаботаВМоделиСервисаКлиент.md new file mode 100644 index 0000000..1d7a83b --- /dev/null +++ b/src/content/docs/bsp/РаботаВМоделиСервисаКлиент.md @@ -0,0 +1,34 @@ +--- +title: Работа в модели сервиса клиент +slug: bsp/работа-в-модели-сервиса-клиент +--- + + +## ПередНачаломРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияКлиентПереопределяемый.ПередНачаломРаботыСистемы +// +// Параметры: +// Параметры - См. ОбщегоНазначенияКлиентПереопределяемый.ПередНачаломРаботыСистемы.Параметры +// +Процедура ПередНачаломРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаКлиент.ПередНачаломРаботыСистемы(Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаВМоделиСервисаПереопределяемый.md b/src/content/docs/bsp/РаботаВМоделиСервисаПереопределяемый.md new file mode 100644 index 0000000..d871d9c --- /dev/null +++ b/src/content/docs/bsp/РаботаВМоделиСервисаПереопределяемый.md @@ -0,0 +1,154 @@ +--- +title: Работа в модели сервиса переопределяемый +slug: bsp/работа-в-модели-сервиса-переопределяемый +--- + + +## ПриУдаленииОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при удалении области данных. +// В процедуре необходимо удалить данные области данных, которые не могут быть удалены стандартным механизмом. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ОбластьДанных - Число - значение разделителя удаляемой области данных. +// +Процедура ПриУдаленииОбластиДанных(Знач ОбластьДанных) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаПереопределяемый.ПриУдаленииОбластиДанных(ОбластьДанных) +``` +
+ +## ПриЗаполненииТаблицыПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// Формирует список параметров ИБ. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ТаблицаПараметров - см. РаботаВМоделиСервиса.ПараметрыИБ +// +Процедура ПриЗаполненииТаблицыПараметровИБ(Знач ТаблицаПараметров) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаПереопределяемый.ПриЗаполненииТаблицыПараметровИБ(ТаблицаПараметров) +``` +
+ +## ПриПолученииЗначенийПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед попыткой получения значений параметров ИБ из одноименных констант. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ИменаПараметров - Массив - имена параметров, значения которых необходимо получить. +// В случае если значение параметра получается в данной процедуре, +// необходимо удалить имя обработанного параметра из массива. +// ЗначенияПараметров - Структура - значения параметров. +// +Процедура ПриПолученииЗначенийПараметровИБ(Знач ИменаПараметров, Знач ЗначенияПараметров) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаПереопределяемый.ПриПолученииЗначенийПараметровИБ(ИменаПараметров, ЗначенияПараметров) +``` +
+ +## ПриУстановкеЗначенийПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед попыткой записи значений параметров ИБ в одноименные константы. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ЗначенияПараметров - Структура - значения параметров которые требуется установить. +// В случае если значение параметра устанавливается в данной процедуре из структуры необходимо удалить соответствующую +// пару КлючИЗначение. +// +Процедура ПриУстановкеЗначенийПараметровИБ(Знач ЗначенияПараметров) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаПереопределяемый.ПриУстановкеЗначенийПараметровИБ(ЗначенияПараметров) +``` +
+ +## ПриВключенииРазделенияПоОбластямДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при включении разделения данных по областям данных, +// при первом запуске конфигурации с параметром "ИнициализироватьРазделеннуюИБ" ("InitializeSeparatedIB"). +// В частности, здесь следует размещать код по включению регламентных заданий, используемых только при включенном +// разделении данных, и соответственно, по выключению заданий, используемых только при выключенном разделении данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +Процедура ПриВключенииРазделенияПоОбластямДанных() Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаПереопределяемый.ПриВключенииРазделенияПоОбластямДанных() +``` +
+ +## УстановитьПраваПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Устанавливает пользователю права по умолчанию. +// Вызывается при работе в модели сервиса, в случае обновления в менеджере +// сервиса прав пользователя без прав администрирования. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи - пользователь, которому +// требуется установить права по умолчанию. +// +Процедура УстановитьПраваПоУмолчанию(Пользователь) Экспорт +``` + +Пример вызова +```bsl +РаботаВМоделиСервисаПереопределяемый.УстановитьПраваПоУмолчанию(Пользователь) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСАдресами.md b/src/content/docs/bsp/РаботаСАдресами.md new file mode 100644 index 0000000..b535cd0 --- /dev/null +++ b/src/content/docs/bsp/РаботаСАдресами.md @@ -0,0 +1,603 @@ +--- +title: Работа с адресами +slug: bsp/работа-с-адресами +--- + + +## РегионАдресаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает наименование субъекта РФ для адреса или пустую строку, если субъект не определен. +// Если переданная строка не содержит информации об адресе, то будет вызвано исключение. +// +// Параметры: +// Адрес - Строка +// - Структура - строка в формате JSON или XML соответствующая XDTO пакету Адрес. +// +// Возвращаемое значение: +// Строка +// +Функция РегионАдресаКонтактнойИнформации(Знач Адрес) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.РегионАдресаКонтактнойИнформации(Адрес) +``` +
+ +## ГородАдресаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает наименование города для адреса РФ или пустую строку для иностранного адреса. +// Если переданная строка не содержит информации об адресе, то будет вызвано исключение. +// +// Параметры: +// Адрес - Строка +// - Структура - строка в формате JSON или строка XML соответствующая XDTO пакету Адрес. +// +// Возвращаемое значение: +// Строка +// +Функция ГородАдресаКонтактнойИнформации(Знач Адрес) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.ГородАдресаКонтактнойИнформации(Адрес) +``` +
+ +## СведенияОбАдресах +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения об адресе в виде отдельных частей адреса и различных кодов (код региона, ОКТМО и др.). +// +// Параметры: +// Адреса - Массив - адреса во внутреннем формате JSON или в XML, соответствующий XDTO-пакету Адрес +// или XDTO объектов, соответствующих XDTO-пакету Адрес. +// ДополнительныеПараметры - Структура - для уточнения возвращаемого значения. Может содержать только поля, +// отличающиеся от значений по умолчанию: +// * БезПредставлений - Булево - если Истина, то поле Представление будет отсутствовать. По умолчанию, Ложь. +// * КодыАдреса - Булево - если Истина, то результат содержит поля ИдентификаторАдресногоОбъекта, ИдентификаторДома +// и структура с кодами адреса(Идентификаторы, ДополнительныеКоды, КодыКЛАДР). +// Подробнее см. в возвращаемом значении структуры Идентификаторы и +// ДополнительныеКоды. По умолчанию, Ложь. Если в адресе отсутствуют идентификаторы +// и в программу не загружены идентификаторы адресных объектов адреса, то получение +// идентификаторов может инициировать HTTP запрос к веб-сервису 1С orgaddress. +// * КодыКЛАДР - Булево - если Истина, то возвращается структура КодыКЛАДР. По умолчанию Ложь. +// Если в адресе отсутствуют коды и в программу не загружены адресные объекты адреса, +// Получение кодов может инициировать HTTP запрос к веб-сервису 1С orgaddress. +// * НаименованиеВключаетСокращение - Булево - если Истина, то поля содержат сокращения в наименованиях адресных объектов. +// * ПроверитьАдрес - Булево - если Истина, то адрес будет проверен на соответствие адресному классификатору. По +// умолчанию, Ложь. Если в программу не загружены проверяемые адресные объекты, +// то проверка адреса может инициировать HTTP запрос к веб-сервису 1С orgaddress. +// * ПолноеНаименованиеСокращений - Булево - устаревший параметр. Следует использовать свойства свойства +// возвращаемого значения с постфиксами ТипПолный и ТипКраткий. По умолчанию, Ложь. +// +// Возвращаемое значение: +// Массив из см. РаботаСАдресами.СведенияОбАдресе +// +Функция СведенияОбАдресах(Адреса, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.СведенияОбАдресах(Адреса, ДополнительныеПараметры); +``` +
+ +## СведенияОбАдресе +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения об адресе в виде отдельных частей адреса и различных кодов (код региона, ОКТМО и др.). +// Для преобразования полученных полей адреса в во внутренний формат JSON следует использовать функцию ПоляАдресаВJSON. +// +// Параметры: +// Адрес - Строка - адрес во внутреннем формате JSON или в XML, соответствующем XDTO-пакету Адрес. +// - ОбъектXDTO - XDTO-объект, соответствующий XDTO пакету Адрес. +// - Неопределено - конструктор для получения пустых полей адреса. +// ДополнительныеПараметры - Структура - для уточнения возвращаемого значения. Может содержать только поля, +// отличающиеся от значений по умолчанию: +// * БезПредставлений - Булево - если Истина, то поле Представление будет отсутствовать. По умолчанию Ложь. +// * КодыАдреса - Булево - если Истина, то результат содержит поля ИдентификаторАдресногоОбъекта, ИдентификаторДома +// и структура с кодами адреса(Идентификаторы, ДополнительныеКоды, КодыКЛАДР). +// Подробнее см. в возвращаемом значении структуры Идентификаторы и +// ДополнительныеКоды. По умолчанию, Ложь. Если в адресе отсутствуют идентификаторы +// и в программу не загружены идентификаторы адресных объектов адреса, то получение +// идентификаторов может инициировать HTTP запрос к веб-сервису 1С orgaddress. +// * КодыКЛАДР - Булево - если Истина, то возвращается структура КодыКЛАДР. По умолчанию Ложь. +// Если в адресе отсутствуют коды и в программу не загружены адресные объекты адреса, +// Получение кодов может инициировать HTTP запрос к веб-сервису 1С orgaddress. +// * НаименованиеВключаетСокращение - Булево - если Истина, то поля содержат сокращениям в наименованиях адресных объектов. +// * ПроверитьАдрес - Булево - если Истина, то адрес будет проверен на соответствие адресному классификатору. По +// умолчанию Ложь. Если в программу не загружены проверяемые адресные объекты, +// то проверка адреса может инициировать HTTP запрос к веб-сервису 1С orgaddress. +// * ПолноеНаименованиеСокращений - Булево - устаревший параметр. Следует использовать свойства свойства +// возвращаемого значения с постфиксами ТипПолный и ТипКраткий. По умолчанию, Ложь. +// +// Возвращаемое значение: +// Структура: +// * Представление - Строка - текстовое представление адреса по административно-территориальному делению. +// * МуниципальноеПредставление - Строка - текстовое представление адреса по муниципальному делению. +// * ТипАдреса - Строка - основной тип адреса (только для адресов РФ). +// Варианты: "Муниципальный", "Административно-территориальный". +// * Страна - Строка - текстовое представление страны. +// * КодСтраны - Строка - код страны по ОКСМ. +// * Индекс - Строка - почтовый индекс. +// * КодРегиона - Строка - код региона РФ. +// * Регион - Строка - текстовое представление региона РФ. Для получения полного наименования региона +// следует использовать функцию РегионАдресаКонтактнойИнформации. +// * РегионТипПолный - Строка - полное наименование типа региона. Например: "область". +// * РегионТипКраткий - Строка - краткое наименование типа региона. Например: "обл". +// * РегионСокращение - Строка - устаревшее свойство. Сокращение региона, например: "обл", если +// ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "область", если +// ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА. +// * Округ - Строка - устаревшее свойство. Текстовое представление округа. +// * ОкругСокращение - Строка - устаревшее свойство. Сокращение округа. +// * Район - Строка - текстовое представление района у адресов по административно-территориальному делению. +// * РайонТипПолный - Строка - полное наименование типа района для адреса по административно-территориальному +// делению. Например: "район". +// * РайонТипКраткий - Строка - краткое наименование типа района для адреса по административно-территориальному +// делению. Например: "р-н". +// * РайонСокращение - Строка - устаревшее свойство. Сокращение района для адреса по +// административно-территориальному делению, например: "р-н", если +// ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "район", если +// ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА. +// * МуниципальныйРайон - Строка - текстовое представление муниципального района для адреса по муниципальному делению. +// * МуниципальныйРайонТипПолный - Строка - полное наименование типа муниципального района по муниципальному +// делению. Например: "городской округ". +// * МуниципальныйРайонТипКраткий - Строка - краткое наименование типа муниципального района для адреса по +// муниципальному делению. Например: "мун.р-н". +// * МуниципальныйРайонСокращение - Строка - устаревшее свойство. Сокращение муниципального района для адреса по +// муниципальному делению, например: "мун.р-н", если +// ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или +// "муниципальный район", если +// ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА. +// * КодМуниципальногоРайона - Строка - код муниципального района: +// 1- муниципальный район; 2- городской округ; 3 - внутригородская территория +// города федерального значения; 4 - муниципальный округ; +// 5 - федеральная территория. +// Если не удалось определить код, то возвращается пустая строка. +// * Город - Строка - текстовое представление города у адресов по административно-территориальному делению. +// * ГородТипПолный - Строка - полное наименование типа города у адресов по административно-территориальному делению. +// * ГородТипКраткий - Строка - текстовое представление города у адресов по административно-территориальному делению. +// * ГородСокращение - Строка - сокращение города у адресов по административно-территориальному делению. +// * Поселение - Строка - текстовое представление поселения у адресов по муниципальному делению. +// * ПоселениеТипПолный - Строка - полное наименование типа сельского поселения по муниципальному делению. +// Например: "сельское поселение". +// * ПоселениеТипКраткий - Строка - краткое наименование типа муниципального района для адреса по муниципальному +// делению. Например: "с. п.". +// * ПоселениеСокращение - Строка - устаревшее свойство. Сокращение сельского поселения для адреса по +// муниципальному делению, например: "с. п.", если +// ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "сельское +// поселение", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА +// * КодПоселения - Строка - код поселения: 1 - городское поселение; 2 - сельское поселение; 3- межселенная +// территория в составе муниципального района; 4 - внутригородской район городского округа; +// * ВнутригородскойРайон - Строка - текстовое представление внутригородского района. +// * ВнутригородскойРайонТипПолный - Строка - полное наименование типа внутригородского района. Например: "микрорайон". +// * ВнутригородскойРайонТипКраткий - Строка - краткое наименование типа внутригородского района. Например: "мкр". +// * ВнутригородскойРайонСокращение - Строка - устаревшее свойство. Сокращение внутригородского района, например: +// "мкр", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = +// ЛОЖЬ, или "микрорайон", если +// ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА +// * НаселенныйПункт - Строка - текстовое представление населенного пункта. +// * НаселенныйПунктТипПолный - Строка - полное наименование типа населенного пункта. Например: "деревня". +// * НаселенныйПунктТипКраткий - Строка - краткое наименование типа населенного пункта. Например: "д". +// * НаселенныйПунктСокращение - Строка - устаревшее свойство. Сокращение населенного пункта, например: "д", +// если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, +// или "деревня", если +// ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА +// * Территория - Строка - текстовое представление территории. +// * ТерриторияТипПолный - Строка - полное наименование типа территории. Например: "Гаражно-строительный кооп.". +// * ТерриторияТипКраткий - Строка - краткое наименование типа территории. Например: "гск". +// * ТерриторияСокращение - Строка - устаревшее свойство. Сокращение населенного пункта, например: "гск", +// если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, +// или "Гаражно-строительный кооп.", если +// ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА +// * Улица - Строка - текстовое представление улицы. +// * УлицаТипПолный - Строка - полное наименование типа улицы. Например: "Улица". +// * УлицаТипКраткий - Строка - краткое наименование типа улицы. Например: "ул". +// * УлицаСокращение - Строка - устаревшее свойство. Сокращение улицы, например: "гск", +// если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, +// или "Улица", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА +// * ДополнительнаяТерритория - Строка - устаревшее свойство. Текстовое представление дополнительной территории. +// * ДополнительнаяТерриторияСокращение - Строка - устаревшее свойство. Сокращение дополнительной территории. +// * ЭлементДополнительнойТерритории - Строка - устаревшее свойство. Текстовое представление элемента +// дополнительной территории. +// * ЭлементДополнительнойТерриторииСокращение - Строка - устаревшее свойство. Сокращение элемента дополнительной +// территории. +// * Здание - Структура - структура с информацией о здании адреса: +// ** ТипЗдания - Строка - тип объекта адресации адреса РФ согласно приказу Минфина России от 5.11.2015 г. N171н. +// ** Номер - Строка - текстовое представление номера дома (только для адресов РФ). +// * Корпуса - Массив - содержит структуры (поля структуры: ТипКорпуса, Номер) с перечнем корпусов адреса. +// * Помещения - Массив - содержит структуры (поля структуры: ТипПомещения, Номер) с перечнем помещений адреса. +// * НомерЗемельногоУчастка - Строка - текстовое представление номера земельного участка (только для адресов РФ). +// * Комментарий - Строка - комментарий об адресе. +// * ИдентификаторАдресногоОбъекта - УникальныйИдентификатор - идентификационный код последнего адресного объекта +// в иерархи адреса. Например, для адреса: Москва г., Дмитровское ш., д.9 это +// будет идентификатор улицы. +// Поле отсутствует, если дополнительный параметр КодыАдреса равен Ложь. +// * ИдентификаторДома - УникальныйИдентификатор - идентификационный код дома(строения) адресного объекта. +// Поле отсутствует, если дополнительный параметр КодыАдреса равен Ложь. +// Пустая строка если значение отсутствует. +// * ИдентификаторЗемельногоУчастка - УникальныйИдентификатор - идентификационный код земельного участка +// адресного объекта. При отсутствии значения - пустая строка. +// * Идентификаторы - Структура - где: +// Идентификаторы адресных объектов адреса, если установлен параметр КодыАдреса +// или КодыКЛАДР. Поле отсутствует, если дополнительный параметр КодыАдреса или +// КодыКЛАДР равен Ложь: +// ** Регион - УникальныйИдентификатор - идентификатор региона. +// ** Район - УникальныйИдентификатор - идентификатор района. +// ** МуниципальныйРайон - УникальныйИдентификатор - идентификатор муниципального района. +// ** Город - УникальныйИдентификатор - идентификатор города. +// ** Поселение - УникальныйИдентификатор - идентификатор поселения. +// ** ВнутригородскойРайон - УникальныйИдентификатор - идентификатор внутригородского района. +// ** НаселенныйПункт - УникальныйИдентификатор - идентификатор населенного пункта. +// ** Территория - УникальныйИдентификатор - идентификатор территории. +// ** Улица - УникальныйИдентификатор - идентификатор улица. +// * КодыКЛАДР - Структура - коды КЛАДР, если параметр КодыКЛАДР установлен в Истина. Где: +// ** Регион - Строка - код КЛАДР региона. +// ** Район - Строка - код КЛАДР район. +// ** Город - Строка - код КЛАДР города. +// ** НаселенныйПункт - Строка - код КЛАДР населенного пункта. +// ** Улица - Строка - код КЛАДР улицу. +// * ДополнительныеКоды - Структура - коды ОКТМО, ОКТМОБюджетополучателя, ОКАТО, +// КодИФНСФЛ, КодИФНСЮЛ, КодУчасткаИФНСФЛ, КодУчасткаИФНСЮЛ. +// Поле отсутствует, если дополнительный параметр КодыАдреса равен Ложь. +// * РезультатПроверкиАдреса - Строка - "Успех", если адрес корректный, "Ошибка" - при наличии ошибок проверки, +// "Отказ", если не удалось проверить адрес, т.к. недоступен классификатор. +// Пустая строка, если в параметре ДополнительныеПараметры.ПроверитьАдрес не +// установлен флаг ПроверитьАдрес. +// * ОшибкиПроверкиАдреса - Строка - описание ошибок в адресе, выявленных в ходе проверки. +// +Функция СведенияОбАдресе(Адрес, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.СведенияОбАдресе(Адрес, ДополнительныеПараметры); +``` +
+ +## СведенияОбАдресеПриказМинфинаРФ171н +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения об адресе в виде отдельных частей адреса и различных кодов (код региона, ОКТМО и др.), где +// типы адресных объектов (свойство ТипКраткий), типы домов, зданий и помещений соответствуют приказу Минфина РФ N 171н. +// +// Параметры: +// Адрес - Строка - адрес во внутреннем формате JSON или в XML, соответствующем XDTO-пакету Адрес. +// - см. РаботаСАдресами.СведенияОбАдресе +// ДополнительныеПараметры - см. РаботаСАдресами.СведенияОбАдресе.ДополнительныеПараметры +// +// Возвращаемое значение: +// см. РаботаСАдресами.СведенияОбАдресе +// +Функция СведенияОбАдресеПриказМинфинаРФ171н(Адрес, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.СведенияОбАдресеПриказМинфинаРФ171н(Адрес, ДополнительныеПараметры); +``` +
+ +## ПроверитьАдрес +
+ +Описание, пример вызова + +```bsl + +// Проверяет адрес на соответствие требованиям к адресной информации. +// +// Параметры: +// Адрес - Строка - строка JSON или XML контактной информации, соответствующая XDTO-пакету КонтактнаяИнформация. +// ПараметрыПроверки - Структура +// - СправочникСсылка.ВидыКонтактнойИнформации - флаги проверки адреса: +// ТолькоНациональныйАдрес - Булево - адрес должен быть только российским. По умолчанию Истина. +// ФорматАдреса - Строка - устарело. По какому классификатору проверять. +// Возвращаемое значение: +// Структура: +// * Результат - Строка - результат проверки: "Корректный", "НеПроверен", "СодержитОшибки". +// * СписокОшибок - СписокЗначений - информация о ошибках. +// +Функция ПроверитьАдрес(Знач Адрес, ПараметрыПроверки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.ПроверитьАдрес(Адрес, ПараметрыПроверки); +``` +
+ +## ПроверитьАдреса +
+ +Описание, пример вызова + +```bsl + +// Проверяет адреса на соответствие адресному классификатору и для устаревших адресов возвращает актуальные варианты. +// Если адресные сведения региона адреса не загружены в программу, то проверка адреса будет +// выполнена через веб-сервис orgaddress и может занимать до 120 секунд. +// Поэтому для исключения зависаний пользовательского интерфейса, например при открытии формы, +// функцию следует вызвать в фоновом задании. +// +// Параметры: +// Адреса - Соответствие из КлючИЗначение: +// * Ключ - Число - уникальный идентификатор адреса; +// * Значение - Строка - проверяемый адрес во внутреннем формате JSON. +// В целях обратной совместимости допускается передача адреса в виде XML, +// соответствующем XDTO-пакету Адрес (HTTP://www.v8.1c.ru/ssl/contactinfo), +// но это негативно сказывается на времени выполнения функции. +// ДополнительныеПараметры - Структура: +// * ПроверятьУстареваниеАдресов - Булево - если адрес устарел, то свойство АктуальныеАдреса будут содержать актуальные +// варианты адреса. Для загруженных регионов адресного классификатора должна быть загружена +// история изменений адресных сведений. По умолчанию, Ложь. +// * ВключатьСтрануВПредставление - Булево - в поле Представление у свойства АктуальныеАдреса включать страну +// в представление актуального адреса. По умолчанию, Ложь. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Число - уникальный идентификатор адреса; +// * Значение - Структура: +// * АдресПроверен - Булево - признак, что адрес был проверен в классификаторе или через веб-сервис. +// * АдресКорректный - Булево - признак, что адрес соответствует адресному классификатору. Устаревшие адреса +// считаются некорректными. +// * Ошибки - Массив из Строка - список ошибок в адресе. +// * АктуальныеАдреса - Массив из Структура - где: +// Если адрес устарел, то содержит варианты актуального адреса в виде полей адреса, где: +// * Представление - Строка - представление актуального варианта адреса; +// * Адрес - Строка - адрес во внутреннем формате JSON. +// +Функция ПроверитьАдреса(Знач Адреса, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.ПроверитьАдреса(Адреса, ДополнительныеПараметры); +``` +
+ +## ПоляАдресаВJSON +
+ +Описание, пример вызова + +```bsl + +// Преобразует структуру полей адреса, полученную функций СведенияОбАдресе или +// РаботаСАдресамиКлиентСервер.ПоляАдреса во внутренний формат хранения контактной информации JSON. +// +// +// Параметры: +// ПоляАдреса - см. РаботаСАдресамиКлиентСервер.ПоляАдреса. +// +// Возвращаемое значение: +// Строка - адрес во внутреннем формате JSON. +// +Функция ПоляАдресаВJSON(ПоляАдреса) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.ПоляАдресаВJSON(ПоляАдреса) +``` +
+ +## АдресПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Возвращает адрес в виде строки XML в соответствии со структурой XDTO КонтактнаяИнформация и Адрес. +// +// Параметры: +// ИдентификаторАдреса - Строка - глобальный уникальный идентификационный код адресного объекта. +// ДополнительнаяИнформацияАдреса - Структура - поля адреса, которые будет добавлены в адрес: +// * АдресВJSON - Булево - возвращает адрес в формате JSON. +// * ДополнительнаяИнформация - Строка - комментарий адреса. +// * Страна - Строка - наименование страны адреса. +// * НомерДома - Строка - номер дома. +// * НомерОфиса - Строка - номер офиса. +// * НомерСтроения - Строка - номер строения. +// * ПочтовыйИндекс - Строка - почтовый индекс адреса. +// * АбонентскийЯщик - Строка - абонентский ящик адреса. +// * Муниципальный - Булево - если Истина, адрес будет сформирован в муниципальном формате. +// По умолчанию Ложь. +// +// Возвращаемое значение: +// Строка - XML в соответствии со структурой XDTO пакетов КонтактнаяИнформация и Адрес. +// JSON, если в ДополнительнаяИнформацияАдреса параметр АдресВJSON установлен в Истина. +// Неопределено - если не удалось сформировать адрес по идентификатору. +// +Функция АдресПоИдентификатору(ИдентификаторАдреса, ДополнительнаяИнформацияАдреса = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.АдресПоИдентификатору(ИдентификаторАдреса, ДополнительнаяИнформацияАдреса); +``` +
+ +## СокращенияОбъектовАдресацииАдресаРФ +
+ +Описание, пример вызова + +```bsl + +// Возвращает общепринятые сокращения адресных объектов. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - полное наименование адресного объекта. Например, "Дом", "Квартира". +// * Значение - Строка - сокращенное наименование адресного объекта. Например, "Д.", "Кв." +// +Функция СокращенияОбъектовАдресацииАдресаРФ() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.СокращенияОбъектовАдресацииАдресаРФ() +``` +
+ +## ПредыдущийФорматКонтактнойИнформацииXML +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РаботаСАдресами.СведенияОбАдресе. +// Преобразует данные формата XML в предыдущий формат контактной информации. +// +// Параметры: +// Данные - Строка - строка XML соответствующая XDTO пакету Адрес. +// СокращенныйСоставПолей - Булево - если Ложь, то из состава полей будут исключены +// поля, отсутствующие в версиях БСП младше 2.1.3. +// +// Возвращаемое значение: +// Строка - набор пар ключ-значение, разделенных переносом строки. +// +Функция ПредыдущийФорматКонтактнойИнформацииXML(Знач Данные, Знач СокращенныйСоставПолей = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.ПредыдущийФорматКонтактнойИнформацииXML(Данные, СокращенныйСоставПолей); +``` +
+ +## ПредыдущаяСтруктураКонтактнойИнформацииXML +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РаботаСАдресами.СведенияОбАдресе. +// Преобразует данные нового формата XML контактной информации в структуру старого формата. +// +// Параметры: +// Данные - Строка - строка XML соответствующая XDTO пакету Адрес. +// ВидКонтактнойИнформации - СправочникСсылка.ВидыКонтактнойИнформации +// - Структура - параметры контактной информации: +// * Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// +// Возвращаемое значение: +// Структура - состав свойств для адреса: +// * Страна - Строка - представление страны. +// * КодСтраны - Строка - код страны по ОКСМ. +// * Индекс - Строка - почтовый индекс (только для адресов РФ). +// * Регион - Строка - представление региона РФ (только для адресов РФ). +// * КодРегиона - Строка - код региона РФ (только для адресов РФ). +// * РегионСокращение - Строка - сокращение региона (если СтарыйСоставПолей = Ложь). +// * Район - Строка - представление района (только для адресов РФ). +// * РайонСокращение - Строка - сокращение района (если СтарыйСоставПолей = Ложь). +// * Город - Строка - представление города (только для адресов РФ). +// * ГородСокращение - Строка - сокращение города (только для адресов РФ). +// * НаселенныйПункт - Строка - представление населенного пункта (только для адресов РФ). +// * НаселенныйПунктСокращение - Строка - сокращение населенного пункта (если СтарыйСоставПолей = Ложь). +// * Улица - Строка - представление улицы (только для адресов РФ). +// * УлицаСокращение - Строка - сокращение улицы (если СтарыйСоставПолей = Ложь). +// * ТипДома - см. РаботаСАдресами.ТипыОбъектовАдресацииАдресаРФ. +// * Дом - Строка - представление дома (только для адресов РФ). +// * ТипКорпуса - см. РаботаСАдресами.ТипыОбъектовАдресацииАдресаРФ. +// * Корпус - Строка - представление корпуса (только для адресов РФ). +// * ТипКвартиры - см. РаботаСАдресами.ТипыОбъектовАдресацииАдресаРФ. +// * Квартира - Строка - представление квартиры (только для адресов РФ). +// Состав свойств для телефона: +// * КодСтраны - Строка - код страны. Например, +7. +// * КодГорода - Строка - код города. Например, 495. +// * НомерТелефона - Строка - номер телефона. +// * Добавочный - Строка - добавочный номер телефона. +// +Функция ПредыдущаяСтруктураКонтактнойИнформацииXML(Знач Данные, Знач ВидКонтактнойИнформации = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.ПредыдущаяСтруктураКонтактнойИнформацииXML(Данные, ВидКонтактнойИнформации); +``` +
+ +## АдресВФорматеКЛАДР +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РаботаСАдресами.СведенияОбАдресе. +// Преобразует адреса формата XML в адрес формата КЛАДР. +// +// Параметры: +// Данные - Строка - строка XML соответствующая XDTO пакету Адрес. +// +// Возвращаемое значение: +// Структура - набор пар ключ-значение. Состав свойств для адреса: +// * Страна - Строка - представление страны. +// * КодСтраны - Строка - код страны по ОКСМ. +// * Индекс - Строка - почтовый индекс (только для адресов РФ). +// * Регион - Строка - представление региона РФ (только для адресов РФ). +// * КодРегиона - Строка - код региона РФ (только для адресов РФ). +// * РегионСокращение - Строка - сокращение региона. +// * Район - Строка - представление района (только для адресов РФ). +// * РайонСокращение - Строка - сокращение района. +// * Город - Строка - представление города (только для адресов РФ). +// * ГородСокращение - Строка - сокращение города (только для адресов РФ). +// * НаселенныйПункт - Строка - представление населенного пункта (только для адресов РФ). +// * НаселенныйПунктСокращение - Строка - сокращение населенного пункта. +// * Улица - Строка - представление улицы (только для адресов РФ). +// * УлицаСокращение - Строка - сокращение улицы. +// * ТипДома - см. РаботаСАдресами.ТипыОбъектовАдресацииАдресаРФ. +// * Дом - Строка - представление дома (только для адресов РФ). +// * ТипКорпуса - см. РаботаСАдресами.ТипыОбъектовАдресацииАдресаРФ. +// * Корпус - Строка - представление корпуса (только для адресов РФ). +// * ТипКвартиры - см. РаботаСАдресами.ТипыОбъектовАдресацииАдресаРФ. +// * Квартира - Строка - представление квартиры (только для адресов РФ). +// * АдресРФ - Булево - если Истина, то адрес российский. +// * Представление - Строка - представление адреса. +// +Функция АдресВФорматеКЛАДР(Знач Данные) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресами.АдресВФорматеКЛАДР(Данные) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСАдресамиКлиентСервер.md b/src/content/docs/bsp/РаботаСАдресамиКлиентСервер.md new file mode 100644 index 0000000..e99feb4 --- /dev/null +++ b/src/content/docs/bsp/РаботаСАдресамиКлиентСервер.md @@ -0,0 +1,178 @@ +--- +title: Работа с адресами клиент сервер +slug: bsp/работа-с-адресами-клиент-сервер +--- + + +## ПоляАдреса +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру полей адреса для программного формирования адреса. +// +// Возвращаемое значение: +// Структура: +// * Представление - Строка - текстовое представление адреса по административно-территориальному делению. +// Например, "175430, Новгородская обл, Валдайский р-н, Бор д, Полевая ул, дом 4". +// * МуниципальноеПредставление - Строка - текстовое представление адреса по муниципальному делению. +// Например, "175430, Новгородская обл, Валдайский муниципальный район, сельское +// поселение Никулинское, Бор д, Полевая ул, дом 4". +// * ТипАдреса - Строка - основной тип адреса (только для адресов РФ). +// Варианты: "Муниципальный", "Административно-территориальный". +// * Страна - Строка - текстовое представление страны. Например, "Россия". +// * КодСтраны - Строка - код страны по ОКСМ. Например, "643". +// * Индекс - Строка - почтовый индекс. Например, "12700". +// * КодРегиона - Строка - код региона РФ. Например, "50". +// * Регион - Строка - текстовое представление региона РФ. Например, "Московская" +// * РегионТипПолный - Строка - тип региона. Например, "область". +// * РегионТипКраткий - Строка - сокращение региона. Например, "обл". +// * РегионСокращение - Строка - устарело. Сокращение региона. Например, "обл". +// * Округ - Строка - устарело. Текстовое представление округа (устарело). +// * ОкругСокращение - Строка - устарело. Сокращение округа (устарело). +// * Район - Строка - текстовое представление района у адресов по административно-территориальному +// делению. Например, "Валдайский". +// * РайонТипПолный - Строка - тип района у адресов по административно-территориальному делению. Например, "район". +// * РайонТипКраткий - Строка - сокращение района у адресов по административно-территориальному делению. Например, "р-н". +// * РайонСокращение - Строка - устарело. Сокращение района у адресов по административно-территориальному делению. +// Например, "р-н". +// * МуниципальныйРайон - Строка - текстовое представление муниципального района у адресов по муниципальному делению. +// Например, "Валдайский". +// * МуниципальныйРайонТипПолный - Строка - тип муниципального района у адресов по муниципальному делению. +// Например, "муниципальный район". +// * МуниципальныйРайонТипКраткий - Строка - сокращение муниципального района у адресов по муниципальному делению. +// Например, "м.р-н". +// * МуниципальныйРайонСокращение - Строка - устарело. Сокращение муниципального района у адресов по муниципальному делению. +// Например, "м.р-н". +// * Город - Строка - текстовое представление города у адресов по административно-территориальному +// делению. Например, "Валдай". +// * ГородТипПолный - Строка - тип города. Например, "город". +// * ГородТипКраткий - Строка - сокращение типа города. Например, "г". +// * ГородСокращение - Строка - устарело. Сокращение типа города. Например, "г". +// * Поселение - Строка - текстовое представление поселения у адресов по муниципальному делению. Например, +// "сельское поселение Никулинское". +// * ПоселениеТипПолный - Строка - тип поселения у адресов по муниципальному делению. Например, "сельское поселение"; +// * ПоселениеТипКраткий - Строка - сокращение типа поселения у адресов по муниципальному делению. Например, "с.п."; +// * ПоселениеСокращение - Строка - устарело. Сокращение поселения у адресов по муниципальному делению. Например, "с.п."; +// * ВнутригородскойРайон - Строка - устарело. Текстовое представление внутригородского района. Например, "Центральный" +// * ВнутригородскойРайонТипПолный - Строка - устарело. Тип внутригородского района. Например, "микрорайон"; +// * ВнутригородскойРайонТипКраткий - Строка - устарело. Сокращение типа внутригородского района. Например, "мкр"; +// * ВнутригородскойРайонСокращение - Строка - устарело. Сокращение внутригородского района. Например, "мкр"; +// * НаселенныйПункт - Строка - текстовое представление населенного пункта. Например, "Бор". +// * НаселенныйПунктТипПолный - Строка - тип населенного пункта. Например, "деревня". +// * НаселенныйПунктТипКраткий - Строка - сокращение типа населенного пункта. Например, "д". +// * НаселенныйПунктСокращение - Строка - устарело. Сокращение населенного пункта. Например, "д". +// * Территория - Строка - текстовое представление территории. Например, "Мотор". +// * ТерриторияТипПолный - Строка -тип территории. Например, "территория". +// * ТерриторияТипКраткий - Строка - сокращение территории. Например, "тер". +// * ТерриторияСокращение - Строка - устарело. Сокращение территории. Например, "тер". +// * Улица - Строка - текстовое представление улицы. Например "Полевая". +// * УлицаТипПолный - Строка - тип улицы. Например "улица". +// * УлицаТипКраткий - Строка - сокращение типа улицы. Например "ул". +// * УлицаСокращение - Строка - устарело. Сокращение улицы. Например "ул". +// * ДополнительнаяТерритория - Строка - текстовое представление дополнительной территории (устарело). +// * ДополнительнаяТерриторияСокращение - Строка - сокращение дополнительной территории (устарело). +// * ЭлементДополнительнойТерритории - Строка - текстовое представление элемента дополнительной территории (устарело). +// * ЭлементДополнительнойТерриторииСокращение - Строка - сокращение элемента дополнительной территории (устарело). +// * Здание - Структура - структура с информацией о здании адреса: +// ** ТипЗдания - Строка - тип объекта адресации адреса РФ согласно приказу Минфина России от 5.11.2015 г. N171н. +// ** Номер - Строка - текстовое представление номера дома (только для адресов РФ). +// * Корпуса - Массив из Структура - содержит список корпусов и строений адреса: +// * ТипКорпуса - Строка - наименование строения корпуса. Например, "Строение". +// * Номер - Строка - номер строения или корпуса. Например, "1". +// * Помещения - Массив из Структура: +// * ТипПомещения - Строка - наименование помещения. Например, "Офис" +// * Номер - Строка - номер помещения. Например, "1". +// * НомерЗемельногоУчастка - Неопределено +// - Строка - текстовое представление номера участка. Например, "10". +// * ИдентификаторАдресногоОбъекта - УникальныйИдентификатор - идентификационный код последнего адресного объекта +// в иерархи адреса. Например, для адреса: Москва г., Дмитровское ш., д.9 это +// будет идентификатор улицы. Например, "8fe5e839-24c8-4500-bea8-a81a55a0fd1e". +// * ИдентификаторДома - УникальныйИдентификатор - идентификационный код дома(строения) адресного объекта. +// Например, "bc26bdef-12be-40f8-959c-2149de1911b9". +// * ИдентификаторЗемельногоУчастка - Неопределено +// - УникальныйИдентификатор - идентификационный код земельного участка. +// * Идентификаторы - Структура - идентификаторы адресных объектов адреса: +// ** РегионИдентификатор - УникальныйИдентификатор +// - Неопределено - идентификатор региона. +// ** РайонИдентификатор - УникальныйИдентификатор +// - Неопределено - идентификатор района. +// ** МуниципальныйРайонИдентификатор - УникальныйИдентификатор +// - Неопределено - идентификатор муниципального района. +// ** ГородИдентификатор - УникальныйИдентификатор +// - Неопределено - идентификатор города. +// ** ПоселениеИдентификатор - УникальныйИдентификатор +// - Неопределено - идентификатор поселения. +// ** ВнутригородскойРайонИдентификатор - УникальныйИдентификатор +// - Неопределено - идентификатор +// внутригородского района. +// ** НаселенныйПунктИдентификатор - УникальныйИдентификатор +// - Неопределено - идентификатор населенного пункта. +// ** ТерриторияИдентификатор - УникальныйИдентификатор +// - Неопределено - идентификатор территории. +// ** УлицаИдентификатор - УникальныйИдентификатор +// - Неопределено - идентификатор улица. +// * КодыКЛАДР - Структура - коды КЛАДР, если установлен параметр КодыКЛАДР. Например, "53004000040000200": +// ** Регион - Строка - код КЛАДР региона. +// ** Район - Строка - код КЛАДР район. +// ** Город - Строка - код КЛАДР города. +// ** НаселенныйПункт - Строка - код КЛАДР населенного пункта. +// ** Улица - Строка - код КЛАДР улицы. +// * ДополнительныеКоды - Структура: +// ** ОКТМО - Строка - код общероссийского классификатора территорий муниципальных образований. Например, "45346000". +// ** ОКАТО - Строка - код общероссийского классификатора административно-территориальных образований. Например, "45277592000". +// ** КодИФНСФЛ - Строка - код налоговых инспекции физических лиц. Например, "7713" +// ** КодИФНСЮЛ - Строка - код налоговых инспекции юридических лиц. Например, "7713" +// ** КодУчасткаИФНСФЛ - Строка - код участка налоговой инспекции физических лиц. Например, "7713" +// ** КодУчасткаИФНСЮЛ - Строка - код участка налоговой инспекции юридических лиц. Например, "7713" +// * Комментарий - Строка - комментарий к адресу. +// * ДополнительнаяИнформация - Строка - текстовое представление дополнительной информации. +// +Функция ПоляАдреса() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресамиКлиентСервер.ПоляАдреса() +``` +
+ +## СтруктураКонтактнойИнформацииПоТипу +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обратная совместимость. + +// Устарела. Оставленная для обратной совместимости. Возвращает структуру контактной информации по типу. +// Для получения полей адреса следует использовать РаботаСАдресамиКлиентСервер.ПоляАдреса. +// Для получения полей телефона следует использовать УправлениеКонтактнойИнформацией.СведенияОТелефоне. +// +// Параметры: +// ТипКИ - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// ФорматАдреса - Строка - тип возвращаемой структуры в зависимости от формата адреса. +// +// Возвращаемое значение: +// Структура - пустая структура контактной информации, ключи - имена полей, значения поля. +// +Функция СтруктураКонтактнойИнформацииПоТипу(ТипКИ, ФорматАдреса = "КЛАДР") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСАдресамиКлиентСервер.СтруктураКонтактнойИнформацииПоТипу(ТипКИ, ФорматАдреса); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСБанками.md b/src/content/docs/bsp/РаботаСБанками.md new file mode 100644 index 0000000..ad10ca8 --- /dev/null +++ b/src/content/docs/bsp/РаботаСБанками.md @@ -0,0 +1,108 @@ +--- +title: Работа с банками +slug: bsp/работа-с-банками +--- + + +## СведенияБИК +
+ +Описание, пример вызова + +```bsl + +// Предоставляет данные из Справочника БИК. +// +// Параметры: +// БИК - Строка - банковский идентификационный код. +// КоррСчет - Строка - корреспондентский счет банка. +// ТолькоАктуальные - Булево - если Истина, то в результат поиска включаются только действующих участники расчетов. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Ссылка - СправочникСсылка.КлассификаторБанков +// * БИК - Строка +// * КоррСчет - Строка +// * Наименование - Строка +// * Город - Строка +// * Адрес- Строка +// * Телефоны - Строка +// * ИНН - Строка +// * ДеятельностьПрекращена - Булево +// * СВИФТБИК - Строка +// * МеждународноеНаименование - Строка +// * ГородМеждународный - Строка +// * АдресМеждународный - Строка +// * Страна - Строка, СправочникСсылка.СтраныМира +// * БИКРКЦ - Строка +// * НаименованиеРКЦ - Строка +// * КоррСчетРКЦ - Строка +// * ГородРКЦ - Строка +// * АдресРКЦ - Строка +// * ИННРКЦ - Строка +// +Функция СведенияБИК(Знач БИК, Знач КоррСчет = Неопределено, ТолькоАктуальные = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСБанками.СведенияБИК(БИК, КоррСчет, ТолькоАктуальные); +``` +
+ +## ПояснениеНедействительногоБанка +
+ +Описание, пример вызова + +```bsl + +// Возвращает текстовое описание причины, по которой банк отмечен как недействительный. +// +// Параметры: +// Банк - СправочникСсылка.КлассификаторБанков - банк, для которого необходимо получить текст пояснения. +// +// Возвращаемое значение: +// ФорматированнаяСтрока - пояснение. +// +Функция ПояснениеНедействительногоБанка(Банк) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСБанками.ПояснениеНедействительногоБанка(Банк) +``` +
+ +## ПолучитьДанныеКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать СведенияБИК. +// Получает данные из справочника КлассификаторБанков по значениям БИК и корреспондентского счета банка. +// +// Параметры: +// БИК - Строка - банковский идентификационный код. +// КоррСчет - Строка - корреспондентский счет банка. +// ЗаписьОБанке - СправочникСсылка +// - Строка - (возвращаемый) найденный банк. +// +Процедура ПолучитьДанныеКлассификатора(БИК = "", КоррСчет = "", ЗаписьОБанке = "") Экспорт +``` + +Пример вызова +```bsl +РаботаСБанками.ПолучитьДанныеКлассификатора(БИК, КоррСчет, ЗаписьОБанке); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСБанкамиКлиент.md b/src/content/docs/bsp/РаботаСБанкамиКлиент.md new file mode 100644 index 0000000..069cf57 --- /dev/null +++ b/src/content/docs/bsp/РаботаСБанкамиКлиент.md @@ -0,0 +1,41 @@ +--- +title: Работа с банками клиент +slug: bsp/работа-с-банками-клиент +--- + + +## ВыбратьИзСправочникаБИК +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора Справочника БИК с отбором по переданному БИК. +// Если в списке выбора единственная запись, то выбор в форме осуществляется автоматически. +// +// Параметры: +// БИК - Строка - банковский идентификационный код. +// Форма - ФормаКлиентскогоПриложения - форма, из которой открывается форма выбора. +// ОбработчикОповещения - ОписаниеОповещения - процедура, в которую передается управление после осуществления выбора. +// Если параметр не указан, то будет вызван стандартный обработчик выбора. +// Параметры процедуры: +// * БИК - СправочникСсылка.КлассификаторБанков - выбранный элемент. +// * ДополнительныеПараметры - Произвольный - параметр, переданный в конструкторе описания оповещения. +// +Процедура ВыбратьИзСправочникаБИК(БИК, Форма, ОбработчикОповещения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСБанкамиКлиент.ВыбратьИзСправочникаБИК(БИК, Форма, ОбработчикОповещения); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСБанкамиПереопределяемый.md b/src/content/docs/bsp/РаботаСБанкамиПереопределяемый.md new file mode 100644 index 0000000..fd2b608 --- /dev/null +++ b/src/content/docs/bsp/РаботаСБанкамиПереопределяемый.md @@ -0,0 +1,76 @@ +--- +title: Работа с банками переопределяемый +slug: bsp/работа-с-банками-переопределяемый +--- + + +## ПриОпределенииНеобходимостиПоказаПредупрежденияОбУстаревшемКлассификатореБанков +
+ +Описание, пример вызова + +```bsl + +// Включает/отключает показ предупреждений о необходимости обновления классификатора банков. +// +// Параметры: +// ПоказыватьПредупреждение - Булево - при установке значения Ложь предупреждения показываться не будут. +// +Процедура ПриОпределенииНеобходимостиПоказаПредупрежденияОбУстаревшемКлассификатореБанков(ПоказыватьПредупреждение) Экспорт +``` + +Пример вызова +```bsl +РаботаСБанкамиПереопределяемый.ПриОпределенииНеобходимостиПоказаПредупрежденияОбУстаревшемКлассификатореБанков(ПоказыватьПредупреждение) +``` +
+ +## ПриОпределенииНастроекЗагрузкиКлассификатораБанков +
+ +Описание, пример вызова + +```bsl + +// Определяет настройки загрузки классификатора банков. +// +// Параметры: +// Настройки - Структура: +// * ОбрабатыватьОбластиДанных - Булево - включает выполнение процедуры ПриОбработкеОбластиДанных при обновлении +// классификатора. +// +Процедура ПриОпределенииНастроекЗагрузкиКлассификатораБанков(Настройки) Экспорт +``` + +Пример вызова +```bsl +РаботаСБанкамиПереопределяемый.ПриОпределенииНастроекЗагрузкиКлассификатораБанков(Настройки) +``` +
+ +## ПриОбработкеОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Используется только в разделенном режиме. Вызывается после загрузки классификатора для выполнения дополнительных +// действий в областях данных. Выполнение процедуры необходимо включить в ПриОпределенииНастроек, по умолчанию выключена. +// +Процедура ПриОбработкеОбластиДанных() Экспорт +``` + +Пример вызова +```bsl +РаботаСБанкамиПереопределяемый.ПриОбработкеОбластиДанных() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСКлассификаторами.md b/src/content/docs/bsp/РаботаСКлассификаторами.md new file mode 100644 index 0000000..720f1ad --- /dev/null +++ b/src/content/docs/bsp/РаботаСКлассификаторами.md @@ -0,0 +1,425 @@ +--- +title: Работа с классификаторами +slug: bsp/работа-с-классификаторами +--- + + +## ОбновитьКлассификаторы +
+ +Описание, пример вызова + +```bsl + +// Выполняет загрузку обновления классификатора и обработку данных. +// +// Параметры: +// Идентификаторы - Массив из Строка - идентификаторы классификаторов в сервисе, +// обновление которых необходимо загрузить. +// +// Возвращаемое значение: +// Структура - содержит результат обновления классификатора: +// * КодОшибки - Строка - строковый код возникшей ошибки, который +// может быть обработан вызывающим функционалом: +// - <Пустая строка> - обновление выполнено успешно; +// - "ОбновлениеНеТребуется" - обновление не обнаружено; +// - "НеверныйЛогинИлиПароль" - неверный логин или пароль; +// - "ПревышеноКоличествоПопыток" - превышено количество попыток +// получения обновления с некорректным логином и паролем; +// - "ОшибкаПодключения" - ошибка при подключении к сервису; +// - "ОшибкаСервиса" - внутренняя ошибка сервиса; +// - "НеизвестнаяОшибка" - при получении информации возникла +// неизвестная (не обрабатываемая) ошибка; +// - "НеОбработан" - файл классификатора успешно загружен, но не обработан. +// Ошибка может возникнуть, если отсутствуют алгоритмы обработки файла +// см. процедуру РаботаСКлассификаторамиПереопределяемый.ПриЗагрузкеКлассификатора +// и ИнтеграцияПодсистемБИП.ПриЗагрузкеКлассификатора; +// - "СервисВременноНеДоступен" - на сервер ведутся регламентные работы; +// - "НеизвестныйКлассификаторИлиПрограмма" - классификатор или программа +// в сервисе не обнаружен по переданному идентификатору; +// - "ФайлНеЗагружен" - при загрузке файлов классификатора возникли ошибки; +// - "НетДоступаКПрограмме" - отсутствует доступ к программе на Портале 1С:ИТС; +// *СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для пользователя; +// *ИнформацияОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для администратора. +// +Функция ОбновитьКлассификаторы(Идентификаторы) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКлассификаторами.ОбновитьКлассификаторы(Идентификаторы) +``` +
+ +## ДоступныеОбновленияКлассификаторов +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие доступных обновлений классификаторов в Сервисе классификаторов +// или в кэше поставляемых данных. При работе в модели сервиса информация о +// актуальных версиях классификаторов будет сохранена в кэше опционально, т.е. +// в зависимости от настройки классификатора в переопределяемом методе +// РаботаСКлассификаторамиПереопределяемый.ПриДобавленииКлассификаторов и в методе +// ИнтеграцияПодсистемБИП.ПриДобавленииКлассификаторов(Классификаторы). Если +// в настройках классификатора установлено значение СохранятьФайлВКэш равным Истина +// получение файлов актуальных версий будет доступно, в противно случае метод вернет +// пустую таблицу ДоступныеВерсии. +// +// Параметры: +// Идентификаторы - Массив из Строка - идентификаторы классификаторов в сервисе, +// обновление которых необходимо загрузить. +// +// Возвращаемое значение: +// Структура - информация о доступных обновлениях: +// * КодОшибки - Строка - строковый код возникшей ошибки, который +// может быть обработан вызывающим функционалом: +// - <Пустая строка> - обновление выполнено успешно; +// - "НеверныйЛогинИлиПароль" - неверный логин или пароль; +// - "ПревышеноКоличествоПопыток" - превышено количество попыток +// получения обновления с некорректным логином и паролем; +// - "ОшибкаПодключения" - ошибка при подключении к сервису; +// - "ОшибкаСервиса" - внутренняя ошибка сервиса; +// - "НеизвестнаяОшибка" - при получении информации возникла +// неизвестная (не обрабатываемая) ошибка; +// - "СервисВременноНеДоступен" - на сервер ведутся регламентные работы; +// - "НеизвестныйКлассификаторИлиПрограмма" - классификатор или программа +// в сервисе не обнаружен по переданному идентификатору; +// - "НетДоступаКПрограмме" - отсутствует доступ к программе на Портале 1С:ИТС; +// - "ОбновлениеНеТребуется" - загружены актуальные версии классификаторов; +// *СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для пользователя; +// *ИнформацияОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для администратора; +// *ДоступныеВерсии - Массив - содержит информацию о доступных обновлениях +// **Идентификатор - Строка - идентификатор классификатора в сервисе; +// **Версия - Строка - номер актуальной версии; +// **ОписаниеВерсии - Строка - описание изменений в версии; +// **ИдентификаторФайла - Структура - описание файла классификатора файла для загрузки +// РаботаСКлассификаторами.ПолучитьФайлыКлассификаторов; +// **ИдентификаторФайла - Строка - идентификатор файла, который будет использован для загрузки; +// **Размер - Строка - размер файла; +// **Наименование - Строка - наименование классификатора; +// +Функция ДоступныеОбновленияКлассификаторов(Идентификаторы) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКлассификаторами.ДоступныеОбновленияКлассификаторов(Идентификаторы) +``` +
+ +## ОбработатьОбновлениеКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Выполняет загрузку файла обновления классификатора и его обработку. +// Необходимо использовать совместно с функцией РаботаСКлассификаторами.ДоступныеОбновленияКлассификаторов. +// +// Параметры: +// Идентификатор - Строка - идентификатор классификатора в сервисе; +// Версия - Строка - номер актуальной версии; +// ИдентификаторФайла - Строка - идентификатор файла, который будет использован для загрузки. +// см. функцию РаботаСКлассификаторами.ДоступныеОбновленияКлассификаторов; +// +// Возвращаемое значение: +// Структура - результат обновления классификатора: +// * КодОшибки - Строка - строковый код возникшей ошибки, который +// может быть обработан вызывающим функционалом: +// - <Пустая строка> - обновление выполнено успешно; +// - "НеверныйЛогинИлиПароль" - неверный логин или пароль; +// - "ПревышеноКоличествоПопыток" - превышено количество попыток +// получения обновления с некорректным логином и паролем; +// - "ОшибкаПодключения" - ошибка при подключении к сервису; +// - "ОшибкаСервиса" - внутренняя ошибка сервиса; +// - "НеизвестнаяОшибка" - при получении информации возникла +// неизвестная (не обрабатываемая) ошибка; +// - "НеОбработан" - файл классификатора успешно загружен, но не обработан. +// Ошибка может возникнуть, если отсутствуют алгоритмы обработки файла +// см. процедуру РаботаСКлассификаторамиПереопределяемый.ПриЗагрузкеКлассификатора +// и ИнтеграцияПодсистемБИП.ПриЗагрузкеКлассификатора; +// - "СервисВременноНеДоступен" - на сервер ведутся регламентные работы; +// - "НеизвестныйКлассификаторИлиПрограмма" - классификатор или программа +// в сервисе не обнаружен по переданному идентификатору; +// - "ФайлНеЗагружен" - при загрузке файлов классификатора возникли ошибки; +// - "НетДоступаКПрограмме" - отсутствует доступ к программе на Портале 1С:ИТС. +// *СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для пользователя; +// *ИнформацияОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для администратора; +// +// Пример: +// Идентификаторы = Новый Массив; +// Идентификаторы.Добавить(Параметры.Идентификатор); +// +// РезультатПроверки = РаботаСКлассификаторами.ДоступныеОбновленияКлассификаторов(Идентификаторы); +// Если ЗначениеЗаполнено(РезультатПроверки.КодОшибки) Тогда +// ПоказатьПредупреждение(, РезультатПроверки.СообщениеОбОшибке); +// ИначеЕсли РезультатПроверки.ДоступныеВерсии.Количество() = 0 Тогда +// Возврат; +// Иначе +// РаботаСКлассификаторами.ОбработатьОбновлениеКлассификатора( +// РезультатПроверки.ДоступныеВерсии[0].Идентификатор, +// РезультатПроверки.ДоступныеВерсии[0].Версия, +// РезультатПроверки.ДоступныеВерсии[0].ИдентификаторФайла) +// КонецЕсли; +// +Функция ОбработатьОбновлениеКлассификатора( Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКлассификаторами.ОбработатьОбновлениеКлассификатора(); +``` +
+ +## ПолучитьФайлыКлассификаторов +
+ +Описание, пример вызова + +```bsl + +// Получает актуальные версии файлов классификаторов из сервиса классификаторов +// или из кэша поставляемых данных. При работе в модели сервиса информация о +// актуальных версиях классификаторов будет сохранена в кэше опционально, т.е. +// в зависимости от настройки классификатора в переопределяемом методе +// РаботаСКлассификаторамиПереопределяемый.ПриДобавленииКлассификаторов и в методе +// ИнтеграцияПодсистемБИП.ПриДобавленииКлассификаторов(Классификаторы). Если +// в настройках классификатора установлено значение СохранятьФайлВКэш равным Истина +// получение файлов актуальных версий будет доступно, в противно случае метод вернет +// пустую таблицу ДанныеКлассификаторов. +// +// Параметры: +// Идентификаторы - Массив из Строка - идентификаторы классификаторов в сервисе, +// файлы которых необходимо загрузить. +// +// Возвращаемое значение: +// Структура - информация о доступных обновлениях: +// *КодОшибки - Строка - строковый код возникшей ошибки, который +// может быть обработан вызывающим функционалом: +// - <Пустая строка> - обновление выполнено успешно; +// - "ОбновлениеНеТребуется" - обновление не обнаружено; +// - "НеверныйЛогинИлиПароль" - неверный логин или пароль; +// - "ПревышеноКоличествоПопыток" - превышено количество попыток +// получения обновления с некорректным логином и паролем; +// - "ОшибкаПодключения" - ошибка при подключении к сервису; +// - "ОшибкаСервиса" - внутренняя ошибка сервиса; +// - "НеизвестнаяОшибка" - при получении информации возникла +// неизвестная (не обрабатываемая) ошибка; +// - "НеОбработан" - файл классификатора успешно загружен, но не обработан. +// Ошибка может возникнуть, если отсутствуют алгоритмы обработки файла +// см. процедуру РаботаСКлассификаторамиПереопределяемый.ПриЗагрузкеКлассификатора +// и ИнтеграцияПодсистемБИП.ПриЗагрузкеКлассификатора; +// - "СервисВременноНеДоступен" - на сервер ведутся регламентные работы; +// - "НеизвестныйКлассификаторИлиПрограмма" - классификатор или программа +// в сервисе не обнаружен по переданному идентификатору; +// - "ФайлНеЗагружен" - при загрузке файлов классификатора возникли ошибки; +// - "НетДоступаКПрограмме" - отсутствует доступ к программе на Портале 1С:ИТС; +// *СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для пользователя; +// *ИнформацияОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для администратора; +// *ДанныеКлассификаторов - ТаблицаЗначений, Неопределено - содержит информацию о доступных обновлениях +// **Идентификатор - Строка - идентификатор классификатора в сервисе; +// **Версия - Строка - номер актуальной версии; +// **АдресФайла - Строка - адрес файла во временном хранилище; +// **ОписаниеВерсии - Строка - описание изменений в версии; +// **КонтрольнаяСумма - Строка - описание изменений в версии; +// **Размер - Строка - описание изменений в версии; +// +Функция ПолучитьФайлыКлассификаторов(Идентификаторы) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКлассификаторами.ПолучитьФайлыКлассификаторов(Идентификаторы) +``` +
+ +## ОписаниеКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Создает описание классификатора, который используется в программе. +// +// Возвращаемое значение: +// Структура - содержит перечень значений необходимых для подключения тестового периода: +// *Наименование - Строка - пользовательское представление классификатора. +// Длина не более 150 символов; +// *Идентификатор - Строка - идентификатор классификатора в сервисе классификаторов. +// Поле обязательно для заполнения, если передана пустая строка, +// при переходе на новую версию будет вызвано исключение. Длина не более +// 50 символов; +// *ОбновлятьАвтоматически - Булево - настройка которая включает/отключает автоматическое +// обновления данных из сервиса; +// *ОбщиеДанные - Булево - регулирует способ обработки поставляем данных. +// Если Ложь, загрузка данных классификатора будет произведена +// в каждую область базы данных. Параметр используется только при работе +// в модели сервиса, в обычном режиме игнорируется; +// *ОбработкаРазделенныхДанных - Булево - указывает на необходимость дополнительной обработки данных +// областей после загрузки классификатора. Настройка используется только +// при работе в модели сервиса для общих классификаторов, т.е. если свойство +// ОбщиеДанные = Ложь, настройка игнорируется. Если значение настройки +// равно Истина, после обработки обновления классификатора для каждой +// области данных будет вызван переопределяемых метод +// РаботаСКлассификаторамиВМоделиСервисаПереопределяемый.ПриОбработкеОбластиДанных +// и метод ИнтеграцияПодсистемБИП.ПриОбработкеОбластиДанных. +// Обработка областей выполняется в асинхронно регламентным заданием +// (см. подсистемы ОчередьЗаданий), которое создается после обработки +// неразделенных данных; +// *СохранятьФайлВКэш - Булево - указывает на необходимость сохранения файла в кэше. +// Если установлено значение Истина, после обработки данных классификатора +// файл будет сохранен в кэше. Данные из кэша получаются при вызове метода +// программного интерфейса РаботаСКлассификаторами.ПолучитьФайлыКлассификаторов. +// Так как файлы физически хранятся в информационной базе, не следует использовать +// кэш для хранения больших классификаторов. Если классификатор имеет значительный +// размер, лучше создать для хранения его данных отдельный объект метаданных. +// +Функция ОписаниеКлассификатора() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКлассификаторами.ОписаниеКлассификатора() +``` +
+ +## УстановитьВерсиюКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Изменяет номер загруженной версии классификатора. Процедуру следует использовать, +// если выполняется обновления данных не из сервиса классификаторов. При работе в модели +// сервиса будет автоматический определена доступность общих данных. Если общие данные +// не доступны, изменение версии регистрируется для области данных. +// +// Параметры: +// Идентификатор - Строка - идентификатор классификатора в сервисе классификаторов; +// Версия - Число - новый номер версии, который необходимо установить. +// +Процедура УстановитьВерсиюКлассификатора(Идентификатор, Версия) Экспорт +``` + +Пример вызова +```bsl +РаботаСКлассификаторами.УстановитьВерсиюКлассификатора(Идентификатор, Версия) +``` +
+ +## УстановитьДатуОбновленияКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Устанавливает дату обновления файла классификатора. Процедуру необходимо вызывать +// после очередного обновления данных классификатора или если обновление не требуется, +// т.е. в информационную базу загружены актуальные данные. При вызове процедуры в монопольном +// обработчике обновления, следует учитывать, что информация о классификаторе будет зарегистрирована +// после выполнения обновления подсистемы "Работа с классификаторами". +// +// Параметры: +// Идентификатор - Строка - идентификатор классификатора в сервисе классификаторов; +// ДатаОбновления - Дата - дата обновления классификатора. +// +Процедура УстановитьДатуОбновленияКлассификатора(Идентификатор, ДатаОбновления) Экспорт +``` + +Пример вызова +```bsl +РаботаСКлассификаторами.УстановитьДатуОбновленияКлассификатора(Идентификатор, ДатаОбновления) +``` +
+ +## ВерсияКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Получает номер версии загруженного из сервиса классификатора. Если номер версии +// по идентификатору не найден, выполняет обновление данных регистра сведений +// ВерсииКлассификаторов. +// +// Параметры: +// Идентификатор - Строка - идентификатор классификатора в сервисе классификаторов; +// ВызыватьИсключение - Булево - если Истина и идентификатор классификатора не найден, будет вызвано исключение. +// +// Возвращаемое значение: +// Число, Неопределено - номер версии классификатора. +// +Функция ВерсияКлассификатора(Идентификатор, ВызыватьИсключение = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКлассификаторами.ВерсияКлассификатора(Идентификатор, ВызыватьИсключение); +``` +
+ +## ДатаОбновленияКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Получает дату последнего обновления классификатора. Если дата обновления +// по идентификатору не найдена, выполняет обновление данных регистра сведений +// ВерсииКлассификаторов. +// +// Параметры: +// Идентификатор - Строка - идентификатор классификатора в сервисе классификаторов; +// ВызыватьИсключение - Булево - если Истина и идентификатор классификатора не найден, будет вызвано исключение. +// +// Возвращаемое значение: +// Дата, Неопределено - дата обновления классификатора. +// +Функция ДатаОбновленияКлассификатора(Идентификатор, ВызыватьИсключение = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКлассификаторами.ДатаОбновленияКлассификатора(Идентификатор, ВызыватьИсключение); +``` +
+ +## ИнтерактивнаяЗагрузкаКлассификаторовДоступна +
+ +Описание, пример вызова + +```bsl + +// Определяет доступность использования обработки интерактивной загрузки +// классификаторов. +// +// Возвращаемое значение: +// Булево - определяет возможность использования обработки ОбновлениеКлассификаторов +// Если Истина, обработку можно использовать. +// +Функция ИнтерактивнаяЗагрузкаКлассификаторовДоступна() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКлассификаторами.ИнтерактивнаяЗагрузкаКлассификаторовДоступна() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСКлассификаторамиВМоделиСервисаПереопределяемый.md b/src/content/docs/bsp/РаботаСКлассификаторамиВМоделиСервисаПереопределяемый.md new file mode 100644 index 0000000..a20bb22 --- /dev/null +++ b/src/content/docs/bsp/РаботаСКлассификаторамиВМоделиСервисаПереопределяемый.md @@ -0,0 +1,75 @@ +--- +title: Работа с классификаторами в модели сервиса переопределяемый +slug: bsp/работа-с-классификаторами-в-модели-сервиса-переопределяемый +--- + + +## ПриОпределенииИдентификаторовКлассификаторов +
+ +Описание, пример вызова + +```bsl + +// Определяет идентификаторы классификаторов, которые в обязательном порядке должны +// быть включены в манифест конфигурации для Менеджера сервиса. Заполнять реализацию +// метода имеет смысл в случае, если загрузка классификатора зависит от настроек +// конфигурации (функциональных опций, констант и т.д.). +// +// Параметры: +// Идентификаторы - Массив из Строка - идентификатор классификатора для добавления в манифест. +// +// Пример: +// Идентификаторы.Добавить("CentralBankRefinancingRate"); +// +//@skip-warning +Процедура ПриОпределенииИдентификаторовКлассификаторов(Идентификаторы) Экспорт +``` + +Пример вызова +```bsl +РаботаСКлассификаторамиВМоделиСервисаПереопределяемый.ПриОпределенииИдентификаторовКлассификаторов(Идентификаторы) +``` +
+ +## ПриОбработкеОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Переопределяются алгоритмы обработки области после загрузки поставляемых данных +// классификаторов. +// +// Параметры: +// Идентификатор - Строка - идентификатор классификатора в сервисе классификаторов. +// Определяется в процедуре ПриДобавленииКлассификаторов; +// Версия - Число - номер загруженной версии; +// ДополнительныеПараметры - Структура - содержит дополнительные параметры обработки, +// которые были заполнены в переопределяемом методе +// РаботаСКлассификаторамиПереопределяемый.ПриЗагрузкеКлассификатора +// и в методе ИнтеграцияПодсистемБИП.ПриЗагрузкеКлассификатора. +// +// Пример: +// Если Идентификатор = "CentralBankRefinancingRate" Тогда +// Документы.КомпенсацияЗаЗадержкуЗарплаты.ПерерасчетКомпенсацияЗаЗадержкуЗарплаты(); +// КонецЕсли; +// +//@skip-warning +Процедура ПриОбработкеОбластиДанных(Идентификатор, Версия, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +РаботаСКлассификаторамиВМоделиСервисаПереопределяемый.ПриОбработкеОбластиДанных(Идентификатор, Версия, ДополнительныеПараметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСКлассификаторамиКлиент.md b/src/content/docs/bsp/РаботаСКлассификаторамиКлиент.md new file mode 100644 index 0000000..559a50e --- /dev/null +++ b/src/content/docs/bsp/РаботаСКлассификаторамиКлиент.md @@ -0,0 +1,90 @@ +--- +title: Работа с классификаторами клиент +slug: bsp/работа-с-классификаторами-клиент +--- + + +## НовыйПараметрыОбновленияКлассификаторов +
+ +Описание, пример вызова + +```bsl + +// Формирует параматры интерактивной загрузки классификаторов. +// +// Параметры: +// Владелец - ФормаКлиентскогоПриложения - форма которая будет установлена в качестве владельца. +// Идентификаторы - Массив из Строка, Неопределено - идентификаторы классификаторов, +// которые необходимо обновить. +// ОписаниеОповещения - ОписаниеОповещения - оповещение, которое будет вызвано после закрытия формы. +// В качестве результата оповещения передается массив из обновленных идентификаторов классификаторов. +// +// Возвращаемое значение: +// Структура - параметры обновления классификаторов: +// *Владелец - ФормаКлиентскогоПриложения - форма которая будет установлена в качестве владельца. +// *Идентификаторы - Массив из Строка, Неопределено - идентификаторы классификаторов, +// которые необходимо обновить. +// *ОписаниеОповещения - ОписаниеОповещения - оповещение, которое будет вызвано после закрытия формы. +// В качестве результата оповещения передается массив из обновленных идентификаторов классификаторов. +// +Функция НовыйПараметрыОбновленияКлассификаторов( Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКлассификаторамиКлиент.НовыйПараметрыОбновленияКлассификаторов(); +``` +
+ +## ОбновитьКлассификаторы +
+ +Описание, пример вызова + +```bsl + +// Открывает помощник обновления классификаторов. +// +// Параметры: +// ПараметрыОбновления - Структура, Неопределено - см. НовыйПараметрыОбновленияКлассификаторов. +// +Процедура ОбновитьКлассификаторы(ПараметрыОбновления = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСКлассификаторамиКлиент.ОбновитьКлассификаторы(ПараметрыОбновления); +``` +
+ +## ИмяСобытияОповещенияОЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Определяет имя события, которое будет содержать оповещение +// о завершении загрузки классификаторов. +// +// Возвращаемое значение: +// Строка - Имя события. Может быть использовано для идентификации +// сообщений принимающими их формами. +// +Функция ИмяСобытияОповещенияОЗагрузки() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКлассификаторамиКлиент.ИмяСобытияОповещенияОЗагрузки() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСКлассификаторамиПереопределяемый.md b/src/content/docs/bsp/РаботаСКлассификаторамиПереопределяемый.md new file mode 100644 index 0000000..e43eeee --- /dev/null +++ b/src/content/docs/bsp/РаботаСКлассификаторамиПереопределяемый.md @@ -0,0 +1,151 @@ +--- +title: Работа с классификаторами переопределяемый +slug: bsp/работа-с-классификаторами-переопределяемый +--- + + +## ПриДобавленииКлассификаторов +
+ +Описание, пример вызова + +```bsl + +// Переопределяется список и настройки классификаторов обновления которых необходимо +// загружать из сервиса классификаторов. Для получения идентификатора необходимо +// перевести наименование объекта метаданных, данные которого планируется обновлять, +// на английский язык. При переводе рекомендуется использовать профессиональные +// программы перевода текста, либо воспользоваться услугами переводчика, т.к. при +// обнаружении смысловых ошибок в идентификаторе потребуется заводить новый классификатор +// и изменять код конфигурации. +// +// Параметры: +// Классификаторы - Массив из Структура - содержит настройки загрузки классификаторов. +// Состав настроек см. функцию РаботаСКлассификаторами.ОписаниеКлассификатора. +// +// Пример: +// Описатель = РаботаСКлассификаторами.ОписаниеКлассификатора(); +// Описатель.Наименование = НСтр("ru = 'Ставки рефинансирования'"); +// Описатель.Идентификатор = "CentralBankRefinancingRate"; +// Описатель.ОбновлятьАвтоматически = Истина; +// Описатель.ОбщиеДанные = Истина; +// Описатель.СохранятьФайлВКэш = Ложь; +// Описатель.ОбработкаРазделенныхДанных = Ложь; +// Классификаторы.Добавить(Описатель); +// +//@skip-warning +Процедура ПриДобавленииКлассификаторов(Классификаторы) Экспорт +``` + +Пример вызова +```bsl +РаботаСКлассификаторамиПереопределяемый.ПриДобавленииКлассификаторов(Классификаторы) +``` +
+ +## ПриОпределенииНачальногоНомераВерсииКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Переопределяются номер версии классификатора, который уже загружен в информационную базу. +// При начале использовании подсистемы "РаботаСКлассификаторами" или при подключении нового +// классификатора к сервису, неизвестно какой номер версии классификатора загружен в ИБ, +// поэтому при очередной итерации обновления данных из сервиса данные будут загружены повторно. +// Чтобы избежать повторной загрузки, необходимо указать задать начальный номер версии. +// Метод будет вызван при попытке загрузить версию классификатора, у которого установлена +// версия равная 0. +// +// Параметры: +// Идентификатор - Строка - идентификатор классификатора в сервисе классификаторов. +// Определяется в процедуре ПриДобавленииКлассификаторов. +// НачальныйНомерВерсии - Число - номер версии загруженного классификатора. +// +// Пример: +// Если Идентификатор = "CentralBankRefinancingRate" Тогда +// НачальныйНомерВерсии = РегистрыСведений.СтавкиРефинансирования.НомерЗагруженнойВерсии(); +// КонецЕсли; +// +//@skip-warning +Процедура ПриОпределенииНачальногоНомераВерсииКлассификатора(Идентификатор, НачальныйНомерВерсии) Экспорт +``` + +Пример вызова +```bsl +РаботаСКлассификаторамиПереопределяемый.ПриОпределенииНачальногоНомераВерсииКлассификатора(Идентификатор, НачальныйНомерВерсии) +``` +
+ +## ПриЗагрузкеКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Переопределяются алгоритмы обработки файла загруженного +// из сервиса классификаторов. После обработки файла нельзя удалять +// временного хранилища, т.к. при необходимости он будет сохранен в +// кэше для последующего использования. +// +// Параметры: +// Идентификатор - Строка - идентификатор классификатора в сервисе классификаторов. +// Определяется в процедуре ПриДобавленииКлассификаторов. +// Версия - Число - номер загруженной версии; +// Адрес - Строка - адрес двоичных данных файла обновления во +// временном хранилище; +// Обработан - Булево - если Ложь, при обработке файла обновления были ошибки +// и его необходимо загрузить повторно; +// ДополнительныеПараметры - Структура - содержит дополнительные параметры обработки. +// Необходимо использовать для передачи значений в переопределяемый +// метод РаботаСКлассификаторамиВМоделиСервисаПереопределяемый.ПриОбработкеОбластиДанных +// и метод ИнтеграцияПодсистемБИП.ПриОбработкеОбластиДанных.. +// Пример: +// Если Идентификатор = "CentralBankRefinancingRate" Тогда +// Обработан = РегистрыСведений.СтавкиРефинансирования.ОбновитьДанныеРегистраИзФайла(Адрес, ДополнительныеПараметры); +// КонецЕсли; +// +//@skip-warning +Процедура ПриЗагрузкеКлассификатора(Идентификатор, Версия, Адрес, Обработан, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +РаботаСКлассификаторамиПереопределяемый.ПриЗагрузкеКлассификатора(Идентификатор, Версия, Адрес, Обработан, ДополнительныеПараметры) +``` +
+ +## ПриОпределенииНастроекПользователя +
+ +Описание, пример вызова + +```bsl + +// Переопределяются пользовательские настройки обновления классификаторов. +// +// Параметры: +// Настройки - Структура: +// * ОтключитьНапоминания - Булево - Истина, если необходимо отключить напоминание о включении +// автоматической загрузки классификаторов в подсистеме БСП.ТекущиеДела и не показывать оповещение +// пользователю при старте системы, если подсистема БСП.ТекущиеДела отсутствует в конфигурации. +// +//@skip-warning +Процедура ПриОпределенииНастроекПользователя(Настройки) Экспорт +``` + +Пример вызова +```bsl +РаботаСКлассификаторамиПереопределяемый.ПриОпределенииНастроекПользователя(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСКурсамиВалют.md b/src/content/docs/bsp/РаботаСКурсамиВалют.md new file mode 100644 index 0000000..2ba8aee --- /dev/null +++ b/src/content/docs/bsp/РаботаСКурсамиВалют.md @@ -0,0 +1,174 @@ +--- +title: Работа с курсами валют +slug: bsp/работа-с-курсами-валют +--- + + +## ДобавитьВалютыПоКоду +
+ +Описание, пример вызова + +```bsl + +// Добавляет в справочник указанные валюты из классификатора. +// Для вызова из обработчиков начального заполнения. +// +// При отсутствии классификатора валюты добавляются с наименованием "Валюта", +// символьный код соответствует цифровому. +// +// Параметры: +// КодыВалют - Массив из Строка - цифровые коды добавляемых валют. +// +// Возвращаемое значение: +// Массив из СправочникСсылка.Валюты +// +Функция ДобавитьВалютыПоКоду(Знач КодыВалют) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКурсамиВалют.ДобавитьВалютыПоКоду(КодыВалют) +``` +
+ +## ПолучитьКурсВалюты +
+ +Описание, пример вызова + +```bsl + +// Возвращает курс валюты на дату. +// +// Параметры: +// Валюта - СправочникСсылка.Валюты - валюта, для которой получается курс. +// ДатаКурса - Дата - дата, на которую получается курс. +// +// Возвращаемое значение: +// Структура: +// * Курс - Число - курс валюты на указанную дату. +// * Кратность - Число - кратность валюты на указанную дату. +// * Валюта - СправочникСсылка.Валюты - ссылка валюты. +// * ДатаКурса - Дата - дата получения курса. +// +Функция ПолучитьКурсВалюты(Валюта, ДатаКурса) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКурсамиВалют.ПолучитьКурсВалюты(Валюта, ДатаКурса) +``` +
+ +## СформироватьСуммуПрописью +
+ +Описание, пример вызова + +```bsl + +// Формирует представление суммы прописью в указанной валюте. +// +// Параметры: +// СуммаЧислом - Число - сумма, которую надо представить прописью. +// Валюта - СправочникСсылка.Валюты - валюта, в которой нужно представить сумму. +// БезДробнойЧасти - Булево - указать Истина, если требуется получить сумму без дробной части (без копеек). +// КодЯзыка - Строка - язык, на котором требуется получить сумму прописью. +// Состоит из кода языка по ISO 639-1 и, опционально, кода страны по ISO 3166-1, разделенных +// символом подчеркивания. Примеры: "en", "en_US", "en_GB", "ru", "ru_RU". +// Значение по умолчанию - язык конфигурации. +// ДробнаяЧастьПрописью - Булево +// +// Возвращаемое значение: +// Строка - сумма прописью. +// +Функция СформироватьСуммуПрописью(СуммаЧислом, Валюта, БезДробнойЧасти = Ложь, Знач КодЯзыка = Неопределено, ДробнаяЧастьПрописью = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКурсамиВалют.СформироватьСуммуПрописью(СуммаЧислом, Валюта, БезДробнойЧасти, КодЯзыка, ДробнаяЧастьПрописью); +``` +
+ +## ПересчитатьВВалюту +
+ +Описание, пример вызова + +```bsl + +// Пересчитывает сумму из одной валюты в другую. +// +// Параметры: +// Сумма - Число - сумма, которую необходимо пересчитать; +// ИсходнаяВалюта - СправочникСсылка.Валюты - пересчитываемая валюта; +// НоваяВалюта - СправочникСсылка.Валюты - валюта, в которую необходимо пересчитать; +// Дата - Дата - дата курсов валют. +// +// Возвращаемое значение: +// Число - пересчитанная сумма. +// +Функция ПересчитатьВВалюту(Сумма, ИсходнаяВалюта, НоваяВалюта, Дата) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКурсамиВалют.ПересчитатьВВалюту(Сумма, ИсходнаяВалюта, НоваяВалюта, Дата) +``` +
+ +## ОписаниеТипаДенежногоПоля +
+ +Описание, пример вызова + +```bsl + +// Предназначена для использования в конструкторе типа Число для денежных полей. +// +// Параметры: +// ДопустимыйЗнакПоля - ДопустимыйЗнак - определяет допустимый знак числа. Значение по умолчанию - ДопустимыйЗнак.Любой. +// +// Возвращаемое значение: +// ОписаниеТипов - тип значения для денежного поля. +// +Функция ОписаниеТипаДенежногоПоля(Знач ДопустимыйЗнакПоля = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКурсамиВалют.ОписаниеТипаДенежногоПоля(ДопустимыйЗнакПоля); +``` +
+ +## ПодключитьИсточникДанныхПечатиЧислоПрописью +
+ +Описание, пример вызова + +```bsl + +// Добавляет возможность вывода числового реквизита прописью при печати. +// Для вызова из УправлениеПечатьюПереопределяемый.ПриОпределенииИсточниковДанныхПечати. +// +// Параметры: +// ИсточникиДанныхПечати - см. УправлениеПечатьюПереопределяемый.ПриОпределенииИсточниковДанныхПечати.ИсточникиДанныхПечати +// +Процедура ПодключитьИсточникДанныхПечатиЧислоПрописью(ИсточникиДанныхПечати) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалют.ПодключитьИсточникДанныхПечатиЧислоПрописью(ИсточникиДанныхПечати) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСКурсамиВалютКлиентЛокализация.md b/src/content/docs/bsp/РаботаСКурсамиВалютКлиентЛокализация.md new file mode 100644 index 0000000..9b8e8b8 --- /dev/null +++ b/src/content/docs/bsp/РаботаСКурсамиВалютКлиентЛокализация.md @@ -0,0 +1,35 @@ +--- +title: Работа с курсами валют клиент локализация +slug: bsp/работа-с-курсами-валют-клиент-локализация +--- + + +## ПоказатьЗагрузкуКурсовВалют +
+ +Описание, пример вызова + +```bsl + +// Выполняет интерактивные действия по загрузке курсов валют. +// +// Параметры: +// ПараметрыЗагрузки - Структура: +// * ОткрытиеИзСписка - Булево - Истина, если действие вызывается из списка валют. +// +Процедура ПоказатьЗагрузкуКурсовВалют(ПараметрыЗагрузки) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютКлиентЛокализация.ПоказатьЗагрузкуКурсовВалют(ПараметрыЗагрузки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСКурсамиВалютКлиентСервер.md b/src/content/docs/bsp/РаботаСКурсамиВалютКлиентСервер.md new file mode 100644 index 0000000..8b4c5f1 --- /dev/null +++ b/src/content/docs/bsp/РаботаСКурсамиВалютКлиентСервер.md @@ -0,0 +1,48 @@ +--- +title: Работа с курсами валют клиент сервер +slug: bsp/работа-с-курсами-валют-клиент-сервер +--- + + +## ПересчитатьПоКурсу +
+ +Описание, пример вызова + +```bsl + +// Пересчитывает сумму из текущей валюты в новую валюту по параметрам их курсов. +// Параметры курсов валют можно получить функцией РаботаСКурсамиВалют.ПолучитьКурсВалюты. +// +// Параметры: +// Сумма - Число - сумма, которую следует пересчитать. +// +// ПараметрыТекущегоКурса - Структура - параметры курса валюты, из которой надо пересчитать: +// * Валюта - СправочникСсылка.Валюты - ссылка пересчитываемой валюты. +// * Курс - Число - курс пересчитываемой валюты. +// * Кратность - Число - кратность пересчитываемой валюты. +// +// ПараметрыНовогоКурса - Структура - параметры курса валюты, в которую надо пересчитать: +// * Валюта - СправочникСсылка.Валюты - ссылка валюты, в которую идет пересчет. +// * Курс - Число - курс валюты, в которую идет пересчет. +// * Кратность - Число - кратность валюты, в которую идет пересчет. +// +// Возвращаемое значение: +// Число - сумма, пересчитанная по новому курсу. +// +Функция ПересчитатьПоКурсу(Сумма, ПараметрыТекущегоКурса, ПараметрыНовогоКурса) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСКурсамиВалютКлиентСервер.ПересчитатьПоКурсу(Сумма, ПараметрыТекущегоКурса, ПараметрыНовогоКурса) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСКурсамиВалютЛокализация.md b/src/content/docs/bsp/РаботаСКурсамиВалютЛокализация.md new file mode 100644 index 0000000..2505812 --- /dev/null +++ b/src/content/docs/bsp/РаботаСКурсамиВалютЛокализация.md @@ -0,0 +1,235 @@ +--- +title: Работа с курсами валют локализация +slug: bsp/работа-с-курсами-валют-локализация +--- + + +## ПриДобавленииВалютПоКоду +
+ +Описание, пример вызова + +```bsl + +// Вызывается при начальном заполнении справочника валют для добавления указанных валют из классификатора. +// +// Параметры: +// КодыВалют - Массив из Строка - цифровые коды добавляемых валют. +// Валюты - Массив из СправочникСсылка.Валюты - выходной параметр. Добавленные валюты. +// СтандартнаяОбработка - Булево - выходной параметр. Установить Ложь, если реализовано собственное заполнение. +// +Процедура ПриДобавленииВалютПоКоду(Знач КодыВалют, Валюты, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриДобавленииВалютПоКоду(КодыВалют, Валюты, СтандартнаяОбработка) +``` +
+ +## ПриОпределенииДоступностиЗагрузкиКурсовВалют +
+ +Описание, пример вызова + +```bsl + +// Определяет техническую возможность загрузки курсов валют из Интернета +// (наличие такой функциональности в конфигурации). +// +// Параметры: +// Значение - Булево +// +Процедура ПриОпределенииДоступностиЗагрузкиКурсовВалют(Значение) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриОпределенииДоступностиЗагрузкиКурсовВалют(Значение) +``` +
+ +## ПриОпределенииКодовВалютЗагружаемыхИзИнтернета +
+ +Описание, пример вызова + +```bsl + +// Определяет валюты, для которых есть техническая возможность загрузки курсов из Интернета +// (внешний ресурс предоставляет эти данные). +// +// Параметры: +// КодыВалютЗагружаемыхИзИнтернета - Массив из Строка - выходной параметр. +// +Процедура ПриОпределенииКодовВалютЗагружаемыхИзИнтернета(КодыВалютЗагружаемыхИзИнтернета) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриОпределенииКодовВалютЗагружаемыхИзИнтернета(КодыВалютЗагружаемыхИзИнтернета) +``` +
+ +## ПриЗагрузкеАктуальныхКурсов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при загрузке курсы валют на текущую дату. +// +// Параметры: +// ПараметрыЗагрузки - Структура: +// * НачалоПериода - Дата - начало периода загрузки. +// * КонецПериода - Дата - конец периода загрузки. +// * СписокВалют - ТаблицаЗначений: +// ** Валюта - СправочникСсылка.Валюты +// ** КодВалюты - Строка +// АдресРезультата - Строка - адрес во временном хранилище для помещения результатов загрузки. +// +Процедура ПриЗагрузкеАктуальныхКурсов(ПараметрыЗагрузки = Неопределено, АдресРезультата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриЗагрузкеАктуальныхКурсов(ПараметрыЗагрузки, АдресРезультата); +``` +
+ +## ПриЗагрузкеКлассификатора +
+ +Описание, пример вызова + +```bsl + +// См. РаботаСКлассификаторамиПереопределяемый.ПриЗагрузкеКлассификатора. +Процедура ПриЗагрузкеКлассификатора(Идентификатор, Версия, Адрес, Обработан, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриЗагрузкеКлассификатора(Идентификатор, Версия, Адрес, Обработан, ДополнительныеПараметры) +``` +
+ +## ПриЗаполненииСпискаТекущихДел +
+ +Описание, пример вызова + +```bsl + +// См. ТекущиеДелаПереопределяемый.ПриОпределенииОбработчиковТекущихДел. +Процедура ПриЗаполненииСпискаТекущихДел(ТекущиеДела) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриЗаполненииСпискаТекущихДел(ТекущиеДела) +``` +
+ +## ПриОпределенииФормВводаПрописей +
+ +Описание, пример вызова + +```bsl + +// Указывает коллекции объектов метаданных, содержащие формы ввода прописей для различных языков. +// Имя формы должно соответствовать шаблону ПараметрыПрописиВалюты_<код языка>. Например, "ПараметрыПрописиВалюты_en". +// +// Для того, чтобы создать новую форму ввода прописей на нужном языке, необходимо скопировать +// форму ПараметрыПрописиВалюты_en, изменить в ее имени код языка и реализовать в ней заполнение параметров прописи на +// выбранном языке. См. описание параметра ПараметрыПредметаИсчисления в функции ЧислоПрописью в синтакс-помощнике. +// +// Параметры: +// КоллекцииФорм - Массив из КоллекцияОбъектовМетаданных - выходной параметр. +// +Процедура ПриОпределенииФормВводаПрописей(КоллекцииФорм) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриОпределенииФормВводаПрописей(КоллекцииФорм) +``` +
+ +## ПриОпределенииНастроекРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// См. РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроекРегламентныхЗаданий. +Процедура ПриОпределенииНастроекРегламентныхЗаданий(Настройки) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриОпределенииНастроекРегламентныхЗаданий(Настройки) +``` +
+ +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазыБСП.ПриДобавленииОбработчиковОбновления. +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ПриИзмененииДанныхАутентификацииИнтернетПоддержки +
+ +Описание, пример вызова + +```bsl + +// См. ИнтернетПоддержкаПользователейПереопределяемый.ПриИзмененииДанныхАутентификацииИнтернетПоддержки. +Процедура ПриИзмененииДанныхАутентификацииИнтернетПоддержки(ДанныеПользователя) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриИзмененииДанныхАутентификацииИнтернетПоддержки(ДанныеПользователя) +``` +
+ +## ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВБезопасномРежимеПереопределяемый.ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам. +Процедура ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам(ЗапросыРазрешений) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютЛокализация.ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам(ЗапросыРазрешений) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСКурсамиВалютПереопределяемый.md b/src/content/docs/bsp/РаботаСКурсамиВалютПереопределяемый.md new file mode 100644 index 0000000..a727d10 --- /dev/null +++ b/src/content/docs/bsp/РаботаСКурсамиВалютПереопределяемый.md @@ -0,0 +1,34 @@ +--- +title: Работа с курсами валют переопределяемый +slug: bsp/работа-с-курсами-валют-переопределяемый +--- + + +## ПриОпределенииНеобходимостиПоказаПредупрежденияОбУстаревшихКурсахВалют +
+ +Описание, пример вызова + +```bsl + +// Включает/отключает показ предупреждений о необходимости обновления курсов валют. +// +// Параметры: +// ПоказыватьПредупреждение - Булево - при установке значения Ложь предупреждения показываться не будут. +// +Процедура ПриОпределенииНеобходимостиПоказаПредупрежденияОбУстаревшихКурсахВалют(ПоказыватьПредупреждение) Экспорт +``` + +Пример вызова +```bsl +РаботаСКурсамиВалютПереопределяемый.ПриОпределенииНеобходимостиПоказаПредупрежденияОбУстаревшихКурсахВалют(ПоказыватьПредупреждение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСПочтовымиСообщениями.md b/src/content/docs/bsp/РаботаСПочтовымиСообщениями.md new file mode 100644 index 0000000..8f19ed5 --- /dev/null +++ b/src/content/docs/bsp/РаботаСПочтовымиСообщениями.md @@ -0,0 +1,615 @@ +--- +title: Работа с почтовыми сообщениями +slug: bsp/работа-с-почтовыми-сообщениями +--- + + +## ОтправитьПисьмо +
+ +Описание, пример вызова + +```bsl + +// Выполняет отправку одного письма. +// Функция может вызвать исключение, которое требуется обработать. +// +// Параметры: +// УчетнаяЗаписьИлиСоединение - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - почтовый ящик, с которого необходимо +// выполнить отправку. +// - ИнтернетПочта - установленное соединение с почтовым сервером. +// +// Письмо - ИнтернетПочтовоеСообщение - отправляемое письмо. +// +// Возвращаемое значение: +// Структура - результат отправки письма: +// * ОшибочныеПолучатели - Соответствие из КлючИЗначение - адреса получателей с ошибками: +// ** Ключ - Строка - адрес получателя; +// ** Значение - Строка - текст ошибки. +// * ИдентификаторПисьмаSMTP - Строка - уникальный идентификатор письма, присвоенный при отправке по протоколу SMTP. +// * ИдентификаторПисьмаIMAP - Строка - уникальный идентификатор письма, присвоенный при отправке по протоколу IMAP. +// +Функция ОтправитьПисьмо(УчетнаяЗаписьИлиСоединение, Письмо) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ОтправитьПисьмо(УчетнаяЗаписьИлиСоединение, Письмо) +``` +
+ +## ОтправитьПисьма +
+ +Описание, пример вызова + +```bsl + +// Выполняет отправку нескольких писем. +// Функция может вызвать исключение, которое требуется обработать. +// Если до наступления ошибки отправки было успешно отправлено хотя бы одно письмо, исключение не вызывается, +// поэтому при обработке результата функции необходимо проверять какие письма не были отправлены. +// +// Параметры: +// УчетнаяЗаписьИлиСоединение - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - почтовый ящик, с которого необходимо +// выполнить отправку. +// - ИнтернетПочта - установленное соединение с почтовым сервером. +// +// Письма - Массив из ИнтернетПочтовоеСообщение - коллекция почтовых сообщений. Элемент коллекции - ИнтернетПочтовоеСообщение. +// ТекстОшибки - Строка - сообщение об ошибке в случае, когда удалось отправить не все письма. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ИнтернетПочтовоеСообщение - отправляемое письмо; +// * Значение - Структура - результат отправки письма: +// ** ОшибочныеПолучатели - Соответствие из КлючИЗначение - адреса получателей с ошибками: +// *** Ключ - Строка - адрес получателя; +// *** Значение - Строка - текст ошибки. +// ** ИдентификаторПисьмаSMTP - Строка - уникальный идентификатор письма, присвоенный при отправке по протоколу SMTP. +// ** ИдентификаторПисьмаIMAP - Строка - уникальный идентификатор письма, присвоенный при отправке по протоколу IMAP. +// +Функция ОтправитьПисьма(УчетнаяЗаписьИлиСоединение, Письма, ТекстОшибки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ОтправитьПисьма(УчетнаяЗаписьИлиСоединение, Письма, ТекстОшибки); +``` +
+ +## ЗагрузитьПочтовыеСообщения +
+ +Описание, пример вызова + +```bsl + +// Загружает сообщения с сервера для указанной почты. +// Предварительно проверяется корректность заполнения настроек почты. +// Функция может вызвать исключение, которое требуется обработать. +// +// Параметры: +// УчетнаяЗаписьИлиСоединение - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - электронная почта, с которой +// загружаются письма. +// - ИнтернетПочта - установленное соединение с почтовым сервером +// ПараметрыЗагрузки - Структура: +// * Колонки - Массив - массив строк названий колонок +// названия колонок должны соответствовать полям объекта +// ИнтернетПочтовоеСообщение. +// * РежимТестирования - Булево - используется для проверки подключения к серверу. +// * ПолучениеЗаголовков - Булево - если Истина, то в возвращаемом наборе есть только +// заголовки писем. +// * Отбор - Структура - соответствует параметру ПараметрыОтбора встроенной функции ИнтернетПочта.ПолучитьЗаголовки. +// * ЗаголовкиИдентификаторы - Массив - заголовки или идентификаторы сообщений, полные +// сообщения по которым требуется получить. +// * ПриводитьСообщенияКТипу - Булево - возвращать набор полученных почтовых сообщений +// в виде таблицы значений с простыми типами. По умолчанию Истина. +// +// Возвращаемое значение: +// ТаблицаЗначений - список почтовых сообщений с колонками: +// * Важность - ВажностьИнтернетПочтовогоСообщения +// * Вложения - ИнтернетПочтовыеВложения - в случае если вложениями являются другие почтовые сообщения, +// они сами не возвращаются, но возвращаются их вложения - двоичные +// данные и их тексты в виде двоичных данных, рекурсивно. +// * ДатаОтправления - Дата +// * ДатаПолучения - Дата +// * Заголовок - Строка +// * ИмяОтправителя - Строка +// * Идентификатор - Массив из Строка +// * Копии - ИнтернетПочтовыеАдреса +// * ОбратныйАдрес - ИнтернетПочтовыеАдреса +// * Отправитель - Строка +// - ИнтернетПочтовыйАдрес +// * Получатели - ИнтернетПочтовыеАдреса +// * Размер - Число +// * Тексты - ИнтернетТекстыПочтовогоСообщения +// * Кодировка - Строка +// * СпособКодированияНеASCIIСимволов - СпособКодированияНеASCIIСимволовИнтернетПочтовогоСообщения +// * Частичное - Булево - заполняется если статус Истина. В режиме тестирования возвращается Истина. +// Булево - если передан параметр РежимТестирования = Истина. Истина - подключение выполнено успешно. +// +Функция ЗагрузитьПочтовыеСообщения(Знач УчетнаяЗаписьИлиСоединение, Знач ПараметрыЗагрузки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ЗагрузитьПочтовыеСообщения(УчетнаяЗаписьИлиСоединение, ПараметрыЗагрузки); +``` +
+ +## ДоступныеУчетныеЗаписи +
+ +Описание, пример вызова + +```bsl + +// Получить доступные учетные записи электронной почты. +// +// Параметры: +// ДляОтправки - Булево - выбирать только учетные записи, настроенные для отправки почты. +// ДляПолучения - Булево - выбирать только учетные записи, настроенные на получение почты. +// ВключатьСистемнуюУчетнуюЗапись - Булево - включать системную учетную запись, если настроена для отправки/получения. +// +// Возвращаемое значение: +// ТаблицаЗначений - описание учетных записей: +// * Ссылка - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - учетная запись; +// * Наименование - Строка - наименование почты; +// * Адрес - Строка - адрес электронной почты. +// +Функция ДоступныеУчетныеЗаписи(Знач ДляОтправки = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ДоступныеУчетныеЗаписи(ДляОтправки, ); +``` +
+ +## СистемнаяУчетнаяЗапись +
+ +Описание, пример вызова + +```bsl + +// Получает настройки почты для рассылки различных уведомлений из программы. +// +// Возвращаемое значение: +// СправочникСсылка.УчетныеЗаписиЭлектроннойПочты +// +Функция СистемнаяУчетнаяЗапись() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.СистемнаяУчетнаяЗапись() +``` +
+ +## ПроверитьСистемнаяУчетнаяЗаписьДоступна +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что почта для рассылки различных уведомлений доступна (может быть использована). +// +// Возвращаемое значение: +// Булево +// +Функция ПроверитьСистемнаяУчетнаяЗаписьДоступна() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ПроверитьСистемнаяУчетнаяЗаписьДоступна() +``` +
+ +## ДоступнаОтправкаПисем +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если доступна по меньшей мере одна настроенная учетная запись для отправки почты +// либо достаточно прав на настройку почты. +// +// Возвращаемое значение: +// Булево +// +Функция ДоступнаОтправкаПисем() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ДоступнаОтправкаПисем() +``` +
+ +## УчетнаяЗаписьНастроена +
+ +Описание, пример вызова + +```bsl + +// Проверяет, настроена ли учетная запись для отправки и/или получения почты. +// +// Параметры: +// УчетнаяЗапись - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - проверяемая учетная запись; +// ДляОтправки - Булево - проверять параметры, необходимые для отправки почты; +// ДляПолучения - Булево - проверять параметры, необходимые для получения почты. +// +// Возвращаемое значение: +// Булево - Истина, если настроена. +// +Функция УчетнаяЗаписьНастроена(УчетнаяЗапись, Знач ДляОтправки = Неопределено, Знач ДляПолучения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.УчетнаяЗаписьНастроена(УчетнаяЗапись, ДляОтправки, ДляПолучения); +``` +
+ +## ПроверитьВозможностьОтправкиИПолученияЭлектроннойПочты +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку настроек электронной почты. +// +// Параметры: +// УчетнаяЗапись - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - проверяемая почта. +// СообщениеОбОшибке - Строка - текст сообщения об ошибке либо пустая строка, если ошибок не было. +// ДополнительноеСообщение - Строка - сообщения о том, какие проверки были выполнены для почты. +// +Процедура ПроверитьВозможностьОтправкиИПолученияЭлектроннойПочты(УчетнаяЗапись, СообщениеОбОшибке, ДополнительноеСообщение) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениями.ПроверитьВозможностьОтправкиИПолученияЭлектроннойПочты(УчетнаяЗапись, СообщениеОбОшибке, ДополнительноеСообщение) +``` +
+ +## ЕстьВнешниеРесурсы +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие в документе HTML ссылок на ресурсы, загружаемые по HTTP(s). +// +// Параметры: +// ДокументHTML - ДокументHTML - документ HTML, в котором необходимо выполнить проверку. +// +// Возвращаемое значение: +// Булево - Истина, если в документе HTML есть внешние ресурсы. +// +Функция ЕстьВнешниеРесурсы(ДокументHTML) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ЕстьВнешниеРесурсы(ДокументHTML) +``` +
+ +## ОтключитьНебезопасноеСодержимое +
+ +Описание, пример вызова + +```bsl + +// Удаляет из документа HTML скрипты, обработчики событий, а также очищает ссылки на ресурсы, загружаемые по HTTP(s). +// +// Параметры: +// ДокументHTML - ДокументHTML - документ HTML, в котором необходимо очистить небезопасное содержимое. +// ОтключитьВнешниеРесурсы - Булево - признак необходимости очистки ссылок на ресурсы, загружаемые по HTTP(s). +// +Процедура ОтключитьНебезопасноеСодержимое(ДокументHTML, ОтключитьВнешниеРесурсы = Истина) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениями.ОтключитьНебезопасноеСодержимое(ДокументHTML, ОтключитьВнешниеРесурсы); +``` +
+ +## ПоясненияПоОшибке +
+ +Описание, пример вызова + +```bsl + +// Получает с сайта ИТС рекомендации по устранению ошибки подключения к почтовому серверу. +// +// Параметры: +// ТекстОшибки - Строка - исходный текст ошибки. +// +// Возвращаемое значение: +// Структура: +// * ВозможныеПричины - Массив из ФорматированнаяСтрока +// * СпособыУстранения - Массив из ФорматированнаяСтрока +// +Функция ПоясненияПоОшибке(ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ПоясненияПоОшибке(ТекстОшибки) +``` +
+ +## РасширенноеПредставлениеОшибки +
+ +Описание, пример вызова + +```bsl + +// Подготавливает расширенное описание ошибки подключения к почтовому серверу. +// +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке +// КодЯзыка - Строка - код языка реквизита. Например, "ru". +// ВключитьПодробноеПредставлениеОшибки - Булево - добавляет в текст ошибки стек. +// +// Возвращаемое значение: +// Строка +// +Функция РасширенноеПредставлениеОшибки(ИнформацияОбОшибке, КодЯзыка, ВключитьПодробноеПредставлениеОшибки = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.РасширенноеПредставлениеОшибки(ИнформацияОбОшибке, КодЯзыка, ВключитьПодробноеПредставлениеОшибки); +``` +
+ +## ПоляИнтернетПочтовогоСообщения +
+ +Описание, пример вызова + +```bsl + +// Возвращает список имен полей объекта ИнтернетПочтовоеСообщение. +// +// Возвращаемое значение: +// Структура: +// * АдресаУведомленияОДоставке - Строка +// * АдресаУведомленияОПрочтении - Строка +// * Важность - Строка +// * Вложения - Строка +// * ДатаОтправления - Строка +// * ДатаПолучения - Строка +// * Заголовок - Строка +// * Идентификатор - Строка +// * ИдентификаторСообщения - Строка +// * ИмяОтправителя - Строка +// * Категории - Строка +// * Кодировка - Строка +// * Копии - Строка +// * ОбратныйАдрес - Строка +// * Отправитель - Строка +// * Получатели - Строка +// * Размер - Строка +// * СлепыеКопии - Строка +// * СмещениеДатыОтправления - Строка +// * СтатусРазбора - Строка +// * Тема - Строка +// * Тексты - Строка +// * СпособКодированияНеASCIIСимволов - Строка +// * УведомитьОДоставке - Строка +// * УведомитьОПрочтении - Строка +// * Частичное - Строка +// +Функция ПоляИнтернетПочтовогоСообщения() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ПоляИнтернетПочтовогоСообщения() +``` +
+ +## ПодготовитьПисьмо +
+ +Описание, пример вызова + +```bsl + +// Формирует письмо по переданным параметрам. +// +// Параметры: +// УчетнаяЗапись - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - ссылка на +// учетную запись электронной почты. +// ПараметрыПисьма - Структура - содержит всю необходимую информацию о письме: +// +// * Кому - Массив +// - Строка - интернет адреса получателей письма. +// - Массив - коллекция структур адресов: +// * Адрес - Строка - почтовый адрес (должно быть обязательно заполнено). +// * Представление - Строка - имя адресата. +// - Строка - интернет-адреса получателей письма, разделитель - ";". +// +// * ПолучателиСообщения - Массив - массив структур, описывающий получателей: +// ** Адрес - Строка - почтовый адрес получателя сообщения. +// ** Представление - Строка - представление адресата. +// +// * Копии - Массив +// - Строка - адреса получателей копий письма. См. описание поля Кому. +// +// * СкрытыеКопии - Массив +// - Строка - адреса получателей скрытых копий письма. См. описание поля Кому. +// +// * Тема - Строка - (обязательный) тема почтового сообщения. +// * Тело - Строка - (обязательный) текст почтового сообщения (простой текст в кодировке win-1251). +// * Важность - ВажностьИнтернетПочтовогоСообщения +// +// * Вложения - Массив - файлы, которые необходимо приложить к письму (описания в виде структур): +// ** Представление - Строка - имя файла вложения; +// ** АдресВоВременномХранилище - Строка - адрес двоичных данных вложения во временном хранилище. +// ** Кодировка - Строка - кодировка вложения (используется, если отличается от кодировки письма). +// ** Идентификатор - Строка - (необязательный) используется для отметки картинок, отображаемых в теле письма. +// +// * АдресОтвета - Соответствие +// - Строка - см. описание поля Кому. +// * ИдентификаторыОснований - Строка - идентификаторы оснований данного письма. +// * ОбрабатыватьТексты - Булево - необходимость обрабатывать тексты письма при отправке. +// * УведомитьОДоставке - Булево - необходимость запроса уведомления о доставке. +// * УведомитьОПрочтении - Булево - необходимость запроса уведомления о прочтении. +// * ТипТекста - Строка +// - ПеречислениеСсылка.ТипыТекстовЭлектронныхПисем +// - ТипТекстаПочтовогоСообщения - определяет тип +// переданного теста допустимые значения: +// HTML/ТипыТекстовЭлектронныхПисем.HTML - текст почтового сообщения в формате HTML. +// ПростойТекст/ТипыТекстовЭлектронныхПисем.ПростойТекст - простой текст почтового сообщения. +// Отображается "как есть" (значение по +// умолчанию). +// РазмеченныйТекст/ТипыТекстовЭлектронныхПисем.РазмеченныйТекст - текст почтового сообщения в формате +// Rich Text. +// +// Возвращаемое значение: +// ИнтернетПочтовоеСообщение - подготовленное письмо. +// +Функция ПодготовитьПисьмо(УчетнаяЗапись, ПараметрыПисьма) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ПодготовитьПисьмо(УчетнаяЗапись, ПараметрыПисьма) +``` +
+ +## ПодключениеКПочте +
+ +Описание, пример вызова + +```bsl + +// Создает открытое подключение к почтовому серверу. Может вызывать исключение, которое необходимо обработать. +// +// Параметры: +// УчетнаяЗапись - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - настройки подключения к почте; +// ДляПолучения - Булево - если Истина, то подключение будет выполняться к серверу входящей почты, +// если Ложь, то к серверу исходящей почты. +// +// Возвращаемое значение: +// ИнтернетПочта +// +Функция ПодключениеКПочте(Знач УчетнаяЗапись, Знач ДляПолучения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ПодключениеКПочте(УчетнаяЗапись, ДляПолучения); +``` +
+ +## ОтправитьПочтовоеСообщение +
+ +Описание, пример вызова + +```bsl + +// Выполняет отправку почтовых сообщений. +// Функция может вызвать исключение, которое требуется обработать. +// +// Параметры: +// УчетнаяЗапись - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - ссылка на +// учетную запись электронной почты. +// ПараметрыОтправки - Структура - содержит всю необходимую информацию о письме: +// +// * Кому - Массив +// - Строка - интернет адреса получателей письма. +// - Массив - коллекция структур адресов: +// * Адрес - Строка - почтовый адрес (должно быть обязательно заполнено). +// * Представление - Строка - имя адресата. +// - Строка - интернет-адреса получателей письма, разделитель - ";". +// +// * ПолучателиСообщения - Массив - массив структур, описывающий получателей: +// ** Адрес - Строка - почтовый адрес получателя сообщения. +// ** Представление - Строка - представление адресата. +// +// * Копии - Массив +// - Строка - адреса получателей копий письма. См. описание поля Кому. +// +// * СкрытыеКопии - Массив +// - Строка - адреса получателей скрытых копий письма. См. описание поля Кому. +// +// * Тема - Строка - (обязательный) тема почтового сообщения. +// * Тело - Строка - (обязательный) текст почтового сообщения (простой текст в кодировке win-1251). +// * Важность - ВажностьИнтернетПочтовогоСообщения +// +// * Вложения - Массив - файлы, которые необходимо приложить к письму (описания в виде структур): +// ** Представление - Строка - имя файла вложения; +// ** АдресВоВременномХранилище - Строка - адрес двоичных данных вложения во временном хранилище. +// ** Кодировка - Строка - кодировка вложения (используется, если отличается от кодировки письма). +// ** Идентификатор - Строка - (необязательный) используется для отметки картинок, отображаемых в теле письма. +// +// * АдресОтвета - Соответствие +// - Строка - см. описание поля Кому. +// * ИдентификаторОснования - Строка - идентификатор основания данного письма. +// * ИдентификаторыОснований - Строка - идентификаторы оснований данного письма. +// * ОбрабатыватьТексты - Булево - необходимость обрабатывать тексты письма при отправке. +// * УведомитьОДоставке - Булево - необходимость запроса уведомления о доставке. +// * УведомитьОПрочтении - Булево - необходимость запроса уведомления о прочтении. +// * ТипТекста - Строка +// - ПеречислениеСсылка.ТипыТекстовЭлектронныхПисем +// - ТипТекстаПочтовогоСообщения - определяет тип +// переданного теста допустимые значения: +// HTML/ТипыТекстовЭлектронныхПисем.HTML - текст почтового сообщения в формате HTML. +// ПростойТекст/ТипыТекстовЭлектронныхПисем.ПростойТекст - простой текст почтового сообщения. +// Отображается "как есть" (значение по +// умолчанию). +// РазмеченныйТекст/ТипыТекстовЭлектронныхПисем.РазмеченныйТекст - текст почтового сообщения в формате +// Rich Text. +// * Соединение - ИнтернетПочта - существующее соединение с почтовым сервером. Если не указано, то создается новое. +// * ПротоколПочты - Строка - если указано значение "IMAP", то письмо будет передано по протоколу IMAP, если по +// указано значение "Все", то по протоколу SMTP и по протоколу IMAP, если ничего не указано +// то по протоколу SMTP. Параметр имеет смысл, только наличии действующего соединения, +// указанного в параметр Соединение. В противном случае протокол будет определен +// автоматически при установке соединения. +// * ИдентификаторСообщения - Строка - (возвращаемый параметр) идентификатор отправленного почтового сообщения на SMTP-сервере; +// * ИдентификаторСообщенияОтправкаIMAP - Строка - (возвращаемый параметр) идентификатор отправленного почтового +// сообщения на IMAP сервере; +// * ОшибочныеПолучатели - Соответствие - (возвращаемый параметр) список адресов, по которым отправка не выполнена. +// См. возвращаемое значение метода ИнтернетПочта.Послать() в синтакс-помощнике. +// +// УдалитьСоединение - ИнтернетПочта - параметр устарел, см. параметр ПараметрыОтправки.Соединение. +// УдалитьПротоколПочты - Строка - параметр устарел, см. параметр ПараметрыОтправки.ПротоколПочты. +// +// Возвращаемое значение: +// Строка - идентификатор отправленного сообщения. +// +Функция ОтправитьПочтовоеСообщение(Знач УчетнаяЗапись, Знач ПараметрыОтправки, Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениями.ОтправитьПочтовоеСообщение(УчетнаяЗапись, ПараметрыОтправки, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСПочтовымиСообщениямиКлиент.md b/src/content/docs/bsp/РаботаСПочтовымиСообщениямиКлиент.md new file mode 100644 index 0000000..5df8790 --- /dev/null +++ b/src/content/docs/bsp/РаботаСПочтовымиСообщениямиКлиент.md @@ -0,0 +1,141 @@ +--- +title: Работа с почтовыми сообщениями клиент +slug: bsp/работа-с-почтовыми-сообщениями-клиент +--- + + +## СоздатьНовоеПисьмо +
+ +Описание, пример вызова + +```bsl + +// Открывает форму создания нового письма. +// +// Параметры: +// ПараметрыОтправкиПисьма - см. РаботаСПочтовымиСообщениямиКлиент.ПараметрыОтправкиПисьма. +// ОповещениеОЗакрытииФормы - ОписаниеОповещения - процедура, в которую необходимо передать управление после закрытия +// формы отправки письма. +// +Процедура СоздатьНовоеПисьмо(ПараметрыОтправкиПисьма = Неопределено, ОповещениеОЗакрытииФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиКлиент.СоздатьНовоеПисьмо(ПараметрыОтправкиПисьма, ОповещениеОЗакрытииФормы); +``` +
+ +## ПараметрыОтправкиПисьма +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую структуру с параметрами отправки письма. +// +// Возвращаемое значение: +// Структура - параметры для заполнения в форме отправки нового письма (все необязательные): +// * Отправитель - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - учетная запись, с которой может +// быть отправлено почтовое сообщение; +// - СписокЗначений - список учетных записей, доступных для выбора в форме: +// ** Представление - Строка - наименование почты; +// ** Значение - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - учетная запись. +// +// * Получатель - Строка - список адресов в формате: +// [ПредставлениеПолучателя1] <Адрес1>; [[ПредставлениеПолучателя2] <Адрес2>;...] +// - СписокЗначений: +// ** Представление - Строка - представление получателя, +// ** Значение - Строка - почтовый адрес. +// - Массив - массив структур, описывающий получателей: +// ** Адрес - Строка - почтовый адрес получателя сообщения; +// ** Представление - Строка - представление адресата; +// ** ИсточникКонтактнойИнформации - СправочникСсылка - владелец контактной информации. +// +// * Копии - СписокЗначений +// - Строка - см. описание поля Получатель. +// * СкрытыеКопии - СписокЗначений +// - Строка - см. описание поля Получатель. +// * Тема - Строка - тема письма. +// * Текст - Строка - тело письма. +// +// * Вложения - Массив - файлы, которые необходимо приложить к письму (описания в виде структур): +// ** Представление - Строка - имя файла вложения; +// ** АдресВоВременномХранилище - Строка - адрес двоичных данных либо табличного документа во временном хранилище. +// ** Кодировка - Строка - кодировка вложения (используется, если отличается от кодировки письма). +// ** Идентификатор - Строка - (необязательный) используется для отметки картинок, отображаемых в теле письма. +// +// * УдалятьФайлыПослеОтправки - Булево - удалять временные файлы после отправки сообщения. +// * Предмет - ЛюбаяСсылка - предмет письма. +// * ИнтерактивныйВыборПолучателей - Булево - если указать Истина, то при подготовке нового письма всегда +// запрашивать выбор контактов. В противном случае в исходящее письмо автоматически подбираются все +// подходящие контакты из документа, что может быть неудобно, когда контактов очень много. +// +Функция ПараметрыОтправкиПисьма() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСПочтовымиСообщениямиКлиент.ПараметрыОтправкиПисьма() +``` +
+ +## ПроверитьНаличиеУчетнойЗаписиДляОтправкиПочты +
+ +Описание, пример вызова + +```bsl + +// Если у пользователя нет настроенной почты для отправки писем, то в зависимости от прав либо показывает +// помощник настройки новой почты, либо выводит сообщение о невозможности отправки. +// Предназначена для сценариев, в которых требуется выполнить настройку почты перед запросом дополнительных +// параметров отправки. +// +// Параметры: +// ОбработчикРезультата - ОписаниеОповещения - процедура, в которую необходимо передать выполнение кода после проверки. +// В качестве результата возвращается Истина, если есть доступная учетная +// запись для отправки почты. Иначе возвращается Ложь. +// +Процедура ПроверитьНаличиеУчетнойЗаписиДляОтправкиПочты(ОбработчикРезультата) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиКлиент.ПроверитьНаличиеУчетнойЗаписиДляОтправкиПочты(ОбработчикРезультата) +``` +
+ +## СообщитьОбОшибкеПодключения +
+ +Описание, пример вызова + +```bsl + +// Открывает форму сообщения об ошибке, в которой помимо текста ошибки сообщаются возможные причины +// и способы устранения. +// +// Параметры: +// УчетнаяЗапись - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты +// Заголовок - Строка - текст заголовка в открываемой форме. +// ТекстОшибки - Строка - исходный текст исключения, рекомендуется передавать КраткоеПредставлениеОшибки. +// +Процедура СообщитьОбОшибкеПодключения(УчетнаяЗапись, Заголовок, ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиКлиент.СообщитьОбОшибкеПодключения(УчетнаяЗапись, Заголовок, ТекстОшибки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСПочтовымиСообщениямиКлиентПереопределяемый.md b/src/content/docs/bsp/РаботаСПочтовымиСообщениямиКлиентПереопределяемый.md new file mode 100644 index 0000000..b4924bc --- /dev/null +++ b/src/content/docs/bsp/РаботаСПочтовымиСообщениямиКлиентПереопределяемый.md @@ -0,0 +1,39 @@ +--- +title: Работа с почтовыми сообщениями клиент переопределяемый +slug: bsp/работа-с-почтовыми-сообщениями-клиент-переопределяемый +--- + + +## ПередОткрытиемФормыОтправкиПисьма +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед открытием формы нового письма. +// Открытие формы может быть отменено изменением параметра СтандартнаяОбработка. +// +// Параметры: +// ПараметрыОтправки - см. РаботаСПочтовымиСообщениямиКлиент.ПараметрыОтправкиПисьма +// ОбработчикЗавершения - ОписаниеОповещения - описание процедуры, которая будет вызвана после завершения +// отправки письма. +// СтандартнаяОбработка - Булево - признак продолжения открытия формы нового письма после выхода из этой +// процедуры. Если установить Ложь, форма письма открыта не будет. +// +Процедура ПередОткрытиемФормыОтправкиПисьма(ПараметрыОтправки, ОбработчикЗавершения, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиКлиентПереопределяемый.ПередОткрытиемФормыОтправкиПисьма(ПараметрыОтправки, ОбработчикЗавершения, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСПочтовымиСообщениямиЛокализация.md b/src/content/docs/bsp/РаботаСПочтовымиСообщениямиЛокализация.md new file mode 100644 index 0000000..39245ab --- /dev/null +++ b/src/content/docs/bsp/РаботаСПочтовымиСообщениямиЛокализация.md @@ -0,0 +1,99 @@ +--- +title: Работа с почтовыми сообщениями локализация +slug: bsp/работа-с-почтовыми-сообщениями-локализация +--- + + +## ПриПолученииАдресовСерверовDNS +
+ +Описание, пример вызова + +```bsl + +// Устанавливает IP-адреса серверов DNS, которые могут использоваться для чтения MX-записей доменов. +// +// Параметры: +// АдресаСерверовDNS - Массив из Строка - IP-адреса; +// СтандартнаяОбработка - Булево - установить в Ложь, если в список не требуется добавлять стандартные +// +Процедура ПриПолученииАдресовСерверовDNS(АдресаСерверовDNS, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиЛокализация.ПриПолученииАдресовСерверовDNS(АдресаСерверовDNS, СтандартнаяОбработка) +``` +
+ +## ПриПолученииАдресаФайлаСНастройками +
+ +Описание, пример вызова + +```bsl + +// Определяет адрес файла с настройками подключения к почтовым серверам. +// +// Параметры: +// АдресФайла - Строка - URL файла с настройками подключения к почтовым серверам. +// +Процедура ПриПолученииАдресаФайлаСНастройками(АдресФайла) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиЛокализация.ПриПолученииАдресаФайлаСНастройками(АдресФайла) +``` +
+ +## ПриПолученииАдресаФайлаСОписаниемОшибок +
+ +Описание, пример вызова + +```bsl + +// Определяет адрес файла с описанием ошибок подключения к почтовым серверам. +// +// Параметры: +// АдресФайла - Строка - URL файла с описанием ошибок подключения к почтовым серверам. +// +Процедура ПриПолученииАдресаФайлаСОписаниемОшибок(АдресФайла) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиЛокализация.ПриПолученииАдресаФайлаСОписаниемОшибок(АдресФайла) +``` +
+ +## ПриПолученииАдресаВнешнегоРесурса +
+ +Описание, пример вызова + +```bsl + +// Определяет адрес внешнего ресурса для механизма профилей безопасности. +// См. РаботаВБезопасномРежимеПереопределяемый.ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам. +// +// Параметры: +// АдресВнешнегоРесурса - Строка - адрес внешнего ресурса. +// +Процедура ПриПолученииАдресаВнешнегоРесурса(АдресВнешнегоРесурса) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиЛокализация.ПриПолученииАдресаВнешнегоРесурса(АдресВнешнегоРесурса) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСПочтовымиСообщениямиПереопределяемый.md b/src/content/docs/bsp/РаботаСПочтовымиСообщениямиПереопределяемый.md new file mode 100644 index 0000000..f9c7306 --- /dev/null +++ b/src/content/docs/bsp/РаботаСПочтовымиСообщениямиПереопределяемый.md @@ -0,0 +1,159 @@ +--- +title: Работа с почтовыми сообщениями переопределяемый +slug: bsp/работа-с-почтовыми-сообщениями-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Переопределяет настройки подсистемы. +// +// Параметры: +// Настройки - Структура: +// * ДоступноПолучениеПисем - Булево - показывать настройки получения писем в учетных записях. +// Значение по умолчанию: для базовых версий конфигурации - Ложь, +// для остальных - Истина. +// * ИспользоватьПротоколPOP3 - Булево - показывать включить или выключить отображение настроек POP3 +// для новых почтовых настроек. Значение по умолчанию Истина. +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПослеОтправкиПисьма +
+ +Описание, пример вызова + +```bsl + +// Позволяет выполнить дополнительные операции после отправки почтового сообщения. +// +// Параметры: +// ПараметрыПисьма - Структура - содержит всю необходимую информацию о письме: +// * Кому - Массив - (обязательный) интернет-адрес получателя письма. +// Адрес - строка - почтовый адрес. +// Представление - строка - имя адресата. +// +// * ПолучателиСообщения - Массив - массив структур, описывающий получателей: +// * ИсточникКонтактнойИнформации - СправочникСсылка - владелец контактной информации. +// * Адрес - Строка - почтовый адрес получателя сообщения. +// * Представление - Строка - представление адресата. +// +// * Копии - Массив - коллекция структур адресов: +// * Адрес - Строка - почтовый адрес (должно быть обязательно заполнено). +// * Представление - Строка - имя адресата. +// +// - Строка - интернет-адреса получателей письма, разделитель - ";". +// +// * СкрытыеКопии - Массив +// - Строка - см. описание поля Копии. +// +// * Тема - Строка - (обязательный) тема почтового сообщения. +// * Тело - Строка - (обязательный) текст почтового сообщения (простой текст в кодировке win-1251). +// * Важность - ВажностьИнтернетПочтовогоСообщения. +// * Вложения - Соответствие из КлючИЗначение: +// * ключ - Строка - наименование вложения +// * значение - ДвоичныеДанные +// - Строка - адрес во временном хранилище двоичных данных вложения; +// - Структура: +// * ДвоичныеДанные - ДвоичныеДанные - двоичные данные вложения. +// * Идентификатор - Строка - идентификатор вложения, используется для хранения картинок, +// отображаемых в теле письма. +// +// * АдресОтвета - Соответствие - см. описание поля Кому. +// * Пароль - Строка - пароль для доступа к почте. +// * ИдентификаторыОснований - Строка - идентификаторы оснований данного письма. +// * ОбрабатыватьТексты - Булево - необходимость обрабатывать тексты письма при отправке. +// * УведомитьОДоставке - Булево - необходимость запроса уведомления о доставке. +// * УведомитьОПрочтении - Булево - необходимость запроса уведомления о прочтении. +// * ТипТекста - Строка +// - ПеречислениеСсылка.ТипыТекстовЭлектронныхПисем +// - ТипТекстаПочтовогоСообщения - определяет тип +// переданного теста допустимые значения: +// HTML/ТипыТекстовЭлектронныхПисем.HTML - текст почтового сообщения в формате HTML; +// ПростойТекст/ТипыТекстовЭлектронныхПисем.ПростойТекст - простой текст почтового сообщения. +// Отображается "как есть" (значение по +// умолчанию); +// РазмеченныйТекст/ТипыТекстовЭлектронныхПисем.РазмеченныйТекст - текст почтового сообщения в формате +// Rich Text. +// +Процедура ПослеОтправкиПисьма(ПараметрыПисьма) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиПереопределяемый.ПослеОтправкиПисьма(ПараметрыПисьма) +``` +
+ +## ПередПолучениемСтатусовПисем +
+ +Описание, пример вызова + +```bsl + +// Определяет список писем, для которых необходимо получить статус доставки/прочтения. +// Пример определения списка писем см. в РассылкаОтчетов.ПередПолучениемСтатусовПисем +// +// Параметры: +// ИдентификаторыПисем - ТаблицаЗначений: +// * Отправитель - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты +// * ИдентификаторПисьма - Строка +// * АдресПолучателя - Строка - электронная почта получателя письма +// +Процедура ПередПолучениемСтатусовПисем(ИдентификаторыПисем) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиПереопределяемый.ПередПолучениемСтатусовПисем(ИдентификаторыПисем) +``` +
+ +## ПослеПолученияСтатусовПисем +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения только об известных статусах доставки (если были получены соответствующие письма). +// Пример обработки полученных статусов писем см. в РассылкаОтчетов.ПослеПолученияСтатусовПисем +// +// Параметры: +// СтатусыДоставки - ТаблицаЗначений: +// * Отправитель - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты +// * ИдентификаторПисьма - Строка +// * АдресПолучателя - Строка - электронная почта получателя письма +// * Статус - ПеречислениеСсылка.СтатусыЭлектронныхПисем +// * ДатаИзмененияСтатуса - Дата +// * Причина - Строка - причина недоставки письма +// +Процедура ПослеПолученияСтатусовПисем(СтатусыДоставки) Экспорт +``` + +Пример вызова +```bsl +РаботаСПочтовымиСообщениямиПереопределяемый.ПослеПолученияСтатусовПисем(СтатусыДоставки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСФайлами.md b/src/content/docs/bsp/РаботаСФайлами.md new file mode 100644 index 0000000..4340ea8 --- /dev/null +++ b/src/content/docs/bsp/РаботаСФайлами.md @@ -0,0 +1,1117 @@ +--- +title: Работа с файлами +slug: bsp/работа-с-файлами +--- + + +## ДвоичныеДанныеФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает двоичные данные файла. +// +// Параметры: +// ПрисоединенныйФайл - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// +// ВызыватьИсключение - Булево - если указать Ложь, то функция будет возвращать Неопределено +// вместо вызова исключений, уровень записи журнала регистрации будет понижен до "Предупреждение". +// Значение по умолчанию - Истина. +// +// Возвращаемое значение: +// ДвоичныеДанные, Неопределено - двоичные данные присоединенного файла. Если двоичные данные файла не найдены +// в информационной базе или в томах, вызывает исключение. Если двоичные данные не +// найдены и параметр ВызыватьИсключение принимает значение Ложь, тогда +// возвращаемое значение - Неопределено. +// +// Пример: +// Сохранение данных файла на сервере: +// ДанныеФайла = РаботаСФайлами.ДвоичныеДанныеФайла(Файл, Ложь); +// Если ДанныеФайла <> Неопределено Тогда +// ДанныеФайла.Записать(ПутьКФайлу); +// КонецЕсли; +// +Функция ДвоичныеДанныеФайла(Знач ПрисоединенныйФайл, Знач ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ДвоичныеДанныеФайла(ПрисоединенныйФайл, ВызыватьИсключение); +``` +
+ +## ДвоичныеДанныеФайлов +
+ +Описание, пример вызова + +```bsl + +// Возвращает двоичные данные файла. +// +// Параметры: +// ПрисоединенныеФайлы - Массив из ОпределяемыйТип.ПрисоединенныйФайл - массив элементов справочника с файлом, все +// элементы должны быть одного типа. +// +// ВызыватьИсключение - Булево - если указать Ложь, то функция будет возвращать Неопределено +// вместо вызова исключений, уровень записи журнала регистрации будет понижен до "Предупреждение". +// Значение по умолчанию - Истина. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ОпределяемыйТип.ПрисоединенныйФайл - файл из параметра ПрисоединенныеФайлы. +// * Значение - ДвоичныеДанные - двоичные данные присоединенного файла. Если двоичные данные файла не существуют +// в информационной базе или в томах, вызывает исключение. Если двоичные данные не +// существуют и параметр ВызыватьИсключение принимает значение Ложь, тогда +// запись для такого файла будет отсутствовать. +// +Функция ДвоичныеДанныеФайлов(Знач ПрисоединенныеФайлы, Знач ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ДвоичныеДанныеФайлов(ПрисоединенныеФайлы, ВызыватьИсключение); +``` +
+ +## ДанныеФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения о файле. Используется в различных командах работы с файлами +// и как значение параметра ДанныеФайла в других процедурах и функциях. +// +// Параметры: +// ПрисоединенныйФайл - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// ДополнительныеПараметры - см. РаботаСФайламиКлиентСервер.ПараметрыДанныхФайла. +// УдалитьПолучатьСсылкуНаДвоичныеДанные - Булево - устарел, следует использовать ДополнительныеПараметры. +// УдалитьДляРедактирования - Булево - устарел, следует использовать ДополнительныеПараметры. +// +// Возвращаемое значение: +// Структура, Неопределено - информация о присоединенном файле. Если файл не найден или +// отсутствует часть обязательной информации о файле и свойство ВызыватьИсключение параметра +// ДополнительныеПараметры принимает значение Ложь, возвращаемое значение - Неопределено. Если файл +// не найден или отсутствует часть обязательной информации о файле и ВызыватьИсключение отсутствует +// или принимает значение Истина, вызывает исключение. Свойства структуры: +// * Ссылка - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// * СсылкаНаДвоичныеДанныеФайла - Строка - адрес во временном хранилище, по которому помещены данные файла. +// * Владелец - ОпределяемыйТип.ВладелецФайлов - ссылка объект-владелец файла. +// * ОтносительныйПуть - Строка - относительный путь файла. +// * ДатаМодификацииУниверсальная - Дата - дата изменения файла в UTC. +// * ИмяФайла - Строка - имя файла, например, "документ.txt". +// * Наименование - Строка - наименование файла (в справочнике хранения файлов). +// * Расширение - Строка - расширение файла без точки. +// * Размер - Число - размер файла в байтах. +// * Редактирует - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// - Неопределено - пользователь, занявший файл для редактирования. +// * ДатаЗаема - Дата - дата и время, когда файл был открыт для редактирования. +// * ПодписанЭП - Булево - признак того, что файл подписан. +// * Зашифрован - Булево - признак того, что файл зашифрован. +// * МассивСертификатовШифрования - см. ЭлектроннаяПодпись.СертификатыШифрования +// * ПометкаУдаления - Булево - признак того, что файл помечен на удаление. +// * НавигационнаяСсылка - Строка - навигационная ссылка на файл. +// * ХранитьВерсии - Булево - признак того, что у файла хранятся версии. +// * ТекущаяВерсия - ОпределяемыйТип.ПрисоединенныйФайл - если справочник файлов поддерживает создание +// версий, содержит ссылку на текущую версию файла. В ином случае содержит +// ссылку на файл. +// * Версия - ОпределяемыйТип.ПрисоединенныйФайл - аналогично выше. +// * НомерВерсии - Число - если справочник файлов поддерживает создание версий, содержит номер +// текущей версии файла, иначе - 0. +// * АвторТекущейВерсии - СправочникСсылка.УчетныеЗаписиСинхронизацииФайлов +// - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи - пользователь, отредактировавший файл. +// * Том - СправочникСсылка.ТомаХраненияФайлов - том хранения файла. +// * Автор - СправочникСсылка.УчетныеЗаписиСинхронизацииФайлов +// - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи - автор файла. +// * СтатусИзвлеченияТекста - Строка - статус извлечения текста из файла. +// * ПолноеНаименованиеВерсии - Строка - если справочник файлов поддерживает создание версий, содержит полное +// наименование текущей версии файла. В ином случае содержит полное +// наименование файла. +// * КодировкаТекущейВерсии - Строка - кодировка текстового файла. +// * НаЧтение - Булево - признак того, что файл редактируется пользователем, отличным от текущего. +// * ПолноеИмяФайлаВРабочемКаталоге - Строка - путь к файлу в рабочем каталоге. +// * ВРабочемКаталогеНаЧтение - Булево - файл в рабочем каталоге помечен только для чтения. +// * РабочийКаталогВладельца - Строка - путь к рабочему каталогу владельца. +// * ПапкаДляСохранитьКак - Строка - путь к каталогу сохранения. +// * ФайлРедактируется - Булево - признак того, что файл занят для редактирования. +// * ФайлРедактируетТекущийПользователь - Булево - признак того, что файл занят для редактирования текущим пользователем. +// * Кодировка - Строка - кодировка текстового файла. +// * Служебный - Булево - признак того, что файл является служебным. +// +// Пример: +// +// // В этом примере установка идентификатора формы в параметре ДополнительныеПараметры предотвращает преждевременную +// // очистку временного хранилища из-за возможных серверных вызовов при открытии файлов (например, +// // если файл зашифрован или когда открывается форма текстового или табличного редактора). +// +// // Открытие нескольких файлов. +// ПараметрыДанныхФайла = РаботаСФайламиКлиентСервер.ПараметрыДанныхФайла(); +// ПараметрыДанныхФайла.ИдентификаторФормы = УникальныйИдентификатор; +// Пока Выборка.Следующий() Цикл +// МассивДанныхФайлов.Добавить(РаботаСФайлами.ДанныеФайла(Выборка.Файл, ПараметрыДанныхФайла)); +// КонецЦикла; +// +Функция ДанныеФайла(Знач ПрисоединенныйФайл, Знач ДополнительныеПараметры = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ДанныеФайла(ПрисоединенныйФайл, ДополнительныеПараметры, ); +``` +
+ +## ЗаполнитьПрисоединенныеФайлыКОбъекту +
+ +Описание, пример вызова + +```bsl + +// Находит все присоединенные к объекту файлы и добавляет ссылки на них в параметр Файлы. +// +// Параметры: +// ВладелецФайла - ОпределяемыйТип.ВладелецПрисоединенныхФайлов +// Файлы - Массив из ОпределяемыйТип.ПрисоединенныйФайл - массив, в который будут добавлены ссылки на файлы объекта. +// +Процедура ЗаполнитьПрисоединенныеФайлыКОбъекту(Знач ВладелецФайла, Знач Файлы) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.ЗаполнитьПрисоединенныеФайлыКОбъекту(ВладелецФайла, Файлы) +``` +
+ +## НоваяСсылкаНаФайл +
+ +Описание, пример вызова + +```bsl + +// Возвращает новую ссылку на файл для указанного владельца файла. +// В частности, ссылка используется при добавлении файла в функции ДобавитьФайл. +// +// Параметры: +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект, к которому +// требуется прикрепить добавляемый файл. +// +// ИмяСправочника - Неопределено - вычислить справочник по владельцу (допустимо, +// когда справочник только один, иначе будет вызвано исключение). +// +// - Строка - имя справочника *ПрисоединенныеФайлы, отличное +// от стандартного <ИмяВладельца>ПрисоединенныеФайлы. +// +// Возвращаемое значение: +// ОпределяемыйТип.ПрисоединенныйФайл - ссылка на новый еще не записанный элемент справочника с файлом. +// +Функция НоваяСсылкаНаФайл(ВладелецФайлов, ИмяСправочника = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.НоваяСсылкаНаФайл(ВладелецФайлов, ИмяСправочника); +``` +
+ +## ОбновитьФайл +
+ +Описание, пример вызова + +```bsl + +// Обновляет свойства файла без учета версий: двоичные данные, текст, дату изменения, +// а также другие необязательные свойства. Использовать только для файлов, которые не хранят версии. +// +// Параметры: +// ПрисоединенныйФайл - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// ИнформацияОФайле - Структура: +// * АдресФайлаВоВременномХранилище - Строка - адрес новых двоичных данных файла. +// * АдресВременногоХранилищаТекста - Строка - адрес новых двоичных данных текста, +// извлеченного из файла. +// * ИмяБезРасширения - Строка - необязательное, если свойство не указано или не заполнено, +// тогда не будет изменено. +// * ДатаМодификацииУниверсальная - Дата - необязательное, дата последнего изменения файла, если +// свойство не указано или не заполнено, тогда будет +// установлена текущая дата сеанса. +// * Расширение - Строка - необязательное, новое расширение файла. +// * Редактирует - ЛюбаяСсылка - необязательное, новый пользователь, редактирующий файл. +// * Кодировка - Строка - необязательное, кодировка, в которой сохранен файл. +// Список поддерживаемых кодировок см. в справке к методу +// глобального контекста "ПолучитьДвоичныеДанныеИзСтроки". +// +Процедура ОбновитьФайл(Знач ПрисоединенныйФайл, Знач ИнформацияОФайле) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.ОбновитьФайл(ПрисоединенныйФайл, ИнформацияОФайле) +``` +
+ +## ИмяФормыОбъектаФайловПоВладельцу +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя формы объекта присоединенных файлов по владельцу. +// +// Параметры: +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект, к которому +// требуется прикрепить добавляемый файл. +// +// Возвращаемое значение: +// Строка - полное имя формы объекта присоединенных файлов по владельцу. +// +Функция ИмяФормыОбъектаФайловПоВладельцу(Знач ВладелецФайлов) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ИмяФормыОбъектаФайловПоВладельцу(ВладелецФайлов) +``` +
+ +## КОбъектуМожноПрисоединятьФайлы +
+ +Описание, пример вызова + +```bsl + +// Определяет возможность прикрепления добавляемого файла к владельцу файлов. +// +// Параметры: +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект, к которому +// требуется прикрепить добавляемый файл. +// ИмяСправочника - Строка - если указано, то выполняется проверка добавления в определенное хранилище файлов. +// Иначе имя справочника будет определено по владельцу. +// +// Возвращаемое значение: +// Булево - если Истина, тогда к объекту можно присоединять файлы. +// +Функция КОбъектуМожноПрисоединятьФайлы(ВладелецФайлов, ИмяСправочника = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.КОбъектуМожноПрисоединятьФайлы(ВладелецФайлов, ИмяСправочника); +``` +
+ +## ДобавитьФайлСДиска +
+ +Описание, пример вызова + +```bsl + +// Добавляет новый файл из файловой системы. +// Если справочник файлов поддерживает хранение версий, то будет создана первая версия файла. +// +// Параметры: +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект, к которому +// требуется прикрепить добавляемый файл. +// ПутьКФайлуНаДиске - Строка - полный путь к файлу, включающий имя и расширение файла. +// Файл должен находиться на сервере. +// +// Возвращаемое значение: +// ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с созданным файлом. +// +Функция ДобавитьФайлСДиска(ВладелецФайлов, ПутьКФайлуНаДиске) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ДобавитьФайлСДиска(ВладелецФайлов, ПутьКФайлуНаДиске) +``` +
+ +## УстановитьПометкуУдаленияФайловДокументовПередЗаписью +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПередЗаписью объектов-владельцев файлов, +// помечает присоединенные файлы на удаление при пометке объекта-владельца. +// Подходит только для документов. +// +// Параметры: +// Источник - ДокументОбъект - документ с присоединенными файлами. +// Отказ - Булево - стандартный параметр обработчика ПередЗаписью. +// РежимЗаписи - РежимЗаписиДокумента - стандартный параметр обработчика ПередЗаписью. +// РежимПроведения - РежимПроведенияДокумента - стандартный параметр обработчика ПередЗаписью. +// +Процедура УстановитьПометкуУдаленияФайловДокументовПередЗаписью(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.УстановитьПометкуУдаленияФайловДокументовПередЗаписью(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## УстановитьПометкуУдаленияФайловПередЗаписью +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПередЗаписью объектов-владельцев файлов, +// помечает присоединенные файлы на удаление при пометке объекта-владельца. +// Подходит для ссылочных объектов, кроме документов. +// +// Параметры: +// Источник - ОпределяемыйТип.ВладелецПрисоединенныхФайловОбъект - объект с присоединенными файлами. +// Отказ - Булево - стандартный параметр обработчика ПередЗаписью. +// +Процедура УстановитьПометкуУдаленияФайловПередЗаписью(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.УстановитьПометкуУдаленияФайловПередЗаписью(Источник, Отказ) +``` +
+ +## ПараметрыДобавленияФайла +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для добавления файла. +// Для использования в РаботаСФайлами.ДобавитьФайл. +// +// Параметры: +// ДополнительныеРеквизиты - Строка +// - Массив - имена реквизитов присоединенного файла, перечисленные через +// запятую, или массив имен реквизитов. +// - Структура - коллекция дополнительных реквизитов. Стандартные свойства будут +// вставлены в коллекцию в случае отсутствия. +// +// Возвращаемое значение: +// Структура: +// * Автор - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// - СправочникСсылка.УчетныеЗаписиСинхронизацииФайлов - пользователь или +// учетная запись синхронизации файлов, от имени которого создается файл. +// Значение по умолчанию - Неопределено. +// * ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект, к которому +// требуется прикрепить добавляемый файл. +// Значение по умолчанию - Неопределено. +// * ИмяБезРасширения - Строка - имя файла без расширения. +// Значение по умолчанию - "". +// * РасширениеБезТочки - Строка - расширение файла (без точки вначале). +// Значение по умолчанию - "". +// * ВремяИзмененияУниверсальное - Дата - дата и время изменения файла (UTC+0:00). Если параметр принимает значение +// Неопределено, при добавлении файла время изменения будет установлено равным +// результату выполнения функции ТекущаяУниверсальнаяДата(). +// Значение по умолчанию - Неопределено. +// * ГруппаФайлов - ОпределяемыйТип.ПрисоединенныйФайл - группа справочника с файлами, в которую +// будет добавлен новый файл. +// Значение по умолчанию - Неопределено. +// * Служебный - Булево - если Истина, тогда файл будет скрыт от пользователей. +// Значение по умолчанию - Ложь. +// +Функция ПараметрыДобавленияФайла(ДополнительныеРеквизиты = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ПараметрыДобавленияФайла(ДополнительныеРеквизиты); +``` +
+ +## ДобавитьФайл +
+ +Описание, пример вызова + +```bsl + +// Создает объект в справочнике для хранения файла и заполняет его реквизиты переданными свойствами. +// +// Параметры: +// ПараметрыФайла - см. РаботаСФайлами.ПараметрыДобавленияФайла. +// АдресФайлаВоВременномХранилище - Строка - адрес, указывающий на двоичные данные во временном хранилище. +// АдресВременногоХранилищаТекста - Строка - адрес, указывающий на извлеченный текст из файла во временном хранилище. +// Описание - Строка - текстовое описание файла. +// НоваяСсылкаНаФайл - Неопределено - если у владельца файла только один справочник хранения файлов. +// - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника хранения файлов, +// которую следует использовать для добавляемого файла. +// Должна соответствовать одному из типов справочников хранения файлов владельца +// файлов. Ссылка может быть получена функцией НоваяСсылкаНаФайл. +// +// Возвращаемое значение: +// ОпределяемыйТип.ПрисоединенныйФайл - ссылка на созданный присоединенный файл. +// +Функция ДобавитьФайл(ПараметрыФайла, Знач АдресФайлаВоВременномХранилище, Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ДобавитьФайл(ПараметрыФайла, АдресФайлаВоВременномХранилище, ); +``` +
+ +## НастройкиРаботыСФайлами +
+ +Описание, пример вызова + +```bsl + +// Возвращает персональные настройки работы с файлами. +// +// Возвращаемое значение: +// Структура: +// * ПоказыватьЗанятыеФайлыПриЗавершенииРаботы - Булево - существует, только если внедрена подсистема Работа с +// файлами. +// * СпрашиватьРежимРедактированияПриОткрытииФайла - Булево - существует, только если внедрена подсистема Работа с +// файлами. +// * ПоказыватьКолонкуРазмер - Булево - существует, только если внедрена подсистема Работа с +// файлами. +// * ДействиеПоДвойномуЩелчкуМыши - Строка - существует, только если внедрена подсистема Работа с +// файлами. +// * СпособСравненияВерсийФайлов - Строка - существует, только если внедрена подсистема Работа с +// файлами. +// * ГрафическиеСхемыРасширение - Строка - список расширений для графических схем. +// * ГрафическиеСхемыСпособОткрытия - ПеречислениеСсылка.СпособыОткрытияФайлаНаПросмотр - способ +// открытия графических схем. +// * ТекстовыеФайлыРасширение - Строка - расширения файлов открытого формата документов. +// * ТекстовыеФайлыСпособОткрытия - ПеречислениеСсылка.СпособыОткрытияФайлаНаПросмотр - способ +// открытия текстовых файлов. +// * МаксимальныйРазмерЛокальногоКэшаФайлов - Число - определяет максимальный размер локального кэша файлов. +// * ПоказыватьИнформациюЧтоФайлНеБылИзменен - Булево - показывать файлы при завершении работы. +// * ПоказыватьПодсказкиПриРедактированииФайлов - Булево - а веб-клиенте показывать подсказки при +// редактировании файлов. +// * ПутьКЛокальномуКэшуФайлов - Строка - путь к локальному кэшу файлов. +// * ЭтоПолноправныйПользователь - Булево - устарел, следует использовать +// ПользователиКлиент.ЭтоПолноправныйПользователь. +// * УдалятьФайлИзЛокальногоКэшаФайловПриЗавершенииРедактирования - Булево - удаление файлов из локального кэша при +// завершении редактирования. +// +Функция НастройкиРаботыСФайлами() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.НастройкиРаботыСФайлами() +``` +
+ +## МаксимальныйРазмерФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает максимальный размер файла. +// +// Возвращаемое значение: +// Число - целое число байтов. +// +Функция МаксимальныйРазмерФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.МаксимальныйРазмерФайла() +``` +
+ +## МаксимальныйРазмерФайлаОбщий +
+ +Описание, пример вызова + +```bsl + +// Возвращает максимальный размер файла провайдера. +// +// Возвращаемое значение: +// Число - целое число байтов. +// +Функция МаксимальныйРазмерФайлаОбщий() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.МаксимальныйРазмерФайлаОбщий() +``` +
+ +## СохранитьНастройкиРаботыСФайлами +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройки работы с файлами. +// +// Параметры: +// НастройкиРаботыСФайлами - Структура - настройки работы с файлами с их значениями: +// * ПоказыватьИнформациюЧтоФайлНеБылИзменен - Булево - необязательный. Показывать сообщение, если файл не +// был изменен. +// * ПоказыватьЗанятыеФайлыПриЗавершенииРаботы - Булево - необязательный. Показывать файлы при завершении работы. +// * ПоказыватьКолонкуРазмер - Булево - необязательный. Если принимает значение Истина, на формах +// списках файлов будет отображаться колонка Размер. +// * ТекстовыеФайлыРасширение - Строка - расширения файлов открытого формата документов. +// * ТекстовыеФайлыСпособОткрытия - ПеречислениеСсылка.СпособыОткрытияФайлаНаПросмотр - способ +// открытия текстовых файлов. +// * ГрафическиеСхемыРасширение - Строка - список расширений графических файлов. +// * ПоказыватьПодсказкиПриРедактированииФайлов - Булево - необязательный. В веб-клиенте показывать подсказки +// при редактировании файлов. +// * СпрашиватьРежимРедактированияПриОткрытииФайла - Булево - необязательный. Выбирать режим редактирования при +// открытии файла. +// * СпособСравненияВерсийФайлов - ПеречислениеСсылка.СпособыСравненияВерсийФайлов - +// необязательный. Способ сравнения версий и файлов. +// * ДействиеПоДвойномуЩелчкуМыши - ПеречислениеСсылка.ДействияСФайламиПоДвойномуЩелчку - необязательный. +// * ГрафическиеСхемыСпособОткрытия - ПеречислениеСсылка.СпособыОткрытияФайлаНаПросмотр - +// необязательный. Способ открытия файла на просмотр. +// +Процедура СохранитьНастройкиРаботыСФайлами(НастройкиРаботыСФайлами) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.СохранитьНастройкиРаботыСФайлами(НастройкиРаботыСФайлами) +``` +
+ +## РеквизитыРедактируемыеВГрупповойОбработке +
+ +Описание, пример вызова + +```bsl + +// Возвращает реквизиты объекта, которые разрешается редактировать +// с помощью обработки группового изменения реквизитов. +// +// Возвращаемое значение: +// Массив из Строка +// +Функция РеквизитыРедактируемыеВГрупповойОбработке() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.РеквизитыРедактируемыеВГрупповойОбработке() +``` +
+ +## ПеренестиФайлыМеждуСправочникамиХранения +
+ +Описание, пример вызова + +```bsl + +// Переносит файлы между справочниками хранения при объекте-владельце файлов и помечает +// перенесенные файлы к удалению. +// +// Для использования в процедурах обновления ИБ, когда выполняется перенос присоединенных файлов +// объекта-владельца между таблиц хранения файлов. Например, для справочника владельца присоединенных +// можно осуществить перенос файлов из справочника +// Справочник.<Имя справочника владельца>ПрисоединенныеФайлы в справочник Справочник.Файлы +// или в обратную сторону. +// Выполняется последовательно для каждого элемента объекта-владельца файлов +// (элемента справочника, ПВХ, документа и т.п.). +// +// Параметры: +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект-владелец - приемник файлов. +// Источник - Строка - если требуется конвертация из указанного хранилища. +// Если не заполнен, то используется первый неосновной справочник хранения. +// Приемник - Строка - если требуется конвертация в указанное хранилище. +// Если не заполнен, то используется основной справочник хранения файлов. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ОпределяемыйТип.ПрисоединенныйФайл - перенесенный файл, который помечен на удаление +// после переноса. +// * Значение - ОпределяемыйТип.ПрисоединенныйФайл - созданный файл. +// +Функция ПеренестиФайлыМеждуСправочникамиХранения(Знач ВладелецФайлов, Знач Источник = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ПеренестиФайлыМеждуСправочникамиХранения(ВладелецФайлов, Источник, ); +``` +
+ +## ПриЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриЗаписиНаСервере формы владельца файла. +// +// Параметры: +// Отказ - Булево - стандартный параметр события формы. +// ТекущийОбъект - ОпределяемыйТип.ВладелецПрисоединенныхФайловОбъект - стандартный параметр события формы. +// ПараметрыЗаписи - Структура - стандартный параметр события формы. +// Форма - ФормаКлиентскогоПриложения - форма записываемого объекта. +// +Процедура ПриЗаписиНаСервере(Отказ, ТекущийОбъект, ПараметрыЗаписи, Форма) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.ПриЗаписиНаСервере(Отказ, ТекущийОбъект, ПараметрыЗаписи, Форма) +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Размещает на форме гиперссылки и поля присоединенных файлов. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма для подключения. +// ДобавляемыеЭлементы - Структура +// - Массив - параметры элементов управления +// присоединенными файлами для размещения на форме или массив +// таких структур. Свойства: см. РаботаСФайлами.ГиперссылкаФайлов +// и РаботаСФайлами.ПолеФайла. +// НастройкиРаботыСФайламиВФорме - см. РаботаСФайлами.НастройкиРаботыСФайламиВФорме. +// +// +// Пример: +// 1. Добавление гиперссылки присоединенных файлов: +// ПараметрыГиперссылки = РаботаСФайлами.ГиперссылкаФайлов(); +// ПараметрыГиперссылки.Размещение = "КоманднаяПанель"; +// РаботаСФайлами.ПриСозданииНаСервере(ЭтотОбъект, ПараметрыГиперссылки); +// +// 2. Добавление поля изображения: +// ПараметрыПоля = РаботаСФайлами.ПолеФайла(); +// ПараметрыПоля.ПутьКДанным = "Объект.ФайлКартинки"; +// ПараметрыПоля.ПутьКДаннымИзображения = "АдресКартинки"; +// РаботаСФайлами.ПриСозданииНаСервере(ЭтотОбъект, ПараметрыПоля); +// +// 3. Добавление нескольких элементов управления: +// ДобавляемыеЭлементы = Новый Массив; +// ДобавляемыеЭлементы.Добавить(ПараметрыГиперссылки); +// ДобавляемыеЭлементы.Добавить(ПараметрыПоля); +// РаботаСФайлами.ПриСозданииНаСервере(ЭтотОбъект, ДобавляемыеЭлементы); +// +Процедура ПриСозданииНаСервере(Форма, ДобавляемыеЭлементы = Неопределено, НастройкиРаботыСФайламиВФорме = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.ПриСозданииНаСервере(Форма, ДобавляемыеЭлементы, НастройкиРаботыСФайламиВФорме); +``` +
+ +## ГиперссылкаФайлов +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для размещения гиперссылки присоединенных файлов на форме. +// +// Возвращаемое значение: +// Структура - параметры размещения гиперссылки. Свойства: +// * Владелец - Строка - имя реквизита, содержащего ссылку на владельца присоединенных файлов. +// Значение по умолчанию - "Объект.Ссылка". +// * Размещение - Строка +// - Неопределено - если указано имя группы формы или командная панель, +// гиперссылка будет помещена в указанную группу или панель. Если указано имя элемента +// формы, гиперссылка будет вставлена перед указанным элементом. Если значение +// параметра - Неопределено или элемент не найден, гиперссылка будет добавлена на форму +// после всех существующих элементов. +// Значение по умолчанию - "УправлениеПрисоединеннымиФайлами". +// * Заголовок - Строка - заголовок гиперссылки. Значение по умолчанию - "Файлы". +// * ОтображатьЗаголовокСправа - Булево - если параметр принимает значение Истина, заголовок +// будет отображаться после команд добавления, иначе - перед командами добавления. +// Значение по умолчанию - Истина; +// * ОтображатьКоличество - Булево - если параметр принимает значение Истина, отображает +// количество присоединенных файлов в заголовке. Значение по умолчанию - Истина. +// * ДобавлятьФайлы - Булево - если указать Ложь, команды добавления файлов будут отсутствовать. +// Значение по умолчанию - Истина. +// * ОтображениеФигуры - Строка - строковое представление свойства "ОтображениеФигуры" для +// команд добавления присоединенных файлов. Значение по умолчанию - "Авто". +// * Видимость - Булево - если параметр принимает значение Ложь, гиперссылка на форме размещаться +// не будет. Параметр имеет смысл только для глобального отключения видимости +// в процедуре РаботаСФайламиПереопределяемый.ПриОпределенииГиперссылкиФайлов. +// +Функция ГиперссылкаФайлов() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ГиперссылкаФайлов() +``` +
+ +## ПолеФайла +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для размещения поля присоединенного файла на форме. +// +// Возвращаемое значение: +// Структура - параметры размещения гиперссылки. Свойства: +// * Владелец - Строка - имя реквизита, содержащего ссылку на владельца присоединенных файлов. +// Значение по умолчанию - "Объект.Ссылка". +// * Размещение - Строка +// - Неопределено - если указано имя группы формы, поле будет +// размещено в указанной группе. Если указано имя элемента формы, поле будет +// вставлено перед указанным элементом. Если значение параметра - Неопределено +// или элемент не найден, поле будет добавлено на форму после всех существующих +// элементов. Значение по умолчанию - "УправлениеПрисоединеннымиФайлами". +// * ПутьКДанным - Строка +// - Неопределено - имя реквизита формы, содержащего ссылку на файл для +// отображения. Если параметр принимает значение Неопределено или реквизит не найден, +// добавляет реквизит формы с именем "ПолеПрисоединенногоФайла" и типом +// "ОпределяемыйТип.ПрисоединенныйФайл". Значение по умолчанию - "ПолеПрисоединенногоФайла". +// * ПутьКДаннымИзображения - Строка +// - Неопределено - имя реквизита формы, содержащего изображение, которое будет +// выведено в поле предпросмотра. Если параметр принимает значение Неопределено или реквизит +// не найден, добавляет реквизит формы с именем "ПолеКартинкиПрисоединенногоФайла" и типом +// "Строка". Значение по умолчанию - Неопределено. +// * ТолькоОдинФайл - Булево - если указать Истина, с помощью команд добавления можно будет +// присоединить только один файл. После добавления первого файла, команда "Добавить" +// будет заменять существующий файл на файл, выбранный пользователем, а нажатие на +// заголовок приведет к открытию файла для просмотра. Значение по умолчанию - Ложь. +// * ПоказыватьПредпросмотр - Булево - если параметр принимает значение Истина, добавляет на форму +// область предпросмотра присоединенного файла. Значение по умолчанию - Истина. +// * ТекстНевыбраннойКартинки - Строка - выводится в поле предпросмотра изображения, если +// изображение отсутствует. Значение по умолчанию - "Добавить изображение". +// * Заголовок - Строка - если заголовок отличается от пустой строки, добавляет на форму заголовок +// поля присоединенного файла. Значение по умолчанию - "". +// * ВыводитьЗаголовокФайла - Булево - если параметр принимает значение Истина, добавляет гиперссылку +// заголовок которой соответствует краткому имени файла. Если значение параметра +// "Заголовок" отличается от "", заголовок файла будет добавлен после общего заголовка +// элемента управления. Значение по умолчанию - Ложь. +// * ПоказыватьКоманднуюПанель - Булево - если параметр принимает значение Истина, команды будут размещены в +// командной панели на форме и в контекстном меню элемента предпросмотра, иначе - +// только в контекстном меню элемента предпросмотра. Значение по умолчанию - Истина. +// * ДобавлятьФайлы - Булево - если указать Ложь, команды добавления файлов будут отсутствовать. +// Значение по умолчанию - Истина. +// * ВыбиратьФайл - Булево - если параметр принимает значение Истина, добавляет команду выбора файла +// из присоединенных. Значение по умолчанию - Истина. +// * ПросматриватьФайл - Булево - если параметр принимает значение Истина, добавляет команду открытия +// файла для просмотра. Значение по умолчанию - Истина. +// * РедактироватьФайл - Строка - если параметр принимает значение "ВФорме", добавляет команду +// открытия формы присоединенного файла. Если параметр принимает значение +// "Непосредственно", добавляет команды редактирования файла, сохранения и отмены +// изменений. Если принимает значение "НеРедактировать", команды редактирования добавлены +// не будут. Значение по умолчанию - "ВФорме". +// * ОчищатьФайл - Булево - если параметр принимает значение Истина, добавляет команду очистки +// реквизита-владельца. Значение по умолчанию - Истина. +// * МаксимальныйРазмер - Число - ограничение на размер файла (в мегабайтах), загружаемого из файловой системы. +// Если принимает значение 0, проверка размера не проводится. Свойство игнорируется, +// если принимает значение больше, чем указано в константе МаксимальныйРазмерФайла. +// Значение по умолчанию - 0. +// * ФильтрДиалогаВыбора - Строка - фильтр, устанавливаемый в диалог выбора при добавлении файла. +// Формат см. в свойстве Фильтр объекта ДиалогВыбораФайла в синтакс-помощнике. +// Значение по умолчанию - "Все файлы (*.*)|*.*" +// +Функция ПолеФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ПолеФайла() +``` +
+ +## ЕстьТомаХраненияФайлов +
+ +Описание, пример вызова + +```bsl + +// Определяет наличие активных томов хранения файлов. +// Если есть хоть один том хранения файлов, то будет возвращена Истина. +// +// Возвращаемое значение: +// Булево - если Истина, тогда существует хотя бы один работающий том. +// +Функция ЕстьТомаХраненияФайлов() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ЕстьТомаХраненияФайлов() +``` +
+ +## ДобавитьПодписьКФайлу +
+ +Описание, пример вызова + +```bsl + +// Добавляет электронную подпись к файлу. +// +// Параметры: +// ПрисоединенныйФайл - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// +// СвойстваПодписи - см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи +// - Массив - массив описанных выше структур. +// +// ИдентификаторФормы - УникальныйИдентификатор - если указан, то используется при блокировке объекта. +// +Процедура ДобавитьПодписьКФайлу(ПрисоединенныйФайл, СвойстваПодписи, ИдентификаторФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.ДобавитьПодписьКФайлу(ПрисоединенныйФайл, СвойстваПодписи, ИдентификаторФормы); +``` +
+ +## СкопироватьПрисоединенныеФайлы +
+ +Описание, пример вызова + +```bsl + +// При программном копировании Источника создает у Получателя копии всех +// присоединенных файлов. Для интерактивного копирования необходимо использовать +// процедуру РаботаСФайлами.ПриЗаписиНаСервере. +// Источник и Получатель должны быть объектами одного типа. +// +// Параметры: +// Источник - ЛюбаяСсылка - объект, имеющий присоединенные файлы для копирования. +// Получатель - ЛюбаяСсылка - объект, к которому копируются присоединенные файлы. +// +Процедура СкопироватьПрисоединенныеФайлы(Знач Источник, Знач Получатель) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.СкопироватьПрисоединенныеФайлы(Источник, Получатель) +``` +
+ +## НастройкиРаботыСФайламиВФорме +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для настройки работы с файлами в форме. +// +// Возвращаемое значение: +// Структура - параметры копирования файлов. Свойства: +// * КопироватьПрисоединенныеФайлы - Булево - признак копирования присоединенных файлов при копировании объекта-владельца +// Значение по умолчанию - Ложь. +// +Функция НастройкиРаботыСФайламиВФорме() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.НастройкиРаботыСФайламиВФорме() +``` +
+ +## ПолучитьНастройкиСканированияПользователя +
+ +Описание, пример вызова + +```bsl + +// Получает настройки сканирования пользователя. +// +// Параметры: +// ИдентификаторКлиента - УникальныйИдентификатор - идентификатор клиента +// +// Возвращаемое значение: +// см. РаботаСФайламиКлиентСервер.НастройкиСканированияПользователя +// +Функция ПолучитьНастройкиСканированияПользователя(ИдентификаторКлиента) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.ПолучитьНастройкиСканированияПользователя(ИдентификаторКлиента) +``` +
+ +## СохранитьНастройкиСканированияПользователя +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройки сканирования пользователя. +// +// Параметры: +// НастройкиСканированияПользователя - см. РаботаСФайламиКлиентСервер.НастройкиСканированияПользователя +// ИдентификаторКлиента - УникальныйИдентификатор +// +Процедура СохранитьНастройкиСканированияПользователя(НастройкиСканированияПользователя, ИдентификаторКлиента) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.СохранитьНастройкиСканированияПользователя(НастройкиСканированияПользователя, ИдентификаторКлиента) +``` +
+ +## СоздатьФайлНаОсновеФайлаНаДиске +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РаботаСФайлами.ДобавитьФайлСДиска +// Добавляет к указанному владельцу файлов новый файл на основании файла из файловой системы. +// Если владелец файлов поддерживает хранение версий, то будет создана первая версия файла. +// +// Параметры: +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - папка файлов или объект, к которому +// требуется прикрепить добавляемый файл. +// ПутьКФайлуНаДиске - Строка - полный путь к файлу, включающий имя и расширение файла. +// Файл должен находиться на сервере. +// +// Возвращаемое значение: +// ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с созданным файлом. +// +Функция СоздатьФайлНаОсновеФайлаНаДиске(ВладелецФайлов, ПутьКФайлуНаДиске) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.СоздатьФайлНаОсновеФайлаНаДиске(ВладелецФайлов, ПутьКФайлуНаДиске) +``` +
+ +## ОпределитьФормуПрисоединенногоФайла +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РаботаСФайламиКлиентСервер.ОпределитьФормуПрисоединенногоФайла. +// Обработчик подписки на событие ОбработкаПолученияФормы для переопределения формы файла. +// +// Параметры: +// Источник - СправочникМенеджер - менеджер справочника с именем "*ПрисоединенныеФайлы". +// ВидФормы - Строка - имя стандартной формы. +// Параметры - Структура - параметры формы. +// ВыбраннаяФорма - Строка - имя или объект метаданных открываемой формы. +// ДополнительнаяИнформация - Структура - дополнительная информация открытия формы. +// СтандартнаяОбработка - Булево - признак выполнения стандартной (системной) обработки события. +// +Процедура ОпределитьФормуПрисоединенногоФайла(Источник, ВидФормы, Параметры, Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.ОпределитьФормуПрисоединенногоФайла(Источник, ВидФормы, Параметры, ); +``` +
+ +## ИзменитьСправочникХраненияФайлов +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать СконвертироватьФайлыВПрисоединенные. +// +// Переносит файлы из справочника Файлы в присоединенные файлы при объекте-владельце файлов и помечает +// перенесенные файлы к удалению. +// +// Для использования в процедурах обновления ИБ. +// Выполняется последовательно для каждого элемента объекта-владельца файлов +// (элемента справочника, ПВХ, документа и т.п.). +// +// Параметры: +// ВладелецФайлов - ЛюбаяСсылка - ссылка на объект, для которого выполняется конвертация. +// ИмяСправочника - Строка - если требуется конвертация в указанное хранилище. +// +Процедура ИзменитьСправочникХраненияФайлов(Знач ВладелецФайлов, ИмяСправочника = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайлами.ИзменитьСправочникХраненияФайлов(ВладелецФайлов, ИмяСправочника); +``` +
+ +## СконвертироватьФайлыВПрисоединенные +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РаботаСФайлами.ПеренестиФайлыМеждуСправочникамиХранения. +// Переносит файлы из справочника Файлы в присоединенные файлы при объекте-владельце файлов и помечает +// перенесенные файлы к удалению. +// +// Для использования в процедурах обновления ИБ, если выполняется переход от использования +// хранения файлов в справочнике Файлы на хранение файлов как присоединенных при объекте-владельце файлов. +// Выполняется последовательно для каждого элемента объекта-владельца файлов +// (элемента справочника, ПВХ, документа и т.п.). +// +// Параметры: +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект-владелец - приемник файлов. +// ИмяСправочника - Строка - если требуется конвертация в указанное хранилище. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.Файлы - перенесенный файл, который помечен на удаление после переноса. +// * Значение - ОпределяемыйТип.ПрисоединенныйФайл - созданный файл. +// +Функция СконвертироватьФайлыВПрисоединенные(Знач ВладелецФайлов, ИмяСправочника = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайлами.СконвертироватьФайлыВПрисоединенные(ВладелецФайлов, ИмяСправочника); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСФайламиКлиент.md b/src/content/docs/bsp/РаботаСФайламиКлиент.md new file mode 100644 index 0000000..0999c6f --- /dev/null +++ b/src/content/docs/bsp/РаботаСФайламиКлиент.md @@ -0,0 +1,1069 @@ +--- +title: Работа с файлами клиент +slug: bsp/работа-с-файлами-клиент +--- + + +## ОткрытьФайл +
+ +Описание, пример вызова + +```bsl + +// Открывает файл для просмотра или редактирования. +// Если файл открывается для просмотра, тогда получает файл в рабочий каталог пользователя, +// при этом ищет файл в рабочем каталоге и предлагает открыть существующий или получить файл с сервера. +// Если файл открывается для редактирования, тогда открывает файл в рабочем каталоге (если есть) или +// получает его с сервера. +// +// Параметры: +// ДанныеФайла - см. РаботаСФайлами.ДанныеФайла. +// ДляРедактирования - Булево - Истина, если файл открывается для редактирования, иначе Ложь. +// +Процедура ОткрытьФайл(Знач ДанныеФайла, Знач ДляРедактирования = Ложь) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ОткрытьФайл(ДанныеФайла, ДляРедактирования); +``` +
+ +## ОткрытьКаталогФайла +
+ +Описание, пример вызова + +```bsl + +// Открывает в стандартной программе просмотра (проводнике) каталог на компьютере, +// в котором размещен указанный файл. +// +// Параметры: +// ДанныеФайла - см. РаботаСФайлами.ДанныеФайла. +// +Процедура ОткрытьКаталогФайла(ДанныеФайла) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ОткрытьКаталогФайла(ДанныеФайла) +``` +
+ +## ДобавитьФайлы +
+ +Описание, пример вызова + +```bsl + +// Открывает диалог выбора файлов для помещения в программу одного или нескольких файлов. +// При этом проверяются необходимые условия: +// - размер файла не превышает максимально допустимого, +// - файл имеет допустимое расширение, +// - имеется свободное место в томе (при хранении файлов в томах), +// - прочие условия. +// +// Параметры: +// ВладелецФайла - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - папка файлов или объект, к которому +// требуется прикрепить добавляемый файл. +// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, во временное хранилище +// которой будет помещен файл. +// Фильтр - Строка - фильтр выбираемого файла, например, картинки для номенклатуры. +// ГруппаФайлов - ОпределяемыйТип.ПрисоединенныйФайл - группа справочника с файлами, в которую будет +// добавлен новый файл. +// ОбработчикРезультата - ОписаниеОповещения - описание процедуры, вызов которой будет произведен +// после добавления файлов со следующими параметрами: +// Результат - Массив - ссылки на добавленные файлы. Если файлы не были добавлены, пустой массив. +// ДополнительныеПараметры - Произвольный - значение, указанное при создании описания оповещения. +// +Процедура ДобавитьФайлы(Знач ВладелецФайла, Знач ИдентификаторФормы, Знач Фильтр = "", ГруппаФайлов = Неопределено, Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ДобавитьФайлы(ВладелецФайла, ИдентификаторФормы, Фильтр, ГруппаФайлов, ); +``` +
+ +## ДобавитьФайл +
+ +Описание, пример вызова + +```bsl + +// Открывает диалог выбора файлов для помещения в программу одного выбранного файла. +// +// Параметры: +// ОбработчикРезультата - ОписаниеОповещения - содержит описание процедуры, вызов которой будет произведен +// после добавления файла со следующими параметрами: +// * Результат - Структура: +// ** ФайлСсылка - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом, +// если он был добавлен, иначе Неопределено. +// ** ФайлДобавлен - Булево - Истина, если файл добавлен. +// ** ТекстОшибки - Строка - текст ошибки, если файл не был добавлен. +// * ДополнительныеПараметры - Произвольный - значение, указанное при создании объекта оповещения. +// +// ВладелецФайла - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - папка файлов или объект, к которому +// требуется прикрепить добавляемый файл. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызвано создание файла. +// РежимСоздания - Неопределено +// - Число - режим создания файла: +// - Неопределено - показать диалог выбора режима создания файла. +// - Число - создать файл указанным способом: +// 1 - из шаблона (копированием другого файла); +// 2 - с компьютера (из файловой системы); +// 3 - со сканера. +// +// ПараметрыДобавления - Структура - дополнительные параметры добавления файлов: +// * МаксимальныйРазмер - Число - ограничение на размер файла (в мегабайтах), загружаемого из файловой системы. +// Если принимает значение 0, проверка размера не проводится. Свойство игнорируется, +// если принимает значение больше, чем указано в константе МаксимальныйРазмерФайла. +// * ФильтрДиалогаВыбора - Строка - фильтр, устанавливаемый в диалог выбора при добавлении файла. +// Формат см. в свойстве Фильтр объекта ДиалогВыбораФайла в синтакс-помощнике. +// * НеОткрыватьКарточку - Булево - действие после создания. Если принимает значение Истина, карточка файла +// не будет открыта после создания, иначе - карточку файла будет открыта. +// +Процедура ДобавитьФайл(ОбработчикРезультата, ВладелецФайла, ФормаВладелец, РежимСоздания = Неопределено, Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ДобавитьФайл(ОбработчикРезультата, ВладелецФайла, ФормаВладелец, РежимСоздания, ); +``` +
+ +## ОткрытьФормуНастройкиРабочегоКаталога +
+ +Описание, пример вызова + +```bsl + +// Открывает форму для настройки параметров рабочего каталога из персональных настроек пользователя программы. +// Рабочий каталог - папка на персональном компьютере пользователя, в которой временно хранятся файлы, +// полученные из программы для просмотра или редактирования. +// +Процедура ОткрытьФормуНастройкиРабочегоКаталога() Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ОткрытьФормуНастройкиРабочегоКаталога() +``` +
+ +## ПоказатьПодтверждениеЗакрытияФормыСФайлами +
+ +Описание, пример вызова + +```bsl + +// Показать предупреждение перед закрытием формы объекта в том случае, +// если у пользователя остались захваченные файлы, присоединенные к этому объекту. +// Вызывается из события ПередЗакрытием форм с файлами. +// +// Если захваченные файлы остались, то в параметре Отказ устанавливается значение Истина, +// а пользователю задается вопрос. Если пользователь ответил утвердительно, то форма закрывается. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой редактируется файл. +// Отказ - Булево - параметр события ПередЗакрытием. +// ЗавершениеРаботы - Булево - признак того, что форма закрывается в процессе завершения работы приложения. +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - папка файлов или объект, к которому присоединены +// файлы. +// ИмяРеквизита - Строка - имя реквизита типа Булево, в котором хранится признак того, +// что вопрос уже выводился. +// +// Пример: +// +// &НаКлиенте +// Процедура ПередЗакрытием(Отказ, ЗавершениеРаботы, ТекстПредупреждения, СтандартнаяОбработка) +// РаботаСФайламиКлиент.ПоказатьПодтверждениеЗакрытияФормыСФайлами(ЭтотОбъект, Отказ, ЗавершениеРаботы, Объект.Ссылка); +// КонецПроцедуры +// +Процедура ПоказатьПодтверждениеЗакрытияФормыСФайлами(Форма, Отказ, ЗавершениеРаботы, ВладелецФайлов, Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ПоказатьПодтверждениеЗакрытияФормыСФайлами(Форма, Отказ, ЗавершениеРаботы, ВладелецФайлов, ); +``` +
+ +## СкопироватьФайл +
+ +Описание, пример вызова + +```bsl + +// Открывает форму нового файла с копией указанного файла. +// +// Параметры: +// ВладелецФайла - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - папка файлов или объект, к которому присоединен файл. +// ФайлОснование - ОпределяемыйТип.ПрисоединенныйФайл - копируемый файл. +// ДополнительныеПараметры - Структура - параметры открытия формы: +// * ИмяСправочникаХранилищаФайлов - Строка - определяет справочник для хранения копии файла. +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - описание процедуры, которая будет вызвана при закрытии формы +// со следующими параметрами: +// <РезультатЗакрытия> - значение, переданное при вызове Закрыть() открываемой формы; +// <ДополнительныеПараметры> - значение, указанное при создании +// ОписаниеОповещенияОЗакрытии. +// Если параметр не указан, то по завершению никакая процедура вызвана не будет. +// +Процедура СкопироватьФайл(ВладелецФайла, ФайлОснование, ДополнительныеПараметры = Неопределено, Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.СкопироватьФайл(ВладелецФайла, ФайлОснование, ДополнительныеПараметры, ); +``` +
+ +## СохранитьВместеСЭП +
+ +Описание, пример вызова + +```bsl + +// Открывает список электронных подписей файла и предлагает выбрать подписи +// для сохранения вместе с файлом по выбранному пользователем пути. +// Имя файл подписи формируется из имени файла и автора подписи с расширением "p7s". +// +// При отсутствии в конфигурации подсистемы "Электронная подпись" сохранение файла не будет выполнено. +// +// Параметры: +// ПрисоединенныйФайл - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, который используется для блокировки файл. +// +Процедура СохранитьВместеСЭП(Знач ПрисоединенныйФайл, Знач ИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.СохранитьВместеСЭП(ПрисоединенныйФайл, ИдентификаторФормы) +``` +
+ +## СохранитьФайлКак +
+ +Описание, пример вызова + +```bsl + +// Открывает диалог сохранения файл, где пользователь может определить путь и имя для сохранения файла. +// +// Параметры: +// ДанныеФайла - см. РаботаСФайлами.ДанныеФайла. +// ОбработчикЗавершения - ОписаниеОповещения +// - Неопределено - описание процедуры, которая +// будет вызвана после завершения со следующими параметрами: +// ПутьКФайлу - Строка - полный путь к сохраненному файлу. +// ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// +Процедура СохранитьФайлКак(Знач ДанныеФайла, ОбработчикЗавершения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.СохранитьФайлКак(ДанныеФайла, ОбработчикЗавершения); +``` +
+ +## ОткрытьФормуВыбораФайлов +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора файлов. +// Используется в обработчике выбора для переопределения стандартного поведения. +// +// Параметры: +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - папка файлов или объект, +// к которому прикреплены выбираемые файлы. +// ЭлементФормы - ТаблицаФормы +// - ПолеФормы - элемент формы, которому будет отправлено +// оповещение о выборе. +// СтандартнаяОбработка - Булево - возвращаемое значение. Всегда устанавливается в Ложь. +// ОписаниеОповещенияОВыборе - ОписаниеОповещения - описание процедуры, которая будет вызвана при закрытии формы +// со следующими параметрами: +// ЗначениеВыбора - ОпределяемыйТип.ПрисоединенныйФайл +// - Неопределено - если произошел выбор, тогда будет +// возвращено значение выбора. Иначе - Неопределено. +// ДополнительныеПараметры - Произвольный - значение, указанное при создании ОписаниеОповещенияОЗакрытии. +// +Процедура ОткрытьФормуВыбораФайлов(Знач ВладелецФайлов, Знач ЭлементФормы, СтандартнаяОбработка = Ложь, Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ОткрытьФормуВыбораФайлов(ВладелецФайлов, ЭлементФормы, СтандартнаяОбработка, ); +``` +
+ +## ОткрытьФормуСпискаФайлов +
+ +Описание, пример вызова + +```bsl + +// Открывает форму списка файлов. +// +// Параметры: +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - папка файлов или объект, +// к которому прикреплены выбираемые файлы. +// ПараметрыФормы - см. ПараметрыОткрытияФормыСпискаФайлов +// ВладелецФормы - ФормаКлиентскогоПриложения +// ОповещениеОЗакрытии - ОписаниеОповещения +// +Процедура ОткрытьФормуСпискаФайлов(Знач ВладелецФайлов, Знач ПараметрыФормы = Неопределено, Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ОткрытьФормуСпискаФайлов(ВладелецФайлов, ПараметрыФормы, ); +``` +
+ +## ПараметрыОткрытияФормыСпискаФайлов +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров открытия формы списка файлов для ОткрытьФормуСпискаФайлов. +// +// Параметры: +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - папка файлов или объект, +// к которому прикреплены выбираемые файлы. +// ФиксированныеНастройки - НастройкиКомпоновкиДанных - настройки динамического списка +// +// Возвращаемое значение: +// Структура: +// * ВладелецФайла - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - папка файлов или объект, +// к которому прикреплены выбираемые файлы. +// * СкрыватьВладельца - Булево - признак отображения/скрытия на форме владельца файлов. +// * ФиксированныеНастройки - НастройкиКомпоновкиДанных - настройки динамического списка. +// +Функция ПараметрыОткрытияФормыСпискаФайлов(ВладелецФайлов, ФиксированныеНастройки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиент.ПараметрыОткрытияФормыСпискаФайлов(ВладелецФайлов, ФиксированныеНастройки); +``` +
+ +## ОткрытьФормуФайла +
+ +Описание, пример вызова + +```bsl + +// Открывает форму файла. +// Может использоваться как обработчик открытия файла. +// +// Параметры: +// ПрисоединенныйФайл - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// СтандартнаяОбработка - Булево - возвращаемое значение. Всегда устанавливается в Ложь. +// ДополнительныеПараметры - Структура - параметры открытия формы. +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - описание процедуры, которая будет вызвана при закрытии формы, +// со следующими параметрами: +// <РезультатЗакрытия> - значение, переданное при вызове Закрыть() открываемой формы; +// <ДополнительныеПараметры> - значение, указанное при создании +// ОписаниеОповещенияОЗакрытии. +// Если параметр не указан, то по завершении никакая процедура вызвана не будет. +// +Процедура ОткрытьФормуФайла(Знач ПрисоединенныйФайл, СтандартнаяОбработка = Ложь, ДополнительныеПараметры = Неопределено, Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ОткрытьФормуФайла(ПрисоединенныйФайл, СтандартнаяОбработка, ДополнительныеПараметры, ); +``` +
+ +## НапечататьФайлы +
+ +Описание, пример вызова + +```bsl + +// Выполняет печать файлов на принтер. +// +// Параметры: +// Файлы - ОпределяемыйТип.ПрисоединенныйФайл +// - Массив из ОпределяемыйТип.ПрисоединенныйФайл +// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, во временное хранилище +// которой будет помещен файл. +// +Процедура НапечататьФайлы(Знач Файлы, ИдентификаторФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.НапечататьФайлы(Файлы, ИдентификаторФормы); +``` +
+ +## ПодписатьФайл +
+ +Описание, пример вызова + +```bsl + +// Выполняет подписание файла электронной подписью. +// При отсутствии подсистемы "Электронная подпись" будет показано предупреждение +// о невозможности добавления электронной подписи. +// +// Параметры: +// ПрисоединенныйФайл - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// - Массив из ОпределяемыйТип.ПрисоединенныйФайл +// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, +// который используется для блокировки файла. +// ДополнительныеПараметры - Неопределено - стандартное поведение (см. ниже). +// - Структура: +// * ДанныеФайла - см. РаботаСФайлами.ДанныеФайла +// - Массив из см. РаботаСФайлами.ДанныеФайла +// * ОбработкаРезультата - ОписаниеОповещения - при вызове передается значение типа Булево, +// если Истина - файл успешно подписан, иначе не подписан, +// если свойства нет, оповещение не будет вызвано. +// ПараметрыПодписи - см. ЭлектроннаяПодписьКлиент.НовыйТипПодписи +// +Процедура ПодписатьФайл(ПрисоединенныйФайл, ИдентификаторФормы, ДополнительныеПараметры = Неопределено, Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ПодписатьФайл(ПрисоединенныйФайл, ИдентификаторФормы, ДополнительныеПараметры, ); +``` +
+ +## ДанныеФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает структурированную информацию о файле. Используется в различных командах работы с файлами +// и как значение параметра ДанныеФайла других процедур и функций. +// +// Параметры: +// ФайлСсылка - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, во временное хранилище +// которой надо поместить файл и вернуть адрес в свойстве СсылкаНаДвоичныеДанныеФайла. +// ПолучатьСсылкуНаДвоичныеДанные - Булево - если передать Ложь, то ссылка на двоичные данные в СсылкаНаДвоичныеДанныеФайла +// не будет получена, что существенно ускорит выполнение для больших двоичных данных. +// ДляРедактирования - Булево - если указать Истина, то файл будет захвачен для редактирования. +// +// Возвращаемое значение: +// см. РаботаСФайлами.ДанныеФайла +// +Функция ДанныеФайла(Знач ФайлСсылка, Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиент.ДанныеФайла(ФайлСсылка, ); +``` +
+ +## ПолучитьПрисоединенныйФайл +
+ +Описание, пример вызова + +```bsl + +// Получает файл из хранилища файлов в рабочий каталог пользователя. +// Аналог интерактивного действия Просмотреть или Редактировать без открытия полученного файла. +// Свойство ТолькоПросмотр полученного файла будет установлено в зависимости от того, захвачен +// файл для редактирования или нет. Если не захвачен - устанавливается только просмотр. +// Если в рабочем каталоге уже существует файл, тогда он будет удален и заменен файлом, +// полученным из хранилища файлов. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение, которое выполняется после получения файла в +// рабочий каталог пользователя. В качестве результата возвращается структура со свойствами: +// ПолноеИмяФайла - Строка - полное имя файла (с путем). +// ОписаниеОшибки - Строка - текст ошибки, если получить файл не удалось. +// +// ПрисоединенныйФайл - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, во временное хранилище +// которой будет помещен файл. +// +// ДополнительныеПараметры - Неопределено - использовать значения по умолчанию. +// - Структура - с необязательными свойствами: +// * ДляРедактирования - Булево - начальное значение Ложь. Если Истина, +// тогда файл будет захвачен для редактирования. +// * ДанныеФайла - Структура - свойства файла, которые можно передать для ускорения, +// если они ранее были получены на клиент с сервера. +// +Процедура ПолучитьПрисоединенныйФайл(Оповещение, ПрисоединенныйФайл, ИдентификаторФормы, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ПолучитьПрисоединенныйФайл(Оповещение, ПрисоединенныйФайл, ИдентификаторФормы, ДополнительныеПараметры); +``` +
+ +## ПоместитьПрисоединенныйФайл +
+ +Описание, пример вызова + +```bsl + +// Помещает файл из рабочего каталога пользователя в хранилище файлов. +// Аналог интерактивного действия Закончить редактирование. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение, которое выполняется после помещения файла в +// хранилище файлов. В качестве результата возвращается структура со свойством: +// ОписаниеОшибки - Строка - текст ошибки, если поместить файл не удалось. +// +// ПрисоединенныйФайл - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на элемент справочника с файлом. +// ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, +// во временное хранилище которой надо поместить данные и вернуть новый адрес. +// +// ДополнительныеПараметры - Неопределено - использовать значения по умолчанию. +// - Структура - с необязательными свойствами: +// * ПолноеИмяФайла - Строка - если заполнено, то указанный файл будет помещен в рабочий каталог +// пользователя, а затем в хранилище файлов. +// * ДанныеФайла - Структура - свойства файла, которые можно передать для ускорения, +// если они ранее были получены на клиент с сервера. +// +Процедура ПоместитьПрисоединенныйФайл(Оповещение, ПрисоединенныйФайл, ИдентификаторФормы, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ПоместитьПрисоединенныйФайл(Оповещение, ПрисоединенныйФайл, ИдентификаторФормы, ДополнительныеПараметры); +``` +
+ +## ОткрытьФормуНастройкиСканирования +
+ +Описание, пример вызова + +```bsl + +// Открывает форму настройки сканирования из пользовательских настроек. +// +Процедура ОткрытьФормуНастройкиСканирования() Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ОткрытьФормуНастройкиСканирования() +``` +
+ +## ПараметрыКонвертацииГрафическогоДокумента +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров параметров конвертации графических документов в PDF. +// +// Возвращаемое значение: +// Структура: +// * ТипРезультата - см. ТипРезультатаКонвертацииИмяФайла +// - см. ТипРезультатаКонвертацииДвоичныеДанные +// - см. ТипРезультатаКонвертацииПрисоединенныйФайл +// * ФорматРезультата - Строка - формат результирующего файла "PDF" или "tif" +// * ИмяФайлаРезультата - см. ТипРезультатаКонвертацииИмяФайла +// * ИспользоватьImageMagick - Булево - признак использования утилиты ImageMagick +// +Функция ПараметрыКонвертацииГрафическогоДокумента() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиент.ПараметрыКонвертацииГрафическогоДокумента() +``` +
+ +## ТипРезультатаКонвертацииИмяФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип результата конвертации в файл на клиенте. +// +// Возвращаемое значение: +// Строка +// +Функция ТипРезультатаКонвертацииИмяФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиент.ТипРезультатаКонвертацииИмяФайла() +``` +
+ +## ТипРезультатаКонвертацииДвоичныеДанные +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип результата конвертации в двоичные данные. +// +// Возвращаемое значение: +// Строка +// +Функция ТипРезультатаКонвертацииДвоичныеДанные() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиент.ТипРезультатаКонвертацииДвоичныеДанные() +``` +
+ +## ТипРезультатаКонвертацииПрисоединенныйФайл +
+ +Описание, пример вызова + +```bsl + +// Обозначает тип результата конвертации в присоединенный файл. +// +// Возвращаемое значение: +// Строка +// +Функция ТипРезультатаКонвертацииПрисоединенныйФайл() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиент.ТипРезультатаКонвертацииПрисоединенныйФайл() +``` +
+ +## ОбъединитьВМногостраничныйФайл +
+ +Описание, пример вызова + +```bsl + + +// Объединить массив переданных документов в один, с возможностью конвертации. +// +// Параметры: +// ОповещениеВозврата - ОписаниеОповещения - процедура, которая будет выполнена после объединения файлов. +// ОбъектыДляОбъединения - Массив из ДвоичныеДанные, ОпределяемыйТип.ПрисоединенныйФайл, Строка - +// Объекты могут поступать в виде двоичных данных, ссылки на присоединенный файл, пути к файлам +// на клиенте. +// ПараметрыКонвертацииГрафическогоДокумента - см. РаботаСФайламиКлиент.ПараметрыКонвертацииГрафическогоДокумента. +// +Процедура ОбъединитьВМногостраничныйФайл(ОповещениеВозврата, ОбъектыДляОбъединения, ПараметрыКонвертацииГрафическогоДокумента) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ОбъединитьВМногостраничныйФайл(ОповещениеВозврата, ОбъектыДляОбъединения, ПараметрыКонвертацииГрафическогоДокумента) +``` +
+ +## ПараметрыСканирования +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров для сканирования. +// +// Параметры: +// Заполнить - Булево - заполнять текущими сохраненными для пользователя значениями. +// +// Возвращаемое значение: +// Структура: +// * ПоказыватьДиалог - Булево - признак открытия диалога сканирования (поставляемый драйвером сканера) с возможностью +// настроек разрешения и пр. +// * ВыбранноеУстройство - Строка - имя сканера. +// * ФорматКартинки - Строка - формат картинки запрашиваемый у драйвера. +// * Разрешение - Число - разрешение DPI. +// * Цветность - Число - принимает значения 0 (черно-белое), 1 (оттенки серого), 2 (цветное). +// * Поворот - Число - угол поворота в градусах, допустимы значения 0, 90, 180, 270. Не все сканеры поддерживают эту +// настройку. +// * РазмерБумаги - Число - не все сканеры поддерживают эту настройку. Принимает значения +// 0 - не задано +// 11 - А3 +// 1 - А4 +// 5 - А5 +// 6 - B4 +// 2 - B5 +// 7 - B6 +// 14 - C4 +// 15 - C5 +// 16 - C6 +// 3 - USLetter +// 4 - USLegal +// 10 - USExecutive +// * КачествоJPG - Число - для формата JPG передается качество (от 1 до 100, 100 - максимальное качество и +// максимальный размер). +// * СжатиеTIFF - Число - сжатие: +// 2 - LZW +// 3 - CCITT3 +// 4 - CCITT4 +// 5 - RLE +// 6 - без сжатия +// * ДвустороннееСканирование - Булево - использовать двустороннее сканирование. +// * АвтоматическаяПодачаДокументов - Булево - использовать автоматический податчик документов. +// * СохранятьВPDF - Булево +// * ИспользоватьImageMagickДляПреобразованияВPDF - Булево +// +Функция ПараметрыСканирования(Заполнить = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиент.ПараметрыСканирования(Заполнить); +``` +
+ +## ПараметрыДобавленияСоСканера +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров добавления со сканера. +// +// Возвращаемое значение: +// Структура: +// * ОбработчикРезультата - Неопределено, ОписаниеОповещения - оповещение, которое будет вызвано после получения изображений. +// * ВладелецФайла - Неопределено, ОпределяемыйТип.ВладелецФайлов - владелец файла, для получения изображений в +// присоединенные файлы. +// * ФормаВладелец - Неопределено, Форма - форма из которой вызывается добавление файла. +// * НеОткрыватьКарточкуПослеСозданияИзФайла - Булево - для режима создания присоединенных файлов. +// * ЭтоФайл - Булево +// * ТипРезультата - см. ТипРезультатаКонвертацииИмяФайла +// - см. ТипРезультатаКонвертацииДвоичныеДанные +// - см. ТипРезультатаКонвертацииПрисоединенныйФайл +// * ТолькоОдинФайл - Булево - сканировать только одно изображение. +// +Функция ПараметрыДобавленияСоСканера() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиент.ПараметрыДобавленияСоСканера() +``` +
+ +## ДобавитьСоСканера +
+ +Описание, пример вызова + +```bsl + +// Добавить со сканера. Если работа со сканером не была предварительно настроена, +// то будут вызвана форма настроек сканирования. +// +// Параметры: +// ПараметрыДобавления - см. ПараметрыДобавленияСоСканера +// ПараметрыСканирования - см. ПараметрыСканирования +// +Процедура ДобавитьСоСканера(ПараметрыДобавления, ПараметрыСканирования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ДобавитьСоСканера(ПараметрыДобавления, ПараметрыСканирования); +``` +
+ +## ДоступноСканирование +
+ +Описание, пример вызова + +```bsl + +// Проверяет ограничения клиента для работы со сканером. +// Сканирование доступно в операционных системах Windows и Linux x86/x64. +// +// Возвращаемое значение: +// Булево +// +Функция ДоступноСканирование() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиент.ДоступноСканирование() +``` +
+ +## ДоступнаКомандаСканировать +
+ +Описание, пример вызова + +```bsl + +// Проверяет ограничения клиента для работы со сканером, установлена ли компонента сканирования и +// есть ли хоть один подключенный сканер. +// +// Параметры: +// ОповещениеРезультата - ОписаниеОповещения - процедура куда будет передан результат проверки: +// * Результат - Булево - признак доступности сканирования. +// * ДополнительныеПараметры - Произвольный - значение, указанное при создании описания оповещения. +// +Процедура ДоступнаКомандаСканировать(ОповещениеРезультата) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ДоступнаКомандаСканировать(ОповещениеРезультата) +``` +
+ +## ПолучитьНастройкиСканированияПользователя +
+ +Описание, пример вызова + +```bsl + +// Получает настройки сканирования пользователя. +// +// Параметры: +// ИдентификаторКлиента - УникальныйИдентификатор - идентификатор клиента +// +// Возвращаемое значение: +// см. РаботаСФайламиКлиентСервер.НастройкиСканированияПользователя +// +Функция ПолучитьНастройкиСканированияПользователя(ИдентификаторКлиента = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиент.ПолучитьНастройкиСканированияПользователя(ИдентификаторКлиента); +``` +
+ +## СохранитьНастройкиСканированияПользователя +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройки сканирования пользователя. +// +// Параметры: +// НастройкиСканированияПользователя - см. РаботаСФайламиКлиентСервер.НастройкиСканированияПользователя +// ИдентификаторКлиента - УникальныйИдентификатор - идентификатор клиента +// +Процедура СохранитьНастройкиСканированияПользователя(НастройкиСканированияПользователя, ИдентификаторКлиента = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.СохранитьНастройкиСканированияПользователя(НастройкиСканированияПользователя, ИдентификаторКлиента); +``` +
+ +## ПриОткрытии +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриОткрытии управляемой формы владельца файла. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца файла. +// Отказ - Булево - стандартный параметр события ПриОткрытии управляемой формы. +// +Процедура ПриОткрытии(Форма, Отказ) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ПриОткрытии(Форма, Отказ) +``` +
+ +## ОбработкаОповещения +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ОбработкаОповещения управляемой формы владельца файла. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца файла. +// ИмяСобытия - Строка - стандартный параметр события ОбработкаОповещения управляемой формы. +// +Процедура ОбработкаОповещения(Форма, ИмяСобытия) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ОбработкаОповещения(Форма, ИмяСобытия) +``` +
+ +## КомандаУправленияПрисоединеннымиФайлами +
+ +Описание, пример вызова + +```bsl + +// Обработчик выполнения дополнительных команд управления присоединенными файлами. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца файла. +// Команда - КомандаФормы - выполняемая команда. +// +Процедура КомандаУправленияПрисоединеннымиФайлами(Форма, Команда) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.КомандаУправленияПрисоединеннымиФайлами(Форма, Команда) +``` +
+ +## ПолеПредпросмотраНажатие +
+ +Описание, пример вызова + +```bsl + +// Обработчик нажатия на поле предпросмотра. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца файла. +// Элемент - ПолеФормы - поле предпросмотра. +// СтандартнаяОбработка - Булево - стандартный параметр события Нажатие поля формы. +// Просмотр - Булево - если параметр принимает значение Истина, открывает файл +// для просмотра. Иначе - загружает файл с компьютера. +// Значение по умолчанию - Ложь. +// +Процедура ПолеПредпросмотраНажатие(Форма, Элемент, СтандартнаяОбработка, Просмотр = Ложь) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ПолеПредпросмотраНажатие(Форма, Элемент, СтандартнаяОбработка, Просмотр); +``` +
+ +## ПолеПредпросмотраПеретаскивание +
+ +Описание, пример вызова + +```bsl + +// Обработчик перетаскивания на поле предпросмотра. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца файла. +// Элемент - ПолеФормы - поле предпросмотра. +// ПараметрыПеретаскивания - ПараметрыПеретаскивания - стандартный параметр события Перетаскивание +// поля формы. +// СтандартнаяОбработка - Булево - стандартный параметр события Перетаскивание поля формы. +// +Процедура ПолеПредпросмотраПеретаскивание(Форма, Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ПолеПредпросмотраПеретаскивание(Форма, Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка) +``` +
+ +## ПолеПредпросмотраПроверкаПеретаскивания +
+ +Описание, пример вызова + +```bsl + +// Обработчик проверки перетаскивания на поле предпросмотра. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца файла. +// Элемент - ПолеФормы - поле предпросмотра. +// ПараметрыПеретаскивания - ПараметрыПеретаскивания - стандартный параметр события Проверка +// перетаскивания поля формы. +// СтандартнаяОбработка - Булево - стандартный параметр события Проверка перетаскивания поля формы. +// +Процедура ПолеПредпросмотраПроверкаПеретаскивания(Форма, Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ПолеПредпросмотраПроверкаПеретаскивания(Форма, Элемент, ПараметрыПеретаскивания, СтандартнаяОбработка) +``` +
+ +## ПерейтиКФормеФайла +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать РаботаСФайламиКлиент.ОткрытьФормуФайла +// Открывает форму файла из формы элемента справочника файлов. Форма элемента закрывается. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма справочника присоединенных файлов. +// +Процедура ПерейтиКФормеФайла(Знач Форма) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиент.ПерейтиКФормеФайла(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСФайламиКлиентПереопределяемый.md b/src/content/docs/bsp/РаботаСФайламиКлиентПереопределяемый.md new file mode 100644 index 0000000..b037d77 --- /dev/null +++ b/src/content/docs/bsp/РаботаСФайламиКлиентПереопределяемый.md @@ -0,0 +1,35 @@ +--- +title: Работа с файлами клиент переопределяемый +slug: bsp/работа-с-файлами-клиент-переопределяемый +--- + + +## ПриОшибкеЗахватаФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается при ошибке захвате файла. +// +// Параметры: +// ДанныеФайла - см. РаботаСФайлами.ДанныеФайла. +// СтандартнаяОбработка - Булево - признак стандартной обработки события. +// +Процедура ПриОшибкеЗахватаФайла(ДанныеФайла, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиентПереопределяемый.ПриОшибкеЗахватаФайла(ДанныеФайла, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСФайламиКлиентСервер.md b/src/content/docs/bsp/РаботаСФайламиКлиентСервер.md new file mode 100644 index 0000000..0e6619e --- /dev/null +++ b/src/content/docs/bsp/РаботаСФайламиКлиентСервер.md @@ -0,0 +1,106 @@ +--- +title: Работа с файлами клиент сервер +slug: bsp/работа-с-файлами-клиент-сервер +--- + + +## ПараметрыДанныхФайла +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для получения данных файла. См. РаботаСФайлами.ДанныеФайла. +// +// Возвращаемое значение: +// Структура: +// * ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, во временное хранилище +// которой надо поместить файл и вернуть адрес в свойстве СсылкаНаДвоичныеДанныеФайла. +// Значение по умолчанию - Неопределено. +// * ПолучатьСсылкуНаДвоичныеДанные - Булево - если передать Ложь, то ссылка на двоичные данные в СсылкаНаДвоичныеДанныеФайла +// не будет получена, что существенно ускорит выполнение для больших двоичных данных. +// Значение по умолчанию - Истина. +// * ДляРедактирования - Булево - если указать Истина, то файл будет захвачен для редактирования. +// Значение по умолчанию - Ложь. +// * ВызыватьИсключение - Булево - если указать Ложь, то функция в исключительных ситуациях не будет вызывать +// исключений и вернет Неопределено. Значение по умолчанию - Истина. +// +Функция ПараметрыДанныхФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиентСервер.ПараметрыДанныхФайла() +``` +
+ +## ОпределитьФормуПрисоединенногоФайла +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ОбработкаПолученияФормы для переопределения формы файла. +// +// Параметры: +// Источник - СправочникМенеджер - менеджер справочника с именем "*ПрисоединенныеФайлы". +// ВидФормы - Строка - имя стандартной формы. +// Параметры - Структура - параметры формы. +// ВыбраннаяФорма - Строка - имя или объект метаданных открываемой формы. +// ДополнительнаяИнформация - Структура - дополнительная информация открытия формы. +// СтандартнаяОбработка - Булево - признак выполнения стандартной (системной) обработки события. +// +Процедура ОпределитьФормуПрисоединенногоФайла(Источник, ВидФормы, Параметры, Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиКлиентСервер.ОпределитьФормуПрисоединенногоФайла(Источник, ВидФормы, Параметры, ); +``` +
+ +## НастройкиСканированияПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки сканирования пользователя. +// +// Возвращаемое значение: +// Структура: +// * ПоказыватьДиалогСканера - Булево +// * ИмяУстройства - Строка - НаименованиеСканера +// * ФорматСканированногоИзображения - ПеречислениеСсылка.ФорматыСканированногоИзображения +// * СохранятьВPDF - Булево +// * ФорматХраненияМногостраничный - ПеречислениеСсылка.ФорматыХраненияМногостраничныхФайлов +// * Разрешение - ПеречислениеСсылка.РазрешенияСканированногоИзображения +// * Цветность - ПеречислениеСсылка.ЦветностиИзображения +// * Поворот - ПеречислениеСсылка.СпособыПоворотаИзображения +// * РазмерБумаги - ПеречислениеСсылка.РазмерыБумаги +// * ДвустороннееСканирование - Булево +// * АвтоматическаяПодачаДокументов - Булево +// * ИспользоватьImageMagickДляПреобразованияВPDF - Булево +// * КачествоJPG - Число +// * СжатиеTIFF - ПеречислениеСсылка.ВариантыСжатияTIFF +// * ПутьКПрограммеКонвертации - Строка +// +Функция НастройкиСканированияПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = РаботаСФайламиКлиентСервер.НастройкиСканированияПользователя() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСФайламиЛокализация.md b/src/content/docs/bsp/РаботаСФайламиЛокализация.md new file mode 100644 index 0000000..1963178 --- /dev/null +++ b/src/content/docs/bsp/РаботаСФайламиЛокализация.md @@ -0,0 +1,59 @@ +--- +title: Работа с файлами локализация +slug: bsp/работа-с-файлами-локализация +--- + + +## ПриОпределенииАдресаВОблачномСервисе +
+ +Описание, пример вызова + +```bsl + +// Вызывается для определения адреса объекта в облачном сервисе файлов. +// +// Параметры: +// Сервис - Строка - адрес облачного сервиса файлов, например, "https://dav.dropdav.com". +// Href - Строка - относительный URL объекта. +// АдресОбъекта - Строка - возвращаемое значение. +// +Процедура ПриОпределенииАдресаВОблачномСервисе(Знач Сервис, Знач Href, АдресОбъекта) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиЛокализация.ПриОпределенииАдресаВОблачномСервисе(Сервис, Href, АдресОбъекта) +``` +
+ +## ПриОпределенииОблачныхСервисов +
+ +Описание, пример вызова + +```bsl + +// Вызывается для определения списка облачных сервисов файлов. +// +// Параметры: +// Сервисы - СписокЗначений: +// * Значение - адрес облачного сервиса файлов. +// * Представление - название облачного сервиса файлов. +// +Процедура ПриОпределенииОблачныхСервисов(Сервисы) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиЛокализация.ПриОпределенииОблачныхСервисов(Сервисы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаботаСФайламиПереопределяемый.md b/src/content/docs/bsp/РаботаСФайламиПереопределяемый.md new file mode 100644 index 0000000..3d44f66 --- /dev/null +++ b/src/content/docs/bsp/РаботаСФайламиПереопределяемый.md @@ -0,0 +1,307 @@ +--- +title: Работа с файлами переопределяемый +slug: bsp/работа-с-файлами-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Переопределение настроек присоединенных файлов. +// +// Параметры: +// Настройки - Структура: +// * НеОчищатьФайлы - Массив из ОбъектМетаданных - объекты, файлы которых не должны выводиться в настройках очистки +// файлов (например, служебные документы). +// * НеСинхронизироватьФайлы - Массив из ОбъектМетаданных - объекты, файлы которых не должны выводиться в настройках +// синхронизации с облачными сервисами (например, служебные документы). +// * НеСоздаватьФайлыПоШаблону - Массив из ОбъектМетаданных - объекты, для файлов которых отключена возможность +// создавать файлы по шаблонам. +// +// Пример: +// Настройки.НеОчищатьФайлы.Добавить(Метаданные.Справочники.Номенклатура); +// Настройки.НеСинхронизироватьФайлы.Добавить(Метаданные.Справочники.Партнеры); +// Настройки.НеСоздаватьФайлыПоШаблону.Добавить(Метаданные.Справочники.Партнеры); +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриОпределенииСправочниковХраненияФайлов +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить справочники хранения файлов по типам владельцев. +// +// Параметры: +// ТипВладелецФайла - Тип - тип ссылки объекта, к которому добавляется файл. +// +// ИменаСправочников - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя справочника присоединенных файлов. +// * Значение - Булево - установить в Истина, чтобы отметить этот справочник как основной. +// Основной справочник используется для интерактивной работы с файлами. +// +// Пример: +// Если ТипВладелецФайла = Тип("СправочникСсылка.Номенклатура") Тогда +// ИменаСправочников["НоменклатураПрисоединенныеФайлы"] = Ложь; +// ИменаСправочников.Вставить("Файлы", Истина); +// КонецЕсли; +// +Процедура ПриОпределенииСправочниковХраненияФайлов(ТипВладелецФайла, ИменаСправочников) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриОпределенииСправочниковХраненияФайлов(ТипВладелецФайла, ИменаСправочников) +``` +
+ +## ПриПопыткеЗанятьФайл +
+ +Описание, пример вызова + +```bsl + +// Позволяет отменить захват файла на основе анализа структуры с данными файла. +// +// Параметры: +// ДанныеФайла - см. РаботаСФайлами.ДанныеФайла. +// ОписаниеОшибки - Строка - текст ошибки в случае невозможности занять файл. +// Если не пустая, файл невозможно занять. +// +Процедура ПриПопыткеЗанятьФайл(ДанныеФайла, ОписаниеОшибки = "") Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриПопыткеЗанятьФайл(ДанныеФайла, ОписаниеОшибки); +``` +
+ +## ПриСозданииФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании файла. Например, может использоваться для обработки логически связанных данных, +// которые должны изменяться при создании новых файлов. +// +// Параметры: +// Файл - ОпределяемыйТип.ПрисоединенныйФайл - ссылка на созданный файл. +// +Процедура ПриСозданииФайла(Файл) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриСозданииФайла(Файл) +``` +
+ +## ЗаполнитьРеквизитыФайлаИзИсходногоФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается после копирования файла из исходного файла для заполнения таких реквизитов нового файла, +// которые самостоятельно добавлены к справочнику Файлы или ВерсииФайлов в конфигурации. +// +// Параметры: +// НовыйФайл - СправочникСсылка.Файлы - ссылка на новый файл, который надо заполнить. +// ИсходныйФайл - СправочникСсылка.Файлы - ссылка на исходный файл, откуда надо скопировать реквизиты. +// +Процедура ЗаполнитьРеквизитыФайлаИзИсходногоФайла(НовыйФайл, ИсходныйФайл) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ЗаполнитьРеквизитыФайлаИзИсходногоФайла(НовыйФайл, ИсходныйФайл) +``` +
+ +## ПриЗахватеФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается при захвате файла. Позволяет изменить структуру с данными файла перед захватом. +// +// Параметры: +// ДанныеФайла - см. РаботаСФайлами.ДанныеФайла. +// УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор формы. +// +Процедура ПриЗахватеФайла(ДанныеФайла, УникальныйИдентификатор) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриЗахватеФайла(ДанныеФайла, УникальныйИдентификатор) +``` +
+ +## ПриОсвобожденииФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается при освобождении файла. Позволяет изменить структуру с данными файла при освобождении. +// +// Параметры: +// ДанныеФайла - см. РаботаСФайлами.ДанныеФайла. +// УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор формы. +// +Процедура ПриОсвобожденииФайла(ДанныеФайла, УникальныйИдентификатор) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриОсвобожденииФайла(ДанныеФайла, УникальныйИдентификатор) +``` +
+ +## ПриОтправкеФайловПочтой +
+ +Описание, пример вызова + +```bsl + +// Позволяет определить параметры электронного письма перед отправкой файла по почте. +// +// Параметры: +// ПараметрыОтправки - см. РаботаСПочтовымиСообщениямиКлиент.ПараметрыОтправкиПисьма. +// ФайлыДляОтправки - Массив из ОпределяемыйТип.ПрисоединенныйФайл - список файлов для отправки. +// ВладелецФайлов - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект-владелец файлов. +// УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор, +// который необходимо использовать, есть требуется помещение данных во временное хранилище. +// +Процедура ПриОтправкеФайловПочтой(ПараметрыОтправки, ФайлыДляОтправки, ВладелецФайлов, УникальныйИдентификатор) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриОтправкеФайловПочтой(ПараметрыОтправки, ФайлыДляОтправки, ВладелецФайлов, УникальныйИдентификатор) +``` +
+ +## ПриСозданииФормыСпискаФайлов +
+ +Описание, пример вызова + +```bsl + +// Позволяет изменить стандартную форму списка файлов. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма списка файлов: +// * ИмяСправочникаХранилищаФайлов - Строка +// * ВладелецФайла - ОпределяемыйТип.ВладелецФайлов +// +Процедура ПриСозданииФормыСпискаФайлов(Форма) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриСозданииФормыСпискаФайлов(Форма) +``` +
+ +## ПриСозданииФормыЭлементаФайлов +
+ +Описание, пример вызова + +```bsl + +// Позволяет изменить стандартную форму файла. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма файла: +// * Объект - ОпределяемыйТип.ПрисоединенныйФайл +// +Процедура ПриСозданииФормыЭлементаФайлов(Форма) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриСозданииФормыЭлементаФайлов(Форма) +``` +
+ +## ПриОпределенииГиперссылкиФайлов +
+ +Описание, пример вызова + +```bsl + +// Позволяет изменить структуру параметров для размещения гиперссылки присоединенных файлов на форме. +// +// Параметры: +// ПараметрыГиперссылки - см. РаботаСФайлами.ГиперссылкаФайлов. +// +// Пример: +// ПараметрыГиперссылки.Размещение = "КоманднаяПанель"; +// +Процедура ПриОпределенииГиперссылкиФайлов(ПараметрыГиперссылки) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриОпределенииГиперссылкиФайлов(ПараметрыГиперссылки) +``` +
+ +## ПриПечатиФайлаСоШтампом +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// +// Параметры: +// ПараметрыШтампа - Структура - возвращаемый параметр, со свойствами: +// * ТекстОтметки - Строка - описание расположения подлинника подписанного документа. +// * Логотип - Картинка - логотип, который будет выведен в штампе. +// Сертификат - СертификатКриптографии - сертификат, по которому формируется штамп электронной подписи. +// +Процедура ПриПечатиФайлаСоШтампом(ПараметрыШтампа, Сертификат) Экспорт +``` + +Пример вызова +```bsl +РаботаСФайламиПереопределяемый.ПриПечатиФайлаСоШтампом(ПараметрыШтампа, Сертификат) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РазмерПриложений.md b/src/content/docs/bsp/РазмерПриложений.md new file mode 100644 index 0000000..38b3ede --- /dev/null +++ b/src/content/docs/bsp/РазмерПриложений.md @@ -0,0 +1,34 @@ +--- +title: Размер приложений +slug: bsp/размер-приложений +--- + + +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +РазмерПриложений.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаспределенноеВыполнениеКоманд.md b/src/content/docs/bsp/РаспределенноеВыполнениеКоманд.md new file mode 100644 index 0000000..fed24b4 --- /dev/null +++ b/src/content/docs/bsp/РаспределенноеВыполнениеКоманд.md @@ -0,0 +1,123 @@ +--- +title: Распределенное выполнение команд +slug: bsp/распределенное-выполнение-команд +--- + + +## ВыполнитьКомандуДополнительнойОбработки +
+ +Описание, пример вызова + +```bsl + +// Вызывает команду указанной дополнительной обработки и передает в нее параметры, +// регистрирует сообщение для МС с результатами выполнения. +// Важно! Вызывается как фоновое задание. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторОбработки - Строка - указывает на обработку, команду которой нужно выполнить. +// ИдентификаторКоманды - Строка - имя команды (как оно задано в обработке), которую нужно выполнить. +// ИдентификаторОперации - Строка - позволяет идентифицировать отдельные вызовы (например, для логирования). +// СообщитьМенеджеру - Булево - указывает на необходимость сообщить Менеджеру сервиса о результате выполнения команды. +// +Процедура ВыполнитьКомандуДополнительнойОбработки(ИдентификаторОбработки, ИдентификаторКоманды, ИдентификаторОперации, СообщитьМенеджеру = Ложь) Экспорт +``` + +Пример вызова +```bsl +РаспределенноеВыполнениеКоманд.ВыполнитьКомандуДополнительнойОбработки(ИдентификаторОбработки, ИдентификаторКоманды, ИдентификаторОперации, СообщитьМенеджеру); +``` +
+ +## ВыполнитьПередачуФайлаПриложению +
+ +Описание, пример вызова + +```bsl + +// Вызывает команду передачи файла из текущей области данных в любую другую область +// данных сервиса. +// Важно! Если какой-либо из параметров передан некорректно, вызывается исключение. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИмяФайла - Строка - полное имя к передаваемому файлу. +// КодПолучателя - Число - код области данных, куда нужно передать файл. +// БыстраяПередача - Булево - указывает, что необходимо использовать быстрые сообщения для передачи файла. +// ПараметрыВызова - Структура - дополнительные параметры вызова: +// * Код - Число - код ответа, +// * Тело - Строка - тело ответа. +// +// Возвращаемое значение: +// УникальныйИдентификатор - идентификатор вызова. +// +Функция ВыполнитьПередачуФайлаПриложению(ИмяФайла, КодПолучателя, БыстраяПередача = Ложь, ПараметрыВызова = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РаспределенноеВыполнениеКоманд.ВыполнитьПередачуФайлаПриложению(ИмяФайла, КодПолучателя, БыстраяПередача, ПараметрыВызова); +``` +
+ +## ВыслатьКвитанциюПередачиФайла +
+ +Описание, пример вызова + +```bsl + +// Отправляет области-получателю сообщение-квитанцию о получении (завершении обработки, +// и так далее) ранее полученного файла. +// Важно! Если какой-либо из параметров передан некорректно, вызывается исключение. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторВызова - УникальныйИдентификатор - ранее выданный функцией ВыполнитьПередачуФайлаПриложению +// КодПолучателя - Число - код области данных, куда нужно передать квитанцию. +// БыстраяПередача - Булево - указывает, что необходимо использовать быстрые сообщения для передачи файла. +// ПараметрыВызова - Структура - дополнительные параметры вызова: +// * Код - Число - код ответа, +// * Тело - Строка - тело ответа. +// +Процедура ВыслатьКвитанциюПередачиФайла(ИдентификаторВызова, КодПолучателя, БыстраяПередача = Ложь, ПараметрыВызова = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РаспределенноеВыполнениеКоманд.ВыслатьКвитанциюПередачиФайла(ИдентификаторВызова, КодПолучателя, БыстраяПередача, ПараметрыВызова); +``` +
+ +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// СоответствиеИменПсевдонимам - см. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков.СоответствиеИменПсевдонимам +// +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +РаспределенноеВыполнениеКоманд.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РаспределенноеВыполнениеКомандПереопределяемый.md b/src/content/docs/bsp/РаспределенноеВыполнениеКомандПереопределяемый.md new file mode 100644 index 0000000..84718d8 --- /dev/null +++ b/src/content/docs/bsp/РаспределенноеВыполнениеКомандПереопределяемый.md @@ -0,0 +1,91 @@ +--- +title: Распределенное выполнение команд переопределяемый +slug: bsp/распределенное-выполнение-команд-переопределяемый +--- + + +## ОбработатьЗапросНаПередачуФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении сообщения о передаче файла из другой области данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ИмяФайла - Строка - полное имя к передаваемому файлу. +// ИдентификаторВызова - УникальныйИдентификатор - для идентификации конкретного вызова +// КодОтправителя - Число - код области данных, откуда был передан файл. +// ПараметрыВызова - Структура - дополнительные параметры вызова, +// *Код (Число), *Тело (Строка). +// Обработан - Булево - признак успешной обработки сообщения. +// +Процедура ОбработатьЗапросНаПередачуФайла(ИмяФайла, ИдентификаторВызова, КодОтправителя, ПараметрыВызова, Обработан) Экспорт +``` + +Пример вызова +```bsl +РаспределенноеВыполнениеКомандПереопределяемый.ОбработатьЗапросНаПередачуФайла(ИмяФайла, ИдентификаторВызова, КодОтправителя, ПараметрыВызова, Обработан) +``` +
+ +## ОбработатьОтветНаПередачуФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении квитанции "Успех" на передачу файла из другой области данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ИдентификаторВызова - УникальныйИдентификатор - для идентификации конкретного вызова +// КодОтправителя - Число - код области данных, откуда был передан файл. +// ПараметрыВызова - Структура - дополнительные параметры вызова, +// *Код (Число), *Тело (Строка). +// Обработан - Булево - признак успешной обработки сообщения. +// +Процедура ОбработатьОтветНаПередачуФайла(ИдентификаторВызова, КодОтправителя, ПараметрыВызова, Обработан) Экспорт +``` + +Пример вызова +```bsl +РаспределенноеВыполнениеКомандПереопределяемый.ОбработатьОтветНаПередачуФайла(ИдентификаторВызова, КодОтправителя, ПараметрыВызова, Обработан) +``` +
+ +## ОбработатьОшибкуПередачиФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении квитанции "Ошибка" на передачу файла из другой области данных. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ИдентификаторВызова - УникальныйИдентификатор - для идентификации конкретного вызова +// КодОтправителя - Число - код области данных, откуда был передан файл. +// ТекстОшибки - Строка - описание возникшей ошибки +// Обработан - Булево - признак успешной обработки сообщения. +// +Процедура ОбработатьОшибкуПередачиФайла(ИдентификаторВызова, КодОтправителя, ТекстОшибки, Обработан) Экспорт +``` + +Пример вызова +```bsl +РаспределенноеВыполнениеКомандПереопределяемый.ОбработатьОшибкуПередачиФайла(ИдентификаторВызова, КодОтправителя, ТекстОшибки, Обработан) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РассылкаОтчетов.md b/src/content/docs/bsp/РассылкаОтчетов.md new file mode 100644 index 0000000..57e126c --- /dev/null +++ b/src/content/docs/bsp/РассылкаОтчетов.md @@ -0,0 +1,356 @@ +--- +title: Рассылка отчетов +slug: bsp/рассылка-отчетов +--- + + +## ВыполнитьРассылкуОтчетов +
+ +Описание, пример вызова + +```bsl + +// Формирует отчеты и отправляет их согласно настройкам в указанную папку файлов, в папку на компьютере, +// по электронной почте или на FTP-ресурс. +// +// Параметры: +// Рассылка - СправочникСсылка.РассылкиОтчетов - выполняемая рассылка отчетов. +// ПараметрыЖурнала - см. РассылкаОтчетов.ПараметрыЖурнала. +// ДополнительныеНастройки - Структура: +// * Получатели - Соответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка - получатель. +// ** Значение - Строка - набор e-mail адресов получателя в строке с разделителями. +// +// Возвращаемое значение: +// Булево - признак успешного выполнения рассылки. +// +Функция ВыполнитьРассылкуОтчетов(Рассылка, ПараметрыЖурнала = Неопределено, ДополнительныеНастройки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РассылкаОтчетов.ВыполнитьРассылкуОтчетов(Рассылка, ПараметрыЖурнала, ДополнительныеНастройки); +``` +
+ +## ВыполнитьРассылку +
+ +Описание, пример вызова + +```bsl + +// Выполняет рассылку произвольных отчетов, указанных в параметре Отчеты. +// +// Параметры: +// Отчеты - см. РассылкаОтчетов.ОтчетыДляРассылки. +// ПараметрыДоставки - см. РассылкаОтчетов.ПараметрыДоставки. +// НаименованиеРассылки - Строка - выводится в тему и сообщение, а также для вывода ошибок. +// - СправочникСсылка.РассылкиОтчетов +// ПараметрыЖурнала - см. РассылкаОтчетов.ПараметрыЖурнала. +// +// Возвращаемое значение: +// Булево - признак успешного выполнения рассылки. +// +Функция ВыполнитьРассылку(Отчеты, ПараметрыДоставки, НаименованиеРассылки = "", ПараметрыЖурнала = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РассылкаОтчетов.ВыполнитьРассылку(Отчеты, ПараметрыДоставки, НаименованиеРассылки, ПараметрыЖурнала); +``` +
+ +## ПараметрыЖурнала +
+ +Описание, пример вызова + +```bsl + +// Конструктор для значения параметра ПараметрыЖурнала функций ВыполнитьРассылкуОтчетов и ВыполнитьРассылку. +// +// Параметры: +// Рассылка - СправочникСсылка.РассылкиОтчетов - выполняемая рассылка отчетов. +// +// Возвращаемое значение: +// Структура - параметры записи в журнал регистрации, где: +// * ИмяСобытия - Строка - имя события (или группы событий). +// * Метаданные - Массив из ОбъектМетаданных, Неопределено - метаданные для привязки события журнала регистрации. +// * Данные - Произвольный - данные для привязки события журнала регистрации. +// +Функция ПараметрыЖурнала(Рассылка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РассылкаОтчетов.ПараметрыЖурнала(Рассылка); +``` +
+ +## ОтчетыДляРассылки +
+ +Описание, пример вызова + +```bsl + +// Конструктор для значения параметра Отчеты функции ВыполнитьРассылку. +// +// Возвращаемое значение: +// ТаблицаЗначений - набор выгружаемых отчетов. Колонки: +// * Отчет - СправочникСсылка.ВариантыОтчетов +// - СправочникСсылка.ДополнительныеОтчетыИОбработки - отчет, который необходимо сформировать. +// * ОтправлятьЕслиПустой - Булево - отправлять отчет, даже если он пустой. +// * Настройки - ПользовательскиеНастройкиКомпоновкиДанных - табличный документ сформируется механизмами СКД. +// - Структура - табличный документ сформируется при помощи метода Сформировать, где: +// ** Ключ - Строка - имя реквизита объекта отчета. +// ** Значение - Произвольный - значение реквизита объекта отчета. +// - Неопределено - настройки по умолчанию. +// Примечание. Настройки, с которыми должен сформироваться отчет. +// * Форматы - Массив из ПеречислениеСсылка.ФорматыСохраненияОтчетов - форматы, в которых необходимо сохранить и +// отправить отчет. +// * ШаблонНаименования - Строка - для формирования имени файла отчета +// +Функция ОтчетыДляРассылки() Экспорт +``` + +Пример вызова +```bsl +Результат = РассылкаОтчетов.ОтчетыДляРассылки() +``` +
+ +## ПараметрыДоставки +
+ +Описание, пример вызова + +```bsl + +// Конструктор для значения параметра ПараметрыДоставки функции ВыполнитьРассылку. +// +// Возвращаемое значение: +// Структура - настройки способа доставки отчетов. Состав свойств может отличаться для разных способов доставки. +// Общие свойства: +// * Автор - СправочникСсылка.Пользователи - автор рассылки. +// * ИспользоватьПапку - Булево - доставлять отчеты в папку подсистемы "Работа с файлами". +// * ИспользоватьСетевойКаталог - Булево - доставлять отчеты в папку файловой системы. +// * ИспользоватьFTPРесурс - Булево - доставлять отчеты на FTP. +// * ИспользоватьЭлектроннуюПочту - Булево - доставлять отчеты по электронной почте. +// +// Свойства, когда ИспользоватьПапку = Истина: +// * Папка - СправочникСсылка.ПапкиФайлов - папка подсистемы "Работа с файлами". +// +// Свойства, когда ИспользоватьСетевойКаталог = Истина: +// * СетевойКаталогWindows - Строка - каталог файловой системы (локальный на сервере или сетевой). +// * СетевойКаталогLinux - Строка - каталог файловой системы (локальный на сервере или сетевой). +// +// Свойства, когда ИспользоватьFTPРесурс = Истина: +// * Владелец - СправочникСсылка.РассылкиОтчетов +// * Сервер - Строка - имя FTP сервера. +// * Порт - Число - порт FTP сервера. +// * Логин - Строка - имя пользователя FTP сервера. +// * Пароль - Строка - пароль пользователя FTP сервера. +// * Каталог - Строка - путь к каталогу на FTP сервере. +// * ПассивноеСоединение - Булево - использовать пассивное соединение. +// +// Свойства, когда ИспользоватьЭлектроннуюПочту = Истина: +// * УчетнаяЗапись - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - для отправки почтового сообщения. +// * Получатели - Соответствие из КлючИЗначение - набор получателей и их e-mail адресов: +// ** Ключ - СправочникСсылка - получатель. +// ** Значение - Строка - email-адреса получателя, разделенные запятыми. +// +// Дополнительные свойства: +// * Архивировать - Булево - архивировать все файлы сформированных отчетов в один архив. +// Архивация может потребоваться, например, при рассылке графиков в формате html. +// * ИмяАрхива - Строка - имя архива. +// * ПарольАрхива - Строка - пароль архива. +// * ТранслитерироватьИменаФайлов - Булево - признак необходимости транслитерации имен файлов отчетов рассылки. +// * СертификатДляШифрования - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - если внедрена +// подсистема ЭлектроннаяПодпись - Неопределено +// +// Необязательные свойства, когда ИспользоватьЭлектроннуюПочту = Истина: +// * Персонализирована - Булево - рассылка персонализирована получателями. +// Значение по умолчанию Ложь. +// Если установить значение Истина, то каждый получатель получит отчет с отбором по нему. +// Для этого в отчетах следует установить отбор "[Получатель]" по реквизиту, совпадающем с типом получателя. +// Применимо только только при доставке по почте, +// поэтому когда устанавливается в Истина, то другие способы доставки отключаются. +// * ТолькоУведомить - Булево - Ложь - отправлять только уведомления (не присоединять сформированные отчеты). +// * СкрытыеКопии - Булево - Ложь - если Истина, то при отправке вместо "Кому" заполняется "СкрытыеКопии". +// * ШаблонТемы - Строка - тема письма. +// * ШаблонТекста - Строка - тело письма. +// * ПараметрыФорматов - Соответствие из КлючИЗначение: +// ** Ключ - ПеречислениеСсылка.ФорматыСохраненияОтчетов +// ** Значение - Структура: +// *** Расширение - Строка +// *** ТипФайла - ТипФайлаТабличногоДокумента +// *** Имя - Строка +// * ПараметрыПисьма - Структура - содержит всю необходимую информацию о письме: +// ** Кому - Массив +// - Строка - интернет адреса получателей письма. +// - Массив - коллекция структур адресов: +// *** Адрес - Строка - почтовый адрес (должно быть обязательно заполнено). +// *** Представление - Строка - имя адресата. +// - Строка - интернет-адреса получателей письма, разделитель - ";". +// ** ПолучателиСообщения - Массив - массив структур, описывающий получателей: +// *** Адрес - Строка - почтовый адрес получателя сообщения. +// *** Представление - Строка - представление адресата. +// ** Копии - Массив +// - Строка - адреса получателей копий письма. См. описание поля Кому. +// ** СкрытыеКопии - Массив +// - Строка - адреса получателей скрытых копий письма. См. описание поля Кому. +// ** Тема - Строка - (обязательный) тема почтового сообщения. +// ** Тело - Строка - (обязательный) текст почтового сообщения (простой текст в кодировке win-1251). +// ** Вложения - Массив - файлы, которые необходимо приложить к письму (описания в виде структур): +// *** Представление - Строка - имя файла вложения; +// *** АдресВоВременномХранилище - Строка - адрес двоичных данных вложения во временном хранилище. +// *** Кодировка - Строка - кодировка вложения (используется, если отличается от кодировки письма). +// *** Идентификатор - Строка - (необязательный) используется для отметки картинок, отображаемых в теле письма. +// ** АдресОтвета - Строка - E-mail адрес, на который будут приходить ответы на рассылку. +// ** ИдентификаторыОснований - Строка - идентификаторы оснований данного письма. +// ** ОбрабатыватьТексты - Булево - необходимость обрабатывать тексты письма при отправке. +// ** УведомитьОДоставке - Булево - необходимость запроса уведомления о доставке. +// ** УведомитьОПрочтении - Булево - необходимость запроса уведомления о прочтении. +// ** ТипТекста - Строка +// - ПеречислениеСсылка.ТипыТекстовЭлектронныхПисем +// - ТипТекстаПочтовогоСообщения - определяет тип переданного теста допустимые значения: +// HTML/ТипыТекстовЭлектронныхПисем.HTML - текст почтового сообщения в формате HTML. +// ПростойТекст/ТипыТекстовЭлектронныхПисем.ПростойТекст - простой текст почтового сообщения. +// Отображается "как есть" (значение по умолчанию). +// РазмеченныйТекст/ТипыТекстовЭлектронныхПисем.РазмеченныйТекст - текст почтового сообщения +// в формате Rich Text. +// +Функция ПараметрыДоставки() Экспорт +``` + +Пример вызова +```bsl +Результат = РассылкаОтчетов.ПараметрыДоставки() +``` +
+ +## УстановитьПараметрыФормата +
+ +Описание, пример вызова + +```bsl + +// Для вызова из модулей РассылкаОтчетовПереопределяемый и РассылкаОтчетовПовтИсп. +// Добавляет формат (в случае его отсутствия) и устанавливает его параметры (если переданы). +// +// Параметры: +// СписокФорматов - СписокЗначений +// ФорматСсылка - Строка +// - ПеречислениеСсылка.ФорматыСохраненияОтчетов - ссылка или имя формата. +// Картинка - Картинка - картинка формата. +// ИспользоватьПоУмолчанию - Булево - признак того, что формат используется по умолчанию. +// +Процедура УстановитьПараметрыФормата(СписокФорматов, ФорматСсылка, Картинка = Неопределено, ИспользоватьПоУмолчанию = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетов.УстановитьПараметрыФормата(СписокФорматов, ФорматСсылка, Картинка, ИспользоватьПоУмолчанию); +``` +
+ +## ДобавитьЭлементВТаблицуТиповПолучателей +
+ +Описание, пример вызова + +```bsl + +// Для вызова из модулей РассылкаОтчетовПереопределяемый и РассылкаОтчетовПовтИсп. +// Добавляет описание типа получателей в соответствующую таблицу. +// +// Параметры: +// ТаблицаТипов - ТаблицаЗначений - передается из параметров процедуры "как есть". Содержит информацию о типах. +// ДоступныеТипы - Массив - передается из параметров процедуры "как есть". Массив неиспользованных типов. +// Настройки - Структура - предустановленные настройки для регистрации основного типа. +// Обязательные параметры: +// * ОсновнойТип - Тип - тип, который будет выступать как основной для описываемых получателей. +// Необязательные параметры: +// * Представление - Строка - представление этого типа получателей в интерфейсе. +// * ВидКИ - СправочникСсылка.ВидыКонтактнойИнформации - основной вид или группа контактной информации +// для адресов электронной почты этого типа получателей. +// * ПутьФормыВыбора - Строка - путь к форме выбора. +// * ДополнительныйТип - Тип - дополнительный тип, который можно выбрать вместе с основным из формы выбора. +// +Процедура ДобавитьЭлементВТаблицуТиповПолучателей(ТаблицаТипов, ДоступныеТипы, Настройки) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетов.ДобавитьЭлементВТаблицуТиповПолучателей(ТаблицаТипов, ДоступныеТипы, Настройки) +``` +
+ +## ВыполнитьРассылкиВФоновомЗадании +
+ +Описание, пример вызова + +```bsl + +// Выполняет несколько рассылок и размещает результат по адресу АдресРезультата. +// +// Параметры: +// ПараметрыВыполнения - Структура - выполняемые рассылки и их параметры: +// * МассивРассылок - Массив из СправочникСсылка.РассылкиОтчетов - выполняемые рассылки. +// * ПредварительныеНастройки - см. РассылкаОтчетов.ВыполнитьРассылкуОтчетов. +// АдресРезультата - Строка - адрес во временном хранилище, по которому будет размещен результат. +// +Процедура ВыполнитьРассылкиВФоновомЗадании(ПараметрыВыполнения, АдресРезультата) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетов.ВыполнитьРассылкиВФоновомЗадании(ПараметрыВыполнения, АдресРезультата) +``` +
+ +## ПодготовитьПараметрыИВыполнитьРассылку +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВыполнитьРассылкуОтчетов. +// Формирует отчеты и отправляет их согласно настройкам транспорта (Папка, FILE, EMAIL, FTP); +// +// Параметры: +// Рассылка - СправочникСсылка.РассылкиОтчетов - выполняемая рассылка отчетов. +// ПараметрыЖурнала - Структура - параметры записи в журнал регистрации: +// * ИмяСобытия - Строка - имя события (или группы событий). +// * Метаданные - ОбъектМетаданных - метаданные для привязки события журнала регистрации. +// * Данные - Произвольный - данные для привязки события журнала регистрации. +// ДополнительныеНастройки - Структура - настройки, которые переопределяют стандартные параметры рассылки: +// * Получатели - Соответствие из КлючИЗначение - набор получателей и их e-mail адресов: +// ** Ключ - СправочникСсылка - получатель. +// ** Значение - Строка - набор e-mail адресов получателя в строке с разделителями. +// +// Возвращаемое значение: +// Булево - признак успешного выполнения рассылки. +// +Функция ПодготовитьПараметрыИВыполнитьРассылку(Рассылка, ПараметрыЖурнала = Неопределено, ДополнительныеНастройки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = РассылкаОтчетов.ПодготовитьПараметрыИВыполнитьРассылку(Рассылка, ПараметрыЖурнала, ДополнительныеНастройки); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РассылкаОтчетовКлиентПереопределяемый.md b/src/content/docs/bsp/РассылкаОтчетовКлиентПереопределяемый.md new file mode 100644 index 0000000..3d465f6 --- /dev/null +++ b/src/content/docs/bsp/РассылкаОтчетовКлиентПереопределяемый.md @@ -0,0 +1,128 @@ +--- +title: Рассылка отчетов клиент переопределяемый +slug: bsp/рассылка-отчетов-клиент-переопределяемый +--- + + +## ПриАктивизацииСтрокиНастройки +
+ +Описание, пример вызова + +```bsl + +// Обработчик активизации строки пользовательской настройки СКД отчета. +// +// Параметры: +// Отчет - ДанныеФормыЭлементКоллекции - строка табличной части, описывающая отчет. +// Свойства для чтения: +// * ПолноеИмя - Строка - полное имя отчета. Например: "Отчет.ИмяОтчета". +// * КлючВарианта - Строка - ключ варианта отчета. +// * Отчет - СправочникСсылка.ВариантыОтчетов - ссылка варианта отчета. +// * Представление - Строка - наименование варианта отчета. +// Свойства для изменения: +// * ВнесеныИзменения - Булево - следует установить Истина когда меняются пользовательские настройки отчета. +// КомпоновщикНастроекКД - КомпоновщикНастроекКомпоновкиДанных - все настройки отчета. +// Свойства для изменения: +// * ПользовательскиеНастройки - ПользовательскиеНастройкиКомпоновкиДанных - все пользовательские настройки отчета. +// Все прочие свойства - только для чтения. +// ИдентификаторКД - ИдентификаторКомпоновкиДанных - идентификатор пользовательской настройки отчета. +// Может использоваться для получения данных пользовательской настройки. Например: +// ПользовательскаяНастройкаКД = КомпоновщикНастроекКД.НайтиПоИдентификатору(ИдентификаторКД); +// ТолькоПросмотрЗначения - Булево - флажок возможности непосредственного редактирования колонки "Значение". +// Если установить в Истина, то следует определить обработчик выбора значения в событии "ПриНачалеВыбораНастройки". +// +Процедура ПриАктивизацииСтрокиНастройки(Отчет, КомпоновщикНастроекКД, ИдентификаторКД, ТолькоПросмотрЗначения) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовКлиентПереопределяемый.ПриАктивизацииСтрокиНастройки(Отчет, КомпоновщикНастроекКД, ИдентификаторКД, ТолькоПросмотрЗначения) +``` +
+ +## ПриНачалеВыбораНастройки +
+ +Описание, пример вызова + +```bsl + +// Обработчик начала выбора значения для строки пользовательской настройки СКД отчета. +// +// Параметры: +// Отчет - ДанныеФормыЭлементКоллекции - строка табличной части, описывающая отчет. +// Свойства для чтения: +// * ПолноеИмя - Строка - полное имя отчета. Например: "Отчет.ИмяОтчета". +// * КлючВарианта - Строка - ключ варианта отчета. +// * Отчет - СправочникСсылка.ВариантыОтчетов - ссылка варианта отчета. +// * Представление - Строка - наименование варианта отчета. +// Свойства для изменения: +// * ВнесеныИзменения - Булево - следует установить Истина когда меняются пользовательские настройки отчета. +// КомпоновщикНастроекКД - КомпоновщикНастроекКомпоновкиДанных - все настройки отчета. +// Свойства для изменения: +// * ПользовательскиеНастройки - ПользовательскиеНастройкиКомпоновкиДанных - все пользовательские настройки отчета. +// Все прочие свойства - только для чтения. +// ИдентификаторКД - ИдентификаторКомпоновкиДанных - идентификатор пользовательской настройки отчета. +// Может использоваться для получения данных пользовательской настройки. Например: +// ПользовательскаяНастройкаКД = КомпоновщикНастроекКД.НайтиПоИдентификатору(ИдентификаторКД); +// СтандартнаяОбработка - Булево - если Истина, то будет использован стандартный диалог выбора. +// Если используется собственная обработка события, то следует установить в Ложь. +// Обработчик - ОписаниеОповещения - обработчик результата выбора прикладной формы. +// В качестве 1-го параметра (Результат) в процедуру-обработчик могут быть переданы значения типов: +// Неопределено - пользователь отказался от выбора. +// ПользовательскиеНастройкиКомпоновкиДанных - новые настройки отчета. +// +Процедура ПриНачалеВыбораНастройки(Отчет, КомпоновщикНастроекКД, ИдентификаторКД, СтандартнаяОбработка, Обработчик) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовКлиентПереопределяемый.ПриНачалеВыбораНастройки(Отчет, КомпоновщикНастроекКД, ИдентификаторКД, СтандартнаяОбработка, Обработчик) +``` +
+ +## ПриОчисткеНастройки +
+ +Описание, пример вызова + +```bsl + +// Обработчик очистки значения для строки пользовательской настройки СКД отчета. +// +// Параметры: +// Отчет - ДанныеФормыЭлементКоллекции - строка табличной части, описывающая отчет. +// Свойства для чтения: +// * ПолноеИмя - Строка - полное имя отчета. Например: "Отчет.ИмяОтчета". +// * КлючВарианта - Строка - ключ варианта отчета. +// * Отчет - СправочникСсылка.ВариантыОтчетов - ссылка варианта отчета. +// * Представление - Строка - наименование варианта отчета. +// Свойства для изменения: +// * ВнесеныИзменения - Булево - следует установить Истина когда меняются пользовательские настройки отчета. +// КомпоновщикНастроекКД - КомпоновщикНастроекКомпоновкиДанных - все настройки отчета. +// Свойства для изменения: +// * ПользовательскиеНастройки - ПользовательскиеНастройкиКомпоновкиДанных - все пользовательские настройки отчета. +// Все прочие свойства - только для чтения. +// ИдентификаторКД - ИдентификаторКомпоновкиДанных - идентификатор пользовательской настройки отчета. +// Может использоваться для получения данных пользовательской настройки. Например: +// ПользовательскаяНастройкаКД = КомпоновщикНастроекКД.НайтиПоИдентификатору(ИдентификаторКД); +// СтандартнаяОбработка - Булево - если Истина, то значение настройки будет очищено. +// Если значение настройки не должно быть очищено, то следует установить в Ложь. +// +Процедура ПриОчисткеНастройки(Отчет, КомпоновщикНастроекКД, ИдентификаторКД, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовКлиентПереопределяемый.ПриОчисткеНастройки(Отчет, КомпоновщикНастроекКД, ИдентификаторКД, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РассылкаОтчетовПереопределяемый.md b/src/content/docs/bsp/РассылкаОтчетовПереопределяемый.md new file mode 100644 index 0000000..4902f59 --- /dev/null +++ b/src/content/docs/bsp/РассылкаОтчетовПереопределяемый.md @@ -0,0 +1,273 @@ +--- +title: Рассылка отчетов переопределяемый +slug: bsp/рассылка-отчетов-переопределяемый +--- + + +## ПереопределитьПараметрыФорматов +
+ +Описание, пример вызова + +```bsl + +// Позволяет изменить форматы по умолчанию и установить картинки. +// Для изменения параметров формата см. РассылкаОтчетов.УстановитьПараметрыФормата. +// +// Параметры: +// СписокФорматов - СписокЗначений: +// * Значение - ПеречислениеСсылка.ФорматыСохраненияОтчетов - ссылка формата. +// * Представление - Строка - представление формата. +// * Пометка - Булево - признак того, что формат используется по умолчанию. +// * Картинка - Картинка - картинка формата. +// +// Пример: +// РассылкаОтчетов.УстановитьПараметрыФормата(СписокФорматов, "HTML", , Ложь); +// РассылкаОтчетов.УстановитьПараметрыФормата(СписокФорматов, "XLS" , , Истина); +// +Процедура ПереопределитьПараметрыФорматов(СписокФорматов) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовПереопределяемый.ПереопределитьПараметрыФорматов(СписокФорматов) +``` +
+ +## ПереопределитьТаблицуТиповПолучателей +
+ +Описание, пример вызова + +```bsl + +// Позволяет добавить описание кросс объектной связи типов для получателей рассылки. +// Для регистрации параметров типа см. РассылкаОтчетов.ДобавитьЭлементВТаблицуТиповПолучателей. +// Другие примеры использования см. функцию РассылкаОтчетовПовтИсп.ТаблицаТиповПолучателей. +// Важно: +// Использовать данный механизм требуется только в том случае, если: +// 1. Требуется описать и представить несколько типов как один (как в справочнике Пользователи и Группы +// пользователей). +// 2. Требуется изменить представление типа без изменения синонима метаданных. +// 3. Требуется указать вид контактной информации E-Mail по умолчанию. +// 4. Требуется определить группу контактной информации. +// +// Параметры: +// ТаблицаТипов - ТаблицаЗначений - таблица описания типов. +// ДоступныеТипы - Массив - доступные типы. +// +// Пример: +// Настройки = Новый Структура; +// Настройки.Вставить("ОсновнойТип", Тип("СправочникСсылка.Контрагенты")); +// Настройки.Вставить("ВидКИ", УправлениеКонтактнойИнформацией.ВидКонтактнойИнформацииПоИмени("EmailКонтрагента")); +// РассылкаОтчетов.ДобавитьЭлементВТаблицуТиповПолучателей(ТаблицаТипов, ДоступныеТипы, Настройки); +// +Процедура ПереопределитьТаблицуТиповПолучателей(ТаблицаТипов, ДоступныеТипы) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовПереопределяемый.ПереопределитьТаблицуТиповПолучателей(ТаблицаТипов, ДоступныеТипы) +``` +
+ +## ПередСохранениемТабличногоДокументаВФормат +
+ +Описание, пример вызова + +```bsl + +// Позволяет определить свой обработчик для сохранения табличного документа в формат. +// Важно: +// Если используется нестандартная обработка (СтандартнаяОбработка меняется на Ложь), +// тогда ПолноеИмяФайла должно содержать полное имя файла с расширением. +// +// Параметры: +// СтандартнаяОбработка - Булево - признак использования стандартных механизмов подсистемы для сохранения в формат. +// ТабличныйДокумент - ТабличныйДокумент - сохраняемый табличный документ. +// Формат - ПеречислениеСсылка.ФорматыСохраненияОтчетов - формат, в котором сохраняется табличный +// документ. +// ПолноеИмяФайла - Строка - полное имя файла. +// Передается без расширения, если формат был добавлен в прикладной конфигурации. +// +// Пример: +// Если Формат = Перечисления.ФорматыСохраненияОтчетов.HTML Тогда +// СтандартнаяОбработка = Ложь; +// ПолноеИмяФайла = ПолноеИмяФайла +".html"; +// ТабличныйДокумент.Записать(ПолноеИмяФайла, ТипФайлаТабличногоДокумента.HTML5); +// КонецЕсли; +// +Процедура ПередСохранениемТабличногоДокументаВФормат(СтандартнаяОбработка, ТабличныйДокумент, Формат, ПолноеИмяФайла) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовПереопределяемый.ПередСохранениемТабличногоДокументаВФормат(СтандартнаяОбработка, ТабличныйДокумент, Формат, ПолноеИмяФайла) +``` +
+ +## ПередФормированиемСпискаПолучателейРассылки +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить список получателей рассылки отчетов. +// Если параметр СтандартнаяОбработка оставить в Истина, то список получателей формируется по правилам: +// - если рассылка личная, то в список получателей включается только автор рассылки; +// - если получатели рассылки - это иерархический справочник, и указан родительский элемент, +// то включаются все его дочерние элементы (кроме групп); +// - исключаются получатели, которые отмечены в списке как исключаемые, а также помеченные на удаление; +// - если получателями рассылки отчетов являются пользователи, то исключаются служебные и недействительные пользователи; +// - для получателей рассылки отчетов заполняются их почтовые адреса, соответствующие виду контактной информации +// ВидПочтовогоАдресаПолучателей параметра ПараметрыПолучателей. +// +// Параметры: +// ПараметрыПолучателей - СправочникСсылка.РассылкиОтчетов +// - Структура - параметры формирования получателей рассылки. +// Запрос - Запрос - запрос, который будет выполнен, если значение параметра СтандартнаяОбработка оставить в Истина. +// СтандартнаяОбработка - Булево - указать Ложь, если Результат требуется заполнить в этом обработчике. +// Результат - Соответствие из КлючИЗначение - возвращаемое значение. Если СтандартнаяОбработка установлена в Истина, +// то заполнить список получателей с их адресами: +// * Ключ - СправочникСсылка - получатель рассылки отчетов. Например, пользователь или контрагент. +// * Значение - Строка - почтовые адреса с разделителями ";", например: "email@server.com; email2@server2.com". +// +Процедура ПередФормированиемСпискаПолучателейРассылки(ПараметрыПолучателей, Запрос, СтандартнаяОбработка, Результат) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовПереопределяемый.ПередФормированиемСпискаПолучателейРассылки(ПараметрыПолучателей, Запрос, СтандартнаяОбработка, Результат) +``` +
+ +## ОпределитьИсключаемыеОтчеты +
+ +Описание, пример вызова + +```bsl + +// Позволяет исключить отчеты, которые не готовы к интеграции с рассылкой. +// Указанные отчеты используются в качестве исключающего фильтра при выборе отчетов. +// +// Параметры: +// ИсключаемыеОтчеты - Массив - список отчетов в виде объектов с типом ОбъектМетаданных: Отчет, +// подключенные к хранилищу "ВариантыОтчетов", но не поддерживающие интеграцию с рассылками. +// +Процедура ОпределитьИсключаемыеОтчеты(ИсключаемыеОтчеты) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовПереопределяемый.ОпределитьИсключаемыеОтчеты(ИсключаемыеОтчеты) +``` +
+ +## ПриПодготовкеПараметровФормированияОтчета +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить параметры формирования рассылаемого отчета. +// +// Параметры: +// ПараметрыФормирования - Структура: +// * ПользовательскиеНастройкиКД - ПользовательскиеНастройкиКомпоновкиДанных - настройки отчета, +// установленные для соответствующей рассылки. +// ДополнительныеПараметры - Структура: +// * Отчет - СправочникСсылка.ВариантыОтчетов - ссылка на хранилище настроек варианта рассылаемого отчета. +// * Объект - ОтчетОбъект - объект рассылаемого отчета. +// * СКД - Булево - признак того, что отчет строится посредством системы компоновки данных. +// * КомпоновщикНастроекКД - КомпоновщикНастроекКомпоновкиДанных - компоновщик настроек рассылаемого отчета. +// +Процедура ПриПодготовкеПараметровФормированияОтчета(ПараметрыФормирования, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовПереопределяемый.ПриПодготовкеПараметровФормированияОтчета(ПараметрыФормирования, ДополнительныеПараметры) +``` +
+ +## ПриОпределенииПараметровТекстаПисьма +
+ +Описание, пример вызова + +```bsl + +// Позволяет добавить дополнительные параметры для формирования темы и текста рассылки отчетов +// Используется вместе с ПриПолученииПараметровТекстаПисьма. +// +// Параметры: +// ВидРассылки - Строка - вид рассылки отчетов. Варианты: "Общая", "Персонализирована", "Личная". +// ТипПолучателейРассылки - ОписаниеТипов +// - Неопределено - когда ВидРассылки = "Личная" +// ДополнительныеПараметрыТекста - Структура - описание дополнительных параметров темы и текста письма, где: +// * Ключ - Строка - имя параметра; +// * Значение - Строка - представление параметра. +// +// Пример: +// Если ВидРассылки = "Персонализирована" И ТипПолучателейРассылки +// = Новый ОписаниеТипов("СправочникСсылка.ФизическиеЛица") Тогда +// ДополнительныеПараметрыТекста.Вставить("Имя", НСтр("ru='Имя'")); +// ДополнительныеПараметрыТекста.Вставить("Отчество", НСтр("ru='Отчество'")); +// КонецЕсли; +// +Процедура ПриОпределенииПараметровТекстаПисьма(ВидРассылки, ТипПолучателейРассылки, ДополнительныеПараметрыТекста) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовПереопределяемый.ПриОпределенииПараметровТекстаПисьма(ВидРассылки, ТипПолучателейРассылки, ДополнительныеПараметрыТекста) +``` +
+ +## ПриПолученииПараметровТекстаПисьма +
+ +Описание, пример вызова + +```bsl + +// Позволяет установить произвольные значения дополнительных параметров текста для формирования темы и текста рассылки отчетов +// Используется вместе с ПриОпределенииПараметровТекстаПисьма. +// +// Параметры: +// ВидРассылки - Строка - вид рассылки отчетов. Варианты: "Общая", "Персонализирована", "Личная". +// ТипПолучателейРассылки - ОписаниеТипов +// Получатель - ОпределяемыйТип.ПолучательРассылки - когда ВидРассылки = "Персонализирована"; +// - Неопределено - когда ВидРассылки = "Личная" или "Общая". +// ДополнительныеПараметрыТекста - Структура - описание дополнительных параметров темы и текста письма, где: +// * Ключ - Строка - имя параметра; +// * Значение - Строка - представление параметра. +// +// Пример: +// Если ВидРассылки = "Персонализирована" И ТипПолучателейРассылки +// = Новый ОписаниеТипов("СправочникСсылка.ФизическиеЛица") И Получатель <> Неопределено Тогда +// РеквизитыФизическогоЛица = ОбщегоНазначения.ЗначенияРеквизитовОбъекта(Получатель, "Имя, Отчество"); +// ДополнительныеПараметрыТекста.Имя = РеквизитыФизическогоЛица.Имя; +// ДополнительныеПараметрыТекста.Отчество = РеквизитыФизическогоЛица.Отчество; +// КонецЕсли; +// +Процедура ПриПолученииПараметровТекстаПисьма(ВидРассылки, ТипПолучателейРассылки, Получатель, ДополнительныеПараметрыТекста) Экспорт +``` + +Пример вызова +```bsl +РассылкаОтчетовПереопределяемый.ПриПолученииПараметровТекстаПисьма(ВидРассылки, ТипПолучателейРассылки, Получатель, ДополнительныеПараметрыТекста) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РасширенияВМоделиСервиса.md b/src/content/docs/bsp/РасширенияВМоделиСервиса.md new file mode 100644 index 0000000..3230fb6 --- /dev/null +++ b/src/content/docs/bsp/РасширенияВМоделиСервиса.md @@ -0,0 +1,205 @@ +--- +title: Расширения в модели сервиса +slug: bsp/расширения-в-модели-сервиса +--- + + +## ПоставляемоеРасширение +
+ +Описание, пример вызова + +```bsl + +// Устарела, в составе конфигурации нет вызовов. Рекомендуется отказаться от использования в прикладном коде. +// Возвращает поставляемое расширение, соответствующее используемому расширению. +// +// Параметры: +// ИдентификаторИспользуемогоРасширения - УникальныйИдентификатор - идентификатор расширения. +// +// Возвращаемое значение: +// СправочникСсылка.ПоставляемыеРасширения - ссылка на поставляемое расширение +// +Функция ПоставляемоеРасширение(ИдентификаторИспользуемогоРасширения) Экспорт +``` + +Пример вызова +```bsl +Результат = РасширенияВМоделиСервиса.ПоставляемоеРасширение(ИдентификаторИспользуемогоРасширения) +``` +
+ +## ПриДобавленииИсключенийПоискаСсылок +
+ +Описание, пример вызова + +```bsl + +// Заполняет массив списком имен объектов метаданных, данные которых могут содержать ссылки на различные объекты метаданных, +// но при этом эти ссылки не должны учитываться в бизнес-логике приложения. +// +// Параметры: +// Массив - Массив Из Строка - например "РегистрСведений.ВерсииОбъектов". +// +Процедура ПриДобавленииИсключенийПоискаСсылок(Массив) Экспорт +``` + +Пример вызова +```bsl +РасширенияВМоделиСервиса.ПриДобавленииИсключенийПоискаСсылок(Массив) +``` +
+ +## ПриЗаполненииТаблицыПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВМоделиСервисаПереопределяемый.ПриЗаполненииТаблицыПараметровИБ +// +// Параметры: +// ТаблицаПараметров - см. РаботаВМоделиСервиса.ПараметрыИБ +Процедура ПриЗаполненииТаблицыПараметровИБ(Знач ТаблицаПараметров) Экспорт +``` + +Пример вызова +```bsl +РасширенияВМоделиСервиса.ПриЗаполненииТаблицыПараметровИБ(ТаблицаПараметров) +``` +
+ +## ПриУстановкеЗначенийПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВМоделиСервисаПереопределяемый.ПриУстановкеЗначенийПараметровИБ. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПриУстановкеЗначенийПараметровИБ(Знач ЗначенияПараметров) Экспорт +``` + +Пример вызова +```bsl +РасширенияВМоделиСервиса.ПриУстановкеЗначенийПараметровИБ(ЗначенияПараметров) +``` +
+ +## РегистрацияИнтерфейсовПринимаемыхСообщений +
+ +Описание, пример вызова + +```bsl + +// См. ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.ЗаполнитьОбработчикиПринимаемыхСообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив Из ОбщийМодуль - обработчики. +// +Процедура РегистрацияИнтерфейсовПринимаемыхСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +РасширенияВМоделиСервиса.РегистрацияИнтерфейсовПринимаемыхСообщений(МассивОбработчиков) +``` +
+ +## РегистрацияИнтерфейсовОтправляемыхСообщений +
+ +Описание, пример вызова + +```bsl + +// См. ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.ЗаполнитьОбработчикиОтправляемыхСообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив Из ОбщийМодуль - обработчики. +// +Процедура РегистрацияИнтерфейсовОтправляемыхСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +РасширенияВМоделиСервиса.РегистрацияИнтерфейсовОтправляемыхСообщений(МассивОбработчиков) +``` +
+ +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +РасширенияВМоделиСервиса.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ПриОпределенииОбработчиковПоставляемыхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ПоставляемыеДанныеПереопределяемый.ПолучитьОбработчикиПоставляемыхДанных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Обработчики - см. ПоставляемыеДанныеПереопределяемый.ПолучитьОбработчикиПоставляемыхДанных.Обработчики +// +Процедура ПриОпределенииОбработчиковПоставляемыхДанных(Обработчики) Экспорт +``` + +Пример вызова +```bsl +РасширенияВМоделиСервиса.ПриОпределенииОбработчиковПоставляемыхДанных(Обработчики) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +РасширенияВМоделиСервиса.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РегламентированныеДанныеКлиентСервер.md b/src/content/docs/bsp/РегламентированныеДанныеКлиентСервер.md new file mode 100644 index 0000000..129db58 --- /dev/null +++ b/src/content/docs/bsp/РегламентированныеДанныеКлиентСервер.md @@ -0,0 +1,174 @@ +--- +title: Регламентированные данные клиент сервер +slug: bsp/регламентированные-данные-клиент-сервер +--- + + +## ИННСоответствуетТребованиям +
+ +Описание, пример вызова + +```bsl + +// Проверяет соответствие ИНН требованиям. Только для проверки ИНН физических и юридических лиц Российской Федерации. +// +// Параметры: +// ИНН - Строка - проверяемый индивидуальный номер налогоплательщика. +// ЭтоЮридическоеЛицо - Булево - признак, является ли владелец ИНН юридическим лицом. +// ТекстСообщения - Строка - текст сообщения о найденных ошибках. +// +// Возвращаемое значение: +// Булево - Истина, если соответствует. +// +Функция ИННСоответствуетТребованиям(Знач ИНН, ЭтоЮридическоеЛицо, ТекстСообщения) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентированныеДанныеКлиентСервер.ИННСоответствуетТребованиям(ИНН, ЭтоЮридическоеЛицо, ТекстСообщения) +``` +
+ +## КППСоответствуетТребованиям +
+ +Описание, пример вызова + +```bsl + +// Проверяет соответствие КПП требованиям. +// Согласно приложению к приказу ФНС России от 29.06.2012 N ММВ-7-6/435@ +// "Об утверждении Порядка и условий присвоения, применения, а также изменения +// идентификационного номера налогоплательщика". +// +// Параметры: +// КПП - Строка - проверяемый код причины постановки на учет. +// ТекстСообщения - Строка - текст сообщения о найденных ошибках. +// +// Возвращаемое значение: +// Булево - Истина, если соответствует. +// +Функция КППСоответствуетТребованиям(Знач КПП, ТекстСообщения) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентированныеДанныеКлиентСервер.КППСоответствуетТребованиям(КПП, ТекстСообщения) +``` +
+ +## ОГРНСоответствуетТребованиям +
+ +Описание, пример вызова + +```bsl + +// Проверяет соответствие ОГРН требованиям. +// +// Параметры: +// ОГРН - Строка - проверяемый основной государственный регистрационный номер. +// ЭтоЮридическоеЛицо - Булево - признак, является ли владелец ОГРН юридическим лицом. +// ТекстСообщения - Строка - текст сообщения о найденных ошибках. +// +// Возвращаемое значение: +// Булево - Истина, если соответствует. +// +Функция ОГРНСоответствуетТребованиям(Знач ОГРН, ЭтоЮридическоеЛицо, ТекстСообщения) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентированныеДанныеКлиентСервер.ОГРНСоответствуетТребованиям(ОГРН, ЭтоЮридическоеЛицо, ТекстСообщения) +``` +
+ +## КодПоОКПОСоответствуетТребованиям +
+ +Описание, пример вызова + +```bsl + +// Проверяет соответствие кода ОКПО требованиям стандартов. +// +// Параметры: +// ПроверяемыйКод - Строка - проверяемый код ОКПО; +// ЭтоЮридическоеЛицо - Булево - признак, является ли владелец кода ОКПО юридическим лицом; +// ТекстСообщения - Строка - текст сообщения о найденных ошибках в проверяемом коде ОКПО. +// +// Возвращаемое значение: +// Булево - Истина, если соответствует. +// +Функция КодПоОКПОСоответствуетТребованиям(Знач ПроверяемыйКод, ЭтоЮридическоеЛицо, ТекстСообщения = "") Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентированныеДанныеКлиентСервер.КодПоОКПОСоответствуетТребованиям(ПроверяемыйКод, ЭтоЮридическоеЛицо, ТекстСообщения); +``` +
+ +## СтраховойНомерПФРСоответствуетТребованиям +
+ +Описание, пример вызова + +```bsl + +// Проверяет номер страхового свидетельства на соответствие требованиям ПФР. +// +// Параметры: +// СтраховойНомер - Строка - страховой номер ПФР. Строка должна быть ведена по шаблону "999-999-999 99". +// ТекстСообщения - Строка - текст сообщения об ошибке ввода страхового номера. +// +// Возвращаемое значение: +// Булево - Истина, если соответствует. +// +Функция СтраховойНомерПФРСоответствуетТребованиям(Знач СтраховойНомер, ТекстСообщения) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентированныеДанныеКлиентСервер.СтраховойНомерПФРСоответствуетТребованиям(СтраховойНомер, ТекстСообщения) +``` +
+ +## КонтрольныйКлючЛицевогоСчетаСоответствуетТребованиям +
+ +Описание, пример вызова + +```bsl + +// Проверка контрольного ключа в номере лицевого счета (9-й разряд номера счета), +// алгоритм установлен документом: +// "ПОРЯДОК РАСЧЕТА КОНТРОЛЬНОГО КЛЮЧА В НОМЕРЕ ЛИЦЕВОГО СЧЕТА" +// (утвержден ЦБ РФ 08.09.1997 N 515). +// +// Параметры: +// НомерСчета - Строка - номер банковского счета. +// БИК - Строка - БИК банка в котором открыт счет. +// ЭтоБанк - Булево - если Истина, то проверяется банковский счет, иначе проверяется как счет РКЦ +// (у РКЦ корреспондентский счет не заполняется). +// +// Возвращаемое значение: +// Булево - Истина, если соответствует. +// +Функция КонтрольныйКлючЛицевогоСчетаСоответствуетТребованиям(НомерСчета, БИК, ЭтоБанк = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентированныеДанныеКлиентСервер.КонтрольныйКлючЛицевогоСчетаСоответствуетТребованиям(НомерСчета, БИК, ЭтоБанк); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РегламентныеЗаданияПереопределяемый.md b/src/content/docs/bsp/РегламентныеЗаданияПереопределяемый.md new file mode 100644 index 0000000..ff3b4ac --- /dev/null +++ b/src/content/docs/bsp/РегламентныеЗаданияПереопределяемый.md @@ -0,0 +1,107 @@ +--- +title: Регламентные задания переопределяемый +slug: bsp/регламентные-задания-переопределяемый +--- + + +## ПриОпределенииНастроекРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// Определяет следующие свойств регламентных заданий: +// - зависимость от функциональных опций; +// - возможность выполнения в различных режимах работы программы; +// - прочие параметры. +// +// Параметры: +// Настройки - ТаблицаЗначений: +// * РегламентноеЗадание - ОбъектМетаданныхРегламентноеЗадание - регламентное задание. +// * ФункциональнаяОпция - ОбъектМетаданныхФункциональнаяОпция - функциональная опция, +// от которой зависит регламентное задание. +// * ЗависимостьПоИ - Булево - если регламентное задание зависит более чем +// от одной функциональной опции и его необходимо включать только тогда, +// когда все функциональные опции включены, то следует указывать Истина +// для каждой зависимости. +// По умолчанию Ложь - если хотя бы одна функциональная опция включена, +// то регламентное задание тоже включено. +// * ВключатьПриВключенииФункциональнойОпции - Булево +// - Неопределено - если Ложь, то при +// включении функциональной опции регламентное задание не будет включаться. Значение +// Неопределено соответствует значению Истина. +// По умолчанию - Неопределено. +// * ДоступноВПодчиненномУзлеРИБ - Булево +// - Неопределено - Истина или Неопределено, если регламентное +// задание доступно в РИБ. +// По умолчанию - Неопределено. +// * ДоступноВАвтономномРабочемМесте - Булево +// - Неопределено - Истина или Неопределено, если регламентное +// задание доступно в автономном рабочем месте. +// По умолчанию - Неопределено. +// * ДоступноВМоделиСервиса - Булево +// - Неопределено - Ложь, если необходимо блокировать выполнение регламентного +// задания (в т.ч. задания очереди) в информационной базе с включенным использованием разделителя. +// Значение Неопределено трактуется как Истина. +// По умолчанию - Неопределено. +// * РаботаетСВнешнимиРесурсами - Булево - Истина, если регламентное задание модифицирует данные +// во внешних источниках (получение почты, синхронизация данных и т.п.). Не следует устанавливать +// значение Истина для регламентных заданий, не модифицирующих данные во внешних источниках. +// Например, регламентное задание ЗагрузкаКурсовВалют. Регламентные задания, работающие с внешними ресурсами, +// автоматически отключаются в копии информационной базы и не выполняются при отключенной функциональной +// опции "Разрешить доступ к Интернет-сервисам". По умолчанию - Ложь. +// * ОбращаетсяКВнешнимРесурсам - Булево - Истина, если регламентное задание обращается к внешним ресурсам +// (Интернет-сервисам), но не модифицирует их, например, регламентное задание ЗагрузкаКурсовВалют. +// Регламентные задания, работающие с Интернет-сервисами, не выполняются при отключенной функциональной +// опции "Разрешить доступ к Интернет-сервисам". По умолчанию - Ложь. +// +// * Параметризуется - Булево - Истина, если регламентное задание параметризованное. +// По умолчанию - Ложь. +// +// Пример: +// Настройка = Настройки.Добавить(); +// Настройка.РегламентноеЗадание = Метаданные.РегламентныеЗадания.ОбновлениеСтатусовДоставкиSMS; +// Настройка.ФункциональнаяОпция = Метаданные.ФункциональныеОпции.ИспользоватьПочтовыйКлиент; +// Настройка.ДоступноВМоделиСервиса = Ложь; +// +Процедура ПриОпределенииНастроекРегламентныхЗаданий(Настройки) Экспорт +``` + +Пример вызова +```bsl +РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроекРегламентныхЗаданий(Настройки) +``` +
+ +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить настройки подсистемы, заданные по умолчанию. +// +// Параметры: +// Настройки - Структура: +// * РасположениеКомандыСнятияБлокировки - Строка - определяет расположение команды снятия +// блокировки работы с внешними ресурсами +// при перемещении информационной базы. +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РегламентныеЗаданияСервер.md b/src/content/docs/bsp/РегламентныеЗаданияСервер.md new file mode 100644 index 0000000..4e0f3d9 --- /dev/null +++ b/src/content/docs/bsp/РегламентныеЗаданияСервер.md @@ -0,0 +1,552 @@ +--- +title: Регламентные задания сервер +slug: bsp/регламентные-задания-сервер +--- + + +## НайтиЗадания +
+ +Описание, пример вызова + +```bsl + +// В локальном режиме работы возвращает регламентные задания, соответствующие отбору. +// В модели сервиса - таблицу значений, в которой содержится описание найденных заданий +// в справочнике ОчередьЗаданий. +// +// Параметры: +// Отбор - Структура - со свойствами: +// 1) Общие для любого режима работы: +// * УникальныйИдентификатор - УникальныйИдентификатор - идентификатор регламентного задания в локальном +// режиме работы или идентификатор ссылки задания очереди в модели сервиса. +// - Строка - строка уникального идентификатора регламентного задания в локальном +// режиме работы или идентификатор ссылки задания очереди в модели сервиса. +// - СправочникСсылка.ОчередьЗаданий - идентификатор задания +// очереди в модели сервиса. +// - СтрокаТаблицыЗначений из см. НайтиЗадания +// * Метаданные - ОбъектМетаданныхРегламентноеЗадание - метаданные регламентного задания. +// - Строка - имя метаданных регламентного задания. +// * Использование - Булево - если Истина, задание включено. +// * Ключ - Строка - прикладной идентификатор задания. +// 2) Возможные ключи только локального режима: +// * Наименование - Строка - наименование регламентного задания. +// * Предопределенное - Булево - если Истина, регламентное задание определено в метаданных. +// 3) Возможные ключи только для модели сервиса: +// * ИмяМетода - Строка - имя метода (или псевдоним) обработчика очереди задании. +// * ОбластьДанных - Число - значение разделителя области данных задания. +// * СостояниеЗадания - ПеречислениеСсылка.СостоянияЗаданий - состояние задания очереди. +// * Шаблон - СправочникСсылка.ШаблоныЗаданийОчереди - шаблон задания, используется только +// для разделенных заданий очереди. +// +// Возвращаемое значение: +// Массив из РегламентноеЗадание - в локальном режиме работы массив регламентных заданий. +// ТаблицаЗначений - в модели сервиса с колонками: +// * Использование - Булево - если Истина, задание включено. +// * Ключ - Строка - прикладной идентификатор задания. +// * Параметры - Массив - параметры, передаваемые в обработчик задания. +// * Расписание - РасписаниеРегламентногоЗадания - расписание задания. +// * УникальныйИдентификатор - СправочникСсылка.ОчередьЗаданий - идентификатор задания +// очереди в модели сервиса. +// * ЗапланированныйМоментЗапуска - Дата - дата и время запланированного запуска задания +// (в часовом поясе области данных). +// * ИмяМетода - Строка - имя метода (или псевдоним) обработчика очереди задании. +// * ОбластьДанных - Число - значение разделителя области данных задания. +// * СостояниеЗадания - ПеречислениеСсылка.СостоянияЗаданий - состояние задания очереди. +// * Шаблон - СправочникСсылка.ШаблоныЗаданийОчереди - шаблон задания, +// используется только для разделенных заданий очереди. +// * ЭксклюзивноеВыполнение - Булево - при установленном флаге задание будет выполнено +// даже при установленной блокировке начала сеансов в области +// данных. Так же если в области есть задания с таким флагом +// сначала будут выполнены они. +// * ИнтервалПовтораПриАварийномЗавершении - Число - интервал в секундах, через который нужно перезапускать +// задание в случае его аварийного завершения. +// * КоличествоПовторовПриАварийномЗавершении - Число - количество повторов при аварийном завершении задания. +// +Функция НайтиЗадания(Отбор) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентныеЗаданияСервер.НайтиЗадания(Отбор) +``` +
+ +## Задание +
+ +Описание, пример вызова + +```bsl + +// Возвращает задание из очереди или регламентное. +// +// Параметры: +// Идентификатор - ОбъектМетаданных - объект метаданных регламентного задания для поиска +// предопределенного регламентного задания. +// - Строка - имя метаданных предопределенного регламентного задания в любом режиме работы +// или строка уникального идентификатора регламентного задания в локальном режиме работы +// или строка уникального идентификатора ссылки задания очереди в модели сервиса. +// - УникальныйИдентификатор - идентификатор регламентного задания в локальном режиме работы +// или идентификатор ссылки задания очереди в модели сервиса. +// - РегламентноеЗадание - регламентное задание из которого нужно получить уникальный идентификатор +// для получения свежей копии регламентного задания в локальном режиме работы. +// - СправочникСсылка.ОчередьЗаданий - идентификатор задания очереди в модели сервиса. +// - СтрокаТаблицыЗначений из см. НайтиЗадания +// +// Возвращаемое значение: +// РегламентноеЗадание - в локальном режиме работы. +// СтрокаТаблицыЗначений из см. НайтиЗадания +// Неопределено - задание не найдено. +// +Функция Задание(Знач Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентныеЗаданияСервер.Задание(Идентификатор) +``` +
+ +## ДобавитьЗадание +
+ +Описание, пример вызова + +```bsl + +// Добавляет новое задание в очередь или регламентное. +// +// Параметры: +// Параметры - Структура - параметры добавляемого задания, возможные свойства: +// * Использование - Булево - Истина, если регламентное задание должно выполняться автоматически согласно расписанию. +// * Метаданные - ОбъектМетаданныхРегламентноеЗадание - обязательно для указания. Объект метаданных, на основе +// которого будет создано регламентное задание. +// * Параметры - Массив - параметры регламентного задания. Количество и состав параметров должны соответствовать +// параметрам метода регламентного задания. +// * Ключ - Строка - прикладной идентификатор регламентного задания. +// * ИнтервалПовтораПриАварийномЗавершении - Число - интервал в секундах, через который нужно перезапускать задание +// в случае его аварийного завершения. +// * Расписание - РасписаниеРегламентногоЗадания - расписание задания. +// * КоличествоПовторовПриАварийномЗавершении - Число - количество повторов при аварийном завершении задания. +// +// Возвращаемое значение: +// РегламентноеЗадание - в локальном режиме работы. +// СтрокаТаблицыЗначений из см. НайтиЗадания +// +Функция ДобавитьЗадание(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентныеЗаданияСервер.ДобавитьЗадание(Параметры) +``` +
+ +## УдалитьЗадание +
+ +Описание, пример вызова + +```bsl + +// Удаляет задание из очереди или регламентное. +// +// Параметры: +// Идентификатор - ОбъектМетаданных - объект метаданных регламентного задания для поиска +// непредопределенного регламентного задания. +// - Строка - имя метаданных предопределенного регламентного задания в любом режиме работы +// или строка уникального идентификатора регламентного задания в локальном режиме работы +// или строка уникального идентификатора ссылки задания очереди в модели сервиса. +// - УникальныйИдентификатор - идентификатор регламентного задания в локальном режиме работы. +// или идентификатор ссылки задания очереди в модели сервиса. +// - РегламентноеЗадание - регламентное задание, уникальный идентификатор которого используется +// для определения удаляемого экземпляра регламентного задания в локальном режиме работы. +// - СправочникСсылка.ОчередьЗаданий - идентификатор задания очереди в модели сервиса. +// - СтрокаТаблицыЗначений из см. НайтиЗадания +// +Процедура УдалитьЗадание(Знач Идентификатор) Экспорт +``` + +Пример вызова +```bsl +РегламентныеЗаданияСервер.УдалитьЗадание(Идентификатор) +``` +
+ +## ИзменитьЗадание +
+ +Описание, пример вызова + +```bsl + +// Изменяет задание очереди или регламентное. +// +// В модели сервиса (разделение включено): +// - в случае вызова в транзакции на задание устанавливается объектная блокировка, +// - если задание создано на основе шаблона или предопределенное, может быть указано +// только свойство Использование в параметре Параметры. Расписание в этом случае, +// изменять нельзя, т.к. оно хранится централизованно в неразделенном Шаблоне задания, +// отдельно для каждой области оно не сохраняется. +// +// Параметры: +// Идентификатор - ОбъектМетаданных - объект метаданных регламентного задания для поиска. +// - Строка - имя метаданных предопределенного регламентного задания в любом режиме работы +// или строка уникального идентификатора регламентного задания в локальном режиме работы +// или строка уникального идентификатора ссылки задания очереди в модели сервиса. +// - УникальныйИдентификатор - идентификатор регламентного задания в локальном режиме работы +// или идентификатор ссылки задания очереди в модели сервиса. +// - РегламентноеЗадание - регламентное задание в локальном режиме работы. +// - СправочникСсылка.ОчередьЗаданий - идентификатор задания очереди в модели сервиса. +// - СтрокаТаблицыЗначений из см. НайтиЗадания +// +// Параметры - Структура - параметры, которые следует установить заданию, возможные свойства: +// * Использование - Булево - Истина, если регламентное задание должно выполняться автоматически согласно расписанию. +// * Параметры - Массив - параметры регламентного задания. Количество и состав параметров должны соответствовать +// параметрам метода регламентного задания. +// * Ключ - Строка - прикладной идентификатор регламентного задания. +// * ИнтервалПовтораПриАварийномЗавершении - Число - интервал в секундах, через который нужно перезапускать задание +// в случае его аварийного завершения. +// * Расписание - РасписаниеРегламентногоЗадания - расписание задания. +// * КоличествоПовторовПриАварийномЗавершении - Число - количество повторов при аварийном завершении задания. +// +Процедура ИзменитьЗадание(Знач Идентификатор, Знач Параметры) Экспорт +``` + +Пример вызова +```bsl +РегламентныеЗаданияСервер.ИзменитьЗадание(Идентификатор, Параметры) +``` +
+ +## УникальныйИдентификатор +
+ +Описание, пример вызова + +```bsl + +// Возвращает уникальный идентификатор задания из очереди или регламентного. +// Для вызова требуются права администрирования или УстановитьПривилегированныйРежим. +// +// Параметры: +// Идентификатор - ОбъектМетаданных - объект метаданных регламентного задания для поиска +// регламентного задания. +// - Строка - строка уникального идентификатора регламентного задания +// или идентификатора ссылки задания очереди в модели сервиса. +// - УникальныйИдентификатор - идентификатор регламентного задания в локальном режиме работы +// или идентификатор ссылки задания очереди в модели сервиса. +// - РегламентноеЗадание - регламентное задание. +// +// Возвращаемое значение: +// УникальныйИдентификатор - идентификатор регламентного задания в локальном режиме работы +// или идентификатор ссылки задания очереди в модели сервиса. +// +Функция УникальныйИдентификатор(Знач Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентныеЗаданияСервер.УникальныйИдентификатор(Идентификатор) +``` +
+ +## УстановитьСлужебногоПользователяРегламентногоЗадания +
+ +Описание, пример вызова + +```bsl + +// Предназначена для ограничения прав, доступных в сеансе регламентного задания или +// для работы с системой взаимодействия. +// Когда список пользователей ИБ не пустой, создает и назначает +// регламентному заданию служебного пользователя для запуска, +// не имеющего никаких прав и никакой аутентификации (не требуется). +// Если процедура вызывается в сеансе регламентного задания, у которого +// еще не установлен служебный пользователь, вызывается исключение +// для перезапуска задания после установки пользователя. +// +// Параметры: +// РегламентноеЗадание - ОбъектМетаданныхРегламентноеЗадание - метаданные регламентного задания. +// СлужебныйПользовательИБ - см. Пользователи.СлужебныйПользовательИБ +// - Неопределено - общий служебный пользователь, в противном случае нужно +// передать аналогичного, например, с другим именем, если требуется. +// +Процедура УстановитьСлужебногоПользователяРегламентногоЗадания(РегламентноеЗадание, СлужебныйПользовательИБ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РегламентныеЗаданияСервер.УстановитьСлужебногоПользователяРегламентногоЗадания(РегламентноеЗадание, СлужебныйПользовательИБ); +``` +
+ +## РегламентноеЗаданиеИспользуется +
+ +Описание, пример вызова + +```bsl + +// Возвращает использование регламентного задания. +// Перед вызовом требуется иметь право администрирования или УстановитьПривилегированныйРежим. +// +// В модели сервиса работает с регламентными заданиями платформы, а не с заданиями очереди, +// одинаково как в разделенном, так и в неразделенном режимах. +// +// Параметры: +// Идентификатор - ОбъектМетаданных - объект метаданных регламентного задания для поиска +// предопределенного регламентного задания. +// - УникальныйИдентификатор - идентификатор регламентного задания. +// - Строка - строка уникального идентификатора регламентного задания. +// - РегламентноеЗадание - регламентное задание. +// +// Возвращаемое значение: +// Булево - Истина, если регламентное задание используется. +// +Функция РегламентноеЗаданиеИспользуется(Знач Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентныеЗаданияСервер.РегламентноеЗаданиеИспользуется(Идентификатор) +``` +
+ +## РасписаниеРегламентногоЗадания +
+ +Описание, пример вызова + +```bsl + +// Возвращает расписание регламентного задания. +// Перед вызовом требуется иметь право администрирования или УстановитьПривилегированныйРежим. +// +// В модели сервиса работает с регламентными заданиями платформы, а не с заданиями очереди, +// одинаково как в разделенном, так и в неразделенном режимах. +// +// Параметры: +// Идентификатор - ОбъектМетаданных - объект метаданных регламентного задания для поиска +// предопределенного регламентного задания. +// - УникальныйИдентификатор - идентификатор регламентного задания. +// - Строка - строка уникального идентификатора регламентного задания. +// - РегламентноеЗадание - регламентное задание. +// +// ВСтруктуре - Булево - если Истина, тогда расписание будет преобразовано +// в структуру, которую можно передать на клиент. +// +// Возвращаемое значение: +// РасписаниеРегламентногоЗадания, Структура - структура содержит те же свойства, что и расписание. +// +Функция РасписаниеРегламентногоЗадания(Знач Идентификатор, Знач ВСтруктуре = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентныеЗаданияСервер.РасписаниеРегламентногоЗадания(Идентификатор, ВСтруктуре); +``` +
+ +## УстановитьИспользованиеРегламентногоЗадания +
+ +Описание, пример вызова + +```bsl + +// Устанавливает использование регламентного задания. +// Перед вызовом требуется иметь право администрирования или УстановитьПривилегированныйРежим. +// +// В модели сервиса работает с регламентными заданиями платформы, а не с заданиями очереди, +// одинаково как в разделенном, так и в неразделенном режимах. +// +// Параметры: +// Идентификатор - ОбъектМетаданных - объект метаданных регламентного задания для поиска +// предопределенного регламентного задания. +// - УникальныйИдентификатор - идентификатор регламентного задания. +// - Строка - строка уникального идентификатора регламентного задания. +// - РегламентноеЗадание - регламентное задание. +// Использование - Булево - значение использования которое нужно установить. +// +Процедура УстановитьИспользованиеРегламентногоЗадания(Знач Идентификатор, Знач Использование) Экспорт +``` + +Пример вызова +```bsl +РегламентныеЗаданияСервер.УстановитьИспользованиеРегламентногоЗадания(Идентификатор, Использование) +``` +
+ +## УстановитьРасписаниеРегламентногоЗадания +
+ +Описание, пример вызова + +```bsl + +// Устанавливает расписание регламентного задания. +// Перед вызовом требуется иметь право администрирования или УстановитьПривилегированныйРежим. +// +// В модели сервиса работает с регламентными заданиями платформы, а не с заданиями очереди, +// одинаково как в разделенном, так и в неразделенном режимах. +// +// Параметры: +// Идентификатор - ОбъектМетаданных - объект метаданных регламентного задания для поиска +// предопределенного регламентного задания. +// - УникальныйИдентификатор - идентификатор регламентного задания. +// - Строка - строка уникального идентификатора регламентного задания. +// - РегламентноеЗадание - регламентное задание. +// +// Расписание - РасписаниеРегламентногоЗадания - расписание. +// - Структура - значение возвращаемое функцией РасписаниеВСтруктуру +// общего модуля ОбщегоНазначенияКлиентСервер. +// +Процедура УстановитьРасписаниеРегламентногоЗадания(Знач Идентификатор, Знач Расписание) Экспорт +``` + +Пример вызова +```bsl +РегламентныеЗаданияСервер.УстановитьРасписаниеРегламентногоЗадания(Идентификатор, Расписание) +``` +
+ +## ПолучитьРегламентноеЗадание +
+ +Описание, пример вызова + +```bsl + +// Возвращает РегламентноеЗадание из информационной базы. +// +// В модели сервиса работает с регламентными заданиями платформы, а не с заданиями очереди, +// одинаково как в разделенном, так и в неразделенном режимах. +// +// Параметры: +// Идентификатор - ОбъектМетаданных - объект метаданных регламентного задания для поиска +// предопределенного регламентного задания. +// - УникальныйИдентификатор - идентификатор регламентного задания. +// - Строка - строка уникального идентификатора регламентного задания. +// - РегламентноеЗадание - регламентное задание из которого нужно получить +// уникальный идентификатор для получения свежей копии регламентного задания. +// +// Возвращаемое значение: +// РегламентноеЗадание - прочитано из базы данных. +// +Функция ПолучитьРегламентноеЗадание(Знач Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентныеЗаданияСервер.ПолучитьРегламентноеЗадание(Идентификатор) +``` +
+ +## СвойстваПоследнегоЗадания +
+ +Описание, пример вызова + +```bsl + +// Возвращает результаты последнего запуска указанного регламентного задания. +// В том числе, если оно было запущено вручную из обработки "Регламентные и фоновые задания". +// +// Параметры: +// Задание - РегламентноеЗадание - для указанного регламентного задания будут получены +// результаты последнего запуска. +// - Строка - уникальный идентификатор регламентного задания +// +// Возвращаемое значение: +// Неопределено +// Структура: +// * Идентификатор - Строка +// * Наименование - Строка +// * Ключ - Строка +// * Конец - Дата +// * ИдентификаторРегламентногоЗадания - Строка +// * Состояние - СостояниеФоновогоЗадания +// * ИмяМетода - Строка +// * Расположение - Строка +// * ОписаниеИнформацииОбОшибке - Строка +// * ПопыткаЗапуска - Число +// * СообщенияПользователю - Массив +// * НомерСеанса - Число +// * НачалоСеанса - Дата +// +Функция СвойстваПоследнегоЗадания(Знач Задание) Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентныеЗаданияСервер.СвойстваПоследнегоЗадания(Задание) +``` +
+ +## РаботаСВнешнимиРесурсамиЗаблокирована +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак установленной блокировки работы с внешними ресурсами. +// +// Возвращаемое значение: +// Булево - Истина, если работа с внешними ресурсами заблокирована. +// +Функция РаботаСВнешнимиРесурсамиЗаблокирована() Экспорт +``` + +Пример вызова +```bsl +Результат = РегламентныеЗаданияСервер.РаботаСВнешнимиРесурсамиЗаблокирована() +``` +
+ +## РазблокироватьРаботуСВнешнимиРесурсами +
+ +Описание, пример вызова + +```bsl + +// Разрешает работу с внешними ресурсами. +// +Процедура РазблокироватьРаботуСВнешнимиРесурсами() Экспорт +``` + +Пример вызова +```bsl +РегламентныеЗаданияСервер.РазблокироватьРаботуСВнешнимиРесурсами() +``` +
+ +## ЗаблокироватьРаботуСВнешнимиРесурсами +
+ +Описание, пример вызова + +```bsl + +// Запрещает работу с внешними ресурсами. +// +Процедура ЗаблокироватьРаботуСВнешнимиРесурсами() Экспорт +``` + +Пример вызова +```bsl +РегламентныеЗаданияСервер.ЗаблокироватьРаботуСВнешнимиРесурсами() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РезервноеКопированиеИБКлиент.md b/src/content/docs/bsp/РезервноеКопированиеИБКлиент.md new file mode 100644 index 0000000..79abfed --- /dev/null +++ b/src/content/docs/bsp/РезервноеКопированиеИБКлиент.md @@ -0,0 +1,34 @@ +--- +title: Резервное копирование иб клиент +slug: bsp/резервное-копирование-иб-клиент +--- + + +## ОткрытьФормуРезервногоКопирования +
+ +Описание, пример вызова + +```bsl + +// Открывает форму создания резервной копии. +// +// Параметры: +// Параметры - Структура - параметры формы создания резервной копии. +// +Процедура ОткрытьФормуРезервногоКопирования(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеИБКлиент.ОткрытьФормуРезервногоКопирования(Параметры); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РезервноеКопированиеИБКлиентПереопределяемый.md b/src/content/docs/bsp/РезервноеКопированиеИБКлиентПереопределяемый.md new file mode 100644 index 0000000..81f75da --- /dev/null +++ b/src/content/docs/bsp/РезервноеКопированиеИБКлиентПереопределяемый.md @@ -0,0 +1,35 @@ +--- +title: Резервное копирование иб клиент переопределяемый +slug: bsp/резервное-копирование-иб-клиент-переопределяемый +--- + + +## ПриОпределенииНеобходимостиПоказаПредупрежденийОРезервномКопировании +
+ +Описание, пример вызова + +```bsl + +// Включает/отключает показ предупреждений о необходимости настройки/выполнении резервного копирования. +// По умолчанию отключено. +// +// Параметры: +// ПоказыватьПредупреждение - Булево - переопределяемый признак необходимости показа предупреждения. +// +Процедура ПриОпределенииНеобходимостиПоказаПредупрежденийОРезервномКопировании(ПоказыватьПредупреждение) Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеИБКлиентПереопределяемый.ПриОпределенииНеобходимостиПоказаПредупрежденийОРезервномКопировании(ПоказыватьПредупреждение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РезервноеКопированиеОбластейДанных.md b/src/content/docs/bsp/РезервноеКопированиеОбластейДанных.md new file mode 100644 index 0000000..45ba57a --- /dev/null +++ b/src/content/docs/bsp/РезервноеКопированиеОбластейДанных.md @@ -0,0 +1,354 @@ +--- +title: Резервное копирование областей данных +slug: bsp/резервное-копирование-областей-данных +--- + + +## РезервноеКопированиеИспользуется +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обмен сообщениями + +// Возвращает состояние использования резервного копирования областей данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Булево - Истина, если резервное копирование используется. +// +Функция РезервноеКопированиеИспользуется() Экспорт +``` + +Пример вызова +```bsl +Результат = РезервноеКопированиеОбластейДанных.РезервноеКопированиеИспользуется() +``` +
+ +## УстановитьФлагАктивностиПользователяВОбласти +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Активность пользователей в области данных. + +// Устанавливает признак активности пользователя в текущей области. +// Признаком является значение совместно разделенной константы ДатаПоследнегоСтартаКлиентскогоСеанса. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура УстановитьФлагАктивностиПользователяВОбласти() Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеОбластейДанных.УстановитьФлагАктивностиПользователяВОбласти() +``` +
+ +## СоответствиеРусскихИменПолейНастроекАнглийским +
+ +Описание, пример вызова + +```bsl + +// Возвращает соответствие русских названий полей программных системных настроек +// английским из XDTO-пакета ZoneBackupControl Менеджера сервиса. +// (тип: {HTTP://www.1c.ru/SaaS/1.0/XMLSchema/ZoneBackupControl}Settings). +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение - соответствие русских имен полей настроек английским: +// * Ключ - Строка +// * Значение - Строка +// +Функция СоответствиеРусскихИменПолейНастроекАнглийским() Экспорт +``` + +Пример вызова +```bsl +Результат = РезервноеКопированиеОбластейДанных.СоответствиеРусскихИменПолейНастроекАнглийским() +``` +
+ +## МенеджерСервисаПоддерживаетРезервноеКопирование +
+ +Описание, пример вызова + +```bsl + +// Определяет, поддерживает ли приложение функциональность резервного копирования. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Булево - Истина, если приложение поддерживает функциональность резервного копирования. +// +Функция МенеджерСервисаПоддерживаетРезервноеКопирование() Экспорт +``` + +Пример вызова +```bsl +Результат = РезервноеКопированиеОбластейДанных.МенеджерСервисаПоддерживаетРезервноеКопирование() +``` +
+ +## ПроксиКонтроляРезервногоКопирования +
+ +Описание, пример вызова + +```bsl + +// Возвращает прокси web-сервиса контроля резервного копирования. +// Вызывающий код должен самостоятельно устанавливать привилегированный режим. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// WSПрокси - прокси менеджера сервиса. +// +Функция ПроксиКонтроляРезервногоКопирования() Экспорт +``` + +Пример вызова +```bsl +Результат = РезервноеКопированиеОбластейДанных.ПроксиКонтроляРезервногоКопирования() +``` +
+ +## ИмяПодсистемыДляСобытийЖурналаРегистрации +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя подсистемы, которое должно использоваться в именах событий журнала регистрации. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - имя подсистемы. +// +Функция ИмяПодсистемыДляСобытийЖурналаРегистрации() Экспорт +``` + +Пример вызова +```bsl +Результат = РезервноеКопированиеОбластейДанных.ИмяПодсистемыДляСобытийЖурналаРегистрации() +``` +
+ +## НаименованиеФоновогоРезервногоКопирования +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Фоновые задания + +// Возвращает наименование фонового задания выгрузки области в файл. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - наименование фонового задания. +// +Функция НаименованиеФоновогоРезервногоКопирования() Экспорт +``` + +Пример вызова +```bsl +Результат = РезервноеКопированиеОбластейДанных.НаименованиеФоновогоРезервногоКопирования() +``` +
+ +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// СоответствиеИменПсевдонимам - См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков.СоответствиеИменПсевдонимам +// +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеОбластейДанных.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеОбластейДанных.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияПереопределяемый.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// СтруктураПоддерживаемыхВерсий - См. ОбщегоНазначенияПереопределяемый.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов.ПоддерживаемыеВерсии +// +Процедура ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(Знач СтруктураПоддерживаемыхВерсий) Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеОбластейДанных.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(СтруктураПоддерживаемыхВерсий) +``` +
+ +## ПриЗаполненииТаблицыПараметровИБ +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВМоделиСервисаПереопределяемый.ПриЗаполненииТаблицыПараметровИБ. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ТаблицаПараметров - см. РаботаВМоделиСервиса.ПараметрыИБ +// +Процедура ПриЗаполненииТаблицыПараметровИБ(ТаблицаПараметров) Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеОбластейДанных.ПриЗаполненииТаблицыПараметровИБ(ТаблицаПараметров) +``` +
+ +## ПриОпределенииОбработчиковОшибок +
+ +Описание, пример вызова + +```bsl + +// См. ОчередьЗаданийПереопределяемый.ПриОпределенииОбработчиковОшибок. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОбработчикиОшибок - См. ОчередьЗаданийПереопределяемый.ПриОпределенииОбработчиковОшибок.ОбработчикиОшибок +// +Процедура ПриОпределенииОбработчиковОшибок(ОбработчикиОшибок) Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеОбластейДанных.ПриОпределенииОбработчиковОшибок(ОбработчикиОшибок) +``` +
+ +## РегистрацияИнтерфейсовПринимаемыхСообщений +
+ +Описание, пример вызова + +```bsl + +// См. ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.ЗаполнитьОбработчикиПринимаемыхСообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - См. ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.ЗаполнитьОбработчикиПринимаемыхСообщений.МассивОбработчиков +// +Процедура РегистрацияИнтерфейсовПринимаемыхСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеОбластейДанных.РегистрацияИнтерфейсовПринимаемыхСообщений(МассивОбработчиков) +``` +
+ +## РегистрацияИнтерфейсовОтправляемыхСообщений +
+ +Описание, пример вызова + +```bsl + +// См. ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.ЗаполнитьОбработчикиОтправляемыхСообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - См. ИнтерфейсыСообщенийВМоделиСервисаПереопределяемый.ЗаполнитьОбработчикиОтправляемыхСообщений.МассивОбработчиков +// +Процедура РегистрацияИнтерфейсовОтправляемыхСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеОбластейДанных.РегистрацияИнтерфейсовОтправляемыхСообщений(МассивОбработчиков) +``` +
+ +## ПриДобавленииПараметровРаботыКлиента +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияПереопределяемый.ПриДобавленииПараметровРаботыКлиента. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Параметры - См. ОбщегоНазначенияПереопределяемый.ПриДобавленииПараметровРаботыКлиента.Параметры +// +Процедура ПриДобавленииПараметровРаботыКлиента(Параметры) Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеОбластейДанных.ПриДобавленииПараметровРаботыКлиента(Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/РезервноеКопированиеОбластейДанныхКлиент.md b/src/content/docs/bsp/РезервноеКопированиеОбластейДанныхКлиент.md new file mode 100644 index 0000000..e1c1c4b --- /dev/null +++ b/src/content/docs/bsp/РезервноеКопированиеОбластейДанныхКлиент.md @@ -0,0 +1,32 @@ +--- +title: Резервное копирование областей данных клиент +slug: bsp/резервное-копирование-областей-данных-клиент +--- + + +## ПредложитьПользователюСоздатьРезервнуюКопию +
+ +Описание, пример вызова + +```bsl + +// Предлагает пользователю создать резервную копию. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПредложитьПользователюСоздатьРезервнуюКопию() Экспорт +``` + +Пример вызова +```bsl +РезервноеКопированиеОбластейДанныхКлиент.ПредложитьПользователюСоздатьРезервнуюКопию() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СводныеПриложения.md b/src/content/docs/bsp/СводныеПриложения.md new file mode 100644 index 0000000..7be0d53 --- /dev/null +++ b/src/content/docs/bsp/СводныеПриложения.md @@ -0,0 +1,475 @@ +--- +title: Сводные приложения +slug: bsp/сводные-приложения +--- + + +## РегистрацияИнтерфейсовПринимаемыхСообщений +
+ +Описание, пример вызова + +```bsl + +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - обработчики сообщений. +// +Процедура РегистрацияИнтерфейсовПринимаемыхСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.РегистрацияИнтерфейсовПринимаемыхСообщений(МассивОбработчиков) +``` +
+ +## РегистрацияИнтерфейсовОтправляемыхСообщений +
+ +Описание, пример вызова + +```bsl + +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - обработчики сообщений. +// +Процедура РегистрацияИнтерфейсовОтправляемыхСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.РегистрацияИнтерфейсовОтправляемыхСообщений(МассивОбработчиков) +``` +
+ +## ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов +
+ +Описание, пример вызова + +```bsl + +//@skip-warning +Процедура ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(Знач СтруктураПоддерживаемыхВерсий) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(СтруктураПоддерживаемыхВерсий) +``` +
+ +## НастроитьЗагрузкуВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/1cFresh/ManageSynopticExchange/a.b.c.d}SetSynopticExchange. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КодОбластиДанных - Число - код области данных, +// Параметры - Структура - идентификатор резервной копии, +// +Процедура НастроитьЗагрузкуВСводноеПриложение(КодОбластиДанных, Параметры) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.НастроитьЗагрузкуВСводноеПриложение(КодОбластиДанных, Параметры) +``` +
+ +## НастроитьВыгрузкуВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/1cFresh/ManageSynopticExchange/a.b.c.d}SetCorrSynopticExchange. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КодОбластиДанных - Число - код области данных, +// Параметры - Структура - идентификатор резервной копии, +// +Процедура НастроитьВыгрузкуВСводноеПриложение(КодОбластиДанных, Параметры) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.НастроитьВыгрузкуВСводноеПриложение(КодОбластиДанных, Параметры) +``` +
+ +## ИнтерактивныйЗапускВыгрузкиВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/1cFresh/ManageSynopticExchange/a.b.c.d}PushSynopticExchangeStep1. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КодОбластиДанных - Число - код области данных, +// Параметры - Структура - идентификатор резервной копии, +// +Процедура ИнтерактивныйЗапускВыгрузкиВСводноеПриложение(КодОбластиДанных, Параметры) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ИнтерактивныйЗапускВыгрузкиВСводноеПриложение(КодОбластиДанных, Параметры) +``` +
+ +## ИнтерактивныйЗапускЗагрузкиВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/1cFresh/ManageSynopticExchange/a.b.c.d}PushSynopticExchangeStep2. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КодОбластиДанных - Число - код области данных, +// Параметры - Структура - идентификатор резервной копии, +// +Процедура ИнтерактивныйЗапускЗагрузкиВСводноеПриложение(КодОбластиДанных, Параметры) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ИнтерактивныйЗапускЗагрузкиВСводноеПриложение(КодОбластиДанных, Параметры) +``` +
+ +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - Массив из ОбъектМетаданных +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ПриОпределенииНастроекРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// См. РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроекРегламентныхЗаданий +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Настройки - см. РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроекРегламентныхЗаданий.Настройки +// +Процедура ПриОпределенииНастроекРегламентныхЗаданий(Настройки) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ПриОпределенииНастроекРегламентныхЗаданий(Настройки) +``` +
+ +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазыБСП.ПриДобавленииОбработчиковОбновления +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Обработчики - см. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления +// +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ЗаданиеВыгрузка +
+ +Описание, пример вызова + +```bsl + +// Регламентное задание СводныеПриложенияВыгрузка. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ЗаданиеВыгрузка() Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ЗаданиеВыгрузка() +``` +
+ +## ЗаданиеПланированиеЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Регламентное задание СводныеПриложенияПланированиеЗагрузки. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ЗаданиеПланированиеЗагрузки() Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ЗаданиеПланированиеЗагрузки() +``` +
+ +## ПередЗаписьюОбъекта +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписьюОбъекта. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПередЗаписьюОбъекта(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ПередЗаписьюОбъекта(Источник, Отказ) +``` +
+ +## ПередЗаписьюДокумента +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ЗаписьюДокумента. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## ПередЗаписьюНабора +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписьюНабора. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПередЗаписьюНабора(Источник, Отказ, Замещение) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ПередЗаписьюНабора(Источник, Отказ, Замещение) +``` +
+ +## ПередЗаписьюНабораРасчета +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписьюНабораРасчета. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПередЗаписьюНабораРасчета(Источник, Отказ, Замещение, ТолькоЗапись, ЗаписьФактическогоПериодаДействия, ЗаписьПерерасчетов) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ПередЗаписьюНабораРасчета(Источник, Отказ, Замещение, ТолькоЗапись, ЗаписьФактическогоПериодаДействия, ЗаписьПерерасчетов) +``` +
+ +## ПередУдалениемОбъекта +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередУдалениемОбъекта. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ПередУдалениемОбъекта(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложения.ПередУдалениемОбъекта(Источник, Отказ) +``` +
+ +## Описание +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание данных логического хранилища. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторХранилища - Строка - идентификатор логического хранилища. +// ИдентификаторДанных - Строка - идентификатор данных хранилища. +// +// Возвращаемое значение: +// Структура - описание состояния задания очереди: +// * ИмяФайла - Строка - имя файла. +// * Размер - Число - размер файла в байтах. +// * Данные - ДвоичныеДанные - двоичные данные файла описания задания. +// +Функция Описание(ИдентификаторХранилища, ИдентификаторДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = СводныеПриложения.Описание(ИдентификаторХранилища, ИдентификаторДанных) +``` +
+ +## Данные +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные логического хранилища. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОписаниеДанных - Структура - описание данных хранилища. +// +// Возвращаемое значение: +// ДвоичныеДанные - +// +Функция Данные(ОписаниеДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = СводныеПриложения.Данные(ОписаниеДанных) +``` +
+ +## Загрузить +
+ +Описание, пример вызова + +```bsl + +// Записывает данные в логическое хранилище. +// @skip-warning ПустойМетод - особенность реализации. +// Выполняет действия: +// - сохраняет файл данных в файловом хранилище +// - планирует задание очереди заданий на обработки файла +// - возвращается идентификатор задания в ответ. +// +// Параметры: +// ОписаниеДанных - Структура - описание данных хранилища: +// * ИмяФайла - Строка - имя файла. +// * Размер - Число - размер файла в байтах. +// * Данные - ДвоичныеДанные, Строка - двоичные данные файла или расположение файла на диске. +// +// Возвращаемое значение: +// Структура: +// * ИмяКонфигурации - Строка - имя конфигурации. +// * ВерсияКонфигурации - Строка - версия конфигурации. +// * ВыполняетсяЗагрузка - Булево - признак что выполняется загрузка. +// * НомерПринятогоСообщения - Число - количество обработанных сообщений. +// * ЗагруженоОбъектов - Число - количество загруженных объектов. +// * ЗавершеноСОшибками - Булево - признак завершения с ошибками. +// * ОписаниеОшибки - Строка - описание ошибки. +// * ТребуетсяПовторнаяОтправка - Булево - Истина если требуется отправить повторно данные, которые находятся сейчас +// в очереди. +Функция Загрузить(ОписаниеДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = СводныеПриложения.Загрузить(ОписаниеДанных) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СводныеПриложенияПереопределяемый.md b/src/content/docs/bsp/СводныеПриложенияПереопределяемый.md new file mode 100644 index 0000000..173a31d --- /dev/null +++ b/src/content/docs/bsp/СводныеПриложенияПереопределяемый.md @@ -0,0 +1,118 @@ +--- +title: Сводные приложения переопределяемый +slug: bsp/сводные-приложения-переопределяемый +--- + + +## ПриВыгрузкеОбъекта +
+ +Описание, пример вызова + +```bsl + +// Обработчик при выгрузке данных. +// +// Параметры: +// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект, ПланСчетовОбъект - +// - ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект, РегистрСведенийНаборЗаписей - +// - РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей, РегистрРасчетаНаборЗаписей - +// - ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей, БизнесПроцессОбъект, ЗадачаОбъект - выгружаемый объект. +// ПараметрыВыгрузки - Структура - параметры выгрузки +// ЗаписьXML - ЗаписьXML - Для самостоятельной сериализации. +// КоличествоОбъектов - Число - Счетчик, который необходимо увеличить, чтобы объект был выгружен +// Отказ - Булево - если данному параметру установить значение Истина, то объект не будет выгружен, при этом +// можно самостоятельно сериализовать объект, например через ПараметрыВыгрузки.Сериализатор в ЗаписьXML. +//@skip-check module-empty-method - переопределяемый метод. +Процедура ПриВыгрузкеОбъекта(Объект, ПараметрыВыгрузки, ЗаписьXML, КоличествоОбъектов, Отказ) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложенияПереопределяемый.ПриВыгрузкеОбъекта(Объект, ПараметрыВыгрузки, ЗаписьXML, КоличествоОбъектов, Отказ) +``` +
+ +## ПриЗагрузкеОбъекта +
+ +Описание, пример вызова + +```bsl + +// Обработчик при загрузке данных. +// +// Параметры: +// Объект - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект, ПланСчетовОбъект - +// - ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект, РегистрСведенийНаборЗаписей - +// - РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей, РегистрРасчетаНаборЗаписей - +// - ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей, БизнесПроцессОбъект, ЗадачаОбъект - загружаемый объект. +// Отказ - Булево - если данному параметру установить значение Истина, то объект не будет загружен. +//@skip-check module-empty-method - переопределяемый метод. +Процедура ПриЗагрузкеОбъекта(Объект, Отказ) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложенияПереопределяемый.ПриЗагрузкеОбъекта(Объект, Отказ) +``` +
+ +## ПриРегистрацииИзмененийОбъекта +
+ +Описание, пример вызова + +```bsl + +// Обработчик при регистрации изменений. +// +// Параметры: +// Источник - КонстантаМенеджерЗначения, СправочникОбъект, ДокументОбъект, ПланСчетовОбъект - +// - ПланВидовХарактеристикОбъект, ПланВидовРасчетаОбъект, РегистрСведенийНаборЗаписей - +// - РегистрНакопленияНаборЗаписей, РегистрБухгалтерииНаборЗаписей, РегистрРасчетаНаборЗаписей - +// - ПоследовательностьНаборЗаписей, ПерерасчетНаборЗаписей, БизнесПроцессОбъект, ЗадачаОбъект - +// регистрируемый объект. +// Отказ - Булево - если данному параметру установить значение Истина, то объект не будет зарегистрирован. +//@skip-check module-empty-method - переопределяемый метод. +Процедура ПриРегистрацииИзмененийОбъекта(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложенияПереопределяемый.ПриРегистрацииИзмененийОбъекта(Источник, Отказ) +``` +
+ +## ПриОпределенииРазрешенныхКВыгрузкеОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// При определении разрешенных к выгрузке объектов метаданных. +// Предполагаемое использование для объектов метаданных, добавленых в расширении, фильтр по которым нельзя настроить из +// Менеджера сервиса. +// +// Параметры: +// ОбъектыМетаданных - Соответствие из КлючИЗначение - коллекция объектов метаданных: +// * Ключ - Строка - Имя объекта метаданных +// * Значение - Булево - Признак, разрешено ли выгружать данный объект +//@skip-check module-empty-method - переопределяемый метод. +Процедура ПриОпределенииРазрешенныхКВыгрузкеОбъектовМетаданных(ОбъектыМетаданных) Экспорт +``` + +Пример вызова +```bsl +СводныеПриложенияПереопределяемый.ПриОпределенииРазрешенныхКВыгрузкеОбъектовМетаданных(ОбъектыМетаданных) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СерверныеОповещения.md b/src/content/docs/bsp/СерверныеОповещения.md new file mode 100644 index 0000000..2427539 --- /dev/null +++ b/src/content/docs/bsp/СерверныеОповещения.md @@ -0,0 +1,179 @@ +--- +title: Серверные оповещения +slug: bsp/серверные-оповещения +--- + + +## НовоеСерверноеОповещение +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПриДобавленииСерверныхОповещений общего модуля ОбщегоНазначенияПереопределяемый. +// +// Параметры: +// Имя - Строка - имя оповещения, подходящее для имени свойства структуры. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - имя оповещения. +// +// * ИмяМодуляОтправки - Строка - имя серверного общего модуля, например, "СоединенияИБ", +// содержащего экспортную процедуру ПриОтправкеСерверногоОповещения. +// Вызов процедуры выполняется в привилегированном режиме. +// Смотри пример в общем модуле СтандартныеПодсистемыСервер. +// Может быть не заполнено. В этом случае вызываться не будет, +// например, используется для отправки сообщений об изменении +// настроек функциональных опций в момент изменения их констант, +// вместо отслеживания изменений в регламентом задании. +// +// * ИмяМодуляПолучения - Строка - имя клиентского общего модуля, например, "СоединенияИБКлиент", +// содержащего экспортную процедуру ПриПолученииСерверногоОповещения. +// Смотри пример в общем модуле СтандартныеПодсистемыКлиент. +// +// * Параметры - Произвольный - любое сериализуемое значение, которое нужно передать +// в процедуру ПриОтправкеСерверногоОповещения в качестве параметров. +// Должно быть как можно меньшего размера в сериализованном виде. +// Например, описание метаданных и расширений сеанса, для вычисления +// добавленных и удаленных расширений и исправлений в регламентном +// задании при вызове ПриОтправкеСерверногоОповещения, и отправке +// оповещения с вычисленными отличиями соответствующим сеансам. +// +// * ПериодПроверки - Число - количество секунд, через которое требуется +// вызывать ПриОтправкеСерверногоОповещения для проверки +// состояния сервера и отправки оповещения, если требуется. +// Начальное значение 20 минут. +// Если указано время меньше 1 мин, тогда будет 1 мин. +// Следует учитывать, что в модели сервиса реальный минимальный +// период может быть значительно больше и нестабильным: 5-10 минут. +// +// +Функция НовоеСерверноеОповещение(Имя) Экспорт +``` + +Пример вызова +```bsl +Результат = СерверныеОповещения.НовоеСерверноеОповещение(Имя) +``` +
+ +## ОтправитьСерверноеОповещение +
+ +Описание, пример вызова + +```bsl + +// Добавляет серверное оповещение в очередь для доставки на клиент. +// Оповещение доставляется через систему взаимодействия, +// либо забирается в рамках общего серверного вызова. +// +// Параметры: +// ИмяОповещения - Строка - смотри НовоеСерверноеОповещение.Имя. +// +// Результат - Произвольный - произвольное сериализуемое значение, +// которое будет отправлено в составе оповещения на клиент +// (должны быть как можно меньшего размера, желательно не более 1 Кб). +// +// Адресаты - Неопределено - все пользователи (и соответственно все сеансы). +// Если указано незаполненное соответствие, тогда возврат. +// - Соответствие из КлючИЗначение: +// * Ключ - УникальныйИдентификатор - идентификатор пользователя ИБ. +// * Значение - Массив из см. СерверныеОповещения.КлючСеанса +// +// ОтправитьСразу - Булево - если Истина, попытаться сразу отправить сообщение +// через систему взаимодействия перед добавлением в очередь. +// Отправка сразу не допускается из обработчиков ПриОтправкеСерверногоОповещения. +// Следует учесть (особенно при вызове в транзакции), что неудачное обращение +// к системе взаимодействия может занимать (3-5 сек)*2, а удачное не менее (50 мс)*2. +// +Процедура ОтправитьСерверноеОповещение(ИмяОповещения, Результат, Адресаты, ОтправитьСразу = Ложь) Экспорт +``` + +Пример вызова +```bsl +СерверныеОповещения.ОтправитьСерверноеОповещение(ИмяОповещения, Результат, Адресаты, ОтправитьСразу); +``` +
+ +## ОбработатьОшибку +
+ +Описание, пример вызова + +```bsl + +// Регистрирует ошибку в журнале регистрации, пойманную в обработчиках события +// ПриПериодическомПолученииДанныхКлиентаНаСервере. +// +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке +// +// Пример: +// МоментНачала = ТекущаяУниверсальнаяДатаВМиллисекундах(); +// Попытка +// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ЦентрМониторинга") Тогда +// МодульЦентрМониторингаСлужебный = ОбщегоНазначения.ОбщийМодуль("ЦентрМониторингаСлужебный"); +// МодульЦентрМониторингаСлужебный.ПриПериодическомПолученииДанныхКлиентаНаСервере(Параметры, Результаты); +// КонецЕсли; +// Исключение +// СерверныеОповещения.ОбработатьОшибку(ИнформацияОбОшибке()); +// КонецПопытки; +// СерверныеОповещения.ДобавитьПоказатель(Результаты, МоментНачала, +// "ЦентрМониторингаСлужебный.ПриПериодическомПолученииДанныхКлиентаНаСервере"); +// +Процедура ОбработатьОшибку(ИнформацияОбОшибке) Экспорт +``` + +Пример вызова +```bsl +СерверныеОповещения.ОбработатьОшибку(ИнформацияОбОшибке) +``` +
+ +## ДобавитьПоказатель +
+ +Описание, пример вызова + +```bsl + +// Добавляет показатель производительности в обработчиках события +// ПриПериодическомПолученииДанныхКлиентаНаСервере. +// +// Параметры: +// Результаты - см. ОбщегоНазначенияПереопределяемый.ПриПериодическомПолученииДанныхКлиентаНаСервере.Результаты +// МоментНачала - Число - ТекущаяУниверсальнаяДатаВМиллисекундах перед вызовом процедуры. +// ИмяПроцедуры - Строка - полное имя вызываемой процедуры +// +// Пример: +// МоментНачала = ТекущаяУниверсальнаяДатаВМиллисекундах(); +// Попытка +// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ЦентрМониторинга") Тогда +// МодульЦентрМониторингаСлужебный = ОбщегоНазначения.ОбщийМодуль("ЦентрМониторингаСлужебный"); +// МодульЦентрМониторингаСлужебный.ПриПериодическомПолученииДанныхКлиентаНаСервере(Параметры, Результаты); +// КонецЕсли; +// Исключение +// СерверныеОповещения.ОбработатьОшибку(ИнформацияОбОшибке()); +// КонецПопытки; +// СерверныеОповещения.ДобавитьПоказатель(Результаты, МоментНачала, +// "ЦентрМониторингаСлужебный.ПриПериодическомПолученииДанныхКлиентаНаСервере"); +// +Процедура ДобавитьПоказатель(Результаты, МоментНачала, ИмяПроцедуры) Экспорт +``` + +Пример вызова +```bsl +СерверныеОповещения.ДобавитьПоказатель(Результаты, МоментНачала, ИмяПроцедуры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СерверныеОповещенияКлиент.md b/src/content/docs/bsp/СерверныеОповещенияКлиент.md new file mode 100644 index 0000000..976170d --- /dev/null +++ b/src/content/docs/bsp/СерверныеОповещенияКлиент.md @@ -0,0 +1,120 @@ +--- +title: Серверные оповещения клиент +slug: bsp/серверные-оповещения-клиент +--- + + +## ЗакончилосьВремяОжидания +
+ +Описание, пример вызова + +```bsl + +// Проверка завершения периодического ожидания для обработчиков +// события ПередПериодическойОтправкойДанныхКлиентаНаСервер. +// +// Параметры: +// ИмяСчетчика - Строка - например, "СтандартныеПодсистемы.ЦентрМониторинга". +// ВремяОжидания - Число - количество секунд ожидания до срабатывания счетчика. +// ПервыйРаз - Булево - если Истина, то возвращает Истина после инициализации. +// ДатаСеанса - Дата - возвращаемое значение (если требуется нестандартный счетчик). +// +// Возвращаемое значение: +// Булево - Истина, если закончилось время с последнего отсчета и начат новый отсчет. +// +// Пример: +// ИмяСчетчика = "СтандартныеПодсистемы.ЦентрМониторинга"; +// Если Не СерверныеОповещенияКлиент.ЗакончилосьВремяОжидания(ИмяСчетчика) Тогда +// Возврат; +// КонецЕсли; +// +Функция ЗакончилосьВремяОжидания(ИмяСчетчика, ВремяОжидания = 1200, ПервыйРаз = Ложь, ДатаСеанса = '00010101') Экспорт +``` + +Пример вызова +```bsl +Результат = СерверныеОповещенияКлиент.ЗакончилосьВремяОжидания(ИмяСчетчика, ВремяОжидания, ПервыйРаз, ДатаСеанса); +``` +
+ +## ОбработатьОшибку +
+ +Описание, пример вызова + +```bsl + +// Регистрирует ошибку в журнале регистрации, пойманную в обработчиках событий +// ПередПериодическойОтправкойДанныхКлиентаНаСервер и +// ПослеПериодическогоПолученияДанныхКлиентаНаСервере. +// +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке +// +// Пример: +// МоментНачала = ТекущаяУниверсальнаяДатаВМиллисекундах(); +// Попытка +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ЦентрМониторинга") Тогда +// МодульЦентрМониторингаКлиентСлужебный = ОбщегоНазначенияКлиент.ОбщийМодуль("ЦентрМониторингаКлиентСлужебный"); +// МодульЦентрМониторингаКлиентСлужебный.ПередПериодическойОтправкойДанныхКлиентаНаСервер(Параметры); +// КонецЕсли; +// Исключение +// СерверныеОповещенияКлиент.ОбработатьОшибку(ИнформацияОбОшибке()); +// КонецПопытки; +// СерверныеОповещенияКлиент.ДобавитьПоказатель(МоментНачала, +// "ЦентрМониторингаКлиентСлужебный.ПередПериодическойОтправкойДанныхКлиентаНаСервер"); +// +Процедура ОбработатьОшибку(ИнформацияОбОшибке) Экспорт +``` + +Пример вызова +```bsl +СерверныеОповещенияКлиент.ОбработатьОшибку(ИнформацияОбОшибке) +``` +
+ +## ДобавитьПоказатель +
+ +Описание, пример вызова + +```bsl + +// Добавляет показатель производительности в обработчиках событий +// ПередПериодическойОтправкойДанныхКлиентаНаСервер и +// ПослеПериодическогоПолученияДанныхКлиентаНаСервере. +// +// Параметры: +// МоментНачала - Число - ТекущаяУниверсальнаяДатаВМиллисекундах перед вызовом процедуры. +// ИмяПроцедуры - Строка - полное имя вызываемой процедуры +// +// Пример: +// МоментНачала = ТекущаяУниверсальнаяДатаВМиллисекундах(); +// Попытка +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.ЦентрМониторинга") Тогда +// МодульЦентрМониторингаКлиентСлужебный = ОбщегоНазначенияКлиент.ОбщийМодуль("ЦентрМониторингаКлиентСлужебный"); +// МодульЦентрМониторингаКлиентСлужебный.ПередПериодическойОтправкойДанныхКлиентаНаСервер(Параметры); +// КонецЕсли; +// Исключение +// СерверныеОповещенияКлиент.ОбработатьОшибку(ИнформацияОбОшибке()); +// КонецПопытки; +// СерверныеОповещенияКлиент.ДобавитьПоказатель(МоментНачала, +// "ЦентрМониторингаКлиентСлужебный.ПередПериодическойОтправкойДанныхКлиентаНаСервер"); +// +Процедура ДобавитьПоказатель(МоментНачала, ИмяПроцедуры) Экспорт +``` + +Пример вызова +```bsl +СерверныеОповещенияКлиент.ДобавитьПоказатель(МоментНачала, ИмяПроцедуры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СервисКриптографии.md b/src/content/docs/bsp/СервисКриптографии.md new file mode 100644 index 0000000..e3474fa --- /dev/null +++ b/src/content/docs/bsp/СервисКриптографии.md @@ -0,0 +1,606 @@ +--- +title: Сервис криптографии +slug: bsp/сервис-криптографии +--- + + +## Зашифровать +
+ +Описание, пример вызова + +```bsl + +// Шифрует данные для заданного списка получателей. +// +// Параметры: +// Данные - ДвоичныеДанные, Строка, Массив - один или несколько файлов, которые необходимо зашифровать. +// Двоичные данные или адрес во временном хранилище файла данных, +// который необходимо зашифровать. +// +// Получатели - ДвоичныеДанные - файлов сертификатов +// - Структура, ФиксированнаяСтруктура - параметры для поиска сертификатов в хранилище: +// * Отпечаток - ДвоичныеДанные, Строка - отпечаток сертификата, +// или +// * СерийныйНомер - ДвоичныеДанные, Строка - серийный номер сертификата, +// * Издатель - Структура, ФиксированнаяСтруктура, Строка - свойства издателя +// или +// * Сертификат - ДвоичныеДанные - файл сертификата. +// - Массив, ФиксированныйМассив - сертификаты получателей зашифрованного сообщения. +// +// ТипШифрования - Строка - тип шифрования. Поддерживается только CMS. +// +// ПараметрыШифрования - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры шифрования. +// +// Возвращаемое значение: +// ДвоичныеДанные, Строка - зашифрованные данные. Если данные переданы через временное хранилище, +// то и результат будет возвращен также. +// +Функция Зашифровать(Данные, Получатели, ТипШифрования = "CMS", ПараметрыШифрования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.Зашифровать(Данные, Получатели, ТипШифрования, ПараметрыШифрования); +``` +
+ +## ЗашифроватьБлок +
+ +Описание, пример вызова + +```bsl + +// Шифрует блок данных для получателя. +// +// Параметры: +// Данные - ДвоичныеДанные, Строка - двоичные данные или адрес во временном хранилище файла данных, +// который необходимо зашифровать. +// +// Получатель - ДвоичныеДанные - файлов сертификатов +// - Структура, ФиксированнаяСтруктура - параметры для поиска сертификатов в хранилище: +// * Отпечаток - ДвоичныеДанные, Строка - отпечаток сертификат. +// или +// * СерийныйНомер - ДвоичныеДанные, Строка - серийный номер сертификата. +// * Издатель - Структура, ФиксированнаяСтруктура, Строка - свойства издателя +// или +// * Сертификат - ДвоичныеДанные - файл сертификата. +// +// Возвращаемое значение: +// ДвоичныеДанные, Строка - зашифрованные данные. Если данные переданы через временное хранилище, +// то и результат будет возвращен также. +// +Функция ЗашифроватьБлок(Данные, Получатель) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.ЗашифроватьБлок(Данные, Получатель) +``` +
+ +## Расшифровать +
+ +Описание, пример вызова + +```bsl + +// Выполняет расшифровку данных. +// +// Параметры: +// ЗашифрованныеДанные - ДвоичныеДанные, Строка - двоичные данные или адрес во временном хранилище файла данных, +// который необходимо расшифровать. +// +// Сертификат - Структура - сертификат, который необходимо использовать для расшифровки: +// * Идентификатор - Строка - идентификатор сертификата. +// +// ТипШифрования - Строка - поддерживается только CMS. +// +// ПараметрыШифрования - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры шифрования: +// * ИспользоватьДлительныйМаркерБезопасности - Булево - Если Истина, то для расшифровки можно использовать длительный маркер безопасности. +// Ложь - значение по умолчанию. +// +// Возвращаемое значение: +// ДвоичныеДанные - расшифрованные данные, +// Строка - расшифрованные данные, если данные переданы через временное хранилище, +// Структура - Описание ошибки выполнения: +// * КодВозврата - Строка - код ошибки. +// * Идентификатор - Строка - идентификатор сертификата. +// +Функция Расшифровать(ЗашифрованныеДанные, Сертификат, ТипШифрования = "CMS", ПараметрыШифрования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.Расшифровать(ЗашифрованныеДанные, Сертификат, ТипШифрования, ПараметрыШифрования); +``` +
+ +## РасшифроватьПереборомСертификатов +
+ +Описание, пример вызова + +```bsl + +// Выполняет расшифровку данных перебором сертификатов из криптосообщения. +// +// Параметры: +// ЗашифрованныеДанные - ДвоичныеДанные, Строка - двоичные данные или адрес во временном хранилище файла данных, +// который необходимо расшифровать. +// +// ТипШифрования - Строка - поддерживается только CMS. +// +// ПараметрыШифрования - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры шифрования. +// * ИспользоватьДлительныйМаркерБезопасности - Булево - Если Истина, то для расшифровки можно использовать длительный маркер безопасности. +// Ложь - значение по умолчанию. +// +// Возвращаемое значение: +// ДвоичныеДанные, Строка - расшифрованные данные. Если данные переданы через временное хранилище, +// то и результат будет возвращен также. +// Структура - Описание ошибки выполнения. +// * КодВозврата - Строка - код ошибки. +// * Идентификатор - Строка - идентификатор сертификата. +// +Функция РасшифроватьПереборомСертификатов(ЗашифрованныеДанные, ТипШифрования = "CMS", ПараметрыШифрования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.РасшифроватьПереборомСертификатов(ЗашифрованныеДанные, ТипШифрования, ПараметрыШифрования); +``` +
+ +## РасшифроватьБлок +
+ +Описание, пример вызова + +```bsl + +// Выполняет расшифровку блока данных. +// +// Параметры: +// ЗашифрованныеДанные - ДвоичныеДанные, Строка - двоичные данные или адрес во временном хранилище файла данных, +// который необходимо расшифровать. +// +// Получатель - ДвоичныеДанные - файл сертификата получателя зашифрованного сообщения +// - Структура, ФиксированнаяСтруктура - параметры для поиска сертификатов в хранилище: +// * Идентификатор - Строка - идентификатор сертификата. +// +// КлючеваяИнформация - Структура, ФиксированнаяСтруктура - позволяет передать данные о ключах шифрования в запрос: +// * ephemeral_key - ДвоичныеДанные, Строка - в base64, эфемерный ключ +// * session_key - ДвоичныеДанные, Строка - в base64, сессионный ключ +// * iv_data - ДвоичныеДанные, Строка - в base64, данные вектора инициализации +// +// ПараметрыШифрования - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры шифрования. +// +// Возвращаемое значение: +// ДвоичныеДанные - расшифрованные данные; +// Строка - расшифрованные данные, если данные переданы через временное хранилище; +// Структура - описание ошибки выполнения: +// * КодВозврата - Строка - код ошибки. +// * Идентификатор - Строка - идентификатор сертификата. +// +Функция РасшифроватьБлок(ЗашифрованныеДанные, Получатель, КлючеваяИнформация, ПараметрыШифрования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.РасшифроватьБлок(ЗашифрованныеДанные, Получатель, КлючеваяИнформация, ПараметрыШифрования); +``` +
+ +## Подписать +
+ +Описание, пример вызова + +```bsl + +// Выполняет подписание данных. +// +// Параметры: +// Данные - ДвоичныеДанные, Строка, Массив - один или несколько файлов, которые необходимо подписать. +// Двоичные данные или адрес во временном хранилище файла данных, +// который необходимо подписать. +// +// Подписант - ДвоичныеДанные - файла сертификата для подписания. +// - Структура, ФиксированнаяСтруктура - параметры для поиска сертификата в хранилище. +// * Отпечаток - ДвоичныеДанные, Строка - отпечаток сертификат. +// или +// * СерийныйНомер - ДвоичныеДанные, Строка - серийный номер сертификата. +// * Издатель - Структура, ФиксированнаяСтруктура, Строка - свойства издателя. +// или +// * Сертификат - ДвоичныеДанные - файл сертификата. +// +// ТипПодписи - Строка - тип подписи. Поддерживаются только "CMS" или "GOST3410". +// +// ПараметрыПодписания - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры подписания: +// * ОтсоединеннаяПодпись - Булево - поддерживается только CMS, если Истина, то будет сформирована отсоединенная подпись, иначе - присоединенная. +// Истина - значение по умолчанию. +// * ИспользоватьДлительныйМаркерБезопасности - Булево - Если Истина, то для расшифровки можно использовать длительный маркер безопасности. +// Ложь - значение по умолчанию. +// +// Возвращаемое значение: +// ДвоичныеДанные - подпись; +// Строка - подпись, если данные переданы через временное хранилище; +// Структура - описание ошибки выполнения: +// * КодВозврата - Строка - код ошибки. +// * Идентификатор - Строка - идентификатор сертификата. +// +Функция Подписать(Данные, Подписант, ТипПодписи = "CMS", ПараметрыПодписания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.Подписать(Данные, Подписант, ТипПодписи, ПараметрыПодписания); +``` +
+ +## ПроверитьПодпись +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку подписи. +// +// Параметры: +// Подпись - ДвоичныеДанные - подпись, которую необходимо проверить. +// +// Данные - ДвоичныеДанные - исходные данные, необходимые для проверки подписи. Используется для проверки ОтсоединеннаяПодпись. +// +// ТипПодписи - Строка - тип подписи. Поддерживаются только "CMS" или "GOST3410". +// +// ПараметрыПодписания - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры подписания. +// * ОтсоединеннаяПодпись - Булево - используется совместно с ТипПодписи = "CMS", если Истина, то подпись будет проверяться с использованием Данные. +// Истина - значение по умолчанию. +// * Сертификат - ДвоичныеДанные - файл сертификата, обязательно используется совместно с ТипПодписи = "GOST3410". +// +// Возвращаемое значение: +// Булево - если Истина, то подпись действительна. +// +Функция ПроверитьПодпись(Подпись, Данные = Неопределено, ТипПодписи = "CMS", ПараметрыПодписания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.ПроверитьПодпись(Подпись, Данные, ТипПодписи, ПараметрыПодписания); +``` +
+ +## ХешированиеДанных +
+ +Описание, пример вызова + +```bsl + +// Выполняет расчет хеш-суммы по переданным данным. +// +// Параметры: +// Данные - ДвоичныеДанные, Строка - двоичные данные или адрес во временном хранилище файла данных, +// от которых необходимо посчитать хеш-сумму. +// АлгоритмХеширования - Строка - константа из списка "GOST R 34.11-94", "GOST R 34.11-2012 256", "GOST R 34.11-2012 512". +// +// ПараметрыХеширования - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры хеширования. +// * ИнвертироватьПолубайты - Булево - управляет инвертированием полубайт в значении хеш-суммы. Применяется только для "GOST R 34.11-94" +// Например, прямой порядок - 62 FB, обратный - 26 BF. +// Истина - значение по умолчанию. +// +// Возвращаемое значение: +// ДвоичныеДанные - значение хеш-суммы. +// +Функция ХешированиеДанных(Данные, АлгоритмХеширования = "GOST R 34.11-94", ПараметрыХеширования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.ХешированиеДанных(Данные, АлгоритмХеширования, ПараметрыХеширования); +``` +
+ +## ПроверитьСертификат +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку сертификата. +// +// Параметры: +// Сертификат - ДвоичныеДанные - файл сертификата. +// +// Возвращаемое значение: +// Булево - если Истина, то сертификат действителен. +// +Функция ПроверитьСертификат(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.ПроверитьСертификат(Сертификат) +``` +
+ +## ПроверитьСертификатСПараметрами +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку сертификата с дополнительными параметрами +// +// Параметры: +// Сертификат - ДвоичныеДанные - файл сертификата. +// ПараметрыПроверки - Структура - содержит дополнительные параметры проверки. +// * РежимПроверкиСертификата - Строка - обрабатываются варианты "ИгнорироватьВремяДействия", +// "ИгнорироватьДействительностьПодписи", +// "ИгнорироватьПроверкуВСпискеОтозванныхСертификатов", +// "РазрешитьТестовыеСертификаты" +// +// Возвращаемое значение: +// Булево - если Истина, то сертификат действителен. +// +Функция ПроверитьСертификатСПараметрами(Сертификат, ПараметрыПроверки) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.ПроверитьСертификатСПараметрами(Сертификат, ПараметрыПроверки) +``` +
+ +## ПолучитьСвойстваСертификата +
+ +Описание, пример вызова + +```bsl + +// Получает основные свойства переданного сертификата. +// +// Параметры: +// Сертификат - ДвоичныеДанные - сертификат, свойства которого необходимо получить. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - свойства сертификата: +// * Версия - Строка - версия сертификата. +// * ДатаНачала - Дата - дата начала действия сертификата (UTC). +// * ДатаОкончания - Дата - дата окончания действия сертификата (UTC). +// * Издатель - ФиксированнаяСтруктура - информация об издателе сертификата: +// ** CN - Строка - commonName +// ** O - Строка - organizationName; +// ** OU - Строка - organizationUnitName; +// ** C - Строка - countryName; +// ** ST - Строка - stateOrProvinceName; +// ** L - Строка - localityName; +// ** E - Строка - emailAddress; +// ** SN - Строка - surname; +// ** GN - Строка - givenName; +// ** T - Строка - title; +// ** STREET - Строка - streetAddress; +// ** OGRN - Строка - ОГРН; +// ** OGRNIP - Строка - ОГРНИП; +// ** INN - Строка - ИНН (не обязательный); +// ** INNLE - Строка - ИНН ЮЛ (не обязательный); +// ** SNILS - Строка - СНИЛС; +// ... +// * ИспользоватьДляПодписи - Булево - указывает, можно ли использовать данный сертификат для подписи. +// * ИспользоватьДляШифрования - Булево - указывает, можно ли использовать данный сертификат для шифрования. +// * ОткрытыйКлюч - ДвоичныеДанные - содержит данные открытого ключа. +// * Отпечаток - ДвоичныеДанные - содержит данные отпечатка. Вычисляется динамически, по алгоритму SHA-1. +// * РасширенныеСвойства - ФиксированнаяСтруктура - расширенные свойства сертификата: +// ** EKU - ФиксированныйМассив из Произвольный - Enhanced Key Usage. +// * СерийныйНомер - ДвоичныеДанные - серийный номер сертификата. +// * Субъект - ФиксированнаяСтруктура - информацию о субъекте сертификата. Состав см. Издатель: +// ** CN - Строка - commonName ... +// * Сертификат - ДвоичныеДанные - файл сертификата в кодировке DER. +// * Идентификатор - Строка - вычисляется по ключевым свойствам Издателя и серийному номеру по алгоритму SHA1. +// Используется для идентификации сертификата в сервисе криптографии. +// +Функция ПолучитьСвойстваСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.ПолучитьСвойстваСертификата(Сертификат) +``` +
+ +## ПолучитьСертификатыИзПодписи +
+ +Описание, пример вызова + +```bsl + +// Извлекает массив сертификатов из данных подписи. +// +// Параметры: +// Подпись - ДвоичныеДанные - файл подписи. +// +// Возвращаемое значение: +// Массив из ФиксированнаяСтруктура - со свойствами сертификатов: +// * Издатель - ФиксированнаяСтруктура - информация об издателе сертификата: +// ** CN - Строка - commonName; +// ** O - Строка - organizationName; +// ** OU - Строка - organizationUnitName; +// ** C - Строка - countryName; +// ** ST - Строка - stateOrProvinceName; +// ** L - Строка - localityName; +// ** E - Строка - emailAddress; +// ** SN - Строка - surname; +// ** GN - Строка - givenName; +// ** T - Строка - title; +// ** STREET - Строка - streetAddress; +// ** OGRN - Строка - ОГРН; +// ** OGRNIP - Строка - ОГРНИП; +// ** INN - Строка - ИНН; +// ** INNLE - Строка - ИНН ЮЛ (не обязательный); +// ** SNILS - Строка - СНИЛС; +// * СерийныйНомер - ДвоичныеДанные - серийный номер сертификата. +// * Сертификат - ДвоичныеДанные - файл сертификата в кодировке DER. +// * Идентификатор - Строка - вычисляется по ключевым свойствам Издателя и серийному номеру по алгоритму SHA1. +// Используется для идентификации сертификата в сервисе криптографии. +// +Функция ПолучитьСертификатыИзПодписи(Подпись) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.ПолучитьСертификатыИзПодписи(Подпись) +``` +
+ +## ПолучитьСвойстваКриптосообщения +
+ +Описание, пример вызова + +```bsl + +// Извлекает свойства из файла криптосообщения. +// +// Параметры: +// Криптосообщение - ДвоичныеДанные, Строка - двоичные данные или адрес во временном хранилище файла криптосообщения. +// ТолькоКлючевыеСвойства - Булево - если Истина, то Содержимое будет возвращаться всегда пустое. +// +// Возвращаемое значение: +// Структура - свойства криптосообщения: +// * Размер - Число - размер файла в байтах. +// * Тип - Строка - указывает тип сообщения: envelopedData, signedData, unknown. +// * Получатели - ФиксированныйМассив Из Структура - описание сертификатов получателей зашифрованного сообщения. Только для Тип="envelopedData": +// ** Идентификатор - Строка - вычисляется по ключевым свойствам Издателя и серийному номеру по алгоритму SHA1, +// остальные поля см. ПолучитьСвойстваСертификата. +// * Подписанты - ФиксированныйМассив Из Структура - описание сертификатов получателей зашифрованного сообщения. Только для Тип="signedData": +// ** Идентификатор - Строка - вычисляется по ключевым свойствам Издателя и серийному номеру по алгоритму SHA1. +// остальные поля см. ПолучитьСвойстваСертификата. +// * Содержимое - ДвоичныеДанные - содержимое криптосообщения. +// +Функция ПолучитьСвойстваКриптосообщения(Криптосообщение, ТолькоКлючевыеСвойства = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.ПолучитьСвойстваКриптосообщения(Криптосообщение, ТолькоКлючевыеСвойства); +``` +
+ +## ПолучитьНастройкиПолученияВременныхПаролей +
+ +Описание, пример вызова + +```bsl + +// Получает возможные способы доставки временных паролей. +// +// Параметры: +// ИдентификаторСертификата - Строка - идентификатор сертификата, для которого необходимо получить способы доставки паролей. +// +// Возвращаемое значение: +// Структура - содержит ключи: +// * Телефон - Строка - замаскированное представление телефона для получения временных паролей в SMS. +// * ЭлектроннаяПочта - Строка - замаскированное представление электронной почты для получения временных паролей в письмах. +// +Функция ПолучитьНастройкиПолученияВременныхПаролей(ИдентификаторСертификата) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.ПолучитьНастройкиПолученияВременныхПаролей(ИдентификаторСертификата) +``` +
+ +## ПолучитьВременныйПароль +
+ +Описание, пример вызова + +```bsl + +// Запрашивает у сервиса криптографии отправку временного пароля. +// +// Параметры: +// ИдентификаторСертификата - Строка - Идентификатора сертификата, для которого требуется временный пароль. +// ПовторнаяОтправка - Булево - Истина, если запрос является повторным. +// СпособДоставкиПаролей - Строка - Одно из значений: "phone" или "email". +// ИдентификаторСессии - Строка - идентификатор сессии +// +// Возвращаемое значение: +// Структура - содержит ключи: +// * ЗадержкаПередПовторнойОтправкой - Число - Число секунд перед повторным запросом нового пароля. +// * ВремяДействияПароля - Число - Число секунд, в течение которых действует высланный пароль. +// * ИдентификаторСессии - Строка - если есть "session_id". +// +Функция ПолучитьВременныйПароль(ИдентификаторСертификата, ПовторнаяОтправка, СпособДоставкиПаролей, ИдентификаторСессии = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.ПолучитьВременныйПароль(ИдентификаторСертификата, ПовторнаяОтправка, СпособДоставкиПаролей, ИдентификаторСессии); +``` +
+ +## ПодтвердитьВременныйПароль +
+ +Описание, пример вызова + +```bsl + +// Отправляет сервису криптографии ранее полученный временный пароль и запрашивает маркеры безопасности для него. +// +// Параметры: +// ИдентификаторСертификата - Строка - Идентификатор сертификата, с помощью которого планируется подписание. +// ВременныйПароль - Строка - Временный пароль, ранее присланный сервисом криптографии. +// +Процедура ПодтвердитьВременныйПароль(ИдентификаторСертификата, ВременныйПароль) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографии.ПодтвердитьВременныйПароль(ИдентификаторСертификата, ВременныйПароль) +``` +
+ +## МаркерыБезопасности +
+ +Описание, пример вызова + +```bsl + +// Пытается получить ранее сохраненные маркеры безопасности: сессионный и долговременный +// +// Параметры: +// ИдентификаторСертификата - Строка - Идентификатор сертификата, с помощью которого планируется подписание. +// ИспользоватьДлительныйМаркерБезопасности - Булево - признак поиска долговременного токена. +// +// Возвращаемое значение: +// Структура - маркер: +// * МаркерБезопасности - Строка +// * ДлительныйМаркерБезопасности - Строка +Функция МаркерыБезопасности(ИдентификаторСертификата, ИспользоватьДлительныйМаркерБезопасности) Экспорт +``` + +Пример вызова +```bsl +Результат = СервисКриптографии.МаркерыБезопасности(ИдентификаторСертификата, ИспользоватьДлительныйМаркерБезопасности) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СервисКриптографииDSSПереопределяемый.md b/src/content/docs/bsp/СервисКриптографииDSSПереопределяемый.md new file mode 100644 index 0000000..0e2c84b --- /dev/null +++ b/src/content/docs/bsp/СервисКриптографииDSSПереопределяемый.md @@ -0,0 +1,94 @@ +--- +title: Сервис криптографии dss переопределяемый +slug: bsp/сервис-криптографии-dss-переопределяемый +--- + + +## СписокПервичнойАвторизации +
+ +Описание, пример вызова + +```bsl + +// Процедура позволяет переопределить список способов первичной аутентификации, доступный пользователю +// +// Параметры: +// МассивСпособов - Массив из ПеречислениеСсылка.СпособыАвторизацииDSS +// +Процедура СписокПервичнойАвторизации(МассивСпособов) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииDSSПереопределяемый.СписокПервичнойАвторизации(МассивСпособов) +``` +
+ +## СписокВторичнойАвторизации +
+ +Описание, пример вызова + +```bsl + +// Процедура позволяет переопределить список способов вторичной авторизация, доступный пользователю +// +// Параметры: +// МассивСпособов - Массив из ПеречислениеСсылка.СпособыАвторизацииDSS +// +Процедура СписокВторичнойАвторизации(МассивСпособов) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииDSSПереопределяемый.СписокВторичнойАвторизации(МассивСпособов) +``` +
+ +## ПриВключенииСервисаОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при изменении значения константы ИспользоватьСервисDSS +// +Процедура ПриВключенииСервисаОблачнойПодписи() Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииDSSПереопределяемый.ПриВключенииСервисаОблачнойПодписи() +``` +
+ +## ИспользоватьСинхронныйРежим +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить использование синхронного режима работы в зависимости от вида клиента +// +// Параметры: +// ТекущийРежим - Булево - для ВебКлиента Ложь, для остальных Истина +// +Процедура ИспользоватьСинхронныйРежим(ТекущийРежим) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииDSSПереопределяемый.ИспользоватьСинхронныйРежим(ТекущийРежим) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СервисКриптографииКлиент.md b/src/content/docs/bsp/СервисКриптографииКлиент.md new file mode 100644 index 0000000..800dd28 --- /dev/null +++ b/src/content/docs/bsp/СервисКриптографииКлиент.md @@ -0,0 +1,430 @@ +--- +title: Сервис криптографии клиент +slug: bsp/сервис-криптографии-клиент +--- + + +## Зашифровать +
+ +Описание, пример вызова + +```bsl + +// Шифрует данные для заданного списка получателей. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** ЗашифрованныеДанные - ДвоичныеДанные, Строка, Массив - один или несколько файлов. +// Если данные переданы через временное хранилище, +// то и результат будет возвращен также. +// +// Данные - ДвоичныеДанные, Строка, Массив - один или несколько файлов, которые необходимо зашифровать. +// Двоичные данные или адрес во временном хранилище файла данных, +// который необходимо зашифровать. +// +// Получатели - ДвоичныеДанные, Структура, ФиксированнаяСтруктура, Массив, ФиксированныйМассив - сертификаты получателей зашифрованного сообщения. +// Либо ДвоичныеДанные файлов сертификатов или Структура с параметрами для поиска сертификатов в хранилище. +// Структура - ключевые параметры сертификата, используемые для поиска. +// Отпечаток или пара СерийныйНомер и Издатель, или Сертификат с двоичными данными. +// * Отпечаток - ДвоичныеДанные, Строка - отпечаток сертификат. +// * СерийныйНомер - ДвоичныеДанные, Строка - серийный номер сертификата. +// * Издатель - Структура, ФиксированнаяСтруктура, Строка - свойства издателя. +// * Сертификат - ДвоичныеДанные - файл сертификата. +// +// ТипШифрования - Строка - тип шифрования. Поддерживается только CMS. +// +// ПараметрыШифрования - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры шифрования. +// +Процедура Зашифровать(ОповещениеОЗавершении, Данные, Получатели, ТипШифрования = "CMS", ПараметрыШифрования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.Зашифровать(ОповещениеОЗавершении, Данные, Получатели, ТипШифрования, ПараметрыШифрования); +``` +
+ +## ЗашифроватьБлок +
+ +Описание, пример вызова + +```bsl + +// Шифрует блок данных для получателя. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** ЗашифрованныеДанные - ДвоичныеДанные, Строка, Массив - один или несколько файлов. +// Если данные переданы через временное хранилище, +// то и результат будет возвращен также. +// +// Данные - ДвоичныеДанные, Строка - Двоичные данные или адрес во временном хранилище файла данных, +// который необходимо зашифровать. +// +// Получатель - ДвоичныеДанные, Структура, ФиксированнаяСтруктура - сертификат получателя зашифрованного сообщения. +// Либо ДвоичныеДанные файлов сертификатов или Структура с параметрами для поиска сертификатов в хранилище. +// Структура - ключевые параметры сертификата, используемые для поиска. +// Отпечаток или пара СерийныйНомер и Издатель, или Сертификат с двоичными данными. +// * Отпечаток - ДвоичныеДанные, Строка - отпечаток сертификат. +// * СерийныйНомер - ДвоичныеДанные, Строка - серийный номер сертификата. +// * Издатель - Структура, ФиксированнаяСтруктура, Строка - свойства издателя. +// * Сертификат - ДвоичныеДанные - файл сертификата. +// +Процедура ЗашифроватьБлок(ОповещениеОЗавершении, Данные, Получатель) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.ЗашифроватьБлок(ОповещениеОЗавершении, Данные, Получатель) +``` +
+ +## Расшифровать +
+ +Описание, пример вызова + +```bsl + +// Выполняет расшифровку данных. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** РасшифрованныеДанные - ДвоичныеДанные, Строка - если данные переданы через временное хранилище, +// то и результат будет возвращен также. +// * Получатели - ФиксированныйМассив - сертификаты, на которые зашифрованы данные. +// +// ЗашифрованныеДанные - ДвоичныеДанные, Строка - двоичные данные или адрес во временном хранилище файла данных, +// который необходимо расшифровать. +// +// ТипШифрования - Строка - поддерживается только CMS. +// +// ПараметрыШифрования - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры шифрования. +// +Процедура Расшифровать(ОповещениеОЗавершении, ЗашифрованныеДанные, ТипШифрования = "CMS", ПараметрыШифрования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.Расшифровать(ОповещениеОЗавершении, ЗашифрованныеДанные, ТипШифрования, ПараметрыШифрования); +``` +
+ +## РасшифроватьБлок +
+ +Описание, пример вызова + +```bsl + +// Выполняет расшифровку блока данных. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** РасшифрованныеДанные - ДвоичныеДанные, Строка - если данные переданы через временное хранилище, +// то и результат будет возвращен также. +// ** Получатели - ФиксированныйМассив - сертификаты, на которые зашифрованы данные. +// +// ЗашифрованныеДанные - ДвоичныеДанные, Строка - двоичные данные или адрес во временном хранилище файла данных, +// который необходимо расшифровать. +// +// Получатель - ДвоичныеДанные - данные файлов сертификатов получателя зашифрованного сообщения. +// - Структура, ФиксированнаяСтруктура - параметры для поиска сертификатов в хранилище. +// +// КлючеваяИнформация - Структура, ФиксированнаяСтруктура - позволяет передать данные о ключах шифрования в запрос: +// * ephemeral_key - ДвоичныеДанные, Строка - в base64, эфемерный ключ +// * session_key - ДвоичныеДанные, Строка - в base64, сессионный ключ +// * iv_data - ДвоичныеДанные, Строка - в base64, данные вектора инициализации +// +// ПараметрыШифрования - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры шифрования: +// * ОчиститьДополняющиеБайты - Булево - флаг определяющий будут ли удалены заполняющие байты. По-умолчанию - удаляются. +// +Процедура РасшифроватьБлок(ОповещениеОЗавершении, ЗашифрованныеДанные, Получатель, КлючеваяИнформация, ПараметрыШифрования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.РасшифроватьБлок(ОповещениеОЗавершении, ЗашифрованныеДанные, Получатель, КлючеваяИнформация, ПараметрыШифрования); +``` +
+ +## Подписать +
+ +Описание, пример вызова + +```bsl + +// Выполняет подписание данных. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** Подпись - ДвоичныеДанные, Строка , Массив из ДвоичныеДанные - +// - Массив из Строка - один или несколько файлов. +// Если данные переданы через временное хранилище, то и результат будет возвращен также. +// +// Данные - ДвоичныеДанные, Строка, Массив - один или несколько файлов, которые необходимо подписать. +// Двоичные данные или адрес во временном хранилище файла данных, +// который необходимо подписать. +// +// Подписант - ДвоичныеДанные - файла сертификата для подписания. +// - Структура, ФиксированнаяСтруктура - параметры для поиска сертификатов в хранилище: +// * Отпечаток - ДвоичныеДанные, Строка - отпечаток сертификат, или +// * СерийныйНомер - ДвоичныеДанные, Строка - серийный номер сертификата. +// * Издатель - Структура, ФиксированнаяСтруктура, Строка - свойства издателя, или +// * Сертификат - ДвоичныеДанные - файл сертификата. +// +// ТипПодписи - Строка - тип подписи. Поддерживаются только CMS или GOST3410. +// +// ПараметрыПодписания - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры подписания: +// * ОтсоединеннаяПодпись - Булево - поддерживается только CMS, если Истина, то будет сформирована отсоединенная подпись, иначе - присоединенная. +// Истина - значение по умолчанию. +// +Процедура Подписать(ОповещениеОЗавершении, Данные, Подписант, ТипПодписи = "CMS", ПараметрыПодписания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.Подписать(ОповещениеОЗавершении, Данные, Подписант, ТипПодписи, ПараметрыПодписания); +``` +
+ +## ПроверитьПодпись +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку подписи. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** ПодписьДействительна - Булево - Истина - результат проверки подписи. +// +// Подпись - ДвоичныеДанные - подпись, которую необходимо проверить. +// +// Данные - ДвоичныеДанные - исходные данные, необходимые для проверки подписи. Используется для проверки ОтсоединеннаяПодпись. +// +// ТипПодписи - Строка - тип подписи. Поддерживаются только "CMS" или "GOST3410". +// +// ПараметрыПодписания - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры подписания. +// * ОтсоединеннаяПодпись - Булево - используется совместно с ТипПодписи = "CMS", если Истина, то подпись будет проверяться с использованием Данные. +// Истина - значение по умолчанию. +// * Сертификат - ДвоичныеДанные - файл сертификата, обязательно используется совместно с ТипПодписи = "GOST3410". +// +Процедура ПроверитьПодпись(ОповещениеОЗавершении, Подпись, Данные = Неопределено, ТипПодписи = "CMS", ПараметрыПодписания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.ПроверитьПодпись(ОповещениеОЗавершении, Подпись, Данные, ТипПодписи, ПараметрыПодписания); +``` +
+ +## ПроверитьСертификат +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку сертификата. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** Действителен - Булево - сертификат соответствует требованиям проверки. +// +// Сертификат - ДвоичныеДанные - файл сертификата. +// +Процедура ПроверитьСертификат(ОповещениеОЗавершении, Сертификат) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.ПроверитьСертификат(ОповещениеОЗавершении, Сертификат) +``` +
+ +## ПроверитьСертификатСПараметрами +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку сертификата с дополнительными параметрами. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** Действителен - Булево - сертификат соответствует требованиям проверки. +// +// Сертификат - ДвоичныеДанные - файл сертификата. +// +// ПараметрыПроверки - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры проверки сертификата. +// * РежимПроверкиСертификата - Строка - перечисляет через запятую режимы проверки сертификата, +// значения строк соответствуют перечислению РежимПроверкиСертификатаКриптографии +// +Процедура ПроверитьСертификатСПараметрами(ОповещениеОЗавершении, Сертификат, ПараметрыПроверки) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.ПроверитьСертификатСПараметрами(ОповещениеОЗавершении, Сертификат, ПараметрыПроверки) +``` +
+ +## ПолучитьСвойстваСертификата +
+ +Описание, пример вызова + +```bsl + +// Получает основные свойства переданного сертификата. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат. Иначе см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** Сертификат - ФиксированнаяСтруктура - свойства сертификата: +// *** Версия - Строка - версия сертификата. +// *** ДатаНачала - Дата - дата начала действия сертификата (UTC). +// *** ДатаОкончания - Дата - дата окончания действия сертификата (UTC). +// *** Издатель - ФиксированнаяСтруктура - информация об издателе сертификата: +// *** CN - Строка - commonName; +// *** O - Строка - organizationName; +// *** OU - Строка - organizationUnitName; +// *** C - Строка - countryName; +// *** ST - Строка - stateOrProvinceName; +// *** L - Строка - localityName; +// *** E - Строка - emailAddress; +// *** SN - Строка - surname; +// *** GN - Строка - givenName; +// *** T - Строка - title; +// *** STREET - Строка - streetAddress; +// *** OGRN - Строка - ОГРН; +// *** OGRNIP - Строка - ОГРНИП; +// *** INN - Строка - ИНН (не обязательный); +// *** INNLE - Строка - ИНН ЮЛ (не обязательный); +// *** SNILS - Строка - СНИЛС; +// ... +// ** ИспользоватьДляПодписи - Булево - указывает, можно ли использовать данный сертификат для подписи. +// ** ИспользоватьДляШифрования - Булево - указывает, можно ли использовать данный сертификат для шифрования. +// ** ОткрытыйКлюч - ДвоичныеДанные - содержит данные открытого ключа. +// ** Отпечаток - ДвоичныеДанные - содержит данные отпечатка. Вычисляется динамически, по алгоритму SHA-1. +// ** РасширенныеСвойства - ФиксированнаяСтруктура - расширенные свойства сертификата: +// *** EKU - ФиксированныйМассив - Enhanced Key Usage. +// ** СерийныйНомер - ДвоичныеДанные - серийный номер сертификата. +// ** Субъект - ФиксированнаяСтруктура - информацию о субъекте сертификата. Состав см. Издатель. +// ** Сертификат - ДвоичныеДанные - файл сертификата в кодировке DER. +// ** Идентификатор - Строка - вычисляется по ключевым свойствам Издателя и серийному номеру по алгоритму SHA1. +// Используется для идентификации сертификата в сервисе криптографии. +// +// Сертификат - ДвоичныеДанные - сертификат, свойства которого необходимо получить. +// +Процедура ПолучитьСвойстваСертификата(ОповещениеОЗавершении, Сертификат) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.ПолучитьСвойстваСертификата(ОповещениеОЗавершении, Сертификат) +``` +
+ +## ПолучитьСертификатыИзПодписи +
+ +Описание, пример вызова + +```bsl + +// Извлекает массив сертификатов из данных подписи. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** Сертификаты - Массив из ДвоичныеДанные - содержимое сертификатов +// +// Подпись - ДвоичныеДанные - файл подписи. +// - Строка - адрес во временном хранилище. +// +Процедура ПолучитьСертификатыИзПодписи(ОповещениеОЗавершении, Подпись) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.ПолучитьСертификатыИзПодписи(ОповещениеОЗавершении, Подпись) +``` +
+ +## ХешированиеДанных +
+ +Описание, пример вызова + +```bsl + +// Выполняет расчет хеш-суммы по переданным данным. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат: +// * Результат - Структура - результат выполнения процедуры: +// ** Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ИнформацияОбОшибке. +// ** ИнформацияОбОшибке - ИнформацияОбОшибке - описание ошибки выполнения. +// ** Хеш - ДвоичныеДанные - значение хеш-суммы. +// +// Данные - ДвоичныеДанные, Строка - двоичные данные или адрес во временном хранилище файла данных, +// от которых необходимо посчитать хеш-сумму. +// АлгоритмХеширования - Строка - константа из списка "GOST R 34.11-94", "GOST R 34.11-2012 256", "GOST R 34.11-2012 512". +// +// ПараметрыХеширования - Структура, ФиксированнаяСтруктура - позволяет указать дополнительные параметры хеширования: +// * ИнвертироватьПолубайты - Булево - управляет инвертированием полубайт в значении хеш-суммы. Применяется только для "GOST R 34.11-94" +// Например, прямой порядок - 62 FB, обратный - 26 BF. +// Истина - значение по умолчанию. +// +Процедура ХешированиеДанных(ОповещениеОЗавершении, Данные, АлгоритмХеширования = "GOST R 34.11-94", ПараметрыХеширования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СервисКриптографииКлиент.ХешированиеДанных(ОповещениеОЗавершении, Данные, АлгоритмХеширования, ПараметрыХеширования); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СклонениеПредставленийОбъектов.md b/src/content/docs/bsp/СклонениеПредставленийОбъектов.md new file mode 100644 index 0000000..c941c57 --- /dev/null +++ b/src/content/docs/bsp/СклонениеПредставленийОбъектов.md @@ -0,0 +1,256 @@ +--- +title: Склонение представлений объектов +slug: bsp/склонение-представлений-объектов +--- + + +## ПросклонятьФИО +
+ +Описание, пример вызова + +```bsl + +// Определяет форму ФИО в заданном падеже. +// +// Параметры: +// ФИО - Строка - строка, в которой содержится ФИО для склонения. +// Падеж - Число - падеж, в который необходимо просклонять представление объекта. +// 1 - Именительный. +// 2 - Родительный. +// 3 - Дательный. +// 4 - Винительный. +// 5 - Творительный. +// 6 - Предложный. +// Объект - ОпределяемыйТип.ОбъектСклонения - ссылка на объект, реквизит которого склоняется. +// Пол - Число - число - пол физического лица, +// 1 - мужской, +// 2 - женский. +// +// Возвращаемое значение: +// Строка - результат склонения ФИО в падеже. +// +Функция ПросклонятьФИО(ФИО, Падеж, Объект = Неопределено, Пол = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СклонениеПредставленийОбъектов.ПросклонятьФИО(ФИО, Падеж, Объект, Пол); +``` +
+ +## ПросклонятьПредставление +
+ +Описание, пример вызова + +```bsl + +// Склоняет представление объекта. +// +// Параметры: +// Представление - Строка - строка, в которой содержится ФИО для склонения. +// Падеж - Число - падеж, в который необходимо просклонять представление объекта. +// 1 - Именительный. +// 2 - Родительный. +// 3 - Дательный. +// 4 - Винительный. +// 5 - Творительный. +// 6 - Предложный. +// Объект - ОпределяемыйТип.ОбъектСклонения - ссылка на объект, реквизит которого склоняется. +// +// Возвращаемое значение: +// Строка - результат склонения представления объекта в падеже. +// +Функция ПросклонятьПредставление(Представление, Падеж, Объект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СклонениеПредставленийОбъектов.ПросклонятьПредставление(Представление, Падеж, Объект); +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Выполняет с формой действия, необходимые для подключения подсистемы Склонения. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма для подключения механизма склонения. +// Представление - Строка - строка для склонения. +// ИмяОсновногоРеквизитаФормы - Строка - имя основного реквизита формы. +// +Процедура ПриСозданииНаСервере(Форма, Представление, ИмяОсновногоРеквизитаФормы = "Объект") Экспорт +``` + +Пример вызова +```bsl +СклонениеПредставленийОбъектов.ПриСозданииНаСервере(Форма, Представление, ИмяОсновногоРеквизитаФормы); +``` +
+ +## ПриЗаписиФормыОбъектаСклонения +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриЗаписиНаСервере управляемой формы объекта для склонения. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта склонения. +// Представление - Строка - строка для склонения. +// Объект - ОпределяемыйТип.ОбъектСклонения - объект для склонения. +// ПараметрыСклонения - см. СклонениеПредставленийОбъектовКлиентСервер.ПараметрыСклонения +// +Процедура ПриЗаписиФормыОбъектаСклонения(Форма, Представление, Объект, ПараметрыСклонения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СклонениеПредставленийОбъектов.ПриЗаписиФормыОбъектаСклонения(Форма, Представление, Объект, ПараметрыСклонения); +``` +
+ +## УстановитьДоступностьСервисаСклонения +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак доступности сервиса склонения. +// +// Параметры: +// Доступность - Булево - признак доступности сервиса склонения. +// +Процедура УстановитьДоступностьСервисаСклонения(Доступность) Экспорт +``` + +Пример вызова +```bsl +СклонениеПредставленийОбъектов.УстановитьДоступностьСервисаСклонения(Доступность) +``` +
+ +## ДоступенСервисСклонения +
+ +Описание, пример вызова + +```bsl + +// Определяет доступен ли сервис склонения. +// +// Возвращаемое значение: +// Булево - Истина, если веб-сервис склонения доступен. +// +Функция ДоступенСервисСклонения() Экспорт +``` + +Пример вызова +```bsl +Результат = СклонениеПредставленийОбъектов.ДоступенСервисСклонения() +``` +
+ +## ПодключитьИсточникДанныхПечатиСклоненияСтрок +
+ +Описание, пример вызова + +```bsl + +// Добавляет возможность склонения по падежам значения реквизита при печати. +// +// Параметры: +// ИсточникиДанныхПечати - см. УправлениеПечатьюПереопределяемый.ПриОпределенииИсточниковДанныхПечати.ИсточникиДанныхПечати +// +Процедура ПодключитьИсточникДанныхПечатиСклоненияСтрок(ИсточникиДанныхПечати) Экспорт +``` + +Пример вызова +```bsl +СклонениеПредставленийОбъектов.ПодключитьИсточникДанныхПечатиСклоненияСтрок(ИсточникиДанныхПечати) +``` +
+ +## ПриЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать СклонениеПредставленийОбъектов.ПриЗаписиФормыОбъектаСклонения. +// Обработчик события ПриЗаписиНаСервере управляемой формы объекта для склонения. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта склонения. +// Представление - Строка - строка для склонения. +// Объект - ОпределяемыйТип.ОбъектСклонения - объект для склонения. +// ЭтоФИО - Булево - признак склонения ФИО. +// Пол - Число - пол физического лица (в случае склонения ФИО) +// 1 - мужской +// 2 - женский. +// +Процедура ПриЗаписиНаСервере(Форма, Представление, Объект, ЭтоФИО = Ложь, Пол = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СклонениеПредставленийОбъектов.ПриЗаписиНаСервере(Форма, Представление, Объект, ЭтоФИО, Пол); +``` +
+ +## ПросклонятьФИОСПомощьюКомпоненты +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать СклонениеПредставленийОбъектов.ПросклонятьФИО. +// +// Склоняет переданную фразу. +// Только для работы на ОС Windows. +// +// Параметры: +// ФИО - Строка - фамилия, имя и отчество в именительном падеже, +// которые необходимо просклонять. +// Падеж - Число - падеж, в который необходимо поставить ФИО: +// 1 - Именительный. +// 2 - Родительный. +// 3 - Дательный. +// 4 - Винительный. +// 5 - Творительный. +// 6 - Предложный. +// Результат - Строка - в этот параметр помещается результат склонения. +// Если ФИО не удалось просклонять, то возвращается значение ФИО. +// Пол - Число - пол физического лица, 1 - мужской, 2 - женский. +// +// Возвращаемое значение: +// Булево - Истина, если ФИО удалось просклонять. +// +Функция ПросклонятьФИОСПомощьюКомпоненты(Знач ФИО, Падеж, Результат, Пол = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СклонениеПредставленийОбъектов.ПросклонятьФИОСПомощьюКомпоненты(ФИО, Падеж, Результат, Пол); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СклонениеПредставленийОбъектовКлиент.md b/src/content/docs/bsp/СклонениеПредставленийОбъектовКлиент.md new file mode 100644 index 0000000..f38cc30 --- /dev/null +++ b/src/content/docs/bsp/СклонениеПредставленийОбъектовКлиент.md @@ -0,0 +1,134 @@ +--- +title: Склонение представлений объектов клиент +slug: bsp/склонение-представлений-объектов-клиент +--- + + +## ПросклонятьПредставление +
+ +Описание, пример вызова + +```bsl + +// Склоняет переданную фразу по всем падежам. +// Результат фиксируется в данных формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта склонения. +// Представление - Строка - строка для склонения. +// ПараметрыСклонения - Структура - параметры склонения, созданные методом СклонениеПредставленийОбъектовКлиентСервер.ПараметрыСклонения(). +// ПоказыватьСообщения - Булево - признак, определяющий нужно ли показывать пользователю сообщения об ошибках. +// +Процедура ПросклонятьПредставление(Форма, Представление, ПараметрыСклонения = Неопределено, ПоказыватьСообщения = Ложь) Экспорт +``` + +Пример вызова +```bsl +СклонениеПредставленийОбъектовКлиент.ПросклонятьПредставление(Форма, Представление, ПараметрыСклонения, ПоказыватьСообщения); +``` +
+ +## ПоказатьСклонение +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды "Склонения" формы объекта склонения. +// Открывает форму редактирования склонений представления по всем падежам. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта склонения. +// Представление - Строка - строка для склонения. +// ПараметрыСклонения - Структура - параметры склонения, созданные методом СклонениеПредставленийОбъектовКлиентСервер.ПараметрыСклонения(). +// +Процедура ПоказатьСклонение(Форма, Представление, ПараметрыСклонения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СклонениеПредставленийОбъектовКлиент.ПоказатьСклонение(Форма, Представление, ПараметрыСклонения); +``` +
+ +## ПриИзмененииПредставления +
+ +Описание, пример вызова + +```bsl + +// Устарела. См. СклонениеПредставленийОбъектовКлиент.ПросклонятьПредставление. +Процедура ПриИзмененииПредставления(Форма) Экспорт +``` + +Пример вызова +```bsl +СклонениеПредставленийОбъектовКлиент.ПриИзмененииПредставления(Форма) +``` +
+ +## ПросклонятьПредставлениеПоВсемПадежам +
+ +Описание, пример вызова + +```bsl + +// Устарела. См. СклонениеПредставленийОбъектовКлиент.ПросклонятьПредставление. +// Склоняет переданную фразу по всем падежам. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта склонения. +// Представление - Строка - строка для склонения. +// ЭтоФИО - Булево - признак склонения ФИО. +// Пол - Число - пол физического лица (в случае склонения ФИО) +// 1 - мужской +// 2 - женский. +// ПоказыватьСообщения - Булево - признак, определяющий нужно ли показывать пользователю сообщения об ошибках. +// +Процедура ПросклонятьПредставлениеПоВсемПадежам(Форма, Представление, ЭтоФИО = Ложь, Пол = Неопределено, ПоказыватьСообщения = Ложь) Экспорт +``` + +Пример вызова +```bsl +СклонениеПредставленийОбъектовКлиент.ПросклонятьПредставлениеПоВсемПадежам(Форма, Представление, ЭтоФИО, Пол, ПоказыватьСообщения); +``` +
+ +## ОбработатьКомандуСклонения +
+ +Описание, пример вызова + +```bsl + +// Устарела. См. СклонениеПредставленийОбъектовКлиент.ПоказатьСклонение. +// Обработчик команды "Склонения" формы объекта склонения. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта склонения. +// Представление - Строка - строка для склонения. +// ЭтоФИО - Булево - признак склонения ФИО. +// Пол - Число - пол физического лица (в случае склонения ФИО) +// 1 - мужской +// 2 - женский. +// +Процедура ОбработатьКомандуСклонения(Форма, Представление, ЭтоФИО = Ложь, Пол = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СклонениеПредставленийОбъектовКлиент.ОбработатьКомандуСклонения(Форма, Представление, ЭтоФИО, Пол); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СклонениеПредставленийОбъектовКлиентСервер.md b/src/content/docs/bsp/СклонениеПредставленийОбъектовКлиентСервер.md new file mode 100644 index 0000000..fd83485 --- /dev/null +++ b/src/content/docs/bsp/СклонениеПредставленийОбъектовКлиентСервер.md @@ -0,0 +1,36 @@ +--- +title: Склонение представлений объектов клиент сервер +slug: bsp/склонение-представлений-объектов-клиент-сервер +--- + + +## ПараметрыСклонения +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров для методов склонения. +// +// Возвращаемое значение: +// Структура: +// ЭтоФИО - Булево - признак склонения ФИО. +// Пол - Число - пол физического лица (в случае склонения ФИО): 1 - мужской, 2 - женский. +// +Функция ПараметрыСклонения() Экспорт +``` + +Пример вызова +```bsl +Результат = СклонениеПредставленийОбъектовКлиентСервер.ПараметрыСклонения() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СнимкиОтчетов.md b/src/content/docs/bsp/СнимкиОтчетов.md new file mode 100644 index 0000000..4f2f79e --- /dev/null +++ b/src/content/docs/bsp/СнимкиОтчетов.md @@ -0,0 +1,128 @@ +--- +title: Снимки отчетов +slug: bsp/снимки-отчетов +--- + + +## ЗарегистрироватьИзмененияДанных +
+ +Описание, пример вызова + +```bsl + +// Регистрирует к выгрузке все варианты отчетов, по которым сформированы снимки. +// +// Параметры: +// УзелОбмена - ПланОбменаСсылка - узел плана обмена, для которого регистрируются изменения. +// +Процедура ЗарегистрироватьИзмененияДанных(УзелОбмена) Экспорт +``` + +Пример вызова +```bsl +СнимкиОтчетов.ЗарегистрироватьИзмененияДанных(УзелОбмена) +``` +
+ +## ЕстьИзмененияДляАвтономногоРежима +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если есть снимки отчета для автономного режима. +// +// Параметры: +// Источник - СправочникОбъект +// +// Возвращаемое значение: +// Булево +// +Функция ЕстьИзмененияДляАвтономногоРежима(Источник) Экспорт +``` + +Пример вызова +```bsl +Результат = СнимкиОтчетов.ЕстьИзмененияДляАвтономногоРежима(Источник) +``` +
+ +## ЗарегистрироватьИзмененияДляАвтономногоРежима +
+ +Описание, пример вызова + +```bsl + +// Зарегистрировать к выгрузке связанные со снимками отчетов вариантов отчетов и пользователей, +// сформировавших эти снимки. +// +// Параметры: +// Источник - Произвольный +// Изменения - Массив +// +Процедура ЗарегистрироватьИзмененияДляАвтономногоРежима(Источник, Изменения) Экспорт +``` + +Пример вызова +```bsl +СнимкиОтчетов.ЗарегистрироватьИзмененияДляАвтономногоРежима(Источник, Изменения) +``` +
+ +## ЗаписатьОтчетыВXML +
+ +Описание, пример вызова + +```bsl + +// Выгружает в XML варианты отчетов, их снимки и связанные с ними сведения о пользователях. +// +// Параметры: +// ЗаписьXML - ЗаписьXML +// Данные - Произвольный - данные для записи в XML. +// +Процедура ЗаписатьОтчетыВXML(ЗаписьXML, Данные) Экспорт +``` + +Пример вызова +```bsl +СнимкиОтчетов.ЗаписатьОтчетыВXML(ЗаписьXML, Данные) +``` +
+ +## ПрочитатьОтчетыИзXML +
+ +Описание, пример вызова + +```bsl + +// Загружает из XML варианты отчетов, их снимки и связанные с ними сведения о пользователях. +// +// Параметры: +// ЧтениеXML - ЧтениеXML +// +// Возвращаемое значение: +// СправочникОбъект +// Неопределено - прочитанные данные, подготовленные для записи. +// +Функция ПрочитатьОтчетыИзXML(ЧтениеXML) Экспорт +``` + +Пример вызова +```bsl +Результат = СнимкиОтчетов.ПрочитатьОтчетыИзXML(ЧтениеXML) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СоединенияИБ.md b/src/content/docs/bsp/СоединенияИБ.md new file mode 100644 index 0000000..4ce6201 --- /dev/null +++ b/src/content/docs/bsp/СоединенияИБ.md @@ -0,0 +1,240 @@ +--- +title: Соединения ИБ +slug: bsp/соединения-иб +--- + + +## УстановитьБлокировкуСоединений +
+ +Описание, пример вызова + +```bsl + +// Устанавливает блокировку соединений ИБ. +// Если вызывается из сеанса с установленными значениями разделителей, +// то устанавливает блокировку сеансов области данных. +// +// Параметры: +// ТекстСообщения - Строка - текст, который будет частью сообщения об ошибке +// при попытке установки соединения с заблокированной +// информационной базой. +// +// КодРазрешения - Строка - строка, которая должна быть добавлена к параметру +// командной строки "/uc" или к параметру строки +// соединения "uc", чтобы установить соединение с +// информационной базой несмотря на блокировку. +// Не применимо для блокировки сеансов области данных. +// ОжиданиеНачалаБлокировки - Число - время отсрочки начала блокировки в минутах. +// ДлительностьБлокировки - Число - время длительности блокировки в минутах. +// +// Возвращаемое значение: +// Булево - Истина, если блокировка установлена успешно. +// Ложь, если для выполнения блокировки недостаточно прав. +// +Функция УстановитьБлокировкуСоединений(Знач ТекстСообщения = "", Знач КодРазрешения = "КодРазрешения", // АПК:142 Для сохранения обратной совместимости. Экспорт +``` + +Пример вызова +```bsl +Результат = СоединенияИБ.УстановитьБлокировкуСоединений(ТекстСообщения, КодРазрешения, // АПК:142 Для сохранения обратной совместимости.); +``` +
+ +## УстановленаБлокировкаСоединений +
+ +Описание, пример вызова + +```bsl + +// Определить, установлена ли блокировка соединений при пакетном +// обновлении конфигурации информационной базы. +// +// Возвращаемое значение: +// Булево - Истина, если установлена, Ложь - иначе. +// +Функция УстановленаБлокировкаСоединений() Экспорт +``` + +Пример вызова +```bsl +Результат = СоединенияИБ.УстановленаБлокировкаСоединений() +``` +
+ +## ПараметрыБлокировкиСеансов +
+ +Описание, пример вызова + +```bsl + +// Получить параметры блокировки соединений ИБ для использования на стороне клиента. +// +// Параметры: +// ПолучитьКоличествоСеансов - Булево - если Истина, то в возвращаемой структуре +// заполняется поле КоличествоСеансов. +// +// Возвращаемое значение: +// Структура: +// * Установлена - Булево - Истина, если установлена блокировка, Ложь - иначе. +// * Начало - Дата - дата начала блокировки. +// * Конец - Дата - дата окончания блокировки. +// * Сообщение - Строка - сообщение пользователю. +// * ИнтервалОжиданияЗавершенияРаботыПользователей - Число - интервал в секундах. +// * КоличествоСеансов - Число - 0, если параметр ПолучитьКоличествоСеансов = Ложь. +// * ТекущаяДатаСеанса - Дата - текущая дата сеанса. +// +Функция ПараметрыБлокировкиСеансов(Знач ПолучитьКоличествоСеансов = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = СоединенияИБ.ПараметрыБлокировкиСеансов(ПолучитьКоличествоСеансов); +``` +
+ +## РазрешитьРаботуПользователей +
+ +Описание, пример вызова + +```bsl + +// Снять блокировку информационной базы. +// +// Возвращаемое значение: +// Булево - Истина, если операция выполнена успешно. +// Ложь, если для выполнения операции недостаточно прав. +// +Функция РазрешитьРаботуПользователей() Экспорт +``` + +Пример вызова +```bsl +Результат = СоединенияИБ.РазрешитьРаботуПользователей() +``` +
+ +## ИнформацияОСоединениях +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о текущих соединениях с информационной базой. +// При необходимости записывает сообщение в журнал регистрации. +// +// Параметры: +// ПолучатьСтрокуСоединения - Булево - признак необходимости добавления в возвращаемое значение строки соединения. +// СообщенияДляЖурналаРегистрации - СписокЗначений - если параметр не пустой, то будет выполнена запись событий +// из списка в журнал регистрации. +// ПортКластера - Число - нестандартный порт кластера серверов. +// +// Возвращаемое значение: +// Структура: +// * НаличиеАктивныхСоединений - Булево - признак наличия активных соединений. +// * НаличиеCOMСоединений - Булево - признак наличия com соединений. +// * НаличиеСоединенияКонфигуратором - Булево - признак наличия соединения конфигуратора. +// * ЕстьАктивныеПользователи - Булево - признак наличия активных пользователей. +// * СтрокаСоединенияИнформационнойБазы - Строка - строка соединения информационной базы. Свойство будет, +// только если параметр ПолучатьСтрокуСоединения был +// установлен в значение Истина. +// +Функция ИнформацияОСоединениях(ПолучатьСтрокуСоединения = Ложь, Экспорт +``` + +Пример вызова +```bsl +Результат = СоединенияИБ.ИнформацияОСоединениях(ПолучатьСтрокуСоединения, ); +``` +
+ +## НовыеПараметрыБлокировкиСоединений +
+ +Описание, пример вызова + +```bsl + +// Получить пустую структуру с параметрами блокировки сеансов области данных. +// +// Возвращаемое значение: +// Структура: +// * Начало - Дата - время начала действия блокировки. +// * Конец - Дата - время завершения действия блокировки. +// * Сообщение - Строка - сообщения для пользователей, выполняющих вход в заблокированную область данных. +// * Установлена - Булево - признак того, что блокировка установлена. +// * Эксклюзивная - Булево - блокировка не может быть изменена администратором приложения. +// +Функция НовыеПараметрыБлокировкиСоединений() Экспорт +``` + +Пример вызова +```bsl +Результат = СоединенияИБ.НовыеПараметрыБлокировкиСоединений() +``` +
+ +## УстановитьБлокировкуСеансовОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Установить блокировку сеансов области данных. +// +// Параметры: +// Параметры - см. НовыеПараметрыБлокировкиСоединений +// ПоМестномуВремени - Булево - время начала и окончания блокировки указаны в местном времени сеанса. +// Если Ложь, то в универсальном времени. +// ОбластьДанных - Число - номер области данных, для которой устанавливается блокировка. +// При вызове из сеанса, в котором заданы значения разделителей, может быть передано только значение, +// совпадающее со значением разделителя в сеансе (или опущено). +// При вызове из сеанса, в котором не заданы значения разделителей, значение параметра не может быть опущено. +// +Процедура УстановитьБлокировкуСеансовОбластиДанных(Знач Параметры, Знач ПоМестномуВремени = Истина, Знач ОбластьДанных = -1) Экспорт +``` + +Пример вызова +```bsl +СоединенияИБ.УстановитьБлокировкуСеансовОбластиДанных(Параметры, ПоМестномуВремени, ОбластьДанных); +``` +
+ +## ПолучитьБлокировкуСеансовОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Получить информацию о блокировке сеансов области данных. +// +// Параметры: +// ПоМестномуВремени - Булево - время начала и окончания блокировки необходимо вернуть +// в местном времени сеанса. Если Ложь, то +// возвращается в универсальном времени. +// +// Возвращаемое значение: +// см. НовыеПараметрыБлокировкиСоединений. +// +Функция ПолучитьБлокировкуСеансовОбластиДанных(Знач ПоМестномуВремени = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = СоединенияИБ.ПолучитьБлокировкуСеансовОбластиДанных(ПоМестномуВремени); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СоединенияИБКлиент.md b/src/content/docs/bsp/СоединенияИБКлиент.md new file mode 100644 index 0000000..cd8b128 --- /dev/null +++ b/src/content/docs/bsp/СоединенияИБКлиент.md @@ -0,0 +1,89 @@ +--- +title: Соединения иб клиент +slug: bsp/соединения-иб-клиент +--- + + +## ПоказатьПараметрыАдминистрирования +
+ +Описание, пример вызова + +```bsl + +// Открывает форму ввода параметров администрирования информационной базы и/или кластера. +// +// Параметры: +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - обработчик, который будет вызван после ввода параметров +// администрирования. +// ЗапрашиватьПараметрыАдминистрированияИБ - Булево - признак необходимости ввода параметров администрирования +// информационной базы. +// ЗапрашиватьПараметрыАдминистрированияКластера - Булево - признак необходимости ввода параметров администрирования +// кластера. +// ПараметрыАдминистрирования - см. СтандартныеПодсистемыСервер.ПараметрыАдминистрирования. +// Заголовок - Строка - заголовок формы, описывающий для чего запрашиваются параметры администрирования. +// ПоясняющаяНадпись - Строка - пояснение для выполняемого действия, в контексте которого запрашиваются параметры. +// +Процедура ПоказатьПараметрыАдминистрирования(ОписаниеОповещенияОЗакрытии, ЗапрашиватьПараметрыАдминистрированияИБ, Экспорт +``` + +Пример вызова +```bsl +СоединенияИБКлиент.ПоказатьПараметрыАдминистрирования(ОписаниеОповещенияОЗакрытии, ЗапрашиватьПараметрыАдминистрированияИБ, ); +``` +
+ +## УстановитьРежимЗавершенияРаботыПользователей +
+ +Описание, пример вызова + +```bsl + +// Устанавливает и отключает режим завершения работы пользователей в программе. +// При завершении работы, до наступления момента блокировки, всем активным пользователям +// будет выводиться уведомление о планируемом завершении работы программы и рекомендацией +// сохранить все свои данные. +// Текущий сеанс завершается последним. +// +// Параметры: +// ЗавершитьРаботу - Булево. +// +Процедура УстановитьРежимЗавершенияРаботыПользователей(Знач ЗавершитьРаботу) Экспорт +``` + +Пример вызова +```bsl +СоединенияИБКлиент.УстановитьРежимЗавершенияРаботыПользователей(ЗавершитьРаботу) +``` +
+ +## УстановитьПризнакЗавершитьВсеСеансыКромеТекущего +
+ +Описание, пример вызова + +```bsl + +// Позволяет отметить необходимость завершения работы сеанса, включившего блокировку работы +// пользователей в программе. +// +// Параметры: +// Значение - Булево - Истина, если если текущий сеанс завершать не требуется. +// +Процедура УстановитьПризнакЗавершитьВсеСеансыКромеТекущего(Значение) Экспорт +``` + +Пример вызова +```bsl +СоединенияИБКлиент.УстановитьПризнакЗавершитьВсеСеансыКромеТекущего(Значение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СоединенияИБПереопределяемый.md b/src/content/docs/bsp/СоединенияИБПереопределяемый.md new file mode 100644 index 0000000..82c19a6 --- /dev/null +++ b/src/content/docs/bsp/СоединенияИБПереопределяемый.md @@ -0,0 +1,34 @@ +--- +title: Соединения иб переопределяемый +slug: bsp/соединения-иб-переопределяемый +--- + + +## ПриОпределенииПараметровБлокировкиСеансов +
+ +Описание, пример вызова + +```bsl + +// Позволяет модифицировать параметры блокировки сеансов. +// +// Параметры: +// ПараметрыБлокировкиСеансов - см. СоединенияИБ.ПараметрыБлокировкиСеансов +// +Процедура ПриОпределенииПараметровБлокировкиСеансов(ПараметрыБлокировкиСеансов) Экспорт +``` + +Пример вызова +```bsl +СоединенияИБПереопределяемый.ПриОпределенииПараметровБлокировкиСеансов(ПараметрыБлокировкиСеансов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СозданиеНаОсновании.md b/src/content/docs/bsp/СозданиеНаОсновании.md new file mode 100644 index 0000000..eb921c8 --- /dev/null +++ b/src/content/docs/bsp/СозданиеНаОсновании.md @@ -0,0 +1,38 @@ +--- +title: Создание на основании +slug: bsp/создание-на-основании +--- + + +## ДобавитьКомандуСозданияНаОсновании +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список команд создания на основании команду создания указанного объекта. +// +// Параметры: +// КомандыСозданияНаОсновании - см. СозданиеНаОснованииПереопределяемый.ПередДобавлениемКомандСозданияНаОсновании.КомандыСозданияНаОсновании +// ОбъектМетаданных - ОбъектМетаданных - объект, для которого добавляется команда. +// +// Возвращаемое значение: +// СтрокаТаблицыЗначений, Неопределено - описание добавленной команды. +// +Функция ДобавитьКомандуСозданияНаОсновании(КомандыСозданияНаОсновании, ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = СозданиеНаОсновании.ДобавитьКомандуСозданияНаОсновании(КомандыСозданияНаОсновании, ОбъектМетаданных) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СозданиеНаОснованииПереопределяемый.md b/src/content/docs/bsp/СозданиеНаОснованииПереопределяемый.md new file mode 100644 index 0000000..b5dd86b --- /dev/null +++ b/src/content/docs/bsp/СозданиеНаОснованииПереопределяемый.md @@ -0,0 +1,173 @@ +--- +title: Создание на основании переопределяемый +slug: bsp/создание-на-основании-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Переопределяет настройки команд ввода на основании. +// +// Параметры: +// Настройки - Структура: +// * ИспользоватьКомандыВводаНаОсновании - Булево - разрешает использование программных команд ввода на основании +// вместо штатных. Значение по умолчанию: Истина. +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +СозданиеНаОснованииПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриОпределенииОбъектовСКомандамиСозданияНаОсновании +
+ +Описание, пример вызова + +```bsl + +// Определяет список объектов конфигурации, в модулях менеджеров которых предусмотрена процедура +// ДобавитьКомандыСозданияНаОсновании, формирующая команды создания на основании объектов. +// Синтаксис процедуры ДобавитьКомандыСозданияНаОсновании см. в документации. +// +// Параметры: +// Объекты - Массив - объекты метаданных (ОбъектМетаданных) с командами создания на основании. +// +// Пример: +// Объекты.Добавить(Метаданные.Справочники.Организации); +// +Процедура ПриОпределенииОбъектовСКомандамиСозданияНаОсновании(Объекты) Экспорт +``` + +Пример вызова +```bsl +СозданиеНаОснованииПереопределяемый.ПриОпределенииОбъектовСКомандамиСозданияНаОсновании(Объекты) +``` +
+ +## ПередДобавлениемКомандСозданияНаОсновании +
+ +Описание, пример вызова + +```bsl + +// Вызывается для формирования списка команд создания на основании КомандыСозданияНаОсновании, однократно для при первой +// необходимости, а затем результат кэшируется с помощью модуля с повторным использованием возвращаемых значений. +// Здесь можно определить команды создания на основании, общие для большинства объектов конфигурации. +// +// Параметры: +// КомандыСозданияНаОсновании - ТаблицаЗначений - сформированные команды для вывода в подменю: +// +// Общие настройки: +// * Идентификатор - Строка - идентификатор команды. +// +// Настройки внешнего вида: +// * Представление - Строка - представление команды в форме. +// * Важность - Строка - группа в подменю, в которой следует вывести эту команду. +// Допустимо использовать: "Важное", "Обычное" и "СмТакже". +// * Порядок - Число - порядок размещения команды в подменю. Используется для настройки под конкретное +// рабочее место. +// * Картинка - Картинка - картинка команды. +// +// Настройки видимости и доступности: +// * ТипПараметра - ОписаниеТипов - типы объектов, для которых предназначена эта команда. +// * ВидимостьВФормах - Строка - имена форм через запятую, в которых должна отображаться команда. +// Используется когда состав команд отличается для различных форм. +// * ФункциональныеОпции - Строка - имена функциональных опций через запятую, определяющих видимость команды. +// * УсловияВидимости - Массив - определяет видимость команды в зависимости от контекста. +// Для регистрации условий следует использовать процедуру +// ПодключаемыеКоманды.ДобавитьУсловиеВидимостиКоманды(). +// Условия объединяются по "И". +// * ИзменяетВыбранныеОбъекты - Булево - определяет доступность команды в ситуации, +// когда у пользователя нет прав на изменение объекта. +// Если Истина, то в описанной выше ситуации кнопка будет недоступна. +// Необязательный. Значение по умолчанию: Ложь. +// +// Настройки процесса выполнения: +// * МножественныйВыбор - Булево +// - Неопределено - если Истина, то команда поддерживает множественный выбор. +// В этом случае в параметре выполнения будет передан список ссылок. +// Необязательный. Значение по умолчанию: Ложь. +// * РежимЗаписи - Строка - действия, связанные с записью объекта, которые выполняются перед обработчиком команды. +// "НеЗаписывать" - Объект не записывается, а в параметрах обработчика вместо ссылок передается +// вся форма. В этом режиме рекомендуется работать напрямую с формой, +// которая передается в структуре 2 параметра обработчика команды. +// "ЗаписыватьТолькоНовые" - Записывать новые объекты. +// "Записывать" - Записывать новые и модифицированные объекты. +// "Проводить" - Проводить документы. +// Перед записью и проведением у пользователя запрашивается подтверждение. +// Необязательный. Значение по умолчанию: "Записывать". +// * ТребуетсяРаботаСФайлами - Булево - если Истина, то в веб-клиенте предлагается +// установить расширение для работы с 1С:Предприятием. +// Необязательный. Значение по умолчанию: Ложь. +// +// Настройки обработчика: +// * Менеджер - Строка - объект, отвечающий за выполнение команды. +// * ИмяФормы - Строка - имя формы, которую требуется получить для выполнения команды. +// Если Обработчик не указан, то у формы вызывается метод "Открыть". +// * ПараметрыФормы - Неопределено +// - ФиксированнаяСтруктура - необязательный. Параметры формы, указанной в ИмяФормы. +// * Обработчик - Строка - описание процедуры, обрабатывающей основное действие команды. +// Формат "<ИмяОбщегоМодуля>.<ИмяПроцедуры>" используется когда процедура размещена в общем модуле. +// Формат "<ИмяПроцедуры>" используется в следующих случаях: +// 1) если ИмяФормы заполнено то в модуле указанной формы ожидается клиентская процедура. +// 2) если ИмяФормы не заполнено то в модуле менеджера этого объекта ожидается серверная процедура. +// * ДополнительныеПараметры - ФиксированнаяСтруктура - необязательный. Параметры обработчика, указанного в Обработчик. +// +// Параметры - Структура - сведения о контексте исполнения: +// * ИмяФормы - Строка - полное имя формы. +// +// СтандартнаяОбработка - Булево - если установить в Ложь, то событие "ДобавитьКомандыСозданияНаОсновании" менеджера +// объекта не будет вызвано. +// +Процедура ПередДобавлениемКомандСозданияНаОсновании(КомандыСозданияНаОсновании, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +СозданиеНаОснованииПереопределяемый.ПередДобавлениемКомандСозданияНаОсновании(КомандыСозданияНаОсновании, Параметры, СтандартнаяОбработка) +``` +
+ +## ПриДобавленииКомандСозданияНаОсновании +
+ +Описание, пример вызова + +```bsl + +// Определяет список команд создания на основании. Вызывается перед вызовом "ДобавитьКомандыСозданияНаОсновании" модуля +// менеджера объекта. +// +// Параметры: +// Объект - ОбъектМетаданных - объект, для которого добавляются команды. +// КомандыСозданияНаОсновании - см. СозданиеНаОснованииПереопределяемый.ПередДобавлениемКомандСозданияНаОсновании.КомандыСозданияНаОсновании +// Параметры - см. СозданиеНаОснованииПереопределяемый.ПередДобавлениемКомандСозданияНаОсновании.Параметры +// СтандартнаяОбработка - Булево - если установить в Ложь, то событие "ДобавитьКомандыСозданияНаОсновании" менеджера +// объекта не будет вызвано. +// +Процедура ПриДобавленииКомандСозданияНаОсновании(Объект, КомандыСозданияНаОсновании, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +СозданиеНаОснованииПереопределяемый.ПриДобавленииКомандСозданияНаОсновании(Объект, КомандыСозданияНаОсновании, Параметры, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.md b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.md new file mode 100644 index 0000000..e5893f3 --- /dev/null +++ b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.md @@ -0,0 +1,343 @@ +--- +title: Сообщения администрирование обмена данными контроль интерфейс +slug: bsp/сообщения-администрирование-обмена-данными-контроль-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Текущая (используемая вызывающим кодом) версия интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - версия интерфейса сообщений. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Название программного интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - название программного интерфейса сообщений. +// +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// +// Параметры: +// МассивОбработчиков - Массив из ОбщийМодуль - коллекция модулей, содержащих обработчики. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// +// Параметры: +// МассивОбработчиков - Массив из ОбщийМодуль - коллекция модулей, содержащих обработчики. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеКорреспондентУспешноПодключен +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Control/a.b.c.d}CorrespondentConnectionCompleted +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеКорреспондентУспешноПодключен(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.СообщениеКорреспондентУспешноПодключен(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаПодключенияКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Control/a.b.c.d}CorrespondentConnectionFailed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОшибкаПодключенияКорреспондента(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.СообщениеОшибкаПодключенияКорреспондента(ИспользуемыйПакет); +``` +
+ +## СообщениеНастройкиСинхронизацииДанныхПолучены +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Control/a.b.c.d}GettingSyncSettingsCompleted +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеНастройкиСинхронизацииДанныхПолучены(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.СообщениеНастройкиСинхронизацииДанныхПолучены(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаПолученияНастроекСинхронизацииДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Control/a.b.c.d}GettingSyncSettingsFailed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОшибкаПолученияНастроекСинхронизацииДанных(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.СообщениеОшибкаПолученияНастроекСинхронизацииДанных(ИспользуемыйПакет); +``` +
+ +## СообщениеВключениеСинхронизацииУспешноЗавершено +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Control/a.b.c.d}EnableSyncCompleted +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеВключениеСинхронизацииУспешноЗавершено(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.СообщениеВключениеСинхронизацииУспешноЗавершено(ИспользуемыйПакет); +``` +
+ +## СообщениеСинхронизацияУспешноОтключена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Control/a.b.c.d}DisableSyncCompleted +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеСинхронизацияУспешноОтключена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.СообщениеСинхронизацияУспешноОтключена(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаВключенияСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Control/a.b.c.d}EnableSyncFailed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОшибкаВключенияСинхронизации(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.СообщениеОшибкаВключенияСинхронизации(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаОтключенияСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Control/a.b.c.d}DisableSyncFailed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОшибкаОтключенияСинхронизации(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.СообщениеОшибкаОтключенияСинхронизации(ИспользуемыйПакет); +``` +
+ +## СообщениеСинхронизацияЗавершена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Control/a.b.c.d}SyncCompleted +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеСинхронизацияЗавершена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольИнтерфейс.СообщениеСинхронизацияЗавершена(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.md b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.md new file mode 100644 index 0000000..7ecdc1d --- /dev/null +++ b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.md @@ -0,0 +1,100 @@ +--- +title: Сообщения администрирование обмена данными контроль обработчик сообщения_2_1_2_1 +slug: bsp/сообщения-администрирование-обмена-данными-контроль-обработчик-сообщения-2-1-2-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Пространство имен версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Версия интерфейса сообщений, обслуживаемая обработчиком. +// +// Возвращаемое значение: +// Строка - версия интерфейса сообщений. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Базовый тип для сообщений версии. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - базовый тип тела сообщения. +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение. +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения. +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.md b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.md new file mode 100644 index 0000000..e8bc168 --- /dev/null +++ b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.md @@ -0,0 +1,368 @@ +--- +title: Сообщения администрирование обмена данными управление интерфейс +slug: bsp/сообщения-администрирование-обмена-данными-управление-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Текущая (используемая вызывающим кодом) версия интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - версия интерфейса сообщений. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Название программного интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - название программного интерфейса сообщений. +// +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// +// Параметры: +// МассивОбработчиков - Массив из ОбщийМодуль - коллекция модулей, содержащих обработчики. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// +// Параметры: +// МассивОбработчиков - Массив из ОбщийМодуль - коллекция модулей, содержащих обработчики. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеПодключитьКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}ConnectCorrespondent +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеПодключитьКорреспондента(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.СообщениеПодключитьКорреспондента(ИспользуемыйПакет); +``` +
+ +## СообщениеУстановитьНастройкиТранспорта +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}SetTransportParams +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеУстановитьНастройкиТранспорта(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.СообщениеУстановитьНастройкиТранспорта(ИспользуемыйПакет); +``` +
+ +## СообщениеПолучитьНастройкиСинхронизацииДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}GetSyncSettings +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеПолучитьНастройкиСинхронизацииДанных(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.СообщениеПолучитьНастройкиСинхронизацииДанных(ИспользуемыйПакет); +``` +
+ +## СообщениеУдалитьНастройкуСинхронизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}DeleteSync +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеУдалитьНастройкуСинхронизации(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.СообщениеУдалитьНастройкуСинхронизации(ИспользуемыйПакет); +``` +
+ +## СообщениеВключитьСинхронизацию +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}EnableSync +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеВключитьСинхронизацию(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.СообщениеВключитьСинхронизацию(ИспользуемыйПакет); +``` +
+ +## СообщениеОтключитьСинхронизацию +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}DisableSync +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОтключитьСинхронизацию(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.СообщениеОтключитьСинхронизацию(ИспользуемыйПакет); +``` +
+ +## СообщениеПротолкнутьСинхронизацию +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}PushSync +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеПротолкнутьСинхронизацию(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.СообщениеПротолкнутьСинхронизацию(ИспользуемыйПакет); +``` +
+ +## СообщениеПротолкнутьСинхронизациюДвухПриложений +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}PushTwoApplicationSync +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеПротолкнутьСинхронизациюДвухПриложений(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.СообщениеПротолкнутьСинхронизациюДвухПриложений(ИспользуемыйПакет); +``` +
+ +## СообщениеВыполнитьСинхронизацию +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}ExecuteSync +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеВыполнитьСинхронизацию(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.СообщениеВыполнитьСинхронизацию(ИспользуемыйПакет); +``` +
+ +## СообщениеОтключитьСинхронизациюЧерезМС +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}DisableSyncInSM +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO +// +Функция СообщениеОтключитьСинхронизациюЧерезМС(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеИнтерфейс.СообщениеОтключитьСинхронизациюЧерезМС(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.md b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.md new file mode 100644 index 0000000..02c55c9 --- /dev/null +++ b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.md @@ -0,0 +1,100 @@ +--- +title: Сообщения администрирование обмена данными управление обработчик сообщения_2_1_2_1 +slug: bsp/сообщения-администрирование-обмена-данными-управление-обработчик-сообщения-2-1-2-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Пространство имен версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Версия интерфейса сообщений, обслуживаемая обработчиком. +// +// Возвращаемое значение: +// Строка - версия интерфейса сообщений. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Базовый тип для сообщений версии. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - базовый тип тела сообщения. +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение. +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения. +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.md b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.md new file mode 100644 index 0000000..21aa404 --- /dev/null +++ b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.md @@ -0,0 +1,100 @@ +--- +title: Сообщения администрирование обмена данными управление обработчик сообщения_3_0_1_1 +slug: bsp/сообщения-администрирование-обмена-данными-управление-обработчик-сообщения-3-0-1-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Пространство имен версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Версия интерфейса сообщений, обслуживаемая обработчиком. +// +// Возвращаемое значение: +// Строка - версия интерфейса сообщений. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Базовый тип для сообщений версии. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - базовый тип тела сообщения. +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение. +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения. +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеТрансляция_2_1_2_1.md b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеТрансляция_2_1_2_1.md new file mode 100644 index 0000000..6bbab3c --- /dev/null +++ b/src/content/docs/bsp/СообщенияАдминистрированиеОбменаДаннымиУправлениеТрансляция_2_1_2_1.md @@ -0,0 +1,148 @@ +--- +title: Сообщения администрирование обмена данными управление трансляция_2_1_2_1 +slug: bsp/сообщения-администрирование-обмена-данными-управление-трансляция-2-1-2-1 +--- + + +## ИсходнаяВерсия +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер версии, для трансляции с которой предназначен обработчик. +// +// Возвращаемое значение: +// Строка +// +Функция ИсходнаяВерсия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеТрансляция_2_1_2_1.ИсходнаяВерсия() +``` +
+ +## ПакетИсходнойВерсии +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии, для трансляции с которой предназначен обработчик. +// +// Возвращаемое значение: +// Строка +// +Функция ПакетИсходнойВерсии() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеТрансляция_2_1_2_1.ПакетИсходнойВерсии() +``` +
+ +## РезультирующаяВерсия +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер версии, для трансляции в которую предназначен обработчик. +// +// Возвращаемое значение: +// Строка +// +Функция РезультирующаяВерсия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеТрансляция_2_1_2_1.РезультирующаяВерсия() +``` +
+ +## ПакетРезультирующейВерсии +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии, для трансляции в которую предназначен обработчик. +// +// Возвращаемое значение: +// Строка +// +Функция ПакетРезультирующейВерсии() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеТрансляция_2_1_2_1.ПакетРезультирующейВерсии() +``` +
+ +## ПередТрансляцией +
+ +Описание, пример вызова + +```bsl + +// Обработчик проверки выполнения стандартной обработки трансляции +// +// Параметры: +// ИсходноеСообщение - ОбъектXDTO - транслируемое сообщение, +// СтандартнаяОбработка - Булево - для отмены выполнения стандартной обработки трансляции +// этому параметру внутри данной процедуры необходимо установить значение Ложь. +// При этом вместо выполнения стандартной обработки трансляции будет вызвана функция +// ТрансляцияСообщения() обработчика трансляции. +// +Процедура ПередТрансляцией(Знач ИсходноеСообщение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеОбменаДаннымиУправлениеТрансляция_2_1_2_1.ПередТрансляцией(ИсходноеСообщение, СтандартнаяОбработка) +``` +
+ +## ТрансляцияСообщения +
+ +Описание, пример вызова + +```bsl + +// Обработчик выполнения произвольной трансляции сообщения. Вызывается только в том случае, +// если при выполнении процедуры ПередТрансляцией значению параметра СтандартнаяОбработка +// было установлено значение Ложь. +// +// Параметры: +// ИсходноеСообщение - ОбъектXDTO - транслируемое сообщение. +// +// Возвращаемое значение: +// ОбъектXDTO - результат произвольной трансляции сообщения. +// +Функция ТрансляцияСообщения(Знач ИсходноеСообщение) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеОбменаДаннымиУправлениеТрансляция_2_1_2_1.ТрансляцияСообщения(ИсходноеСообщение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.md b/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.md new file mode 100644 index 0000000..8a624e4 --- /dev/null +++ b/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.md @@ -0,0 +1,226 @@ +--- +title: Сообщения администрирование сводные приложения контроль интерфейс +slug: bsp/сообщения-администрирование-сводные-приложения-контроль-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую (используемую вызывающим кодом) версию интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - версия интерфейса. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Возвращает название программного интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - название интерфейса. +// +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеНастройкаВыгрузкиВСводноеПриложениеВыполнена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ControlSynopticExchange/a.b.c.d}SynopticExchangePrepared +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO +// +Функция СообщениеНастройкаВыгрузкиВСводноеПриложениеВыполнена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.СообщениеНастройкаВыгрузкиВСводноеПриложениеВыполнена(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаНастройкиВыгрузкиВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ControlSynopticExchange/a.b.c.d}SynopticExchangeFailed +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO +// +Функция СообщениеОшибкаНастройкиВыгрузкиВСводноеПриложение(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.СообщениеОшибкаНастройкиВыгрузкиВСводноеПриложение(ИспользуемыйПакет); +``` +
+ +## СообщениеНастройкаВыгрузкиВСводноеПриложениеУдалена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ControlSynopticExchange/a.b.c.d}SynopticExchangeDeleted +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO +// +Функция СообщениеНастройкаВыгрузкиВСводноеПриложениеУдалена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.СообщениеНастройкаВыгрузкиВСводноеПриложениеУдалена(ИспользуемыйПакет); +``` +
+ +## СообщениеИнтерактивныйЗапускВыгрузкиВСводноеПриложениеВыполнен +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ControlSynopticExchange/a.b.c.d}SynopticExchangePushed +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO +// +Функция СообщениеИнтерактивныйЗапускВыгрузкиВСводноеПриложениеВыполнен(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияКонтрольИнтерфейс.СообщениеИнтерактивныйЗапускВыгрузкиВСводноеПриложениеВыполнен(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.md b/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.md new file mode 100644 index 0000000..e41bf78 --- /dev/null +++ b/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.md @@ -0,0 +1,227 @@ +--- +title: Сообщения администрирование сводные приложения управление интерфейс +slug: bsp/сообщения-администрирование-сводные-приложения-управление-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - наименование пакета. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую (используемую вызывающим кодом) версию интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - версия пакета. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Возвращает название программного интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - идентификатор программного интерфейса. +// +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеНастроитьВыгрузкуВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}SetCorrSynopticExchange +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO +// +Функция СообщениеНастроитьВыгрузкуВСводноеПриложение(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.СообщениеНастроитьВыгрузкуВСводноеПриложение(ИспользуемыйПакет); +``` +
+ +## СообщениеНастроитьЗагрузкуВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}SetSynopticExchange +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO +// +Функция СообщениеНастроитьЗагрузкуВСводноеПриложение(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.СообщениеНастроитьЗагрузкуВСводноеПриложение(ИспользуемыйПакет); +``` +
+ +## СообщениеИнтерактивныйЗапускВыгрузкиВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}PushSynopticExchangeStep1 +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO +// +Функция СообщениеИнтерактивныйЗапускВыгрузкиВСводноеПриложение(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.СообщениеИнтерактивныйЗапускВыгрузкиВСводноеПриложение(ИспользуемыйПакет); +``` +
+ +## СообщениеИнтерактивныйЗапускЗагрузкиВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ExchangeAdministration/Manage/a.b.c.d}PushSynopticExchangeStep2 +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO +// +Функция СообщениеИнтерактивныйЗапускЗагрузкиВСводноеПриложение(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияУправлениеИнтерфейс.СообщениеИнтерактивныйЗапускЗагрузкиВСводноеПриложение(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияУправлениеОбработчикСообщения_1_0_0_1.md b/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияУправлениеОбработчикСообщения_1_0_0_1.md new file mode 100644 index 0000000..e9470dc --- /dev/null +++ b/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияУправлениеОбработчикСообщения_1_0_0_1.md @@ -0,0 +1,104 @@ +--- +title: Сообщения администрирование сводные приложения управление обработчик сообщения_1_0_0_1 +slug: bsp/сообщения-администрирование-сводные-приложения-управление-обработчик-сообщения-1-0-0-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - наименование пакета. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияУправлениеОбработчикСообщения_1_0_0_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию интерфейса сообщений, обслуживаемую обработчиком. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка -версия пакета. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияУправлениеОбработчикСообщения_1_0_0_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Возвращает базовый тип для сообщений версии. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - базовый тип тел сообщений в модели сервиса. +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияАдминистрированиеСводныеПриложенияУправлениеОбработчикСообщения_1_0_0_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение, +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения. +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеСводныеПриложенияУправлениеОбработчикСообщения_1_0_0_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияУправлениеРеализация.md b/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияУправлениеРеализация.md new file mode 100644 index 0000000..1a8c359 --- /dev/null +++ b/src/content/docs/bsp/СообщенияАдминистрированиеСводныеПриложенияУправлениеРеализация.md @@ -0,0 +1,105 @@ +--- +title: Сообщения администрирование сводные приложения управление реализация +slug: bsp/сообщения-администрирование-сводные-приложения-управление-реализация +--- + + +## НастроитьЗагрузкуВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/1cFresh/ManageSynopticExchange/a.b.c.d}SetSynopticExchange. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КодОбластиДанных - Число - код области данных, +// Параметры - Структура - идентификатор резервной копии, +// +Процедура НастроитьЗагрузкуВСводноеПриложение(КодОбластиДанных, Параметры) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеСводныеПриложенияУправлениеРеализация.НастроитьЗагрузкуВСводноеПриложение(КодОбластиДанных, Параметры) +``` +
+ +## НастроитьВыгрузкуВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/1cFresh/ManageSynopticExchange/a.b.c.d}SetCorrSynopticExchange. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КодОбластиДанных - Число - код области данных, +// Параметры - Структура - идентификатор резервной копии, +// +Процедура НастроитьВыгрузкуВСводноеПриложение(КодОбластиДанных, Параметры) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеСводныеПриложенияУправлениеРеализация.НастроитьВыгрузкуВСводноеПриложение(КодОбластиДанных, Параметры) +``` +
+ +## ИнтерактивныйЗапускВыгрузкиВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/1cFresh/ManageSynopticExchange/a.b.c.d}PushSynopticExchangeStep1. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КодОбластиДанных - Число - код области данных, +// Параметры - Структура - идентификатор резервной копии, +// +Процедура ИнтерактивныйЗапускВыгрузкиВСводноеПриложение(КодОбластиДанных, Параметры) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеСводныеПриложенияУправлениеРеализация.ИнтерактивныйЗапускВыгрузкиВСводноеПриложение(КодОбластиДанных, Параметры) +``` +
+ +## ИнтерактивныйЗапускЗагрузкиВСводноеПриложение +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/1cFresh/ManageSynopticExchange/a.b.c.d}PushSynopticExchangeStep2. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КодОбластиДанных - Число - код области данных, +// Параметры - Структура - идентификатор резервной копии, +// +Процедура ИнтерактивныйЗапускЗагрузкиВСводноеПриложение(КодОбластиДанных, Параметры) Экспорт +``` + +Пример вызова +```bsl +СообщенияАдминистрированиеСводныеПриложенияУправлениеРеализация.ИнтерактивныйЗапускЗагрузкиВСводноеПриложение(КодОбластиДанных, Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияВМоделиСервиса.md b/src/content/docs/bsp/СообщенияВМоделиСервиса.md new file mode 100644 index 0000000..ffaf42f --- /dev/null +++ b/src/content/docs/bsp/СообщенияВМоделиСервиса.md @@ -0,0 +1,129 @@ +--- +title: Сообщения в модели сервиса +slug: bsp/сообщения-в-модели-сервиса +--- + + +## НовоеСообщение +
+ +Описание, пример вызова + +```bsl + +// Возвращает новое сообщение. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ТипТелаСообщения - ТипОбъектаXDTO - тип тела сообщения которое требуется создать. +// +// Возвращаемое значение: +// ОбъектXDTO - объект требуемого типа. +// +Функция НовоеСообщение(Знач ТипТелаСообщения) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияВМоделиСервиса.НовоеСообщение(ТипТелаСообщения) +``` +
+ +## ОтправитьСообщение +
+ +Описание, пример вызова + +```bsl + +// Отправляет сообщение +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Сообщение - ОбъектXDTO - сообщение. +// Получатель - ПланОбменаСсылка.ОбменСообщениями - получатель сообщения. +// Сейчас - Булево - отправить сообщений через механизм быстрых сообщений. +// +Процедура ОтправитьСообщение(Знач Сообщение, Знач Получатель = Неопределено, Экспорт +``` + +Пример вызова +```bsl +СообщенияВМоделиСервиса.ОтправитьСообщение(Сообщение, Получатель, ); +``` +
+ +## ПолучитьОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Получает список обработчиков сообщений по пространству имен. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Обработчики - ТаблицаЗначений - с колонками: +// * Канал - Строка - Канал сообщения. +// * Обработчик - ОбщийМодуль - Обработчик сообщения. +// ПространствоИмен - Строка - uri пространства имен в котором определены типы тел сообщений. +// ОбщийМодуль - ОбщийМодуль - Общий модуль в котором содержатся обработчики сообщений. +// +Процедура ПолучитьОбработчикиКаналовСообщений(Знач Обработчики, Экспорт +``` + +Пример вызова +```bsl +СообщенияВМоделиСервиса.ПолучитьОбработчикиКаналовСообщений(Обработчики, ); +``` +
+ +## ДоставитьБыстрыеСообщения +
+ +Описание, пример вызова + +```bsl + +// Выполняет доставку быстрых сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +Процедура ДоставитьБыстрыеСообщения() Экспорт +``` + +Пример вызова +```bsl +СообщенияВМоделиСервиса.ДоставитьБыстрыеСообщения() +``` +
+ +## ТипТело +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип, являющийся базовым для всех типов тел сообщений в модели сервиса. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - базовый тип тел сообщений в модели сервиса. +// +Функция ТипТело() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияВМоделиСервиса.ТипТело() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияВМоделиСервисаПереопределяемый.md b/src/content/docs/bsp/СообщенияВМоделиСервисаПереопределяемый.md new file mode 100644 index 0000000..9ea5be5 --- /dev/null +++ b/src/content/docs/bsp/СообщенияВМоделиСервисаПереопределяемый.md @@ -0,0 +1,142 @@ +--- +title: Сообщения в модели сервиса переопределяемый +slug: bsp/сообщения-в-модели-сервиса-переопределяемый +--- + + +## ПриПолученииСообщения +
+ +Описание, пример вызова + +```bsl + +// Обработчик события при получении сообщения. +// Обработчик данного события вызывается при получении сообщения из XML-потока. +// Обработчик вызывается для каждого получаемого сообщения. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// КаналСообщений - Строка - идентификатор канала сообщений, из которого получено сообщение. +// ТелоСообщения - Произвольный - Тело полученного сообщения. В обработчике события тело +// сообщения может быть изменено, например, дополнено информацией. +// ОбъектСообщения - Произвольный - Объект получаемого сообщения. +// +Процедура ПриПолученииСообщения(КаналСообщений, ТелоСообщения, ОбъектСообщения) Экспорт +``` + +Пример вызова +```bsl +СообщенияВМоделиСервисаПереопределяемый.ПриПолученииСообщения(КаналСообщений, ТелоСообщения, ОбъектСообщения) +``` +
+ +## ПриОтправкеСообщения +
+ +Описание, пример вызова + +```bsl + +// Обработчик события при отправке сообщения. +// Обработчик данного события вызывается перед помещением сообщения в XML-поток. +// Обработчик вызывается для каждого отправляемого сообщения. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// КаналСообщений - Строка - идентификатор канала сообщений, в который отправляется сообщение. +// ТелоСообщения - Произвольный - тело отправляемого сообщения. В обработчике события тело сообщения +// может быть изменено, например, дополнено информацией. +// ОбъектСообщения - Произвольный - Объект отправляемого сообщения. +// +Процедура ПриОтправкеСообщения(КаналСообщений, ТелоСообщения, ОбъектСообщения) Экспорт +``` + +Пример вызова +```bsl +СообщенияВМоделиСервисаПереопределяемый.ПриОтправкеСообщения(КаналСообщений, ТелоСообщения, ОбъектСообщения) +``` +
+ +## ПриНачалеОбработкиСообщения +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при начале обработки входящего сообщения. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение, +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующей +// информационной базе, отправившей сообщение. +// +Процедура ПриНачалеОбработкиСообщения(Знач Сообщение, Знач Отправитель) Экспорт +``` + +Пример вызова +```bsl +СообщенияВМоделиСервисаПереопределяемый.ПриНачалеОбработкиСообщения(Сообщение, Отправитель) +``` +
+ +## ПослеОбработкиСообщения +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается после обработки входящего сообщения. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение, +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующей +// информационной базе, отправившей сообщение, +// СообщениеОбработано - Булево - Флаг того, что сообщение было успешно обработано. Если значение +// установлено равным Ложь - после выполнения этой процедуры будет вызвано исключение. В данной +// процедуре значение данного параметра может быть изменено. +// +Процедура ПослеОбработкиСообщения(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияВМоделиСервисаПереопределяемый.ПослеОбработкиСообщения(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +## ПриОшибкеОбработкиСообщения +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при возникновении ошибки обработки сообщения. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение, +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующей +// информационной базе, отправившей сообщение. +// +Процедура ПриОшибкеОбработкиСообщения(Знач Сообщение, Знач Отправитель) Экспорт +``` + +Пример вызова +```bsl +СообщенияВМоделиСервисаПереопределяемый.ПриОшибкеОбработкиСообщения(Сообщение, Отправитель) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержки.md b/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержки.md new file mode 100644 index 0000000..7cf2ca0 --- /dev/null +++ b/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержки.md @@ -0,0 +1,88 @@ +--- +title: Сообщения в службу технической поддержки +slug: bsp/сообщения-в-службу-технической-поддержки +--- + + +## ПодготовитьСообщение +
+ +Описание, пример вызова + +```bsl + +// Формирует сообщение для отправки сообщения в службу технической +// поддержки. В параметрах передаются данные заполнения, вложения +// и параметры выгрузки журнала регистрации. +// +// Параметры: +// ДанныеСообщения - Структура - данные для формирования сообщения, +// См. СообщенияВСлужбуТехническойПоддержкиКлиентСервер.ДанныеСообщения; +// Вложения - Массив Из Структура, Неопределено - файлы вложений. Важно: допускаются только +// текстовые вложения (*.txt, *.json, *.xml). Поля структуры элемента вложения: +// * Представление - Строка - представление вложения. Например, "Вложение 1.txt"; +// * ВидДанных - Строка - определяет преобразование переданных данных. +// Возможна передача одного из значений: +// - ИмяФайла - Строка - полное имя файла вложения; +// - Адрес - Строка - адрес во временном хранилище значения типа ДвоичныеДанные; +// - Текст - Строка - текст вложения; +// * Данные - Строка - данные для формирования вложения; +// ОтборЖурналаРегистрации - Структура, Неопределено - настройки выгрузки журнала регистрации: +// * ДатаНачала - Дата - начало периода журнала; +// * ДатаОкончания - Дата - конец периода журнала; +// * События - Массив - список событий; +// * Метаданные - Массив, Неопределено - массив метаданных для отбора; +// * Уровень - Строка - уровень важности событий журнала регистрации. Возможные значения: +// - "Ошибка" - будет выполнен отбор по событиям с УровеньЖурналаРегистрации.Ошибка; +// - "Предупреждение" - будет выполнен отбор по событиям с УровеньЖурналаРегистрации.Предупреждение; +// - "Информация" - будет выполнен отбор по событиям с УровеньЖурналаРегистрации.Информация; +// - "Примечание" - будет выполнен отбор по событиям с УровеньЖурналаРегистрации.Примечание. +// +// Возвращаемое значение: +// Структура - результат отправки сообщения: +// * КодОшибки - Строка - идентификатор ошибки при отправки: +// - <Пустая строка> - отправка выполнена успешно; +// - "НеверныйФорматЗапроса" - переданы некорректные параметры +// сообщения в техническую поддержку; +// - "НеизвестнаяОшибка" - при отправке сообщения возникли ошибки; +// - "НеизвестнаяОшибкаСервиса" - при отправке сообщения возникли проблемы с сервисом; +// - "ОтсутствуетОбязательныйПараметрЗапроса" - отсутствует обязательный параметр +// сообщения в техническую поддержку; +// - "ОшибкаФайловойСистемы" - ошибка файловой системы; +// - "ПревышенМаксимальныйРазмерВложения" - превышен максимальный размер вложения; +// - "ПревышенМаксимальныйРазмерЖурналаРегистрации" - превышен максимальный размер +// журнала регистрации; +// - "ПустойПараметрЗапроса" - не заполнен обязательный параметр +// сообщения в техническую поддержку; +// * СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для пользователя; +// * ИспользуетсяИнформационныйЦентр - Булево - признак использования Информационного центра. +// * СообщениеВИнформационныйЦентр - Структура, Неопределено - параметры передачи обращения в Информационный центр. +// Когда не используется Информационный центр, тогда Неопределено: +// ** Тема - Строка - тема обращения +// ** Текст - Строка - текст обращения +// ** ИспользоватьСтандартныйШаблон - Булево - если Истина, то текст обращения будет заполнен по шаблону +// из метода ИнформационныйЦентрСервер.ШаблонТекстаВТехПоддержку; +// ** Вложения - Массив из Структура - массив сложения из структур с полями: +// *** ИмяФайла - Строка - имя файла-вложения с расширением, например "file.txt"; +// *** АдресВоВременномХранилище - Строка - адрес файла-вложения во временном хранилище; +// ** ОбработчикЗавершения - ОписаниеОповещения, Неопределено - описание оповещения о закрытии формы нового обращения; +// ** ДополнительныеДанные - Структура - произвольная структура данных, которую можноп ередать в службу поддержки. +// Эта структура должна быть сериализуемой в JSON; +// * URLСтраницы - Строка - URL страницы отправки сообщения. +// +Функция ПодготовитьСообщение( Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияВСлужбуТехническойПоддержки.ПодготовитьСообщение(); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержкиКлиент.md b/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержкиКлиент.md new file mode 100644 index 0000000..1d75fa3 --- /dev/null +++ b/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержкиКлиент.md @@ -0,0 +1,78 @@ +--- +title: Сообщения в службу технической поддержки клиент +slug: bsp/сообщения-в-службу-технической-поддержки-клиент +--- + + +## ОтправитьСообщение +
+ +Описание, пример вызова + +```bsl + +// Открывает страницу Портала 1С:ИТС для отправки сообщения в службу +// технической поддержки. В параметрах передаются данные заполнения, +// вложения и параметры выгрузки журнала регистрации. +// +// Параметры: +// ДанныеСообщения - Структура - данные для формирования сообщения, +// См. СообщенияВСлужбуТехническойПоддержкиКлиентСервер.ДанныеСообщения; +// Вложения - Массив Из Структура, Неопределено - файлы вложений. Важно: допускаются только +// текстовые вложения (*.txt, *.json, *.xml). При передаче адреса во временном хранилище +// данные должны быть помещены с уникальным идентификатором. Поля структуры элемента вложения: +// *Представление - Строка - представление вложения. Например, "Вложение 1.txt"; +// *ВидДанных - Строка - определяет преобразование переданных данных. +// Возможна передача одного из значений: +// - ИмяФайла - Строка - полное имя файла вложения; +// - Адрес - Строка - адрес во временном хранилище значения типа ДвоичныеДанные; +// - Текст - Строка - текст вложения; +// *Данные - Строка - данные для формирования вложения; +// ОтборЖурналаРегистрации - Структура, Неопределено - настройки выгрузки журнала регистрации: +// *ДатаНачала - Дата - начало периода журнала; +// *ДатаОкончания - Дата - конец периода журнала; +// *События - Массив - список событий; +// *Метаданные - Массив, Неопределено - массив метаданных для отбора; +// *Уровень - Строка - уровень важности событий журнала регистрации. Возможные значения: +// - "Ошибка" - будет выполнен отбор по событиям с УровеньЖурналаРегистрации.Ошибка; +// - "Предупреждение" - будет выполнен отбор по событиям с УровеньЖурналаРегистрации.Предупреждение; +// - "Информация" - будет выполнен отбор по событиям с УровеньЖурналаРегистрации.Информация; +// - "Примечание" - будет выполнен отбор по событиям с УровеньЖурналаРегистрации.Примечание. +// ОповещениеОЗавершении - ОписаниеОповещения, Неопределено - метод, в который должен быть +// передан результат отправки сообщения. В метод передается значение типа +// Структура - результат отправки сообщения: +// *КодОшибки - Строка - идентификатор ошибки при отправки: +// - <Пустая строка> - отправка выполнена успешно; +// - "НеверныйФорматЗапроса" - переданы некорректные параметры +// сообщения в техническую поддержку; +// - "НеизвестнаяОшибка" - при отправке сообщения возникли ошибки; +// - "НеизвестнаяОшибкаСервиса" - при отправке сообщения возникли +// проблемы с сервисом; +// - "ОтсутствуетОбязательныйПараметрЗапроса" - отсутствует +// обязательный параметр сообщения в техническую поддержку; +// - "ОшибкаФайловойСистемы" - ошибка файловой системы; +// - "ПревышенМаксимальныйРазмерВложения" - превышен максимальный +// размер вложения; +// - "ПревышенМаксимальныйРазмерЖурналаРегистрации" - превышен +// максимальный размер журнала регистрации; +// - "ПустойПараметрЗапроса" - не заполнен обязательный параметр +// сообщения в техническую поддержку; +// *СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке +// для пользователя; +// +Процедура ОтправитьСообщение( Экспорт +``` + +Пример вызова +```bsl +СообщенияВСлужбуТехническойПоддержкиКлиент.ОтправитьСообщение(); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержкиКлиентСервер.md b/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержкиКлиентСервер.md new file mode 100644 index 0000000..57451db --- /dev/null +++ b/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержкиКлиентСервер.md @@ -0,0 +1,43 @@ +--- +title: Сообщения в службу технической поддержки клиент сервер +slug: bsp/сообщения-в-службу-технической-поддержки-клиент-сервер +--- + + +## ДанныеСообщения +
+ +Описание, пример вызова + +```bsl + +// Данные сообщения для отправки в техническую поддержку. +// +// Возвращаемое значение: +// Структура - данные для формирования сообщения: +// *Тема - Строка - тема сообщения; +// *Сообщение - Строка - тело текст сообщения для отправки; +// *ИспользоватьСтандартныйШаблон - Булево - признак использования стандартного шаблона сообщения в техподдержку; +// *Получатель - Строка - условное имя получателя сообщения; +// *ИНН - Строка - ИНН организации; +// *РегистрационныйНомер - Строка - регистрационный номер; +// *НастройкиПоискаГотовогоОтвета - Структура - настройки поиска готового ответа. См. НастройкиПоискаГотовогоОтвета; +// *ДанныеТехническойИнформации - Структура - данные технической информации. См. ОписаниеТехническойИнформации; +// *НастройкиТехническойИнформации - Структура - данные технической информации. См. НастройкиТехническойИнформации. +// +Функция ДанныеСообщения() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияВСлужбуТехническойПоддержкиКлиентСервер.ДанныеСообщения() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержкиПереопределяемый.md b/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержкиПереопределяемый.md new file mode 100644 index 0000000..89d397f --- /dev/null +++ b/src/content/docs/bsp/СообщенияВСлужбуТехническойПоддержкиПереопределяемый.md @@ -0,0 +1,35 @@ +--- +title: Сообщения в службу технической поддержки переопределяемый +slug: bsp/сообщения-в-службу-технической-поддержки-переопределяемый +--- + + +## ПриОпределенииХостаСервисовТехническойПоддержки +
+ +Описание, пример вызова + +```bsl + +// Переопределяет хост для вызова отправки сообщений +// в службу технической поддержки. +// +// Параметры: +// Хост - Строка - хост подключения; +// +Процедура ПриОпределенииХостаСервисовТехническойПоддержки(Хост) Экспорт +``` + +Пример вызова +```bsl +СообщенияВСлужбуТехническойПоддержкиПереопределяемый.ПриОпределенииХостаСервисовТехническойПоддержки(Хост) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияКонтрольДополнительныхОтчетовИОбработокОбработчикТрансляции_1_0_0_1.md b/src/content/docs/bsp/СообщенияКонтрольДополнительныхОтчетовИОбработокОбработчикТрансляции_1_0_0_1.md new file mode 100644 index 0000000..8d46f0f --- /dev/null +++ b/src/content/docs/bsp/СообщенияКонтрольДополнительныхОтчетовИОбработокОбработчикТрансляции_1_0_0_1.md @@ -0,0 +1,148 @@ +--- +title: Сообщения контроль дополнительных отчетов и обработок обработчик трансляции_1_0_0_1 +slug: bsp/сообщения-контроль-дополнительных-отчетов-и-обработок-обработчик-трансляции-1-0-0-1 +--- + + +## ИсходнаяВерсия +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер версии, для трансляции с которой предназначен обработчик. +// +// Возвращаемое значение: +// Строка +// +Функция ИсходнаяВерсия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольДополнительныхОтчетовИОбработокОбработчикТрансляции_1_0_0_1.ИсходнаяВерсия() +``` +
+ +## ПакетИсходнойВерсии +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии, для трансляции с которой предназначен обработчик. +// +// Возвращаемое значение: +// Строка +// +Функция ПакетИсходнойВерсии() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольДополнительныхОтчетовИОбработокОбработчикТрансляции_1_0_0_1.ПакетИсходнойВерсии() +``` +
+ +## РезультирующаяВерсия +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер версии, для трансляции в которую предназначен обработчик. +// +// Возвращаемое значение: +// Строка +// +Функция РезультирующаяВерсия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольДополнительныхОтчетовИОбработокОбработчикТрансляции_1_0_0_1.РезультирующаяВерсия() +``` +
+ +## ПакетРезультирующейВерсии +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии, для трансляции в которую предназначен обработчик. +// +// Возвращаемое значение: +// Строка +// +Функция ПакетРезультирующейВерсии() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольДополнительныхОтчетовИОбработокОбработчикТрансляции_1_0_0_1.ПакетРезультирующейВерсии() +``` +
+ +## ПередТрансляцией +
+ +Описание, пример вызова + +```bsl + +// Обработчик проверки выполнения стандартной обработки трансляции +// +// Параметры: +// ИсходноеСообщение - ОбъектXDTO - транслируемое сообщение, +// СтандартнаяОбработка - Булево - для отмены выполнения стандартной обработки трансляции +// этому параметру внутри данной процедуры необходимо установить значение Ложь. +// При этом вместо выполнения стандартной обработки трансляции будет вызвана функция +// ТрансляцияСообщения() обработчика трансляции. +// +Процедура ПередТрансляцией(Знач ИсходноеСообщение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольДополнительныхОтчетовИОбработокОбработчикТрансляции_1_0_0_1.ПередТрансляцией(ИсходноеСообщение, СтандартнаяОбработка) +``` +
+ +## ТрансляцияСообщения +
+ +Описание, пример вызова + +```bsl + +// Обработчик выполнения произвольной трансляции сообщения. Вызывается только в том случае, +// если при выполнении процедуры ПередТрансляцией значению параметра СтандартнаяОбработка +// было установлено значение Ложь. +// +// Параметры: +// ИсходноеСообщение - ОбъектXDTO - транслируемое сообщение. +// +// Возвращаемое значение: +// ОбъектXDTO - результат произвольной трансляции сообщения. +// +Функция ТрансляцияСообщения(Знач ИсходноеСообщение) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольДополнительныхОтчетовИОбработокОбработчикТрансляции_1_0_0_1.ТрансляцияСообщения(ИсходноеСообщение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияКонтрольРезервногоКопированияИнтерфейс.md b/src/content/docs/bsp/СообщенияКонтрольРезервногоКопированияИнтерфейс.md new file mode 100644 index 0000000..4be84b3 --- /dev/null +++ b/src/content/docs/bsp/СообщенияКонтрольРезервногоКопированияИнтерфейс.md @@ -0,0 +1,198 @@ +--- +title: Сообщения контроль резервного копирования интерфейс +slug: bsp/сообщения-контроль-резервного-копирования-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую (используемую вызывающим кодом) версию интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - версия интерфейса. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Возвращает название программного интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - название интерфейса. +// +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольРезервногоКопированияИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольРезервногоКопированияИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеРезервнаяКопияОбластиСоздана +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ControlZonesBackup/a.b.c.d}ZoneBackupSuccessfull. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой получается тип сообщения. +// +// Возвращаемое значение: +// ОбъектXDTO - тип сообщения. +// +Функция СообщениеРезервнаяКопияОбластиСоздана(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияИнтерфейс.СообщениеРезервнаяКопияОбластиСоздана(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаАрхивацииОбласти +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ControlZonesBackup/a.b.c.d}ZoneBackupFailed. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой получается тип сообщения. +// +// Возвращаемое значение: +// ОбъектXDTO - тип сообщения. +// +Функция СообщениеОшибкаАрхивацииОбласти(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияИнтерфейс.СообщениеОшибкаАрхивацииОбласти(ИспользуемыйПакет); +``` +
+ +## СообщениеАрхивацияОбластиПропущена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ControlZonesBackup/a.b.c.d}ZoneBackupSkipped. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой получается тип сообщения. +// +// Возвращаемое значение: +// ОбъектXDTO - тип сообщения. +// +Функция СообщениеАрхивацияОбластиПропущена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияИнтерфейс.СообщениеАрхивацияОбластиПропущена(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияКонтрольРезервногоКопированияОбработчикТрансляции_1_0_2_1.md b/src/content/docs/bsp/СообщенияКонтрольРезервногоКопированияОбработчикТрансляции_1_0_2_1.md new file mode 100644 index 0000000..d69b10f --- /dev/null +++ b/src/content/docs/bsp/СообщенияКонтрольРезервногоКопированияОбработчикТрансляции_1_0_2_1.md @@ -0,0 +1,154 @@ +--- +title: Сообщения контроль резервного копирования обработчик трансляции_1_0_2_1 +slug: bsp/сообщения-контроль-резервного-копирования-обработчик-трансляции-1-0-2-1 +--- + + +## ИсходнаяВерсия +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер версии, для трансляции с которой предназначен обработчик. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - исходная версия. +// +Функция ИсходнаяВерсия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияОбработчикТрансляции_1_0_2_1.ИсходнаяВерсия() +``` +
+ +## ПакетИсходнойВерсии +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии, для трансляции с которой предназначен обработчик. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - пакет исходной версии. +// +Функция ПакетИсходнойВерсии() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияОбработчикТрансляции_1_0_2_1.ПакетИсходнойВерсии() +``` +
+ +## РезультирующаяВерсия +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер версии, для трансляции в которую предназначен обработчик. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - результирующая версия. +// +Функция РезультирующаяВерсия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияОбработчикТрансляции_1_0_2_1.РезультирующаяВерсия() +``` +
+ +## ПакетРезультирующейВерсии +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии, для трансляции в которую предназначен обработчик. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - пакет результирующей версии. +// +Функция ПакетРезультирующейВерсии() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияОбработчикТрансляции_1_0_2_1.ПакетРезультирующейВерсии() +``` +
+ +## ПередТрансляцией +
+ +Описание, пример вызова + +```bsl + +// Обработчик проверки выполнения стандартной обработки трансляции. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИсходноеСообщение - ОбъектXDTO - транслируемое сообщение, +// СтандартнаяОбработка - Булево - для отмены выполнения стандартной обработки трансляции +// этому параметру внутри данной процедуры необходимо установить значение Ложь. +// При этом вместо выполнения стандартной обработки трансляции будет вызвана функция. +// ТрансляцияСообщения() обработчика трансляции. +// +Процедура ПередТрансляцией(Знач ИсходноеСообщение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольРезервногоКопированияОбработчикТрансляции_1_0_2_1.ПередТрансляцией(ИсходноеСообщение, СтандартнаяОбработка) +``` +
+ +## ТрансляцияСообщения +
+ +Описание, пример вызова + +```bsl + +// Обработчик выполнения произвольной трансляции сообщения. Вызывается только в том случае, +// если при выполнении процедуры ПередТрансляцией значению параметра СтандартнаяОбработка +// было установлено значение Ложь. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИсходноеСообщение - ОбъектXDTO - транслируемое сообщение. +// +// Возвращаемое значение: +// ОбъектXDTO - результат произвольной трансляции сообщения. +// +Функция ТрансляцияСообщения(Знач ИсходноеСообщение) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольРезервногоКопированияОбработчикТрансляции_1_0_2_1.ТрансляцияСообщения(ИсходноеСообщение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.md b/src/content/docs/bsp/СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.md new file mode 100644 index 0000000..b56173d --- /dev/null +++ b/src/content/docs/bsp/СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.md @@ -0,0 +1,273 @@ +--- +title: Сообщения контроль удаленного администрирования интерфейс +slug: bsp/сообщения-контроль-удаленного-администрирования-интерфейс +--- + + +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую (используемую вызывающим кодом) версию интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// Возвращаемое значение: +// Строка - +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.Версия() +``` +
+ +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// Возвращаемое значение: +// Строка - +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.Пакет() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Возвращает название программного интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// Возвращаемое значение: +// Строка - +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - обработчики сообщений. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - обработчики сообщений. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеОбластьДанныхПодготовлена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/RemoteAdministration/Control/a.b.c.d}ApplicationPrepared. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO, ТипОбъектаXDTO - тип сообщения. +// +Функция СообщениеОбластьДанныхПодготовлена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.СообщениеОбластьДанныхПодготовлена(ИспользуемыйПакет); +``` +
+ +## СообщениеОбластьДанныхУдалена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/RemoteAdministration/Control/a.b.c.d}ApplicationDeleted. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO, ТипОбъектаXDTO - тип сообщения. +// +Функция СообщениеОбластьДанныхУдалена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.СообщениеОбластьДанныхУдалена(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаПодготовкиОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/RemoteAdministration/Control/a.b.c.d}ApplicationPrepareFailed. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO, ТипОбъектаXDTO - тип сообщения. +// +Функция СообщениеОшибкаПодготовкиОбластиДанных(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.СообщениеОшибкаПодготовкиОбластиДанных(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаПодготовкиОбластиДанныхТребуетсяКонвертация +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/RemoteAdministration/Control/a.b.c.d}ApplicationPrepareFailedConversionRequired +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO, ТипОбъектаXDTO - тип сообщения. +// +Функция СообщениеОшибкаПодготовкиОбластиДанныхТребуетсяКонвертация(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.СообщениеОшибкаПодготовкиОбластиДанныхТребуетсяКонвертация(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаУдаленияОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/RemoteAdministration/Control/a.b.c.d}ApplicationDeleteFailed. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO, ТипОбъектаXDTO - тип сообщения. +// +Функция СообщениеОшибкаУдаленияОбластиДанных(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.СообщениеОшибкаУдаленияОбластиДанных(ИспользуемыйПакет); +``` +
+ +## СообщениеОбластьДанныхГотоваКИспользованию +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/RemoteAdministration/Control/a.b.c.d}ApplicationReady. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO, ТипОбъектаXDTO - тип сообщения. +// +Функция СообщениеОбластьДанныхГотоваКИспользованию(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУдаленногоАдминистрированияИнтерфейс.СообщениеОбластьДанныхГотоваКИспользованию(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияКонтрольУправленияРазрешениямиИнтерфейс.md b/src/content/docs/bsp/СообщенияКонтрольУправленияРазрешениямиИнтерфейс.md new file mode 100644 index 0000000..71a3b96 --- /dev/null +++ b/src/content/docs/bsp/СообщенияКонтрольУправленияРазрешениямиИнтерфейс.md @@ -0,0 +1,190 @@ +--- +title: Сообщения контроль управления разрешениями интерфейс +slug: bsp/сообщения-контроль-управления-разрешениями-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУправленияРазрешениямиИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую (используемую вызывающим кодом) версию интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУправленияРазрешениямиИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Возвращает название программного интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУправленияРазрешениямиИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольУправленияРазрешениямиИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольУправленияРазрешениямиИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеОбработанЗапросРазрешенийИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/Application/Permissions/Control/a.b.c.d}InfoBasePermissionsRequestProcessed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO, ТипОбъектаXDTO - тип сообщения. +// +Функция СообщениеОбработанЗапросРазрешенийИнформационнойБазы(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУправленияРазрешениямиИнтерфейс.СообщениеОбработанЗапросРазрешенийИнформационнойБазы(ИспользуемыйПакет); +``` +
+ +## СообщениеОбработанЗапросРазрешенийОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/Application/Permissions/Control/a.b.c.d}ApplicationPermissionsRequestProcessed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO, ТипОбъектаXDTO - тип сообщения. +// +Функция СообщениеОбработанЗапросРазрешенийОбластиДанных(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУправленияРазрешениямиИнтерфейс.СообщениеОбработанЗапросРазрешенийОбластиДанных(ИспользуемыйПакет); +``` +
+ +## СловарьТиповРезультатовОбработкиЗапросов +
+ +Описание, пример вызова + +```bsl + +// Словарь преобразования элементов перечисления схемы +// {HTTP://www.1c.ru/1cFresh/Application/Permissions/Control/1.0.0.1}PermissionRequestProcessingResultTypes +// в элементы перечисления РезультатыОбработкиЗапросовНаИспользованиеВнешнихРесурсовВМоделиСервиса. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - с полями: +// * Approved - ПеречислениеСсылка.РезультатыОбработкиЗапросовНаИспользованиеВнешнихРесурсовВМоделиСервиса - одобрен. +// * Rejected - ПеречислениеСсылка.РезультатыОбработкиЗапросовНаИспользованиеВнешнихРесурсовВМоделиСервиса - отклонен. +Функция СловарьТиповРезультатовОбработкиЗапросов() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУправленияРазрешениямиИнтерфейс.СловарьТиповРезультатовОбработкиЗапросов() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияКонтрольУправленияРазрешениямиОбработчикСообщения_1_0_0_1.md b/src/content/docs/bsp/СообщенияКонтрольУправленияРазрешениямиОбработчикСообщения_1_0_0_1.md new file mode 100644 index 0000000..3679e22 --- /dev/null +++ b/src/content/docs/bsp/СообщенияКонтрольУправленияРазрешениямиОбработчикСообщения_1_0_0_1.md @@ -0,0 +1,97 @@ +--- +title: Сообщения контроль управления разрешениями обработчик сообщения_1_0_0_1 +slug: bsp/сообщения-контроль-управления-разрешениями-обработчик-сообщения-1-0-0-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУправленияРазрешениямиОбработчикСообщения_1_0_0_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию интерфейса сообщений, обслуживаемую обработчиком. +// +// Возвращаемое значение: +// Строка - +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУправленияРазрешениямиОбработчикСообщения_1_0_0_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Возвращает базовый тип для сообщений версии. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияКонтрольУправленияРазрешениямиОбработчикСообщения_1_0_0_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение, +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольУправленияРазрешениямиОбработчикСообщения_1_0_0_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияКонтрольУправленияРазрешениямиРеализация.md b/src/content/docs/bsp/СообщенияКонтрольУправленияРазрешениямиРеализация.md new file mode 100644 index 0000000..6f99c56 --- /dev/null +++ b/src/content/docs/bsp/СообщенияКонтрольУправленияРазрешениямиРеализация.md @@ -0,0 +1,59 @@ +--- +title: Сообщения контроль управления разрешениями реализация +slug: bsp/сообщения-контроль-управления-разрешениями-реализация +--- + + +## ОбработанЗапросНеразделенногоСеанса +
+ +Описание, пример вызова + +```bsl + +// {HTTP://www.1c.ru/1cFresh/Application/Permissions/Control/a.b.c.d}InfoBasePermissionsRequestProcessed +// +// Параметры: +// ИдентификаторПакета - УникальныйИдентификатор - идентификатор запроса на использование внешних ресурсов. +// РезультатОбработки - ПеречислениеСсылка.РезультатыОбработкиЗапросовНаИспользованиеВнешнихРесурсовВМоделиСервиса - результат обработки, +// ИнформацияОбОшибке - ОбъектXDTO - {HTTP://www.1c.ru/SaaS/ServiceCommon}ErrorDescription. +// +Процедура ОбработанЗапросНеразделенногоСеанса(Знач ИдентификаторПакета, Знач РезультатОбработки, Знач ИнформацияОбОшибке) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольУправленияРазрешениямиРеализация.ОбработанЗапросНеразделенногоСеанса(ИдентификаторПакета, РезультатОбработки, ИнформацияОбОшибке) +``` +
+ +## ОбработанЗапросРазделенногоСеанса +
+ +Описание, пример вызова + +```bsl + +// {HTTP://www.1c.ru/1cFresh/Application/Permissions/Control/a.b.c.d}ApplicationPermissionsRequestProcessed +// +// Параметры: +// ИдентификаторПакета - УникальныйИдентификатор - идентификатор запроса на использование внешних ресурсов. +// РезультатОбработки - ПеречислениеСсылка.РезультатыОбработкиЗапросовНаИспользованиеВнешнихРесурсовВМоделиСервиса - результат обработки, +// ИнформацияОбОшибке - ОбъектXDTO - {HTTP://www.1c.ru/SaaS/ServiceCommon}ErrorDescription. +// +Процедура ОбработанЗапросРазделенногоСеанса(Знач ИдентификаторПакета, Знач РезультатОбработки, Знач ИнформацияОбОшибке) Экспорт +``` + +Пример вызова +```bsl +СообщенияКонтрольУправленияРазрешениямиРеализация.ОбработанЗапросРазделенногоСеанса(ИдентификаторПакета, РезультатОбработки, ИнформацияОбОшибке) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияОбменаДаннымиКонтрольИнтерфейс.md b/src/content/docs/bsp/СообщенияОбменаДаннымиКонтрольИнтерфейс.md new file mode 100644 index 0000000..61b9855 --- /dev/null +++ b/src/content/docs/bsp/СообщенияОбменаДаннымиКонтрольИнтерфейс.md @@ -0,0 +1,418 @@ +--- +title: Сообщения обмена данными контроль интерфейс +slug: bsp/сообщения-обмена-данными-контроль-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Текущая (используемая вызывающим кодом) версия интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - версия интерфейса сообщений. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Название программного интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - название программного интерфейса сообщений. +// +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// +// Параметры: +// МассивОбработчиков - Массив из ОбщийМодуль - коллекция модулей, содержащих обработчики. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбменаДаннымиКонтрольИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// +// Параметры: +// МассивОбработчиков - Массив из ОбщийМодуль - коллекция модулей, содержащих обработчики. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбменаДаннымиКонтрольИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеНастройкаОбменаШаг1УспешноЗавершена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}SetupExchangeStep1Completed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеНастройкаОбменаШаг1УспешноЗавершена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеНастройкаОбменаШаг1УспешноЗавершена(ИспользуемыйПакет); +``` +
+ +## СообщениеНастройкаОбменаШаг2УспешноЗавершена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}SetupExchangeStep2Completed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеНастройкаОбменаШаг2УспешноЗавершена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеНастройкаОбменаШаг2УспешноЗавершена(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаНастройкиОбменаШаг1 +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}SetupExchangeStep1Failed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОшибкаНастройкиОбменаШаг1(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеОшибкаНастройкиОбменаШаг1(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаНастройкиОбменаШаг2 +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}SetupExchangeStep2Failed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОшибкаНастройкиОбменаШаг2(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеОшибкаНастройкиОбменаШаг2(ИспользуемыйПакет); +``` +
+ +## СообщениеЗагрузкаСообщенияОбменаУспешноЗавершена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}DownloadMessageCompleted +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеЗагрузкаСообщенияОбменаУспешноЗавершена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеЗагрузкаСообщенияОбменаУспешноЗавершена(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаЗагрузкиСообщенияОбмена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}DownloadMessageFailed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОшибкаЗагрузкиСообщенияОбмена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеОшибкаЗагрузкиСообщенияОбмена(ИспользуемыйПакет); +``` +
+ +## СообщениеПолучениеДанныхКорреспондентаУспешноЗавершено +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}GettingDataCompleted +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеПолучениеДанныхКорреспондентаУспешноЗавершено(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеПолучениеДанныхКорреспондентаУспешноЗавершено(ИспользуемыйПакет); +``` +
+ +## СообщениеПолучениеОбщихДанныхУзловКорреспондентаУспешноЗавершено +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}GettingCommonNodsDataCompleted +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеПолучениеОбщихДанныхУзловКорреспондентаУспешноЗавершено(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеПолучениеОбщихДанныхУзловКорреспондентаУспешноЗавершено(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаПолученияДанныхКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}GettingDataFailed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОшибкаПолученияДанныхКорреспондента(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеОшибкаПолученияДанныхКорреспондента(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаПолученияОбщихДанныхУзловКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}GettingCommonNodsDataFailed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОшибкаПолученияОбщихДанныхУзловКорреспондента(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеОшибкаПолученияОбщихДанныхУзловКорреспондента(ИспользуемыйПакет); +``` +
+ +## СообщениеПолучениеПараметровУчетаКорреспондентаУспешноЗавершено +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}GettingCorrespondentParamsCompleted +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеПолучениеПараметровУчетаКорреспондентаУспешноЗавершено(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеПолучениеПараметровУчетаКорреспондентаУспешноЗавершено(ИспользуемыйПакет); +``` +
+ +## СообщениеОшибкаПолученияПараметровУчетаКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Control/a.b.c.d}GettingCorrespondentParamsFailed +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеОшибкаПолученияПараметровУчетаКорреспондента(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольИнтерфейс.СообщениеОшибкаПолученияПараметровУчетаКорреспондента(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.md b/src/content/docs/bsp/СообщенияОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.md new file mode 100644 index 0000000..214060c --- /dev/null +++ b/src/content/docs/bsp/СообщенияОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.md @@ -0,0 +1,100 @@ +--- +title: Сообщения обмена данными контроль обработчик сообщения_2_1_2_1 +slug: bsp/сообщения-обмена-данными-контроль-обработчик-сообщения-2-1-2-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Пространство имен версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Версия интерфейса сообщений, обслуживаемая обработчиком. +// +// Возвращаемое значение: +// Строка - версия интерфейса сообщений. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Базовый тип для сообщений версии. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - базовый тип тела сообщения. +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение. +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения. +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбменаДаннымиКонтрольОбработчикСообщения_2_1_2_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияОбменаДаннымиОбработчикСообщения.md b/src/content/docs/bsp/СообщенияОбменаДаннымиОбработчикСообщения.md new file mode 100644 index 0000000..1287141 --- /dev/null +++ b/src/content/docs/bsp/СообщенияОбменаДаннымиОбработчикСообщения.md @@ -0,0 +1,57 @@ +--- +title: Сообщения обмена данными обработчик сообщения +slug: bsp/сообщения-обмена-данными-обработчик-сообщения +--- + + +## ПолучитьОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Получает список обработчиков сообщений, которые обрабатывает данная подсистема. +// +// Параметры: +// Обработчики - ТаблицаЗначений - состав полей см. в ОбменСообщениями.НоваяТаблицаОбработчиковСообщений. +// +Процедура ПолучитьОбработчикиКаналовСообщений(Обработчики) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбменаДаннымиОбработчикСообщения.ПолучитьОбработчикиКаналовСообщений(Обработчики) +``` +
+ +## ОбработатьСообщение +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку тела сообщения из канала в соответствии с алгоритмом текущего канала сообщений. +// +// Параметры: +// КаналСообщений - Строка - идентификатор канала сообщений, из которого получено сообщение. +// ТелоСообщения - Произвольный - тело сообщения, полученное из канала, которое подлежит обработке. +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - конечная точка, которая является отправителем сообщения. +// +Процедура ОбработатьСообщение(КаналСообщений, ТелоСообщения, Отправитель) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбменаДаннымиОбработчикСообщения.ОбработатьСообщение(КаналСообщений, ТелоСообщения, Отправитель) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеИнтерфейс.md b/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеИнтерфейс.md new file mode 100644 index 0000000..035ab4f --- /dev/null +++ b/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеИнтерфейс.md @@ -0,0 +1,268 @@ +--- +title: Сообщения обмена данными управление интерфейс +slug: bsp/сообщения-обмена-данными-управление-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Текущая (используемая вызывающим кодом) версия интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - версия интерфейса сообщений. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Название программного интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - название программного интерфейса сообщений. +// +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// +// Параметры: +// МассивОбработчиков - Массив из ОбщийМодуль - коллекция модулей, содержащих обработчики. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбменаДаннымиУправлениеИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// +// Параметры: +// МассивОбработчиков - Массив из ОбщийМодуль - коллекция модулей, содержащих обработчики. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбменаДаннымиУправлениеИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеНастроитьОбменШаг1 +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Manage/a.b.c.d}SetupExchangeStep1 +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеНастроитьОбменШаг1(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеИнтерфейс.СообщениеНастроитьОбменШаг1(ИспользуемыйПакет); +``` +
+ +## СообщениеНастроитьОбменШаг2 +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Manage/a.b.c.d}SetupExchangeStep2 +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеНастроитьОбменШаг2(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеИнтерфейс.СообщениеНастроитьОбменШаг2(ИспользуемыйПакет); +``` +
+ +## СообщениеЗагрузитьСообщениеОбмена +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Manage/a.b.c.d}DownloadMessage +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеЗагрузитьСообщениеОбмена(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеИнтерфейс.СообщениеЗагрузитьСообщениеОбмена(ИспользуемыйПакет); +``` +
+ +## СообщениеПолучитьДанныеКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Manage/a.b.c.d}GetData +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеПолучитьДанныеКорреспондента(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеИнтерфейс.СообщениеПолучитьДанныеКорреспондента(ИспользуемыйПакет); +``` +
+ +## СообщениеПолучитьОбщиеДанныеУзловКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Manage/a.b.c.d}GetCommonNodsData +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеПолучитьОбщиеДанныеУзловКорреспондента(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеИнтерфейс.СообщениеПолучитьОбщиеДанныеУзловКорреспондента(ИспользуемыйПакет); +``` +
+ +## СообщениеПолучитьПараметрыУчетаКорреспондента +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/Exchange/Manage/a.b.c.d}GetCorrespondentParams +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - тип объекта сообщения. +// +Функция СообщениеПолучитьПараметрыУчетаКорреспондента(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеИнтерфейс.СообщениеПолучитьПараметрыУчетаКорреспондента(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.md b/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.md new file mode 100644 index 0000000..1c7afef --- /dev/null +++ b/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.md @@ -0,0 +1,100 @@ +--- +title: Сообщения обмена данными управление обработчик сообщения_2_1_2_1 +slug: bsp/сообщения-обмена-данными-управление-обработчик-сообщения-2-1-2-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Пространство имен версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Версия интерфейса сообщений, обслуживаемая обработчиком. +// +// Возвращаемое значение: +// Строка - версия интерфейса сообщений. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Базовый тип для сообщений версии. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - базовый тип тела сообщения. +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение. +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения. +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбменаДаннымиУправлениеОбработчикСообщения_2_1_2_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.md b/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.md new file mode 100644 index 0000000..547a297 --- /dev/null +++ b/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.md @@ -0,0 +1,100 @@ +--- +title: Сообщения обмена данными управление обработчик сообщения_3_0_1_1 +slug: bsp/сообщения-обмена-данными-управление-обработчик-сообщения-3-0-1-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Пространство имен версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Версия интерфейса сообщений, обслуживаемая обработчиком. +// +// Возвращаемое значение: +// Строка - версия интерфейса сообщений. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Базовый тип для сообщений версии. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - базовый тип тела сообщения. +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение. +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения. +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбменаДаннымиУправлениеОбработчикСообщения_3_0_1_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеОбработчикТрансляции_2_1_2_1.md b/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеОбработчикТрансляции_2_1_2_1.md new file mode 100644 index 0000000..66674fc --- /dev/null +++ b/src/content/docs/bsp/СообщенияОбменаДаннымиУправлениеОбработчикТрансляции_2_1_2_1.md @@ -0,0 +1,148 @@ +--- +title: Сообщения обмена данными управление обработчик трансляции_2_1_2_1 +slug: bsp/сообщения-обмена-данными-управление-обработчик-трансляции-2-1-2-1 +--- + + +## ИсходнаяВерсия +
+ +Описание, пример вызова + +```bsl + +// Номер версии, для трансляции с которой предназначен обработчик. +// +// Возвращаемое значение: +// Строка - исходная версия интерфейса сообщений. +// +Функция ИсходнаяВерсия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикТрансляции_2_1_2_1.ИсходнаяВерсия() +``` +
+ +## ПакетИсходнойВерсии +
+ +Описание, пример вызова + +```bsl + +// Пространство имен версии, для трансляции с которой предназначен обработчик. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция ПакетИсходнойВерсии() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикТрансляции_2_1_2_1.ПакетИсходнойВерсии() +``` +
+ +## РезультирующаяВерсия +
+ +Описание, пример вызова + +```bsl + +// Номер версии, для трансляции в которую предназначен обработчик. +// +// Возвращаемое значение: +// Строка - результирующая версия интерфейса сообщений. +// +Функция РезультирующаяВерсия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикТрансляции_2_1_2_1.РезультирующаяВерсия() +``` +
+ +## ПакетРезультирующейВерсии +
+ +Описание, пример вызова + +```bsl + +// Пространство имен версии, для трансляции в которую предназначен обработчик. +// +// Возвращаемое значение: +// Строка - пространство имен. +// +Функция ПакетРезультирующейВерсии() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикТрансляции_2_1_2_1.ПакетРезультирующейВерсии() +``` +
+ +## ПередТрансляцией +
+ +Описание, пример вызова + +```bsl + +// Обработчик проверки выполнения стандартной обработки трансляции. +// +// Параметры: +// ИсходноеСообщение - ОбъектXDTO - транслируемое сообщение. +// СтандартнаяОбработка - Булево - для отмены выполнения стандартной обработки трансляции +// этому параметру внутри данной процедуры необходимо установить значение Ложь. +// При этом вместо выполнения стандартной обработки трансляции будет вызвана функция. +// ТрансляцияСообщения() обработчика трансляции. +// +Процедура ПередТрансляцией(Знач ИсходноеСообщение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбменаДаннымиУправлениеОбработчикТрансляции_2_1_2_1.ПередТрансляцией(ИсходноеСообщение, СтандартнаяОбработка) +``` +
+ +## ТрансляцияСообщения +
+ +Описание, пример вызова + +```bsl + +// Обработчик выполнения произвольной трансляции сообщения. Вызывается только в том случае, +// если при выполнении процедуры ПередТрансляцией значению параметра СтандартнаяОбработка +// было установлено значение Ложь. +// +// Параметры: +// ИсходноеСообщение - ОбъектXDTO - транслируемое сообщение. +// +// Возвращаемое значение: +// ОбъектXDTO - результат произвольной трансляции сообщения. +// +Функция ТрансляцияСообщения(Знач ИсходноеСообщение) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияОбменаДаннымиУправлениеОбработчикТрансляции_2_1_2_1.ТрансляцияСообщения(ИсходноеСообщение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияОбработкаВМонопольномРежиме.md b/src/content/docs/bsp/СообщенияОбработкаВМонопольномРежиме.md new file mode 100644 index 0000000..f75ad2f --- /dev/null +++ b/src/content/docs/bsp/СообщенияОбработкаВМонопольномРежиме.md @@ -0,0 +1,54 @@ +--- +title: Сообщения обработка в монопольном режиме +slug: bsp/сообщения-обработка-в-монопольном-режиме +--- + + +## ПриОпределенииОбработчиковКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// См. ОбменСообщениямиПереопределяемый.ПолучитьОбработчикиКаналовСообщений. +// +Процедура ПриОпределенииОбработчиковКаналовСообщений(Обработчики) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбработкаВМонопольномРежиме.ПриОпределенииОбработчиковКаналовСообщений(Обработчики) +``` +
+ +## ОбработатьСообщение +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку тела сообщения из канала в соответствии с алгоритмом текущего канала сообщений. +// +// Параметры: +// КаналСообщений - Строка - идентификатор канала сообщений, из которого получено сообщение. +// ТелоСообщения - Произвольный - тело сообщения, полученное из канала, которое подлежит обработке. +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - конечная точка, которая является отправителем сообщения. +// +Процедура ОбработатьСообщение(КаналСообщений, ТелоСообщения, Отправитель) Экспорт +``` + +Пример вызова +```bsl +СообщенияОбработкаВМонопольномРежиме.ОбработатьСообщение(КаналСообщений, ТелоСообщения, Отправитель) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияРаспределенноеВыполнениеКомандИнтерфейс.md b/src/content/docs/bsp/СообщенияРаспределенноеВыполнениеКомандИнтерфейс.md new file mode 100644 index 0000000..4eb3f5a --- /dev/null +++ b/src/content/docs/bsp/СообщенияРаспределенноеВыполнениеКомандИнтерфейс.md @@ -0,0 +1,123 @@ +--- +title: Сообщения распределенное выполнение команд интерфейс +slug: bsp/сообщения-распределенное-выполнение-команд-интерфейс +--- + + +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер текущей версии программного интерфейса. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - Номер версии интерфейса +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияРаспределенноеВыполнениеКомандИнтерфейс.Версия() +``` +
+ +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - Пространство имен интерфейса +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияРаспределенноеВыполнениеКомандИнтерфейс.Пакет() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Возвращает название программного интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - Имя интерфейса +// +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияРаспределенноеВыполнениеКомандИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - Обработчики каналов. +// +Процедура ОбработчикиКаналовСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияРаспределенноеВыполнениеКомандИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - Обработчики каналов. +// +Процедура ОбработчикиТрансляцииСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияРаспределенноеВыполнениеКомандИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияУдаленногоАдминистрированияИнтерфейс.md b/src/content/docs/bsp/СообщенияУдаленногоАдминистрированияИнтерфейс.md new file mode 100644 index 0000000..233ea58 --- /dev/null +++ b/src/content/docs/bsp/СообщенияУдаленногоАдминистрированияИнтерфейс.md @@ -0,0 +1,117 @@ +--- +title: Сообщения удаленного администрирования интерфейс +slug: bsp/сообщения-удаленного-администрирования-интерфейс +--- + + +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую (используемую вызывающим кодом) версию интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// Возвращаемое значение: +// Строка - +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУдаленногоАдминистрированияИнтерфейс.Версия() +``` +
+ +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// Возвращаемое значение: +// Строка - +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУдаленногоАдминистрированияИнтерфейс.Пакет() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Возвращает название программного интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// Возвращаемое значение: +// Строка - +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУдаленногоАдминистрированияИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияУдаленногоАдминистрированияИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияУдаленногоАдминистрированияИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияУдаленногоАдминистрированияРеализация.md b/src/content/docs/bsp/СообщенияУдаленногоАдминистрированияРеализация.md new file mode 100644 index 0000000..c9660ec --- /dev/null +++ b/src/content/docs/bsp/СообщенияУдаленногоАдминистрированияРеализация.md @@ -0,0 +1,59 @@ +--- +title: Сообщения удаленного администрирования реализация +slug: bsp/сообщения-удаленного-администрирования-реализация +--- + + +## КодУзлаПланаОбменаВСервисе +
+ +Описание, пример вызова + +```bsl + +// Генерирует код узла плана обмена для заданной области данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// НомерОбласти - Число - Значение разделителя. +// +// Возвращаемое значение: +// Строка - Код узла плана обмена для заданной области. +// +Функция КодУзлаПланаОбменаВСервисе(Знач НомерОбласти) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУдаленногоАдминистрированияРеализация.КодУзлаПланаОбменаВСервисе(НомерОбласти) +``` +
+ +## СобытиеЖурналаРегистрацииУдаленноеАдминистрированиеУстановитьПараметры +
+ +Описание, пример вызова + +```bsl + +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - наименование события. +// +Функция СобытиеЖурналаРегистрацииУдаленноеАдминистрированиеУстановитьПараметры() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУдаленногоАдминистрированияРеализация.СобытиеЖурналаРегистрацииУдаленноеАдминистрированиеУстановитьПараметры() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемИнтерфейс.md b/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемИнтерфейс.md new file mode 100644 index 0000000..6877f8b --- /dev/null +++ b/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемИнтерфейс.md @@ -0,0 +1,226 @@ +--- +title: Сообщения управление резервным копированием интерфейс +slug: bsp/сообщения-управление-резервным-копированием-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - наименование пакета. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую (используемую вызывающим кодом) версию интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - версия пакета. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Возвращает название программного интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - идентификатор программного интерфейса. +// +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправлениеРезервнымКопированиемИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправлениеРезервнымКопированиемИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеПланироватьАрхивациюОбласти +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ManageZonesBackup/a.b.c.d}PlanZoneBackup. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ОбъектXDTO - сообщение. +// +Функция СообщениеПланироватьАрхивациюОбласти(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемИнтерфейс.СообщениеПланироватьАрхивациюОбласти(ИспользуемыйПакет); +``` +
+ +## СообщениеОтменитьАрхивациюОбласти +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ManageZonesBackup/a.b.c.d}CancelZoneBackup. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ОбъектXDTO - сообщение. +// +Функция СообщениеОтменитьАрхивациюОбласти(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемИнтерфейс.СообщениеОтменитьАрхивациюОбласти(ИспользуемыйПакет); +``` +
+ +## СообщениеОбновитьНастройкиПериодическогоРезервногоКопирования +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ManageZonesBackup/a.b.c.d}UpdateScheduledZoneBackupSettings +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ОбъектXDTO - сообщение. +// +Функция СообщениеОбновитьНастройкиПериодическогоРезервногоКопирования(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемИнтерфейс.СообщениеОбновитьНастройкиПериодическогоРезервногоКопирования(ИспользуемыйПакет); +``` +
+ +## СообщениеОтменитьПериодическоеРезервноеКопирование +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/SaaS/ManageZonesBackup/a.b.c.d}CancelScheduledZoneBackup +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой получается тип сообщения. +// +// Возвращаемое значение: +// ОбъектXDTO - сообщение. +// +Функция СообщениеОтменитьПериодическоеРезервноеКопирование(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемИнтерфейс.СообщениеОтменитьПериодическоеРезервноеКопирование(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_2_1.md b/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_2_1.md new file mode 100644 index 0000000..9041e3f --- /dev/null +++ b/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_2_1.md @@ -0,0 +1,104 @@ +--- +title: Сообщения управление резервным копированием обработчик сообщения_1_0_2_1 +slug: bsp/сообщения-управление-резервным-копированием-обработчик-сообщения-1-0-2-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - наименование пакета. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_2_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию интерфейса сообщений, обслуживаемую обработчиком. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка -версия пакета. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_2_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Возвращает базовый тип для сообщений версии. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - базовый тип тел сообщений в модели сервиса. +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_2_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение, +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения. +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_2_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_3_1.md b/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_3_1.md new file mode 100644 index 0000000..b58da41 --- /dev/null +++ b/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_3_1.md @@ -0,0 +1,104 @@ +--- +title: Сообщения управление резервным копированием обработчик сообщения_1_0_3_1 +slug: bsp/сообщения-управление-резервным-копированием-обработчик-сообщения-1-0-3-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии интерфейса сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - наименование пакета. +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_3_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию интерфейса сообщений, обслуживаемую обработчиком. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// Строка - версия пакета. +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_3_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Возвращает базовый тип для сообщений версии. +// @skip-warning ПустойМетод - особенность реализации. +// +// Возвращаемое значение: +// ТипОбъектаXDTO - базовый тип тел сообщений в модели сервиса. +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_3_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение, +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения. +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправлениеРезервнымКопированиемОбработчикСообщения_1_0_3_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемРеализация.md b/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемРеализация.md new file mode 100644 index 0000000..6e6502d --- /dev/null +++ b/src/content/docs/bsp/СообщенияУправлениеРезервнымКопированиемРеализация.md @@ -0,0 +1,108 @@ +--- +title: Сообщения управление резервным копированием реализация +slug: bsp/сообщения-управление-резервным-копированием-реализация +--- + + +## ПланироватьСозданиеРезервнойКопииОбласти +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/SaaS/ManageZonesBackup/a.b.c.d}PlanZoneBackup. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КодОбластиДанных - Число - код области данных, +// ИдентификаторРезервнойКопии - УникальныйИдентификатор - идентификатор резервной копии, +// МоментРезервнойКопии - Дата - дата и время резервной копии, +// Принудительно - Булево - флаг принудительного создания резервной копии. +// ДляПоддержки - Булево - признак создания копии для службы поддержки. +// +Процедура ПланироватьСозданиеРезервнойКопииОбласти(Знач КодОбластиДанных, Экспорт +``` + +Пример вызова +```bsl +СообщенияУправлениеРезервнымКопированиемРеализация.ПланироватьСозданиеРезервнойКопииОбласти(КодОбластиДанных, ); +``` +
+ +## ОтменитьСозданиеРезервнойКопииОбласти +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/SaaS/ManageZonesBackup/a.b.c.d}CancelZoneBackup. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// КодОбластиДанных - Число - код области данных, +// ИдентификаторРезервнойКопии - УникальныйИдентификатор - идентификатор резервной копии. +// +Процедура ОтменитьСозданиеРезервнойКопииОбласти(Знач КодОбластиДанных, Знач ИдентификаторРезервнойКопии) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправлениеРезервнымКопированиемРеализация.ОтменитьСозданиеРезервнойКопииОбласти(КодОбластиДанных, ИдентификаторРезервнойКопии) +``` +
+ +## ОбновитьНастройкиПериодическогоРезервногоКопирования +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом +// {HTTP://www.1c.ru/SaaS/ManageZonesBackup/a.b.c.d}UpdateScheduledZoneBackupSettings. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОбластьДанных - Число - значение разделителя области данных. +// Настройки - Структура - новые настройки резервного копирования. +// +Процедура ОбновитьНастройкиПериодическогоРезервногоКопирования(Знач ОбластьДанных, Знач Настройки) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправлениеРезервнымКопированиемРеализация.ОбновитьНастройкиПериодическогоРезервногоКопирования(ОбластьДанных, Настройки) +``` +
+ +## ОтменитьПериодическоеРезервноеКопирование +
+ +Описание, пример вызова + +```bsl + +// Обработка входящих сообщений с типом {HTTP://www.1c.ru/SaaS/ManageZonesBackup/a.b.c.d}CancelScheduledZoneBackup. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОбластьДанных - Число - значение разделителя области данных. +// +Процедура ОтменитьПериодическоеРезервноеКопирование(Знач ОбластьДанных) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправлениеРезервнымКопированиемРеализация.ОтменитьПериодическоеРезервноеКопирование(ОбластьДанных) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияУправленияДОИООбработчикСообщения_1_0_1_1.md b/src/content/docs/bsp/СообщенияУправленияДОИООбработчикСообщения_1_0_1_1.md new file mode 100644 index 0000000..fb978f8 --- /dev/null +++ b/src/content/docs/bsp/СообщенияУправленияДОИООбработчикСообщения_1_0_1_1.md @@ -0,0 +1,100 @@ +--- +title: Сообщения управления ДОИО обработчик сообщения_1_0_1_1 +slug: bsp/сообщения-управления-доио-обработчик-сообщения-1-0-1-1 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДОИООбработчикСообщения_1_0_1_1.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию интерфейса сообщений, обслуживаемую обработчиком. +// +// Возвращаемое значение: +// Строка +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДОИООбработчикСообщения_1_0_1_1.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Возвращает базовый тип для сообщений версии. +// +// Возвращаемое значение: +// Строка +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДОИООбработчикСообщения_1_0_1_1.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса. +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение, +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправленияДОИООбработчикСообщения_1_0_1_1.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияУправленияДОИООбработчикСообщения_1_0_1_2.md b/src/content/docs/bsp/СообщенияУправленияДОИООбработчикСообщения_1_0_1_2.md new file mode 100644 index 0000000..62950cc --- /dev/null +++ b/src/content/docs/bsp/СообщенияУправленияДОИООбработчикСообщения_1_0_1_2.md @@ -0,0 +1,100 @@ +--- +title: Сообщения управления ДОИО обработчик сообщения_1_0_1_2 +slug: bsp/сообщения-управления-доио-обработчик-сообщения-1-0-1-2 +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДОИООбработчикСообщения_1_0_1_2.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию интерфейса сообщений, обслуживаемую обработчиком. +// +// Возвращаемое значение: +// Строка +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДОИООбработчикСообщения_1_0_1_2.Версия() +``` +
+ +## БазовыйТип +
+ +Описание, пример вызова + +```bsl + +// Возвращает базовый тип для сообщений версии. +// +// Возвращаемое значение: +// Строка +// +Функция БазовыйТип() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДОИООбработчикСообщения_1_0_1_2.БазовыйТип() +``` +
+ +## ОбработатьСообщениеМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку входящих сообщений модели сервиса +// +// Параметры: +// Сообщение - ОбъектXDTO - входящее сообщение, +// Отправитель - ПланОбменаСсылка.ОбменСообщениями - узел плана обмена, соответствующий отправителю сообщения +// СообщениеОбработано - Булево - флаг успешной обработки сообщения. Значение данного параметра необходимо +// установить равным Истина в том случае, если сообщение было успешно прочитано в данном обработчике. +// +Процедура ОбработатьСообщениеМоделиСервиса(Знач Сообщение, Знач Отправитель, СообщениеОбработано) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправленияДОИООбработчикСообщения_1_0_1_2.ОбработатьСообщениеМоделиСервиса(Сообщение, Отправитель, СообщениеОбработано) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.md b/src/content/docs/bsp/СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.md new file mode 100644 index 0000000..ede46ef --- /dev/null +++ b/src/content/docs/bsp/СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.md @@ -0,0 +1,293 @@ +--- +title: Сообщения управления дополнительными отчетами и обработками интерфейс +slug: bsp/сообщения-управления-дополнительными-отчетами-и-обработками-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// +// Возвращаемое значение: +// Строка +// +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую (используемую вызывающим кодом) версию интерфейса сообщений. +// +// Возвращаемое значение: +// Строка +// +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Возвращает название программного интерфейса сообщений. +// +// Возвращаемое значение: +// Строка +// +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// +// Параметры: +// МассивОбработчиков - Массив - общие модули или модули менеджеров. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// +// Параметры: +// МассивОбработчиков - Массив - общие модули или модули менеджеров. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеУстановитьДополнительныйОтчетИлиОбработку +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ApplicationExtensions/Management/a.b.c.d}InstallExtension +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO +// +Функция СообщениеУстановитьДополнительныйОтчетИлиОбработку(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.СообщениеУстановитьДополнительныйОтчетИлиОбработку(ИспользуемыйПакет); +``` +
+ +## ТипНастройкиКомандыДополнительногоОтчетаИлиОбработки +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ApplicationExtensions/Management/a.b.c.d}ExtensionCommandSettings +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO +// +Функция ТипНастройкиКомандыДополнительногоОтчетаИлиОбработки(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.ТипНастройкиКомандыДополнительногоОтчетаИлиОбработки(ИспользуемыйПакет); +``` +
+ +## СообщениеУдалитьДополнительныйОтчетИлиОбработку +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ApplicationExtensions/Management/a.b.c.d}DeleteExtension +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO +// +Функция СообщениеУдалитьДополнительныйОтчетИлиОбработку(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.СообщениеУдалитьДополнительныйОтчетИлиОбработку(ИспользуемыйПакет); +``` +
+ +## СообщениеОтключитьДополнительныйОтчетИлиОбработку +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ApplicationExtensions/Management/a.b.c.d}DisableExtension +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO +// +Функция СообщениеОтключитьДополнительныйОтчетИлиОбработку(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.СообщениеОтключитьДополнительныйОтчетИлиОбработку(ИспользуемыйПакет); +``` +
+ +## СообщениеВключитьДополнительныйОтчетИлиОбработку +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ApplicationExtensions/Management/a.b.c.d}EnableExtension +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO +// +Функция СообщениеВключитьДополнительныйОтчетИлиОбработку(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.СообщениеВключитьДополнительныйОтчетИлиОбработку(ИспользуемыйПакет); +``` +
+ +## СообщениеОтозватьДополнительныйОтчетИлиОбработку +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ApplicationExtensions/Management/a.b.c.d}DropExtension +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO +// +Функция СообщениеОтозватьДополнительныйОтчетИлиОбработку(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.СообщениеОтозватьДополнительныйОтчетИлиОбработку(ИспользуемыйПакет); +``` +
+ +## СообщениеУстановитьРежимИсполненияДополнительногоОтчетаИлиОбработкиВОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ApplicationExtensions/Management/a.b.c.d}SetExtensionSecurityProfile +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипОбъектаXDTO +// +Функция СообщениеУстановитьРежимИсполненияДополнительногоОтчетаИлиОбработкиВОбластиДанных(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияДополнительнымиОтчетамиИОбработкамиИнтерфейс.СообщениеУстановитьРежимИсполненияДополнительногоОтчетаИлиОбработкиВОбластиДанных(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СообщенияУправленияПриложениямиИнтерфейс.md b/src/content/docs/bsp/СообщенияУправленияПриложениямиИнтерфейс.md new file mode 100644 index 0000000..6d09de4 --- /dev/null +++ b/src/content/docs/bsp/СообщенияУправленияПриложениямиИнтерфейс.md @@ -0,0 +1,139 @@ +--- +title: Сообщения управления приложениями интерфейс +slug: bsp/сообщения-управления-приложениями-интерфейс +--- + + +## Пакет +
+ +Описание, пример вызова + +```bsl + +// Возвращает пространство имен текущей (используемой вызывающим кодом) версии интерфейса сообщений. +// Возвращаемое значение: +// Строка - +Функция Пакет() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияПриложениямиИнтерфейс.Пакет() +``` +
+ +## Версия +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую (используемую вызывающим кодом) версию интерфейса сообщений. +// Возвращаемое значение: +// Строка - +Функция Версия() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияПриложениямиИнтерфейс.Версия() +``` +
+ +## ПрограммныйИнтерфейс +
+ +Описание, пример вызова + +```bsl + +// Возвращает название программного интерфейса сообщений. +// Возвращаемое значение: +// Строка - +Функция ПрограммныйИнтерфейс() Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияПриложениямиИнтерфейс.ПрограммныйИнтерфейс() +``` +
+ +## ОбработчикиКаналовСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков сообщений в качестве обработчиков каналов обмена сообщениями. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиКаналовСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправленияПриложениямиИнтерфейс.ОбработчикиКаналовСообщений(МассивОбработчиков) +``` +
+ +## ОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию обработчиков трансляции сообщений. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// МассивОбработчиков - Массив - массив обработчиков. +// +Процедура ОбработчикиТрансляцииСообщений(Знач МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +СообщенияУправленияПриложениямиИнтерфейс.ОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +## СообщениеАннулироватьДоступПользователя +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип сообщения {HTTP://www.1c.ru/1cFresh/ManageApplication/Messages/a.b.c.d}RevokeUserAccess. +// +// Параметры: +// ИспользуемыйПакет - Строка - пространство имен версии интерфейса сообщений, для которой +// получается тип сообщения. +// +// Возвращаемое значение: +// ТипЗначенияXDTO, ТипОбъектаXDTO - тип сообщения. +// +Функция СообщениеАннулироватьДоступПользователя(Знач ИспользуемыйПакет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СообщенияУправленияПриложениямиИнтерфейс.СообщениеАннулироватьДоступПользователя(ИспользуемыйПакет); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтандартныеПодсистемыКлиент.md b/src/content/docs/bsp/СтандартныеПодсистемыКлиент.md new file mode 100644 index 0000000..09775a5 --- /dev/null +++ b/src/content/docs/bsp/СтандартныеПодсистемыКлиент.md @@ -0,0 +1,827 @@ +--- +title: Стандартные подсистемы клиент +slug: bsp/стандартные-подсистемы-клиент +--- + + +## УстановитьРасширенныйЗаголовокПриложения +
+ +Описание, пример вызова + +```bsl + +// Устанавливает заголовок главного окна приложения, используя значение константы +// ЗаголовокПриложения и заголовок приложения по умолчанию. +// +// Параметры: +// ПриЗапуске - Булево - Истина, если вызывается при начале работы программы. +// +Процедура УстановитьРасширенныйЗаголовокПриложения(ПриЗапуске = Ложь) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.УстановитьРасширенныйЗаголовокПриложения(ПриЗапуске); +``` +
+ +## ПоказатьВопросПользователю +
+ +Описание, пример вызова + +```bsl + +// Показать форму вопроса. +// +// Параметры: +// ОписаниеОповещенияОЗавершении - ОписаниеОповещения - описание процедуры, которая будет вызвана после закрытия окна +// вопроса со следующими параметрами: +// РезультатВопроса - Структура: +// Значение - результат выбора пользователя: значение +// системного перечисления или значение, +// связанное с нажатой кнопкой. В случае закрытия +// диалога по истечении времени - значение +// Таймаут. +// БольшеНеЗадаватьЭтотВопрос - Булево - результат выбора +// пользователя в +// одноименном флажке. +// ДополнительныеПараметры - Структура +// ТекстВопроса - Строка, ФорматированнаяСтрока - текст задаваемого вопроса. +// Кнопки - РежимДиалогаВопрос +// - СписокЗначений - может быть задан список значений, в котором: +// Значение - содержит значение, связанное с кнопкой и возвращаемое при +// ее нажатии. В качестве значения может использоваться значение +// перечисления КодВозвратаДиалога, а также другие значения, +// поддерживающее XDTO-сериализацию. +// Представление - текст кнопки. +// +// ДополнительныеПараметры - см. СтандартныеПодсистемыКлиент.ПараметрыВопросаПользователю. +// +Процедура ПоказатьВопросПользователю(ОписаниеОповещенияОЗавершении, ТекстВопроса, Кнопки, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПоказатьВопросПользователю(ОписаниеОповещенияОЗавершении, ТекстВопроса, Кнопки, ДополнительныеПараметры); +``` +
+ +## ПараметрыВопросаПользователю +
+ +Описание, пример вызова + +```bsl + +// Возвращает новую структуру дополнительных параметров для процедуры ПоказатьВопросПользователю. +// +// Возвращаемое значение: +// Структура: +// * КнопкаПоУмолчанию - Произвольный - определяет кнопку по умолчанию по типу кнопки или по связанному +// с ней значению. +// * Таймаут - Число - интервал времени в секундах до автоматического закрытия окна +// вопроса. +// * КнопкаТаймаута - Произвольный - кнопка (по типу кнопки или по связанному с ней значению), +// на которой отображается количество секунд, оставшихся до +// истечения таймаута. +// * Заголовок - Строка - заголовок вопроса. +// * ПредлагатьБольшеНеЗадаватьЭтотВопрос - Булево - если Истина, то в окне вопроса будет доступен одноименный флажок. +// * БольшеНеЗадаватьЭтотВопрос - Булево - принимает значение, выбранное пользователем в соответствующем +// флажке. +// * БлокироватьВесьИнтерфейс - Булево - если Истина, форма вопроса открывается, блокируя работу всех +// остальных открытых окон, включая главное окно. +// * Картинка - Картинка - картинка, выводимая в окне вопроса. +// * ТекстФлажка - Строка - текст флажка "Больше не спрашивать". +// +Функция ПараметрыВопросаПользователю() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыКлиент.ПараметрыВопросаПользователю() +``` +
+ +## ОткрытьСписокАктивныхПользователей +
+ +Описание, пример вызова + +```bsl + +// Вызывается при необходимости открыть форму списка активных пользователей, +// которые в данный момент времени работают с системой. +// +// Параметры: +// ПараметрыФормы - Структура - см. описание параметра Параметры метода ОткрытьФорму в синтакс-помощнике. +// ВладелецФормы - ФормаКлиентскогоПриложения - см. описание параметра Владелец метода ОткрытьФорму в синтакс-помощнике. +// +Процедура ОткрытьСписокАктивныхПользователей(ПараметрыФормы = Неопределено, ВладелецФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ОткрытьСписокАктивныхПользователей(ПараметрыФормы, ВладелецФормы); +``` +
+ +## ВыбратьОбъектыМетаданных +
+ +Описание, пример вызова + +```bsl + +// Открыть выбор объектов метаданных. +// +// Параметры: +// ПараметрыФормы - см. СтандартныеПодсистемыКлиентСервер.ПараметрыВыбораОбъектовМетаданных +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - оповещение, вызываемое при закрытии формы с параметрами: +// # ВыбранныеОбъектыМетаданных - СписокЗначений - полные имена выбранных объектов метаданных, +// или ссылки на идентификаторы объектов метаданных, если параметр ВыбиратьСсылки установлен в Истина. +// # ДополнительныеПараметры - Произвольный - дополнительные параметры, переданные при создании оповещения. +// Если ОписаниеОповещенияОЗакрытии не указано, то будет вызвано оповещение, которое можно получить +// с помощью обработчика ОбработкаОповещения: +// # ИмяСобытия - Строка - "ВыборОбъектовМетаданных" +// # Параметр - СписокЗначений - выбранные объекты метаданных. +// # Источник - см. СтандартныеПодсистемыКлиентСервер.ПараметрыВыбораОбъектовМетаданных.УникальныйИдентификаторИсточник +// +Процедура ВыбратьОбъектыМетаданных(ПараметрыФормы, ОписаниеОповещенияОЗакрытии = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ВыбратьОбъектыМетаданных(ПараметрыФормы, ОписаниеОповещенияОЗакрытии); +``` +
+ +## ПоказатьРедакторТабличногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Открыть табличный документ на просмотр или редактирование. +// При записи отредактированного табличного документа также вызывается оповещение, которое можно получить +// с помощью обработчика ОбработкаОповещения: +// # ИмяСобытия - Строка - "Запись_ТабличныйДокумент" или "ОтменаРедактированияТабличногоДокумента" +// # Параметр - Структура: +// ## ПутьКФайлу - Строка - полный путь к файлу отредактированного табличного документа. +// ## Представление - Строка - имя документа, заданное в ПараметрыРедактораТабличногоДокумента.ИмяДокумента +// # Источник - ФормаКлиентскогоПриложения - форма редактора табличного документа. +// +// Параметры: +// ТабличныйДокумент - ТабличныйДокумент - отображаемый или редактируемый табличный документ. +// ПараметрыФормы - см. СтандартныеПодсистемыКлиент.ПараметрыРедактораТабличногоДокумента +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - оповещение, которое будет вызвано при закрытии +// формы редактора табличного документа. +// Владелец - ФормаКлиентскогоПриложения - форма-владелец. +// +Процедура ПоказатьРедакторТабличногоДокумента(Знач ТабличныйДокумент, Знач ПараметрыФормы = Неопределено, Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПоказатьРедакторТабличногоДокумента(ТабличныйДокумент, ПараметрыФормы, ); +``` +
+ +## ПараметрыРедактораТабличногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Параметры редактора табличного документа для СтандартныеПодсистемыКлиент.ПоказатьРедакторТабличногоДокумента. +// +// Возвращаемое значение: +// Структура: +// * ИмяДокумента - Строка - наименование табличного документа, выводимое в заголовке редактора. +// * ТабличныйДокумент - ТабличныйДокумент, Строка - отображаемый или редактируемый табличный документ. +// Также может быть указан адрес табличного документа во временном хранилище. +// * ПутьКФайлу - Строка - полный путь к файлу табличного документа, опционально. +// * Редактирование - Булево - если Истина, то табличный документ можно отредактировать. По умолчанию Ложь. +// +Функция ПараметрыРедактораТабличногоДокумента() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыКлиент.ПараметрыРедактораТабличногоДокумента() +``` +
+ +## ПоказатьСравнениеТабличныхДокументов +
+ +Описание, пример вызова + +```bsl + +// Отрыть форму сравнения табличных документов, в которой можно посмотреть их отличия. +// +// Параметры: +// ТабличныйДокументЛевый - ТабличныйДокумент - первый сравниваемый табличный документ. +// ТабличныйДокументПравый - ТабличныйДокумент - второй сравниваемый табличный документ. +// Параметры - см. ПараметрыСравненияТабличныхДокументов +// +Процедура ПоказатьСравнениеТабличныхДокументов(ТабличныйДокументЛевый, ТабличныйДокументПравый, Параметры) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПоказатьСравнениеТабличныхДокументов(ТабличныйДокументЛевый, ТабличныйДокументПравый, Параметры) +``` +
+ +## ПараметрыСравненияТабличныхДокументов +
+ +Описание, пример вызова + +```bsl + +// Параметры сравнения табличных документов для процедуры ПоказатьСравнениеТабличныхДокументов. +// +// Возвращаемое значение: +// Структура: +// * АдресТабличныхДокументов - Строка - адрес сравниваемых табличных документов во временном хранилище. +// * Заголовок - Строка - заголовок формы. Если не задано, то "Сравнение табличных документов". +// * ЗаголовокЛевый - Строка - заголовок первого табличного документа (слева). +// * ЗаголовокПравый - Строка - заголовок правого табличного документа (справа). +// +Функция ПараметрыСравненияТабличныхДокументов() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыКлиент.ПараметрыСравненияТабличныхДокументов() +``` +
+ +## ЭтоБазоваяВерсияКонфигурации +
+ +Описание, пример вызова + +```bsl + +// См. СтандартныеПодсистемыСервер.ЭтоБазоваяВерсияКонфигурации +Функция ЭтоБазоваяВерсияКонфигурации() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыКлиент.ЭтоБазоваяВерсияКонфигурации() +``` +
+ +## ЭтоУчебнаяПлатформа +
+ +Описание, пример вызова + +```bsl + +// См. СтандартныеПодсистемыСервер.ЭтоУчебнаяПлатформа +Функция ЭтоУчебнаяПлатформа() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыКлиент.ЭтоУчебнаяПлатформа() +``` +
+ +## ВывестиИнформациюОбОшибке +
+ +Описание, пример вызова + +```bsl + +// Вызывает метод ПоказатьИнформациюОбОшибке объекта ОбработкаОшибок. +// Требуется использовать для возможности автоматического тестирования, +// чтобы перехватывать ошибки с помощью расширения. +// +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке +// +// Пример: +// // Параметры: +// // Результат - см. ДлительныеОперацииКлиент.НовыйРезультатДлительнойОперации +// // ДополнительныеПараметры - Неопределено +// // +// &НаКлиенте +// Процедура ОбновитьТекущийСписокЗавершение(Результат, ДополнительныеПараметры) Экспорт +// Если Результат = Неопределено Тогда +// Возврат; +// КонецЕсли; +// Если Результат.Статус = "Ошибка" Тогда +// СтандартныеПодсистемыКлиент.ВывестиИнформациюОбОшибке(Результат.ИнформацияОбОшибке); +// Возврат; +// КонецЕсли; +// ... // Статус = "Выполнено" +// КонецПроцедуры +// +Процедура ВывестиИнформациюОбОшибке(ИнформацияОбОшибке) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ВывестиИнформациюОбОшибке(ИнформацияОбОшибке) +``` +
+ +## НастроитьВидимостьИЗаголовокСсылкиОтправкиОтчетаОбОшибке +
+ +Описание, пример вызова + +```bsl + +// Отключает видимость указанному элементу, если ошибка +// не подходит по категории с учетом параметра ОшибкаТребуетЗавершениеРаботы. +// Устанавливает в заголовок текст обязательной отправки, +// если администратор настроил Отправлять в объекте +// РежимОтправкиИнформацииОбОшибке, в противном случае +// (СпрашиватьПользователя или Авто) текст необязательной отправки. +// Рекомендуется вызывать ПриОткрытии своей формы ошибки. +// +// Параметры: +// Элемент - ПолеФормы, КнопкаФормы - элемент которому будет установлена видимость и заголовок. +// ИнформацияОбОшибке - ИнформацияОбОшибке - ошибка по категории которой уточняется необходимость отправки отчета. +// ОшибкаТребуетЗавершениеРаботы - Булево - учитывается при настройке видимости ссылки. По ошибкам, +// из-за которых требуется завершение работы или перезапуск, как правило обязательно отправляется отчет. +// +// Пример: +// #Область ОписаниеПеременных +// &НаКлиенте +// Перем ОтчетОбОшибке, ОтчетИнформацияОбОшибке; +// #КонецОбласти +// #Область ОбработчикиСобытийФормы +// &НаКлиенте +// Процедура ПриОткрытии(Отказ) +// Если Параметры.ИнформацияОбОшибке <> Неопределено Тогда +// ОтчетИнформацияОбОшибке = Параметры.ИнформацияОбОшибке; +// ОтчетОбОшибке = Новый ОтчетОбОшибке(ОтчетИнформацияОбОшибке); +// СтандартныеПодсистемыКлиент.НастроитьВидимостьИЗаголовокСсылкиОтправкиОтчетаОбОшибке( +// Элементы.СформироватьОтчетОбОшибке, ОтчетИнформацияОбОшибке); +// КонецЕсли; +// КонецПроцедуры +// &НаКлиенте +// Процедура ПриЗакрытии(ЗавершениеРаботы) +// Если ОтчетОбОшибке <> Неопределено Тогда +// СтандартныеПодсистемыКлиент.ОтправитьОтчетОбОшибке(ОтчетОбОшибке, ОтчетИнформацияОбОшибке); +// КонецЕсли; +// КонецПроцедуры +// #КонецОбласти +// #Область ОбработчикиСобытийЭлементовШапкиФормы +// &НаКлиенте +// Процедура СформироватьОтчетОбОшибкеНажатие(Элемент) +// СтандартныеПодсистемыКлиент.ПоказатьОтчетОбОшибке(ОтчетОбОшибке); +// КонецПроцедуры +// #КонецОбласти +// +Процедура НастроитьВидимостьИЗаголовокСсылкиОтправкиОтчетаОбОшибке(Элемент, ИнформацияОбОшибке, ОшибкаТребуетЗавершениеРаботы = Ложь) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.НастроитьВидимостьИЗаголовокСсылкиОтправкиОтчетаОбОшибке(Элемент, ИнформацияОбОшибке, ОшибкаТребуетЗавершениеРаботы); +``` +
+ +## ПоказатьОтчетОбОшибке +
+ +Описание, пример вызова + +```bsl + +// Открывает отчет об ошибке для проверки и настройки состава отчета, +// либо в режиме отправки (если указан адрес сервиса для отправки и администратор +// не настроил НеОтправлять в объекте РежимОтправкиИнформацииОбОшибке) +// либо в режиме записи в файл в противном случае. +// +// Параметры: +// ОтчетДляОтправки - ОтчетОбОшибке +// +// Пример: +// #Область ОписаниеПеременных +// &НаКлиенте +// Перем ОтчетОбОшибке, ОтчетИнформацияОбОшибке; +// #КонецОбласти +// #Область ОбработчикиСобытийФормы +// &НаКлиенте +// Процедура ПриОткрытии(Отказ) +// Если Параметры.ИнформацияОбОшибке <> Неопределено Тогда +// ОтчетИнформацияОбОшибке = Параметры.ИнформацияОбОшибке; +// ОтчетОбОшибке = Новый ОтчетОбОшибке(ОтчетИнформацияОбОшибке); +// СтандартныеПодсистемыКлиент.НастроитьВидимостьИЗаголовокСсылкиОтправкиОтчетаОбОшибке( +// Элементы.СформироватьОтчетОбОшибке, ОтчетИнформацияОбОшибке); +// КонецЕсли; +// КонецПроцедуры +// &НаКлиенте +// Процедура ПриЗакрытии(ЗавершениеРаботы) +// Если ОтчетОбОшибке <> Неопределено Тогда +// СтандартныеПодсистемыКлиент.ОтправитьОтчетОбОшибке(ОтчетОбОшибке, ОтчетИнформацияОбОшибке); +// КонецЕсли; +// КонецПроцедуры +// #КонецОбласти +// #Область ОбработчикиСобытийЭлементовШапкиФормы +// &НаКлиенте +// Процедура СформироватьОтчетОбОшибкеНажатие(Элемент) +// СтандартныеПодсистемыКлиент.ПоказатьОтчетОбОшибке(ОтчетОбОшибке); +// КонецПроцедуры +// #КонецОбласти +// +Процедура ПоказатьОтчетОбОшибке(ОтчетДляОтправки) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПоказатьОтчетОбОшибке(ОтчетДляОтправки) +``` +
+ +## ОтправитьОтчетОбОшибке +
+ +Описание, пример вызова + +```bsl + +// Неинтерактивно отправляет отчет об ошибке, если ошибка подходит +// по категории для отправки с учетом параметра ЗавершениеРаботы и +// администратор настроил Отправлять в объекте РежимОтправкиИнформацииОбОшибке. +// Рекомендуется вызывать ПриЗакрытии своей формы ошибки. +// +// Параметры: +// ОтчетДляОтправки - ОтчетОбОшибке +// ИнформацияОбОшибке - ИнформацияОбОшибке - ошибка по категории которой уточняется необходимость отправки отчета. +// ОшибкаТребуетЗавершениеРаботы - Булево - учитывается при отправке отчета. По ошибкам, +// из-за которых требуется завершение работы или перезапуск, как правило обязательно отправляется отчет. +// Нужно передать то же значение, что и в процедуру НастроитьВидимостьИЗаголовокСсылкиОтправкиОтчетаОбОшибке. +// +// Пример: +// #Область ОписаниеПеременных +// &НаКлиенте +// Перем ОтчетОбОшибке, ОтчетИнформацияОбОшибке; +// #КонецОбласти +// #Область ОбработчикиСобытийФормы +// &НаКлиенте +// Процедура ПриОткрытии(Отказ) +// Если Параметры.ИнформацияОбОшибке <> Неопределено Тогда +// ОтчетИнформацияОбОшибке = Параметры.ИнформацияОбОшибке; +// ОтчетОбОшибке = Новый ОтчетОбОшибке(ОтчетИнформацияОбОшибке); +// СтандартныеПодсистемыКлиент.НастроитьВидимостьИЗаголовокСсылкиОтправкиОтчетаОбОшибке( +// Элементы.СформироватьОтчетОбОшибке, ОтчетИнформацияОбОшибке); +// КонецЕсли; +// КонецПроцедуры +// &НаКлиенте +// Процедура ПриЗакрытии(ЗавершениеРаботы) +// Если ОтчетОбОшибке <> Неопределено Тогда +// СтандартныеПодсистемыКлиент.ОтправитьОтчетОбОшибке(ОтчетОбОшибке, ОтчетИнформацияОбОшибке); +// КонецЕсли; +// КонецПроцедуры +// #КонецОбласти +// #Область ОбработчикиСобытийЭлементовШапкиФормы +// &НаКлиенте +// Процедура СформироватьОтчетОбОшибкеНажатие(Элемент) +// СтандартныеПодсистемыКлиент.ПоказатьОтчетОбОшибке(ОтчетОбОшибке); +// КонецПроцедуры +// #КонецОбласти +// +Процедура ОтправитьОтчетОбОшибке(ОтчетДляОтправки, ИнформацияОбОшибке, ОшибкаТребуетЗавершениеРаботы = Ложь) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ОтправитьОтчетОбОшибке(ОтчетДляОтправки, ИнформацияОбОшибке, ОшибкаТребуетЗавершениеРаботы); +``` +
+ +## ПропуститьПредупреждениеПередЗавершениемРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Отключает выдачу предупреждения пользователю при завершении работы программы. +// +Процедура ПропуститьПредупреждениеПередЗавершениемРаботыСистемы() Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПропуститьПредупреждениеПередЗавершениемРаботыСистемы() +``` +
+ +## ПередНачаломРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Выполнить стандартные действия перед началом работы пользователя +// с областью данных, либо в локальном режиме работы. +// +// Предназначена для вызова из обработчика ПередНачаломРаботыСистемы модулей управляемого и обычного приложения. +// +// Параметры: +// ОповещениеЗавершения - ОписаниеОповещения - не задается при вызове из обработчика ПередНачаломРаботыСистемы +// модулей управляемого и обычного приложения. В других случаях, после запуска будет вызвано +// оповещение с параметром типа Структура со свойствами: +// > Отказ - Булево - Ложь, если запуск выполнен успешно, или Истина, если вход в программу не +// выполнен; +// > Перезапустить - Булево - если требуется перезапуск программы; +// > ДополнительныеПараметрыКоманднойСтроки - Строка - для перезапуска. +// +Процедура ПередНачаломРаботыСистемы(Знач ОповещениеЗавершения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПередНачаломРаботыСистемы(ОповещениеЗавершения); +``` +
+ +## ПриНачалеРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Выполнить стандартные действия при начале работы пользователя +// с областью данных, либо в локальном режиме работы. +// +// Предназначена для вызова из обработчика ПриНачалеРаботыСистемы модулей управляемого и обычного приложения. +// +// Параметры: +// ОповещениеЗавершения - ОписаниеОповещения - не задается при вызове из обработчика ПриНачалеРаботыСистемы +// модулей управляемого и обычного приложения. В других случаях, после запуска будет вызвано +// оповещение с параметром типа Структура со свойствами: +// > Отказ - Булево - Ложь, если запуск выполнен успешно, или Истина, если вход в программу не +// выполнен; +// > Перезапустить - Булево - если требуется перезапуск программы; +// > ДополнительныеПараметрыКоманднойСтроки - Строка - для перезапуска. +// +// НепрерывноеВыполнение - Булево - только для внутреннего использования. +// Для перехода из обработчика ПередНачаломРаботыСистемы +// выполненного в режиме интерактивной обработки. +// +Процедура ПриНачалеРаботыСистемы(Знач ОповещениеЗавершения = Неопределено, НепрерывноеВыполнение = Истина) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПриНачалеРаботыСистемы(ОповещениеЗавершения, НепрерывноеВыполнение); +``` +
+ +## ПередЗавершениемРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Выполнить стандартные действия перед завершением работы пользователя +// с областью данных, либо в локальном режиме работы. +// +// Предназначена для вызова из обработчика ПередЗавершениемРаботыСистемы модулей управляемого и обычного приложения. +// +// Параметры: +// Отказ - Булево - возвращаемое значение. Признак отказа от завершения работы +// для обработчика события ПередЗавершениемРаботыСистемы, либо программного отказа, +// либо того, что потребовалась интерактивная обработка. В случае успешного взаимодействия +// с пользователем завершение работы будет продолжено. +// ТекстПредупреждения - Строка - см. ПередЗавершениемРаботыСистемы() в синтакс-помощнике. +// +Процедура ПередЗавершениемРаботыСистемы(Отказ = Ложь, ТекстПредупреждения = "") Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПередЗавершениемРаботыСистемы(Отказ, ТекстПредупреждения); +``` +
+ +## ОбработкаПолученияФормыВыбораПользователейСистемыВзаимодействия +
+ +Описание, пример вызова + +```bsl + +// Выполнить стандартные действия при обработке получения формы выбора пользователей системы взаимодействия. +// +// Параметры: +// НазначениеВыбора - НазначениеВыбораПользователейСистемыВзаимодействия +// Форма - ФормаКлиентскогоПриложения +// ИдентификаторОбсуждения - ИдентификаторОбсужденияСистемыВзаимодействия +// Параметры - Структура +// ВыбраннаяФорма - Строка +// СтандартнаяОбработка - Булево +// +Процедура ОбработкаПолученияФормыВыбораПользователейСистемыВзаимодействия(НазначениеВыбора, Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ОбработкаПолученияФормыВыбораПользователейСистемыВзаимодействия(НазначениеВыбора, ); +``` +
+ +## ПредупреждениеПриЗавершенииРаботы +
+ +Описание, пример вызова + +```bsl + +// Возвращает новую структуру параметров для вывода предупреждения перед завершением работы программы. +// Для использования в ОбщегоНазначенияКлиентПереопределяемый.ПередЗавершениемРаботыСистемы. +// +// Возвращаемое значение: +// Структура: +// ТекстПредупреждения - Строка - текст, выводимый в окне веб-браузера (или тонкого клиента) при завершении работы. +// Например, "Имеются редактируемые файлы, которые не помещены в приложение". +// Остальные параметры определяют внешний вид формы предупреждений, +// открываемой после подтверждения в окне веб-браузера (или тонкого клиента). +// ТекстФлажка - Строка - если задан, то в форме предупреждений выводится флажок с указанным текстом. +// Например, "Завершить редактирование файлов (5)". +// ПоясняющийТекст - Строка - текст, выводимый в форме сверху управляющего элемента (флажок или гиперссылка). +// Например, "Редактируемые файлы, не помещенные в приложение". +// ТекстГиперссылки - Строка - если задан, то выводится гиперссылка с указанным текстом. +// Например, "Редактируемые файлы (5)". +// РасширеннаяПодсказка - Строка - текст подсказки, выводимый по кнопке справа от управляющего элемента (флажок или +// гиперссылка). Например, "Нажмите для перехода к списку файлов, +// открытых для редактирования". +// Приоритет - Число - относительный порядок в списке предупреждений на форме (чем больше, тем выше). +// ВывестиОдноПредупреждение - Булево - если Истина, то в списке предупреждений выводится только одно это +// предупреждение. Т.е. такое предупреждение не совместимо с любыми другими. +// ДействиеПриУстановленномФлажке - Структура: +// * Форма - Строка - если пользователь установил флажок, то следует открыть указанную форму. +// Например, "Обработка.Файлы.РедактируемыеФайлы". +// * ПараметрыФормы - Структура - произвольная структура параметров для открытия формы. +// ДействиеПриНажатииГиперссылки - Структура: +// * Форма - Строка - путь к форме, которая должна открываться по нажатию на гиперссылку. +// Например, "Обработка.Файлы.РедактируемыеФайлы". +// * ПараметрыФормы - Структура - произвольная структура параметров для открываемой формы. +// * ПрикладнаяФормаПредупреждения - Строка - путь к форме, которая должна открываться сразу +// вместо универсальной формы в случае, когда в списке +// предупреждений оказывается только одно данное предупреждение. +// Например, "Обработка.Файлы.РедактируемыеФайлы". +// * ПараметрыПрикладнойФормыПредупреждения - Структура - произвольная структура +// параметров для вышеописанной формы. +// * РежимОткрытияОкна - РежимОткрытияОкнаФормы - режим открытия форм Форма или ПрикладнаяФормаПредупреждения. +// +Функция ПредупреждениеПриЗавершенииРаботы() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыКлиент.ПредупреждениеПриЗавершенииРаботы() +``` +
+ +## ПараметрыРаботыКлиентаПриЗапуске +
+ +Описание, пример вызова + +```bsl + +// Возвращает значения параметров, необходимых для работы клиентского кода +// при запуске конфигурации за один серверный вызов (для минимизации клиент-серверного взаимодействия +// и снижения времени запуска). +// С помощью этой функции можно обращаться к параметрам в клиентском коде, вызываемым из обработчиков событий: +// - ПередНачаломРаботыСистемы, +// - ПриНачалеРаботыСистемы. +// +// В этих обработчиках при запуске недопустимо использовать команды сброса кэша +// повторно используемых модулей, иначе запуск может привести +// к непредсказуемым ошибкам и лишним серверным вызовам. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - параметры работы клиента при запуске. +// См. в ОбщегоНазначенияПереопределяемый.ПриДобавленииПараметровРаботыКлиентаПриЗапуске. +// +// +Функция ПараметрыРаботыКлиентаПриЗапуске() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиентаПриЗапуске() +``` +
+ +## ПараметрыРаботыКлиента +
+ +Описание, пример вызова + +```bsl + +// Возвращает значения параметров, необходимых для работы клиентского кода конфигурации +// без дополнительных серверных вызовов. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - параметры работы клиента. +// Состав свойств см. в ОбщегоНазначенияПереопределяемый.ПриДобавленииПараметровРаботыКлиента. +// +Функция ПараметрыРаботыКлиента() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиента() +``` +
+ +## ПриГлобальномПоиске +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияКлиентПереопределяемый.ПриГлобальномПоиске +Процедура ПриГлобальномПоиске(СтрокаПоиска, ПланПоиска) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПриГлобальномПоиске(СтрокаПоиска, ПланПоиска) +``` +
+ +## ПриВыбореРезультатаГлобальногоПоиска +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияКлиентПереопределяемый.ПриВыбореРезультатаГлобальногоПоиска +Процедура ПриВыбореРезультатаГлобальногоПоиска(ЭлементРезультата, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПриВыбореРезультатаГлобальногоПоиска(ЭлементРезультата, СтандартнаяОбработка) +``` +
+ +## ПриВыбореДействияРезультатаГлобальногоПоиска +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияКлиентПереопределяемый.ПриВыбореДействияРезультатаГлобальногоПоиска +Процедура ПриВыбореДействияРезультатаГлобальногоПоиска(ЭлементРезультата, Действие) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ПриВыбореДействияРезультатаГлобальногоПоиска(ЭлементРезультата, Действие) +``` +
+ +## ОбработкаПереходаПоНавигационнойСсылке +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияКлиентПереопределяемый.ОбработкаПереходаПоНавигационнойСсылке +Процедура ОбработкаПереходаПоНавигационнойСсылке(ДанныеПереходаПоНавигационнойСсылке, Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиент.ОбработкаПереходаПоНавигационнойСсылке(ДанныеПереходаПоНавигационнойСсылке, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтандартныеПодсистемыКлиентСервер.md b/src/content/docs/bsp/СтандартныеПодсистемыКлиентСервер.md new file mode 100644 index 0000000..ea4a927 --- /dev/null +++ b/src/content/docs/bsp/СтандартныеПодсистемыКлиентСервер.md @@ -0,0 +1,72 @@ +--- +title: Стандартные подсистемы клиент сервер +slug: bsp/стандартные-подсистемы-клиент-сервер +--- + + +## ПараметрыВыбораОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры выбора объектов метаданных для процедуры +// СтандартныеПодсистемыКлиент.ВыбратьОбъектыМетаданных. +// +// Возвращаемое значение: +// Структура: +// * КоллекцииВыбираемыхОбъектовМетаданных - СписокЗначений - фильтр по типам объектов метаданных, +// которые могут быть выбраны. Например, выбирать только объекты метаданных справочники и документы: +// КоллекцииВыбираемыхОбъектовМетаданных = Новый СписокЗначений; +// КоллекцииВыбираемыхОбъектовМетаданных.Добавить("Справочники"); +// КоллекцииВыбираемыхОбъектовМетаданных.Добавить("Документы"); +// +// * ФильтрПоОбъектамМетаданных - СписокЗначений - фильтр по объектам метаданных, +// которые могут быть выбраны. Например: +// ФильтрПоОбъектамМетаданных = Новый СписокЗначений; +// ФильтрПоОбъектамМетаданных.Добавить("Справочник.Товары"); +// ФильтрПоОбъектамМетаданных.Добавить("Документ.СчетНаОплату"); +// * ВыбранныеОбъектыМетаданных - СписокЗначений - полные имена выбранных объектов метаданных, которые +// в дереве метаданных должны быть отмечены флажком. +// * НачальноеЗначениеВыбора - Строка - полное имя метаданных, на котором будет спозиционирован +// список при открытии формы. Например, "Справочник.Партнеры". +// * ВыборЕдинственного - Булево - по умолчанию Ложь. Укажите Истина, если нужно выбрать один объект метаданных. +// При этом пометка нескольких строк будет невозможна, а выбирать можно по двойному клик по строке. +// * ВыбиратьСсылки - Булево - по умолчанию Ложь. Укажите Истина, чтобы в возвращаемом значении вместо +// полных имен выбранных метаданных содержались ссылки на их идентификаторы, +// смотри ОбщегоНазначения.ИдентификаторыОбъектовМетаданных. +// * ВыбиратьКоллекцииКогдаВыбраныВсеОбъекты - Булево - по умолчанию Ложь. При группировке объектов по видам, +// укажите Истина, чтобы в возвращаемое значение включать также типы объектов метаданных +// (Конфигурация, Справочники, Документы...), если у них выбраны все подчиненные строки. +// * ВыбиратьТаблицыВнешнихИсточниковДанных - Булево - по умолчанию Ложь для совместимости. +// * Заголовок - Строка - если не указано, то форма откроется со стандартным заголовком "Выбор объектов метаданных". +// * СпособГруппировкиОбъектов - Строка - по умолчанию "ПоВидам". Укажите "ПоРазделам", чтобы вывести дерево +// объектов метаданных по разделам командного интерфейса (подсистемам, включенным в командный интерфейс) +// вместо группировки по технологическим типам: Справочники, Документы и т.п. +// Также можно указать "ПоРазделам,ПоВидам" или "ПоВидам,ПоРазделам", чтобы в форме был доступен +// переключатель группировки объектов метаданных. +// * РодительскиеПодсистемы - СписокЗначений - можно указать список подсистемы, только подчиненные подсистемы +// которых нужно отобразить в форме. +// * ТолькоПодсистемыСКИ - Булево - по умолчанию Ложь. Укажите Истина, чтобы в списке оставить только подсистемы, +// которые включены в командный интерфейс (разделы командного интерфейса). +// * УникальныйИдентификаторИсточник - УникальныйИдентификатор - опционально. Уникальный идентификатор формы, +// передаваемый в оповещение ВыборОбъектовМетаданных в качестве параметра Источник. +// Это оповещение вызывается, если +// +Функция ПараметрыВыбораОбъектовМетаданных() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыКлиентСервер.ПараметрыВыбораОбъектовМетаданных() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтандартныеПодсистемыКлиентСерверЛокализация.md b/src/content/docs/bsp/СтандартныеПодсистемыКлиентСерверЛокализация.md new file mode 100644 index 0000000..c0aec81 --- /dev/null +++ b/src/content/docs/bsp/СтандартныеПодсистемыКлиентСерверЛокализация.md @@ -0,0 +1,36 @@ +--- +title: Стандартные подсистемы клиент сервер локализация +slug: bsp/стандартные-подсистемы-клиент-сервер-локализация +--- + + +## ПриЗаполненииПравилТранслитерации +
+ +Описание, пример вызова + +```bsl + +// Описывает правил транслитерации национального алфавита в латиницу. +// +// Параметры: +// Правила - Соответствие из КлючИЗначение: +// * Ключ - Строка - буква национального алфавита; +// * Значение - Строка - буква латинского алфавита. +// +Процедура ПриЗаполненииПравилТранслитерации(Правила) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыКлиентСерверЛокализация.ПриЗаполненииПравилТранслитерации(Правила) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтандартныеПодсистемыСервер.md b/src/content/docs/bsp/СтандартныеПодсистемыСервер.md new file mode 100644 index 0000000..91a541a --- /dev/null +++ b/src/content/docs/bsp/СтандартныеПодсистемыСервер.md @@ -0,0 +1,377 @@ +--- +title: Стандартные подсистемы сервер +slug: bsp/стандартные-подсистемы-сервер +--- + + +## УстановкаПараметровСеанса +
+ +Описание, пример вызова + +```bsl + +// Вызов этой процедуры необходимо разместить в модуле сеанса в процедуре УстановкаПараметровСеанса +// согласно документации. +// +// Параметры: +// ИменаПараметровСеанса - Массив из Строка +// - Неопределено - имена параметров сеанса для инициализации. +// Массив устанавливаемых идентификаторов параметров сеанса, +// которые нужно инициализировать, если обработчик вызывается +// перед использованием неинициализированных параметров сеанса. +// Неопределено, если обработчик события вызывается системой при начале сеанса. +// +// Возвращаемое значение: +// Массив из Строка - имена параметров сеанса, значения которых были успешно установлены. +// +Функция УстановкаПараметровСеанса(ИменаПараметровСеанса) Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыСервер.УстановкаПараметровСеанса(ИменаПараметровСеанса) +``` +
+ +## ЭтоБазоваяВерсияКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, является ли конфигурация базовой. +// Базовые версии конфигураций могут иметь программные ограничения, действие которых +// можно предусмотреть с помощью этой функции. +// Конфигурация считается базовой, если в ее имени есть термин "Базовая", +// например, "УправлениеТорговлейБазовая". +// +// Возвращаемое значение: +// Булево - Истина, если конфигурация - базовая. +// +Функция ЭтоБазоваяВерсияКонфигурации() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыСервер.ЭтоБазоваяВерсияКонфигурации() +``` +
+ +## ЭтоУчебнаяПлатформа +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, что выполнение происходит на учебной платформе. +// Используется, когда нужно поддержать работу кода, который зависит +// от ограничений учебной версии платформы. +// +// Возвращаемое значение: +// Булево - Истина, если выполнение происходит на учебной платформе. +// +Функция ЭтоУчебнаяПлатформа() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыСервер.ЭтоУчебнаяПлатформа() +``` +
+ +## ОбновитьВсеПараметрыРаботыПрограммы +
+ +Описание, пример вызова + +```bsl + +// Обновляет кэши свойств метаданных, позволяющие ускорить +// открытие сеанса, а также обновление ИБ, особенно в модели сервиса. +// Их обновление происходит до обновления ИБ. +// +// Для использования в других библиотеках и конфигурациях. +// +Процедура ОбновитьВсеПараметрыРаботыПрограммы() Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыСервер.ОбновитьВсеПараметрыРаботыПрограммы() +``` +
+ +## ВерсияБиблиотеки +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер версии "Библиотеки стандартных подсистем" (БСП), +// встроенной в конфигурацию. +// +// Возвращаемое значение: +// Строка - версия БСП, например "1.0.1.1". +// +Функция ВерсияБиблиотеки() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыСервер.ВерсияБиблиотеки() +``` +
+ +## ИдентификаторИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Получает уникальный идентификатор информационной базы, +// с помощью которого можно различать различные экземпляры информационных баз, +// например, при сборе статистики или в механизмах внешнего управления базами. +// Если идентификатор не заполнен, то его значение автоматически устанавливается и возвращается. +// +// Идентификатор хранится в константе ИдентификаторИнформационнойБазы. +// Константа ИдентификаторИнформационнойБазы не должна входить в составы планов обмена, чтобы иметь +// различные значения в каждой информационной базе (узле РИБ). +// +// Возвращаемое значение: +// Строка - идентификатор информационной базы. +// +Функция ИдентификаторИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыСервер.ИдентификаторИнформационнойБазы() +``` +
+ +## ПараметрыАдминистрирования +
+ +Описание, пример вызова + +```bsl + +// Возвращает сохраненные в информационной базы параметры администрирования. +// Предназначена для использования в механизмах, требующих для свой работы +// ввода параметров администрирования информационной базы и/или кластера серверов. +// Например, блокировка установки соединений с информационной базой. +// См. так же УстановитьПараметрыАдминистрирования. +// +// Возвращаемое значение: +// Структура - содержит свойства двух структур +// АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияКластера +// и АдминистрированиеКластераКлиентСервер.ПараметрыАдминистрированияИнформационнойБазыКластера. +// При этом поля, содержащие пароли, возвращаются пустыми. Если параметры администрирования +// не были ранее сохранены при помощи функции УстановитьПараметрыАдминистрирования, +// то будут возвращены автоматически вычисленные параметры администрирования по умолчанию. +// +Функция ПараметрыАдминистрирования() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыСервер.ПараметрыАдминистрирования() +``` +
+ +## УстановитьПараметрыАдминистрирования +
+ +Описание, пример вызова + +```bsl + +// Сохраняет параметры администрирования информационной базы и кластера серверов. +// При сохранении поля, содержащие пароли, будут очищены в целях безопасности. +// +// Параметры: +// ПараметрыАдминистрированияИБ - см. ПараметрыАдминистрирования +// +// Пример: +// ПараметрыАдминистрирования = СтандартныеПодсистемыСервер.ПараметрыАдминистрирования(); +// // Вывод параметров администрирования администратору для подтверждения корректности и ввода паролей. +// // Далее выполнение действий, связанных с подключением к кластеру серверов. +// СтандартныеПодсистемыСервер.ПараметрыАдминистрирования(ПараметрыАдминистрирования); +// +Процедура УстановитьПараметрыАдминистрирования(ПараметрыАдминистрированияИБ) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыСервер.УстановитьПараметрыАдминистрирования(ПараметрыАдминистрированияИБ) +``` +
+ +## УстановитьУсловноеОформлениеПоляДата +
+ +Описание, пример вызова + +```bsl + +// Устанавливает представление поля Дата в списках, содержащих реквизит с составом даты Дата и время. +// Подробнее см. стандарт "Поле "Дата" в списках". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма со списком. +// ПолноеИмяРеквизита - Строка - полный путь к реквизиту типа "Дата" в формате "<ИмяСписка>.<ИмяПоля>". +// ИмяЭлемента - Строка - имя элемента формы, связанного с реквизитом списка типа "Дата". +// +// Пример: +// +// Процедура ПриСозданииНаСервере(Отказ, СтандартнаяОбработка) +// СтандартныеПодсистемыСервер.УстановитьУсловноеОформлениеПоляДата(ЭтотОбъект); +// +Процедура УстановитьУсловноеОформлениеПоляДата(Форма, Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыСервер.УстановитьУсловноеОформлениеПоляДата(Форма, ); +``` +
+ +## ЗапрашиватьПодтверждениеПриЗавершенииПрограммы +
+ +Описание, пример вызова + +```bsl + +// Получает настройку необходимости выводить подтверждение при завершении работы программы +// для текущего пользователя. Предназначена для использования в форме персональных настроек +// пользователя. +// +// Возвращаемое значение: +// Булево - если Истина, то пользователю при закрытии программы будет показано +// окно с подтверждением завершения сеанса. +// +Функция ЗапрашиватьПодтверждениеПриЗавершенииПрограммы() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыСервер.ЗапрашиватьПодтверждениеПриЗавершенииПрограммы() +``` +
+ +## НастройкиФорматовСохраненияТабличногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания форматов сохранения табличного документа. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ТипФайлаТабличногоДокумента - ТипФайлаТабличногоДокумента - значение, соответствующее формату; +// * Ссылка - ПеречислениеСсылка.ФорматыСохраненияОтчетов - ссылка на метаданные, где хранится представление; +// * Представление - Строка - представление типа файла (заполняется из перечисления); +// * Расширение - Строка - тип файла для операционной системы; +// * Картинка - Картинка - картинка формата. +// +Функция НастройкиФорматовСохраненияТабличногоДокумента() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыСервер.НастройкиФорматовСохраненияТабличногоДокумента() +``` +
+ +## ВерсияРежимаСовместимости +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию режима совместимости в формате нумерации редакций и версий, например, 8.3.15.0. +// +// Возвращаемое значение: +// Строка - версия режима совместимости в формате нумерации редакций и версий. +// +Функция ВерсияРежимаСовместимости() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыСервер.ВерсияРежимаСовместимости() +``` +
+ +## УстановитьОтображениеЗаголовковГрупп +
+ +Описание, пример вызова + +```bsl + +// Устарела. Веб-клиент более не поддерживает конфигурации, которые используют интерфейс версии 8.2. +// При работе в веб-клиенте отключена возможность переключения интерфейса +// между интерфейсом версии 8.2 и интерфейсом Такси. +// +// Устанавливает жирное оформление шрифта заголовков групп формы для их корректного отображения в интерфейсе 8.2. +// В интерфейсе "Такси" заголовки групп с обычным выделением и без выделения выводятся большим шрифтом. +// В интерфейсе 8.2 такие заголовки выводятся как обычные надписи и не ассоциируются с заголовками. +// Эта функция предназначена для визуального выделения (жирным шрифтом) заголовков групп в режиме интерфейса 8.2. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма для изменения шрифта заголовков групп; +// ИменаГрупп - Строка - список имен групп формы, разделенных запятыми. Если имена групп не указаны, +// то оформление будет применено ко всем группам на форме. +// +// Пример: +// Процедура ПриСозданииНаСервере(Отказ, СтандартнаяОбработка) +// СтандартныеПодсистемыСервер.УстановитьОтображениеЗаголовковГрупп(ЭтотОбъект); +// +Процедура УстановитьОтображениеЗаголовковГрупп(Форма, ИменаГрупп = "") Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыСервер.УстановитьОтображениеЗаголовковГрупп(Форма, ИменаГрупп); +``` +
+ +## ПоказыватьПредупреждениеОбУстановленныхОбновленияхПрограммы +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак необходимости показа всплывающего уведомления об установленных +// обновлениях программы - динамическом обновлении программы, новых патчей и расширений. +// +// Возвращаемое значение: +// Булево - если Истина, то всплывающие уведомления включены. +// +Функция ПоказыватьПредупреждениеОбУстановленныхОбновленияхПрограммы() Экспорт +``` + +Пример вызова +```bsl +Результат = СтандартныеПодсистемыСервер.ПоказыватьПредупреждениеОбУстановленныхОбновленияхПрограммы() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтандартныеПодсистемыСерверЛокализация.md b/src/content/docs/bsp/СтандартныеПодсистемыСерверЛокализация.md new file mode 100644 index 0000000..2d56b98 --- /dev/null +++ b/src/content/docs/bsp/СтандартныеПодсистемыСерверЛокализация.md @@ -0,0 +1,85 @@ +--- +title: Стандартные подсистемы сервер локализация +slug: bsp/стандартные-подсистемы-сервер-локализация +--- + + +## ПриНастройкеФорматовСохраненияТабличногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Позволяет добавить новые или поменять форматы сохранения табличного документа, +// в зависимости от национальной специфики. Например, указать те форматы, в которых +// принимают документы в местных контролирующих органах. +// +// Параметры: +// ТаблицаФорматов - см. СтандартныеПодсистемыСервер.НастройкиФорматовСохраненияТабличногоДокумента +// +Процедура ПриНастройкеФорматовСохраненияТабличногоДокумента(ТаблицаФорматов) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыСерверЛокализация.ПриНастройкеФорматовСохраненияТабличногоДокумента(ТаблицаФорматов) +``` +
+ +## ПриОпределенииМинимальнойИРекомендуемойВерсийПлатформы +
+ +Описание, пример вызова + +```bsl + +// Процедура доопределяет минимальную и рекомендуемую версии платформы "1С:Предприятие" для работы конфигурации, +// заданные в ОбщегоНазначенияПереопределяемый.ПриОпределенииОбщихПараметровБазовойФункциональности. +// Может использоваться для установки минимальной и рекомендуемой версий платформы по данным внешнего сервиса. +// +// Параметры: +// МинимальнаяВерсияПлатформы - см. ОбщегоНазначенияПереопределяемый.ПриОпределенииОбщихПараметровБазовойФункциональности.ОбщиеПараметры.МинимальнаяВерсияПлатформы +// РекомендуемаяВерсияПлатформы - см. ОбщегоНазначенияПереопределяемый.ПриОпределенииОбщихПараметровБазовойФункциональности.ОбщиеПараметры.РекомендуемаяВерсияПлатформы +// +Процедура ПриОпределенииМинимальнойИРекомендуемойВерсийПлатформы(МинимальнаяВерсияПлатформы, РекомендуемаяВерсияПлатформы) Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыСерверЛокализация.ПриОпределенииМинимальнойИРекомендуемойВерсийПлатформы(МинимальнаяВерсияПлатформы, РекомендуемаяВерсияПлатформы) +``` +
+ +## ПриНеверномЗаполненииМинимальнойИРекомендуемойВерсийПлатформы +
+ +Описание, пример вызова + +```bsl + +// Вызывается при неверном заполнении минимальной и рекомендуемой версий платформы +// в процедуре ПриОпределенииМинимальнойИРекомендуемойВерсийПлатформы. +// +// Параметры: +// УказаннаяМинимальная - Строка +// УказаннаяРекомендуемая - Строка +// ТребуемаяБСПМинимальная - Строка +// ОбщиеПараметры - см. ОбщегоНазначения.ОбщиеПараметрыБазовойФункциональности +// +Процедура ПриНеверномЗаполненииМинимальнойИРекомендуемойВерсийПлатформы(УказаннаяМинимальная, УказаннаяРекомендуемая, Экспорт +``` + +Пример вызова +```bsl +СтандартныеПодсистемыСерверЛокализация.ПриНеверномЗаполненииМинимальнойИРекомендуемойВерсийПлатформы(УказаннаяМинимальная, УказаннаяРекомендуемая, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтроковыеФункции.md b/src/content/docs/bsp/СтроковыеФункции.md new file mode 100644 index 0000000..117e32d --- /dev/null +++ b/src/content/docs/bsp/СтроковыеФункции.md @@ -0,0 +1,123 @@ +--- +title: Строковые функции +slug: bsp/строковые-функции +--- + + +## ФорматированнаяСтрока +
+ +Описание, пример вызова + +```bsl + +// Форматирует строку в соответствии с заданным шаблоном. +// Возможные значения тегов в шаблоне: +// - Строка - оформляет текст описанными +// в атрибуте style элементами стиля. +// - Строка - выделяет строку элементом стиля ВажнаяНадписьШрифт, +// который соответствует полужирному шрифту. +// - Строка - добавляет гиперссылку. +// - - добавляет картинку из библиотеки картинок. +// Атрибут style применяется для оформления текста. Атрибут может быть использован для тегов span и a. +// Вначале следует имя стилевого свойства, затем через двоеточие имя элемента стиля. +// Стилевые свойства: +// - color - Определяет цвет текста. Например, color: ГиперссылкаЦвет; +// - background-color - Определяет цвет фона у текста. Например, background-color: ИтогиФонГруппы; +// - font - Определяет шрифт текста.Например, font: ОсновнойЭлементСписка. +// Стилевые свойства разделяются точкой с запятой. Например, style="color: ГиперссылкаЦвет; font: ОсновнойЭлементСписка" +// Вложенные теги не поддерживаются. +// +// Параметры: +// ШаблонСтроки - Строка - строка, содержащая теги форматирования. +// Параметр - Строка - значение подставляемого параметра. +// +// Возвращаемое значение: +// ФорматированнаяСтрока - преобразованная строка. +// +// Пример: +// 1. СтроковыеФункцииКлиент.ФорматированнаяСтрока(НСтр("ru=' +// Минимальная версия приложения 1.1. +// Обновите приложение.'")); +// 2. СтроковыеФункцииКлиент.ФорматированнаяСтрока(НСтр("ru='Режим: +// Редактирование'")); +// 3. СтроковыеФункцииКлиент.ФорматированнаяСтрока(НСтр("ru='Текущая дата +// %1'"), ТекущаяДатаСеанса()); +// +Функция ФорматированнаяСтрока(Знач ШаблонСтроки, Знач Параметр1 = Неопределено, Знач Параметр2 = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункции.ФорматированнаяСтрока(ШаблонСтроки, Параметр1, Параметр2, ); +``` +
+ +## СтрокаЛатиницей +
+ +Описание, пример вызова + +```bsl + +// Преобразует исходную строку в транслит. +// Может использоваться для отправки SMS-сообщений латиницей или для сохранения +// файлов и папок, чтобы обеспечить возможность их переноса между разными операционными системами. +// Обратное преобразование из латинских символов не предусмотрено. +// +// Параметры: +// Значение - Строка - произвольная строка. +// +// Возвращаемое значение: +// Строка - строка, в которой кириллица заменена на транслит. +// +Функция СтрокаЛатиницей(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункции.СтрокаЛатиницей(Значение) +``` +
+ +## ПредставлениеПериодаВТексте +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление периода в нижнем регистре или с заглавной буквы, +// если с него начинается фраза (предложение). +// Например, если требуется вывести представление периода в заголовке отчета +// в формате "Продажи за [ДатаНачала] - [ДатаОкончания]", то ожидается, что +// результат будет выглядеть так: "Продажи за февраль 2020 г. - март 2020 г.". +// Т.е. - строчно, т.к. "февраль 2020 г. - март 2020 г." не является началом предложения. +// +// Параметры: +// ДатаНачала - Дата - начало периода. +// ДатаОкончания - Дата - конец периода. +// ФорматнаяСтрока - Строка - определяет способ форматирования периода. +// СЗаглавнойБуквы - Булево - Истина, если с представления периода начинается предложение. +// По умолчанию - Ложь. +// +// Возвращаемое значение: +// Строка - представление периода в требуемом формате и регистре. +// +Функция ПредставлениеПериодаВТексте(ДатаНачала, ДатаОкончания, ФорматнаяСтрока = "", СЗаглавнойБуквы = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункции.ПредставлениеПериодаВТексте(ДатаНачала, ДатаОкончания, ФорматнаяСтрока, СЗаглавнойБуквы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтроковыеФункцииКлиент.md b/src/content/docs/bsp/СтроковыеФункцииКлиент.md new file mode 100644 index 0000000..93eb769 --- /dev/null +++ b/src/content/docs/bsp/СтроковыеФункцииКлиент.md @@ -0,0 +1,123 @@ +--- +title: Строковые функции клиент +slug: bsp/строковые-функции-клиент +--- + + +## ФорматированнаяСтрока +
+ +Описание, пример вызова + +```bsl + +// Форматирует строку в соответствии с заданным шаблоном. +// Возможные значения тегов в шаблоне: +// - Строка - оформляет текст описанными +// в атрибуте style элементами стиля. +// - Строка - выделяет строку элементом стиля ВажнаяНадписьШрифт, +// который соответствует полужирному шрифту. +// - Строка - добавляет гиперссылку. +// - - добавляет картинку из библиотеки картинок. +// Атрибут style применяется для оформления текста. Атрибут может быть использован для тегов span и a. +// Вначале следует имя стилевого свойства, затем через двоеточие имя элемента стиля. +// Стилевые свойства: +// - color - Определяет цвет текста. Например, color: ГиперссылкаЦвет; +// - background-color - Определяет цвет фона у текста. Например, background-color: ИтогиФонГруппы; +// - font - Определяет шрифт текста.Например, font: ОсновнойЭлементСписка. +// Стилевые свойства разделяются точкой с запятой. Например, style="color: ГиперссылкаЦвет; font: ОсновнойЭлементСписка" +// Вложенные теги не поддерживаются. +// +// Параметры: +// ШаблонСтроки - Строка - строка, содержащая теги форматирования. +// Параметр - Строка - значение подставляемого параметра. +// +// Возвращаемое значение: +// ФорматированнаяСтрока - преобразованная строка. +// +// Пример: +// 1. СтроковыеФункцииКлиент.ФорматированнаяСтрока(НСтр("ru=' +// Минимальная версия приложения 1.1. +// Обновите приложение.'")); +// 2. СтроковыеФункцииКлиент.ФорматированнаяСтрока(НСтр("ru='Режим: +// Редактирование'")); +// 3. СтроковыеФункцииКлиент.ФорматированнаяСтрока(НСтр("ru='Текущая дата +// %1'"), ТекущаяДатаСеанса()); +// +Функция ФорматированнаяСтрока(Знач ШаблонСтроки, Знач Параметр1 = Неопределено, Знач Параметр2 = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиент.ФорматированнаяСтрока(ШаблонСтроки, Параметр1, Параметр2, ); +``` +
+ +## СтрокаЛатиницей +
+ +Описание, пример вызова + +```bsl + +// Преобразует исходную строку в транслит. +// Может использоваться для отправки SMS-сообщений латиницей или для сохранения +// файлов и папок, чтобы обеспечить возможность их переноса между разными операционными системами. +// Обратное преобразование из латинских символов не предусмотрено. +// +// Параметры: +// Значение - Строка - произвольная строка. +// +// Возвращаемое значение: +// Строка - строка, в которой кириллица заменена на транслит. +// +Функция СтрокаЛатиницей(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиент.СтрокаЛатиницей(Значение) +``` +
+ +## ПредставлениеПериодаВТексте +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление периода в нижнем регистре или с заглавной буквы, +// если с него начинается фраза (предложение). +// Например, если требуется вывести представление периода в заголовке отчета +// в формате "Продажи за [ДатаНачала] - [ДатаОкончания]", то ожидается, что +// результат будет выглядеть так: "Продажи за февраль 2020 г. - март 2020 г.". +// Т.е. - строчно, т.к. "февраль 2020 г. - март 2020 г." не является началом предложения. +// +// Параметры: +// ДатаНачала - Дата - начало периода. +// ДатаОкончания - Дата - конец периода. +// ФорматнаяСтрока - Строка - определяет способ форматирования периода. +// СЗаглавнойБуквы - Булево - Истина, если с представления периода начинается предложение. +// По умолчанию - Ложь. +// +// Возвращаемое значение: +// Строка - представление периода в требуемом формате и регистре. +// +Функция ПредставлениеПериодаВТексте(ДатаНачала, ДатаОкончания, ФорматнаяСтрока = "", СЗаглавнойБуквы = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиент.ПредставлениеПериодаВТексте(ДатаНачала, ДатаОкончания, ФорматнаяСтрока, СЗаглавнойБуквы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтроковыеФункцииКлиентСервер.md b/src/content/docs/bsp/СтроковыеФункцииКлиентСервер.md new file mode 100644 index 0000000..47bc134 --- /dev/null +++ b/src/content/docs/bsp/СтроковыеФункцииКлиентСервер.md @@ -0,0 +1,907 @@ +--- +title: Строковые функции клиент сервер +slug: bsp/строковые-функции-клиент-сервер +--- + + +## РазложитьСтрокуВМассивПодстрок +
+ +Описание, пример вызова + +```bsl + +// Разбивает строку на несколько строк по указанному разделителю. Разделитель может иметь любую длину. +// В случаях, когда разделителем является строка из одного символа, и не используется параметр СокращатьНепечатаемыеСимволы, +// рекомендуется использовать функцию платформы СтрРазделить. +// +// Параметры: +// Значение - Строка - текст с разделителями. +// Разделитель - Строка - разделитель строк текста, минимум 1 символ. +// ПропускатьПустыеСтроки - Булево - признак необходимости включения в результат пустых строк. +// Если параметр не задан, то функция работает в режиме совместимости со своей предыдущей версией: +// > для разделителя-пробела пустые строки не включаются в результат, для остальных разделителей пустые строки +// включаются в результат; +// > если параметр Строка не содержит значащих символов или не содержит ни одного символа (пустая строка), то в +// случае разделителя-пробела результатом функции будет массив, содержащий одно значение "" (пустая строка), а +// при других разделителях результатом функции будет пустой массив. +// СокращатьНепечатаемыеСимволы - Булево - сокращать непечатаемые символы по краям каждой из найденных подстрок. +// +// Возвращаемое значение: +// Массив из Строка +// +// Пример: +// СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивПодстрок(",один,,два,", ",") +// - возвратит массив из 5 элементов, три из которых - пустые: "", "один", "", "два", ""; +// СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивПодстрок(",один,,два,", ",", Истина) +// - возвратит массив из двух элементов: "один", "два"; +// СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивПодстрок(" один два ", " ") +// - возвратит массив из двух элементов: "один", "два"; +// СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивПодстрок("") +// - возвратит пустой массив; +// СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивПодстрок("",,Ложь) +// - возвратит массив с одним элементом: ""(пустая строка); +// СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивПодстрок("", " ") +// - возвратит массив с одним элементом: "" (пустая строка). +// +Функция РазложитьСтрокуВМассивПодстрок(Знач Значение, Знач Разделитель = ",", Знач ПропускатьПустыеСтроки = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивПодстрок(Значение, Разделитель, ", ПропускатьПустыеСтроки, ); +``` +
+ +## ЭтоРазделительСлов +
+ +Описание, пример вызова + +```bsl + +// Определяет, является ли символ разделителем. +// +// Параметры: +// КодСимвола - Число - код проверяемого символа; +// РазделителиСлов - Строка - символы разделителей. Если параметр не указан, то +// разделителем считаются все символы, не являющиеся цифрами, +// латинскими и кириллическими буквами, а также знаком подчеркивания. +// +// Возвращаемое значение: +// Булево - Истина, если символ с кодом КодСимвола является разделителем. +// +Функция ЭтоРазделительСлов(КодСимвола, РазделителиСлов = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ЭтоРазделительСлов(КодСимвола, РазделителиСлов); +``` +
+ +## РазложитьСтрокуВМассивСлов +
+ +Описание, пример вызова + +```bsl + +// Разбивает строку на несколько строк, используя заданный набор разделителей. +// Если параметр РазделителиСлов не задан, то разделителем слов считается любой из символов, +// не относящихся к символам латиницы, кириллицы, цифры, подчеркивания. +// +// Параметры: +// Значение - Строка - исходная строка, которую необходимо разложить на слова. +// РазделителиСлов - Строка - перечень символов-разделителей. Например, ".,;". +// +// Возвращаемое значение: +// Массив - список слов. +// +// Пример: +// СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивСлов("один-@#два2_!три") возвратит массив значений: "один", +// "два2_", "три"; СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивСлов("один-@#два2_!три", "#@!_") возвратит массив +// значений: "один-", "два2", "три". +// +Функция РазложитьСтрокуВМассивСлов(Знач Значение, РазделителиСлов = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.РазложитьСтрокуВМассивСлов(Значение, РазделителиСлов); +``` +
+ +## ПодставитьПараметрыВСтроку +
+ +Описание, пример вызова + +```bsl + +// Подставляет параметры в строку. Максимально возможное число параметров - 9. +// Параметры в строке задаются как %<номер параметра>. Нумерация параметров начинается с единицы. +// +// Параметры: +// ШаблонСтроки - Строка - шаблон строки с параметрами (вхождениями вида "%<номер параметра>", +// например "%1 пошел в %2"); +// Параметр1 - Строка - значение подставляемого параметра. +// Параметр2 - Строка +// Параметр3 - Строка +// Параметр4 - Строка +// Параметр5 - Строка +// Параметр6 - Строка +// Параметр7 - Строка +// Параметр8 - Строка +// Параметр9 - Строка +// +// Возвращаемое значение: +// Строка - текстовая строка с подставленными параметрами. +// +// Пример: +// СтроковыеФункцииКлиентСервер.ПодставитьПараметрыВСтроку(НСтр("ru='%1 пошел в %2'"), "Вася", "Зоопарк") = "Вася пошел +// в Зоопарк". +// +Функция ПодставитьПараметрыВСтроку(Знач ШаблонСтроки, Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ПодставитьПараметрыВСтроку(ШаблонСтроки, ); +``` +
+ +## ПодставитьПараметрыВСтрокуИзМассива +
+ +Описание, пример вызова + +```bsl + +// Подставляет параметры в строку. Число параметров в строке не ограничено. +// Параметры в строке задаются как %<номер параметра>. Нумерация параметров +// начинается с единицы. +// +// Параметры: +// ШаблонСтроки - Строка - шаблон строки с параметрами (вхождениями вида "%<номер параметра>", +// например "%1 пошел в %2"); +// Параметры - Массив - значения параметров в строке ШаблонСтроки. +// +// Возвращаемое значение: +// Строка - строка с подставленными значениями параметрами. +// +// Пример: +// ЗначенияПараметров = Новый Массив; +// ЗначенияПараметров.Добавить("Вася"); +// ЗначенияПараметров.Добавить("Зоопарк"); +// Результат = СтроковыеФункцииКлиентСервер.ПодставитьПараметрыВСтрокуИзМассива(НСтр("ru='%1 пошел в %2'"), ЗначенияПараметров); +// - вернет строку "Вася пошел в Зоопарк". +// +Функция ПодставитьПараметрыВСтрокуИзМассива(Знач ШаблонСтроки, Знач Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ПодставитьПараметрыВСтрокуИзМассива(ШаблонСтроки, Параметры) +``` +
+ +## ВставитьПараметрыВСтроку +
+ +Описание, пример вызова + +```bsl + +// Заменяет в шаблоне строки имена параметров на их значения. Параметры в строке выделяются с двух сторон квадратными +// скобками. +// +// Параметры: +// ШаблонСтроки - Строка - строка, в которую необходимо вставить значения. +// Параметры - Структура - подставляемые значения параметров, где ключ - имя параметра без спецсимволов, +// значение - вставляемое значение. +// +// Возвращаемое значение: +// Строка - строка со вставленными значениями. +// +// Пример: +// Значения = Новый Структура("Фамилия,Имя", "Пупкин", "Вася"); +// Результат = СтроковыеФункцииКлиентСервер.ВставитьПараметрыВСтроку("Здравствуй, [Имя] [Фамилия].", Значения); +// - возвращает: "Здравствуй, Вася Пупкин". +// +Функция ВставитьПараметрыВСтроку(Знач ШаблонСтроки, Знач Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ВставитьПараметрыВСтроку(ШаблонСтроки, Параметры) +``` +
+ +## ПараметрыИзСтроки +
+ +Описание, пример вызова + +```bsl + +// Получает значения параметров из строки. +// +// Параметры: +// СтрокаПараметров - Строка - строка, содержащая параметры, каждый из которых представляет собой +// фрагмент вида <Имя параметра>=<Значение>, где: +// Имя параметра - имя параметра; +// Значение - его значение. +// Фрагменты отделяются друг от друга символами ';'. +// Если значение содержит пробельные символы, то оно должно быть заключено в двойные +// кавычки ("). +// Например: +// "File=""c:\InfoBases\Trade""; Usr=""Director"";" +// Разделитель - Строка - символ, которым фрагменты отделяются друг от друга. +// +// Возвращаемое значение: +// Структура - значения параметров, где ключ - имя параметра, значение - значение параметра. +// +// Пример: +// Результат = СтроковыеФункцииКлиентСервер.ПараметрыИзСтроки("File=""c:\InfoBases\Trade""; Usr=""Director"";""", ";"); +// - вернет структуру: +// ключ "File" и значение "c:\InfoBases\Trade" +// ключ "Usr" и значение "Director". +// +Функция ПараметрыИзСтроки(Знач СтрокаПараметров, Знач Разделитель = ";") Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ПараметрыИзСтроки(СтрокаПараметров, Разделитель); +``` +
+ +## ТолькоЦифрыВСтроке +
+ +Описание, пример вызова + +```bsl + +// Проверяет, содержит ли строка только цифры. +// +// Параметры: +// Значение - Строка - проверяемая строка. +// Устаревший - Булево - устаревший параметр, не используется. +// ПробелыЗапрещены - Булево - если Ложь, то в строке допустимо наличие пробелов. +// +// Возвращаемое значение: +// Булево - Истина - строка содержит только цифры или пустая, Ложь - строка содержит иные символы. +// +// Пример: +// Результат = СтроковыеФункцииКлиентСервер.ТолькоЦифрыВСтроке("0123"); // Истина +// Результат = СтроковыеФункцииКлиентСервер.ТолькоЦифрыВСтроке("0123abc"); // Ложь +// Результат = СтроковыеФункцииКлиентСервер.ТолькоЦифрыВСтроке("01 2 3",, Ложь); // Истина +// +Функция ТолькоЦифрыВСтроке(Знач Значение, Знач Устаревший = Истина, Знач ПробелыЗапрещены = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ТолькоЦифрыВСтроке(Значение, Устаревший, ПробелыЗапрещены); +``` +
+ +## ТолькоЛатиницаВСтроке +
+ +Описание, пример вызова + +```bsl + +// Проверяет, содержит ли строка только символы латинского алфавита. +// +// Параметры: +// СтрокаПроверки - Строка - проверяемая строка. +// УчитыватьРазделителиСлов - Булево - учитывать ли разделители слов или они являются исключением. +// ДопустимыеСимволы - Строка - дополнительные разрешенные символы, кроме латиницы. +// +// Возвращаемое значение: +// Булево - Истина, если строка содержит только латинские (или допустимые) символы; +// Ложь, если строка содержит иные символы. +// +Функция ТолькоЛатиницаВСтроке(Знач СтрокаПроверки, Знач УчитыватьРазделителиСлов = Истина, ДопустимыеСимволы = "") Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ТолькоЛатиницаВСтроке(СтрокаПроверки, УчитыватьРазделителиСлов, ДопустимыеСимволы); +``` +
+ +## ТолькоСимволыНациональногоАлфавитаВСтроке +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие в строке посторонних символов. +// +// Параметры: +// ПроверяемаяСтрока - Строка - проверяемая строка. +// ДополнительныеДопустимыеСимволы - Неопределено, Строка - дополнительные разрешенные символы. Если Параметр не +// указан, то +// допустимыми символами считаются непечатные символы: пробел, неразрывный пробел, табуляция, перевод строки +// и перевод формы. +// +// Возвращаемое значение: +// Булево - Истина, если строка содержит только допустимые символы или пустая; +// Ложь, если строка содержит иные символы. +// +Функция ТолькоСимволыНациональногоАлфавитаВСтроке(Знач ПроверяемаяСтрока, Знач ДополнительныеДопустимыеСимволы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ТолькоСимволыНациональногоАлфавитаВСтроке(ПроверяемаяСтрока, ДополнительныеДопустимыеСимволы); +``` +
+ +## СократитьДвойныеКавычки +
+ +Описание, пример вызова + +```bsl + +// Удаляет двойные кавычки с начала и конца строки, если они есть. +// +// Параметры: +// Значение - Строка - входная строка. +// +// Возвращаемое значение: +// Строка - строка без двойных кавычек. +// +Функция СократитьДвойныеКавычки(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.СократитьДвойныеКавычки(Значение) +``` +
+ +## УдалитьПоследнийСимволВСтроке +
+ +Описание, пример вызова + +```bsl + +// Удаляет из строки указанное количество символов справа. +// +// Параметры: +// Текст - Строка - строка, в которой необходимо удалить последние символы; +// ЧислоСимволов - Число - количество удаляемых символов. +// +Процедура УдалитьПоследнийСимволВСтроке(Текст, ЧислоСимволов = 1) Экспорт +``` + +Пример вызова +```bsl +СтроковыеФункцииКлиентСервер.УдалитьПоследнийСимволВСтроке(Текст, ЧислоСимволов); +``` +
+ +## ЭтоУникальныйИдентификатор +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли строка уникальным идентификатором. +// В качестве уникального идентификатора предполагается строка вида +// "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", где X = [0..9,a..f]. +// +// Параметры: +// Значение - Строка - проверяемая строка. +// +// Возвращаемое значение: +// Булево - Истина, если переданная строка является уникальным идентификатором. +// +Функция ЭтоУникальныйИдентификатор(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ЭтоУникальныйИдентификатор(Значение) +``` +
+ +## СформироватьСтрокуСимволов +
+ +Описание, пример вызова + +```bsl + +// Формирует строку повторяющихся символов заданной длины. +// +// Параметры: +// Символ - Строка - символ, из которого будет формироваться строка. +// ДлинаСтроки - Число - требуемая длина результирующей строки. +// +// Возвращаемое значение: +// Строка +// +Функция СформироватьСтрокуСимволов(Знач Символ, Знач ДлинаСтроки) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.СформироватьСтрокуСимволов(Символ, ДлинаСтроки) +``` +
+ +## ДополнитьСтроку +
+ +Описание, пример вызова + +```bsl + +// Дополняет строку символами слева или справа до заданной длины и возвращает ее. +// При этом удаляются незначащие символы слева и справа (подробнее про незначащие символы +// см. синтакс-помощник к методу платформы СокрЛП). +// По умолчанию функция дополняет строку символами "0" (ноль) слева. +// +// Параметры: +// Значение - Строка - исходная строка, которую необходимо дополнить символами; +// ДлинаСтроки - Число - требуемая результирующая длина строки; +// Символ - Строка - символ, которым необходимо дополнить строку; +// Режим - Строка - "Слева" или "Справа" - вариант добавления символов к исходной строке. +// +// Возвращаемое значение: +// Строка - строка, дополненная символами. +// +// Пример: +// 1. Результат = СтроковыеФункцииКлиентСервер.ДополнитьСтроку("1234", 10, "0", "Слева"); +// Возвращает: "0000001234". +// +// 2. Результат = СтроковыеФункцииКлиентСервер.ДополнитьСтроку(" 1234 ", 10, "#", "Справа"); +// Строка = " 1234 "; ДлинаСтроки = 10; Символ = "#"; Режим = "Справа" +// Возвращает: "1234######". +// +Функция ДополнитьСтроку(Знач Значение, Знач ДлинаСтроки, Знач Символ = "0", Знач Режим = "Слева") Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ДополнитьСтроку(Значение, ДлинаСтроки, Символ, Режим); +``` +
+ +## УдалитьПовторяющиесяСимволы +
+ +Описание, пример вызова + +```bsl + +// Удаляет крайние повторяющиеся символы слева или справа в строке. +// +// Параметры: +// Значение - Строка - исходная строка, из которой необходимо удалить крайние повторяющиеся символы; +// УдаляемыйСимвол - Строка - искомый символ для удаления; +// Режим - Строка - "Слева" или "Справа" - режим удаления символов в исходной строке. +// +// Возвращаемое значение: +// Строка - обрезанная строка. +// +Функция УдалитьПовторяющиесяСимволы(Знач Значение, Знач УдаляемыйСимвол, Знач Режим = "Слева") Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.УдалитьПовторяющиесяСимволы(Значение, УдаляемыйСимвол, Режим); +``` +
+ +## ЗаменитьОдниСимволыДругими +
+ +Описание, пример вызова + +```bsl + +// Выполняет замену символов в строке. +// Предназначена для простых случаев - например, для замены латиницы на похожие кириллические символы. +// +// Параметры: +// ЗаменяемыеСимволы - Строка - строка символов, каждый из которых требует замены; +// Значение - Строка - исходная строка, в которой требуется замена символов; +// СимволыЗамены - Строка - строка символов, на каждый из которых нужно заменить символы параметра +// ЗаменяемыеСимволы. +// +// Возвращаемое значение: +// Строка - строка после замены символов. +// +Функция ЗаменитьОдниСимволыДругими(ЗаменяемыеСимволы, Значение, СимволыЗамены) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ЗаменитьОдниСимволыДругими(ЗаменяемыеСимволы, Значение, СимволыЗамены) +``` +
+ +## ПреобразоватьЧислоВРимскуюНотацию +
+ +Описание, пример вызова + +```bsl + +// Выполняет преобразование арабского числа в римское. +// +// Параметры: +// АрабскоеЧисло - Число - число, целое, от 0 до 999; +// ИспользоватьКириллицу - Булево - использовать в качестве арабских цифр кириллицу или латиницу. +// +// Возвращаемое значение: +// Строка - число в римской нотации. +// +// Пример: +// СтроковыеФункцииКлиентСервер.ПреобразоватьЧислоВРимскуюНотацию(17) = "XVII". +// +Функция ПреобразоватьЧислоВРимскуюНотацию(АрабскоеЧисло, ИспользоватьКириллицу = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ПреобразоватьЧислоВРимскуюНотацию(АрабскоеЧисло, ИспользоватьКириллицу); +``` +
+ +## ПреобразоватьЧислоВАрабскуюНотацию +
+ +Описание, пример вызова + +```bsl + +// Выполняет преобразование римского числа в арабское. +// +// Параметры: +// РимскоеЧисло - Строка - число, записанное римскими цифрами; +// ИспользоватьКириллицу - Булево - использовать в качестве арабских цифр кириллицу или латиницу. +// +// Возвращаемое значение: +// Число - преобразованное число. +// +// Пример: +// СтроковыеФункцииКлиентСервер.ПреобразоватьЧислоВАрабскуюНотацию("XVII") = 17. +// +Функция ПреобразоватьЧислоВАрабскуюНотацию(РимскоеЧисло, ИспользоватьКириллицу = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ПреобразоватьЧислоВАрабскуюНотацию(РимскоеЧисло, ИспользоватьКириллицу); +``` +
+ +## ИзвлечьТекстИзHTML +
+ +Описание, пример вызова + +```bsl + +// Очищает текст в формате HTML от тегов и возвращает неформатированный текст. +// +// Параметры: +// ИсходныйТекст - Строка - текст в формате HTML. +// +// Возвращаемое значение: +// Строка - текст, очищенный от тегов, скриптов и заголовков. +// +Функция ИзвлечьТекстИзHTML(Знач ИсходныйТекст) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ИзвлечьТекстИзHTML(ИсходныйТекст) +``` +
+ +## СтрокаВЧисло +
+ +Описание, пример вызова + +```bsl + +// Преобразует исходную строку в число без вызова исключений. +// +// Параметры: +// Значение - Строка - строка, которую необходимо привести к числу. +// Например, "10", "+10", "010", вернет 10; +// "(10)", "-10",вернет -10; +// "10,2", "10.2",вернет 10.2; +// "000", " ", "",вернет 0; +// "10текст", вернет Неопределено. +// +// Возвращаемое значение: +// Число, Неопределено - полученное число, либо Неопределено, если строка не является числом. +// +Функция СтрокаВЧисло(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.СтрокаВЧисло(Значение) +``` +
+ +## СтрокаВДату +
+ +Описание, пример вызова + +```bsl + +// Преобразует исходную строку в дату. +// Если дату не удалось распознать, то возвращается пустая дата (01.01.01 00:00:00). +// +// Параметры: +// Значение - Строка - строка, которую необходимо привести к дате. +// Формат даты должен быть в виде "ДД.ММ.ГГГГ" или "ДД/ММ/ГГ" или "ДД-ММ-ГГ ЧЧ:ММ:CC", +// Например, "23.02.1980" или "23/02/80 09:15:45". +// ЧастьДаты - ЧастиДаты - определяет допустимые части даты. По умолчанию, ЧастиДаты.Дата. +// +// Возвращаемое значение: +// Дата +// +Функция СтрокаВДату(Знач Значение, ЧастьДаты = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.СтрокаВДату(Значение, ЧастьДаты); +``` +
+ +## СтрокаСЧисломДляЛюбогоЯзыка +
+ +Описание, пример вызова + +```bsl + +// Формирует представление числа для определенного языка и параметров числа. +// Представление параметров: +// ┌──────┬──────┬─────────────────┬────────────────┬───────────────────┬───────────────────────┬────────────────┐ +// │ Lang │ Zero │ One │ Two │ Few │ Many │ Other │ +// ├──────┼──────┼─────────────────┼────────────────┼───────────────────┼───────────────────────┼────────────────┤ +// │ ru │ │ XX1 / X11 │ │ XX2─XX4 / X12─X14 │ XX0, XX5─XX9, X11─X14 │ дробные │ +// │ Card.│ │ остался %1 день │ │ осталось %1 дня │ осталось %1 дней │ осталось %1 дня│ +// │ │ │ вижу %1 рыбу │ │ вижу %1─х рыб │ вижу %5 рыб │ вижу %1 рыбы │ +// ├──────┼──────┼─────────────────┼────────────────┼───────────────────┼───────────────────────┼────────────────┤ +// │ ru │ │ │ │ │ │ других нет │ +// │ Ord. │ │ │ │ │ │ %1─й день │ +// ├──────┼──────┼─────────────────┼────────────────┼───────────────────┼───────────────────────┼────────────────┤ +// │ en │ │ для 1 │ │ │ │ остальное │ +// │ Card.│ │ left %1 day │ │ │ │ left %1 days │ +// ├──────┼──────┼─────────────────┼────────────────┼───────────────────┼───────────────────────┼────────────────┤ +// │ en │ │ XX1 / X11 │ XX2 / X12 │ XX3 / X13 │ │ остальное │ +// │ Ord. │ │ %1st day │ %1nd day │ %1rd day │ │ %1th day. │ +// └──────┴──────┴─────────────────┴────────────────┴───────────────────┴───────────────────────┴────────────────┘ +// ┌──────┬───────────────────────────┐ +// │Card. │ Cardinal ─ Количественное;│ +// │ Ord. │ Ordinal - Порядковое; │ +// ├──────┼───────────────────────────┤ +// │ X │ любая цифра; │ +// │ / │ кроме. │ +// └──────┴───────────────────────────┘ +// +// Параметры: +// Шаблон - Строка - строка, содержит перечисленные через точку с запятой 6 форм строки +// для каждой категории числительного: +// %1 обозначает позицию числа; +// Число - Число - число, которое будет подставлено в строку вместо параметра "%1". +// Вид - ВидЧисловогоЗначения - определяет вид числового значения, для которого формируется представление. +// Количественное (по умолчанию) или Порядковое. +// ФорматнаяСтрока - Строка - строка параметров форматирования. См. аналогичный параметр в СтрокаСЧислом. +// +// Возвращаемое значение: +// Строка - представление строки числа в требуемой форме. +// +// Пример: +// +// Строка = СтроковыеФункцииКлиентСервер.СтрокаСЧисломДляЛюбогоЯзыка( +// НСтр("ru=';остался %1 день;;осталось %1 дня;осталось %1 дней;осталось %1 дня'; +// |en=';%1 day left;;;;%1 days left'"), +// 0.05,, "ЧДЦ=1"); +// +Функция СтрокаСЧисломДляЛюбогоЯзыка(Шаблон, Число, Вид = Неопределено, ФорматнаяСтрока = "ЧН=0;") Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.СтрокаСЧисломДляЛюбогоЯзыка(Шаблон, Число, Вид, ФорматнаяСтрока); +``` +
+ +## ФорматированнаяСтрока +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать см. СтроковыеФункции.ФорматированнаяСтрока +// или см. СтроковыеФункцииКлиент.ФорматированнаяСтрока. +// +// Форматирует строку в соответствии с заданным шаблоном. +// Возможные значения тегов в шаблоне: +// - Строка - выделяет строку жирным шрифтом. +// - Строка - добавляет гиперссылку. +// Например, "Минимальная версия приложения 1.1. Обновите приложение.". +// +// Параметры: +// СтрокаСТегами - Строка - строка, содержащая теги форматирования. +// +// Возвращаемое значение: +// ФорматированнаяСтрока - преобразованная строка. +// +Функция ФорматированнаяСтрока(Знач СтрокаСТегами) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ФорматированнаяСтрока(СтрокаСТегами) +``` +
+ +## ЧислоЦифрамиПредметИсчисленияПрописью +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать см. СтроковыеФункцииКлиентСервер.СтрокаСЧисломДляЛюбогоЯзыка. +// +// ЧислоЦифрамиПредметИсчисленияПрописью(1.5, "минуту,минуты,минут"); +// ->СтрокаСЧисломДляЛюбогоЯзыка(";%1 минуту;;%1 минуты;%1 минут;%1 минуты ", Значение); +// +// ЧислоЦифрамиПредметИсчисленияПрописью(1.5, "минуту,минуты,минут ", Ложь); +// ->СтрокаСЧисломДляЛюбогоЯзыка(";минуту;;минуты;минут;минуты", Значение); +// +// Возвращает текстовое представление числа с единицей измерения в правильном склонении и числе. +// +// Параметры: +// Значение - Число - любое целое число. +// ПараметрыПредметаИсчисления - Строка - варианты написания единицы измерения для одной, +// для двух и для пяти единиц, разделитель - запятая. +// ДобавлятьЧислоКРезультату - Булево - при передаче значения Ложь число не будет добавлено к строке. +// +// Возвращаемое значение: +// Строка - текстовое представление количества единиц, число записывается цифрами. +// +// Пример: +// ЧислоЦифрамиПредметИсчисленияПрописью(23, "минуту,минуты,минут") = "23 минуты"; +// ЧислоЦифрамиПредметИсчисленияПрописью(15, "минуту,минуты,минут") = "15 минут". +// +Функция ЧислоЦифрамиПредметИсчисленияПрописью(Знач Значение, Знач ПараметрыПредметаИсчисления, Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ЧислоЦифрамиПредметИсчисленияПрописью(Значение, ПараметрыПредметаИсчисления, ); +``` +
+ +## ФормаМножественногоЧисла +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать см. СтроковыеФункцииКлиентСервер.СтрокаСЧисломДляЛюбогоЯзыка. +// +// ФормаМножественногоЧисла("минуту", "минуты", "минут", 1.5); +// -> СтрокаСЧисломДляЛюбогоЯзыка(";минуту;;минуты;минут;минуты", Значение); +// +// Возвращает единицу измерения в нужном склонении в зависимости от количества единиц. +// +// Параметры: +// ФормаДля1 - Строка - форма слова для одной единицы; +// ФормаДля2 - Строка - форма слова для двух единиц; +// ФормаДля5 - Строка - форма слова для пяти единиц; +// Значение - Число - любое целое число. +// +// Возвращаемое значение: +// Строка - единица изменения в нужном склонении. +// +// Пример: +// СтроковыеФункцииКлиентСервер.ФормаМножественногоЧисла("шкаф", "шкафа", "шкафов", 3); возвращает "шкафа". +// +Функция ФормаМножественногоЧисла(ФормаДля1, ФормаДля2, ФормаДля5, Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ФормаМножественногоЧисла(ФормаДля1, ФормаДля2, ФормаДля5, Значение) +``` +
+ +## ТолькоКириллицаВСтроке +
+ +Описание, пример вызова + +```bsl + +// Локализация + +// Устарела. Следует использовать см. СтроковыеФункцииКлиентСервер.ТолькоСимволыНациональногоАлфавитаВСтроке +// Проверяет, содержит ли строка только символы кириллического алфавита. +// +// Параметры: +// СтрокаПроверки - Строка - проверяемая строка. +// УчитыватьРазделителиСлов - Булево - учитывать ли разделители слов или они являются исключением. +// ДопустимыеСимволы - Строка - дополнительные разрешенные символы, кроме кириллицы. +// +// Возвращаемое значение: +// Булево - Истина, если строка содержит только кириллические (или допустимые) символы или пустая; +// Ложь, если строка содержит иные символы. +// +Функция ТолькоКириллицаВСтроке(Знач СтрокаПроверки, Знач УчитыватьРазделителиСлов = Истина, ДопустимыеСимволы = "") Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.ТолькоКириллицаВСтроке(СтрокаПроверки, УчитыватьРазделителиСлов, ДопустимыеСимволы); +``` +
+ +## СтрокаЛатиницей +
+ +Описание, пример вызова + +```bsl + +// Конец Локализация + +// Устарела. Следует использовать см. СтроковыеФункции.СтрокаЛатиницей +// или см. СтроковыеФункцииКлиент.СтрокаЛатиницей. +// +// Преобразует исходную строку в транслит. +// Может использоваться для отправки SMS-сообщений латиницей или для сохранения +// файлов и папок, чтобы обеспечить возможность их переноса между разными операционными системами. +// Обратное преобразование из латинских символов не предусмотрено. +// +// Параметры: +// Значение - Строка - произвольная строка. +// +// Возвращаемое значение: +// Строка - строка, в которой кириллица заменена на транслит. +// +Функция СтрокаЛатиницей(Знач Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСервер.СтрокаЛатиницей(Значение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтроковыеФункцииКлиентСерверЛокализация.md b/src/content/docs/bsp/СтроковыеФункцииКлиентСерверЛокализация.md new file mode 100644 index 0000000..d4b4b55 --- /dev/null +++ b/src/content/docs/bsp/СтроковыеФункцииКлиентСерверЛокализация.md @@ -0,0 +1,59 @@ +--- +title: Строковые функции клиент сервер локализация +slug: bsp/строковые-функции-клиент-сервер-локализация +--- + + +## ПриОпределенииСимволовНациональногоАлфавита +
+ +Описание, пример вызова + +```bsl + +// Определяет символы национального алфавита +// +// Параметры: +// СимволыНациональногоАлфавита - Строка +// ДополнительныеДопустимыеСимволы - Строка +// +Процедура ПриОпределенииСимволовНациональногоАлфавита(СимволыНациональногоАлфавита, ДополнительныеДопустимыеСимволы) Экспорт +``` + +Пример вызова +```bsl +СтроковыеФункцииКлиентСерверЛокализация.ПриОпределенииСимволовНациональногоАлфавита(СимволыНациональногоАлфавита, ДополнительныеДопустимыеСимволы) +``` +
+ +## ПриОпределенииСимволовСлов +
+ +Описание, пример вызова + +```bsl + +// Определяет коды символов, которые не считаются разделителем. +// Если явно не указан разделитель слов. +// +// Параметры: +// Диапазоны - Массив из Структура: +// * Мин - Число - код символа, с которого начинается диапазон. +// * Макс - Число - код символа, на котором заканчивается диапазон. +// +Процедура ПриОпределенииСимволовСлов(Диапазоны) Экспорт +``` + +Пример вызова +```bsl +СтроковыеФункцииКлиентСерверЛокализация.ПриОпределенииСимволовСлов(Диапазоны) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтроковыеФункцииКлиентСерверРФ.md b/src/content/docs/bsp/СтроковыеФункцииКлиентСерверРФ.md new file mode 100644 index 0000000..3608f4a --- /dev/null +++ b/src/content/docs/bsp/СтроковыеФункцииКлиентСерверРФ.md @@ -0,0 +1,40 @@ +--- +title: Строковые функции клиент сервер РФ +slug: bsp/строковые-функции-клиент-сервер-рф +--- + + +## ТолькоКириллицаВСтроке +
+ +Описание, пример вызова + +```bsl + +// Проверяет, содержит ли строка только символы кириллического алфавита. +// +// Параметры: +// СтрокаПроверки - Строка - проверяемая строка. +// УчитыватьРазделителиСлов - Булево - учитывать ли разделители слов или они являются исключением. +// ДопустимыеСимволы - Строка - дополнительные разрешенные символы, кроме кириллицы. +// +// Возвращаемое значение: +// Булево - Истина, если строка содержит только кириллические (или допустимые) символы или пустая; +// Ложь, если строка содержит иные символы. +// +Функция ТолькоКириллицаВСтроке(Знач СтрокаПроверки, Знач УчитыватьРазделителиСлов = Истина, ДопустимыеСимволы = "") Экспорт +``` + +Пример вызова +```bsl +Результат = СтроковыеФункцииКлиентСерверРФ.ТолькоКириллицаВСтроке(СтрокаПроверки, УчитыватьРазделителиСлов, ДопустимыеСимволы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СтруктураПодчиненностиПереопределяемый.md b/src/content/docs/bsp/СтруктураПодчиненностиПереопределяемый.md new file mode 100644 index 0000000..21f0ef7 --- /dev/null +++ b/src/content/docs/bsp/СтруктураПодчиненностиПереопределяемый.md @@ -0,0 +1,212 @@ +--- +title: Структура подчиненности переопределяемый +slug: bsp/структура-подчиненности-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Вызывается для получения настроек подсистемы. +// +// Параметры: +// Настройки - Структура: +// * Реквизиты - Соответствие из КлючИЗначение - для переопределения имен реквизитов объекта, в которых содержится информация +// о сумме и валюте, выводимых в списке связанных документов. +// В ключе указывается полное имя объекта метаданных, в значении - соответствие +// реквизитов Валюта и СуммаДокумента с реальными реквизитами объекта. +// Если не задано, то значения зачитываются из реквизитов Валюта и СуммаДокумента. +// * РеквизитыДляПредставления - Соответствие из КлючИЗначение - для переопределения представления объектов, выводимых +// в списке связанных документов. В ключе указывается полное имя объекта метаданных, в +// значении - массив имен реквизитов, значения которых участвуют в формировании представления. +// Для формирования представления перечисленных здесь объектов будет вызываться +// процедура СтруктураПодчиненностиПереопределяемый.ПриПолученииПредставления. +// +// Пример: +// Реквизиты = Новый Соответствие; +// Реквизиты.Вставить("СуммаДокумента", Метаданные.Документы.СчетНаОплатуПокупателю.Реквизиты.СуммаОплаты.Имя); +// Реквизиты.Вставить("Валюта", Метаданные.Документы.СчетНаОплатуПокупателю.Реквизиты.ВалютаДокумента.Имя); +// Настройки.Реквизиты.Вставить(Метаданные.Документы.СчетНаОплатуПокупателю.ПолноеИмя(), Реквизиты); +// +// РеквизитыДляПредставления = Новый Массив; +// РеквизитыДляПредставления.Добавить(Метаданные.Документы.ЭлектронноеПисьмоИсходящее.Реквизиты.ДатаОтправления.Имя); +// РеквизитыДляПредставления.Добавить(Метаданные.Документы.ЭлектронноеПисьмоИсходящее.Реквизиты.Тема.Имя); +// РеквизитыДляПредставления.Добавить(Метаданные.Документы.ЭлектронноеПисьмоИсходящее.Реквизиты.СписокПолучателейПисьма.Имя); +// Настройки.РеквизитыДляПредставления.Вставить(Метаданные.Документы.ЭлектронноеПисьмоИсходящее.ПолноеИмя(), +// РеквизитыДляПредставления); +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +СтруктураПодчиненностиПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриПолученииПредставления +
+ +Описание, пример вызова + +```bsl + +// Вызывается для получения представления объектов, выводимых в списке связанных документов. +// Только для тех объектов, которые перечислены в свойстве РеквизитыДляПредставления параметра Настройки +// процедуры СтруктураПодчиненностиПереопределяемый.ПриОпределенииНастроек. +// +// Параметры: +// ТипДанных - ЛюбаяСсылка - тип ссылки выводимого объекта, см. свойство Тип критерия отбора СвязанныеДокументы. +// Данные - ВыборкаИзРезультатаЗапроса +// - Структура - содержит значения полей, из которых формируется представление: +// * Ссылка - ЛюбаяСсылка - ссылка объекта, выводимого в списке связанных документов. +// * ДополнительныйРеквизит1 - Произвольный - значение первого реквизита, указанного в массиве +// РеквизитыДляПредставления параметра Настройки процедуры ПриОпределенииНастроек. +// * ДополнительныйРеквизит2 - Произвольный - значение второго реквизита... +// ... +// Представление - Строка - поместить в этот параметр рассчитанное представление объекта. +// СтандартнаяОбработка - Булево - поместить в этот параметр Ложь, если установлено значение параметра Представление. +// +Процедура ПриПолученииПредставления(ТипДанных, Данные, Представление, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +СтруктураПодчиненностиПереопределяемый.ПриПолученииПредставления(ТипДанных, Данные, Представление, СтандартнаяОбработка) +``` +
+ +## ПередВыводомСвязанногоОбъекта +
+ +Описание, пример вызова + +```bsl + +// Позволяет повлиять на вывод объектов в отчет Связанные документы. +// Вывод еще не начат - выполняется получение данных. +// +// Параметры: +// Объект - СправочникСсылка +// - ДокументСсылка +// - ЗадачаСсылка +// - БизнесПроцессСсылка +// - ПланВидовХарактеристикСсылка - +// ссылка на объект структуры подчиненности, который подлежит выводу в отчет. +// СвойстваОбъекта - Структура - признаки, описывающие состояние объекта, где: +// * ЭтоОсновной - Булево - если Истина, то это объект для которого формируется структура. +// * ЭтоСлужебный - Булево - если Истина, то объект не обязателен к выводу. По умолчанию - Ложь. +// * ЭтоПодчиненный - Булево - если Истина, то объект является подчиненным по отношению к основному. +// * Выводился - Структура - счетчик частоты вывода объекта суммарно и в подчиненных, где: +// * Итого - Число - суммарная частота вывода объекта. +// * ВПодчиненных - Число - частота вывода объекта в подчиненных. +// Отказ - Булево - если Истина, то объект не будет выведен в отчет. +// При этом, это не мешает выводу подчиненных ему объектов. +// +Процедура ПередВыводомСвязанногоОбъекта(Объект, СвойстваОбъекта, Отказ) Экспорт +``` + +Пример вызова +```bsl +СтруктураПодчиненностиПереопределяемый.ПередВыводомСвязанногоОбъекта(Объект, СвойстваОбъекта, Отказ) +``` +
+ +## МассивРеквизитовОбъектаДляФормированияПредставления +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать СтруктураПодчиненностиПереопределяемый.ПриОпределенииНастроек. +// См. свойство РеквизитыДляПредставления параметра Настройки. +// Формирует массив реквизитов документа. +// +// Параметры: +// ИмяДокумента - Строка - имя документа. +// +// Возвращаемое значение: +// Массив - массив наименований реквизитов документа. +// +Функция МассивРеквизитовОбъектаДляФормированияПредставления(ИмяДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = СтруктураПодчиненностиПереопределяемый.МассивРеквизитовОбъектаДляФормированияПредставления(ИмяДокумента) +``` +
+ +## ПредставлениеОбъектаДляВыводаВОтчет +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать СтруктураПодчиненностиПереопределяемый.ПриПолученииПредставления. +// Получает представление документа для печати. +// +// Параметры: +// Выборка - ВыборкаИзРезультатаЗапроса - структура или выборка из результатов запроса +// в которой содержатся дополнительные реквизиты, на основании +// которых можно сформировать переопределенное представление +// документа для вывода в отчет "Структура подчиненности". +// +// Возвращаемое значение: +// - Строка +// - Неопределено - переопределенное представление документа, или Неопределено, +// если для данного типа документов такое не задано. +// +Функция ПредставлениеОбъектаДляВыводаВОтчет(Выборка) Экспорт +``` + +Пример вызова +```bsl +Результат = СтруктураПодчиненностиПереопределяемый.ПредставлениеОбъектаДляВыводаВОтчет(Выборка) +``` +
+ +## ИмяРеквизитаДокумента +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать СтруктураПодчиненностиПереопределяемый.ПриОпределенииНастроек. +// См. свойство Реквизиты параметра Настройки. +// Возвращает имя реквизита документа, в котором содержится информация о Сумме и Валюте документа для вывода в +// структуру подчиненности. +// По умолчанию используются реквизиты Валюта и СуммаДокумента. Если для конкретного документа или конфигурации в целом +// используются другие +// реквизиты, то переопределить значения по умолчанию можно в данной функции. +// +// Параметры: +// ИмяДокумента - Строка - имя документа, для которого надо получить имя реквизита. +// Реквизит - Строка - строка, может принимать значения "Валюта" и "СуммаДокумента". +// +// Возвращаемое значение: +// Строка - имя реквизита документа, в котором содержится информация о Валюте или Сумме. +// +Функция ИмяРеквизитаДокумента(ИмяДокумента, Реквизит) Экспорт +``` + +Пример вызова +```bsl +Результат = СтруктураПодчиненностиПереопределяемый.ИмяРеквизитаДокумента(ИмяДокумента, Реквизит) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/СхемаКонфигурации.md b/src/content/docs/bsp/СхемаКонфигурации.md new file mode 100644 index 0000000..3c6071b --- /dev/null +++ b/src/content/docs/bsp/СхемаКонфигурации.md @@ -0,0 +1,37 @@ +--- +title: Схема конфигурации +slug: bsp/схема-конфигурации +--- + + +## ДвоичныеДанныеСхемы +
+ +Описание, пример вызова + +```bsl + +// Двоичные данные схемы +// +// Параметры: +// АннотироватьСсылочныеТипы - Булево +// УчитыватьРасширениеДанных - Булево +// +// Возвращаемое значение: +// ДвоичныеДанные +Функция ДвоичныеДанныеСхемы(АннотироватьСсылочныеТипы = Ложь, УчитыватьРасширениеДанных = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = СхемаКонфигурации.ДвоичныеДанныеСхемы(АннотироватьСсылочныеТипы, УчитыватьРасширениеДанных); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/Тарификация.md b/src/content/docs/bsp/Тарификация.md new file mode 100644 index 0000000..ac6417e --- /dev/null +++ b/src/content/docs/bsp/Тарификация.md @@ -0,0 +1,349 @@ +--- +title: Тарификация +slug: bsp/тарификация +--- + + +## УслугаПоИдентификаторуИИдентификаторуПоставщика +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на услугу по ее идентификатору и идентификатору поставщика услуги. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторУслуги - Строка - идентификатор услуги. +// ИдентификаторПоставщика - Строка - идентификатор поставщика. +// ВызыватьИсключение - Булево - флаг необходимости вызвать исключение в случае если услуга не найдена +// +// Возвращаемое значение: +// СправочникСсылка.УслугиСервиса - ссылка на услугу. +// +Функция УслугаПоИдентификаторуИИдентификаторуПоставщика(Знач ИдентификаторУслуги, Знач ИдентификаторПоставщика, ВызыватьИсключение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.УслугаПоИдентификаторуИИдентификаторуПоставщика(ИдентификаторУслуги, ИдентификаторПоставщика, ВызыватьИсключение); +``` +
+ +## ЗарегистрированаЛицензияБезлимитнойУслуги +
+ +Описание, пример вызова + +```bsl + +// Проверяет, позволяет ли система тарификации сервиса использование указанной безлимитной услуге +// указанному пользователю. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПоставщика - Строка - уникальный строковый идентификатор (код) поставщика услуг в сервисе. +// ИдентификаторУслуги - Строка - уникальный строковый идентификатор (код) услуги в сервисе. +// +// Возвращаемое значение: +// Булево - результат проверки (Истина = лицензия зарегистрирована). +// +Функция ЗарегистрированаЛицензияБезлимитнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги) Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.ЗарегистрированаЛицензияБезлимитнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги) +``` +
+ +## ЗарегистрированаЛицензияУникальнойУслуги +
+ +Описание, пример вызова + +```bsl + +// Проверяет, зарегистрирован ли в системе тарификации сервиса указанный идентификатор +// лицензии на использование указанной уникальной лимитированной услуги. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПоставщика - Строка - уникальный строковый идентификатор (код) поставщика услуг в сервисе. +// ИдентификаторУслуги - Строка - уникальный строковый идентификатор (код) услуги в сервисе. +// ИмяЛицензии - Строка - Строка(200) уникальное строковое представление лицензии, ПОНЯТНОЕ ПОЛЬЗОВАТЕЛЮ. +// КонтекстЛицензии - Строка - Строка (200), контекст лицензии. +// +// Возвращаемое значение: +// Булево - результат проверки (Истина = лицензия зарегистрирована). +// +Функция ЗарегистрированаЛицензияУникальнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, ИмяЛицензии, КонтекстЛицензии = "") Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.ЗарегистрированаЛицензияУникальнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, ИмяЛицензии, КонтекстЛицензии); +``` +
+ +## ЗанятьЛицензиюУникальнойУслуги +
+ +Описание, пример вызова + +```bsl + +// Выполняет попытку получить лицензию на использование уникальной услуги в системе тарификации сервиса. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПоставщика - Строка - уникальный строковый идентификатор (код) поставщика услуг в сервисе. +// ИдентификаторУслуги - Строка - уникальный строковый идентификатор (код) услуги в сервисе. +// ИмяЛицензии - Строка - Строка(200) уникальное строковое представление лицензии, ПОНЯТНОЕ ПОЛЬЗОВАТЕЛЮ. +// ИдентификаторОперации - УникальныйИдентификатор - уникальный идентификатор операции, потребуется для подтверждения. +// КонтекстЛицензии - Строка - Строка(200) контекст лицензия, указывающий уникальность лицензии. +// +// Возвращаемое значение: +// Структура - со свойствами: +// * Результат - Булево - результат выполнения (Истина = лицензия успешно получена). +// * ДоступноЛицензий - Число - максимально доступное абоненту количество лицензий на указанную услугу (если "-1", значит неограниченное количество). +// * ЗанятоЛицензий - Число - количество уже полученных (использованных) лицензий на услугу. +// * СвободноЛицензий - Число - количество свободных лицензий (если "-1", значит неограниченное количество). +// +Функция ЗанятьЛицензиюУникальнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, ИмяЛицензии, ИдентификаторОперации, КонтекстЛицензии = "") Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.ЗанятьЛицензиюУникальнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, ИмяЛицензии, ИдентификаторОперации, КонтекстЛицензии); +``` +
+ +## ОсвободитьЛицензиюУникальнойУслуги +
+ +Описание, пример вызова + +```bsl + +// Выполняет попытку освободить лицензию на уникальную услугу в системе тарификации сервиса. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПоставщика - Строка - уникальный строковый идентификатор (код) поставщика услуг в сервисе. +// ИдентификаторУслуги - Строка - уникальный строковый идентификатор (код) услуги в сервисе. +// ИмяЛицензии - Строка - Строка(200) уникальное строковое представление лицензии, ПОНЯТНОЕ ПОЛЬЗОВАТЕЛЮ. +// ИдентификаторОперации - УникальныйИдентификатор - уникальный идентификатор операции, потребуется для подтверждения. +// КодОбластиДанных - Число - код области данных (если мы вызываем функцию из неразделенного сеанса). +// КонтекстЛицензии - Строка - Строка(200) контекст лицензия, указывающий уникальность лицензии. +// УдалитьЛицензиюВоВсехОбластяхДанных - Булево - удалять или нет данную лицензию по областям данных. +// +// Возвращаемое значение: +// Булево - результат выполнения (Истина = лицензия успешно освобождена, Ложь - данная лицензия не была найдена). +// +Функция ОсвободитьЛицензиюУникальнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, ИмяЛицензии, Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.ОсвободитьЛицензиюУникальнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, ИмяЛицензии, ); +``` +
+ +## ЗанятьЛицензииЛимитированнойУслуги +
+ +Описание, пример вызова + +```bsl + +// Выполняет попытку получить лицензии на использование лимитированной услуги в сервисе. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПоставщика - Строка - уникальный строковый идентификатор (код) поставщика услуг в сервисе. +// ИдентификаторУслуги - Строка - уникальный строковый идентификатор (код) услуги в сервисе. +// КоличествоЛицензий - Число - требуемое количество лицензий (натуральное число, 10 разрядов). +// КодОбластиДанных - Число - код области данных (если мы вызываем функцию из неразделенного сеанса). +// +// Возвращаемое значение: +// Структура - со свойствами: +// * Результат - Булево - результат выполнения (Истина = лицензия успешно получена). +// * ДоступноЛицензий - Число - максимально доступное абоненту количество лицензий на указанную услугу (если "-1", значит неограниченное количество). +// * ЗанятоЛицензий - Число - количество уже полученных (использованных) лицензий на услугу. +// * СвободноЛицензий - Число - количество свободных лицензий (если "-1", значит неограниченное количество). +// +Функция ЗанятьЛицензииЛимитированнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, КоличествоЛицензий, КодОбластиДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.ЗанятьЛицензииЛимитированнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, КоличествоЛицензий, КодОбластиДанных); +``` +
+ +## ОсвободитьЛицензииЛимитированнойУслуги +
+ +Описание, пример вызова + +```bsl + +// Выполняет попытку освободить лицензии на использование лимитированной услуги в сервисе. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПоставщика - Строка - уникальный строковый идентификатор (код) поставщика услуг в сервисе. +// ИдентификаторУслуги - Строка - уникальный строковый идентификатор (код) услуги в сервисе. +// КоличествоЛицензий - Число - требуемое количество лицензий (натуральное число, 10 разрядов). +// КодОбластиДанных - Число - код области данных (если мы вызываем функцию из неразделенного сеанса). +// +// Возвращаемое значение: +// Булево - результат выполнения (Истина = лицензия успешно освобождена). +// +Функция ОсвободитьЛицензииЛимитированнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, КоличествоЛицензий, КодОбластиДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.ОсвободитьЛицензииЛимитированнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, КоличествоЛицензий, КодОбластиДанных); +``` +
+ +## ПодтвердитьОперацию +
+ +Описание, пример вызова + +```bsl + +// Выполняет подтверждение ранее запрошенной операции с лицензиями (получение или освобождение). +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторОперации - УникальныйИдентификатор - идентификатор операции, который передавался при запросе операции. +// +// Возвращаемое значение: +// Булево - результат операции (Истина = операция подтверждена). +// +Функция ПодтвердитьОперацию(ИдентификаторОперации) Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.ПодтвердитьОперацию(ИдентификаторОперации) +``` +
+ +## ОтменитьОперацию +
+ +Описание, пример вызова + +```bsl + +// Выполняет отмену ранее запрошенной операции с лицензиями (получение или освобождение). +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторОперации - УникальныйИдентификатор - идентификатор операции, который передавался при запросе операции. +// +// Возвращаемое значение: +// Булево - результат операции (Истина = операция отменена). +// +Функция ОтменитьОперацию(ИдентификаторОперации) Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.ОтменитьОперацию(ИдентификаторОперации) +``` +
+ +## КоличествоЛицензийУникальнойУслуги +
+ +Описание, пример вызова + +```bsl + +// Выполняет попытку получить количество свободных лицензий на использование уникальной услуги в системе тарификации сервиса. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПоставщика - Строка - уникальный строковый идентификатор (код) поставщика услуг в сервисе. +// ИдентификаторУслуги - Строка - уникальный строковый идентификатор (код) услуги в сервисе. +// +// Возвращаемое значение: +// Структура - с ключами: +// * ДоступноЛицензий - Число - максимально доступное абоненту количество лицензий на указанную услугу (если "-1", значит неограниченное количество). +// * ЗанятоЛицензий - Число - количество уже полученных (использованных) лицензий на услугу. +// * СвободноЛицензий - Число - количество свободных лицензий (если "-1", значит неограниченное количество). +// +Функция КоличествоЛицензийУникальнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги) Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.КоличествоЛицензийУникальнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги) +``` +
+ +## КоличествоЛицензийЛимитированнойУслуги +
+ +Описание, пример вызова + +```bsl + +// Выполняет попытку получить количество лицензий лимитированной услуги в сервисе. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПоставщика - Строка - уникальный строковый идентификатор (код) поставщика услуг в сервисе. +// ИдентификаторУслуги - Строка - уникальный строковый идентификатор (код) услуги в сервисе. +// КодОбластиДанных - Число - код области данных (если мы вызываем функцию из неразделенного сеанса). +// +// Возвращаемое значение: +// Структура - с ключами: +// * ДоступноЛицензий - Число - максимально доступное абоненту количество лицензий на указанную услугу (если "-1", значит неограниченное количество). +// * ЗанятоЛицензий - Число - количество уже полученных (использованных) лицензий на услугу. +// * СвободноЛицензий - Число - количество свободных лицензий (если "-1", значит неограниченное количество). +// +Функция КоличествоЛицензийЛимитированнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, КодОбластиДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.КоличествоЛицензийЛимитированнойУслуги(ИдентификаторПоставщика, ИдентификаторУслуги, КодОбластиДанных); +``` +
+ +## ТекущийСеансЗаблокирован +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак блокировки текущего сеанса тарификацией. +// +// Возвращаемое значение: +// Булево - +Функция ТекущийСеансЗаблокирован() Экспорт +``` + +Пример вызова +```bsl +Результат = Тарификация.ТекущийСеансЗаблокирован() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ТарификацияВызовСервера.md b/src/content/docs/bsp/ТарификацияВызовСервера.md new file mode 100644 index 0000000..fad52eb --- /dev/null +++ b/src/content/docs/bsp/ТарификацияВызовСервера.md @@ -0,0 +1,29 @@ +--- +title: Тарификация вызов сервера +slug: bsp/тарификация-вызов-сервера +--- + + +## ОбработкаПолученияФормы +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПолученияФормы(Источник, ВидФормы, Параметры, ВыбраннаяФорма, ДополнительнаяИнформация, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ТарификацияВызовСервера.ОбработкаПолученияФормы(Источник, ВидФормы, Параметры, ВыбраннаяФорма, ДополнительнаяИнформация, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ТарификацияПереопределяемый.md b/src/content/docs/bsp/ТарификацияПереопределяемый.md new file mode 100644 index 0000000..dc7a7b8 --- /dev/null +++ b/src/content/docs/bsp/ТарификацияПереопределяемый.md @@ -0,0 +1,118 @@ +--- +title: Тарификация переопределяемый +slug: bsp/тарификация-переопределяемый +--- + + +## ПриФормированииСпискаУслуг +
+ +Описание, пример вызова + +```bsl + +// Регистрирует тарифицируемые услуги конфигурации из Структуры. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ПоставщикиУслуг - Массив из Структура - описывает поставщика услуги: +// * Идентификатор - Строка - идентификатор поставщика услуги (тип Строка - Строка(50)), +// * Наименование - Строка - наименование поставщика услуги (тип Строка - Строка(150)), +// * Услуги - Массив из Структура - услуги поставщика с обязательными ключами: +// ** Идентификатор - Строка - идентификатор услуги (тип Строка - Строка(50)) +// ** Наименование - Строка - наименование услуги (тип Строка - Строка(150)) +// ** ТипУслуги - ПеречислениеСсылка.ТипыУслуг - тип услуги. +// +Процедура ПриФормированииСпискаУслуг(ПоставщикиУслуг) Экспорт +``` + +Пример вызова +```bsl +ТарификацияПереопределяемый.ПриФормированииСпискаУслуг(ПоставщикиУслуг) +``` +
+ +## ПриИзмененииСостоянияАктивацииЛицензии +
+ +Описание, пример вызова + +```bsl + +// Событие, которое вызывается при изменении активации лицензии. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ДанныеОЛицензии - Структура - данные о лицензии: +// * Услуга - СправочникСсылка.УслугиСервиса - услуга. +// * ИмяЛицензии - Строка - имя лицензии. +// * КонтекстЛицензии - Строка - контекст лицензии. +// ЛицензияАктивирована - Булево - активирована лицензия или деактивирована. +// +Процедура ПриИзмененииСостоянияАктивацииЛицензии(ДанныеОЛицензии, ЛицензияАктивирована) Экспорт +``` + +Пример вызова +```bsl +ТарификацияПереопределяемый.ПриИзмененииСостоянияАктивацииЛицензии(ДанныеОЛицензии, ЛицензияАктивирована) +``` +
+ +## ПриОбновленииДоступныхЛицензий +
+ +Описание, пример вызова + +```bsl + +// Событие, которое вызывается при обновлении доступных лицензий. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ПараметрыЛицензии - Структура - соответствует составу реквизитов, измерений и ресурсов РС "ДоступныеЛицензии": +// * ИдентификаторПодписки - УникальныйИдентификатор - внутренний идентификатор подписки. +// * Услуга - СправочникСсылка.УслугиСервиса - услуга. +// * ДатаНачалаДействия - Дата - дата начала действия подписки. +// * ДатаОкончанияДействия - Дата - дата окончания действия подписки. +// * КоличествоЛицензий - Число - количество лицензий. +// * НомерПодписки - Строка - номер подписки. +// * ДатаИзменения - Дата - дата изменения. +// +Процедура ПриОбновленииДоступныхЛицензий(ПараметрыЛицензии) Экспорт +``` + +Пример вызова +```bsl +ТарификацияПереопределяемый.ПриОбновленииДоступныхЛицензий(ПараметрыЛицензии) +``` +
+ +## ПриУдаленииДоступныхЛицензий +
+ +Описание, пример вызова + +```bsl + +// Событие, которое вызывается при удалении доступных лицензий. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ПараметрыЛицензии - см. ПриОбновленииДоступныхЛицензий.ПараметрыЛицензии +// +Процедура ПриУдаленииДоступныхЛицензий(ПараметрыЛицензии) Экспорт +``` + +Пример вызова +```bsl +ТарификацияПереопределяемый.ПриУдаленииДоступныхЛицензий(ПараметрыЛицензии) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ТекущиеДелаПереопределяемый.md b/src/content/docs/bsp/ТекущиеДелаПереопределяемый.md new file mode 100644 index 0000000..b77486e --- /dev/null +++ b/src/content/docs/bsp/ТекущиеДелаПереопределяемый.md @@ -0,0 +1,148 @@ +--- +title: Текущие дела переопределяемый +slug: bsp/текущие-дела-переопределяемый +--- + + +## ПриОпределенииОбработчиковТекущихДел +
+ +Описание, пример вызова + +```bsl + +// Определяет список обработчиков (модулей менеджеров или общих модулей) для формирования и обновления +// списка всех текущих дел, предусмотренных в конфигурации. +// +// В указанных модулях должна быть размещена процедура обработчика, в которую передается параметр +// ТекущиеДела - см. ТекущиеДелаСервер.ТекущиеДела. +// +// Далее пример процедуры обработчика для копирования в указанные модули: +// +//// Параметры: +//// ТекущиеДела - см. ТекущиеДелаСервер.ТекущиеДела. +//// +//Процедура ПриЗаполненииСпискаТекущихДел(ТекущиеДела) Экспорт +// +//КонецПроцедуры +// +// Параметры: +// ТекущиеДела - Массив - модули менеджеров или общие модули, +// например: Документы.ЗаказПокупателя, ТекущиеДелаПоПродажам. +// Пример: +// ТекущиеДела.Добавить(Документы.ЗаказПокупателя); +// +Процедура ПриОпределенииОбработчиковТекущихДел(ТекущиеДела) Экспорт +``` + +Пример вызова +```bsl +ТекущиеДелаПереопределяемый.ПриОпределенииОбработчиковТекущихДел(ТекущиеДела) +``` +
+ +## ПриОпределенииПорядкаРазделовКомандногоИнтерфейса +
+ +Описание, пример вызова + +```bsl + +// Задает начальный порядок разделов в панели текущих дел. +// +// Параметры: +// Разделы - Массив - массив разделов командного интерфейса. +// Разделы в панели текущих дел выводятся в +// том порядке, в котором они были добавлены в массив. +// +Процедура ПриОпределенииПорядкаРазделовКомандногоИнтерфейса(Разделы) Экспорт +``` + +Пример вызова +```bsl +ТекущиеДелаПереопределяемый.ПриОпределенииПорядкаРазделовКомандногоИнтерфейса(Разделы) +``` +
+ +## ПриОтключенииТекущихДел +
+ +Описание, пример вызова + +```bsl + +// Определяет текущие дела, которые не будут выводиться пользователю. +// +// Параметры: +// ОтключаемыеДела - Массив - массив строк идентификаторов текущих дел, которые нужно отключать. +// +Процедура ПриОтключенииТекущихДел(ОтключаемыеДела) Экспорт +``` + +Пример вызова +```bsl +ТекущиеДелаПереопределяемый.ПриОтключенииТекущихДел(ОтключаемыеДела) +``` +
+ +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Позволяет менять некоторые настройки подсистемы. +// +// Параметры: +// Параметры - Структура: +// * ЗаголовокПрочихДел - Строка - заголовок раздела, в который выводятся +// дела, не отнесенные к разделам командного интерфейса. +// Применимо для тех дел, размещение которых в панели +// определяется функцией ТекущиеДелаСервер.РазделыДляОбъекта. +// Если не указано - дела выводятся в группу с заголовком +// "Прочие дела". +// +Процедура ПриОпределенииНастроек(Параметры) Экспорт +``` + +Пример вызова +```bsl +ТекущиеДелаПереопределяемый.ПриОпределенииНастроек(Параметры) +``` +
+ +## УстановитьОбщиеПараметрыЗапросов +
+ +Описание, пример вызова + +```bsl + +// Позволяет установить параметры запросов, общие для нескольких текущих дел. +// +// Например, если в нескольких обработчиках получения текущих дел устанавливается +// параметр "ТекущаяДата", то установку параметра можно прописать в данной +// процедуре, а в обработчике формирования дела сделать вызов процедуры +// ТекущиеДела.УстановитьОбщиеПараметрыЗапросов(), которая установит данный параметр. +// +// Параметры: +// Запрос - Запрос - выполняемый запрос. +// ОбщиеПараметрыЗапросов - Структура - общие значения для расчета текущих дел. +// +Процедура УстановитьОбщиеПараметрыЗапросов(Запрос, ОбщиеПараметрыЗапросов) Экспорт +``` + +Пример вызова +```bsl +ТекущиеДелаПереопределяемый.УстановитьОбщиеПараметрыЗапросов(Запрос, ОбщиеПараметрыЗапросов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ТекущиеДелаСервер.md b/src/content/docs/bsp/ТекущиеДелаСервер.md new file mode 100644 index 0000000..1b1c2d5 --- /dev/null +++ b/src/content/docs/bsp/ТекущиеДелаСервер.md @@ -0,0 +1,188 @@ +--- +title: Текущие дела сервер +slug: bsp/текущие-дела-сервер +--- + + +## ТекущиеДела +
+ +Описание, пример вызова + +```bsl + +// Таблица текущих дел пользователя. +// Передается в обработчики ПриЗаполненииСпискаТекущихДел. +// +// Возвращаемое значение: +// ТаблицаЗначений - определяет параметры дела: +// * Идентификатор - Строка - внутренний идентификатор дела, используемый подсистемой. +// * ЕстьДела - Булево - если Истина, дело выводится в списке текущих дел пользователя. +// * Важное - Булево - если Истина, дело будет выделено красным цветом. +// * ВыводитьВОповещениях - Булево - если Истина, уведомление о деле будет дублироваться всплывающим +// оповещением и отображением в центре оповещений. +// * СкрыватьВНастройках - Булево - если Истина, то дело будет скрыто в форме настроек текущих дел. +// Можно применять для дел, которые не предполагают многократного +// использования, т.е. после выполнения они для данной информационной базы +// больше отображаться не будут. +// * Представление - Строка - представление дела, выводимое пользователю. +// * Количество - Число - количественный показатель дела, выводится в строке заголовка дела. +// * Форма - Строка - полный путь к форме, которую необходимо открыть при нажатии на гиперссылку +// дела на панели "Текущие дела". +// * ПараметрыФормы - Структура - параметры, с которыми нужно открывать форму показателя. +// * Владелец - Строка +// - ОбъектМетаданных - строковый идентификатор дела, которое будет владельцем для текущего +// или объект метаданных подсистема. +// * Подсказка - Строка - текст подсказки. +// * ОбъектВладелецДел - Строка - полное имя объекта метаданных, в котором расположен обработчик заполнения дел. +// +Функция ТекущиеДела() Экспорт +``` + +Пример вызова +```bsl +Результат = ТекущиеДелаСервер.ТекущиеДела() +``` +
+ +## РазделыДляОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив подсистем командного интерфейса, в которые включен переданный +// объект метаданных. +// +// Параметры: +// ИмяОбъектаМетаданных - Строка - полное имя объекта метаданных. +// +// Возвращаемое значение: +// Массив - массив подсистем командного интерфейса программы. +// +Функция РазделыДляОбъекта(ИмяОбъектаМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = ТекущиеДелаСервер.РазделыДляОбъекта(ИмяОбъектаМетаданных) +``` +
+ +## ДелоОтключено +
+ +Описание, пример вызова + +```bsl + +// Определяет, нужно ли выводить дело в списке дел пользователя. +// +// Параметры: +// ИдентификаторДела - Строка - идентификатор дела, которое надо искать в списке отключенных. +// +// Возвращаемое значение: +// Булево - Истина, если дело было программно отключено и его не требуется выводить пользователю. +// +Функция ДелоОтключено(ИдентификаторДела) Экспорт +``` + +Пример вызова +```bsl +Результат = ТекущиеДелаСервер.ДелоОтключено(ИдентификаторДела) +``` +
+ +## ОбщиеПараметрыЗапросов +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру общих значений, используемых для расчета текущих дел. +// +// Возвращаемое значение: +// Структура: +// * Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи - текущий пользователь. +// * ЭтоПолноправныйПользователь - Булево - Истина, если пользователь полноправный. +// * ТекущаяДата - Дата - текущая дата сеанса. +// * ПустаяДата - Дата - пустая дата. +// +Функция ОбщиеПараметрыЗапросов() Экспорт +``` + +Пример вызова +```bsl +Результат = ТекущиеДелаСервер.ОбщиеПараметрыЗапросов() +``` +
+ +## УстановитьПараметрыЗапросов +
+ +Описание, пример вызова + +```bsl + +// Устанавливает общие параметры запросов для расчета текущих дел. +// +// Параметры: +// Запрос - Запрос - выполняемый запрос, которому +// необходимо заполнить общие параметры. +// ОбщиеПараметрыЗапросов - Структура - общие значения для расчета показателей. +// +Процедура УстановитьПараметрыЗапросов(Запрос, ОбщиеПараметрыЗапросов) Экспорт +``` + +Пример вызова +```bsl +ТекущиеДелаСервер.УстановитьПараметрыЗапросов(Запрос, ОбщиеПараметрыЗапросов) +``` +
+ +## ЧисловыеПоказателиТекущихДел +
+ +Описание, пример вызова + +```bsl + +// Получает числовые значения дел из переданного запроса. +// +// Запрос с данными должен содержать только одну строку с произвольным количеством полей. +// Значения этих полей должны являться значениями соответствующих показателей. +// +// Например, такой запрос может иметь следующий вид: +// ВЫБРАТЬ +// Количество(*) КАК <Имя предопределенного элемента - показателя количества документов>. +// ИЗ +// Документ.<Имя документа>. +// +// Параметры: +// Запрос - Запрос - выполняемый запрос. +// ОбщиеПараметрыЗапросов - Структура - общие значения для расчета текущих дел. +// +// Возвращаемое значение: +// Структура: +// * Ключ - Строка - имя показателя текущих дел. +// * Значение - Число - числовое значение показателя. +// +Функция ЧисловыеПоказателиТекущихДел(Запрос, ОбщиеПараметрыЗапросов = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ТекущиеДелаСервер.ЧисловыеПоказателиТекущихДел(Запрос, ОбщиеПараметрыЗапросов); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ТехнологияСервиса.md b/src/content/docs/bsp/ТехнологияСервиса.md new file mode 100644 index 0000000..a9a626f --- /dev/null +++ b/src/content/docs/bsp/ТехнологияСервиса.md @@ -0,0 +1,55 @@ +--- +title: Технология сервиса +slug: bsp/технология-сервиса +--- + + +## ВерсияБиблиотеки +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию библиотеки "1С:Библиотека технологии сервиса" +// +// Возвращаемое значение: +// Строка - версия библиотеки в формате РР.{П|ПП}.ЗЗ.СС. +// +Функция ВерсияБиблиотеки() Экспорт +``` + +Пример вызова +```bsl +Результат = ТехнологияСервиса.ВерсияБиблиотеки() +``` +
+ +## ВерсияРасширенияБиблиотеки +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию расширения библиотеки "1С:Библиотека технологии сервиса" +// +// Возвращаемое значение: +// Строка, Неопределено - версия расширения библиотеки или Неопределено, если расширение не установлено или не активно +// +Функция ВерсияРасширенияБиблиотеки() Экспорт +``` + +Пример вызова +```bsl +Результат = ТехнологияСервиса.ВерсияРасширенияБиблиотеки() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ТехнологияСервисаСлужебныйЗапросы.md b/src/content/docs/bsp/ТехнологияСервисаСлужебныйЗапросы.md new file mode 100644 index 0000000..bf4723e --- /dev/null +++ b/src/content/docs/bsp/ТехнологияСервисаСлужебныйЗапросы.md @@ -0,0 +1,48 @@ +--- +title: Технология сервиса служебный запросы +slug: bsp/технология-сервиса-служебный-запросы +--- + + +## ПолучитьПорциюДанныхНезависимогоНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Курсорные запросы для независимых наборов записей + +// Получить порцию данных независимого набора записей. +// +// Параметры: +// МетаданныеОбъекта - ОбъектМетаданных +// Отбор - Массив Из Структура: +// * ВидСравнения - ВидСравнения +// * Поле - Строка +// * Значение - Произвольный +// РазмерПорции - Число +// МожноПродолжать - Булево +// Состояние - см. ИнициализироватьСостояниеДляВыборкиПорцийНезависимогоНабораЗаписей +// ДополнениеКИмениТаблицы - Строка +// +// Возвращаемое значение: +// Массив из ТаблицаЗначений: +// * Колонка - Произвольный - произвольный набор колонок - полей объекта. +// +Функция ПолучитьПорциюДанныхНезависимогоНабораЗаписей(Знач МетаданныеОбъекта, Знач Отбор, Экспорт +``` + +Пример вызова +```bsl +Результат = ТехнологияСервисаСлужебныйЗапросы.ПолучитьПорциюДанныхНезависимогоНабораЗаписей(МетаданныеОбъекта, Отбор, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ТрансляцияXDTO.md b/src/content/docs/bsp/ТрансляцияXDTO.md new file mode 100644 index 0000000..8c0e9b1 --- /dev/null +++ b/src/content/docs/bsp/ТрансляцияXDTO.md @@ -0,0 +1,71 @@ +--- +title: Трансляция XDTO +slug: bsp/трансляция-xdto +--- + + +## ТранслироватьВВерсию +
+ +Описание, пример вызова + +```bsl + +// Функция выполняет трансляцию произвольного XDTO-объекта +// между версиями по зарегистрированным в системе обработчикам трансляции, +// определяя результирующую версию по пространству имен результирующего сообщения. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИсходныйОбъект - ОбъектXDTO - Транслируемый объект. +// РезультирующаяВерсия - строка - Номер результирующей версии интерфейса, в формате РР.{П|ПП}.ЗЗ.СС. +// ПакетИсходнойВерсии - Строка - пространство имен версии сообщения. +// +// Возвращаемое значение: +// ОбъектXDTO - результат трансляции объекта. +// +Функция ТранслироватьВВерсию(Знач ИсходныйОбъект, Знач РезультирующаяВерсия, Экспорт +``` + +Пример вызова +```bsl +Результат = ТрансляцияXDTO.ТранслироватьВВерсию(ИсходныйОбъект, РезультирующаяВерсия, ); +``` +
+ +## ТранслироватьВПространствоИмен +
+ +Описание, пример вызова + +```bsl + +// Функция выполняет трансляцию произвольного XDTO-объекта +// между версиями по зарегистрированным в системе обработчикам трансляции, +// определяя результирующую версию по пространству имен результирующего сообщения. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИсходныйОбъект - ОбъектXDTO - Транслируемый объект. +// ПакетРезультирующейВерсии - Строка - Пространство имен результирующей версии. +// ПакетИсходнойВерсии - Строка - пространство имен версии сообщения. +// +// Возвращаемое значение: +// ОбъектXDTO - результат трансляции объекта. +// +Функция ТранслироватьВПространствоИмен(Знач ИсходныйОбъект, Экспорт +``` + +Пример вызова +```bsl +Результат = ТрансляцияXDTO.ТранслироватьВПространствоИмен(ИсходныйОбъект, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ТрансляцияXDTOПереопределяемый.md b/src/content/docs/bsp/ТрансляцияXDTOПереопределяемый.md new file mode 100644 index 0000000..c402ef5 --- /dev/null +++ b/src/content/docs/bsp/ТрансляцияXDTOПереопределяемый.md @@ -0,0 +1,34 @@ +--- +title: Трансляция XDTO переопределяемый +slug: bsp/трансляция-xdto-переопределяемый +--- + + +## ЗаполнитьОбработчикиТрансляцииСообщений +
+ +Описание, пример вызова + +```bsl + +// Заполняет переданный массив обработчиками трансляции сообщений между версиями. +// @skip-warning ПустойМетод - переопределяемый метод. +// Параметры: +// МассивОбработчиков - Массив - Элементами массива являются общие модули. +// +Процедура ЗаполнитьОбработчикиТрансляцииСообщений(МассивОбработчиков) Экспорт +``` + +Пример вызова +```bsl +ТрансляцияXDTOПереопределяемый.ЗаполнитьОбработчикиТрансляцииСообщений(МассивОбработчиков) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ТранспортСообщенийОбмена.md b/src/content/docs/bsp/ТранспортСообщенийОбмена.md new file mode 100644 index 0000000..92cf0c5 --- /dev/null +++ b/src/content/docs/bsp/ТранспортСообщенийОбмена.md @@ -0,0 +1,522 @@ +--- +title: Транспорт сообщений обмена +slug: bsp/транспорт-сообщений-обмена +--- + + +## ПараметрыИнициализации +
+ +Описание, пример вызова + +```bsl + +// Параметры инициализации. +// +// Параметры: +// ИдентификаторТранспорта - Строка - идентифкатор транспорта +// +// Возвращаемое значение: +// Структура: +// * Корреспондент - ПланОбменаСсылка, Неопределено - ссылка на узел плана обмена +// * ИмяПланаОбмена - Строка +// * ИмяПланаОбменаКорреспондента - Строка +// * ИдентификаторТранспорта - Строка +// * НастройкиТранспорта - Структура - состав повторяет реквизиты обработки транспорта +// * ДанныеАутентификации - Структура - состав повторяет реквизиты обработки транспорта, +// но только данные аутентификации, например: Пароль, ИмяПользоватля +// +Функция ПараметрыИнициализации(ИдентификаторТранспорта = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.ПараметрыИнициализации(ИдентификаторТранспорта); +``` +
+ +## Инициализация +
+ +Описание, пример вызова + +```bsl + +// Инициализация обарботки транспорта. +// +// Параметры: +// ПараметрыИнициализации - Структура: +// * Корреспондент - ПланОбменаСсылка - ссылка на узел плана обмена. Если значение задано, +// то будут заполнены настройки транспорта (реквизиты обработки). +// * ИмяПланаОбмена - Строка +// * ИмяПланаОбменаКорреспондента - Строка +// * ИдентификаторТранспорта - Строка - доступный индентфикатор транспорта. +// Доступные идентфикаторы см. ДоступныеТипыТранспорта +// * НастройкиТранспорта - Структура - состав повторяет реквизиты обработки транспорта, +// * ДанныеАутентификации - Структура - состав повторяет реквизиты обработки транспорта, +// но только данные аутентификации, например: Пароль, ИмяПользоватля +// +// Возвращаемое значение: +// ОбработкаОбъект.ТранспортСообщенийОбменаCOM, +// ОбработкаОбъект.ТранспортСообщенийОбменаEMAIL, +// ОбработкаОбъект.ТранспортСообщенийОбменаESB1C, +// ОбработкаОбъект.ТранспортСообщенийОбменаFILE, +// ОбработкаОбъект.ТранспортСообщенийОбменаFTP, +// ОбработкаОбъект.ТранспортСообщенийОбменаGoogleDrive, +// ОбработкаОбъект.ТранспортСообщенийОбменаHTTP, +// ОбработкаОбъект.ТранспортСообщенийОбменаSM, +// ОбработкаОбъект.ТранспортСообщенийОбменаWS, +// ОбработкаОбъект.ТранспортСообщенийОбменаПассивныйРежим, +// ОбработкаОбъект.ТранспортСообщенийОбменаЯндексДиск - обработка заданного типа транспорта с заполненными параметрами. +// При инициализации создатся ВременныйКаталог, задается временное имя файла СообщениеОбмена, +// а так же шаблоны имен файлов (ШаблоныИменДляПолученияСообщения) для получения +// +Функция Инициализация(ПараметрыИнициализации) Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.Инициализация(ПараметрыИнициализации) +``` +
+ +## Деинициализация +
+ +Описание, пример вызова + +```bsl + +// Уничтожение обработки трансорта, удаление временного каталога обмена +// +// Параметры: +// Транспорт - ОбработкаОбъект.ТранспортСообщенийОбменаCOM, +// - ОбработкаОбъект.ТранспортСообщенийОбменаEMAIL, +// - ОбработкаОбъект.ТранспортСообщенийОбменаESB1C, +// - ОбработкаОбъект.ТранспортСообщенийОбменаFILE, +// - ОбработкаОбъект.ТранспортСообщенийОбменаFTP, +// - ОбработкаОбъект.ТранспортСообщенийОбменаGoogleDrive, +// - ОбработкаОбъект.ТранспортСообщенийОбменаHTTP, +// - ОбработкаОбъект.ТранспортСообщенийОбменаSM, +// - ОбработкаОбъект.ТранспортСообщенийОбменаWS, +// - ОбработкаОбъект.ТранспортСообщенийОбменаПассивныйРежим, +// - ОбработкаОбъект.ТранспортСообщенийОбменаЯндексДиск - обработка транспорта сообщений обмена. +// +// Возвращаемое значение: +// Булево - Истина при удачном выполнении, Ложь - при возникновении ошибки. +// +Функция Деинициализация(Транспорт) Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.Деинициализация(Транспорт) +``` +
+ +## НастройкиТранспорта +
+ +Описание, пример вызова + +```bsl + +// Настройки транспорта. +// +// Параметры: +// Корреспондент - ПланОбменаСсылка - корреспондент +// ИдентификаторТранспорта - Строка - идентификатор транспорта +// +// Возвращаемое значение: +// Структура - настройки транспорта (рекизиты обработки транспорта) +// +Функция НастройкиТранспорта(Корреспондент, ИдентификаторТранспорта) Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.НастройкиТранспорта(Корреспондент, ИдентификаторТранспорта) +``` +
+ +## НастройкиТранспортаПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Настройки транспорта по умолчанию. +// +// Параметры: +// Корреспондент - ПланОбменаСсылка +// ИдентификаторТранспорта - Строка - возвращает идентификатор транспорта заданный по умолчанию +// +// Возвращаемое значение: +// Структура - настройки транспорта по умолчанию (рекизиты обработки транспорта) +// +Функция НастройкиТранспортаПоУмолчанию(Корреспондент, ИдентификаторТранспорта = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.НастройкиТранспортаПоУмолчанию(Корреспондент, ИдентификаторТранспорта); +``` +
+ +## ТранспортПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Транспорт по умолчанию. +// +// Параметры: +// Корреспондент - ПланОбменаСсылка - корреспондент +// +// Возвращаемое значение: +// Строка - идентфикатор транспорта +// +Функция ТранспортПоУмолчанию(Корреспондент) Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.ТранспортПоУмолчанию(Корреспондент) +``` +
+ +## ПараметрыТранспорта +
+ +Описание, пример вызова + +```bsl + +// Параметры транспорта (обработки транспорта). +// +// Параметры: +// ИдентификаторТранспорта - Строка - идентификатор транспорта +// +// Возвращаемое значение: +// Неопределено, Структура - см. СтруктураПараметровТранспорта +// +Функция ПараметрыТранспорта(Знач ИдентификаторТранспорта) Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.ПараметрыТранспорта(ИдентификаторТранспорта) +``` +
+ +## ПараметрТранспорта +
+ +Описание, пример вызова + +```bsl + +// Параметр транспорта (обработки транспорта). +// +// Параметры: +// ИдентификаторТранспорта - Строка - идентификатор транспорта +// ИмяПараметра - Строка - имя параметра транспорта. Список параметров см. СтруктураПараметровТранспорта +// +// Возвращаемое значение: +// Произвольный +// +Функция ПараметрТранспорта(Знач ИдентификаторТранспорта, ИмяПараметра) Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.ПараметрТранспорта(ИдентификаторТранспорта, ИмяПараметра) +``` +
+ +## МенеджерТранспортаПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Возвращает обработку транспорта по ее идентификатору. +// +// Параметры: +// ИдентификаторТранспорта - Строка - идентификатор транспорта +// +// Возвращаемое значение: +// Произвольный - менеджер обработки транспорта +// +Функция МенеджерТранспортаПоИдентификатору(ИдентификаторТранспорта) Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаПоИдентификатору(ИдентификаторТранспорта) +``` +
+ +## МенеджерТранспортаFILE +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта FILE. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаFILE +// +Функция МенеджерТранспортаFILE() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаFILE() +``` +
+ +## МенеджерТранспортаCOM +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта COM. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаCOM +// +Функция МенеджерТранспортаCOM() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаCOM() +``` +
+ +## МенеджерТранспортаEMAIL +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта EMAIL. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаEMAIL +// +Функция МенеджерТранспортаEMAIL() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаEMAIL() +``` +
+ +## МенеджерТранспортаFTP +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта FTP. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаFTP +// +Функция МенеджерТранспортаFTP() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаFTP() +``` +
+ +## МенеджерТранспортаHTTP +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта HTTP. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаHTTP +// +Функция МенеджерТранспортаHTTP() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаHTTP() +``` +
+ +## МенеджерТранспортаWS +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта WS. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаWS +// +Функция МенеджерТранспортаWS() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаWS() +``` +
+ +## МенеджерТранспортаSM +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта SM. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаSM +// +Функция МенеджерТранспортаSM() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаSM() +``` +
+ +## МенеджерТранспортаПассивныйРежим +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта ПассивныйРежим. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаПассивныйРежим +// +Функция МенеджерТранспортаПассивныйРежим() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаПассивныйРежим() +``` +
+ +## МенеджерТранспортаESB1C +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта ESB1C. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаESB1C +// +Функция МенеджерТранспортаESB1C() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаESB1C() +``` +
+ +## МенеджерТранспортаGoogleDrive +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта GoogleDrive. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаGoogleDrive +// +Функция МенеджерТранспортаGoogleDrive() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаGoogleDrive() +``` +
+ +## МенеджерТранспортаЯндексДиск +
+ +Описание, пример вызова + +```bsl + +// Возвращает менеджер обработки транспорта ЯндексДиск. +// +// Возвращаемое значение: +// ОбработкаМенеджер.ТранспортСообщенийОбменаЯндексДиск +// +Функция МенеджерТранспортаЯндексДиск() Экспорт +``` + +Пример вызова +```bsl +Результат = ТранспортСообщенийОбмена.МенеджерТранспортаЯндексДиск() +``` +
+ +## УдалитьВсеНастройкиТранспорта +
+ +Описание, пример вызова + +```bsl + +// Удалить все настройки транспорта. +// +// Параметры: +// Корреспондент - ПланОбменаСсылка - удаляемый узел плана обмена +// +Процедура УдалитьВсеНастройкиТранспорта(Корреспондент) Экспорт +``` + +Пример вызова +```bsl +ТранспортСообщенийОбмена.УдалитьВсеНастройкиТранспорта(Корреспондент) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ТранспортСообщенийОбменаПереопределяемый.md b/src/content/docs/bsp/ТранспортСообщенийОбменаПереопределяемый.md new file mode 100644 index 0000000..bb40bb1 --- /dev/null +++ b/src/content/docs/bsp/ТранспортСообщенийОбменаПереопределяемый.md @@ -0,0 +1,104 @@ +--- +title: Транспорт сообщений обмена переопределяемый +slug: bsp/транспорт-сообщений-обмена-переопределяемый +--- + + +## ПриОпределенииТиповТранспорта +
+ +Описание, пример вызова + +```bsl + +// Вызывается из ТранспортСообщенийОбмена.ВсеТипыТранспорта +// Возвращает все доступные типы транспорта. +// +// Параметры: +// ТипыТранспорта - Массив из ОбработкаОбъект.ТранспортСообщенийОбмена* +// +Процедура ПриОпределенииТиповТранспорта(ТипыТранспорта) Экспорт +``` + +Пример вызова +```bsl +ТранспортСообщенийОбменаПереопределяемый.ПриОпределенииТиповТранспорта(ТипыТранспорта) +``` +
+ +## ПриОпределенииДоступныхТиповТранспорта +
+ +Описание, пример вызова + +```bsl + +// Вызывается в ТранспортСообщенийОбмена.ДоступныеТипыТранспорта +// Определяет доступные типы транспорта для узла плана обмена +// +// Параметры: +// ДоступныеТипыТранспорта - Массив из ОбработкаОбъект.ТранспортСообщенийОбмена* +// Корреспондент - ПланОбменаСсылка - узел, для котороно определяются доступные типы транспорта +// ВариантНастройки - Строка - вариант настройки +// +Процедура ПриОпределенииДоступныхТиповТранспорта(ДоступныеТипыТранспорта, Корреспондент, ВариантНастройки = "") Экспорт +``` + +Пример вызова +```bsl +ТранспортСообщенийОбменаПереопределяемый.ПриОпределенииДоступныхТиповТранспорта(ДоступныеТипыТранспорта, Корреспондент, ВариантНастройки); +``` +
+ +## ПриПомещенииФайлаВХранилище +
+ +Описание, пример вызова + +```bsl + +// Вызывается в ОбменДаннымиОперацииВебСервисов.СобратьФайлИзЧастей, +// при помещении файла в хранилище сообщений обмена (регистр сведений СообщенияОбменаДанными). +// +// Параметры: +// ИмяФайла - Строка +// ИдентификаторФайла - Строка +// +Процедура ПриПомещенииФайлаВХранилище(ИмяФайла, ИдентификаторФайла) Экспорт +``` + +Пример вызова +```bsl +ТранспортСообщенийОбменаПереопределяемый.ПриПомещенииФайлаВХранилище(ИмяФайла, ИдентификаторФайла) +``` +
+ +## ПередПолучениемФайлаИзХранилища +
+ +Описание, пример вызова + +```bsl + +// Вызывается в ОбменДаннымиОперацииВебСервисов.ПодготовитьФайлДляПолучения, +// перед получерием файла их хранилища сообщений обмена (регистр сведений СообщенияОбменаДанными). +// +// Параметры: +// ИдентификаторФайла - Строка +// +Процедура ПередПолучениемФайлаИзХранилища(ИдентификаторФайла) Экспорт +``` + +Пример вызова +```bsl +ТранспортСообщенийОбменаПереопределяемый.ПередПолучениемФайлаИзХранилища(ИдентификаторФайла) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УдалениеПомеченныхОбъектов.md b/src/content/docs/bsp/УдалениеПомеченныхОбъектов.md new file mode 100644 index 0000000..9390fe8 --- /dev/null +++ b/src/content/docs/bsp/УдалениеПомеченныхОбъектов.md @@ -0,0 +1,264 @@ +--- +title: Удаление помеченных объектов +slug: bsp/удаление-помеченных-объектов +--- + + +## УдалитьПомеченныеОбъекты +
+ +Описание, пример вызова + +```bsl + +// Безвозвратно удаляет объекты, помеченные на удаление, выполняя при этом контроль ссылочной целостности. +// Следует вызывать вне транзакции, т.к. функция сама управляет транзакциями и порционностью. +// +// Параметры: +// УдаляемыеОбъекты - Массив из ПланОбменаСсылка +// - Массив из СправочникСсылка +// - Массив из ДокументСсылка +// - Массив из ПланСчетовСсылка +// - Массив из ПланВидовРасчетаСсылка +// - Массив из БизнесПроцессСсылка +// - Массив из ЗадачаСсылка - объекты для удаления. +// РежимУдаления - Строка - способ удаления, может принимать значения: +// "Стандартный" - удаление объектов с контролем ссылочной целостности и сохранением возможности +// многопользовательской работы. +// "Монопольный" - удаление объектов с контролем ссылочной целостности с установкой монопольного режима. +// Если монопольный режим установить не удалось, то будет вызвано исключение. +// "Упрощенный" - удаление объектов, при котором контроль ссылочной целостности выполняется только в непомеченных +// на удаление объектах. В помеченных на удаление объектах ссылки на удаляемые объекты будут очищены. +// +// Возвращаемое значение: +// Структура: +// * Успешно - Булево - Истина, если все объекты были удалены. +// * ПрепятствующиеУдалению - ТаблицаЗначений - объекты, в которых есть ссылки на удаляемые объекты: +// ** УдаляемыйСсылка - ЛюбаяСсылка +// ** МестоИспользования - ЛюбаяСсылка - ссылка на объект, препятствующий удалению. +// - Неопределено - объект используется в константе или +// в процессе удаление произошла ошибка. Информация о константе указана в поле метаданные. +// Информация об ошибке указана в поле ОписаниеОшибки. +// ** ОписаниеОшибки - Строка - описание ошибки при удалении объекта. +// ** ПодробноеОписаниеОшибки - Строка - подробное описание ошибки при удалении объекта. +// ** Метаданные - ОбъектМетаданных - описание метаданных объекта, препятствующего удалению. +// * Удаленные - Массив из ЛюбаяСсылка- успешно удаленные объекты. +// * НеУдаленные - Массив из ЛюбаяСсылка - не удаленные объекты. +// +Функция УдалитьПомеченныеОбъекты(УдаляемыеОбъекты, РежимУдаления = "Стандартный") Экспорт +``` + +Пример вызова +```bsl +Результат = УдалениеПомеченныхОбъектов.УдалитьПомеченныеОбъекты(УдаляемыеОбъекты, РежимУдаления); +``` +
+ +## ПомеченныеНаУдаление +
+ +Описание, пример вызова + +```bsl + +// Формирует помеченные на удаление с учетом разделения и фильтрацией служебных и предопределенных объектов. +// При выполнении в разделенном сеансе будут возвращены объекты с учетом разделителя. +// Предопределенные элементы исключаются из результата поиска. +// +// Параметры: +// ОтборМетаданных - СписокЗначений из Строка - список из полных имен метаданных, в которых будет +// выполнен поиск помеченных на удаление. +// Например, "Справочник.Номенклатура". +// - Неопределено - отбор по объектам метаданных накладываться не будет. +// +// ИскатьТехнологическиеОбъекты - Булево - если Истина, то поиск будет осуществляться в объектах метаданных, +// добавленных в исключения поиска ссылок. +// см. ОбщегоНазначения.ИсключенияПоискаСсылок. +// Например, в справочнике КлючиДоступа. +// +// +// Возвращаемое значение: +// Массив из ЛюбаяСсылка +// +Функция ПомеченныеНаУдаление(Знач ОтборМетаданных = Неопределено, ИскатьТехнологическиеОбъекты = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УдалениеПомеченныхОбъектов.ПомеченныеНаУдаление(ОтборМетаданных, ИскатьТехнологическиеОбъекты); +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Устанавливает видимость помеченных на удаление. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма с динамическим списком +// НастройкиОтображенияПомеченныхОбъектов - см. НастройкиОтображенияПомеченныхОбъектов +// - ТаблицаФормы - элемент формы динамического списка. +// +// Пример: +// // Для настройки одного списка +// УдалениеПомеченныхОбъектов.ПриСозданииНаСервере(ЭтотОбъект, Элементы.Список); +// +// // Для настройки нескольких списков +// НастройкиОтображенияПомеченных = УдалениеПомеченныхОбъектов.НастройкиОтображенияПомеченныхОбъектов(); +// Настройка = НастройкиОтображения.Добавить(); +// Настройка.ИмяЭлементаФормы = Элементы.Список1.Имя; +// Настройка = НастройкиОтображения.Добавить(); +// Настройка.ИмяЭлементаФормы = Элементы.Список2.Имя; +// +// // Установка основной таблицы необходима для перехода к спискам помеченных объектов +// // с предустановленным отбором +// ОсновныеТаблицыСписка = Новый СписокЗначений(); +// ОсновныеТаблицыСписка.Добавить("Справочник.Номенклатура"); +// Настройка.ТипыМетаданных = ОсновныеТаблицыСписка; +// УдалениеПомеченныхОбъектов.ПриСозданииНаСервере(ЭтотОбъект, НастройкиОтображенияПомеченных); +// +Процедура ПриСозданииНаСервере(Форма, Знач НастройкиОтображенияПомеченныхОбъектов) Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектов.ПриСозданииНаСервере(Форма, НастройкиОтображенияПомеченныхОбъектов) +``` +
+ +## НастройкиОтображенияПомеченныхОбъектов +
+ +Описание, пример вызова + +```bsl + +// Формирует настройки отображения помеченных на удаления объектов. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ИмяЭлементаФормы - Строка - имя таблицы формы, связанного с динамическим списком. +// * ТипыМетаданных - СписокЗначений из Строка - типы объектов, отображаемых в динамическом списке. +// * ИмяСписка - Строка - необязательный. Имя динамического списка на форме. +// +Функция НастройкиОтображенияПомеченныхОбъектов() Экспорт +``` + +Пример вызова +```bsl +Результат = УдалениеПомеченныхОбъектов.НастройкиОтображенияПомеченныхОбъектов() +``` +
+ +## РежимУдалятьПоРасписанию +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о настройках удаления помеченных по расписанию. +// Пример использования см. в документации. +// +// Возвращаемое значение: +// Структура: +// * Расписание - см. РегламентныеЗаданияСервер.РасписаниеРегламентногоЗадания +// * Использование - Булево - признак использования регламентного задания. +// +Функция РежимУдалятьПоРасписанию() Экспорт +``` + +Пример вызова +```bsl +Результат = УдалениеПомеченныхОбъектов.РежимУдалятьПоРасписанию() +``` +
+ +## УстановитьПометкуКомандыПоказатьПомеченные +
+ +Описание, пример вызова + +```bsl + +// Устанавливает пометку команды Показать помеченные в соответствии с сохраненными настройками пользователя. +// Используется для установки начального значения пометки кнопки формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// ТаблицаФормы - ТаблицаФормы - таблица формы, связанная с динамическим списком +// КнопкаФормы - КнопкаФормы - кнопка, связанная с командой Показать помеченные +// +Процедура УстановитьПометкуКомандыПоказатьПомеченные(Форма, ТаблицаФормы, КнопкаФормы) Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектов.УстановитьПометкуКомандыПоказатьПомеченные(Форма, ТаблицаФормы, КнопкаФормы) +``` +
+ +## СсылкиНаУдаляемыеОбъекты +
+ +Описание, пример вызова + +```bsl + +// Возвращает перечень объектов, которые удаляются в текущий момент и на которые есть ссылки в объекте Источник. +// Для наборов записей, подчиненных регистратору, возвращает всегда пустой список ссылок: +// - для уменьшения влияния контроля на производительность; +// - для бесперебойной работы автоматических механизмов формирования движений (например, закрытия месяца). +// +// Параметры: +// Источник - СправочникОбъект +// - ДокументОбъект +// - РегистрСведенийНаборЗаписей - объект, в котором будет выполнен поиск удаляемых объектов. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ЛюбаяСсылка - удаляемый объект, ссылка на который есть в объекте Источник. +// * Значение - Строка - представление ссылки. +// +Функция СсылкиНаУдаляемыеОбъекты(Источник) Экспорт +``` + +Пример вызова +```bsl +Результат = УдалениеПомеченныхОбъектов.СсылкиНаУдаляемыеОбъекты(Источник) +``` +
+ +## ЗначениеФлажкаУдалятьПоРасписанию +
+ +Описание, пример вызова + +```bsl + +// Устарела. Состояние флажка для формы настроек удаления помеченных объектов. +// Следует использовать УдалениеПомеченныхОбъектов.РежимУдалятьПоРасписанию. +// +// Возвращаемое значение: +// Булево - значение. +// +Функция ЗначениеФлажкаУдалятьПоРасписанию() Экспорт +``` + +Пример вызова +```bsl +Результат = УдалениеПомеченныхОбъектов.ЗначениеФлажкаУдалятьПоРасписанию() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УдалениеПомеченныхОбъектовКлиент.md b/src/content/docs/bsp/УдалениеПомеченныхОбъектовКлиент.md new file mode 100644 index 0000000..a6eeed6 --- /dev/null +++ b/src/content/docs/bsp/УдалениеПомеченныхОбъектовКлиент.md @@ -0,0 +1,207 @@ +--- +title: Удаление помеченных объектов клиент +slug: bsp/удаление-помеченных-объектов-клиент +--- + + +## НачатьУдалениеПомеченных +
+ +Описание, пример вызова + +```bsl + +// Начинает интерактивное удаление помеченных объектов. +// +// Параметры: +// УдаляемыеОбъекты - Массив из ЛюбаяСсылка - перечень удаляемых объектов. +// ПараметрыУдаления - см. ПараметрыИнтерактивногоУдаления +// +// Владелец - ФормаКлиентскогоПриложения +// - Неопределено - форма, из которой начата операция удаления. +// Если не указан, то в обработку оповещения о закрытии +// не будет передана подробная информация об итогах удаления. +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - если указано, то при окончании удаления или +// при закрытии формы в обработку оповещения будет передан результат +// в виде структуры со свойствами: +// # Успешно - Булево - Истина, если все объекты удалены успешно. +// # УдаленныеКоличество - Число - количество удаленных объектов. +// # НеУдаленныеКоличество - Число - количество неудаленных объектов. +// # АдресРезультата - Строка - адрес временного хранилища. +// +Процедура НачатьУдалениеПомеченных(УдаляемыеОбъекты, ПараметрыУдаления = Неопределено, Владелец = Неопределено, Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектовКлиент.НачатьУдалениеПомеченных(УдаляемыеОбъекты, ПараметрыУдаления, Владелец, ); +``` +
+ +## ПараметрыИнтерактивногоУдаления +
+ +Описание, пример вызова + +```bsl + +// Настройки интерактивного удаления. +// +// Возвращаемое значение: +// Структура: +// * Режим - Строка - способ удаления, может принимать значения: +// "Стандартный" - удаление объектов с контролем ссылочной целостности и сохранением возможности +// многопользовательской работы. +// "Монопольный" - удаление объектов с контролем ссылочной целостности с установкой монопольного режима. +// "Упрощенный" - удаление объектов, при котором контроль ссылочной целостности выполняется только в непомеченных +// на удаление объектах. В помеченных на удаление объектах ссылки на удаляемые объекты +// будут очищены. +// +Функция ПараметрыИнтерактивногоУдаления() Экспорт +``` + +Пример вызова +```bsl +Результат = УдалениеПомеченныхОбъектовКлиент.ПараметрыИнтерактивногоУдаления() +``` +
+ +## ПерейтиКПомеченнымНаУдаление +
+ +Описание, пример вызова + +```bsl + +// Открывает рабочее место Удаление помеченных. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// ТаблицаФормы - ТаблицаФормы +// - ДанныеФормыСтруктура +// - Неопределено - таблица формы, связанная с динамическим списком +// +Процедура ПерейтиКПомеченнымНаУдаление(Форма, ТаблицаФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектовКлиент.ПерейтиКПомеченнымНаУдаление(Форма, ТаблицаФормы); +``` +
+ +## ПоказатьПомеченныеНаУдаление +
+ +Описание, пример вызова + +```bsl + +// Изменяет видимость помеченных на удаление и сохраняет настройку пользователя. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// ТаблицаФормы - ТаблицаФормы - таблица формы, связанная с динамическим списком. +// КнопкаФормы - КнопкаФормы - кнопка формы, связанная с командой Показать помеченные на удаление. +// +Процедура ПоказатьПомеченныеНаУдаление(Форма, ТаблицаФормы, КнопкаФормы) Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектовКлиент.ПоказатьПомеченныеНаУдаление(Форма, ТаблицаФормы, КнопкаФормы) +``` +
+ +## НачатьИзменениеРасписанияРегламентногоЗадания +
+ +Описание, пример вызова + +```bsl + +// Открывает форму для изменения расписания регламентного задания. +// Если расписание задано, то будет включено регламентное задание с установленным расписанием. +// +// Не поддерживается на мобильном платформе. +// +// Параметры: +// ОповещениеОбИзменении - ОписаниеОповещения - обработчик изменения расписания регламентного задания. +// +Процедура НачатьИзменениеРасписанияРегламентногоЗадания(ОповещениеОбИзменении = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектовКлиент.НачатьИзменениеРасписанияРегламентногоЗадания(ОповещениеОбИзменении); +``` +
+ +## ПриИзмененииФлажкаУдалятьПоРасписанию +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриИзменении для флажка, выполняющего переключение режима автоматического удаления объектов. +// +// Параметры: +// АвтоматическиУдалятьПомеченныеОбъекты - Булево - новое значение флажка, которое требуется обработать. +// ОповещениеОбИзменении - ОписаниеОповещения - если ЗначениеФлажкаАвтоматическиУдалятьПомеченныеОбъекты = Истина, то процедура +// будет вызвана после выбора расписания регламентного задания. +// Если ЗначениеФлажкаАвтоматическиУдалятьПомеченныеОбъекты = Ложь, то процедура будет +// вызвана сразу же. +// +// Пример: +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.УдалениеПомеченныхОбъектов") Тогда +// МодульУдалениеПомеченныхОбъектовКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("УдалениеПомеченныхОбъектовКлиент"); +// МодульУдалениеПомеченныхОбъектовКлиент.ПриИзмененииФлажкаУдалятьПоРасписанию(АвтоматическиУдалятьПомеченныеОбъекты); +// КонецЕсли; +// +Процедура ПриИзмененииФлажкаУдалятьПоРасписанию(АвтоматическиУдалятьПомеченныеОбъекты, ОповещениеОбИзменении = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектовКлиент.ПриИзмененииФлажкаУдалятьПоРасписанию(АвтоматическиУдалятьПомеченныеОбъекты, ОповещениеОбИзменении); +``` +
+ +## ОбработкаОповещенияИзмененияФлажкаУдалятьПоРасписанию +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ОбработкаОповещения для формы, на которой требуется отобразить флажок удаления по расписанию. +// +// Параметры: +// ИмяСобытия - Строка - имя события, которое было получено обработчиком события на форме. +// АвтоматическиУдалятьПомеченныеОбъекты - Булево - реквизит, в которое будет помещено значение. +// +// Пример: +// Если ОбщегоНазначенияКлиент.ПодсистемаСуществует("СтандартныеПодсистемы.УдалениеПомеченныхОбъектов") Тогда +// МодульУдалениеПомеченныхОбъектовКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("УдалениеПомеченныхОбъектовКлиент"); +// МодульУдалениеПомеченныхОбъектовКлиент.ОбработкаОповещенияИзмененияФлажкаУдалятьПоРасписанию( +// ИмяСобытия, +// АвтоматическиУдалятьПомеченныеОбъекты); +// КонецЕсли; +// +Процедура ОбработкаОповещенияИзмененияФлажкаУдалятьПоРасписанию(Знач ИмяСобытия, Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектовКлиент.ОбработкаОповещенияИзмененияФлажкаУдалятьПоРасписанию(ИмяСобытия, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УдалениеПомеченныхОбъектовПереопределяемый.md b/src/content/docs/bsp/УдалениеПомеченныхОбъектовПереопределяемый.md new file mode 100644 index 0000000..a047c6b --- /dev/null +++ b/src/content/docs/bsp/УдалениеПомеченныхОбъектовПереопределяемый.md @@ -0,0 +1,116 @@ +--- +title: Удаление помеченных объектов переопределяемый +slug: bsp/удаление-помеченных-объектов-переопределяемый +--- + + +## ПриОпределенииОбъектовСКомандойПоказатьПомеченные +
+ +Описание, пример вызова + +```bsl + +// Определить объекты метаданных, в формах списков которых +// будет выведена команда показать помеченные и перейти к помеченным на удаление. +// см. УдалениеПомеченныхОбъектовКлиент.ПоказатьПомеченныеНаУдаление и УдалениеПомеченныхОбъектовКлиент.ПерейтиКПомеченнымНаУдаление. +// +// Параметры: +// Объекты - Массив из ОбъектМетаданных - объекты метаданных, в формы списка которых будут добавлены команды скрытия +// помеченных на удаления. +// +// Пример: +// Объекты.Добавить(Метаданные.Справочники.Номенклатура); +// Объекты.Добавить(Метаданные.Справочники.Партнеры); +// +Процедура ПриОпределенииОбъектовСКомандойПоказатьПомеченные(Объекты) Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектовПереопределяемый.ПриОпределенииОбъектовСКомандойПоказатьПомеченные(Объекты) +``` +
+ +## ПередУдалениемГруппыОбъектов +
+ +Описание, пример вызова + +```bsl + +// Вызывается вне транзакции перед удалением группы связанных объектов. +// +// Параметры: +// Контекст - Структура - произвольные данные, которые можно проинициализировать для передачи +// в УдалениеПомеченныхОбъектовПереопределяемый.ПослеУдаленияГруппыОбъектов. +// УдаляемыеОбъекты - Массив из ЛюбаяСсылка - объекты, которые будут удалены. +// +Процедура ПередУдалениемГруппыОбъектов(Контекст, УдаляемыеОбъекты) Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектовПереопределяемый.ПередУдалениемГруппыОбъектов(Контекст, УдаляемыеОбъекты) +``` +
+ +## ПослеУдаленияГруппыОбъектов +
+ +Описание, пример вызова + +```bsl + +// Вызывается вне транзакции после удаления группы связанных объектов. +// Например, для очистки связанных данных на внешних ресурсах и других операций, +// которые недопустимо выполнять в транзакции удаления. +// +// Параметры: +// Контекст - см. УдалениеПомеченныхОбъектовПереопределяемый.ПередУдалениемГруппыОбъектов.Контекст +// Успешно - Булево - Истина, если группа объектов успешно удалена. +// +Процедура ПослеУдаленияГруппыОбъектов(Контекст, Успешно) Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектовПереопределяемый.ПослеУдаленияГруппыОбъектов(Контекст, Успешно) +``` +
+ +## ПередПоискомПомеченныхНаУдаление +
+ +Описание, пример вызова + +```bsl + +// Устарела. Вызывается перед поиском объектов, помеченных на удаление. +// В этом обработчике можно организовать удаление устаревших ключей аналитик и любых других объектов информационной +// базы, ставших более не нужными. +// +// Вместо процедуры следует использовать либо событие ПередУдалением удаляемых объектов, +// либо определить ПодчиненныеОбъекты, см. ОбщегоНазначения.ПодчиненныеОбъекты. +// +// Параметры: +// Параметры - Структура: +// * Интерактивное - Булево - Истина, если удаление помеченных объектов запущено пользователем; +// Ложь, если удаление запущено по расписанию регламентного задания. +// +Процедура ПередПоискомПомеченныхНаУдаление(Параметры) Экспорт +``` + +Пример вызова +```bsl +УдалениеПомеченныхОбъектовПереопределяемый.ПередПоискомПомеченныхНаУдаление(Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УдаленноеАдминистрированиеБТСКлиент.md b/src/content/docs/bsp/УдаленноеАдминистрированиеБТСКлиент.md new file mode 100644 index 0000000..88f409f --- /dev/null +++ b/src/content/docs/bsp/УдаленноеАдминистрированиеБТСКлиент.md @@ -0,0 +1,48 @@ +--- +title: Удаленное администрирование БТС клиент +slug: bsp/удаленное-администрирование-бтс-клиент +--- + + +## ПриЗавершенииСеансов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при завершении сеанса средствами подсистемы ЗавершениеРаботыПользователей. +// +// Параметры: +// ФормаВладелец - ФормаКлиентскогоПриложения - из которой выполняется завершение сеанса, +// НомераСеансов - Число - номер сеанса, который будет завершен, +// СтандартнаяОбработка - Булево - флаг выполнения стандартной обработки завершения сеанса +// (подключение к агенту сервера через COM-соединение или сервер администрирования с +// запросом параметров подключения к кластеру у текущего пользователя). Может быть +// установлен в значение Ложь внутри обработчика события, в этом случае стандартная +// обработка завершения сеанса выполняться не будет, +// ОповещениеПослеЗавершенияСеанса - ОписаниеОповещения - описание оповещения, которое должно +// быть вызвано после завершения сеанса (для автоматического обновления списка активных +// пользователей). При установке значения параметра СтандартнаяОбработка равным Ложь, +// после успешного завершения сеанса, для переданного описания оповещения должна быть +// выполнена обработка с помощью метода ВыполнитьОбработкуОповещения (в качестве значения +// параметра Результат следует передавать КодВозвратаДиалога.ОК при успешном завершении +// сеанса). Параметр может быть опущен - в этом случае выполнять обработку оповещения не +// следует. +// +Процедура ПриЗавершенииСеансов(ФормаВладелец, Знач НомераСеансов, СтандартнаяОбработка, Знач ОповещениеПослеЗавершенияСеанса = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УдаленноеАдминистрированиеБТСКлиент.ПриЗавершенииСеансов(ФормаВладелец, НомераСеансов, СтандартнаяОбработка, ОповещениеПослеЗавершенияСеанса); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УдаленноеАдминистрированиеБТССлужебный.md b/src/content/docs/bsp/УдаленноеАдминистрированиеБТССлужебный.md new file mode 100644 index 0000000..a56b027 --- /dev/null +++ b/src/content/docs/bsp/УдаленноеАдминистрированиеБТССлужебный.md @@ -0,0 +1,39 @@ +--- +title: Удаленное администрирование БТС служебный +slug: bsp/удаленное-администрирование-бтс-служебный +--- + + +## ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру массивами поддерживаемых версий всех подлежащих версионированию подсистем, +// используя в качестве ключей названия подсистем. +// Обеспечивает функциональность Web-сервиса InterfaceVersion. +// При внедрении надо поменять тело процедуры так, чтобы она возвращала актуальные наборы версий (см. пример.ниже). +// +// Параметры: +// СтруктураПоддерживаемыхВерсий - Структура - структура поддерживаемых версий: +// * Ключи - Строка - название подсистеы. +// * Значения - Массив - названия поддерживаемых версий. +// +Процедура ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(Знач СтруктураПоддерживаемыхВерсий) Экспорт +``` + +Пример вызова +```bsl +УдаленноеАдминистрированиеБТССлужебный.ПриОпределенииПоддерживаемыхВерсийПрограммныхИнтерфейсов(СтруктураПоддерживаемыхВерсий) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УниверсальнаяИнтеграция.md b/src/content/docs/bsp/УниверсальнаяИнтеграция.md new file mode 100644 index 0000000..5a7b428 --- /dev/null +++ b/src/content/docs/bsp/УниверсальнаяИнтеграция.md @@ -0,0 +1,244 @@ +--- +title: Универсальная интеграция +slug: bsp/универсальная-интеграция +--- + + +## ПолучитьДанныеОбъектаПоПравилу +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные объекта из Менеджера сервиса по правилу трансляции. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПравила - Строка - идентификатор правила трансляции с типом "Чтение". +// КлючОбъекта - Строка, Число - ключ объекта, определенный в правиле. +// +// Возвращаемое значение: +// Структура -- данные объекта или Неопределено, если данные не получены: +// * Поле - Произвольный - произвольный состав полей. +Функция ПолучитьДанныеОбъектаПоПравилу(ИдентификаторПравила, КлючОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = УниверсальнаяИнтеграция.ПолучитьДанныеОбъектаПоПравилу(ИдентификаторПравила, КлючОбъекта) +``` +
+ +## ОтправитьДанныеОбъектаПоПравилу +
+ +Описание, пример вызова + +```bsl + +// Отправляет данные в Менеджер сервиса. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПравила - Строка - идентификатор правила трансляции с типом "Загрузка". +// Данные - Структура - данные для отправки в менеджер сервиса: +// * Поле - Произвольный - произвольный состав полей, определенный у универсальном объекте. +// +// Возвращаемое значение: +// Структура - результат выполнения запроса: +// * КодСостояния - Число - код состояния ответа. +// * ТелоОтвета - Строка - тело ответа в виде строки. +// * ДанныеОтвета - Неопределено, Структура - данные объекта или Неопределено, если данные не получены: +// ** Поле - Произвольный - произвольный состав полей, если ответ содержит заголовок +// "Content-Type: application/json" возвращается Структура. +Функция ОтправитьДанныеОбъектаПоПравилу(ИдентификаторПравила, Данные = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УниверсальнаяИнтеграция.ОтправитьДанныеОбъектаПоПравилу(ИдентификаторПравила, Данные); +``` +
+ +## ИзменитьДанныеОбъектаПоПравилу +
+ +Описание, пример вызова + +```bsl + +// Изменяет объект в Менеджере сервиса по правилу трансляции. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПравила - Строка - идентификатор правила трансляции с типом "Загрузка". +// КлючОбъекта - Строка, Число - ключ объекта, определенный в правиле. +// Данные - Структура - данные для отправки в менеджер сервиса. +// * Поле - Произвольный - произвольный состав полей, определенный у универсальном объекте. +// +// Возвращаемое значение: +// Структура - данные ответа: +// * КодСостояния - Число - код состояния ответа. +// * ТелоОтвета - Строка - тело ответа. +// * ДанныеОтвета - Неопределено, Структура - данные объекта или Неопределено, если данные не получены: +// ** Поле - Произвольный - произвольный состав полей, если ответ содержит заголовок +// "Content-Type: application/json" возвращается Структура. +Функция ИзменитьДанныеОбъектаПоПравилу(ИдентификаторПравила, КлючОбъекта, Данные = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УниверсальнаяИнтеграция.ИзменитьДанныеОбъектаПоПравилу(ИдентификаторПравила, КлючОбъекта, Данные); +``` +
+ +## ПодписатьсяНаОповещенияОбИзменении +
+ +Описание, пример вызова + +```bsl + +// Метод позволяет подписаться на оповещения об изменении объектов в менеджере сервиса по правилам тарансляции. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПравила - Строка - идентификатор правила трансляции. +// КлючОбъекта - Строка - ключ объекта интеграции на обновления которого подписываемся. +// +Процедура ПодписатьсяНаОповещенияОбИзменении(ИдентификаторПравила, КлючОбъекта) Экспорт +``` + +Пример вызова +```bsl +УниверсальнаяИнтеграция.ПодписатьсяНаОповещенияОбИзменении(ИдентификаторПравила, КлючОбъекта) +``` +
+ +## ОтписатьсяОтОповещенийНаИзменения +
+ +Описание, пример вызова + +```bsl + +// Метод позволяет отписаться от оповещений об изменении объектов в менеджере сервиса по правилам трансляции. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПравила - Строка - идентификатор правила трансляции +// КлючОбъекта - Строка - ключ объекта, по которому отписываемся от оповещений об обновлениях. +// +Процедура ОтписатьсяОтОповещенийНаИзменения(ИдентификаторПравила, КлючОбъекта) Экспорт +``` + +Пример вызова +```bsl +УниверсальнаяИнтеграция.ОтписатьсяОтОповещенийНаИзменения(ИдентификаторПравила, КлючОбъекта) +``` +
+ +## ПрочитатьПолученныеДанныеОбъекта +
+ +Описание, пример вызова + +```bsl + +// Функция позволяет прочитать полученные данные объекта по ключу полученных данных. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ИдентификаторПравила - Строка - идентификатор правила трансляции. +// КлючОбъекта - Строка - ключ объекта. +// +// Возвращаемое значение: +// Структура - прочитанные полученные данные объекта: +// * Поле - Произвольный - произвольный состав полей, определенный у универсальном объекте. +// +Функция ПрочитатьПолученныеДанныеОбъекта(ИдентификаторПравила, КлючОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = УниверсальнаяИнтеграция.ПрочитатьПолученныеДанныеОбъекта(ИдентификаторПравила, КлючОбъекта) +``` +
+ +## ПодписатьсяНаОповещениеОбИзмененииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Метод позволяет подписаться на оповещения об изменении объектов в менеджере сервиса. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ТипОбъекта - Строка +// ИдентификаторОбъекта - УникальныйИдентификатор +Процедура ПодписатьсяНаОповещениеОбИзмененииОбъекта(ТипОбъекта, ИдентификаторОбъекта) Экспорт +``` + +Пример вызова +```bsl +УниверсальнаяИнтеграция.ПодписатьсяНаОповещениеОбИзмененииОбъекта(ТипОбъекта, ИдентификаторОбъекта) +``` +
+ +## ОтписатьсяОтОповещенияОбИзмененииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Метод позволяет отписаться от оповещений об изменении объектов в менеджере сервиса по правилам трансляции. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ТипОбъекта - Строка +// ИдентификаторОбъекта - УникальныйИдентификатор +Процедура ОтписатьсяОтОповещенияОбИзмененииОбъекта(ТипОбъекта, ИдентификаторОбъекта) Экспорт +``` + +Пример вызова +```bsl +УниверсальнаяИнтеграция.ОтписатьсяОтОповещенияОбИзмененииОбъекта(ТипОбъекта, ИдентификаторОбъекта) +``` +
+ +## ПолученоОповещениеОбИзмененииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Функция позволяет проверить признак изменения объекта по типу и идентификатору объекта. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ТипОбъекта - Строка +// ИдентификаторОбъекта - УникальныйИдентификатор +// +// Возвращаемое значение: +// Булево - признак изменения объекта после последней подписки на изменение. +Функция ПолученоОповещениеОбИзмененииОбъекта(ТипОбъекта, ИдентификаторОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = УниверсальнаяИнтеграция.ПолученоОповещениеОбИзмененииОбъекта(ТипОбъекта, ИдентификаторОбъекта) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УниверсальнаяИнтеграцияПереопределяемый.md b/src/content/docs/bsp/УниверсальнаяИнтеграцияПереопределяемый.md new file mode 100644 index 0000000..6f77e17 --- /dev/null +++ b/src/content/docs/bsp/УниверсальнаяИнтеграцияПереопределяемый.md @@ -0,0 +1,85 @@ +--- +title: Универсальная интеграция переопределяемый +slug: bsp/универсальная-интеграция-переопределяемый +--- + + +## ОбработатьДанныеПередОтправкой +
+ +Описание, пример вызова + +```bsl + +// Позволяет дополнить, изменить данные перед отправкой в менеджер сервиса. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ИдентификаторПравила - Строка - идентификатор правила. +// Данные - Структура - данные к отправке. +// +Процедура ОбработатьДанныеПередОтправкой(ИдентификаторПравила, Данные) Экспорт +``` + +Пример вызова +```bsl +УниверсальнаяИнтеграцияПереопределяемый.ОбработатьДанныеПередОтправкой(ИдентификаторПравила, Данные) +``` +
+ +## ОбработатьОповещениеОбИзменении +
+ +Описание, пример вызова + +```bsl + +// Процедура обработки оповещения об изменении объекта по правилу трансляции. +// Вызывается после получения данных объекта, перед сохранением объекта в безопасное хранилище. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ИдентификаторПравила - Строка - идентификатор правила трансляции. +// КлючОбъекта - Строка - ключ объекта. +// Данные - Структура - данные объекта. +// +Процедура ОбработатьОповещениеОбИзменении(ИдентификаторПравила, КлючОбъекта, Данные) Экспорт +``` + +Пример вызова +```bsl +УниверсальнаяИнтеграцияПереопределяемый.ОбработатьОповещениеОбИзменении(ИдентификаторПравила, КлючОбъекта, Данные) +``` +
+ +## ОбработатьОповещениеОбИзмененииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Процедура обработки оповещения об изменении объекта. +// Вызывается после получения оповещения, перед сохранением в безопасное хранилище. +// @skip-warning ПустойМетод - переопределяемый метод. +// +// Параметры: +// ТипОбъекта - Строка - тип объекта. +// КлючОбъекта - Строка - ключ объекта. +// +Процедура ОбработатьОповещениеОбИзмененииОбъекта(ТипОбъекта, КлючОбъекта) Экспорт +``` + +Пример вызова +```bsl +УниверсальнаяИнтеграцияПереопределяемый.ОбработатьОповещениеОбИзмененииОбъекта(ТипОбъекта, КлючОбъекта) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеДоступом.md b/src/content/docs/bsp/УправлениеДоступом.md new file mode 100644 index 0000000..00c0db7 --- /dev/null +++ b/src/content/docs/bsp/УправлениеДоступом.md @@ -0,0 +1,1452 @@ +--- +title: Управление доступом +slug: bsp/управление-доступом +--- + + +## ЕстьРоль +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что у пользователя есть роль (дополнительное право) в одном из профилей тех групп доступа, +// в которых он участвует с учетом того, что хотя бы одна группа доступа профиля предоставляет +// право Чтение объекта (или набор значений доступа разрешен для группы доступа). +// +// Для проверки только роли следует использовать функцию Пользователи.РолиДоступны. +// +// Параметры: +// Роль - Строка - имя роли. +// +// СсылкаНаОбъект - ЛюбаяСсылка - на объект, для которого заполняются наборы значений доступа +// для проверки права Чтение. +// - ТаблицаЗначений - таблица произвольных наборов значений доступа с колонками: +// * НомерНабора - Число - номер, группирующий несколько строк в отдельный набор. +// * ВидДоступа - Строка - имя вида доступа, указанного в переопределяемом модуле. +// * ЗначениеДоступа - ОпределяемыйТип.ЗначениеДоступа - тип значения доступа, +// указанного в переопределяемом модуле. +// Пустую подготовленную таблицу можно получить с помощью функции +// ТаблицаНаборыЗначенийДоступа общего модуля УправлениеДоступом +// (колонки Чтение, Изменение не заполнять). +// +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// - Неопределено - если параметр не указан, +// тогда право проверяется для текущего пользователя. +// +// Возвращаемое значение: +// Булево - если Истина, тогда у пользователя есть роль с учетом ограничений. +// +Функция ЕстьРоль(Знач Роль, Знач СсылкаНаОбъект = Неопределено, Знач Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ЕстьРоль(Роль, СсылкаНаОбъект, Пользователь); +``` +
+ +## ЕстьПраво +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что для пользователя настроено разрешение права для объекта. +// Например, для папки файлов могут быть настроены права "УправлениеПравами", "Чтение", "ИзменениеПапок", +// причем право "Чтение" является как правом для папки файлов, так и правом для файлов. +// +// Параметры: +// Право - Строка - имя права, как оно указано в процедуре ПриЗаполненииВозможныхПравДляНастройкиПравОбъектов +// общего модуля УправлениеДоступомПереопределяемый. +// +// СсылкаНаОбъект - СправочникСсылка +// - ПланВидовХарактеристикСсылка - ссылка на одного из владельцев прав, +// указанных в процедуре ПриЗаполненииВозможныхПравДляНастройкиПравОбъектов +// общего модуля УправлениеДоступомПереопределяемый, например ссылка на папку файлов. +// +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// - Неопределено - если параметр не указан, +// тогда право проверяется для текущего пользователя. +// +// Возвращаемое значение: +// Булево - если Истина, то настроено разрешение права с учетом всех разрешающих и +// запрещающих настроек в иерархии. +// +Функция ЕстьПраво(Право, СсылкаНаОбъект, Знач Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ЕстьПраво(Право, СсылкаНаОбъект, Пользователь); +``` +
+ +## ЧтениеРазрешено +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что на уровне записей (и на уровне прав) указанному пользователю +// разрешено чтение объекта или набора записей из базы данных. +// +// Важно: если подсистема работает в стандартном варианте, тогда +// а) если указан пользователь, но не текущий пользователь, то будет вызвано исключение; +// б) выполняется проверка только объекта в базе данных (объект в памяти не проверяется). +// Для проверки варианта работы предусмотрена функция ПроизводительныйВариант. +// +// Параметры: +// ОписаниеДанных - СправочникСсылка +// - ДокументСсылка +// - ПланВидовХарактеристикСсылка +// - ПланСчетовСсылка +// - ПланВидовРасчетаСсылка +// - БизнесПроцессСсылка +// - ЗадачаСсылка +// - ПланОбменаСсылка - ссылка на объект в базе данных, который требуется проверить. +// - РегистрСведенийКлючЗаписи +// - РегистрНакопленияКлючЗаписи +// - РегистрБухгалтерииКлючЗаписи +// - РегистрРасчетаКлючЗаписи - ключ записи в базе данных, которую требуется проверить. +// - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - объект в памяти и базе данных, которые требуется проверить. +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор записей в памяти и базе данных, которые требуется проверить. +// В структуре ДополнительныеСвойства можно вставить необязательное свойство +// Замещение (Булево, РежимЗамещения), если не указано, тогда считается равным Истина. +// Если Замещение равно Ложь или РежимЗамещения.Добавление, тогда записи в базе данных +// не проверяются. Если Замещение равно Истина или РежимЗамещения.Замещение, +// тогда записи для проверки будут получены из базы данных по настройке свойства Отбор, +// в противном случае по ключам строк записей в наборе записей. +// +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// - Неопределено - текущий пользователь. +// Когда параметр указан, привилегированный режим не учитывается. +// Для проверки прав не текущего пользователя требуются административные права. +// +// Возвращаемое значение: +// Булево +// +Функция ЧтениеРазрешено(ОписаниеДанных, Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ЧтениеРазрешено(ОписаниеДанных, Пользователь); +``` +
+ +## ИзменениеРазрешено +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что на уровне записей (и на уровне прав) указанному пользователю +// разрешено изменение объекта в базе данных на объект в памяти. +// Для нового объекта проверяется только объект в памяти. +// Если указана ссылка или ключ записи, проверятся только объект в базе данных. +// +// Важно: если подсистема работает в стандартном варианте, тогда +// а) если указан пользователь, но не текущий пользователь, то будет вызвано исключение; +// б) выполняется проверка только объекта в базе данных (объект в памяти не проверяется), +// причем на уровне записей проверяется только право Чтение, +// а право Изменение проверяется на таблицу в целом. +// Для проверки варианта работы предусмотрена функция ПроизводительныйВариант. +// +// Параметры: +// ОписаниеДанных - СправочникСсылка +// - ДокументСсылка +// - ПланВидовХарактеристикСсылка +// - ПланСчетовСсылка +// - ПланВидовРасчетаСсылка +// - БизнесПроцессСсылка +// - ЗадачаСсылка +// - ПланОбменаСсылка - ссылка на объект в базе данных, который требуется проверить. +// - РегистрСведенийКлючЗаписи +// - РегистрНакопленияКлючЗаписи +// - РегистрБухгалтерииКлючЗаписи +// - РегистрРасчетаКлючЗаписи - ключ записи в базе данных, которую требуется проверить. +// - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - объект в памяти и базе данных, который требуется проверить. +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор записей в памяти и базе данных, которые требуется проверить. +// В структуре ДополнительныеСвойства можно вставить необязательное свойство +// Замещение (Булево, РежимЗамещения), если не указано, тогда считается равным Истина. +// Если Замещение равно Ложь или РежимЗамещения.Добавление, тогда записи в базе данных +// не проверяются. Если Замещение равно Истина или РежимЗамещения.Замещение, +// тогда записи для проверки будут получены из базы данных по настройке свойства Отбор, +// в противном случае по ключам строк записей в наборе записей. +// +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// - Неопределено - текущий пользователь. +// Когда параметр указан, привилегированный режим не учитывается. +// Для проверки прав не текущего пользователя требуются административные права. +// +// Возвращаемое значение: +// Булево +// +Функция ИзменениеРазрешено(ОписаниеДанных, Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ИзменениеРазрешено(ОписаниеДанных, Пользователь); +``` +
+ +## ПроверитьЧтениеРазрешено +
+ +Описание, пример вызова + +```bsl + +// Делает тоже, что функция ЧтениеРазрешено, но если не разрешено, вызывается исключение. +// +// Параметры: +// ОписаниеДанных - см. ЧтениеРазрешено.ОписаниеДанных +// +Процедура ПроверитьЧтениеРазрешено(ОписаниеДанных) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ПроверитьЧтениеРазрешено(ОписаниеДанных) +``` +
+ +## ПроверитьИзменениеРазрешено +
+ +Описание, пример вызова + +```bsl + +// Делает тоже, что функция ИзменениеРазрешено, но если не разрешено, вызывается исключение. +// +// Параметры: +// ОписаниеДанных - см. ИзменениеРазрешено.ОписаниеДанных +// +Процедура ПроверитьИзменениеРазрешено(ОписаниеДанных) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ПроверитьИзменениеРазрешено(ОписаниеДанных) +``` +
+ +## ПраваДоступаКДанным +
+ +Описание, пример вызова + +```bsl + +// Возвращает права Чтение и Изменение указанных или всех пользователей и +// внешних пользователей на указанный существующий элемент данных или их массив. +// Для использования требуются административные права или привилегированный режим. +// Служебные пользователи пропускаются. +// +// Если объект не существует или на него не рассчитаны права, тогда для него вернется пустой список прав. +// Аналогично, если записей регистра не существует, тогда для них вернется пустой список прав. +// Если имя поля ключа записи регистра совпадает с именем одной из колонок возвращаемой таблицы +// "ПользовательСПравом" или "ПравоИзменение", тогда оно будет дополнено нижним подчеркиванием слева. +// +// В отличие от функций ЧтениеРазрешено, ИзменениеРазрешено и +// процедур ПроверитьЧтениеРазрешено, ПроверитьИзменениеРазрешено, +// права для текущего пользователя возвращаются по состоянию в базе данных, +// а не по состоянию сеанса (если права были изменены после запуска сеанса). +// +// Важно: требуется производительный вариант ограничения доступа. +// Для проверки варианта работы предусмотрена функция ПроизводительныйВариант. +// +// Параметры: +// ОписаниеДанных - СправочникСсылка +// - ДокументСсылка +// - ПланВидовХарактеристикСсылка +// - ПланСчетовСсылка +// - ПланВидовРасчетаСсылка +// - БизнесПроцессСсылка +// - ЗадачаСсылка +// - ПланОбменаСсылка - ссылка на объект. +// - Массив из СправочникСсылка +// - Массив из ДокументСсылка +// - Массив из ПланВидовХарактеристикСсылка +// - Массив из ПланСчетовСсылка +// - Массив из ПланВидовРасчетаСсылка +// - Массив из БизнесПроцессСсылка +// - Массив из ЗадачаСсылка +// - Массив из ПланОбменаСсылка - массив ссылок на объекты одного типа. +// - РегистрСведенийКлючЗаписи +// - РегистрНакопленияКлючЗаписи +// - РегистрБухгалтерииКлючЗаписи +// - РегистрРасчетаКлючЗаписи - ключ записи, +// по которому определяется запись в базе данных для получения прав. +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор записей с настроенным свойством Отбор, +// по которому определяются записи в базе данных для получения прав. +// Если свойство Отбор не установлено, а набор записей непустой, +// тогда будут возвращены права для записей, содержащихся в наборе записей +// (у записей в наборе записей используются только значения измерений). +// +// ДляВнешнихПользователей - Булево - если Истина, тогда вернуть права для внешних пользователей. +// - Неопределено - вернуть для пользователей и внешних пользователей. +// +// СоставПользователей - Неопределено - вернуть всех пользователей, у которых есть права. +// - Массив из СправочникСсылка.Пользователи, СправочникСсылка.ВнешниеПользователи - список +// пользователей для которых нужно вернуть права, если есть. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ПользовательСПравом - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи - пользователь, если есть хотя бы право Чтение. +// * ПравоИзменение - Булево - Истина, если есть право Изменение и право Чтение, +// Ложь, если есть только право Чтение. +// <Поле Ссылка или поля ключа записи регистра>. +// +Функция ПраваДоступаКДанным(ОписаниеДанных, ДляВнешнихПользователей = Ложь, СоставПользователей = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ПраваДоступаКДанным(ОписаниеДанных, ДляВнешнихПользователей, СоставПользователей); +``` +
+ +## ВключитьПрофильПользователю +
+ +Описание, пример вызова + +```bsl + +// Назначение пользователю профиля групп доступа путем включения +// в персональную группу доступа (только для упрощенной настройки прав). +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи - требуемый пользователь. +// Профиль - СправочникСсылка.ПрофилиГруппДоступа - профиль, для которого нужно найти или создать персональную +// группу доступа и включить в нее пользователя. +// - УникальныйИдентификатор - уникальный идентификатор поставляемого профиля, +// с помощью которого нужно найти профиль групп доступа. +// - Строка - имя поставляемого профиля, +// с помощью которого нужно найти профиль групп доступа. +// +Процедура ВключитьПрофильПользователю(Пользователь, Профиль) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ВключитьПрофильПользователю(Пользователь, Профиль) +``` +
+ +## ВыключитьПрофильПользователю +
+ +Описание, пример вызова + +```bsl + +// Отмена назначения пользователю профиля групп доступа путем исключения +// из персональной группы доступа (только для упрощенной настройки прав). +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи - требуемый пользователь. +// Профиль - СправочникСсылка.ПрофилиГруппДоступа - профиль, для которого нужно найти или создать персональную +// группу доступа и включить в нее пользователя. +// - УникальныйИдентификатор - уникальный идентификатор поставляемого профиля, +// с помощью которого нужно найти профиль групп доступа. +// - Строка - имя поставляемого профиля, +// с помощью которого нужно найти профиль групп доступа. +// - Неопределено - выключить пользователю все профили. +// +Процедура ВыключитьПрофильПользователю(Пользователь, Профиль = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ВыключитьПрофильПользователю(Пользователь, Профиль); +``` +
+ +## ОграничиватьДоступНаУровнеЗаписей +
+ +Описание, пример вызова + +```bsl + +// Проверяет, используется ли ограничение доступа на уровне записей. +// +// Возвращаемое значение: +// Булево - если Истина, тогда доступ ограничивается на уровне записей. +// +Функция ОграничиватьДоступНаУровнеЗаписей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ОграничиватьДоступНаУровнеЗаписей() +``` +
+ +## ПроизводительныйВариант +
+ +Описание, пример вызова + +```bsl + +// Возвращает вариант работы ограничений доступа на уровне записей. +// +// Требуется при расширенном использовании функций +// ЧтениеРазрешено и ИзменениеРазрешено в производительном варианте. +// +// Возвращаемое значение: +// Булево - если Ложь, стандартный вариант, иначе производительный. +// +Функция ПроизводительныйВариант() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ПроизводительныйВариант() +``` +
+ +## ПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик события формы ПриЧтенииНаСервере, который встраивается в формы элементов справочников, +// документов, записей регистров и др., чтобы заблокировать форму, если изменение запрещено. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента объекта или записи регистра. +// +// ТекущийОбъект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - проверяемый объект. +// - РегистрСведенийМенеджерЗаписи - менеджер проверяемой записи. +// - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей - набор проверяемых записей. +// +Процедура ПриЧтенииНаСервере(Форма, ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ПриЧтенииНаСервере(Форма, ТекущийОбъект) +``` +
+ +## ПослеЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик события формы ПослеЗаписиНаСервере, который встраивается в формы +// элементов справочников, документов, записей регистров и др., чтобы ускорить +// запуск обновления доступа зависимых объектов, когда обновление запланировано. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента объекта или записи регистра. +// +// ТекущийОбъект - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - проверяемый объект. +// - РегистрСведенийМенеджерЗаписи - менеджер проверяемой записи. +// +// ПараметрыЗаписи - Структура - стандартный параметр, передаваемый в обработчик события. +// +Процедура ПослеЗаписиНаСервере(Форма, ТекущийОбъект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ПослеЗаписиНаСервере(Форма, ТекущийОбъект, ПараметрыЗаписи) +``` +
+ +## ПриСозданииФормыЗначенияДоступа +
+ +Описание, пример вызова + +```bsl + +// АПК:142-выкл - №640.5 Необязательных параметров более 3 для обратной совместимости. + +// Настраивает форму значения доступа, которое использует группы значений доступа +// для выбора разрешенных значений в группах доступа пользователей. +// +// Поддерживается только для случая, когда у значения доступа выбирается одна группа значений доступа, +// а не несколько. +// +// Для элемента формы ГруппаДоступа, связанного с реквизитом ГруппаДоступа, устанавливает +// список групп значений доступа в параметр выбора, которые дают доступ на изменение значения доступа. +// +// При создании нового значения доступа, если количество групп значений доступа, которые дают доступ +// на изменение значения доступа, равно нулю, будет вызвано исключение. +// +// Если в базе данных уже записана группа значений доступа, которая не дает доступ на изменение значения доступа, +// или количество групп значений доступа, которые дают доступ на изменение значения доступа, равно нулю, +// тогда свойство формы ТолькоПросмотр устанавливается в Истина. +// +// Если ограничение на уровне записей не используется или ограничение по виду доступа не используется, +// тогда элемент формы скрывается. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма значения доступа, +// использующего группы для выбора разрешенных значений. +// +// ДополнительныеПараметры - см. ПараметрыПриСозданииФормыЗначенияДоступа +// +// УдалитьЭлементы - Неопределено - устарел, следует использовать ДополнительныеПараметры. +// УдалитьТипЗначения - Неопределено - устарел, следует использовать ДополнительныеПараметры. +// УдалитьСозданиеНового - Неопределено - устарел, следует использовать ДополнительныеПараметры. +// +Процедура ПриСозданииФормыЗначенияДоступа(Форма, ДополнительныеПараметры = Неопределено, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ПриСозданииФормыЗначенияДоступа(Форма, ДополнительныеПараметры, ); +``` +
+ +## ПараметрыПриСозданииФормыЗначенияДоступа +
+ +Описание, пример вызова + +```bsl + +// АПК:142-вкл. + +// Описание дополнительных параметров, используемых в процедуре ПриСозданииФормыЗначенияДоступа. +// +// Возвращаемое значение: +// Структура: +// * Реквизит - Неопределено - означает имя реквизита формы "Объект.ГруппаДоступа". +// - Строка - имя реквизита формы, содержащего группу доступа. +// +// * Элементы - Неопределено - означает имя элемента формы "ГруппаДоступа". +// - Строка - имя элемента формы. +// - Массив - имена элементов формы. +// +// * ТипЗначения - Неопределено - означает: получить тип из реквизита формы "Объект.Ссылка". +// - Тип - тип ссылки значения доступа. +// +// * СозданиеНового - Неопределено - означает: получить значение "НЕ ЗначениеЗаполнено(Форма.Объект.Ссылка)" +// для определения того, создается новое значение доступа или нет. +// - Булево - используется указанное значение. +// +Функция ПараметрыПриСозданииФормыЗначенияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ПараметрыПриСозданииФормыЗначенияДоступа() +``` +
+ +## ГруппыЗначенийДоступаРазрешающиеИзменениеЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив групп значений доступа, разрешающих изменять значения доступа. +// +// Поддерживается только для случая, когда выбирается одна группа значений доступа, а не несколько. +// +// Параметры: +// ТипЗначенийДоступа - Тип - тип ссылки значений доступа. +// ВозвращатьВсе - Булево - если Истина, то в случае, когда нет ограничений +// (доступны все), будет возвращен массив всех вместо Неопределено. +// +// Возвращаемое значение: +// Неопределено - все группы значений доступа разрешают изменять значения доступа. +// Массив - массив найденных групп значений доступа. +// +Функция ГруппыЗначенийДоступаРазрешающиеИзменениеЗначенийДоступа(ТипЗначенийДоступа, ВозвращатьВсе = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ГруппыЗначенийДоступаРазрешающиеИзменениеЗначенийДоступа(ТипЗначенийДоступа, ВозвращатьВсе); +``` +
+ +## НастроитьОтборыДинамическогоСписка +
+ +Описание, пример вызова + +```bsl + +// Устанавливает в условие ГДЕ динамического списка постоянные отборы +// на основе разрешенных значений доступа указанных типов в рамках всех групп доступа. +// Это позволяет в отдельных случаях ускорить открытие динамического списка. +// Если количество разрешенных значений в общей сложности получилось более 100, отбор не устанавливается. +// +// Для работы процедуры у динамического списка должна быть установлена основная таблица, +// установлен произвольный запрос, а также должно поддерживаться преобразование вида: +// СхемаЗапроса = Новый СхемаЗапроса; +// СхемаЗапроса.УстановитьТекстЗапроса(Список.ТекстЗапроса); +// Список.ТекстЗапроса = СхемаЗапроса.ПолучитьТекстЗапроса(); +// Если это условие выполнить не удается, тогда следует добавлять отборы самостоятельно +// с использованием функции РазрешенныеЗначенияДляДинамическогоСписка, как в этой процедуре. +// +// Параметры: +// Список - ДинамическийСписок - динамический список, в который нужно установить отборы. +// ОписаниеОтборов - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя поля основной таблицы динамического списка, для которого +// нужно установить условие <Поле> В (&РазрешенныеЗначения). +// * Значение - Тип - тип значений доступа, которые нужно включить в состав +// параметра "&РазрешенныеЗначения". +// - Массив - массив указанных выше типов. +// +Процедура НастроитьОтборыДинамическогоСписка(Список, ОписаниеОтборов) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.НастроитьОтборыДинамическогоСписка(Список, ОписаниеОтборов) +``` +
+ +## РазрешенныеЗначенияДляДинамическогоСписка +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив разрешенных значений указанных типов в рамках всех групп доступа. +// Используется в процедуре НастроитьОтборыДинамическогоСписка для ускорения открытия динамических списков. +// +// Параметры: +// Таблица - Строка - полное имя объекта метаданных, например "Документ.РасходнаяНакладная". +// ТипЗначений - Тип - тип значений доступа, разрешенные значения которых нужно вернуть. +// - Массив - массив указанных выше типов. +// Пользователь - Неопределено - вернуть разрешенные значения для авторизованного пользователя. +// - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи - вернуть +// разрешенные значения для указанного пользователя. +// ВернутьВсе - Булево - если установить в Истина, тогда будут возвращены все значения - даже тогда, +// когда их более 100. +// +// Возвращаемое значение: +// Неопределено - либо все значения разрешены для типов, указанных в параметре ТипЗначений, +// либо (когда ВернутьВсе = Ложь) количество разрешенных значений превышает 100. +// Массив - ссылки разрешенных значений указанных типов. +// +Функция РазрешенныеЗначенияДляДинамическогоСписка(Таблица, ТипЗначений, Пользователь = Неопределено, ВернутьВсе = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.РазрешенныеЗначенияДляДинамическогоСписка(Таблица, ТипЗначений, Пользователь, ВернутьВсе); +``` +
+ +## ПраваПоИдентификаторам +
+ +Описание, пример вызова + +```bsl + +// Возвращает права доступа к объектам метаданных ссылочного типа по указанным идентификаторам. +// +// Параметры: +// Идентификаторы - Массив - значения СправочникСсылка.ИдентификаторыОбъектовМетаданных, +// объектов ссылочного типа, для которых нужно вернуть права. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.ИдентификаторыОбъектовМетаданных - идентификатор типа; +// * Значение - Структура: +// ** Ключ - Строка - имя права доступа ("Чтение", "Изменение", "Добавление"); +// ** Значение - Булево - если Истина, тогда право есть, иначе нет. +// +Функция ПраваПоИдентификаторам(Идентификаторы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ПраваПоИдентификаторам(Идентификаторы); +``` +
+ +## ВозможноЗаполнитьНаборыЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Проверяет, предусмотрена ли для объекта метаданных процедура заполнения наборов значений доступа. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - ссылка на любой объект. +// +// Возвращаемое значение: +// Булево - если Истина, наборы значений доступа можно заполнить. +// +Функция ВозможноЗаполнитьНаборыЗначенийДоступа(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ВозможноЗаполнитьНаборыЗначенийДоступа(Ссылка) +``` +
+ +## ТаблицаНаборыЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую таблицу, которая заполняется для передачи в функцию ЕстьРоль и +// в процедуры ЗаполнитьНаборыЗначенийДоступа(Таблица), определенные прикладным разработчиком. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * НомерНабора - Число - необязательно, если набор один. +// * ВидДоступа - Строка - необязательно, кроме специальных: ПравоЧтения, ПравоИзменения. +// * ЗначениеДоступа - ОпределяемыйТип.ЗначениеДоступа - тип значения доступа, указанный для вида доступа +// в процедуре ПриЗаполненииВидовДоступа общего модуля УправлениеДоступомПереопределяемый. +// * Чтение - Булево - необязательно, если набор для всех прав, устанавливается для одной строки набора. +// * Изменение - Булево - необязательно, если набор для всех прав, устанавливается для одной строки набора. +// +Функция ТаблицаНаборыЗначенийДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ТаблицаНаборыЗначенийДоступа() +``` +
+ +## ЗаполнитьНаборыЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Заполняет наборы значений доступа для переданного значения Объект, вызывая +// процедуру ЗаполнитьНаборыЗначенийДоступа, определенную в модуле этого объекта, +// и возвращает их в параметре Таблица. +// +// Объекты должны быть включены в подписку на событие ЗаписатьНаборыЗначенийДоступа +// или ЗаписатьЗависимыеНаборыЗначенийДоступа. +// +// В модулях объектов должна быть размещена процедура обработчика, в которую передаются параметры: +// Таблица - ТаблицаЗначений - возвращаемая функцией ТаблицаНаборыЗначенийДоступа. +// +// Далее пример процедуры обработчика для копирования в модули объектов. +// +//// См. УправлениеДоступом.ЗаполнитьНаборыЗначенийДоступа. +//Процедура ЗаполнитьНаборыЗначенийДоступа(Таблица) Экспорт +// +// // Логика ограничения: +// // Чтения: Организация. +// // Изменения: Организация И Ответственный. +// +// // Чтение: набор № 1. +// Строка = Таблица.Добавить(); +// Строка.НомерНабора = 1; +// Строка.Чтение = Истина; +// Строка.ЗначениеДоступа = Организация; +// +// // Изменение: набор № 2. +// Строка = Таблица.Добавить(); +// Строка.НомерНабора = 2; +// Строка.Изменение = Истина; +// Строка.ЗначениеДоступа = Организация; +// +// Строка = Таблица.Добавить(); +// Строка.НомерНабора = 2; +// Строка.ЗначениеДоступа = Ответственный; +// +//КонецПроцедуры +// +// Параметры: +// Объект - ЛюбаяСсылка +// - ОпределяемыйТип.ВладелецНаборовЗначенийДоступаОбъект - ссылка или объект, +// (элемент справочника, документ, бизнес-процесс, задача, план видов характеристик и т.п.), +// для которого требуется заполнить наборы значений доступа. +// +// Таблица - см. ТаблицаНаборыЗначенийДоступа +// - Неопределено - возвращает в этом параметре подготовленные наборы значений доступа. +// Если передано Неопределено, то будет создана и заполнена новая таблица наборов значений доступа. +// +// СсылкаНаПодчиненныйОбъект - ЛюбаяСсылка - используется, когда нужно заполнить наборы значений +// доступа объекта-владельца для указанного подчиненного объекта. +// Подробнее смотри УправлениеДоступомПереопределяемый.ПриЗаполненииЗависимостейПравДоступа. +// +Процедура ЗаполнитьНаборыЗначенийДоступа(Знач Объект, Таблица, Знач СсылкаНаПодчиненныйОбъект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ЗаполнитьНаборыЗначенийДоступа(Объект, Таблица, СсылкаНаПодчиненныйОбъект); +``` +
+ +## ДобавитьНаборыЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Позволяет добавить к одной таблице наборов значений доступа другую таблицу +// наборов значений доступа либо логическим сложением, либо логическим умножением. +// +// Результат помещается в параметр Приемник. +// +// Параметры: +// Приемник - ТаблицаЗначений - с колонками как у таблицы, возвращаемой функцией ТаблицаНаборыЗначенийДоступа. +// Источник - ТаблицаЗначений - с колонками как у таблицы, возвращаемой функцией ТаблицаНаборыЗначенийДоступа. +// +// Умножение - Булево - определяет способ логического объединения наборов приемника и источника. +// Упростить - Булево - определяет, требуется ли упрощение наборов после добавления. +// +Процедура ДобавитьНаборыЗначенийДоступа(Приемник, Знач Источник, Знач Умножение = Ложь, Знач Упростить = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ДобавитьНаборыЗначенийДоступа(Приемник, Источник, Умножение, Упростить); +``` +
+ +## ОбновитьНаборыЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Выполняет обновление наборов значений доступа объекта, если они изменились. +// Наборы обновляются в табличной части (если используется) и +// в регистре сведений НаборыЗначенийДоступа. +// +// Параметры: +// СсылкаИлиОбъект - ЛюбаяСсылка +// - ОпределяемыйТип.ВладелецНаборовЗначенийДоступаОбъект - ссылка или объект, +// для которого заполняются наборы значений доступа. +// +// ОбновлениеИБ - Булево - если Истина, то необходимо выполнять запись данных, +// не выполняя лишних, избыточных действий с данными. +// См. ОбновлениеИнформационнойБазы.ЗаписатьДанные. +// +Процедура ОбновитьНаборыЗначенийДоступа(СсылкаИлиОбъект, ОбновлениеИБ = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ОбновитьНаборыЗначенийДоступа(СсылкаИлиОбъект, ОбновлениеИБ); +``` +
+ +## НовоеОписаниеПрофиляГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру для удобства описания поставляемых профилей. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - может использоваться в программном интерфейсе, +// например, в процедуре ВключитьПрофильПользователю. +// * Родитель - Строка - имя папки профилей, в которую входит профиль. +// * Идентификатор - Строка - строка уникального идентификатора поставляемого +// профиля, которая используется для поиска в базе данных. +// Чтобы получить идентификатор, нужно создать профиль в режиме 1С:Предприятие и +// получить уникальный идентификатор ссылки. Не следует указывать идентификаторы, +// полученные произвольным способом, т.к. это может нарушить уникальность ссылок. +// * Наименование - Строка - наименование поставляемого профиля. +// * Описание - Строка - описание поставляемого профиля. +// * Роли - Массив из Строка - имена ролей поставляемого профиля. +// * Назначение - Массив из Тип - типы ссылок пользователя и объектов авторизации внешних +// пользователей. Если пустой, значит, назначение для пользователей. +// Должны быть в пределах состава определяемого типа Пользователь. +// * ВидыДоступа - СписокЗначений: +// ** Значение - Строка - имя вида доступа, указанного в переопределяемом +// модуле УправлениеДоступомПереопределяемый в процедуре ПриЗаполненииВидовДоступа. +// ** Представление - Строка - допустимы строки "ВначалеВсеЗапрещены" (или пустая строка), +// "ВначалеВсеРазрешены", "Предустановленный". +// +// * ЗначенияДоступа - СписокЗначений: +// ** Значение - Строка - имя вида доступа, указанного в параметре ВидыДоступа. +// ** Представление - Строка - имя предопределенного элемента, например +// "Справочник.ГруппыПользователей.ВсеПользователи". +// +// * ЭтоПапка - Булево - всегда Ложь. Нельзя изменять. +// +// Пример: +// +// // Профиль "Пользователь". +// ОписаниеПрофиля = УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа(); +// ОписаниеПрофиля.Имя = "Пользователь"; +// ОписаниеПрофиля.Идентификатор = "09e56dbf-90a0-11de-862c-001d600d9ad2"; +// ОписаниеПрофиля.Наименование = НСтр("ru = 'Пользователь'", ОбщегоНазначения.КодОсновногоЯзыка()); +// // Переопределение назначения. +// ОбщегоНазначенияКлиентСервер.ДополнитьМассив(ОписаниеПрофиля.Назначение, +// Метаданные.ОпределяемыеТипы.ВнешнийПользователь.Тип.Типы()); +// ОписаниеПрофиля.Описание = +// НСтр("ru = 'Общие разрешенные действия для большинства пользователей. +// |Как правило, это права на просмотр данных информационной системы.'"); +// // Использование 1С:Предприятия. +// ОписаниеПрофиля.Роли.Добавить("ЗапускТонкогоКлиента"); +// ОписаниеПрофиля.Роли.Добавить("ВыводНаПринтерФайлБуферОбмена"); +// ОписаниеПрофиля.Роли.Добавить("СохранениеДанныхПользователя"); +// // ... +// // Использование программы. +// ОписаниеПрофиля.Роли.Добавить("БазовыеПраваБСП"); +// ОписаниеПрофиля.Роли.Добавить("ПросмотрОписанияИзмененийПрограммы"); +// ОписаниеПрофиля.Роли.Добавить("ИзменениеТекущегоПользователя"); +// // ... +// // Использование НСИ. +// ОписаниеПрофиля.Роли.Добавить("ЧтениеБазовойНСИ"); +// ОписаниеПрофиля.Роли.Добавить("ЧтениеОбщейБазовойНСИ"); +// // ... +// // Типовые возможности. +// ОписаниеПрофиля.Роли.Добавить("ДобавлениеИзменениеЛичныхВариантовОтчетов"); +// ОписаниеПрофиля.Роли.Добавить("ПросмотрСвязанныеДокументы"); +// // ... +// // Основные возможности профиля. +// ОписаниеПрофиля.Роли.Добавить("ДобавлениеИзменениеЗаметок"); +// ОписаниеПрофиля.Роли.Добавить("ДобавлениеИзменениеНапоминаний"); +// ОписаниеПрофиля.Роли.Добавить("ДобавлениеИзменениеЗаданий"); +// ОписаниеПрофиля.Роли.Добавить("ИзменениеВыполнениеЗадач"); +// // ... +// // Виды ограничения доступа профиля. +// ОписаниеПрофиля.ВидыДоступа.Добавить("Организации"); +// ОписаниеПрофиля.ВидыДоступа.Добавить("Пользователи", "Предустановленный"); +// ОписаниеПрофиля.ВидыДоступа.Добавить("ХозяйственныеОперации", "Предустановленный"); +// ОписаниеПрофиля.ЗначенияДоступа.Добавить("ХозяйственныеОперации", +// "Перечисление.ХозяйственныеОперации.ВыдачаДенежныхСредствПодотчетнику"); +// // ... +// ОписанияПрофилей.Добавить(ОписаниеПрофиля); +// +Функция НовоеОписаниеПрофиляГруппДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа() +``` +
+ +## НовоеОписаниеПапкиПрофилейГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру для удобства описания поставляемых папок профилей (групп элементов). +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - используется в поле Родитель для профиля и папки профилей. +// * Родитель - Строка - имя другой папки профилей, в которую входит эта папка. +// * Идентификатор - Строка - строка уникального идентификатора поставляемой папки +// профиля, которая используется для поиска в базе данных. +// Чтобы получить идентификатор, нужно создать папку профилей в режиме 1С:Предприятие и +// получить уникальный идентификатор ссылки. Не следует указывать идентификаторы, +// полученные произвольным способом, т.к. это может нарушить уникальность ссылок. +// * Наименование - Строка - наименование поставляемой папки профилей. +// * ЭтоПапка - Булево - всегда Истина. Нельзя изменять. +// +// Пример: +// // Папка профилей "Дополнительные профили". +// ОписаниеПапки = УправлениеДоступом.НовоеОписаниеПапкиПрофилейГруппДоступа(); +// ОписаниеПапки.Имя = "ДополнительныеПрофили"; +// ОписаниеПапки.Идентификатор = ""; +// ОписаниеПапки.Наименование = НСтр("ru = 'Дополнительные профили'", ОбщегоНазначения.КодОсновногоЯзыка()); +// // ... +// ОписанияПрофилей.Добавить(ОписаниеПрофиля); +// +Функция НовоеОписаниеПапкиПрофилейГруппДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.НовоеОписаниеПапкиПрофилейГруппДоступа() +``` +
+ +## ДобавитьДополнительныеТипыВидаДоступа +
+ +Описание, пример вызова + +```bsl + +// Добавляет дополнительные типы в процедуре ПриЗаполненииВидовДоступа +// общего модуля УправлениеДоступомПереопределяемый. +// +// Параметры: +// ВидДоступа - СтрокаТаблицыЗначений - добавленная в параметр ВидыДоступа. +// ТипЗначений - Тип - дополнительный тип значений доступа. +// ТипГруппЗначений - Тип - дополнительный тип групп значений доступа, может совпадать +// с типом групп значений, указанным ранее для этого же вида доступа. +// НесколькоГруппЗначений - Булево - Истина, если у дополнительного типа значений доступа +// можно указать несколько групп значений (есть табличная часть ГруппыДоступа). +// +Процедура ДобавитьДополнительныеТипыВидаДоступа(ВидДоступа, ТипЗначений, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ДобавитьДополнительныеТипыВидаДоступа(ВидДоступа, ТипЗначений, ); +``` +
+ +## ЗаменитьРолиВПрофилях +
+ +Описание, пример вызова + +```bsl + +// Заменяет роли в профилях, кроме поставляемых профилей, которые обновляются автоматически. +// Предназначена для вызова из оперативного обработчика обновления. +// +// Параметры: +// ЗаменяемыеРоли - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя заменяемой роли, например "ЧтениеБазовойНСИ". Если роль была удалена, +// то к имени нужно добавить приставку "? ", например "? ЧтениеБазовойНСИ". +// +// * Значение - Массив - имена ролей для замены указанной (пустой массив, чтобы удалить указанную роль, +// можно указывать заменяемую роль, например, при разделении на несколько). +// +Процедура ЗаменитьРолиВПрофилях(ЗаменяемыеРоли) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ЗаменитьРолиВПрофилях(ЗаменяемыеРоли) +``` +
+ +## ПоставляемыйПрофильПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на поставляемый профиль или папку профилей по идентификатору. +// +// Параметры: +// Идентификатор - Строка - имя или уникальный идентификатор поставляемого профиля или папки профилей, +// как указано в процедуре ПриЗаполненииПоставляемыхПрофилейГруппДоступа +// общего модуля УправлениеДоступомПереопределяемый. +// +// Возвращаемое значение: +// СправочникСсылка.ПрофилиГруппДоступа - если поставляемый профиль или папка профилей найдена в справочнике. +// Неопределено - если поставляемый профиль или папка профилей не существует в справочнике. +// +Функция ПоставляемыйПрофильПоИдентификатору(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ПоставляемыйПрофильПоИдентификатору(Идентификатор) +``` +
+ +## ПрофильАдминистратор +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на стандартный поставляемый профиль Администратор. +// +// Возвращаемое значение: +// СправочникСсылка.ПрофилиГруппДоступа +// +Функция ПрофильАдминистратор() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ПрофильАдминистратор() +``` +
+ +## ГруппаДоступаАдминистраторы +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на стандартную поставляемую группу доступа Администраторы. +// +// Возвращаемое значение: +// СправочникСсылка.ГруппыДоступа +// +Функция ГруппаДоступаАдминистраторы() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ГруппаДоступаАдминистраторы() +``` +
+ +## ТаблицаЗаменыПравВНастройкахПравОбъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую таблицу для заполнения и +// передачи в процедуру ЗаменитьПраваВНастройкахПравОбъектов. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ТипВладельцев - ОпределяемыйТип.ВладелецНастроекПрав - пустая ссылка типа владельца прав, +// например пустая ссылка справочника ПапкиФайлов. +// * СтароеИмя - Строка - старое имя права. +// * НовоеИмя - Строка - новое имя права. +// +Функция ТаблицаЗаменыПравВНастройкахПравОбъектов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступом.ТаблицаЗаменыПравВНастройкахПравОбъектов() +``` +
+ +## ЗаменитьПраваВНастройкахПравОбъектов +
+ +Описание, пример вызова + +```bsl + +// Заменяет права, используемые в настройках прав объектов. +// После выполнения замены будет выполнено обновление вспомогательных данных +// регистра сведений НастройкиПравОбъектов, поэтому следует вызвать +// процедуру однократно, чтобы не снижать производительность. +// +// Параметры: +// ТаблицаПереименований - ТаблицаЗначений: +// * ТипВладельцев - ОпределяемыйТип.ВладелецНастроекПрав - пустая ссылка типа владельца прав, +// например пустая ссылка справочника ПапкиФайлов. +// * СтароеИмя - Строка - старое имя права, относящееся к указанному типу владельцев. +// * НовоеИмя - Строка - новое имя права, относящееся к указанному типу владельцев. +// Если указана пустая строка, настройка старого права будет удалена. +// Если старому имени поставлены в соответствие два новых имени, +// тогда одна старая настройка будет размножена в две новых. +// +Процедура ЗаменитьПраваВНастройкахПравОбъектов(ТаблицаПереименований) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ЗаменитьПраваВНастройкахПравОбъектов(ТаблицаПереименований) +``` +
+ +## ОбновитьРолиПользователей +
+ +Описание, пример вызова + +```bsl + +// Обновляет список ролей пользователей информационной базы по их текущим принадлежностям +// к группам доступа. Пользователи ИБ с ролью "ПолныеПрава" пропускаются. +// +// Параметры: +// МассивПользователей - Массив +// - Неопределено +// - Тип - массив из элементов +// СправочникСсылка.Пользователи или СправочникСсылка.ВнешниеПользователи. +// Если Неопределено, то обновить роли всех пользователей. +// Если Тип = Справочник.ВнешниеПользователи, то будут обновлены роли всех внешних пользователей, +// иначе будут обновлены роли всех пользователей. +// +// ПарольПользователяСервиса - Строка - пароль для авторизации в менеджере сервиса. +// +Процедура ОбновитьРолиПользователей(Знач МассивПользователей = Неопределено, Знач ПарольПользователяСервиса = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ОбновитьРолиПользователей(МассивПользователей, ПарольПользователяСервиса); +``` +
+ +## ОбновитьРазрешенныеЗначенияПриИзмененииИспользованияВидовДоступа +
+ +Описание, пример вызова + +```bsl + +// Обновляет содержание регистров ЗначенияГруппДоступа и ЗначенияГруппДоступаПоУмолчанию, +// которые заполняются на основании настроек в группах доступа и использования видов доступа. +// +Процедура ОбновитьРазрешенныеЗначенияПриИзмененииИспользованияВидовДоступа() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ОбновитьРазрешенныеЗначенияПриИзмененииИспользованияВидовДоступа() +``` +
+ +## ЗаполнениеДанныхДляОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Выполняет последовательное заполнение и частичное обновление данных, необходимых для работы +// подсистемы УправлениеДоступом в режиме ограничения доступа на уровне записей. +// +// При включенном режиме ограничения доступа на уровне записей заполняет наборы +// значений доступа. Заполнение выполняется частями при каждом запуске, пока все +// наборы значений доступа не будут заполнены. +// +// При отключении режима ограничения доступа на уровне записей наборы значений доступа +// (заполненные ранее) удаляются при перезаписи объектов, а не все сразу. +// +// Независимо от режима ограничения доступа на уровне записей обновляет вторичные данные - +// группы значений доступа и дополнительные поля в существующих наборах значений доступа. +// После завершения всех обновлений и заполнений отключает использование регламентного задания. +// +// Сведения о состоянии работы записываются в журнал регистрации. +// Возможно вызывать программно, например при обновлении информационной базы. +// +// Параметры: +// КоличествоДанных - Число - возвращаемое значение. Количество объектов данных, +// для которых было выполнено заполнение. +// +Процедура ЗаполнениеДанныхДляОграниченияДоступа(КоличествоДанных = 0) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ЗаполнениеДанныхДляОграниченияДоступа(КоличествоДанных); +``` +
+ +## ОтключитьОбновлениеКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Для ускорения пакетной обработки данных в текущем сеансе (полноправный пользователь) +// отключает и включает расчет прав при записи объекта или набора записей +// (обновление ключей доступа к объектам и к записям регистров, а также прав +// групп доступа, пользователей и внешних пользователей на новые ключи доступа). +// +// Рекомендуется: +// - при восстановлении из резервной копии XML; +// - массовой загрузке данных из файла; +// - массовой загрузке данных при обмене данными; +// - групповом изменении объектов. +// +// Параметры: +// Отключить - Булево - Истина - отключает обновление ключей доступа и включает режим +// сбора состава таблиц (списков), для которых будет запланировано +// обновление ключей доступа при продолжении обновления ключей доступа. +// Ложь - планирует обновление ключей доступа таблиц, собранных в режиме +// отключения, и включает стандартный режим обновления ключей доступа. +// +// ПланироватьОбновление - Булево - планирование обновления при отключении и продолжении. +// Когда Отключить = Истина, тогда определяет необходимость сбора +// состава таблиц, для которых будет запланировано обновление. +// Ложь - требуется только в режиме загрузки из резервной копии XML, когда +// загружаются все данные информационной базы, включая все служебные данные. +// Когда Отключить = Ложь, тогда определяет необходимость планирования +// обновления для собранных таблиц. +// Ложь требуется в обработке исключения после отмены транзакции, +// если есть внешняя транзакция, так как любая запись +// в базу данных в таком состоянии приведет к ошибке, кроме того, +// планировать обновление после отмены транзакции не требуется. +// Пример: +// +// Вариант 1. Запись набора объектов вне транзакции (ТранзакцияАктивна() = Ложь). +// +// УправлениеДоступом.ОтключитьОбновлениеКлючейДоступа(Истина); +// Попытка +// // Запись набора объектов. +// // ... +// УправлениеДоступом.ОтключитьОбновлениеКлючейДоступа(Ложь); +// Исключение +// УправлениеДоступом.ОтключитьОбновлениеКлючейДоступа(Ложь); +// //... +// ВызватьИсключение; +// КонецПопытки; +// +// Вариант 2. Запись набора объектов в транзакции (ТранзакцияАктивна() = Истина). +// +// УправлениеДоступом.ОтключитьОбновлениеКлючейДоступа(Истина); +// НачатьТранзакцию(); +// Попытка +// БлокировкаДанных.Заблокировать(); +// // ... +// // Запись набора объектов. +// // ... +// УправлениеДоступом.ОтключитьОбновлениеКлючейДоступа(Ложь); +// ЗафиксироватьТранзакцию(); +// Исключение +// ОтменитьТранзакцию(); +// УправлениеДоступом.ОтключитьОбновлениеКлючейДоступа(Ложь, Ложь); +// //... +// ВызватьИсключение; +// КонецПопытки; +// +Процедура ОтключитьОбновлениеКлючейДоступа(Отключить, ПланироватьОбновление = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ОтключитьОбновлениеКлючейДоступа(Отключить, ПланироватьОбновление); +``` +
+ +## ДобавитьОбработчикОбновленияДляВключенияУниверсальногоОграничения +
+ +Описание, пример вызова + +```bsl + +// Добавляет отложенный обработчик обновления, который включает универсальное ограничение доступа +// (включает константу ОграничиватьДоступНаУровнеЗаписейУниверсально). +// Следует использовать только в конечных типовых решениях, а не в поставках библиотек. +// +// Параметры: +// Версия - Строка - версия для таблицы ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +// Можно указать пустую строку, если параметр УстарелТолькоНачальноеЗаполнение указан Истина. +// Обработчики - см. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления +// УстарелТолькоНачальноеЗаполнение - Булево - для обратной совместимости, если указан Истина, +// тогда не будет добавлен отложенный обработчик обновления для версии в параметре Версия. +// УстарелБезУчетаРИБ - Булево - не учитывается (обработчики добавляются без учета наличия РИБ). +// +// Пример: +// Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +// УправлениеДоступом.ДобавитьОбработчикОбновленияДляВключенияУниверсальногоОграничения("3.0.3.7", Обработчики); +// КонецПроцедуры +// +Процедура ДобавитьОбработчикОбновленияДляВключенияУниверсальногоОграничения(Версия, Обработчики, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ДобавитьОбработчикОбновленияДляВключенияУниверсальногоОграничения(Версия, Обработчики, ); +``` +
+ +## ЗапланироватьОбновлениеДоступа +
+ +Описание, пример вызова + +```bsl + +// Планирует обновление доступа для указанной таблицы. +// Будут проверены и обновлены ключи доступа всех объектов указанной таблицы, если не актуальны. +// Будут пересчитаны и обновлены права на все ключи доступа объектов указанной таблицы, если не актуальны. +// +// Требуется при исправлении специфических прикладных ошибок, из-за которых может потребоваться актуализация +// ключей доступа или прав на ключи доступа, но система не выявила эту необходимость автоматически. +// +// Параметры: +// Таблица - Строка - полное имя объекта метаданных. +// - Массив из Строка - полные имена объектов метаданных. +// +Процедура ЗапланироватьОбновлениеДоступа(Таблица) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступом.ЗапланироватьОбновлениеДоступа(Таблица) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеДоступомПереопределяемый.md b/src/content/docs/bsp/УправлениеДоступомПереопределяемый.md new file mode 100644 index 0000000..a036c7e --- /dev/null +++ b/src/content/docs/bsp/УправлениеДоступомПереопределяемый.md @@ -0,0 +1,406 @@ +--- +title: Управление доступом переопределяемый +slug: bsp/управление-доступом-переопределяемый +--- + + +## ПриЗаполненииВидовДоступа +
+ +Описание, пример вызова + +```bsl + +// Заполняет виды доступа, используемые в ограничениях прав доступа. +// Примечание: виды доступа Пользователи и ВнешниеПользователи предопределены, +// но их можно удалить из списка ВидыДоступа, если они не требуются для ограничения прав доступа. +// +// Параметры: +// ВидыДоступа - ТаблицаЗначений: +// * Имя - Строка - имя, используемое в описании поставляемых +// профилей групп доступа и текстах ОДД. +// * Представление - Строка - представляет вид доступа в профилях и группах доступа. +// * ТипЗначений - Тип - тип ссылки значений доступа, +// например Тип("СправочникСсылка.Номенклатура"). +// * ТипГруппЗначений - Тип - тип ссылки групп значений доступа, +// например Тип("СправочникСсылка.ГруппыДоступаНоменклатуры"). +// * НесколькоГруппЗначений - Булево - Истина указывает, что для значения доступа (Номенклатуры) можно +// выбрать несколько групп значений (Групп доступа номенклатуры). +// +// Пример: +// 1. Для настройки прав доступа в разрезе организаций: +// ВидДоступа = ВидыДоступа.Добавить(); +// ВидДоступа.Имя = "Организации"; +// ВидДоступа.Представление = НСтр("ru = 'Организации'"); +// ВидДоступа.ТипЗначений = Тип("СправочникСсылка.Организации"); +// +// 2. Для настройки прав доступа в разрезе групп партнеров: +// ВидДоступа = ВидыДоступа.Добавить(); +// ВидДоступа.Имя = "ГруппыПартнеров"; +// ВидДоступа.Представление = НСтр("ru = 'Группы партнеров'"); +// ВидДоступа.ТипЗначений = Тип("СправочникСсылка.Партнеры"); +// ВидДоступа.ТипГруппЗначений = Тип("СправочникСсылка.ГруппыДоступаПартнеров"); +// +Процедура ПриЗаполненииВидовДоступа(ВидыДоступа) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомПереопределяемый.ПриЗаполненииВидовДоступа(ВидыДоступа) +``` +
+ +## ПриЗаполненииСписковСОграничениемДоступа +
+ +Описание, пример вызова + +```bsl + +// Позволяет указать объекты метаданных, для которых задана логика ограничения доступа к данным. +// В модулях менеджеров указанных списков размещается процедура обработчика, например: +// +//// Параметры: +//// Ограничение - см. УправлениеДоступомПереопределяемый.ПриЗаполненииОграниченияДоступа.Ограничение. +//// +//Процедура ПриЗаполненииОграниченияДоступа(Ограничение) Экспорт +// +// Ограничение.Текст = +// "РазрешитьЧтениеИзменение +// |ГДЕ +// | ЗначениеРазрешено(Организация) +// | И ЗначениеРазрешено(Контрагент)"; +// +//КонецПроцедуры +// +// Логика ограничения доступа к данным также может быть переопределена в процедуре +// УправлениеДоступомПереопределяемый.ПриЗаполненииОграниченияДоступа. +// +// Параметры: +// Списки - Соответствие из КлючИЗначение - списки с ограничением доступа: +// * Ключ - ОбъектМетаданных - список с ограничением доступа. +// * Значение - Булево - Истина - текст ограничения в модуле менеджера, +// Ложь - текст ограничения в этом переопределяемом +// модуле в процедуре ПриЗаполненииОграниченияДоступа. +// +Процедура ПриЗаполненииСписковСОграничениемДоступа(Списки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомПереопределяемый.ПриЗаполненииСписковСОграничениемДоступа(Списки) +``` +
+ +## ПриЗаполненииПоставляемыхПрофилейГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Заполняет описания поставляемых профилей групп доступа и +// переопределяет параметры обновления профилей и групп доступа. +// +// Для автоматической подготовки содержимого процедуры следует воспользоваться инструментами +// разработчика для подсистемы Управление доступом. +// +// Параметры: +// ОписанияПрофилей - Массив из см. УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа, +// см. УправлениеДоступом.НовоеОписаниеПапкиПрофилейГруппДоступа +// ПараметрыОбновления - Структура: +// * ОбновлятьИзмененныеПрофили - Булево - начальное значение Истина. +// * ЗапретитьИзменениеПрофилей - Булево - начальное значение Истина. +// Если установить Ложь, тогда поставляемые профили можно не только просматривать, но и редактировать. +// * ОбновлятьГруппыДоступа - Булево - начальное значение Истина. +// * ОбновлятьГруппыДоступаСУстаревшимиНастройками - Булево - начальное значение Ложь. +// Если установить Истина, то настройки значений, выполненные администратором для +// вида доступа, который был удален из профиля, будут также удалены из групп доступа. +// +// Пример: +// ОписаниеПрофиля = УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа(); +// ОписаниеПрофиля.Имя = "Менеджер"; +// ОписаниеПрофиля.Идентификатор = "75fa0ecb-98aa-11df-b54f-e0cb4ed5f655"; +// ОписаниеПрофиля.Наименование = НСтр("ru = 'Менеджер по продажам'", ОбщегоНазначения.КодОсновногоЯзыка()); +// ОписаниеПрофиля.Роли.Добавить("ЗапускВебКлиента"); +// ОписаниеПрофиля.Роли.Добавить("ЗапускТонкогоКлиента"); +// ОписаниеПрофиля.Роли.Добавить("БазовыеПраваБСП"); +// ОписаниеПрофиля.Роли.Добавить("Подсистема_Продажи"); +// ОписаниеПрофиля.Роли.Добавить("ДобавлениеИзменениеДокументовПокупателей"); +// ОписаниеПрофиля.Роли.Добавить("ПросмотрОтчетаКнигаПокупок"); +// ОписанияПрофилей.Добавить(ОписаниеПрофиля); +// +// ОписаниеПапки = УправлениеДоступом.НовоеОписаниеПапкиПрофилейГруппДоступа(); +// ОписаниеПапки.Имя = "ДополнительныеПрофили"; +// ОписаниеПапки.Идентификатор = "69a066e7-ce81-11eb-881c-b06ebfbf08c7"; +// ОписаниеПапки.Наименование = НСтр("ru = 'Дополнительные профили'", ОбщегоНазначения.КодОсновногоЯзыка()); +// ОписанияПрофилей.Добавить(ОписаниеПапки); +// +// ОписаниеПрофиля = УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа(); +// ОписаниеПрофиля.Родитель = "ДополнительныеПрофили"; +// ОписаниеПрофиля.Идентификатор = "70179f20-2315-11e6-9bff-d850e648b60c"; +// ОписаниеПрофиля.Наименование = НСтр("ru = 'Редактирование, отправка по почте, сохранение в файл печатных форм (дополнительно)'", +// ОбщегоНазначения.КодОсновногоЯзыка()); +// ОписаниеПрофиля.Описание = НСтр("ru = 'Дополнительно назначается пользователям, которым должна быть доступна возможность редактирования, +// |перед печатью, отправка по почте и сохранение в файл сформированных печатных форм.'"); +// ОписаниеПрофиля.Роли.Добавить("РедактированиеПечатныхФорм"); +// ОписанияПрофилей.Добавить(ОписаниеПрофиля); +// +Процедура ПриЗаполненииПоставляемыхПрофилейГруппДоступа(ОписанияПрофилей, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомПереопределяемый.ПриЗаполненииПоставляемыхПрофилейГруппДоступа(ОписанияПрофилей, ПараметрыОбновления) +``` +
+ +## ПриЗаполненииЗависимостейПравДоступа +
+ +Описание, пример вызова + +```bsl + +// Заполняет зависимости прав доступа "подчиненного" объекта (например, задачи ЗадачаИсполнителя), +// от "ведущего" объекта (например, бизнес-процесса Задание), которые отличаются от стандартных. +// +// Зависимости прав используются в стандартном шаблоне ограничения доступа для вида доступа "Объект". +// 1. Стандартно при чтении "подчиненного" объекта +// проверяется наличие права чтения "ведущего" объекта и +// проверяется отсутствие ограничения чтения "ведущего" объекта. +// 2. Стандартно при добавлении, изменении, удалении "подчиненного" объекта +// проверяется наличие права изменения "ведущего" объекта и +// проверяется отсутствие ограничения изменения "ведущего" объекта. +// +// Допускается только одно переназначение по сравнению со стандартным - +// в пункте 2 вместо проверки права изменения "ведущего" объекта установить +// проверку права чтения "ведущего" объекта. +// +// Параметры: +// ЗависимостиПрав - ТаблицаЗначений: +// * ВедущаяТаблица - Строка - например Метаданные.БизнесПроцессы.Задание.ПолноеИмя(). +// * ПодчиненнаяТаблица - Строка - например Метаданные.Задачи.ЗадачаИсполнителя.ПолноеИмя(). +// +Процедура ПриЗаполненииЗависимостейПравДоступа(ЗависимостиПрав) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомПереопределяемый.ПриЗаполненииЗависимостейПравДоступа(ЗависимостиПрав) +``` +
+ +## ПриЗаполненииВозможныхПравДляНастройкиПравОбъектов +
+ +Описание, пример вызова + +```bsl + +// Заполняет описания возможных прав, назначаемых для объектов указанных типов. +// +// Параметры: +// ВозможныеПрава - ТаблицаЗначений: +// * ВладелецПрав - Строка - полное имя таблицы значения доступа. +// +// * Имя - Строка - идентификатор права, например ИзменениеПапок. Право с именем УправлениеПравами +// должно быть обязательно определено для общей формы настройки прав "Права доступа". +// УправлениеПравами - это право на изменение прав по владельцу прав, которое проверяется +// при открытии ОбщаяФорма.НастройкиПравОбъектов. +// +// * Заголовок - Строка - заголовок права, например в форме НастройкиПравОбъектов: +// "Изменение. +// |папок". +// +// * Подсказка - Строка - подсказка к заголовку права, +// например "Добавление, изменение и пометка удаления папок". +// +// * НачальноеЗначение - Булево - начальное значение флажка права при добавлении новой строки +// в форме "Права доступа". +// +// * ТребуемыеПрава - Массив из Строка - имена прав, требуемых для этого права - +// например, право "ДобавлениеФайлов" требует права "ИзменениеФайлов". +// +// * ЧтениеВТаблицах - Массив из Строка - полные имена таблиц, для которых это право обозначает право Чтение. +// Возможно использование символа "*", который обозначает "для всех остальных таблиц", +// т.к. право Чтение может зависеть только от права Чтение, то имеет смысл только символ "*" +// (требуется для работы шаблонов ограничения доступа). +// +// * ИзменениеВТаблицах - Массив из Строка - полные имена таблиц, для которых это право обозначает право Изменение. +// Возможно использование символа "*", который обозначает "для всех остальных таблиц" +// (требуется для работы шаблонов ограничения доступа). +// +Процедура ПриЗаполненииВозможныхПравДляНастройкиПравОбъектов(ВозможныеПрава) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомПереопределяемый.ПриЗаполненииВозможныхПравДляНастройкиПравОбъектов(ВозможныеПрава) +``` +
+ +## ПриОпределенииИнтерфейсаНастройкиДоступа +
+ +Описание, пример вызова + +```bsl + +// Определяет вид используемого интерфейса пользователя для настройки доступа. +// +// Параметры: +// УпрощенныйИнтерфейс - Булево - начальное значение Ложь. +// +Процедура ПриОпределенииИнтерфейсаНастройкиДоступа(УпрощенныйИнтерфейс) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомПереопределяемый.ПриОпределенииИнтерфейсаНастройкиДоступа(УпрощенныйИнтерфейс) +``` +
+ +## ПриЗаполненииИспользованияВидаДоступа +
+ +Описание, пример вызова + +```bsl + +// Заполняет использование видов доступа в зависимости от функциональных опций конфигурации, +// например, ИспользоватьГруппыДоступаНоменклатуры. +// +// Параметры: +// ВидДоступа - Строка - имя вида доступа, заданное в процедуре ПриЗаполненииВидовДоступа. +// Использование - Булево - начальное значение Истина. +// +Процедура ПриЗаполненииИспользованияВидаДоступа(ВидДоступа, Использование) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомПереопределяемый.ПриЗаполненииИспользованияВидаДоступа(ВидДоступа, Использование) +``` +
+ +## ПриЗаполненииОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить ограничение, указанное в модуле менеджера объекта метаданных. +// +// Параметры: +// Список - ОбъектМетаданных - список, для которого нужно вернуть текст ограничения. +// В процедуре ПриЗаполненииСписковСОграничениемДоступа нужно +// указать для списка значение Ложь, иначе вызова не будет. +// +// Ограничение - Структура: +// * Текст - Строка - ограничение доступа для пользователей. +// Если пустая строка, значит, доступ разрешен. +// * ТекстДляВнешнихПользователей - Строка - ограничение доступа для внешних пользователей. +// Если пустая строка, значит, доступ запрещен. +// * ПоВладельцуБезЗаписиКлючейДоступа - Неопределено - определить автоматически. +// - Булево - если Ложь, то всегда записывать ключи доступа, +// если Истина, тогда не записывать ключи доступа, +// а использовать ключи доступа владельца (требуется, +// чтобы ограничение было строго по объекту-владельцу). +// * ПоВладельцуБезЗаписиКлючейДоступаДляВнешнихПользователей - Неопределено, Булево - также +// как у параметра ПоВладельцуБезЗаписиКлючейДоступа. +// +Процедура ПриЗаполненииОграниченияДоступа(Список, Ограничение) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомПереопределяемый.ПриЗаполненииОграниченияДоступа(Список, Ограничение) +``` +
+ +## ПриЗаполненииВидовОграниченийПравОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// Заполняет состав видов доступа, используемых при ограничении прав объектов метаданных. +// Если состав видов доступа не заполнен, отчет "Права доступа" покажет некорректные сведения. +// +// Обязательно требуется заполнить только виды доступа, используемые в шаблонах ограничения доступа +// явно, а виды доступа, используемые в наборах значений доступа, могут быть получены из текущего +// состояния регистра сведений НаборыЗначенийДоступа. +// +// Для автоматической подготовки содержимого процедуры следует воспользоваться инструментами +// разработчика для подсистемы Управление доступом. +// +// Параметры: +// Описание - Строка - многострочная строка формата <Таблица>.<Право>.<ВидДоступа>[.Таблица объекта], +// например, "Документ.ПриходнаяНакладная.Чтение.Организации", +// "Документ.ПриходнаяНакладная.Чтение.Контрагенты", +// "Документ.ПриходнаяНакладная.Изменение.Организации", +// "Документ.ПриходнаяНакладная.Изменение.Контрагенты", +// "Документ.ЭлектронныеПисьма.Чтение.Объект.Документ.ЭлектронныеПисьма", +// "Документ.ЭлектронныеПисьма.Изменение.Объект.Документ.ЭлектронныеПисьма", +// "Документ.Файлы.Чтение.Объект.Справочник.ПапкиФайлов", +// "Документ.Файлы.Чтение.Объект.Документ.ЭлектронноеПисьмо", +// "Документ.Файлы.Изменение.Объект.Справочник.ПапкиФайлов", +// "Документ.Файлы.Изменение.Объект.Документ.ЭлектронноеПисьмо". +// Вид доступа Объект предопределен как литерал. Этот вид доступа используется в +// шаблонах ограничений доступа как "ссылка" на другой объект, по которому +// ограничивается текущий объект таблицы. +// Когда вид доступа "Объект" задан, также требуется задать типы таблиц, +// которые используются для этого вида доступа. Т.е. перечислить типы, +// которые соответствуют полю, использованному в шаблоне ограничения доступа +// в паре с видом доступа "Объект". При перечислении типов по виду доступа "Объект" +// нужно перечислить только те типы поля, которые есть +// у поля РегистрыСведений.НаборыЗначенийДоступа.Объект, остальные типы лишние. +// +Процедура ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомПереопределяемый.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) +``` +
+ +## ПриИзмененииНаборовЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Позволяет реализовать перезапись зависимых наборов значений доступа других объектов. +// +// Вызывается из процедур +// УправлениеДоступомСлужебный.ЗаписатьНаборыЗначенийДоступа, +// УправлениеДоступомСлужебный.ЗаписатьЗависимыеНаборыЗначенийДоступа. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - ссылка на объект, для которого записываются наборы значений доступа. +// +// СсылкиНаЗависимыеОбъекты - Массив - массив элементов типа СправочникСсылка, ДокументСсылка и т. п. +// Содержит ссылки на объекты с зависимыми наборами значений доступа. +// Начальное значение - пустой массив. +// +Процедура ПриИзмененииНаборовЗначенийДоступа(Ссылка, СсылкиНаЗависимыеОбъекты) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомПереопределяемый.ПриИзмененииНаборовЗначенийДоступа(Ссылка, СсылкиНаЗависимыеОбъекты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеДоступомСлужебный.md b/src/content/docs/bsp/УправлениеДоступомСлужебный.md new file mode 100644 index 0000000..429a129 --- /dev/null +++ b/src/content/docs/bsp/УправлениеДоступомСлужебный.md @@ -0,0 +1,18195 @@ +--- +title: Управление доступом служебный +slug: bsp/управление-доступом-служебный +--- + + +## НовоеОтключениеОбновленияКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * Стандартное - Булево +// * Полное - Булево +// * ВложенныеОтключения - ФиксированныйМассив +// * ИзмененныеСписки - ХранилищеЗначения +// +Функция НовоеОтключениеОбновленияКлючейДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовоеОтключениеОбновленияКлючейДоступа() +``` +
+ +## ОбновитьПараметрыСеанса +
+ +Описание, пример вызова + +```bsl + +// Только для внутреннего использования. +Процедура ОбновитьПараметрыСеанса() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьПараметрыСеанса() +``` +
+ +## ПроверитьНаличиеПользователяИБВГруппеДоступаАдминистраторы +
+ +Описание, пример вызова + +```bsl + +// Проверка группы доступа Администраторы перед записью. +Процедура ПроверитьНаличиеПользователяИБВГруппеДоступаАдминистраторы(ПользователиГруппы, ОписаниеОшибки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьНаличиеПользователяИБВГруппеДоступаАдминистраторы(ПользователиГруппы, ОписаниеОшибки) +``` +
+ +## ЕстьОграничениеТаблицыПоВидуДоступа +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступом.ЕстьОграничениеТаблицыПоВидуДоступа +Функция ЕстьОграничениеТаблицыПоВидуДоступа(Таблица, ВидДоступа, ВсеВидыДоступа) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЕстьОграничениеТаблицыПоВидуДоступа(Таблица, ВидДоступа, ВсеВидыДоступа) +``` +
+ +## ДобавитьОбъектПланируемыйКУдалению +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Объекты - см. ОбновлениеИнформационнойБазы.ДобавитьОбъектПланируемыйКУдалению.Объекты +// ПолноеИмяИзмерения - см. ОбновлениеИнформационнойБазы.ДобавитьОбъектПланируемыйКУдалению.Объект +// ТребуемыеТипы - ОписаниеТипов +// УказанныеТипы - ОписаниеТипов +// +Процедура ДобавитьОбъектПланируемыйКУдалению(Объекты, ТребуемыеТипы, МетаданныеИзмерения) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьОбъектПланируемыйКУдалению(Объекты, ТребуемыеТипы, МетаданныеИзмерения)); +``` +
+ +## ОбновитьГруппыЗначенийДоступаПередЗаписью +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки ОбновитьГруппыЗначенийДоступаПередЗаписью: +// - проверяет изменение родителя и готовит группы доступа, в которых +// нужно обновить значения доступа, выбранные с учетом иерархии. +// +Процедура ОбновитьГруппыЗначенийДоступаПередЗаписью(Знач Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьГруппыЗначенийДоступаПередЗаписью(Источник, Отказ) +``` +
+ +## ОбновитьГруппыЗначенийДоступаПриЗаписи +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки ОбновитьГруппыЗначенийДоступаПриЗаписи: +// - вызывает метод записи групп значений доступа в +// регистр сведений ГруппыЗначенийДоступа для требуемых объектов метаданных, +// - обновляет значения групп доступа, выбранные с учетом иерархии. +// +Процедура ОбновитьГруппыЗначенийДоступаПриЗаписи(Источник) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьГруппыЗначенийДоступаПриЗаписи(Источник) +``` +
+ +## ОбновитьГруппыВладельцевНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки ОбновитьГруппыВладельцевНастроекПрав на событие ПередЗаписью: +// - вызывает метод записи иерархии владельцев настроек прав объектов в +// регистр сведений НаследованиеНастроекПравОбъектов для требуемых объектов метаданных. +// +Процедура ОбновитьГруппыВладельцевНастроекПрав(Знач Объект, Отказ) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьГруппыВладельцевНастроекПрав(Объект, Отказ) +``` +
+ +## ЗаписатьНаборыЗначенийДоступаПриЗаписи +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки ЗаписатьНаборыЗначенийДоступа на событие ПриЗаписи +// вызывает метод записи значений доступа объекта в РегистрСведений.НаборыЗначенийДоступа. +// Возможен случай использования подсистемы "УправлениеДоступом", когда +// указанной подписки не существует, если наборы значений доступа не применяются. +// +Процедура ЗаписатьНаборыЗначенийДоступаПриЗаписи(Знач Объект, Отказ) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьНаборыЗначенийДоступаПриЗаписи(Объект, Отказ) +``` +
+ +## ЗаписатьЗависимыеНаборыЗначенийДоступаПриЗаписи +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки ЗаписатьЗависимыеНаборыЗначенийДоступа события ПриЗаписи +// вызывает перезапись зависимых наборов значений доступа в регистре сведений НаборыЗначенийДоступа. +// +// Возможен случай использования подсистемы "УправлениеДоступом", когда +// указанной подписки не существует, если зависимые наборы значений доступа не применяются. +// +Процедура ЗаписатьЗависимыеНаборыЗначенийДоступаПриЗаписи(Знач Объект, Отказ) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьЗависимыеНаборыЗначенийДоступаПриЗаписи(Объект, Отказ) +``` +
+ +## ЗаполнитьНаборыЗначенийДоступаТабличныхЧастей +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписок ЗаполнитьНаборыЗначенийДоступаТабличныхЧастей* на событие ПередЗаписью +// вызывает заполнение значений доступа табличной части объекта НаборыЗначенийДоступа, +// когда для ограничения доступа к самому объекту используется шаблон #ПоНаборамЗначений. +// Возможен случай использования подсистемы Управление доступом, когда +// указанной подписки не существует, если для указанной цели наборы не применяются. +// +// Параметры: +// Источник - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - объект данных, передаваемый в подписку на событие ПередЗаписью. +// +// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// +// РежимЗаписи - Булево - параметр, передаваемый в подписку на событие ПередЗаписью, +// когда тип параметра Источник - ДокументОбъект. +// +// РежимПроведения - Булево - параметр, передаваемый в подписку на событие ПередЗаписью, +// когда тип параметра Источник - ДокументОбъект. +// +Процедура ЗаполнитьНаборыЗначенийДоступаТабличныхЧастей(Источник, Отказ = Неопределено, РежимЗаписи = Неопределено, РежимПроведения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьНаборыЗначенийДоступаТабличныхЧастей(Источник, Отказ, РежимЗаписи, РежимПроведения); +``` +
+ +## ЗаполнениеДанныхДляОграниченияДоступаОбработчикЗадания +
+ +Описание, пример вызова + +```bsl + +// Обработчик регламентного задания ЗаполнениеДанныхДляОграниченияДоступа. +Процедура ЗаполнениеДанныхДляОграниченияДоступаОбработчикЗадания() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнениеДанныхДляОграниченияДоступаОбработчикЗадания() +``` +
+ +## ЗаполнениеДанныхДляОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Выполняет последовательное заполнение и обновление данных, необходимых для работы +// подсистемы УправленияДоступом в режиме ограничения доступа на уровне записей. +// +// При включенном режиме ограничения доступа на уровне записей заполняет наборы +// значений доступа. Заполнение выполняется частями при каждом запуске, пока все +// наборы значений доступа не будут заполнены. +// При отключении режима ограничения доступа на уровне записей наборы значений доступа +// (заполненные ранее) удаляются при перезаписи объектов, а не все сразу. +// Независимо от режима ограничения доступа на уровне записей обновляет кэш-реквизиты. +// После завершения всех обновлений и заполнений отключает использование регламентного задания. +// +// Сведения о состоянии работы записываются в журнал регистрации. +// +// Возможно вызывать программно, например, при обновлении информационной базы. +// Также для целей обновления есть форма Справочник.ГруппыДоступа.ОбновлениеДанныхОграниченияДоступа, +// с помощью которой можно сделать интерактивное обновление данных ограничения доступа +// при обновлении информационной базы. +// +Процедура ЗаполнениеДанныхДляОграниченияДоступа(КоличествоДанных = 0, ТолькоКэшРеквизиты = Ложь, ЕстьИзменения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнениеДанныхДляОграниченияДоступа(КоличествоДанных, ТолькоКэшРеквизиты, ЕстьИзменения); +``` +
+ +## УстановитьЗаполнениеДанныхДляОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Устанавливает использование регламентного задания заполнения данных управления доступом. +// +// Параметры: +// Использование - Булево - Истина, если задание нужно включить, иначе Ложь. +// +Процедура УстановитьЗаполнениеДанныхДляОграниченияДоступа(Знач Использование) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьЗаполнениеДанныхДляОграниченияДоступа(Использование) +``` +
+ +## ВидДоступаИспользуется +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если вид доступа включен по функциональным опциям для всех сеансов. +// +// Параметры: +// ВидДоступа - ОпределяемыйТип.ЗначениеДоступа - пустая ссылка основного типа вида доступа. +// - Строка - имя вида доступа. +// +// Возвращаемое значение: +// Булево +// +Функция ВидДоступаИспользуется(Знач ВидДоступа) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВидДоступаИспользуется(ВидДоступа) +``` +
+ +## ИспользуемыеВидыДоступа +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// БезУчетаОграниченияДоступа - Булево +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ОпределяемыйТип.ЗначениеДоступа - пустая ссылка основного типа вида доступа. +// * Значение - Булево - значение Истина. +// +Функция ИспользуемыеВидыДоступа(БезУчетаОграниченияДоступа = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИспользуемыеВидыДоступа(БезУчетаОграниченияДоступа); +``` +
+ +## СвойстваВидаДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства вида доступа или всех видов доступа. +// +// Параметры: +// ВидДоступа - ОпределяемыйТип.ЗначениеДоступа - пустая ссылка основного типа вида доступа. +// - Строка - имя вида доступа. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка +// * Ссылка - ОпределяемыйТип.ЗначениеДоступа +// * ТипЗначений - Тип +// * ТипГруппЗначений - Тип +// * НесколькоГруппЗначений - Булево +// * ДополнительныеТипы - ФиксированныйМассив из см. ДополнительныйТипВидаДоступа +// * ТипыВыбираемыхЗначений - ФиксированныйМассив из Тип +// Неопределено +// +Функция СвойстваВидаДоступа(ВидДоступа) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваВидаДоступа(ВидДоступа) +``` +
+ +## ПолучитьНаборыЗначенийДоступаТабличнойЧасти +
+ +Описание, пример вызова + +```bsl + +// Возвращает новые наборы для заполнения табличной части. +// +// Параметры: +// Объект - ОпределяемыйТип.ВладелецСОграничениемПоНаборамЗначенийДоступаОбъект +// - ОпределяемыйТип.ВладелецСОграничениемПоНаборамЗначенийДоступаДокумент +// +// Возвращаемое значение: +// см. УправлениеДоступом.ТаблицаНаборыЗначенийДоступа +// +Функция ПолучитьНаборыЗначенийДоступаТабличнойЧасти(Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПолучитьНаборыЗначенийДоступаТабличнойЧасти(Объект)); +``` +
+ +## ОбновитьНаборыЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Выполняет обновление наборов значений доступа объекта, если они изменились. +// Наборы обновляются в табличной части (если используется) и +// в регистре сведений НаборыЗначенийДоступа. +// +// Параметры: +// СсылкаИлиОбъект - ЛюбаяСсылка +// - ОпределяемыйТип.ВладелецНаборовЗначенийДоступаОбъект - ссылка или объект, +// для которого записываются наборы значений доступа. +// +// ЕстьИзменения - Булево +// - Неопределено +// +// ОбновлениеИБ - Булево - если Истина, то необходимо выполнять запись данных, +// не выполняя лишних, избыточных действий с данными. +// См. ОбновлениеИнформационнойБазы.ЗаписатьДанные. +// +Процедура ОбновитьНаборыЗначенийДоступа(СсылкаИлиОбъект, ЕстьИзменения = Неопределено, ОбновлениеИБ = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьНаборыЗначенийДоступа(СсылкаИлиОбъект, ЕстьИзменения, ОбновлениеИБ); +``` +
+ +## ПодготовитьНаборыЗначенийДоступаКЗаписи +
+ +Описание, пример вызова + +```bsl + +// Заполняет вспомогательные данные, ускоряющие работу шаблонов ограничений доступа. +// Выполняется перед записью в регистр НаборыЗначенийДоступа. +// +// Параметры: +// СсылкаНаОбъект - ЛюбаяСсылка - ссылка на объект для которого заполняются наборы значений доступа. +// Таблица - ТаблицаЗначений +// ДобавитьКэшРеквизиты - Булево +// +Процедура ПодготовитьНаборыЗначенийДоступаКЗаписи(СсылкаНаОбъект, Таблица, ДобавитьКэшРеквизиты = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПодготовитьНаборыЗначенийДоступаКЗаписи(СсылкаНаОбъект, Таблица, ДобавитьКэшРеквизиты); +``` +
+ +## ПриИзмененииОграниченияДоступаНаУровнеЗаписей +
+ +Описание, пример вызова + +```bsl + +// Если необходимо, включает заполнение данных для ограничения доступа и +// обновляет некоторые данные сразу. +// +// Вызывается из обработчика ПриЗаписи константы ОграничиватьДоступаНаУровнеЗаписей. +// +Процедура ПриИзмененииОграниченияДоступаНаУровнеЗаписей(ОграничениеДоступаНаУровнеЗаписейВключено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПриИзмененииОграниченияДоступаНаУровнеЗаписей(ОграничениеДоступаНаУровнеЗаписейВключено) +``` +
+ +## ПриСозданииНаСервереФормыРедактированияРазрешенныхЗначений +
+ +Описание, пример вызова + +```bsl + +// Заполняет вспомогательные данные, требуемые для работы формы, +// которые не зависят от содержания объекта или заполняются для нового объекта. +// +// Форма должна содержать реквизиты, указанные ниже. +// Реквизиты отмеченные символом & заполняются автоматически, но их нужно создать в форме. +// Реквизиты отмеченные символом # должны быть созданы в форме, если +// в форме будет создан реквизит ТекущаяГруппаДоступа (см. ниже). +// Реквизиты отмеченные символом @ будут созданы автоматически. +// +// ТекущаяГруппаДоступа - необязательный реквизит, +// если не создан в форме, тогда не используется. +// +// ВидыДоступа - Таблица с полями: +// #ГруппаДоступа - СправочникСсылка.ГруппыДоступа, +// ВидДоступа - ОпределяемыйТип.ЗначениеДоступа, +// Предустановленный - Булево (только для профиля), +// ВсеРазрешены - Булево, +// &ВидДоступаПредставление - Строка - представление настройки, +// &ВсеРазрешеныПредставление - Строка - представление настройки, +// @Используется - Булево. +// +// ЗначенияДоступа - Таблица с полями: +// #ГруппаДоступа - СправочникСсылка.ГруппыДоступа, +// &ВидДоступа - ОпределяемыйТип.ЗначениеДоступа, +// ЗначениеДоступа - ОпределяемыйТип.ЗначениеДоступа, +// &НомерСтрокиПоВиду - Число. +// +// &ИспользоватьВнешнихПользователей - Булево - реквизит будет создан, если нет в форме. +// &НадписьВидДоступа - Строка - представление текущего вида доступа в форме. +// @ЭтоПрофильГруппДоступа - Булево. +// @ТекущийВидДоступа - ОпределяемыйТип.ЗначениеДоступа. +// @ТекущиеТипыВыбираемыхЗначений - СписокЗначений. +// @ТекущийТипВыбираемыхЗначений - ОпределяемыйТип.ЗначениеДоступа. +// @ИмяРеквизитаХранилищаТаблиц - Строка. +// @ВидДоступаПользователи - ОпределяемыйТип.ЗначениеДоступа. +// @ВидДоступаВнешниеПользователи - ОпределяемыйТип.ЗначениеДоступа. +// +// @ВсеВидыДоступа - Таблица с полями: +// @Ссылка - ОпределяемыйТип.ЗначениеДоступа, +// @Представление - Строка, +// @Используется - Булево. +// +// @ПредставленияВсеРазрешены - Таблица с полями: +// @Имя - Строка, +// @Представление - Строка. +// +// @ВсеТипыВыбираемыхЗначений - Таблица с полями: +// @ВидДоступа - ОпределяемыйТип.ЗначениеДоступа, +// @ТипЗначений - ОпределяемыйТип.ЗначениеДоступа, +// @ПредставлениеТипа - Строка, +// @ИмяТаблицы - Строка, +// @ИерархияЭлементов - Булево. +// +// Параметры: +// Форма - см. УправлениеДоступомСлужебныйКлиентСервер.ПараметрыФормыРедактированияРазрешенныхЗначений +// +// ЭтоПрофиль - Булево - указывает, что возможна настройка видов доступа +// в том числе представление настройки содержит 4 значения, а не 2. +// +// ИмяРеквизитаХранилищаТаблиц - Строка - содержащая, например, строку "Объект", которая +// содержит таблицы ВидыДоступа и ЗначенияДоступа (см. ниже). +// Если указана пустая строка, тогда считается, +// что таблицы хранятся в реквизитах формы. +// +Процедура ПриСозданииНаСервереФормыРедактированияРазрешенныхЗначений(Форма, ЭтоПрофиль = Ложь, ИмяРеквизитаХранилищаТаблиц = "Объект") Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПриСозданииНаСервереФормыРедактированияРазрешенныхЗначений(Форма, ЭтоПрофиль, ИмяРеквизитаХранилищаТаблиц); +``` +
+ +## ПриПовторномЧтенииНаСервереФормыРедактированияРазрешенныхЗначений +
+ +Описание, пример вызова + +```bsl + +// При повторном чтении заполняет или обновляет вспомогательные данные, +// требуемые для работы формы, которые зависят от содержания объекта. +// +Процедура ПриПовторномЧтенииНаСервереФормыРедактированияРазрешенныхЗначений(Форма, ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПриПовторномЧтенииНаСервереФормыРедактированияРазрешенныхЗначений(Форма, ТекущийОбъект) +``` +
+ +## ПередЗаписьюНаСервереФормыРедактированияРазрешенныхЗначений +
+ +Описание, пример вызова + +```bsl + +// Удаляет лишние значения доступа перед записью. +// Лишние значения доступа могут появиться, если заменить или удалить вид доступа, +// для которого введены значения доступа. +// +Процедура ПередЗаписьюНаСервереФормыРедактированияРазрешенныхЗначений(Форма, ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередЗаписьюНаСервереФормыРедактированияРазрешенныхЗначений(Форма, ТекущийОбъект) +``` +
+ +## ПослеЗаписиНаСервереФормыРедактированияРазрешенныхЗначений +
+ +Описание, пример вызова + +```bsl + +// Обновляет свойства видов доступа. +Процедура ПослеЗаписиНаСервереФормыРедактированияРазрешенныхЗначений(Форма, ТекущийОбъект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПослеЗаписиНаСервереФормыРедактированияРазрешенныхЗначений(Форма, ТекущийОбъект, ПараметрыЗаписи) +``` +
+ +## ОбновитьОтображениеНеиспользуемыхВидовДоступа +
+ +Описание, пример вызова + +```bsl + +// Скрывает или показывает неиспользуемые виды доступа. +Процедура ОбновитьОтображениеНеиспользуемыхВидовДоступа(Форма, ПриСозданииНаСервере = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьОтображениеНеиспользуемыхВидовДоступа(Форма, ПриСозданииНаСервере); +``` +
+ +## УстановитьУсловиеОтбораВЗапросе +
+ +Описание, пример вызова + +```bsl + +// Только для внутреннего использования. +Процедура УстановитьУсловиеОтбораВЗапросе(Знач Запрос, Знач Значения, Знач ИмяПараметраЗначений, Знач ИмяПараметраУсловияОтбораИмяПоля) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьУсловиеОтбораВЗапросе(Запрос, Значения, ИмяПараметраЗначений, ИмяПараметраУсловияОтбораИмяПоля) +``` +
+ +## ОбновитьНаборЗаписей +
+ +Описание, пример вызова + +```bsl + +// Обновляет набор записей в базе данных, +// если записи набора отличаются от записей в базе данных. +// +// Параметры: +// Данные - Структура: +// * НаборЗаписей - РегистрСведенийНаборЗаписей - пустой или прочитанный с заданным отбором или без. +// - РегистрСведенийМенеджер - менеджер регистра для создания набора записей. +// +// * НовыеЗаписи - ТаблицаЗначений - в формате регистра. +// +// * ПоляСравнения - Строка - содержит список полей по значениям которых требуется вычислять +// отличие записей набора. Например, "Измерение1, Измерение2, Ресурс1", +// а реквизит ДатаИзмерения не входит в список. +// +// * ПолеОтбора - Неопределено - записывается весь регистр или +// отбор уже задан в наборе записей. +// Строка - имя поля по которому нужно установить отбор. +// +// * ЗначениеОтбора - Отбор - значение, которое будет установлено в качестве отбора +// по полю отбора, если поле отбора задано. +// +// * НаборЗаписейПрочитан - Булево - если Истина, тогда не заданный набор записей уже содержит +// прочитанные записи блокировка данных этих записей установлена и +// транзакция открыта. +// +// * ТолькоПроверка - Булево - если Истина, тогда не выполнять запись, +// а лишь выявить необходимость записи и установить +// свойство ЕстьИзменения. +// +// * ДополнительныеСвойства - Структура +// - Неопределено - если Структура, тогда в +// объекты <Регистр*>НаборЗаписей в свойство ДополнительныеСвойства +// будут вставлены все параметры структуры. +// +// * ОбновлениеИБ - Булево - если Истина, то необходимо выполнять запись данных, +// не выполняя лишних, избыточных действий с данными. +// См. ОбновлениеИнформационнойБазы.ЗаписатьДанные. +// Если свойство не вставлено, то значение вычисляется по "Или" с помощью функций +// ВыполняетсяОбновлениеИнформационнойБазы и ЭтоВызовИзОбработчикаОбновления +// общего модуля ОбновлениеИнформационнойБазы. +// +// ЕстьИзменения - Булево - возвращаемое значение. Если производилась запись, +// устанавливается Истина, иначе не изменяется. +// +// ИзмененныеЗаписи - Неопределено - никаких действий, иначе +// возвращает таблицу значений в формате регистра с полем ВидИзмененияСтроки +// типа Число (-1 запись удалена, 1 запись добавлена). +// +Процедура ОбновитьНаборЗаписей(Знач Данные, ЕстьИзменения = Неопределено, ИзмененныеЗаписи = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьНаборЗаписей(Данные, ЕстьИзменения, ИзмененныеЗаписи); +``` +
+ +## ОбновитьНаборыЗаписей +
+ +Описание, пример вызова + +```bsl + +// Обновляет строки регистра с отбором по нескольким значениям для одного или +// для двух измерений регистра, выполняется проверка наличия изменений, +// если изменений нет, перезапись не производится. +// +// Параметры: +// Данные - Структура: +// * МенеджерРегистра - РегистрСведенийМенеджер - менеджер регистра для создания набора записей. +// +// * НовыеЗаписи - ТаблицаЗначений - в формате регистра. +// +// * ПоляСравнения - Строка - содержит список полей по значениям которых требуется +// вычислять отличие записей набора, например, "Измерение1, Измерение2, +// Ресурс1", а реквизит ДатаИзменения не входит в список. +// +// * ИмяПервогоИзмерения - Неопределено - нет отбора по измерению. +// - Строка - содержит имя первого измерения, для которого задано +// несколько значений. +// +// * ЗначенияПервогоИзмерения - Неопределено - нет отбора по измерению, аналогично, +// ИмяПервогоИзмерения = Неопределено. +// - ЛюбаяСсылка - содержит одно значение отбора регистра для +// обновляемых записей. +// - Массив - содержит массив значений отбора регистра для +// обновляемых записей, пустой массив - значит +// действий не требуется. +// +// * ИмяВторогоИзмерения - Неопределено +// - Строка - аналогично ИмяПервогоИзмерения. +// * ЗначенияВторогоИзмерения - Неопределено +// - ЛюбаяСсылка +// - Массив - аналогично ЗначенияПервогоИзмерения. +// * ИмяТретьегоИзмерения - Неопределено +// - Строка - аналогично ИмяПервогоИзмерения. +// * ЗначенияТретьегоИзмерения - Неопределено +// - ЛюбаяСсылка +// - Массив - аналогично ЗначенияПервогоИзмерения. +// +// * ТолькоПроверка - Булево - если Истина, тогда не выполнять запись, +// а лишь выявить необходимость записи и установить +// свойство ЕстьИзменения. +// +// * ДополнительныеСвойства - Неопределено +// - Структура - если Структура, тогда в +// объекты <Регистр*>НаборЗаписей в свойство +// ДополнительныеСвойства будут вставлены все параметры структуры. +// +// * ОбновлениеИБ - Булево - если Истина, то необходимо выполнять запись данных, +// не выполняя лишних, избыточных действий с данными. +// См. ОбновлениеИнформационнойБазы.ЗаписатьДанные. +// Если свойство не вставлено, то значение вычисляется по "Или" с помощью функций +// ВыполняетсяОбновлениеИнформационнойБазы и ЭтоВызовИзОбработчикаОбновления +// общего модуля ОбновлениеИнформационнойБазы. +// +// ЕстьИзменения - Булево - возвращаемое значение. Если производилась запись, +// устанавливается Истина, иначе не изменяется. +// +Процедура ОбновитьНаборыЗаписей(Знач Данные, ЕстьИзменения) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьНаборыЗаписей(Данные, ЕстьИзменения)); +``` +
+ +## ОбновитьРегистрСведений +
+ +Описание, пример вызова + +```bsl + +// Обновляет регистр сведений по данным в таблице значений ИзмененияСтрок. +// +// Параметры: +// Данные - Структура: +// +// * МенеджерРегистра - РегистрСведенийМенеджер - менеджер регистра для создания набора записей. +// +// * ИзмененияСоставаСтрок - ТаблицаЗначений - содержащей поля регистра и +// поле ВидИзмененияСтроки (Число): +// " 1" - значит, что строку нужно добавить, +// "-1" - значит, что строку нужно удалить. +// +// * ФиксированныйОтбор - Структура - содержащая имя измерения в ключе и значение +// отбора в значении. Может быть указана, когда измерений +// более 3-х и заранее известно, что по измерениям сверх 3-х +// будет единственное значение. Измерения указанные в +// фиксированном отборе не используются при формировании +// наборов записей для выполнения обновления. +// +// * ИзмеренияОтбора - Строка - измерений перечисленных через запятую, которые +// нужно использовать при формировании наборов записей +// для выполнения обновления (не более 3-х). Не указанные +// измерения будут превращены в фиксированный отбор, +// если по ним все значения совпадают. +// +// * ТолькоПроверка - Булево - если Истина, тогда не выполнять запись, +// а лишь выявить необходимость записи и установить +// свойство ЕстьИзменения. +// +// * ДополнительныеСвойства - Неопределено +// - Структура - если Структура, тогда в +// объекты <Регистр*>НаборЗаписей в свойство +// ДополнительныеСвойства будут вставлены все параметры структуры. +// +// * ОбновлениеИБ - Булево - если Истина, то необходимо выполнять запись данных, +// не выполняя лишних, избыточных действий с данными. +// См. ОбновлениеИнформационнойБазы.ЗаписатьДанные. +// Если свойство не вставлено, то значение вычисляется по "Или" с помощью функций +// ВыполняетсяОбновлениеИнформационнойБазы и ЭтоВызовИзОбработчикаОбновления +// общего модуля ОбновлениеИнформационнойБазы. +// +// ЕстьИзменения - Булево - возвращаемое значение. Если производилась запись, +// устанавливается Истина, иначе не изменяется. +// +Процедура ОбновитьРегистрСведений(Знач Данные, ЕстьИзменения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьРегистрСведений(Данные, ЕстьИзменения); +``` +
+ +## ПустаяСсылкаОбъектаМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую ссылку объекта метаданных ссылочного типа. +// +// Параметры: +// ОписаниеОбъектаМетаданных - ОбъектМетаданных, +// - Тип - по которому можно найти объект метаданных, +// - Строка - полное имя объекта метаданных. +// Возвращаемое значение: +// ЛюбаяСсылка +// +Функция ПустаяСсылкаОбъектаМетаданных(ОписаниеОбъектаМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПустаяСсылкаОбъектаМетаданных(ОписаниеОбъектаМетаданных) +``` +
+ +## ТекстЗапросаВыбораИзменений +
+ +Описание, пример вызова + +```bsl + +// Создает запрос выбора различий между строками регистра в заданной области данных +// (на основе отборов в параметре ПоляИОтбор). +// +// Параметры: +// ТекстЗапросаВыбораНовых - Строка. +// +// ПоляИОтбор - Массив из Структура - со свойствами "ИмяПоля", ИмяПараметраУсловияОтбора. +// +// ПолноеИмяРегистра - Строка - запрос старых формируется автоматически. +// - Неопределено - запрос старых берется из следующего параметра. +// +// ТекстЗапросовВременныхТаблиц - Строка - запрос временных таблиц, если требуется. +// +// ТекстЗапросаВыбораСтарых - Строка - запрос старых, с учетом нестандартных отборов. +// - Неопределено - когда полное имя регистра определено. +// +// Возвращаемое значение: +// Строка - текст запроса +// +Функция ТекстЗапросаВыбораИзменений(ТекстЗапросаВыбораНовых, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаВыбораИзменений(ТекстЗапросаВыбораНовых, ); +``` +
+ +## ЗаполнитьОбработчикиРазделенныхДанных +
+ +Описание, пример вызова + +```bsl + +// Заполняет обработчик разделенных данных, зависимый от изменения неразделенных данных. +// +// Параметры: +// Параметры - Структура - структура параметров обработчиков: +// * РазделенныеОбработчики - см. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления +// +Процедура ЗаполнитьОбработчикиРазделенныхДанных(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьОбработчикиРазделенныхДанных(Параметры); +``` +
+ +## ОбновитьВспомогательныеДанныеПоИзменениямКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Обновляет вспомогательные данные, которые зависят от конфигурации частично. +// +// Обновляется при наличии изменений конфигурации, записанных в параметры +// ограничения доступа при обновлении базы данных на текущую версию конфигурации. +// +Процедура ОбновитьВспомогательныеДанныеПоИзменениямКонфигурации(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьВспомогательныеДанныеПоИзменениямКонфигурации(Параметры); +``` +
+ +## ВключитьЗаполнениеДанныхДляОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Обновляет настройки и включает регламентное задание. +Процедура ВключитьЗаполнениеДанныхДляОграниченияДоступа() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВключитьЗаполнениеДанныхДляОграниченияДоступа() +``` +
+ +## ОбновитьДанныеПрофиляОткрытиеВнешнихОтчетовИОбработок +
+ +Описание, пример вызова + +```bsl + +// Обновляет данные профиля "ИнтерактивноеОткрытиеВнешнихОтчетовИОбработок". +Процедура ОбновитьДанныеПрофиляОткрытиеВнешнихОтчетовИОбработок() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьДанныеПрофиляОткрытиеВнешнихОтчетовИОбработок() +``` +
+ +## ОбновитьВспомогательныеДанныеГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Только для внутреннего использования. +Процедура ОбновитьВспомогательныеДанныеГруппДоступа(Параметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьВспомогательныеДанныеГруппДоступа(Параметры) +``` +
+ +## ПраваРолейРасширений +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// см. РегистрыСведений.ПраваРолей.ТаблицаПравРолей +// +Функция ПраваРолейРасширений() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПраваРолейРасширений() +``` +
+ +## ОбновитьТаблицыГруппДоступаДляПодключенныхРасширений +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ПраваРолейРасширений - см. РегистрыСведений.ПраваРолей.ТаблицаПравРолей +// +Процедура ОбновитьТаблицыГруппДоступаДляПодключенныхРасширений(ПраваРолейРасширений = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьТаблицыГруппДоступаДляПодключенныхРасширений(ПраваРолейРасширений); +``` +
+ +## ЭтоПраваРолейРасширений +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьТаблицыГруппДоступаДляПодключенныхРасширений. +// +// Параметры: +// ПраваРолейРасширений - см. РегистрыСведений.ПраваРолей.ТаблицаПравРолей +// ПустыеПраваРолейРасширений - см. РегистрыСведений.ПраваРолей.ТаблицаПравРолей +// +Функция ЭтоПраваРолейРасширений(ПраваРолейРасширений, ПустыеПраваРолейРасширений) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоПраваРолейРасширений(ПраваРолейРасширений, ПустыеПраваРолейРасширений)); +``` +
+ +## ПраваРолейРасширенийИзменились +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьТаблицыГруппДоступаДляПодключенныхРасширений. +// +// Параметры: +// НовыеПраваРолейРасширений - см. РегистрыСведений.ПраваРолей.ТаблицаПравРолей +// СтарыеПраваРолейРасширений - см. РегистрыСведений.ПраваРолей.ТаблицаПравРолей +// +Функция ПраваРолейРасширенийИзменились(НовыеПраваРолейРасширений, СтарыеПраваРолейРасширений) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПраваРолейРасширенийИзменились(НовыеПраваРолейРасширений, СтарыеПраваРолейРасширений)); +``` +
+ +## ПриИзмененииНаборовЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ПриИзмененииНаборовЗначенийДоступа(Знач СсылкаНаОбъект, ОбновлениеИБ = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПриИзмененииНаборовЗначенийДоступа(СсылкаНаОбъект, ОбновлениеИБ); +``` +
+ +## ИдентификаторПрофиляОткрытиеВнешнихОтчетовИОбработок +
+ +Описание, пример вызова + +```bsl + +Функция ИдентификаторПрофиляОткрытиеВнешнихОтчетовИОбработок() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИдентификаторПрофиляОткрытиеВнешнихОтчетовИОбработок()); +``` +
+ +## ЭтоПрофильОткрытиеВнешнихОтчетовИОбработок +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоПрофильОткрытиеВнешнихОтчетовИОбработок(Профиль) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоПрофильОткрытиеВнешнихОтчетовИОбработок(Профиль) +``` +
+ +## ГруппыДоступаПрофиляОткрытиеВнешнихОтчетовИОбработок +
+ +Описание, пример вызова + +```bsl + +Функция ГруппыДоступаПрофиляОткрытиеВнешнихОтчетовИОбработок() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ГруппыДоступаПрофиляОткрытиеВнешнихОтчетовИОбработок()); +``` +
+ +## ОписаниеПрофиляОткрытиеВнешнихОтчетовИОбработок +
+ +Описание, пример вызова + +```bsl + +Функция ОписаниеПрофиляОткрытиеВнешнихОтчетовИОбработок() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеПрофиляОткрытиеВнешнихОтчетовИОбработок() +``` +
+ +## ГруппаДоступаОткрытиеВнешнихОтчетовИОбработок +
+ +Описание, пример вызова + +```bsl + +Функция ГруппаДоступаОткрытиеВнешнихОтчетовИОбработок(СвойстваПрофиля) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ГруппаДоступаОткрытиеВнешнихОтчетовИОбработок(СвойстваПрофиля)); +``` +
+ +## ГруппыПрофиля +
+ +Описание, пример вызова + +```bsl + +Функция ГруппыПрофиля(СсылкаПрофиля, ПометкаУдаления) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ГруппыПрофиля(СсылкаПрофиля, ПометкаУдаления)); +``` +
+ +## ТекстЗапросаГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функция РазрешенныеЗначенияДляДинамическогоСписка, ЕстьОграничениеПоВидуДоступа. +Функция ТекстЗапросаГруппДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаГруппДоступа()); +``` +
+ +## ЗаполнитьПараметры +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьНаборЗаписей, ОбновитьНаборыЗаписей, ОбновитьРегистрСведений. +Процедура ЗаполнитьПараметры(ВходныеПараметры, Знач ВсеПараметры, Знач ОбязательныеПараметры = "") Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПараметры(ВходныеПараметры, ВсеПараметры, ОбязательныеПараметры); +``` +
+ +## ОбъектПодсистемыУправлениеДоступомТолькоДляСозданияНачальногоОбраза +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПриОтправкеДанныхГлавному, ПриОтправкеДанныхПодчиненному, +// ПриПолученииДанныхОтГлавного, ПриПолученииДанныхОтПодчиненного. +// +Функция ОбъектПодсистемыУправлениеДоступомТолькоДляСозданияНачальногоОбраза(ЭлементДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбъектПодсистемыУправлениеДоступомТолькоДляСозданияНачальногоОбраза(ЭлементДанных)); +``` +
+ +## ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПриПолученииДанныхОтГлавного, ПриПолученииДанныхОтПодчиненного +Процедура ПриОтправкеДанных(ЭлементДанных, ОтправкаЭлемента, Подчиненному, СозданиеНачальногоОбраза) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПриОтправкеДанных(ЭлементДанных, ОтправкаЭлемента, Подчиненному, СозданиеНачальногоОбраза)); +``` +
+ +## ПриПолученииДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПриПолученииДанныхОтГлавного, ПриПолученииДанныхОтПодчиненного +Процедура ПриПолученииДанных(ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад, ОтПодчиненного) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПриПолученииДанных(ЭлементДанных, ПолучениеЭлемента, ОтправкаНазад, ОтПодчиненного)); +``` +
+ +## ЗарегистрироватьЗначенияДоступаИзмененныеПриПолученииДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПриПолученииДанныхОтГлавногоИлиОтПодчиненного. +Процедура ЗарегистрироватьЗначенияДоступаИзмененныеПриПолученииДанных(ЭлементДанных) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗарегистрироватьЗначенияДоступаИзмененныеПриПолученииДанных(ЭлементДанных)); +``` +
+ +## ОбновитьВспомогательныеДанныеЭлементовИзмененныхПриПолученииДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПослеПолученияДанных, ПослеОбновленияИнформационнойБазы. +Процедура ОбновитьВспомогательныеДанныеЭлементовИзмененныхПриПолученииДанных() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьВспомогательныеДанныеЭлементовИзмененныхПриПолученииДанных()); +``` +
+ +## ОбработатьИзменениеЗначенийДоступаЗарегистрированноеПриПолученииДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьВспомогательныеДанныеЭлементовИзмененныхПриПолученииДанных. +Процедура ОбработатьИзменениеЗначенийДоступаЗарегистрированноеПриПолученииДанных() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьИзменениеЗначенийДоступаЗарегистрированноеПриПолученииДанных()); +``` +
+ +## ОбработатьЗарегистрированноеИзменениеЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьИзменениеЗначенийДоступаЗарегистрированноеПриПолученииДанных. +Процедура ОбработатьЗарегистрированноеИзменениеЗначенийДоступа(ИмяВидаСсылок, ОчисткаРегистрации) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьЗарегистрированноеИзменениеЗначенийДоступа(ИмяВидаСсылок, ОчисткаРегистрации)); +``` +
+ +## ОбработатьЗарегистрированноеИзменениеИерархииЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьИзменениеЗначенийДоступаЗарегистрированноеПриПолученииДанных. +Процедура ОбработатьЗарегистрированноеИзменениеИерархииЗначенийДоступа(ИмяВидаСсылок, ОчисткаРегистрации) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьЗарегистрированноеИзменениеИерархииЗначенийДоступа(ИмяВидаСсылок, ОчисткаРегистрации)); +``` +
+ +## ОбработатьСвязьПользователяСГруппойДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ВключитьПользователяВГруппуДоступа. +Функция ОбработатьСвязьПользователяСГруппойДоступа(Пользователь, ПоставляемыйПрофиль, Включить = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбработатьСвязьПользователяСГруппойДоступа(Пользователь, ПоставляемыйПрофиль, Включить); +``` +
+ +## ЗаписатьНаборыЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаписатьНаборыЗначенийДоступаПриЗаписи. + +// Перезаписывает наборы значений доступа проверяемого объекта +// в РегистрСведений.НаборыЗначенийДоступа, используя процедуру +// УправлениеДоступом.ЗаполнитьНаборыЗначенийДоступа(). +// +// Процедура вызывается из УправлениеДоступомСлужебный.ЗаписатьНаборыЗначенийДоступа(), +// но может быть вызвана из любого места, например, +// при включении ограничения доступа на уровне записей. +// +// Вызывает процедуру прикладного разработчика +// УправлениеДоступомПереопределяемый.ПриИзмененииНаборовЗначенийДоступа(), +// которая используется для перезаписи зависимых наборов значений доступа. +// +// Параметры: +// Объект - ЛюбаяСсылка +// - ОпределяемыйТип.ВладелецНаборовЗначенийДоступаОбъект - +// В случае вызова с клиента можно передать только ссылку, а нужен объект. +// Если получена ссылка, то по ней будет получен объект. +// ОбновлениеИБ - Булево - если Истина, то необходимо выполнять запись данных, +// не выполняя лишних, избыточных действий с данными. +// См. ОбновлениеИнформационнойБазы.ЗаписатьДанные. +// +Процедура ЗаписатьНаборыЗначенийДоступа(Знач Объект, ЕстьИзменения = Неопределено, ОбновлениеИБ = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьНаборыЗначенийДоступа(Объект, ЕстьИзменения, ОбновлениеИБ); +``` +
+ +## ЗаписатьЗависимыеНаборыЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаписатьЗависимыеНаборыЗначенийДоступаПриЗаписи. + +// Перезаписывает наборы значений доступа зависимых объектов. +// +// Процедура вызывается из УправлениеДоступомСлужебный.ЗаписатьЗависимыеНаборыЗначенийДоступа(), +// состав типов подписки дополняет (без пересечения) состав типов подписки ЗаписатьНаборыЗначенийДоступа, +// теми типами, для которых выполнять запись наборов в регистр сведений НаборыЗначенийДоступа +// не требуется, но сами наборы входят в состав других наборов, например, наборы некоторых файлов +// из справочника "Файлы" могут входить в состав некоторых бизнес-процессов "Задание", созданных +// на основании файлов, при этом наборы файлов записывать в регистр не требуется. +// +// Вызывает процедуру прикладного разработчика +// УправлениеДоступомПереопределяемый.ПриИзмененииНаборовЗначенийДоступа(), +// которая используется для перезаписи зависимых наборов значений доступа, +// то есть организуется рекурсия. +// +// Параметры: +// Объект - ЛюбаяСсылка +// - ОпределяемыйТип.ВладелецНаборовЗначенийДоступаОбъект - +// В случае вызова с клиента можно передать только ссылку, а нужен объект. +// Если получена ссылка, то по ней будет получен объект. +// +// ОбновлениеИБ - Булево - если Истина, то необходимо выполнять запись данных, +// не выполняя лишних, избыточных действий с данными. +// См. ОбновлениеИнформационнойБазы.ЗаписатьДанные. +// +Процедура ЗаписатьЗависимыеНаборыЗначенийДоступа(Знач Объект, ОбновлениеИБ = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьЗависимыеНаборыЗначенийДоступа(Объект, ОбновлениеИБ); +``` +
+ +## ЕстьИзмененияПараметровОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьВспомогательныеДанныеПоИзменениямКонфигурации и +// ЗаполнитьОбработчикиРазделенныхДанных. + +// Проверяет были ли изменения неразделенных данных для какой-нибудь области данных. +Функция ЕстьИзмененияПараметровОграниченияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЕстьИзмененияПараметровОграниченияДоступа()); +``` +
+ +## ПриПодготовкеДополнительныхРолейАдминистратора +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьРолиПользователей. + +// Для тестирования. +// +// Параметры: +// ДополнительныеРоли - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя роли, которую можно назначить администратору. +// * Значение - Булево - Истина. +// +Процедура ПриПодготовкеДополнительныхРолейАдминистратора(ДополнительныеРоли) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПриПодготовкеДополнительныхРолейАдминистратора(ДополнительныеРоли)); +``` +
+ +## ТекущиеСвойстваПользователей +
+ +Описание, пример вызова + +```bsl + +Функция ТекущиеСвойстваПользователей(МассивПользователей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекущиеСвойстваПользователей(МассивПользователей)); +``` +
+ +## ПроверитьАктуальностьНовыхРолейПользователейВСеансе +
+ +Описание, пример вызова + +```bsl + +// Для функции ТекущиеСвойстваПользователей. +Процедура ПроверитьАктуальностьНовыхРолейПользователейВСеансе(ИдентификаторыРолей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьАктуальностьНовыхРолейПользователейВСеансе(ИдентификаторыРолей)); +``` +
+ +## ДобавитьИменаРолей +
+ +Описание, пример вызова + +```bsl + +// Для функции ТекущиеСвойстваПользователей. +Процедура ДобавитьИменаРолей(РолиАдминистратора, ПолныеИменаРолей, ИдентификаторыРолей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьИменаРолей(РолиАдминистратора, ПолныеИменаРолей, ИдентификаторыРолей)); +``` +
+ +## ДобавитьИдентификаторыРолей +
+ +Описание, пример вызова + +```bsl + +// Для функции ТекущиеСвойстваПользователей. +Процедура ДобавитьИдентификаторыРолей(ПолныеИменаРолей, ИдентификаторыРолей, ИменаРолей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьИдентификаторыРолей(ПолныеИменаРолей, ИдентификаторыРолей, ИменаРолей)); +``` +
+ +## ДобавитьИдентификаторыРолейБезОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// Для функции ТекущиеСвойстваПользователей. +Процедура ДобавитьИдентификаторыРолейБезОбъектовМетаданных(БезОбъектовМетаданных, ИдентификаторыРолей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьИдентификаторыРолейБезОбъектовМетаданных(БезОбъектовМетаданных, ИдентификаторыРолей)); +``` +
+ +## ЗаполнитьИдентификаторыРолей +
+ +Описание, пример вызова + +```bsl + +// Для функции ТекущиеСвойстваПользователей. +Процедура ЗаполнитьИдентификаторыРолей(РолиАдминистратора, ИдентификаторыРолей, ИменаРолей = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьИдентификаторыРолей(РолиАдминистратора, ИдентификаторыРолей, ИменаРолей); +``` +
+ +## ПоследниеИдентификаторыРолей +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступомСлужебныйПовтИсп.ИдентификаторыРолейСеанса +Функция ПоследниеИдентификаторыРолей(ИмяПараметра, УжеИзменен = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПоследниеИдентификаторыРолей(ИмяПараметра, УжеИзменен); +``` +
+ +## НовыеНекорректныеРоли +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// НовыеРолиПользователей - ТаблицаЗначений +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// * РольСсылка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// * Роль - Строка - имя роли. +// +Функция НовыеНекорректныеРоли(НовыеРолиПользователей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеНекорректныеРоли(НовыеРолиПользователей)); +``` +
+ +## ДобавитьНекорректнуюРоль +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// НекорректныеРоли - см. НовыеНекорректныеРоли +// ОписаниеРоли - СтрокаТаблицыЗначений +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// +Процедура ДобавитьНекорректнуюРоль(НекорректныеРоли, ОписаниеРоли, Пользователь, ЭтоНенайденнаяРоль) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьНекорректнуюРоль(НекорректныеРоли, ОписаниеРоли, Пользователь, ЭтоНенайденнаяРоль)); +``` +
+ +## ЗарегистрироватьНекорректныеРоли +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// НекорректныеРоли - см. НовыеНекорректныеРоли +// +Процедура ЗарегистрироватьНекорректныеРоли(НекорректныеРоли) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗарегистрироватьНекорректныеРоли(НекорректныеРоли)); +``` +
+ +## ЗаполнитьИменаНенайденныхРолей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗарегистрироватьНекорректныеРоли. +Процедура ЗаполнитьИменаНенайденныхРолей(НекорректныеРоли) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьИменаНенайденныхРолей(НекорректныеРоли)); +``` +
+ +## ЗарегистрироватьНедоступнуюРоль +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьНедоступнуюРоль(ОписаниеРоли, Профиль) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗарегистрироватьНедоступнуюРоль(ОписаниеРоли, Профиль)); +``` +
+ +## ЗарегистрироватьНенайденнуюРоль +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьНенайденнуюРоль(ОписаниеРоли, Профиль) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗарегистрироватьНенайденнуюРоль(ОписаниеРоли, Профиль)); +``` +
+ +## ОбновитьРолиПользователейИБ +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьРолиПользователейИБ(ОбновляемыеПользователиИБ, ПарольПользователяСервиса) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьРолиПользователейИБ(ОбновляемыеПользователиИБ, ПарольПользователяСервиса)); +``` +
+ +## ОтключитьУВсехРасширенийФлажокИспользоватьОсновныеРолиДляВсехПользователей +
+ +Описание, пример вызова + +```bsl + +Процедура ОтключитьУВсехРасширенийФлажокИспользоватьОсновныеРолиДляВсехПользователей() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтключитьУВсехРасширенийФлажокИспользоватьОсновныеРолиДляВсехПользователей()); +``` +
+ +## ПрофилиПользователейСРолями +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// НекорректныеРоли - см. НовыеНекорректныеРоли +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// * РольСсылка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// * Профиль - СправочникСсылка.ПрофилиГруппДоступа +// +Функция ПрофилиПользователейСРолями(НекорректныеРоли) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПрофилиПользователейСРолями(НекорректныеРоли)); +``` +
+ +## ЗаписатьПользователяПриОбновленииРолей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьРолиПользователейИБ. +Процедура ЗаписатьПользователяПриОбновленииРолей(ПользовательСсылка, ПользовательИБ, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьПользователяПриОбновленииРолей(ПользовательСсылка, ПользовательИБ, ); +``` +
+ +## КлючИЗначение +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ТекстЗапросаВыбораИзменений. + +Функция КлючИЗначение(Структура) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КлючИЗначение(Структура)); +``` +
+ +## ЗаписатьОбъектИлиНаборЗаписей +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьНаборЗаписей, ОбновитьНовыеЗаписиНабораПоРазличнымНовымЗаписям. + +Процедура ЗаписатьОбъектИлиНаборЗаписей(Данные, ОбъектИлиНаборЗаписей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьОбъектИлиНаборЗаписей(Данные, ОбъектИлиНаборЗаписей)); +``` +
+ +## ГруппаПараметровИзмеренияОбработана +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьНаборЗаписей и ОбновитьНаборыЗаписей. + +Функция ГруппаПараметровИзмеренияОбработана(ИмяИзмерения, ЗначенияИзмерения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ГруппаПараметровИзмеренияОбработана(ИмяИзмерения, ЗначенияИзмерения)); +``` +
+ +## УпорядочитьГруппыПараметровИзмерений +
+ +Описание, пример вызова + +```bsl + +Процедура УпорядочитьГруппыПараметровИзмерений(Данные) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УпорядочитьГруппыПараметровИзмерений(Данные)); +``` +
+ +## ПоляНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +Функция ПоляНабораЗаписей(НаборЗаписей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПоляНабораЗаписей(НаборЗаписей)); +``` +
+ +## ОбновитьНовыеЗаписиНабораПоВсемНовымЗаписям +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьНовыеЗаписиНабораПоВсемНовымЗаписям(Знач Данные, Знач Отбор, Знач СписокПолей, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьНовыеЗаписиНабораПоВсемНовымЗаписям(Данные, Отбор, СписокПолей, ); +``` +
+ +## ОбновитьНовыеЗаписиНабораПоРазличнымНовымЗаписям +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьНовыеЗаписиНабораПоРазличнымНовымЗаписям(Знач Данные, Знач Отбор, ЕстьИзменения) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьНовыеЗаписиНабораПоРазличнымНовымЗаписям(Данные, Отбор, ЕстьИзменения)); +``` +
+ +## ОбновлятьНаборЗаписейЦеликом +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьНовыеЗаписиНабораПоРазличнымНовымЗаписям. +Функция ОбновлятьНаборЗаписейЦеликом(КоличествоДляЧтения, КлючиЗаписей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбновлятьНаборЗаписейЦеликом(КоличествоДляЧтения, КлючиЗаписей)); +``` +
+ +## ИсключениеПриОшибкеПоискаЗаписи +
+ +Описание, пример вызова + +```bsl + +Процедура ИсключениеПриОшибкеПоискаЗаписи(Параметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ИсключениеПриОшибкеПоискаЗаписи(Параметры)); +``` +
+ +## ЗаблокироватьОбластьНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаблокироватьОбластьНабораЗаписей(НаборЗаписей, ПолноеИмяРегистра = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаблокироватьОбластьНабораЗаписей(НаборЗаписей, ПолноеИмяРегистра); +``` +
+ +## УстановитьОтбор +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьОтбор(ЭлементОтбора, ЗначениеОтбора) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьОтбор(ЭлементОтбора, ЗначениеОтбора)); +``` +
+ +## ЗаписьНесколькимиНаборами +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписьНесколькимиНаборами(Данные, Отбор, ИмяПоля, ЗначенияПоля) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗаписьНесколькимиНаборами(Данные, Отбор, ИмяПоля, ЗначенияПоля)); +``` +
+ +## ПрочитатьКоличествоДляЧтения +
+ +Описание, пример вызова + +```bsl + +Процедура ПрочитатьКоличествоДляЧтения(Данные) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПрочитатьКоличествоДляЧтения(Данные)); +``` +
+ +## УстановитьДополнительныеСвойства +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьДополнительныеСвойства(НаборЗаписей, ДополнительныеСвойства) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьДополнительныеСвойства(НаборЗаписей, ДополнительныеСвойства)); +``` +
+ +## ЗначенияКолонкиТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьРегистрСведений. + +Функция ЗначенияКолонкиТаблицы(Таблица, ИмяКолонки) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗначенияКолонкиТаблицы(Таблица, ИмяКолонки)); +``` +
+ +## ДобавитьРеквизитыВспомогательныхДанныхВФорму +
+ +Описание, пример вызова + +```bsl + +// Обслуживание таблиц ВидыДоступа и ЗначенияДоступа в формах редактирования. + +Процедура ДобавитьРеквизитыВспомогательныхДанныхВФорму(Форма, ИмяРеквизитаХранилищаТаблиц) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьРеквизитыВспомогательныхДанныхВФорму(Форма, ИмяРеквизитаХранилищаТаблиц)); +``` +
+ +## ЗаполнитьТаблицуВсеВидыДоступаВФорме +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьТаблицуВсеВидыДоступаВФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьТаблицуВсеВидыДоступаВФорме(Форма)); +``` +
+ +## ЗаполнитьТаблицуПредставленияВсеРазрешеныВФорме +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьТаблицуПредставленияВсеРазрешеныВФорме(Форма, ЭтоПрофиль) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьТаблицуПредставленияВсеРазрешеныВФорме(Форма, ЭтоПрофиль)); +``` +
+ +## ОформитьТаблицуВидыДоступаВФорме +
+ +Описание, пример вызова + +```bsl + +Процедура ОформитьТаблицуВидыДоступаВФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОформитьТаблицуВидыДоступаВФорме(Форма)); +``` +
+ +## ОформитьТаблицуЗначенияДоступаВФорме +
+ +Описание, пример вызова + +```bsl + +Процедура ОформитьТаблицуЗначенияДоступаВФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОформитьТаблицуЗначенияДоступаВФорме(Форма)); +``` +
+ +## УдалитьЛишниеЗначенияДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура УдалитьЛишниеЗначенияДоступа(Форма, ТекущийОбъект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьЛишниеЗначенияДоступа(Форма, ТекущийОбъект); +``` +
+ +## УдалитьНесуществующиеВидыИЗначенияДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура УдалитьНесуществующиеВидыИЗначенияДоступа(Форма, ТекущийОбъект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьНесуществующиеВидыИЗначенияДоступа(Форма, ТекущийОбъект); +``` +
+ +## ПараметрыФормыРедактированияРазрешенныхЗначений +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыФормыРедактированияРазрешенныхЗначений(Форма, ТекущийОбъект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПараметрыФормыРедактированияРазрешенныхЗначений(Форма, ТекущийОбъект); +``` +
+ +## РеквизитФормыСуществует +
+ +Описание, пример вызова + +```bsl + +Функция РеквизитФормыСуществует(Форма, ИмяРеквизита) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РеквизитФормыСуществует(Форма, ИмяРеквизита)); +``` +
+ +## ПустыеСсылкиЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +Функция ПустыеСсылкиЗначенийДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПустыеСсылкиЗначенийДоступа() +``` +
+ +## ВсеКомбинацииВидовДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановкаПараметровСеанса. + +Функция ВсеКомбинацииВидовДоступа(НеупорядоченныйМассивИмен) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВсеКомбинацииВидовДоступа(НеупорядоченныйМассивИмен)); +``` +
+ +## ГруппыСтрокВСтроку +
+ +Описание, пример вызова + +```bsl + +Функция ГруппыСтрокВСтроку(ГруппыСтрок) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ГруппыСтрокВСтроку(ГруппыСтрок)); +``` +
+ +## НаборыЗначенийДоступаТабличнойЧастиИзменены +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьНаборыЗначенийДоступа, ПриИзмененииНаборовЗначенийДоступа. + +// Проверяет, что наборы в табличной части отличаются от новых наборов. +Функция НаборыЗначенийДоступаТабличнойЧастиИзменены(СсылкаНаОбъект, НовыеНаборы) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НаборыЗначенийДоступаТабличнойЧастиИзменены(СсылкаНаОбъект, НовыеНаборы)); +``` +
+ +## ДобавитьЗапросВПакет +
+ +Описание, пример вызова + +```bsl + +// Для функции РазрешенныеЗначенияДляДинамическогоСписка. +Процедура ДобавитьЗапросВПакет(ТекстПакета, ТекстЗапроса) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗапросВПакет(ТекстПакета, ТекстЗапроса)); +``` +
+ +## ОбъединитьЗапросСЗапросом +
+ +Описание, пример вызова + +```bsl + +// Для функции РазрешенныеЗначенияДляДинамическогоСписка. +Процедура ОбъединитьЗапросСЗапросом(ТекстЗапроса, ДобавляемыйТекстЗапроса) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбъединитьЗапросСЗапросом(ТекстЗапроса, ДобавляемыйТекстЗапроса)); +``` +
+ +## ЗаполненныеВидыДоступаСеанса +
+ +Описание, пример вызова + +```bsl + +// Обновление свойств видов доступа. + +// Для функций ПроверенныеСвойстваВидовДоступаСеанса, ПредставлениеВидовДоступа. +// Смотри также УправлениеДоступомПереопределяемый.ПриЗаполненииВидовДоступа. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Имя - Строка +// * Представление - Строка +// * ТипЗначений - Тип +// * ТипГруппЗначений - Тип +// * НесколькоГруппЗначений - Булево +// * ДополнительныеТипы - см. НоваяТаблицаДополнительныеТипыВидаДоступа +// +Функция ЗаполненныеВидыДоступаСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗаполненныеВидыДоступаСеанса()); +``` +
+ +## НоваяТаблицаДополнительныеТипыВидаДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗаполненныеВидыДоступаСеанса и +// процедуры ДобавитьДополнительныеТипыВидаДоступа общего модуля УправлениеДоступом. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ТипЗначений - Тип +// * ТипГруппЗначений - Тип +// * НесколькоГруппЗначений - Булево +// +Функция НоваяТаблицаДополнительныеТипыВидаДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяТаблицаДополнительныеТипыВидаДоступа() +``` +
+ +## ОбновитьГруппыИНаборыЗначенийДоступаПриИзмененииТиповГруппИЗначений +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПриЗаполненииВсехПараметровРаботыРасширений и +// ОбновитьВспомогательныеДанныеПоИзменениямКонфигурации. +// +Процедура ОбновитьГруппыИНаборыЗначенийДоступаПриИзмененииТиповГруппИЗначений() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьГруппыИНаборыЗначенийДоступаПриИзмененииТиповГруппИЗначений()); +``` +
+ +## СвойстваВидовДоступа +
+ +Описание, пример вызова + +```bsl + +// Смотри УправлениеДоступомПереопределяемый.ПриЗаполненииВидовДоступа. +// Смотри также заполнение в функции ПроверенныеСвойстваВидовДоступаСеанса. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * Массив - ФиксированныйМассив из см. СвойстваВидаДоступа +// * ПоИменам - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Строка +// ** Значение - см. СвойстваВидаДоступа +// * ПоСсылкам - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка +// ** Значение - см. СвойстваВидаДоступа +// * ПоТипамЗначений - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип +// ** Значение - см. СвойстваВидаДоступа +// * ПоТипамГруппИЗначений - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип +// ** Значение - см. СвойстваВидаДоступа +// * ПоТипамЗначенийСИерархией - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип +// ** Значение - см. СвойстваВидаДоступа +// * ЗначенияДоступаСГруппами - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип +// ** Значение - см. ЗначенияДоступаСГруппами +// * БезГруппДляЗначенияДоступа - ФиксированныйМассив из Строка +// * СОднойГруппойДляЗначенияДоступа - ФиксированныйМассив из Строка +// * ТипыЗначенийДоступаСГруппами - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип +// ** Значение - СправочникСсылка +// +Функция СвойстваВидовДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваВидовДоступа() +``` +
+ +## ПроверенныеСвойстваВидовДоступаСеанса +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УправлениеДоступомСлужебныйПовтИсп.ОписаниеСвойствВидовДоступаСеанса. +// Возвращает свойства видов доступа, заполняемых при внедрении в процедуре ПриЗаполненииВидовДоступа +// общего модуля УправлениеДоступомПереопределяемый и одноименных обработчиках этого события. +// +// Смотри также УправлениеДоступомПереопределяемый.ПриЗаполненииВидовДоступа. +// +// Параметры: +// ХешСуммы - см. НовыеХешСуммыСвойствВидовДоступа +// +// Возвращаемое значение: +// см. СвойстваВидовДоступа +// +Функция ПроверенныеСвойстваВидовДоступаСеанса(ХешСуммы) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПроверенныеСвойстваВидовДоступаСеанса(ХешСуммы) +``` +
+ +## НовыеСвойстваВидаДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции СвойстваВидовДоступа. +// +// Возвращаемое значение: +// см. СвойстваВидаДоступа +// +Функция НовыеСвойстваВидаДоступа(ВидДоступа, ПустаяСсылкаТипаЗначений) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеСвойстваВидаДоступа(ВидДоступа, ПустаяСсылкаТипаЗначений)); +``` +
+ +## ЗначенияДоступаСГруппами +
+ +Описание, пример вызова + +```bsl + +// Для функции СвойстваВидовДоступа. +// +// Возвращаемое значение: +// Структура: +// * ПоТипам - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип +// ** Значение - см. СвойстваВидаДоступа +// * ПоТипамСсылок - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип +// ** Значение - см. СвойстваВидаДоступа +// * ИменаТаблицДляОбновления - ФиксированныйМассив из Строка +// * ТипыГруппЗначенийДляОбновления - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип +// ** Значение - СправочникСсылка +// * ПоТипамСсылокДляОбновления - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип +// ** Значение - см. СвойстваВидаДоступа +// +Функция ЗначенияДоступаСГруппами() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗначенияДоступаСГруппами()); +``` +
+ +## ДополнительныйТипВидаДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции СвойстваВидовДоступа. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * ТипЗначений - Тип +// * ТипГруппЗначений - Тип +// * НесколькоГруппЗначений - Булево +// +Функция ДополнительныйТипВидаДоступа(Строка) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ДополнительныйТипВидаДоступа(Строка)); +``` +
+ +## ЗаполнитьЗначенияДоступаСГруппами +
+ +Описание, пример вызова + +```bsl + +// Для функции СвойстваВидовДоступа. +Процедура ЗаполнитьЗначенияДоступаСГруппами(Строка, ЗначенияДоступаСГруппами, Свойства, ТипыВыбираемыхЗначений) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьЗначенияДоступаСГруппами(Строка, ЗначенияДоступаСГруппами, Свойства, ТипыВыбираемыхЗначений)); +``` +
+ +## ДобавитьТипыПодпискиОбновитьГруппыЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции СвойстваВидовДоступа и процедуры ЗаполнитьЗначенияДоступаСГруппами. +Процедура ДобавитьТипыПодпискиОбновитьГруппыЗначенийДоступа(ТипСсылки, ТипОбъекта, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТипыПодпискиОбновитьГруппыЗначенийДоступа(ТипСсылки, ТипОбъекта, ); +``` +
+ +## ПроверитьТипыПодпискиОбновитьГруппыЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции СвойстваВидовДоступа. +Процедура ПроверитьТипыПодпискиОбновитьГруппыЗначенийДоступа(ЗначенияДоступаСГруппами) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьТипыПодпискиОбновитьГруппыЗначенийДоступа(ЗначенияДоступаСГруппами)); +``` +
+ +## ПроверитьТип +
+ +Описание, пример вызова + +```bsl + +// Для функции СвойстваВидовДоступа. +Процедура ПроверитьТип(ВидДоступа, Тип, ВсеТипы, Параметры, ПроверкаТиповГрупп = Ложь, ПроверкаПересечения = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьТип(ВидДоступа, Тип, ВсеТипы, Параметры, ПроверкаТиповГрупп, ПроверкаПересечения); +``` +
+ +## ПредставлениеВидовДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение: +// * Ключ - Тип +// * Значение - Строка +// +Функция ПредставлениеВидовДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПредставлениеВидовДоступа() +``` +
+ +## ПредставлениеВидаДоступа +
+ +Описание, пример вызова + +```bsl + +Функция ПредставлениеВидаДоступа(СвойстваВидаДоступа) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПредставлениеВидаДоступа(СвойстваВидаДоступа) +``` +
+ +## ДобавитьВМассив +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьЗначенияДоступаСГруппами. +Процедура ДобавитьВМассив(Массив, Значение) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВМассив(Массив, Значение)); +``` +
+ +## НовыеХешСуммыСвойствВидовДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функций УправлениеДоступомСлужебныйПовтИсп.ОписаниеСвойствВидовДоступаСеанса, +// СвойстваВидовДоступа и процедур ОбновитьОписаниеСвойствВидовДоступа, +// ОбновитьГруппыИНаборыЗначенийДоступаПриИзмененииТиповГруппИЗначений. +// +// Параметры: +// Значение - Неопределено +// - ФиксированнаяСтруктура +// +// Возвращаемое значение: +// Структура: +// * ХешСумма - Строка +// * ХешСуммаТиповГруппИЗначенийДоступа - Строка +// +Функция НовыеХешСуммыСвойствВидовДоступа(Значение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеХешСуммыСвойствВидовДоступа(Значение); +``` +
+ +## ХешСуммаТиповГруппИЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверенныеСвойстваВидовДоступаСеанса. +Функция ХешСуммаТиповГруппИЗначенийДоступа(СвойстваВидовДоступа) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ХешСуммаТиповГруппИЗначенийДоступа(СвойстваВидовДоступа)); +``` +
+ +## ОписаниеТиповИзКлючейСоответствия +
+ +Описание, пример вызова + +```bsl + +// Для функции ХешСуммаТиповГруппИЗначенийДоступа. +Функция ОписаниеТиповИзКлючейСоответствия(Данные) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеТиповИзКлючейСоответствия(Данные)); +``` +
+ +## ХешСуммаДанных +
+ +Описание, пример вызова + +```bsl + +Функция ХешСуммаДанных(Данные) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ХешСуммаДанных(Данные) +``` +
+ +## ГруппыДоступаИспользующиеИерархиюЗначенийДоступа +
+ +Описание, пример вызова + +```bsl + +Функция ГруппыДоступаИспользующиеИерархиюЗначенийДоступа(ТипЗначенияВидаДоступа) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ГруппыДоступаИспользующиеИерархиюЗначенийДоступа(ТипЗначенияВидаДоступа)); +``` +
+ +## ПостоянныеВидыОграниченийПравОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений, содержащую вид ограничений доступа по каждому праву +// объектов метаданных. +// Если записи по праву нет, значит ограничений по праву нет. +// Таблица содержит только виды доступа, заданные разработчиком, +// исходя из их применения в текстах ограничений. +// В стандартном варианте ограничения доступа для получения видов доступа объектов, +// которые ограничиваются с помощью шаблона ПоНаборамЗначений, используется текущее +// состояние регистра сведений НаборыЗначенийДоступа. Признаком такого ограничения +// является строка, в которой таблица ограничивается по виду ограничения Объект +// с той же ведущей таблицей (кроме случая, когда таблица является владельцем настроек прав). +// +// Параметры: +// ДляПроверки - Булево - вернуть текстовое описание ограничений прав, заполненное +// в переопределяемых модулях без проверки. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ДляВнешнихПользователей - Булево - если Ложь, тогда ограничение для пользователей, +// если Истина, тогда для внешних пользователей. +// Колонка присутствует только для универсального ограничения. +// * ПолноеИмя - Строка - полное имя таблицы. +// * Таблица - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений - идентификатор таблицы. +// * Право - Строка - "Чтение", "Изменение". +// * ВидДоступа - ОпределяемыйТип.ЗначениеДоступа - пустая ссылка основного типа значений вида доступа. +// Неопределено если ограничение с помощью стандартного шаблона ПоНаборамЗначений. +// Перечисление.ДополнительныеЗначенияДоступа.Неопределено для +// специальных ограничений Объект и НастройкиПрав. +// * ЭтоАвторизованныйПользователь - Булево - Истина, если вид доступа Пользователи или ВнешниеПользователи, +// но проверка только с помощью ограничения ФункцияЭтоАвторизованныйПользователь. +// * ТаблицаОбъекта - ЛюбаяСсылка - пустая ссылка объекта, который ограничивается с помощью +// стандартного шаблона ПоНаборамЗначений. +// - Неопределено - если ВидДоступа <> Неопределено. +// Колонка присутствует только для стандартного ограничения. +// +// Строка - когда ДляПроверки равно Истина, тогда ограничения прав, как они добавлены в переопределяемом модуле. +// +Функция ПостоянныеВидыОграниченийПравОбъектовМетаданных(ДляПроверки = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПостоянныеВидыОграниченийПравОбъектовМетаданных(ДляПроверки); +``` +
+ +## ДобавитьВидыОграниченияПрав +
+ +Описание, пример вызова + +```bsl + +// Для функции ПостоянныеВидыОграниченийПравОбъектовМетаданных. +Процедура ДобавитьВидыОграниченияПрав(ВидыОграниченийПрав, ОграниченияПрав, ВидыДоступаПоИменам, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВидыОграниченияПрав(ВидыОграниченийПрав, ОграниченияПрав, ВидыДоступаПоИменам, ); +``` +
+ +## ТипыГруппИЗначенийВидовДоступа +
+ +Описание, пример вызова + +```bsl + +// Только для внутреннего использования. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ВидДоступа - ОпределяемыйТип.ЗначениеДоступа - пустая ссылка +// * ТипГруппИЗначений - ОпределяемыйТип.ЗначениеДоступа - пустая ссылка +// +Функция ТипыГруппИЗначенийВидовДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипыГруппИЗначенийВидовДоступа() +``` +
+ +## ТипыЗначенийВидовДоступаИВладельцевНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Только для внутреннего использования. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ВидДоступа - ЛюбаяСсылка +// * ТипЗначений - ЛюбаяСсылка +// +Функция ТипыЗначенийВидовДоступаИВладельцевНастроекПрав() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипыЗначенийВидовДоступаИВладельцевНастроекПрав() +``` +
+ +## ТипыЗначенийВидовДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции ТипыЗначенийВидовДоступаИВладельцевНастроекПрав. +Функция ТипыЗначенийВидовДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипыЗначенийВидовДоступа()); +``` +
+ +## ВозможныеПраваДляНастройкиПравОбъектов +
+ +Описание, пример вызова + +```bsl + +// Смотри УправлениеДоступомПереопределяемый.ПриЗаполненииВозможныхПравДляНастройкиПравОбъектов. +// Смотри также заполнение в функции РегистрыСведений.НастройкиПравОбъектов.ВозможныеПраваСеанса. +// +// Возвращаемое значение: +// Структура: +// * ПоТипам - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип - тип ссылки или объекта из ОпределяемыйТип.ВладельцыНастроекПрав +// ** Значение - ФиксированноеСоответствие из КлючИЗначение: +// *** Ключ - Строка - имя возможного права +// *** Значение - см. РегистрыСведений.НастройкиПравОбъектов.СвойстваВозможногоПрава +// * ПоТипамСсылок - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип - тип ссылки из ОпределяемыйТип.ВладельцыНастроекПрав +// ** Значение - ФиксированныйМассив из см. РегистрыСведений.НастройкиПравОбъектов.СвойстваВозможногоПрава +// * ПоПолнымИменам - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Строка - владелец прав (полное имя таблицы) +// ** Значение - см. РегистрыСведений.НастройкиПравОбъектов.СвойстваВозможногоПрава +// * ТипыВладельцев - ФиксированныйМассив из ОпределяемыйТип.ВладелецНастроекПрав +// * ОтдельныеТаблицы - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений - идентификатор таблицы +// ** Значение - Строка - полное имя таблицы +// * ИерархическиеТаблицы - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Тип - тип ссылки или объекта из ОпределяемыйТип.ВладельцыНастроекПрав +// ** Значение - Булево - Истина. +// +Функция ВозможныеПраваДляНастройкиПравОбъектов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВозможныеПраваДляНастройкиПравОбъектов() +``` +
+ +## ПоставляемыеПрофили +
+ +Описание, пример вызова + +```bsl + +// Смотри УправлениеДоступомПереопределяемый.ПриЗаполненииПоставляемыхПрофилейГруппДоступа. +// Смотри также заполнение в функции Справочники.ПрофилиГруппДоступа.ПроверенныеПоставляемыеПрофилиСеанса. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * ОписанияПрофилей - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Строка +// ** Значение - см. Справочники.ПрофилиГруппДоступа.СвойстваПоставляемогоПрофиля +// * ОписанияПрофилейМассив - ФиксированныйМассив из см. Справочники.ПрофилиГруппДоступа.СвойстваПоставляемогоПрофиля +// * ПапкиПоРодителям - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Строка +// ** Значение - ФиксированноеСоответствие из КлючИЗначение: +// *** Ключ - Строка +// *** Значение - Булево +// * ПараметрыОбновления - ФиксированнаяСтруктура: +// ** ОбновлятьИзмененныеПрофили - Булево +// ** ЗапретитьИзменениеПрофилей - Булево +// ** ОбновлятьГруппыДоступа - Булево +// ** ОбновлятьГруппыДоступаСУстаревшимиНастройками - Булево +// +Функция ПоставляемыеПрофили() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПоставляемыеПрофили() +``` +
+ +## СтандартныеРолиРасширений +
+ +Описание, пример вызова + +```bsl + +// Смотри заполнение в функции Справочники.ПрофилиГруппДоступа.ПодготовленныеСтандартныеРолиРасширенийСеанса. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * ОбщиеПрава - ФиксированныйМассив из Строка - имена ролей <ПрефиксРасширения>ОбщиеПрава +// * ПолныеПрава - ФиксированныйМассив из Строка - имена ролей <ПрефиксРасширения>ПолныеПрава +// * БазовыеПрава - ФиксированныйМассив из Строка - имена ролей <ПрефиксРасширения>БазовыеПрава +// * БазовыеПраваВнешнихПользователей - ФиксированныйМассив из Строка - имена ролей <ПрефиксРасширения>БазовыеПраваВнешнихПользователей +// * АдминистраторСистемы - ФиксированныйМассив из Строка - имена ролей <ПрефиксРасширения>АдминистраторСистемы +// * Все - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Строка - имя роли расширений, из указанных выше. +// ** Значение - Строка - имя вида ролей (имя свойства структуры). +// * ДополнительныеРолиАдминистратора - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - Строка - имя ролей расширений, которые можно назначить администратору. +// ** Значение - Булево - Истина. +// +Функция СтандартныеРолиРасширений() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтандартныеРолиРасширений() +``` +
+ +## ПроверитьДоступПередЗаписью +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписок ПроверитьДоступПередЗаписью* проверяет доступ к старой версии объекта, проверяет +// изменение полей объектов дополнительных таблиц, присоединенных в ограничениях доступа списков. +// Если изменения найдены, тогда регистрируется необходимость обновления ключей доступа +// для списков, у которых в ограничениях доступа присоединены дополнительные таблицы. +// +// Параметры: +// Источник - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - объект данных, передаваемый в подписку на событие ПередЗаписью. +// +// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// +// РежимЗаписи - РежимЗаписиДокумента - параметр, передаваемый в подписку на событие ПередЗаписью, +// когда Источник это ДокументОбъект. +// +// РежимПроведения - РежимПроведенияДокумента - параметр, передаваемый в подписку на событие ПередЗаписью, +// когда Источник это ДокументОбъект. +// +Процедура ПроверитьДоступПередЗаписью(Источник, Отказ, РежимЗаписи = Неопределено, РежимПроведения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступПередЗаписью(Источник, Отказ, РежимЗаписи, РежимПроведения); +``` +
+ +## ПроверитьДоступПередЗаписьюНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписок ПроверитьДоступПередЗаписьюНабораЗаписей* проверяет доступ к старой версии набора записей, +// проверяет изменение полей наборов записей дополнительных таблиц, присоединенных в ограничениях доступа списков. +// Если изменения найдены, тогда регистрируется необходимость обновления ключей доступа +// для списков, у которых в ограничениях доступа присоединены дополнительные таблицы. +// +// Параметры: +// Источник - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей +// - ПерерасчетНаборЗаписей - набор записей, передаваемый в подписку +// на событие ПередЗаписью. +// +// Отказ - Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// Замещение - РежимЗамещения, Булево - параметр, передаваемый в подписку на событие ПередЗаписью. +// +// ТолькоЗапись - Булево - параметр, передаваемый в подписку на событие ПередЗаписью, +// когда Источник это РегистрРасчетаНаборЗаписей. +// +// ЗаписьФактическогоПериодаДействия - Булево - параметр, передаваемый в подписку на событие ПередЗаписью, +// когда Источник это РегистрРасчетаНаборЗаписей. +// +// ЗаписьПерерасчетов - Булево - параметр, передаваемый в подписку на событие ПередЗаписью, +// когда Источник это РегистрРасчетаНаборЗаписей. +// +Процедура ПроверитьДоступПередЗаписьюНабораЗаписей(Источник, Отказ, Замещение, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступПередЗаписьюНабораЗаписей(Источник, Отказ, Замещение, ); +``` +
+ +## ПроверитьДоступПриЗаписи +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписок ПроверитьДоступПриЗаписи* проверяет устаревание ключа доступа +// новой версии объекта. Обновляет устаревший ключ доступа и, в этом случае, +// выполняет проверку прав Чтение и Изменение новой версии объекта. +// +// Параметры: +// Источник - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - объект данных, передаваемый в подписку на событие ПриЗаписи. +// +// Отказ - Булево - параметр, передаваемый в подписку на событие ПриЗаписи. +// +Процедура ПроверитьДоступПриЗаписи(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступПриЗаписи(Источник, Отказ) +``` +
+ +## ПроверитьДоступПриЗаписиНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписок ПроверитьДоступПриЗаписиНабораЗаписей* проверяет устаревание ключей доступа +// новой версии набора записей. Обновляет устаревшие ключи доступа и, в этом случае, +// выполняет проверку прав Чтение и Изменение новой версии набора записей. +// +// Параметры: +// Источник - РегистрСведенийНаборЗаписей +// - РегистрНакопленияНаборЗаписей +// - РегистрБухгалтерииНаборЗаписей +// - РегистрРасчетаНаборЗаписей +// - ПерерасчетНаборЗаписей - набор записей, передаваемый в подписку +// на событие ПриЗаписи. +// +// Отказ - Булево - параметр, передаваемый в подписку на событие ПриЗаписи. +// Замещение - РежимЗамещения, Булево - параметр, передаваемый в подписку на событие ПриЗаписи. +// +// ТолькоЗапись - Булево - параметр, передаваемый в подписку на событие ПриЗаписи, +// когда Источник это РегистрРасчетаНаборЗаписей. +// +// ЗаписьФактическогоПериодаДействия - Булево - параметр, передаваемый в подписку на событие ПриЗаписи, +// когда Источник это РегистрРасчетаНаборЗаписей. +// +// ЗаписьПерерасчетов - Булево - параметр, передаваемый в подписку на событие ПриЗаписи, +// когда Источник это РегистрРасчетаНаборЗаписей. +// +Процедура ПроверитьДоступПриЗаписиНабораЗаписей(Источник, Отказ, Замещение, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступПриЗаписиНабораЗаписей(Источник, Отказ, Замещение, ); +``` +
+ +## ПроверитьДоступПередУдалением +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписок ПроверитьДоступПередУдалением* проверяет +// изменение полей объектов дополнительных таблиц, присоединенных в ограничениях доступа списков. +// Если изменения найдены, тогда регистрируется необходимость обновления ключей доступа +// для списков, у которых в ограничениях доступа присоединены дополнительные таблицы. +// +// Параметры: +// Источник - СправочникОбъект +// - ДокументОбъект +// - ПланВидовХарактеристикОбъект +// - ПланСчетовОбъект +// - ПланВидовРасчетаОбъект +// - БизнесПроцессОбъект +// - ЗадачаОбъект +// - ПланОбменаОбъект - объект данных, передаваемый в подписку на событие ПередУдалением. +// +// Отказ - Булево - параметр, передаваемый в подписку на событие ПередУдалением. +// +Процедура ПроверитьДоступПередУдалением(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступПередУдалением(Источник, Отказ) +``` +
+ +## ДоступРазрешен +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ОписаниеДанных - см. УправлениеДоступом.ИзменениеРазрешено.ОписаниеДанных +// ПравоИзменение - Булево +// ВызыватьИсключение - Булево +// ПроверитьТолькоСтаруюВерсию - Булево +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// - Неопределено - проверить для текущего пользователя. +// +// Возвращаемое значение: +// Булево +// +Функция ДоступРазрешен(ОписаниеДанных, ПравоИзменение, ВызыватьИсключение = Ложь, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ДоступРазрешен(ОписаниеДанных, ПравоИзменение, ВызыватьИсключение, ); +``` +
+ +## ЧтениеДоступно +
+ +Описание, пример вызова + +```bsl + +// Для функции ДоступРазрешен. +Функция ЧтениеДоступно(ПолноеИмя, ОбъектМетаданных, ОписаниеДанных, ВызыватьИсключение) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЧтениеДоступно(ПолноеИмя, ОбъектМетаданных, ОписаниеДанных, ВызыватьИсключение)); +``` +
+ +## ПраваДоступаКДанным +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступом.ПраваДоступаКДанным +Функция ПраваДоступаКДанным(ОписаниеДанных, ДляВнешнихПользователей, СоставПользователей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПраваДоступаКДанным(ОписаниеДанных, ДляВнешнихПользователей, СоставПользователей) +``` +
+ +## ОтборЗаписейИзОписанияДанных +
+ +Описание, пример вызова + +```bsl + +// Для функций ДоступРазрешен, ЧтениеРазрешено, ПраваДоступаКДанным. +Функция ОтборЗаписейИзОписанияДанных(ОписаниеДанных, ПолноеИмяРегистра, НовыйПустойНаборЗаписей, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОтборЗаписейИзОписанияДанных(ОписаниеДанных, ПолноеИмяРегистра, НовыйПустойНаборЗаписей, ); +``` +
+ +## ПодготовленныйРезультат +
+ +Описание, пример вызова + +```bsl + +// Для функции ПраваДоступаКДанным. +Функция ПодготовленныйРезультат(ПараметрыОграничения, Запрос = Неопределено); Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПодготовленныйРезультат(ПараметрыОграничения, Запрос); +``` +
+ +## ДобавитьЗапросПроверяемыхПользователей +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьЗапросПроверяемыхПользователей(Запрос, ДляВнешнихПользователей, СоставПользователей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗапросПроверяемыхПользователей(Запрос, ДляВнешнихПользователей, СоставПользователей)); +``` +
+ +## ДобавитьЗапросПравПользователейНаТаблицу +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьЗапросПравПользователейНаТаблицу(Запрос, ПараметрыОграничения, ВариантПрав, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗапросПравПользователейНаТаблицу(Запрос, ПараметрыОграничения, ВариантПрав, ); +``` +
+ +## ДобавитьЗапросПроверяемыхОбъектов +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьЗапросПроверяемыхОбъектов(Запрос, ОписаниеДанных, ПараметрыОграничения, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗапросПроверяемыхОбъектов(Запрос, ОписаниеДанных, ПараметрыОграничения, ); +``` +
+ +## ДобавитьЗапросПользователейИзПравНаЭлементыДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьЗапросПользователейИзПравНаЭлементыДанных(Запрос, ПараметрыОграничения, СоставПользователей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗапросПользователейИзПравНаЭлементыДанных(Запрос, ПараметрыОграничения, СоставПользователей)); +``` +
+ +## ДобавитьИтоговыйЗапросПравПользователей +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьИтоговыйЗапросПравПользователей(Запрос, ПараметрыОграничения, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьИтоговыйЗапросПравПользователей(Запрос, ПараметрыОграничения, ); +``` +
+ +## МаксимальнаяДата +
+ +Описание, пример вызова + +```bsl + +// Требуется, как начальная максимальная дата при планировании начального обновления доступа. +// +// Возвращаемое значение: +// Дата +// +Функция МаксимальнаяДата() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МаксимальнаяДата() +``` +
+ +## МаксимальнаяДатаПриПродолжении +
+ +Описание, пример вызова + +```bsl + +// Требуется, как начальная максимальная дата при планировании продолжения обновления доступа. +Функция МаксимальнаяДатаПриПродолжении() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МаксимальнаяДатаПриПродолжении()); +``` +
+ +## ПолноеИмяXML +
+ +Описание, пример вызова + +```bsl + +// Для функции НастройкиВнедрения. +Функция ПолноеИмяXML(ПолноеИмя, ТипыТаблицПоИменам) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПолноеИмяXML(ПолноеИмя, ТипыТаблицПоИменам)); +``` +
+ +## ИмяТипаСсылки +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТипыТребуемыеВОпределяемомТипе. +Функция ИмяТипаСсылки(ПолноеИмя, ТипыТаблицПоИменам) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИмяТипаСсылки(ПолноеИмя, ТипыТаблицПоИменам)); +``` +
+ +## ИмяТипаСсылкиXML +
+ +Описание, пример вызова + +```bsl + +// Для функции НастройкиВнедрения. +Функция ИмяТипаСсылкиXML(ПолноеИмя, ТипыТаблицПоИменам) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИмяТипаСсылкиXML(ПолноеИмя, ТипыТаблицПоИменам)); +``` +
+ +## ИмяТипаОбъектаИлиНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Для функции ДобавитьТипыТребуемыеВОпределяемомТипе. +Функция ИмяТипаОбъектаИлиНабораЗаписей(ПолноеИмя, ТипыТаблицПоИменам) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИмяТипаОбъектаИлиНабораЗаписей(ПолноеИмя, ТипыТаблицПоИменам)); +``` +
+ +## ИмяТипаОбъектаИлиНабораЗаписейXML +
+ +Описание, пример вызова + +```bsl + +// Для функции НастройкиВнедрения. +Функция ИмяТипаОбъектаИлиНабораЗаписейXML(ПолноеИмя, ТипыТаблицПоИменам) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИмяТипаОбъектаИлиНабораЗаписейXML(ПолноеИмя, ТипыТаблицПоИменам)); +``` +
+ +## ДобавитьОбъектКВладельцам +
+ +Описание, пример вызова + +```bsl + +// Для функции НастройкиВнедрения. +Процедура ДобавитьОбъектКВладельцам(ИмяТипаОбъектаXML, ВладельцыЗначенийКлючейДоступа) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьОбъектКВладельцам(ИмяТипаОбъектаXML, ВладельцыЗначенийКлючейДоступа)); +``` +
+ +## ДобавитьОграниченияВРолях +
+ +Описание, пример вызова + +```bsl + +// Для функции НастройкиВнедрения. +Процедура ДобавитьОграниченияВРолях(ПолноеИмяXML, ПолноеИмя, ОграниченияВРолях, СвойстваОграничений, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьОграниченияВРолях(ПолноеИмяXML, ПолноеИмя, ОграниченияВРолях, СвойстваОграничений, Контекст)); +``` +
+ +## ДобавитьТипыИзмерения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьОграниченияВРолях. +Процедура ДобавитьТипыИзмерения(ИмяРегистраКлючей, ОпорныеПоля, ИмяИсходногоРегистра, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТипыИзмерения(ИмяРегистраКлючей, ОпорныеПоля, ИмяИсходногоРегистра, Контекст)); +``` +
+ +## ТипыИзмеренийРегистраКлючей +
+ +Описание, пример вызова + +```bsl + +// Для функции НастройкиВнедрения и процедуры ДобавитьТипыИзмерения. +Функция ТипыИзмеренийРегистраКлючей(ТипыИзмеренийРегистровКлючей, ИмяРегистраКлючей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипыИзмеренийРегистраКлючей(ТипыИзмеренийРегистровКлючей, ИмяРегистраКлючей)); +``` +
+ +## КонстантаПервоеОбновлениеДоступаЗавершилось +
+ +Описание, пример вызова + +```bsl + +// Для функции ОграничиватьДоступНаУровнеЗаписейУниверсально. +Функция КонстантаПервоеОбновлениеДоступаЗавершилось() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КонстантаПервоеОбновлениеДоступаЗавершилось()); +``` +
+ +## ПредварительнаяБлокировкаПередЗаписьюНовогоВФайловойИБ +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьДоступПередЗаписьюИсточника и др. +Процедура ПредварительнаяБлокировкаПередЗаписьюНовогоВФайловойИБ() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПредварительнаяБлокировкаПередЗаписьюНовогоВФайловойИБ()); +``` +
+ +## ПредварительнаяБлокировкаПередЗаписьюСуществующегоВФайловойИБ +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьДоступПередЗаписьюИсточника и др. +Процедура ПредварительнаяБлокировкаПередЗаписьюСуществующегоВФайловойИБ() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПредварительнаяБлокировкаПередЗаписьюСуществующегоВФайловойИБ()); +``` +
+ +## ПроверитьДоступПередЗаписьюИсточника +
+ +Описание, пример вызова + +```bsl + +// Для обработчиков подписок на событие ПередЗаписью. +Процедура ПроверитьДоступПередЗаписьюИсточника(Источник, Отказ, ЭтоНаборЗаписей, Замещение) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступПередЗаписьюИсточника(Источник, Отказ, ЭтоНаборЗаписей, Замещение)); +``` +
+ +## ПроверитьДоступПриЗаписиИсточника +
+ +Описание, пример вызова + +```bsl + +// Для обработчиков подписок на событие ПриЗаписи. +Процедура ПроверитьДоступПриЗаписиИсточника(Источник, Отказ, ЭтоНаборЗаписей, Замещение) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступПриЗаписиИсточника(Источник, Отказ, ЭтоНаборЗаписей, Замещение)); +``` +
+ +## ПроверитьДоступПередУдалениемИсточника +
+ +Описание, пример вызова + +```bsl + +// Для обработчиков подписок на событие ПередУдалением. +Процедура ПроверитьДоступПередУдалениемИсточника(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступПередУдалениемИсточника(Источник, Отказ)); +``` +
+ +## ПропуститьПроверкуДоступа +
+ +Описание, пример вызова + +```bsl + + +// Для процедур ПроверитьДоступПередЗаписьюИсточника, ПроверитьДоступПриЗаписиИсточника. +Функция ПропуститьПроверкуДоступа(Отказ, Источник) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПропуститьПроверкуДоступа(Отказ, Источник)); +``` +
+ +## ЗапомнитьДанныеВлияющиеНаЗависимыеКлючиДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступПередЗаписьюИсточника. +Процедура ЗапомнитьДанныеВлияющиеНаЗависимыеКлючиДоступа(Источник, ЭтоНаборЗаписей, Замещение) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапомнитьДанныеВлияющиеНаЗависимыеКлючиДоступа(Источник, ЭтоНаборЗаписей, Замещение)); +``` +
+ +## ОтборПоИзмерениямНабораЗаписей +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗапомнитьДанныеВлияющиеНаЗависимыеКлючиДоступа, ОбновитьКлючиДоступаКНаборуЗаписей и +// функций ДоступРазрешен, ЧтениеДоступно. +// +Функция ОтборПоИзмерениямНабораЗаписей(НаборЗаписей, Запрос, Замещение = Неопределено, ЗапросНовыхКомбинаций = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОтборПоИзмерениямНабораЗаписей(НаборЗаписей, Запрос, Замещение, ЗапросНовыхКомбинаций); +``` +
+ +## УстановитьРазрешенныйКлючДоступаДляНовогоОбъекта +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступПередЗаписьюИсточника. +Процедура УстановитьРазрешенныйКлючДоступаДляНовогоОбъекта(Источник, ЭтоПолноправныйПользователь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьРазрешенныйКлючДоступаДляНовогоОбъекта(Источник, ЭтоПолноправныйПользователь)); +``` +
+ +## ПроверитьДоступКИсточнику +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьДоступПередЗаписьюИсточника, ПроверитьДоступПриЗаписиИсточника. +Процедура ПроверитьДоступКИсточнику(Источник, ПередЗаписью, ЭтоНаборЗаписей, Замещение, ЭтоПолноправныйПользователь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступКИсточнику(Источник, ПередЗаписью, ЭтоНаборЗаписей, Замещение, ЭтоПолноправныйПользователь)); +``` +
+ +## ПараметрыОграниченияПриПроверкеДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступКИсточнику. +// +// Возвращаемое значение: +// см. РассчитанныеПараметрыОграничения +// +Функция ПараметрыОграниченияПриПроверкеДоступа(Источник, ПолноеИмя, ИдентификаторТранзакции) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПараметрыОграниченияПриПроверкеДоступа(Источник, ПолноеИмя, ИдентификаторТранзакции)); +``` +
+ +## ПроверитьДоступКОбъекту +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступКИсточнику. +Процедура ПроверитьДоступКОбъекту(Источник, ПередЗаписью, ЭтоПолноправныйПользователь, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступКОбъекту(Источник, ПередЗаписью, ЭтоПолноправныйПользователь, ); +``` +
+ +## УточнитьПравоДобавление +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступКОбъекту и функции ДоступРазрешен. +Процедура УточнитьПравоДобавление(Запрос, ЭтоНовый, ПараметрыОграничения, ПроверкаДобавления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УточнитьПравоДобавление(Запрос, ЭтоНовый, ПараметрыОграничения, ПроверкаДобавления)); +``` +
+ +## ОбновитьКлючДоступаОбъектаПриЗаписи +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступКОбъекту. +Процедура ОбновитьКлючДоступаОбъектаПриЗаписи(Источник, ЭтоНовый, ИдентификаторТранзакции, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьКлючДоступаОбъектаПриЗаписи(Источник, ЭтоНовый, ИдентификаторТранзакции, ); +``` +
+ +## РезультатЗапросаПроверкиДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьДоступКОбъекту, ПроверитьДоступКНаборуЗаписей. +Функция РезультатЗапросаПроверкиДоступа(Запрос, Источник) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РезультатЗапросаПроверкиДоступа(Запрос, Источник)); +``` +
+ +## ПроверитьДоступКНаборуЗаписей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступКИсточнику. +Процедура ПроверитьДоступКНаборуЗаписей(Источник, ПередЗаписью, Замещение, ЭтоПолноправныйПользователь, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьДоступКНаборуЗаписей(Источник, ПередЗаписью, Замещение, ЭтоПолноправныйПользователь, ); +``` +
+ +## ОбновитьКлючиДоступаКНаборуЗаписей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступКНаборуЗаписей и для функции ДоступРазрешен. +Процедура ОбновитьКлючиДоступаКНаборуЗаписей(Источник, ПередЗаписью, Замещение, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьКлючиДоступаКНаборуЗаписей(Источник, ПередЗаписью, Замещение, ); +``` +
+ +## ЗаписатьКлючиДоступаНовыхКомбинацийЗначенийОпорныхПолейПередЗаписью +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступПередЗаписьюИсточника. +Процедура ЗаписатьКлючиДоступаНовыхКомбинацийЗначенийОпорныхПолейПередЗаписью(Источник, Замещение, ЭтоПолноправныйПользователь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьКлючиДоступаНовыхКомбинацийЗначенийОпорныхПолейПередЗаписью(Источник, Замещение, ЭтоПолноправныйПользователь)); +``` +
+ +## КомбинацииЗначенийОпорныхПолей +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьДоступКНаборуЗаписей, +// ЗаписатьКлючиДоступаНовыхКомбинацийЗначенийОпорныхПолейПередЗаписью. +// +Функция КомбинацииЗначенийОпорныхПолей(Источник, ОтборПоИзмерениям, ПараметрыОграничения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КомбинацииЗначенийОпорныхПолей(Источник, ОтборПоИзмерениям, ПараметрыОграничения)); +``` +
+ +## ОбновитьКлючиДоступаНовыхКомбинацийЗначенийОпорныхПолей +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьДоступКНаборуЗаписей, +// ЗаписатьКлючиДоступаНовыхКомбинацийЗначенийОпорныхПолейПередЗаписью. +// +Процедура ОбновитьКлючиДоступаНовыхКомбинацийЗначенийОпорныхПолей(ЗапросНовыхКомбинаций, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьКлючиДоступаНовыхКомбинацийЗначенийОпорныхПолей(ЗапросНовыхКомбинаций, ); +``` +
+ +## ЭлементыДанныхНовыхКомбинацийЗначенийОпорныхПолей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьКлючиДоступаНовыхКомбинацийЗначенийОпорныхПолей. +Функция ЭлементыДанныхНовыхКомбинацийЗначенийОпорныхПолей(ЗапросНовыхКомбинаций, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭлементыДанныхНовыхКомбинацийЗначенийОпорныхПолей(ЗапросНовыхКомбинаций, ); +``` +
+ +## СообщитьОбОшибкеДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьДоступКОбъекту, ПроверитьДоступКНаборуЗаписей. +Процедура СообщитьОбОшибкеДоступа(Данные, СтараяВерсия, ЕстьПравоЧтения, ЕстьПравоИзменения, ЭтоНовый) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СообщитьОбОшибкеДоступа(Данные, СтараяВерсия, ЕстьПравоЧтения, ЕстьПравоИзменения, ЭтоНовый)); +``` +
+ +## ПредставлениеДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедуры СообщитьОбОшибкеДоступа. +Функция ПредставлениеДанных(Данные) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПредставлениеДанных(Данные)); +``` +
+ +## КлючДоступаИсточникаУстарел +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступКОбъекту и формы ОбновлениеДоступаРучноеУправление. +// +// Возвращаемое значение: +// Булево +// +Функция КлючДоступаИсточникаУстарел(СсылкаНаОбъект, ПараметрыОграничения, Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КлючДоступаИсточникаУстарел(СсылкаНаОбъект, ПараметрыОграничения, Источник); +``` +
+ +## ОбновитьКлючиДоступаЭлементовДанныхПриЗаписи +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьДоступКОбъекту, ПроверитьДоступКНаборуЗаписей и формы ОбновлениеДоступаРучноеУправление. +Процедура ОбновитьКлючиДоступаЭлементовДанныхПриЗаписи(ОписаниеЭлементовДанных, ПараметрыОграничения, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьКлючиДоступаЭлементовДанныхПриЗаписи(ОписаниеЭлементовДанных, ПараметрыОграничения, ); +``` +
+ +## ЗапланироватьОбновлениеЗависимыхСписковПоЗначениямСГруппами +
+ +Описание, пример вызова + +```bsl + +// Для регистра сведений ГруппыЗначенийДоступа. +Процедура ЗапланироватьОбновлениеЗависимыхСписковПоЗначениямСГруппами(ЗначенияСИзменениямиПоТипам) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеЗависимыхСписковПоЗначениямСГруппами(ЗначенияСИзменениямиПоТипам) +``` +
+ +## ДобавитьСпискиДляОбновленияДляВидаПользователей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗапланироватьОбновлениеЗависимыхСписковПоЗначениямСГруппами. +Процедура ДобавитьСпискиДляОбновленияДляВидаПользователей(СпискиДляОбновления, ПоЗначениямСГруппами, ИмяВидаПользователей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСпискиДляОбновленияДляВидаПользователей(СпискиДляОбновления, ПоЗначениямСГруппами, ИмяВидаПользователей)); +``` +
+ +## ЗапланироватьОбновлениеУстаревшихКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗапланироватьОбновлениеЗависимыхУстаревшихКлючейДоступа, ЗаписатьКлючиДоступаОбъектов, +// ЗапланироватьОбновлениеЗависимыхСписковПоЗначениямСГруппами. +// +Процедура ЗапланироватьОбновлениеУстаревшихКлючейДоступа(СпискиДляОбновления, ИдентификаторТранзакции, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеУстаревшихКлючейДоступа(СпискиДляОбновления, ИдентификаторТранзакции, ); +``` +
+ +## ЗапланироватьОбновлениеЗависимыхУстаревшихКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьДоступПриЗаписиИсточника, ПроверитьДоступПередУдалениемИсточника. +Процедура ЗапланироватьОбновлениеЗависимыхУстаревшихКлючейДоступа(Источник, ЭтоНаборЗаписей, Удаление) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеЗависимыхУстаревшихКлючейДоступа(Источник, ЭтоНаборЗаписей, Удаление)); +``` +
+ +## ОписаниеВедущегоОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ПоЗначениямПолей - Структура: +// ** Описание - ЛюбаяСсылка +// - Отбор +// ** ИзмененнаяТаблица - Строка - полное имя списка +// ** СоставИзменений - см. СоставИзмененийТаблицы +// * ПоКлючамДоступа - СправочникСсылка.КлючиДоступа +// * ПоЗначениямСГруппами - ОпределяемыйТип.ЗначениеДоступа - только значения доступа с группами. +// * ПоДаннымКэшаРасчетаПрав - Строка - наименование данных для кэша расчета прав. +// +Функция ОписаниеВедущегоОбъекта() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеВедущегоОбъекта()); +``` +
+ +## НовыеЗначенияТабличнойЧасти +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗапланироватьОбновлениеЗависимыхУстаревшихКлючейДоступа. +Функция НовыеЗначенияТабличнойЧасти(Источник, ОписаниеТабличнойЧасти, Удаление) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеЗначенияТабличнойЧасти(Источник, ОписаниеТабличнойЧасти, Удаление)); +``` +
+ +## ЗапланироватьОбновлениеЗависимыхУстаревшихКлючейДоступаПоЗначениямПолей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗапланироватьОбновлениеЗависимыхУстаревшихКлючейДоступа. +Процедура ЗапланироватьОбновлениеЗависимыхУстаревшихКлючейДоступаПоЗначениямПолей(РезультатЗапроса, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеЗависимыхУстаревшихКлючейДоступаПоЗначениямПолей(РезультатЗапроса, ); +``` +
+ +## СоставИзмененийТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗапланироватьОбновлениеЗависимыхУстаревшихКлючейДоступаПоЗначениямПолей. +// +// Возвращаемое значение: +// ТаблицаЗначений +// +Функция СоставИзмененийТаблицы(РезультатЗапроса, Источник, Поля) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СоставИзмененийТаблицы(РезультатЗапроса, Источник, Поля)); +``` +
+ +## ПроверитьОбъектыНастроекДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьТаблицыГруппДоступаДляПодключенныхРасширений. +Процедура ПроверитьОбъектыНастроекДоступа() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьОбъектыНастроекДоступа()); +``` +
+ +## УстановитьРазделяемуюБлокировку +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьОбъектыНастроекДоступа. +Процедура УстановитьРазделяемуюБлокировку(ИмяТаблицы) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьРазделяемуюБлокировку(ИмяТаблицы)); +``` +
+ +## ЗаблокироватьРегистрыПланированияОбновленияКлючейДоступаВФайловойИБ +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаблокироватьРегистрыПланированияОбновленияКлючейДоступаВФайловойИБ(ЭтоОшибкаБлокировки = Ложь, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаблокироватьРегистрыПланированияОбновленияКлючейДоступаВФайловойИБ(ЭтоОшибкаБлокировки, ); +``` +
+ +## ЗапланироватьОбновлениеДоступаПриИзмененииУчастниковГруппыДоступа +
+ +Описание, пример вызова + +```bsl + +// Для вызова и модуля менеджера справочника ГруппыДоступа. +Процедура ЗапланироватьОбновлениеДоступаПриИзмененииУчастниковГруппыДоступа(ГруппыДоступа, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеДоступаПриИзмененииУчастниковГруппыДоступа(ГруппыДоступа, ); +``` +
+ +## ЗапланироватьОбновлениеДоступаПриКосвенномИзмененииУчастниковГруппыДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПослеОбновленияСоставовГруппПользователей и +// модуля менеджера справочника ГруппыДоступа. +// +Процедура ЗапланироватьОбновлениеДоступаПриКосвенномИзмененииУчастниковГруппыДоступа(ИзмененныеУчастники, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеДоступаПриКосвенномИзмененииУчастниковГруппыДоступа(ИзмененныеУчастники, ); +``` +
+ +## ЗапланироватьОбновлениеДоступаПриИзмененииТаблицГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Для вызова из модуля менеджера регистра ТаблицыГруппДоступа. +Процедура ЗапланироватьОбновлениеДоступаПриИзмененииТаблицГруппДоступа(Таблицы) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеДоступаПриИзмененииТаблицГруппДоступа(Таблицы) +``` +
+ +## ЗапланироватьОбновлениеДоступаПриИзмененииРолейПрофиля +
+ +Описание, пример вызова + +```bsl + +// Для вызова из модуля объекта и модуля менеджера справочника ПрофилиГруппДоступа. +Процедура ЗапланироватьОбновлениеДоступаПриИзмененииРолейПрофиля(Описание, ИзмененныеРоли) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеДоступаПриИзмененииРолейПрофиля(Описание, ИзмененныеРоли) +``` +
+ +## ЗапланироватьОбновлениеДоступаПриИзмененииПрофиляГруппыДоступа +
+ +Описание, пример вызова + +```bsl + +// Для вызова из модуля объекта и модуля менеджера справочника ГруппыДоступа. +Процедура ЗапланироватьОбновлениеДоступаПриИзмененииПрофиляГруппыДоступа(Описание, ИзмененныеРоли, ПрофильИзменен) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеДоступаПриИзмененииПрофиляГруппыДоступа(Описание, ИзмененныеРоли, ПрофильИзменен) +``` +
+ +## ЗапланироватьОбновлениеДоступаПриИзмененииРолей +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗапланироватьОбновлениеДоступаПриИзмененииРолейПрофиля и +// ЗапланироватьОбновлениеДоступаПриИзмененииПрофиляГруппыДоступа. +// +Процедура ЗапланироватьОбновлениеДоступаПриИзмененииРолей(Описание, ИзмененныеРоли) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеДоступаПриИзмененииРолей(Описание, ИзмененныеРоли)); +``` +
+ +## ДобавитьСпискиВедущейРолиДляОбновленияПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗапланироватьОбновлениеДоступаПриИзмененииРолей. +Процедура ДобавитьСпискиВедущейРолиДляОбновленияПрав(Списки, СпискиВедущейРоли, ДобавленныеСписки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСпискиВедущейРолиДляОбновленияПрав(Списки, СпискиВедущейРоли, ДобавленныеСписки)); +``` +
+ +## ЗапланироватьОбновлениеДоступаПриИзмененииРазрешенныхЗначений +
+ +Описание, пример вызова + +```bsl + +// Для вызова из модуля менеджера регистра ЗначенияГруппДоступа. +Процедура ЗапланироватьОбновлениеДоступаПриИзмененииРазрешенныхЗначений(ГруппыДоступаИТипыЗначений) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеДоступаПриИзмененииРазрешенныхЗначений(ГруппыДоступаИТипыЗначений) +``` +
+ +## СлужебныйИдентификатор +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗапланироватьОбновлениеДоступа, ЗапланироватьОбновлениеПараметровОграниченияДоступа. +Функция СлужебныйИдентификатор(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СлужебныйИдентификатор(ПолноеИмя)); +``` +
+ +## ЗапланироватьОбновлениеПользователейКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗапланироватьОбновлениеДоступаПриИзмененииУчастниковГруппыДоступа, +// ЗапланироватьОбновлениеДоступаПриКосвенномИзмененииУчастниковГруппыДоступа, +// ЗапланироватьОбновлениеДоступаПриИзмененииТаблицГруппДоступа, +// ЗапланироватьОбновлениеДоступаПриИзмененииРазрешенныхЗначений. +// +Процедура ЗапланироватьОбновлениеПользователейКлючейДоступа(ОписаниеСписков, Описание, ДляПользователей, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеПользователейКлючейДоступа(ОписаниеСписков, Описание, ДляПользователей, ); +``` +
+ +## ТребуетсяОбновлениеПользователейКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗапланироватьОбновлениеПользователейКлючейДоступа. +Функция ТребуетсяОбновлениеПользователейКлючейДоступа(Контекст, ДляВнешнихПользователей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТребуетсяОбновлениеПользователейКлючейДоступа(Контекст, ДляВнешнихПользователей)); +``` +
+ +## ЗапланироватьОбновлениеНаборовГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗапланироватьОбновлениеДоступаПриКосвенномИзмененииУчастниковГруппыДоступа и +// модулей менеджера и объекта справочника ГруппыДоступа. +// +Процедура ЗапланироватьОбновлениеНаборовГруппДоступа(Описание, ДляПользователей = Истина, ДляВнешнихПользователей = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеНаборовГруппДоступа(Описание, ДляПользователей, ДляВнешнихПользователей); +``` +
+ +## ЗапланироватьОбновлениеКэшаРасчетаПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗапланироватьОбновлениеДоступаПриИзмененииУчастниковГруппыДоступа, +// ЗапланироватьОбновлениеДоступаПриКосвенномИзмененииУчастниковГруппыДоступа, +// ЗапланироватьОбновлениеДоступаПриИзмененииТаблицГруппДоступа, +// ЗапланироватьОбновлениеДоступаПриИзмененииРазрешенныхЗначений. +// +Процедура ЗапланироватьОбновлениеКэшаРасчетаПрав(Описание, ИмяИзмененныхДанных) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеКэшаРасчетаПрав(Описание, ИмяИзмененныхДанных)); +``` +
+ +## СписокДляПланированияОбновленияКэшаРасчетаПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПодготовитьПланОбновления, ЗапланироватьОбновлениеКэшаРасчетаПрав +// и функции ВерсияДанныхДляКэшаРасчетаПрав. +// +Функция СписокДляПланированияОбновленияКэшаРасчетаПрав() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СписокДляПланированияОбновленияКэшаРасчетаПрав()); +``` +
+ +## НоваяВерсияДанныхДляКэшаРасчетаПрав +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ТаблицыГруппДоступа - Строка +// - Неопределено +// * ЗначенияГруппДоступа - Строка +// - Неопределено +// * УчастникиГруппДоступа - Строка +// - Неопределено +// * СоставыГруппПользователей - Строка +// - Неопределено +// * РолиПрофилейГруппДоступа - Строка +// - Неопределено +// * ГруппыДоступаПрофилей - Строка +// - Неопределено +// +Функция НоваяВерсияДанныхДляКэшаРасчетаПрав(Версия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяВерсияДанныхДляКэшаРасчетаПрав(Версия); +``` +
+ +## ИмяПараметраВерсииДанныхДляКэшаРасчетаПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьПланОбновленияКэшаРасчетаПрав. +Функция ИмяПараметраВерсииДанныхДляКэшаРасчетаПрав() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИмяПараметраВерсииДанныхДляКэшаРасчетаПрав()); +``` +
+ +## ЕстьЗапланированныеТочечныеЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗапуститьОбновлениеДоступа. +Функция ЕстьЗапланированныеТочечныеЗадания() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЕстьЗапланированныеТочечныеЗадания()); +``` +
+ +## ЗапуститьОбновлениеДоступаНаУровнеЗаписей +
+ +Описание, пример вызова + +```bsl + +// Запускает фоновое задание обновления доступа вместо регламентного задания. +// +// Параметры: +// ЭтоЗапускВручную - Булево - если передать Ложь, то наименование будет начинаться с "Автозапуск", +// в противном случае, наименование будет начинаться с "Запуск вручную", +// блокировка обновления доступа будет снята, если была установлена, +// выполнение будет продолжаться до полного завершения. +// ЭтоПерезапуск - Булево - если передать Истина, тогда текущий сеанс фонового задания не будет +// считаться незавершенным исполнителем. +// ДляУскорения - Булево - если передать Истина, тогда признак передается в процедуру обновления доступа, +// чтобы прекратить обновление, когда точечных заданий нет и функция +// ЗапускатьОбновлениеДоступаДляУскоренияТолькоТочечныхЗаданий возвращает Истина. +// +// Возвращаемое значение: +// - Неопределено - обновление доступа не требуется или запрещено. +// - Структура: +// * УжеВыполняется - Булево - если обновление уже выполняется. +// +// * ИдентификаторФоновогоЗадания - Неопределено - если обновление не выполняется или +// выполняется не в фоновом задании. +// - УникальныйИдентификатор - идентификатор фонового задания. +// +// * СвойстваСеанса - Неопределено - если запуска не было или фоновое задание только добавлено в очередь. +// - Структура - со свойствами сеанса, если обновление уже выполняется: +// ** ИмяКомпьютера - Строка - одноименное свойства объекта СеансИнформационнойБазы. +// ** НомерСеанса - Число - одноименное свойства объекта СеансИнформационнойБазы. +// ** НачалоСеанса - Строка - одноименное свойства объекта СеансИнформационнойБазы. +// +// * ТекстПредупреждения - Неопределено - если запуска не было или запущено новое фоновое задание. +// - Строка - описание, что обновление доступа уже запущено. +// +Функция ЗапуститьОбновлениеДоступаНаУровнеЗаписей(ЭтоЗапускВручную = Ложь, ЭтоПерезапуск = Ложь, ДляУскорения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗапуститьОбновлениеДоступаНаУровнеЗаписей(ЭтоЗапускВручную, ЭтоПерезапуск, ДляУскорения); +``` +
+ +## ОтменитьОбновлениеДоступаНаУровнеЗаписей +
+ +Описание, пример вызова + +```bsl + +// Отменить обновление доступа, которое выполняется в фоновом задании. +Процедура ОтменитьОбновлениеДоступаНаУровнеЗаписей() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтменитьОбновлениеДоступаНаУровнеЗаписей() +``` +
+ +## ВключитьРегламентноеЗаданиеОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьОбновлениеДоступа. +Процедура ВключитьРегламентноеЗаданиеОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВключитьРегламентноеЗаданиеОбновленияДоступа() +``` +
+ +## ОтключитьРегламентноеЗаданиеОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьОбновлениеДоступа. +Процедура ОтключитьРегламентноеЗаданиеОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтключитьРегламентноеЗаданиеОбновленияДоступа() +``` +
+ +## ИзменитьРегламентноеЗаданиеОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьОбновлениеДоступа. +Процедура ИзменитьРегламентноеЗаданиеОбновленияДоступа(ВключитьЗадание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ИзменитьРегламентноеЗаданиеОбновленияДоступа(ВключитьЗадание)); +``` +
+ +## УстановитьЗапретОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Включает или отключает запрет обновления доступа при запуске +// с помощью регламентного задания или при программном запуске. +// +// При вызове процедуры ОбновлениеДоступаНаУровнеЗаписей +// с признаком ОбновитьВсе запрет игнорируется. +// +// При вызове процедуры ЗапуститьОбновлениеДоступаНаУровнеЗаписей +// с признаком ЭтоЗапускВручную запрет снимается автоматически. +// +Процедура УстановитьЗапретОбновленияДоступа(Использование, ОтменитьОбновление = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьЗапретОбновленияДоступа(Использование, ОтменитьОбновление); +``` +
+ +## СекундОжиданияЗавершенияФоновогоЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОтменитьОбновлениеДоступаНаУровнеЗаписей, УстановитьЗапретОбновленияДоступа. +Функция СекундОжиданияЗавершенияФоновогоЗадания() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СекундОжиданияЗавершенияФоновогоЗадания()); +``` +
+ +## ОбновлениеДоступаНаУровнеЗаписей +
+ +Описание, пример вызова + +```bsl + +// Обработчик регламентного задания ОбновлениеДоступаНаУровнеЗаписей. +Процедура ОбновлениеДоступаНаУровнеЗаписей(ОбновитьВсе = Ложь, ВызыватьИсключениеВместоРегистрацииОшибки = Ложь, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновлениеДоступаНаУровнеЗаписей(ОбновитьВсе, ВызыватьИсключениеВместоРегистрацииОшибки, ); +``` +
+ +## НовыеДополнительныеПараметрыОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Только для внутреннего использования. +// +// Возвращаемое значение: +// Структура: +// * ДляУскорения - Булево +// * ЭтоПерезапуск - Булево +// +Функция НовыеДополнительныеПараметрыОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеДополнительныеПараметрыОбновленияДоступа()); +``` +
+ +## ВыполнитьОбновлениеДоступаНаУровнеЗаписей +
+ +Описание, пример вызова + +```bsl + +// Выполняет обновление доступа, если запланировано. +Процедура ВыполнитьОбновлениеДоступаНаУровнеЗаписей(ОбновитьВсе, ВызыватьИсключениеВместоРегистрацииОшибки, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВыполнитьОбновлениеДоступаНаУровнеЗаписей(ОбновитьВсе, ВызыватьИсключениеВместоРегистрацииОшибки, ); +``` +
+ +## ОписаниеОсновногоСеанса +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ИдентификаторФоновогоЗадания - УникальныйИдентификатор +// * ФоновоеЗадание - ФоновоеЗадание +// * НомерСеанса - Число +// * НачалоСеанса - Дата +// * Идентификатор - Строка - представление сеанса +// +Функция ОписаниеОсновногоСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеОсновногоСеанса()); +``` +
+ +## ЗапланированоОбновлениеДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗапуститьОбновлениеДоступаНаУровнеЗаписей. +Функция ЗапланированоОбновлениеДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗапланированоОбновлениеДоступа()); +``` +
+ +## ПоследнееОбновлениеДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗапуститьОбновлениеДоступаНаУровнеЗаписей и +// процедур ОбновлениеДоступаНаУровнеЗаписей, ОтменитьОбновлениеДоступаНаУровнеЗаписей и +// формы ОбновлениеДоступаНаУровнеЗаписей. +// +// Возвращаемое значение: +// Структура: +// * ДатаЗапускаНаСервере - Дата +// * ДатаЗавершенияНаСервере - Дата +// * ОбновлениеОтменено - Булево +// * ПоследнееВыполнениеСекунд - Число +// * ДатаПолногоЗавершения - Дата +// * ТекстОшибкиЗавершения - Строка +// * НомерСеанса - Число +// * ИмяКомпьютера - Строка +// * ОбновлениеДоступаЗапрещено - Булево +// * БалансировкаНагрузкиНаДиск - Булево +// * ИдентификаторФоновогоЗадания - УникальныйИдентификатор +// * ПоследнееПланированиеОбработкиУстаревшихЭлементов - Дата +// +Функция ПоследнееОбновлениеДоступа(ТекущееЗначение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПоследнееОбновлениеДоступа(ТекущееЗначение); +``` +
+ +## УстановитьПоследнееОбновлениеДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ВыполнитьОбновлениеДоступаНаУровнеЗаписей, +// УстановитьЗапретОбновленияДоступа и УстановитьБалансировкуНагрузкиНаДиск. +// +Процедура УстановитьПоследнееОбновлениеДоступа(Свойства, ЕстьВнешняяТранзакция) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьПоследнееОбновлениеДоступа(Свойства, ЕстьВнешняяТранзакция)); +``` +
+ +## ОчиститьПоследнееОбновлениеДоступа +
+ +Описание, пример вызова + +```bsl + +// Для константы ОграничиватьДоступНаУровнеЗаписейУниверсально. +Процедура ОчиститьПоследнееОбновлениеДоступа() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОчиститьПоследнееОбновлениеДоступа() +``` +
+ +## ИсполнительОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗапуститьОбновлениеДоступаНаУровнеЗаписей и +// процедур ОбновлениеДоступаНаУровнеЗаписей, ОтменитьОбновлениеДоступаНаУровнеЗаписей и +// формы ОбновлениеДоступаНаУровнеЗаписей. +// +// Параметры: +// ПоследнееОбновлениеДоступа - см. ПоследнееОбновлениеДоступа +// ИдентификаторИсключаемогоЗадания - УникальныйИдентификатор +// - Неопределено +// +// Возвращаемое значение: +// - ФоновоеЗадание +// - СеансИнформационнойБазы +// - Неопределено +// +Функция ИсполнительОбновленияДоступа(ПоследнееОбновлениеДоступа, ИдентификаторИсключаемогоЗадания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИсполнительОбновленияДоступа(ПоследнееОбновлениеДоступа, ИдентификаторИсключаемогоЗадания); +``` +
+ +## ИдентификаторПроизвольногоСеанса +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновлениеДоступаНаУровнеЗаписей, ИсполнительОбновленияДоступа. +Функция ИдентификаторПроизвольногоСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИдентификаторПроизвольногоСеанса()); +``` +
+ +## ПроверитьОбновитьДействующиеПараметрыОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ВыполнитьОбновлениеДоступа, ДобавитьЗаданияОбновленияДоступа и +// ОбновитьСоставИспользуемыхВерсийПараметровШаблонов. +// +// Параметры: +// Контекст - см. НовыйКонтекстОбновленияДоступа +// ПриЗапуске - Булево +// +Процедура ПроверитьОбновитьДействующиеПараметрыОграниченияДоступа(Контекст, ПриЗапуске = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьОбновитьДействующиеПараметрыОграниченияДоступа(Контекст, ПриЗапуске); +``` +
+ +## ЗапланированоОбновлениеПараметровОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьОбновитьДействующиеПараметрыОграниченияДоступа. +Функция ЗапланированоОбновлениеПараметровОграниченияДоступа(ДатаАктуальности) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗапланированоОбновлениеПараметровОграниченияДоступа(ДатаАктуальности)); +``` +
+ +## УменьшитьНомераВерсийПараметровОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьОбновитьДействующиеПараметрыОграниченияДоступа. +Процедура УменьшитьНомераВерсийПараметровОграниченияДоступа() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УменьшитьНомераВерсийПараметровОграниченияДоступа()); +``` +
+ +## ИспользованиеВидовДоступаИзменено +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьОбновитьДействующиеПараметрыОграниченияДоступа. +Функция ИспользованиеВидовДоступаИзменено(ДействующиеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИспользованиеВидовДоступаИзменено(ДействующиеПараметры)); +``` +
+ +## ЗавершитьПотокиОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновлениеДоступаНаУровнеЗаписей, ВыполнитьОбновлениеДоступа, +// ОтменитьОбновлениеДоступаНаУровнеЗаписей, ЗавершитьОбновлениеДоступа. +// +Процедура ЗавершитьПотокиОбновленияДоступа(ОтменитьОбновление = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗавершитьПотокиОбновленияДоступа(ОтменитьОбновление); +``` +
+ +## ИдентификаторОтменыОбновленияДоступаНаУровнеЗаписей +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбработатьВыполненныеЗадания, ЗавершитьПотокиОбновленияДоступа. +Функция ИдентификаторОтменыОбновленияДоступаНаУровнеЗаписей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИдентификаторОтменыОбновленияДоступаНаУровнеЗаписей()); +``` +
+ +## ОтменитьФоновыеЗаданияПотоковОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновлениеДоступаНаУровнеЗаписей, ВыполнитьОбновлениеДоступа, +// ОтменитьОбновлениеДоступаНаУровнеЗаписей, ЗавершитьОбновлениеДоступа. +// +Процедура ОтменитьФоновыеЗаданияПотоковОбновленияДоступа(СекундОжидания = 5) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтменитьФоновыеЗаданияПотоковОбновленияДоступа(СекундОжидания); +``` +
+ +## ВыполнитьОбновлениеДоступа +
+ +Описание, пример вызова + +```bsl + +// Обновляет ключи доступа к данным на основе записей в регистре сведений +// ОбновлениеКлючейДоступаКДанным и ключи доступа пользователей на основе записей +// регистра сведений ОбновлениеКлючейДоступаПользователей. +// +// Обновляется порция данных для каждой таблицы, начиная с самых свежих данных. +// Процедура должна вызываться повторно, пока обработка не будет завершена, +// при этом регламентное задание выключается. +// +// Процедура предназначена для работы в единственном экземпляре, то есть без параллельной +// работы (вызов из процедуры регламентного задания ОбновлениеДоступаНаУровнеЗаписей). +// Параллельность обеспечивает сама процедура путем запуска до двух фоновых заданий +// на каждый список, но не более значения константы КоличествоПотоковОбновленияДоступа. +// +Процедура ВыполнитьОбновлениеДоступа(ОбновитьВсе, ПараметрыВыполнения, ПоследнееОбновлениеДоступа) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВыполнитьОбновлениеДоступа(ОбновитьВсе, ПараметрыВыполнения, ПоследнееОбновлениеДоступа)); +``` +
+ +## НовыйКонтекстОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ОписаниеОсновногоСеанса - см. ОписаниеОсновногоСеанса +// * ТекущееФоновоеЗадание - ФоновоеЗадание +// * Задания - см. ТаблицаЗаданийОбновления +// * ЗаданияДляЗапуска - Массив из СтрокаТаблицыЗначений: см. ТаблицаЗаданийОбновления +// * ЗанятыеПотоки - Соответствие из КлючИЗначение: +// ** Ключ - УникальныйИдентификатор +// ** Значение - см. НовыйПоток +// * СвободныеПотоки - Массив из см. НовыйПоток +// * ГраницаОбновленияЗаданий - Дата +// * ОбщиеПараметрыОбновления - см. ОписаниеОбщихПараметровОбновления +// * ОбновлениеВЭтомСеансе - Булево +// * КоличествоПотоков - Число +// * ДатаПолногоЗавершения - Дата +// * ТекстОшибкиЗавершения - Строка +// * ЕстьОтложенныеЗадания - Булево +// * ЕстьЗапущенноеЗадание - Булево +// * ОбработкаЗавершена - Булево +// * ОбновлениеОтменено - Булево +// * ТребуетсяПерезапускСеанса - Булево +// * МаксимумПорцийИзИсходной - Число +// * КоличествоДополнительныхПорций - Число +// * ЕстьДлительноеЗаданиеПолученияПорцийЭлементовДанных - Булево +// * МаксимальноеКоличествоСекундБыстрогоПолученияПорцийЭлементовДанных - Число +// * ИдентификаторыОтключенныхОбъектовМетаданных - Соответствие +// * ИдентификаторСправочникаНаборыГруппДоступа - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// +Функция НовыйКонтекстОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйКонтекстОбновленияДоступа()); +``` +
+ +## ЗапланироватьОбработкуУстаревшихЭлементов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Процедура ЗапланироватьОбработкуУстаревшихЭлементов(ТекстОшибкиПланирования, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбработкуУстаревшихЭлементов(ТекстОшибкиПланирования, ); +``` +
+ +## МаксимумМиллисекундПолученияПорций +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗапуститьОбновлениеДоступаСписка. +Функция МаксимумМиллисекундПолученияПорций(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МаксимумМиллисекундПолученияПорций(Контекст)); +``` +
+ +## ДоступнаБалансировкаНагрузкиНаДиск +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьКоличествоПотоков и формы ОбновлениеДоступаНаУровнеЗаписей. +// +// Возвращаемое значение: +// Булево +// +Функция ДоступнаБалансировкаНагрузкиНаДиск() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ДоступнаБалансировкаНагрузкиНаДиск() +``` +
+ +## БалансировкаНагрузкиНаДиск +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьКоличествоПотоков и формы ОбновлениеДоступаНаУровнеЗаписей. +// +// Возвращаемое значение: +// Булево +// +Функция БалансировкаНагрузкиНаДиск() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.БалансировкаНагрузкиНаДиск() +``` +
+ +## УстановитьБалансировкуНагрузкиНаДиск +
+ +Описание, пример вызова + +```bsl + +// Для формы ОбновлениеДоступаНаУровнеЗаписей. +Процедура УстановитьБалансировкуНагрузкиНаДиск(Использование) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьБалансировкуНагрузкиНаДиск(Использование) +``` +
+ +## ТаблицаЗаданийОбновления +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +// Возвращаемое значение: +// ТаблицаЗначений: +// * ЕстьТочечноеЗадание - Булево +// * ЕстьНачальноеОбновлениеТочечногоЗадания - Дата +// * ДатаПоследнегоЗапускаТочечногоЗадания - Дата +// * ДатаДобавленияТочечногоЗадания - Дата +// * УровеньЗависимости - Число +// * ЗависимыеСписки - Массив +// - Строка +// * ЕстьНачальноеОбновление - Булево +// * ЕстьПерезапуск - Булево +// * ДатаПоследнегоЗапускаОбщегоЗадания - Дата +// * ЕстьДатаПоследнегоОбновленногоЭлемента - Булево +// * ДатаПоследнегоОбновленногоЭлемента - Дата +// * ДатаДобавленияОбщегоЗадания - Дата +// * ИдентификаторСписка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// * ДляВнешнихПользователей - Булево +// * ЭтоОбновлениеПрав - Булево +// * Запускать - Булево +// * ЗанятыеПотоки - Соответствие из КлючИЗначение: +// ** Ключ - УникальныйИдентификатор +// ** Значение - см. НовыйПоток +// * НаборПорций - Массив из см. ПорцияИзНабора +// * КоличествоПорцийДляОбработки - Число +// * ИндексСледующейПорцииДляОбработки - Число +// * Пропустить - Булево +// * Удалить - Булево +// * ПорядокВидаКлючаДанных - Число +// * ЭтоОбработкаУстаревшихЭлементов - Булево +// * ОбновитьУровеньЗависимости - Булево +// +Функция ТаблицаЗаданийОбновления() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТаблицаЗаданийОбновления()); +``` +
+ +## ТаблицаКлючейЗаданий +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьЗаданияОбновленияДоступа. +Функция ТаблицаКлючейЗаданий() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТаблицаКлючейЗаданий()); +``` +
+ +## НовыйПоток +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +// +// Возвращаемое значение: +// Структура: +// * ИдентификаторПотока - УникальныйИдентификатор +// * ФоновоеЗадание - ФоновоеЗадание +// * Задание - СтрокаТаблицыЗначений из см. ТаблицаЗаданийОбновления +// * ОтменитьЗадание - Булево +// * МоментЗапускаЗадания - Число +// * ПорцияИзНабора - см. ПорцияИзНабора +// * ПолучитьПорции - Число +// * ДатаОсвобождения - Дата +// +Функция НовыйПоток() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйПоток()); +``` +
+ +## ОписаниеОбщихПараметровОбновления +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +// +// Возвращаемое значение: +// Структура: +// * ЭтоОбновлениеПрав - Булево +// * ИдентификаторСписка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// * ДляВнешнихПользователей - Булево +// * ЭтоОбработкаУстаревшихЭлементов - Булево +// * РазрешенаОбработкаУстаревшихЭлементов - Булево +// * ДатаНачала - Дата +// * ДатаОкончания - Дата +// * НачальноеОбновление - Булево +// * ОбработкаЗавершена - Булево +// * МаксимумМиллисекундОбработки - Число +// * ИдентификаторСправочникаНаборыГруппДоступа - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// * Кэш - см. НовыйКэшКонтекста +// * МаксимумПорцийИзИсходной - Число +// +Функция ОписаниеОбщихПараметровОбновления(Контекст = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеОбщихПараметровОбновления(Контекст); +``` +
+ +## ТекстЗапросаЗаданий +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Функция ТекстЗапросаЗаданий() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаЗаданий()); +``` +
+ +## ЗаполнитьКоличествоПотоков +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Процедура ЗаполнитьКоличествоПотоков(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьКоличествоПотоков(Контекст)); +``` +
+ +## ДобавитьЗаданияОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Процедура ДобавитьЗаданияОбновленияДоступа(РезультатыЗапроса, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗаданияОбновленияДоступа(РезультатыЗапроса, Контекст)); +``` +
+ +## НовыйКэшКонтекста +
+ +Описание, пример вызова + +```bsl + +// Для функции ДобавитьЗаданияОбновленияДоступа. +// +// Возвращаемое значение: +// Структура: +// * ОбъектыМетаданныхПоИдентификаторам - Соответствие +// +Функция НовыйКэшКонтекста() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйКэшКонтекста()); +``` +
+ +## ОбновитьСвойствоЭтоОбработкаУстаревшихЭлементов +
+ +Описание, пример вызова + +```bsl + +// Для процедур ДобавитьЗаданияОбновленияДоступа, ОбновитьСвойстваЗадания и +// функции ЗапуститьОбновлениеДоступаСписка. +// +Процедура ОбновитьСвойствоЭтоОбработкаУстаревшихЭлементов(Задание, ТребуетсяОбновитьУровеньЗависимостиПриИзменении = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьСвойствоЭтоОбработкаУстаревшихЭлементов(Задание, ТребуетсяОбновитьУровеньЗависимостиПриИзменении); +``` +
+ +## ЭтоОбновлениеСоставаНаборовГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьОбщиеПараметрыОбновления. +Функция ЭтоОбновлениеСоставаНаборовГруппДоступа(Задание, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоОбновлениеСоставаНаборовГруппДоступа(Задание, Контекст)); +``` +
+ +## ЗаполнитьУровниЗависимостиЗаданий +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьЗаданияОбновленияДоступа. +Процедура ЗаполнитьУровниЗависимостиЗаданий(Контекст, СвойстваВедущихСписков) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьУровниЗависимостиЗаданий(Контекст, СвойстваВедущихСписков)); +``` +
+ +## УстановитьУровеньЗависимостиПоВедущим +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗаполнитьУровниЗависимостиЗаданий, ОбновитьУровеньЗависимости. +Процедура УстановитьУровеньЗависимостиПоВедущим(Задание, Задания, ВедущиеСпискиПоЗависимым) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьУровеньЗависимостиПоВедущим(Задание, Задания, ВедущиеСпискиПоЗависимым)); +``` +
+ +## ОбновитьУровеньЗависимости +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьОбщиеПараметрыОбновления. +Процедура ОбновитьУровеньЗависимости(СвойстваЗадания, Задания, ВедущиеСпискиПоЗависимым) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьУровеньЗависимости(СвойстваЗадания, Задания, ВедущиеСпискиПоЗависимым)); +``` +
+ +## ЗаполнитьОбщиеПараметрыОбновления +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Процедура ЗаполнитьОбщиеПараметрыОбновления(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьОбщиеПараметрыОбновления(Контекст)); +``` +
+ +## ПериодОбновленияДоПериодаДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедур ДобавитьЗаданияОбновленияДоступа, ЗапуститьОбновлениеДоступаСписка, +// ВыполнитьОбновлениеДоступаСписка. +// +Функция ПериодОбновленияДоПериодаДанных(ДатаНачала, ДатаПоследнегоОбновленногоЭлемента) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПериодОбновленияДоПериодаДанных(ДатаНачала, ДатаПоследнегоОбновленногоЭлемента)); +``` +
+ +## ОбработатьЗаданияСОшибками +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Процедура ОбработатьЗаданияСОшибками(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьЗаданияСОшибками(Контекст)); +``` +
+ +## ОбновитьСоставИспользуемыхВерсийПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Процедура ОбновитьСоставИспользуемыхВерсийПараметровШаблонов(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьСоставИспользуемыхВерсийПараметровШаблонов(Контекст)); +``` +
+ +## ЗавершитьОбновлениеДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Процедура ЗавершитьОбновлениеДоступа(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗавершитьОбновлениеДоступа(Контекст)); +``` +
+ +## ИспользуетсяОдинВариантДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьСоставИспользуемыхВерсийПараметровШаблонов. +Функция ИспользуетсяОдинВариантДоступа(ДополнительныйКонтекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИспользуетсяОдинВариантДоступа(ДополнительныйКонтекст)); +``` +
+ +## ОтключитьРегламентноеЗаданиеЕслиНетНовыхЗаданий +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗавершитьОбновлениеДоступа. +Процедура ОтключитьРегламентноеЗаданиеЕслиНетНовыхЗаданий(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтключитьРегламентноеЗаданиеЕслиНетНовыхЗаданий(Контекст)); +``` +
+ +## УстановитьНедоступныеСписки +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОтключитьРегламентноеЗаданиеЕслиНетНовыхЗаданий. +// +// Параметры: +// РезультатЗапроса - РезультатЗапроса +// НедоступныеСписки - Массив +// +Процедура УстановитьНедоступныеСписки(РезультатЗапроса, НедоступныеСписки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьНедоступныеСписки(РезультатЗапроса, НедоступныеСписки)); +``` +
+ +## ЗапуститьОбновлениеДоступаСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Функция ЗапуститьОбновлениеДоступаСписка(Задание, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗапуститьОбновлениеДоступаСписка(Задание, Контекст)); +``` +
+ +## ОбщееЗаданиеВыполняется +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗапуститьОбновлениеДоступаСписка и процедуры ОбработатьРезультатЗадания. +Функция ОбщееЗаданиеВыполняется(Задание) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбщееЗаданиеВыполняется(Задание)); +``` +
+ +## ИмяМетодаПотокаОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗапуститьОбновлениеДоступаСписка и процедуры ОтменитьФоновыеЗаданияПотоковОбновленияДоступа. +Функция ИмяМетодаПотокаОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИмяМетодаПотокаОбновленияДоступа()); +``` +
+ +## ИмяМетодаЗаданияОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур УстановитьОбновлениеДоступа, ЗапуститьОбновлениеДоступаНаУровнеЗаписей, +// ОтменитьОбновлениеДоступаНаУровнеЗаписей и функции ИсполнительОбновленияДоступа. +// +Функция ИмяМетодаЗаданияОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИмяМетодаЗаданияОбновленияДоступа()); +``` +
+ +## ПодождатьОсвобожденияПотока +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа, ЗавершитьОбновлениеДоступа. +Процедура ПодождатьОсвобожденияПотока(Контекст, ЖдатьЗавершенияЗадания = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПодождатьОсвобожденияПотока(Контекст, ЖдатьЗавершенияЗадания); +``` +
+ +## ИдентификаторыПотоков +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПодождатьОсвобожденияПотока, ОбработатьВыполненныеЗадания. +Функция ИдентификаторыПотоков(ЗанятыеПотоки) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИдентификаторыПотоков(ЗанятыеПотоки)); +``` +
+ +## ОбновитьСвойстваФоновогоЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПодождатьОсвобожденияПотока, УдалитьОстановленныеПотоки. +Процедура ОбновитьСвойстваФоновогоЗадания(Поток, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьСвойстваФоновогоЗадания(Поток, Контекст)); +``` +
+ +## ОтменитьФоновоеЗаданиеПотока +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьВыполненныеЗадания. +Процедура ОтменитьФоновоеЗаданиеПотока(Поток, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтменитьФоновоеЗаданиеПотока(Поток, Контекст)); +``` +
+ +## ОбработатьВыполненныеЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа, ОбработатьРезультатЗадания. +Процедура ОбработатьВыполненныеЗадания(Контекст, ЗанятыеПотоки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьВыполненныеЗадания(Контекст, ЗанятыеПотоки); +``` +
+ +## ЭтоДлительноеЗаданиеПолученияПорций +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Задание - СтрокаТаблицыЗначений из см. ТаблицаЗаданийОбновления +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоДлительноеЗаданиеПолученияПорций(Задание) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоДлительноеЗаданиеПолученияПорций(Задание)); +``` +
+ +## ОбновлениеДоступаОтменено +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбработатьВыполненныеЗадания, ВыполнитьОбновлениеДоступаСпискаСПопыткамиПовтора. +Функция ОбновлениеДоступаОтменено() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбновлениеДоступаОтменено()); +``` +
+ +## ОбработатьРезультатВыполненногоЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьВыполненныеЗадания. +Процедура ОбработатьРезультатВыполненногоЗадания(Поток, ОписаниеРезультата, Контекст, ЗадержкаЗапроса) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьРезультатВыполненногоЗадания(Поток, ОписаниеРезультата, Контекст, ЗадержкаЗапроса)); +``` +
+ +## ОсвободитьПоток +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбработатьРезультатВыполненногоЗадания, УдалитьПоток. +Процедура ОсвободитьПоток(Поток, Контекст, ДатаЗавершения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОсвободитьПоток(Поток, Контекст, ДатаЗавершения); +``` +
+ +## СнятьПризнакОбрабатываетсяДляПорции +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗапуститьОбновлениеДоступаСписка, ОбработатьРезультатВыполненногоЗадания, ОсвободитьПоток. +Процедура СнятьПризнакОбрабатываетсяДляПорции(ПотокИлиРезультат, Задание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СнятьПризнакОбрабатываетсяДляПорции(ПотокИлиРезультат, Задание)); +``` +
+ +## УдалитьПоток +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьРезультатВыполненногоЗадания, ЗавершитьОбновлениеДоступа. +Процедура УдалитьПоток(Поток, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьПоток(Поток, Контекст)); +``` +
+ +## УдалитьОстановленныеПотоки +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьРезультатВыполненногоЗадания, ЗавершитьОбновлениеДоступа. +Процедура УдалитьОстановленныеПотоки(Контекст, ОписаниеПотоков) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьОстановленныеПотоки(Контекст, ОписаниеПотоков)); +``` +
+ +## УдалитьНеиспользуемыеСвободныеПотоки +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьВыполненныеЗадания. +Процедура УдалитьНеиспользуемыеСвободныеПотоки(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьНеиспользуемыеСвободныеПотоки(Контекст)); +``` +
+ +## ОтменитьЗадание +
+ +Описание, пример вызова + +```bsl + +// Для процедур ДобавитьЗаданияОбновленияДоступа и ОбработатьРезультатЗадания. +Процедура ОтменитьЗадание(Задание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтменитьЗадание(Задание)); +``` +
+ +## ОбработатьРезультатЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗапуститьОбновлениеДоступаСписка, ОбработатьРезультатВыполненногоЗадания. +Процедура ОбработатьРезультатЗадания(Контекст, Результат, Задание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьРезультатЗадания(Контекст, Результат, Задание)); +``` +
+ +## ОбновитьСвойстваЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьРезультатЗадания. +Процедура ОбновитьСвойстваЗадания(Задание, НовыйПоследнийОбновленныйЭлемент) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьСвойстваЗадания(Задание, НовыйПоследнийОбновленныйЭлемент)); +``` +
+ +## ВыполнитьОбновлениеДоступаСпискаВФоне +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗапуститьОбновлениеДоступаСписка. +Процедура ВыполнитьОбновлениеДоступаСпискаВФоне(ОписаниеРодительскогоСеанса) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВыполнитьОбновлениеДоступаСпискаВФоне(ОписаниеРодительскогоСеанса) +``` +
+ +## ИсполняющийПотокЗапущен +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСпискаВФоне. +Функция ИсполняющийПотокЗапущен(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИсполняющийПотокЗапущен(Контекст)); +``` +
+ +## ПродолжитьОжиданиеНовогоЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСпискаВФоне. +Функция ПродолжитьОжиданиеНовогоЗадания(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПродолжитьОжиданиеНовогоЗадания(Контекст)); +``` +
+ +## СеансСуществует +
+ +Описание, пример вызова + +```bsl + +// Для функции ПродолжитьОжиданиеНовогоЗадания. +Функция СеансСуществует(ОписаниеСеанса) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СеансСуществует(ОписаниеСеанса)); +``` +
+ +## ЗаписатьРезультатОбновленияДоступаСпискаВФоне +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСпискаВФоне. +Процедура ЗаписатьРезультатОбновленияДоступаСпискаВФоне(Результат, ИсходныеПараметры, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьРезультатОбновленияДоступаСпискаВФоне(Результат, ИсходныеПараметры, Контекст)); +``` +
+ +## ПоказателиОбновленияОсновногоСеанса +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Функция ПоказателиОбновленияОсновногоСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПоказателиОбновленияОсновногоСеанса()); +``` +
+ +## ДобавитьПоказателиОбновленияУправляющегоПотока +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступа. +Процедура ДобавитьПоказателиОбновленияУправляющегоПотока(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПоказателиОбновленияУправляющегоПотока(Контекст)); +``` +
+ +## ПоказателиОбновленияИсполняющегоПотока +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСпискаВФоне. +Функция ПоказателиОбновленияИсполняющегоПотока() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПоказателиОбновленияИсполняющегоПотока()); +``` +
+ +## ДобавитьПоказателиВыполненияЗаданий +
+ +Описание, пример вызова + +```bsl + +// Для функций ПоказателиОбновленияУправляющегоПотока, ПоказателиОбновленияИсполняющегоПотока. +Процедура ДобавитьПоказателиВыполненияЗаданий(Показатели) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПоказателиВыполненияЗаданий(Показатели)); +``` +
+ +## СнятьПоказателиВыдачиЗаданий +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗапуститьОбновлениеДоступаСписка. +Процедура СнятьПоказателиВыдачиЗаданий(Показатели) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СнятьПоказателиВыдачиЗаданий(Показатели)); +``` +
+ +## СнятьПоказателиОбработкиРезультатаЗадания +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗапуститьОбновлениеДоступаСписка. +Процедура СнятьПоказателиОбработкиРезультатаЗадания(Показатели) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СнятьПоказателиОбработкиРезультатаЗадания(Показатели)); +``` +
+ +## СнятьПоказателиВыполненияЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСпискаВФоне. +Процедура СнятьПоказателиВыполненияЗадания(Показатели) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СнятьПоказателиВыполненияЗадания(Показатели)); +``` +
+ +## СнятьПоказателиОшибокВыполненияЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСпискаВФоне. +Процедура СнятьПоказателиОшибокВыполненияЗадания(Показатели, ТекстОшибок, КоличествоОшибок); Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СнятьПоказателиОшибокВыполненияЗадания(Показатели, ТекстОшибок, КоличествоОшибок);); +``` +
+ +## ФорматСекунд +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗарегистрироватьПоказателиОбновленияОсновногоПотока, +// ЗарегистрироватьПоказателиОбновленияИсполняющегоПотока, +// ДобавитьЗначенияПоказателейРаботыСеанса, +// ДобавитьЗначенияПоказателейВыполненияЗаданий. +// +Функция ФорматСекунд(ЧислоСекунд) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ФорматСекунд(ЧислоСекунд)); +``` +
+ +## ФорматКоличества +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗарегистрироватьПоказателиОбновленияОсновногоПотока, +// ЗарегистрироватьПоказателиОбновленияИсполняющегоПотока, +// ДобавитьЗначенияПоказателейВыполненияЗаданий. +// +Функция ФорматКоличества(ЧислоКоличества) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ФорматКоличества(ЧислоКоличества)); +``` +
+ +## ЗарегистрироватьПоказателиОбновленияОсновногоПотока +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗавершитьОбновлениеДоступа. +Процедура ЗарегистрироватьПоказателиОбновленияОсновногоПотока(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗарегистрироватьПоказателиОбновленияОсновногоПотока(Контекст)); +``` +
+ +## ЗарегистрироватьПоказателиОбновленияИсполняющегоПотока +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСпискаВФоне. +Процедура ЗарегистрироватьПоказателиОбновленияИсполняющегоПотока(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗарегистрироватьПоказателиОбновленияИсполняющегоПотока(Контекст)); +``` +
+ +## ДобавитьЗначенияПоказателейРаботыСеанса +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗарегистрироватьПоказателиОбновленияУправляющегоПотока и +// ЗарегистрироватьПоказателиОбновленияИсполняющегоПотока. +// +Процедура ДобавитьЗначенияПоказателейРаботыСеанса(Комментарий, Показатели, ОписаниеСеанса, ЭтоИсполняющийПоток = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗначенияПоказателейРаботыСеанса(Комментарий, Показатели, ОписаниеСеанса, ЭтоИсполняющийПоток); +``` +
+ +## ДобавитьЗначенияПоказателейВыполненияЗаданий +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗарегистрироватьПоказателиОбновленияУправляющегоПотока и +// ЗарегистрироватьПоказателиОбновленияИсполняющегоПотока. +// +Процедура ДобавитьЗначенияПоказателейВыполненияЗаданий(Комментарий, Показатели) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗначенияПоказателейВыполненияЗаданий(Комментарий, Показатели)); +``` +
+ +## ДобавитьТекстОшибкиЗавершения +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновлениеДоступаНаУровнеЗаписей, ОбработатьРезультатЗадания, ЗарегистрироватьОшибкуОбновленияДоступа. +Процедура ДобавитьТекстОшибкиЗавершения(ТекстОшибкиЗавершения, ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТекстОшибкиЗавершения(ТекстОшибкиЗавершения, ТекстОшибки)); +``` +
+ +## ТекстОшибкиОбновленияСКонтекстом +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьСвойстваФоновогоЗадания, ОтменитьФоновоеЗаданиеПотока, ОбработатьВыполненныеЗадания, +// УдалитьОстановленныеПотоки, ВыполнитьОбновлениеДоступаСпискаВФоне. +// +Функция ТекстОшибкиОбновленияСКонтекстом(ИнформацияОбОшибке, ОбщиеПараметрыОбновления, УстранимаяОшибка = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстОшибкиОбновленияСКонтекстом(ИнформацияОбОшибке, ОбщиеПараметрыОбновления, УстранимаяОшибка); +``` +
+ +## ЗарегистрироватьОшибкуОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновлениеДоступаНаУровнеЗаписей, ЗавершитьФоновыеЗадания, +// ОбработатьРезультатВыполненногоЗадания, ОбновитьСвойстваФоновогоЗадания, +// ВыполнитьОбновлениеДоступаСпискаВФоне. +// +Процедура ЗарегистрироватьОшибкуОбновленияДоступа(ТекстОшибки, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗарегистрироватьОшибкуОбновленияДоступа(ТекстОшибки, Контекст)); +``` +
+ +## ВыполнитьОбновлениеДоступаСпискаСПопыткамиПовтора +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗапуститьОбновлениеДоступаСписка и процедуры ВыполнитьОбновлениеДоступаСпискаВФоне. +Процедура ВыполнитьОбновлениеДоступаСпискаСПопыткамиПовтора(ОбщиеПараметрыОбновления, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВыполнитьОбновлениеДоступаСпискаСПопыткамиПовтора(ОбщиеПараметрыОбновления, Контекст)); +``` +
+ +## ВыполнитьОбновлениеДоступаСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСпискаСПопыткамиПовтора. +Процедура ВыполнитьОбновлениеДоступаСписка(ОбщиеПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВыполнитьОбновлениеДоступаСписка(ОбщиеПараметрыОбновления)); +``` +
+ +## ЭтоСправочникНаборыГруппДоступа +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоСправочникНаборыГруппДоступа(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоСправочникНаборыГруппДоступа(ПараметрыОбновления)); +``` +
+ +## ПараметрыОбновления +
+ +Описание, пример вызова + +```bsl + +// Для процедура ВыполнитьОбновлениеДоступаСписка. +// +// Возвращаемое значение: +// Структура: +// * ЭтоОбновлениеПрав - Булево +// * ИдентификаторСписка - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// * ДляВнешнихПользователей - Булево +// * Кэш - см. НовыйКэшКонтекста +// * ДатаНачала - Дата +// * ДатаОкончания - Дата +// * МаксимумПорцийИзИсходной - Число +// * ИдентификаторСправочникаНаборыГруппДоступа - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// * ГраницаВремениОбработки - Дата +// +// Свойства, если ЭтоСправочникНаборыГруппДоступа. +// * СписокСДатой - Булево +// * СписокСПериодом - Булево +// * ЭтоСсылочныйТип - Булево +// * ПустойНаборГруппДоступа - СправочникСсылка.НаборыГруппДоступа +// +// Свойства, если не ЭтоСправочникНаборыГруппДоступа. +// * ИдентификаторТранзакции - УникальныйИдентификатор +// * ЗависимыеСпискиПоКлючамДоступа - Массив из Строка - полные имена списков +// +// Свойства добавляемые в процессе работы. +// * ЕстьИзмененияПрав - Булево +// * ОбновитьПраваНаКлючи - Булево +// * ПоследнийОбновленныйЭлемент - см. НачальныйЭлемент +// * НовыйПоследнийОбновленныйЭлемент - см. НачальныйЭлемент +// * ПерезапускОбновления - Булево +// * ЕстьЗадания - Булево +// * ТочечноеЗадание - см. ПодготовленноеТочечноеЗадание +// * НаборПорций - Массив из см. ПорцияИзНабора +// * ТипПользователя - Тип +// * ТипГруппыПользователей - Тип +// * ТипГруппыДоступа - Тип +// * ПустаяГруппаДоступа - СправочникСсылка.ГруппыДоступа +// * ПраваГруппДоступаСписка - см. НовыеПраваГруппДоступаСписка +// * ПользователиГруппПользователей - см. НовыеПользователиГруппПользователей +// * ГруппыПользователейКакЗначенияДоступа - см. НовыеГруппыПользователейКакЗначенияДоступа +// * УчастникиГруппДоступа - см. НовыеУчастникиГруппДоступа +// * ГруппыПользователейГруппДоступа - см. НовыеГруппыПользователейГруппДоступа +// * ЗначенияГруппДоступа - см. НовыеЗначенияГруппДоступа +// * РолиПрофилейГруппДоступа - см. НовыеРолиПрофилейГруппДоступа +// * ГруппыДоступаПрофилей - см. НовыеГруппыДоступаПрофилей +// * ПраваНаСпискиВедущихКлючейДоступа - см. НовыеПраваНаСпискиВедущихКлючейДоступа +// * ПраваНаВедущиеКлючиДоступа - см. НовыеПраваНаВедущиеКлючиДоступа +// * ПраваНаВедущиеСписки - см. НовыеПраваНаВедущиеСписки +// * ПраваПоВладельцамНастроекПрав - см. НовыеПраваПоВладельцамНастроекПрав +// * МодельОбъектовВПамяти - см. МодельОбъектовВПамяти +// +// Копия свойств из ПараметрыОграниченияПоСтруктуреОграничения. +// * Список - Строка +// * ДляВнешнихПользователей - Булево +// * Версия - Строка +// * ВедущиеСписки - см. НовыеВедущиеСписки +// * ДоступЗапрещен - Булево +// * ОграничениеОтключено - Булево +// * ОграничениеЧтенияОтключено - Булево +// * ПолеВладельца - см. НовоеПолеВладельца +// * ТребуетсяОграничениеПоВладельцу - Булево +// * ИспользуетсяОграничениеПоВладельцу - Булево +// * РассчитыватьПраваПользователей - Булево +// * ЕстьЗависимыеСпискиБезЗаписиКлючейДоступа +// * ЧтениеРазрешеноДляВсехПользователей - Булево +// * ИзменениеРазрешеноДляВсехПользователей - Булево +// * ЕстьВедущиеКлючиДоступа - Булево +// * ЕстьВедущиеСпискиПоПравам - Булево +// * ЕстьФункцияПравоДоступаИлиРольДоступна - Булево +// * ТипыВладельцевНастроекПрав - ФиксированноеСоответствие +// * ИдентификаторТаблицыНастроекПрав - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// * ЕстьВладельцыНастроекПрав - Булево +// * ИспользуемыеТипыЗначенийДоступа - Массив из Тип +// * ВсеВидыОграниченийПрав - Соответствие +// * ПоляТаблицОбъекта - Массив из см. НовыеПоляТаблицыОбъекта +// * ИмяОтдельногоРегистраКлючей - Строка +// * ОпорныеПоля - см. НовоеОписаниеОпорныхПолей +// * ВариантДоступа - Число +// * СоставПолей - Число +// * ЕстьОграничениеЧтения - Булево +// * ЕстьОграничениеИзменения - Булево +// * ЕстьОграничениеПоПользователям - Булево +// * СтруктураРасчетаПраваЧтение - см. СтруктураРасчетаПрава +// * СтруктураРасчетаПраваИзменение - см. СтруктураРасчетаПрава +// * Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +// Свойства, добавляемые в процедуре ДобавитьТекстыЗапросовВПараметрыОграничения. +// * ТекстЗапросаПроверкиПравЧтениеИзменение - Строка +// * ТекстЗапросаПроверкиПраваЧтение - Строка +// * ПолеОбъектаВладельцаВЗапросеПроверкиПрав - Строка +// * ТекстЗапросаУстаревшихЭлементовДанных - Строка +// * ТекстЗапросаПроверкиУстаревшихЭлементовДанных - Строка +// * ТекстЗапросаНекорректныхЭлементовДанных - Строка +// * ТекстЗапросаНекорректныхЭлементовДанныхИзОбщегоРегистра - Строка +// * ТаблицыКлюча - Массив из Строка +// * РеквизитыТаблицКлюча - см. НовыеРеквизитыТаблицКлюча +// * ТекстЗапросаДиапазонаЭлементовДанных - Строка +// * ТекстЗапросаЭлементовДанныхСУстаревшимиКлючами - Строка +// * ТекстЗапросаПроверкиКлючаДоступаОбъекта - Строка +// * ТекстЗапросаЭлементовДанныхБезКлючейДоступа - Строка +// * ТекстЗапросаНовыхКомбинацийЗначенийОпорныхПолейСуществующихЗаписей - Строка +// * ТекстЗапросаНовыхКомбинацийЗначенийОпорныхПолейНовыхЗаписей - Строка +// * ОписаниеЗапросовУстаревшихКлючейДоступаПоВедущимОбъектам - Соответствие из КлючИЗначение: +// ** Ключ - Строка +// ** Значение - Соответствие из КлючИЗначение: +// *** Ключ - Строка +// *** Значение - Соответствие +// - Структура: +// *** ТипСсылки - ХранилищеЗначения +// *** КлючиЗапросовПоТипам - Соответствие +// *** ТекстыЗапросовПоКлючам - Соответствие +// *** ТекстЗапросаПараметров - Строка +// - Строка +// * ТекстЗапросаТекущихКлючейДоступаРегистра - Строка +// * ТекстЗапросаЗначенийЭлементовДанныхДляКлючейДоступа - Строка +// * ТекстЗапросаЗначенийОбъектовВПамятиДляКлючейДоступа - Строка +// * ТекстЗапросаЗначенийИзИспользуемыхКлючейДоступаДляСравнения - Строка +// * ТекстЗапросаЗначенийИзВсехКлючейДоступаДляСравнения - Строка +// * ТекстЗапросаСуществованияКлючейДляСравнения - Строка +// * ТекстЗапросаКлючейДоступаДляОбновленияПрав - Строка +// * ТекстЗапросаКлючейПоВедущимКлючамДляОбновленияПрав - Строка +// * ТекстЗапросаЗначенийИзКлючейДоступаДляРасчетаПрав - Строка +// * ТекстЗапросаУстаревшихКлючейДоступа - Строка +// +Функция ПараметрыОбновления(ОбщиеПараметрыОбновления, ОбъектМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПараметрыОбновления(ОбщиеПараметрыОбновления, ОбъектМетаданных)); +``` +
+ +## ДобавитьПараметрыОграничения +
+ +Описание, пример вызова + +```bsl + +// Для процедура ВыполнитьОбновлениеДоступаСписка. +Процедура ДобавитьПараметрыОграничения(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПараметрыОграничения(ПараметрыОбновления)); +``` +
+ +## НачальныйЭлемент +
+ +Описание, пример вызова + +```bsl + +// Для процедур ВыполнитьОбновлениеДоступаСписка, ПодготовитьПланОбновления. +// +// Возвращаемое значение: +// Структура: +// * КлючДанных - ЛюбаяСсылка +// - Null +// - Структура +// * ОбработатьУстаревшиеЭлементы - Булево +// * ОбработатьНаборыГруппСУстаревшимиПравами - Булево +// * Дата - Дата +// +Функция НачальныйЭлемент(ПараметрыОбновления, ВидКлючаДанных = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НачальныйЭлемент(ПараметрыОбновления, ВидКлючаДанных, ); +``` +
+ +## ПодготовитьПланОбновления +
+ +Описание, пример вызова + +```bsl + +// Для процедура ВыполнитьОбновлениеДоступаСписка. +Процедура ПодготовитьПланОбновления(ПараметрыОбновления, ПодготовкаЗавершена) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПодготовитьПланОбновления(ПараметрыОбновления, ПодготовкаЗавершена)); +``` +
+ +## ОчиститьЗагруженныеЗаписи +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПодготовитьПланОбновления. +Процедура ОчиститьЗагруженныеЗаписи(ПланОбновления, Выгрузка) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОчиститьЗагруженныеЗаписи(ПланОбновления, Выгрузка)); +``` +
+ +## ОбработатьПланОбновленияКэшаРасчетаПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПодготовитьПланОбновления. +Процедура ОбработатьПланОбновленияКэшаРасчетаПрав(Выгрузка, НоваяВерсияДанныхДляКэша = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьПланОбновленияКэшаРасчетаПрав(Выгрузка, НоваяВерсияДанныхДляКэша); +``` +
+ +## ОбработатьЗаданиеОбновленияКэшаРасчетаПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьПланОбновленияКэшаРасчетаПрав. +Процедура ОбработатьЗаданиеОбновленияКэшаРасчетаПрав(ВерсияДанныхДляКэша, ИмяИзмененныхДанных, КлючУникальности) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьЗаданиеОбновленияКэшаРасчетаПрав(ВерсияДанныхДляКэша, ИмяИзмененныхДанных, КлючУникальности)); +``` +
+ +## НоваяВерсияДанныхДляКэша +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбработатьПланОбновленияКэшаРасчетаПрав. +Функция НоваяВерсияДанныхДляКэша(ТекущееЗначение, ВерсияДанныхДляКэша, ДляЗаписи = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяВерсияДанныхДляКэша(ТекущееЗначение, ВерсияДанныхДляКэша, ДляЗаписи); +``` +
+ +## ВерсияДанныхДляКэшаРасчетаПрав +
+ +Описание, пример вызова + +```bsl + +// Для функции КэшРасчетаПравДляВидаПользователей. +Функция ВерсияДанныхДляКэшаРасчетаПрав() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВерсияДанныхДляКэшаРасчетаПрав()); +``` +
+ +## СохраняемыеПараметрыЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПодготовитьПланОбновления, ЗаписатьПоследнийОбновленныйЭлемент. +// +// Возвращаемое значение: +// Структура: +// * ПоследнийОбновленныйЭлемент - см. НачальныйЭлемент +// * ТочечноеЗадание - Структура: +// ** ПоКлючамДоступа - Соответствие +// ** ПоЗначениямПолей - Соответствие +// ** ПоЗначениямСГруппами - Соответствие +// +Функция СохраняемыеПараметрыЗадания(ЭтоОбновлениеПрав, ПараметрыОбновления, ПараметрыЗадания = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СохраняемыеПараметрыЗадания(ЭтоОбновлениеПрав, ПараметрыОбновления, ПараметрыЗадания, ); +``` +
+ +## ДобавитьВедущийОбъектКТочечномуЗаданию +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПодготовитьПланОбновления. +Процедура ДобавитьВедущийОбъектКТочечномуЗаданию(ТочечноеЗадание, СохраняемоеТочечноеЗадание, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВедущийОбъектКТочечномуЗаданию(ТочечноеЗадание, СохраняемоеТочечноеЗадание, ); +``` +
+ +## ЕстьСвойстваКлючаДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПодготовитьПланОбновления. +Функция ЕстьСвойстваКлючаДанных(ПараметрыЗадания) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЕстьСвойстваКлючаДанных(ПараметрыЗадания)); +``` +
+ +## ЭтоОбработкаУстаревшихЭлементов +
+ +Описание, пример вызова + +```bsl + +// Для процедур ВыполнитьОбновлениеДоступаСписка, ОбновитьПорциюЭлементов, +// УстановитьТекстЗапросаИПараметрыПоследнегоОбновленногоЭлементаДанных, ОбновитьНаборыГруппДоступа и +// функций ЭлементыДляОбновления, ПоследнийЭлемент, КлючДанных, НаборыГруппДоступаДляОбновления. +// +Функция ЭтоОбработкаУстаревшихЭлементов(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоОбработкаУстаревшихЭлементов(ПараметрыОбновления)); +``` +
+ +## ПорядокВидаКлючаДанных +
+ +Описание, пример вызова + +```bsl + +// Для функций СохраняемыеПараметрыЗадания, ЕстьСвойстваКлючаДанных и +// процедур ОбновитьСвойствоЭтоОбработкаУстаревшихЭлементов, УстановитьВидКлючаДанных. +// +Функция ПорядокВидаКлючаДанных(ВидКлючаДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПорядокВидаКлючаДанных(ВидКлючаДанных)); +``` +
+ +## УстановитьВидКлючаДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗапланироватьОбновлениеДоступа, ЗапланироватьОбновлениеНаборовГруппДоступа, +// УточнитьПустойПоследнийЭлемент и функции НачальныйЭлемент. +// +Процедура УстановитьВидКлючаДанных(Элемент, ВидКлючаДанных) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьВидКлючаДанных(Элемент, ВидКлючаДанных)); +``` +
+ +## ПодготовленноеТочечноеЗадание +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПодготовитьПланОбновления. +Функция ПодготовленноеТочечноеЗадание(ЭтоОбновлениеПрав, СохраняемоеТочечноеЗадание, ПерезапускОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПодготовленноеТочечноеЗадание(ЭтоОбновлениеПрав, СохраняемоеТочечноеЗадание, ПерезапускОбновления)); +``` +
+ +## КоличествоЭлементовВПорции +
+ +Описание, пример вызова + +```bsl + +// Для процедура ВыполнитьОбновлениеДоступаСписка. +Функция КоличествоЭлементовВПорции(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КоличествоЭлементовВПорции(ПараметрыОбновления)); +``` +
+ +## КоличествоЭлементовВЗапросе +
+ +Описание, пример вызова + +```bsl + +// Для процедура ВыполнитьОбновлениеДоступаСписка. +Функция КоличествоЭлементовВЗапросе(ЭтоОбновлениеПрав) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КоличествоЭлементовВЗапросе(ЭтоОбновлениеПрав)); +``` +
+ +## ОбновитьПорциюЭлементов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Процедура ОбновитьПорциюЭлементов(Элементы, ПараметрыОбновления, ЭтоТочечноеЗадание = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьПорциюЭлементов(Элементы, ПараметрыОбновления, ЭтоТочечноеЗадание); +``` +
+ +## ТребуетсяПрерватьОбработкуЭлементов +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьНаборыГруппДоступа, УдалитьУстаревшиеЭлементыДанныхСписка, +// ЗаписатьКлючиДоступаОбъектов, ЗаписатьКлючиДоступаРегистров, +// ОбновитьПраваПорцииКлючейДоступаСписка, УдалитьПорциюКлючейДоступаСписка, +// УдалитьТекущуюПорциюКлючейДоступаСписка. +// +Функция ТребуетсяПрерватьОбработкуЭлементов(ПараметрыОбновления, КоличествоОбработанныхНаШаге = 1) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТребуетсяПрерватьОбработкуЭлементов(ПараметрыОбновления, КоличествоОбработанныхНаШаге); +``` +
+ +## ЗаписатьПоследнийОбновленныйЭлемент +
+ +Описание, пример вызова + +```bsl + +// Для процедур ВыполнитьОбновлениеДоступаСписка, ПроверитьЗавершитьОбновлениеПоПорциям. +Процедура ЗаписатьПоследнийОбновленныйЭлемент(ОбщиеПараметрыОбновления, ПоследнийОбновленныйЭлемент) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьПоследнийОбновленныйЭлемент(ОбщиеПараметрыОбновления, ПоследнийОбновленныйЭлемент)); +``` +
+ +## ЭлементыДляОбновления +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Функция ЭлементыДляОбновления(ПараметрыОбновления, КоличествоВЗапросе, ВыбраныВсеЭлементы) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭлементыДляОбновления(ПараметрыОбновления, КоличествоВЗапросе, ВыбраныВсеЭлементы)); +``` +
+ +## ПризнакПустогоЗапроса +
+ +Описание, пример вызова + +```bsl + +// Для функции ЭлементыДляОбновления и процедур +// УстановитьТекстЗапросаИПараметрыПоследнегоОбновленногоЭлементаДанных, +// УстановитьОбработкуУстаревшихДанных, +// ДобавитьТекстЗапросаУстаревшихЭлементовДанных. +// +Функция ПризнакПустогоЗапроса() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПризнакПустогоЗапроса()); +``` +
+ +## ПризнакИтерационногоЗапроса +
+ +Описание, пример вызова + +```bsl + +// Для функции ЭлементыДляОбновления и +// процедуры УстановитьПустойПоследнийЭлемент. +// +Функция ПризнакИтерационногоЗапроса() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПризнакИтерационногоЗапроса()); +``` +
+ +## ИтерационнаяВыборкаЭлементовДляОбновления +
+ +Описание, пример вызова + +```bsl + +// Для функции ЭлементыДляОбновления. +Функция ИтерационнаяВыборкаЭлементовДляОбновления(Запрос, ПараметрыОбновления, КоличествоВЗапросе, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИтерационнаяВыборкаЭлементовДляОбновления(Запрос, ПараметрыОбновления, КоличествоВЗапросе, ); +``` +
+ +## УстановитьУточнениеПланаЗапроса +
+ +Описание, пример вызова + +```bsl + +// Для процедур выполнения запросов. +Процедура УстановитьУточнениеПланаЗапроса(ТекстЗапроса, УникальныйПлан = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьУточнениеПланаЗапроса(ТекстЗапроса, УникальныйПлан); +``` +
+ +## ЭлементыТочечногоЗаданияДляОбновления +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Функция ЭлементыТочечногоЗаданияДляОбновления(ПараметрыОбновления, КоличествоВЗапросе, ВыбраныВсеЭлементы) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭлементыТочечногоЗаданияДляОбновления(ПараметрыОбновления, КоличествоВЗапросе, ВыбраныВсеЭлементы)); +``` +
+ +## ДобавитьЗапросыТочечногоЗадания +
+ +Описание, пример вызова + +```bsl + +// Для функции ЭлементыТочечногоЗаданияДляОбновления. +Функция ДобавитьЗапросыТочечногоЗадания(ВидЗадания, Запрос, ЗапросыПакета, ЗапросыДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ДобавитьЗапросыТочечногоЗадания(ВидЗадания, Запрос, ЗапросыПакета, ЗапросыДанных, ПараметрыОбновления)); +``` +
+ +## ТаблицаТочечногоЗадания +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ТаблицаЗначений: +// * Ссылка - ЛюбаяСсылка +// +Функция ТаблицаТочечногоЗадания() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТаблицаТочечногоЗадания()); +``` +
+ +## ПерезапуститьОбновлениеПриНезавершенномТочечномОбновлении +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Процедура ПерезапуститьОбновлениеПриНезавершенномТочечномОбновлении(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПерезапуститьОбновлениеПриНезавершенномТочечномОбновлении(ПараметрыОбновления)); +``` +
+ +## НаборПорцийЭлементов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Функция НаборПорцийЭлементов(ПараметрыОбновления, Элементы, ВыбраныВсеЭлементы, РазмерПорции = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НаборПорцийЭлементов(ПараметрыОбновления, Элементы, ВыбраныВсеЭлементы, РазмерПорции); +``` +
+ +## ПорцияИзНабора +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * Обработана - Булево +// * Обрабатывается - Булево +// * Элементы - ХранилищеЗначения +// * ДатаПоследнегоЭлементаПорции - Дата +// * ПоследнийЭлементПорции - см. НачальныйЭлемент +// * НовыйПоследнийЭлементПорции - см. НачальныйЭлемент +// +Функция ПорцияИзНабора() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПорцияИзНабора()); +``` +
+ +## ПоследнийЭлемент +
+ +Описание, пример вызова + +```bsl + +// Для процедур ВыполнитьОбновлениеДоступаСписка, ОбновитьПорциюЭлементов, НаборПорцийЭлементов. +Функция ПоследнийЭлемент(Элементы, ПараметрыОбновления, ПоследнийОбработанный = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПоследнийЭлемент(Элементы, ПараметрыОбновления, ПоследнийОбработанный); +``` +
+ +## УточнитьПоследнийОбновленныйЭлемент +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Процедура УточнитьПоследнийОбновленныйЭлемент(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УточнитьПоследнийОбновленныйЭлемент(ПараметрыОбновления)); +``` +
+ +## УстановитьПустойПоследнийЭлемент +
+ +Описание, пример вызова + +```bsl + +// Для процедур ВыполнитьОбновлениеДоступаСписка, НаборПорцийЭлементов. +Процедура УстановитьПустойПоследнийЭлемент(Элемент, ПараметрыОбновления, ДатаЭлемента = '00010101') Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьПустойПоследнийЭлемент(Элемент, ПараметрыОбновления, ДатаЭлемента); +``` +
+ +## УстановитьОбработкуУстаревшихДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедур УточнитьПоследнийОбновленныйЭлемент, УстановитьПустойПоследнийЭлемент. +Процедура УстановитьОбработкуУстаревшихДанных(Элемент, ПараметрыОбновления, ВидКлючаДанныхЗавершения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьОбработкуУстаревшихДанных(Элемент, ПараметрыОбновления, ВидКлючаДанныхЗавершения); +``` +
+ +## УстановитьЭлементСледующегоПериода +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УточнитьПустойПоследнийЭлемент. +Процедура УстановитьЭлементСледующегоПериода(ПараметрыОбновления, Элемент, ДатаЭлемента, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьЭлементСледующегоПериода(ПараметрыОбновления, Элемент, ДатаЭлемента, ); +``` +
+ +## УстановитьТекстЗапросаИПараметрыПоследнегоОбновленногоЭлементаДанных +
+ +Описание, пример вызова + +```bsl + +// Для функции ЭлементыДляОбновления. +Процедура УстановитьТекстЗапросаИПараметрыПоследнегоОбновленногоЭлементаДанных(Запрос, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьТекстЗапросаИПараметрыПоследнегоОбновленногоЭлементаДанных(Запрос, ПараметрыОбновления)); +``` +
+ +## КлючДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПоследнийЭлемент, УстановитьПараметрыПоследнегоОбновленногоЭлемента и +// функции ТекстЗапросаКоличестваОставшихсяЭлементовРегистра. +// +// Возвращаемое значение: +// Структура: +// * Поле1 - ЛюбаяСсылка +// * Поле2 - ЛюбаяСсылка +// * Поле3 - ЛюбаяСсылка +// * Поле4 - ЛюбаяСсылка +// * Поле5 - ЛюбаяСсылка +// +Функция КлючДанных(ПараметрыОбновления, ИсходныйКлючДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КлючДанных(ПараметрыОбновления, ИсходныйКлючДанных); +``` +
+ +## НаборыГруппДоступаДляОбновления +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЭлементыДляОбновления. +Функция НаборыГруппДоступаДляОбновления(ПараметрыОбновления, КоличествоВЗапросе) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НаборыГруппДоступаДляОбновления(ПараметрыОбновления, КоличествоВЗапросе)); +``` +
+ +## ОбновитьНаборыГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПорциюЭлементов. +Процедура ОбновитьНаборыГруппДоступа(ЭлементыДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьНаборыГруппДоступа(ЭлементыДанных, ПараметрыОбновления)); +``` +
+ +## ОчиститьПраваПустогоНабораГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Процедура ОчиститьПраваПустогоНабораГруппДоступа(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОчиститьПраваПустогоНабораГруппДоступа(ПараметрыОбновления)); +``` +
+ +## ОбновитьНаборыГруппСУстаревшимиПравами +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьНаборыГруппДоступа. +Процедура ОбновитьНаборыГруппСУстаревшимиПравами(ЭлементыДанных, ПараметрыОбновления, ЭтоНовыеНаборы = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьНаборыГруппСУстаревшимиПравами(ЭлементыДанных, ПараметрыОбновления, ЭтоНовыеНаборы); +``` +
+ +## ОбновитьКлючиДоступаНаборовГрупп +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьНаборыГруппСУстаревшимиПравами. +Процедура ОбновитьКлючиДоступаНаборовГрупп(ПараметрыОбновления, НаборГруппДоступа, ИмяРегистраПрав, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьКлючиДоступаНаборовГрупп(ПараметрыОбновления, НаборГруппДоступа, ИмяРегистраПрав, ); +``` +
+ +## УстранитьДублиНаборовИзОдногоПользователяВСправочнике +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Процедура УстранитьДублиНаборовИзОдногоПользователяВСправочнике(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстранитьДублиНаборовИзОдногоПользователяВСправочнике(ПараметрыОбновления)); +``` +
+ +## ОбновитьНаборыИзОдногоПользователяВСправочнике +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьНаборыГруппДоступа. +Процедура ОбновитьНаборыИзОдногоПользователяВСправочнике(ЭлементыДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьНаборыИзОдногоПользователяВСправочнике(ЭлементыДанных, ПараметрыОбновления)); +``` +
+ +## ЗаполнитьПустыеХешиНаборовГрупп +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Процедура ЗаполнитьПустыеХешиНаборовГрупп(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПустыеХешиНаборовГрупп(ПараметрыОбновления)); +``` +
+ +## НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции НаборыГруппДоступаДляОбновления. +Функция НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГруппДоступа(ПараметрыОбновления, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГруппДоступа(ПараметрыОбновления, ); +``` +
+ +## НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГруппПользователей +
+ +Описание, пример вызова + +```bsl + +// Для функции НаборыГруппДоступаДляОбновления. +Функция НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГруппПользователей(ПараметрыОбновления, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГруппПользователей(ПараметрыОбновления, ); +``` +
+ +## НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГрупп +
+ +Описание, пример вызова + +```bsl + +// Для функций НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГруппДоступа, +// НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГруппПользователей. +// +Функция НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГрупп(ПараметрыОбновления, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НаборыИзОдногоПользователяДляОбновленияНазначенныхНаборовГрупп(ПараметрыОбновления, ); +``` +
+ +## ОбновитьНаборыГруппНазначенныеПользователямВСправочнике +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПорциюЭлементов. +Процедура ОбновитьНаборыГруппНазначенныеПользователямВСправочнике(ЭлементыДанных, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьНаборыГруппНазначенныеПользователямВСправочнике(ЭлементыДанных, ); +``` +
+ +## ЗаполнитьНомераГрупп +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьНаборыГруппВСправочнике. +Процедура ЗаполнитьНомераГрупп(НомераГрупп, ИменаЧастейНомера, МаксимальныйНомерГруппыВЧастиНомера) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьНомераГрупп(НомераГрупп, ИменаЧастейНомера, МаксимальныйНомерГруппыВЧастиНомера)); +``` +
+ +## НовыйНаборГрупп +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьНаборыГруппВСправочнике. +Функция НовыйНаборГрупп(ГруппыНабора, ДляВнешнихПользователей, ТипЭлементовНабора, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйНаборГрупп(ГруппыНабора, ДляВнешнихПользователей, ТипЭлементовНабора, ); +``` +
+ +## ЗаполнитьХешНабораГрупп +
+ +Описание, пример вызова + +```bsl + +// Для функции НовыйНаборГрупп и процедуры ЗаполнитьПустыеХешиНаборовГрупп. +Процедура ЗаполнитьХешНабораГрупп(Объект) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьХешНабораГрупп(Объект)); +``` +
+ +## ГруппыНабораПоНомерам +
+ +Описание, пример вызова + +```bsl + +// Для функции НовыйНаборГрупп. +Функция ГруппыНабораПоНомерам(НомераГрупп, ИменаЧастейНомера, ЧастиНомера) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ГруппыНабораПоНомерам(НомераГрупп, ИменаЧастейНомера, ЧастиНомера)); +``` +
+ +## НаборГруппСуществует +
+ +Описание, пример вызова + +```bsl + +// Для функции НовыйНаборГрупп. +Функция НаборГруппСуществует(Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НаборГруппСуществует(Объект)); +``` +
+ +## ОбновитьНаборыГруппРазрешенныеПользователямВСправочнике +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьНаборыГруппДоступа. +Процедура ОбновитьНаборыГруппРазрешенныеПользователямВСправочнике(ЭлементыДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьНаборыГруппРазрешенныеПользователямВСправочнике(ЭлементыДанных, ПараметрыОбновления)); +``` +
+ +## ОчиститьПраваНесуществующихНаборовГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Процедура ОчиститьПраваНесуществующихНаборовГруппДоступа(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОчиститьПраваНесуществующихНаборовГруппДоступа(ПараметрыОбновления)); +``` +
+ +## УстаревшиеНаборыГруппДоступаВСправочнике +
+ +Описание, пример вызова + +```bsl + +// Для функции НаборыГруппДоступаДляОбновления. +Функция УстаревшиеНаборыГруппДоступаВСправочнике(ПараметрыОбновления, КоличествоВЗапросе) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.УстаревшиеНаборыГруппДоступаВСправочнике(ПараметрыОбновления, КоличествоВЗапросе)); +``` +
+ +## ДатаУстаревания +
+ +Описание, пример вызова + +```bsl + +// Для функций УстаревшиеНаборыГруппДоступаВСправочнике, ЭлементыДляОбновления. +Функция ДатаУстаревания() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ДатаУстаревания()); +``` +
+ +## ОбработатьУстаревшиеНаборыВСправочнике +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПорциюЭлементов. +Процедура ОбработатьУстаревшиеНаборыВСправочнике(ЭлементыДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьУстаревшиеНаборыВСправочнике(ЭлементыДанных, ПараметрыОбновления)); +``` +
+ +## УдалитьЗаписиРегистраДляНабора +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УдалитьУстаревшиеНаборыВСправочнике, ОчиститьПраваНесуществующихНаборовГруппДоступа. +Процедура УдалитьЗаписиРегистраДляНабора(Набор, ИмяРегистраСведений, ИмяПоляНабора) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьЗаписиРегистраДляНабора(Набор, ИмяРегистраСведений, ИмяПоляНабора)); +``` +
+ +## ОбновитьПраваНаРазрешенныйКлючДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Процедура ОбновитьПраваНаРазрешенныйКлючДоступа(ЕстьИзменения = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьПраваНаРазрешенныйКлючДоступа(ЕстьИзменения); +``` +
+ +## ОбновитьГруппыДоступаРазрешенногоКлючаДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваНаРазрешенныйКлючДоступа. +Процедура ОбновитьГруппыДоступаРазрешенногоКлючаДоступа(ГруппыДоступа = Неопределено, ЕстьИзменения = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьГруппыДоступаРазрешенногоКлючаДоступа(ГруппыДоступа, ЕстьИзменения); +``` +
+ +## ТекстЗапросаВыбораРазличийГруппДоступаРазрешенногоКлюча +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьГруппыРазрешенногоКлючаДоступа. +Функция ТекстЗапросаВыбораРазличийГруппДоступаРазрешенногоКлюча() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаВыбораРазличийГруппДоступаРазрешенногоКлюча()); +``` +
+ +## УдалитьУстаревшиеЭлементыДанныхСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПорциюЭлементов. +Процедура УдалитьУстаревшиеЭлементыДанныхСписка(ЭлементыДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьУстаревшиеЭлементыДанныхСписка(ЭлементыДанных, ПараметрыОбновления)); +``` +
+ +## УдалитьУстаревшиеЭлементыДанныхСсылочногоТипа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УдалитьУстаревшиеЭлементыДанныхСписка. +Процедура УдалитьУстаревшиеЭлементыДанныхСсылочногоТипа(ЭлементыДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьУстаревшиеЭлементыДанныхСсылочногоТипа(ЭлементыДанных, ПараметрыОбновления)); +``` +
+ +## УдалитьУстаревшиеЭлементыДанныхРегистров +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УдалитьУстаревшиеЭлементыДанныхСписка. +Процедура УдалитьУстаревшиеЭлементыДанныхРегистров(ЭлементыДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьУстаревшиеЭлементыДанныхРегистров(ЭлементыДанных, ПараметрыОбновления)); +``` +
+ +## УдалитьОбъектыНедопустимыхТиповВРегистреКлючиДоступаКОбъектам +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ВыполнитьОбновлениеДоступаСписка. +Процедура УдалитьОбъектыНедопустимыхТиповВРегистреКлючиДоступаКОбъектам() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьОбъектыНедопустимыхТиповВРегистреКлючиДоступаКОбъектам()); +``` +
+ +## ОбновитьЭлементыДанныхСпискаСУстаревшимиКлючами +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПорциюЭлементов. +Процедура ОбновитьЭлементыДанныхСпискаСУстаревшимиКлючами(ЭлементыДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьЭлементыДанныхСпискаСУстаревшимиКлючами(ЭлементыДанных, ПараметрыОбновления)); +``` +
+ +## НекорректнаяКомбинацияЗначенийОпорныхПолей +
+ +Описание, пример вызова + +```bsl + +// Для функции ОбновитьЭлементыДанныхСпискаСУстаревшимиКлючами. +Функция НекорректнаяКомбинацияЗначенийОпорныхПолей(ЭлементДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НекорректнаяКомбинацияЗначенийОпорныхПолей(ЭлементДанных, ПараметрыОбновления)); +``` +
+ +## НедопустимаяКомбинацияЗначенийОпорныхПолей +
+ +Описание, пример вызова + +```bsl + +// Для функции ОбновитьЭлементыДанныхСпискаСУстаревшимиКлючами. +Функция НедопустимаяКомбинацияЗначенийОпорныхПолей(ЭлементДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НедопустимаяКомбинацияЗначенийОпорныхПолей(ЭлементДанных, ПараметрыОбновления)); +``` +
+ +## МодельОбъектовВПамяти +
+ +Описание, пример вызова + +```bsl + +// Для функции ДоступРазрешен. +Функция МодельОбъектовВПамяти(ОписаниеДанных, ПараметрыОграничения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МодельОбъектовВПамяти(ОписаниеДанных, ПараметрыОграничения)); +``` +
+ +## ОбновитьКлючиДоступаПорцииЭлементовДанныхСписка +
+ +Описание, пример вызова + +```bsl + +// Для функции ОбновитьЭлементыДанныхСпискаСУстаревшимиКлючами, ОбновитьКлючиДоступаЭлементовДанныхПриЗаписи. +Процедура ОбновитьКлючиДоступаПорцииЭлементовДанныхСписка(ПорцияЭлементовДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьКлючиДоступаПорцииЭлементовДанныхСписка(ПорцияЭлементовДанных, ПараметрыОбновления)); +``` +
+ +## ОбновитьПраваНаКлючиДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьКлючиДоступаПорцииЭлементовДанныхСписка. +Процедура ОбновитьПраваНаКлючиДоступа(ОписаниеКлючей, ПараметрыОбновления, ЭтоНовыеКлючи = Ложь, Контекст = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьПраваНаКлючиДоступа(ОписаниеКлючей, ПараметрыОбновления, ЭтоНовыеКлючи, Контекст); +``` +
+ +## ЗначенияТаблицыКлюча +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ТаблицаЗначений: +// * Ссылка - СправочникСсылка.КлючиДоступа +// * НомерСтроки - Число - номер строки табличной части +// +Функция ЗначенияТаблицыКлюча() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗначенияТаблицыКлюча()); +``` +
+ +## СтрокаДляХешаКлючаДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьКлючиДоступаПорцииЭлементовДанныхСписка. +Функция СтрокаДляХешаКлючаДоступа(ОписаниеКлючейЗначений, ТаблицыКлюча) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтрокаДляХешаКлючаДоступа(ОписаниеКлючейЗначений, ТаблицыКлюча)); +``` +
+ +## ЗаписатьКлючиДоступаОбъектов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьКлючиДоступаПорцииЭлементовДанных. +Процедура ЗаписатьКлючиДоступаОбъектов(ПараметрыОбновления, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьКлючиДоступаОбъектов(ПараметрыОбновления, Контекст)); +``` +
+ +## ЗаписатьКлючиДоступаРегистров +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьКлючиДоступаПорцииЭлементовДанных. +Процедура ЗаписатьКлючиДоступаРегистров(ПараметрыОбновления, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьКлючиДоступаРегистров(ПараметрыОбновления, Контекст)); +``` +
+ +## УдалитьНекорректныеКомбинацииЗначенийОпорныхПолей +
+ +Описание, пример вызова + +```bsl + +// Для функции ОбновитьЭлементыДанныхСпискаСУстаревшимиКлючами. +Процедура УдалитьНекорректныеКомбинацииЗначенийОпорныхПолей(ПорцияЭлементовДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьНекорректныеКомбинацииЗначенийОпорныхПолей(ПорцияЭлементовДанных, ПараметрыОбновления)); +``` +
+ +## КлючиЗначенийСтрокОбъектов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьКлючиДоступаПорцииЭлементовДанных. +Функция КлючиЗначенийСтрокОбъектов(РезультатыЗапроса, Индекс, ТаблицыКлюча, ЗначенияСтрокТаблиц = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КлючиЗначенийСтрокОбъектов(РезультатыЗапроса, Индекс, ТаблицыКлюча, ЗначенияСтрокТаблиц); +``` +
+ +## СтрокаДанныхДляХеширования +
+ +Описание, пример вызова + +```bsl + +// Для функции КлючиЗначенийСтрокОбъектов и др. +Функция СтрокаДанныхДляХеширования(Данные) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтрокаДанныхДляХеширования(Данные)); +``` +
+ +## ПроверитьТипЗначенийКлючаДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьКлючиДоступаПорцииЭлементовДанных. +Процедура ПроверитьТипЗначенийКлючаДоступа(ОписаниеКлюча, ДопустимыеТипыЗначений, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьТипЗначенийКлючаДоступа(ОписаниеКлюча, ДопустимыеТипыЗначений, ПараметрыОбновления)); +``` +
+ +## ПодготовитьНовыйКлючДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьКлючиДоступаПорцииЭлементовДанных. +Процедура ПодготовитьНовыйКлючДоступа(ОписаниеКлюча, ОписаниеНовыхКлючей, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПодготовитьНовыйКлючДоступа(ОписаниеКлюча, ОписаниеНовыхКлючей, ПараметрыОбновления)); +``` +
+ +## ОбновитьПраваПорцииКлючейДоступаСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьПорциюЭлементов, ОбновитьПраваНаКлючиДоступа. +Процедура ОбновитьПраваПорцииКлючейДоступаСписка(ОписаниеКлючейДоступа, ПараметрыОбновления, ЭтоНовыеКлючи = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьПраваПорцииКлючейДоступаСписка(ОписаниеКлючейДоступа, ПараметрыОбновления, ЭтоНовыеКлючи); +``` +
+ +## НовыеЗначенияТаблицКлючей +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура из КлючИЗначение: +// * Ключ - Строка - имя таблицы ключа +// * Значение - ДеревоЗначений +// +Функция НовыеЗначенияТаблицКлючей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеЗначенияТаблицКлючей()); +``` +
+ +## НовыеЗначенияТаблицКлюча +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура из КлючИЗначение: +// * Ключ - Строка - имя таблицы ключа +// * Значение - см. НовыеЗначенияТаблицыКлюча +// +Функция НовыеЗначенияТаблицКлюча() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеЗначенияТаблицКлюча()); +``` +
+ +## НовыеЗначенияТаблицыКлюча +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// - КоллекцияСтрокДереваЗначений +// - ТаблицаЗначений +// - СтрокаДереваЗначений +// +Функция НовыеЗначенияТаблицыКлюча() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеЗначенияТаблицыКлюча()); +``` +
+ +## ОбработатьУстаревшиеКлючиДоступаСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПорциюЭлементов. +Процедура ОбработатьУстаревшиеКлючиДоступаСписка(ЭлементыДанных, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьУстаревшиеКлючиДоступаСписка(ЭлементыДанных, ПараметрыОбновления)); +``` +
+ +## КэшРасчетаПравДляВидаПользователей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваПорцииКлючейДоступаСписка. +// +// Возвращаемое значение: +// Структура: +// * ПраваГруппДоступаСписков - Соответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений - идентификатор списка +// ** Значение - см. ПраваГруппДоступаСписка +// +// * ЗначенияГруппДоступа - см. НовыеЗначенияГруппДоступа +// * УчастникиГруппДоступа - см. НовыеУчастникиГруппДоступа +// * ПользователиГруппПользователей - см. НовыеПользователиГруппПользователей +// * ГруппыПользователейГруппДоступа - см. НовыеГруппыПользователейГруппДоступа +// * ГруппыПользователейКакЗначенияДоступа - см. НовыеГруппыПользователейКакЗначенияДоступа +// * РолиПрофилейГруппДоступа - см. НовыеРолиПрофилейГруппДоступа +// * ГруппыДоступаПрофилей - см. НовыеГруппыДоступаПрофилей +// +Функция КэшРасчетаПравДляВидаПользователей(ДляВнешнихПользователей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КэшРасчетаПравДляВидаПользователей(ДляВнешнихПользователей) +``` +
+ +## СброситьКэшРасчетаПрав +
+ +Описание, пример вызова + +```bsl + +// Для функции КэшРасчетаПравДляВидаПользователей. +Процедура СброситьКэшРасчетаПрав(Кэш, Свойство, НовоеСоответствие = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СброситьКэшРасчетаПрав(Кэш, Свойство, НовоеСоответствие); +``` +
+ +## ТекстЗапросаНазначенияПрофилей +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗаполнитьПраваГруппДоступаСписка и +// ЗаполнитьУчастниковГруппДоступаСписка. +// +Функция ТекстЗапросаНазначенияПрофилей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаНазначенияПрофилей()); +``` +
+ +## НовыеПраваГруппДоступаСписка +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Права - ТаблицаЗначений +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ГруппаДоступа - СправочникСсылка.ГруппыДоступа +// * ПравоИзменение - Булево +// * ПравоДобавление - Булево +// * ПравоЧтениеБезОграничения - Булево +// * ПравоИзменениеБезОграничения - Булево +// * ПравоДобавлениеБезОграничения - Булево +// +Функция НовыеПраваГруппДоступаСписка(Права) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеПраваГруппДоступаСписка(Права)); +``` +
+ +## ЗаполнитьПраваГруппДоступаСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваПорцииКлючейДоступаСписка. +Процедура ЗаполнитьПраваГруппДоступаСписка(ПараметрыОбновления, Кэш) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПраваГруппДоступаСписка(ПараметрыОбновления, Кэш)); +``` +
+ +## НовыеПользователиГруппПользователей +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.ГруппыПользователей +// - СправочникСсылка.ГруппыВнешнихПользователей +// - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// * Значение - Соответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// ** Значение - Булево - Истина +// +Функция НовыеПользователиГруппПользователей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеПользователиГруппПользователей()); +``` +
+ +## ЗаполнитьПользователейГруппПользователей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваПорцииКлючейДоступаСписка. +Процедура ЗаполнитьПользователейГруппПользователей(ПараметрыОбновления, Кэш) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПользователейГруппПользователей(ПараметрыОбновления, Кэш)); +``` +
+ +## НовыеГруппыПользователейКакЗначенияДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.ГруппыПользователей +// - СправочникСсылка.ГруппыВнешнихПользователей +// * Значение - Соответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// ** Значение - Булево - Истина +// +Функция НовыеГруппыПользователейКакЗначенияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеГруппыПользователейКакЗначенияДоступа()); +``` +
+ +## ЗаполнитьГруппыПользователейКакЗначенияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваПорцииКлючейДоступаСписка. +Процедура ЗаполнитьГруппыПользователейКакЗначенияДоступа(ПараметрыОбновления, Кэш) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьГруппыПользователейКакЗначенияДоступа(ПараметрыОбновления, Кэш)); +``` +
+ +## НовыеУчастникиГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.ГруппыДоступа +// * Значение - Соответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка.Пользователи +// - СправочникСсылка.ГруппыПользователей +// - СправочникСсылка.ВнешниеПользователи +// - СправочникСсылка.ГруппыВнешнихПользователей +// ** Значение - Булево - Истина +// +Функция НовыеУчастникиГруппДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеУчастникиГруппДоступа()); +``` +
+ +## НовыеГруппыПользователейГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.ГруппыДоступа +// * Значение - Соответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка.ГруппыПользователей +// - СправочникСсылка.ГруппыВнешнихПользователей +// ** Значение - Соответствие из КлючИЗначение: +// *** Ключ - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// *** Значение - Булево - Истина +// +Функция НовыеГруппыПользователейГруппДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеГруппыПользователейГруппДоступа()); +``` +
+ +## ЗаполнитьУчастниковГруппДоступаСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваПорцииКлючейДоступаСписка. +Процедура ЗаполнитьУчастниковГруппДоступаСписка(ПараметрыОбновления, Кэш) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьУчастниковГруппДоступаСписка(ПараметрыОбновления, Кэш)); +``` +
+ +## ЗаполнитьПользователейГрупп +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗаполнитьПользователейГруппПользователей и +// ЗаполнитьГруппыПользователейКакЗначенияДоступа. +// +Процедура ЗаполнитьПользователейГрупп(ПользователиГруппПользователей, РезультатЗапроса) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПользователейГрупп(ПользователиГруппПользователей, РезультатЗапроса)); +``` +
+ +## НовыеЗначенияГруппыДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Тип - тип значений доступа +// * Значение - Структура: +// ** ВсеРазрешены - Булево +// ** Значения - Соответствие из КлючИЗначение: +// *** Ключ - ОпределяемыйТип.ЗначениеДоступа +// *** Значение - Булево - Истина +// +Функция НовыеЗначенияГруппыДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеЗначенияГруппыДоступа()); +``` +
+ +## НовыеЗначенияГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.ГруппыДоступа +// * Значение - см. НовыеЗначенияГруппыДоступа +// +Функция НовыеЗначенияГруппДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеЗначенияГруппДоступа()); +``` +
+ +## ЗаполнитьЗначенияГруппДоступаДляРасчетаПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваПорцииКлючейДоступаСписка. +Процедура ЗаполнитьЗначенияГруппДоступаДляРасчетаПрав(ПараметрыОбновления, Кэш) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьЗначенияГруппДоступаДляРасчетаПрав(ПараметрыОбновления, Кэш)); +``` +
+ +## НовыеРолиПрофилейГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ТаблицаЗначений: +// * Профиль - СправочникСсылка.ПрофилиГруппДоступа +// * Роль - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений +// * ИмяРоли - Строка +// * ИмяРолиВерхнийРегистр - Строка +// +Функция НовыеРолиПрофилейГруппДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеРолиПрофилейГруппДоступа()); +``` +
+ +## НовыеГруппыДоступаПрофилей +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ТаблицаЗначений: +// * Профиль - СправочникСсылка.ПрофилиГруппДоступа +// * ГруппаДоступа - СправочникСсылка.ГруппыДоступа +// +Функция НовыеГруппыДоступаПрофилей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеГруппыДоступаПрофилей()); +``` +
+ +## ЗаполнитьРолиИГруппыДоступаПрофилей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваПорцииКлючейДоступаСписка. +Процедура ЗаполнитьРолиИГруппыДоступаПрофилей(ПараметрыОбновления, Кэш) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьРолиИГруппыДоступаПрофилей(ПараметрыОбновления, Кэш)); +``` +
+ +## НовыеПраваНаСпискиВедущихКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.КлючиДоступа +// * Значение - ФиксированнаяСтруктура: +// ** ОграничениеЧтенияОтключено - Булево +// ** ОграничениеОтключено - Булево +// ** ПоГруппамДоступа - ФиксированноеСоответствие из КлючИЗначение: +// *** Ключ - СправочникСсылка.ГруппыДоступа +// *** Значение - Булево - право изменение +// +Функция НовыеПраваНаСпискиВедущихКлючейДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеПраваНаСпискиВедущихКлючейДоступа()); +``` +
+ +## НовыеПраваНаВедущиеКлючиДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.КлючиДоступа +// * Значение - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка.ГруппыДоступа +// - СправочникСсылка.ГруппыПользователей +// - СправочникСсылка.ГруппыВнешнихПользователей +// ** Значение - Булево - право изменение +// +Функция НовыеПраваНаВедущиеКлючиДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеПраваНаВедущиеКлючиДоступа()); +``` +
+ +## НовыеПраваНаВедущиеСписки +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение: +// * Ключ - СправочникСсылка.ИдентификаторыОбъектовМетаданных +// - СправочникСсылка.ИдентификаторыОбъектовРасширений - идентификатор списка +// - Тип - тип значений списка +// * Значение - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка.ГруппыДоступа +// - СправочникСсылка.ГруппыПользователей +// - СправочникСсылка.ГруппыВнешнихПользователей +// ** Значение - Булево - право изменение +// +Функция НовыеПраваНаВедущиеСписки() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеПраваНаВедущиеСписки()); +``` +
+ +## ЗаполнитьПраваНаВедущиеКлючиДоступаИВедущиеСписки +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваПорцииКлючейДоступаСписка. +Процедура ЗаполнитьПраваНаВедущиеКлючиДоступаИВедущиеСписки(РезультатыЗапроса, НомерТаблицы, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПраваНаВедущиеКлючиДоступаИВедущиеСписки(РезультатыЗапроса, НомерТаблицы, ПараметрыОбновления)); +``` +
+ +## НовыеПраваПоВладельцамНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение: +// * Ключ - ОпределяемыйТип.ВладелецНастроекПрав +// * Значение - ФиксированноеСоответствие из КлючИЗначение: +// ** Ключ - СправочникСсылка.Пользователи +// - СправочникСсылка.ГруппыПользователей +// - СправочникСсылка.ВнешниеПользователи +// - СправочникСсылка.ГруппыВнешнихПользователей +// ** Значение - Булево - право изменение +// +Функция НовыеПраваПоВладельцамНастроекПрав() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеПраваПоВладельцамНастроекПрав()); +``` +
+ +## ЗаполнитьПраваПоВладельцамНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваПорцииКлючейДоступаСписка. +Процедура ЗаполнитьПраваПоВладельцамНастроекПрав(РезультатыЗапроса, НомерТаблицы, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПраваПоВладельцамНастроекПрав(РезультатыЗапроса, НомерТаблицы, ПараметрыОбновления)); +``` +
+ +## НовыйКонтекстРасчетаПрав +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ЗначенияТаблицКлюча - см. НовыеЗначенияТаблицКлюча +// * БезЗаписиПраваЧтение - Булево +// * РеквизитыТаблицКлюча - см. НовыеРеквизитыТаблицКлюча +// * УчастникиГруппДоступа - см. НовыеУчастникиГруппДоступа +// * ГруппыПользователейГруппДоступа - см. НовыеГруппыПользователейГруппДоступа +// * ГруппыПользователейКакЗначенияДоступа - см. НовыеГруппыПользователейКакЗначенияДоступа +// * ПользователиГруппПользователей - см. НовыеПользователиГруппПользователей +// * ПраваНаСпискиВедущихКлючейДоступа - см. НовыеПраваНаСпискиВедущихКлючейДоступа +// * ПраваНаВедущиеКлючиДоступа - см. НовыеПраваНаВедущиеКлючиДоступа +// * ПраваНаВедущиеСписки - см. НовыеПраваНаВедущиеСписки +// * ПраваПоВладельцамНастроекПрав - см. НовыеПраваПоВладельцамНастроекПрав +// * ТипГруппыДоступа - Тип +// * ПустаяГруппаДоступа - СправочникСсылка.ГруппыДоступа +// * ТипПользователя - Тип +// * ТипГруппыПользователей - Тип +// * ТипыВладельцевНастроекПрав - ФиксированноеСоответствие +// * ПраваРолейФункцииПравоДоступа - Соответствие +// * ОбъектыМетаданныхФункцииПравоДоступа - Соответствие +// * ПраваПрофилейФункцииПравоДоступа - Соответствие +// * РолиПрофилейГруппДоступа - см. РолиПрофилейГруппДоступа +// * ГруппыДоступаПрофилей - см. ГруппыДоступаПрофилей +// * ГруппаДоступа - СправочникСсылка.ГруппыДоступа - текущее значение +// * ЗначенияГруппыДоступа - см. НовыеЗначенияГруппыДоступа +// * ОписанияТребуемыхТаблицКлюча - Массив из Структура: +// ** РеквизитыТаблиц - Соответствие из КлючИЗначение: +// *** Ключ - Строка - имя таблицы ключа +// *** Значение - Массив из Строка - имя реквизита таблицы ключа +// ** ЗначенияТаблиц - см. ТекущиеЗначенияТаблицКлюча +// ** ИндексыСтрокТаблиц - Соответствие +// * ТекущиеСтрокиТаблицКлюча - см. НовыеЗначенияТаблицКлюча +// +Функция НовыйКонтекстРасчетаПрав() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйКонтекстРасчетаПрав()); +``` +
+ +## ПраваНаКлючДоступаСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваНаКлючиДоступаСписка. +Функция ПраваНаКлючДоступаСписка(ЗначенияТаблицКлюча, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПраваНаКлючДоступаСписка(ЗначенияТаблицКлюча, ПараметрыОбновления)); +``` +
+ +## ДобавитьПраваПользователейНаКлючДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПраваНаКлючДоступаСписка. +Процедура ДобавитьПраваПользователейНаКлючДоступа(ПраваНаКлюч, ПравоЧтение, ПравоИзменение, ПравоДобавление, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПраваПользователейНаКлючДоступа(ПраваНаКлюч, ПравоЧтение, ПравоИзменение, ПравоДобавление, Контекст)); +``` +
+ +## НовыеПрава +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ПравоИзменение - Булево +// * ПравоДобавление - Булево +// +Функция НовыеПрава(ПравоИзменение, ПравоДобавление) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеПрава(ПравоИзменение, ПравоДобавление)); +``` +
+ +## ДобавитьПользователямПраваНаКлючДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьПраваПользователейНаКлючДоступа. +Процедура ДобавитьПользователямПраваНаКлючДоступа(ПраваНаКлючДляПользователей, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПользователямПраваНаКлючДоступа(ПраваНаКлючДляПользователей, ); +``` +
+ +## РассчитанноеУсловиеДляСтрок +
+ +Описание, пример вызова + +```bsl + +// Для функций ПраваНаКлючДоступаСписка и РассчитанноеУсловие. +Функция РассчитанноеУсловиеДляСтрок(Контекст, Условие, УзелРеквизитов = Неопределено, ДляЛюбойИзСтрок = Истина, КорневойУзел = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РассчитанноеУсловиеДляСтрок(Контекст, Условие, УзелРеквизитов, ДляЛюбойИзСтрок, КорневойУзел); +``` +
+ +## ДобавитьТекущийРезультат +
+ +Описание, пример вызова + +```bsl + +// Для функции РассчитанноеУсловиеДляСтрок. +Процедура ДобавитьТекущийРезультат(Результат, ТекущийРезультат, ДляЛюбойИзСтрок, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТекущийРезультат(Результат, ТекущийРезультат, ДляЛюбойИзСтрок, Контекст)); +``` +
+ +## ПользователиГрупп +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекущийРезультат и УстановитьОбратныйРезультат. +Функция ПользователиГрупп(ПользователиИГруппы, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПользователиГрупп(ПользователиИГруппы, Контекст)); +``` +
+ +## УстановитьОбратныйРезультат +
+ +Описание, пример вызова + +```bsl + +// Для функции РассчитанноеУсловие. +Процедура УстановитьОбратныйРезультат(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьОбратныйРезультат(Результат, Контекст)); +``` +
+ +## ТекущиеЗначенияТаблицКлюча +
+ +Описание, пример вызова + +```bsl + +// Для функции РассчитанноеУсловиеДляСтрок. +// +// Возвращаемое значение: +// Структура из КлючИЗначение: +// * Ключ - Строка - имя таблицы ключа +// * Значение - см. ЗначенияТаблицыКлюча +// +Функция ТекущиеЗначенияТаблицКлюча(Контекст, ТребуемыеРеквизитыТабличныхЧастейКлюча) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекущиеЗначенияТаблицКлюча(Контекст, ТребуемыеРеквизитыТабличныхЧастейКлюча)); +``` +
+ +## РассчитанноеУсловие +
+ +Описание, пример вызова + +```bsl + +// Для функции РассчитанноеУсловиеДляСтрок. +Функция РассчитанноеУсловие(Контекст, Условие, КорневойУзел = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РассчитанноеУсловие(Контекст, Условие, КорневойУзел); +``` +
+ +## ЗначениеУказаноВГруппеПользователей +
+ +Описание, пример вызова + +```bsl + +// Для функции РассчитанноеУсловие. +Функция ЗначениеУказаноВГруппеПользователей(Пользователь, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗначениеУказаноВГруппеПользователей(Пользователь, Контекст)); +``` +
+ +## ЗаполнитьРезультатДляПользователя +
+ +Описание, пример вызова + +```bsl + +// Для функции РассчитанноеУсловие. +Процедура ЗаполнитьРезультатДляПользователя(Результат, Пользователь, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьРезультатДляПользователя(Результат, Пользователь, Контекст)); +``` +
+ +## ЗаполнитьРезультатДляГруппыПользователей +
+ +Описание, пример вызова + +```bsl + +// Для функции РассчитанноеУсловие. +Процедура ЗаполнитьРезультатДляГруппыПользователей(Результат, ГруппаПользователей, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьРезультатДляГруппыПользователей(Результат, ГруппаПользователей, Контекст)); +``` +
+ +## ЕстьПравоДоступаВРоляхПрофиляГруппыДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции РассчитанноеУсловие. +Функция ЕстьПравоДоступаВРоляхПрофиляГруппыДоступа(Условие, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЕстьПравоДоступаВРоляхПрофиляГруппыДоступа(Условие, Контекст)); +``` +
+ +## ЕстьРольВПрофилеГруппыДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции РассчитанноеУсловие. +Функция ЕстьРольВПрофилеГруппыДоступа(Условие, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЕстьРольВПрофилеГруппыДоступа(Условие, Контекст)); +``` +
+ +## ОбновитьПраваНаКлючДоступаСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваПорцииКлючейДоступаСписка. +Процедура ОбновитьПраваНаКлючДоступаСписка(КлючДоступа, ПраваНаКлюч, ОписаниеНовыхКлючей, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьПраваНаКлючДоступаСписка(КлючДоступа, ПраваНаКлюч, ОписаниеНовыхКлючей, ПараметрыОбновления)); +``` +
+ +## ТекстЗапросаВыбораРазличийПроизводныхПравДляГруппДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьПраваНаКлючДоступаСписка, ОбновитьГруппыДоступаРазрешенногоКлючаДоступа. +Функция ТекстЗапросаВыбораРазличийПроизводныхПравДляГруппДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаВыбораРазличийПроизводныхПравДляГруппДоступа()); +``` +
+ +## ТекстЗапросаВыбораРазличийПроизводныхПравДляПользователей +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьПраваНаКлючДоступаСписка. +Функция ТекстЗапросаВыбораРазличийПроизводныхПравДляПользователей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаВыбораРазличийПроизводныхПравДляПользователей()); +``` +
+ +## ТекстЗапросаВыбораРазличийПроизводныхПравДляВнешнихПользователей +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьПраваНаКлючДоступаСписка. +Функция ТекстЗапросаВыбораРазличийПроизводныхПравДляВнешнихПользователей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаВыбораРазличийПроизводныхПравДляВнешнихПользователей()); +``` +
+ +## НовыйКлючДоступаУжеСуществует +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваНаКлючДоступаСписка. +Функция НовыйКлючДоступаУжеСуществует(ОписаниеНовыхКлючей, ОписаниеНовогоКлюча, ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйКлючДоступаУжеСуществует(ОписаниеНовыхКлючей, ОписаниеНовогоКлюча, ПараметрыОбновления)); +``` +
+ +## ОбновитьИсходныеПраваГруппНаКлючДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваНаКлючДоступаСписка. +Процедура ОбновитьИсходныеПраваГруппНаКлючДоступа(РезультатЗапроса, НаборЗаписей, ИмяПоляВладельцаПрав, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьИсходныеПраваГруппНаКлючДоступа(РезультатЗапроса, НаборЗаписей, ИмяПоляВладельцаПрав, ); +``` +
+ +## ОбновитьИсходныеПраваПользователейНаКлючДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваНаКлючДоступаСписка. +Процедура ОбновитьИсходныеПраваПользователейНаКлючДоступа(РезультатЗапроса, НаборЗаписей, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьИсходныеПраваПользователейНаКлючДоступа(РезультатЗапроса, НаборЗаписей, ); +``` +
+ +## ОбновитьПроизводныеПраваНаКлючДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьПраваНаКлючДоступаСписка. +Процедура ОбновитьПроизводныеПраваНаКлючДоступа(РезультатЗапроса, НаборЗаписей, ИмяПоляВладельцаПрав, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьПроизводныеПраваНаКлючДоступа(РезультатЗапроса, НаборЗаписей, ИмяПоляВладельцаПрав, ); +``` +
+ +## СлужебныйЭлемент +
+ +Описание, пример вызова + +```bsl + +// Создает служебный элемент справочника, который не участвует в подписках на события. +Функция СлужебныйЭлемент(МенеджерСправочника, Ссылка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СлужебныйЭлемент(МенеджерСправочника, Ссылка); +``` +
+ +## СлужебныйНаборЗаписей +
+ +Описание, пример вызова + +```bsl + +// Создает набор записей служебного регистра, который не участвует в подписках на события. +Функция СлужебныйНаборЗаписей(МенеджерРегистра) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СлужебныйНаборЗаписей(МенеджерРегистра)); +``` +
+ +## СлужебныйМенеджерЗначения +
+ +Описание, пример вызова + +```bsl + +// Создает менеджер значения служебной константы, которая не участвует в подписках на события. +Функция СлужебныйМенеджерЗначения(МенеджерКонстанты) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СлужебныйМенеджерЗначения(МенеджерКонстанты)); +``` +
+ +## ЗарегистрироватьПланированиеОбновленияДоступаВЖурнале +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗарегистрироватьПланированиеОбновленияДоступа. +Процедура ЗарегистрироватьПланированиеОбновленияДоступаВЖурнале(Списки, ПараметрыПланирования) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗарегистрироватьПланированиеОбновленияДоступаВЖурнале(Списки, ПараметрыПланирования)); +``` +
+ +## ОписаниеУказателяВедущегоОбъекта +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗарегистрироватьПланированиеОбновленияДоступаВЖурнале. +Функция ОписаниеУказателяВедущегоОбъекта(Указатель, ПараметрыПланирования) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеУказателяВедущегоОбъекта(Указатель, ПараметрыПланирования)); +``` +
+ +## ЗарегистрироватьПланированиеОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для вызова из мест планирования обновления доступа. +Процедура ЗарегистрироватьПланированиеОбновленияДоступа(СпискиПоИдентификаторам, ПараметрыПланирования, ВсеСписки = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗарегистрироватьПланированиеОбновленияДоступа(СпискиПоИдентификаторам, ПараметрыПланирования, ВсеСписки); +``` +
+ +## ПолноеИмяСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗарегистрироватьПланированиеОбновленияДоступа. +Функция ПолноеИмяСписка(ОписаниеСписка) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПолноеИмяСписка(ОписаниеСписка)); +``` +
+ +## ДобавитьЗависимыеСписки +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УправлениеДоступом.ОтключитьОбновлениеКлючейДоступа. +// +// Параметры: +// Списки - Массив +// ДобавленныеСписки - Соответствие +// НедоступныеСписки - Массив - возвращаемое значение. +// +Процедура ДобавитьЗависимыеСписки(Списки, ДобавленныеСписки, НедоступныеСписки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗависимыеСписки(Списки, ДобавленныеСписки, НедоступныеСписки) +``` +
+ +## ОписаниеОграниченийДанных +
+ +Описание, пример вызова + +```bsl + +Функция ОписаниеОграниченийДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеОграниченийДанных() +``` +
+ +## КоличествоЧасовУстареванияНеиспользуемыхЭлементов +
+ +Описание, пример вызова + +```bsl + +Функция КоличествоЧасовУстареванияНеиспользуемыхЭлементов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КоличествоЧасовУстареванияНеиспользуемыхЭлементов()); +``` +
+ +## КоличествоЧасовМеждуПланированиемОбработкиУстаревшихЭлементов +
+ +Описание, пример вызова + +```bsl + +Функция КоличествоЧасовМеждуПланированиемОбработкиУстаревшихЭлементов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КоличествоЧасовМеждуПланированиемОбработкиУстаревшихЭлементов()); +``` +
+ +## МаксимальноеКоличествоМинутВыполненияФоновогоЗаданияОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +Функция МаксимальноеКоличествоМинутВыполненияФоновогоЗаданияОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МаксимальноеКоличествоМинутВыполненияФоновогоЗаданияОбновленияДоступа()); +``` +
+ +## МаксимальноеКоличествоСекундОжиданияВыполненияОдногоЗаданияВПотоке +
+ +Описание, пример вызова + +```bsl + +Функция МаксимальноеКоличествоСекундОжиданияВыполненияОдногоЗаданияВПотоке() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МаксимальноеКоличествоСекундОжиданияВыполненияОдногоЗаданияВПотоке() +``` +
+ +## МинимальноеКоличествоСекундОбработкиПорцииВОтдельномПотоке +
+ +Описание, пример вызова + +```bsl + +Функция МинимальноеКоличествоСекундОбработкиПорцииВОтдельномПотоке() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МинимальноеКоличествоСекундОбработкиПорцииВОтдельномПотоке()); +``` +
+ +## МинимальноеКоличествоСекундВыполненияТочечногоЗадания +
+ +Описание, пример вызова + +```bsl + +Функция МинимальноеКоличествоСекундВыполненияТочечногоЗадания() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МинимальноеКоличествоСекундВыполненияТочечногоЗадания()); +``` +
+ +## ЗагружатьСвободныеПотокиСледующимиЗаданиямиПриДлительныхЗапросах +
+ +Описание, пример вызова + +```bsl + +Функция ЗагружатьСвободныеПотокиСледующимиЗаданиямиПриДлительныхЗапросах() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗагружатьСвободныеПотокиСледующимиЗаданиямиПриДлительныхЗапросах()); +``` +
+ +## МаксимальныйПериодПолученияПорцийЗапросом +
+ +Описание, пример вызова + +```bsl + +Функция МаксимальныйПериодПолученияПорцийЗапросом() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МаксимальныйПериодПолученияПорцийЗапросом()); +``` +
+ +## ЗапускатьОбновлениеПолученныхПорцийПриПолученииНовыхПорций +
+ +Описание, пример вызова + +```bsl + +Функция ЗапускатьОбновлениеПолученныхПорцийПриПолученииНовыхПорций() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗапускатьОбновлениеПолученныхПорцийПриПолученииНовыхПорций()); +``` +
+ +## МаксимальноеКоличествоСекундБыстрогоПолученияПорцийЭлементовДанных +
+ +Описание, пример вызова + +```bsl + +Функция МаксимальноеКоличествоСекундБыстрогоПолученияПорцийЭлементовДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МаксимальноеКоличествоСекундБыстрогоПолученияПорцийЭлементовДанных()); +``` +
+ +## КоличествоЭлементовДанныхВЗапросе +
+ +Описание, пример вызова + +```bsl + +Функция КоличествоЭлементовДанныхВЗапросе() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КоличествоЭлементовДанныхВЗапросе()); +``` +
+ +## КоличествоЭлементовДанныхВПорции +
+ +Описание, пример вызова + +```bsl + +Функция КоличествоЭлементовДанныхВПорции() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КоличествоЭлементовДанныхВПорции()); +``` +
+ +## КоличествоКлючейДоступаВЗапросе +
+ +Описание, пример вызова + +```bsl + +Функция КоличествоКлючейДоступаВЗапросе() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КоличествоКлючейДоступаВЗапросе()); +``` +
+ +## КоличествоКлючейДоступаВПорции +
+ +Описание, пример вызова + +```bsl + +Функция КоличествоКлючейДоступаВПорции() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КоличествоКлючейДоступаВПорции()); +``` +
+ +## ЗаписыватьТолькоИзмененныеКлючиДоступаЭлементовДанных +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписыватьТолькоИзмененныеКлючиДоступаЭлементовДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗаписыватьТолькоИзмененныеКлючиДоступаЭлементовДанных()); +``` +
+ +## МаксимальноеКоличествоКомбинацийЗначенийВедущихПолейПриВычисленииСоставаИзмененных +
+ +Описание, пример вызова + +```bsl + +Функция МаксимальноеКоличествоКомбинацийЗначенийВедущихПолейПриВычисленииСоставаИзмененных() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МаксимальноеКоличествоКомбинацийЗначенийВедущихПолейПриВычисленииСоставаИзмененных()); +``` +
+ +## КоличествоСекундПередОтключениемРегламентногоЗаданияПослеПолногоЗавершенияОбновления +
+ +Описание, пример вызова + +```bsl + +Функция КоличествоСекундПередОтключениемРегламентногоЗаданияПослеПолногоЗавершенияОбновления() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КоличествоСекундПередОтключениемРегламентногоЗаданияПослеПолногоЗавершенияОбновления()); +``` +
+ +## ЗапускатьОбновлениеДоступаДляУскоренияТолькоТочечныхЗаданий +
+ +Описание, пример вызова + +```bsl + +Функция ЗапускатьОбновлениеДоступаДляУскоренияТолькоТочечныхЗаданий(ПроверкаПриЗапуске) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗапускатьОбновлениеДоступаДляУскоренияТолькоТочечныхЗаданий(ПроверкаПриЗапуске)); +``` +
+ +## РегистрироватьПоказателиОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +Функция РегистрироватьПоказателиОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РегистрироватьПоказателиОбновленияДоступа()); +``` +
+ +## РегистрироватьПоказателиПланированияОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +Функция РегистрироватьПоказателиПланированияОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РегистрироватьПоказателиПланированияОбновленияДоступа()); +``` +
+ +## РегистрироватьСтрокуВерсииПараметровОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +Функция РегистрироватьСтрокуВерсииПараметровОграниченияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РегистрироватьСтрокуВерсииПараметровОграниченияДоступа()); +``` +
+ +## ПередБлокировкойДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПередБлокировкойДанных(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередБлокировкойДанных(ПараметрыОбновления)); +``` +
+ +## ПослеБлокировкиДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеБлокировкиДанных(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПослеБлокировкиДанных(ПараметрыОбновления)); +``` +
+ +## ПередЗапросомТекущихКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗапросомТекущихКлючейДоступа(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередЗапросомТекущихКлючейДоступа(ПараметрыОбновления)); +``` +
+ +## ПослеЗапросаТекущихКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеЗапросаТекущихКлючейДоступа(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПослеЗапросаТекущихКлючейДоступа(ПараметрыОбновления)); +``` +
+ +## ПередЗаписьюСтрок +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗаписьюСтрок(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередЗаписьюСтрок(ПараметрыОбновления)); +``` +
+ +## ПослеЗаписиСтрок +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеЗаписиСтрок(ПараметрыОбновления, КоличествоЗаписанных) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПослеЗаписиСтрок(ПараметрыОбновления, КоличествоЗаписанных)); +``` +
+ +## ПередФиксациейТранзакции +
+ +Описание, пример вызова + +```bsl + +Процедура ПередФиксациейТранзакции(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередФиксациейТранзакции(ПараметрыОбновления)); +``` +
+ +## ПослеФиксацииТранзакции +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеФиксацииТранзакции(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПослеФиксацииТранзакции(ПараметрыОбновления)); +``` +
+ +## ПередПланированиемОбновления +
+ +Описание, пример вызова + +```bsl + +Процедура ПередПланированиемОбновления(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередПланированиемОбновления(ПараметрыОбновления)); +``` +
+ +## ПослеПланированияОбновления +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеПланированияОбновления(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПослеПланированияОбновления(ПараметрыОбновления)); +``` +
+ +## ПередЗаписьюНовогоКлюча +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗаписьюНовогоКлюча(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередЗаписьюНовогоКлюча(ПараметрыОбновления)); +``` +
+ +## ПослеЗаписиНовогоКлюча +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеЗаписиНовогоКлюча(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПослеЗаписиНовогоКлюча(ПараметрыОбновления)); +``` +
+ +## ПередЗапросомПравГруппДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗапросомПравГруппДоступа(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередЗапросомПравГруппДоступа(ПараметрыОбновления)); +``` +
+ +## ПослеЗапросаПравГруппДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеЗапросаПравГруппДоступа(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПослеЗапросаПравГруппДоступа(ПараметрыОбновления)); +``` +
+ +## ПередЗапросомИзмененийПроизводныхПрав +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗапросомИзмененийПроизводныхПрав(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередЗапросомИзмененийПроизводныхПрав(ПараметрыОбновления)); +``` +
+ +## ПослеЗапросаИзмененийПроизводныхПрав +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеЗапросаИзмененийПроизводныхПрав(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПослеЗапросаИзмененийПроизводныхПрав(ПараметрыОбновления)); +``` +
+ +## ПередЗапросомПравПользователей +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗапросомПравПользователей(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередЗапросомПравПользователей(ПараметрыОбновления)); +``` +
+ +## ПослеЗапросаПравПользователей +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеЗапросаПравПользователей(ПараметрыОбновления) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПослеЗапросаПравПользователей(ПараметрыОбновления)); +``` +
+ +## ПередИзменениемПараметровСеансаДляШаблонов +
+ +Описание, пример вызова + +```bsl + +Процедура ПередИзменениемПараметровСеансаДляШаблонов(НовыеЗначения, ЭтоУстановка) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПередИзменениемПараметровСеансаДляШаблонов(НовыеЗначения, ЭтоУстановка)); +``` +
+ +## ПриОшибкеПроверкиАктуальностиМетаданных +
+ +Описание, пример вызова + +```bsl + +Процедура ПриОшибкеПроверкиАктуальностиМетаданных(ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПриОшибкеПроверкиАктуальностиМетаданных(ТекстОшибки)); +``` +
+ +## СвойстваСпискаКакВедущего +
+ +Описание, пример вызова + +```bsl + +// Основная функция, возвращающая параметры, необходимые для регистрации +// необходимости обновления ключей доступа к элементам данных. +// +// Параметры: +// ПолноеИмя - Строка - полное имя списка +// ИдентификаторТранзакции - УникальныйИдентификатор +// ПовторныйВызов - Булево - только при вызове из самой же функции +// +// Возвращаемое значение: +// Структура: +// * ЗависимыеСписки - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка. +// ** Значение - Булево - Истина. +// * ПоЗначениямПолей - см. ВедущийСписокПоЗначениямПолей +// * ПоКлючамДоступа - см. ВедущийСписокПоКлючамДоступаИлиЗначениямСГруппами +// * ПоЗначениямСГруппами - см. ВедущийСписокПоКлючамДоступаИлиЗначениямСГруппами +// +Функция СвойстваСпискаКакВедущего(ПолноеИмя, ИдентификаторТранзакции = Неопределено, ПовторныйВызов = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваСпискаКакВедущего(ПолноеИмя, ИдентификаторТранзакции, ПовторныйВызов); +``` +
+ +## НовыйКэшПараметровОграничения +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ВедущиеСпискиПроверенные - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. УправлениеДоступомСлужебный.СвойстваСпискаКакВедущего +// * ОграниченияСписков - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. УправлениеДоступомСлужебный.РассчитанныеПараметрыОграничения +// * ИдентификаторыТранзакции - Соответствие из КлючИЗначение: +// ** Ключ - УникальныйИдентификатор - произвольный УИД. +// ** Значение - Булево - значение Истина. +// * ВидыОграниченийПравДляПользователей - Неопределено +// - Строка +// * ВидыОграниченийПравДляВнешнихПользователей - Неопределено +// - Строка +// +Функция НовыйКэшПараметровОграничения() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйКэшПараметровОграничения() +``` +
+ +## КэшПараметровОграничения +
+ +Описание, пример вызова + +```bsl + +// Для функции СвойстваСпискаКакВедущего и процедур ЗаполнитьПараметрыОграничения, +// ОбновитьИдентификаторыТранзакции, УстановитьВерсиюПараметров. +// +Функция КэшПараметровОграничения() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КэшПараметровОграничения()); +``` +
+ +## СброситьКэшПараметровОграничения +
+ +Описание, пример вызова + +```bsl + +Процедура СброситьКэшПараметровОграничения() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СброситьКэшПараметровОграничения()); +``` +
+ +## ЗаполнитьТекстЗапросаСтарыхЗначенийДляПроверкиИзмененияПолейВедущегоСписка +
+ +Описание, пример вызова + +```bsl + +// Для функции СвойстваСпискаКакВедущего. +Процедура ЗаполнитьТекстЗапросаСтарыхЗначенийДляПроверкиИзмененияПолейВедущегоСписка(ПолноеИмя, Свойства, Отказ) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьТекстЗапросаСтарыхЗначенийДляПроверкиИзмененияПолейВедущегоСписка(ПолноеИмя, Свойства, Отказ)); +``` +
+ +## ЗаполнитьПоляВыбораТекущейТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьТекстЗапросаСтарыхЗначенийДляПроверкиИзмененияПолейВедущегоСписка. +Процедура ЗаполнитьПоляВыбораТекущейТаблицы(ТекстЗапроса, ПолноеИмя, ОписаниеПолей, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПоляВыбораТекущейТаблицы(ТекстЗапроса, ПолноеИмя, ОписаниеПолей, ); +``` +
+ +## ПолеСуществует +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьПоляВыбораТекущейТаблицы. +Функция ПолеСуществует(Коллекция, ИмяПоля) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПолеСуществует(Коллекция, ИмяПоля)); +``` +
+ +## ПараметрыОграничения +
+ +Описание, пример вызова + +```bsl + +// Основная функция, возвращающая параметры, необходимые для проверки прав в момент записи элементов данных. +// +// Возвращаемое значение: +// см. ПараметрыОграниченияПоСтруктуреОграничения +// +Функция ПараметрыОграничения(ПолноеИмя, ИдентификаторТранзакции = Неопределено, ДляВнешнихПользователей = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПараметрыОграничения(ПолноеИмя, ИдентификаторТранзакции, ДляВнешнихПользователей); +``` +
+ +## ЗаполнитьПараметрыОграничения +
+ +Описание, пример вызова + +```bsl + +// Для функций СвойстваСпискаКакВедущего, ПараметрыОграничения. +Процедура ЗаполнитьПараметрыОграничения(ПолноеИмя, ИдентификаторТранзакции, Параметры, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПараметрыОграничения(ПолноеИмя, ИдентификаторТранзакции, Параметры, ); +``` +
+ +## ОбщийКонтекстРасчетаПараметровОграничения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьПараметрыОграничения и функций +// ХранимыеПараметрыОграниченияДоступа, ОшибкиОграниченийДоступа. +// +// Возвращаемое значение: +// Структура: +// * СвойстваВидовДоступа - см. СвойстваВидовДоступа +// * ТипыПользователя - Массив из Тип +// * ТипыВладельцевНастроекПрав - ФиксированноеСоответствие +// * ОтдельныеТаблицыНастроекПрав - ФиксированноеСоответствие +// * ВнешниеПользователиВключены - Булево +// * ИспользуемыеТипыЗначений - см. ИспользуемыеТипыЗначений +// * СпискиСОграничением - см. УправлениеДоступомСлужебныйПовтИсп.СпискиСОграничением +// +Функция ОбщийКонтекстРасчетаПараметровОграничения(ПолноеИмя = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбщийКонтекстРасчетаПараметровОграничения(ПолноеИмя, ); +``` +
+ +## ИспользуемыеТипыЗначений +
+ +Описание, пример вызова + +```bsl + +// Для функций ОбщийКонтекстРасчетаПараметровОграничения и ИспользованиеВидовДоступаИзменено. +// +// Параметры: +// СвойстваВидовДоступа - см. СвойстваВидовДоступа +// ПолноеИмя - Строка +// ВсеВидыДоступаИспользуются - Неопределено +// - Булево +// ТолькоХешСумма - Булево +// +// Возвращаемое значение: +// Структура: +// * ДляИБ - Соответствие из КлючИЗначение: +// ** Ключ - Тип +// ** Значение - Булево - Истина +// * ПоТаблицам - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя объекта метаданных +// ** Значение - Соответствие из КлючИЗначение: +// *** Ключ - Тип +// *** Значение - Булево - Истина +// * ХешСумма - Строка - контрольная сумма настроек использования ДляИБ и ПоТаблицам. +// * ПолноеИмяТаблицы - Строка - полное имя таблицы, когда свойство ПоТаблицам +// заполнено только для одной таблицы. +// - Неопределено - когда свойство ПоТаблицам не заполнялось (ВсеВидыДоступаИспользуются = Истина). +// +Функция ИспользуемыеТипыЗначений(СвойстваВидовДоступа, ПолноеИмя = Неопределено, ВсеВидыДоступаИспользуются = Неопределено, ТолькоХешСумма = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИспользуемыеТипыЗначений(СвойстваВидовДоступа, ПолноеИмя, ВсеВидыДоступаИспользуются, ТолькоХешСумма); +``` +
+ +## РассчитанныеПараметрыОграничения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьПараметрыОграниченияСписка. +// +// Возвращаемое значение: +// Структура: +// * Версия - Строка +// * ВедущиеСписки - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. СвойстваСпискаКакВедущего +// * ДляПользователей - см. ПараметрыОграниченияПоСтруктуреОграничения +// * ДляВнешнихПользователей - см. ПараметрыОграниченияПоСтруктуреОграничения +// +Функция РассчитанныеПараметрыОграничения(ПолноеИмя, ОбщийКонтекст, ДействующиеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РассчитанныеПараметрыОграничения(ПолноеИмя, ОбщийКонтекст, ДействующиеПараметры) +``` +
+ +## ОшибкаОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции ОшибкиОграниченийДоступа. +Функция ОшибкаОграниченияДоступа(ОбщийКонтекст, ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОшибкаОграниченияДоступа(ОбщийКонтекст, ПолноеИмя)); +``` +
+ +## РезультатПроверкиОграниченияДоступаОбъекта +
+ +Описание, пример вызова + +```bsl + +// Для функции РезультатПроверкиОграниченияДоступа. +Функция РезультатПроверкиОграниченияДоступаОбъекта(ПолноеИмя, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РезультатПроверкиОграниченияДоступаОбъекта(ПолноеИмя, ДополнительныеПараметры)); +``` +
+ +## УстановитьОграничениеПоВладельцуИспользуется +
+ +Описание, пример вызова + +```bsl + +// Для функции РезультатПроверкиОграниченияДоступаОбъекта +Процедура УстановитьОграничениеПоВладельцуИспользуется(Результат, ПолноеИмя, ДополнительныйКонтекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьОграничениеПоВладельцуИспользуется(Результат, ПолноеИмя, ДополнительныйКонтекст)); +``` +
+ +## УстановитьНастройкиВнедрения +
+ +Описание, пример вызова + +```bsl + +// Для функции РезультатПроверкиОграниченияДоступаОбъекта. +Процедура УстановитьНастройкиВнедрения(НастройкиВнедрения, Данные, ТипыТаблицПоИменам) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьНастройкиВнедрения(НастройкиВнедрения, Данные, ТипыТаблицПоИменам)); +``` +
+ +## ДобавитьТипыТребуемыеВОпределяемомТипе +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьНастройкиВнедрения. +Процедура ДобавитьТипыТребуемыеВОпределяемомТипе(НастройкиВнедрения, ТипыТаблицПоИменам, ТипыСсылок, ИменаТипов, ИмяОпределяемогоТипа) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТипыТребуемыеВОпределяемомТипе(НастройкиВнедрения, ТипыТаблицПоИменам, ТипыСсылок, ИменаТипов, ИмяОпределяемогоТипа)); +``` +
+ +## СписокТиповИзМассива +
+ +Описание, пример вызова + +```bsl + +// Для процедур УстановитьНастройкиВнедрения, ДобавитьТипыТребуемыеВОпределяемомТипе. +Функция СписокТиповИзМассива(ИменаТипов, ТипыСсылок, ТипыТаблицПоИменам, ОписаниеТипов) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СписокТиповИзМассива(ИменаТипов, ТипыСсылок, ТипыТаблицПоИменам, ОписаниеТипов)); +``` +
+ +## СтруктураРезультатаПроверкиОграниченияДляВидаПользователей +
+ +Описание, пример вызова + +```bsl + +// Для функции РезультатПроверкиОграниченияДоступаОбъекта. +Функция СтруктураРезультатаПроверкиОграниченияДляВидаПользователей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтруктураРезультатаПроверкиОграниченияДляВидаПользователей()); +``` +
+ +## ПроверитьОграничениеДляВидаПользователей +
+ +Описание, пример вызова + +```bsl + +// Для функции РезультатПроверкиОграниченияДоступаОбъекта. +Процедура ПроверитьОграничениеДляВидаПользователей(Контекст, Результат, ДляВнешнихПользователей, ДополнительныйКонтекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьОграничениеДляВидаПользователей(Контекст, Результат, ДляВнешнихПользователей, ДополнительныйКонтекст)); +``` +
+ +## ОбщаяВерсия +
+ +Описание, пример вызова + +```bsl + +// Для функций ХранимыеПараметрыОграниченияДоступа, РассчитанныеПараметрыОграничения. +Функция ОбщаяВерсия(ОбщийКонтекст, ПолноеИмя, ВерсияДляПользователей, ВерсияДляВнешнихПользователей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбщаяВерсия(ОбщийКонтекст, ПолноеИмя, ВерсияДляПользователей, ВерсияДляВнешнихПользователей)); +``` +
+ +## УстановитьСвойстваЗаписиКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции РассчитанныеПараметрыОграничения. +Процедура УстановитьСвойстваЗаписиКлючейДоступа(Результат) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьСвойстваЗаписиКлючейДоступа(Результат)); +``` +
+ +## ОписаниеОграниченияДанных +
+ +Описание, пример вызова + +```bsl + +// Для функций РассчитанныеПараметрыОграничения, ХранимыеПараметрыОграниченияДоступа. +// +// Возвращаемое значение: +// Структура: +// * Текст - Строка +// * ТекстДляВнешнихПользователей - Строка +// * ПоВладельцуБезЗаписиКлючейДоступа - Булево +// - Неопределено +// * ПоВладельцуБезЗаписиКлючейДоступаДляВнешнихПользователей - Булево +// - Неопределено +// * ТекстВМодулеМенеджера - Булево +// +Функция ОписаниеОграниченияДанных(ОбщийКонтекст, ПолноеИмя, БезВызоваИсключения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеОграниченияДанных(ОбщийКонтекст, ПолноеИмя, БезВызоваИсключения); +``` +
+ +## ЭтоЖурналДокументов +
+ +Описание, пример вызова + +```bsl + +// Для функции ОписаниеОграниченияДанных. +Функция ЭтоЖурналДокументов(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоЖурналДокументов(ПолноеИмя)); +``` +
+ +## РассчитаннаяСтруктураОграничения +
+ +Описание, пример вызова + +```bsl + +// Для функций РассчитанныеПараметрыОграничения и ПараметрыОграниченияДляВидаПользователей. +// +// Возвращаемое значение: +// см. СтруктураОграничения +// +Функция РассчитаннаяСтруктураОграничения(ПолноеИмя, ТекстОграничения, ТекстВМодулеМенеджера, ДляВнешнихПользователей, БезИсключения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РассчитаннаяСтруктураОграничения(ПолноеИмя, ТекстОграничения, ТекстВМодулеМенеджера, ДляВнешнихПользователей, БезИсключения); +``` +
+ +## ДействующиеПараметрыОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функций СвойстваСпискаКакВедущего, ПараметрыОграничения и процедур УстановкаПараметровСеанса, +// ЗаполнитьПараметрыОграничения, ДобавитьПараметрыОграниченияСписка. +// +// Возвращаемое значение: +// см. НоваяСтруктураХранимыхПараметровЗаписи +// +Функция ДействующиеПараметрыОграниченияДоступа(ИдентификаторТранзакции, ОбщийКонтекст, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ДействующиеПараметрыОграниченияДоступа(ИдентификаторТранзакции, ОбщийКонтекст, ); +``` +
+ +## ВсеВидыОграниченийПравДляОтчетаПраваДоступа +
+ +Описание, пример вызова + +```bsl + +// Для отчета ПраваДоступа. +// +// Возвращаемое значение: +// Структура: +// * ДляПользователей - Строка +// * ДляВнешнихПользователей - Строка +// +Функция ВсеВидыОграниченийПравДляОтчетаПраваДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВсеВидыОграниченийПравДляОтчетаПраваДоступа()); +``` +
+ +## ЗаписьПараметровОграниченияДоступаВТекущемСеансе +
+ +Описание, пример вызова + +```bsl + +// Для функции НоваяВерсияПараметровОграниченияДоступа. +Функция ЗаписьПараметровОграниченияДоступаВТекущемСеансе() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗаписьПараметровОграниченияДоступаВТекущемСеансе()); +``` +
+ +## ОписаниеПоследнейВерсии +
+ +Описание, пример вызова + +```bsl + +// Для функций ДействующиеПараметрыОграниченияДоступа, НоваяВерсияПараметровОграниченияДоступа. +// +// Возвращаемое значение: +// Структура: +// * Версия - Число +// - Неопределено +// * ХешСумма - Строка +// - Неопределено +// * ДатаСоздания - Дата +// - Неопределено +// * ВерсииПараметровШаблонов - ХранилищеЗначения +// - Неопределено +// +Функция ОписаниеПоследнейВерсии(ПрочитатьВерсииПараметровШаблонов = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеПоследнейВерсии(ПрочитатьВерсииПараметровШаблонов); +``` +
+ +## ВерсияПараметров +
+ +Описание, пример вызова + +```bsl + +// Для функции ДействующиеПараметрыОграниченияДоступа. +Функция ВерсияПараметров(Версия, УстановкаПараметровСеансаДляШаблонов, УстановкаПараметровДляОтчетаПраваДоступа) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВерсияПараметров(Версия, УстановкаПараметровСеансаДляШаблонов, УстановкаПараметровДляОтчетаПраваДоступа)); +``` +
+ +## НоваяВерсияПараметровОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции ДействующиеПараметрыОграниченияДоступа. +// +// Возвращаемое значение: +// см. ХранимыеПараметрыОграниченияДоступа +// +Функция НоваяВерсияПараметровОграниченияДоступа(ОбщийКонтекст, ЕстьИзменения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяВерсияПараметровОграниченияДоступа(ОбщийКонтекст, ЕстьИзменения); +``` +
+ +## ЗавершеныЗаданияЗаписиНовойВерсииПараметровОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функций НоваяВерсияПараметровОграниченияДоступа и +// ДействующиеПараметрыОграниченияДоступа. +// +Функция ЗавершеныЗаданияЗаписиНовойВерсииПараметровОграниченияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗавершеныЗаданияЗаписиНовойВерсииПараметровОграниченияДоступа()); +``` +
+ +## ИмяПроцедурыЗаданияЗаписиНовойВерсииПараметровОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функций НоваяВерсияПараметровОграниченияДоступа и +// ЗавершеныЗаданияЗаписиНовойВерсииПараметровОграниченияДоступа. +// +Функция ИмяПроцедурыЗаданияЗаписиНовойВерсииПараметровОграниченияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИмяПроцедурыЗаданияЗаписиНовойВерсииПараметровОграниченияДоступа()); +``` +
+ +## НоваяИнформацияНесоответствияПараметровДляЖурнала +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// Предупреждение - Строка +// Ошибка - Строка +// ВерсияТекстовОграниченияДоступа - Строка +// +Функция НоваяИнформацияНесоответствияПараметровДляЖурнала() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяИнформацияНесоответствияПараметровДляЖурнала()); +``` +
+ +## ЗаписатьНовуюВерсиюПараметровОграниченияДоступаВФоне +
+ +Описание, пример вызова + +```bsl + +// Для функции НоваяВерсияПараметровОграниченияДоступа. +Процедура ЗаписатьНовуюВерсиюПараметровОграниченияДоступаВФоне(АдресРезультата, ХранилищеПараметров) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьНовуюВерсиюПараметровОграниченияДоступаВФоне(АдресРезультата, ХранилищеПараметров) +``` +
+ +## ИдентификаторДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции НоваяВерсияПараметровОграниченияДоступа и +// процедуры ЗаписатьНовуюВерсиюПараметровОграниченияДоступаВФоне. +// +Функция ИдентификаторДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИдентификаторДоступа()); +``` +
+ +## ОписаниеНовойВерсииПараметровОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции НоваяВерсияПараметровОграниченияДоступа и +// процедуры ЗаписатьНовуюВерсиюПараметровОграниченияДоступаВФоне. +// +Функция ОписаниеНовойВерсииПараметровОграниченияДоступа(Параметры, БезЗаписи = Ложь, ЭтоОшибкаБлокировки = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеНовойВерсииПараметровОграниченияДоступа(Параметры, БезЗаписи, ЭтоОшибкаБлокировки); +``` +
+ +## НоваяТаблицаРегистраСведенийПараметрыОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ТаблицаЗначений: +// * Версия - Число +// * ХешСумма - Строка +// * ХешСуммаПостоянныхПараметров - Строка +// * ДляЗаписиОбъектовИПроверкиПрав - ХранилищеЗначения +// * ДляОтчетаПоПравамДоступа - ХранилищеЗначения +// * ХешСуммаПараметровШаблонов - Строка +// * ДляШаблоновВСеансахПользователей - ХранилищеЗначения +// * ДляШаблоновВСеансахВнешнихПользователей - ХранилищеЗначения +// * ВерсииПараметровШаблонов - ХранилищеЗначения +// * ДатаСоздания - Дата +// +Функция НоваяТаблицаРегистраСведенийПараметрыОграниченияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяТаблицаРегистраСведенийПараметрыОграниченияДоступа()); +``` +
+ +## ЗапланироватьОбновлениеДоступаПриИзмененииПараметров +
+ +Описание, пример вызова + +```bsl + +// Для функции ОписаниеНовойВерсииПараметровОграниченияДоступа. +Процедура ЗапланироватьОбновлениеДоступаПриИзмененииПараметров(СтараяВерсия, Параметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗапланироватьОбновлениеДоступаПриИзмененииПараметров(СтараяВерсия, Параметры)); +``` +
+ +## ПроверитьАктуальностьМетаданных +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьТаблицыГруппДоступаДляПодключенныхРасширений и +// функции НоваяВерсияПараметровОграниченияДоступа. +// +Процедура ПроверитьАктуальностьМетаданных() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьАктуальностьМетаданных() +``` +
+ +## ЭтоСеансФоновогоЗадания +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьАктуальностьМетаданных +Функция ЭтоСеансФоновогоЗадания() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоСеансФоновогоЗадания()); +``` +
+ +## ЭтоСеансФоновогоОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьОбновлениеДоступа +Функция ЭтоСеансФоновогоОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоСеансФоновогоОбновленияДоступа()); +``` +
+ +## УстановитьЭтоСеансФоновогоОбновленияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ВыполнитьОбновлениеДоступаНаУровнеЗаписей, ВыполнитьОбновлениеДоступаСпискаВФоне. +Процедура УстановитьЭтоСеансФоновогоОбновленияДоступа() Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьЭтоСеансФоновогоОбновленияДоступа()); +``` +
+ +## ЗаписатьНесоответствиеПараметровВЖурнал +
+ +Описание, пример вызова + +```bsl + +// Для функции НоваяВерсияПараметровОграниченияДоступа. +Процедура ЗаписатьНесоответствиеПараметровВЖурнал(Запись, Комментарий, ЭтоОшибка = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаписатьНесоответствиеПараметровВЖурнал(Запись, Комментарий, ЭтоОшибка); +``` +
+ +## ЗарегистрироватьСтрокуВерсииПараметровОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции НоваяВерсияПараметровОграниченияДоступа. +Процедура ЗарегистрироватьСтрокуВерсииПараметровОграниченияДоступа(Запись, СтрокиВерсии) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗарегистрироватьСтрокуВерсииПараметровОграниченияДоступа(Запись, СтрокиВерсии)); +``` +
+ +## СпискиСИзменениемВерсий +
+ +Описание, пример вызова + +```bsl + +// Для функции НоваяВерсияПараметровОграниченияДоступа. +Функция СпискиСИзменениемВерсий(Версия, НовыеВерсииОграниченийСписков, НедоступныеСписки, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СпискиСИзменениемВерсий(Версия, НовыеВерсииОграниченийСписков, НедоступныеСписки, ); +``` +
+ +## ВсеИдентификаторыСПодобнымиПолнымиИменами +
+ +Описание, пример вызова + +```bsl + +// Для функции СпискиСИзменениемВерсий и для процедуры ДобавитьЗависимыеСписки. +Функция ВсеИдентификаторыСПодобнымиПолнымиИменами(ПолныеИмена) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВсеИдентификаторыСПодобнымиПолнымиИменами(ПолныеИмена)); +``` +
+ +## ВерсияСтруктурыКэша +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ХранимыеПараметрыОграниченияДоступа. +// +// Возвращаемое значение: +// Строка +// +Функция ВерсияСтруктурыКэша() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВерсияСтруктурыКэша() +``` +
+ +## ВерсияПеревода +
+ +Описание, пример вызова + +```bsl + +Функция ВерсияПеревода() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВерсияПеревода()); +``` +
+ +## ВерсииШаблоновОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур УстановкаПараметровСеанса, УточнитьВерсииШаблоновОграниченияДоступа и +// для функции СтруктураХранимыхПараметровШаблонов. +// +// Возвращаемое значение: +// Строка +// +Функция ВерсииШаблоновОграниченияДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВерсииШаблоновОграниченияДоступа()); +``` +
+ +## ВерсияСтруктурыВерсийПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для процедур УстановитьВерсиюПараметров, ЗаполнитьПараметрыДляШаблонов и +// функции НоваяСтруктураХранимыхВерсийПараметровШаблонов. +// +// +// Возвращаемое значение: +// Строка +// +Функция ВерсияСтруктурыВерсийПараметровШаблонов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВерсияСтруктурыВерсийПараметровШаблонов()); +``` +
+ +## ОбновитьИдентификаторыТранзакции +
+ +Описание, пример вызова + +```bsl + +// Для функции ДействующиеПараметрыОграниченияДоступа. +Процедура ОбновитьИдентификаторыТранзакции(ИдентификаторТранзакции) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьИдентификаторыТранзакции(ИдентификаторТранзакции)); +``` +
+ +## УстановитьВерсиюПараметров +
+ +Описание, пример вызова + +```bsl + +// Для функции ДействующиеПараметрыОграниченияДоступа. +Процедура УстановитьВерсиюПараметров(ВерсияПараметров, ИдентификаторТранзакции, ОбщийКонтекст, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьВерсиюПараметров(ВерсияПараметров, ИдентификаторТранзакции, ОбщийКонтекст, ); +``` +
+ +## СеансовыеПараметрыОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьВерсиюПараметров. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * Версия - Строка +// * ХешСумма - Строка +// * ДатаСоздания - Дата +// * Параметры - см. СтруктураХранимыхПараметровЗаписи +// +Функция СеансовыеПараметрыОграниченияДоступа(ВерсияПараметров, ДляЗаписиОбъектовИПроверкиПрав, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СеансовыеПараметрыОграниченияДоступа(ВерсияПараметров, ДляЗаписиОбъектовИПроверкиПрав, ); +``` +
+ +## УточнитьВерсииШаблоновОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьВерсиюПараметров. +Процедура УточнитьВерсииШаблоновОграниченияДоступа(ВерсииШаблонов) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УточнитьВерсииШаблоновОграниченияДоступа(ВерсииШаблонов)); +``` +
+ +## ОбновитьРазрешенныеНаборыВПараметрахСеанса +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьВерсиюПараметров, ПроверитьДоступКОбъекту, +// ПроверитьДоступКНаборуЗаписей и функции ДоступРазрешен. +// +Процедура ОбновитьРазрешенныеНаборыВПараметрахСеанса(УстановкаПараметровСеансаДляШаблонов = Ложь, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьРазрешенныеНаборыВПараметрахСеанса(УстановкаПараметровСеансаДляШаблонов, ); +``` +
+ +## РазрешенныеНаборыПараметровЗапроса +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьРазрешенныеНаборыВПараметрахСеанса и +// УстановитьРазрешенныеНаборыВПараметрыЗапроса. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи +// - СправочникСсылка.ВнешниеПользователи +// - Неопределено - текущий пользователь. +// +// Возвращаемое значение: +// Структура: +// * РазрешенныйПользователь - СправочникСсылка.НаборыГруппДоступа +// * РазрешенныйНаборГруппДоступа - СправочникСсылка.НаборыГруппДоступа +// * РазрешенныйНаборГруппПользователей - СправочникСсылка.НаборыГруппДоступа +// * РазрешенныйПустойНаборГруппДоступа - СправочникСсылка.НаборыГруппДоступа +// +Функция РазрешенныеНаборыПараметровЗапроса(Знач Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РазрешенныеНаборыПараметровЗапроса(Пользователь); +``` +
+ +## УчестьНастройкиПравПриПостроенииПланаВыполненияЗапроса +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьРазрешенныеНаборыВПараметрахСеанса. +Процедура УчестьНастройкиПравПриПостроенииПланаВыполненияЗапроса(Состав) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УчестьНастройкиПравПриПостроенииПланаВыполненияЗапроса(Состав)); +``` +
+ +## ОписаниеХешСуммыНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УчестьНастройкиПравПриПостроенииПланаВыполненияЗапроса. +Функция ОписаниеХешСуммыНастроекПрав(НаборГруппДоступа, Символ = "") Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеХешСуммыНастроекПрав(НаборГруппДоступа, Символ); +``` +
+ +## УстановитьРазрешенныеНаборыВПараметрыЗапроса +
+ +Описание, пример вызова + +```bsl + +// Для функции ДоступРазрешен и процедур ПроверитьДоступКОбъекту, ПроверитьДоступКНаборуЗаписей. +Процедура УстановитьРазрешенныеНаборыВПараметрыЗапроса(Запрос, Знач Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьРазрешенныеНаборыВПараметрыЗапроса(Запрос, Пользователь); +``` +
+ +## ХранимыеПараметрыОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции НоваяВерсияПараметровОграниченияДоступа. +// +// Параметры: +// ОбщийКонтекст - см. ОбщийКонтекстРасчетаПараметровОграничения +// ВерсииОграниченийСписков - Соответствие +// +// Возвращаемое значение: +// Структура: +// * ДатаСоздания - Дата +// * ДляЗаписиОбъектовИПроверкиПрав - ХранилищеЗначения - содержит тип НоваяСтруктураХранимыхПараметровЗаписи +// * ДляОтчетаПоПравамДоступа - ХранилищеЗначения - содержит тип НоваяСтруктураХранимыхПараметровОтчета +// * ХешСуммаПостоянныхПараметров - Строка +// * ДляШаблоновВСеансахПользователей - ХранилищеЗначения - содержит тип НоваяСтруктураХранимыхПараметровШаблонов +// * ДляШаблоновВСеансахВнешнихПользователей - ХранилищеЗначения - содержит тип НоваяСтруктураХранимыхПараметровШаблонов +// * ВерсииПараметровШаблонов - ХранилищеЗначения - содержит тип НоваяСтруктураХранимыхВерсийПараметровШаблонов +// * ХешСуммаПараметровШаблонов - Строка - заполняется при записи после обновления +// параметра ВерсииПараметровШаблонов и заполнения свойства СпискиСОграничениемПоПолям +// параметров ДляШаблоновВСеансахПользователей, ДляШаблоновВСеансахВнешнихПользователей. +// * ХешСумма - Строка - заполняется при записи, +// вычисляется из хеш-сумм ХешСуммаПостоянныхПараметров и ХешСуммаПараметровШаблонов. +// +Функция ХранимыеПараметрыОграниченияДоступа(ОбщийКонтекст, ВерсииОграниченийСписков = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ХранимыеПараметрыОграниченияДоступа(ОбщийКонтекст, ВерсииОграниченийСписков); +``` +
+ +## НовыеСтрокиВерсийСписков +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// ТаблицаЗначений: +// * Список - Строка +// * ДляВнешнихПользователей - Булево +// * Версия - Строка +// * СтрокаВерсии - Строка +// +Функция НовыеСтрокиВерсийСписков() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеСтрокиВерсийСписков()); +``` +
+ +## НовыйДополнительныйКонтекст +
+ +Описание, пример вызова + +```bsl + +// Для функций РассчитанныеПараметрыОграничения и ХранимыеПараметрыОграниченияДоступа. +// +// Возвращаемое значение: +// Структура: +// * ОписанияОграничений - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. СокращенноеОписаниеОграничения +// * СвойстваОграниченияСписков - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. НовыеСвойстваОграниченияСписка +// * СпискиСОграничениемПоВладельцу - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - значение ПоВладельцу, кроме Неопределено. +// * СпискиСОтключеннымОграничением - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// * СпискиСОтключеннымОграничениемЧтения - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// * СпискиСЗаписьюКлючейДляЗависимыхСписковБезКлючей - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// * ОсновныеВариантыДоступа - см. НовыеОсновныеВариантыДоступа +// +Функция НовыйДополнительныйКонтекст() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйДополнительныйКонтекст()); +``` +
+ +## НовыйХранимыйДополнительныйКонтекст +
+ +Описание, пример вызова + +```bsl + +// Для функций РассчитанныеПараметрыОграничения и ХранимыеПараметрыОграниченияДоступа. +// +// Возвращаемое значение: +// Структура: +// * СвойстваОграниченияСписков - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. НовыеСвойстваОграниченияСписка +// * СпискиСОтключеннымОграничением - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// * СпискиСОтключеннымОграничениемЧтения - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// * СпискиСЗаписьюКлючейДляЗависимыхСписковБезКлючей - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// * ОсновныеВариантыДоступа - см. НовыеОсновныеВариантыДоступа +// +Функция НовыйХранимыйДополнительныйКонтекст() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйХранимыйДополнительныйКонтекст()); +``` +
+ +## ДобавитьДополнительныйКонтекст +
+ +Описание, пример вызова + +```bsl + +// Для функций РассчитанныеПараметрыОграничения и ХранимыеПараметрыОграниченияДоступа. +Процедура ДобавитьДополнительныйКонтекст(ПолноеИмя, ДополнительныйКонтекст, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьДополнительныйКонтекст(ПолноеИмя, ДополнительныйКонтекст, ); +``` +
+ +## СокращенноеОписаниеОграничения +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * Текст - Строка +// * ВМодулеМенеджера - Булево +// +Функция СокращенноеОписаниеОграничения() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СокращенноеОписаниеОграничения()); +``` +
+ +## ДобавитьХранимыеПараметрыОграниченияДляВидаПользователей +
+ +Описание, пример вызова + +```bsl + +// Для функции ХранимыеПараметрыОграниченияДоступа. +Процедура ДобавитьХранимыеПараметрыОграниченияДляВидаПользователей(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьХранимыеПараметрыОграниченияДляВидаПользователей(Контекст)); +``` +
+ +## СвойстваСписковДляРасчетаХранимыхПараметров +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ПолноеИмя - Строка +// * Зависимый - Булево +// * Ведущие - Массив +// * Уровень - Число +// * Ведущий - Булево +// * Параметры - Структура +// * Обработан - Булево +// * ОграничениеПоВладельцуВозможно - Булево +// * ОграничениеПоВладельцуВключено - Булево +// * КлючиДоступаПользователей - Булево +// * ЕстьЗависимыеСпискиБезЗаписиКлючейДоступа - Булево +// * КлючиДоступаПользователейИГруппДоступа - Булево +// +Функция СвойстваСписковДляРасчетаХранимыхПараметров() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваСписковДляРасчетаХранимыхПараметров()); +``` +
+ +## ПараметрыОграниченияДляВидаПользователей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ХранимыеПараметрыОграниченияДляВидаПользователей. +// +// Возвращаемое значение: +// см. ПараметрыОграниченияПоСтруктуреОграничения +// +Функция ПараметрыОграниченияДляВидаПользователей(ПолноеИмя, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПараметрыОграниченияДляВидаПользователей(ПолноеИмя, Контекст)); +``` +
+ +## УстановитьУровеньЗависимыхСписков +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьХранимыеПараметрыОграниченияДляВидаПользователей. +Процедура УстановитьУровеньЗависимыхСписков(СвойстваВедущегоСписка, СвойстваСписков, ПредыдущиеВедущие, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьУровеньЗависимыхСписков(СвойстваВедущегоСписка, СвойстваСписков, ПредыдущиеВедущие, ); +``` +
+ +## НастроитьОптимизациюПоПолюВладельцу +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьХранимыеПараметрыОграниченияДляВидаПользователей. +Процедура НастроитьОптимизациюПоПолюВладельцу(СвойстваЗависимогоСписка, СвойстваСписков, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.НастроитьОптимизациюПоПолюВладельцу(СвойстваЗависимогоСписка, СвойстваСписков, Контекст)); +``` +
+ +## УстановитьЕстьЗависимыеСпискиБезЗаписиКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры НастроитьОптимизациюПоПолюВладельцу. +Процедура УстановитьЕстьЗависимыеСпискиБезЗаписиКлючейДоступа(СвойстваВедущегоСписка, СвойстваЗависимогоСписка) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьЕстьЗависимыеСпискиБезЗаписиКлючейДоступа(СвойстваВедущегоСписка, СвойстваЗависимогоСписка)); +``` +
+ +## ЗаполнитьСпискиБезВнедрения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьХранимыеПараметрыОграниченияДляВидаПользователей. +Процедура ЗаполнитьСпискиБезВнедрения(СпискиБезВнедрения, СвойстваСписка) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьСпискиБезВнедрения(СпискиБезВнедрения, СвойстваСписка)); +``` +
+ +## ЭтоУстаревшийОбъектМетаданных +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗаполнитьСпискиБезВнедрения. +Функция ЭтоУстаревшийОбъектМетаданных(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоУстаревшийОбъектМетаданных(ПолноеИмя)); +``` +
+ +## УстановитьСвойствоОграничения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьХранимыеПараметрыОграниченияДляВидаПользователей. +Процедура УстановитьСвойствоОграничения(ПолноеИмя, ИмяСвойства, ЗначениеСвойства, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьСвойствоОграничения(ПолноеИмя, ИмяСвойства, ЗначениеСвойства, Контекст)); +``` +
+ +## СвойстваОграниченияСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедур УстановитьСвойствоОграничения, ЗаполнитьЗапросыПроверкиПравЧтениеИзменение. +Функция СвойстваОграниченияСписка(ПолноеИмя, Контекст, ДобавлятьВКоллекцию = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваОграниченияСписка(ПолноеИмя, Контекст, ДобавлятьВКоллекцию); +``` +
+ +## НовыеСвойстваОграниченияСписка +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ДоступЗапрещен - Булево +// * ПолеВладельца - см. НовоеПолеВладельца +// * ОпорныеПоля - см. НовоеОписаниеОпорныхПолей +// * ИмяОтдельногоРегистраКлючей - Строка +// * РассчитыватьПраваПользователей - Булево +// * ИспользуемыеТипыЗначенийДоступа - ХранилищеЗначения - содержит тип Массив из Тип +// * ОграничениеВШаблонахЧерезКлючиДоступаПользователей - Булево +// * ОграничениеВШаблонахЧерезКлючиДоступаПользователейИГруппДоступа - Булево +// +Функция НовыеСвойстваОграниченияСписка() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеСвойстваОграниченияСписка()); +``` +
+ +## ЗаполнитьНесоответствиеПараметровДляЖурнала +
+ +Описание, пример вызова + +```bsl + +// Для функции ХранимыеПараметрыОграниченияДоступа. +// +// Параметры: +// СпискиБезВнедрения - Соответствие +// ИнформацияДляЖурнала - см. НоваяИнформацияНесоответствияПараметровДляЖурнала +// +Процедура ЗаполнитьНесоответствиеПараметровДляЖурнала(СпискиБезВнедрения, ИнформацияДляЖурнала); Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьНесоответствиеПараметровДляЖурнала(СпискиБезВнедрения, ИнформацияДляЖурнала);); +``` +
+ +## ОписаниеНесоответствияПараметров +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьНесоответствиеПараметровДляЖурнала. +Функция ОписаниеНесоответствияПараметров(СпискиБезВнедрения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеНесоответствияПараметров(СпискиБезВнедрения)); +``` +
+ +## ДобавитьВедущиеРоли +
+ +Описание, пример вызова + +```bsl + +// Для функции ХранимыеПараметрыОграниченияДоступа. +Процедура ДобавитьВедущиеРоли(ВедущиеРоли, ИмяСвойстваВидаПользователей, КонтекстВидаПользователей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВедущиеРоли(ВедущиеРоли, ИмяСвойстваВидаПользователей, КонтекстВидаПользователей)); +``` +
+ +## ДобавитьВедущиеСписки +
+ +Описание, пример вызова + +```bsl + +// Для функции ХранимыеПараметрыОграниченияДоступа. +Процедура ДобавитьВедущиеСписки(ВедущиеСписки, ИмяСвойстваВидаПользователей, ЗависимыйСписок, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВедущиеСписки(ВедущиеСписки, ИмяСвойстваВидаПользователей, ЗависимыйСписок, ); +``` +
+ +## ВедущийСписокПоЗначениямПолей +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ЭтоСсылочныйТип - Булево +// * ПоляШапки - см. ОписаниеПолейВедущегоСписка +// * ТабличныеЧасти - Массив из см. ОписаниеПолейВедущегоСписка +// +Функция ВедущийСписокПоЗначениямПолей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВедущийСписокПоЗначениямПолей()); +``` +
+ +## ВедущийСписокПоКлючамДоступаИлиЗначениямСГруппами +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ДляПользователей - Массив из Строка - полные имена списков +// * ДляВнешнихПользователей - Массив из Строка - полные имена списков +// +Функция ВедущийСписокПоКлючамДоступаИлиЗначениямСГруппами() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВедущийСписокПоКлючамДоступаИлиЗначениямСГруппами()); +``` +
+ +## ОписаниеПолейВедущегоСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьВедущиеСписки. +// +// Возвращаемое значение: +// Структура: +// * ВсеПоля - Массив +// * ТипыВсехПолей - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя поля. +// ** Значение - ХранилищеЗначения - содержит тип ОписаниеТипов - тип поля. +// * НаборыПолей - Структура: +// ** ДляПользователей - Булево +// ** ДляВнешнихПользователей - Булево +// * Имя - Строка - имя табличной части (есть только у полей табличной части) +// +Функция ОписаниеПолейВедущегоСписка() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеПолейВедущегоСписка()); +``` +
+ +## ДобавитьВедущиеСпискиПоВидуЗависимости +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьВедущиеСписки. +Процедура ДобавитьВедущиеСпискиПоВидуЗависимости(ВедущиеСписки, ИмяСвойстваВидаПользователей, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВедущиеСпискиПоВидуЗависимости(ВедущиеСписки, ИмяСвойстваВидаПользователей, ); +``` +
+ +## ТекущиеСвойстваВедущегоСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьВедущиеСписки. +// +// Возвращаемое значение: +// Структура: +// * ЗависимыеСписки - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// * ПоЗначениямПолей - Структура - похожая на см. ВедущийСписокПоПоЗначениямПолей +// * ПоКлючамДоступа - см. ВедущийСписокПоКлючамДоступаИлиЗначениямСГруппами +// * ПоЗначениямСГруппами - см. ВедущийСписокПоКлючамДоступаИлиЗначениямСГруппами +// +Функция ТекущиеСвойстваВедущегоСписка(ВедущиеСписки, ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекущиеСвойстваВедущегоСписка(ВедущиеСписки, ПолноеИмя)); +``` +
+ +## ДобавитьПоляВедущегоСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьВедущиеСписки. +Процедура ДобавитьПоляВедущегоСписка(ТекущиеПоля, ОписаниеПолей, ОписаниеПолейОтбора, ЗависимыйСписок, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПоляВедущегоСписка(ТекущиеПоля, ОписаниеПолей, ОписаниеПолейОтбора, ЗависимыйСписок, ); +``` +
+ +## НастроитьПараметрыШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьХранимыеПараметрыОграниченияДляВидаПользователей. +Процедура НастроитьПараметрыШаблонов(СвойстваСписка, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.НастроитьПараметрыШаблонов(СвойстваСписка, Контекст)); +``` +
+ +## КлючТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедуры НастроитьПараметрыШаблонов. +// +// Параметры: +// ПолноеИмя - Строка +// ИмяКоллекцииТипа - Строка +// ТипыТаблицПоИменам - Соответствие +// +// Возвращаемое значение: +// Строка +// +Функция КлючТаблицы(ПолноеИмя, ИмяКоллекцииТипа = Неопределено, ТипыТаблицПоИменам = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КлючТаблицы(ПолноеИмя, ИмяКоллекцииТипа, ТипыТаблицПоИменам); +``` +
+ +## ЗаполнитьПараметрыДляШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОписаниеНовойВерсииПараметровОграниченияДоступа. +Процедура ЗаполнитьПараметрыДляШаблонов(Запись, ПараметрыЗаписи, ОписаниеВерсии) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПараметрыДляШаблонов(Запись, ПараметрыЗаписи, ОписаниеВерсии)); +``` +
+ +## НоваяСтруктураДляЗаполненияПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьПараметрыДляШаблонов. +// +// Возвращаемое значение: +// Структура: +// * СтараяДатаСоздания - Дата +// * ХешированиеДанных - ХешированиеДанных +// * СпискиСНовымОсновнымВариантомДоступа - Массив из Строка +// * СпискиСУстаревшимиВариантамиДоступа - Массив из Строка +// * ХранимыеТекущиеВерсии - Структура: +// ** ВерсииПараметровШаблонов - см. НовыеВерсииПараметровШаблонов +// ** ОсновныеВариантыДоступа - см. НовыеОсновныеВариантыДоступа +// * НовыеВерсииПолейСписков - см. НовыеВерсииПараметровШаблонов +// * ТекущиеСвойстваОграниченияСписков - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. НовыеСвойстваОграниченияСписка +// * НовыеСвойстваОграниченияСписков - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. НовыеСвойстваОграниченияСписка +// +Функция НоваяСтруктураДляЗаполненияПараметровШаблонов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяСтруктураДляЗаполненияПараметровШаблонов()); +``` +
+ +## ЗаполнитьПараметрыДляШаблоновДляВидаПользователей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьПараметрыДляШаблонов. +// +// Параметры: +// Параметры - см. НоваяСтруктураДляЗаполненияПараметровШаблонов +// ХранилищеДляШаблоновВСеансах - ХранилищеЗначения - обновляемое значение +// СпискиСОграничениемПоПолям - Строка - возвращаемое значение +// +Процедура ЗаполнитьПараметрыДляШаблоновДляВидаПользователей(Параметры, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПараметрыДляШаблоновДляВидаПользователей(Параметры, ); +``` +
+ +## ОбновитьИспользованиеВерсийПолейСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьПараметрыДляШаблоновДляВидаПользователей. +Процедура ОбновитьИспользованиеВерсийПолейСписка(ТекущиеВерсииПолейСписка, ОсновнаяВерсияИзменена, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьИспользованиеВерсийПолейСписка(ТекущиеВерсииПолейСписка, ОсновнаяВерсияИзменена, ); +``` +
+ +## ДобавитьПоляОграниченияСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьПараметрыДляШаблоновДляВидаПользователей. +Процедура ДобавитьПоляОграниченияСписка(СпискиСОграничениемПоПолям, ТекущиеВерсииПолейСписка) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПоляОграниченияСписка(СпискиСОграничениемПоПолям, ТекущиеВерсииПолейСписка)); +``` +
+ +## ВариантыДоступаВБазеДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьПараметрыДляШаблоновДляВидаПользователей. +Функция ВариантыДоступаВБазеДанных(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВариантыДоступаВБазеДанных(Параметры)); +``` +
+ +## ОтключитьИспользованиеВерсийКромеОсновнойДляОбновленныхСписков +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьПараметрыДляШаблоновДляВидаПользователей. +Процедура ОтключитьИспользованиеВерсийКромеОсновнойДляОбновленныхСписков( Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтключитьИспользованиеВерсийКромеОсновнойДляОбновленныхСписков(); +``` +
+ +## ДобавитьСуществующиеВерсииПолейСписка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьПараметрыДляШаблоновДляВидаПользователей. +Процедура ДобавитьСуществующиеВерсииПолейСписка(ТекущиеВерсииПолейСписка, НоваяВерсия, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСуществующиеВерсииПолейСписка(ТекущиеВерсииПолейСписка, НоваяВерсия, ); +``` +
+ +## МаксимальноеКоличествоВариантовСоединений +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбновитьИспользованиеВерсийПолейСписка и ДобавитьПоляОграниченияСписка. +Функция МаксимальноеКоличествоВариантовСоединений() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МаксимальноеКоличествоВариантовСоединений()); +``` +
+ +## МаксимальноеКоличествоВерсийВВариантеДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗаполнитьПараметрыДляШаблоновДляВидаПользователей. +Функция МаксимальноеКоличествоВерсийВВариантеДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.МаксимальноеКоличествоВерсийВВариантеДоступа()); +``` +
+ +## ЗначениеИзХранилища +
+ +Описание, пример вызова + +```bsl + +// Для процедур УстановитьВерсиюПараметров, ЗаполнитьПараметрыДляШаблонов, +// ОбновитьТаблицыГруппДоступаДляПодключенныхРасширений и +// функции СпискиСИзменениемВерсий. +// +Функция ЗначениеИзХранилища(ХранилищеЗначения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЗначениеИзХранилища(ХранилищеЗначения)); +``` +
+ +## СтруктураХранимыхПараметровЗаписи +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьВерсиюПараметров, и для функции ХранимыеПараметрыОграниченияДоступа. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * ВерсияСтруктурыКэша - см. ВерсияСтруктурыКэша +// * ВерсииОграниченийСписков - ФиксированноеСоответствие +// * ВедущиеСписки - ФиксированноеСоответствие +// * ДополнительныйКонтекст - ФиксированнаяСтруктура +// * СпискиСДатой - ФиксированноеСоответствие +// * ВнешниеПользователиВключены - Булево +// * ОграничениеДоступаВключено - Булево +// * ИспользуемыеТипыЗначений - ХранилищеЗначения +// +Функция СтруктураХранимыхПараметровЗаписи(Значения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтруктураХранимыхПараметровЗаписи(Значения)); +``` +
+ +## НоваяСтруктураХранимыхПараметровЗаписи +
+ +Описание, пример вызова + +```bsl + +// Для функций СтруктураХранимыхПараметровЗаписи и ХранимыеПараметрыОграниченияДоступа. +// +// Возвращаемое значение: +// Структура: +// * ВерсияСтруктурыКэша - см. ВерсияСтруктурыКэша +// * ВерсииОграниченийСписков - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Строка - общая версия ограничения списка +// первая строка - хеш-сумма свойств версии для пользователей и через Символы.ПС +// вторая строка - хеш-сумма свойств версии для внешних пользователей. +// +// * ВедущиеСписки - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. СвойстваСпискаКакВедущего +// +// * ДополнительныйКонтекст - Структура: +// ** ДляПользователей - см. НовыйХранимыйДополнительныйКонтекст +// ** ДляВнешнихПользователей - см. НовыйХранимыйДополнительныйКонтекст +// +// * СпискиСДатой - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// * ВнешниеПользователиВключены - Булево +// * ОграничениеДоступаВключено - Булево +// * ИспользуемыеТипыЗначений - ХранилищеЗначения - смотри функцию ИспользуемыеТипыЗначений. +// * ВерсияТекстовОграниченияДоступа - Строка +// +Функция НоваяСтруктураХранимыхПараметровЗаписи() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяСтруктураХранимыхПараметровЗаписи() +``` +
+ +## СтруктураХранимыхПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьВерсиюПараметров. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * ВерсияСтруктурыКэша - см. ВерсияСтруктурыКэша +// * ВерсииШаблонов - см. ВерсииШаблоновОграниченияДоступа +// * ПараметрыШаблонов - см. СтруктураПараметровШаблонов +// +Функция СтруктураХранимыхПараметровШаблонов(Значения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтруктураХранимыхПараметровШаблонов(Значения)); +``` +
+ +## НоваяСтруктураХранимыхПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для функций СтруктураХранимыхПараметровШаблонов, СтруктураХранимыхПараметровЗаписи и +// ХранимыеПараметрыОграниченияДоступа. +// +// Возвращаемое значение: +// Структура: +// * ВерсияСтруктурыКэша - см. ВерсияСтруктурыКэша +// * ВерсииШаблонов - см. ВерсииШаблоновОграниченияДоступа +// * ПараметрыШаблонов - см. СтруктураПараметровШаблонов +// +Функция НоваяСтруктураХранимыхПараметровШаблонов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяСтруктураХранимыхПараметровШаблонов()); +``` +
+ +## СтруктураПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьВерсиюПараметров. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * СпискиСОграничениемЧерезКлючиДоступаГруппДоступа - Строка +// * СпискиСОграничениемЧерезКлючиДоступаПользователей - Строка +// * СпискиСОграничениемПоПолям - Строка +// * СпискиСОтключеннымОграничениемЧтения - Строка +// +Функция СтруктураПараметровШаблонов(Значения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтруктураПараметровШаблонов(Значения)); +``` +
+ +## НоваяСтруктураПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для функций СтруктураПараметровШаблонов, ХранимыеПараметрыОграниченияДоступа и +// НоваяСтруктураХранимыхПараметровШаблонов. +// +// Возвращаемое значение: +// Структура: +// * СпискиСОграничениемЧерезКлючиДоступаГруппДоступа - Строка +// * СпискиСОграничениемЧерезКлючиДоступаПользователей - Строка +// * СпискиСОграничениемПоПолям - Строка +// * СпискиСОтключеннымОграничениемЧтения - Строка +// +Функция НоваяСтруктураПараметровШаблонов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяСтруктураПараметровШаблонов()); +``` +
+ +## СтруктураХранимыхВерсийПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для процедур УстановитьВерсиюПараметров и ЗаполнитьПараметрыДляШаблонов. +// +// Возвращаемое значение: +// см. НоваяСтруктураХранимыхВерсийПараметровШаблонов +// +Функция СтруктураХранимыхВерсийПараметровШаблонов(Значения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтруктураХранимыхВерсийПараметровШаблонов(Значения)); +``` +
+ +## НоваяСтруктураХранимыхВерсийПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для функций ХранимыеПараметрыОграниченияДоступа, СтруктураХранимыхВерсийПараметровШаблонов и +// процедуры ЗаполнитьПараметрыДляШаблонов. +// +// Возвращаемое значение: +// Структура: +// * ВерсияСтруктурыВерсий - см. ВерсияСтруктурыВерсийПараметровШаблонов +// * ДляПользователей - Структура: +// ** ВерсииПараметровШаблонов - см. НовыеВерсииПараметровШаблонов +// ** ОсновныеВариантыДоступа - см. НовыеОсновныеВариантыДоступа +// * ДляВнешнихПользователей - Структура: +// ** ВерсииПараметровШаблонов - см. НовыеВерсииПараметровШаблонов +// ** ОсновныеВариантыДоступа - см. НовыеОсновныеВариантыДоступа +// +Функция НоваяСтруктураХранимыхВерсийПараметровШаблонов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяСтруктураХранимыхВерсийПараметровШаблонов()); +``` +
+ +## НовыеВерсииПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для функций ХранимыеПараметрыОграниченияДоступа и +// НоваяСтруктураХранимыхВерсийПараметровШаблонов. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - полное имя регистра. +// * Значение - Массив из см. НоваяВерсияПараметровШаблонов +// +Функция НовыеВерсииПараметровШаблонов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеВерсииПараметровШаблонов()); +``` +
+ +## НоваяВерсияПараметровШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для функции НовыеВерсииПараметровШаблонов и процедуры НастроитьПараметрыШаблонов. +// +// Возвращаемое значение: +// Структура: +// * ДатаСоздания - Дата - момент добавления новой версии. +// * Список - Строка - полное имя объекта метаданных. +// * ПоляСоединения - Строка - список полей, используемых в соединении. +// * ПоляШаблона - Строка - список полей, указанных в шаблоне #ДляРегистра. +// * Используется - Булево - признак того, что версия используется в шаблонах. +// * ВариантДоступа - Число - значение поля ВариантДоступа в регистрах КлючиДоступаКРегистрам, +// КлючиДоступаКРегистру*. +// +Функция НоваяВерсияПараметровШаблонов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяВерсияПараметровШаблонов()); +``` +
+ +## НовыеОсновныеВариантыДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции НоваяСтруктураХранимыхВерсийПараметровШаблонов. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - полное имя регистра. +// * Значение - Массив из см. НовыйИспользуемыйВариантДоступа +// +Функция НовыеОсновныеВариантыДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеОсновныеВариантыДоступа()); +``` +
+ +## НовыйИспользуемыйВариантДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗаполнитьПараметрыДляШаблоновДляВидаПользователей. +// +// Возвращаемое значение: +// Структура: +// * ВариантДоступа - Число - значение поля ВариантДоступа +// в регистрах КлючиДоступаКРегистрам, КлючиДоступаКРегистру*, +// начиная с основного варианта доступа. +// * ПоляСоединения - Строка - имена полей соединения для варианта доступа через запятую. +// +Функция НовыйИспользуемыйВариантДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйИспользуемыйВариантДоступа()); +``` +
+ +## СтруктураХранимыхПараметровОтчета +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьВерсиюПараметров. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * ВерсияСтруктурыКэша - см. ВерсияСтруктурыКэша +// * ВидыОграниченийПравДляПользователей - Строка +// * ВидыОграниченийПравДляВнешнихПользователей - Строка +// +Функция СтруктураХранимыхПараметровОтчета(Значения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтруктураХранимыхПараметровОтчета(Значения)); +``` +
+ +## НоваяСтруктураХранимыхПараметровОтчета +
+ +Описание, пример вызова + +```bsl + +// Для функций СтруктураХранимыхПараметровОтчета и ХранимыеПараметрыОграниченияДоступа. +// +// Возвращаемое значение: +// Структура: +// * ВерсияСтруктурыКэша - см. ВерсияСтруктурыКэша +// * ВидыОграниченийПравДляПользователей - Строка +// * ВидыОграниченийПравДляВнешнихПользователей - Строка +// +Функция НоваяСтруктураХранимыхПараметровОтчета() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НоваяСтруктураХранимыхПараметровОтчета()); +``` +
+ +## ВидыОграниченийПравСтрокой +
+ +Описание, пример вызова + +```bsl + +// Для функции ХранимыеПараметрыОграниченияДоступа. +Функция ВидыОграниченийПравСтрокой(ВидыОграниченийПрав) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВидыОграниченийПравСтрокой(ВидыОграниченийПрав)); +``` +
+ +## ПараметрыОграниченияПоСтруктуреОграничения +
+ +Описание, пример вызова + +```bsl + +// Основная функция области, возвращающая параметры ограничения доступа +// для вида пользователей списка без учета зависимости от других списков, +// как по ключам доступа, так и по наличию видов доступа Пользователи и ВнешниеПользователи. +// +// Возвращаемое значение: +// Структура: +// * Список - Строка - полное имя таблицы объекта метаданных. +// * ДляВнешнихПользователей - Булево - вид пользователей, для которых предназначены параметры. +// * Версия - Строка - хеш-сумма параметров ограничения доступа для отслеживания их изменения. +// * ВедущиеСписки - см. НовыеВедущиеСписки +// * ДоступЗапрещен - Булево - Истина, если текст ограничения "ГДЕ ЛОЖЬ", +// а также не указан для внешних пользователей. +// * ОграничениеОтключено - Булево - Истина, если текст ограничения не указан или указан, +// но ограничение отключено из-за отключения использования +// видов доступа, задействованных в нем. +// * ОграничениеЧтенияОтключено - Булево - Истина, если текст ограничения чтения не указан или указан, +// но ограничение отключено из-за отключения использования +// видов доступа, задействованных в нем. +// +// Поле владельца, когда возможно ограничение только по объекту-владельцу. +// * ПолеВладельца - см. НовоеПолеВладельца +// +// * ТребуетсяОграничениеПоВладельцу - Булево - признак оптимизации, указанный разработчиком +// рядом с текстом ограничения. +// * ИспользуетсяОграничениеПоВладельцу - Булево - признак использования оптимизации, +// вычисленный на втором проходе графа. +// * РассчитыватьПраваПользователей - Булево - признак расчета прав на ключи доступа для пользователей, +// а не для групп доступа, вычисленный на втором проходе графа. +// Имеет смысл только, когда признак +// ИспользуетсяОграничениеПоВладельцу = Ложь. +// * ЕстьЗависимыеСпискиБезЗаписиКлючейДоступа - Булево - признак того, что ведущий список должен записывать +// ключи для зависимых списков, которые не записывают +// своих ключей. Признак вычисляется на втором проходе графа. +// * БезОбновленияКлючейДоступаКОбъектам - Булево - когда Истина, запись связи объекта с ключом доступа +// пропускается так как тип списка не указан +// в определяемом типе ВладелецЗначенийКлючейДоступа. +// * БезОбновленияВсехКомбинацийЗначенийОпорныхПолей - Булево - когда Истина, запись связи строки регистра с ключом +// доступа пропускается, если тип значения опорного поля регистра не +// указан в определяемом типе ПолеРегистраКлючейДоступаКРегистрам +// или типе соответствующего поля отдельного регистра ключей. +// * ЧтениеРазрешеноДляВсехПользователей - Булево - признак, вычисленный на втором проходе графа. +// Когда ЕстьЗависимыеСпискиБезЗаписиКлючейДоступа = Истина, +// тогда показывает наличие права Чтение в одной из ролей +// БазовыеПрава* или БазовыеПраваВнешнихПользователей*. +// * ИзменениеРазрешеноДляВсехПользователей - Булево - признак, вычисленный на втором проходе графа. +// Когда ЕстьЗависимыеСпискиБезЗаписиКлючейДоступа = Истина, +// тогда показывает наличие права Изменение в одной из ролей +// БазовыеПрава* или БазовыеПраваВнешнихПользователей*. +// * ЕстьВедущиеКлючиДоступа - Булево - признак наличия ведущих ключей доступа в ограничении. +// * ЕстьВедущиеСпискиПоПравам - Булево - признак наличия ведущих списков по правам в ограничении. +// * ЕстьФункцияПравоДоступаИлиРольДоступна - Булево - признак наличия перечисленных функций в ограничении. +// * ТипыВладельцевНастроекПрав - ФиксированноеСоответствие - типы владельцев настроек прав, используемые +// при расчете прав на ключи доступа (см. ПоТипамСсылок). +// * ИдентификаторТаблицыНастроекПрав - СправочникСсылка.ИдентификаторыОбъектовМетаданных - идентификатор +// списка, если для него используются отдельные настройки прав +// или пустой идентификатор. +// * ЕстьВладельцыНастроекПрав - Булево - признак наличия ограничения по владельцу настроек прав. +// * ИспользуемыеТипыЗначенийДоступа - Массив из Тип - описание типов значений доступа, +// которые используются в ограничении доступа. +// * ВсеВидыОграниченийПрав - Соответствие - все виды ограничений прав без учета использования. +// * ПоляТаблицОбъекта - Массив из см. НовыеПоляТаблицыОбъекта +// * ИмяОтдельногоРегистраКлючей - Строка - для регистров. +// * ОпорныеПоля - см. НовоеОписаниеОпорныхПолей +// * ВариантДоступа - Число - основной вариант доступа смотри также НовыеОсновныеВариантыДоступа. +// * СоставПолей - Число - число, описывающее реквизиты, используемые в ключе. +// * ЕстьОграничениеЧтения - Булево - установлено, если ограничение чтения отличается от "ГДЕ ИСТИНА". +// * ЕстьОграничениеИзменения - Булево - установлено, если ограничение изменения отличается от "ГДЕ ИСТИНА". +// * ЕстьОграничениеПоПользователям - Булево - установлено, если проверяются значения Пользователь +// или ГруппаПользователей или ВнешнийПользователь +// или ГруппаВнешнихПользователей для функций +// ЗначениеРазрешено или ЭтоАвторизованныйПользователь. +// * СтруктураРасчетаПраваЧтение - см. СтруктураРасчетаПрава +// * СтруктураРасчетаПраваИзменение - см. СтруктураРасчетаПрава +// * Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Функция ПараметрыОграниченияПоСтруктуреОграничения(Список, СтруктураОграничения, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПараметрыОграниченияПоСтруктуреОграничения(Список, СтруктураОграничения, ); +``` +
+ +## НовыеВедущиеСписки +
+ +Описание, пример вызова + +```bsl + +// Списки с полями от которых зависит ограничение доступа. +// +// Возвращаемое значение: +// Структура: +// * ПоЗначениямПолей - Соответствие - списки с полями, от которых зависит ограничение доступа +// (для регистрации заданий обновления). +// * ПоКлючамДоступа - Соответствие - списки от ключей доступа которых зависит ограничение доступа +// (для установки параметров сеанса и регистрации заданий обновления). +// * ПоЗначениямСГруппами - Соответствие - списки значений доступа с группами, от которых зависит +// ограничение доступа (для регистрации заданий обновления). +// +Функция НовыеВедущиеСписки() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеВедущиеСписки()); +``` +
+ +## КонтекстПараметровПоСтруктуреОграничения +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * СтрокаСвойствВерсии - Строка +// * Список - Строка +// * ДляВнешнихПользователей - Булево +// * ЭтоСсылочныйТип - Булево +// * СписокСДатой - Булево +// * СписокСПериодом - Булево +// * ИмяКоллекцииТипа - Строка +// * СвойстваВерсии - Массив из Строка +// * ПоляТаблицОбъекта - см. НовоеОписаниеПолейТаблицОбъекта +// * ОпорныеПоля - см. НовоеОписаниеОпорныхПолей +// * ВариантДоступа - Число - основной вариант доступа смотри также НовыеОсновныеВариантыДоступа. +// * ИспользуетсяОграничениеПоВладельцу - Булево +// * РассчитыватьПраваПользователей - Булево +// * ЕстьЗависимыеСпискиБезЗаписиКлючейДоступа - Булево +// * ЧтениеРазрешеноДляВсехПользователей - Булево +// * ИзменениеРазрешеноДляВсехПользователей - Булево +// * БезОбъектаМетаданных - Булево +// * СтруктураОграничения - см. СтруктураОграничения +// * ИсходнаяСтруктураОграничения - см. СтруктураОграничения +// * ВедущиеСпискиПоЗначениямПолей - см. ОписаниеВедущихСписковПоЗначениямПолей +// * ВедущиеСпискиПоКлючамДоступа - см. ОписаниеВедущихСписковПоПолюСсылка +// * ВедущиеСпискиПоЗначениямСГруппами - см. ОписаниеВедущихСписковПоПолюСсылка +// * ЕстьПроверкаАвторизованногоПользователя - Булево +// * ЕстьФункцияПравоДоступаИлиРольДоступна - Булево +// * ЕстьФункцияПравоДоступаИлиРольДоступнаВОграниченииЧтения - Булево +// * НеиспользуемыеТипыЗначенийДоступа - Массив из Тип +// * ВсеВидыОграниченийПрав - Соответствие +// * ЕстьОграничениеПоПользователям - Булево +// * ИспользуетсяОграничениеПоВладельцу - Булево +// * РассчитыватьПраваПользователей - Булево +// * СвойстваВсехПолей - Соответствие из КлючИЗначение: +// ** Ключ - см. ОписаниеУзла +// ** Значение - см. СвойстваПоля +// * ОставшиесяПоляПослеУпрощения - Соответствие из КлючИЗначение: +// ** Ключ - см. ОписаниеУзла +// ** Значение - Массив из см. ОписаниеУзла +// * ПоляКлючаДоступаПослеУпрощения - Массив из см. НовоеПолеКлючаДоступа +// * СвойстваПолейКлючаДоступа - Соответствие из КлючИЗначение: +// ** Ключ - см. ОписаниеУзла +// ** Значение - см. СвойстваПоля +// * ГруппыПолей - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя группы полей (Шапка?, ТабличнаяЧасть?) +// ** Значение - Массив из см. СвойстваПоля +// * ПсевдонимыТабличныхЧастейОбъекта - Соответствие из КлючИЗначение: +// ** Ключ - Число - номер табличной части ключа +// ** Значение - Строка - псевдоним таблицы +// * ГруппыДополнительныхТаблиц - см. ГруппыДополнительныхТаблиц +// * КоличествоТабличныхЧастейКлюча - Число +// * ПоляУсловияСоединенияДополнительныхТаблиц - Массив из Структура: +// ** УзелПоле - см. ОписаниеУзла +// ** ПсевдонимТаблицыУсловия - Строка +// * ИмяПрава - Строка +// * ТребуемыеРеквизитыТабличныхЧастейКлюча - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя таблицы ключа (ИмяГруппыПолейКлючаДоступа) +// ** Значение - Массив из Строка - имя реквизита таблицы ключа (ИмяРеквизитаГруппыПолейКлючаДоступа) +// * СтруктураРасчетаПраваСвойстваВерсии - Массив из Строка +// * ВедущиеРоли - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя роли +// ** Значение - Булево - значение Истина. +// +// Свойства, скопированные от ОбщийКонтекст: +// * СвойстваВидовДоступа - см. СвойстваВидовДоступа +// * ТипыПользователя - Массив из Тип +// * ТипыВладельцевНастроекПрав - ФиксированноеСоответствие +// * ОтдельныеТаблицыНастроекПрав - ФиксированноеСоответствие +// * ИспользуемыеТипыЗначений - см. ИспользуемыеТипыЗначений +// * СпискиСОграничением - см. УправлениеДоступомСлужебныйПовтИсп.СпискиСОграничением +// * ВнешниеПользователиВключены - Булево +// +// Свойства, скопированные от ДополнительныйКонтекст: +// * ОписанияОграничений - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. СокращенноеОписаниеОграничения +// * СвойстваОграниченияСписков - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - см. НовыеСвойстваОграниченияСписка +// * СпискиСОграничениемПоВладельцу - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - значение ПоВладельцу, кроме Неопределено. +// * СпискиСОтключеннымОграничением - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// * СпискиСОтключеннымОграничениемЧтения - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// * СпискиСЗаписьюКлючейДляЗависимыхСписковБезКлючей - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя списка +// ** Значение - Булево - Истина +// +Функция КонтекстПараметровПоСтруктуреОграничения() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КонтекстПараметровПоСтруктуреОграничения()); +``` +
+ +## СтруктураРасчетаПрава +
+ +Описание, пример вызова + +```bsl + +// Структура ограничения, приведенную к формату размещения значений в ключах доступа. +// +// Возвращаемое значение: +// Структура: +// * Узел - Строка - одна из строк "Поле", "Константа", "И", "Или", "Не", "Выбор", +// "ЗначениеРазрешено", "ЭтоАвторизованныйПользователь", +// "ЧтениеОбъектаРазрешено", "ИзменениеОбъектаРазрешено", +// "ЧтениеСпискаРазрешено", "ИзменениеСпискаРазрешено", +// "ДляВсехСтрок", "ДляОднойИзСтрок". +// +// Свойства узла Поле. +// * Таблица - Строка - таблица ключа доступа (Шапка?, ТабличнаяЧасть?). +// * Реквизит - Строка - имя реквизита таблицы ключа доступа (Реквизит?). +// * ПроверкаЕстьNull - Булево - Истина (необязательное свойство). +// +// Свойства узла Константа. +// * Значение - Булево +// - Число +// - Строка +// - Неопределено - Ложь, Истина, произвольное +// целое число до 16 разрядов или произвольная строка до 150 символов. +// +// Свойства узлов И, Или. +// * Аргументы - Массив из см. СтруктураРасчетаПрава +// +// Свойства узла Не. +// * Аргумент - см. СтруктураРасчетаПрава +// +// * Узел - Строка - заглушка к предыдущей строке (для определения типа в EDT) +// +// Свойства узла Выбор (Иначе может быть Неопределено). +// * Иначе - см. СтруктураРасчетаПрава +// * Когда - Массив из Структура: +// ** Условие - см. СтруктураРасчетаПрава +// ** Значение - см. СтруктураРасчетаПрава +// +// * Узел - Строка - заглушка к предыдущей строке (для определения типа в EDT) +// +// Свойства узлов ЗначениеРазрешено, ЭтоАвторизованныйПользователь, +// ЧтениеОбъектаРазрешено, ИзменениеОбъектаРазрешено, +// ЧтениеСпискаРазрешено, ИзменениеСпискаРазрешено. +// * Поле - см. СтруктураРасчетаПрава +// * УточненияСравнения - Соответствие из КлючИЗначение: +// ** Ключ - Строка +// - Тип - уточняемое значение "Неопределено", "Null", "ПустаяСсылка", +// "Отключено", Тип (Ссылка, Число, Даты, Булево). +// ** Значение - Строка - результат "Ложь", "Истина". +// +// Свойства узлов ДляВсехСтрок, ДляОднойИзСтрок. +// * Аргумент - см. СтруктураРасчетаПрава +// +Функция СтруктураРасчетаПрава() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтруктураРасчетаПрава()); +``` +
+ +## НастроитьСозданиеКлючаДоступаДляЗависимыхСписковБезКлючей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПараметрыОграниченияПоСтруктуреОграничения. +Процедура НастроитьСозданиеКлючаДоступаДляЗависимыхСписковБезКлючей(Результат) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.НастроитьСозданиеКлючаДоступаДляЗависимыхСписковБезКлючей(Результат)); +``` +
+ +## ПравоРазрешеноДляВсехПользователей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПараметрыОграниченияПоСтруктуреОграничения. +Функция ПравоРазрешеноДляВсехПользователей(ИмяПрава, ОбъектМетаданных, ДляВнешнихПользователей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПравоРазрешеноДляВсехПользователей(ИмяПрава, ОбъектМетаданных, ДляВнешнихПользователей)); +``` +
+ +## ДобавитьСвойствоВерсииВедущиеРоли +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПараметрыОграниченияПоСтруктуреОграничения. +Процедура ДобавитьСвойствоВерсииВедущиеРоли(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСвойствоВерсииВедущиеРоли(Контекст)); +``` +
+ +## ДобавитьСвойстваВерсии +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УдалитьПоляНеиспользуемыхВидовДоступа и функции ГруппыДополнительныхТаблиц. +Процедура ДобавитьСвойстваВерсии(Контекст, Структура, ИменаПолей = "") Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСвойстваВерсии(Контекст, Структура, ИменаПолей); +``` +
+ +## ДобавитьСвойствоВерсии +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПараметрыОграниченияПоСтруктуреОграничения. +Процедура ДобавитьСвойствоВерсии(Контекст, Структура, ИмяПоля) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСвойствоВерсии(Контекст, Структура, ИмяПоля)); +``` +
+ +## ДобавитьЭлементВерсии +
+ +Описание, пример вызова + +```bsl + +// Для процедур ДобавитьСвойстваВерсии, ДобавитьСвойствоВерсии. +Процедура ДобавитьЭлементВерсии(Контекст, ИмяПоля, Значение) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЭлементВерсии(Контекст, ИмяПоля, Значение) +``` +
+ +## ЭтоСсылочныйТипТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияПоСтруктуреОграничения и формы ОбновлениеДоступаРучноеУправление. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоСсылочныйТипТаблицы(ПолноеИмя, ИмяКоллекцииТипа = "") Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоСсылочныйТипТаблицы(ПолноеИмя, ИмяКоллекцииТипа); +``` +
+ +## НовыеПоляТаблицыОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ПолноеИмяТаблицы - Строка +// * ТабличнаяЧасть - Строка +// * Поля - Массив из Строка - с полем Ссылка +// * СписокПолей - Строка - без поля Ссылка +// * ТаблицаСПолями - ХранилищеЗначения - с объектом ТаблицаЗначений +// с типизированными полями (включая поле Ссылка). +// +Функция НовыеПоляТаблицыОбъекта() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеПоляТаблицыОбъекта()); +``` +
+ +## НовоеОписаниеПолейТаблицОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * Результат - Массив из см. НовыеПоляТаблицыОбъекта +// * Состав - Структура: +// ** Ключ - Строка - полное имя таблицы объекта. +// ** Значение - Структура: +// *** Ключ - Строка - имя поля. +// *** Значение - Структура: +// **** Тип - ОписаниеТипов - типы поля. +// **** Использование - Булево - использование поля. +// * ПоСвойствамПолей - Соответствие из КлючИЗначение: +// ** Ключ - см. НовыеСвойстваПоля +// ** Значение - Структура: +// *** Таблица - Строка - полное имя таблицы объекта. +// *** Поле - Строка - имя поля. +// * ПоДополнительнымТаблицам - Соответствие из КлючИЗначение: +// ** Ключ - Строка - дополнительная таблица +// ** Значение - Структура: +// *** Ключ - Строка - полное имя таблицы объекта. +// *** Значение - Массив из Строка - имя поля. +// +Функция НовоеОписаниеПолейТаблицОбъекта(Результат) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовоеОписаниеПолейТаблицОбъекта(Результат)); +``` +
+ +## ЗаполнитьНовоеОписаниеОпорныхПолей +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияПоСтруктуреОграничения. +// +// Параметры: +// Результат - см. ПараметрыОграниченияПоСтруктуреОграничения +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ЗаполнитьНовоеОписаниеОпорныхПолей(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьНовоеОписаниеОпорныхПолей(Результат, Контекст)); +``` +
+ +## НовоеОписаниеОпорныхПолей +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * Все - Массив +// * ТипыВсех - Массив из ХранилищеЗначения - содержит тип ОписаниеТипов +// * Используемые - Массив +// * ТипыИспользуемых - Массив из ХранилищеЗначения - содержит тип ОписаниеТипов +// * МаксимальноеКоличество - Число +// * МаксимальноДопустимоеКоличество - Число +// +// * Список - СписокЗначений +// * ТипыПоИменамПолей - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя опорного поля +// ** Значение - ОписаниеТипов - типы опорного поля +// * ПоСвойствамПолей - Соответствие из КлючИЗначение: +// ** Ключ - см. НовыеСвойстваПоля +// ** Значение - Строка - имя опорного поля +// * ПоДополнительнымТаблицам - Соответствие из КлючИЗначение: +// ** Ключ - Строка - дополнительная таблица +// ** Значение - Массив из Строка - имена опорных полей +// * НедостающиеТипы - Массив из Строка - полные имена типов +// * ПоляНедостающихТипов - Массив из Строка - имена полей регистра ключей +// +Функция НовоеОписаниеОпорныхПолей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовоеОписаниеОпорныхПолей()); +``` +
+ +## ЭтоБезусловноеОграничение +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +// +// Параметры: +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// Результат - см. ПараметрыОграниченияПоСтруктуреОграничения +// +Функция ЭтоБезусловноеОграничение(Контекст, Результат) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоБезусловноеОграничение(Контекст, Результат)); +``` +
+ +## ЗаполнитьНаличиеОграниченияПоПравам +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +// +// Параметры: +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// Результат - см. ПараметрыОграниченияПоСтруктуреОграничения +// +Процедура ЗаполнитьНаличиеОграниченияПоПравам(Контекст, Результат, ПослеУпрощения) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьНаличиеОграниченияПоПравам(Контекст, Результат, ПослеУпрощения)); +``` +
+ +## ЗаполнитьОграничениеПоОбъектуВладельцуДоУпрощения +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +// +// Параметры: +// Результат - см. ПараметрыОграниченияПоСтруктуреОграничения +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ЗаполнитьОграничениеПоОбъектуВладельцуДоУпрощения(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьОграничениеПоОбъектуВладельцуДоУпрощения(Результат, Контекст)); +``` +
+ +## ВозможноеОграничениеПоОбъектуВладельцу +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьОграничениеПоОбъектуВладельцуДоУпрощения. +Функция ВозможноеОграничениеПоОбъектуВладельцу(Условие, ЭтоОграничениеИзменения, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВозможноеОграничениеПоОбъектуВладельцу(Условие, ЭтоОграничениеИзменения, Контекст)); +``` +
+ +## ОбработаноВозможноеОграничениеПоОбъектуВладельцу +
+ +Описание, пример вызова + +```bsl + +// Для функции ВозможноеОграничениеПоОбъектуВладельцу. +Функция ОбработаноВозможноеОграничениеПоОбъектуВладельцу(Условие, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбработаноВозможноеОграничениеПоОбъектуВладельцу(Условие, ); +``` +
+ +## ЗаполнитьОграничениеПоОбъектуВладельцуПослеУпрощения +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +// +// Параметры: +// Результат - см. ПараметрыОграниченияПоСтруктуреОграничения +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ЗаполнитьОграничениеПоОбъектуВладельцуПослеУпрощения(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьОграничениеПоОбъектуВладельцуПослеУпрощения(Результат, Контекст)); +``` +
+ +## НовоеПолеВладельца +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * Имя - Строка +// * ИзменениеКакЧтение - Булево +// * Отключено - Булево +// +Функция НовоеПолеВладельца() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовоеПолеВладельца()); +``` +
+ +## ТекстОшибкиСЗаголовком +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗаполнитьОграничениеПоОбъектуВладельцу и процедуры НастроитьОптимизациюПоПолюВладельцу. +Функция ТекстОшибкиСЗаголовком(ТекстОшибки, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстОшибкиСЗаголовком(ТекстОшибки, Контекст)); +``` +
+ +## ФункцияБезУточненийТиповСПолемБезВложений +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьОграничениеПоОбъектуВладельцу. +Функция ФункцияБезУточненийТиповСПолемБезВложений(Ограничение) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ФункцияБезУточненийТиповСПолемБезВложений(Ограничение)); +``` +
+ +## ЗаполнитьНаличиеВедущихКлючейИСписковИВладельцевНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +// +// Параметры: +// Результат - см. ПараметрыОграниченияПоСтруктуреОграничения +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ЗаполнитьНаличиеВедущихКлючейИСписковИВладельцевНастроекПрав(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьНаличиеВедущихКлючейИСписковИВладельцевНастроекПрав(Результат, Контекст)); +``` +
+ +## УдалитьПоляНеиспользуемыхВидовДоступа +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +// +// Параметры: +// Результат - см. ПараметрыОграниченияПоСтруктуреОграничения +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура УдалитьПоляНеиспользуемыхВидовДоступа(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьПоляНеиспользуемыхВидовДоступа(Результат, Контекст)); +``` +
+ +## ЗаполнитьНаличиеОграниченияПоВидуДоступаПользователи +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +// +// Параметры: +// Результат - см. ПараметрыОграниченияПоСтруктуреОграничения +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ЗаполнитьНаличиеОграниченияПоВидуДоступаПользователи(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьНаличиеОграниченияПоВидуДоступаПользователи(Результат, Контекст)); +``` +
+ +## ЗаполнитьНаличиеОграниченияЧтения +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +// +// Параметры: +// Результат - см. ПараметрыОграниченияПоСтруктуреОграничения +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ЗаполнитьНаличиеОграниченияЧтения(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьНаличиеОграниченияЧтения(Результат, Контекст)); +``` +
+ +## ЗаполнитьГруппыПолейИДополнительныхТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +// +// Параметры: +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ЗаполнитьГруппыПолейИДополнительныхТаблиц(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьГруппыПолейИДополнительныхТаблиц(Контекст)); +``` +
+ +## ЗаполнитьСтруктуруРасчетаПрава +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +// +// Параметры: +// УсловиеРасчета - см. СтруктураРасчетаПрава +// Условие - см. ОписаниеУзла +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ЗаполнитьСтруктуруРасчетаПрава(УсловиеРасчета, Условие, Контекст, КореньУсловия = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьСтруктуруРасчетаПрава(УсловиеРасчета, Условие, Контекст, КореньУсловия); +``` +
+ +## УсловиеРасчетаПоле +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьСтруктуруРасчетаПрава. +Процедура УсловиеРасчетаПоле(УсловиеРасчета, СвойстваПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УсловиеРасчетаПоле(УсловиеРасчета, СвойстваПоля, Контекст)); +``` +
+ +## ДобавитьЗависимостьОтРолей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьСтруктуруРасчетаПрава. +Процедура ДобавитьЗависимостьОтРолей(Контекст, УсловиеРасчета) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗависимостьОтРолей(Контекст, УсловиеРасчета)); +``` +
+ +## ДобавитьСвойствоВерсииСтруктурыРасчета +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗаполнитьСтруктуруРасчетаПрава, УсловиеРасчетаПоле. +Процедура ДобавитьСвойствоВерсииСтруктурыРасчета(Контекст, Имя, Значение); Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСвойствоВерсииСтруктурыРасчета(Контекст, Имя, Значение);); +``` +
+ +## Степень16 +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьГруппыПолейИДополнительныхТаблиц. +Функция Степень16(Степень) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.Степень16(Степень)); +``` +
+ +## ГруппыДополнительныхТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для функции ЗаполнитьГруппыПолейИДополнительныхТаблиц. +// +// Параметры: +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +// Возвращаемое значение: +// Структура: +// * НомераПоПсевдонимам - Соответствие из КлючИЗначение: +// ** Ключ - Строка - псевдоним дополнительной таблицы +// ** Значение - Число - номер группы дополнительных таблиц +// +// * ТаблицыПоГруппам - Соответствие из КлючИЗначение: +// ** Ключ - Число - номер группы дополнительных таблиц +// ** Значение - Массив из см. НовоеОписаниеСоединения +// +// * ПсевдонимыТаблицСПолями - Соответствие из КлючИЗначение: +// ** Ключ - Строка - псевдоним дополнительной таблицы +// с полями ключа доступа (кроме полей соединений). +// ** Значение - Булево - Истина. +// +Функция ГруппыДополнительныхТаблиц(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ГруппыДополнительныхТаблиц(Контекст)); +``` +
+ +## ТекстУсловияСоединения +
+ +Описание, пример вызова + +```bsl + +// Для функции ГруппыДополнительныхТаблиц. +Функция ТекстУсловияСоединения(ДополнительнаяТаблица, Контекст, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстУсловияСоединения(ДополнительнаяТаблица, Контекст, ); +``` +
+ +## ПараПолейУсловияСоединения +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ПервоеПоле - см. НовоеПолеУсловияСоединения +// * ВтороеПоле - см. НовоеПолеУсловияСоединения +// +Функция ПараПолейУсловияСоединения(ПервоеПоле, ВтороеПоле) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПараПолейУсловияСоединения(ПервоеПоле, ВтороеПоле)); +``` +
+ +## НовоеПолеУсловияСоединения +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * Поле - Строка +// * Псевдоним - Строка +// +Функция НовоеПолеУсловияСоединения() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовоеПолеУсловияСоединения()); +``` +
+ +## ДобавитьПолеТаблицыОбъекта +
+ +Описание, пример вызова + +```bsl + +// Для функций СвойстваПоля, ТекстУсловияСоединения. +Процедура ДобавитьПолеТаблицыОбъекта(Контекст, УзелПоле, СвойстваПоля = Неопределено, ДополнительнаяТаблица = Неопределено, ТабличнаяЧасть = "") Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПолеТаблицыОбъекта(Контекст, УзелПоле, СвойстваПоля, ДополнительнаяТаблица, ТабличнаяЧасть); +``` +
+ +## ДобавитьОпорноеПоле +
+ +Описание, пример вызова + +```bsl + +// Для функций СвойстваПоля, ТекстУсловияСоединения. +Процедура ДобавитьОпорноеПоле(Контекст, УзелПоле, СвойстваПоля = Неопределено, ДополнительнаяТаблица = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьОпорноеПоле(Контекст, УзелПоле, СвойстваПоля, ДополнительнаяТаблица); +``` +
+ +## УстановитьИспользованиеПоляТаблицыОбъекта +
+ +Описание, пример вызова + +```bsl + +// Для процедур УдалитьПоляНеиспользуемыхВидовДоступа, ГруппыДополнительныхТаблиц. +Процедура УстановитьИспользованиеПоляТаблицыОбъекта(Контекст, СвойстваПоля = Неопределено, ДополнительнаяТаблица = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьИспользованиеПоляТаблицыОбъекта(Контекст, СвойстваПоля, ДополнительнаяТаблица); +``` +
+ +## УстановитьИспользованиеОпорногоПоля +
+ +Описание, пример вызова + +```bsl + +// Для процедур УдалитьПоляНеиспользуемыхВидовДоступа, ГруппыДополнительныхТаблиц. +Процедура УстановитьИспользованиеОпорногоПоля(Контекст, СвойстваПоля = Неопределено, ДополнительнаяТаблица = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьИспользованиеОпорногоПоля(Контекст, СвойстваПоля, ДополнительнаяТаблица); +``` +
+ +## ЗавершитьПодготовкуПолейТаблицОбъекта +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьГруппыПолейИДополнительныхТаблиц. +// +// Параметры: +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ЗавершитьПодготовкуПолейТаблицОбъекта(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗавершитьПодготовкуПолейТаблицОбъекта(Контекст)); +``` +
+ +## ЗавершитьПодготовкуОпорныхПолей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьГруппыПолейИДополнительныхТаблиц. +// +// Параметры: +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ЗавершитьПодготовкуОпорныхПолей(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗавершитьПодготовкуОпорныхПолей(Контекст)); +``` +
+ +## ИмяПоляСРазверткойОпорногоПоляПоТипам +
+ +Описание, пример вызова + +```bsl + +// Для функций ТекстУсловияСоединения, СвойстваПоля. +Функция ИмяПоляСРазверткойОпорногоПоляПоТипам(Псевдоним, УзелПоле) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИмяПоляСРазверткойОпорногоПоляПоТипам(Псевдоним, УзелПоле)); +``` +
+ +## ЗаполнитьСвойстваПолей +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияДоступа. +Процедура ЗаполнитьСвойстваПолей(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьСвойстваПолей(Контекст)); +``` +
+ +## УпрощенноеУсловиеОграничения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьСвойстваПолей. +Функция УпрощенноеУсловиеОграничения(Знач Условие, Контекст, КореньУсловия = Ложь, ДобавитьОставшиесяПоля = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.УпрощенноеУсловиеОграничения(Условие, Контекст, КореньУсловия, ДобавитьОставшиесяПоля); +``` +
+ +## ОбработатьУпрощенноеЗначениеВыбора +
+ +Описание, пример вызова + +```bsl + +// Для функции УпрощенноеУсловиеОграничения. +Процедура ОбработатьУпрощенноеЗначениеВыбора(Условие, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьУпрощенноеЗначениеВыбора(Условие, ); +``` +
+ +## РезультатФункцииЗначениеРазрешено +
+ +Описание, пример вызова + +```bsl + +// Для функции УпрощенноеУсловиеОграничения. +Функция РезультатФункцииЗначениеРазрешено(Условие, ТипыКонечногоПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РезультатФункцииЗначениеРазрешено(Условие, ТипыКонечногоПоля, Контекст)); +``` +
+ +## ТипЗначенийДоступаИспользуется +
+ +Описание, пример вызова + +```bsl + +// Для функции РезультатФункцииЗначениеРазрешено и процедуры ДобавитьСвойстваТиповПоля. +Функция ТипЗначенийДоступаИспользуется(Контекст, ТипЗначений) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипЗначенийДоступаИспользуется(Контекст, ТипЗначений)); +``` +
+ +## РезультатФункцииПравоОбъектаРазрешено +
+ +Описание, пример вызова + +```bsl + +// Для функции УпрощенноеУсловиеОграничения. +Функция РезультатФункцииПравоОбъектаРазрешено(Условие, ТипыКонечногоПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РезультатФункцииПравоОбъектаРазрешено(Условие, ТипыКонечногоПоля, Контекст)); +``` +
+ +## ОбработанноеСовмещенноеПоле +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьСвойстваПолей. +Функция ОбработанноеСовмещенноеПоле(ОбработанныеОдинаковыеПоля, СвойстваПоля) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбработанноеСовмещенноеПоле(ОбработанныеОдинаковыеПоля, СвойстваПоля)); +``` +
+ +## УточнитьСвойстваПоляСравнения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьСвойстваПолей. +Процедура УточнитьСвойстваПоляСравнения(Свойства, ОписаниеПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УточнитьСвойстваПоляСравнения(Свойства, ОписаниеПоля, Контекст)); +``` +
+ +## НаборПолейУсловияКогда +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьСвойстваПолей. +Функция НаборПолейУсловияКогда(ИсходныеСвойстваПоля, ОписаниеПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НаборПолейУсловияКогда(ИсходныеСвойстваПоля, ОписаниеПоля, Контекст)); +``` +
+ +## БезЗначенияNull +
+ +Описание, пример вызова + +```bsl + +// Для функций СвойстваПоля, УточнитьСвойстваПоляСравнения, НаборПолейУсловияКогда. +Функция БезЗначенияNull(СвойстваПоля) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.БезЗначенияNull(СвойстваПоля)); +``` +
+ +## ДобавитьСвойстваТиповПоля +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьСвойстваПолей. +// +// Параметры: +// Свойства - см. СвойстваПоля +// ОписаниеПоля - см. НовоеПолеКлючаДоступа +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// +Процедура ДобавитьСвойстваТиповПоля(Свойства, ОписаниеПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСвойстваТиповПоля(Свойства, ОписаниеПоля, Контекст)); +``` +
+ +## ИмяТипаНаЯзыкеЗапросов +
+ +Описание, пример вызова + +```bsl + +// Для функций СвойстваПоля, ДобавитьСвойстваТиповПоля. +Функция ИмяТипаНаЯзыкеЗапросов(Тип, ОбъектМетаданных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИмяТипаНаЯзыкеЗапросов(Тип, ОбъектМетаданных); +``` +
+ +## ДобавитьВидОграниченияПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьСвойстваТиповПоля. +Процедура ДобавитьВидОграниченияПрав(ВидОграничения, СвойстваПоля, Контекст, ПоОбъекту = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВидОграниченияПрав(ВидОграничения, СвойстваПоля, Контекст, ПоОбъекту); +``` +
+ +## СвойстваПоля +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьСвойстваПолей. +// +// Параметры: +// УзелПоле - см. ОписаниеУзла +// Контекст - см. КонтекстПараметровПоСтруктуреОграничения +// СвойстваПоля - см. СвойстваПоля +// +// Возвращаемое значение: +// Структура: +// * ПсевдонимТаблицы - Строка +// * ИмяПоляДляЗапроса - Строка +// * ТабличнаяЧасть - Строка +// * ЭтоПолеСписка - Булево +// * БезЗначенияNull - Булево +// * ПолеСодержитNull - Неопределено +// * ЕстьВыразить - Неопределено +// * УзелПоле - см. ОписаниеУзла +// * СвойстваВложения - см. СвойстваПоля +// * Чтение - Булево +// * ПроверкаЕстьNull - Неопределено +// * ТипыСохраненияКлючейДоступа - Массив из Тип +// * ТипыСохраненияГруппЗначений - Массив из Тип +// * ТипыСохраненияЗначений - Массив из Тип +// * ТипыСохраненияПустойСсылки - Массив из Тип +// * ТипыСохраненияТипов - Массив из Тип +// * ТипыСохраненияТипаЗапрещенный - Массив из Тип +// * ТипыСохраненияТипаРазрешенный - Массив из Тип +// * НеиспользуемыеТипыЗначенийДоступа - Массив из Тип +// * ИспользуемыеТипыЗначенийДоступа - Массив из Тип +// * НесколькоГруппЗначений - Булево +// * ЭтоСписокЗначенийДоступаСГруппамиЗначений - Булево +// * ЕстьУточнениеNull - Булево +// * ЕстьУточнениеНеопределено - Булево +// * ЕстьТипВедущегоСписка - Булево +// * ЕстьТипВладельцаНастроекПрав - Булево +// * ЕстьПроверкаАвторизованногоПользователя - Булево +// * ТипыСохраненияТиповКонфигурации - Массив из Тип +// * ТипыСохраненияТиповРасширений - Массив из Тип +// * ТипыСохраненияТиповПростых - Массив из Тип +// * ИмяГруппыПолейКлючаДоступа - Строка +// * ИмяРеквизитаГруппыПолейКлючаДоступа - Строка +// +Функция СвойстваПоля(УзелПоле, Контекст, СвойстваПоля = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваПоля(УзелПоле, Контекст, СвойстваПоля); +``` +
+ +## ОписаниеВедущихСписковПоЗначениямПолей +
+ +Описание, пример вызова + +```bsl + + +// Для функции ПараметрыОграниченияПоСтруктуреОграничения. +// +// Возвращаемое значение: +// Структура: +// * Поля - Соответствие +// * СоединенияОтборов - Соответствие +// +Функция ОписаниеВедущихСписковПоЗначениямПолей() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеВедущихСписковПоЗначениямПолей()); +``` +
+ +## ДобавитьВедущиеСпискиПоЗначениямПолей +
+ +Описание, пример вызова + +```bsl + +// Для функций ГруппыДополнительныхТаблиц. +Процедура ДобавитьВедущиеСпискиПоЗначениямПолей(Контекст, УзелПоле, СвойстваВложения = Неопределено, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВедущиеСпискиПоЗначениямПолей(Контекст, УзелПоле, СвойстваВложения, ); +``` +
+ +## ДобавитьПолеВедущегоСпискаПоЗначениямПолей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьВедущиеСпискиПоЗначениямПолей. +Процедура ДобавитьПолеВедущегоСпискаПоЗначениямПолей(Контекст, Таблица, Поле, ТипПоля, ДополнительныйКонтекст, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПолеВедущегоСпискаПоЗначениямПолей(Контекст, Таблица, Поле, ТипПоля, ДополнительныйКонтекст, ); +``` +
+ +## ВставитьПолеВедущегоСпискаПоЗначениямПолей +
+ +Описание, пример вызова + +```bsl + +// Для процедуру ДобавитьПолеВедущегоСпискаПоЗначениямПолей. +Процедура ВставитьПолеВедущегоСпискаПоЗначениямПолей(ОписаниеПолей, ТабличнаяЧасть, Поле, ТипПоля) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВставитьПолеВедущегоСпискаПоЗначениямПолей(ОписаниеПолей, ТабличнаяЧасть, Поле, ТипПоля)); +``` +
+ +## ОписаниеВедущихСписковПоПолюСсылка +
+ +Описание, пример вызова + +```bsl + +// Для функции ПараметрыОграниченияПоСтруктуреОграничения. +// +// Возвращаемое значение: +// Структура: +// * Списки - Соответствие +// * КлючиЗапросовПоТипам - Соответствие +// * СоединенияОтборов - Соответствие +// * ТипСсылки - ОписаниеТипов +// +Функция ОписаниеВедущихСписковПоПолюСсылка() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеВедущихСписковПоПолюСсылка()); +``` +
+ +## ДобавитьВедущийСписокПоПолюСсылка +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьСвойстваТиповПоля. +Процедура ДобавитьВедущийСписокПоПолюСсылка(ВедущиеСписки, ВедущийСписок, УзелПоле, СвойстваПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВедущийСписокПоПолюСсылка(ВедущиеСписки, ВедущийСписок, УзелПоле, СвойстваПоля, Контекст)); +``` +
+ +## ЗаполнитьОтборыПоЗначениямПолейВедущегоСписка +
+ +Описание, пример вызова + +```bsl + +// Для функции ГруппыДополнительныхТаблиц. +Процедура ЗаполнитьОтборыПоЗначениямПолейВедущегоСписка(ВедущийСписок, Описание, Группы, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьОтборыПоЗначениямПолейВедущегоСписка(ВедущийСписок, Описание, Группы, Контекст)); +``` +
+ +## ЗаполнитьОтборыВедущихСписковПоПолюСсылка +
+ +Описание, пример вызова + +```bsl + +// Для функции ГруппыДополнительныхТаблиц. +Процедура ЗаполнитьОтборыВедущихСписковПоПолюСсылка(ВедущиеСписки, Группы, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьОтборыВедущихСписковПоПолюСсылка(ВедущиеСписки, Группы, Контекст)); +``` +
+ +## ТекстСоединенияОтбораПоЗначениямПолей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьОтборыПоЗначениямПолейВедущегоСписка. +Функция ТекстСоединенияОтбораПоЗначениямПолей(Условие, Группы, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстСоединенияОтбораПоЗначениямПолей(Условие, Группы, Контекст)); +``` +
+ +## ЭтоПростойТип +
+ +Описание, пример вызова + +```bsl + + +// Для процедур ДобавитьОпорноеПоле, ДобавитьТипыИзмерения, ДобавитьСвойстваТиповПоля, +// ДобавитьПроверкуПоТипам и функции СвойстваПоля. +// +Функция ЭтоПростойТип(Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоПростойТип(Тип)); +``` +
+ +## ТипПроверяется +
+ +Описание, пример вызова + +```bsl + +// Для функции ДобавитьСвойстваТиповПоля. +Функция ТипПроверяется(Узел, ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипПроверяется(Узел, ПолноеИмя)); +``` +
+ +## ТипУточнен +
+ +Описание, пример вызова + +```bsl + +// Для функции ДобавитьСвойстваТиповПоля. +Функция ТипУточнен(Узел, ИмяТипаНаЯзыкеЗапросов) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипУточнен(Узел, ИмяТипаНаЯзыкеЗапросов)); +``` +
+ +## УточнениеТипа +
+ +Описание, пример вызова + +```bsl + +// Для функции ДобавитьСвойстваТиповПоля. +Функция УточнениеТипа(Узел, ИмяТипаНаЯзыкеЗапросов) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.УточнениеТипа(Узел, ИмяТипаНаЯзыкеЗапросов)); +``` +
+ +## ТипЗначенияУзлаЗначениеИлиКонстанта +
+ +Описание, пример вызова + +```bsl + +// Для функции СвойстваПоля. +Функция ТипЗначенияУзлаЗначениеИлиКонстанта(Узел) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипЗначенияУзлаЗначениеИлиКонстанта(Узел)); +``` +
+ +## ВыражениеУзлаЗначениеИлиКонстанта +
+ +Описание, пример вызова + +```bsl + +// Для функций ТекстУсловияСоединения, СвойстваПоля, НаборПолейУсловияКогда и +// процедуры УточнитьСвойстваПоляСравнения. +// +Функция ВыражениеУзлаЗначениеИлиКонстанта(Узел) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВыражениеУзлаЗначениеИлиКонстанта(Узел)); +``` +
+ +## ТипСсылкиПоПолномуИмениПредопределенного +
+ +Описание, пример вызова + +```bsl + +// Для функции ТипЗначенияУзлаЗначениеИлиКонстанта. +Функция ТипСсылкиПоПолномуИмениПредопределенного(ПолноеИмяПредопределенного) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипСсылкиПоПолномуИмениПредопределенного(ПолноеИмяПредопределенного)); +``` +
+ +## ТипСсылкиПоПолномуИмениМетаданных +
+ +Описание, пример вызова + +```bsl + +// Для функций СвойстваПоля, ТипСсылкиПоПолномуИмениПредопределенного. +Функция ТипСсылкиПоПолномуИмениМетаданных(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипСсылкиПоПолномуИмениМетаданных(ПолноеИмя)); +``` +
+ +## ТипКлючаЗаписиПоПолномуИмениМетаданных +
+ +Описание, пример вызова + +```bsl + +// Для функции КлючТаблицы. +Функция ТипКлючаЗаписиПоПолномуИмениМетаданных(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипКлючаЗаписиПоПолномуИмениМетаданных(ПолноеИмя)); +``` +
+ +## ТипНабораЗаписейПоПолномуИмениМетаданных +
+ +Описание, пример вызова + +```bsl + +// Для функции КлючТаблицы. +Функция ТипНабораЗаписейПоПолномуИмениМетаданных(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипНабораЗаписейПоПолномуИмениМетаданных(ПолноеИмя)); +``` +
+ +## ТипМенеджераОбъектаПоПолномуИмениМетаданных +
+ +Описание, пример вызова + +```bsl + +// Для функции КлючТаблицы. +Функция ТипМенеджераОбъектаПоПолномуИмениМетаданных(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипМенеджераОбъектаПоПолномуИмениМетаданных(ПолноеИмя)); +``` +
+ +## ЭтоРусскийВариантВидаОбъектаМетаданных +
+ +Описание, пример вызова + +```bsl + +// Для функций ТипСсылкиПоПолномуИмениМетаданных, ТипКлючаЗаписиПоПолномуИмениМетаданных, +// ТипНабораЗаписейПоПолномуИмениМетаданных, ТипМенеджераОбъектаПоПолномуИмениМетаданных. +// +Функция ЭтоРусскийВариантВидаОбъектаМетаданных(ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЭтоРусскийВариантВидаОбъектаМетаданных(ПолноеИмя)); +``` +
+ +## НовыеРеквизитыТаблицКлюча +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка +// * Значение - Массив из Строка +// +Функция НовыеРеквизитыТаблицКлюча() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеРеквизитыТаблицКлюча()); +``` +
+ +## ДобавитьТекстыЗапросовВПараметрыОграничения +
+ +Описание, пример вызова + +```bsl + +// Основная функция области, которая является второй частью +// функции ПараметрыОграниченияПоСтруктуреОграничения, но +// не используется при подготовке хранимых параметров ограничения доступа, +// а используется при вызове функции ПараметрыОграничения. +// +Процедура ДобавитьТекстыЗапросовВПараметрыОграничения(Результат) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТекстыЗапросовВПараметрыОграничения(Результат)); +``` +
+ +## ЗаполнитьНедостающиеТипыОпорныхПолей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПараметрыОграниченияПоСтруктуреОграничения. +Процедура ЗаполнитьНедостающиеТипыОпорныхПолей(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьНедостающиеТипыОпорныхПолей(Результат, Контекст)); +``` +
+ +## ДобавитьТекстЗапросаДатыСледующегоЭлементаДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ДобавитьТекстЗапросаДатыСледующегоЭлементаДанных(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТекстЗапросаДатыСледующегоЭлементаДанных(Результат, Контекст)); +``` +
+ +## ДобавитьТекстЗапросаУстаревшихЭлементовДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ДобавитьТекстЗапросаУстаревшихЭлементовДанных(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТекстЗапросаУстаревшихЭлементовДанных(Результат, Контекст)); +``` +
+ +## ЗаполнитьИспользуемыеПоляОсновнойТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ЗаполнитьИспользуемыеПоляОсновнойТаблицы(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьИспользуемыеПоляОсновнойТаблицы(Контекст)); +``` +
+ +## ЗаполнитьШаблоныЧастейЗапросаПроверки +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ЗаполнитьШаблоныЧастейЗапросаПроверки(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьШаблоныЧастейЗапросаПроверки(Контекст)); +``` +
+ +## ЗаполнитьШаблоныЧастейЗапросаПроверкиОбъекта +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьШаблоныЧастейЗапросаПроверки. +Процедура ЗаполнитьШаблоныЧастейЗапросаПроверкиОбъекта(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьШаблоныЧастейЗапросаПроверкиОбъекта(Контекст)); +``` +
+ +## ЗаполнитьШаблоныЧастейЗапросаПроверкиРегистра +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьШаблоныЧастейЗапросаПроверки. +Процедура ЗаполнитьШаблоныЧастейЗапросаПроверкиРегистра(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьШаблоныЧастейЗапросаПроверкиРегистра(Контекст)); +``` +
+ +## ДобавитьЗапросыПроверкиПоВедущимСпискам +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЗаполнитьШаблоныЧастейЗапросаПроверкиОбъекта, ЗаполнитьШаблоныЧастейЗапросаПроверкиРегистра. +Процедура ДобавитьЗапросыПроверкиПоВедущимСпискам(ШаблонЗапроса, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗапросыПроверкиПоВедущимСпискам(ШаблонЗапроса, Контекст)); +``` +
+ +## ОписаниеЗапросовПроверкиПоВедущейТаблице +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьЗапросыПроверкиПоВедущимСпискам. +Функция ОписаниеЗапросовПроверкиПоВедущейТаблице(СоединенияОтборов, ТипыПолей, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеЗапросовПроверкиПоВедущейТаблице(СоединенияОтборов, ТипыПолей, ); +``` +
+ +## ДобавитьЗапросыПроверкиПоПолюСсылкаВедущихСписков +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьЗапросыПроверкиПоВедущимСпискам. +Процедура ДобавитьЗапросыПроверкиПоПолюСсылкаВедущихСписков(ВидВедущегоСписка, ШаблонЗапроса, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗапросыПроверкиПоПолюСсылкаВедущихСписков(ВидВедущегоСписка, ШаблонЗапроса, Контекст)); +``` +
+ +## СобратьЧастиЗапросаПроверки +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура СобратьЧастиЗапросаПроверки(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СобратьЧастиЗапросаПроверки(Результат, Контекст)); +``` +
+ +## ДобавитьЧастьЗапроса +
+ +Описание, пример вызова + +```bsl + +// Для процедуры СобратьЧастиЗапросаПроверки. +Процедура ДобавитьЧастьЗапроса(ЧастиЗапроса, ЧастьУсловияПроверки, Контекст, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЧастьЗапроса(ЧастиЗапроса, ЧастьУсловияПроверки, Контекст, ); +``` +
+ +## СобратьЧастиЗапросовЗаполнения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура СобратьЧастиЗапросовЗаполнения(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СобратьЧастиЗапросовЗаполнения(Результат, Контекст)); +``` +
+ +## ДобавитьЧастьЗапросаВыбораПравВедущихКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры СобратьЧастиЗапросовЗаполнения. +Процедура ДобавитьЧастьЗапросаВыбораПравВедущихКлючейДоступа(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЧастьЗапросаВыбораПравВедущихКлючейДоступа(Контекст)); +``` +
+ +## ДобавитьЧастьЗапросаВыбораПравВедущихСписков +
+ +Описание, пример вызова + +```bsl + +// Для процедуры СобратьЧастиЗапросовЗаполнения. +Процедура ДобавитьЧастьЗапросаВыбораПравВедущихСписков(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЧастьЗапросаВыбораПравВедущихСписков(Контекст)); +``` +
+ +## ДобавитьЧастьЗапросаВыбораПравПоВладельцамНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры СобратьЧастиЗапросовЗаполнения. +Процедура ДобавитьЧастьЗапросаВыбораПравПоВладельцамНастроекПрав(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЧастьЗапросаВыбораПравПоВладельцамНастроекПрав(Контекст)); +``` +
+ +## ТекстЗапросаВыбораПравПоВладельцамНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьЧастьЗапросаВыбораПравПоВладельцамНастроекПрав и +// функции ТекстЗапросаПравПользователейПоВладельцамНастроекПрав. +// +Функция ТекстЗапросаВыбораПравПоВладельцамНастроекПрав() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаВыбораПравПоВладельцамНастроекПрав()); +``` +
+ +## ТекстЗапросаКлючейДоступаДляОбновленияПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры СобратьЧастиЗапросовЗаполнения. +Функция ТекстЗапросаКлючейДоступаДляОбновленияПрав(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаКлючейДоступаДляОбновленияПрав(Контекст)); +``` +
+ +## ТекстЗапросаКлючейПоВедущимКлючамДляОбновленияПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры СобратьЧастиЗапросовЗаполнения. +Функция ТекстЗапросаКлючейПоВедущимКлючамДляОбновленияПрав(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаКлючейПоВедущимКлючамДляОбновленияПрав(Контекст)); +``` +
+ +## ТекстЗапросаУстаревшихКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры СобратьЧастиЗапросовЗаполнения. +Функция ТекстЗапросаУстаревшихКлючейДоступа(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаУстаревшихКлючейДоступа(Контекст)); +``` +
+ +## ЗаполнитьЗапросыПравПользователей +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ЗаполнитьЗапросыПравПользователей(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьЗапросыПравПользователей(Результат, Контекст)); +``` +
+ +## УстановитьПоляИзмеренийДляВыбораИГруппировки +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьЗапросыПравПользователей. +Процедура УстановитьПоляИзмеренийДляВыбораИГруппировки(ТекстЗапроса, ПолноеИмяРегистра) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьПоляИзмеренийДляВыбораИГруппировки(ТекстЗапроса, ПолноеИмяРегистра)); +``` +
+ +## УточненноеИмяПоляКлючаЗаписиДляВыбораПравДоступаКДанным +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьПоляИзмеренийДляВыбораИГруппировки +Функция УточненноеИмяПоляКлючаЗаписиДляВыбораПравДоступаКДанным(ИмяПоля) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.УточненноеИмяПоляКлючаЗаписиДляВыбораПравДоступаКДанным(ИмяПоля)); +``` +
+ +## ДобавитьТекстЗапросаПравПользователейПоВладельцамНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьЗапросыПравПользователей. +Процедура ДобавитьТекстЗапросаПравПользователейПоВладельцамНастроекПрав(ДляВнешнихПользователей, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТекстЗапросаПравПользователейПоВладельцамНастроекПрав(ДляВнешнихПользователей, ); +``` +
+ +## ЗаполнитьЗапросыПроверкиПравЧтениеИзменение +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ЗаполнитьЗапросыПроверкиПравЧтениеИзменение(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьЗапросыПроверкиПравЧтениеИзменение(Результат, Контекст)); +``` +
+ +## УсловиеИзЗапросаСПроверкойПоВладельцамНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьЗапросыПроверкиПравЧтениеИзменение. +Функция УсловиеИзЗапросаСПроверкойПоВладельцамНастроекПрав() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.УсловиеИзЗапросаСПроверкойПоВладельцамНастроекПрав()); +``` +
+ +## ТекстЗапросаСПроверкойПоВладельцамНастроекПрав +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьЗапросыПроверкиПравЧтениеИзменение. +Функция ТекстЗапросаСПроверкойПоВладельцамНастроекПрав() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаСПроверкойПоВладельцамНастроекПрав()); +``` +
+ +## УточнитьРегистрКлючейИУсловиеСоединения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ЗаполнитьЗапросыПроверкиПравЧтениеИзменение. +Процедура УточнитьРегистрКлючейИУсловиеСоединения(ТекстЗапроса, Результат, Контекст, ДобавитьПоляВыбора = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УточнитьРегистрКлючейИУсловиеСоединения(ТекстЗапроса, Результат, Контекст, ДобавитьПоляВыбора); +``` +
+ +## ПодставитьОбщиеПараметрыВЗапрос +
+ +Описание, пример вызова + +```bsl + +// Для функции СобратьЧастиЗапросов. +Процедура ПодставитьОбщиеПараметрыВЗапрос(ТекстЗапроса, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПодставитьОбщиеПараметрыВЗапрос(ТекстЗапроса, Контекст)); +``` +
+ +## ДобавитьПроверкуШапкиКлюча +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ДобавитьПроверкуШапкиКлюча(Контекст, НомерШапки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПроверкуШапкиКлюча(Контекст, НомерШапки)); +``` +
+ +## ДобавитьПроверкуТабличнойЧастиКлюча +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ДобавитьПроверкуТабличнойЧастиКлюча(Контекст, НомерТабличнойЧастиКлюча) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПроверкуТабличнойЧастиКлюча(Контекст, НомерТабличнойЧастиКлюча)); +``` +
+ +## ЧастьУсловияПроверки +
+ +Описание, пример вызова + +```bsl + +// Для процедур ДобавитьПроверкуШапкиКлюча, ДобавитьПроверкуТабличнойЧастиКлюча. +// +// Возвращаемое значение: +// Структура: +// * Соединения - Строка +// * Условие - Строка +// * ДополнительныеПоля - Строка +// * ИмяТабличнойЧастиКлюча - Строка +// +Функция ЧастьУсловияПроверки(Соединения, Условие, ДополнительныеПоля, ИмяТабличнойЧастиКлюча = "") Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЧастьУсловияПроверки(Соединения, Условие, ДополнительныеПоля, ИмяТабличнойЧастиКлюча); +``` +
+ +## ДобавитьЗаполнениеШапкиКлюча +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ДобавитьЗаполнениеШапкиКлюча(Контекст, НомерШапки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗаполнениеШапкиКлюча(Контекст, НомерШапки)); +``` +
+ +## ДобавитьУсловиеОтбораПравДляШапкиКлюча +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьЗаполнениеШапкиКлюча. +Процедура ДобавитьУсловиеОтбораПравДляШапкиКлюча(Контекст, ГруппаПолей, НомерШапки, НазначениеУсловия) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьУсловиеОтбораПравДляШапкиКлюча(Контекст, ГруппаПолей, НомерШапки, НазначениеУсловия)); +``` +
+ +## ДобавитьВыборКлючейБезПолейВШапке +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ДобавитьВыборКлючейБезПолейВШапке(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВыборКлючейБезПолейВШапке(Контекст)); +``` +
+ +## ДобавитьЗаполнениеТабличнойЧастиКлюча +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТекстыЗапросовВПараметрыОграничения. +Процедура ДобавитьЗаполнениеТабличнойЧастиКлюча(Контекст, НомерТабличнойЧастиКлюча) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьЗаполнениеТабличнойЧастиКлюча(Контекст, НомерТабличнойЧастиКлюча)); +``` +
+ +## ДобавитьУсловиеОтбораПравДляТабличнойЧастиКлюча +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьЗаполнениеТабличнойЧастиКлюча. +Процедура ДобавитьУсловиеОтбораПравДляТабличнойЧастиКлюча(Контекст, ГруппаПолей, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьУсловиеОтбораПравДляТабличнойЧастиКлюча(Контекст, ГруппаПолей, ); +``` +
+ +## ДобавитьОписаниеТаблицыКлюча +
+ +Описание, пример вызова + +```bsl + +// Для процедур ДобавитьЗаполнениеШапкиКлюча, ДобавитьЗаполнениеТабличнойЧастиКлюча. +Процедура ДобавитьОписаниеТаблицыКлюча(ИмяТаблицыКлюча, ГруппаПолей, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьОписаниеТаблицыКлюча(ИмяТаблицыКлюча, ГруппаПолей, Контекст)); +``` +
+ +## ДобавитьУсловиеОтбораПоВедущимКлючамДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьЗаполнениеШапкиКлюча, ДобавитьЗаполнениеТабличнойЧастиКлюча. +Процедура ДобавитьУсловиеОтбораПоВедущимКлючамДоступа(Контекст, ГруппаПолей, НомерШапки = 0, НомерТабличнойЧастиКлюча = 0) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьУсловиеОтбораПоВедущимКлючамДоступа(Контекст, ГруппаПолей, НомерШапки, НомерТабличнойЧастиКлюча); +``` +
+ +## СоединенияИПоляПоТаблицам +
+ +Описание, пример вызова + +```bsl + +// Для процедур ДобавитьПроверкуШапкиКлюча, ДобавитьПроверкуТабличнойЧастиКлюча. +Функция СоединенияИПоляПоТаблицам(ГруппаПолей, ТабличнаяЧастьКлюча, НомерШапки = 0, ДляВыбораЗначений = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СоединенияИПоляПоТаблицам(ГруппаПолей, ТабличнаяЧастьКлюча, НомерШапки, ДляВыбораЗначений); +``` +
+ +## СравнениеПоля +
+ +Описание, пример вызова + +```bsl + +// Для функции СоединенияИПоляПоТаблицам. +Функция СравнениеПоля(СвойстваПоля) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СравнениеПоля(СвойстваПоля)); +``` +
+ +## ДобавитьПроверкуПоТипам +
+ +Описание, пример вызова + +```bsl + +// Для функции СравнениеПоля. +Процедура ДобавитьПроверкуПоТипам(ПроверкиПоТипам, ИсходныеТипы, Проверка, ДополнительноеСвойство = "", ПропуститьБулево = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПроверкуПоТипам(ПроверкиПоТипам, ИсходныеТипы, Проверка, ДополнительноеСвойство, ПропуститьБулево); +``` +
+ +## ЗаполнитьПсевдонимПоНомеруРеквизита +
+ +Описание, пример вызова + +```bsl + +// Для функции ДобавитьПроверкуШапкиКлюча. +Процедура ЗаполнитьПсевдонимПоНомеруРеквизита(Соединения, Поле, НомерРеквизита, Псевдоним) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьПсевдонимПоНомеруРеквизита(Соединения, Поле, НомерРеквизита, Псевдоним)); +``` +
+ +## ТекстСОтступом +
+ +Описание, пример вызова + +```bsl + +// Для функций ДобавитьПроверкуШапкиКлюча, СравнениеПоля. +Функция ТекстСОтступом(Текст, Отступ) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстСОтступом(Текст, Отступ)); +``` +
+ +## ЕстьПростойТип +
+ +Описание, пример вызова + +```bsl + +// Для функции СравнениеПоля, ДобавитьОпорноеПоле. +Функция ЕстьПростойТип(ОписаниеТипов) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЕстьПростойТип(ОписаниеТипов)); +``` +
+ +## РазобранноеОграничение +
+ +Описание, пример вызова + +```bsl + +// См. также УправлениеДоступом.РазобранноеОграничение. +// +// Возвращаемое значение: +// Структура: +// * ПоляТаблиц - см. НовыеПоляТаблиц +// * ВнутренниеДанные - см. НовыеВнутренниеДанные +// +Функция РазобранноеОграничение(ОсновнаяТаблица, ТекстОграничения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РазобранноеОграничение(ОсновнаяТаблица, ТекстОграничения) +``` +
+ +## НовыеВнутренниеДанные +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ОсновнаяТаблица - Строка - таблица, которая ограничивается. +// * ТекстОграничения - Строка +// * СинтаксисЯзыка - см. СинтаксисЯзыка +// * ПоляТаблиц - см. НовыеПоляТаблиц +// * Псевдонимы - Соответствие +// * ПоляКлючаДоступа - Массив из см. НовоеПолеКлючаДоступа +// * ТаблицаНаборовСимволов - см. ТаблицаНаборовСимволов +// * ЧастиОграничения - см. ЧастиОграничения +// +Функция НовыеВнутренниеДанные() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеВнутренниеДанные()); +``` +
+ +## РасширенныеВнутренниеДанные +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ОсновнаяТаблица - Строка - таблица, которая ограничивается. +// * ТекстОграничения - Строка +// * СинтаксисЯзыка - см. СинтаксисЯзыка +// * ПоляТаблиц - см. НовыеПоляТаблиц +// * Псевдонимы - Соответствие +// * ПоляКлючаДоступа - Массив из см. НовоеПолеКлючаДоступа +// * ТаблицаНаборовСимволов - см. ТаблицаНаборовСимволов +// * ЧастиОграничения - см. ЧастиОграничения +// * ЭтоУсловиеСоединения - Булево +// * ЭтоУсловиеКогда - Булево +// * ЭтоЗначениеТогдаИначе - Булево +// * КорневойУзел - см. ОписаниеУзла +// +Функция РасширенныеВнутренниеДанные(ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.РасширенныеВнутренниеДанные(ВнутренниеДанные)); +``` +
+ +## НовыеПоляТаблиц +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - имя коллекции объектов метаданных, например, Справочники. +// * Значение - см. НовыйСоставКоллекции +// +Функция НовыеПоляТаблиц() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеПоляТаблиц()); +``` +
+ +## НовыйСоставКоллекции +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Строка - имя таблицы (объекта метаданных) в верхнем регистре. +// * Значение - см. НовыеСвойстваТаблицы +// +Функция НовыйСоставКоллекции() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйСоставКоллекции()); +``` +
+ +## НовыеСвойстваТаблицы +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ТаблицаСуществует - Булево - Ложь (для заполнения Истина, если существует). +// * ЭтоОсновнаяТаблица - Булево +// * Источники - Массив +// * ПервоеПоле - Неопределено +// * Поля - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя реквизита в верхнем регистре, в том числе через точки, +// например, "ВЛАДЕЛЕЦ.ОРГАНИЗАЦИЯ", "ТОВАРЫ.НОМЕНКЛАТУРА". +// ** Значение - см. НовыеСвойстваПоля +// * Предопределенные - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя предопределенного элемента. +// ** Значение - см. НовыеСвойстваПредопределенного +// * Расширения - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя третьего имени таблицы, например, имя табличной части. +// ** Значение - см. НовыеСвойстваРасширения +// +Функция НовыеСвойстваТаблицы() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеСвойстваТаблицы()); +``` +
+ +## НовыеСвойстваПоля +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ПолеСОшибкой - Число - 0 (для заполнения, если поле содержит ошибку, +// если 1, то ошибка в имени первой части поля, +// если 2, то ошибка в имени второй части поля, т.е. после первой точки). +// * ВидОшибки - Строка - "НеНайдено", "ТабличнаяЧастьБезПоля", +// "ТабличнаяЧастьПослеТочки". +// * Коллекция - Строка - пустая строка (для заполнения, если первая часть +// поля существует, т.е. часть поля до первой точки). Варианты: "Реквизиты", +// "ТабличныеЧасти", "СтандартныеРеквизиты", "СтандартныеТабличныеЧасти", +// "Измерения", "Ресурсы", "Графы", "ПризнакиУчета", "ПризнакиУчетаСубконто", +// "РеквизитыАдресации", "СпециальныеПоля". Специальные поля - это +// "Значение" - у таблиц "Константа.*", +// "Регистратор" и "Период" - у таблиц "Последовательность.*", +// "ОбъектПерерасчета", "ВидРасчета" у таблиц "РегистрРасчета.<Имя>.<ИмяПерерасчета>". +// Поля после первой точки могут относится только к коллекциям: "Реквизиты", +// "СтандартныеРеквизиты", "ПризнакиУчета", "РеквизитыАдресации". Для этих +// частей имени поля не требуется уточнять коллекцию. +// * СодержитТипы - Соответствие из КлючИЗначение: +// ** Ключ - Строка - полное имя ссылочной таблицы в верхнем регистре. +// ** Значение - Структура: +// *** ИмяТипа - Строка - имя типа, наличие которого нужно проверить. +// *** СодержитТип - Булево - Ложь (для заполнения Истина, +// если у поля последнего поля есть тип). +// * ПервыйИсточник - Структура: +// ** Ключ - СтрокаТаблицыЗначений - строка-источник первого поля. +// ** Значение - Строка - таблица +// +Функция НовыеСвойстваПоля() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеСвойстваПоля()); +``` +
+ +## НовыеСвойстваПредопределенного +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ИмяСуществует - Булево - Ложь (для заполнения Истина, если предопределенный есть). +// * Источники - Массив +// +Функция НовыеСвойстваПредопределенного() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеСвойстваПредопределенного()); +``` +
+ +## НовыеСвойстваРасширения +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ТаблицаСуществует - Булево - Ложь (для заполнения Истина, если существует). +// * Источники - Массив +// * ПервоеПоле - Неопределено +// * Поля - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя реквизита в верхнем регистре, в том числе через точки, +// например, "ВЛАДЕЛЕЦ.ОРГАНИЗАЦИЯ", "ТОВАРЫ.НОМЕНКЛАТУРА". +// ** Значение - см. НовыеСвойстваПоля +// +Функция НовыеСвойстваРасширения() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеСвойстваРасширения()); +``` +
+ +## СтруктураОграничения +
+ +Описание, пример вызова + +```bsl + + +// Смотри также УправлениеДоступом.СтруктураОграничения +// +// Параметры: +// РазобранноеОграничение - см. РазобранноеОграничение +// +// Возвращаемое значение: +// Структура: +// * ОписаниеОшибок - см. ОписаниеОшибок +// * ДополнительныеТаблицы - Массив из см. НовоеОписаниеСоединения +// * ПсевдонимОсновнойТаблицы - Строка - заполнено, если указаны дополнительные таблицы. +// * ОграничениеЧтения - см. ОписаниеУзла +// * ОграничениеИзменения - см. ОписаниеУзла +// +Функция СтруктураОграничения(РазобранноеОграничение) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтруктураОграничения(РазобранноеОграничение) +``` +
+ +## ОписаниеОшибок +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ЕстьОшибки - Булево +// * ТекстОшибок - Строка +// * Ограничение - Строка +// * Ошибки - Массив из см. СвойстваОшибки +// * Дополнение - Строка +// +Функция ОписаниеОшибок() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеОшибок()); +``` +
+ +## СвойстваОшибки +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * НомерСтроки - Число - номер строки текста ограничения, в которой найдена ошибка. +// * ПозицияВСтроке - Число - позиция в строке текста ограничения, в которой найдена ошибка. +// * ТекстОшибки - Строка - описание ошибки. +// * СтрокаОшибки - Строка - строка текста ограничения, в которой найдена ошибка. +// +Функция СвойстваОшибки() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваОшибки()); +``` +
+ +## ТекстОшибокДляВызоваИсключения +
+ +Описание, пример вызова + +```bsl + +// Формирует полный текст ошибок описания ограничения доступа с дополнением, +// который можно указать, как текст для вызова исключения. +// +// Параметры: +// ПолноеИмя - Строка - полное имя таблицы списка. +// ОписаниеОшибок - Структура - значение возвращаемое функцией СтруктураОграничения. +// ДляВнешнихПользователей - Булево - если передать Истина, тогда текст ошибки будет содержать +// назначение ограничения для внешних пользователей. +// +// Возвращаемое значение: +// Строка - текст для вызова исключения. +// +Функция ТекстОшибокДляВызоваИсключения(ПолноеИмя, ОписаниеОшибок, ДляВнешнихПользователей, ВМодулеМенеджера) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстОшибокДляВызоваИсключения(ПолноеИмя, ОписаниеОшибок, ДляВнешнихПользователей, ВМодулеМенеджера)); +``` +
+ +## ДобавитьОшибку +
+ +Описание, пример вызова + +```bsl + +// Для функции СтруктураОграничения. +Процедура ДобавитьОшибку(Строка, ОписаниеОшибок, ВнутренниеДанные, ДлинаНомераСтроки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьОшибку(Строка, ОписаниеОшибок, ВнутренниеДанные, ДлинаНомераСтроки)); +``` +
+ +## ПронумерованныйТекстОграниченияСОтметкамиОшибок +
+ +Описание, пример вызова + +```bsl + +// Для функции СтруктураОграничения. +Функция ПронумерованныйТекстОграниченияСОтметкамиОшибок(ТекстОграничения, Ошибки, ДлинаНомераСтроки) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПронумерованныйТекстОграниченияСОтметкамиОшибок(ТекстОграничения, Ошибки, ДлинаНомераСтроки)); +``` +
+ +## ОписаниеДопустимыхШаблонов +
+ +Описание, пример вызова + +```bsl + +// Для функции СтруктураОграничения. +Функция ОписаниеДопустимыхШаблонов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеДопустимыхШаблонов()); +``` +
+ +## КоординатыПозицииВТексте +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьОшибку. +Функция КоординатыПозицииВТексте(Текст, ПозицияВТексте) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КоординатыПозицииВТексте(Текст, ПозицияВТексте)); +``` +
+ +## ТаблицаНаборовСимволов +
+ +Описание, пример вызова + +```bsl + +// Для функции РазобранноеОграничение. +// Раскладывает текст в таблицу наборов символов, в которых: +// - нет символов отступа (пробелов, табуляций, переводов строки); +// - выделены символы произвольных строк и чисел; +// - определены ключевые слова и операции; +// - проверен формат имен и чисел; +// - добавлены ошибки с описанием. +// +// Параметры: +// ТекстОграничения - Строка - текст ограничения доступа. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Символы - Строка - символ, пара символов или слово. +// * Позиция - Число - позиция символов в тексте ограничения. +// * Вид - Строка - "КлючевоеСлово", "Операция", "Имя", "Разделитель", +// "Число", "ПроизвольнаяСтрока", "НедопустимыйСимвол", "Конец". +// * Тип - Строка - тип для для видов "КлючевоеСлово" и "Операция". +// * Приоритет - Число - приоритет для видов "КлючевоеСлово" и "Операция". +// * Уточнение - Число - числовое значение для вида "Число". +// - Строка - имя для вида "КлючевоеСлово", строка символов для вида "ПроизвольнаяСтрока". +// * ЭтоРезерв - Булево - если Истина, значит это зарезервированная операция или ключевое слово. +// * ПозицияОшибки - Число - позиция ошибки в тексте ограничения, если текст ошибки не пустой. +// * ТекстОшибки - Строка - текст ошибки, если найдена ошибка. +// +Функция ТаблицаНаборовСимволов(ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТаблицаНаборовСимволов(ВнутренниеДанные)); +``` +
+ +## ДобавитьСловоВТаблицуНаборовСимволов +
+ +Описание, пример вызова + +```bsl + +// Для функции ТаблицаНаборовСимволов. +Процедура ДобавитьСловоВТаблицуНаборовСимволов(Таблица, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСловоВТаблицуНаборовСимволов(Таблица, ); +``` +
+ +## ДобавитьОперациюВТаблицуНаборовСимволов +
+ +Описание, пример вызова + +```bsl + +// Для функции ТаблицаНаборовСимволов. +Процедура ДобавитьОперациюВТаблицуНаборовСимволов(Таблица, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьОперациюВТаблицуНаборовСимволов(Таблица, ); +``` +
+ +## СинтаксисЯзыка +
+ +Описание, пример вызова + +```bsl + +// Для функции РазобранноеОграничение и косвенно для многих других. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * СимволыЯзыка - см. СимволыЯзыка +// * СимволыЦифр - см. СимволыЦифр +// * ОперацииЯзыка - см. ОперацииЯзыка +// * СловаЯзыка - см. СловаЯзыка +// * ТипыТаблиц - см. ТипыТаблиц +// +Функция СинтаксисЯзыка() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СинтаксисЯзыка() +``` +
+ +## СимволыЯзыка +
+ +Описание, пример вызова + +```bsl + +// Для функции СинтаксисЯзыка. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение: +// * Ключ - Строка - символ +// * Значение - Строка - вид символа +// +Функция СимволыЯзыка() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СимволыЯзыка()); +``` +
+ +## СимволыЦифр +
+ +Описание, пример вызова + +```bsl + +// Для функции СинтаксисЯзыка. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение: +// * Ключ - Строка - символ +// * Значение - Булево - Истина +// +Функция СимволыЦифр() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СимволыЦифр()); +``` +
+ +## СловаЯзыка +
+ +Описание, пример вызова + +```bsl + +// Для функции СинтаксисЯзыка. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение: +// * Ключ - Строка - слово на русском и английском языках. +// * Значение - см. СвойстваСлова +// +Функция СловаЯзыка() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СловаЯзыка()); +``` +
+ +## ОперацииЯзыка +
+ +Описание, пример вызова + +```bsl + +// Для функции СинтаксисЯзыка. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение: +// * Ключ - Строка - слово на русском и английском языках. +// * Значение - см. СвойстваСлова +// +Функция ОперацииЯзыка() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОперацииЯзыка()); +``` +
+ +## ДобавитьСловоЯзыка +
+ +Описание, пример вызова + +```bsl + +// Для функций СловаЯзыка и ОперацииЯзыка. +Процедура ДобавитьСловоЯзыка(Слова, ЯзыкРусский, ЯзыкАнглийский, ТипСлова, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСловоЯзыка(Слова, ЯзыкРусский, ЯзыкАнглийский, ТипСлова, ); +``` +
+ +## СвойстваСлова +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьСловоЯзыка. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * Идентификатор - Строка - слово языка на языке конфигурации (русском или английском). +// * ЯзыкРусский - Строка - слово языка на русском языке. +// * ЯзыкАнглийский - Строка - слово языка на английском языке. +// * Тип - Строка - имя типа слова. +// * ВерхнийРегистр - Булево +// * Приоритет - Число +// * ЭтоРезерв - Булево +// +Функция СвойстваСлова(ЯзыкРусский, ЯзыкАнглийский, ТипСлова, ВерхнийРегистр, Приоритет, ЭтоРезерв) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваСлова(ЯзыкРусский, ЯзыкАнглийский, ТипСлова, ВерхнийРегистр, Приоритет, ЭтоРезерв)); +``` +
+ +## ТипыТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для функции СинтаксисЯзыка. +// +// Возвращаемое значение: +// Структура: +// * ПоИменам - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя типа таблиц на русском и на английском языках. +// ** Значение - см. СвойстваТипаТаблиц +// * ПоКоллекциям - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя коллекции на языке конфигурации (русском или английском). +// ** Значение - см. СвойстваТипаТаблиц +// +Функция ТипыТаблиц() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТипыТаблиц()); +``` +
+ +## ДобавитьТипТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для функции ТипыТаблиц. +Процедура ДобавитьТипТаблиц(ТипыТаблиц, ЯзыкРусский, ЯзыкАнглийский, ИмяКоллекции) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТипТаблиц(ТипыТаблиц, ЯзыкРусский, ЯзыкАнглийский, ИмяКоллекции)); +``` +
+ +## СвойстваТипаТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьСловоЯзыка. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * ИмяКоллекции - Строка - имя коллекции на языке конфигурации (русском или английском). +// * ЯзыкРусский - Строка - имя типа таблиц на русском языке. +// * ЯзыкАнглийский - Строка - имя типа таблиц на английском языке. +// * ЭтоСсылочныйТип - Булево +// * ЕстьОграничение - Булево +// * ЕстьПредопределенные - Булево +// * КоллекцииПолей - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя коллекции полей на языке конфигурации (русском или английском). +// ** Значение - Строка - +// "Разрешены" - можно использовать без ограничений. +// "Недопустимы" - нельзя использовать в ограничении доступа платформы 1С:Предприятия. +// +// * КоллекцииТабличныхЧастей - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя коллекции табличных частей на языке конфигурации (русском или английском). +// ** Значение - Строка - +// "Разрешены" - можно использовать без ограничений. +// "Недопустимы" - нельзя использовать в ограничении доступа платформы 1С:Предприятия. +// +// * ОбщиеРеквизиты - Строка - +// "Разрешены" - можно использовать без ограничений. +// "Недопустимы" - нельзя использовать в ограничении доступа платформы 1С:Предприятия. +// "Отсутствуют" - не существуют у объекта метаданных. +// +// * ПризнакиУчетаСубконто - Строка - +// "Разрешены" - можно использовать без ограничений. +// "Недопустимы" - нельзя использовать в ограничении доступа платформы 1С:Предприятия. +// "Отсутствуют" - не существуют у объекта метаданных. +// +// * УточнениеПолей - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя поля таблиц на русском и на английском языках. +// ** Значение - см. УточнениеПоля +// +// * УточнениеТаблиц - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя расширения таблиц на русском и на английском языках. +// ** Значение - см. УточнениеТаблиц +// +// * Использование - Строка - +// "Разрешено" - можно использовать без ограничений. +// "Недопустимо" - нельзя использовать в ограничении доступа платформы 1С:Предприятия. +// "Запрещено" - запрещено присоединять, как дополнительную таблицу в ограничении доступа БСП. +// +Функция СвойстваТипаТаблиц(ЯзыкРусский, ЯзыкАнглийский, ИмяКоллекции) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваТипаТаблиц(ЯзыкРусский, ЯзыкАнглийский, ИмяКоллекции)); +``` +
+ +## УстановитьСвойствоТипаТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для функции ТипыТаблиц. +Процедура УстановитьСвойствоТипаТаблиц(ТипыТаблиц, ИменаТиповТаблиц, Свойство, Значение) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьСвойствоТипаТаблиц(ТипыТаблиц, ИменаТиповТаблиц, Свойство, Значение)); +``` +
+ +## ДобавитьКоллекциюПолейТипаТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для функции ТипыТаблиц. +Процедура ДобавитьКоллекциюПолейТипаТаблиц(ТипыТаблиц, ИменаТиповТаблиц, ИмяКоллекции, Использование) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьКоллекциюПолейТипаТаблиц(ТипыТаблиц, ИменаТиповТаблиц, ИмяКоллекции, Использование)); +``` +
+ +## ДобавитьКоллекциюТабличныхЧастейТипаТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для функции ТипыТаблиц. +Процедура ДобавитьКоллекциюТабличныхЧастейТипаТаблиц(ТипыТаблиц, ИменаТиповТаблиц, ИмяКоллекции, Использование) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьКоллекциюТабличныхЧастейТипаТаблиц(ТипыТаблиц, ИменаТиповТаблиц, ИмяКоллекции, Использование)); +``` +
+ +## ДобавитьПолеТипаТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для функции ТипыТаблиц. +Процедура ДобавитьПолеТипаТаблиц(ТипыТаблиц, ИменаТиповТаблиц, ЯзыкРусский, ЯзыкАнглийский, Использование) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПолеТипаТаблиц(ТипыТаблиц, ИменаТиповТаблиц, ЯзыкРусский, ЯзыкАнглийский, Использование)); +``` +
+ +## УточнениеПоля +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьПолеТипаТаблиц. +// +// Возвращаемое значение: +// Структура: +// * ЯзыкРусский - Строка - имя поля таблиц на русском языке. +// * ЯзыкАнглийский - Строка - имя поля таблиц на английском языке. +// * Использование - Строка - +// "Разрешено" - можно использовать без ограничений. +// "Недопустимо" - нельзя использовать в ограничении доступа платформы 1С:Предприятия. +// "Запрещено" - запрещено использовать в ограничении доступа БСП. +// +Функция УточнениеПоля(ЯзыкРусский, ЯзыкАнглийский, Использование) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.УточнениеПоля(ЯзыкРусский, ЯзыкАнглийский, Использование)); +``` +
+ +## ДобавитьРасширениеТипаТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для функции ТипыТаблиц. +Процедура ДобавитьРасширениеТипаТаблиц(ТипыТаблиц, ИменаТиповТаблиц, ЯзыкРусский, ЯзыкАнглийский, Использование) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьРасширениеТипаТаблиц(ТипыТаблиц, ИменаТиповТаблиц, ЯзыкРусский, ЯзыкАнглийский, Использование)); +``` +
+ +## УточнениеТаблиц +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьПолеТипаТаблиц. +// +// Возвращаемое значение: +// Структура: +// * ЯзыкРусский - Строка - имя расширения таблиц на русском языке. +// * ЯзыкАнглийский - Строка - имя расширения таблиц на английском языке. +// * Использование - Строка - +// "Разрешено" - можно использовать без ограничений. +// "Недопустимо" - нельзя использовать в ограничении доступа платформы 1С:Предприятия. +// "Запрещено" - запрещено использовать в ограничении доступа БСП. +// +Функция УточнениеТаблиц(ЯзыкРусский, ЯзыкАнглийский, Использование) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.УточнениеТаблиц(ЯзыкРусский, ЯзыкАнглийский, Использование)); +``` +
+ +## ЧастиОграничения +
+ +Описание, пример вызова + +```bsl + +// Для функции РазобранноеОграничение. +// +// Параметры: +// ВнутренниеДанные - см. НовыеВнутренниеДанные +// +// Возвращаемое значение: +// Структура: +// * ДополнительныеТаблицы - Массив из см. НовоеОписаниеСоединения +// * ПсевдонимОсновнойТаблицы - Строка +// * ОграничениеЧтения - Структура +// * ОграничениеИзменения - Структура +// +Функция ЧастиОграничения(ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ЧастиОграничения(ВнутренниеДанные)); +``` +
+ +## СтрокаДобавить +
+ +Описание, пример вызова + +```bsl + +// Процедура: +// Родитель - СтрокаТаблицыЗначений из см. ТаблицаНаборовСимволов +// - Структура +// Строка - СтрокаТаблицыЗначений из см. ТаблицаНаборовСимволов +// Контекст - Структура: +// * Таблица - см. ТаблицаНаборовСимволов +// +Процедура СтрокаДобавить(Родитель, Строка, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.СтрокаДобавить(Родитель, Строка, Контекст)); +``` +
+ +## СтрокаТаблицы +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ОписаниеСтроки - Число - индекс таблицы значений. +// - СтрокаТаблицыЗначений из см. ТаблицаНаборовСимволов +// - Структура - см. ДополнительнаяСтрока +// Контекст - Структура: +// * Таблица - см. ТаблицаНаборовСимволов +// +// Возвращаемое значение: +// см. ДополнительнаяСтрока +// +Функция СтрокаТаблицы(ОписаниеСтроки, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СтрокаТаблицы(ОписаниеСтроки, Контекст)); +``` +
+ +## НовыеСвойстваЧасти +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * Строки - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// * СтрокаРазделителя - СтрокаТаблицыЗначений из см. ТаблицаНаборовСимволов +// * Имя - Строка +// * Представление - Строка +// +Функция НовыеСвойстваЧасти() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеСвойстваЧасти()); +``` +
+ +## НовоеОписаниеСоединения +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * Таблица - Строка +// * Псевдоним - Строка +// * УсловиеСоединения - см. ОписаниеУзла +// * ПсевдонимыТребуемыхТаблиц - Массив из Строка +// * ПоляУсловияСоединения - Массив из см. ПараПолейУсловияСоединения +// * ТекстУсловияСоединения - Строка +// +Функция НовоеОписаниеСоединения() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовоеОписаниеСоединения()); +``` +
+ +## ОписаниеУзла +
+ +Описание, пример вызова + +```bsl + + +// Возвращаемое значение: +// Структура: +// * Источник - СтрокаТаблицыЗначений из см. ТаблицаНаборовСимволов +// +// * Узел - Строка - одна из строк "Поле", "Значение", "Константа", +// "И", "Или", "Не", "=", "<>", "В", "ЕстьNull", "Тип", "ТипЗначения", "Выбор", +// "ЗначениеРазрешено", "ЭтоАвторизованныйПользователь", +// "ЧтениеОбъектаРазрешено", "ИзменениеОбъектаРазрешено", +// "ЧтениеСпискаРазрешено", "ИзменениеСпискаРазрешено", +// "ДляВсехСтрок", "ДляОднойИзСтрок", +// "ПравоДоступа", "РольДоступна". +// +// Свойства узла Поле. +// * Имя - Строка - имя поля, например, "Организация" или "ОсновнаяОрганизация". +// * Таблица - Строка - имя таблицы этого поля (или пустая строка для основной таблицы). +// * Псевдоним - Строка - имя псевдонима присоединяемой таблицы этого поля (или пустая строка для основной таблицы), +// например, "РегистрСведенийНастройки" для поля "ОсновнаяОрганизация". +// * Выразить - Строка - имя таблицы (если используется), например, для описания поля в виде: +// "ВЫРАЗИТЬ(ВЫРАЗИТЬ(Владелец КАК Справочник.Файлы).ВладелецФайла КАК Справочник.Организации).Ссылка". +// * Вложение - Структура - узел Поле, содержащий вложенное действие ВЫРАЗИТЬ (с или без ЕстьNull). +// - Неопределено - нет вложенного поля. +// * ЕстьNull - Структура - узел Значение Или Константа, например, для описания выражения вида +// "ЕстьNULL(Владелец, Значение(Справочник.Файлы.ПустаяСсылка))". +// - Неопределено - если ЕстьNull не используется (в том числе, когда свойство Вложение заполнено). +// * ИмяИсточник - СтрокаТаблицыЗначений +// - Неопределено +// * ВыразитьИсточник - СтрокаТаблицыЗначений +// - Неопределено +// * ЕстьNullИсточник - СтрокаТаблицыЗначений +// - Неопределено +// +// Свойства узлов Значение и Тип. +// * Имя - Строка - имя значения, например, "Справочник.Организации.Основная", +// "Справочник.Организации.ПустаяСсылка", +// имя таблицы, например, "Справочник.Организации". +// +// Свойства узла Константа. +// * Значение - Булево +// - Число +// - Строка +// - Неопределено - Ложь, Истина, произвольное +// целое число до 16 разрядов или произвольная строка до 150 символов. +// +// Свойства узлов И, Или (любой узел, кроме Значение и Константа). +// * Аргументы - Массив из см. ОписаниеУзла +// +// Свойства узла Не (любой узел, кроме Значение и Константа). +// * Аргумент - см. ОписаниеУзла +// +// * Имя - Строка - заглушка к предыдущей строке (для определения типа в EDT) +// +// Свойства узлов =, <> (ПервыйАргумент - узел Поле, +// ВторойАргумент - узел Значение, Константа, а узел Поле только для условия соединения). +// * ПервыйАргумент - см. ОписаниеУзла +// * ВторойАргумент - см. ОписаниеУзла +// +// * Имя - Строка - заглушка к предыдущей строке (для определения типа в EDT) +// +// Свойства узла В (Искомое - узел Поле, Значения - узлы Значение и/или Константа). +// * Искомое - см. ОписаниеУзла +// * Значения - Массив из см. ОписаниеУзла +// +// Свойства узла ЕстьNull (узел Поле - выражение вида "<Поле> ЕСТЬ NULL"). +// * Аргумент - см. ОписаниеУзла +// +// * Имя - Строка - заглушка к предыдущей строке (для определения типа в EDT) +// +// Свойства узла ТипЗначения (узел Поле). +// * Аргумент - см. ОписаниеУзла +// +// * Имя - Строка - заглушка к предыдущей строке (для определения типа в EDT) +// +// Свойства узла Выбор +// В свойстве Выбор +// узел Поле +// Неопределено - условия содержат выражение, а не узел Значение +// В свойстве Когда +// Условие - узел Значение, если свойство Выбор указано, в противном случае +// узлы И, Или, Не, =, <>, В (распространяется на вложенное содержимое) +// Значение - узел, кроме Выбор +// В свойстве Иначе +// узел, кроме ВЫБОР и Значение (Поле и Константа может быть только типа Булево). +// * Выбор - см. ОписаниеУзла +// * Когда - Массив из Структура: +// ** Условие - см. ОписаниеУзла +// ** Значение - см. ОписаниеУзла +// * Иначе - см. ОписаниеУзла +// +// * Имя - Строка - заглушка к предыдущей строке (для определения типа в EDT) +// +// Свойства узлов ЗначениеРазрешено, ЭтоАвторизованныйПользователь, +// ЧтениеОбъектаРазрешено, ИзменениеОбъектаРазрешено, +// ЧтениеСпискаРазрешено, ИзменениеСпискаРазрешено. +// В свойстве Поле - узел Поле. +// * Поле - см. ОписаниеУзла +// * Типы - Массив из Строка - полное имя таблицы +// * ПроверятьТипыКромеУказанных - Булево - если Истина, то все типы свойства Поле, +// кроме указанных в свойстве Типы. +// * УточненияСравнения - Соответствие из КлючИЗначение: +// ** Ключ - Строка - уточняемое значение "Неопределено", "Null", "ПустаяСсылка", +// <полное имя таблицы>, "Число", "Строка", "Дата", "Булево". +// ** Значение - Строка - результат "Ложь", "Истина". +// +// Свойства узлов ДляВсехСтрок, ДляОднойИзСтрок (любой узел). +// * Аргумент - см. ОписаниеУзла. +// +Функция ОписаниеУзла() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеУзла()); +``` +
+ +## УстановитьЧастьОграничения +
+ +Описание, пример вызова + +```bsl + +// Для функции ЧастиОграничения. +Процедура УстановитьЧастьОграничения(ЧастиОграничения, СвойстваЧасти) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьЧастьОграничения(ЧастиОграничения, СвойстваЧасти)); +``` +
+ +## УстановитьОшибкуНачалаЧасти +
+ +Описание, пример вызова + +```bsl + +// Для функции ЧастиОграничения, процедур РазобратьДополнительныеТаблицы, РазобратьУсловиеОграничения. +// Параметры: +// СвойстваЧасти - см. НовыеСвойстваЧасти +// ТекстОшибки - Строка +// +Процедура УстановитьОшибкуНачалаЧасти(СвойстваЧасти, ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьОшибкуНачалаЧасти(СвойстваЧасти, ТекстОшибки)); +``` +
+ +## УстановитьОшибкуВнутриЧасти +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьСоединение. +// Параметры: +// Строки - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// ИндексСтроки - Число +// ТекстОшибки - Строка +// +Процедура УстановитьОшибкуВнутриЧасти(Строки, ИндексСтроки, ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьОшибкуВнутриЧасти(Строки, ИндексСтроки, ТекстОшибки)); +``` +
+ +## УстановитьОшибкуВСтроке +
+ +Описание, пример вызова + +```bsl + +// Для функции ВыраженияВСкобкахВоВложениях, ВыраженияВыборКогдаТогдаВоВложениях. +Процедура УстановитьОшибкуВСтроке(Строка, ТекстОшибки, ВКонцеСлова = Ложь, НомерСлова = 1) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьОшибкуВСтроке(Строка, ТекстОшибки, ВКонцеСлова, НомерСлова); +``` +
+ +## РазобратьЧастьОграничения +
+ +Описание, пример вызова + +```bsl + +// Для функции ЧастиОграничения. +Процедура РазобратьЧастьОграничения(СвойстваЧасти, ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьЧастьОграничения(СвойстваЧасти, ВнутренниеДанные)); +``` +
+ +## РазобратьДополнительныеТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьЧастьОграничения. +Процедура РазобратьДополнительныеТаблицы(СвойстваЧасти, ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьДополнительныеТаблицы(СвойстваЧасти, ВнутренниеДанные)); +``` +
+ +## РазобратьСоединение +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьДополнительныеТаблицы. +// +// Параметры: +// Соединение - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// +Процедура РазобратьСоединение(Соединение, СвойстваЧасти, ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьСоединение(Соединение, СвойстваЧасти, ВнутренниеДанные)); +``` +
+ +## РазобратьПоляУсловияСоединенияИОтметитьЗапреты +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьДополнительныеТаблицы. +Процедура РазобратьПоляУсловияСоединенияИОтметитьЗапреты(ОписаниеСоединения, ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьПоляУсловияСоединенияИОтметитьЗапреты(ОписаниеСоединения, ВнутренниеДанные)); +``` +
+ +## УзлыДляПроверкиДоступности +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьУсловиеСоединения, РазобратьУсловиеОграничения. +// +// Параметры: +// Список - Строка - список имен узлов через запятую. +// ЭтоСписокИсключений - Булево - если Истина, добавить узлы, кроме указанных. +// +// Возвращаемое значение: +// ФиксированноеСоответствие из КлючИЗначение: +// * Ключ - Строка - имя узла +// * Значение - Булево +// - Структура: +// ** Выразить - Булево +// ** Вложение - Булево +// ** ЕстьNull - Булево +// +Функция УзлыДляПроверкиДоступности(Список, ЭтоСписокИсключений) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.УзлыДляПроверкиДоступности(Список, ЭтоСписокИсключений) +``` +
+ +## ОтметитьНекорректныеАргументыИЗапрещенныеУзлы +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьУсловиеСоединения, РазобратьУсловиеОграничения. +// +// Параметры: +// Условие - см. ОписаниеУзла +// ДоступныеУзлы - Структура +// Контекст - см. РасширенныеВнутренниеДанные +// Родитель - см. ОписаниеУзла +// +Процедура ОтметитьНекорректныеАргументыИЗапрещенныеУзлы(Условие, ДоступныеУзлы, Контекст, Родитель = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтметитьНекорректныеАргументыИЗапрещенныеУзлы(Условие, ДоступныеУзлы, Контекст, Родитель); +``` +
+ +## НовоеПолеКлючаДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * Поле - см. ОписаниеУзла +// * Чтение - Булево +// * Родители - Массив из см. ОписаниеУзла +// +Функция НовоеПолеКлючаДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовоеПолеКлючаДоступа()); +``` +
+ +## ВыделитьПсевдонимПоля +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОтметитьНекорректныеАргументыИЗапрещенныеУзлы. +Процедура ВыделитьПсевдонимПоля(УзелПоле, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВыделитьПсевдонимПоля(УзелПоле, Контекст)); +``` +
+ +## УдалитьСвойствоИсточник +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьУсловиеСоединения, РазобратьУсловиеОграничения. +Процедура УдалитьСвойствоИсточник(Условие) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьСвойствоИсточник(Условие)); +``` +
+ +## УстановитьОшибкуУзелЗапрещен +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОтметитьНекорректныеАргументыИЗапрещенныеУзлы. +Процедура УстановитьОшибкуУзелЗапрещен(Строка, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьОшибкуУзелЗапрещен(Строка, Контекст)); +``` +
+ +## ОтметитьПовторыТиповСредиПроверяемыхИУточняемых +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОтметитьНекорректныеАргументыИЗапрещенныеУзлы. +Процедура ОтметитьПовторыТиповСредиПроверяемыхИУточняемых(Узел, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтметитьПовторыТиповСредиПроверяемыхИУточняемых(Узел, Контекст)); +``` +
+ +## РазобратьУсловиеОграничения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьЧастьОграничения. +// +// Параметры: +// СвойстваЧасти - см. НовыеСвойстваЧасти +// ВнутренниеДанные - см. НовыеВнутренниеДанные +// +Процедура РазобратьУсловиеОграничения(СвойстваЧасти, ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьУсловиеОграничения(СвойстваЧасти, ВнутренниеДанные)); +``` +
+ +## ДобавитьПсевдонимыПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Для процедур ЧастиОграничения, РазобратьУсловиеОграничения. +Процедура ДобавитьПсевдонимыПоУмолчанию(Контекст); Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьПсевдонимыПоУмолчанию(Контекст);); +``` +
+ +## РазобратьУсловие +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьУсловиеСоединения, РазобратьУсловиеОграничения. +// +// Параметры: +// Условие - Массив из СтрокаТаблицыЗначений +// Состав - см. ОписаниеУзла +// ВнутренниеДанные - см. НовыеВнутренниеДанные +// +Процедура РазобратьУсловие(Условие, Состав, ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьУсловие(Условие, Состав, ВнутренниеДанные)); +``` +
+ +## ОбъединитьВложенныеЛогическиеОперации +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьУсловие. +Процедура ОбъединитьВложенныеЛогическиеОперации(Состав) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбъединитьВложенныеЛогическиеОперации(Состав)); +``` +
+ +## РазобратьВыражение +
+ +Описание, пример вызова + +```bsl + + +// Для процедур РазобратьУсловие, РазобратьФункцию, РазобратьВыбор. +// +// Параметры: +// Условие - Массив из см. СтрокаТаблицы.ОписаниеСтроки +// +Процедура РазобратьВыражение(Условие, Состав, ТекущийКонтекст, ВложенноеВыражение = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьВыражение(Условие, Состав, ТекущийКонтекст, ВложенноеВыражение); +``` +
+ +## ОписаниеУзлаПолеИлиУзлаКонстанта +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьВыражение, РазобратьПервыйПараметрПроверочнойФункции, +// РазобратьПараметрыФункцииТипЗначения, РазобратьВыбор и +// для функции ОписаниеУзлаПолеИзФункцииЕстьNull. +// +Функция ОписаниеУзлаПолеИлиУзлаКонстанта(Строка) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеУзлаПолеИлиУзлаКонстанта(Строка)); +``` +
+ +## ОписаниеУзлаПоле +
+ +Описание, пример вызова + +```bsl + +// Для функций ОписаниеУзлаПолеИлиУзлаКонстанта, ОписаниеУзлаПолеИзФункцииВыразить, ОписаниеУзлаПолеИзФункцииЕстьNull. +Функция ОписаниеУзлаПоле(Строка) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеУзлаПоле(Строка)); +``` +
+ +## РазобратьСоединитель +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьВыражение. +Процедура РазобратьСоединитель(Контекст, ЭтоОперация = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьСоединитель(Контекст, ЭтоОперация); +``` +
+ +## РазобратьСоединительВ +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьВыражение. +Процедура РазобратьСоединительВ(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьСоединительВ(Контекст)); +``` +
+ +## РазобратьЗначениеСоединителяВ +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьСоединительВ. +Процедура РазобратьЗначениеСоединителяВ(Контекст, Подстрока, НовоеОписание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьЗначениеСоединителяВ(Контекст, Подстрока, НовоеОписание)); +``` +
+ +## НовыйКонтекст +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьЗначениеСоединителяВ. +Функция НовыйКонтекст(Контекст, Строка = null, Описание = null) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыйКонтекст(Контекст, Строка, Описание); +``` +
+ +## ДобавитьСоединитель +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьСоединитель, РазобратьСоединительВ, ВставитьСоединительСУчетомПриоритета. +Процедура ДобавитьСоединитель(Контекст, НовоеОписание, ПервыйАргумент); Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьСоединитель(Контекст, НовоеОписание, ПервыйАргумент);); +``` +
+ +## ОбработатьПропущенныйАргументПослеСоединителя +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьСоединитель. +Процедура ОбработатьПропущенныйАргументПослеСоединителя(Контекст, ВторойАргумент, ЛогическаяОперация = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьПропущенныйАргументПослеСоединителя(Контекст, ВторойАргумент, ЛогическаяОперация); +``` +
+ +## ВставитьСоединительСУчетомПриоритета +
+ +Описание, пример вызова + +```bsl + +// Для процедур ДобавитьСоединитель, ОбработатьПропущеннуюЛогическуюОперацию. +Процедура ВставитьСоединительСУчетомПриоритета(Контекст, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВставитьСоединительСУчетомПриоритета(Контекст, ); +``` +
+ +## РазобратьОператор +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьВыражение. +Процедура РазобратьОператор(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьОператор(Контекст)); +``` +
+ +## РазобратьФункцию +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьВыражение, РазобратьЗначениеСоединителяВ. +Процедура РазобратьФункцию(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьФункцию(Контекст)); +``` +
+ +## РазобратьПараметрыПроверочнойФункции +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьФункцию. +Процедура РазобратьПараметрыПроверочнойФункции(Контекст, НовоеОписание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьПараметрыПроверочнойФункции(Контекст, НовоеОписание)); +``` +
+ +## РазобратьПервыйПараметрПроверочнойФункции +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьПараметрыПроверочнойФункции. +// +// Параметры: +// ПервыйПараметр - Структура: +// * Строки - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// +Процедура РазобратьПервыйПараметрПроверочнойФункции(Контекст, ПервыйПараметр, НовоеОписание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьПервыйПараметрПроверочнойФункции(Контекст, ПервыйПараметр, НовоеОписание)); +``` +
+ +## РазобратьДополнительныйПараметрПроверочнойФункции +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьПараметрыПроверочнойФункции. +// +// Параметры: +// Параметр - Структура: +// * Строки - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// +Процедура РазобратьДополнительныйПараметрПроверочнойФункции(Контекст, Параметр, НовоеОписание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьДополнительныйПараметрПроверочнойФункции(Контекст, Параметр, НовоеОписание)); +``` +
+ +## РазобратьПараметрыФункцииЗначениеИлиФункцииТип +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьФункцию. +Процедура РазобратьПараметрыФункцииЗначениеИлиФункцииТип(Строка, НовоеОписание, ЭтоФункцияЗначение, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьПараметрыФункцииЗначениеИлиФункцииТип(Строка, НовоеОписание, ЭтоФункцияЗначение, Контекст)); +``` +
+ +## РазобратьПараметрыФункцииРольДоступна +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьФункцию. +Процедура РазобратьПараметрыФункцииРольДоступна(Строка, НовоеОписание, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьПараметрыФункцииРольДоступна(Строка, НовоеОписание, Контекст)); +``` +
+ +## РазобратьПараметрыФункцииПравоДоступа +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьФункцию. +Процедура РазобратьПараметрыФункцииПравоДоступа(Строка, НовоеОписание, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьПараметрыФункцииПравоДоступа(Строка, НовоеОписание, Контекст)); +``` +
+ +## РазобратьПараметрыФункцииТипЗначения +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьФункцию. +Процедура РазобратьПараметрыФункцииТипЗначения(Контекст, НовоеОписание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьПараметрыФункцииТипЗначения(Контекст, НовоеОписание)); +``` +
+ +## ОписаниеУзлаПолеИзФункцииВыразить +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьФункцию, РазобратьПервыйПараметрПроверочнойФункции, РазобратьПараметрыФункцииТипЗначения. +Функция ОписаниеУзлаПолеИзФункцииВыразить(Строка, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеУзлаПолеИзФункцииВыразить(Строка, Контекст)); +``` +
+ +## ОписаниеУзлаПолеИзФункцииЕстьNull +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьФункцию, РазобратьПервыйПараметрПроверочнойФункции, +// РазобратьПараметрыФункцииТипЗначения и +// для функции ОписаниеУзлаПолеИзФункцииВыразить. +// +Функция ОписаниеУзлаПолеИзФункцииЕстьNull(Строка, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОписаниеУзлаПолеИзФункцииЕстьNull(Строка, Контекст)); +``` +
+ +## ПараметрыРазделенныеЗапятыми +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьСоединительВ, РазобратьПараметрыПроверочнойФункции, +// РазобратьПараметрыФункцииЗначениеИлиФункцииТип, РазобратьПараметрыФункцииТипЗначения и +// для функций ОписаниеУзлаПолеИзФункцииВыразить, ОписаниеУзлаПолеИзФункцииЕстьNull. +// +// Параметры: +// ОписаниеСтроки - см. СтрокаТаблицы.ОписаниеСтроки +// +// Возвращаемое значение: +// Массив из Структура: +// * Строки - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// +Функция ПараметрыРазделенныеЗапятыми(ОписаниеСтроки, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПараметрыРазделенныеЗапятыми(ОписаниеСтроки, Контекст)); +``` +
+ +## РазобратьВыбор +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьВыражение. +// +// Параметры: +// Контекст - Структура: +// * Строка - Структура: +// ** Строки - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// +Процедура РазобратьВыбор(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьВыбор(Контекст)); +``` +
+ +## РазобратьОшибочноеКлючевоеСлово +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьВыражение. +Процедура РазобратьОшибочноеКлючевоеСлово(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РазобратьОшибочноеКлючевоеСлово(Контекст)); +``` +
+ +## ДобавитьАргументФункциюВыборОператор +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьВыражение, РазобратьОператор, РазобратьФункцию, РазобратьВыбор. +Процедура ДобавитьАргументФункциюВыборОператор(Контекст, ДобавляемоеОписание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьАргументФункциюВыборОператор(Контекст, ДобавляемоеОписание)); +``` +
+ +## ОбработатьПропущеннуюЛогическуюОперацию +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьАргументФункциюВыборОператор +Процедура ОбработатьПропущеннуюЛогическуюОперацию(Контекст, ПоследнийАргументОписания, ДобавляемоеОписание) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбработатьПропущеннуюЛогическуюОперацию(Контекст, ПоследнийАргументОписания, ДобавляемоеОписание)); +``` +
+ +## ВыраженияВСкобкахВоВложениях +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьУсловие. +// +// Возвращаемое значение: +// Массив из СтрокаТаблицыЗначений +// +Функция ВыраженияВСкобкахВоВложениях(Строки, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВыраженияВСкобкахВоВложениях(Строки, Контекст)); +``` +
+ +## ВыраженияВыборКогдаТогдаВоВложениях +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьУсловие. +// +// Параметры: +// Строки - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// +Функция ВыраженияВыборКогдаТогдаВоВложениях(Строки, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВыраженияВыборКогдаТогдаВоВложениях(Строки, Контекст)); +``` +
+ +## ФункцииСВыражениямиВСкобках +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьУсловие. +// +// Параметры: +// Строки - Массив из см. СтрокаТаблицы.ОписаниеСтроки +// +Функция ФункцииСВыражениямиВСкобках(Строки, ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ФункцииСВыражениямиВСкобках(Строки, ВнутренниеДанные)); +``` +
+ +## ДобавитьВложение +
+ +Описание, пример вызова + +```bsl + +// Для функций ВыраженияВСкобкахВоВложениях, ВыраженияВыборКогдаТогдаВоВложениях. +Процедура ДобавитьВложение(Строка, Вложения, ТекущееВложение, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьВложение(Строка, Вложения, ТекущееВложение, Контекст)); +``` +
+ +## УдалитьПоследнееВложение +
+ +Описание, пример вызова + +```bsl + +// Для функций ВыраженияВСкобкахВоВложениях, ВыраженияВыборКогдаТогдаВоВложениях. +Процедура УдалитьПоследнееВложение(Вложения, ТекущееВложение, Контекст, КонечнаяСтрока = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УдалитьПоследнееВложение(Вложения, ТекущееВложение, Контекст, КонечнаяСтрока); +``` +
+ +## ВосстановитьСтруктуруВыбора +
+ +Описание, пример вызова + +```bsl + +// Для функции ВыраженияВыборКогдаТогдаВоВложениях. +Процедура ВосстановитьСтруктуруВыбора(Строка, Вложения, ТекущееВложение, СписокНедостающихСлов, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ВосстановитьСтруктуруВыбора(Строка, Вложения, ТекущееВложение, СписокНедостающихСлов, Контекст)); +``` +
+ +## ДополнительнаяСтрока +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОбработатьПропущеннуюЛогическуюОперацию, ВыраженияВыборКогдаТогдаВоВложениях, +// ВосстановитьСтруктуруВыбора и для функции ПараметрыРазделенныеЗапятыми. +// +// Возвращаемое значение: +// Структура: +// * Символы - Строка +// * Вид - Строка +// * Тип - Строка +// * Приоритет - Число +// * Уточнение - Строка +// * Строки - Массив из Число - индексы строк ТаблицаНаборовСимволов +// * КонечнаяСтрока - Число - индекс строки ТаблицаНаборовСимволов +// * ПозицияОшибки - Число +// * ТекстОшибки - Строка +// +Функция ДополнительнаяСтрока(Строка, Уточнение = "", Контекст = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ДополнительнаяСтрока(Строка, Уточнение, Контекст); +``` +
+ +## ИзменитьВидКлючевогоСловаСписокНаИмя +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьДополнительныеТаблицы, РазобратьУсловиеОграничения. +// +// Параметры: +// СтрокиЧасти - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// +Процедура ИзменитьВидКлючевогоСловаСписокНаИмя(СтрокиЧасти, ИсключаемаяСтрока = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ИзменитьВидКлючевогоСловаСписокНаИмя(СтрокиЧасти, ИсключаемаяСтрока); +``` +
+ +## УстановитьПсевдоним +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьДополнительныеТаблицы, РазобратьСоединение. +// +// Параметры: +// СтрокиЧасти - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// +Процедура УстановитьПсевдоним(СтрокаЧасти, ОписаниеСоединения, ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьПсевдоним(СтрокаЧасти, ОписаниеСоединения, ВнутренниеДанные)); +``` +
+ +## УстановитьИмяТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьСоединение. +// +// Параметры: +// СтрокиЧасти - Массив из СтрокаТаблицыЗначений: см. ТаблицаНаборовСимволов +// +Процедура УстановитьИмяТаблицы(СтрокаЧасти, ОписаниеСоединения, ВнутренниеДанные) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьИмяТаблицы(СтрокаЧасти, ОписаниеСоединения, ВнутренниеДанные)); +``` +
+ +## ДобавитьТребуемуюТаблицуКакИсточникДанных +
+ +Описание, пример вызова + +```bsl + +// Для процедуры УстановитьИмяТаблицы. +Процедура ДобавитьТребуемуюТаблицуКакИсточникДанных(Контекст, Таблица, Источник) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТребуемуюТаблицуКакИсточникДанных(Контекст, Таблица, Источник)); +``` +
+ +## ДобавитьТребуемуюТаблицуКакСсылочныйТип +
+ +Описание, пример вызова + +```bsl + +// Для процедур ВыделитьПсевдонимПоля, РазобратьПервыйПараметрПроверочнойФункции, +// РазобратьДополнительныйПараметрПроверочнойФункции, РазобратьПараметрыФункцииЗначениеИлиФункцииТип. +// +Процедура ДобавитьТребуемуюТаблицуКакСсылочныйТип(Контекст, Таблица, Источник) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТребуемуюТаблицуКакСсылочныйТип(Контекст, Таблица, Источник)); +``` +
+ +## ДобавитьТребуемыйПредопределенныйЭлемент +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьПараметрыФункцииЗначениеИлиФункцииТип. +Процедура ДобавитьТребуемыйПредопределенныйЭлемент(Контекст, ПолноеИмяПредопределенного, Источник) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТребуемыйПредопределенныйЭлемент(Контекст, ПолноеИмяПредопределенного, Источник)); +``` +
+ +## ПроверитьИмяРоли +
+ +Описание, пример вызова + +```bsl + +// Для процедуры РазобратьПараметрыФункцииРольДоступна. +Процедура ПроверитьИмяРоли(ИмяРоли, Источник) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьИмяРоли(ИмяРоли, Источник)); +``` +
+ +## ПроверитьИмяПраваОбъектаМетаданных +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьИмяПраваОбъектаМетаданных(ИмяПрава, ИсточникПрава, ИмяОбъекта, ИсточникОбъекта) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьИмяПраваОбъектаМетаданных(ИмяПрава, ИсточникПрава, ИмяОбъекта, ИсточникОбъекта)); +``` +
+ +## ОбъектМетаданныхПоПолномуИмениДляПроверкиПрава +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьИмяПраваОбъектаМетаданных +Функция ОбъектМетаданныхПоПолномуИмениДляПроверкиПрава(ПолноеИмя, ИмяСтандартногоРеквизита = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбъектМетаданныхПоПолномуИмениДляПроверкиПрава(ПолноеИмя, ИмяСтандартногоРеквизита); +``` +
+ +## ДобавитьТребуемоеПолеТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедур ОтметитьНекорректныеАргументыИЗапрещенныеУзлы, ВыделитьПсевдонимПоля, +// ДобавитьТипыВидовДоступаПользователиИВнешниеПользователиДляПроверкиОтсутствия. +// +Процедура ДобавитьТребуемоеПолеТаблицы(Контекст, Таблица, ИмяПоля, Источник, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТребуемоеПолеТаблицы(Контекст, Таблица, ИмяПоля, Источник, ); +``` +
+ +## СвойстваИмениТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедур ДобавитьТребуемуюТаблицуКакИсточникДанных, ДобавитьТребуемуюТаблицуКакСсылочныйТип, +// ДобавитьТребуемыйПредопределенныйЭлемент, ДобавитьТребуемоеПолеТаблицы. +// +Функция СвойстваИмениТаблицы(Контекст, ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваИмениТаблицы(Контекст, ПолноеИмя)); +``` +
+ +## СвойстваТребуемойТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедур ДобавитьТребуемуюТаблицуКакИсточникДанных, ДобавитьТребуемуюТаблицуКакСсылочныйТип, +// ДобавитьТребуемыйПредопределенныйЭлемент, ДобавитьТребуемоеПолеТаблицы. +// +Функция СвойстваТребуемойТаблицы(Контекст, СвойстваИмени, БезРасширения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваТребуемойТаблицы(Контекст, СвойстваИмени, БезРасширения); +``` +
+ +## ПодставитьКлючевыеСловаВСтроку +
+ +Описание, пример вызова + +```bsl + +// Для процедур и функций ЧастиОграничения, РазобратьДополнительныеТаблицы, РазобратьСоединение, +// РазобратьУсловиеОграничения, ВыраженияВыборКогдаТогдаВоВложениях. +// +Функция ПодставитьКлючевыеСловаВСтроку(Контекст, Строка, СписокСлов, ПараметрОдин = "", ПараметрДва = "", ПараметрТри = "") Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ПодставитьКлючевыеСловаВСтроку(Контекст, Строка, СписокСлов, ПараметрОдин, ПараметрДва, ПараметрТри); +``` +
+ +## КлючевоеСловоСУчетомЯзыка +
+ +Описание, пример вызова + +```bsl + +// Для процедур РазобратьДополнительныеТаблицы, РазобратьСоединение, РазобратьУсловиеОграничения. +Функция КлючевоеСловоСУчетомЯзыка(ИдентификаторСлова, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.КлючевоеСловоСУчетомЯзыка(ИдентификаторСлова, Контекст)); +``` +
+ +## ПроверитьТаблицыПоляИТипыПолей +
+ +Описание, пример вызова + +```bsl + +// Проверка таблиц, полей таблиц и типов полей, найденных при разборе текста ограничения. +// Аналогичная процедура реализуется в СППР. +// +// Параметры: +// РазобранноеОграничение - см. РазобранноеОграничение +// +Процедура ПроверитьТаблицыПоляИТипыПолей(РазобранноеОграничение) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьТаблицыПоляИТипыПолей(РазобранноеОграничение)); +``` +
+ +## ПроверитьПолеТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьТаблицыПоляИТипыПолей, ПроверитьСледующееПолеЧерезТочку. +Процедура ПроверитьПолеТаблицы(ОписаниеПоля, Контекст, Индекс = 0, ПервыйВызов = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьПолеТаблицы(ОписаниеПоля, Контекст, Индекс, ПервыйВызов); +``` +
+ +## ПроверитьСледующееПолеЧерезТочку +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьПолеТаблицы и ПроверитьРасширенияТаблицы. +Процедура ПроверитьСледующееПолеЧерезТочку(ОписаниеПоля, Индекс, СвойстваТекущегоПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьСледующееПолеЧерезТочку(ОписаниеПоля, Индекс, СвойстваТекущегоПоля, Контекст)); +``` +
+ +## СвойстваПоляИлиТабличнойЧасти +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьПолеТаблицы. +Функция СвойстваПоляИлиТабличнойЧасти(ИмяПоляИлиТабличнойЧасти, Контекст, ЭтоПервоеПоле) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваПоляИлиТабличнойЧасти(ИмяПоляИлиТабличнойЧасти, Контекст, ЭтоПервоеПоле)); +``` +
+ +## СвойстваПоляТабличнойЧасти +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьРасширенияТаблицы, ПроверитьПолеТаблицы. +Функция СвойстваПоляТабличнойЧасти(ИмяПоляТабличнойЧасти, МетаданныеТабличнойЧасти, ИмяКоллекции, МетаданныеТаблицы) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваПоляТабличнойЧасти(ИмяПоляТабличнойЧасти, МетаданныеТабличнойЧасти, ИмяКоллекции, МетаданныеТаблицы)); +``` +
+ +## СвойстваПоляПерерасчета +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьРасширенияТаблицы, ПроверитьПолеТаблицы. +Функция СвойстваПоляПерерасчета(ИмяПоляПерерасчета, МетаданныеПерерасчета, МетаданныеТаблицы) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.СвойстваПоляПерерасчета(ИмяПоляПерерасчета, МетаданныеПерерасчета, МетаданныеТаблицы)); +``` +
+ +## ДобавитьТипыПоляДополнительно +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьПолеТаблицы. +Процедура ДобавитьТипыПоляДополнительно(ОписаниеПоля, Индекс, СвойстваТекущегоПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТипыПоляДополнительно(ОписаниеПоля, Индекс, СвойстваТекущегоПоля, Контекст)); +``` +
+ +## ЗаполнитьТипыПоляСтрокойДополнительно +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьПолеТаблицы. +Процедура ЗаполнитьТипыПоляСтрокойДополнительно(ОписаниеПоля) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьТипыПоляСтрокойДополнительно(ОписаниеПоля)); +``` +
+ +## ДобавитьОсновнойПорядокПоля +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТипыПоляДополнительно. +Процедура ДобавитьОсновнойПорядокПоля(СвойстваТекущегоПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьОсновнойПорядокПоля(СвойстваТекущегоПоля, Контекст)); +``` +
+ +## УстановитьПолеСодержитNull +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ДобавитьТипыПоляДополнительно. +Процедура УстановитьПолеСодержитNull(УзелПоле, СвойстваТекущегоПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьПолеСодержитNull(УзелПоле, СвойстваТекущегоПоля, Контекст)); +``` +
+ +## ПроверитьРасширенияТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьТаблицыПоляИТипыПолей. +Процедура ПроверитьРасширенияТаблицы(ПоляТаблицы, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьРасширенияТаблицы(ПоляТаблицы, Контекст)); +``` +
+ +## ПроверитьТипыПоля +
+ +Описание, пример вызова + +```bsl + +// Для процедур ПроверитьТаблицыПоляИТипыПолей и ПроверитьРасширенияТаблицы. +Процедура ПроверитьТипыПоля(ОписаниеПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьТипыПоля(ОписаниеПоля, Контекст)); +``` +
+ +## ПроверитьПредопределенныеЗначенияТаблицы +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ПроверитьТаблицыПоляИТипыПолей. +// +// Параметры: +// ПоляТаблицы - см. НовыйСоставКоллекции +// +Процедура ПроверитьПредопределенныеЗначенияТаблицы(ПоляТаблицы, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ПроверитьПредопределенныеЗначенияТаблицы(ПоляТаблицы, Контекст)); +``` +
+ +## ОтметитьНекорректныеИменаТаблицПолейИТиповПолей +
+ +Описание, пример вызова + +```bsl + + +// Для функции СтруктураОграничения. +Процедура ОтметитьНекорректныеИменаТаблицПолейИТиповПолей(ПоляТаблиц, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтметитьНекорректныеИменаТаблицПолейИТиповПолей(ПоляТаблиц, Контекст)); +``` +
+ +## ОтметитьНекорректноеПолеИТипыПоля +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОтметитьНекорректныеИменаТаблицПолейИТиповПолей. +Процедура ОтметитьНекорректноеПолеИТипыПоля(ОписаниеПоля, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОтметитьНекорректноеПолеИТипыПоля(ОписаниеПоля, Контекст)); +``` +
+ +## УстановитьОшибкуВСтрокеИмениПоля +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОтметитьНекорректныеИменаТаблицПолейИТиповПолей. +Процедура УстановитьОшибкуВСтрокеИмениПоля(Контекст, Строка, ШаблонОшибки, ПолеСОшибкой, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.УстановитьОшибкуВСтрокеИмениПоля(Контекст, Строка, ШаблонОшибки, ПолеСОшибкой, ); +``` +
+ +## НовыеХранимыеДанныеОбновленияПрогресса +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * СтрокиСписков - Соответствие +// * СвойстваСписков - Соответствие +// * КоличествоКлючей - Число +// * ДатаПоследнегоОбновления - Дата +// +Функция НовыеХранимыеДанныеОбновленияПрогресса() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.НовыеХранимыеДанныеОбновленияПрогресса() +``` +
+ +## ОбновитьПрогрессВФоне +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Контекст - Структура: +// * Версия - Число +// * ХранимыеДанные - см. НовыеХранимыеДанныеОбновленияПрогресса +// * РассчитыватьПоКоличествуДанных - Булево +// * ПоказыватьОбработанныеСписки - Булево +// * ЭтоПовторноеОбновлениеПрогресса - Булево +// * ВсегоОбновлено - Число +// * ПериодОбновленияПрогресса - Число +// * АвтообновлениеПрогресса - Булево +// * ДобавленныеСтроки - Массив +// * УдаленныеСтроки - Соответствие +// * ИзмененныеСтроки - Соответствие +// * ОбновлениеДоступаВыполняется - Булево +// +// АдресРезультата - Строка +// +Процедура ОбновитьПрогрессВФоне(Контекст, АдресРезультата) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьПрогрессВФоне(Контекст, АдресРезультата) +``` +
+ +## ОбновитьПрогресс +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьПрогресс(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьПрогресс(Контекст)); +``` +
+ +## ЗаполнитьДолиОбработанных +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьДолиОбработанных(Строка, ОписаниеОбновления, СвойстваСписка, ЭтоОбработкаЭлементов, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьДолиОбработанных(Строка, ОписаниеОбновления, СвойстваСписка, ЭтоОбработкаЭлементов, Контекст)); +``` +
+ +## ОбработаноПоДолям +
+ +Описание, пример вызова + +```bsl + +Функция ОбработаноПоДолям(ДоляОбработанныхДляПользователей, ДоляОбработанныхДляВнешнихПользователей, ИмяТаблицы, ДействующиеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ОбработаноПоДолям(ДоляОбработанныхДляПользователей, ДоляОбработанныхДляВнешнихПользователей, ИмяТаблицы, ДействующиеПараметры)); +``` +
+ +## ОбнулитьКоличествоЭлементов +
+ +Описание, пример вызова + +```bsl + +Процедура ОбнулитьКоличествоЭлементов(Строка, Контекст); Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбнулитьКоличествоЭлементов(Строка, Контекст);); +``` +
+ +## ОбнулитьКоличествоКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ОбнулитьКоличествоКлючейДоступа(Строка, Контекст); Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбнулитьКоличествоКлючейДоступа(Строка, Контекст);); +``` +
+ +## ДобавитьНовуюСтрокуСписка +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьНовуюСтрокуСписка(Контекст, Список, ИмяТаблицы) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьНовуюСтрокуСписка(Контекст, Список, ИмяТаблицы)); +``` +
+ +## РассчитатьВсегоОбновленоПоКоличествуДанных +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Контекст - Структура: +// * ДобавленныеСтроки - Массив +// * ИзмененныеСтроки - Соответствие +// * СвойстваСписков - Соответствие +// * СтрокиСписков - Соответствие +// * ДействующиеПараметры - см. ДействующиеПараметрыОграниченияДоступа +// * СтрокиОбновленияКоличестваЭлементов - Массив +// * СтрокиОбновленияКоличестваКлючейДоступа - Массив +// * ИдентификаторыТаблиц - см. ОбщегоНазначения.ИдентификаторыОбъектовМетаданных +// * ХранимыеДанные - см. НовыеХранимыеДанныеОбновленияПрогресса +// * ТипыТаблицПоИменам - Соответствие +// +// ВсегоОбновлено - Число +// +Процедура РассчитатьВсегоОбновленоПоКоличествуДанных(Контекст, ВсегоОбновлено) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.РассчитатьВсегоОбновленоПоКоличествуДанных(Контекст, ВсегоОбновлено)); +``` +
+ +## ЗаполнитьКоличествоЭлементовИКлючейДоступаПоСпискам +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьКоличествоЭлементовИКлючейДоступаПоСпискам(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьКоличествоЭлементовИКлючейДоступаПоСпискам(Контекст)); +``` +
+ +## ОбновитьКоличествоЭлементовИКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьКоличествоЭлементовИКлючейДоступа(Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьКоличествоЭлементовИКлючейДоступа(Контекст)); +``` +
+ +## ОбновитьКоличество +
+ +Описание, пример вызова + +```bsl + +// Для процедуры ОбновитьКоличествоЭлементовИКлючейДоступа. +Процедура ОбновитьКоличество(РезультатЗапроса, ПоследнийОбновленный, Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьКоличество(РезультатЗапроса, ПоследнийОбновленный, ); +``` +
+ +## ВыполнитьПакетЗапросовПоЧастям +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Массив из РезультатЗапроса +// +Функция ВыполнитьПакетЗапросовПоЧастям(ОписаниеЗапроса) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ВыполнитьПакетЗапросовПоЧастям(ОписаниеЗапроса)); +``` +
+ +## ДобавитьРезультатыЗапроса +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьРезультатыЗапроса(РезультатыПакетаЗапросов, ТекстыПорцииЗапросов, ОписаниеЗапроса) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьРезультатыЗапроса(РезультатыПакетаЗапросов, ТекстыПорцииЗапросов, ОписаниеЗапроса)); +``` +
+ +## ОбновитьЗначениеВСтроке +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьЗначениеВСтроке(СтароеЗначение, НовоеЗначение, Строка, Контекст) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ОбновитьЗначениеВСтроке(СтароеЗначение, НовоеЗначение, Строка, Контекст)); +``` +
+ +## ДобавитьТекстЗапросаКоличестваЭлементов +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьТекстЗапросаКоличестваЭлементов(ОписаниеЗапроса, Строка, Индекс, Контекст, ДляВнешнихПользователей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТекстЗапросаКоличестваЭлементов(ОписаниеЗапроса, Строка, Индекс, Контекст, ДляВнешнихПользователей)); +``` +
+ +## ТекстЗапросаКоличестваЭлементовРегистра +
+ +Описание, пример вызова + +```bsl + +Функция ТекстЗапросаКоличестваЭлементовРегистра(Контекст, Строка, Индекс, ДляВнешнихПользователей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаКоличестваЭлементовРегистра(Контекст, Строка, Индекс, ДляВнешнихПользователей)); +``` +
+ +## ДобавитьТекстЗапросаКоличестваОставшихсяЭлементов +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьТекстЗапросаКоличестваОставшихсяЭлементов(ОписаниеЗапроса, Строка, Индекс, Контекст, ДляВнешнихПользователей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТекстЗапросаКоличестваОставшихсяЭлементов(ОписаниеЗапроса, Строка, Индекс, Контекст, ДляВнешнихПользователей)); +``` +
+ +## ЗаполнитьДолиКоличествоЭлементовСсылочногоТипа +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьДолиКоличествоЭлементовСсылочногоТипа(ДолиКоличестваЭлементов, Элемент, ИмяТаблицы) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьДолиКоличествоЭлементовСсылочногоТипа(ДолиКоличестваЭлементов, Элемент, ИмяТаблицы)); +``` +
+ +## ТекстЗапросаКоличестваОставшихсяЭлементовРегистра +
+ +Описание, пример вызова + +```bsl + +Функция ТекстЗапросаКоличестваОставшихсяЭлементовРегистра(ОписаниеЗапроса, Строка, Индекс, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекстЗапросаКоличестваОставшихсяЭлементовРегистра(ОписаниеЗапроса, Строка, Индекс, ); +``` +
+ +## ЗаполнитьДолиКоличестваЭлементовРегистра +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьДолиКоличестваЭлементовРегистра(ДолиКоличестваЭлементов, Элемент, СвойстваОграничения) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьДолиКоличестваЭлементовРегистра(ДолиКоличестваЭлементов, Элемент, СвойстваОграничения)); +``` +
+ +## ДобавитьТекстЗапросаКоличестваКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьТекстЗапросаКоличестваКлючейДоступа(ОписаниеЗапроса, Строка, Индекс, ДляВнешнихПользователей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТекстЗапросаКоличестваКлючейДоступа(ОписаниеЗапроса, Строка, Индекс, ДляВнешнихПользователей)); +``` +
+ +## ДобавитьТекстЗапросаКоличестваОставшихсяКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьТекстЗапросаКоличестваОставшихсяКлючейДоступа(ОписаниеЗапроса, Строка, Индекс, Контекст, ДляВнешнихПользователей) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ДобавитьТекстЗапросаКоличестваОставшихсяКлючейДоступа(ОписаниеЗапроса, Строка, Индекс, Контекст, ДляВнешнихПользователей)); +``` +
+ +## ЗаполнитьДолиКоличестваКлючейДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьДолиКоличестваКлючейДоступа(ДолиКоличестваКлючейДоступа, Элемент) Экспорт +``` + +Пример вызова +```bsl +УправлениеДоступомСлужебный.ЗаполнитьДолиКоличестваКлючейДоступа(ДолиКоличестваКлючейДоступа, Элемент)); +``` +
+ +## ИдентификаторыСписковСОграничением +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ДействующиеПараметры - см. ДействующиеПараметрыОграниченияДоступа +// +// Возвращаемое значение: +// см. ОбщегоНазначения.ИдентификаторыОбъектовМетаданных +// +Функция ИдентификаторыСписковСОграничением(ДействующиеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ИдентификаторыСписковСОграничением(ДействующиеПараметры)); +``` +
+ +## ТекущаяДатаНаСервере +
+ +Описание, пример вызова + +```bsl + +Функция ТекущаяДатаНаСервере() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеДоступомСлужебный.ТекущаяДатаНаСервере() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеКолонтитулами.md b/src/content/docs/bsp/УправлениеКолонтитулами.md new file mode 100644 index 0000000..a45fe45 --- /dev/null +++ b/src/content/docs/bsp/УправлениеКолонтитулами.md @@ -0,0 +1,35 @@ +--- +title: Управление колонтитулами +slug: bsp/управление-колонтитулами +--- + + +## НастройкиКолонтитулов +
+ +Описание, пример вызова + +```bsl + +// Получает сохраненные ранее настройки колонтитулов. Если настройки отсутствуют, то +// возвращается пустая структура настроек. +// +// Возвращаемое значение: +// Структура - значения настроек колонтитулов. +// +Функция НастройкиКолонтитулов() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКолонтитулами.НастройкиКолонтитулов() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеКонтактнойИнформацией.md b/src/content/docs/bsp/УправлениеКонтактнойИнформацией.md new file mode 100644 index 0000000..e37323b --- /dev/null +++ b/src/content/docs/bsp/УправлениеКонтактнойИнформацией.md @@ -0,0 +1,2046 @@ +--- +title: Управление контактной информацией +slug: bsp/управление-контактной-информацией +--- + + +## КонтактнаяИнформация +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу, содержащую контактную информацию нескольких объектов. +// +// Параметры: +// Источник - Массив - владельцы контактной информации. +// Отбор - см. ОтборКонтактнойИнформации. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Объект - ЛюбаяСсылка - владелец контактной информации. +// * Вид - СправочникСсылка.ВидыКонтактнойИнформации - вид контактной информации. +// * Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// * Значение - Строка - контактная информация во внутреннем формате JSON. +// * Представление - Строка - представление контактной информации. +// * Дата - Дата - дата, с которой действует запись контактной информации. +// * ИдентификаторСтрокиТабличнойЧасти - Число - идентификатор строки этой табличной части +// * ЗначенияПолей - Строка - устаревший XML, соответствующий XDTO пакетам КонтактнаяИнформация или Адрес. Для +// обратной совместимости. +// +Функция КонтактнаяИнформация(Источник, Отбор) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.КонтактнаяИнформация(Источник, Отбор) +``` +
+ +## ОтборКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра Отбор для функции КонтактнаяИнформация. +// +// Возвращаемое значение: +// Структура: +// * ТипыКонтактнойИнформации - Массив из ПеречислениеСсылка.ТипыКонтактнойИнформации - отбор по типу контактной информации. +// * ВидыКонтактнойИнформации - Массив из СправочникСсылка.ВидыКонтактнойИнформации - отбор по видам контактной информации. +// * Дата - Дата - дата с которой действует запись контактной информации, используется при хранении +// истории изменения контактной информации. Если владелец хранит историю изменений, +// то при несоответствии параметра дате будет вызвано исключение. +// * КодЯзыка - Строка - код языка, на котором необходимо получить представление контактной информации. +// Представления контактной информации типа Адрес будет получено путем транслитерации, на остальные +// типы контактной информации данных параметр не влияет. +// +Функция ОтборКонтактнойИнформации() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ОтборКонтактнойИнформации() +``` +
+ +## КонтактнаяИнформацияОбъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу, содержащую контактную информацию нескольких объектов. +// +// Параметры: +// СсылкиИлиОбъекты - Массив - владельцы контактной информации. +// ТипыКонтактнойИнформации - Массив +// - ПеречислениеСсылка.ТипыКонтактнойИнформации - если указаны, то будет получена +// контактная информация только этих типов. +// ВидыКонтактнойИнформации - Массив +// - СправочникСсылка.ВидыКонтактнойИнформации - если указаны, то будет возвращена +// контактная информация только этих видов контактной информации. +// Дата - Дата - дата с которой действует запись контактной информации, +// используется при хранении истории изменения контактной информации. +// Если владелец хранит историю изменений, то при несоответствии параметра +// дате будет вызвано исключение. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Объект - ЛюбаяСсылка - владелец контактной информации. +// * Вид - СправочникСсылка.ВидыКонтактнойИнформации - вид контактной информации. +// * Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// * Значение - Строка - контактная информация во внутреннем формате JSON. +// * Представление - Строка - представление контактной информации. +// * Дата - Дата - дата, с которой действует запись контактной информации. +// * ИдентификаторСтрокиТабличнойЧасти - Число - идентификатор строки этой табличной части +// * ЗначенияПолей - Строка - устаревший XML, соответствующий XDTO пакетам КонтактнаяИнформация или Адрес. Для +// обратной совместимости. +// +Функция КонтактнаяИнформацияОбъектов(СсылкиИлиОбъекты, Знач ТипыКонтактнойИнформации = Неопределено, Знач ВидыКонтактнойИнформации = Неопределено, Дата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.КонтактнаяИнформацияОбъектов(СсылкиИлиОбъекты, ТипыКонтактнойИнформации, ВидыКонтактнойИнформации, Дата); +``` +
+ +## КонтактнаяИнформацияОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу, содержащую контактную информацию объекта. +// Поведение, при котором возвращалось представление контактной информации, теперь считается устаревшим +// и сохранено для обратной совместимости. Для получения представления контактной информации рекомендуется +// использовать функцию ПредставлениеКонтактнойИнформацииОбъекта. +// +// Параметры: +// СсылкаИлиОбъект - ОпределяемыйТип.ВладелецКонтактнойИнформации +// - СправочникОбъект +// - ДокументОбъект - ссылка или объект-владелец контактной информации (организация, +// контрагент, партнер и т.д.). +// ВидИлиТипКонтактнойИнформации - СправочникСсылка.ВидыКонтактнойИнформации - отбор по виду контактной информации. +// - ПеречислениеСсылка.ТипыКонтактнойИнформации - отбор по типу контактной информации. +// Дата - Дата - дата с которой действует запись контактной информации, +// используется при хранении истории изменения контактной информации. +// Если владелец хранит историю изменений, то при несоответствии параметра +// дате будет вызвано исключение. +// ТолькоПредставление - Булево - если Истина, то возвращает только представление, иначе таблицу значений. +// Для получения представления рекомендуется использовать функцию ПредставлениеКонтактнойИнформацииОбъекта. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Объект - ЛюбаяСсылка - владелец контактной информации. +// * Вид - СправочникСсылка.ВидыКонтактнойИнформации - вид контактной информации. +// * Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// * Значение - Строка - контактная информация во внутреннем формате JSON. +// * Представление - Строка - представление контактной информации. +// * Дата - Дата - дата, с которой действует запись контактной информации. +// * ИдентификаторСтрокиТабличнойЧасти - Число - идентификатор строки этой табличной части +// * ЗначенияПолей - Строка - устаревший XML, соответствующий XDTO пакетам КонтактнаяИнформация или Адрес. Для +// обратной совместимости. +// +Функция КонтактнаяИнформацияОбъекта(СсылкаИлиОбъект, ВидИлиТипКонтактнойИнформации = Неопределено, Дата = Неопределено, ТолькоПредставление = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.КонтактнаяИнформацияОбъекта(СсылкаИлиОбъект, ВидИлиТипКонтактнойИнформации, Дата, ТолькоПредставление); +``` +
+ +## ПредставлениеКонтактнойИнформацииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление контактной информации объекта. +// +// Параметры: +// СсылкаИлиОбъект - Произвольный - владелец контактной информации. +// ВидКонтактнойИнформации - СправочникСсылка.ВидыКонтактнойИнформации - вид контактной информации. +// Разделитель - Строка - разделитель, который добавляется в представление между записями контактной информации. +// По умолчанию это запятая с последующим пробелом, для исключения +// пробела необходимо использовать признак БезПробелов у параметра ДополнительныеПараметры. +// Дата - Дата - дата, с которой действует запись контактной информации. Если контактная информация +// хранит историю изменения, то передача даты обязательна. +// ДополнительныеПараметры - Структура - необязательные параметры для формирования представления контактной информации: +// * ТолькоПервая - Булево - если Истина, то будет возвращено представление только основной(первой) записи +// контактной информации. По умолчанию - Ложь; +// * БезПробелов - Булево - если Истина, то после разделителя не будет автоматически добавляться пробел. +// По умолчанию - Ложь; +// +// Возвращаемое значение: +// Строка +// +Функция ПредставлениеКонтактнойИнформацииОбъекта(СсылкаИлиОбъект, ВидКонтактнойИнформации, Разделитель = ",", Дата = Неопределено, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ПредставлениеКонтактнойИнформацииОбъекта(СсылкаИлиОбъект, ВидКонтактнойИнформации, Разделитель, ", Дата, ДополнительныеПараметры); +``` +
+ +## НоваяКонтактнаяИнформация +
+ +Описание, пример вызова + +```bsl + +// Формирует новую таблицу контактной информации. +// +// Параметры: +// КолонкаОбъект - Булево - если Истина, то таблица будет содержать колонку "Объект". +// Это нужно, если в таблице необходимо хранить контактной информацию для нескольких объектов. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Объект - ЛюбаяСсылка - владелец контактной информации. +// * Вид - СправочникСсылка.ВидыКонтактнойИнформации - вид контактной информации. +// * Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// * Значение - Строка - JSON, соответствующий структуре контактной информации. +// * ЗначенияПолей - Строка - XML, соответствующий XDTO пакету КонтактнаяИнформация или Адрес. +// * Представление - Строка - представление контактной информации. +// * Дата - Дата - дата, с которой действует запись контактной информации. +// * ИдентификаторСтрокиТабличнойЧасти - Число - идентификатор строки этой табличной части +// +Функция НоваяКонтактнаяИнформация(КолонкаОбъект = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.НоваяКонтактнаяИнформация(КолонкаОбъект); +``` +
+ +## ДобавитьКонтактнуюИнформацию +
+ +Описание, пример вызова + +```bsl + +// Добавляет контактную информацию к объекту по представлению или JSON. +// +// Параметры: +// СсылкаИлиОбъект - СправочникСсылка +// - ДокументСсылка +// - СправочникОбъект +// - ДокументОбъект - ссылка или объект-владелец, содержащий контактную информацию. +// Если указана ссылка, то объект-владелец будет записан в информационную базу. +// Если передан объект, то запись не выполняется. Для сохранения изменений объект +// необходимо будет записать отдельно. +// ЗначениеИлиПредставление - Строка - представление, JSON или XML, соответствующее XDTO-пакету КонтактнаяИнформация +// или Адрес. Если передана пустая строка, то запись не будет добавлена. +// ВидКонтактнойИнформации - СправочникСсылка.ВидыКонтактнойИнформации - вид добавляемой контактной информации. +// Дата - Дата - дата, с которой будет действовать запись контактной информации. +// Требуется для контактной информации, у которой хранится история изменений. +// Если значение не указано, то принимается текущая дата сеанса. +// Замещать - Булево - если Истина (по умолчанию), то будет заменена вся контактная информация по +// переданному виду контактной информации. +// Если Ложь, то запись будет добавлена. Если вид контактной информации не +// разрешает ввод нескольких значений, а контактная информация объекта уже +// содержит запись, то запись не будет добавлена. +// РаспознатьАдрес - Булево - если Истина (по умолчанию), то переданное представление адреса в +// ЗначениеИлиПредставление будет распознано на основе загруженных данных +// адресного классификатора или с помощью веб-сервиса адресов. +// Применим, когда параметр ЗначениеИлиПредставление - это представление адреса +// и ВидКонтактнойИнформации.Тип = ТипыКонтактнойИнформации.Адрес. +// +Процедура ДобавитьКонтактнуюИнформацию(СсылкаИлиОбъект, ЗначениеИлиПредставление, ВидКонтактнойИнформации, Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ДобавитьКонтактнуюИнформацию(СсылкаИлиОбъект, ЗначениеИлиПредставление, ВидКонтактнойИнформации, ); +``` +
+ +## УстановитьКонтактнуюИнформациюОбъектов +
+ +Описание, пример вызова + +```bsl + +// Добавляет или изменяет контактную информацию для нескольких владельцев контактной информации. +// Важно! Если в колонке Объект у параметра КонтактнаяИнформация указана ссылка, то после добавления +// контактной информации владелец будет записан. В случае, если колонка Объект содержит объект владельца +// контактной информации, то для сохранения изменений объекты необходимо будет записать отдельно. +// +// Параметры: +// КонтактнаяИнформация - см. УправлениеКонтактнойИнформацией.НоваяКонтактнаяИнформация +// Замещать - Булево - если Истина(по умолчанию), то будет заменена вся +// вся контактная информация по переданном виду контактной информации. +// Если Ложь, то запись будет добавлена. Если вид контактной информации не разрешает +// ввод нескольких значений, а контактная информация объекта уже содержит запись, +// то запись не будет добавлена. +// +// +// +Процедура УстановитьКонтактнуюИнформациюОбъектов(КонтактнаяИнформация, Замещать = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.УстановитьКонтактнуюИнформациюОбъектов(КонтактнаяИнформация, Замещать); +``` +
+ +## УстановитьКонтактнуюИнформациюОбъекта +
+ +Описание, пример вызова + +```bsl + +// Добавляет или изменяет контактную информацию у владельца контактной информации. +// +// Параметры: +// СсылкаИлиОбъект - СправочникСсылка +// - ДокументСсылка +// - СправочникОбъект +// - ДокументОбъект - ссылка или объект владелец +// контактной информации. Для ссылки после добавления контактной информации +// владелец будет записан. Если передан объект, то контактная информация будет +// добавлена без записи. Для сохранения изменений объект необходимо будет +// записать отдельно. +// - ДанныеФормыСтруктура: +// * Ссылка - СправочникСсылка - ссылка на объект-владельца контактной информации +// КонтактнаяИнформация - ТаблицаЗначений - таблица, содержащая контактную информацию +// Описание колонок см. функцию НоваяКонтактнаяИнформация. +// Важно! Если передана пустая таблица значений и указан режим замещения, то +// произойдет очистка всей контактной информации владельца контактной информации. +// Замещать - Булево - если Истина(по умолчанию), то будет заменена +// вся контактная информация по переданном виду контактной информации. +// Если Ложь, то запись будет добавлена. Если вид контактной информации +// не разрешает ввод нескольких значений, а контактная информация объекта +// уже содержит запись, то запись не будет добавлена. +// +Процедура УстановитьКонтактнуюИнформациюОбъекта(СсылкаИлиОбъект, Знач КонтактнаяИнформация, Замещать = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.УстановитьКонтактнуюИнформациюОбъекта(СсылкаИлиОбъект, КонтактнаяИнформация, Замещать); +``` +
+ +## СведенияОТелефоне +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения о телефоне или факсе. +// +// Параметры: +// КонтактнаяИнформация - Строка - телефон во внутреннем формате JSON или в XML, соответствующем XDTO-пакету контактная +// информация. +// - Неопределено - конструктор, возвращает список незаполненных полей телефона. +// +// Возвращаемое значение: +// Структура: +// * Представление - Строка - полное представление телефона с добавочным номером и комментарием, например, "+7 495 +// 1234567 (+12) Звонить после 18:00". +// * КодСтраны - Строка - код страны. Например, +7. +// * КодГорода - Строка - код города. Например, 495. +// * НомерТелефона - Строка - номер телефона. Например, 1234567. +// * Добавочный - Строка - добавочный номер телефона. Например, +12. +// * Комментарий - Строка - комментарий к номеру телефона. Например, Звонить после 18:00. +// +Функция СведенияОТелефоне(КонтактнаяИнформация = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.СведенияОТелефоне(КонтактнаяИнформация); +``` +
+ +## НомерТелефонаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает строку с номером телефона без кода и дополнительного номера. +// +// Параметры: +// КонтактнаяИнформация - Строка - строка JSON или XML контактной информации соответствующая XDTO пакету КонтактнаяИнформация. +// +// Возвращаемое значение: +// Строка - номер телефона. +// +Функция НомерТелефонаКонтактнойИнформации(Знач КонтактнаяИнформация) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.НомерТелефонаКонтактнойИнформации(КонтактнаяИнформация) +``` +
+ +## КонтактнаяИнформацияВJSON +
+ +Описание, пример вызова + +```bsl + +// Преобразует входящие форматы контактной информации во внутренний формат JSON. +// +// Параметры: +// КонтактнаяИнформация - Строка - строка в формате XML. Структура XML-документа соответствует XDTO-пакету КонтактнаяИнформация +// или Адрес (для адресов содержащих поля с национальной спецификой). +// Если передана строка во внутреннем формате JSON, то возвращаемое значение будет +// полностью совпадать с ней. +// - Структура - см. УправлениеКонтактнойИнформациейКлиентСервер.СтруктураКонтактнойИнформацииПоТипу +// см. РаботаСАдресамиКлиентСервер.ПоляАдреса (для адресов содержащих поля с +// национальной спецификой), см. РаботаСАдресамиКлиентСервер.СтруктураКонтактнойИнформацииПоТипу +// (для других типов контактной информации содержащих поля с национальной спецификой). +// ОжидаемыйВид - СправочникСсылка.ВидыКонтактнойИнформации +// - ПеречислениеСсылка.ТипыКонтактнойИнформации - +// используется для определения типа контактной информации, если его невозможно определить из +// переданной контактной информации в параметре КонтактнаяИнформация. +// +// Возвращаемое значение: +// Строка - контактная информация во внутреннем формате JSON. +// Поля и их описание см. УправлениеКонтактнойИнформациейКлиентСервер.ОписаниеНовойКонтактнойИнформации. +// Дополнительные поля для конфигурации с поддержкой национальной специфики см. РаботаСАдресамиКлиентСервер.ОписаниеНовойКонтактнойИнформации +// +Функция КонтактнаяИнформацияВJSON(Знач КонтактнаяИнформация, Знач ОжидаемыйВид = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.КонтактнаяИнформацияВJSON(КонтактнаяИнформация, ОжидаемыйВид); +``` +
+ +## КонтактнаяИнформацияВXML +
+ +Описание, пример вызова + +```bsl + +// Преобразует все входящие форматы контактной информации в XML. +// +// Параметры: +// ЗначенияПолей - Строка +// - Структура +// - Соответствие +// - СписокЗначений - описание полей контактной информации. +// XML должен соответствовать XDTO-пакету КонтактнаяИнформация или Адрес. +// Структура, Соответствие, СписокЗначений должен содержать поля в соответствии со структурой +// XDTO пакетов КонтактнаяИнформация или Адрес(для конфигурации с поддержкой специфики РФ). +// Представление - Строка - представление контактной информации. Используется, если невозможно определить +// представление из параметра ЗначенияПолей (например, отсутствует поле Представление). +// ОжидаемыйВид - СправочникСсылка.ВидыКонтактнойИнформации +// - ПеречислениеСсылка.ТипыКонтактнойИнформации - +// Используется для определения типа, если его невозможно вычислить по полю ЗначенияПолей. +// +// Возвращаемое значение: +// Строка - контактная информация в виде XML, соответствующего структуре XDTO пакетов КонтактнаяИнформация и Адрес. +// +Функция КонтактнаяИнформацияВXML(Знач ЗначенияПолей, Знач Представление = "", Знач ОжидаемыйВид = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.КонтактнаяИнформацияВXML(ЗначенияПолей, Представление, ОжидаемыйВид); +``` +
+ +## ОбновитьКонтактнуюИнформациюОбъекта +
+ +Описание, пример вызова + +```bsl + +// Преобразует контактную информацию, хранящуюся в поле ЗначениеПолей, в формат JSON и сохраняет его +// в поле колонки Значение таблицы КонтактнаяИнформация. +// Если колонки ЗначениеПолей и Значение содержат пустые строки, то JSON будет сформирована по представлению. +// В случае, когда параметр СсылкаИлиОбъект содержит объект контактной информации, +// то для сохранения изменений преобразования необходимо будет записать объект отдельно. +// Если передана ссылка, то после конвертирования хотя бы одной строки контактной информации владелец будет записан. +// +// Параметры: +// СсылкаИлиОбъект - ОпределяемыйТип.ВладелецКонтактнойИнформации - ссылка на объект с контактной информацией. +// - СправочникОбъект +// - ДокументОбъект - объект-владелец контактной информации (организация, +// контрагент, партнер и т.д.). +// +// Возвращаемое значение: +// Булево - если, Истина, то контактная информация была преобразована в JSON. +// +Функция ОбновитьКонтактнуюИнформациюОбъекта(СсылкаИлиОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ОбновитьКонтактнуюИнформациюОбъекта(СсылкаИлиОбъект) +``` +
+ +## ОбъектыТребующиеОбновленияКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает объекты, хранящие контактную информацию в устаревших форматах XML или Ключ-Значение, +// и требующие преобразования контактной информации в современный формат JSON. +// +// Параметры: +// ОбъектМетаданных - ОбъектМетаданных - объект с контактной информации у которого требуется определить элемент +// содержащие незаполненные поля в JSON. +// РазмерПорции - Число - количество объектов, возвращаемых за один вызов. Если не указано, то будут выбраны все объекты. +// +// Возвращаемое значение: +// Массив - ссылки на объекты. +// +Функция ОбъектыТребующиеОбновленияКонтактнойИнформации(ОбъектМетаданных, РазмерПорции = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ОбъектыТребующиеОбновленияКонтактнойИнформации(ОбъектМетаданных, РазмерПорции); +``` +
+ +## ТипКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип контактной информации. +// +// Параметры: +// КонтактнаяИнформация - Строка - контактная информация в виде XML, соответствующего структуре XDTO-пакетов +// КонтактнаяИнформация и Адрес. +// +// Возвращаемое значение: +// ПеречислениеСсылка.ТипыКонтактнойИнформации - соответствующий тип. +// +Функция ТипКонтактнойИнформации(Знач КонтактнаяИнформация) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ТипКонтактнойИнформации(КонтактнаяИнформация) +``` +
+ +## КонтактнаяИнформацияПоПредставлению +
+ +Описание, пример вызова + +```bsl + +// Преобразует представление контактной информации во внутренний формат JSON. +// +// Для адресов, введенных в свободной форме, корректное преобразование не гарантируется. +// +// Параметры: +// Представление - Строка - строковое представление контактной информации, выводимое пользователю. +// ОжидаемыйВид - СправочникСсылка.ВидыКонтактнойИнформации +// - ПеречислениеСсылка.ТипыКонтактнойИнформации +// - Структура - вид или тип контактной информации. +// +// Возвращаемое значение: +// Строка - контактная информация в виде JSON. +// +Функция КонтактнаяИнформацияПоПредставлению(Представление, ОжидаемыйВид) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.КонтактнаяИнформацияПоПредставлению(Представление, ОжидаемыйВид) +``` +
+ +## ПредставлениеКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление контактной информации (адреса, телефона, электронной почты и т.п.). +// +// Параметры: +// КонтактнаяИнформация - Строка - строка JSON или XML контактной информации +// соответствующая XDTO пакетам КонтактнаяИнформация или Адрес. +// - ОбъектXDTO - XDTO-объект КонтактнаяИнформация или Адрес. +// - Структура - см. РаботаСАдресами.СведенияОбАдресе +// - Структура - см. УправлениеКонтактнойИнформацией.СведенияОТелефоне +// ПеревестиВТранслит - Булево - Истина, если требуется перевести представление контактной информации в транслит. +// +// Возвращаемое значение: +// Строка - представление контактной информации. +// +Функция ПредставлениеКонтактнойИнформации(Знач КонтактнаяИнформация, Знач ПеревестиВТранслит = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ПредставлениеКонтактнойИнформации(КонтактнаяИнформация, ПеревестиВТранслит); +``` +
+ +## АдресВведенВСвободнойФорме +
+ +Описание, пример вызова + +```bsl + +// Вычисляет, что адрес был введен в свободной форме. +// +// Параметры: +// КонтактнаяИнформация - Строка - строка JSON или XML контактной информации, соответствующая XDTO-пакетам +// КонтактнаяИнформация или Адрес. +// +// Возвращаемое значение: +// Булево - новое значение. +// +Функция АдресВведенВСвободнойФорме(Знач КонтактнаяИнформация) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.АдресВведенВСвободнойФорме(КонтактнаяИнформация) +``` +
+ +## КомментарийКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает комментарий контактной информации. +// +// Параметры: +// КонтактнаяИнформация - Строка - строка JSON или XML или объект XDTO, соответствующие XDTO-пакетам +// КонтактнаяИнформация или Адрес. +// +// Возвращаемое значение: +// Строка - комментарий контактной информации или пустая строка, +// если значение параметра не является контактной информацией. +// +Функция КомментарийКонтактнойИнформации(КонтактнаяИнформация) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.КомментарийКонтактнойИнформации(КонтактнаяИнформация) +``` +
+ +## УстановитьКомментарийКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Устанавливает новый комментарий для контактной информации. +// +// Параметры: +// КонтактнаяИнформация - Строка +// - ОбъектXDTO - строка JSON или XML контактной информации, соответствующая XDTO +// пакетам КонтактнаяИнформация или Адрес. +// Комментарий - Строка - новое значение комментария. +// +Процедура УстановитьКомментарийКонтактнойИнформации(КонтактнаяИнформация, Знач Комментарий) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.УстановитьКомментарийКонтактнойИнформации(КонтактнаяИнформация, Комментарий) +``` +
+ +## СтранаАдресаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о стране адреса. +// Если переданная строка не содержит информации об адресе, то будет вызвано исключение. +// Если передана пустая строка, то возвращается пустая структура. +// Если страна не существует в справочнике, но есть в классификаторе стран, то поле Ссылка результата не будет заполнено. +// Если страна не существует в классификаторе стран, то будет заполнено только поле Наименование. +// +// Параметры: +// Адрес - Структура +// - Строка - адрес в формате JSON или строка XML соответствующая XDTO-пакетам КонтактнаяИнформация +// или Адрес. +// +// Возвращаемое значение: +// Структура - описание страны адреса. Содержит поля: +// * Ссылка - СправочникСсылка.СтраныМира +// - Неопределено - ссылка на элемент справочника страны мира. +// * Наименование - Строка - наименование страны. +// * Код - Строка - код страны. +// * НаименованиеПолное - Строка - полное наименование страны. +// * КодАльфа2 - Строка - двузначный буквенный код страны Альфа-2. +// * КодАльфа3 - Строка - трехзначный буквенный код страны Альфа-3. +// +Функция СтранаАдресаКонтактнойИнформации(Знач Адрес) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.СтранаАдресаКонтактнойИнформации(Адрес) +``` +
+ +## ДоменАдресаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает домен сетевого адреса для веб-ссылки или адреса электронной почты. +// +// Параметры: +// КонтактнаяИнформация - Строка - строка JSON или XML контактной информации соответствующая XDTO пакету КонтактнаяИнформация. +// +// Возвращаемое значение: +// Строка - домен адреса. +// +Функция ДоменАдресаКонтактнойИнформации(Знач КонтактнаяИнформация) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ДоменАдресаКонтактнойИнформации(КонтактнаяИнформация) +``` +
+ +## РазличияКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Сравнивает два экземпляра контактной информации. +// +// Параметры: +// Данные1 - ОбъектXDTO - объект с контактной информацией. +// - Строка - контактная информация в формате XML. +// - Структура - описание контактной информацию. Ожидаются поля: +// * ЗначенияПолей - Строка +// - Структура +// - СписокЗначений +// - Соответствие - поля контактной информации. +// * Представление - Строка - представление. Используется в случае, если не удалось вычислить +// представление из ЗначенияПолей (отсутствие в них поля Представление). +// * Комментарий - Строка - комментарий. Используется в том случае, если не удалось вычислить комментарий +// из ЗначенияПолей. +// * ВидКонтактнойИнформации - СправочникСсылка.ВидыКонтактнойИнформации +// - ПеречислениеСсылка.ТипыКонтактнойИнформации +// - Структура - +// используется в том случае, если не удалось вычислить тип из ЗначенияПолей. +// Данные2 - ОбъектXDTO +// - Строка +// - Структура - смотри описание параметра Данные1. +// +// Возвращаемое значение: +// ТаблицаЗначений: - таблица отличающихся полей со следующими колонками: +// * Путь - Строка - XPath, идентифицирующий отличающееся значение. Значение "ТипКонтактнойИнформации" +// означает, что переданные экземпляры контактной информации различаются типом. +// * Описание - Строка - описание отличающегося реквизита в терминах предметной области. +// * Значение1 - Строка - значение, соответствующая объекту, переданному в параметре Данные1. +// * Значение2 - Строка - значение, соответствующая объекту, переданному в параметре Данные2. +// +Функция РазличияКонтактнойИнформации(Знач Данные1, Знач Данные2) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.РазличияКонтактнойИнформации(Данные1, Данные2) +``` +
+ +## СоздатьВТКонтактнаяИнформация +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу с контактной информацией нескольких объектов. +// +// Параметры: +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - в менеджере создается временная таблица +// ВТКонтактнаяИнформация с полями: +// * Объект - ЛюбаяСсылка - владелец контактной информации. +// * Вид - СправочникСсылка.ВидыКонтактнойИнформации - ссылка на вид контактной информации. +// * Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// * ЗначенияПолей - Строка - XML соответствующий XDTO пакету КонтактнаяИнформация или Адрес. +// * Представление - Строка - представление контактной информации. +// МассивОбъектов - Массив - владельцы контактной информации. +// ТипыКонтактнойИнформации - Массив - если указаны, то временная таблица будет содержать только контактную +// информацию этих типов. +// ВидыКонтактнойИнформации - Массив - если указаны, то временная таблица будет содержать только контактную +// информацию этих видов. +// Дата - Дата - дата, с которой действует запись контактной информации, используется при +// хранении истории изменения контактной информации. Если владелец хранит историю +// изменений, то при несоответствии параметра дате будет вызвано исключение. +// +Процедура СоздатьВТКонтактнаяИнформация(МенеджерВременныхТаблиц, МассивОбъектов, ТипыКонтактнойИнформации = Неопределено, ВидыКонтактнойИнформации = Неопределено, Дата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.СоздатьВТКонтактнаяИнформация(МенеджерВременныхТаблиц, МассивОбъектов, ТипыКонтактнойИнформации, ВидыКонтактнойИнформации, Дата); +``` +
+ +## ДанныеСтраныМира +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные о стране по справочнику стран мира или классификатору. +// +// Параметры: +// КодСтраны - Строка +// - Число - код страны по классификатору. Если не указано, то поиск по коду не производится. +// Наименование - Строка - наименование страны, в т.ч. и международное. Если не указано, то поиск по наименованию не производится. +// +// Возвращаемое значение: +// Структура - описание страны. Содержит поля: +// * Ссылка - СправочникСсылка.СтраныМира +// - Неопределено - соответствующий элемент справочника Страны мира. +// * Наименование - Строка - наименование страны. +// * Код - Строка - код страны. +// * НаименованиеПолное - Строка - полное наименование страны. +// * КодАльфа2 - Строка - двузначный буквенный код страны альфа-2. +// * КодАльфа3 - Строка - трехзначный буквенный код страны альфа-3. +// * УчастникЕАЭС - Булево - страна-участник ЕАЭС. +// * МеждународноеНаименование - Строка - международное наименование страны мира +// Неопределено - страна не существует. +// +Функция ДанныеСтраныМира(Знач КодСтраны = Неопределено, Знач Наименование = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ДанныеСтраныМира(КодСтраны, Наименование); +``` +
+ +## ДанныеКлассификатораСтранМираПоКоду +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные страны по коду. +// +// Параметры: +// Код - Строка +// - Число - код страны по классификатору. +// ТипКода - Строка - варианты: КодСтраны (по умолчанию), Альфа2, Альфа3. +// +// Возвращаемое значение: +// Структура - описание страны. Содержит поля: +// * Наименование - Строка - наименование страны. +// * Код - Строка - код страны. +// * НаименованиеПолное - Строка - полное наименование страны. +// * КодАльфа2 - Строка - двузначный буквенный код страны альфа-2. +// * КодАльфа3 - Строка - трехзначный буквенный код страны альфа-3. +// * УчастникЕАЭС - Булево - страна-участник ЕАЭС. +// Неопределено - страна не существует. +// +Функция ДанныеКлассификатораСтранМираПоКоду(Знач Код, Знач ТипКода = "КодСтраны") Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ДанныеКлассификатораСтранМираПоКоду(Код, ТипКода); +``` +
+ +## ДанныеКлассификатораСтранМираПоНаименованию +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные о стране по наименованию страны. +// +// Параметры: +// Наименование - Строка - наименование страны. +// +// Возвращаемое значение: +// Структура - описание страны. Содержит поля: +// * Наименование - Строка - наименование страны. +// * Код - Строка - код страны. +// * НаименованиеПолное - Строка - полное наименование страны. +// * КодАльфа2 - Строка - двузначный буквенный код страны альфа-2. +// * КодАльфа3 - Строка - трехзначный буквенный код страны альфа-3. +// * УчастникЕАЭС - Булево - страна-участник ЕАЭС. +// Неопределено - страна не существует в классификаторе. +// +Функция ДанныеКлассификатораСтранМираПоНаименованию(Знач Наименование) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ДанныеКлассификатораСтранМираПоНаименованию(Наименование) +``` +
+ +## СтранаМираПоКодуИлиНаименованию +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на элемент справочника страны мира по коду или наименованию. +// Если элемент справочника СтраныМиры не существует, то он будет создан на основании данных заполнения. +// +// Параметры: +// КодИлиНаименование - Строка - код страны, код Альфа2, код Альфа3 или наименование страны, в т.ч. международное. +// ДанныеЗаполнения - Структура - данные для заполнения в случае создания нового элемента. +// Ключи структуры соответствуют реквизитам справочника СтраныМира. +// +// Возвращаемое значение: +// СправочникСсылка.СтраныМира - если найдено несколько значений, то будет возвращено первое. +// Если не существует и данные заполнения не указаны, то возвращается пустая ссылка. +// +Функция СтранаМираПоКодуИлиНаименованию(КодИлиНаименование, ДанныеЗаполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.СтранаМираПоКодуИлиНаименованию(КодИлиНаименование, ДанныеЗаполнения); +``` +
+ +## СтраныУчастникиЕАЭС +
+ +Описание, пример вызова + +```bsl + +// Возвращает список стран Евразийского экономического союза (ЕАЭС). +// Вызов функции может инициировать HTTP-запрос к веб-сервису по работе с классификаторами +// для получения актуального списка всех стран участников ЕАЭС. +// +// Возвращаемое значение: +// - ТаблицаЗначений - список стран Евразийского экономического союза (ЕАЭС): +// * Ссылка - СправочникСсылка.СтраныМира - ссылка на элемент справочника страны. +// * Наименование - Строка - наименование страны. +// * Код - Строка - код страны. +// * НаименованиеПолное - Строка - полное наименование страны. +// * КодАльфа2 - Строка - двузначный буквенный код страны альфа-2. +// * КодАльфа3 - Строка - трехзначный буквенный код страны альфа-3. +// * МеждународноеНаименование - Строка - международное наименование страны мира +// +Функция СтраныУчастникиЕАЭС() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.СтраныУчастникиЕАЭС() +``` +
+ +## ЭтоСтранаУчастникЕАЭС +
+ +Описание, пример вызова + +```bsl + +// Определяет, является ли страна участником Евразийского экономического союза (ЕАЭС). +// +// Параметры: +// Страна - Строка +// - СправочникСсылка.СтраныМира - код страны, код Альфа2, код Альфа3, +// наименование страны или ссылка на элемент справочника Страны мира. +// Возвращаемое значение: +// Булево - если Истина, то страна является государством-участником ЕАЭС. +// +Функция ЭтоСтранаУчастникЕАЭС(Страна) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ЭтоСтранаУчастникЕАЭС(Страна) +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик для события формы ПриСозданииНаСервере. +// Вызывается из модуля формы объекта-владельца КИ при внедрении подсистемы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта-владельца, предназначенная для вывода контактной информации. +// Объект - СправочникСсылка +// - ДокументСсылка +// - СправочникОбъект +// - ДокументОбъект - объект-владелец контактной информации. +// Если это ссылка, то контактная информация +// будет получена из объекта по ссылке, иначе из таблицы КонтактнаяИнформация объекта. +// ДополнительныеПараметры - см. ПараметрыКонтактнойИнформации. +// - Строка - устарел. +// УдалитьПоложениеЗаголовкаКИ - ПоложениеЗаголовкаЭлементаФормы - устарел, следует использовать ДополнительныеПараметры. +// УдалитьИсключаемыеВиды - Массив - устарел,следует использовать ДополнительныеПараметры. +// УдалитьОтложеннаяИнициализация - Массив - устарел,следует использовать ДополнительныеПараметры. +// +Процедура ПриСозданииНаСервере(Форма, Объект, Знач ДополнительныеПараметры = Неопределено, УдалитьПоложениеЗаголовкаКИ = "", Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ПриСозданииНаСервере(Форма, Объект, ДополнительныеПараметры, УдалитьПоложениеЗаголовкаКИ, ); +``` +
+ +## ПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик для события формы ПриЧтенииНаСервере. +// Вызывается из модуля формы объекта-владельца КИ при внедрении подсистемы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта-владельца, предназначенная для вывода контактной информации. +// Объект - СправочникСсылка +// - ДокументСсылка +// - СправочникОбъект +// - ДокументОбъект - объект-владелец контактной информации. +// ИмяЭлементаДляРазмещения - Строка - группа, куда будут размещены элементы контактной информации. +// +Процедура ПриЧтенииНаСервере(Форма, Объект, ИмяЭлементаДляРазмещения = "ГруппаКонтактнаяИнформация") Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ПриЧтенииНаСервере(Форма, Объект, ИмяЭлементаДляРазмещения); +``` +
+ +## ПослеЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик для события формы ПослеЗаписиНаСервере. +// Вызывается из модуля формы объекта-владельца КИ при внедрении подсистемы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта-владельца, предназначенная для вывода контактной информации. +// Объект - СправочникСсылка +// - ДокументСсылка +// - СправочникОбъект +// - ДокументОбъект - объект-владелец контактной информации. +// +Процедура ПослеЗаписиНаСервере(Форма, Объект) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ПослеЗаписиНаСервере(Форма, Объект) +``` +
+ +## ОбработкаПроверкиЗаполненияНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик для события формы ОбработкаПроверкиЗаполненияНаСервере. +// Вызывается из модуля формы объекта-владельца КИ при внедрении подсистемы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта-владельца, предназначенная для вывода контактной информации. +// Объект - СправочникСсылка +// - ДокументСсылка +// - СправочникОбъект +// - ДокументОбъект - объект-владелец контактной информации. +// Отказ - Булево - если Истина, то во время проверки были обнаружены ошибки. +// +Процедура ОбработкаПроверкиЗаполненияНаСервере(Форма, Объект, Отказ) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ОбработкаПроверкиЗаполненияНаСервере(Форма, Объект, Отказ) +``` +
+ +## ПередЗаписьюНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик для события формы ПередЗаписьюНаСервере. +// Вызывается из модуля формы объекта-владельца КИ при внедрении подсистемы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта-владельца, предназначенная для вывода контактной информации. +// Объект - СправочникОбъект +// - ДокументСсылка - объект-владелец контактной информации. +// ДанныеФормыСтруктура - Объект, содержащий табличную часть с контактной информацией. Поддерживает работу +// со скрываемыми видами контактной информации только для уже существующих объектов, +// из-за невозможности установить ссылку для нового объекта. +// Отказ - Булево - если Истина, то объект не был записан, т.к. во время записи возникли ошибки. +// +Процедура ПередЗаписьюНаСервере(Форма, Объект, Отказ = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ПередЗаписьюНаСервере(Форма, Объект, Отказ); +``` +
+ +## ОбновитьКонтактнуюИнформацию +
+ +Описание, пример вызова + +```bsl + +// Добавляет (удаляет) поле ввода или комментарий на форму, обновляя данные. +// Вызывается из модуля формы объекта-владельца контактной информации. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта-владельца, предназначенная для вывода контактной информации. +// Объект - ДанныеФормыСтруктура - объект-владелец контактной информации. +// Результат - Неопределено - служебный реквизит, полученный из предыдущего обработчика события. +// - Структура: - набор свойств динамический: +// * ПоменятьМестамиЭлементы - Булево - если значения элементов меняются местами. +// * ПервыйЭлемент - Строка - если значения элементов меняются местами. +// * ВторойЭлемент - Строка - если значения элементов меняются местами. +// * ОбновитьКонтекстноеМеню - Булево - если выполняется обновление меню +// * ИмяРеквизита - Строка - если выполняется обновление меню +// * ДобавляемыйВид - Булево - при добавлении нового элемента +// * ЭтоДобавлениеКомментария - Булево - при добавлении комментария +// * ОбновитьКонтекстноеМеню - Булево - при обновлении контекстного меню +// * ИмяЭлементаДляРазмещения - Строка - если добавляет новый элемент, комментарий или обновляется контекстное меню +// * Комментарий - Строка - при обновлении контекстного меню +// * Перечитать - Булево - если нужно полностью обновить контактную информацию в рамках элемента для размещения. +// +// Возвращаемое значение: +// Неопределено - значение не используется, обратная совместимость. +// +Функция ОбновитьКонтактнуюИнформацию(Форма, Объект, Результат = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ОбновитьКонтактнуюИнформацию(Форма, Объект, Результат); +``` +
+ +## ОбработкаЗаполненияКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки события "ОбработкаЗаполнения". +// +// Параметры: +// Источник - СправочникОбъект +// - ДокументОбъект - объект, содержащий контактную информацию. +// ДанныеЗаполнения - Структура - данные с контактной информацией для заполнения объекта. +// ТекстЗаполнения - Строка - не используется. +// СтандартнаяОбработка - Булево - не используется. +// +Процедура ОбработкаЗаполненияКонтактнойИнформации(Источник, ДанныеЗаполнения, ТекстЗаполнения, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ОбработкаЗаполненияКонтактнойИнформации(Источник, ДанныеЗаполнения, ТекстЗаполнения, СтандартнаяОбработка) +``` +
+ +## ОбработкаОбновленияКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки события "ПередЗаписью" для обновления контактной информации для списков. +// +// Параметры: +// Объект - Произвольный - объект, содержащий контактную информацию. +// Отказ - Булево - не используется, обратная совместимость. +// +Процедура ОбработкаОбновленияКонтактнойИнформации(Объект, Отказ) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ОбработкаОбновленияКонтактнойИнформации(Объект, Отказ) +``` +
+ +## ОбработкаЗаполненияКонтактнойИнформацииДокумента +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки события "ОбработкаЗаполнения" для документов. +// +// Параметры: +// Источник - Произвольный - объект, содержащий контактную информацию. +// ДанныеЗаполнения - Структура - данные с контактной информацией для заполнения объекта. +// ТекстЗаполнения - Строка +// - Неопределено - данные заполнения реквизита Наименование. +// СтандартнаяОбработка - Булево - не используется. +// +Процедура ОбработкаЗаполненияКонтактнойИнформацииДокумента(Источник, ДанныеЗаполнения, ТекстЗаполнения, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ОбработкаЗаполненияКонтактнойИнформацииДокумента(Источник, ДанныеЗаполнения, ТекстЗаполнения, СтандартнаяОбработка) +``` +
+ +## ВыполнитьОтложеннуюИнициализацию +
+ +Описание, пример вызова + +```bsl + +// Выполняет отложенную инициализацию реквизитов и элементов контактной информации. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта-владельца, предназначенная для вывода +// контактной информации. +// Объект - Произвольный - объект-владелец контактной информации. +// ИмяЭлементаДляРазмещения - Строка - имя группы, где размещена контактная информация. +// +Процедура ВыполнитьОтложеннуюИнициализацию(Форма, Объект, ИмяЭлементаДляРазмещения = "ГруппаКонтактнаяИнформация") Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ВыполнитьОтложеннуюИнициализацию(Форма, Объект, ИмяЭлементаДляРазмещения); +``` +
+ +## ВидыКонтактнойИнформацииОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает используемые виды контактной информации объекта. +// +// Параметры: +// ВладелецКонтактнойИнформации - СправочникСсылка.ВидыКонтактнойИнформации +// - СправочникОбъект.ВидыКонтактнойИнформации +// - ДанныеФормыСтруктура: +// * Ссылка - СправочникСсылка.ВидыКонтактнойИнформации - ссылка на вид КИ. +// ТипКонтактнойИнформации - ПеречислениеСсылка.ТипыКонтактнойИнформации - отбор видов КИ по типу. +// +// Возвращаемое значение: +// ТаблицаЗначений - виды контактной информации, где: +// * Ссылка - СправочникСсылка.ВидыКонтактнойИнформации +// * Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации +// * Представление - Строка +// * Наименование - Строка +// * РазрешитьВводНесколькихЗначений - Булево +// * РеквизитДопУпорядочивания - Число +// * ОбязательноеЗаполнение - Булево +// * ПроверятьКорректность - Булево +// * ИдентификаторДляФормул - Строка +// * ИмяПредопределенногоВида - Строка +// +Функция ВидыКонтактнойИнформацииОбъекта(ВладелецКонтактнойИнформации, ТипКонтактнойИнформации = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ВидыКонтактнойИнформацииОбъекта(ВладелецКонтактнойИнформации, ТипКонтактнойИнформации); +``` +
+ +## СодержитКонтактнуюИнформацию +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак, что объект подключен к подсистеме "Контактная информация" +// и содержит табличную часть КонтактнаяИнформация. +// +// Параметры: +// ПроверяемыйОбъект - СправочникОбъект +// - СправочникСсылка +// - ДокументОбъект +// - ДокументСсылка +// - Тип - проверяемый объект на подключение к подсистеме Контактная информация. +// +// Возвращаемое значение: +// Булево - если Истина, то объект содержит контактную информацию. +// +Функция СодержитКонтактнуюИнформацию(ПроверяемыйОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.СодержитКонтактнуюИнформацию(ПроверяемыйОбъект) +``` +
+ +## ВидКонтактнойИнформацииПоИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на вид контактной информации. +// Если по виден не был найден по имени, то выполняется поиск по именам предопределенных элементов. +// +// Параметры: +// Имя - Строка - уникальное имя вида контактной информации. +// +// Возвращаемое значение: +// СправочникСсылка.ВидыКонтактнойИнформации +// +Функция ВидКонтактнойИнформацииПоИмени(Имя) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ВидКонтактнойИнформацииПоИмени(Имя) +``` +
+ +## ПараметрыКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Описание параметров контактной информации, используемых в обработчике ПриСозданииНаСервере. +// +// Возвращаемое значение: +// Структура - параметры контактной информации: +// * Индекс - Строка - индекс адреса. +// * Страна - Строка - страна адреса. +// * ТипПомещения - Строка - наименование типа помещения, который будет установлен +// в форме ввода нового адреса. По умолчанию, "Квартира". +// * ИмяЭлементаДляРазмещения - Строка - группа, куда будут размещены элементы контактной информации. +// * СкрываемыеВиды - Массив - виды контактной информации, которые не требуется отображать на форме. +// * ОтложеннаяИнициализация - Булево - если Истина, то создание полей контактной информации на форме будет отложено. +// * ПоложениеЗаголовкаКИ - ПоложениеЗаголовкаЭлементаФормы - может принимать значения: +// ПоложениеЗаголовкаЭлементаФормы.Верх или +// ПоложениеЗаголовкаЭлементаФормы.Лево (по умолчанию). +// * РазрешитьДобавлениеПолей - Булево - если Истина, то на форме владельца контактной информации, будет отображена кнопка +// для добавления дополнительной контактной информации +// * РазмещеныНаФорме - Соответствие из КлючИЗначение - виды контактной информации, которые были размещены на +// форме интерактивно, при отложенной инициализации будут созданы на форме +// после вызова процедуры УправлениеКонтактнойИнформацией.ВыполнитьОтложеннуюИнициализацию: +// ** Ключ - Строка - имя предопределенного вида контактной информации +// - СправочникСсылка.ВидыКонтактнойИнформации +// ** Значение - Булево - Истина +// * ОбработкаНавигационнойСсылки - Булево - если истина, то отображение контактной информации с типом ВебСтраница +// будет в виде гиперссылки +// * ИсключаемыеВиды - Массив - устарело. Следует использовать РазмещеныНаФорме. +// +Функция ПараметрыКонтактнойИнформации() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ПараметрыКонтактнойИнформации() +``` +
+ +## СведенияОбАдресе +
+ +Описание, пример вызова + +```bsl + +// Возвращает детализированную информацию об адресе в виде отдельных полей, таких как город, улица, регион, индекс и др. +// Если в конфигурации присутствует общий модуль РаботаСАдресами, +// вызов данной функции будет автоматически перенаправлен в этот модуль. +// +// Параметры: +// Адрес - Строка - адрес во внутреннем формате JSON. +// - Неопределено - конструктор для получения пустых полей адреса. +// ДополнительныеПараметры - Структура - для уточнения возвращаемого значения. +// * БезПредставлений - Булево - если Истина, то поле Представление будет отсутствовать. По умолчанию Ложь. +//// +// Возвращаемое значение: +// Структура: +// * Представление - Строка - текстовое представление адреса. Например, "08681, Центральный регион, город +// Лима, ул. Широкая, дом 1". +// * ТипАдреса - Строка - тип адреса. Варианты: "ВСвободнойФорме", "Иностранный". +// * Страна - Строка - текстовое представление страны. Например, "Перу". +// * КодСтраны - Строка - код страны. Например, "604". +// * Индекс - Строка - почтовый индекс. Например, "08681". +// * Регион - Строка - текстовое представление региона или штата. Например, "Центральный". +// * Город - Строка - текстовое представление города. +// * Улица - Строка - текстовое представление улицы включая номер дома, корпус, строения. Например +// "ул. Широкая, дом 1". +// * ДополнительнаяИнформация - Строка - текстовое представление дополнительной информации. Например, когда +// требуется указать детали, такие как квартира, офис, этаж или другие уточнения. +// +Функция СведенияОбАдресе(Адрес = Неопределено, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.СведенияОбАдресе(Адрес, ДополнительныеПараметры); +``` +
+ +## СведенияОбАдресах +
+ +Описание, пример вызова + +```bsl + +// Возвращает детализированную информацию об адресе в виде отдельных полей, таких как город, улица, регион, индекс и др. +// Если в конфигурации присутствует общий модуль РаботаСАдресами, +// вызов данной функции будет автоматически перенаправлен в этот модуль. +// +// Параметры: +// Адреса - Массив из см. СведенияОбАдресе.Адрес +// ДополнительныеПараметры - см. СведенияОбАдресе.ДополнительныеПараметры +// +// Возвращаемое значение: +// Массив из см. СведенияОбАдресе +// +Функция СведенияОбАдресах(Адреса, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.СведенияОбАдресах(Адреса, ДополнительныеПараметры); +``` +
+ +## ПроверитьКонтактнуюИнформацию +
+ +Описание, пример вызова + +```bsl + + +// Проверяет контактную информацию. +// +// Параметры: +// Представление - Строка - представление контактной информации. Используется, если невозможно определить +// представление из параметра ЗначенияПолей (отсутствие поля Представление). +// ЗначенияПолей - Строка +// - Структура +// - Соответствие +// - СписокЗначений - описание полей контактной информации. +// ВидИнформации - СправочникСсылка.ВидыКонтактнойИнформации - используется для определения типа, если его невозможно +// определить по параметру ЗначенияПолей. +// ТипИнформации - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// ИмяРеквизита - Строка - имя реквизита на форме. +// Комментарий - Строка - текст комментария. +// ПутьКРеквизиту - Строка - путь к реквизиту. +// +// Возвращаемое значение: +// Число - уровень ошибок, 0 - ошибки отсутствуют. +// +Функция ПроверитьКонтактнуюИнформацию(Представление, ЗначенияПолей, ВидИнформации, ТипИнформации, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ПроверитьКонтактнуюИнформацию(Представление, ЗначенияПолей, ВидИнформации, ТипИнформации, ); +``` +
+ +## УстановитьСвойстваГруппыВидаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Устанавливает свойства группы контактной информации. +// +// Параметры: +// Параметры - Структура: +// * Код - Строка - код вида контактной информации для идентификации элемента. +// * Наименование - Строка - наименование вида контактной информации. +// * Имя - Строка - имя предопределенного вида контактной информации; +// * Используется - Булево - признак использования вида контактной информации. Значение по умолчанию Истина. +// +// Возвращаемое значение: +// СправочникСсылка.ВидыКонтактнойИнформации - ссылка на группу. +// +Функция УстановитьСвойстваГруппыВидаКонтактнойИнформации(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.УстановитьСвойстваГруппыВидаКонтактнойИнформации(Параметры) +``` +
+ +## УстановитьСвойстваВидаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Устанавливает свойства вида контактной информации. +// +// Примечание. При задании свойства Параметры.Порядок следует следить за уникальностью назначаемого значения. +// Если значения порядка окажутся неуникальными в пределах группы, то настройка +// порядка пользователем будет невозможна. В общем случае рекомендуется не +// использовать этот параметр (порядок не изменится), либо задавать значение 0. +// Для размещения видов КИ в нужной последовательности достаточно вызывать данную процедуру +// в нужной последовательности для каждого вида КИ с указанием порядка 0. +// Если предопределенный вид КИ добавляется к уже существующим в информационной базе, +// не рекомендуется назначать порядок в явном виде. +// +// +// Параметры: +// Параметры - см. ПараметрыВидаКонтактнойИнформации. +// +Процедура УстановитьСвойстваВидаКонтактнойИнформации(Параметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.УстановитьСвойстваВидаКонтактнойИнформации(Параметры) +``` +
+ +## ПараметрыГруппыВидаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров группы вида контактной информации. +// +// Параметры: +// ГруппаКонтактнойИнформации - СправочникСсылка.ВидыКонтактнойИнформации- группа контактной информации. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - уникальное имя вида контактной информации. +// * Наименование - Строка - наименование вида контактной информации. +// * Группа - СправочникСсылка.ВидыКонтактнойИнформации - ссылка на группу(родителя) элемента справочника. +// * Используется - Булево - признак использования вида контактной информации. Значение по умолчанию Истина. +// +Функция ПараметрыГруппыВидаКонтактнойИнформации(ГруппаКонтактнойИнформации = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ПараметрыГруппыВидаКонтактнойИнформации(ГруппаКонтактнойИнформации); +``` +
+ +## ПараметрыВидаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вида контактной информации для указанного типа. +// Для совместного использования с процедурами +// УправлениеКонтактнойИнформацией.УстановитьСвойстваВидаКонтактнойИнформации +// и УправлениеКонтактнойИнформациейКлиент.ОткрытьФормуКонтактнойИнформации. +// +// Параметры: +// ТипИлиВидКонтактнойИнформации - ПеречислениеСсылка.ТипыКонтактнойИнформации +// - Строка - тип контактной информации, +// - СправочникСсылка.ВидыКонтактнойИнформации - вид контактной информации для +// заполнения свойства НастройкиПроверки. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка - уникальное имя вида контактной информации, например "АдресКлиента". +// * Наименование - Строка - наименование вида контактной информации, например "Адрес клиента". +// * Вид - СправочникСсылка.ВидыКонтактнойИнформации +// - Строка - вид контактной информации или идентификатор предопределенного элемента. +// * Группа - СправочникСсылка.ВидыКонтактнойИнформации - группа (родитель) вида контактной информации. +// * Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// * Порядок - Число +// - Неопределено - положение в списке относительно других элементов в группе. +// Если Неопределено, то порядок не переназначается; +// 0 - порядок назначается автоматически; +// Число > 0 - указанный порядок (уникальное значение в пределах группы). +// * МожноИзменятьСпособРедактирования - Булево - признак возможности изменения свойств вида контактной информации пользователем. +// Если Ложь, то в форме вида контактной информации свойства доступны +// только для просмотра. Значение по умолчанию - Ложь. +// * ВидРедактирования - Строка - вид редактирования: "ПолеВводаИДиалог", "ПолеВвода", "Диалог". +// Если "Диалог", то форме выводится гиперссылка с представлением контактной +// информации, по нажатию на которую, открывается форма соответствующего типа КИ. +// Свойство применимо только для контактной информации с типом: Адрес, Телефон, Факс. +// Если "ПолеВвода", то на форме выводится поле ввода. +// Если "ПолеВводаИДиалог", то доступен ввод в поле и в форме соответствующего типа КИ. +// * ВидРедактирования - Строка - определят вид редактирования значения. Варианты: "ПолеВводаИДиалог", "ПолеВвода", "Диалог". +// Если "Диалог", то форме выводится гиперссылка с представлением контактной +// информации, по нажатию на которую, открывается форма соответствующего типа КИ. +// Свойство применимо только для контактной информации с типом: Адрес, Телефон, Факс. +// Если "ПолеВвода", то на форме выводится поле ввода. +// Если "ПолеВводаИДиалог", то доступен ввод в поле и в форме соответствующего типа КИ. +// * ХранитьИсториюИзменений - Булево - признак возможности хранения истории контактной информации. +// Хранение истории допускается, если признак ВидРедактирования = "Диалог" +// равен Истина. Свойство применимо если табличная часть КонтактнаяИнформация +// содержит реквизит ДействуетС. Значение по умолчанию - Ложь. +// * ОбязательноеЗаполнение - Булево - если Истина, то требуется обязательный ввод значения в поле на форме. +// Значение по умолчанию - Ложь. +// * РазрешитьВводНесколькихЗначений - Булево - признак возможности ввода нескольких значений для данного вида. +// Значение по умолчанию - Ложь. +// * ЗапретитьРедактированиеПользователем - Булево - признак недоступности редактирования пользователем +// вида контактной информации. Значение по умолчанию - Ложь. +// * Используется - Булево - если Ложь, то вид контактной информации недоступен для использования пользователем. +// Такой вид не выводится в формах и списке видов контактной информации. +// Значение по умолчанию - Истина. +// * МеждународныйФорматАдреса - Булево - если Истина, то ввод адресов возможен только в международном формате. +// Значение по умолчанию - Ложь. +// * ВидПоляДругое - Строка - определяет внешний вид поля с типом Другое на форме. +// Варианты: "МногострочноеШирокое", "ОднострочноеШирокое", "ОднострочноеУзкое". +// Значение по умолчанию - "ОднострочноеШирокое". +// * РедактированиеТолькоВДиалоге - Булево - устарело. Следует использовать ВидРедактирования. +// Если Истина, то форме выводится гиперссылка с представлением контактной +// информации по нажатию на которую, открывается форма соответствующего +// типа КИ. Свойство применимо только для контактной информации с типом - +// Адрес, Телефон, Факс, ВебСтраница. Значение по умолчанию - Ложь. +// * НастройкиПроверки - Неопределено - для типов Другое, ВебСтраница, Skype. +// - Структура: +// ** ТолькоНациональныйАдрес - Булево - для типа Адрес. Если Истина, то разрешается ввод только национальных адресов. +// Изменение страны у адреса не допускается. +// ** СкрыватьНеактуальныеАдреса - Булево - для типа Адрес. Если Истина, если не требуется показывать +// неактуальные адреса при вводе (только если ТолькоНациональныйАдрес = Истина). +// ** ПроверятьКорректность - Булево - для типа Адрес значение Истина, означает, что разрешено вводить адреса, +// проходящие проверку по адресному классификатору (ТолькоНациональныйАдрес = Истина). +// Допускается ввод адресов других стран в свободной форме, +// если свойство ТолькоНациональныйАдрес = Ложь. +// Для типа АдресЭлектроннойПочты при значении Истина запрещен ввод +// некорректных адресов электронной почты. +// Значение по умолчанию - Ложь. +// ** ВключатьСтрануВПредставление - Булево - для типа Адрес. если Истина, то Наименование страны всегда +// добавляется в представление адреса, даже когда другие поля адреса пустые. +// Значение по умолчанию - Ложь. +// ** УказыватьОКТМО - Булево - для типа Адрес. признак возможности ручного ввода кода ОКМТО в форме ввода адреса. +// ** ТелефонСДобавочнымНомером - Булево - для типа Телефон и Факс. Если Истина, то в форме ввода телефона +// доступен ввод добавочного номера. Значение по умолчанию - Истина. +// ** ВводитьНомерПоМаске - Булево - для типа Телефон или Факс. Если Истина, требуется ввод телефона по маске. +// ** МаскаНомераТелефона - Строка - для типа Телефон или Факс. Содержит посимвольную строку маски +// ввода текста в поле. +// +Функция ПараметрыВидаКонтактнойИнформации(ТипИлиВидКонтактнойИнформации = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ПараметрыВидаКонтактнойИнформации(ТипИлиВидКонтактнойИнформации); +``` +
+ +## ПараметрыАдреса +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вида контактной информации типа Адрес. +// Для совместного использования с процедурами +// УправлениеКонтактнойИнформацией.УстановитьСвойстваВидаКонтактнойИнформации +// и УправлениеКонтактнойИнформациейКлиент.ОткрытьФормуКонтактнойИнформации. +// +// Возвращаемое значение: +// см. ПараметрыВидаКонтактнойИнформации +// +Функция ПараметрыАдреса() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ПараметрыАдреса() +``` +
+ +## ПараметрыАдресаЭлектроннойПочты +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вида контактной информации типа АдресЭлектроннойПочты. +// Для совместного использования с процедурами +// УправлениеКонтактнойИнформацией.УстановитьСвойстваВидаКонтактнойИнформации +// и УправлениеКонтактнойИнформациейКлиент.ОткрытьФормуКонтактнойИнформации. +// +// Возвращаемое значение: +// см. ПараметрыВидаКонтактнойИнформации +// +Функция ПараметрыАдресаЭлектроннойПочты() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ПараметрыАдресаЭлектроннойПочты() +``` +
+ +## ПараметрыТелефона +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вида контактной информации типа Телефон. +// Для совместного использования с процедурами +// УправлениеКонтактнойИнформацией.УстановитьСвойстваВидаКонтактнойИнформации +// и УправлениеКонтактнойИнформациейКлиент.ОткрытьФормуКонтактнойИнформации. +// +// Возвращаемое значение: +// см. ПараметрыВидаКонтактнойИнформации +// +Функция ПараметрыТелефона() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ПараметрыТелефона() +``` +
+ +## ЗаписатьКонтактнуюИнформацию +
+ +Описание, пример вызова + +```bsl + +// Записывает контактную информацию из XML в поля табличной части Контактная информация объекта. +// +// Параметры: +// Объект - СправочникОбъект - объект конфигурации, содержащий табличную часть контактная информация. +// Значение - Строка - контактная информация в внутреннем формате JSON. +// ВидИнформации - СправочникСсылка.ВидыКонтактнойИнформации - ссылка на вид контактной информации. +// ТипИнформации - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// ИдентификаторСтроки - Число - идентификатор строки табличной части. +// Дата - Дата - дата, с которой действует запись контактной информации, +// используется при хранении истории изменения контактной информации. +// +Процедура ЗаписатьКонтактнуюИнформацию(Объект, Знач Значение, ВидИнформации, ТипИнформации, ИдентификаторСтроки = 0, Дата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ЗаписатьКонтактнуюИнформацию(Объект, Значение, ВидИнформации, ТипИнформации, ИдентификаторСтроки, Дата); +``` +
+ +## ОбновитьКонтактнуюИнформациюДляСписков +
+ +Описание, пример вызова + +```bsl + +// Обновляет представление контактной информации в служебном поле ВидДляСписка, +// используемое для вывода ее в динамических списках и отчетах. +// +// Параметры: +// Объект -ОпределяемыйТип.ВладелецКонтактнойИнформации - ссылка на объект конфигурации, содержащий табличную часть +// контактная информация. +// +Процедура ОбновитьКонтактнуюИнформациюДляСписков(Объект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ОбновитьКонтактнуюИнформациюДляСписков(Объект); +``` +
+ +## ОбновитьКонтактнуюИнформациюДляСписковОтложенно +
+ +Описание, пример вызова + +```bsl + +// Выполняет отложенное обновление контактной информации для списков. +// +// Параметры: +// Параметры - Структура - параметры обработчика обновления. +// РазмерПорции - Число - размер порции обрабатываемых данных за один запуск. +// +Процедура ОбновитьКонтактнуюИнформациюДляСписковОтложенно(Параметры, РазмерПорции = 1000) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.ОбновитьКонтактнуюИнформациюДляСписковОтложенно(Параметры, РазмерПорции); +``` +
+ +## СнятьПризнакПредопределенныйДляВидовКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Удаляет информацию о соответствии элемента справочника виде контактной информации предопределенному значению, +// которое помечено как удаленное. Для однократного вызова в обработчиках обновления по отказу от предопределенных +// элементов справочника ВидыКонтактнойИнформации. +// +Процедура СнятьПризнакПредопределенныйДляВидовКонтактнойИнформации() Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформацией.СнятьПризнакПредопределенныйДляВидовКонтактнойИнформации() +``` +
+ +## КонтактнаяИнформацияXMLПоПредставлению +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обратная совместимость. + +// Устарела. Следует использовать УправлениеКонтактнойИнформацией.КонтактнаяИнформацияПоПредставлению. +// Преобразует представление контактной информации в XML строку соответствующую структуре +// XDTO пакетам КонтактнаяИнформация и Адрес. +// Для адресов, введенных в свободной форме, корректное преобразование не гарантируется. +// +// Параметры: +// Представление - Строка - строковое представление контактной информации, выводимое пользователю. +// ОжидаемыйВид - СправочникСсылка.ВидыКонтактнойИнформации +// - ПеречислениеСсылка.ТипыКонтактнойИнформации +// - Структура - вид или тип контактной информации. +// +// Возвращаемое значение: +// Строка - контактная информация в виде XML, соответствующего структуре XDTO пакетов КонтактнаяИнформация и Адрес. +// +Функция КонтактнаяИнформацияXMLПоПредставлению(Представление, ОжидаемыйВид) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.КонтактнаяИнформацияXMLПоПредставлению(Представление, ОжидаемыйВид) +``` +
+ +## ОписаниеКоманд +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание команд, разбитое по типам контактной информации. +// Полученное соответствие используется в УправлениеКонтактнойИнформациейПереопределяемый.ПриОпределенииНастроек +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ПеречислениеСсылка.ТипыКонтактнойИнформации +// * Значение - см. КомандыТипаКонтактнойИнформации +// +Функция ОписаниеКоманд() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ОписаниеКоманд() +``` +
+ +## КомандыТипаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание команд, предназначенные для типа контактной информации, переданного в качестве параметра. +// Полученное соответствие используется в УправлениеКонтактнойИнформациейПереопределяемый.ПриОпределенииНастроек +// +// Параметры: +// Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации +// +// Возвращаемое значение: +// Структура - состав полей зависит от типа контактной информации. Для типа Адрес: ВвестиКомментарийКАдресу, +// ПоказатьНаКартеGoogle, ЗапланироватьВстречу, ПоказатьИсториюИзменений. +// Для типа Телефон: ПозвонитьПоТелефону, ОтправитьSMS, ПоказатьИсториюИзменений. +// Для типа Факс: ОтправитьФакс, ПоказатьИсториюИзменений. +// Для типа АдресЭлектронной почты: НаписатьЭлектронноеПисьмо. +// Для типа Skype: ПозвонитьSkype, НачатьЧатSkype. +// Для типа ВебСтраница: ОткрытьВебСтраницу. +// Для типа Другое: ОткрытьОкноДругое. +// Состав полей: +// * ВвестиКомментарийКАдресу - см. ОписаниеКомандыПоИмени +// * ПоказатьНаКартеGoogle - см. ОписаниеКомандыПоИмени +// * ЗапланироватьВстречу - см. ОписаниеКомандыПоИмени +// * ПоказатьИсториюИзменений - см. ОписаниеКомандыПоИмени +// * ПозвонитьПоТелефону - см. ОписаниеКомандыПоИмени +// * ОтправитьSMS - см. ОписаниеКомандыПоИмени +// * ОтправитьФакс - см. ОписаниеКомандыПоИмени +// * НаписатьЭлектронноеПисьмо - см. ОписаниеКомандыПоИмени +// * ПозвонитьSkype - см. ОписаниеКомандыПоИмени +// * НачатьЧатSkype - см. ОписаниеКомандыПоИмени +// * ОткрытьВебСтраницу - см. ОписаниеКомандыПоИмени +// * ОткрытьОкноДругое - см. ОписаниеКомандыПоИмени +// +Функция КомандыТипаКонтактнойИнформации(Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.КомандыТипаКонтактнойИнформации(Тип) +``` +
+ +## ОписаниеКомандыПоИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру с описанием команды контактной информации. +// Полученное соответствие используется в УправлениеКонтактнойИнформациейПереопределяемый.ПриОпределенииНастроек +// +// Параметры: +// ИмяКоманды - Строка - имя команды, описание которой нужно получить. +// +// Возвращаемое значение: +// см. СвойстваКоманды +// +Функция ОписаниеКомандыПоИмени(ИмяКоманды) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.ОписаниеКомандыПоИмени(ИмяКоманды) +``` +
+ +## СвойстваКоманды +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру для описания команд контактной информации. +// Полученная структура используется в УправлениеКонтактнойИнформациейПереопределяемый.ПриОпределенииНастроек +// +// Параметры: +// Заголовок - Строка - заголовок команды. +// Подсказка - Строка - подсказка команды. +// Картинка - Картинка - картинка команды. +// Действие - Строка - полный путь к процедуре, которую необходимо выполнить. +// Например, "СтандартныеПодсистемыКлиент.ОткрытьФормуДокументаВстреча". +// ИзменяетСохраняемыеДанные - Булево +// +// Возвращаемое значение: +// Структура: +// * Заголовок - Строка +// * Подсказка - Строка +// * Картинка - Картинка +// * Действие - Строка +// * ИзменяетСохраняемыеДанные - Булево +// +Функция СвойстваКоманды(Заголовок, Подсказка, Картинка = "", Действие = "", ИзменяетСохраняемыеДанные = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформацией.СвойстваКоманды(Заголовок, Подсказка, Картинка, Действие, ИзменяетСохраняемыеДанные); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиент.md b/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиент.md new file mode 100644 index 0000000..141df5b --- /dev/null +++ b/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиент.md @@ -0,0 +1,835 @@ +--- +title: Управление контактной информацией клиент +slug: bsp/управление-контактной-информацией-клиент +--- + + +## НачатьВыбор +
+ +Описание, пример вызова + +```bsl + +// Обработчик события НачалоВыбора поля формы контактной информации. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// Элемент - ПолеФормы - элемент формы, содержащий представление контактной информации. +// Модифицированность - Булево - устанавливаемый флаг модифицированности формы. +// СтандартнаяОбработка - Булево - устанавливаемый флаг стандартной обработки события формы. +// ПараметрыОткрытия - Структура - параметры открытия формы ввода контактной информации. +// +Процедура НачатьВыбор(Форма, Элемент, Модифицированность = Истина, СтандартнаяОбработка = Ложь, ПараметрыОткрытия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.НачатьВыбор(Форма, Элемент, Модифицированность, СтандартнаяОбработка, ПараметрыОткрытия); +``` +
+ +## НачатьИзменение +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриИзменении поля формы контактной информации. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// Элемент - ПолеФормы - элемент формы, содержащий представление контактной информации. +// ЭтоТабличнаяЧасть - Булево - флаг того, что элемент является частью таблицы формы. +// +Процедура НачатьИзменение(Форма, Элемент, ЭтоТабличнаяЧасть = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.НачатьИзменение(Форма, Элемент, ЭтоТабличнаяЧасть); +``` +
+ +## НачатьОчистку +
+ +Описание, пример вызова + +```bsl + +// Обработчик события Очистка поля формы контактной информации. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// ИмяРеквизита - Строка - имя реквизита формы, связанного с представление контактной информации. +// +Процедура НачатьОчистку(Знач Форма, Знач ИмяРеквизита) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.НачатьОчистку(Форма, ИмяРеквизита) +``` +
+ +## НачатьВыполнениеКоманды +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды, связанной с контактной информацией (написать письмо, открыть адрес, и т.п.). +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// ИмяКоманды - Строка - имя автоматически сгенерированной команды действия. +// +Процедура НачатьВыполнениеКоманды(Знач Форма, Знач ИмяКоманды) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.НачатьВыполнениеКоманды(Форма, ИмяКоманды) +``` +
+ +## НачатьОбработкуНавигационнойСсылки +
+ +Описание, пример вызова + +```bsl + +// Обработчик навигационной ссылки для открытия веб-страницы. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// Элемент - ПолеФормы - элемент формы, содержащий представление контактной информации. +// НавигационнаяСсылкаФорматированнойСтроки - Строка - значение гиперссылки форматированной строки. Параметр +// передается по ссылке. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной +// системной) обработки события. Если в теле процедуры-обработчика +// установить данному параметру значение Ложь, стандартная обработка события +// производиться не будет. +// +Процедура НачатьОбработкуНавигационнойСсылки(Форма, Элемент, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.НачатьОбработкуНавигационнойСсылки(Форма, Элемент, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) +``` +
+ +## ОбработкаНавигационнойСсылки +
+ +Описание, пример вызова + +```bsl + +// Обработчик навигационной ссылки для открытия веб-страницы. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// Элемент - ПолеФормы - элемент формы, содержащий представление контактной информации. +// НавигационнаяСсылкаФорматированнойСтроки - Строка - значение гиперссылки форматированной строки. Параметр +// передается по ссылке. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной +// системной) обработки события. Если в теле процедуры-обработчика +// установить данному параметру значение Ложь, стандартная обработка события +// производиться не будет. +// +Процедура ОбработкаНавигационнойСсылки(Форма, Элемент, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ОбработкаНавигационнойСсылки(Форма, Элемент, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) +``` +
+ +## АвтоПодборАдреса +
+ +Описание, пример вызова + +```bsl + +// Обработчик события АвтоПодбор поля формы контактной информации для подбора вариантов адреса по введенной строке. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Элемент - ПолеФормы - элемент формы, содержащий представление контактной информации. +// Текст - Строка - строка текста, введенная пользователем в поле контактной информации. +// ДанныеВыбора - СписокЗначений - содержит список значений, который будет использован при стандартной +// обработке события. +// ПараметрыПолученияДанных - Структура +// - Неопределено - содержит параметры поиска, которые будут переданы +// в метод ПолучитьДанныеВыбора. Подробнее см. описание расширения поля формы для +// поля ввода АвтоПодбор в синтакс-помощнике. +// Ожидание - Число - интервал в секундах после ввода текста, через который произошло событие. +// Если 0, то это означает, что событие было вызвано не по поводу ввода текста, +// а для формирования списка быстрого выбора. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной +// системной) обработки события. Если в теле процедуры-обработчика +// установить данному параметру значение Ложь, стандартная обработка события +// производиться не будет. +// +Процедура АвтоПодборАдреса(Элемент, Текст, ДанныеВыбора, ПараметрыПолученияДанных, Ожидание, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.АвтоПодборАдреса(Элемент, Текст, ДанныеВыбора, ПараметрыПолученияДанных, Ожидание, СтандартнаяОбработка) +``` +
+ +## ОбработкаВыбора +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ОбработкаВыбора поля формы контактной информации. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// ВыбранноеЗначение - Строка - выбранное значение, которое будет установлено как значение поля ввода +// контактной информации. +// ИмяРеквизита - Строка - имя реквизита формы, связанного с представление контактной информации. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной +// (системной) обработки события. Если в теле процедуры-обработчика +// установить данному параметру значение Ложь, стандартная обработка события +// производиться не будет. +// +Процедура ОбработкаВыбора(Знач Форма, Знач ВыбранноеЗначение, Знач ИмяРеквизита, СтандартнаяОбработка = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ОбработкаВыбора(Форма, ВыбранноеЗначение, ИмяРеквизита, СтандартнаяОбработка); +``` +
+ +## ОткрытьФормуВводаАдреса +
+ +Описание, пример вызова + +```bsl + +// Открытие формы адреса формы контактной информации. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// Результат - Произвольный - данные, переданные обработчиком команды. +// +Процедура ОткрытьФормуВводаАдреса(Форма, Результат) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ОткрытьФормуВводаАдреса(Форма, Результат) +``` +
+ +## КонтрольОбновленияФормы +
+ +Описание, пример вызова + +```bsl + +// Обработчик возможного обновления формы контактной информации. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// Результат - Произвольный - данные, переданные обработчиком команды. +// +Процедура КонтрольОбновленияФормы(Форма, Результат) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.КонтрольОбновленияФормы(Форма, Результат) +``` +
+ +## СтранаМираОбработкаВыбора +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ОбработкаВыбора страны мира. +// Реализует функционал автоматического заведения элемента справочника СтраныМира после выбора. +// +// Параметры: +// Элемент - ПолеФормы - элемент, содержащий редактируемую страну мира. +// ВыбранноеЗначение - Произвольный - значение выбора. +// СтандартнаяОбработка - Булево - устанавливаемый флаг стандартной обработки события формы. +// +Процедура СтранаМираОбработкаВыбора(Элемент, ВыбранноеЗначение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.СтранаМираОбработкаВыбора(Элемент, ВыбранноеЗначение, СтандартнаяОбработка) +``` +
+ +## ПараметрыФормыКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Конструктор для параметров открытия формы контактной информации в ОткрытьФормуКонтактнойИнформации. +// Состав полей может быть расширен в общем модуле РаботаСАдресамиКлиент свойствами с национальной спецификой. +// +// Параметры: +// ВидКонтактнойИнформации - СправочникСсылка.ВидыКонтактнойИнформации - вид редактируемой контактной информации. +// - см. УправлениеКонтактнойИнформацией.ПараметрыВидаКонтактнойИнформации +// Значение - Строка - сериализованное значение полей контактной информации в формате JSON или XML. +// Представление - Строка - представление контактной информации. +// Комментарий - Строка - комментарий контактной информации. +// ТипКонтактнойИнформации - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// Если указан, то в возвращаемую структуру добавляются поля соответствующие типу. +// +// Возвращаемое значение: +// Структура: +// * ВидКонтактнойИнформации - см. УправлениеКонтактнойИнформацией.ПараметрыВидаКонтактнойИнформации +// * ТолькоПросмотр - Булево - если Истина, то форма будет открыта в режиме только просмотра. +// * Значение - Строка - значение полей контактной информации в формате JSON или XML. +// * Представление - Строка - представление контактной информации. +// * ТипКонтактнойИнформации - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации, если был указан +// в параметрах. +// * Страна - Строка - страна мира, только если указан тип контактной информации Адрес. +// * Регион - Строка - значение поля региона, только если указан тип контактной информации Адрес. +// Актуально для стран ЕАЭС. +// * Индекс - Строка - почтовый индекс, только если указан тип контактной информации Адрес. +// * ТипПомещения - Строка - тип помещения в форме ввода нового адреса, , только если указан тип контактной +// информации Адрес. +// * КодСтраны - Строка - телефонный код страны мира, только если указан тип контактной информации Телефон. +// * КодГорода - Строка - телефонный код города, только если указан тип контактной информации Телефон. +// * НомерТелефона - Строка - телефонный номер, только если указан тип контактной информации Телефон. +// * Добавочный - Строка - добавочный телефонный номер, только если указан тип контактной информации Телефон. +// * Заголовок - Строка - заголовок формы. По умолчанию, представление вида контактной информации. +// * ТипАдреса - Строка - варианты: Пустая строка (по умолчанию), "ВСвободнойФорме", "ЕАЭС"; +// Для РФ: "Муниципальный" или "АдминистративноТерриториальный". +// Если не указан (пустая строка), то для существующего адреса будет установлен адрес +// выбранный пользователем в форме ввода адреса, для нового адреса - Муниципальный". +// +Функция ПараметрыФормыКонтактнойИнформации(ВидКонтактнойИнформации, Значение, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиент.ПараметрыФормыКонтактнойИнформации(ВидКонтактнойИнформации, Значение, ); +``` +
+ +## ОткрытьФормуКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Открывает соответствующую форму для просмотра и ввода контактной информации. +// +// Параметры: +// Параметры - см. ПараметрыФормыКонтактнойИнформации +// Владелец - Произвольный - параметр для открываемой формы. +// Оповещение - ОписаниеОповещения - для обработки закрытия формы. +// +// Возвращаемое значение: +// ФормаКлиентскогоПриложения +// +Функция ОткрытьФормуКонтактнойИнформации(Параметры, Владелец = Неопределено, Оповещение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиент.ОткрытьФормуКонтактнойИнформации(Параметры, Владелец, Оповещение); +``` +
+ +## СоздатьЭлектронноеПисьмо +
+ +Описание, пример вызова + +```bsl + +// Создает письмо по контактной информации. +// +// Параметры: +// ЗначенияПолей - Строка +// - Структура +// - Соответствие +// - СписокЗначений - значение контактной информации. +// ПараметрыПисьма - см. ПараметрыПисьмаSMS +// УдалитьОжидаемыйВид - СправочникСсылка.ВидыКонтактнойИнформации +// - ПеречислениеСсылка.ТипыКонтактнойИнформации +// - Структура - устарело, следует использовать ПараметрыПисьма. +// УдалитьИсточникКонтактнойИнформации - ЛюбаяСсылка - устарело, следует использовать ПараметрыПисьма. +// УдалитьИмяРеквизита - Строка - устарело, следует использовать ПараметрыПисьма. +// +Процедура СоздатьЭлектронноеПисьмо(Знач ЗначенияПолей, Знач ПараметрыПисьма = Неопределено, Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.СоздатьЭлектронноеПисьмо(ЗначенияПолей, ПараметрыПисьма, ); +``` +
+ +## СоздатьSMS +
+ +Описание, пример вызова + +```bsl + +// Создает сообщение SMS по контактной информации. +// +// Параметры: +// ЗначенияПолей - Строка +// - Структура +// - Соответствие +// - СписокЗначений - контактная информация. +// ПараметрыSMS - см. ПараметрыПисьмаSMS +// УдалитьОжидаемыйВид - СправочникСсылка.ВидыКонтактнойИнформации +// - ПеречислениеСсылка.ТипыКонтактнойИнформации +// - Структура - устарело, следует использовать ПараметрыSMS. +// УдалитьИсточникКонтактнойИнформации - ЛюбаяСсылка - устарело, следует использовать ПараметрыSMS. +// +Процедура СоздатьSMS(Знач ЗначенияПолей, Знач ПараметрыSMS = Неопределено, Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.СоздатьSMS(ЗначенияПолей, ПараметрыSMS, ); +``` +
+ +## ПараметрыПисьмаSMS +
+ +Описание, пример вызова + +```bsl + +// Конструктор для параметров процедур СоздатьЭлектронноеПисьмо и СоздатьSMS. +// +// Возвращаемое значение: +// Структура: +// * Представление - Строка - представление контактной информации. Используется, если невозможно определить +// представление из параметра. ЗначенияПолей (отсутствие поля Представление). +// * ОжидаемыйВид - СправочникСсылка.ВидыКонтактнойИнформации +// - ПеречислениеСсылка.ТипыКонтактнойИнформации +// - Структура - для определения типа, если его невозможно вычислить по ЗначенияПолей. +// * ИсточникКонтактнойИнформации - ЛюбаяСсылка - объект-владелец контактной информации. +// * ИмяРеквизита - Строка - имя реквизита вызывающей формы, в которой нужно привязать сообщение об ошибке. +// Если не задано, то сообщение выводится в виде окна с предупреждением. +// +Функция ПараметрыПисьмаSMS() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиент.ПараметрыПисьмаSMS() +``` +
+ +## ПозвонитьПоТелефону +
+ +Описание, пример вызова + +```bsl + +// Совершает звонок на переданный номер телефона по SIP телефонии, +// а если она не доступна, то с использованием программы Skype. +// +// Параметры: +// НомерТелефона -Строка - номер телефона, на который будет осуществлен звонок. +// +Процедура ПозвонитьПоТелефону(НомерТелефона) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ПозвонитьПоТелефону(НомерТелефона) +``` +
+ +## ПозвонитьНаSkype +
+ +Описание, пример вызова + +```bsl + +// Совершает звонок в программе Skype. +// +// Параметры: +// ЛогинSkype - Строка - логин Skype. +// +Процедура ПозвонитьНаSkype(ЛогинSkype) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ПозвонитьНаSkype(ЛогинSkype) +``` +
+ +## НачатьБеседуВSkype +
+ +Описание, пример вызова + +```bsl + +// Открыть окно беседы(чат) в программе Skype +// +// Параметры: +// ЛогинSkype - Строка - логин Skype. +// +Процедура НачатьБеседуВSkype(ЛогинSkype) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.НачатьБеседуВSkype(ЛогинSkype) +``` +
+ +## ПерейтиПоВебСсылке +
+ +Описание, пример вызова + +```bsl + +// Открывает ссылку по контактной информации. +// +// Параметры: +// ЗначенияПолей - Строка +// - Структура +// - Соответствие +// - СписокЗначений - контактная информация. +// Представление - Строка - представление. Используется, если невозможно определить представление из параметра. +// ЗначенияПолей (отсутствие поля "Представление"). +// ОжидаемыйВид - СправочникСсылка.ВидыКонтактнойИнформации +// - ПеречислениеСсылка.ТипыКонтактнойИнформации +// - Структура - +// Используется для определения типа, если его невозможно вычислить по полю ЗначенияПолей. +// +Процедура ПерейтиПоВебСсылке(Знач ЗначенияПолей, Знач Представление = "", ОжидаемыйВид = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ПерейтиПоВебСсылке(ЗначенияПолей, Представление, ОжидаемыйВид); +``` +
+ +## ПоказатьАдресНаКарте +
+ +Описание, пример вызова + +```bsl + +// Отображает адрес в браузере с помощью интерактивных карт. Например на Google Maps. +// +// Параметры: +// Адрес - Строка - текстовое представление адреса. +// ИмяКартографическогоСервиса - Строка - имя картографического сервиса, в котором необходимо показать адрес. +// Например, GoogleMaps. +// +Процедура ПоказатьАдресНаКарте(Адрес, ИмяКартографическогоСервиса) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ПоказатьАдресНаКарте(Адрес, ИмяКартографическогоСервиса) +``` +
+ +## ОткрытьФормуИсторииИзменений +
+ +Описание, пример вызова + +```bsl + +// Отображает форму с историей изменения контактной информации. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма с контактной информацией. +// ПараметрыКонтактнойИнформации - Структура - сведения об элементе контактной информации. +// АсинхронныйВызов - Булево - служебный параметр. +// +Процедура ОткрытьФормуИсторииИзменений(Форма, ПараметрыКонтактнойИнформации, АсинхронныйВызов = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ОткрытьФормуИсторииИзменений(Форма, ПараметрыКонтактнойИнформации, АсинхронныйВызов); +``` +
+ +## НачалоВыбора +
+ +Описание, пример вызова + +```bsl + +// Синхронные обработчики + +// Обработчик события НачалоВыбора поля формы контактной информации. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// Элемент - ПолеФормы - элемент формы, содержащий представление контактной информации. +// Модифицированность - Булево - устанавливаемый флаг модифицированности формы. +// СтандартнаяОбработка - Булево - устанавливаемый флаг стандартной обработки события формы. +// ПараметрыОткрытия - Структура - параметры открытия формы ввода контактной информации. +// +Процедура НачалоВыбора(Форма, Элемент, Модифицированность = Истина, СтандартнаяОбработка = Ложь, ПараметрыОткрытия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.НачалоВыбора(Форма, Элемент, Модифицированность, СтандартнаяОбработка, ПараметрыОткрытия); +``` +
+ +## Очистка +
+ +Описание, пример вызова + +```bsl + +// Обработчик события Очистка поля формы контактной информации. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// ИмяРеквизита - Строка - имя реквизита формы, связанного с представление контактной информации. +// +Процедура Очистка(Знач Форма, Знач ИмяРеквизита) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.Очистка(Форма, ИмяРеквизита) +``` +
+ +## ВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды, связанной с контактной информацией (написать письмо, открыть адрес, и т.п.). +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// ИмяКоманды - Строка - имя автоматически сгенерированной команды действия. +// +Процедура ВыполнитьКоманду(Знач Форма, Знач ИмяКоманды) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ВыполнитьКоманду(Форма, ИмяКоманды) +``` +
+ +## ПриИзменении +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриИзменении поля формы контактной информации. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// Элемент - ПолеФормы - элемент формы, содержащий представление контактной информации. +// ЭтоТабличнаяЧасть - Булево - флаг того, что элемент является частью таблицы формы. +// +Процедура ПриИзменении(Форма, Элемент, ЭтоТабличнаяЧасть = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ПриИзменении(Форма, Элемент, ЭтоТабличнаяЧасть); +``` +
+ +## АвтоПодбор +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать АвтоПодборАдреса. +// Обработчик события АвтоПодбор поля формы контактной информации. +// Вызывается из подключаемых действий при внедрении подсистемы "Контактная информация". +// +// Параметры: +// Текст - Строка - строка текста, введенная пользователем в поле контактной информации. +// ДанныеВыбора - СписокЗначений - содержит список значений, который будет использован при стандартной +// обработке события. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной +// (системной) обработки события. Если в теле процедуры-обработчика +// установить данному параметру значение Ложь, стандартная обработка события +// производиться не будет. +// +Процедура АвтоПодбор(Знач Текст, ДанныеВыбора, СтандартнаяОбработка = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.АвтоПодбор(Текст, ДанныеВыбора, СтандартнаяОбработка); +``` +
+ +## ПредставлениеПриИзменении +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ПриИзменении. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// Элемент - ПолеФормы - элемент формы, содержащий представление контактной информации. +// ЭтоТабличнаяЧасть - Булево - флаг того, что элемент является частью таблицы формы. +// +Процедура ПредставлениеПриИзменении(Форма, Элемент, ЭтоТабличнаяЧасть = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиент.ПредставлениеПриИзменении(Форма, Элемент, ЭтоТабличнаяЧасть); +``` +
+ +## ПредставлениеНачалоВыбора +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать НачалоВыбора. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// Элемент - ПолеФормы - элемент формы, содержащий представление контактной информации. +// Модифицированность - Булево - устанавливаемый флаг модифицированности формы. +// СтандартнаяОбработка - Булево - устанавливаемый флаг стандартной обработки события формы. +// +// Возвращаемое значение: +// Неопределено - не используется, обратная совместимость. +// +Функция ПредставлениеНачалоВыбора(Форма, Элемент, Модифицированность = Истина, СтандартнаяОбработка = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиент.ПредставлениеНачалоВыбора(Форма, Элемент, Модифицированность, СтандартнаяОбработка); +``` +
+ +## ПредставлениеОчистка +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать Очистка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// ИмяРеквизита - Строка - имя реквизита формы, связанного с представление контактной информации. +// +// Возвращаемое значение: +// Неопределено - не используется, обратная совместимость. +// +Функция ПредставлениеОчистка(Форма, ИмяРеквизита) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиент.ПредставлениеОчистка(Форма, ИмяРеквизита) +``` +
+ +## ПодключаемаяКоманда +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ВыполнитьКоманду. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца контактной информации. +// ИмяКоманды - Строка - имя автоматически сгенерированной команды действия. +// +// Возвращаемое значение: +// Неопределено - не используется, обратная совместимость. +// +Функция ПодключаемаяКоманда(Форма, ИмяКоманды) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиент.ПодключаемаяКоманда(Форма, ИмяКоманды) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиентЛокализация.md b/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиентЛокализация.md new file mode 100644 index 0000000..cf2e149 --- /dev/null +++ b/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиентЛокализация.md @@ -0,0 +1,84 @@ +--- +title: Управление контактной информацией клиент локализация +slug: bsp/управление-контактной-информацией-клиент-локализация +--- + + +## ПриОпределенииURLКартографическогоСервиса +
+ +Описание, пример вызова + +```bsl + +// При определении адрес ресурса(URL) картографического сервиса. +// +// Параметры: +// ИмяКартографическогоСервиса - Строка - Имя картографического сервиса; +// АдресРесурса - Строка - адрес ресурса в интернете, ведущий на картографический сайт. В АдресРесурса необходимо обязательно +// указать параметр %1, куда будет подставлен искомый адрес для отображения на карте. +// Например: https://www.openstreetmap.org/search?query=%1. +// +Процедура ПриОпределенииURLКартографическогоСервиса(ИмяКартографическогоСервиса, АдресРесурса) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиентЛокализация.ПриОпределенииURLКартографическогоСервиса(ИмяКартографическогоСервиса, АдресРесурса) +``` +
+ +## ПоказатьАдресНаКартеЯндекс +
+ +Описание, пример вызова + +```bsl + +// Показать адрес на карте Яндекс. +// +// Параметры: +// КонтактнаяИнформация - см. УправлениеКонтактнойИнформациейКлиент.ПараметрКонтактнаяИнформацияДляВыполненияКоманд +// ДополнительныеПараметры - см. УправлениеКонтактнойИнформациейКлиент.ДополнительныеПараметрыДляВыполненияКоманд +// +Процедура ПоказатьАдресНаКартеЯндекс(КонтактнаяИнформация, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиентЛокализация.ПоказатьАдресНаКартеЯндекс(КонтактнаяИнформация, ДополнительныеПараметры) +``` +
+ +## ПриОпределенииПорядкаПолейАдреса +
+ +Описание, пример вызова + +```bsl + +// Определяет очередность полей в представлении адреса. +// Вызывается только в международной поставке. +// +// Параметры: +// ПорядокПолей - Массив - набор полей в нужном порядке. Например, "area", "ZIPcode", "city". +// Страна - СправочникСсылка.СтраныМира - ссылка на справочник стран мира +// ВключатьСтрануВПредставление - Булево - Истина, если в настройках вида контактной информации установлен признак +// включения страны в представление адреса. +// +Процедура ПриОпределенииПорядкаПолейАдреса(ПорядокПолей, Страна, ВключатьСтрануВПредставление) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиентЛокализация.ПриОпределенииПорядкаПолейАдреса(ПорядокПолей, Страна, ВключатьСтрануВПредставление) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиентСервер.md b/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиентСервер.md new file mode 100644 index 0000000..7a6bc5b --- /dev/null +++ b/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиентСервер.md @@ -0,0 +1,191 @@ +--- +title: Управление контактной информацией клиент сервер +slug: bsp/управление-контактной-информацией-клиент-сервер +--- + + +## СформироватьПредставлениеТелефона +
+ +Описание, пример вызова + +```bsl + +// Формирует строковое представление телефона. +// +// Параметры: +// КодСтраны - Строка - код страны. +// КодГорода - Строка - код города. +// НомерТелефона - Строка - номер телефона. +// Добавочный - Строка - добавочный номер. +// Комментарий - Строка - комментарий. +// +// Возвращаемое значение: +// - Строка - представление телефона. +// +Функция СформироватьПредставлениеТелефона(КодСтраны, КодГорода, НомерТелефона, Добавочный, Комментарий) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиентСервер.СформироватьПредставлениеТелефона(КодСтраны, КодГорода, НомерТелефона, Добавочный, Комментарий) +``` +
+ +## ЭтоКонтактнаяИнформацияВXML +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, является ли строка данных контактной информации XML данными. +// +// Параметры: +// Текст - Строка - проверяемая строка. +// +// Возвращаемое значение: +// Булево - результат проверки. +// +Функция ЭтоКонтактнаяИнформацияВXML(Знач Текст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиентСервер.ЭтоКонтактнаяИнформацияВXML(Текст) +``` +
+ +## ЭтоКонтактнаяИнформацияВJSON +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, является ли строка данных контактной информации JSON данными. +// +// Параметры: +// Текст - Строка - проверяемая строка. +// +// Возвращаемое значение: +// Булево - результат проверки. +// +Функция ЭтоКонтактнаяИнформацияВJSON(Знач Текст) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиентСервер.ЭтоКонтактнаяИнформацияВJSON(Текст) +``` +
+ +## ТекстПустогоАдресаВВидеГиперссылки +
+ +Описание, пример вызова + +```bsl + +// Текст, который выводится в поле контактной информации, когда контактная информация не заполнена и отображается в виде +// гиперссылки. +// +// Возвращаемое значение: +// Строка - текст, который выводится в поле с контактной информацией. +// +Функция ТекстПустогоАдресаВВидеГиперссылки() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиентСервер.ТекстПустогоАдресаВВидеГиперссылки() +``` +
+ +## КонтактнаяИнформацияЗаполнена +
+ +Описание, пример вызова + +```bsl + +// Определяет, введена ли информация в поле контактной информации, для случаев когда она отображается в виде гиперссылки. +// +// Параметры: +// Значение - Строка - значение контактной информации. +// +// Возвращаемое значение: +// Булево - если Истина, то поле контактной информации было заполнено. +// +Функция КонтактнаяИнформацияЗаполнена(Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиентСервер.КонтактнаяИнформацияЗаполнена(Значение) +``` +
+ +## СформироватьПредставлениеАдреса +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеКонтактнойИнформацией.ПредставлениеКонтактнойИнформации +// Формирует представление с указанным видом для формы ввода адреса. +// +// Параметры: +// СтруктураАдреса - Структура - адрес в виде структуры. +// Описание структуры см. в функции РаботаСАдресами.СведенияОбАдресе. +// Описание предыдущей версии структуры см. в функции РаботаСАдресами.ПредыдущаяСтруктураКонтактнойИнформацииXML. +// Представление - Строка - представление адреса. +// НаименованиеВида - Строка - наименование вида. +// +// Возвращаемое значение: +// Строка - представление адреса с видом. +// +Функция СформироватьПредставлениеАдреса(СтруктураАдреса, Представление, НаименованиеВида = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиентСервер.СформироватьПредставлениеАдреса(СтруктураАдреса, Представление, НаименованиеВида); +``` +
+ +## СтруктураКонтактнойИнформацииПоТипу +
+ +Описание, пример вызова + +```bsl + +// Устарела. Для получения адреса следует использовать РаботаСАдресами.СведенияОбАдресе, +// для получения структуры телефона или факса УправлениеКонтактнойИнформацией.СведенияОТелефоне. +// Возвращает структуру контактной информации по типу. +// +// Параметры: +// ТипКИ - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// ФорматАдреса - Строка - не используется, оставлен для обратной совместимости. +// +// Возвращаемое значение: +// Структура - пустая структура контактной информации, ключи - имена полей, значения поля. +// +Функция СтруктураКонтактнойИнформацииПоТипу(ТипКИ, ФорматАдреса = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеКонтактнойИнформациейКлиентСервер.СтруктураКонтактнойИнформацииПоТипу(ТипКИ, ФорматАдреса); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиентСерверЛокализация.md b/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиентСерверЛокализация.md new file mode 100644 index 0000000..cd962c4 --- /dev/null +++ b/src/content/docs/bsp/УправлениеКонтактнойИнформациейКлиентСерверЛокализация.md @@ -0,0 +1,35 @@ +--- +title: Управление контактной информацией клиент сервер локализация +slug: bsp/управление-контактной-информацией-клиент-сервер-локализация +--- + + +## ПриОпределенияДействияКомандыТипаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// При определении вида действия команды типа контактной информации. +// +// Параметры: +// Действие - Строка - действие команды +// ВидДействия - Строка - вид действия команды. Например, "ПоказатьНаКарте". +// +Процедура ПриОпределенияДействияКомандыТипаКонтактнойИнформации(Действие, ВидДействия) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейКлиентСерверЛокализация.ПриОпределенияДействияКомандыТипаКонтактнойИнформации(Действие, ВидДействия) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеКонтактнойИнформациейЛокализация.md b/src/content/docs/bsp/УправлениеКонтактнойИнформациейЛокализация.md new file mode 100644 index 0000000..377ff9b --- /dev/null +++ b/src/content/docs/bsp/УправлениеКонтактнойИнформациейЛокализация.md @@ -0,0 +1,397 @@ +--- +title: Управление контактной информацией локализация +slug: bsp/управление-контактной-информацией-локализация +--- + + +## ПриОпределениеКомандТипаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание команд, предназначенные для типа контактной информации, переданного в качестве параметра. +// Полученное соответствие используется в УправлениеКонтактнойИнформациейПереопределяемый.ПриОпределенииНастроек. +// КомандыТипа - выходной параметр. +// +// Параметры: +// КомандыТипа - Структура: +// * Ключ - Строка - имя команды, например "ПоказатьНаКарте". +// * Значение - см. УправлениеКонтактнойИнформацией.СвойстваКоманды +// Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// +Процедура ПриОпределениеКомандТипаКонтактнойИнформации(КомандыТипа, Тип) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриОпределениеКомандТипаКонтактнойИнформации(КомандыТипа, Тип) +``` +
+ +## ПриКонвертированииКонтактнуюИнформациюИзJSONВXML +
+ +Описание, пример вызова + +```bsl + +// Преобразует контактную информацию из формата JSON в формат XML. +// +// Параметры: +// КонтактнаяИнформацияВJSON - Строка - контактная информация во внутреннем формате JSON. +// КонтактнаяИнформацияВXML - Строка - выходной параметр. Контактная информация в формате XML. +// ОжидаемыйТип - ПеречислениеСсылка.ТипыКонтактнойИнформации - используется для определения типа, +// если его невозможно вычислить автоматически по данным JSON. +// +Процедура ПриКонвертированииКонтактнуюИнформациюИзJSONВXML(Знач КонтактнаяИнформацияВJSON, КонтактнаяИнформацияВXML, ОжидаемыйТип = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриКонвертированииКонтактнуюИнформациюИзJSONВXML(КонтактнаяИнформацияВJSON, КонтактнаяИнформацияВXML, ОжидаемыйТип); +``` +
+ +## ПриКонвертированииКонтактнойИнформацииИзXML +
+ +Описание, пример вызова + +```bsl + +// При конвертировании контактной информации из XML в объекта XDTO. +// +// Параметры: +// Текст - Строка - контактная информация во формате XML +// КонтактнаяИнформация - ОбъектXDTO - выходной параметр. Контактная информация в формате объекта XDTO. +// ОжидаемыйВид - ПеречислениеСсылка.ТипыКонтактнойИнформации - ожидаемый вид типа контактной информации. +// РезультатПреобразования - Структура: +// * СведенияИсправлены - Булево - Истина, если сведения были скорректированы +// - Неопределено - преобразование не выполнялось. +// НастройкиКонвертации - см. УправлениеКонтактнойИнформацией.НастройкиКонвертацииКонтактнойИнформации +// +Процедура ПриКонвертированииКонтактнойИнформацииИзXML(Знач Текст, КонтактнаяИнформация, Знач ОжидаемыйВид = Неопределено, РезультатПреобразования = Неопределено, НастройкиКонвертации = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриКонвертированииКонтактнойИнформацииИзXML(Текст, КонтактнаяИнформация, ОжидаемыйВид, РезультатПреобразования, НастройкиКонвертации); +``` +
+ +## ПриКонвертированииКонтактнойИнформацииВСтруктуруJSON +
+ +Описание, пример вызова + +```bsl + +// При конвертировании контактной информации в структуру JSON. +// +// Параметры: +// КонтактнаяИнформация - Строка - контактная информация во формате XML +// КонтактнаяИнформацияJSON - Строка - выходной параметр. Контактная информация в формате JSON +// Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации - ожидаемый вид типа контактной информации. +// НастройкиКонвертации - Структура +// +Процедура ПриКонвертированииКонтактнойИнформацииВСтруктуруJSON(КонтактнаяИнформация, КонтактнаяИнформацияJSON, Тип, НастройкиКонвертации) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриКонвертированииКонтактнойИнформацииВСтруктуруJSON(КонтактнаяИнформация, КонтактнаяИнформацияJSON, Тип, НастройкиКонвертации) +``` +
+ +## ПриПриведенииКонтактнойИнформацииВXML +
+ +Описание, пример вызова + +```bsl + +// Преобразует входные данные контактной информации в формат XML. +// +// Параметры: +// Данные - см. УправлениеКонтактнойИнформациейКлиентСервер.ОписаниеКонтактнойИнформации +// Результат - см. УправлениеКонтактнойИнформацией.ПоляКонтактнойИнформацииДляПреобразования +// СтандартнаяОбработка - Булево - выходной параметр. Установить Ложь, если реализовано собственное преобразование. +// +Процедура ПриПриведенииКонтактнойИнформацииВXML(Знач Данные, Результат, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриПриведенииКонтактнойИнформацииВXML(Данные, Результат, СтандартнаяОбработка) +``` +
+ +## ПриКонвертацииТелефонаВОбъектXDTO +
+ +Описание, пример вызова + +```bsl + +// Выполняет преобразование контактной информации, включающей номер телефона, в объект типа XDTO. +// +// Параметры: +// ЗначенияПолей - Строка - контактная информация +// Результат - ОбъектXDTO - выходной параметр. Результат преобразования контактной информации в ОбъектXDTO +// Представление - Строка - представление контактной информации +// ОжидаемыйТип - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации +// +Процедура ПриКонвертацииТелефонаВОбъектXDTO(ЗначенияПолей, Результат, Представление = "", ОжидаемыйТип = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриКонвертацииТелефонаВОбъектXDTO(ЗначенияПолей, Результат, Представление, ОжидаемыйТип); +``` +
+ +## ПриКонвертацииФаксаВОбъектXDTO +
+ +Описание, пример вызова + +```bsl + +// Выполняет преобразование контактной информации, включающей номер факса, в объект типа XDTO. +// +// Параметры: +// ЗначенияПолей - Строка - контактная информация +// Результат - ОбъектXDTO - выходной параметр. Результат преобразования контактной информации в ОбъектXDTO +// Представление - Строка - представление контактной информации +// ОжидаемыйТип - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации +// +Процедура ПриКонвертацииФаксаВОбъектXDTO(ЗначенияПолей, Результат, Представление = "", ОжидаемыйТип = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриКонвертацииФаксаВОбъектXDTO(ЗначенияПолей, Результат, Представление, ОжидаемыйТип); +``` +
+ +## ПриУстановкеКомментарияКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Добавление комментария к контактной информации. +// +// Параметры: +// КонтактнаяИнформация - Строка - контактная информация, для которой будет добавлен комментарий. +// Комментарий - Строка - комментарий контактной информации +// +Процедура ПриУстановкеКомментарияКонтактнойИнформации(КонтактнаяИнформация, Знач Комментарий) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриУстановкеКомментарияКонтактнойИнформации(КонтактнаяИнформация, Комментарий) +``` +
+ +## ПриОпределенииТипаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Определяет тип контактной информации. +// +// Параметры: +// XMLСтрока - Строка - контактная информация в формате XML. +// Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации - выходной параметр. Тип контактной информации. +// +Процедура ПриОпределенииТипаКонтактнойИнформации(Знач XMLСтрока, Тип) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриОпределенииТипаКонтактнойИнформации(XMLСтрока, Тип) +``` +
+ +## ПриПреобразованииКонтактнойИнформацииXDTOПоПредставлению +
+ +Описание, пример вызова + +```bsl + +// При преобразовании представления контактной информации в XDTO объект. +// +// Параметры: +// Текст - Строка - представление контактной информации. +// Результат - ОбъектXDTO - выходной параметр. Результат преобразования +// ОжидаемыйВид - ПеречислениеСсылка.ТипыКонтактнойИнформации - тип контактной информации. +// +Процедура ПриПреобразованииКонтактнойИнформацииXDTOПоПредставлению(Текст, Результат, ОжидаемыйВид) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриПреобразованииКонтактнойИнформацииXDTOПоПредставлению(Текст, Результат, ОжидаемыйВид) +``` +
+ +## ПриПреобразованииКонтактнойИнформацииXDTOВXML +
+ +Описание, пример вызова + +```bsl + +// Преобразует контактную информацию из XDTO в XML. +// +// Параметры: +// ОбъектXDTOИнформации - ОбъектXDTO - контактная информация в формате объекта XDTO +// КонтактнаяИнформацияВXML - Строка - выходной параметр. Контактная информация в формате XML. +// +Процедура ПриПреобразованииКонтактнойИнформацииXDTOВXML(ОбъектXDTOИнформации, КонтактнаяИнформацияВXML) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриПреобразованииКонтактнойИнформацииXDTOВXML(ОбъектXDTOИнформации, КонтактнаяИнформацияВXML) +``` +
+ +## ПриПолученииСтрокиСоставаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// При получении строки состава контактной информации. +// +// Параметры: +// XMLДанные - Строка - контактная информация в формате XMLДанные; +// СтрокаСостава - Строка - выходной параметр. Строка состава из XML данных. +// +Процедура ПриПолученииСтрокиСоставаКонтактнойИнформации(XMLДанные, СтрокаСостава) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриПолученииСтрокиСоставаКонтактнойИнформации(XMLДанные, СтрокаСостава) +``` +
+ +## ПриЗаполненииРеквизитовТабличнойЧастиДляВебСтраницы +
+ +Описание, пример вызова + +```bsl + +// При заполнение реквизитов табличной части для веб страницы. +// +// Параметры: +// Источник - ОбъектXDTO - источник контактной информации +// Результат - Строка - результат заполнения +// +Процедура ПриЗаполненииРеквизитовТабличнойЧастиДляВебСтраницы(Источник, Результат) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриЗаполненииРеквизитовТабличнойЧастиДляВебСтраницы(Источник, Результат) +``` +
+ +## ПриОпределенииРазличияКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Сравнивает два экземпляра контактной информации. +// +// Параметры: +// Данные1 - ОбъектXDTO - объект с контактной информацией. +// - Строка - контактная информация в формате XML. +// - Структура - описание контактной информацию. Ожидаются поля: +// * ЗначенияПолей - Строка +// - Структура +// - СписокЗначений +// - Соответствие - поля контактной информации. +// * Представление - Строка - представление. Используется в случае, если не удалось вычислить +// представление из ЗначенияПолей (отсутствие в них поля Представление). +// * Комментарий - Строка - комментарий. Используется в том случае, если не удалось вычислить комментарий +// из ЗначенияПолей. +// * ВидКонтактнойИнформации - СправочникСсылка.ВидыКонтактнойИнформации +// - ПеречислениеСсылка.ТипыКонтактнойИнформации +// - Структура - +// используется в том случае, если не удалось вычислить тип из ЗначенияПолей. +// Данные2 - ОбъектXDTO +// - Строка +// - Структура - смотри описание параметра Данные1. +// Результат - ТаблицаЗначений: +// * Путь - Строка - XPath, идентифицирующий отличающееся значение. Значение "ТипКонтактнойИнформации" +// означает, что переданные экземпляры контактной информации различаются типом. +// * Описание - Строка - описание отличающегося реквизита в терминах предметной области. +// * Значение1 - Строка - значение, соответствующая объекту, переданному в параметре Данные1. +// * Значение2 - Строка - значение, соответствующая объекту, переданному в параметре Данные2. +// +// +// Возвращаемое значение: +// ТаблицаЗначений: - таблица отличающихся полей со следующими колонками: +// * Путь - Строка - XPath, идентифицирующий отличающееся значение. Значение "ТипКонтактнойИнформации" +// означает, что переданные экземпляры контактной информации различаются типом. +// * Описание - Строка - описание отличающегося реквизита в терминах предметной области. +// * Значение1 - Строка - значение, соответствующая объекту, переданному в параметре Данные1. +// * Значение2 - Строка - значение, соответствующая объекту, переданному в параметре Данные2. +// +Процедура ПриОпределенииРазличияКонтактнойИнформации(Знач Данные1, Знач Данные2, Результат) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриОпределенииРазличияКонтактнойИнформации(Данные1, Данные2, Результат) +``` +
+ +## ПриПроверкеСтраныПослеПоискаСтраныПоКлассификатору +
+ +Описание, пример вызова + +```bsl + +// Позволяет выполнить дополнительную проверку и обработку данных о стране, найденной по классификатору. +// +// Параметры: +// СтранаПоКлассификатору - СтрокаТаблицыЗначений: +// * Код - Строка - данные страны. +// * Наименование - Строка - данные страны. +// * НаименованиеПолное - Строка - данные страны. +// * КодАльфа2 - Строка - данные страны. +// * КодАльфа3 - Строка - данные страны. +// +Процедура ПриПроверкеСтраныПослеПоискаСтраныПоКлассификатору(СтранаПоКлассификатору) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейЛокализация.ПриПроверкеСтраныПослеПоискаСтраныПоКлассификатору(СтранаПоКлассификатору) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеКонтактнойИнформациейПереопределяемый.md b/src/content/docs/bsp/УправлениеКонтактнойИнформациейПереопределяемый.md new file mode 100644 index 0000000..af83adb --- /dev/null +++ b/src/content/docs/bsp/УправлениеКонтактнойИнформациейПереопределяемый.md @@ -0,0 +1,187 @@ +--- +title: Управление контактной информацией переопределяемый +slug: bsp/управление-контактной-информацией-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Изменяет, добавляет, удаляет стандартные команды контактной информации, отображаемые в справочниках и документах, +// Вкл./Выкл. отображение иконок контактной информации слева от заголовка вида контактной информации, +// Изменяет положение кнопки Добавить дополнительное поле контактной информации, +// Изменяет ширину поля комментарий для полей контактной информации с типами Телефон, АдресЭлектроннойПочты, Skype, +// ВебСтраница, Факс +// +// Параметры: +// Настройки - Структура: +// * ОтображатьИконки - Булево +// * ОписаниеКоманд - см. УправлениеКонтактнойИнформацией.ОписаниеКоманд +// * ПоложениеКнопкиДобавить - ГоризонтальноеПоложениеЭлемента - допустимые значения: Лево, Право, Авто. +// Лево - Безусловное положение слева. +// Право - Безусловное положение слева. +// Авто - Располагается справа, когда контактная +// информация в виде поля. Располагается слева, +// когда контактная информация в виде +// гиперссылки, или ни одно поле контактной +// информации не выведено в группе. +// * ШиринаПоляКомментарий - Число - ширина поля комментарий для полей контактной информации с типами Телефон, АдресЭлектроннойПочты, +// Skype, ВебСтраница, Факс. Данный параметр устанавливается только когда группа +// контактной информации ограничена по ширине. +// +// Пример: +// Настройки.ОтображатьИконки = Истина; +// Настройки.ШиринаПоляКомментарий = 10; +// Настройки.ПоложениеКнопкиДобавить = ГоризонтальноеПоложениеЭлемента.Авто; +// +// Адрес = Перечисления.ТипыКонтактнойИнформации.Адрес; +// Настройки.ОписаниеКоманд[Адрес].ЗапланироватьВстречу.Заголовок = НСтр("ru='Встреча'"); +// Настройки.ОписаниеКоманд[Адрес].ЗапланироватьВстречу.Подсказка = НСтр("ru='Создать событие встречи'"); +// Настройки.ОписаниеКоманд[Адрес].ЗапланироватьВстречу.Картинка = БиблиотекаКартинок.ЗапланированноеВзаимодействие; +// Настройки.ОписаниеКоманд[Адрес].ЗапланироватьВстречу.Действие = "СтандартныеПодсистемыКлиент.ОткрытьФормуДокументаВстреча"; +// +// ФактическийАдресОрганизации = УправлениеКонтактнойИнформацией.ВидКонтактнойИнформацииПоИмени("ФактическийАдресОрганизации"); +// Настройки.ОписаниеКоманд[ФактическийАдресОрганизации] = +// ОбщегоНазначения.СкопироватьРекурсивно(УправлениеКонтактнойИнформацией.КомандыТипаКонтактнойИнформации(Перечисления.ТипыКонтактнойИнформации.Адрес)); +// Настройки.ОписаниеКоманд[ФактическийАдресОрганизации].ЗапланироватьВстречу.Действие = ""; // Отключение действия команды для вида +// +// Процедурам, указанных в свойстве Действие, передаются 2 параметра: +// КонтактнаяИнформация - Структура: +// * Представление - Строка +// * Значение - Строка +// * Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации +// * Вид - СправочникСсылка.ВидыКонтактнойИнформации +// ДополнительныеПараметры - Структура: +// * ВладелецКонтактнойИнформации - ОпределяемыйТип.ВладелецКонтактнойИнформации. +// * Форма - ФормаКлиентскогоПриложения - форма объекта-владельца, предназначенная для вывода контактной информации. +// +// Процедура ОткрытьФормуДокументаВстреча(КонтактнаяИнформация, ДополнительныеПараметры) Экспорт +// ЗначенияЗаполнения = Новый Структура; +// ЗначенияЗаполнения.Вставить("МестоПроведенияВстречи", КонтактнаяИнформация.Представление); +// Если ТипЗнч(ДополнительныеПараметры.ВладелецКонтактнойИнформации) = Тип("ДокументСсылка.ЗаказПокупателя") Тогда +// ЗначенияЗаполнения.Вставить("Предмет", ДополнительныеПараметры.ВладелецКонтактнойИнформации); +// ЗначенияЗаполнения.Вставить("Контакт", ""); +// Иначе +// ЗначенияЗаполнения.Вставить("Контакт", ДополнительныеПараметры.ВладелецКонтактнойИнформации); +// ЗначенияЗаполнения.Вставить("Предмет", ""); +// КонецЕсли; +// +// ОткрытьФорму("Документ.Встреча.ФормаОбъекта", Новый Структура("ЗначенияЗаполнения", ЗначенияЗаполнения), +// ДополнительныеПараметры.Форма); +// КонецПроцедуры +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриПолученииНаименованийВидовКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Получает наименования видов контактной информации на разных языках. +// +// Параметры: +// Наименования - Соответствие из КлючИЗначение - представление вида контактной информации на переданном языке: +// * Ключ - Строка - имя вида контактной информации. Например, "АдресПартнера". +// * Значение - Строка - наименование вида контактной информации для переданного кода языка. +// КодЯзыка - Строка - код языка. Например, "en". +// +// Пример: +// Наименования["АдресПартнера"] = НСтр("ru='Адрес'; en='Address';", КодЯзыка); +// +Процедура ПриПолученииНаименованийВидовКонтактнойИнформации(Наименования, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейПереопределяемый.ПриПолученииНаименованийВидовКонтактнойИнформации(Наименования, КодЯзыка) +``` +
+ +## ПриНастройкеНачальногоЗаполненияЭлементов +
+ +Описание, пример вызова + +```bsl + +// Смотри также ОбновлениеИнформационнойБазыПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов +// +// Параметры: +// Настройки - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов.Настройки +// +Процедура ПриНастройкеНачальногоЗаполненияЭлементов(Настройки) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов(Настройки) +``` +
+ +## ПриНачальномЗаполненииЭлементов +
+ +Описание, пример вызова + +```bsl + +// Смотри также ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов +// +// Параметры: +// КодыЯзыков - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов.КодыЯзыков +// Элементы - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов.Элементы +// ТабличныеЧасти - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов.ТабличныеЧасти +// +Процедура ПриНачальномЗаполненииЭлементов(КодыЯзыков, Элементы, ТабличныеЧасти) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейПереопределяемый.ПриНачальномЗаполненииЭлементов(КодыЯзыков, Элементы, ТабличныеЧасти) +``` +
+ +## ПриНачальномЗаполненииЭлемента +
+ +Описание, пример вызова + +```bsl + +// Смотри также ОбновлениеИнформационнойБазыПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов +// +// Параметры: +// Объект - СправочникОбъект.РолиИсполнителей - заполняемый объект. +// Данные - СтрокаТаблицыЗначений - данные заполнения объекта. +// ДополнительныеПараметры - Структура: +// * ПредопределенныеДанные - ТаблицаЗначений - данные заполненные в процедуре ПриНачальномЗаполненииЭлементов. +// +Процедура ПриНачальномЗаполненииЭлемента(Объект, Данные, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеКонтактнойИнформациейПереопределяемый.ПриНачальномЗаполненииЭлемента(Объект, Данные, ДополнительныеПараметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеПечатью.md b/src/content/docs/bsp/УправлениеПечатью.md new file mode 100644 index 0000000..ff42f74 --- /dev/null +++ b/src/content/docs/bsp/УправлениеПечатью.md @@ -0,0 +1,1396 @@ +--- +title: Управление печатью +slug: bsp/управление-печатью +--- + + +## ТаблицаПолейДанныхПечати +
+ +Описание, пример вызова + +```bsl + +// Конструктор списка полей данных печати для функции СхемаКомпоновкиДанныхПечати. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Идентификатор - Строка - имя поля. +// * Представление - Строка - заголовок поля. +// * ТипЗначения - ОписаниеТипов - тип значения поля. +// * ИмяКартинки - Строка - картинка поля, выводится в списке доступных полей редактора макета. +// * Порядок - Число - используется для упорядочивания поля в списке доступных полей редактора макета. +// +Функция ТаблицаПолейДанныхПечати() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.ТаблицаПолейДанныхПечати() +``` +
+ +## ДеревоПолейДанныхПечати +
+ +Описание, пример вызова + +```bsl + +// Конструктор списка полей данных печати для функции СхемаКомпоновкиДанныхПечати. +// +// Возвращаемое значение: +// ДеревоЗначений: +// * Идентификатор - Строка - имя поля. +// * Представление - Строка - заголовок поля. +// * ТипЗначения - ОписаниеТипов - тип значения поля. +// * ИмяКартинки - Строка - картинка поля, выводится в списке доступных полей редактора макета. +// * Порядок - Число - используется для упорядочивания поля в списке доступных полей редактора макета. +// * Папка - Булево - указывает на то, что поле является папкой. В отличие от групп, папка входит в полный +// путь к полю. +// * Таблица - Булево - используется для описания табличной части. Подчиненные поля - поля этой табличной части. +// +Функция ДеревоПолейДанныхПечати() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.ДеревоПолейДанныхПечати() +``` +
+ +## СхемаКомпоновкиДанныхПечати +
+ +Описание, пример вызова + +```bsl + +// Формирует схему компоновки данных печати с заданным списком полей. +// +// Параметры: +// СписокПолей - см. ТаблицаПолейДанныхПечати +// - ДеревоЗначений - см. ДеревоПолейДанныхПечати +// +// Возвращаемое значение: +// СхемаКомпоновкиДанных +// +Функция СхемаКомпоновкиДанныхПечати(СписокПолей) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.СхемаКомпоновкиДанныхПечати(СписокПолей) +``` +
+ +## СведенияОПечатнойФорме +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание найденной в коллекции печатной формы. +// Если описание не существует, возвращает Неопределено. +// Функция предназначена для использования только внутри процедуры Печать. +// +// Параметры: +// КоллекцияПечатныхФорм - см. УправлениеПечатьюПереопределяемый.ПриПечати.КоллекцияПечатныхФорм +// Идентификатор - Строка - идентификатор печатной формы в менеджере печати. +// +// Возвращаемое значение: +// СтрокаТаблицыЗначений из см. УправлениеПечатьюПереопределяемый.ПриПечати.КоллекцияПечатныхФорм +// +// Пример: +// ПечатнаяФорма = УправлениеПечатью.СведенияОПечатнойФорме(КоллекцияПечатныхФорм, "Квитанция"); +// Если ПечатнаяФорма <> Неопределено Тогда +// ПечатнаяФорма.ТабличныйДокумент = ПечатьКвитанции(МассивОбъектов); +// ПечатнаяФорма.СинонимМакета = НСтр("ru = 'Квитанция (с QR кодом)'"); +// ПечатнаяФорма.ПолныйПутьКМакету = "Документ.СчетНаОплатуПокупателю.ПФ_MXL_Квитанция"; +// КонецЕсли; +// +Функция СведенияОПечатнойФорме(КоллекцияПечатныхФорм, Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.СведенияОПечатнойФорме(КоллекцияПечатныхФорм, Идентификатор) +``` +
+ +## НужноПечататьМакет +
+ +Описание, пример вызова + +```bsl + +// Проверить, нужно ли печатать макет. +// Функция предназначена для использования только внутри процедуры Печать. +// +// Параметры: +// КоллекцияПечатныхФорм - ТаблицаЗначений - служебный параметр, переданный в процедуру Печать; +// ИмяМакета - Строка - имя проверяемого макета. +// +// Возвращаемое значение: +// Булево - Истина, если макет надо печатать. +// +Функция НужноПечататьМакет(КоллекцияПечатныхФорм, ИмяМакета) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.НужноПечататьМакет(КоллекцияПечатныхФорм, ИмяМакета) +``` +
+ +## ВывестиТабличныйДокументВКоллекцию +
+ +Описание, пример вызова + +```bsl + +// Добавляет табличный документ в коллекцию печатных форм. +// Процедура предназначена для использования только внутри процедуры Печать. +// +// Параметры: +// КоллекцияПечатныхФорм - ТаблицаЗначений - служебный параметр, переданный в процедуру Печать; +// ИмяМакета - Строка - имя макета; +// СинонимМакета - Строка - представление макета; +// ТабличныйДокумент - ТабличныйДокумент - печатная форма документа; +// Картинка - Картинка - пиктограмма печатной формы; +// ПолныйПутьКМакету - Строка - путь к макету в дереве метаданных, например +// "Документ.СчетНаОплатуПокупателю.ПФ_MXL_СчетЗаказ". +// Если не указывать этот параметр, то редактирование макета пользователем будет +// недоступно в форме ПечатьДокументов. +// ИмяФайлаПечатнойФормы - Строка - имя, используемое при сохранении печатной формы в файл; +// - Соответствие из КлючИЗначение: +// * Ключ - ЛюбаяСсылка - ссылка на объект печати; +// * Значение - Строка - имя файла. +// +Процедура ВывестиТабличныйДокументВКоллекцию(КоллекцияПечатныхФорм, ИмяМакета, СинонимМакета, ТабличныйДокумент, Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ВывестиТабличныйДокументВКоллекцию(КоллекцияПечатныхФорм, ИмяМакета, СинонимМакета, ТабличныйДокумент, ); +``` +
+ +## ЗадатьОбластьПечатиДокумента +
+ +Описание, пример вызова + +```bsl + +// Задает область печати объекта в табличном документе. Необходимо использовать при выводе нескольких печатных форм +// в одном табличном документе для возможности печати комплектов документов, а также для возможности сохранения +// печатных форм в отдельных файлах. +// Необходимо вызывать после формирования каждой печатной формы в табличном документе. +// +// Параметры: +// ТабличныйДокумент - ТабличныйДокумент - печатная форма; +// НомерСтрокиНачало - Число - позиция начала очередной области в документе; +// ОбъектыПечати - см. УправлениеПечатьюПереопределяемый.ПриПечати.ОбъектыПечати +// Ссылка - ЛюбаяСсылка - объект печати. +// +// Пример: +// Пока ВыборкаПоДокументам.Следующий() Цикл +// НомерСтрокиНачало = ТабличныйДокумент.ВысотаТаблицы + 1; +// // ... вывод печатной формы в табличный документ ... +// УправлениеПечатью.ЗадатьОбластьПечатиДокумента(ТабличныйДокумент, НомерСтрокиНачало, ОбъектыПечати, ВыборкаПоДокументам.Ссылка); +// КонецЦикла; +// +Процедура ЗадатьОбластьПечатиДокумента(ТабличныйДокумент, НомерСтрокиНачало, ОбъектыПечати, Ссылка) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ЗадатьОбластьПечатиДокумента(ТабличныйДокумент, НомерСтрокиНачало, ОбъектыПечати, Ссылка) +``` +
+ +## СписокПечатныхФормИзВнешнихИсточников +
+ +Описание, пример вызова + +```bsl + +// Возвращает список внешних печатных форм. +// +// Параметры: +// ПолноеИмяОбъектаМетаданных - Строка - полное имя объекта метаданных, для которого необходимо получить список +// печатных форм. +// +// Возвращаемое значение: +// СписокЗначений: +// * Значение - Строка - идентификатор печатной формы; +// * Представление - Строка - представление печатной формы. +// +Функция СписокПечатныхФормИзВнешнихИсточников(ПолноеИмяОбъектаМетаданных) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.СписокПечатныхФормИзВнешнихИсточников(ПолноеИмяОбъектаМетаданных) +``` +
+ +## КомандыПечатиФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает список команд печати для указанной формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// - Строка - форма или полное имя формы, для которой необходимо получить список +// команд печати. +// СписокОбъектов - Массив - коллекция объектов метаданных, команды печати которых необходимо использовать при составлении +// списка команд печати для указанной формы. +// Возвращаемое значение: +// см. СоздатьКоллекциюКомандПечати +// +Функция КомандыПечатиФормы(Форма, СписокОбъектов = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.КомандыПечатиФормы(Форма, СписокОбъектов); +``` +
+ +## СоздатьКоллекциюКомандПечати +
+ +Описание, пример вызова + +```bsl + +// Создает пустую таблицу с описанием команд печати. +// Таблица команд печати передается в процедуры ДобавитьКомандыПечати, +// размещенные в модулях менеджеров объектов конфигурации, которые перечислены в процедуре +// УправлениеПечатьюПереопределяемый.ПриОпределенииОбъектовСКомандамиПечати. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// +// * Идентификатор - Строка - идентификатор команды печати, по которому менеджер печати определяет печатную +// форму, которую необходимо сформировать. +// Например, "СчетЗаказ". +// +// Для печати нескольких печатных форм можно указывать одновременно несколько их +// идентификаторов (строкой, через запятую либо массивом строк), например: +// "СчетЗаказ,ГарантийноеПисьмо". +// +// Если необходимо задать количество копий печати для печатной формы, то ее +// идентификатор нужно продублировать столько раз, сколько копий необходимо +// сформировать. При этом следует учитывать, что порядок следования печатных +// форм в комплекте будет соответствовать порядку идентификаторов печатных форм, +// указанных в этом параметре. Например (2 счета на оплату + 1 гарантийное письмо): +// "СчетЗаказ,СчетЗаказ,ГарантийноеПисьмо". +// +// Идентификатор печатной формы может содержать в себе и альтернативный менеджер +// печати, если он отличается от указанного в параметре МенеджерПечати, +// например: "СчетЗаказ,Обработка.ПечатнаяФорма.ГарантийноеПисьмо". +// +// В этом примере ГарантийноеПисьмо формируется в менеджере печати +// Обработка.ПечатнаяФорма, а СчетЗаказ - в менеджере печати, указанном в +// параметре МенеджерПечати. +// +// Для печатных форм, менеджером печати которых является общий модуль +// "УправлениеПечатью", в качестве идентификатора необходимо указать полный путь к макету. +// Например, "Документ.СчетНаОплатуПокупателю.ПФ_MXL_СчетНаОплату". +// +// - Массив - список идентификаторов команд печати. +// +// * Представление - Строка - представление команды в меню Печать. +// Например, "Счет на оплату". +// +// * МенеджерПечати - Строка - (необязательный) имя объекта, в модуле менеджера которого располагается +// процедура Печать, формирующая табличные документы для этой команды. +// Если печатная форма формируется автоматически по данным печати и макету, то +// в параметре необходимо указать общий модуль "УправлениеПечатью". +// Значение по умолчанию - имя модуля менеджера объекта. +// Например, "Документ.СчетНаОплатуПокупателю". +// * ТипыОбъектовПечати - Массив - (необязательный) список типов объектов, для которых предназначена команда +// печати. Параметр предназначен для команд печати в журналах документов, где +// требуется проверка передаваемого типа объекта перед вызовом менеджера печати. +// Если список не заполнен, то при автоматическом создании списка команд печати +// в журнале документов он заполняется типом объекта, из которого была +// импортирована команда печати. +// +// * Обработчик - Строка - (необязательный) клиентский обработчик команды, в который необходимо передать +// управление вместо стандартного обработчика команды Печать. Используется, +// например, когда печатная форма формируется на клиенте. +// Формат "<ИмяОбщегоМодуля>.<ИмяПроцедуры>" используется, когда процедура размещена +// в общем модуле. +// Формат "<ИмяПроцедуры>" используется, когда процедура размещена +// в модуле основной формы отчета или обработки, указанной в МенеджерПечати. +// Например, +// КомандаПечати.Обработчик = "ЗащитаПерсональныхДанныхКлиент.ОткрытьФормуСогласиеНаОбработкуПерсональныхДанных"; +// Пример обработчика в модуле формы: +// // Формирует печатную форму <представление печатной формы>. +// // +// // Параметры: +// // ПараметрыПечати - Структура - сведения о печатной форме. +// // * ОбъектыПечати - Массив - массив ссылок выбранных объектов. +// // * Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана +// // команда печати. +// // * ДополнительныеПараметры - Структура - дополнительные параметры печати. +// // Прочие ключи структуры соответствуют колонкам таблицы КомандыПечати, +// // подробнее см. в функции УправлениеПечатью.СоздатьКоллекциюКомандПечати. +// // +// &НаКлиенте +// Функция <ИмяФункции>(ПараметрыПечати) Экспорт +// // Обработчик печати. +// КонецФункции +// Следует иметь в виду, что обработчик вызывается при помощи метода Вычислить, +// поэтому в качестве обработчика может выступать только функция. +// При этом возвращаемое значение функции никак в дальнейшем не используется подсистемой. +// +// * Порядок - Число - (необязательный) Значение от 1 до 100, указывающее порядок размещения команды +// по отношению к другим командам. Сортировка команд меню Печать осуществляется +// сначала по полю Порядок, затем по представлению. +// Значение по умолчанию - 50. +// +// * Картинка - Картинка - (необязательный) Картинка, которая отображается возле команды в меню Печать. +// Например, БиблиотекаКартинок.ФорматPDF. +// +// * СписокФорм - Строка - (необязательный) Имена форм через запятую, в которых должна отображаться +// команда. Если параметр не указан, то команда печати будет отображаться во +// всех формах объекта, где встроена подсистема Печать. +// Например, "ФормаДокумента". +// +// * МестоРазмещения - Строка - (необязательный) Имя группы формы, в которую необходимо разместить +// команду печати. Параметр необходимо использовать только в случае, когда на +// форме размещается более одного подменю "Печать". В остальных случаях место +// размещения необходимо задавать в модуле формы при вызове +// метода ПодключаемыеКоманды.ПриСозданииНаСервере. +// +// * ЗаголовокФормы - Строка - (необязательный) Произвольная строка, переопределяющая стандартных заголовок +// формы "Печать документов". Например, "Настраиваемый комплект". +// +// * ФункциональныеОпции - Строка - (необязательный) Имена функциональных опций через запятую, от которых зависит +// доступность команды печати. +// +// * УсловияВидимости - Массив - (необязательный) Коллекция условий видимости команды в зависимости от +// контекста. Условия видимости команды задаются при помощи процедуры +// ДобавитьУсловиеВидимостиКоманды. +// Если параметр не задан, команда видна вне зависимости от контекста. +// +// * ПроверкаПроведенияПередПечатью - Булево - (необязательный) Признак необходимости проверки проведенности +// документов перед печатью. Если выбран хотя бы один непроведенный документ, то +// перед выполнением команды печати возникает диалог проведения. +// Для непроведенных документов команда печати не выполняется. +// Если параметр не указан, то проверка проведенности не выполняется. +// +// * СразуНаПринтер - Булево - (необязательный) Признак необходимости печати документов без предварительного +// просмотра, сразу на принтер. Если параметр не указан, то при выборе команды +// печати открывается форма предварительного просмотра "Печать документов". +// +// * ФорматСохранения - ТипФайлаТабличногоДокумента - (необязательный) Применяется для быстрого сохранения печатной +// формы (без дополнительных действий) в различные форматы, отличные от mxl. +// Если параметр не указан, то формируется обычный mxl. +// Например, ТипФайлаТабличногоДокумента.PDF. +// +// При выборе команды печати сразу открывается сформированный в формате PDF +// документ. +// +// * ПереопределитьПользовательскиеНастройкиКоличества - Булево - (необязательный) Признак необходимости отключения в +// форме ПечатьДокументов механизма сохранения/восстановления выбранного +// пользователем количества экземпляров на печать. Если параметр не указан, то +// механизм сохранения/восстановления настроек будет работать при открытии формы. +// ПечатьДокументов. +// +// * ДополнитьКомплектВнешнимиПечатнымиФормами - Булево - (необязательный) Признак необходимости дополнить комплект +// документов всеми подключенными к объекту внешними печатными формами +// (подсистема ДополнительныеОтчетыИОбработки). Если параметр не указан, внешние +// печатные формы не добавляются в комплект. +// +// * ФиксированныйКомплект - Булево - (необязательный) Признак необходимости блокировки от изменения пользователем +// состава комплекта документов. Если параметр не указан, то пользователь сможет +// исключать отдельные печатные формы из комплекта в форме ПечатьДокументов, а +// также изменять их количество. +// +// * ДополнительныеПараметры - Структура - (необязательный) произвольные параметры для передачи в менеджер печати. +// +// * НеВыполнятьЗаписьВФорме - Булево - (необязательный) Признак необходимости отключения механизма записи объекта +// перед выполнением команды печати. Используется в исключительных случаях. Если +// параметр не указан, производится запись объекта в случае, если в форме +// объекта установлен признак модифицированности. +// +// * ТребуетсяРасширениеРаботыСФайлами - Булево - (необязательный) Признак необходимости подключения расширения для работы +// с 1С:Предприятием перед выполнением команды. Если параметр не указан, расширение +// подключаться не будет. +// +// * ОсновнаяПечатнаяФорма - Булево - (необязательный) Признак определяющий возможность запоминания +// наименований сформированных печатных форм. +// +// * НаименованиеПечатнойФормы - Строка - (необязательный) Наименование, которое будет сохранено при установленном +// признаке "ОсновнаяПечатнаяФорма". Если не заполнено, будет запоминаться значение +// из поля "Представление". +// +Функция СоздатьКоллекциюКомандПечати() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.СоздатьКоллекциюКомандПечати() +``` +
+ +## ДобавитьУсловиеВидимостиКоманды +
+ +Описание, пример вызова + +```bsl + +// Задает условия видимости команды печати на форме в зависимости от контекста. +// +// Параметры: +// КомандаПечати - СтрокаТаблицыЗначений - элемент коллекции КомандыПечати в процедуре ДобавитьКомандыПечати: +// * УсловияВидимости - Массив - список условий видимости; +// Реквизит - Строка - имя реквизита объекта; +// Значение - Произвольный - значение реквизита объекта; +// МетодСравнения - ВидСравнения - вид сравнения значений. Допустимые для использования виды: +// Равно, НеРавно, Больше, БольшеИлиРавно, Меньше, МеньшеИлиРавно, ВСписке, НеВСписке. +// Значение по умолчанию - Равно. +// +Процедура ДобавитьУсловиеВидимостиКоманды(КомандаПечати, Реквизит, Значение, Знач МетодСравнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ДобавитьУсловиеВидимостиКоманды(КомандаПечати, Реквизит, Значение, МетодСравнения); +``` +
+ +## ЗарегистрироватьНовоеИмяМакета +
+ +Описание, пример вызова + +```bsl + +// Используется при переносе макета (объекта метаданных) печатной формы в другой объект. +// Предназначена для вызова в процедуре заполнения данных обновления (для "отложенного" обработчика). +// Регистрирует новый адрес макета для обработки. +// +// Параметры: +// ИмяМакета - Строка - новое имя макета в формате +// "Документ.<ИмяДокумента>.<ИмяМакета>" +// "Обработка.<ИмяОбработки>.<ИмяМакета>" +// "ОбщийМакет.<ИмяМакета>". +// Параметры - см. ОбновлениеИнформационнойБазы.ОсновныеПараметрыОтметкиКОбработке. +// +Процедура ЗарегистрироватьНовоеИмяМакета(ИмяМакета, Параметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ЗарегистрироватьНовоеИмяМакета(ИмяМакета, Параметры) +``` +
+ +## ПеренестиПользовательскиеМакеты +
+ +Описание, пример вызова + +```bsl + +// Используется при переносе макета (объекта метаданных) печатной формы в другой объект. +// Предназначена для вызова в "отложенном" обработчике обновления. +// Переносит пользовательские данные, относящиеся к макету, на новый адрес. +// +// Параметры: +// Макеты - Соответствие из КлючИЗначение - сведения о прежних и новых именах макетов в формате +// "Документ.<ИмяДокумента>.<ИмяМакета>" +// "Обработка.<ИмяОбработки>.<ИмяМакета>" +// "ОбщийМакет.<ИмяМакета>": +// * Ключ - Строка - новое имя макета. +// * Значение - Строка - прежнее имя макета. +// +// Параметры - Структура - параметры, передаваемые в "отложенный" обработчик обновления. +// +Процедура ПеренестиПользовательскиеМакеты(Макеты, Параметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ПеренестиПользовательскиеМакеты(Макеты, Параметры) +``` +
+ +## ЗаполнитьПрофильРедактированиеПечатныхФорм +
+ +Описание, пример вызова + +```bsl + +// Предоставляет дополнительный профиль доступа "Редактирование, отправка по почте, сохранение в файл печатных форм (дополнительно)". +// Предназначена для использования в процедуре ПриЗаполненииПоставляемыхПрофилейГруппДоступа модуля УправлениеДоступомПереопределяемый. +// +// Параметры: +// ОписанияПрофилей - см. УправлениеДоступомПереопределяемый.ПриЗаполненииПоставляемыхПрофилейГруппДоступа.ОписанияПрофилей +// +Процедура ЗаполнитьПрофильРедактированиеПечатныхФорм(ОписанияПрофилей) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ЗаполнитьПрофильРедактированиеПечатныхФорм(ОписанияПрофилей) +``` +
+ +## ДобавитьОписаниеОбласти +
+ +Описание, пример вызова + +```bsl + +// Добавляет к параметру НаборОбластей новую запись об области. +// +// Параметры: +// ОбластиМакетаОфисногоДокумента - Массив - набор областей (массив структур) макета офисного документа. +// ИмяОбласти - Строка - имя добавляемой области. +// ТипОбласти - Строка - тип области: +// ВерхнийКолонтитул; +// НижнийКолонтитул; +// Общая; +// СтрокаТаблицы; +// Список. +// +// Пример: +// Функция ОбластиМакетаОфисногоДокумента() +// +// Области = Новый Структура; +// +// УправлениеПечатью.ДобавитьОписаниеОбласти(Области, "ВерхнийКолонтитул", "ВерхнийКолонтитул"); +// УправлениеПечатью.ДобавитьОписаниеОбласти(Области, "НижнийКолонтитул", "НижнийКолонтитул"); +// УправлениеПечатью.ДобавитьОписаниеОбласти(Области, "Заголовок", "Общая"); +// +// Возврат Области; +// +// КонецФункции +// +Процедура ДобавитьОписаниеОбласти(ОбластиМакетаОфисногоДокумента, Знач ИмяОбласти, Знач ТипОбласти) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ДобавитьОписаниеОбласти(ОбластиМакетаОфисногоДокумента, ИмяОбласти, ТипОбласти) +``` +
+ +## МакетыИДанныеОбъектовДляПечати +
+ +Описание, пример вызова + +```bsl + +// Получает за один вызов всю необходимую информацию для печати: данные объектов по макетам, двоичные +// данные макетов, описание областей макетов. +// Для вызова из клиентских модулей печати форм по макетам офисных документов. +// +// Параметры: +// ИмяМенеджераПечати - Строка - имя для обращения к менеджеру объекта, например "Документ.<Имя документа>". +// ИменаМакетов - Строка - имена макетов, по которым будут формироваться печатные формы. +// СоставДокументов - Массив - ссылки на объекты информационной базы (должны быть одного типа). +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение - коллекция ссылок на объекты и их данные: +// * Ключ - ЛюбаяСсылка - ссылка на объект информационной базы; +// * Значение - Структура: +// ** Ключ - Строка - имя макета; +// ** Значение - Структура - данные объекта. +// +Функция МакетыИДанныеОбъектовДляПечати(Знач ИмяМенеджераПечати, Знач ИменаМакетов, Знач СоставДокументов) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.МакетыИДанныеОбъектовДляПечати(ИмяМенеджераПечати, ИменаМакетов, СоставДокументов) +``` +
+ +## МакетПечатнойФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает макет печатной формы по полному пути к макету. +// +// Если конфигурация рассчитана на несколько языков, в ней могут быть предусмотрены несколько макетов для этих языков: +// - ПФ_DOC_СчетНаОплату_ru +// - ПФ_DOC_СчетНаОплату_en +// - и т.п. +// В этом случае при поиске нужного макета учитывается следующий приоритет: +// 1) на языке, указанном в параметре КодЯзыка, +// 2) на языке конфигурации (ОбщегоНазначения.КодОсновногоЯзыка()), +// 3) без указания языка. +// +// Параметры: +// ПутьКМакету - Строка - полный путь к макету в формате: +// "Документ.<ИмяДокумента>.<ИмяМакета>" +// "Обработка.<ИмяОбработки>.<ИмяМакета>" +// "ОбщийМакет.<ИмяМакета>". +// КодЯзыка - Строка - язык, на котором требуется получить макет. +// Состоит из кода языка по ISO 639-1 и, опционально, кода страны по ISO 3166-1, разделенных +// символом подчеркивания. Примеры: "en", "en_US", "en_GB", "ru", "ru_RU". +// +// Возвращаемое значение: +// ТабличныйДокумент, ДвоичныеДанные - макет. +// +Функция МакетПечатнойФормы(ПутьКМакету, Знач КодЯзыка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.МакетПечатнойФормы(ПутьКМакету, КодЯзыка); +``` +
+ +## ИспользуетсяПользовательскийМакет +
+ +Описание, пример вызова + +```bsl + +// Проверяет, использование пользовательского макет вместо поставляемого. +// +// Параметры: +// ПутьКМакету - Строка - полный путь к макету в формате: +// "Документ.<ИмяДокумента>.<ИмяМакета>" +// "Обработка.<ИмяОбработки>.<ИмяМакета>" +// "ОбщийМакет.<ИмяМакета>". +// Возвращаемое значение: +// Булево - Истина, если используется пользовательский макет. +// +Функция ИспользуетсяПользовательскийМакет(ПутьКМакету) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.ИспользуетсяПользовательскийМакет(ПутьКМакету) +``` +
+ +## ПоставляемыйМакетИзменен +
+ +Описание, пример вызова + +```bsl + +// Проверяет, был ли изменен поставляемый макет по сравнению с предыдущей версией конфигурации. +// +// Параметры: +// ПутьКМакету - Строка - полный путь к макету в формате: +// "Документ.<ИмяДокумента>.<ИмяМакета>" +// "Обработка.<ИмяОбработки>.<ИмяМакета>" +// "ОбщийМакет.<ИмяМакета>". +// Возвращаемое значение: +// Булево - Истина, если макет был изменен. +// +Функция ПоставляемыйМакетИзменен(ПутьКМакету) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.ПоставляемыйМакетИзменен(ПутьКМакету) +``` +
+ +## ОтключитьПользовательскийМакет +
+ +Описание, пример вызова + +```bsl + +// Переключает использование пользовательского макета на макет из конфигурации. +// Применяется в случае, когда макет печатной формы конфигурации и/или алгоритм вывода изменены без поддержки обратной +// совместимости с макетом предыдущей версии конфигурации. +// Для использования в обработчиках обновления. +// +// В общем случае при внесении изменений в макеты и процедуры формирования печатных форм необходимо учитывать +// возможность того, что макеты могут быть изменены пользователями (т.е. взят за основу типовой макет из конфигурации +// и в него добавлен статический текст, изменен шрифт, цвет и другое оформление ячеек, которое не требует программной +// обработки со стороны алгоритмов конфигурации). +// +// Однако в ряде случаев точное следование порядку заполнения форм важнее, чем совместимость с возможными изменениями +// пользователя в макетах предыдущих версий (например, это справедливо для строго регламентированных печатных форм, +// при нарушении порядка их применения контролирующие органы могут накладывать штрафы, отказывать в проведении +// операций, в налоговых вычетах и т.п. - в них недопустимы сокращение количества полей на форме, перекомпоновка). +// Примерами таких форм являются счет-фактура, созданные на его основе УПД и УКД, кассовые ордера (КО-1 и КО-2), +// платежное поручение. +// Поэтому если у пользователя есть измененный макет, то при обновлении его следует отключать, чтобы эти печатные формы +// формировались корректно. +// +// +// Параметры: +// ПутьКМакету - Строка - полный путь к макету в формате: +// "Документ.<ИмяДокумента>.<ИмяМакета>" +// "Обработка.<ИмяОбработки>.<ИмяМакета>" +// "ОбщийМакет.<ИмяМакета>". +// +Процедура ОтключитьПользовательскийМакет(ПутьКМакету) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ОтключитьПользовательскийМакет(ПутьКМакету) +``` +
+ +## ТабличныйДокументПоДвоичнымДанным +
+ +Описание, пример вызова + +```bsl + +// Возвращает табличный документ по двоичным данным табличного документа. +// +// Параметры: +// ДвоичныеДанныеДокумента - ДвоичныеДанные - двоичные данные табличного документа. +// +// Возвращаемое значение: +// ТабличныйДокумент - табличный документ. +// +Функция ТабличныйДокументПоДвоичнымДанным(ДвоичныеДанныеДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.ТабличныйДокументПоДвоичнымДанным(ДвоичныеДанныеДокумента) +``` +
+ +## НапечататьВФайл +
+ +Описание, пример вызова + +```bsl + +// Формирует печатные формы в требуемом формате и записывает в файлы. +// Ограничение: печатные формы, формируемые на клиенте не поддерживаются. +// +// Параметры: +// КомандыПечати - Структура +// - Массив - команда или несколько команд печати формы, +// см. УправлениеПечатью.КомандыПечатиФормы. +// СписокОбъектов - Массив - ссылки на печатаемые объекты. +// НастройкиСохранения - см. УправлениеПечатью.НастройкиСохранения. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ИмяФайла - Строка - имя файла; +// * ДвоичныеДанные - ДвоичныеДанные - файл печатной формы. +// +Функция НапечататьВФайл(КомандыПечати, СписокОбъектов, НастройкиСохранения) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.НапечататьВФайл(КомандыПечати, СписокОбъектов, НастройкиСохранения) +``` +
+ +## НастройкиСохранения +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра НастройкиСохранения функции УправлениеПечатью.НапечататьВФайл. +// Определяет формат и другие настройки записи табличного документа в файл. +// +// Возвращаемое значение: +// Структура - настройки записи табличного документа в файл: +// * ФорматыСохранения - Массив - коллекция значений типа ТипФайлаТабличногоДокумента, +// либо значений типа ТипФайлаТабличногоДокумента, преобразованных в строку. +// По умолчанию сохранение выполняется в формате PDF. +// * УпаковатьВАрхив - Булево - если установить значение Истина, будет создан один файл архива с файлами указанных форматов. +// * ПереводитьИменаФайловВТранслит - Булево - если установить Истина, то имена полученных файлов будут на латинице. +// * ПодписьИПечать - Булево - если установить Истина и сохраняемый табличный документ поддерживает размещение +// подписей и печатей, то в записанных файлах будут размещены подписи и печати. +// +Функция НастройкиСохранения() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.НастройкиСохранения() +``` +
+ +## НастройкиПечатиОбъекта +
+ +Описание, пример вызова + +```bsl + +// Определяет тип параметра Настройки в процедурах ПриОпределенииНастроекПечати модулей менеджеров объектов. +// Возвращает настройки печати объекта, подключенного к подсистеме печати. +// +// Параметры: +// МенеджерОбъекта - СправочникМенеджер, ДокументМенеджер, ОбработкаМенеджер, РегистрСведенийМенеджер - менеджер объекта. +// +// Возвращаемое значение: +// Структура: +// * ПриОпределенииПолучателей - Булево - при установке значения Истина будет вызвана процедура модуля менеджера +// объекта ПриОпределенииПолучателей, +// где определяются получатели для отправки печатной формы. +// По умолчанию, значение Ложь. +// * ПриДобавленииКомандПечати - Булево - при установке значения Истина будет вызвана процедура модуля +// менеджера объекта ДобавитьКомандыПечати, где добавляются команды печати. +// По умолчанию, значение Ложь. +// +Функция НастройкиПечатиОбъекта(МенеджерОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.НастройкиПечатиОбъекта(МенеджерОбъекта) +``` +
+ +## НаименованияСформированныхОсновныхПечатныхФорм +
+ +Описание, пример вызова + +```bsl + +// Возвращает наименования основных печатных форм, которые были сформированы по объектам. +// +// Параметры: +// Ссылки - Массив из ЛюбаяСсылка +// - ФиксированныйМассив из ЛюбаяСсылка - документы, для которых необходимо получить наименование. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ЛюбаяСсылка - документ, для которого получено наименование. +// * Значение - Строка - наименование сформированной основной печатной формы. +// - Неопределено - если документ еще не был напечатан. +// +Функция НаименованияСформированныхОсновныхПечатныхФорм(Ссылки) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.НаименованияСформированныхОсновныхПечатныхФорм(Ссылки) +``` +
+ +## НаименованиеСформированнойОсновнойПечатнойФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает наименование основной печатной формы, которая была сформирована по объекту. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - документ, для которого необходимо получить наименование. +// +// Возвращаемое значение: +// Строка - наименование сформированной основной печатной формы. +// Неопределено - если документ еще не был напечатан. +// +Функция НаименованиеСформированнойОсновнойПечатнойФормы(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.НаименованиеСформированнойОсновнойПечатнойФормы(Ссылка) +``` +
+ +## ИнициализироватьПечатнуюФорму +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Работа с макетами офисных документов. + +// Секция содержит интерфейсные функции (API), используемые при создании +// печатных форм основанных на офисных документах. На данный момент поддерживается +// офисные пакеты, работающие с форматом Office Open XML (MS Office, Open Office, Google Docs). +// +//////////////////////////////////////////////////////////////////////////////// +// Типы используемых данных (определяется конкретными реализациями). +// СсылкаПечатнаяФорма - ссылка на печатную форму. +// СсылкаМакет - ссылка на макет. +// Область - ссылка на область в печатной форме или макете (структура) +// доопределяется в интерфейсном модуле служебной информацией +// об области. +// ОписаниеОбласти - описание области макета (см. ниже). +// ДанныеЗаполнения - либо структура, либо массив структур (для случая +// списков и таблиц. +//////////////////////////////////////////////////////////////////////////////// +// ОписаниеОбласти - структура, описывающая подготовленные пользователем области макета +// ключ ИмяОбласти - имя области +// ключ ТипТипОбласти - ВерхнийКолонтитул. +// НижнийКолонтитул +// ВерхнийТитульныйКолонтитул +// НижнийТитульныйКолонтитул +// ВерхнийЧетныйКолонтитул +// НижнийЧетныйКолонтитул +// Общая +// СтрокаТаблицы +// Список +// + +//////////////////////////////////////////////////////////////////////////////// +// Функции инициализации и закрытия ссылок. + +// АПК:1382-выкл - Нельзя определять тип в возвращаемом значении. +// +// Конструктор печатной формы в формате офисного документа. +// +// Параметры: +// УдалитьТипДокумента - Строка - устаревший параметр, не используется; +// УдалитьНастройкиСтраницыМакета - Соответствие - устаревший параметр, не используется; +// Макет - см. ИнициализироватьМакетОфисногоДокумента +// +// Возвращаемое значение: +// Структура - описание создаваемой печатной формы: +// * ИмяКаталога - Строка - путь, куда помещается структура каталогов конечного документа для последующей +// сборки контейнера DOCX. +// * СтруктураДокумента - см. УправлениеПечатьюСлужебный.ИнициализироватьДокумент +// * Тип - Строка +// * ПоследняяВыделеннаяОбласть - Структура +// +Функция ИнициализироватьПечатнуюФорму(Знач УдалитьТипДокумента, Знач УдалитьНастройкиСтраницыМакета = Неопределено, Макет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.ИнициализироватьПечатнуюФорму(УдалитьТипДокумента, УдалитьНастройкиСтраницыМакета, Макет); +``` +
+ +## ИнициализироватьМакетОфисногоДокумента +
+ +Описание, пример вызова + +```bsl +// АПК:1382-вкл + +// Подготавливает макет для использования в процедурах формирования печатной формы. +// +// Параметры: +// ДвоичныеДанныеМакета - ДвоичныеДанные - двоичные данные макета; +// УдалитьТипМакета - Строка - устаревший параметр, не используется; +// УдалитьИмяМакета - Строка - устаревший параметр, не используется. +// +// Возвращаемое значение: +// Структура: +// * ИмяКаталога - Строка - путь, куда распаковывается контейнер DOCX шаблона для дальнейшего анализа; +// * СтруктураДокумента - Структура - информация по областям, разделам и колонтитулам, входящих в шаблон. +// +Функция ИнициализироватьМакетОфисногоДокумента(ДвоичныеДанныеМакета, Знач УдалитьТипМакета, Знач УдалитьИмяМакета = "") Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.ИнициализироватьМакетОфисногоДокумента(ДвоичныеДанныеМакета, УдалитьТипМакета, УдалитьИмяМакета); +``` +
+ +## ОчиститьСсылки +
+ +Описание, пример вызова + +```bsl + + +// Удаляет временные файлы, образовавшиеся после раскрытия xml-структуры макета. +// Необходимо вызывать каждый раз после завершения формирования макета и печатной формы, +// а также в случае аварийного завершения формирования. +// +// Параметры: +// ПечатнаяФорма - см. УправлениеПечатью.ИнициализироватьПечатнуюФорму +// УдалитьЗакрытьПриложение - Булево - устаревший параметр, не используется. +// +Процедура ОчиститьСсылки(ПечатнаяФорма, Знач УдалитьЗакрытьПриложение = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ОчиститьСсылки(ПечатнаяФорма, УдалитьЗакрытьПриложение); +``` +
+ +## СформироватьДокумент +
+ +Описание, пример вызова + +```bsl + +// Формирует файл выходной печатной формы и помещает его в хранилище. +// Необходимо вызывать после помещения в структуру печатной формы всех необходимых областей. +// +// Параметры: +// ПечатнаяФорма - см. УправлениеПечатью.ИнициализироватьПечатнуюФорму. +// +// Возвращаемое значение: +// Строка - адрес хранилища, куда помещается сформированный файл. +// +Функция СформироватьДокумент(Знач ПечатнаяФорма) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.СформироватьДокумент(ПечатнаяФорма) +``` +
+ +## ОбластьМакета +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции получения областей из макета, вывода в печатную форму областей макета +// и заполнение параметров в них. + +// Получает область из макета печатной формы. +// +// Параметры: +// СсылкаНаМакет - Структура - макет печатной формы. +// ОписаниеОбласти - Структура: +// * ИмяОбласти - Строка - имя области; +// * ТипТипОбласти - Строка - тип области: +// "ВерхнийКолонтитул", "НижнийКолонтитул", +// "ВерхнийТитульныйКолонтитул", "НижнийТитульныйКолонтитул", +// "ВерхнийЧетныйКолонтитул", "НижнийЧетныйКолонтитул", +// "Общая", +// "СтрокаТаблицы", +// "Список". +// +// Возвращаемое значение: +// Структура - область макета. +// +Функция ОбластьМакета(СсылкаНаМакет, ОписаниеОбласти) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.ОбластьМакета(СсылкаНаМакет, ОписаниеОбласти) +``` +
+ +## ПрисоединитьОбласть +
+ +Описание, пример вызова + +```bsl + +// Присоединяет область в печатную форму из макета. +// Применяется при одиночном выводе области. +// +// Параметры: +// ПечатнаяФорма - см. УправлениеПечатью.ИнициализироватьПечатнуюФорму. +// ОбластьМакета - см. УправлениеПечатью.ОбластьМакета. +// ПереходНаСледующуюСтроку - Булево - Истина, если требуется вставить разрыв после вывода области. +// +Процедура ПрисоединитьОбласть(ПечатнаяФорма, ОбластьМакета, Знач ПереходНаСледующуюСтроку = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ПрисоединитьОбласть(ПечатнаяФорма, ОбластьМакета, ПереходНаСледующуюСтроку); +``` +
+ +## ЗаполнитьПараметры +
+ +Описание, пример вызова + +```bsl + +// Заполняет параметры области печатной формы. +// +// Параметры: +// ПечатнаяФорма - Структура - область печатной формы либо сама печатная форма. +// Данные - Структура - данные заполнения. +// +Процедура ЗаполнитьПараметры(ПечатнаяФорма, Данные) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ЗаполнитьПараметры(ПечатнаяФорма, Данные) +``` +
+ +## ПрисоединитьОбластьИЗаполнитьПараметры +
+ +Описание, пример вызова + +```bsl + +// Добавляет область в печатную форму из макета, при этом заменяя параметры в области значениями из данных объекта. +// Применяется при одиночном выводе области. +// +// Параметры: +// ПечатнаяФорма - см. УправлениеПечатью.ИнициализироватьПечатнуюФорму. +// ОбластьМакета - см. УправлениеПечатью.ОбластьМакета. +// Данные - Структура - данные заполнения. +// ПереходНаСледующуюСтроку - Булево - Истина, если требуется вставить разрыв после вывода области. +// +Процедура ПрисоединитьОбластьИЗаполнитьПараметры(ПечатнаяФорма, ОбластьМакета, Данные, Знач ПереходНаСледующуюСтроку = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ПрисоединитьОбластьИЗаполнитьПараметры(ПечатнаяФорма, ОбластьМакета, Данные, ПереходНаСледующуюСтроку); +``` +
+ +## ПрисоединитьИЗаполнитьКоллекцию +
+ +Описание, пример вызова + +```bsl + +// Добавляет область в печатную форму из макета, при этом заменяя +// параметры в области значениями из данных объекта. +// Применяется при одиночном выводе области. +// +// Параметры: +// ПечатнаяФорма - см. УправлениеПечатью.ИнициализироватьПечатнуюФорму. +// ОбластьМакета - см. УправлениеПечатью.ОбластьМакета. +// Данные - Массив - коллекция элементов типа Структура - данные объекта. +// ПереходНаСледСтроку - Булево - Истина, если требуется вставить разрыв после вывода области. +// +Процедура ПрисоединитьИЗаполнитьКоллекцию(ПечатнаяФорма, ОбластьМакета, Данные, Знач ПереходНаСледСтроку = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ПрисоединитьИЗаполнитьКоллекцию(ПечатнаяФорма, ОбластьМакета, Данные, ПереходНаСледСтроку); +``` +
+ +## ВставитьРазрывНаНовуюСтроку +
+ +Описание, пример вызова + +```bsl + +// Вставляет разрыв между строками в виде символа перевода строки. +// +// Параметры: +// ПечатнаяФорма - см. УправлениеПечатью.ИнициализироватьПечатнуюФорму. +// +Процедура ВставитьРазрывНаНовуюСтроку(ПечатнаяФорма) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатью.ВставитьРазрывНаНовуюСтроку(ПечатнаяФорма) +``` +
+ +## ФорматнаяСтрокаУФЭБС +
+ +Описание, пример вызова + +```bsl + +// Локализация + +// Устарела. Следует использовать УправлениеПечатьюРФ.ФорматнаяСтрокаУФЭБС. +// +// Формирует форматную строку согласно "Унифицированному формату электронных банковских сообщений" для ее отображения в +// виде QR-кода. +// +// Параметры: +// ДанныеДокумента - Структура - содержит значения полей документа. +// Данные документа будут закодированы согласно стандарту +// "Стандарты финансовых операций. Символы двумерного штрихового кода для осуществления платежей физических лиц". +// ДанныеДокумента должны содержать информацию в полях, описанных ниже. +// Обязательные поля структуры: +// * ТекстПолучателя - Строка - наименование получателя платежа, макс. 160 символов; +// * НомерСчетаПолучателя - Строка - номер счета получателя платежа, макс. 20 символов; +// * НаименованиеБанкаПолучателя - Строка - наименование банка получателя платежа, макс. 45 символов; +// * БИКБанкаПолучателя - Строка - макс. 9 символов; +// * СчетБанкаПолучателя - Строка - номер к/с банка получателя платежа, макс. 20 символов; +// Дополнительные поля структуры: +// * СуммаЧислом - Строка - сумма платежа, в рублях, макс. 16 символов. +// * НазначениеПлатежа - Строка - наименование платежа (назначение), макс. 210 символов; +// * ИННПолучателя - Строка - ИНН получателя платежа, макс. 12 символов; +// * ИННПлательщика - Строка - ИНН плательщика, макс. 12 символов; +// * СтатусСоставителя - Строка - статус составителя платежного документа, макс. 2 символа; +// * КПППолучателя - Строка - КПП получателя платежа, макс. 9 символов. +// * КодБК - Строка - КБК, макс. 20 символов; +// * КодОКТМО - Строка - ОКТМО, макс. 11 символов; +// * ПоказательОснования - Строка - основание налогового платежа, макс. 2 символа; +// * ПоказательПериода - Строка - налоговый период, макс. 10 символов; +// * ПоказательНомера - Строка - номер документа, макс. 15 символов; +// * ПоказательДаты - Строка - дата документа, макс. 10 символов. +// * ПоказательТипа - Строка - тип платежа, макс. 2 символа. +// Прочие дополнительные поля: +// * ФамилияПлательщика - Строка - фамилия плательщика. +// * ИмяПлательщика - Строка - имя плательщика. +// * ОтчествоПлательщика - Строка - отчество плательщика. +// * АдресПлательщика - Строка - адрес плательщика. +// * ЛицевойСчетБюджетногоПолучателя - Строка - лицевой счет бюджетного получателя. +// * ИндексПлатежногоДокумента - Строка - индекс платежного документа. +// * СНИЛС - Строка - № лицевого счета в системе персонифицированного учета в ПФР - СНИЛС. +// * НомерДоговора - Строка - номер договора. +// * НомерЛицевогоСчетаПлательщика - Строка - номер лицевого счета плательщика в организации (в системе учета ПУ). +// * НомерКвартиры - Строка - номер квартиры. +// * НомерТелефона - Строка - номер телефона. +// * ВидПлательщика - Строка - вид ДУЛ плательщика. +// * НомерПлательщик - Строка - номер ДУЛ плательщика. +// * ФИОРебенка - Строка - ФИО ребенка/учащегося. +// * ДатаРождения - Строка - дата рождения. +// * СрокПлатежа - Строка - срок платежа/дата выставления счета. +// * ПериодОплаты - Строка - период оплаты. +// * ВидПлатежа - Строка - вид платежа. +// * КодУслуги - Строка - код услуги/название прибора учета. +// * НомерПрибораУчета - Строка - номер прибора учета. +// * ПоказаниеПрибораУчета - Строка - показание прибора учета. +// * НомерИзвещения - Строка - номер извещения, начисления, счета. +// * ДатаИзвещения - Строка - дата извещения/начисления/счета/постановления (для ГИБДД). +// * НомерУчреждения - Строка - номер учреждения (образовательного, медицинского). +// * НомерГруппы - Строка - номер группы детсада/класса школы. +// * ФИОПреподавателя - Строка - ФИО преподавателя, специалиста, оказывающего услугу. +// * СуммаСтраховки - Строка - сумма страховки/дополнительной услуги/Сумма пени (в копейках). +// * НомерПостановления - Строка - номер постановления (для ГИБДД). +// * НомерИсполнительногоПроизводства - Строка - номер исполнительного производства. +// * КодВидаПлатежа - Строка - код вида платежа (например, для платежей в адрес Росреестра). +// * ИдентификаторНачисления - Строка - уникальный идентификатор начисления. +// * ТехническийКод - Строка - технический код, рекомендуемый для заполнения поставщиком услуг. +// Может использоваться принимающей организацией для вызова соответствующей +// обрабатывающей ИТ-системы. +// Перечень значений кода представлен ниже. +// +// Код назначения Наименование назначения платежа +// платежа. +// +// 01 Мобильная связь, стационарный телефон. +// 02 Коммунальные услуги, ЖКХ. +// 03 ГИБДД, налоги, пошлины, бюджетные платежи. +// 04 Охранные услуги +// 05 Услуги, оказываемые УФМС. +// 06 ПФР +// 07 Погашение кредитов +// 08 Образовательные учреждения. +// 09 Интернет и ТВ +// 10 Электронные деньги +// 11 Отдых и путешествия. +// 12 Инвестиции и страхование. +// 13 Спорт и здоровье +// 14 Благотворительные и общественные организации. +// 15 Прочие услуги. +// +// Возвращаемое значение: +// Строка - строка данных в формате УФЭБС. +// +Функция ФорматнаяСтрокаУФЭБС(ДанныеДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатью.ФорматнаяСтрокаУФЭБС(ДанныеДокумента) +``` +
+ +## ДанныеQRКода +
+ +Описание, пример вызова + +```bsl + +// Конец Локализация + +// Устарела. Следует использовать ГенерацияШтрихкода.ДанныеQRКода +// или ГенерацияШтрихкода.ИзображениеШтрихкода. +// +// Возвращает двоичные данные для формирования 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Строка, УровеньКоррекции, Размер) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеПечатьюВызовСервера.md b/src/content/docs/bsp/УправлениеПечатьюВызовСервера.md new file mode 100644 index 0000000..1da992e --- /dev/null +++ b/src/content/docs/bsp/УправлениеПечатьюВызовСервера.md @@ -0,0 +1,47 @@ +--- +title: Управление печатью вызов сервера +slug: bsp/управление-печатью-вызов-сервера +--- + + +## МакетыИДанныеОбъектовДляПечати +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатью.МакетыИДанныеОбъектовДляПечати и серверный механизм +// формирования печатных форм по макетам офисных документов. +// Получает за один вызов всю необходимую информацию для печати: данные объектов по макетам, двоичные +// данные макетов, описание областей макетов. +// Для вызова из клиентских модулей печати форм по макетам офисных документов. +// +// Параметры: +// ИмяМенеджераПечати - Строка - имя для обращения к менеджеру объекта, например "Документ.<Имя документа>". +// ИменаМакетов - Строка - имена макетов, по которым будут формироваться печатные формы. +// СоставДокументов - Массив - ссылки на объекты информационной базы (должны быть одного типа). +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение - коллекция ссылок на объекты и их данные: +// * Ключ - ЛюбаяСсылка - ссылка на объект информационной базы; +// * Значение - Структура: +// ** Ключ - Строка - имя макета; +// ** Значение - Структура - данные объекта. +// +Функция МакетыИДанныеОбъектовДляПечати(Знач ИмяМенеджераПечати, Знач ИменаМакетов, Знач СоставДокументов) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатьюВызовСервера.МакетыИДанныеОбъектовДляПечати(ИмяМенеджераПечати, ИменаМакетов, СоставДокументов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеПечатьюКлиент.md b/src/content/docs/bsp/УправлениеПечатьюКлиент.md new file mode 100644 index 0000000..2d3230b --- /dev/null +++ b/src/content/docs/bsp/УправлениеПечатьюКлиент.md @@ -0,0 +1,689 @@ +--- +title: Управление печатью клиент +slug: bsp/управление-печатью-клиент +--- + + +## ВыполнитьКомандуПечати +
+ +Описание, пример вызова + +```bsl + +// Формирует и выводит на экран печатные формы. +// +// Параметры: +// ИмяМенеджераПечати - Строка - менеджер печати для печатаемых объектов; +// ИменаМакетов - Строка - идентификаторы печатных форм; +// МассивОбъектов - ЛюбаяСсылка +// - Массив из ЛюбаяСсылка - объекты печати; +// ВладелецФормы - ФормаКлиентскогоПриложения - форма, из которой выполняется печать; +// ПараметрыПечати - Структура - произвольные параметры для передачи в менеджер печати. +// +// Пример: +// УправлениеПечатьюКлиент.ВыполнитьКомандуПечати("Обработка.ПечатнаяФорма", "СписаниеТоваров", ДокументыНаПечать, ЭтотОбъект); +// +Процедура ВыполнитьКомандуПечати(ИмяМенеджераПечати, ИменаМакетов, МассивОбъектов, ВладелецФормы, ПараметрыПечати = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ВыполнитьКомандуПечати(ИмяМенеджераПечати, ИменаМакетов, МассивОбъектов, ВладелецФормы, ПараметрыПечати); +``` +
+ +## ВыполнитьКомандуПечатиНаПринтер +
+ +Описание, пример вызова + +```bsl + +// Формирует и выводит на принтер печатные формы. +// +// Параметры: +// ИмяМенеджераПечати - Строка - менеджер печати для печатаемых объектов; +// ИменаМакетов - Строка - идентификаторы печатных форм; +// МассивОбъектов - ЛюбаяСсылка +// - Массив из ЛюбаяСсылка - объекты печати; +// ПараметрыПечати - Структура - произвольные параметры для передачи в менеджер печати. +// +// Пример: +// УправлениеПечатьюКлиент.ВыполнитьКомандуПечатиНаПринтер("Обработка.ПечатнаяФорма", "СписаниеТоваров", ДокументыНаПечать); +// +Процедура ВыполнитьКомандуПечатиНаПринтер(ИмяМенеджераПечати, ИменаМакетов, МассивОбъектов, ПараметрыПечати = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ВыполнитьКомандуПечатиНаПринтер(ИмяМенеджераПечати, ИменаМакетов, МассивОбъектов, ПараметрыПечати); +``` +
+ +## РаспечататьТабличныеДокументы +
+ +Описание, пример вызова + +```bsl + +// Вывести табличные документы на принтер. +// +// Параметры: +// ТабличныеДокументы - СписокЗначений - печатные формы. +// ОбъектыПечати - СписокЗначений - соответствие объектов именам областей табличного документа. +// ПечататьКомплектами - Булево +// - Неопределено - не используется (вычисляется автоматически). +// КоличествоКопийКомплектов - Число - количество экземпляров каждого из комплектов документов. +// +Процедура РаспечататьТабличныеДокументы(ТабличныеДокументы, ОбъектыПечати, Знач ПечататьКомплектами = Неопределено, Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.РаспечататьТабличныеДокументы(ТабличныеДокументы, ОбъектыПечати, ПечататьКомплектами, ); +``` +
+ +## ПроверитьПроведенностьДокументов +
+ +Описание, пример вызова + +```bsl + +// Выполняет интерактивное проведение документов перед печатью. +// Если есть непроведенные документы, предлагает выполнить проведение. Спрашивает +// пользователя о продолжении, если какие-то из документов не провелись и имеются проведенные. +// +// Параметры: +// ОписаниеПроцедурыЗавершения - ОписаниеОповещения - процедура, в которую необходимо передать управление после +// выполнения. +// Параметры вызываемой процедуры: +// СписокДокументов - Массив - проведенные документы; +// ДополнительныеПараметры - значение, которое было указано при создании объекта +// оповещения. +// СписокДокументов - Массив - ссылки на документы, которые требуется провести. +// Форма - ФормаКлиентскогоПриложения - форма, из которой было вызвана команда. Параметр +// требуется, когда процедура +// вызвана из формы объекта, для того чтобы перечитать форму. +// +Процедура ПроверитьПроведенностьДокументов(ОписаниеПроцедурыЗавершения, СписокДокументов, Форма = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ПроверитьПроведенностьДокументов(ОписаниеПроцедурыЗавершения, СписокДокументов, Форма); +``` +
+ +## ПечатьДокументов +
+ +Описание, пример вызова + +```bsl + +// Открывает форму ПечатьДокументов для коллекции табличных документов. +// +// Параметры: +// КоллекцияПечатныхФорм - Массив из см. НоваяКоллекцияПечатныхФорм +// ОбъектыПечати - СписокЗначений - см. УправлениеПечатьюПереопределяемый.ПриПечати +// ДополнительныеПараметры - см. ПараметрыПечати +// - ФормаКлиентскогоПриложения - форма, из которой выполняется печать; +// +Процедура ПечатьДокументов(КоллекцияПечатныхФорм, Знач ОбъектыПечати = Неопределено, Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ПечатьДокументов(КоллекцияПечатныхФорм, ОбъектыПечати, ); +``` +
+ +## ПараметрыПечати +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра ДополнительныеПараметры процедуры ПечатьДокументов. +// +// Возвращаемое значение: +// Структура - дополнительные параметры открытия формы печати: +// * ВладелецФормы - ФормаКлиентскогоПриложения - форма, из которой выполняется печать. +// * Заголовок - Строка - заголовок формы ПечатьДокументов. +// +Функция ПараметрыПечати() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатьюКлиент.ПараметрыПечати() +``` +
+ +## НоваяКоллекцияПечатныхФорм +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра КоллекцияПечатныхФорм для процедур и функций этого модуля. +// См. ПечатьДокументов() +// См. ОписаниеПечатнойФормы(). +// +// Параметры: +// Идентификаторы - Строка - идентификаторы печатных форм. +// +// Возвращаемое значение: +// Массив - коллекция описаний печатных форм. Коллекция предназначена для использования в качестве +// параметра КоллекцияПечатныхФорм в других процедурах клиентского программного интерфейса подсистемы. +// Для обращения к элементам коллекции необходимо использовать функцию ОписаниеПечатнойФормы. +// +Функция НоваяКоллекцияПечатныхФорм(Знач Идентификаторы) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатьюКлиент.НоваяКоллекцияПечатныхФорм(Идентификаторы) +``` +
+ +## ОписаниеПечатнойФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание найденной в коллекции печатной формы. +// Если описание не существует, возвращает Неопределено. +// +// Параметры: +// КоллекцияПечатныхФорм - Массив из см. НоваяКоллекцияПечатныхФорм. +// Идентификатор - Строка - идентификатор печатной формы. +// +// Возвращаемое значение: +// Структура - найденное описание печатной формы в коллекции печатных форм: +// * СинонимМакета - Строка - представление печатной формы; +// * ТабличныйДокумент - ТабличныйДокумент - печатная форма; +// * Экземпляров - Число - количество копий, которое необходимо вывести на печать; +// * ПолныйПутьКМакету - Строка - используется для быстрого перехода к редактированию макета печатной формы; +// * ИмяФайлаПечатнойФормы - Строка - имя файла; +// - Соответствие из КлючИЗначение - имена файлов для каждого объекта: +// ** Ключ - ЛюбаяСсылка - ссылка на объект печати; +// ** Значение - Строка - имя файла; +// * ОфисныеДокументы - Соответствие из КлючИЗначение - коллекция печатных форм в формате офисных документов: +// ** Ключ - Строка - адрес во временном хранилище двоичных данных печатной формы; +// ** Значение - Строка - имя файла печатной формы. +// +Функция ОписаниеПечатнойФормы(КоллекцияПечатныхФорм, Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатьюКлиент.ОписаниеПечатнойФормы(КоллекцияПечатныхФорм, Идентификатор) +``` +
+ +## ЗадатьДействиеПриВыбореМакетаПечатнойФормы +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора режима открытия макетов. +// +Процедура ЗадатьДействиеПриВыбореМакетаПечатнойФормы() Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ЗадатьДействиеПриВыбореМакетаПечатнойФормы() +``` +
+ +## ПоказатьИнструкциюПоСозданиюФаксимильнойПодписиИПечати +
+ +Описание, пример вызова + +```bsl + +// Открывает форму с инструкцией как сделать факсимильную подпись и печать. +Процедура ПоказатьИнструкциюПоСозданиюФаксимильнойПодписиИПечати() Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ПоказатьИнструкциюПоСозданиюФаксимильнойПодписиИПечати() +``` +
+ +## НастройкаТекущейПечатнойФормы +
+ +Описание, пример вызова + +```bsl + +// Предназначена для использования в процедурах модуля УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументов<...>. +// Возвращает коллекцию параметров текущей печатной формы в форме "Печать документов" (ОбщаяФорма.ПечатьДокументов). +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма ПечатьДокументов, переданная в параметре Форма процедуры общего модуля +// УправлениеПечатьюКлиентПереопределяемый. +// +// Возвращаемое значение: +// ДанныеФормыЭлементКоллекции - настройки текущей печатной формы. +// +Функция НастройкаТекущейПечатнойФормы(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатьюКлиент.НастройкаТекущейПечатнойФормы(Форма) +``` +
+ +## ОписаниеПараметровПечати +
+ +Описание, пример вызова + +```bsl + +// Определяет тип параметра ПараметрыПечати в обработчиках команд печати. +// +// Возвращаемое значение: +// Структура: +// * Форма - ФормаКлиентскогоПриложения - форма, в которой выполняется печать. +// * ОбъектыПечати - Массив из ЛюбаяСсылка - объекты, по которым необходимо сформировать печатные формы. +// * Идентификатор - Строка - идентификатор команды печати, по которому менеджер печати определяет печатную +// форму, которую необходимо сформировать. +// Например, "СчетЗаказ". +// +// Для печати нескольких печатных форм можно указывать одновременно несколько их +// идентификаторов (строкой, через запятую либо массивом строк), например: +// "СчетЗаказ,ГарантийноеПисьмо". +// +// Если необходимо задать количество копий печати для печатной формы, то ее +// идентификатор нужно продублировать столько раз, сколько копий необходимо +// сформировать. При этом следует учитывать, что порядок следования печатных +// форм в комплекте будет соответствовать порядку идентификаторов печатных форм, +// указанных в этом параметре. Например (2 счета на оплату + 1 гарантийное письмо): +// "СчетЗаказ,СчетЗаказ,ГарантийноеПисьмо". +// +// Идентификатор печатной формы может содержать в себе и альтернативный менеджер +// печати, если он отличается от указанного в параметре МенеджерПечати, +// например: "СчетЗаказ,Обработка.ПечатнаяФорма.ГарантийноеПисьмо". +// +// В этом примере ГарантийноеПисьмо формируется в менеджере печати +// Обработка.ПечатнаяФорма, а СчетЗаказ - в менеджере печати, указанном в +// параметре МенеджерПечати. +// +// - Массив - список идентификаторов команд печати. +// +// * МенеджерПечати - Строка - (необязательный) имя объекта, в модуле менеджера которого располагается +// процедура Печать, формирующая табличные документы для этой команды. +// Значение по умолчанию - имя модуля менеджера объекта. +// Например, "Документ.СчетНаОплатуПокупателю". +// +// * Обработчик - Строка - (необязательный) клиентский обработчик команды, в который необходимо передать +// управление вместо стандартного обработчика команды Печать. Используется, +// например, когда печатная форма формируется на клиенте. +// Формат "<ИмяОбщегоМодуля>.<ИмяПроцедуры>" используется, когда процедура размещена +// в общем модуле. +// Формат "<ИмяПроцедуры>" используется, когда процедура размещена +// в модуле основной формы отчета или обработки, указанной в МенеджерПечати. +// Например, +// КомандаПечати.Обработчик = "ЗащитаПерсональныхДанныхКлиент.ОткрытьФормуСогласиеНаОбработкуПерсональныхДанных"; +// Пример обработчика в модуле формы: +// // Формирует печатную форму <представление печатной формы>. +// // +// // Параметры: +// // ПараметрыПечати - Структура - сведения о печатной форме. +// // * ОбъектыПечати - Массив - массив ссылок выбранных объектов. +// // * Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана +// // команда печати. +// // * ДополнительныеПараметры - Структура - дополнительные параметры печати. +// // Прочие ключи структуры соответствуют колонкам таблицы КомандыПечати, +// // подробнее см. в функции УправлениеПечатью.СоздатьКоллекциюКомандПечати. +// // +// &НаКлиенте +// Функция <ИмяФункции>(ПараметрыПечати) Экспорт +// // Обработчик печати. +// КонецФункции +// Следует иметь в виду, что обработчик вызывается при помощи метода Вычислить, +// поэтому в качестве обработчика может выступать только функция. +// При этом возвращаемое значение функции никак в дальнейшем не используется подсистемой. +// +// * СразуНаПринтер - Булево - (необязательный) Признак необходимости печати документов без предварительного +// просмотра, сразу на принтер. Если параметр не указан, то при выборе команды +// печати открывается форма предварительного просмотра "Печать документов". +// +// * ФорматСохранения - ТипФайлаТабличногоДокумента - (необязательный) Применяется для быстрого сохранения печатной +// формы (без дополнительных действий) в различные форматы, отличные от mxl. +// Если параметр не указан, то формируется обычный mxl. +// Например, ТипФайлаТабличногоДокумента.PDF. +// +// При выборе команды печати сразу открывается сформированный в формате PDF +// документ. +// +// * ЗаголовокФормы - Строка - (необязательный) Произвольная строка, переопределяющая стандартных заголовок +// формы "Печать документов". +// Например, "Настраиваемый комплект". +// +// * ПереопределитьПользовательскиеНастройкиКоличества - Булево - (необязательный) Признак необходимости отключения в +// форме ПечатьДокументов механизма сохранения/восстановления выбранного +// пользователем количества экземпляров на печать. Если параметр не указан, то +// механизм сохранения/восстановления настроек будет работать при открытии формы. +// ПечатьДокументов. +// +// * ДополнитьКомплектВнешнимиПечатнымиФормами - Булево - (необязательный) Признак необходимости дополнить комплект +// документов всеми подключенными к объекту внешними печатными формами +// (подсистема ДополнительныеОтчетыИОбработки). Если параметр не указан, внешние +// печатные формы не добавляются в комплект. +// * ФиксированныйКомплект - Булево - (необязательный) Признак необходимости блокировки от изменения пользователем +// состава комплекта документов. Если параметр не указан, то пользователь сможет +// исключать отдельные печатные формы из комплекта в форме ПечатьДокументов, а +// также изменять их количество. +// +// * ДополнительныеПараметры - Структура - (необязательный) произвольные параметры для передачи в менеджер печати. +// +// +Функция ОписаниеПараметровПечати() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатьюКлиент.ОписаниеПараметровПечати() +``` +
+ +## ИнициализироватьПечатнуюФорму +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатью.ИнициализироватьПечатнуюФорму. +// +// Создает соединение с выходной печатной формой. +// Необходимо вызвать перед любыми действиями над формой. +// Функция не работает в любых других браузерах кроме IE. +// Перед выполнением функции в веб-клиенте необходимо подключить расширение для работы с 1С:Предприятием. +// +// Параметры: +// ТипДокумента - Строка - тип печатной формы "DOC" или "ODT"; +// НастройкиСтраницыМакета - Соответствие - параметры из структуры, возвращаемой функцией ИнициализироватьМакет +// (параметр устарел, его следует пропускать и использовать параметр Макет); +// Макет - Структура - результат функции ИнициализироватьМакет. +// +// Возвращаемое значение: +// Структура - новая печатная форма. +// +Функция ИнициализироватьПечатнуюФорму(Знач ТипДокумента, Знач НастройкиСтраницыМакета = Неопределено, Макет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатьюКлиент.ИнициализироватьПечатнуюФорму(ТипДокумента, НастройкиСтраницыМакета, Макет); +``` +
+ +## ИнициализироватьМакетОфисногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатью.ИнициализироватьМакетОфисногоДокумента. +// +// Создает COM-соединение с макетом. В дальнейшем это соединение используется при получении из него областей (тегов и +// таблиц). +// Функция не работает в любых других браузерах кроме IE. +// Перед выполнением функции в веб-клиенте необходимо подключить расширение для работы с 1С:Предприятием. +// +// Параметры: +// ДвоичныеДанныеМакета - ДвоичныеДанные - двоичные данные макета; +// ТипМакета - Строка - тип макета печатной формы "DOC" или "ODT"; +// ИмяМакета - Строка - имя, которое будет использовано при создании временного файла макета. +// +// Возвращаемое значение: +// Структура - макет. +// +Функция ИнициализироватьМакетОфисногоДокумента(Знач ДвоичныеДанныеМакета, Знач ТипМакета, Знач ИмяМакета = "") Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатьюКлиент.ИнициализироватьМакетОфисногоДокумента(ДвоичныеДанныеМакета, ТипМакета, ИмяМакета); +``` +
+ +## ОчиститьСсылки +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатью.ОчиститьСсылки. +// +// Освобождает ссылки в созданном интерфейсе связи с офисным приложением. +// Необходимо вызывать каждый раз после завершения формирования макета и выводе печатной формы пользователю. +// +// Параметры: +// ПечатнаяФорма - Структура - результат функций ИнициализироватьПечатнуюФорму и ИнициализироватьМакетОфисногоДокумента; +// ЗакрытьПриложение - Булево - Истина, если требуется ли закрыть приложение. +// Соединение с макетом требуется закрывать с закрытием приложения. +// ПечатнуюФорму не требуется закрывать. +// +Процедура ОчиститьСсылки(ПечатнаяФорма, Знач ЗакрытьПриложение = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ОчиститьСсылки(ПечатнаяФорма, ЗакрытьПриложение); +``` +
+ +## ПоказатьДокумент +
+ +Описание, пример вызова + +```bsl + +// Устарела. Более не требуется. +// +// Показывает сформированный документ пользователю. +// +// Параметры: +// ПечатнаяФорма - Структура - результат функции ИнициализироватьПечатнуюФорму. +// +Процедура ПоказатьДокумент(Знач ПечатнаяФорма) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ПоказатьДокумент(ПечатнаяФорма) +``` +
+ +## ОбластьМакета +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Функции получения областей из макета, вывода в печатную форму областей макета +// и заполнение параметров в них. + +// Устарела. Следует использовать УправлениеПечатью.ОбластьМакета. +// +// Получает область из макета печатной формы. +// +// Параметры: +// СсылкаНаМакет - Структура - макет печатной формы. +// ОписаниеОбласти - Структура: +// * ИмяОбласти - Строка -имя области; +// * ТипТипОбласти - Строка - тип области: "ВерхнийКолонтитул", "НижнийКолонтитул", "Общая", "СтрокаТаблицы", "Список". +// +// Возвращаемое значение: +// Структура - область макета. +// +Функция ОбластьМакета(Знач СсылкаНаМакет, Знач ОписаниеОбласти) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатьюКлиент.ОбластьМакета(СсылкаНаМакет, ОписаниеОбласти) +``` +
+ +## ПрисоединитьОбласть +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатью.ПрисоединитьОбласть. +// +// Присоединяет область в печатную форму из макета. +// Применяется при одиночном выводе области. +// +// Параметры: +// ПечатнаяФорма - см. ИнициализироватьПечатнуюФорму. +// ОбластьМакета - см. ОбластьМакета. +// ПереходНаСледующуюСтроку - Булево - Истина, если требуется вставить разрыв после вывода области. +// +Процедура ПрисоединитьОбласть(Знач ПечатнаяФорма, Знач ОбластьМакета, Знач ПереходНаСледующуюСтроку = Истина) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ПрисоединитьОбласть(ПечатнаяФорма, ОбластьМакета, ПереходНаСледующуюСтроку); +``` +
+ +## ЗаполнитьПараметры +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатью.ЗаполнитьПараметры. +// +// Заполняет параметры области печатной формы. +// +// Параметры: +// ПечатнаяФорма - Структура - область печатной формы, либо сама печатная форма. +// Данные - Структура - данные заполнения. +// +Процедура ЗаполнитьПараметры(Знач ПечатнаяФорма, Знач Данные) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ЗаполнитьПараметры(ПечатнаяФорма, Данные) +``` +
+ +## ПрисоединитьОбластьИЗаполнитьПараметры +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатью.ПрисоединитьОбластьИЗаполнитьПараметры. +// +// Добавляет область в печатную форму из макета, при этом заменяя параметры в области значениями из данных объекта. +// Применяется при одиночном выводе области. +// +// Параметры: +// ПечатнаяФорма - см. ИнициализироватьПечатнуюФорму. +// ОбластьМакета - см. ОбластьМакета. +// Данные - Структура - данные заполнения. +// ПереходНаСледующуюСтроку - Булево - Истина, если требуется вставить разрыв после вывода области. +// +Процедура ПрисоединитьОбластьИЗаполнитьПараметры(Знач ПечатнаяФорма, Знач ОбластьМакета, Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ПрисоединитьОбластьИЗаполнитьПараметры(ПечатнаяФорма, ОбластьМакета, ); +``` +
+ +## ПрисоединитьИЗаполнитьКоллекцию +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатью.ПрисоединитьИЗаполнитьКоллекцию. +// +// Добавляет область в печатную форму из макета, при этом заменяя +// параметры в области значениями из данных объекта. +// Применяется при одиночном выводе области. +// +// Параметры: +// ПечатнаяФорма - см. ИнициализироватьПечатнуюФорму. +// ОбластьМакета - см. ОбластьМакета +// Данные - Массив - коллекция элементов типа Структура - данные объекта. +// ПереходНаСледСтроку - Булево - Истина, если требуется вставить разрыв после вывода области. +// +Процедура ПрисоединитьИЗаполнитьКоллекцию(Знач ПечатнаяФорма, Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ПрисоединитьИЗаполнитьКоллекцию(ПечатнаяФорма, ); +``` +
+ +## ВставитьРазрывНаНовуюСтроку +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатью.ВставитьРазрывНаНовуюСтроку. +// +// Вставляет разрыв между строками в виде символа перевода строки. +// +// Параметры: +// ПечатнаяФорма - см. ИнициализироватьПечатнуюФорму. +// +Процедура ВставитьРазрывНаНовуюСтроку(Знач ПечатнаяФорма) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиент.ВставитьРазрывНаНовуюСтроку(ПечатнаяФорма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеПечатьюКлиентПереопределяемый.md b/src/content/docs/bsp/УправлениеПечатьюКлиентПереопределяемый.md new file mode 100644 index 0000000..c9a7f46 --- /dev/null +++ b/src/content/docs/bsp/УправлениеПечатьюКлиентПереопределяемый.md @@ -0,0 +1,125 @@ +--- +title: Управление печатью клиент переопределяемый +slug: bsp/управление-печатью-клиент-переопределяемый +--- + + +## ПечатьДокументовПослеОткрытия +
+ +Описание, пример вызова + +```bsl + +// Вызывается после выполнения обработчика ПриОткрытии формы печати документов (ОбщаяФорма.ПечатьДокументов). +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма ОбщаяФорма.ПечатьДокументов. +// +Процедура ПечатьДокументовПослеОткрытия(Форма) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовПослеОткрытия(Форма) +``` +
+ +## ПечатьДокументовОбработкаНавигационнойСсылки +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика Подключаемый_ОбработкаНавигационнойСсылки формы печати документов (ОбщаяФорма.ПечатьДокументов). +// Позволяет реализовать обработчик нажатия гиперссылки, которая добавлена в форму +// с помощью УправлениеПечатьюПереопределяемый.ПечатьДокументовПриСозданииНаСервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма ОбщаяФорма.ПечатьДокументов. +// Элемент - ПолеФормы - элемент формы, вызвавший данное событие. +// НавигационнаяСсылкаФорматированнойСтроки - Строка - значение гиперссылки форматированной строки. Передается по ссылке. +// СтандартнаяОбработка - Булево - признак выполнения стандартной (системной) обработки события. Если установить +// значение Ложь, стандартная обработка события производиться не будет. +// +Процедура ПечатьДокументовОбработкаНавигационнойСсылки(Форма, Элемент, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовОбработкаНавигационнойСсылки(Форма, Элемент, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) +``` +
+ +## ПечатьДокументовВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика Подключаемый_ВыполнитьКоманду формы печати документов (ОбщаяФорма.ПечатьДокументов). +// Позволяет реализовать клиентскую часть обработчика команды, которая добавлена в форму +// с помощью УправлениеПечатьюПереопределяемый.ПечатьДокументовПриСозданииНаСервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма ОбщаяФорма.ПечатьДокументов. +// Команда - КомандаФормы - выполняемая команда. +// ПродолжитьВыполнениеНаСервере - Булево - при установке значения Истина, выполнение обработчика будет продолжено в +// серверном контексте в процедуре УправлениеПечатьюПереопределяемый.ПечатьДокументовПриВыполненииКоманды. +// ДополнительныеПараметры - Произвольный - параметры, которые необходимо передать в серверный контекст. +// +// Пример: +// Если Команда.Имя = "МояКоманда" Тогда +// НастройкаПечатнойФормы = УправлениеПечатьюКлиент.НастройкаТекущейПечатнойФормы(Форма); +// +// ДополнительныеПараметры = Новый Структура; +// ДополнительныеПараметры.Вставить("ИмяКоманды", Команда.Имя); +// ДополнительныеПараметры.Вставить("ИмяРеквизитаТабличногоДокумента", НастройкаПечатнойФормы.ИмяРеквизита); +// ДополнительныеПараметры.Вставить("НазваниеПечатнойФормы", НастройкаПечатнойФормы.Название); +// +// ПродолжитьВыполнениеНаСервере = Истина; +// КонецЕсли; +// +Процедура ПечатьДокументовВыполнитьКоманду(Форма, Команда, ПродолжитьВыполнениеНаСервере, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовВыполнитьКоманду(Форма, Команда, ПродолжитьВыполнениеНаСервере, ДополнительныеПараметры) +``` +
+ +## ПечатьДокументовОбработкаОповещения +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ОбработкаОповещения формы ПечатьДокументов. +// Позволяет реализовать обработчик внешнего события в форме. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма ОбщаяФорма.ПечатьДокументов. +// ИмяСобытия - Строка - идентификатор оповещения. +// Параметр - Произвольный - произвольный параметр оповещения. +// Источник - Произвольный - источник события. +// +Процедура ПечатьДокументовОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеПечатьюМультиязычностьПереопределяемый.md b/src/content/docs/bsp/УправлениеПечатьюМультиязычностьПереопределяемый.md new file mode 100644 index 0000000..642b870 --- /dev/null +++ b/src/content/docs/bsp/УправлениеПечатьюМультиязычностьПереопределяемый.md @@ -0,0 +1,34 @@ +--- +title: Управление печатью мультиязычность переопределяемый +slug: bsp/управление-печатью-мультиязычность-переопределяемый +--- + + +## ПриОпределенииДоступныхДляПереводаМакетов +
+ +Описание, пример вызова + +```bsl + +// Определяет макеты печатных форм, в которых поддерживается перевод на другие языки. +// +// Параметры: +// Макеты - Массив из ОбъектМетаданныхМакет +// +Процедура ПриОпределенииДоступныхДляПереводаМакетов(Макеты) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюМультиязычностьПереопределяемый.ПриОпределенииДоступныхДляПереводаМакетов(Макеты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеПечатьюПереопределяемый.md b/src/content/docs/bsp/УправлениеПечатьюПереопределяемый.md new file mode 100644 index 0000000..0781c71 --- /dev/null +++ b/src/content/docs/bsp/УправлениеПечатьюПереопределяемый.md @@ -0,0 +1,564 @@ +--- +title: Управление печатью переопределяемый +slug: bsp/управление-печатью-переопределяемый +--- + + +## ПриОпределенииНастроекПечати +
+ +Описание, пример вызова + +```bsl + +// Переопределяет настройки подсистемы. +// +// Параметры: +// Настройки - Структура: +// * ИспользоватьПодписиИПечати - Булево - при установке значения Ложь отключается возможность установки подписей +// и печатей в печатных формах. +// * СкрыватьПодписиИПечатиДляРедактирования - Булево - удалять рисунки подписей и печатей табличных документов при +// снятии флажка "Подписи и печати" в форме "Печать документов", для того, +// чтобы они не мешали редактировать текст, находящийся под ними. +// * ПроверкаПроведенияПередПечатью - Булево - признак необходимости проверки проведенности +// документов перед печатью, является значением по умолчанию для команды печати +// см. УправлениеПечатью.СоздатьКоллекциюКомандПечати. +// Для непроведенных документов команда печати не выполняется. +// Если параметр не указан, то проверка проведенности не выполняется. +// * ОбъектыПечати - Массив - менеджеры объектов с процедурой ПриОпределенииНастроекПечати. +// +Процедура ПриОпределенииНастроекПечати(Настройки) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПриОпределенииНастроекПечати(Настройки) +``` +
+ +## ПередДобавлениемКомандПечати +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить список команд печати в произвольной форме. +// Может использоваться для общих форм, у которых нет модуля менеджера для размещения в нем процедуры ДобавитьКомандыПечати, +// для случаев, когда штатных средств добавления команд в такие формы недостаточно. +// Например, если в общих формах нужны специфические команды печати. +// Вызывается из функции УправлениеПечатью.КомандыПечатиФормы. +// +// Параметры: +// ИмяФормы - Строка - полное имя формы, в которой добавляются команды печати; +// КомандыПечати - см. УправлениеПечатью.СоздатьКоллекциюКомандПечати +// СтандартнаяОбработка - Булево - при установке значения Ложь не будет автоматически заполняться коллекция КомандыПечати. +// +// Пример: +// Если ИмяФормы = "ОбщаяФорма.ЖурналДокументов" Тогда +// Если Пользователи.РолиДоступны("ПечатьСчетаНаОплатуНаПринтер") Тогда +// КомандаПечати = КомандыПечати.Добавить(); +// КомандаПечати.Идентификатор = "Счет"; +// КомандаПечати.Представление = НСтр("ru = 'Счет на оплату (на принтер)'"); +// КомандаПечати.Картинка = БиблиотекаКартинок.ПечатьСразу; +// КомандаПечати.ПроверкаПроведенияПередПечатью = Истина; +// КомандаПечати.СразуНаПринтер = Истина; +// КонецЕсли; +// КонецЕсли; +// +Процедура ПередДобавлениемКомандПечати(ИмяФормы, КомандыПечати, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПередДобавлениемКомандПечати(ИмяФормы, КомандыПечати, СтандартнаяОбработка) +``` +
+ +## ПриПолученииНастроекСпискаКомандПечати +
+ +Описание, пример вызова + +```bsl + +// Позволяет задать дополнительные настройки команд печати в журналах документов. +// +// Параметры: +// НастройкиСписка - Структура - модификаторы списка команд печати: +// * МенеджерКомандПечати - ОбщийМодуль - менеджер объекта, в котором формируется список команд печати; +// * АвтоматическоеЗаполнение - Булево - заполнять команды печати из объектов, входящих в состав журнала. +// Если установлено значение Ложь, то список команд печати журнала будет +// заполнен вызовом метода ДобавитьКомандыПечати из модуля менеджера журнала. +// Значение по умолчанию - Истина - метод ДобавитьКомандыПечати будет вызван из +// модулей менеджеров документов, входящих в состав журнала. +// +// Пример: +// Если НастройкиСписка.МенеджерКомандПечати = "ЖурналДокументов.СкладскиеДокументы" Тогда +// НастройкиСписка.АвтоматическоеЗаполнение = Ложь; +// КонецЕсли; +// +Процедура ПриПолученииНастроекСпискаКомандПечати(НастройкиСписка) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПриПолученииНастроекСпискаКомандПечати(НастройкиСписка) +``` +
+ +## ПриПечати +
+ +Описание, пример вызова + +```bsl + +// Позволяет выполнить постобработку печатных форм при их формировании. +// Например, можно вставить в печатную форму дату формирования. +// Вызывается после завершения процедуры Печать менеджера печати объекта, имеет те же параметры. +// Не вызывается при вызове УправлениеПечатьюКлиент.ПечатьДокументов. +// +// Параметры: +// МассивОбъектов - Массив из ЛюбаяСсылка - список объектов, для которых была выполняется команда печати; +// ПараметрыПечати - Структура - произвольные параметры, переданные при вызове команды печати; +// КоллекцияПечатныхФорм - ТаблицаЗначений - возвращаемый параметр, коллекция сформированных печатных форм: +// * ИмяМакета - Строка - идентификатор печатной формы; +// * СинонимМакета - Строка - название печатной формы; +// +// * ТабличныйДокумент - ТабличныйДокумент - одна или несколько печатных форм, выведенных в один табличный документ +// Для разметки печатных форм внутри табличного документа после вывода каждой печатной формы +// необходимо вызывать процедуру УправлениеПечатью.ЗадатьОбластьПечатиДокумента; +// Параметр не используется, если вывод печатных форм выполняется в формате офисных документов +// (см. параметр "ОфисныеДокументы"); +// +// * ОфисныеДокументы - Соответствие из КлючИЗначение - коллекция печатных форм в формате офисных документов: +// ** Ключ - Строка - адрес во временном хранилище двоичных данных печатной формы; +// ** Значение - Строка - имя файла печатной формы. +// +// * ИмяФайлаПечатнойФормы - Строка - имя файла печатной формы при сохранении в файл или отправке в качестве +// почтового вложения. Не используется для печатных форм в формате офисных документов. +// По умолчанию имя файла устанавливается в формате +// "[НазваниеПечатнойФормы] № [Номер] от [Дата]" для документов, +// "[НазваниеПечатнойФормы] - [ПредставлениеОбъекта] - [ТекущаяДата]" для объектов. +// - Соответствие из КлючИЗначение - имена файлов для каждого объекта: +// ** Ключ - ЛюбаяСсылка - ссылка на объект печати из коллекции МассивОбъектов; +// ** Значение - Строка - имя файла; +// +// * Экземпляров - Число - количество копий, которое необходимо вывести на печать; +// * ПолныйПутьКМакету - Строка - используется для быстрого перехода к редактированию макета печатной формы +// в общей форме ПечатьДокументов; +// * ДоступенВыводНаДругихЯзыках - Булево - необходимо установить значение Истина, если печатная форма адаптирована +// для вывода на произвольном языке. +// +// ОбъектыПечати - СписокЗначений - выходной параметр, соответствие между объектами и именами областей в табличных +// документах, заполняется автоматически +// при вызове УправлениеПечатью.ЗадатьОбластьПечатиДокумента: +// * Значение - ЛюбаяСсылка - ссылка из коллекции МассивОбъектов, +// * Представление - Строка - имя области с объектом в табличных документах; +// +// ПараметрыВывода - Структура - настройки вывода печатных форм: +// * ПараметрыОтправки - Структура - для автоматического заполнения полей в форме создания письма при отправке +// сформированных печатных форм по почте: +// ** Получатель - см. РаботаСПочтовымиСообщениямиКлиент.ПараметрыОтправкиПисьма.Получатель +// ** Тема - см. РаботаСПочтовымиСообщениямиКлиент.ПараметрыОтправкиПисьма.Тема +// ** Текст - см. РаботаСПочтовымиСообщениямиКлиент.ПараметрыОтправкиПисьма.Текст +// * КодЯзыка - Строка - язык, на котором требуется сформировать печатную форму. +// Состоит из кода языка по ISO 639-1 и, опционально, кода страны по ISO 3166-1, разделенных +// символом подчеркивания. Примеры: "en", "en_US", "en_GB", "ru", "ru_RU". +// +// * ЗаголовокФормы - Строка - переопределяет заголовок формы печати документов (ПечатьДокументов). +// +// Пример: +// +// ПечатнаяФорма = УправлениеПечатью.СведенияОПечатнойФорме(КоллекцияПечатныхФорм, "<ИдентификаторПечатнойФормы>"); +// Если ПечатнаяФорма <> Неопределено Тогда +// ТабличныйДокумент = Новый ТабличныйДокумент; +// ТабличныйДокумент.КлючПараметровПечати = "<КлючСохраненияПараметровПечатнойФормы>"; +// Для Каждого Ссылка Из МассивОбъектов Цикл +// Если ТабличныйДокумент.ВысотаТаблицы > 0 Тогда +// ТабличныйДокумент.ВывестиГоризонтальныйРазделительСтраниц(); +// КонецЕсли; +// НачалоОбласти = ТабличныйДокумент.ВысотаТаблицы + 1; +// // ... код по формированию табличного документа ... +// УправлениеПечатью.ЗадатьОбластьПечатиДокумента(ТабличныйДокумент, НачалоОбласти, ОбъектыПечати, Ссылка); +// КонецЦикла; +// ПечатнаяФорма.ТабличныйДокумент = ТабличныйДокумент; +// КонецЕсли; +// +Процедура ПриПечати(МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПриПечати(МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) +``` +
+ +## ПередПечатью +
+ +Описание, пример вызова + +```bsl + +// Позволяет выполнить переопределение данных печатной формы перед формированием. +// +// Параметры: +// ИдентификаторПечатнойФормы - Строка - идентификатор печатной формы; +// ОбъектыПечати - Массив - коллекция ссылок на объекты печати; +// ПараметрыПечати - Структура - произвольные параметры, переданные при вызове команды печати; +// +Процедура ПередПечатью(Знач ИдентификаторПечатнойФормы, ОбъектыПечати, ПараметрыПечати) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПередПечатью(ИдентификаторПечатнойФормы, ОбъектыПечати, ПараметрыПечати) +``` +
+ +## ПередОтправкойПоПочте +
+ +Описание, пример вызова + +```bsl + +// Переопределяет параметры отправки печатных форм при подготовке письма. +// Может использоваться, например, для подготовки текста письма. +// +// Параметры: +// ПараметрыОтправки - Структура: +// * Получатель - Массив - коллекция имен получателей; +// * Тема - Строка - тема письма; +// * Текст - Строка - текст письма; +// * Вложения - Структура: +// ** АдресВоВременномХранилище - Строка - адрес вложения во временном хранилище; +// ** Представление - Строка - имя файла вложения. +// ОбъектыПечати - Массив - коллекция объектов, по которым сформированы печатные формы. +// ПараметрыВывода - Структура - параметр ПараметрыВывода в вызове процедуры Печать. +// ПечатныеФормы - ТаблицаЗначений - коллекция табличных документов: +// * Название - Строка - название печатной формы; +// * ТабличныйДокумент - ТабличныйДокумент - печатная форма. +// +Процедура ПередОтправкойПоПочте(ПараметрыОтправки, ПараметрыВывода, ОбъектыПечати, ПечатныеФормы) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПередОтправкойПоПочте(ПараметрыОтправки, ПараметрыВывода, ОбъектыПечати, ПечатныеФормы) +``` +
+ +## ПриПолученииПодписейИПечатей +
+ +Описание, пример вызова + +```bsl + +// Определяет набор подписей и печатей для документов. +// +// Параметры: +// Документы - Массив - коллекция ссылок на объекты печати; +// ПодписиИПечати - Соответствие из КлючИЗначение - коллекция объектов печати и комплектов подписей/печатей к ним: +// * Ключ - ЛюбаяСсылка - ссылка на объект печати; +// * Значение - Структура - комплект подписей и печатей: +// ** Ключ - Строка - идентификатор подписи или печати в макете печатной формы, +// должен начинаться с "Подпись...", "Печать..." или "Факсимиле...", +// например, "ПодписьРуководителя", "ПечатьОрганизации"; +// ** Значение - Картинка - изображение подписи или печати. +// +Процедура ПриПолученииПодписейИПечатей(Документы, ПодписиИПечати) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПриПолученииПодписейИПечатей(Документы, ПодписиИПечати) +``` +
+ +## ПечатьДокументовПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ПриСозданииНаСервере формы печати документов (ОбщаяФорма.ПечатьДокументов). +// Позволяет изменить внешний вид и поведение формы, например, разместить на ней дополнительные элементы: +// информационные надписи, кнопки, гиперссылки, различные настройки и т.п. +// +// При добавлении команд (кнопок) в качестве обработчика следует указывать имя "Подключаемый_ВыполнитьКоманду", +// а его реализацию размещать в УправлениеПечатьюПереопределяемый.ПечатьДокументовПриВыполненииКоманды (серверная часть), +// либо в УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовВыполнитьКоманду (клиентская часть). +// +// Для того, чтобы добавить свою команду на форму, необходимо сделать следующее. +// 1. Создать команду и кнопку в УправлениеПечатьюПереопределяемый.ПечатьДокументовПриСозданииНаСервере. +// 2. Реализовать клиентский обработчик команды в УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовВыполнитьКоманду. +// 3. (Опционально) Реализовать серверный обработчик команды в УправлениеПечатьюПереопределяемый.ПечатьДокументовПриВыполненииКоманды. +// +// При добавлении гиперссылок в качестве обработчика нажатия следует указывать имя "Подключаемый_ОбработкаНавигационнойСсылки", +// а его реализацию размещать в УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовОбработкаНавигационнойСсылки. +// +// При размещении элементов, значение которых должны запоминаться между открытиями формы печати, +// следует воспользоваться процедурами ПечатьДокументовПриЗагрузкеДанныхИзНастроекНаСервере и +// ПечатьДокументовПриСохраненииДанныхВНастройкахНаСервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма ОбщаяФорма.ПечатьДокументов. +// Отказ - Булево - признак отказа от создания формы. Если установить +// данному параметру значение Истина, то форма создана не будет. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной (системной) обработки +// события. Если установить данному параметру значение Ложь, +// стандартная обработка события производиться не будет. +// +// Пример: +// КомандаФормы = Форма.Команды.Добавить("МояКоманда"); +// КомандаФормы.Действие = "Подключаемый_ВыполнитьКоманду"; +// КомандаФормы.Заголовок = НСтр("ru = 'Моя команда'"); +// +// КнопкаФормы = Форма.Элементы.Добавить(КомандаФормы.Имя, Тип("КнопкаФормы"), Форма.Элементы.КоманднаяПанельПраваяЧасть); +// КнопкаФормы.Вид = ВидКнопкиФормы.КнопкаКоманднойПанели; +// КнопкаФормы.ИмяКоманды = КомандаФормы.Имя; +// +Процедура ПечатьДокументовПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПечатьДокументовПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) +``` +
+ +## ПечатьДокументовПриЗагрузкеДанныхИзНастроекНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ПриЗагрузкеДанныхИзНастроекНаСервере формы печати документов (ОбщаяФорма.ПечатьДокументов). +// Совместно с ПечатьДокументовПриСохраненииДанныхВНастройкахНаСервере позволяет реализовать загрузку и сохранение +// настроек элементов управления, размещенных с помощью ПечатьДокументовПриСозданииНаСервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма ОбщаяФорма.ПечатьДокументов. +// Настройки - Соответствие - значения реквизитов формы. +// +Процедура ПечатьДокументовПриЗагрузкеДанныхИзНастроекНаСервере(Форма, Настройки) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПечатьДокументовПриЗагрузкеДанныхИзНастроекНаСервере(Форма, Настройки) +``` +
+ +## ПечатьДокументовПриСохраненииДанныхВНастройкахНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ПриСохраненииДанныхВНастройкахНаСервере формы печати документов (ОбщаяФорма.ПечатьДокументов). +// Совместно с ПечатьДокументовПриЗагрузкеДанныхИзНастроекНаСервере позволяет реализовать загрузку и сохранение +// настроек элементов управления, размещенных с помощью ПечатьДокументовПриСозданииНаСервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма ОбщаяФорма.ПечатьДокументов. +// Настройки - Соответствие - значения реквизитов формы. +// +Процедура ПечатьДокументовПриСохраненииДанныхВНастройкахНаСервере(Форма, Настройки) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПечатьДокументовПриСохраненииДанныхВНастройкахНаСервере(Форма, Настройки) +``` +
+ +## ПечатьДокументовПриВыполненииКоманды +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика Подключаемый_ВыполнитьКоманду формы печати документов (ОбщаяФорма.ПечатьДокументов). +// Позволяет реализовать серверную часть обработчика команды, которая добавлена в форму +// с помощью ПечатьДокументовПриСозданииНаСервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма ОбщаяФорма.ПечатьДокументов. +// ДополнительныеПараметры - Произвольный - параметры, переданные из УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовВыполнитьКоманду. +// +// Пример: +// Если ТипЗнч(ДополнительныеПараметры) = Тип("Структура") И ДополнительныеПараметры.ИмяКоманды = "МояКоманда" Тогда +// ТабличныйДокумент = Новый ТабличныйДокумент; +// ТабличныйДокумент.Область("R1C1").Текст = НСтр("ru = 'Пример использования серверного обработчика подключенной команды.'"); +// +// ПечатнаяФорма = Форма[ДополнительныеПараметры.ИмяРеквизитаТабличногоДокумента]; +// ПечатнаяФорма.ВставитьОбласть(ТабличныйДокумент.Область("R1"), ПечатнаяФорма.Область("R1"), +// ТипСмещенияТабличногоДокумента.ПоГоризонтали) +// КонецЕсли; +// +Процедура ПечатьДокументовПриВыполненииКоманды(Форма, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПечатьДокументовПриВыполненииКоманды(Форма, ДополнительныеПараметры) +``` +
+ +## ПриОпределенииИсточниковДанныхПечати +
+ +Описание, пример вызова + +```bsl + +// Определяет используемый макет данных печати для объектов метаданных и отдельных полей. +// По умолчанию используется макет ДанныеПечати у ссылочных объектов. Если макет отсутствует в метаданных, он будет +// сгенерирован автоматически на основе выборки всех реквизитов объекта. В данной процедуре можно переопределить +// состав полей, доступных для печати как для всего объекта, так и для отдельного поля объекта. +// +// Параметры: +// Объект - Строка - полное имя объекта метаданных либо имя поля из макета "ДанныеПечати" объекта метаданных +// в формате "ПолноеИмяОбъектаМетаданных.ИмяПоля". +// ИсточникиДанныхПечати - СписокЗначений: +// * Значение - СхемаКомпоновкиДанных - схема данных печати. Определяет состав подчиненных полей объекта или поля, +// используется при получении данных печати. +// При получении данных печати отбор значений производится по полю Ссылка. +// Поэтому в составе полей схемы компоновки данных обязательно должно +// присутствовать поле Ссылка, даже если оно фактически не ссылочного типа, +// а, например, Строка. +// +// * Представление - Строка - идентификатор схемы, используется в процедуре ПриПодготовкеДанныхПечати. +// Если в качестве идентификатора схемы используется полное имя объекта метаданных, то +// при подготовке данных печати будет вызываться процедура ПриПодготовкеДанныхПечати +// модуля менеджера объекта. Иначе будет вызвана аналогичная процедура этого модуля. +// +// * Пометка -Булево - Истина, если в качестве дополнительного ключевого поля выступает владелец источника данных. +// +Процедура ПриОпределенииИсточниковДанныхПечати(Объект, ИсточникиДанныхПечати) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПриОпределенииИсточниковДанныхПечати(Объект, ИсточникиДанныхПечати) +``` +
+ +## ПриПодготовкеДанныхПечати +
+ +Описание, пример вызова + +```bsl + +// Подготавливает данные печати. Вызывается в случае, если используемая схема компоновки данных содержит набор +// данных Объект. +// В случае, если в качестве идентификатора схемы используется имя объекта метаданных, то вместо этой процедуры +// вызывается аналогичная процедура модуля менеджера объекта. +// +// Параметры: +// ИсточникиДанных - Массив - объекты, для которых формируются данные печати. +// ВнешниеНаборыДанных - Структура - коллекция наборов данных для передачи в процессор компоновки данных. +// ИдентификаторСхемыКомпоновкиДанных - Строка - идентификатор СКД, указанный в ПриОпределенииИсточниковДанныхПечати. +// КодЯзыка - Строка - язык, на котором требуется подготовить данные печати. +// ДополнительныеПараметры - Структура: +// * ОписанияИсточниковДанных - ТаблицаЗначений - дополнительные сведения об объектах, для которых формируются данные печати. +// * ДанныеИсточниковСгруппированыПоВладельцуИсточникаДанных - Булево - указывает на то, что в результате компоновки +// данные печати сгруппированы не по объектам печати, а по их владельцам в схеме данных печати. +// +Процедура ПриПодготовкеДанныхПечати(ИсточникиДанных, ВнешниеНаборыДанных, ИдентификаторСхемыКомпоновкиДанных, КодЯзыка, Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПриПодготовкеДанныхПечати(ИсточникиДанных, ВнешниеНаборыДанных, ИдентификаторСхемыКомпоновкиДанных, КодЯзыка, ); +``` +
+ +## ПриПолученииКомандПечати +
+ +Описание, пример вызова + +```bsl + +// Позволяет задать дополнительные настройки команд печати. +// +// Параметры: +// ПолноеИмяОбъектаМетаданных - ОбъектМетаданных - к которому подключены источники команд +// КомандыПечати - см. УправлениеПечатью.СоздатьКоллекциюКомандПечати +// +Процедура ПриПолученииКомандПечати(Знач ПолноеИмяОбъектаМетаданных, КомандыПечати) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПриПолученииКомандПечати(ПолноеИмяОбъектаМетаданных, КомандыПечати) +``` +
+ +## ПриОпределенииКлючевыхРеквизитовОсновныхПечатныхФорм +
+ +Описание, пример вызова + +```bsl + + +// Позволяет переопределить значения реквизитов для обращения к регистру сведений ОсновныеПечатныеФормыКонтрагентов. +// +// Параметры: +// Ссылка - ЛюбаяСсылка - объект, для которого необходимо переопределить значения реквизитов. +// КлючевыеРеквизиты - Структура: +// * Организация - ЛюбаяСсылка - значение реквизита Организация переданной ссылки. +// * Получатель - ЛюбаяСсылка - значение реквизита Контрагент переданной ссылки. +// +Процедура ПриОпределенииКлючевыхРеквизитовОсновныхПечатныхФорм(Ссылка, КлючевыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПриОпределенииКлючевыхРеквизитовОсновныхПечатныхФорм(Ссылка, КлючевыеРеквизиты) +``` +
+ +## ПриОпределенииОбъектовСКомандамиПечати +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УправлениеПечатьюПереопределяемый.ПриОпределенииНастроекПечати(). +// Определяет объекты конфигурации, в модулях менеджеров которых размещена процедура ДобавитьКомандыПечати, +// формирующая список команд печати, предоставляемых этим объектом. +// Синтаксис процедуры ДобавитьКомандыПечати см. в документации к подсистеме. +// +// Параметры: +// СписокОбъектов - Массив - менеджеры объектов с процедурой ДобавитьКомандыПечати. +// +Процедура ПриОпределенииОбъектовСКомандамиПечати(СписокОбъектов) Экспорт +``` + +Пример вызова +```bsl +УправлениеПечатьюПереопределяемый.ПриОпределенииОбъектовСКомандамиПечати(СписокОбъектов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеПечатьюРФ.md b/src/content/docs/bsp/УправлениеПечатьюРФ.md new file mode 100644 index 0000000..0667df1 --- /dev/null +++ b/src/content/docs/bsp/УправлениеПечатьюРФ.md @@ -0,0 +1,116 @@ +--- +title: Управление печатью РФ +slug: bsp/управление-печатью-рф +--- + + +## ФорматнаяСтрокаУФЭБС +
+ +Описание, пример вызова + +```bsl + +// Формирует форматную строку согласно "Унифицированному формату электронных банковских сообщений" для ее отображения в +// виде QR-кода. +// +// Параметры: +// ДанныеДокумента - Структура - содержит значения полей документа. +// Данные документа будут закодированы согласно стандарту +// "СТАНДАРТЫ ФИНАНСОВЫХ ОПЕРАЦИЙ Символы двумерного штрихового кода для осуществления платежей физических лиц". +// ДанныеДокумента должны содержать информацию в полях, описанных ниже. +// Обязательные поля структуры: +// * ТекстПолучателя - Строка - наименование получателя платежа, макс. 160 символов; +// * НомерСчетаПолучателя - Строка - номер счета получателя платежа, макс. 20 символов; +// * НаименованиеБанкаПолучателя - Строка - наименование банка получателя платежа, макс. 45 символов; +// * БИКБанкаПолучателя - Строка - макс. 9 символов; +// * СчетБанкаПолучателя - Строка - номер к/с банка получателя платежа, макс. 20 символов; +// Дополнительные поля структуры: +// * СуммаЧислом - Строка - сумма платежа, в рублях, макс. 16 символов. +// * НазначениеПлатежа - Строка - наименование платежа (назначение), макс. 210 символов; +// * ИННПолучателя - Строка - ИНН получателя платежа, макс. 12 символов; +// * ИННПлательщика - Строка - ИНН плательщика, макс. 12 символов; +// * СтатусСоставителя - Строка - статус составителя платежного документа, макс. 2 символа; +// * КПППолучателя - Строка - КПП получателя платежа, макс. 9 символов. +// * КодБК - Строка - макс. 20 символов; +// * КодОКТМО - Строка - код ОКТМО, макс. 11 символов; +// * ПоказательОснования - Строка - основание налогового платежа, макс. 2 символа; +// * ПоказательПериода - Строка - налоговый период, макс. 10 символов; +// * ПоказательНомера - Строка - номер документа, макс. 15 символов; +// * ПоказательДаты - Строка - дата документа, макс. 10 символ. +// * ПоказательТипа - Строка - тип платежа, макс. 2 символа. +// Прочие дополнительные поля. +// * ФамилияПлательщика - Строка - фамилия плательщика. +// * ИмяПлательщика - Строка - имя плательщика. +// * ОтчествоПлательщика - Строка - отчество плательщика. +// * АдресПлательщика - Строка - адрес плательщика. +// * ЛицевойСчетБюджетногоПолучателя - Строка - лицевой счет бюджетного получателя. +// * ИндексПлатежногоДокумента - Строка - индекс платежного документа. +// * СНИЛС - Строка - № лицевого счета в системе персонифицированного учета в ПФР - СНИЛС. +// * НомерДоговора - Строка - номер договора. +// * НомерЛицевогоСчетаПлательщика - Строка - номер лицевого счета плательщика в организации (в системе учета ПУ). +// * НомерКвартиры - Строка - номер квартиры. +// * НомерТелефона - Строка - номер телефона. +// * ВидПлательщика - Строка - вид ДУЛ плательщика. +// * НомерПлательщик - Строка - номер ДУЛ плательщика. +// * ФИОРебенка - Строка - Ф.И.О. ребенка/учащегося. +// * ДатаРождения - Строка - дата рождения. +// * СрокПлатежа - Строка - срок платежа/дата выставления счета. +// * ПериодОплаты - Строка - период оплаты. +// * ВидПлатежа - Строка - вид платежа. +// * КодУслуги - Строка - код услуги/название прибора учета. +// * НомерПрибораУчета - Строка - номер прибора учета. +// * ПоказаниеПрибораУчета - Строка - показание прибора учета. +// * НомерИзвещения - Строка - номер извещения, начисления, счета. +// * ДатаИзвещения - Строка - дата извещения/начисления/счета/постановления (для ГИБДД). +// * НомерУчреждения - Строка - номер учреждения (образовательного, медицинского). +// * НомерГруппы - Строка - номер группы детсада/класса школы. +// * ФИОПреподавателя - Строка - ФИО преподавателя, специалиста, оказывающего услугу. +// * СуммаСтраховки - Строка - сумма страховки/дополнительной услуги/Сумма пени (в копейках). +// * НомерПостановления - Строка - номер постановления (для ГИБДД). +// * НомерИсполнительногоПроизводства - Строка - номер исполнительного производства. +// * КодВидаПлатежа - Строка - код вида платежа (например, для платежей в адрес Росреестра). +// * ИдентификаторНачисления - Строка - уникальный идентификатор начисления. +// * ТехническийКод - Строка - технический код, рекомендуемый для заполнения поставщиком услуг. +// Может использоваться принимающей организацией для вызова соответствующей +// обрабатывающей ИТ-системы. +// Перечень значений кода представлен ниже. +// +// Код назначения Наименование назначения платежа +// платежа. +// +// 01 Мобильная связь, стационарный телефон. +// 02 Коммунальные услуги, ЖКХ. +// 03 ГИБДД, налоги, пошлины, бюджетные платежи. +// 04 Охранные услуги +// 05 Услуги, оказываемые УФМС. +// 06 ПФР +// 07 Погашение кредитов +// 08 Образовательные учреждения. +// 09 Интернет и ТВ +// 10 Электронные деньги +// 11 Отдых и путешествия. +// 12 Инвестиции и страхование. +// 13 Спорт и здоровье +// 14 Благотворительные и общественные организации. +// 15 Прочие услуги. +// +// Возвращаемое значение: +// Строка - строка данных в формате УФЭБС. +// +Функция ФорматнаяСтрокаУФЭБС(ДанныеДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеПечатьюРФ.ФорматнаяСтрокаУФЭБС(ДанныеДокумента) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеСвойствами.md b/src/content/docs/bsp/УправлениеСвойствами.md new file mode 100644 index 0000000..4a2e865 --- /dev/null +++ b/src/content/docs/bsp/УправлениеСвойствами.md @@ -0,0 +1,1146 @@ +--- +title: Управление свойствами +slug: bsp/управление-свойствами +--- + + +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Создает основные реквизиты и поля формы, необходимые для работы. +// Заполняет дополнительные реквизиты, если используются. +// Вызывается из обработчика ПриСозданииНаСервере формы объекта со свойствами. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - в которой будут отображаться дополнительные реквизиты со свойствами: +// * Объект - ДанныеФормыСтруктура - по типу объекта, со свойствами: +// ** Ссылка - ЛюбаяСсылка - ссылка на объект, к которому подключаются свойства. +// +// ДополнительныеПараметры - Неопределено - все дополнительные параметры имеют значения по умолчанию. +// Ранее реквизит назывался "Объект" и имел смысл, +// как одноименное свойство структуры, указанной ниже. +// - Структура - с необязательными свойствами: +// +// * Объект - ДанныеФормыСтруктура - по типу объекта, содержит свойства: +// ** Ссылка - ЛюбаяСсылка - ссылка на объект, к которому подключаются свойства. +// +// * ИмяЭлементаДляРазмещения - Строка - имя группы формы, в которой будут размещены свойства. +// +// * ПроизвольныйОбъект - Булево - если Истина, тогда в форме создается таблица описания дополнительных +// реквизитов, параметр Объект игнорируется, дополнительные реквизиты не создаются и не заполняются. +// +// Это востребовано при последовательном использовании одной формы для просмотра или редактирования +// дополнительных реквизитов разных объектов (в том числе разных типов). +// +// После выполнения ПриСозданииНаСервере следует вызывать ЗаполнитьДополнительныеРеквизитыВФорме() +// для добавления и заполнения дополнительных реквизитов. +// Чтобы сохранить изменения, следует вызвать ПеренестиЗначенияИзРеквизитовФормыВОбъект(), +// а для обновления состава реквизитов вызвать ОбновитьЭлементыДополнительныхРеквизитов(). +// +// * ИмяЭлементаКоманднойПанели - Строка - имя группы формы, в которую будет добавлена кнопка. +// РедактироватьСоставДополнительныхРеквизитов. Если имя элемента не указано, +// используется стандартная группа "Форма.КоманднаяПанель". +// +// * СкрытьУдаленные - Булево - установить/отключить режим скрытия удаленных. +// Если параметр не указан, а параметр Объект указан и свойство Ссылка не заполнено, +// тогда начальное значение устанавливается Истина, иначе Ложь. +// При вызове процедуры ПередЗаписьюНаСервере в режиме скрытия удаленных удаленные значения +// очищаются (не переносятся обратно в объект), а режим СкрытьУдаленные устанавливается Ложь. +// +// * ПараметрыОтображенияМеток - см. ПараметрыОтображенияМеток. +// +Процедура ПриСозданииНаСервере(Форма, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ПриСозданииНаСервере(Форма, ДополнительныеПараметры); +``` +
+ +## ПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Заполняет объект из реквизитов, созданных в форме. +// Вызывается из обработчика ПередЗаписьюНаСервере формы объекта со свойствами. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - уже настроена в процедуре ПриСозданииНаСервере. +// ТекущийОбъект - СправочникОбъектИмяСправочника +// - ДокументОбъектИмяДокумента +// - ПланВидовХарактеристикОбъектИмяПланаВидовХарактеристик +// - БизнесПроцессОбъектИмяБизнесПроцесса +// - ЗадачаОбъектИмяЗадачи +// - ПланВидовРасчетаОбъектИмяПланаВидовРасчета +// - ПланСчетовОбъектИмяПланаСчетов +// +Процедура ПриЧтенииНаСервере(Форма, ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ПриЧтенииНаСервере(Форма, ТекущийОбъект) +``` +
+ +## ПередЗаписьюНаСервере +
+ +Описание, пример вызова + +```bsl + +// Заполняет объект из реквизитов, созданных в форме. +// Вызывается из обработчика ПередЗаписьюНаСервере формы объекта со свойствами. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - уже настроена в процедуре ПриСозданииНаСервере. +// ТекущийОбъект - СправочникОбъектИмяСправочника +// - ДокументОбъектИмяДокумента +// - ПланВидовХарактеристикОбъектИмяПланаВидовХарактеристик +// - БизнесПроцессОбъектИмяБизнесПроцесса +// - ЗадачаОбъектИмяЗадачи +// - ПланВидовРасчетаОбъектИмяПланаВидовРасчета +// - ПланСчетовОбъектИмяПланаСчетов +// +Процедура ПередЗаписьюНаСервере(Форма, ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ПередЗаписьюНаСервере(Форма, ТекущийОбъект) +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +// Проверяет заполненность реквизитов, обязательных для заполнения. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - уже настроена в процедуре ПриСозданииНаСервере со свойствами: +// * Свойства_ОписаниеДополнительныхРеквизитов - ТаблицаЗначений: +// ** ИмяРеквизитаЗначение - Строка +// ** Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения +// ** ВладелецДополнительныхЗначений - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения +// ** ТипЗначения - ОписаниеТипов +// ** МногострочноеПолеВвода - Число +// ** Удалено - Булево +// ** ЗаполнятьОбязательно - Булево +// ** Доступен - Булево +// ** Виден - Булево +// ** Наименование - Строка +// ** ЭлементФормыДобавлен - Булево +// ** ВыводитьВВидеГиперссылки - Булево +// ** СтрокаСсылочногоТипа - Булево +// Отказ - Булево - параметр обработчика ОбработкаПроверкиЗаполненияНаСервере. +// ПроверяемыеРеквизиты - Массив - параметр обработчика ОбработкаПроверкиЗаполненияНаСервере. +// Объект - СправочникОбъектИмяСправочника +// - ДокументОбъектИмяДокумента +// - ПланВидовХарактеристикОбъектИмяПланаВидовХарактеристик +// - БизнесПроцессОбъектИмяБизнесПроцесса +// - ЗадачаОбъектИмяЗадачи +// - ПланВидовРасчетаОбъектИмяПланаВидовРасчета +// - ПланСчетовОбъектИмяПланаСчетов +// - Неопределено - если свойство не указано или Неопределено, +// объект берется из реквизита формы "Объект". +// +Процедура ОбработкаПроверкиЗаполнения(Форма, Отказ, ПроверяемыеРеквизиты, Объект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ОбработкаПроверкиЗаполнения(Форма, Отказ, ПроверяемыеРеквизиты, Объект); +``` +
+ +## ПередЗаписьюВидаОбъекта +
+ +Описание, пример вызова + +```bsl + +// Обновляет наборы дополнительных реквизитов и сведений для вида объектов со свойствами. +// Используется при записи элементов справочников, которые являются видами объектов со свойствами. +// Например, если есть справочник Номенклатура, к которому применяется подсистема Свойства, для него создан +// справочник ВидыНоменклатуры, то при записи элемента ВидНоменклатуры необходимо вызывать эту процедуру. +// +// Параметры: +// ВидОбъекта - СправочникОбъектИмяСправочника - например вид номенклатуры перед записью. +// ИмяОбъектаСоСвойствами - Строка - например "Номенклатура". +// ИмяРеквизитаНабораСвойств - Строка - используется, когда наборов свойств несколько или +// используется имя реквизита основного набора, отличное от "НаборСвойств". +// +Процедура ПередЗаписьюВидаОбъекта(ВидОбъекта, Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ПередЗаписьюВидаОбъекта(ВидОбъекта, ); +``` +
+ +## ПередУдалениемВидаОбъекта +
+ +Описание, пример вызова + +```bsl + +// Удаляет зависимые наборы дополнительных реквизитов и сведений при удалении вида объектов со свойствами. +// +// Параметры: +// ВидОбъекта - СправочникОбъектИмяСправочника - например, вид номенклатуры. +// ИмяРеквизитаНабораСвойств - Строка - используется, когда наборов свойств несколько или +// используется имя реквизита основного набора, отличное от "НаборСвойств". +// +Процедура ПередУдалениемВидаОбъекта(ВидОбъекта, ИмяРеквизитаНабораСвойств = "НаборСвойств") Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ПередУдалениемВидаОбъекта(ВидОбъекта, ИмяРеквизитаНабораСвойств); +``` +
+ +## ОбновитьЭлементыДополнительныхРеквизитов +
+ +Описание, пример вызова + +```bsl + +// Обновляет отображаемые данные дополнительных реквизитов на форме объекта со свойствами. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - уже настроена в процедуре ПриСозданииНаСервере. +// +// Объект - Неопределено - взять объект из реквизита формы "Объект". +// - СправочникОбъектИмяСправочника +// - ДокументОбъектИмяДокумента +// - ПланВидовХарактеристикОбъектИмяПланаВидовХарактеристик +// - БизнесПроцессОбъектИмяБизнесПроцесса +// - ЗадачаОбъектИмяЗадачи +// - ПланВидовРасчетаОбъектИмяПланаВидовРасчета +// - ПланСчетовОбъектИмяПланаСчетов +// - ДанныеФормыСтруктура +// +// СкрытьУдаленные - Неопределено - не менять текущий режим скрытия удаленных, установленный ранее. +// - Булево - установить/отключить режим скрытия удаленных. +// При вызове процедуры ПередЗаписьюНаСервере в режиме скрытия удаленных удаленные значения +// очищаются (не переносятся обратно в объект), а режим СкрытьУдаленные устанавливается Ложь. +// +Процедура ОбновитьЭлементыДополнительныхРеквизитов(Форма, Объект = Неопределено, СкрытьУдаленные = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ОбновитьЭлементыДополнительныхРеквизитов(Форма, Объект, СкрытьУдаленные); +``` +
+ +## ПриПолученииДанныхНаСервере +
+ +Описание, пример вызова + +```bsl + +// В форме списка выводит колонки с метками. +// Вызывается из события ПриПолученииДанныхНаСервере формы списка. +// +// Параметры: +// Настройки - НастройкиКомпоновкиДанных - содержит копию полных настроек динамического списка, +// Строки - СтрокиДинамическогоСписка - коллекция содержит данные и оформление всех строк, +// ИмяВладельца - Строка - реквизит строки динамического списка, который будет +// использован для получения свойств. Если Неопределено +// используется ключи строк. +// +Процедура ПриПолученииДанныхНаСервере(Настройки, Строки, ИмяВладельца = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ПриПолученииДанныхНаСервере(Настройки, Строки, ИмяВладельца); +``` +
+ +## ДобавитьСвойство +
+ +Описание, пример вызова + +```bsl + +// Добавляет дополнительный реквизит, сведение или метку к переданному объекту или набору свойств. +// +// Параметры: +// Владелец - ОбъектМетаданных +// - Строка - полное имя объекта метаданных или имя набора свойств. +// - СправочникСсылка.НаборыДополнительныхРеквизитовИСведений - набор свойств. +// Параметры - см. ПараметрыДобавленияСвойства. +// ВидСвойства - ПеречислениеСсылка.ВидыСвойств - вид добавляемого свойства. +// - Булево - для обратной совместимости. +// +// Возвращаемое значение: +// ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения +// +Функция ДобавитьСвойство(Знач Владелец, Знач Параметры, Знач ВидСвойства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ДобавитьСвойство(Владелец, Параметры, ВидСвойства); +``` +
+ +## ДобавитьЗначениеСвойства +
+ +Описание, пример вызова + +```bsl + +// Добавляет доступное значение для реквизита с типом ЗначенияСвойствОбъектов +// или ЗначенияСвойствОбъектовИерархия. +// +// Параметры: +// Владелец - Строка - имя дополнительного реквизита. +// - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - дополнительный реквизит, +// для которого надо добавить значение. +// Параметры - см. ПараметрыДобавленияЗначенияСвойства. +// Иерархия - Булево +// +// Возвращаемое значение: +// СправочникСсылка.ЗначенияСвойствОбъектов +// СправочникСсылка.ЗначенияСвойствОбъектовИерархия +// +Функция ДобавитьЗначениеСвойства(Знач Владелец, Параметры, Иерархия = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ДобавитьЗначениеСвойства(Владелец, Параметры, Иерархия); +``` +
+ +## ПараметрыДобавленияСвойства +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры, необходимые для для добавления свойства. +// +// Возвращаемое значение: +// Структура: +// * Наименование - Строка - обязательно для заполнения. +// * ТипЗначения - ОписаниеТипов - обязательно для заполнения. +// * Имя - Строка +// * Комментарий - Строка +// * ЗаголовокФормыЗначения - Строка +// * ЗаголовокФормыВыбораЗначения - Строка +// * ИдентификаторДляФормул - Строка +// * МногострочноеПолеВвода - Булево +// * Подсказка - Строка +// * ЦветСвойства - Перечисления.ЦветаСвойств, обязательный для вида свойств Метка +// +Функция ПараметрыДобавленияСвойства() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ПараметрыДобавленияСвойства() +``` +
+ +## ПараметрыДобавленияЗначенияСвойства +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры, требуемые для добавления значения свойства. +// +// Возвращаемое значение: +// Структура: +// * Наименование - Строка - обязательно для заполнения. +// * ПолноеНаименование - Строка +// * Родитель - СправочникСсылка.ЗначенияСвойствОбъектов +// - СправочникСсылка.ЗначенияСвойствОбъектовИерархия +// * ЭтоГруппа - Булево +// +Функция ПараметрыДобавленияЗначенияСвойства() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ПараметрыДобавленияЗначенияСвойства() +``` +
+ +## НаборСвойствПоИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на предопределенный набор свойств по имени набора. +// Предназначена для наборов, указанных в процедуре +// УправлениеСвойствамиПереопределяемый.ПриПолученииПредопределенныхНаборовСвойств. +// +// Параметры: +// ИмяНабора - Строка - имя получаемого набора свойств. +// +// Возвращаемое значение: +// СправочникСсылка.НаборыДополнительныхРеквизитовИСведений - ссылка на набор свойств. +// Неопределено - если предопределенный набор не существует. +// +// Пример: +// Ссылка = УправлениеСвойствами.НаборСвойствПоИмени("Справочник_Пользователи"); +// +Функция НаборСвойствПоИмени(ИмяНабора) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.НаборСвойствПоИмени(ИмяНабора) +``` +
+ +## ЗаполнитьДополнительныеРеквизитыВФорме +
+ +Описание, пример вызова + +```bsl + +// Создает/пересоздает дополнительные реквизиты и элементы в форме владельца свойств. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - уже настроена в процедуре ПриСозданииНаСервере. +// +// Объект - Неопределено - взять объект из реквизита формы "Объект". +// - СправочникОбъектИмяСправочника +// - ДокументОбъектИмяДокумента +// - ПланВидовХарактеристикОбъектИмяПланаВидовХарактеристик +// - БизнесПроцессОбъектИмяБизнесПроцесса +// - ЗадачаОбъектИмяЗадачи +// - ПланВидовРасчетаОбъектИмяПланаВидовРасчета +// - ПланСчетовОбъектИмяПланаСчетов +// - ДанныеФормыСтруктура +// +// ПоляНадписей - Булево - если указать Истина, то вместо полей ввода на форме будут созданы поля надписей. +// +// СкрытьУдаленные - Неопределено - не менять текущий режим скрытия удаленных, установленный ранее. +// - Булево - установить/отключить режим скрытия удаленных. +// При вызове процедуры ПередЗаписьюНаСервере в режиме скрытия удаленных, удаленные значения +// очищаются (не переносятся обратно в объект), а режим СкрытьУдаленные устанавливается Ложь. +// +Процедура ЗаполнитьДополнительныеРеквизитыВФорме(Форма, Объект = Неопределено, ПоляНадписей = Ложь, СкрытьУдаленные = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ЗаполнитьДополнительныеРеквизитыВФорме(Форма, Объект, ПоляНадписей, СкрытьУдаленные); +``` +
+ +## ПеренестиЗначенияИзРеквизитовФормыВОбъект +
+ +Описание, пример вызова + +```bsl + +// Переносит значения свойств из реквизитов формы в табличную часть объекта. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - уже настроена в процедуре ПриСозданииНаСервере. +// Объект - Неопределено - взять объект из реквизита формы "Объект". +// - СправочникОбъект, ДокументОбъект, ДанныеФормыСтруктура - объект со свойствами или +// реквизит формы, содержащий объект. +// +Процедура ПеренестиЗначенияИзРеквизитовФормыВОбъект(Форма, Объект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ПеренестиЗначенияИзРеквизитовФормыВОбъект(Форма, Объект); +``` +
+ +## УдалитьСтарыеРеквизитыИЭлементы +
+ +Описание, пример вызова + +```bsl + +// Удаляет старые реквизиты и элементы формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - уже настроена в процедуре ПриСозданииНаСервере. +// +Процедура УдалитьСтарыеРеквизитыИЭлементы(Форма) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.УдалитьСтарыеРеквизитыИЭлементы(Форма) +``` +
+ +## СвойстваОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства у указанного объекта. +// +// Параметры: +// ВладелецСвойств - ЛюбаяСсылка - например: СправочникСсылка.Номенклатура, ДокументСсылка.ЗаказПокупателя, ... +// - СправочникОбъект, ДокументОбъект - любой объект со свойствами. +// - ДанныеФормыСтруктура - коллекция по типу объекта владельца свойств. +// ПолучатьДопРеквизиты - Булево - в результат включать дополнительные реквизиты. +// ПолучатьДопСведения - Булево - в результат включать дополнительные сведения. +// +// Возвращаемое значение: +// Массив из ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения +// +Функция СвойстваОбъекта(ВладелецСвойств, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.СвойстваОбъекта(ВладелецСвойств, ); +``` +
+ +## ЗначенияСвойств +
+ +Описание, пример вызова + +```bsl + +// АПК:142-выкл Проектное решение + +// Возвращает значения дополнительных свойств объектов. +// +// Параметры: +// ОбъектыСоСвойствами - Массив - объекты, для которых нужно получить значения дополнительных свойств. +// Допустимо передавать объекты только одного типа. +// - ЛюбаяСсылка - ссылка на объект, например, СправочникСсылка.Номенклатура, +// ДокументСсылка.ЗаказПокупателя, ... +// ПолучатьДопРеквизиты - Булево - в результат включать дополнительные реквизиты. По умолчанию Истина. +// ПолучатьДопСведения - Булево - в результат включать дополнительные сведения. По умолчанию Истина. +// Свойства - Массив из ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - значения +// которых следует получить. +// - Массив из Строка - уникальное имя дополнительного свойства. +// - Неопределено - по умолчанию, получить значения всех свойств владельца. +// КодЯзыка - Строка - код языка, на котором будет получено представление значения свойства. +// Если не указано - берется текущий язык. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - свойство владельца. +// * ИмяСвойства - Строка - уникальное имя свойства владельца. +// * Значение - Произвольный - значения любого типа из описания типов свойства объекта метаданных: +// "Метаданные.ПланВидовХарактеристик.ДополнительныеРеквизитыИСведения.Тип". +// * Представление - Строка - представление значения на указанном языке. +// * ВладелецСвойств - ЛюбаяСсылка - ссылка на объект. +// +Функция ЗначенияСвойств(ОбъектыСоСвойствами, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ЗначенияСвойств(ОбъектыСоСвойствами, ); +``` +
+ +## ЗначениеСвойства +
+ +Описание, пример вызова + +```bsl + +// АПК:142-вкл + +// Возвращает значение дополнительного свойства объекта. +// +// Параметры: +// Объект - ЛюбаяСсылка - ссылка на объект, например, СправочникСсылка.Номенклатура, +// ДокументСсылка.ЗаказПокупателя, ... +// Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - ссылка на +// дополнительный реквизит, значение которого нужно получить. +// - Строка - имя дополнительного свойства. +// КодЯзыка - Строка - если указано, то вместо значения дополнительного свойства будет +// возвращено его представление на указанном языке. +// +// Возвращаемое значение: +// Произвольный - любое значение, допустимое для свойства. +// +Функция ЗначениеСвойства(Объект, Свойство, КодЯзыка = "") Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ЗначениеСвойства(Объект, Свойство, КодЯзыка); +``` +
+ +## ПроверитьСвойствоУОбъекта +
+ +Описание, пример вызова + +```bsl + +// Проверяет, есть ли у объекта свойство. +// +// Параметры: +// ВладелецСвойств - ЛюбаяСсылка - например: СправочникСсылка.Номенклатура, ДокументСсылка.ЗаказПокупателя, ... +// Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - проверяемое свойство. +// +// Возвращаемое значение: +// Булево - если Истина, свойство у владельца есть. +// +Функция ПроверитьСвойствоУОбъекта(ВладелецСвойств, Свойство) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ПроверитьСвойствоУОбъекта(ВладелецСвойств, Свойство) +``` +
+ +## ЗаписатьСвойстваУОбъекта +
+ +Описание, пример вызова + +```bsl + +// Записывает дополнительные реквизиты и сведения владельцу свойств. +// Изменения происходят в транзакции. +// +// Параметры: +// ВладелецСвойств - ЛюбаяСсылка - например, СправочникСсылка.Номенклатура, ДокументСсылка.ЗаказПокупателя и т.д. +// ТаблицаСвойствИЗначений - ТаблицаЗначений: +// * Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - свойство владельца. +// * Значение - Произвольный - любое значение, допустимое для свойства (указано в элементе свойства). +// +Процедура ЗаписатьСвойстваУОбъекта(ВладелецСвойств, ТаблицаСвойствИЗначений) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ЗаписатьСвойстваУОбъекта(ВладелецСвойств, ТаблицаСвойствИЗначений) +``` +
+ +## УстановитьСвойстваУОбъекта +
+ +Описание, пример вызова + +```bsl + +// Добавляет дополнительные реквизиты и метки в переданный объект Владелец. Подходит для случаев, +// когда необходимо установить свойства для нового еще незаписанного объекта. +// При попытке добавить дополнительные сведения будет вызвано исключение. +// +// Параметры: +// Владелец - СправочникОбъектИмяСправочника +// - ДокументОбъектИмяДокумента +// - ПланВидовХарактеристикОбъект +// - БизнесПроцессОбъектИмяБизнесПроцесса +// - ЗадачаОбъект +// - ПланВидовРасчетаОбъект +// - ПланСчетовОбъект +// Свойства - Массив из Соответствие: +// * Ключ - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - свойство, которое необходимо установить. +// * Значение - Произвольный - новое значение свойства. +// +Процедура УстановитьСвойстваУОбъекта(Владелец, Свойства) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.УстановитьСвойстваУОбъекта(Владелец, Свойства) +``` +
+ +## ИспользоватьДопРеквизиты +
+ +Описание, пример вызова + +```bsl + +// Проверяет, используются ли дополнительные реквизиты с объектом. +// +// Параметры: +// ВладелецСвойств - ЛюбаяСсылка - например, СправочникСсылка.Номенклатура, ДокументСсылка.ЗаказПокупателя, ... +// +// Возвращаемое значение: +// Булево - если Истина, тогда дополнительные реквизиты используются. +// +Функция ИспользоватьДопРеквизиты(ВладелецСвойств) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ИспользоватьДопРеквизиты(ВладелецСвойств) +``` +
+ +## ИспользоватьДопСведения +
+ +Описание, пример вызова + +```bsl + +// Проверяет, используются ли дополнительные сведения объектом. +// +// Параметры: +// ВладелецСвойств - ЛюбаяСсылка - например, СправочникСсылка.Номенклатура, ДокументСсылка.ЗаказПокупателя, ... +// +// Возвращаемое значение: +// Булево - если Истина, тогда дополнительные сведения используются. +// +Функция ИспользоватьДопСведения(ВладелецСвойств) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ИспользоватьДопСведения(ВладелецСвойств) +``` +
+ +## СвойстваДоступны +
+ +Описание, пример вызова + +```bsl + +// Проверяет доступность подсистемы для текущего пользователя. +// +// Возвращаемое значение: +// Булево - Истина, если подсистема доступна. +// +Функция СвойстваДоступны() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.СвойстваДоступны() +``` +
+ +## ПредставлениеЗначенияСвойства +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление значения дополнительного свойства объекта +// на требуемом языке. +// +// Параметры: +// Объект - ЛюбаяСсылка - ссылка на объект, например, СправочникСсылка.Номенклатура, +// ДокументСсылка.ЗаказПокупателя, ... +// Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - ссылка на +// дополнительный реквизит, значение которого нужно получить. +// - Строка - имя дополнительного свойства. +// КодЯзыка - Строка - код языка, на котором нужно получить представление. +// +// Возвращаемое значение: +// Строка +// +Функция ПредставлениеЗначенияСвойства(Объект, Свойство, КодЯзыка = "") Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ПредставлениеЗначенияСвойства(Объект, Свойство, КодЯзыка); +``` +
+ +## ПредставленияЗначенийСвойств +
+ +Описание, пример вызова + +```bsl + +// Возвращает значения дополнительных свойств объектов. +// Подходит для подстановки параметров при формировании печатных форм. +// +// Параметры: +// ОбъектыСоСвойствами - Массив - объекты, для которых нужно получить значения дополнительных свойств. +// - ЛюбаяСсылка - ссылка на объект, например, СправочникСсылка.Номенклатура, +// ДокументСсылка.ЗаказПокупателя, ... +// КодЯзыка - Строка - код языка, на котором нужно получить представление. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ЛюбаяСсылка - ссылка на объект. +// * Значение - Структура: +// * Ключ - Строка - имя свойства. +// * Значение - Строка - представление свойства на переданном языке. +// +Функция ПредставленияЗначенийСвойств(ОбъектыСоСвойствами, КодЯзыка = "") Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ПредставленияЗначенийСвойств(ОбъектыСоСвойствами, КодЯзыка); +``` +
+ +## УстановитьВидимостьЛегендыМеток +
+ +Описание, пример вызова + +```bsl + +// Устанавливает видимость легенды меток в рамках сеанса работы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - уже настроена в процедуре ПриСозданииНаСервере. +// +Процедура УстановитьВидимостьЛегендыМеток(Форма) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.УстановитьВидимостьЛегендыМеток(Форма) +``` +
+ +## ЗаполнитьМеткиОбъекта +
+ +Описание, пример вызова + +```bsl + +// Заполняет/перезаполняет метки в форме владельца свойств. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - уже настроена в процедуре ПриСозданииНаСервере. +// +// Объект - Неопределено - взять объект из реквизита формы "Объект". +// - СправочникОбъектИмяСправочника +// - ДокументОбъектИмяДокумента +// - ПланВидовХарактеристикОбъектИмяПланаВидовХарактеристик +// - БизнесПроцессОбъектИмяБизнесПроцесса +// - ЗадачаОбъектИмяЗадачи +// - ПланВидовРасчетаОбъектИмяПланаВидовРасчета +// - ПланСчетовОбъектИмяПланаСчетов +// - ДанныеФормыСтруктура +// +// ПроизвольныйОбъект - Булево - если Истина, тогда в форме нельзя редактировать метки. +// +Процедура ЗаполнитьМеткиОбъекта(Форма, Объект = Неопределено, ПроизвольныйОбъект = Ложь) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ЗаполнитьМеткиОбъекта(Форма, Объект, ПроизвольныйОбъект); +``` +
+ +## ПараметрыОтображенияМеток +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров для отображения меток на форме. +// +// Возвращаемое значение: +// Структура: +// +// * ИмяЭлементаДляРазмещенияМеток - Строка - имя группы формы, в которой будут размещены метки. +// +// * ИмяЭлементаДляРазмещенияЛегендыМеток - Строка - имя группы формы, в которой будет размещена легенда меток. +// +// * МаксимумМетокНаФорме - Число - максимальное количество отображаемых меток на форме. По умолчанию, ограничений нет. +// +// * ОтборМеток - Булево - возможность отбирать объекты в списке по меткам. +// +// * ВариантОтображенияМеток - ПеречислениеСсылка.ВариантыОтображенияМеток - вариант отображения меток на форме. +// Миниатюрные цветные картинки для форм с небольшим количеством свободного места или +// надписи с цветным фоном для быстрого ознакомления с текстом меток. +// По умолчанию, используется вариант Картинка. +// +// * ВидОбъектов - Строка - полное имя объекта метаданных для отображения легенды меток в форме списка. +// +Функция ПараметрыОтображенияМеток() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ПараметрыОтображенияМеток() +``` +
+ +## СвойстваПоВидуДополнительныхРеквизитов +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства определенного вида. +// +// Параметры: +// Свойства - ТаблицаЗначений - таблица свойств. +// +// ВидСвойства - ПеречислениеСсылка.ВидыСвойств - вид свойств, дополнительные реквизиты или метки. +// +// Возвращаемое значение: +// Массив - массив свойств определенного вида. +// +Функция СвойстваПоВидуДополнительныхРеквизитов(Свойства, ВидСвойства) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.СвойстваПоВидуДополнительныхРеквизитов(Свойства, ВидСвойства) +``` +
+ +## ЕстьВладельцыМеток +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак наличия владельцев меток. +// +// Возвращаемое значение: +// Булево - признак наличия владельцев меток. +// +Функция ЕстьВладельцыМеток() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ЕстьВладельцыМеток() +``` +
+ +## ОбновитьНаименованияНаборовИСвойств +
+ +Описание, пример вызова + +```bsl + +// 1. Обновляет наименования предопределенных наборов свойств, +// если они отличаются от текущих представлений соответствующих +// им объектов метаданных со свойствами. +// 2. Обновляет наименования не общих свойств, если у них +// уточнение отличается от наименования их набора. +// 3. Устанавливает пометку удаления у необщих свойств, +// если установлена пометка удаления их наборов. +// +Процедура ОбновитьНаименованияНаборовИСвойств() Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ОбновитьНаименованияНаборовИСвойств() +``` +
+ +## УстановитьПараметрыНабораСвойств +
+ +Описание, пример вызова + +```bsl + +// Устанавливает параметры набора свойств. +// +// Параметры: +// ИмяНабораСвойств - Строка - имя предопределенного набора свойств. +// Параметры - см. СтруктураПараметровНабораСвойств +// +Процедура УстановитьПараметрыНабораСвойств(ИмяНабораСвойств, Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.УстановитьПараметрыНабораСвойств(ИмяНабораСвойств, Параметры); +``` +
+ +## СтруктураПараметровНабораСвойств +
+ +Описание, пример вызова + +```bsl + +// Получает структуру параметров для набора свойств. +// +// Возвращаемое значение: +// Структура: +// * Используется - Булево - признак использования набора свойств. +// Устанавливается в Ложь, например, если +// объект отключен функциональной опцией. +// +Функция СтруктураПараметровНабораСвойств() Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.СтруктураПараметровНабораСвойств() +``` +
+ +## ВосстановитьНастройкиФормСДополнительнымиРеквизитами +
+ +Описание, пример вызова + +```bsl + +// Для использования в обработчиках обновления. Позволяет сохранить настройки форм +// при переходе на описание наборов свойств в процедуре +// УправлениеСвойствамиПереопределяемый.ПриПолученииПредопределенныхНаборовСвойств, +// если до этого они описывались в предопределенных элементах справочника +// НаборыДополнительныхРеквизитовИСведений. +// +Процедура ВосстановитьНастройкиФормСДополнительнымиРеквизитами() Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствами.ВосстановитьНастройкиФормСДополнительнымиРеквизитами() +``` +
+ +## ПолучитьЗначенияСвойств +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЗначенияСвойств или ЗначенияСвойства. +// Возвращает значения дополнительных свойств объекта. +// +// Параметры: +// ВладелецСвойств - ЛюбаяСсылка - например, СправочникСсылка.Номенклатура, ДокументСсылка.ЗаказПокупателя, ... +// ПолучатьДопРеквизиты - Булево - в результат включать дополнительные реквизиты. +// ПолучатьДопСведения - Булево - в результат включать дополнительные сведения. +// МассивСвойств - Массив из ПланВидовХарактеристикСсылка - дополнительные реквизиты, значения +// которых следует получить. +// - Неопределено - получить значения всех свойств владельца. +// Возвращаемое значение: +// ТаблицаЗначений: +// * Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - свойство владельца. +// * Значение - Произвольный - значения любого типа из описания типов свойства объекта метаданных: +// "Метаданные.ПланВидовХарактеристик.ДополнительныеРеквизитыИСведения.Тип". +// +Функция ПолучитьЗначенияСвойств(ВладелецСвойств, Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ПолучитьЗначенияСвойств(ВладелецСвойств, ); +``` +
+ +## ПолучитьСписокСвойств +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать СвойстваОбъекта. +// Возвращает свойства владельца. +// +// Параметры: +// ВладелецСвойств - ЛюбаяСсылка - например, СправочникСсылка.Номенклатура, ДокументСсылка.ЗаказПокупателя, ... +// ПолучатьДопРеквизиты - Булево - в результат включать дополнительные реквизиты. +// ПолучатьДопСведения - Булево - в результат включать дополнительные сведения. +// +// Возвращаемое значение: +// Массив из ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - если есть. +// +Функция ПолучитьСписокСвойств(ВладелецСвойств, ПолучатьДопРеквизиты = Истина, ПолучатьДопСведения = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ПолучитьСписокСвойств(ВладелецСвойств, ПолучатьДопРеквизиты, ПолучатьДопСведения); +``` +
+ +## ПолучитьСписокЗначенийСвойств +
+ +Описание, пример вызова + +```bsl + +// Возвращает перечисляемые значения указанного свойства. +// +// Параметры: +// Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - свойство для +// которого нужно получить перечисляемые значения. +// +// Возвращаемое значение: +// Массив из СправочникСсылка.ЗначенияСвойствОбъектов, СправочникСсылка.ЗначенияСвойствОбъектовИерархия - значения +// свойства, если есть. +// +Функция ПолучитьСписокЗначенийСвойств(Свойство) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствами.ПолучитьСписокЗначенийСвойств(Свойство) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеСвойствамиКлиент.md b/src/content/docs/bsp/УправлениеСвойствамиКлиент.md new file mode 100644 index 0000000..0080063 --- /dev/null +++ b/src/content/docs/bsp/УправлениеСвойствамиКлиент.md @@ -0,0 +1,166 @@ +--- +title: Управление свойствами клиент +slug: bsp/управление-свойствами-клиент +--- + + +## ОбрабатыватьОповещения +
+ +Описание, пример вызова + +```bsl + +// Определяет, что указанное событие - это событие об изменении набора свойств. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой была вызвана обработка оповещения. +// ИмяСобытия - Строка - имя обрабатываемого события. +// Параметр - Произвольный - параметры, переданные в событии. +// - Структура: +// * Ссылка - СправочникСсылка.НаборыДополнительныхРеквизитовИСведений - измененный набор свойств. +// - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - измененный дополнительный +// реквизит. +// +// Возвращаемое значение: +// Булево - если Истина, тогда это оповещение об изменении набора свойств и +// его нужно обработать в форме. +// +Функция ОбрабатыватьОповещения(Форма, ИмяСобытия, Параметр) Экспорт +``` + +Пример вызова +```bsl +Результат = УправлениеСвойствамиКлиент.ОбрабатыватьОповещения(Форма, ИмяСобытия, Параметр) +``` +
+ +## ОбновитьЗависимостиДополнительныхРеквизитов +
+ +Описание, пример вызова + +```bsl + +// Обновляет видимость, доступность и обязательность заполнения +// дополнительных реквизитов. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - обрабатываемая форма. +// Объект - ДанныеФормыСтруктура - описание объекта, к которому подключены свойства, +// если свойство не указано или Неопределено, то +// объект будет взят из реквизита формы "Объект". +// +Процедура ОбновитьЗависимостиДополнительныхРеквизитов(Форма, Объект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиКлиент.ОбновитьЗависимостиДополнительныхРеквизитов(Форма, Объект); +``` +
+ +## ПослеЗагрузкиДополнительныхРеквизитов +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие зависимых дополнительных реквизитов на форме +// и при необходимости подключает обработчик ожидания проверки зависимостей реквизитов. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - проверяемая форма. +// +Процедура ПослеЗагрузкиДополнительныхРеквизитов(Форма) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиКлиент.ПослеЗагрузкиДополнительныхРеквизитов(Форма) +``` +
+ +## ВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// Обработчик команд с форм, к которым подключены дополнительные свойства. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма с дополнительными реквизитами, предварительно +// настроенная в процедуре УправлениеСвойствами.ПриСозданииНаСервере(). +// Элемент - ПолеФормы +// - КомандаФормы - элемент, нажатие которого необходимо обработать. +// СтандартнаяОбработка - Булево - возвращаемый параметр, если необходимо выполнить интерактивные +// действия с пользователем, то устанавливается в значение Ложь. +// Объект - ДанныеФормыСтруктура - описание объекта, к которому подключены свойства, +// если свойство не указано или Неопределено, то +// объект будет взят из реквизита формы "Объект". +// +Процедура ВыполнитьКоманду(Форма, Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиКлиент.ВыполнитьКоманду(Форма, ); +``` +
+ +## РедактироватьМетки +
+ +Описание, пример вызова + +```bsl + +// Открывает форму редактирования меток для объекта. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - обрабатываемая форма. +// Объект - ДанныеФормыСтруктура - описание объекта, к которому подключены свойства, +// если свойство не указано или Неопределено, то +// объект будет взят из реквизита формы "Объект". +// +Процедура РедактироватьМетки(Форма, Объект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиКлиент.РедактироватьМетки(Форма, Объект); +``` +
+ +## УстановитьОтборПоМетке +
+ +Описание, пример вызова + +```bsl + +// Устанавливает отбор в списке по метке. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - обрабатываемая форма. +// ИмяКоманды - Строка - имя команды установки отбора по метке. +// +Процедура УстановитьОтборПоМетке(Форма, ИмяКоманды) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиКлиент.УстановитьОтборПоМетке(Форма, ИмяКоманды) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УправлениеСвойствамиПереопределяемый.md b/src/content/docs/bsp/УправлениеСвойствамиПереопределяемый.md new file mode 100644 index 0000000..9f32663 --- /dev/null +++ b/src/content/docs/bsp/УправлениеСвойствамиПереопределяемый.md @@ -0,0 +1,219 @@ +--- +title: Управление свойствами переопределяемый +slug: bsp/управление-свойствами-переопределяемый +--- + + +## ПриПолученииПредопределенныхНаборовСвойств +
+ +Описание, пример вызова + +```bsl + +// Получает описание предопределенных наборов свойств. +// +// Параметры: +// Наборы - ДеревоЗначений: +// * Имя - Строка - имя набора свойств. Формируется из полного имени объекта +// метаданных заменой символа "." на "_". +// Например, "Документ_ЗаказПокупателя". +// * Идентификатор - УникальныйИдентификатор - уникальный идентификатор предопределенного набора свойств. +// Не должен повторяться в других наборах свойств. +// Формат идентификатора Random UUID (Version 4). +// Чтобы получить идентификатор, нужно в режиме 1С:Предприятие вычислить значение +// конструктора платформы "Новый УникальныйИдентификатор" или воспользоваться online-генератором, +// например, https://www.uuidgenerator.net/version4. +// * Используется - Неопределено +// - Булево - признак того, что набор свойств используется. +// Например, можно использовать для скрытия набора по функциональным опциям. +// Значение по умолчанию - Неопределено, соответствует значению Истина. +// * ЭтоГруппа - Булево - Истина, если набор свойств является группой. +// +Процедура ПриПолученииПредопределенныхНаборовСвойств(Наборы) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиПереопределяемый.ПриПолученииПредопределенныхНаборовСвойств(Наборы) +``` +
+ +## ПриПолученииНаименованийНаборовСвойств +
+ +Описание, пример вызова + +```bsl + +// Получает наименования наборов свойств второго уровня на разных языках. +// +// Параметры: +// Наименования - Соответствие из КлючИЗначение - представление набора на переданном языке: +// * Ключ - Строка - имя набора свойств. Например, "Справочник_Партнеры_Общие". +// * Значение - Строка - наименование набора для переданного кода языка. +// КодЯзыка - Строка - код языка. Например, "en". +// +// Пример: +// Наименования["Справочник_Партнеры_Общие"] = НСтр("ru='Общие'; en='General';", КодЯзыка); +// +Процедура ПриПолученииНаименованийНаборовСвойств(Наименования, КодЯзыка) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиПереопределяемый.ПриПолученииНаименованийНаборовСвойств(Наименования, КодЯзыка) +``` +
+ +## ЗаполнитьНаборыСвойствОбъекта +
+ +Описание, пример вызова + +```bsl + +// Заполняет наборы свойств объекта. Обычно требуется, если наборов более одного. +// +// Параметры: +// Объект - ЛюбаяСсылка - ссылка на объект со свойствами. +// - ФормаКлиентскогоПриложения - форма объекта, к которому подключены свойства. +// - ДанныеФормыСтруктура - описание объекта, к которому подключены свойства. +// +// ТипСсылки - Тип - тип ссылки владельца свойств. +// +// НаборыСвойств - ТаблицаЗначений: +// * Набор - СправочникСсылка.НаборыДополнительныхРеквизитовИСведений +// * ОбщийНабор - Булево - Истина, если набор свойств содержит свойства, +// общие для всех объектов. +// // Далее свойства элемента формы типа ГруппаФормы вида обычная группа +// // или страница, которая создается, если наборов больше одного без учета +// // пустого набора, который описывает свойства группы удаленных реквизитов. +// +// // Если значение Неопределено, значит, использовать значение по умолчанию. +// +// // Для любой группы управляемой формы. +// * Высота - Число +// * Заголовок - Строка +// * Подсказка - Строка +// * РастягиватьПоВертикали - Булево +// * РастягиватьПоГоризонтали - Булево +// * ТолькоПросмотр - Булево +// * ЦветТекстаЗаголовка - Цвет +// * Ширина - Число +// * ШрифтЗаголовка - Шрифт +// +// // Для обычной группы и страницы. +// * Группировка - ГруппировкаПодчиненныхЭлементовФормы +// +// // Для обычной группы. +// * Отображение - ОтображениеОбычнойГруппы +// +// // Для страницы. +// * Картинка - Картинка +// * ОтображатьЗаголовок - Булево +// +// СтандартнаяОбработка - Булево - начальное значение Истина. Указывает, получать ли +// основной набор, когда НаборыСвойств.Количество() равно нулю. +// +// КлючНазначения - Неопределено - (начальное значение) - указывает вычислить +// ключ назначения автоматически и добавить к значениям свойств +// формы КлючНазначенияИспользования и КлючСохраненияПоложенияОкна, +// чтобы изменения формы (настройки, положение и размер) сохранялись +// отдельно для разного состава наборов. +// Например, для каждого вида номенклатуры - свой состав наборов. +// +// - Строка - (не более 32 символа) - использовать указанный ключ +// назначения для добавления к значениям свойств формы. +// Пустая строка - не изменять свойства ключей формы, т.к. они +// устанавливается в форме и уже учитывают различия состава наборов. +// +// Добавка имеет формат "КлючНаборовСвойств<КлючНазначения>", +// чтобы <КлючНазначения> можно было обновлять без повторной добавки. +// При автоматическом вычислении <КлючНазначения> содержит хеш +// идентификаторов ссылок упорядоченных наборов свойств. +// +Процедура ЗаполнитьНаборыСвойствОбъекта(Знач Объект, ТипСсылки, НаборыСвойств, СтандартнаяОбработка, КлючНазначения) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиПереопределяемый.ЗаполнитьНаборыСвойствОбъекта(Объект, ТипСсылки, НаборыСвойств, СтандартнаяОбработка, КлючНазначения) +``` +
+ +## ПриНастройкеНачальногоЗаполненияЭлементов +
+ +Описание, пример вызова + +```bsl + +// Смотри также ОбновлениеИнформационнойБазыПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов +// +// Параметры: +// Настройки - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов.Настройки +// +Процедура ПриНастройкеНачальногоЗаполненияЭлементов(Настройки) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов(Настройки) +``` +
+ +## ПриНачальномЗаполненииЭлементов +
+ +Описание, пример вызова + +```bsl + +// Смотри также ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов +// +// Параметры: +// КодыЯзыков - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов.КодыЯзыков +// Элементы - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов.Элементы +// ТабличныеЧасти - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов.ТабличныеЧасти +// +Процедура ПриНачальномЗаполненииЭлементов(КодыЯзыков, Элементы, ТабличныеЧасти) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиПереопределяемый.ПриНачальномЗаполненииЭлементов(КодыЯзыков, Элементы, ТабличныеЧасти) +``` +
+ +## ПриНачальномЗаполненииЭлемента +
+ +Описание, пример вызова + +```bsl + +// Смотри также ОбновлениеИнформационнойБазыПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов +// +// Параметры: +// Объект - СправочникОбъект.РолиИсполнителей - заполняемый объект. +// Данные - СтрокаТаблицыЗначений - данные заполнения объекта. +// ДополнительныеПараметры - Структура: +// * ПредопределенныеДанные - ТаблицаЗначений - данные заполненные в процедуре ПриНачальномЗаполненииЭлементов. +// +Процедура ПриНачальномЗаполненииЭлемента(Объект, Данные, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +УправлениеСвойствамиПереопределяемый.ПриНачальномЗаполненииЭлемента(Объект, Данные, ДополнительныеПараметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УчетОригиналовПервичныхДокументов.md b/src/content/docs/bsp/УчетОригиналовПервичныхДокументов.md new file mode 100644 index 0000000..2171f47 --- /dev/null +++ b/src/content/docs/bsp/УчетОригиналовПервичныхДокументов.md @@ -0,0 +1,422 @@ +--- +title: Учет оригиналов первичных документов +slug: bsp/учет-оригиналов-первичных-документов +--- + + +## ПриСозданииНаСервере_ФормаДокумента +
+ +Описание, пример вызова + +```bsl + +// Обработчик события "ПриСозданииНаСервере" формы документа. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения: +// * Объект - ДанныеФормыСтруктура, ДокументОбъект - основной реквизит формы. +// Расположение - ГруппаФормы - группа, в которой будет располагаться надпись о текущем состоянии оригинала. +// Если Неопределено, тогда надпись будет расположена в нижнем правом углу формы. Необязательный. +// +Процедура ПриСозданииНаСервере_ФормаДокумента(Форма, Расположение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ПриСозданииНаСервере_ФормаДокумента(Форма, Расположение); +``` +
+ +## ПриСозданииНаСервере_ФормаСписка +
+ +Описание, пример вызова + +```bsl + +// Обработчик события "ПриСозданииНаСервере" формы списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма списка документа. +// Список - ТаблицаФормы - основной список формы. +// Расположение - ПолеФормы - колонка списка, перед которой будут располагаться новые колонки состояний. +// Если Неопределено, тогда колонки будут расположены в конце списка. Необязательный. +// +Процедура ПриСозданииНаСервере_ФормаСписка(Форма, Список, Расположение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ПриСозданииНаСервере_ФормаСписка(Форма, Список, Расположение); +``` +
+ +## ПриПолученииДанныхНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик события "ПриПолученииДанныхНаСервере" формы списка. +// +// Параметры: +// СтрокиСписка - СтрокиДинамическогоСписка - строки списка документов. +// +Процедура ПриПолученииДанныхНаСервере(СтрокиСписка) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ПриПолученииДанныхНаСервере(СтрокиСписка) +``` +
+ +## УстановитьНовоеСостояниеОригинала +
+ +Описание, пример вызова + +```bsl + +// Вызывается для записи новых или изменении текущих состояний оригиналов первичных документов. +// +// Параметры: +// ОбъектыЗаписи - Массив из Структура - массив данных об изменяемом состоянии оригинала, в случае множественного +// изменения состояний документов: +// * ОбщееСостояние - Булево - Истина, если текущее состояние является общим. +// * Ссылка - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - документ, +// для которого необходимо изменить состояние оригинала. +// * СостояниеОригиналаПервичногоДокумента - СправочникСсылка.СостоянияОригиналовПервичныхДокументов - +// текущие состояние оригинала первичного документа. +// * ПервичныйДокумент - Строка - идентификатор первичного документа. +// Задается, если данное состояние не является общим. +// * Извне - Булево - Истина, если первичный документ был добавлен пользователем вручную. +// Задается, если данное состояние не является общим. +// - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ, для которого +// необходимо изменить состояние оригинала, в случае единичного изменения. +// СостояниеОригинала - СправочникСсылка.СостоянияОригиналовПервичныхДокументов - ссылка на устанавливаемое состояние. +// +// Возвращаемое значение: +// Строка - "Изменено", если состояние оригинала документа не повторяется и было записано; +// "НеИзменено"; +// "НеПроведено". +// +Функция УстановитьНовоеСостояниеОригинала(Знач ОбъектыЗаписи, Знач СостояниеОригинала) Экспорт +``` + +Пример вызова +```bsl +Результат = УчетОригиналовПервичныхДокументов.УстановитьНовоеСостояниеОригинала(ОбъектыЗаписи, СостояниеОригинала) +``` +
+ +## СведенияОСостоянииОригиналаПоСсылке +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные о текущем общем состоянии оригинала документа по ссылке. +// +// Параметры: +// Документ - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ, для которого необходимо +// получить сведения об общем состоянии. +// +// Возвращаемое значение: +// Структура: +// * Ссылка - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ. +// * СостояниеОригиналаПервичногоДокумента - СправочникСсылка.СостоянияОригиналовПервичныхДокументов - текущее общее +// состояние оригинала документа. +// +Функция СведенияОСостоянииОригиналаПоСсылке(Документ) Экспорт +``` + +Пример вызова +```bsl +Результат = УчетОригиналовПервичныхДокументов.СведенияОСостоянииОригиналаПоСсылке(Документ) +``` +
+ +## ЗаписатьСостоянияОригиналовПослеПечати +
+ +Описание, пример вызова + +```bsl + +// Вызывается для записи состояний оригиналов печатных форм в регистр, после печати формы. +// +// Параметры: +// ОбъектыПечати - СписокЗначений - список ссылок на объекты печати. +// СписокПечати - СписокЗначений - список с именами макетов и представлениями печатных форм. +// Записано - Булево - признак того, что состояние документа записано в регистр. +// +Процедура ЗаписатьСостоянияОригиналовПослеПечати(ОбъектыПечати, СписокПечати, Записано = Ложь) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ЗаписатьСостоянияОригиналовПослеПечати(ОбъектыПечати, СписокПечати, Записано); +``` +
+ +## ОбновитьКомандыСостоянияОригинала +
+ +Описание, пример вызова + +```bsl + +// Обновляет команды установки состояния оригинала на форме. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма списка документа. +// Список - ТаблицаФормы - основной список формы. Если процедура вызывается для формы документа, то Неопределено. +// +Процедура ОбновитьКомандыСостоянияОригинала(Форма, Список = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ОбновитьКомандыСостоянияОригинала(Форма, Список); +``` +
+ +## УстановитьУсловноеОформлениеВФормеСписка +
+ +Описание, пример вызова + +```bsl + +// Устанавливает условное форматирование для подключаемых элементов в списке. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма списка документа. +// Список - ТаблицаФормы - основной список формы. +// +Процедура УстановитьУсловноеОформлениеВФормеСписка(Форма, Список) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.УстановитьУсловноеОформлениеВФормеСписка(Форма, Список) +``` +
+ +## ДополнитьПрофильРольюДляИзмененияСостоянийОригиналовДокументов +
+ +Описание, пример вызова + +```bsl + +// Добавляет в описание профиля поставляемых групп доступа роль для изменения состояния оригинала. +// +// Параметры: +// ОписаниеПрофиля - см. УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа +// +Процедура ДополнитьПрофильРольюДляИзмененияСостоянийОригиналовДокументов(ОписаниеПрофиля) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ДополнитьПрофильРольюДляИзмененияСостоянийОригиналовДокументов(ОписаниеПрофиля) +``` +
+ +## ДополнитьПрофильРольюДляНастройкиСостоянийОригиналовДокументов +
+ +Описание, пример вызова + +```bsl + +// Добавляет в описание профиля поставляемых групп доступа роль для настройки списка состояния оригинала. +// +// Параметры: +// ОписаниеПрофиля - см. УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа. +// +Процедура ДополнитьПрофильРольюДляНастройкиСостоянийОригиналовДокументов(ОписаниеПрофиля) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ДополнитьПрофильРольюДляНастройкиСостоянийОригиналовДокументов(ОписаниеПрофиля) +``` +
+ +## ДополнитьПрофильРольюДляЧтенияСостоянийОригиналовДокументов +
+ +Описание, пример вызова + +```bsl + +// Добавляет в описание профиля поставляемых групп доступа роль для чтения состояния оригинала. +// +// Параметры: +// ОписаниеПрофиля - см. УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа. +// +Процедура ДополнитьПрофильРольюДляЧтенияСостоянийОригиналовДокументов(ОписаниеПрофиля) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ДополнитьПрофильРольюДляЧтенияСостоянийОригиналовДокументов(ОписаниеПрофиля) +``` +
+ +## ВсеСостояния +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив всех состояний оригиналов первичных документов. +// +// Возвращаемое значение: +// Массив из СправочникСсылка.СостоянияОригиналовПервичныхДокументов - все возможные состояния оригинала, включая +// скрытое "Оригиналы не все". +// +Функция ВсеСостояния() Экспорт +``` + +Пример вызова +```bsl +Результат = УчетОригиналовПервичныхДокументов.ВсеСостояния() +``` +
+ +## ВывестиНаФормуКомандыСостоянияОригинала +
+ +Описание, пример вызова + +```bsl + +// Выводит подключаемые команды в форме. Вызывается без подключения подсистемы "Подключаемые команды". +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма списка документа. +// Список - ТаблицаФормы - основной список формы. Если процедура вызывается для формы документа, то Неопределено. +// СостоянияОригиналов - ТаблицаЗначений - состояния оригинала, разрешенные пользователям, и используемые при смене +// состояния оригинала: +// * Наименование - Строка - наименование состояния оригинала; +// * Ссылка - СправочникСсылка.СостоянияОригиналовПервичныхДокументов - ссылка на элемент справочника СостоянияОригиналовПервичныхДокументов. +// +Процедура ВывестиНаФормуКомандыСостоянияОригинала(Форма, Список, СостоянияОригиналов) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ВывестиНаФормуКомандыСостоянияОригинала(Форма, Список, СостоянияОригиналов) +``` +
+ +## ПредставлениеГиперссылкиСостояния +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление гиперссылки состояния оригинала документа по ссылке. +// +// Параметры: +// Документ - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ, для которого необходимо +// получить представление гиперссылки состояния. +// Возвращаемое значение: +// Строка - представление гиперссылки состояния оригинала документа. +// +Функция ПредставлениеГиперссылкиСостояния(Документ) Экспорт +``` + +Пример вызова +```bsl +Результат = УчетОригиналовПервичныхДокументов.ПредставлениеГиперссылкиСостояния(Документ) +``` +
+ +## ЗаписатьСостоянияОригиналовДокументаПослеПечатиФормы +
+ +Описание, пример вызова + +```bsl + +// Устанавливает состояния оригиналов печатных форм. Вызывается после печати формы. +// +// Параметры: +// ОбъектыПечати - СписокЗначений - список документов. +// ПечатныеФормы - СписокЗначений - наименование макетов и представление печатных форм. +// Записано - Булево - выходной параметр. Признак того, что состояние документа записано. +// +Процедура ЗаписатьСостоянияОригиналовДокументаПослеПечатиФормы(ОбъектыПечати, ПечатныеФормы, Записано = Ложь) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ЗаписатьСостоянияОригиналовДокументаПослеПечатиФормы(ОбъектыПечати, ПечатныеФормы, Записано); +``` +
+ +## ЗаписатьСостояниеОригиналаДокументаПоПечатнымФормам +
+ +Описание, пример вызова + +```bsl + +// Устанавливает состояние оригинала печатной формы. Вызывается после печати формы. +// +// Параметры: +// Документ - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - документ. +// ПечатнаяФорма - Строка - имя макета печатной формы. +// Представление - Строка - наименование печатной формы. +// Состояние - СправочникСсылка.СостоянияОригиналовПервичныхДокументов - состояние оригинала печатной формы. +// Извне - Булево - признак, показывающий принадлежит ли форма системе 1С. +// Сотрудник - СправочникСсылка - сотрудник, если в оригинале документа есть сведения о сотрудниках. +// +Процедура ЗаписатьСостояниеОригиналаДокументаПоПечатнымФормам(Документ, ПечатнаяФорма, Представление, Состояние, Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ЗаписатьСостояниеОригиналаДокументаПоПечатнымФормам(Документ, ПечатнаяФорма, Представление, Состояние, ); +``` +
+ +## ЗаписатьОбщееСостояниеОригиналаДокумента +
+ +Описание, пример вызова + +```bsl + +// Записывает общее состояния оригинала документа. +// +// Параметры: +// Документ - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - документ. +// Состояние - СправочникСсылка.СостоянияОригиналовПервичныхДокументов - состояние оригинала. +// +Процедура ЗаписатьОбщееСостояниеОригиналаДокумента(Документ, Состояние) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументов.ЗаписатьОбщееСостояниеОригиналаДокумента(Документ, Состояние) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УчетОригиналовПервичныхДокументовВызовСервера.md b/src/content/docs/bsp/УчетОригиналовПервичныхДокументовВызовСервера.md new file mode 100644 index 0000000..e877363 --- /dev/null +++ b/src/content/docs/bsp/УчетОригиналовПервичныхДокументовВызовСервера.md @@ -0,0 +1,37 @@ +--- +title: Учет оригиналов первичных документов вызов сервера +slug: bsp/учет-оригиналов-первичных-документов-вызов-сервера +--- + + +## ЗаписатьСостоянияОригиналовПослеПечати +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать УчетОригиналовПервичныхДокументовКлиент.ЗаписатьСостоянияОригиналовПослеПечати. +// Вызывается для записи состояний оригиналов печатных форм в регистр, после печати формы. +// +// Параметры: +// ОбъектыПечати - СписокЗначений - список ссылок на объекты печати. +// СписокПечати - СписокЗначений - список с именами макетов и представлениями печатных форм. +// Записано - Булево - признак того, что состояние документа записано в регистр. +// +Процедура ЗаписатьСостоянияОригиналовПослеПечати(ОбъектыПечати, СписокПечати, Записано = Ложь) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовВызовСервера.ЗаписатьСостоянияОригиналовПослеПечати(ОбъектыПечати, СписокПечати, Записано); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УчетОригиналовПервичныхДокументовКлиент.md b/src/content/docs/bsp/УчетОригиналовПервичныхДокументовКлиент.md new file mode 100644 index 0000000..f5173c0 --- /dev/null +++ b/src/content/docs/bsp/УчетОригиналовПервичныхДокументовКлиент.md @@ -0,0 +1,287 @@ +--- +title: Учет оригиналов первичных документов клиент +slug: bsp/учет-оригиналов-первичных-документов-клиент +--- + + +## Подключаемый_УстановитьСостояниеОригинала +
+ +Описание, пример вызова + +```bsl + +// Устанавливает состояние оригинала для выделенных документов. Вызывается через подсистему "Подключаемые команды". +// +// Параметры: +// МассивСсылок - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ. +// Параметры -см. ПодключаемыеКоманды.ПараметрыВыполненияКоманды. +// +Процедура Подключаемый_УстановитьСостояниеОригинала(МассивСсылок, Параметры) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.Подключаемый_УстановитьСостояниеОригинала(МассивСсылок, Параметры) +``` +
+ +## УстановитьСостояниеОригинала +
+ +Описание, пример вызова + +```bsl + +// Устанавливает состояние оригинала для выделенных документов. Вызывается без подключения подсистемы "Подключаемые команды". +// +// Параметры: +// ИмяКоманды - Строка- имя выполняемой команды формы. +// Форма - ФормаКлиентскогоПриложения - форма списка или документа. +// Список - ТаблицаФормы - список формы, в котором будет происходить изменение состояния. Если состояние устанавливается +// из формы документа, то Неопределено. +// +Процедура УстановитьСостояниеОригинала(ИмяКоманды, Форма, Список = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.УстановитьСостояниеОригинала(ИмяКоманды, Форма, Список); +``` +
+ +## ОткрытьМенюВыбораСостояния +
+ +Описание, пример вызова + +```bsl + +// Открывает на форме списка или документа выпадающие меню выбора состояния оригинала. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - основной реквизит формы. +// Источник - ТаблицаФормы - список или декорация формы, у которого будет открыт выпадающий список. +// Если не задан, то элемент с именем "ДекорацияСостояниеОригинала". +// +Процедура ОткрытьМенюВыбораСостояния(Знач Форма, Знач Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.ОткрытьМенюВыбораСостояния(Форма, Источник); +``` +
+ +## ОбработчикОповещенияФормаДокумента +
+ +Описание, пример вызова + +```bsl + +// Обработчик оповещения событий подсистемы "Учет оригиналов первичных документов" для формы документа. +// +// Параметры: +// ИмяСобытия - Строка - имя произошедшего события. +// Форма - ФормаКлиентскогоПриложения - форма документа. +// Источник - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ, источник события. +// - Массив из ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов: +// * Ссылка - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ, источник события. +// +Процедура ОбработчикОповещенияФормаДокумента(ИмяСобытия, Форма, Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.ОбработчикОповещенияФормаДокумента(ИмяСобытия, Форма, Источник); +``` +
+ +## ОбработчикОповещенияФормаСписка +
+ +Описание, пример вызова + +```bsl + +// Обработчик оповещения событий подсистемы "Учет оригиналов первичных документов" для формы списка. +// +// Параметры: +// ИмяСобытия - Строка - имя произошедшего события. +// Форма - ФормаКлиентскогоПриложения - форма списка документов. +// Список - ТаблицаФормы - основной список формы. +// Источник - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ, источник события. +// - Массив из ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов: +// * Ссылка - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ, источник события. +// +Процедура ОбработчикОповещенияФормаСписка(ИмяСобытия, Форма, Список, Источник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.ОбработчикОповещенияФормаСписка(ИмяСобытия, Форма, Список, Источник); +``` +
+ +## СписокВыбор +
+ +Описание, пример вызова + +```bsl + +// Обработчик события "Выбор" списка. +// +// Параметры: +// ИмяПоля - Строка - наименование выбранного поля. +// Форма - ФормаКлиентскогоПриложения - форма списка документов. +// Список - ТаблицаФормы - основной список формы. +// СтандартнаяОбработка - Булево - Истина, если в форме используется стандартная обработка события "Выбор" +// +Процедура СписокВыбор(ИмяПоля, Форма, Список, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.СписокВыбор(ИмяПоля, Форма, Список, СтандартнаяОбработка) +``` +
+ +## ОбработатьШтрихкод +
+ +Описание, пример вызова + +```bsl + +// Процедура обрабатывает действия по учету оригиналов после сканирования штрихкода документа. +// +// Параметры: +// Штрихкод - Строка - отсканированный штрихкод документа. +// ИмяСобытия - Строка - имя события формы. +// +Процедура ОбработатьШтрихкод(Штрихкод, ИмяСобытия) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.ОбработатьШтрихкод(Штрихкод, ИмяСобытия) +``` +
+ +## ОповеститьПользователяОбУстановкеСостояний +
+ +Описание, пример вызова + +```bsl + +// Процедура показывает пользователю оповещение об изменении состояний оригинала документа. +// +// Параметры: +// КоличествоОбработанных - Число - количество успешно обработанных документов. +// Документ - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ для обработки нажатия +// на оповещение пользователя в случае единичной установки состояния. Необязательный параметр. +// СостояниеОригинала - СправочникСсылка.СостоянияОригиналовПервичныхДокументов - ссылка на устанавливаемое состояние. +// +Процедура ОповеститьПользователяОбУстановкеСостояний(КоличествоОбработанных, Документ = Неопределено, СостояниеОригинала = Неопределено) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.ОповеститьПользователяОбУстановкеСостояний(КоличествоОбработанных, Документ, СостояниеОригинала); +``` +
+ +## ОткрытьФормуНастройкиСостояний +
+ +Описание, пример вызова + +```bsl + +// Открывает форму списка справочника "СостоянияОригиналовПервичныхДокументов". +Процедура ОткрытьФормуНастройкиСостояний() Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.ОткрытьФормуНастройкиСостояний() +``` +
+ +## ЗаписатьСостоянияОригиналовПослеПечати +
+ +Описание, пример вызова + +```bsl + +// Вызывается для записи состояний оригиналов печатных форм в регистр, после печати формы. +// +// Параметры: +// ОбъектыПечати - СписокЗначений - список ссылок на объекты печати. +// СписокПечати - СписокЗначений - список с именами макетов и представлениями печатных форм. +// Записано - Булево - признак того, что состояние документа записано в регистр. +// +Процедура ЗаписатьСостоянияОригиналовПослеПечати(ОбъектыПечати, СписокПечати, Записано = Ложь) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.ЗаписатьСостоянияОригиналовПослеПечати(ОбъектыПечати, СписокПечати, Записано); +``` +
+ +## ОткрытьФормуИзмененияСостоянийПечатныхФорм +
+ +Описание, пример вызова + +```bsl + +// Открывает форму уточнения состояний печатных форм документа. +// +// Параметры: +// ДокументСсылка - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ,для которого +// необходимо получить ключ записи общего состояния. +// +Процедура ОткрытьФормуИзмененияСостоянийПечатныхФорм(ДокументСсылка) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.ОткрытьФормуИзмененияСостоянийПечатныхФорм(ДокументСсылка) +``` +
+ +## ПриПодключенииСканераШтрихкода +
+ +Описание, пример вызова + +```bsl + +// Вызывается при открытии журнала оригиналов первичных документов в случае использования подключаемого оборудования. +// Позволяет определить собственный процесс подключения подключаемого оборудования к журналу. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма списка документа. +// +Процедура ПриПодключенииСканераШтрихкода(Форма) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиент.ПриПодключенииСканераШтрихкода(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УчетОригиналовПервичныхДокументовКлиентПереопределяемый.md b/src/content/docs/bsp/УчетОригиналовПервичныхДокументовКлиентПереопределяемый.md new file mode 100644 index 0000000..ca02ed0 --- /dev/null +++ b/src/content/docs/bsp/УчетОригиналовПервичныхДокументовКлиентПереопределяемый.md @@ -0,0 +1,54 @@ +--- +title: Учет оригиналов первичных документов клиент переопределяемый +slug: bsp/учет-оригиналов-первичных-документов-клиент-переопределяемый +--- + + +## ПриПодключенииСканераШтрихкода +
+ +Описание, пример вызова + +```bsl + +// Вызывается при открытии журнала оригиналов первичных документов в случае использования подключаемого оборудования. +// Позволяет определить собственный процесс подключения подключаемого оборудования к журналу. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма списка документа. +// +Процедура ПриПодключенииСканераШтрихкода(Форма) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиентПереопределяемый.ПриПодключенииСканераШтрихкода(Форма) +``` +
+ +## ПриОткрытииФормыЖурналаУчетаОригиналов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при открытии журнала оригиналов первичных документов в случае использования подключаемого оборудования. +// Позволяет определить собственный процесс подключения подключаемого оборудования к журналу. +// +Процедура ПриОткрытииФормыЖурналаУчетаОригиналов() Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовКлиентПереопределяемый.ПриОткрытииФормыЖурналаУчетаОригиналов() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/УчетОригиналовПервичныхДокументовПереопределяемый.md b/src/content/docs/bsp/УчетОригиналовПервичныхДокументовПереопределяемый.md new file mode 100644 index 0000000..ea972e7 --- /dev/null +++ b/src/content/docs/bsp/УчетОригиналовПервичныхДокументовПереопределяемый.md @@ -0,0 +1,164 @@ +--- +title: Учет оригиналов первичных документов переопределяемый +slug: bsp/учет-оригиналов-первичных-документов-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Переопределяет настройки учета оригиналов первичных документов +// +// Параметры: +// Настройки - Структура: +// * ВыводитьКнопкиНаФормеДокумента - Булево - Истина, если необходимо отображение внешнего командного интерфейса +// по учету оригиналов первичных документов на формах документов в виде кнопок, +// Ложь - если в виде гиперссылки. Значение по умолчанию: Ложь. +// * ОтображатьПодсказкуВФормеИзмененияСостояний - Булево - Ложь, если необходимо убрать информационную надпись +// с формы "Изменение состояния оригинала документа" при уточнении состояния по печатным +// формам. Значение по умолчанию: Истина. +// * ОткрыватьВыпадающиеМенюПоГиперссылке - Булево - Ложь, если при нажатии на гиперссылку с состоянием оригинала +// первичного документа в форме списка или документа, необходимо сразу открывать форму +// "Изменение состояния оригинала документа" для уточнения состояния по печатным формам. +// Значение по умолчанию: Истина. +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриИзмененииОбщегоСостоянияОригинала +
+ +Описание, пример вызова + +```bsl + +// Позволяет доопределить действия при записи общего состояния оригинала. +// +// Параметры: +// Документ - ОпределяемыйТип.ОбъектСУчетомОригиналовПервичныхДокументов - ссылка на документ, для которого +// записывается новое общее состояние. +// СостояниеОригинала - СправочникСсылка.СостоянияОригиналовПервичныхДокументов - ссылка на устанавливаемое состояние. +// +Процедура ПриИзмененииОбщегоСостоянияОригинала(Документ, СостояниеОригинала) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовПереопределяемый.ПриИзмененииОбщегоСостоянияОригинала(Документ, СостояниеОригинала) +``` +
+ +## ПередЗаписьюСостоянийОригиналовПослеПечати +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить список объектов печати и печатных форм, перед записью состояний после печати. +// +// Параметры: +// ОбъектыПечати - СписокЗначений - список ссылок на объекты печати. +// СписокПечати - СписокЗначений - список с именами макетов и представлениями печатных форм. +// +Процедура ПередЗаписьюСостоянийОригиналовПослеПечати(ОбъектыПечати, СписокПечати) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовПереопределяемый.ПередЗаписьюСостоянийОригиналовПослеПечати(ОбъектыПечати, СписокПечати) +``` +
+ +## ПриОпределенииОбъектовСКомандамиУчетаОригиналов +
+ +Описание, пример вызова + +```bsl + +// Определяет объекты конфигурации, в формах списках которых размещены команды учета оригиналов первичных документов, +// +// Параметры: +// СписокОбъектов - Массив из Строка - менеджеры объектов с процедурой ДобавитьКомандыПечати. +// +Процедура ПриОпределенииОбъектовСКомандамиУчетаОригиналов(СписокОбъектов) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовПереопределяемый.ПриОпределенииОбъектовСКомандамиУчетаОригиналов(СписокОбъектов) +``` +
+ +## ПриОпределенииМногосотрудниковыхДокументов +
+ +Описание, пример вызова + +```bsl + +// Определяет объекты конфигурации, для которых отслеживание состояний будет в разрезе сотрудников. +// +// Параметры: +// СписокОбъектов - Соответствие из КлючИЗначение: +// * Ключ - ОбъектМетаданных. +// * Значение - Строка - наименование табличной части, в которой хранятся сотрудники. +// +Процедура ПриОпределенииМногосотрудниковыхДокументов(СписокОбъектов) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовПереопределяемый.ПриОпределенииМногосотрудниковыхДокументов(СписокОбъектов) +``` +
+ +## ЗаполнитьТаблицуУчетаОригиналов +
+ +Описание, пример вызова + +```bsl + +// Заполняет таблицу значений учета оригиналов +// Если тело процедуры оставить пустым - состояния будут отслеживаться по всем печатным формам подключенных объектов. +// Если в таблицу значений добавить объекты, подключенные к подсистеме учета оригиналов, и их печатные формы, +// то состояния будут отслеживаться только по ним. +// +// Параметры: +// ТаблицаУчетаОригиналов - ТаблицаЗначений - коллекция объектов и макетов по которым требуется вести учет оригиналов: +// * ОбъектМетаданных - ОбъектМетаданных. +// * Идентификатор - Строка - идентификатор макета. +// +// Пример: +// НоваяСтрока = ТаблицаУчетаОригиналов.Добавить(); +// НоваяСтрока.ОбъектМетаданных = Метаданные.Документы.РеализацияТоваров; +// НоваяСтрока.Идентификатор = "РасходнаяНакладная"; +// +Процедура ЗаполнитьТаблицуУчетаОригиналов(ТаблицаУчетаОригиналов) Экспорт +``` + +Пример вызова +```bsl +УчетОригиналовПервичныхДокументовПереопределяемый.ЗаполнитьТаблицуУчетаОригиналов(ТаблицаУчетаОригиналов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ФайловаяСистема.md b/src/content/docs/bsp/ФайловаяСистема.md new file mode 100644 index 0000000..6e8b77a --- /dev/null +++ b/src/content/docs/bsp/ФайловаяСистема.md @@ -0,0 +1,266 @@ +--- +title: Файловая система +slug: bsp/файловая-система +--- + + +## СоздатьВременныйКаталог +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для работы с временными файлами. + +// Создает временный каталог. После окончания работы с временным каталогом его необходимо удалить +// с помощью ФайловаяСистема.УдалитьВременныйКаталог. +// +// Параметры: +// Расширение - Строка - расширение каталога, которое идентифицирует назначение временного каталога +// и подсистему, которая его создала. +// Рекомендуется указывать на английском языке. +// +// Возвращаемое значение: +// Строка - полный путь к каталогу с разделителем пути. +// +Функция СоздатьВременныйКаталог(Знач Расширение = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистема.СоздатьВременныйКаталог(Расширение); +``` +
+ +## УдалитьВременныйКаталог +
+ +Описание, пример вызова + +```bsl + +// Удаляет временный каталог вместе с его содержимым, если возможно. +// Если временный каталог не может быть удален (например, он занят каким-то процессом), +// то в журнал регистрации записывается соответствующее предупреждение, а процедура завершается. +// +// Для совместного использования с ФайловаяСистема.СоздатьВременныйКаталог, +// после окончания работы с временным каталогом. +// +// Параметры: +// Путь - Строка - полный путь к временному каталогу. +// +Процедура УдалитьВременныйКаталог(Знач Путь) Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистема.УдалитьВременныйКаталог(Путь) +``` +
+ +## УдалитьВременныйФайл +
+ +Описание, пример вызова + +```bsl + +// Удаляет временный файл. +// +// Выбрасывает исключение, если передано имя не временного файла. +// +// Если временный файл не может быть удален (например, он занят каким-то процессом), +// то в журнал регистрации записывается соответствующее предупреждение, а процедура завершается. +// +// Для совместного использования с методом ПолучитьИмяВременногоФайла, +// после окончания работы с временным файлом. +// +// Параметры: +// Путь - Строка - полный путь к временному файлу. +// +Процедура УдалитьВременныйФайл(Знач Путь) Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистема.УдалитьВременныйФайл(Путь) +``` +
+ +## УникальноеИмяФайла +
+ +Описание, пример вызова + +```bsl + +// Формирует уникальное имя файла в указанной папке, при необходимости добавляя к имени файла порядковый номер, +// например: "файл (2).txt", "файл (3).txt" и т.п. +// +// Параметры: +// ИмяФайла - Строка - полное имя файла с папкой, например, "C:\Документы\файл.txt". +// +// Возвращаемое значение: +// Строка - например, "C:\Документы\файл (2).txt", если "файл.txt" уже существует в указанной папке. +// +Функция УникальноеИмяФайла(Знач ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистема.УникальноеИмяФайла(ИмяФайла) +``` +
+ +## ПараметрыЗапускаПрограммы +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции для работы с внешними приложениями. + +// Конструктор параметров для ФайловаяСистема.ЗапуститьПрограмму. +// +// Возвращаемое значение: +// Структура: +// * ТекущийКаталог - Строка - задает текущий каталог запускаемого приложения. +// * ДождатьсяЗавершения - Булево - Ложь - дожидаться завершения запущенного приложения +// перед продолжением работы. +// * ПолучитьПотокВывода - Булево - Ложь - результат, направленный в поток stdout, +// если не указан ДождатьсяЗавершения - игнорируется. +// * ПолучитьПотокОшибок - Булево - Ложь - ошибки, направленные в поток stderr, +// если не указан ДождатьсяЗавершения - игнорируется. +// * КодировкаПотоков - КодировкаТекста +// - Строка - кодировка, используемая для чтения stdout и stderr. +// По умолчанию используется для Windows "CP866", для остальных - "UTF-8". +// * КодировкаИсполнения - Строка +// - Число - кодировка, устанавливаемая в Windows с помощью команды chcp, +// возможные значения: "OEM", "CP866", "UTF8" или номер кодовой страницы. +// В Linux устанавливается переменной окружения "LANGUAGE" для конкретной команды, +// возможные значения можно определить выполнив команду "locale -a", например "ru_RU.UTF-8". +// В MacOS игнорируется. +// +Функция ПараметрыЗапускаПрограммы() Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистема.ПараметрыЗапускаПрограммы() +``` +
+ +## ЗапуститьПрограмму +
+ +Описание, пример вызова + +```bsl + +// Запускает внешнюю программу на исполнение (например, *.exe, *bat), +// или системную команду (например, ping, tracert или traceroute, обращаться к rac-клиенту), +// Позволяет также получать код возврата и значения потоков вывода (stdout) и ошибок (stderr) +// +// При запуске внешней программы в пакетном режиме поток вывода и поток ошибок может возвращаться на не ожидаемом языке. +// Для того чтобы передать внешней программе язык, на котором ожидается результат следует: +// - указать язык в параметре запуска этой программы (если такой параметр предусмотрен). +// Например, в пакетном режиме платформы 1С:Предприятие предусмотрен ключ "/L en"; +// - в других случаях явно установить кодировку исполнения пакетной команды. +// См. свойство КодировкаИсполнения возвращаемого значения ФайловаяСистема.ПараметрыЗапускаПрограммы. +// +// Параметры: +// КомандаЗапуска - Строка - командная строка для запуска программы. +// - Массив - первый элемент массива, путь к исполняемому приложению, +// остальные элементы массива - это передаваемые параметры, +// массив соответствует тому, который получит вызываемая программа в argv. +// ПараметрыЗапускаПрограммы - см. ФайловаяСистема.ПараметрыЗапускаПрограммы +// +// Возвращаемое значение: +// Структура: +// * КодВозврата - Число - код возврата программы; +// * ПотокВывода - Строка - результат работы программы, направленный в поток stdout; +// * ПотокОшибок - Строка - ошибки исполнения программы, направленные в поток stderr. +// +// Пример: +// // Простой запуск +// ФайловаяСистема.ЗапуститьПрограмму("calc"); +// +// // Запуск с ожиданием завершения +// ПараметрыЗапускаПрограммы = ФайловаяСистема.ПараметрыЗапускаПрограммы(); +// ПараметрыЗапускаПрограммы.ДождатьсяЗавершения = Истина; +// ФайловаяСистема.ЗапуститьПрограмму("C:\Program Files\1cv8\common\1cestart.exe", +// ПараметрыЗапускаПрограммы); +// +// // Запуск с ожиданием завершения и получением потока вывода +// ПараметрыЗапускаПрограммы = ФайловаяСистема.ПараметрыЗапускаПрограммы(); +// ПараметрыЗапускаПрограммы.ДождатьсяЗавершения = Истина; +// ПараметрыЗапускаПрограммы.ПолучитьПотокВывода = Истина; +// Результат = ФайловаяСистема("ping 127.0.0.1 -n 5", ПараметрыЗапускаПрограммы); +// ОбщегоНазначений.СообщитьПользователю(Результат.ПотокВывода); +// +// // Запуск с ожиданием завершения и получением потока вывода ИС конкатенацией команды запуска +// ПараметрыЗапускаПрограммы = ФайловаяСистема.ПараметрыЗапускаПрограммы(); +// ПараметрыЗапускаПрограммы.ДождатьсяЗавершения = Истина; +// ПараметрыЗапускаПрограммы.ПолучитьПотокВывода = Истина; +// КомандаЗапуска = Новый Массив; +// КомандаЗапуска.Добавить("ping"); +// КомандаЗапуска.Добавить("127.0.0.1"); +// КомандаЗапуска.Добавить("-n"); +// КомандаЗапуска.Добавить(5); +// Результат = ФайловаяСистема.ЗапуститьПрограмму(КомандаЗапуска, ПараметрыЗапускаПрограммы); +// ОбщегоНазначений.СообщитьПользователю(Результат.ПотокВывода); +// +Функция ЗапуститьПрограмму(Знач КомандаЗапуска, ПараметрыЗапускаПрограммы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистема.ЗапуститьПрограмму(КомандаЗапуска, ПараметрыЗапускаПрограммы); +``` +
+ +## ОбщийКаталогВременныхФайлов +
+ +Описание, пример вызова + +```bsl + +// Возвращает путь к общему сетевому каталогу временных файлов. +// +// Для корректной работы программы в клиент-серверном варианте временные файлы +// следует размещать в общем сетевом каталоге, одинаково доступном с любого сервера в кластере. +// Это обеспечит доступ со всех серверов кластера к временному файлу, например, +// для его обработки в фоновых заданиях, работающих параллельно +// Путь к каталогу определяется в общих настройках администрирования. +// Если путь не заполнен или информационная база развернута в файловом варианте, то каталог +// создается во временном каталоге пользователя. +// Следует удалять временные файлы в каталоге самостоятельно после их использования, +// т.к. при активном создании файлов временные файлы могут занять значительную часть дискового пространства. +// +// Параметры: +// ВложенныйКаталог - Строка - если указан, то внутри общего сетевого каталога будет создан подчиненный каталог. +// +// Возвращаемое значение: +// Строка - путь к каталогу временных файлов. +// +Функция ОбщийКаталогВременныхФайлов(ВложенныйКаталог = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистема.ОбщийКаталогВременныхФайлов(ВложенныйКаталог); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ФайловаяСистемаКлиент.md b/src/content/docs/bsp/ФайловаяСистемаКлиент.md new file mode 100644 index 0000000..7880188 --- /dev/null +++ b/src/content/docs/bsp/ФайловаяСистемаКлиент.md @@ -0,0 +1,774 @@ +--- +title: Файловая система клиент +slug: bsp/файловая-система-клиент +--- + + +## ЗагрузитьФайл +
+ +Описание, пример вызова + +```bsl + +// Показывает диалог выбора файла и помещает выбранный файл во временное хранилище. +// Совмещает работу методов глобального контекста НачатьПомещениеФайла и НачатьПомещениеФайлов, +// возвращая идентичный результат вне зависимости от того, подключено или нет расширение для работы с 1С:Предприятием. +// Ограничения: +// Не используется для выбора каталогов - эта опция не поддерживается веб-клиентом. +// +// Параметры: +// ОбработчикЗавершения - ОписаниеОповещения - содержит описание процедуры, которая будет вызвана после +// загрузки файла со следующими параметрами: +// # ПомещенныйФайл - Структура - пользователь выбрал файл: +// ## Хранение - Строка - адрес временного хранилища с двоичными данными файла. +// ## Имя - Строка - в тонком клиенте и в веб-клиенте с установленным +// расширением работы с 1С:Предприятием - локальный путь, по которому +// был получен файл. В веб-клиенте без расширения для работы с 1С:Предприятием +// передается имя файла с расширением. +// - Неопределено - пользователь отказался от выбора или файл занят другой программой. +// # ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта +// ОписаниеОповещения. +// ПараметрыЗагрузки - см. ФайловаяСистемаКлиент.ПараметрыЗагрузкиФайла. +// ИмяФайла - Строка - полный путь к файлу, который будет предложен пользователю в начале +// интерактивного выбора или помещен во временное хранилище в неинтерактивном. +// Если выбран неинтерактивный режим и параметр не заполнен, будет вызвано исключение. +// АдресВоВременномХранилище - Строка - адрес, по которому будет сохранен файл. +// +// Пример: +// Оповещение = Новый ОписаниеОповещения("ВыбратьФайлПослеПомещенияФайла", ЭтотОбъект, Контекст); +// ПараметрыЗагрузки = ФайловаяСистемаКлиент.ПараметрыЗагрузкиФайла(); +// ПараметрыЗагрузки.ИдентификаторФормы = УникальныйИдентификатор; +// ФайловаяСистемаКлиент.ЗагрузитьФайл(Оповещение, ПараметрыЗагрузки); +// +Процедура ЗагрузитьФайл(ОбработчикЗавершения, ПараметрыЗагрузки = Неопределено, ИмяФайла = "", Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.ЗагрузитьФайл(ОбработчикЗавершения, ПараметрыЗагрузки, ИмяФайла, ); +``` +
+ +## ЗагрузитьФайлы +
+ +Описание, пример вызова + +```bsl + +// Показывает диалог выбора файлов и помещает выбранные файлы во временное хранилище. +// Совмещает работу методов глобального контекста НачатьПомещениеФайла и НачатьПомещениеФайлов, +// возвращая идентичный результат вне зависимости от того, подключено или нет расширение для работы с 1С:Предприятием. +// Ограничения: +// Не используется для выбора каталогов - эта опция не поддерживается веб-клиентом. +// Не поддерживается множественный выбор в веб-клиенте, если не установлено расширение для работы с 1С:Предприятием. +// +// Параметры: +// ОбработчикЗавершения - ОписаниеОповещения - содержит описание процедуры, которая будет вызвана после +// загрузки файлов со следующими параметрами: +// # ПомещенныеФайлы - Неопределено - пользователь отказался от выбора или файл занят другой программой. +// - Массив из Структура - пользователь выбрал файл: +// ## Хранение - Строка - адрес временного хранилища с двоичными данными файла. +// ## Имя - Строка - в тонком клиенте и в веб-клиенте с установленным +// расширением работы с 1С:Предприятием - локальный путь, по которому +// был получен файл. В веб-клиенте без расширения для работы с 1С:Предприятием +// передается имя файла с расширением. +// ## ПолноеИмя - Строка - в тонком клиенте и в веб-клиенте с установленным +// расширением работы с 1С:Предприятием - локальный путь, по которому +// был получен файл. В веб-клиенте без расширения для работы с 1С:Предприятием +// принимает значение "". +// ## ИмяФайла - Строка - имя файла с расширением. +// # ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// ПараметрыЗагрузки - см. ФайловаяСистемаКлиент.ПараметрыЗагрузкиФайла. +// ЗагружаемыеФайлы - Массив - содержит объекты типа ОписаниеПередаваемогоФайла. Может быть заполнен полностью, +// в этом случае загружаемые файлы будут сохранены по указанным адресам. Может быть заполнен +// частично - у элементов массива заполнены только имена. В этом случае, загружаемые файлы будут +// размещены в новых временных хранилищах. Массив может быть не заполнен. В этом случае набор +// помещаемых файлов определяется по значениям, указанным в параметре ПараметрыЗагрузки. Если в +// параметрах загрузки выбран неинтерактивный режим и параметр ЗагружаемыеФайлы не заполнен, +// будет вызвано исключение. +// +// Пример: +// Оповещение = Новый ОписаниеОповещения("ЗагрузитьРасширениеПослеПомещенияФайлов", ЭтотОбъект, Контекст); +// ПараметрыЗагрузки = ФайловаяСистемаКлиент.ПараметрыЗагрузкиФайла(); +// ПараметрыЗагрузки.ИдентификаторФормы = УникальныйИдентификатор; +// ФайловаяСистемаКлиент.ЗагрузитьФайлы(Оповещение, ПараметрыЗагрузки); +// +Процедура ЗагрузитьФайлы(ОбработчикЗавершения, ПараметрыЗагрузки = Неопределено, ЗагружаемыеФайлы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.ЗагрузитьФайлы(ОбработчикЗавершения, ПараметрыЗагрузки, ЗагружаемыеФайлы); +``` +
+ +## СохранитьФайл +
+ +Описание, пример вызова + +```bsl + +// Получает файл и сохраняет его в локальную файловую систему пользователя. +// +// Параметры: +// ОбработчикЗавершения - Неопределено +// - ОписаниеОповещения - содержит описание процедуры, которая будет вызвана после +// завершения со следующими параметрами: +// # ПолученныеФайлы - Массив из ОписаниеПереданногоФайла - сохраненные файлы. +// - Неопределено - файлы не были получены. +// # ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// РасположениеФайла - Строка - адрес временного хранилища или навигационная ссылка на +// реквизит типа ХранилищеЗначения, содержащий двоичные данные файла. +// ИмяФайла - Строка - полный путь, по которому должен быть сохранен получаемый файл или имя файла +// с расширением. +// ПараметрыСохранения - см. ФайловаяСистемаКлиент.ПараметрыСохраненияФайла +// +// Пример: +// Оповещение = Новый ОписаниеОповещения("СохранитьСертификатПослеПолученияФайлов", ЭтотОбъект, Контекст); +// ПараметрыСохранения = ФайловаяСистемаКлиент.ПараметрыСохраненияФайла(); +// ФайловаяСистемаКлиент.СохранитьФайл(Оповещение, Контекст.АдресСертификата, ИмяФайла, ПараметрыСохранения); +// +Процедура СохранитьФайл(ОбработчикЗавершения, РасположениеФайла, ИмяФайла = "", Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.СохранитьФайл(ОбработчикЗавершения, РасположениеФайла, ИмяФайла, ); +``` +
+ +## СохранитьФайлы +
+ +Описание, пример вызова + +```bsl + +// Получает файлы и сохраняет их в локальную файловую систему пользователя. +// Для сохранения файлов в неинтерактивном режиме свойство Имя параметра СохраняемыеФайлы должно содержать +// полный путь к сохраняемому файлу или, если свойство Имя содержит только имя файла с расширением, необходимо +// заполнить свойство Каталог элемента Диалог параметра ПараметрыСохранения. В иных случаях будет вызвано +// исключение. +// +// Параметры: +// ОбработчикЗавершения - Неопределено +// - ОписаниеОповещения - содержит описание процедуры, которая будет вызвана +// после завершения со следующими параметрами: +// * ПолученныеФайлы - Массив из ОписаниеПереданногоФайла - сохраненные файлы. +// - Неопределено - файлы не были получены. +// * ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта +// ОписаниеОповещения. +// СохраняемыеФайлы - Массив из ОписаниеПередаваемогоФайла +// ПараметрыСохранения - см. ФайловаяСистемаКлиент.ПараметрыСохраненияФайла +// +// Пример: +// Оповещение = Новый ОписаниеОповещения("СохранитьПечатнуюФормуВФайлПослеПолученияФайлов", ЭтотОбъект); +// ПараметрыСохранения = ФайловаяСистемаКлиент.ПараметрыСохраненияФайлов(); +// ФайловаяСистемаКлиент.СохранитьФайлы(Оповещение, ПолучаемыеФайлы, ПараметрыСохранения); +// +Процедура СохранитьФайлы(ОбработчикЗавершения, СохраняемыеФайлы, ПараметрыСохранения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.СохранитьФайлы(ОбработчикЗавершения, СохраняемыеФайлы, ПараметрыСохранения); +``` +
+ +## ПараметрыЗагрузкиФайла +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для загрузки файла из файловой системы. +// Для использования в ФайловаяСистемаКлиент.ЗагрузитьФайл и ФайловаяСистемаКлиент.ЗагрузитьФайлы +// +// Возвращаемое значение: +// Структура: +// * ИдентификаторФормы - УникальныйИдентификатор - уникальный идентификатор формы, из +// которой выполняется размещение файла. Если параметр не заполнен, +// необходимо вызывать метод глобального контекста УдалитьИзВременногоХранилища +// после завершения работы с полученными двоичными данными. Значение по +// умолчанию - Неопределено. +// * Интерактивно - Булево - указывает использование интерактивного режима, при котором +// пользователю показывается диалог выбора файлов. Значение по +// умолчанию - Истина. +// * Диалог - ДиалогВыбораФайла - свойства см. в синтакс-помощнике. +// Используется, если свойство Интерактивно принимает значение Истина и +// удалось подключить расширение для работы с 1С:Предприятием. +// * ТекстПредложения - Строка - текст предложения об установке расширения. Если параметр +// принимает значение "", будет выведен стандартный текст предложения. +// Значение по умолчанию - "". +// * ДействиеПередНачаломПомещенияФайлов - ОписаниеОповещения +// - Неопределено - содержит описание процедуры, +// которая будет вызвана непосредственно перед началом помещения файла +// во временное хранилище.Если параметр принимает значение Неопределено, +// перед помещением файла никакая процедура вызываться не будет. Значение +// по умолчанию - Неопределено. Параметры вызываемой процедуры: +// # ПомещаемыеФайлы - СсылкаНаФайл +// - Массив из СсылкаНаФайл - ссылка на файл, готовый к помещению во временное хранилище. +// Если загружалось несколько файлов, содержит массив ссылок. +// # ОтказОтПомещенияФайла - Булево - признак отказа от дальнейшего помещения файла. Если в теле процедуры-обработчика +// установить данному параметру значение Истина, то помещение файла будет отменено. +// # ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// +// Пример: +// ПараметрыЗагрузки = ФайловаяСистемаКлиент.ПараметрыЗагрузкиФайла(); +// ПараметрыЗагрузки.Диалог.Заголовок = НСтр("ru = 'Выберите документ'"); +// ПараметрыЗагрузки.Диалог.Фильтр = НСтр("ru = 'Файлы MS Word (*.doc;*.docx)|*.doc;*.docx|Все файлы (*.*)|*.*'"); +// ФайловаяСистемаКлиент.ЗагрузитьФайл(Оповещение, ПараметрыЗагрузки); +// +Функция ПараметрыЗагрузкиФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистемаКлиент.ПараметрыЗагрузкиФайла() +``` +
+ +## ПараметрыСохраненияФайла +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для сохранения файла в файловую систему. +// Для использования в ФайловаяСистемаКлиент.СохранитьФайл. +// +// Возвращаемое значение: +// Структура: +// * Интерактивно - Булево - указывает использование интерактивного режима, при котором +// пользователю показывается диалог выбора файлов. Значение по +// умолчанию - Истина. +// * Диалог - ДиалогВыбораФайла - свойства см. в синтакс-помощнике. +// Используется, если свойство Интерактивно принимает значение Истина и +// удалось подключить расширение для работы с 1С:Предприятием. +// * ТекстПредложения - Строка - текст предложения об установке расширения. Если параметр +// принимает значение "", будет выведен стандартный текст предложения. +// Значение по умолчанию - "". +// +// Пример: +// ПараметрыСохранения = ФайловаяСистемаКлиент.ПараметрыСохраненияФайла(); +// ПараметрыСохранения.Диалог.Заголовок = НСтр("ru = 'Сохранить профиль ключевых операций в файл'"); +// ПараметрыСохранения.Диалог.Фильтр = "Файлы профиля ключевых операций (*.xml)|*.xml"; +// ФайловаяСистемаКлиент.СохранитьФайл(Неопределено, СохранитьПрофильКлючевыхОперацийНаСервере(), , ПараметрыСохранения); +// +Функция ПараметрыСохраненияФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистемаКлиент.ПараметрыСохраненияФайла() +``` +
+ +## ПараметрыСохраненияФайлов +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для сохранения файла в файловую систему. +// Для использования в ФайловаяСистемаКлиент.СохранитьФайлы. +// +// Возвращаемое значение: +// Структура: +// * Интерактивно - Булево - указывает использование интерактивного режима, при котором +// пользователю показывается диалог выбора файлов. Значение по +// умолчанию - Истина. +// * Диалог - ДиалогВыбораФайла - свойства см. в синтакс-помощнике. +// Используется, если свойство Интерактивно принимает значение Истина и +// удалось подключить расширение для работы с 1С:Предприятием. +// * ТекстПредложения - Строка - текст предложения об установке расширения. Если параметр +// принимает значение "", будет выведен стандартный текст предложения. +// Значение по умолчанию - "". +// +// Пример: +// ПараметрыСохранения = ФайловаяСистемаКлиент.ПараметрыСохраненияФайлов(); +// ПараметрыСохранения.Диалог.Заголовок = НСтр("ru ='Выбор папки для сохранения сформированного документа'"); +// ФайловаяСистемаКлиент.СохранитьФайлы(Оповещение, ПолучаемыеФайлы, ПараметрыСохранения); +// +Функция ПараметрыСохраненияФайлов() Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистемаКлиент.ПараметрыСохраненияФайлов() +``` +
+ +## ПараметрыОткрытияФайла +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для открытия файла. +// Для использования в ФайловаяСистемаКлиент.ОткрытьФайл. +// +// Возвращаемое значение: +// Структура: +// *Кодировка - Строка - кодировка текстового файла. Если параметр не задан, формат текста +// будет определен автоматически. Список кодировок см. в синтакс-помощнике в +// описании метода Записать текстового документа. Значение по умолчанию - "". +// *ДляРедактирования - Булево - Истина, если файл открывается для редактирования, иначе Ложь. Если +// параметр принимает значение Истина, ожидает закрытия программы и если в параметре +// РасположениеФайла хранится адрес во временном хранилище, обновляет данные файла. +// Значение по умолчанию - Ложь. +// +Функция ПараметрыОткрытияФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистемаКлиент.ПараметрыОткрытияФайла() +``` +
+ +## ОткрытьФайл +
+ +Описание, пример вызова + +```bsl + +// Открывает файл для просмотра или редактирования. +// Если файл открывается из двоичных данных во временном хранилище, предварительно сохраняет +// его во временный каталог. +// +// Параметры: +// РасположениеФайла - Строка - полный путь к файлу в файловой системе, адрес временного хранилища +// или навигационная ссылка на реквизит типа ХранилищеЗначения с двоичными данными файла. +// ОбработчикЗавершения - ОписаниеОповещения +// - Неопределено - описание процедуры, принимающей результат работы процедуры +// с параметрами: +// # ФайлИзменен - Булево - изменен файл на компьютере или двоичные данные во временном хранилище. +// # ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта +// ОписаниеОповещения. +// ИмяФайла - Строка - имя файла с расширением или расширение файла без точки. Если +// параметр РасположениеФайла содержит адрес во временном хранилище и параметр +// ИмяФайла не заполнен, будет вызвано исключение. +// ПараметрыОткрытия - см. ФайловаяСистемаКлиент.ПараметрыОткрытияФайла. +// +Процедура ОткрытьФайл(РасположениеФайла, ОбработчикЗавершения = Неопределено, ИмяФайла = "", Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.ОткрытьФайл(РасположениеФайла, ОбработчикЗавершения, ИмяФайла, ); +``` +
+ +## ОткрытьПроводник +
+ +Описание, пример вызова + +```bsl + +// Открывает проводник с указанным путем. +// Если передан путь к файлу, то выполняет позиционирование курсора в проводнике на этом файле. +// +// Параметры: +// ПутьККаталогуИлиФайлу - Строка - полный путь к файлу или каталогу на компьютере. +// +// Пример: +// // Для Windows +// ФайловаяСистемаКлиент.ОткрытьПроводник("C:\Users"); +// ФайловаяСистемаКлиент.ОткрытьПроводник("C:\Program Files\1cv8\common\1cestart.exe"); +// // Для Linux +// ФайловаяСистемаКлиент.ОткрытьПроводник("/home/"); +// ФайловаяСистемаКлиент.ОткрытьПроводник("/opt/1C/v8.3/x86_64/1cv8c"); +// +Процедура ОткрытьПроводник(ПутьККаталогуИлиФайлу) Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.ОткрытьПроводник(ПутьККаталогуИлиФайлу) +``` +
+ +## ОткрытьНавигационнуюСсылку +
+ +Описание, пример вызова + +```bsl + +// Открывает навигационную ссылку в программе, которая ассоциирована с протоколом навигационной ссылки. +// Допустимые протоколы: HTTP, https, e1c, v8help, mailto, tel, skype. +// +// Для открытия проводника или файла в программе просмотра не следует формировать ссылку по протоколу file:// +// - для открытия проводника см. ОткрытьПроводник. +// - для открытия файла по расширению см. ОткрытьФайлВПрограммеПросмотра. +// +// Параметры: +// НавигационнаяСсылка - Строка - ссылка, которую требуется открыть. +// Оповещение - ОписаниеОповещения - оповещение о результате открытия. +// Если оповещение не задано, в случае ошибки будет показано предупреждение. +// ПриложениеЗапущено - Булево - Истина, если внешнее приложение не вызвало ошибок при открытии. +// ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// +// Пример: +// ФайловаяСистемаКлиент.ОткрытьНавигационнуюСсылку("e1cib/navigationpoint/startpage"); // начальная страница. +// ФайловаяСистемаКлиент.ОткрытьНавигационнуюСсылку("v8help://1cv8/QueryLanguageFullTextSearchInData"); +// ФайловаяСистемаКлиент.ОткрытьНавигационнуюСсылку("https://1c.ru"); +// ФайловаяСистемаКлиент.ОткрытьНавигационнуюСсылку("mailto:help@1c.ru"); +// ФайловаяСистемаКлиент.ОткрытьНавигационнуюСсылку("skype:echo123?call"); +// +Процедура ОткрытьНавигационнуюСсылку(НавигационнаяСсылка, Знач Оповещение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.ОткрытьНавигационнуюСсылку(НавигационнаяСсылка, Оповещение); +``` +
+ +## ПараметрыЗапускаПрограммы +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров для ФайловаяСистемаКлиент.ЗапуститьПрограмму. +// +// Возвращаемое значение: +// Структура: +// * ТекущийКаталог - Строка - задает текущий каталог запускаемого приложения. +// * Оповещение - ОписаниеОповещения - оповещение о результате завершения запущенного приложения, +// если оповещение не задано в случае ошибки будет показано предупреждение. Параметры обработчика завершения: +// # Результат - Структура - результат работы программы: +// ## ПриложениеЗапущено - Булево - Истина, если внешнее приложение не вызвало ошибок при открытии. +// ## ОписаниеОшибки - Строка - краткое описание ошибки. При отмене пользователем пустая строка. +// ## КодВозврата - Число - код возврата программы. +// ## ПотокВывода - Строка - результат работы программы, направленный в поток stdout. +// В веб-клиенте всегда принимает значение "". +// ## ПотокОшибок - Строка - ошибки исполнения программы, направленные в поток stderr. +// В веб-клиенте всегда принимает значение "". +// # ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// * ДождатьсяЗавершения - Булево - Истина, дожидаться завершения запущенного приложения перед продолжением работы. +// * ПолучитьПотокВывода - Булево - Ложь - результат, направленный в поток stdout, +// если не указан ДождатьсяЗавершения - игнорируется. +// * ПолучитьПотокОшибок - Булево - Ложь - ошибки, направленные в поток stderr, +// если не указан ДождатьсяЗавершения - игнорируется. +// * КодировкаПотоков - КодировкаТекста +// - Строка - кодировка, используемая для чтения stdout и stderr. +// По умолчанию для Windows "CP866", для остальных - "UTF-8". +// * КодировкаИсполнения - Строка +// - Число - кодировка, устанавливаемая в Windows с помощью команды chcp, +// возможные значения: "OEM", "CP866", "UTF8" или номер кодовой страницы. +// В Linux устанавливается переменной окружения "LANGUAGE" для конкретной команды, +// возможные значения можно определить выполнив команду "locale -a", например "ru_RU.UTF-8". +// В MacOS игнорируется. +// * ВыполнитьСНаивысшимиПравами - Булево - Истина, если требуется запустить программу на исполнение +// с повышением привилегий системы: +// Windows: запрос UAC; +// Linux: исполнение с командой pkexec; +// macOS, веб-клиент и мобильный клиент: будет возвращен Результат.ОписаниеОшибки. +// * СредаИсполнения - Строка - пустая строка, если среда исполнения не Windows. Используется при +// определении недопустимых символов в строке запуска. +// +Функция ПараметрыЗапускаПрограммы() Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистемаКлиент.ПараметрыЗапускаПрограммы() +``` +
+ +## ЗапуститьПрограмму +
+ +Описание, пример вызова + +```bsl + +// Запускает внешнюю программу на исполнение (например, *.exe, *bat), +// или системную команду (например, ping, tracert или traceroute, обращаться к rac-клиенту), +// Позволяет также получать код возврата и значения потоков вывода (stdout) и ошибок (stderr) +// +// При запуске внешней программы в пакетном режиме поток вывода и поток ошибок может возвращаться на не ожидаемом языке. +// Для того чтобы передать внешней программе язык, на котором ожидается результат следует: +// - указать язык в параметре запуска этой программы (если такой параметр предусмотрен). +// Например, в пакетном режиме платформы 1С:Предприятие предусмотрен ключ "/L en"; +// - в других случаях явно установить кодировку исполнения пакетной команды. +// См. свойство КодировкаИсполнения возвращаемого значения ФайловаяСистемаКлиент.ПараметрыЗапускаПрограммы. +// +// Параметры: +// КомандаЗапуска - Строка - командная строка для запуска программы. +// - Массив из Строка - первый элемент массива - путь к исполняемому приложению, остальные - +// передаваемые параметры, массив соответствует тому, который получит вызываемая программа в argv. +// ПараметрыЗапускаПрограммы - см. ФайловаяСистемаКлиент.ПараметрыЗапускаПрограммы. +// +// Пример: +// // Простой запуск +// ФайловаяСистемаКлиент.ЗапуститьПрограмму("calc"); +// +// Пример: +// // Передача аргументов в виде массива: +// // Для выполнения Setup.exe -args "PIDKEY =***": +// КомандаЗапуска = Новый Массив; +// КомандаЗапуска.Добавить("Setup.exe"); +// КомандаЗапуска.Добавить("- args"); +// КомандаЗапуска.Добавить("PIDKEY =***"); +// ФайловаяСистемаКлиент.ЗапуститьПрограмму(КомандаЗапуска); +// +// // Запуск с ожиданием завершения и получения кода возврата: +// ПараметрыЗапускаПрограммы = ФайловаяСистемаКлиент.ПараметрыЗапускаПрограммы(); +// ПараметрыЗапускаПрограммы.ДождатьсяЗавершения = Истина; +// ПараметрыЗапускаПрограммы.ПолучитьПотокВывода = Истина; +// ПараметрыЗапускаПрограммы.ПолучитьПотокОшибок = Истина; +// ПараметрыЗапускаПрограммы.Оповещение = Новый ОписаниеОповещения("ПриПолученииРезультатаЗапускаПрограммы", ЭтотОбъект); +// +// ФайловаяСистемаКлиент.ЗапуститьПрограмму("ping 127.0.0.1 -n 5", ПараметрыЗапускаПрограммы); +// +// // Пример обработки оповещения +// &НаКлиенте +// Процедура ПриПолученииРезультатаЗапускаПрограммы(Результат, ДополнительныеПараметры) Экспорт +// КодВозврата = Результат.КодВозврата; +// ПотокВывода = Результат.ПотокВывода; +// ПотокОшибок = Результат.ПотокОшибок; +// КонецПроцедуры +// +Процедура ЗапуститьПрограмму(Знач КомандаЗапуска, Знач ПараметрыЗапускаПрограммы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.ЗапуститьПрограмму(КомандаЗапуска, ПараметрыЗапускаПрограммы); +``` +
+ +## НапечататьИзПриложенияПоИмениФайла +
+ +Описание, пример вызова + +```bsl + +// Выполняет печать файла внешним приложением. +// +// Параметры: +// ИмяОткрываемогоФайла - Строка +// +Процедура НапечататьИзПриложенияПоИмениФайла(ИмяОткрываемогоФайла) Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.НапечататьИзПриложенияПоИмениФайла(ИмяОткрываемогоФайла) +``` +
+ +## ВыбратьКаталог +
+ +Описание, пример вызова + +```bsl + +// Показывает диалог выбора каталога. +// +// Параметры: +// ОбработчикЗавершения - ОписаниеОповещения - содержит описание процедуры, которая будет вызвана после +// закрытия диалога выбора со следующими параметрами: +// # ПутьККаталогу - Строка - полный путь к каталогу. Если не установлено расширение для работы с 1С:Предприятием +// или пользователь отказался от выбора, возвращает пустую строку. +// # ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// Заголовок - Строка - заголовок диалога выбора каталога. +// Каталог - Строка - начальное значение каталога, предлагаемое по умолчанию. +// +Процедура ВыбратьКаталог(ОбработчикЗавершения, Заголовок = "", Каталог = "") Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.ВыбратьКаталог(ОбработчикЗавершения, Заголовок, Каталог); +``` +
+ +## ПоказатьДиалогВыбора +
+ +Описание, пример вызова + +```bsl + +// Показывает диалог выбора файла. +// В веб-клиенте пользователю будет показан диалог установки расширения для работы с 1С:Предприятием, +// если требуется. +// +// Параметры: +// ОбработчикЗавершения - ОписаниеОповещения - содержит описание процедуры, которая будет вызвана после +// закрытия диалога выбора с параметрами: +// # Результат - Массив из Строка - выбранные имена файлов. +// - Строка - пустая строка, если пользователь отказался от установки расширения. +// - Неопределено - если пользователь отказался от выбора файла. +// # ДополнительныеПараметры - Произвольный - дополнительные параметры оповещения. +// Диалог - ДиалогВыбораФайла - свойства см. в синтакс-помощнике. +// +Процедура ПоказатьДиалогВыбора(ОбработчикЗавершения, Диалог) Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.ПоказатьДиалогВыбора(ОбработчикЗавершения, Диалог) +``` +
+ +## СоздатьВременныйКаталог +
+ +Описание, пример вызова + +```bsl + +// Получение имени временного каталога. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение о результате получения со следующими параметрами: +// # ИмяКаталога - Строка - путь к созданному каталогу. +// # ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// Расширение - Строка - суффикс в имени каталога, который поможет идентифицировать каталог при анализе. +// +Процедура СоздатьВременныйКаталог(Знач Оповещение, Расширение = "") Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.СоздатьВременныйКаталог(Оповещение, Расширение); +``` +
+ +## ПодключитьРасширениеДляРаботы1СПредприятия +
+ +Описание, пример вызова + +```bsl + +// Предлагает пользователю установить расширение для работы с 1С:Предприятием в веб-клиенте. +// Предназначена для использования в начале участков кода, в которых ведется работа с файлами. +// +// Параметры: +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - описание процедуры, которая будет вызвана после закрытия +// формы со следующими параметрами: +// # РасширениеПодключено - Булево - Истина, если расширение было подключено. +// # ДополнительныеПараметры - Произвольный - параметры, заданные в ОписаниеОповещенияОЗакрытии. +// ТекстПредложения - Строка - текст сообщения. Если не указан, то выводится текст по умолчанию. +// ВозможноПродолжениеБезУстановки - Булево - если Истина, будет показана кнопка ПродолжитьБезУстановки, +// если Ложь, будет показана кнопка Отмена. +// +// Пример: +// +// Оповещение = Новый ОписаниеОповещения("ПечатьДокументаЗавершение", ЭтотОбъект); +// ТекстСообщения = НСтр("ru = 'Для печати документа необходимо установить расширение для работы с 1С:Предприятием.'"); +// ФайловаяСистемаКлиент.ПодключитьРасширениеДляРаботы1СПредприятия(Оповещение, ТекстСообщения); +// +// Процедура ПечатьДокументаЗавершение(РасширениеПодключено, ДополнительныеПараметры) Экспорт +// Если РасширениеПодключено Тогда +// // код печати документа, рассчитывающий на то, что расширение подключено. +// // ... +// Иначе +// // код печати документа, который работает без подключенного расширения. +// // ... +// КонецЕсли; +// +Процедура ПодключитьРасширениеДляРаботы1СПредприятия(ОписаниеОповещенияОЗакрытии, ТекстПредложения = "", Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.ПодключитьРасширениеДляРаботы1СПредприятия(ОписаниеОповещенияОЗакрытии, ТекстПредложения, ); +``` +
+ +## УникальноеИмяФайла +
+ +Описание, пример вызова + +```bsl + +// Формирует уникальное имя файла в указанной папке, при необходимости добавляя к имени файла порядковый номер, +// например: "файл (2).txt", "файл (3).txt" и т.п. +// +// Параметры: +// ИмяФайла - Строка - полное имя файла с папкой, например, "C:\Документы\файл.txt". +// +// Возвращаемое значение: +// Строка - например, "C:\Документы\файл (2).txt", если "файл.txt" уже существует в указанной папке. +// +Функция УникальноеИмяФайла(Знач ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайловаяСистемаКлиент.УникальноеИмяФайла(ИмяФайла) +``` +
+ +## ПодключитьРасширениеДляРаботыСФайлами +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ПодключитьРасширениеДляРаботы1СПредприятия. +// Предлагает пользователю установить расширение для работы с 1С:Предприятием в веб-клиенте. +// Предназначена для использования в начале участков кода, в которых ведется работа с файлами. +// +// Параметры: +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - описание процедуры, которая будет вызвана после закрытия +// формы со следующими параметрами: +// # РасширениеПодключено - Булево - Истина, если расширение было подключено. +// # ДополнительныеПараметры - Произвольный - параметры, заданные в ОписаниеОповещенияОЗакрытии. +// ТекстПредложения - Строка - текст сообщения. Если не указан, то выводится текст по умолчанию. +// ВозможноПродолжениеБезУстановки - Булево - если Истина, будет показана кнопка ПродолжитьБезУстановки, +// если Ложь, будет показана кнопка Отмена. +// +// Пример: +// +// Оповещение = Новый ОписаниеОповещения("ПечатьДокументаЗавершение", ЭтотОбъект); +// ТекстСообщения = НСтр("ru = 'Для печати документа необходимо установить расширение для работы с 1С:Предприятием.'"); +// ФайловаяСистемаКлиент.ПодключитьРасширениеДляРаботыСФайлами(Оповещение, ТекстСообщения); +// +// Процедура ПечатьДокументаЗавершение(РасширениеПодключено, ДополнительныеПараметры) Экспорт +// Если РасширениеПодключено Тогда +// // код печати документа, рассчитывающий на то, что расширение подключено. +// // ... +// Иначе +// // код печати документа, который работает без подключенного расширения. +// // ... +// КонецЕсли; +// +Процедура ПодключитьРасширениеДляРаботыСФайлами(ОписаниеОповещенияОЗакрытии, ТекстПредложения = "", Экспорт +``` + +Пример вызова +```bsl +ФайловаяСистемаКлиент.ПодключитьРасширениеДляРаботыСФайлами(ОписаниеОповещенияОЗакрытии, ТекстПредложения, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ФайлыБТС.md b/src/content/docs/bsp/ФайлыБТС.md new file mode 100644 index 0000000..d07ccbd --- /dev/null +++ b/src/content/docs/bsp/ФайлыБТС.md @@ -0,0 +1,268 @@ +--- +title: Файлы БТС +slug: bsp/файлы-бтс +--- + + +## ОбщийКаталогВременныхФайлов +
+ +Описание, пример вызова + +```bsl + +// Путь общего каталога временных файлов для доступа между сеансами. +// +// Возвращаемое значение: +// Строка - полный путь к каталогу. +// +Функция ОбщийКаталогВременныхФайлов() Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыБТС.ОбщийКаталогВременныхФайлов() +``` +
+ +## НовыйФайлВременногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Регистрирует уникальное имя файла во временном хранилище. +// +// Параметры: +// Префикс - Строка - Префикс имени файла. Только английские буквы и цифры, до 20-и символов +// Расширение - Строка - Расширение файла. Только английские буквы и цифры, до 4-х символов +// МинутХранения - Число - Минут хранения файла. Не менее одной минуты +// +// Возвращаемое значение: +// Строка - имя зарегистрированного временного файла. +Функция НовыйФайлВременногоХранилища(Знач Префикс, Знач Расширение, МинутХранения) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыБТС.НовыйФайлВременногоХранилища(Префикс, Расширение, МинутХранения) +``` +
+ +## СвойстваФайлаВременногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Свойства файла временного хранилища. +// +// Параметры: +// ИмяФайла - Строка - имя зарегистрированного во временном хранилище файла +// +// Возвращаемое значение: +// Структура - Свойства файла временного хранилища: +// * Зарегистрирован - Булево +// * ДатаРегистрации - Дата +// * СрокХранения - Дата +// * ПутьWindows - Строка +// * ПутьLinux - Строка +Функция СвойстваФайлаВременногоХранилища(ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыБТС.СвойстваФайлаВременногоХранилища(ИмяФайла) +``` +
+ +## ПолноеИмяФайлаВременногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Полное имя файла временного хранилища. +// +// Параметры: +// ИмяФайла - Строка - имя зарегистрированного во временном хранилище файла +// +// Возвращаемое значение: +// Строка, Неопределено - полное имя файла. Неопределено - если файл не зарегистрирован +Функция ПолноеИмяФайлаВременногоХранилища(ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыБТС.ПолноеИмяФайлаВременногоХранилища(ИмяФайла) +``` +
+ +## ПолноеИмяФайлаВСеансе +
+ +Описание, пример вызова + +```bsl + +// Полное имя файла в сеансе в зависимости от ОС рабочего сервера. +// +// Параметры: +// Имя - Строка +// ПутьWindows - Строка +// ПутьLinux - Строка +// +// Возвращаемое значение: +// Строка - полное имя файла в сеансе. +Функция ПолноеИмяФайлаВСеансе(Имя, ПутьWindows, ПутьLinux) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыБТС.ПолноеИмяФайлаВСеансе(Имя, ПутьWindows, ПутьLinux) +``` +
+ +## УдалитьФайлВременногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Удалить файл временного хранилища. +// +// Параметры: +// ИмяФайла - Строка - имя зарегистрированного во временном хранилище файла +Процедура УдалитьФайлВременногоХранилища(ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +ФайлыБТС.УдалитьФайлВременногоХранилища(ИмяФайла) +``` +
+ +## УдалитьВсеФайлыВременногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Удалить все файлы временного хранилища, кроме заблокированных. +// +// Параметры: +// Граница - Дата - Универсальная дата, до которой следует удалить файлы +Процедура УдалитьВсеФайлыВременногоХранилища(Граница) Экспорт +``` + +Пример вызова +```bsl +ФайлыБТС.УдалитьВсеФайлыВременногоХранилища(Граница) +``` +
+ +## ЗаблокироватьФайлВременногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Заблокировать файл временного хранилища. +// +// Параметры: +// ИмяФайла - Строка - имя зарегистрированного во временном хранилище файла +// ИдентификаторФормы - УникальныйИдентификатор, Неопределено - идентификатор формы, на время жизни которой файл будет +// оставаться заблокированным. +// +// Возвращаемое значение: +// Булево - Истина, если блокировка установлена +Функция ЗаблокироватьФайлВременногоХранилища(ИмяФайла, ИдентификаторФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыБТС.ЗаблокироватьФайлВременногоХранилища(ИмяФайла, ИдентификаторФормы); +``` +
+ +## РазблокироватьФайлВременногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Разблокировать файл временного хранилища. +// +// Параметры: +// ИмяФайла - Строка - имя зарегистрированного во временном хранилище файла +// ИдентификаторФормы - УникальныйИдентификатор, Неопределено - идентификатор формы, в которой файл был заблокирован +Процедура РазблокироватьФайлВременногоХранилища(ИмяФайла, ИдентификаторФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ФайлыБТС.РазблокироватьФайлВременногоХранилища(ИмяФайла, ИдентификаторФормы); +``` +
+ +## ФайлВременногоХранилищаЗаблокирован +
+ +Описание, пример вызова + +```bsl + +// Файл временного хранилища заблокирован. +// +// Параметры: +// ИмяФайла - Строка - имя зарегистрированного во временном хранилище файла +// +// Возвращаемое значение: +// Булево +Функция ФайлВременногоХранилищаЗаблокирован(ИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыБТС.ФайлВременногоХранилищаЗаблокирован(ИмяФайла) +``` +
+ +## УстановитьСрокХраненияФайлаВременногоХранилища +
+ +Описание, пример вызова + +```bsl + +// Установить срок хранения файла временного хранилища относительно текущей универсальной даты. +// +// Параметры: +// ИмяФайла - Строка - имя зарегистрированного во временном хранилище файла +// МинутХранения - Число - Минут хранения файла +// +// Возвращаемое значение: +// Булево - Истина, если срок хранения установлен +Функция УстановитьСрокХраненияФайлаВременногоХранилища(ИмяФайла, МинутХранения) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыБТС.УстановитьСрокХраненияФайлаВременногоХранилища(ИмяФайла, МинутХранения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ФайлыБТСКлиент.md b/src/content/docs/bsp/ФайлыБТСКлиент.md new file mode 100644 index 0000000..b3bbd63 --- /dev/null +++ b/src/content/docs/bsp/ФайлыБТСКлиент.md @@ -0,0 +1,155 @@ +--- +title: Файлы БТС клиент +slug: bsp/файлы-бтс-клиент +--- + + +## ПараметрыПолученияФайла +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для получения файла с сервера на клиент. +// Для использования в ФайлыБТСКлиент.ПолучитьФайлИнтерактивно. +// +// Возвращаемое значение: +// Структура - Параметры получения файла: +// * ИмяФайлаИлиАдрес - Строка - Адрес во временном хранилище, либо имя файла на сервере (без пути) для +// получения клиентом. Если указан адрес во временном хранилище, то при попытке получения файлов +// более 4Гб будет вызвано исключение. +// * ПутьФайлаWindows - Строка - Путь к файлу при работе сеанса на Windows сервере. Значение игнорируется, +// если в параметре ИмяФайлаИлиАдрес указан адрес во временном хранилище или указано имя зарегистрированного +// файла временного хранилища. +// * ПутьФайлаLinux - Строка - Путь к файлу при работе сеанса на Linux сервере. Значение игнорируется, +// если в параметре ИмяФайлаИлиАдрес указан адрес во временном хранилище или указано имя зарегистрированного +// файла временного хранилища. +// * ОписаниеОповещенияОЗавершении - ОписаниеОповещения, Неопределено - Содержит описание процедуры, которая +// будет вызвана после получения файла. Если указано Неопределено, никакой обработчик запускаться +// не будет. Вызываемая процедура должна иметь параметры: +// Результат - Структура, Неопределено - при отказе от получения файла, либо структура со свойствами: +// ИмяФайлаИлиАдрес - Строка - Адрес во временном хранилище, либо имя файла на сервере (без пути) +// ИмяФайлаНаКлиенте - Строка - полное имя клиентского файла, полученного клиентом +// ДополнительныеПараметры - Произвольный - значение, которое было указано при создании +// объекта ОписаниеОповещения. +// * БлокируемаяФорма - ФормаКлиентскогоПриложения, Неопределено - Владелец формы получения файла для блокировки. +// Если указано Неопределено, на время загрузки будет заблокирован весь интерфейс. +// * ЗаголовокДиалогаСохранения - Строка, Неопределено - заголовок диалога выбора и формы загрузки файла. +// Если указано Неопределено, заголовки будут сформированы автоматически. +// * ЗаголовокОперацииПолучения - Строка, Неопределено - заголовок формы, отображающей длительную операцию. +// * ФильтрДиалогаСохранения - Строка, Неопределено - фильтр диалога выбора файла для сохранения. +// Если указано Неопределено, в диалоге можно будет выбрать любой файл. +// * ИмяФайлаДиалогаСохранения - Строка - Имя клиентского файла, которое будет предложено в диалоге +// выбора файла для сохранения. +// * ПоказатьВопросОткрытьСохранить - Булево - признак того, что при получении файла необходимо +// дополнительно задать вопрос, и при положительном ответе сразу открыть файл. Если указано Ложь, +// вопрос задаваться не будет. Если в параметре ИмяФайлаИлиАдрес указан адрес во временном хранилище, +// то значение параметра игнорируется, а поведение регулируется платформой. +Функция ПараметрыПолученияФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыБТСКлиент.ПараметрыПолученияФайла() +``` +
+ +## ПараметрыПомещенияФайла +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для помещения файла из файловой системы клиента на сервер. +// Для использования в ФайлыБТСКлиент.ПоместитьФайлИнтерактивно. +// +// Возвращаемое значение: +// Структура - со свойствами: +// * ИмяФайлаИлиАдрес - Строка - Адрес во временном хранилище, либо имя файла на сервере (без пути) +// для помещения. Если указан адрес во временном хранилище, то при попытке помещения файлов более 4Гб +// будет вызвано исключение, а для помещения файла более 100Мб потребуется расширение для работы с файлами. +// Если указан путь к файлу на сервере, то результат будет записан в файл, а для успешной работы в веб +// так же потребуется установка расширения для работы с файлами. +// * ПутьФайлаWindows - Строка - Путь к файлу при работе сеанса на Windows сервере. Значение игнорируется, +// если в параметре ИмяФайлаИлиАдрес указан адрес во временном хранилище или указано имя зарегистрированного +// файла временного хранилища. +// * ПутьФайлаLinux - Строка - Путь к файлу при работе сеанса на Linux сервере. Значение игнорируется, +// если в параметре ИмяФайлаИлиАдрес указан адрес во временном хранилище или указано имя зарегистрированного +// файла временного хранилища. +// * ОписаниеОповещенияОЗавершении - ОписаниеОповещения, Неопределено - Содержит описание процедуры, которая +// будет вызвана после помещения файла. Если указано Неопределено, никакой обработчик запускаться не будет +// Вызываемая процедура должна иметь параметры: +// Результат - Структура, Неопределено - Неопределено при отказе, либо структура со свойствами: +// ИмяФайлаИлиАдрес - Строка - Адрес во временном хранилище, либо имя файла на сервере (без пути) +// ИмяФайлаНаКлиенте - Строка - полное имя клиентского файла, помещенного на сервер +// ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта +// ОписаниеОповещения. +// * БлокируемаяФорма - ФормаКлиентскогоПриложения, Неопределено - Владелец формы загрузки файла для блокировки. +// Если указано Неопределено, на время загрузки будет заблокирован весь интерфейс. +// * ЗаголовокДиалогаВыбора - Строка, Неопределено - заголовок диалога выбора файла. +// * ЗаголовокОперацииПомещения - Строка, Неопределено - заголовок формы, отображающей длительную операцию загрузки. +// * ФильтрДиалогаВыбора - Строка, Неопределено - фильтр диалога выбора файла. Если указано Неопределено, в диалоге +// можно будет выбрать любой файл. +// * ИмяФайлаДиалогаВыбора - Строка - Имя клиентского файла, которое будет предложено в диалоге выбора файла +// * МаксимальныйРазмер - Число, Неопределено - максимальный размер клиентского файла, доступного к помещению +// на сервер. Если указано Неопределено, размер клиентсколго файла контролироваться не будет. +Функция ПараметрыПомещенияФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыБТСКлиент.ПараметрыПомещенияФайла() +``` +
+ +## ПолучитьФайлИнтерактивно +
+ +Описание, пример вызова + +```bsl + +// Получает размещенный во временном хранилище или на диске сервера файл, и сохраняет его на клиенте +// в локальной файловой системе пользователя. +// +// Параметры: +// ПараметрыПолученияФайла - см. ПараметрыПолученияФайла +Процедура ПолучитьФайлИнтерактивно(ПараметрыПолученияФайла) Экспорт +``` + +Пример вызова +```bsl +ФайлыБТСКлиент.ПолучитьФайлИнтерактивно(ПараметрыПолученияФайла) +``` +
+ +## ПоместитьФайлИнтерактивно +
+ +Описание, пример вызова + +```bsl + +// Помещает выбранный на клиенте файл из локальной файловой системы пользователя во временное хранилище +// или в файл на диске сервера. +// +// Параметры: +// ПараметрыПомещенияФайла - см. ПараметрыПомещенияФайла +Процедура ПоместитьФайлИнтерактивно(ПараметрыПомещенияФайла) Экспорт +``` + +Пример вызова +```bsl +ФайлыБТСКлиент.ПоместитьФайлИнтерактивно(ПараметрыПомещенияФайла) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ФайлыОбластейДанных.md b/src/content/docs/bsp/ФайлыОбластейДанных.md new file mode 100644 index 0000000..edb1546 --- /dev/null +++ b/src/content/docs/bsp/ФайлыОбластейДанных.md @@ -0,0 +1,203 @@ +--- +title: Файлы областей данных +slug: bsp/файлы-областей-данных +--- + + +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Типы - см. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +ФайлыОбластейДанных.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ОписаниеФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя, размер, расположение или двоичные данные файла по идентификатору. +// Если файл хранится на диске, в значение ПолноеИмя возвращается расположение файла. +// Если файл хранится в информационной базе, в значение Данные возвращаются двоичные данные. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОбластьДанных - Число - номер области данных. +// Идентификатор - Строка - идентификатор файла (длина - 36). +// +// Возвращаемое значение: +// Структура - описание файла, см. НовыйОписаниеФайла: +// * ИмяФайла - Строка - имя файла +// * Размер - Число - размер файла в байтах +// * ПолноеИмя - Строка, Неопределено - расположение файла в томе. +// * Данные - ДвоичныеДанные, Неопределено - двоичные данные файла. +// * CRC32 - Число - контрольная сумма данных файла. +// * УстановитьВременныйПриПолучении - Булево - признак временного при получении. +// +Функция ОписаниеФайла(Знач ОбластьДанных, Знач Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыОбластейДанных.ОписаниеФайла(ОбластьДанных, Идентификатор) +``` +
+ +## ДвоичныеДанныеФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает двоичные данные файла по идентификатору. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОбластьДанных - Число - номер области данных. +// Идентификатор - Строка - идентификатор файла (длина - 36). +// +// Возвращаемое значение: +// ДвоичныеДанные - двоичные данные файла. +// +Функция ДвоичныеДанныеФайла(Знач ОбластьДанных, Знач Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыОбластейДанных.ДвоичныеДанныеФайла(ОбластьДанных, Идентификатор) +``` +
+ +## ОписаниеПередаваемогоФайла +
+ +Описание, пример вызова + +```bsl + +// Помещает данные файла во временное хранилище и возвращает описание +// для сохранения или открытия файла. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОбластьДанных - Число - номер области данных. +// ИдентификаторФайла - УникальныйИдентификатор - идентификатор файла. +// ИдентификаторФормы - УникальныйИдентификатор - идентификатор формы для помещения. +// +// Возвращаемое значение: +// ОписаниеПередаваемогоФайла - ОписаниеПередаваемогоФайла - описание для сохранения или открытия файла. +// +Функция ОписаниеПередаваемогоФайла(Знач ОбластьДанных, ИдентификаторФайла, ИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыОбластейДанных.ОписаниеПередаваемогоФайла(ОбластьДанных, ИдентификаторФайла, ИдентификаторФормы) +``` +
+ +## ЗагрузитьФайл +
+ +Описание, пример вызова + +```bsl + +// Сохраняет данные как запись о файле в регистре сведений ФайлыОбластейДанных. +// Если параметр Данные = Неопределено, должен быть заполнен параметр ПолноеИмя = полное имя файла с путем. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОбластьДанных - Число - номер области данных. +// Имя - Строка - имя файла в хранилище. +// Данные - ДвоичныеДанные, Строка, Неопределено - двоичные данные файла, если ПолноеИмя = Неопределено. +// ПолноеИмя - Строка, Неопределено - полное имя файла с путем, если Данные = Неопределено. +// Временный - Булево - признак временного файла (будет удален по заданному расписанию рег. задания УдалениеВременныхФайловОбластейДанных) +// УстановитьВременныйПриПолучении - Булево - устанавливать признак временного файла при первом получении. +// +// Возвращаемое значение: +// УникальныйИдентификатор - Идентификатор файла. +// +Функция ЗагрузитьФайл(Знач ОбластьДанных, Знач Имя, Данные = Неопределено, ПолноеИмя = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыОбластейДанных.ЗагрузитьФайл(ОбластьДанных, Имя, Данные, ПолноеИмя, ); +``` +
+ +## УстановитьПризнакВременного +
+ +Описание, пример вызова + +```bsl + +// Устанавливает у файла признак "Временный" = Истина. +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОбластьДанных - Число - номер области данных. +// ИдентификаторФайла - УникальныйИдентификатор - идентификатор файла. +// +// Возвращаемое значение: +// Булево - Истина, если установка удалась, Ложь - в противном случае. +Функция УстановитьПризнакВременного(Знач ОбластьДанных, Знач ИдентификаторФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыОбластейДанных.УстановитьПризнакВременного(ОбластьДанных, ИдентификаторФайла) +``` +
+ +## УдалитьФайл +
+ +Описание, пример вызова + +```bsl + +// Удалить файл из информационной базы +// @skip-warning ПустойМетод - особенность реализации. +// +// Параметры: +// ОбластьДанных - Число - номер области данных. +// ИдентификаторФайла - УникальныйИдентификатор - идентификатор удаляемого файла. +// УдалятьЕслиНаДиске - Булево - если Ложь и хранение на диске, регистрируется как временный ИС диска не удаляется. +// +// Возвращаемое значение: +// Булево - Успешность удаления. +// +Функция УдалитьФайл(Знач ОбластьДанных, Знач ИдентификаторФайла, Знач УдалятьЕслиНаДиске = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ФайлыОбластейДанных.УдалитьФайл(ОбластьДанных, ИдентификаторФайла, УдалятьЕслиНаДиске); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ФизическиеЛицаКлиентСервер.md b/src/content/docs/bsp/ФизическиеЛицаКлиентСервер.md new file mode 100644 index 0000000..ff0b59e --- /dev/null +++ b/src/content/docs/bsp/ФизическиеЛицаКлиентСервер.md @@ -0,0 +1,92 @@ +--- +title: Физические лица клиент сервер +slug: bsp/физические-лица-клиент-сервер +--- + + +## ЧастиИмени +
+ +Описание, пример вызова + +```bsl + +// Раскладывает полное имя физического лица на составные части. +// +// Параметры: +// ПолноеИмя - см. ФизическиеЛицаКлиентСерверЛокализация.ПриОпределенииЧастейПолногоИмени.ПолноеИмя +// ФорматИмени - см. ФизическиеЛицаКлиентСерверЛокализация.ПриОпределенииЧастейПолногоИмени.ФорматИмени +// +// Возвращаемое значение: +// см. ФизическиеЛицаКлиентСерверЛокализация.ПриОпределенииЧастейПолногоИмени.Результат +// +Функция ЧастиИмени(ПолноеИмя, Знач ФорматИмени = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ФизическиеЛицаКлиентСервер.ЧастиИмени(ПолноеИмя, ФорматИмени); +``` +
+ +## ФамилияИнициалы +
+ +Описание, пример вызова + +```bsl + +// Формирует краткое представление из полного имени физического лица. +// +// Параметры: +// ПолноеИмя - см. ФизическиеЛицаКлиентСерверЛокализация.ПриОпределенииФамилииИнициалов.ПолноеИмя +// ФорматПолногоИмени - см. ФизическиеЛицаКлиентСерверЛокализация.ПриОпределенииФамилииИнициалов.ФорматПолногоИмени +// ИнициалыВНачале - см. ФизическиеЛицаКлиентСерверЛокализация.ПриОпределенииФамилииИнициалов.ИнициалыВНачале +// +// Возвращаемое значение: +// см. ФизическиеЛицаКлиентСерверЛокализация.ПриОпределенииФамилииИнициалов.Результат +// +Функция ФамилияИнициалы(Знач ПолноеИмя, Знач ФорматПолногоИмени = "", Знач ИнициалыВНачале = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ФизическиеЛицаКлиентСервер.ФамилияИнициалы(ПолноеИмя, ФорматПолногоИмени, ИнициалыВНачале); +``` +
+ +## ФИОНаписаноВерно +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать СтроковыеФункцииКлиентСервер.ТолькоСимволыНациональногоАлфавитаВСтроке +// +// Проверяет, верно ли написано ФИО физического лица. +// ФИО считается верным, если содержит только символы национального алфавита, либо только латиницу. +// +// Параметры: +// ФИО - Строка - фамилия, имя и отчество. Например, "Пупкин Василий Иванович". +// ТолькоНациональныеСимволы - Булево - при проверке ФИО должна включать только символы национального алфавита. +// +// Возвращаемое значение: +// Булево - Истина, если ФИО написано верно. +// +Функция ФИОНаписаноВерно(Знач ФИО, ТолькоНациональныеСимволы = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ФизическиеЛицаКлиентСервер.ФИОНаписаноВерно(ФИО, ТолькоНациональныеСимволы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ФизическиеЛицаКлиентСерверЛокализация.md b/src/content/docs/bsp/ФизическиеЛицаКлиентСерверЛокализация.md new file mode 100644 index 0000000..02da97a --- /dev/null +++ b/src/content/docs/bsp/ФизическиеЛицаКлиентСерверЛокализация.md @@ -0,0 +1,103 @@ +--- +title: Физические лица клиент сервер локализация +slug: bsp/физические-лица-клиент-сервер-локализация +--- + + +## ПриОпределенииФамилииИнициалов +
+ +Описание, пример вызова + +```bsl + +// Формирует краткое представление полного имени физического лица. +// +// Параметры: +// ПолноеИмя - Строка - например, "Пупкин Василий Иванович"; +// - Структура: +// * Фамилия - Строка +// * Имя - Строка +// * Отчество - Строка +// ФорматПолногоИмени - Строка - "Фамилия,Имя,Отчество" (по умолчанию) или "Имя,Отчество,Фамилия". +// ИнициалыВНачале - Булево - "Фамилия И. О.", если Ложь (по умолчанию), +// "И. О. Фамилия", если Истина +// Результат - Строка - фамилия и инициалы. Например, "Пупкин В. И.". +// +Процедура ПриОпределенииФамилииИнициалов(Знач ПолноеИмя, Знач ФорматПолногоИмени, Знач ИнициалыВНачале, Результат) Экспорт +``` + +Пример вызова +```bsl +ФизическиеЛицаКлиентСерверЛокализация.ПриОпределенииФамилииИнициалов(ПолноеИмя, ФорматПолногоИмени, ИнициалыВНачале, Результат) +``` +
+ +## ПриОпределенииЧастейПолногоИмени +
+ +Описание, пример вызова + +```bsl + +// Раскладывает полное имя физического лица на составные части - фамилию, имя и отчество. +// Если в конце полного имени встречаются "оглы", "улы", "уулу", "кызы" или "гызы", +// то они также считаются частью отчества. +// +// Параметры: +// ПолноеИмя - Строка - полное имя в виде "Фамилия Имя Отчество". +// ФорматИмени - Строка - определяет порядок частей имени во входном параметре. +// "Фамилия,Имя,Отчество"" - фамилия в начале (по умолчанию), +// "Имя,Отчество,Фамилия" - фамилия в конце. +// Результат - Структура: +// * Фамилия - Строка - фамилия; +// * Имя - Строка - имя; +// * Отчество - Строка - отчество. +// +// Пример: +// 1. ФизическиеЛицаКлиентСервер.ЧастиИмени("Иванов Иван Иванович") +// вернет структуру со значениями свойств: "Иванов", "Иван", "Иванович". +// 2. ФизическиеЛицаКлиентСервер.ЧастиИмени("Смит Джон") +// вернет структуру со значениями свойств: "Смит", "Джон", "". +// 3. ФизическиеЛицаКлиентСервер.ЧастиИмени("Алиев Ахмед Октай оглы") +// вернет структуру со значениями свойств: "Алиев", "Ахмед", "Октай оглы". +// +Процедура ПриОпределенииЧастейПолногоИмени(Знач ПолноеИмя, Знач ФорматИмени, Результат) Экспорт +``` + +Пример вызова +```bsl +ФизическиеЛицаКлиентСерверЛокализация.ПриОпределенииЧастейПолногоИмени(ПолноеИмя, ФорматИмени, Результат) +``` +
+ +## ФИОНаписаноВерно +
+ +Описание, пример вызова + +```bsl + +// Проверяет, верно ли написано ФИО физического лица. +// +// Параметры: +// ФИО - Строка - фамилия, имя и отчество. +// ТолькоНациональныеСимволы - Булево - при проверке ФИО должна включать только символы национального алфавита. +// РезультатПроверки - Булево - возвращаемое значение. Если Истина, то ФИО написано верно. +// +Процедура ФИОНаписаноВерно(Знач ФИО, Знач ТолькоНациональныеСимволы, РезультатПроверки) Экспорт +``` + +Пример вызова +```bsl +ФизическиеЛицаКлиентСерверЛокализация.ФИОНаписаноВерно(ФИО, ТолькоНациональныеСимволы, РезультатПроверки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ХранилищеСертификатов.md b/src/content/docs/bsp/ХранилищеСертификатов.md new file mode 100644 index 0000000..f3a5e05 --- /dev/null +++ b/src/content/docs/bsp/ХранилищеСертификатов.md @@ -0,0 +1,157 @@ +--- +title: Хранилище сертификатов +slug: bsp/хранилище-сертификатов +--- + + +## Добавить +
+ +Описание, пример вызова + +```bsl + +// Добавляет сертификат в хранилище сертификатов. +// +// Параметры: +// Сертификат - ДвоичныеДанные - файл сертификата. +// - Строка - адрес файла сертификата во временном хранилище. +// ТипХранилища - Строка, ПеречислениеСсылка.ТипХранилищаСертификатов - тип хранилища, в которое необходимо добавить сертификат. +// +Процедура Добавить(Сертификат, ТипХранилища) Экспорт +``` + +Пример вызова +```bsl +ХранилищеСертификатов.Добавить(Сертификат, ТипХранилища) +``` +
+ +## Получить +
+ +Описание, пример вызова + +```bsl + +// Получает сертификаты из хранилища. +// +// Параметры: +// ТипХранилища - Строка, ПеречислениеСсылка.ТипХранилищаСертификатов - тип хранилища, из которого необходимо получить +// сертификаты. +// Если не заполнено, то будут получены все сертификаты. +// +// Возвращаемое значение: +// Массив из ФиксированнаяСтруктура - свойства сертификатов: +// * Версия - Строка - версия сертификата. +// * ДатаНачала - Дата - дата начала действия сертификата. +// * ДатаОкончания - Дата - дата окончания действия сертификата. +// * Издатель - ФиксированнаяСтруктура - информация об издателе сертификата: +// ** CN - Строка - commonName +// ** O - Строка - organizationName +// ** OU - Строка - organizationUnitName +// ** C - Строка - countryName +// ** ST - Строка - stateOrProvinceName +// ** L - Строка - localityName +// ** E - Строка - emailAddress +// ** SN - Строка - surname +// ** GN - Строка - givenName +// ** T - Строка - title +// ** STREET - Строка - streetAddress +// ** OGRN - Строка - ОГРН +// ** OGRNIP - Строка - ОГРНИП +// ** INN - Строка - ИНН (не обязательный) +// ** INNLE - Строка - ИНН ЮЛ (не обязательный) +// ** SNILS - Строка - СНИЛС +// * ИспользоватьДляПодписи - Булево - указывает, можно ли использовать данный сертификат для подписи. +// * ИспользоватьДляШифрования - Булево - указывает, можно ли использовать данный сертификат для шифрования. +// * Отпечаток - ДвоичныеДанные - содержит данные отпечатка. Вычисляется динамически, по алгоритму SHA-1. +// * РасширенныеСвойства - ФиксированнаяСтруктура - расширенные свойства сертификата: +// ** EKU - ФиксированныйМассив из Строка - Enhanced Key Usage. +// * СерийныйНомер - ДвоичныеДанные - серийный номер сертификата. +// * Субъект - ФиксированнаяСтруктура - информацию о субъекте сертификата: +// ** CN - Строка - commonName... и т.д. состав см. Издатель. +// * Сертификат - ДвоичныеДанные - файл сертификата в кодировке DER. +// * Идентификатор - Строка - вычисляется по ключевым свойствам Издателя и серийному номеру по алгоритму SHA1. +// Используется для идентификации сертификата в сервисе криптографии. +// +Функция Получить(ТипХранилища = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ХранилищеСертификатов.Получить(ТипХранилища); +``` +
+ +## НайтиСертификат +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиска сертификата в хранилище. +// +// Параметры: +// Сертификат - Структура - ключевые параметры сертификата, используемые для поиска: +// Отпечаток или пара СерийныйНомер и Издатель. +// * Отпечаток - ДвоичныеДанные - отпечаток сертификат. +// - Строка - строковое представление отпечатка. +// * СерийныйНомер - ДвоичныеДанные - серийный номер сертификата. +// - Строка - строковое представление серийного номера. +// * Издатель - Структура - свойства издателя +// - Строка - строковое представление издателя. +// +// Возвращаемое значение: +// Неопределено, ФиксированнаяСтруктура - сертификат не найден или свойства найденного сертификата: +// * Наименование - Строка - наименование сертификата. +// * Версия - Строка - версия сертификата. +// * ДатаНачала - Дата - дата начала действия сертификата. +// * ДатаОкончания - Дата - дата окончания действия сертификата. +// * Издатель - ФиксированнаяСтруктура - информация об издателе сертификата: +// ** CN - Строка - commonName; +// ** O - Строка - organizationName; +// ** OU - Строка - organizationUnitName; +// ** C - Строка - countryName; +// ** ST - Строка - stateOrProvinceName; +// ** L - Строка - localityName; +// ** E - Строка - emailAddress; +// ** SN - Строка - surname; +// ** GN - Строка - givenName; +// ** T - Строка - title; +// ** STREET - Строка - streetAddress; +// ** OGRN - Строка - ОГРН; +// ** OGRNIP - Строка - ОГРНИП; +// ** INN - Строка - ИНН (не обязательный); +// ** INNLE - Строка - ИНН ЮЛ (не обязательный); +// ** SNILS - Строка - СНИЛС; +// ... +// * ИспользоватьДляПодписи - Булево - указывает, можно ли использовать данный сертификат для подписи. +// * ИспользоватьДляШифрования - Булево - указывает, можно ли использовать данный сертификат для шифрования. +// * Отпечаток - ДвоичныеДанные - содержит данные отпечатка. Вычисляется динамически, по алгоритму SHA-1. +// * РасширенныеСвойства - ФиксированнаяСтруктура - расширенные свойства сертификата: +// ** EKU - ФиксированныйМассив из Строка - Enhanced Key Usage. +// * СерийныйНомер - ДвоичныеДанные - серийный номер сертификата. +// * Субъект - ФиксированнаяСтруктура - информацию о субъекте сертификата. Состав см. Издатель: +// ** CN - Строка - commonName и т.д... +// * Сертификат - ДвоичныеДанные - файл сертификата в кодировке DER. +// * Идентификатор - Строка - вычисляется по ключевым свойствам Издателя и серийному номеру по алгоритму SHA1. +// Используется для идентификации сертификата в сервисе криптографии. +// +Функция НайтиСертификат(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ХранилищеСертификатов.НайтиСертификат(Сертификат) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ХранилищеСертификатовКлиент.md b/src/content/docs/bsp/ХранилищеСертификатовКлиент.md new file mode 100644 index 0000000..9e71c64 --- /dev/null +++ b/src/content/docs/bsp/ХранилищеСертификатовКлиент.md @@ -0,0 +1,135 @@ +--- +title: Хранилище сертификатов клиент +slug: bsp/хранилище-сертификатов-клиент +--- + + +## Добавить +
+ +Описание, пример вызова + +```bsl + +// Добавляет сертификат в хранилище сертификатов. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура - результат выполнения процедуры. +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// +// Сертификат - ДвоичныеДанные - файл сертификата. +// Строка - адрес файла сертификата во временном хранилище. +// ТипХранилища - Строка, ПеречислениеСсылка.ТипХранилищаСертификатов - тип хранилища, в которое необходимо добавить сертификат. +// +Процедура Добавить(ОповещениеОЗавершении, Сертификат, ТипХранилища) Экспорт +``` + +Пример вызова +```bsl +ХранилищеСертификатовКлиент.Добавить(ОповещениеОЗавершении, Сертификат, ТипХранилища) +``` +
+ +## Получить +
+ +Описание, пример вызова + +```bsl + +// Получает сертификаты из хранилища. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура - результат выполнения процедуры. +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * Сертификаты - Массив - массив объектов ФиксированнаяСтруктура со свойствами сертификатов. +// ** Версия - Строка - версия сертификата. +// ** ДатаНачала - Дата - дата начала действия сертификата. +// ** ДатаОкончания - Дата - дата окончания действия сертификата. +// ** Издатель - ФиксированнаяСтруктура - информация об издателе сертификата: +// *** CN - commonName; +// *** O - organizationName; +// *** OU - organizationUnitName; +// *** C - countryName; +// *** ST - stateOrProvinceName; +// *** L - localityName; +// *** E - emailAddress; +// *** SN - surname; +// *** GN - givenName; +// *** T - title; +// *** STREET - streetAddress; +// *** OGRN - ОГРН; +// *** OGRNIP - ОГРНИП; +// *** INN - Строка - ИНН (не обязательный); +// *** INNLE - Строка - ИНН ЮЛ (не обязательный); +// *** SNILS - СНИЛС; +// ... +// ** ИспользоватьДляПодписи - Булево - указывает, можно ли использовать данный сертификат для подписи. +// ** ИспользоватьДляШифрования - Булево - указывает, можно ли использовать данный сертификат для шифрования. +// ** Отпечаток - ДвоичныеДанные - содержит данные отпечатка. Вычисляется динамически, по алгоритму SHA-1. +// ** РасширенныеСвойства - ФиксированнаяСтруктура - расширенные свойства сертификата: +// *** EKU - ФиксированныйМассив из Строка - Enhanced Key Usage. +// ** СерийныйНомер - ДвоичныеДанные - серийный номер сертификата. +// ** Субъект - ФиксированнаяСтруктура - информацию о субъекте сертификата. Состав см. Издатель. +// ** Сертификат - ДвоичныеДанные - файл сертификата в кодировке DER. +// ** Идентификатор - Строка - вычисляется по ключевым свойствам Издателя и серийному номеру по алгоритму SHA1. +// Используется для идентификации сертификата в сервисе криптографии. +// +// ТипХранилища - Строка, ПеречислениеСсылка.ТипХранилищаСертификатов - тип хранилища, из которого необходимо получить +// сертификаты. +// Если не заполнено, то будут получены все сертификаты. +// +Процедура Получить(ОповещениеОЗавершении, ТипХранилища = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ХранилищеСертификатовКлиент.Получить(ОповещениеОЗавершении, ТипХранилища); +``` +
+ +## НайтиСертификат +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиска сертификата в хранилище. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура - результат выполнения процедуры. +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * Сертификат - ФиксированнаяСтруктура, Неопределено - свойства найденного сертификата. +// +// Сертификат - Структура - ключевые параметры сертификата, используемые для поиска. +// Отпечаток или пара СерийныйНомер и Издатель. +// * Отпечаток - ДвоичныеДанные - отпечаток сертификат. +// Строка - строковое представление отпечатка. +// * СерийныйНомер - ДвоичныеДанные - серийный номер сертификата. +// Строка - строковое представление серийного номера. +// * Издатель - Структура - свойства издателя +// Строка - строковое представление издателя. +// +Процедура НайтиСертификат(ОповещениеОЗавершении, Сертификат) Экспорт +``` + +Пример вызова +```bsl +ХранилищеСертификатовКлиент.НайтиСертификат(ОповещениеОЗавершении, Сертификат) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЦентрМониторинга.md b/src/content/docs/bsp/ЦентрМониторинга.md new file mode 100644 index 0000000..bc77807 --- /dev/null +++ b/src/content/docs/bsp/ЦентрМониторинга.md @@ -0,0 +1,238 @@ +--- +title: Центр мониторинга +slug: bsp/центр-мониторинга +--- + + +## ЦентрМониторингаВключен +
+ +Описание, пример вызова + +```bsl + +// Проверяет состояние подсистемы. +// Возвращаемое значение: +// Булево - Истина включен, Ложь выключен. +// +Функция ЦентрМониторингаВключен() Экспорт +``` + +Пример вызова +```bsl +Результат = ЦентрМониторинга.ЦентрМониторингаВключен() +``` +
+ +## ВключитьПодсистему +
+ +Описание, пример вызова + +```bsl + +// Включает подсистему ЦентрМониторинга. +// +Процедура ВключитьПодсистему() Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторинга.ВключитьПодсистему() +``` +
+ +## ОтключитьПодсистему +
+ +Описание, пример вызова + +```bsl + +// Отключает подсистему ЦентрМониторинга. +// +Процедура ОтключитьПодсистему() Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторинга.ОтключитьПодсистему() +``` +
+ +## ИдентификаторИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Возвращает строковое представление идентификатора информационной базы в центре мониторинга. +// Возвращаемое значение: +// Строка - уникальный идентификатор информационной базы в центре мониторинга. +// +Функция ИдентификаторИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +Результат = ЦентрМониторинга.ИдентификаторИнформационнойБазы() +``` +
+ +## ЗаписатьОперациюБизнесСтатистики +
+ +Описание, пример вызова + +```bsl + +// Записывает операцию бизнес статистики. +// +// Параметры: +// ИмяОперации - Строка - имя операции статистики, в случае отсутствия создается новое. +// Значение - Число - количественное значение операции статистики. +// Комментарий - Строка - произвольный комментарий. +// Разделитель - Строка - разделитель значений в ИмяОперации, если разделитель не точка. +// +Процедура ЗаписатьОперациюБизнесСтатистики(ИмяОперации, Значение, Комментарий = Неопределено, Разделитель = ".") Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторинга.ЗаписатьОперациюБизнесСтатистики(ИмяОперации, Значение, Комментарий, Разделитель); +``` +
+ +## ЗаписатьОперациюБизнесСтатистикиЧас +
+ +Описание, пример вызова + +```bsl + +// Записывает уникальную операцию бизнес статистики в разрезе часа. +// При записи проверяет уникальность. +// +// Параметры: +// ИмяОперации - Строка - имя операции статистики, в случае отсутствия создается новое. +// КлючУникальности - Строка - ключ для контроля уникальности записи, максимальная длина 100. +// Значение - Число - количественное значение операции статистики. +// Замещать - Булево - определяет режим замещения существующей записи. +// Истина - перед записью существующая запись будет удалена. +// Ложь - если запись уже существует, новые данные игнорируются. +// Значение по умолчанию: Ложь. +// +Процедура ЗаписатьОперациюБизнесСтатистикиЧас(ИмяОперации, КлючУникальности, Значение, Замещать = Ложь) Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторинга.ЗаписатьОперациюБизнесСтатистикиЧас(ИмяОперации, КлючУникальности, Значение, Замещать); +``` +
+ +## ЗаписатьОперациюБизнесСтатистикиСутки +
+ +Описание, пример вызова + +```bsl + +// Записывает уникальную операцию бизнес статистики в разрезе суток. +// При записи проверяет уникальность. +// +// Параметры: +// ИмяОперации - Строка - имя операции статистики, в случае отсутствия создается новое. +// КлючУникальности - Строка - ключ для контроля уникальности записи, максимальная длина 100. +// Значение - Число - количественное значение операции статистики. +// Замещать - Булево - определяет режим замещения существующей записи. +// Истина - перед записью существующая запись будет удалена. +// Ложь - если запись уже существует, новые данные игнорируются. +// Значение по умолчанию: Ложь. +// +Процедура ЗаписатьОперациюБизнесСтатистикиСутки(ИмяОперации, КлючУникальности, Значение, Замещать = Ложь) Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторинга.ЗаписатьОперациюБизнесСтатистикиСутки(ИмяОперации, КлючУникальности, Значение, Замещать); +``` +
+ +## ЗаписыватьОперацииБизнесСтатистики +
+ +Описание, пример вызова + +```bsl + + +// Возвращает состояние регистрации бизнес-статистики. +// Возвращаемое значение: +// Булево - регистрировать бизнес статистику. +// +Функция ЗаписыватьОперацииБизнесСтатистики() Экспорт +``` + +Пример вызова +```bsl +Результат = ЦентрМониторинга.ЗаписыватьОперацииБизнесСтатистики() +``` +
+ +## ЗаписатьСтатистикуКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Записывает статистику по объектам конфигурации. +// +// Параметры: +// СоответствиеИменМетаданных - Структура: +// * Ключ - Строка - имя объекта метаданных. +// * Значение - Строка - текст запроса выборки данных, обязательно должно +// присутствовать поле Количество. Если Количество равно нулю, +// то запись не происходит. +// +Процедура ЗаписатьСтатистикуКонфигурации(СоответствиеИменМетаданных) Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторинга.ЗаписатьСтатистикуКонфигурации(СоответствиеИменМетаданных) +``` +
+ +## ЗаписатьСтатистикуОбъектаКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Записывает статистику по объекту конфигурации. +// +// Параметры: +// ИмяОбъекта - Строка - имя операции статистики, в случае отсутствия создается новое. +// Значение - Число - количественное значение операции статистики. Если значение +// равно нулю, то запись не происходит. +// +Процедура ЗаписатьСтатистикуОбъектаКонфигурации(ИмяОбъекта, Значение) Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторинга.ЗаписатьСтатистикуОбъектаКонфигурации(ИмяОбъекта, Значение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЦентрМониторингаКлиент.md b/src/content/docs/bsp/ЦентрМониторингаКлиент.md new file mode 100644 index 0000000..8901cd8 --- /dev/null +++ b/src/content/docs/bsp/ЦентрМониторингаКлиент.md @@ -0,0 +1,104 @@ +--- +title: Центр мониторинга клиент +slug: bsp/центр-мониторинга-клиент +--- + + +## ЗаписатьОперациюБизнесСтатистики +
+ +Описание, пример вызова + +```bsl + +// Записывает операцию бизнес статистики в кэш на клиенте. +// Запись в информационную базу происходит в обработчике ПриПериодическомПолученииДанныхКлиентаНаСервере +// общего модуля ОбщегоНазначенияПереопределяемый. +// При закрытии приложения данные не записываются. +// +// Параметры: +// ИмяОперации - Строка - имя операции статистики, в случае отсутствия создается новое. +// Значение - Число - количественное значение операции статистики. +// +Процедура ЗаписатьОперациюБизнесСтатистики(ИмяОперации, Значение) Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторингаКлиент.ЗаписатьОперациюБизнесСтатистики(ИмяОперации, Значение) +``` +
+ +## ЗаписатьОперациюБизнесСтатистикиЧас +
+ +Описание, пример вызова + +```bsl + +// Записывает уникальную операцию бизнес статистики в разрезе часа в кэш на клиенте. +// При записи проверяет уникальность. +// Запись в информационную базу происходит в обработчике ПриПериодическомПолученииДанныхКлиентаНаСервере +// общего модуля ОбщегоНазначенияПереопределяемый. +// При закрытии приложения данные не записываются. +// +// Параметры: +// ИмяОперации - Строка - имя операции статистики, в случае отсутствия создается новое. +// Значение - Число - количественное значение операции статистики. +// Замещать - Булево - определяет режим замещения существующей записи. +// Истина - перед записью существующая запись будет удалена. +// Ложь - если запись уже существует, новые данные игнорируются. +// Значение по умолчанию: Ложь. +// КлючУникальности - Строка - ключ для контроля уникальности записи, максимальная длина 100. Если не задан, +// используется хеш MD5 уникального идентификатора пользователя и номера сеанса. +// Значение по умолчанию: Неопределено. +// +Процедура ЗаписатьОперациюБизнесСтатистикиЧас(ИмяОперации, Значение, Замещать = Ложь, КлючУникальности = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторингаКлиент.ЗаписатьОперациюБизнесСтатистикиЧас(ИмяОперации, Значение, Замещать, КлючУникальности); +``` +
+ +## ЗаписатьОперациюБизнесСтатистикиСутки +
+ +Описание, пример вызова + +```bsl + +// Записывает уникальную операцию бизнес статистики в разрезе суток в кэш на клиенте. +// При записи проверяет уникальность. +// Запись в информационную базу происходит в обработчике ПриПериодическомПолученииДанныхКлиентаНаСервере +// общего модуля ОбщегоНазначенияПереопределяемый. +// При закрытии приложения данные не записываются. +// +// Параметры: +// ИмяОперации - Строка - имя операции статистики, в случае отсутствия создается новое. +// Значение - Число - количественное значение операции статистики. +// Замещать - Булево - определяет режим замещения существующей записи. +// Истина - перед записью существующая запись будет удалена. +// Ложь - если запись уже существует, новые данные игнорируются. +// Значение по умолчанию: Ложь. +// КлючУникальности - Строка - ключ для контроля уникальности записи, максимальная длина 100. Если не задан, +// используется хеш MD5 уникального идентификатора пользователя и номера сеанса. +// Значение по умолчанию: Неопределено. +// +Процедура ЗаписатьОперациюБизнесСтатистикиСутки(ИмяОперации, Значение, Замещать = Ложь, КлючУникальности = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторингаКлиент.ЗаписатьОперациюБизнесСтатистикиСутки(ИмяОперации, Значение, Замещать, КлючУникальности); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЦентрМониторингаПереопределяемый.md b/src/content/docs/bsp/ЦентрМониторингаПереопределяемый.md new file mode 100644 index 0000000..7dc073f --- /dev/null +++ b/src/content/docs/bsp/ЦентрМониторингаПереопределяемый.md @@ -0,0 +1,56 @@ +--- +title: Центр мониторинга переопределяемый +slug: bsp/центр-мониторинга-переопределяемый +--- + + +## ПриСбореПоказателейСтатистикиКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Выполняется при запуске регламентного задания. +// +Процедура ПриСбореПоказателейСтатистикиКонфигурации() Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторингаПереопределяемый.ПриСбореПоказателейСтатистикиКонфигурации() +``` +
+ +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Задает настройки, применяемые как умолчания для объектов подсистемы. +// +// Параметры: +// Настройки - Структура - коллекция настроек подсистемы. Реквизиты: +// * ВключитьОповещение - Булево - умолчание для оповещений пользователя: +// Истина - По умолчанию оповещаем администратора системы, например, если нет подсистемы "Текущие дела". +// Ложь - По умолчанию не оповещаем администратора системы. +// Значение по умолчанию: зависит от наличия подсистемы "Текущие дела". +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +ЦентрМониторингаПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ШаблоныСообщений.md b/src/content/docs/bsp/ШаблоныСообщений.md new file mode 100644 index 0000000..c9b65ec --- /dev/null +++ b/src/content/docs/bsp/ШаблоныСообщений.md @@ -0,0 +1,556 @@ +--- +title: Шаблоны сообщений +slug: bsp/шаблоны-сообщений +--- + + +## СформироватьСообщение +
+ +Описание, пример вызова + +```bsl + +// Создает сообщение на основании предмета по шаблону сообщения. +// +// Параметры: +// Шаблон - СправочникСсылка.ШаблоныСообщений - ссылка на шаблон сообщения. +// Предмет - Произвольный - объект основание для шаблона сообщений, типы объектов перечислены в +// определяемом типе ПредметШаблонаСообщения. +// УникальныйИдентификатор - УникальныйИдентификатор - идентификатор формы, необходим для размещения вложений во +// временном хранилище при клиент-серверном вызове. Если вызов +// происходит только на сервере, то можно использовать любой идентификатор. +// ДополнительныеПараметры - Структура - список дополнительных параметров, который будет передан в параметр +// Сообщение в процедурах ПриФормированииСообщения в момент создания сообщения: +// * ЗначенияПараметровСКД - Структура - значения параметров СКД, состав и значения реквизитов +// для формируемого шаблона определяется средствами СКД. +// * ПреобразовыватьHTMLДляФорматированногоДокумента - Булево - необязательный, по умолчанию Ложь, определяет +// необходимо ли преобразование HTML текста сообщения содержащего картинки в тексте письма из-за +// особенностей вывода изображений в форматированном документе. +// +// Возвращаемое значение: +// Структура - подготовленное сообщение на основание шаблона для отправки: +// * Тема - Строка - тема письма +// * Текст - Строка - текст письма +// * Получатель - СписокЗначений - получатели письма, где в значении электронная почта получателя, а +// в представлении получатель письма. +// - Массив из см. НовыйПолучателиПисьма - если в процедуре ПриОпределенииНастроек +// общего модуля ШаблоныСообщенийПереопределяемый свойство РасширенныйСписокПолучателей равно Истина. +// * ДополнительныеПараметры - Структура - параметры шаблона сообщения. +// * Вложения - ТаблицаЗначений: +// ** Представление - Строка - имя файла вложения. +// ** АдресВоВременномХранилище - Строка - адрес двоичных данных вложения во временном хранилище. +// ** Кодировка - Строка - кодировка вложения (используется, если отличается от кодировки письма). +// ** Идентификатор - Строка - необязательный, идентификатор вложения, используется для хранения +// картинок, отображаемых в теле письма. +// +Функция СформироватьСообщение(Шаблон, Предмет, УникальныйИдентификатор, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.СформироватьСообщение(Шаблон, Предмет, УникальныйИдентификатор, ДополнительныеПараметры); +``` +
+ +## СформироватьСообщениеИОтправить +
+ +Описание, пример вызова + +```bsl + +// Отправляет сообщение почты или SMS на основании предмета по шаблону сообщения. +// +// Параметры: +// Шаблон - СправочникСсылка.ШаблоныСообщений - ссылка на шаблон сообщения. +// Предмет - Произвольный - объект основание для шаблона сообщений, типы объектов перечислены в +// определяемом типе ПредметШаблонаСообщения. +// УникальныйИдентификатор - УникальныйИдентификатор - идентификатор формы, необходим для размещения вложений во +// временном хранилище. +// ДополнительныеПараметры - см. ПараметрыОтправкиПисьмаПоШаблону +// +// Возвращаемое значение: +// см. ШаблоныСообщенийСлужебный.РезультатОтправкиПисьма +// +Функция СформироватьСообщениеИОтправить(Шаблон, Предмет, УникальныйИдентификатор, Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.СформироватьСообщениеИОтправить(Шаблон, Предмет, УникальныйИдентификатор, ); +``` +
+ +## ПараметрыОтправкиПисьмаПоШаблону +
+ +Описание, пример вызова + +```bsl + +// Возвращает список обязательных дополнительных параметров, для процедуры СформироватьСообщениеИОтправить. +// Список параметров может быть расширен, для сквозной передачи в составе параметра Сообщение +// процедур ПриФормированииСообщения и последующего использования их значений при создании сообщения. +// +// Возвращаемое значение: +// Структура: +// * ПреобразовыватьHTMLДляФорматированногоДокумента - Булево - необязательный, по умолчанию Ложь, определяет, +// необходимо ли преобразование HTML-текста сообщения, содержащего картинки в тексте письма, из-за +// особенностей вывода изображений в форматированном документе. +// * УчетнаяЗапись - Неопределено +// - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - электронная почта +// для отправки письма, сформированного по шаблону. +// * ОтправитьСразу - Булево - если Ложь, то письмо будет помещено в папку Исходящих +// и отправлено при общей отправке писем. Только при отправке через Взаимодействие. +// Значение по умолчанию, Ложь. +// * ЗначенияПараметровСКД - Структура - значения параметров СКД, состав и значения реквизитов +// для формируемого шаблона определяется средствами СКД. +// +Функция ПараметрыОтправкиПисьмаПоШаблону() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.ПараметрыОтправкиПисьмаПоШаблону() +``` +
+ +## СформироватьСписокРеквизитовПоСКД +
+ +Описание, пример вызова + +```bsl + +// Заполняет список реквизитов шаблона сообщений на основание макета СКД. +// +// Параметры: +// Реквизиты - ДеревоЗначений - заполняемый список реквизитов. +// Макет - СхемаКомпоновкиДанных - макет СКД. +// +Процедура СформироватьСписокРеквизитовПоСКД(Реквизиты, Макет) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщений.СформироватьСписокРеквизитовПоСКД(Реквизиты, Макет) +``` +
+ +## ЗаполнитьРеквизитыПоСКД +
+ +Описание, пример вызова + +```bsl + +// Заполняет список реквизитов шаблона сообщений на основании макета СКД. +// +// Параметры: +// Реквизиты - Соответствие - список реквизитов. +// Предмет - Произвольный - ссылка на объект основание для шаблона сообщений. +// ПараметрыШаблона - см. ПараметрыШаблона. +// +Процедура ЗаполнитьРеквизитыПоСКД(Реквизиты, Предмет, ПараметрыШаблона) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщений.ЗаполнитьРеквизитыПоСКД(Реквизиты, Предмет, ПараметрыШаблона) +``` +
+ +## СоздатьШаблон +
+ +Описание, пример вызова + +```bsl + +// Создать шаблон сообщения. +// +// Параметры: +// Наименование - Строка - наименование шаблона. +// ПараметрыШаблона - см. ШаблоныСообщений.ОписаниеПараметровШаблона +// +// Возвращаемое значение: +// СправочникСсылка.ШаблоныСообщений - ссылка на созданный шаблон. +// +Функция СоздатьШаблон(Наименование, ПараметрыШаблона) Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.СоздатьШаблон(Наименование, ПараметрыШаблона) +``` +
+ +## ОписаниеПараметровШаблона +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание параметров шаблона. +// +// Возвращаемое значение: +// Структура: +// * Наименование - Строка - наименование шаблона сообщений. +// * Текст - Строка - текст шаблона письма или сообщения SMS. +// * Тема - Строка - текст темы письма. Только для шаблонов электронной почты. +// * ТипШаблона - Строка - тип шаблона. Варианты: "Письмо","SMS". +// * Назначение - Строка - представление предмет шаблона сообщений. Например, Заказ покупателя. +// * ПолноеИмяТипаНазначения - Строка - предмет шаблона сообщений. Если указан полный путь к объекту метаданных, то в шаблоне +// в качестве параметров будут доступны все его реквизиты. Например, Документ.ЗаказПокупателя. +// * ФорматПисьма - ПеречислениеСсылка.СпособыРедактированияЭлектронныхПисем- формат письма HTML или обычный текст. +// Только для шаблонов электронной почты. +// * УпаковатьВАрхив - Булево - если Истина, то печатные формы и вложения будут упакованы в архив при отправке. +// Только для шаблонов электронной почты. +// * ТранслитерироватьИменаФайлов - Булево - печатные формы и файлы, вложенные в письмо будут иметь имена, содержащие +// только латинские буквы и цифры, для возможности переноса между +// различными операционными системами. Например, файл "Счет на оплату.PDF" будет +// сохранен с именем "Schet na oplaty.PDF". Только для шаблонов электронной почты. +// * ФорматыВложений - СписокЗначений - список форматов вложений. Только для шаблонов электронной почты. +// * Вложения - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя файла с расширением (например, image.png). Наименование будет без расширения. +// Или идентификатор картинки в html-письме (без cid). +// ** Значение - Строка - адрес, указывающий на двоичные данные файла во временном хранилище. +// * КомандыПечати - Массив из Строка - уникальные идентификаторы печатных форм +// * ВладелецШаблона - ОпределяемыйТип.ВладелецШаблонаСообщения - владелец контекстного шаблона. +// * ШаблонПоВнешнейОбработке - Булево - если Истина, то шаблон формируется внешней обработкой. +// * ВнешняяОбработка - СправочникСсылка.ДополнительныеОтчетыИОбработки - внешняя обработка, в которой содержится шаблон. +// * ПодписьИПечать - Булево - добавляет факсимильную подпись и печать в печатную форму. Только для шаблонов +// электронной почты. +// * ДобавлятьПрисоединенныеФайлы - Булево - если Истина, то к вложениям письма будут добавлены все +// присоединенные файлы предмета-владельца. +// +Функция ОписаниеПараметровШаблона() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.ОписаниеПараметровШаблона() +``` +
+ +## РазвернутьРеквизит +
+ +Описание, пример вызова + +```bsl + +// Создает подчиненные реквизиты у ссылочного реквизита в дереве значений +// +// Параметры: +// Имя - Строка - имя ссылочного реквизита, в дереве значений у которого необходимо добавить подчиненные реквизиты. +// Узел - КоллекцияСтрокДереваЗначений - узел в дереве значений, для которого необходимо создать дочерние элементы. +// СписокРеквизитов - Строка - список добавляемых реквизитов через запятую, если указано, то будет добавлены только они. +// ИсключаяРеквизиты - Строка - список исключаемых реквизитов через запятую. +// +Процедура РазвернутьРеквизит(Имя, Узел, СписокРеквизитов = "", ИсключаяРеквизиты = "") Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщений.РазвернутьРеквизит(Имя, Узел, СписокРеквизитов, ИсключаяРеквизиты); +``` +
+ +## ЗаполнитьПолучателей +
+ +Описание, пример вызова + +```bsl + +// Добавляет актуальные адреса почты или номера телефонов из контактной информации объекта в список получателей. +// В выборку адресов почты или номеров телефонов попадают только актуальные сведения, +// т.к. нет смысла отправлять письма или сообщения SMS на архивные данные. +// +// Параметры: +// ПолучателиПисьма - ТаблицаЗначений - список получателей письма или сообщения SMS +// ПредметСообщения - Произвольный - объект-родитель, у которого есть реквизиты, содержащие контактную информацию. +// ИмяРеквизита - Строка - имя реквизита в объекте-родителе, из которого следует получить адреса почты или +// номера телефонов. +// ТипКонтактнойИнформации - ПеречислениеСсылка.ТипыКонтактнойИнформации - если тип Адрес, то будут добавлены адреса +// почты, если Телефон, то номера телефонов. +// ВариантОтправки - Строка - вариант отправки для получателя письма: Кому, Копия, СкрытаяКопия, ОбратныйАдрес; +// +Процедура ЗаполнитьПолучателей(ПолучателиПисьма, ПредметСообщения, ИмяРеквизита, Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщений.ЗаполнитьПолучателей(ПолучателиПисьма, ПредметСообщения, ИмяРеквизита, ); +``` +
+ +## УстановитьИспользованиеШаблоновСообщений +
+ +Описание, пример вызова + +```bsl + +// Включает/выключает формирование сообщений по ранее созданным шаблонам. +// +// Параметры: +// Значение - Булево - если Истина, то шаблоны сообщений доступны для использования. +// +Процедура УстановитьИспользованиеШаблоновСообщений(Значение) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщений.УстановитьИспользованиеШаблоновСообщений(Значение) +``` +
+ +## ИспользуютсяШаблоныСообщений +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность использования механизма шаблонов сообщений. +// +// Возвращаемое значение: +// Булево - если Истина, то шаблоны сообщений доступны для использования. +// +Функция ИспользуютсяШаблоныСообщений() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.ИспользуютсяШаблоныСообщений() +``` +
+ +## ТаблицаПараметров +
+ +Описание, пример вызова + +```bsl + +// Программный интерфейс для внешних обработок. + +// Создает описание таблицы параметров шаблона сообщения. +// +// Возвращаемое значение: +// ТаблицаЗначений - сформированная пустая таблица значений. +// +Функция ТаблицаПараметров() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.ТаблицаПараметров() +``` +
+ +## ДобавитьПараметрШаблона +
+ +Описание, пример вызова + +```bsl + +// Добавить параметр шаблона для внешней обработки. +// +// Параметры: +// ТаблицаПараметров - ТаблицаЗначений - таблица со списком параметров. +// ИмяПараметра - Строка - имя добавляемого параметра. +// ОписаниеТипа - ОписаниеТипов - тип параметра. +// ЭтоПредопределенныйПараметр - Булево - если Истина, то параметр предопределенный. +// ПредставлениеПараметра - Строка - представление параметра. +// +Процедура ДобавитьПараметрШаблона(ТаблицаПараметров, ИмяПараметра, ОписаниеТипа, ЭтоПредопределенныйПараметр, Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщений.ДобавитьПараметрШаблона(ТаблицаПараметров, ИмяПараметра, ОписаниеТипа, ЭтоПредопределенныйПараметр, ); +``` +
+ +## ИнициализироватьСтруктуруПолучатели +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру Получатели для заполнения возможных получателей сообщения. +// +// Возвращаемое значение: +// Структура - созданная структура. +// +Функция ИнициализироватьСтруктуруПолучатели() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.ИнициализироватьСтруктуруПолучатели() +``` +
+ +## ИнициализироватьСтруктуруСообщения +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру сообщения по шаблону, которую должна вернуть внешняя обработка. +// +// Возвращаемое значение: +// Структура - созданная структура. +// +Функция ИнициализироватьСтруктуруСообщения() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.ИнициализироватьСтруктуруСообщения() +``` +
+ +## ПараметрыШаблона +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание параметров шаблона сообщения по данным формы, ссылке на элемент справочника шаблона +// сообщения или определив контекстный шаблон по его владельцу. Если шаблон не будет найден, то будет возвращена +// структура с незаполненными полями шаблона сообщения, заполнив которые, можно создать новый шаблон сообщения. +// +// Параметры: +// Шаблон - ДанныеФормыСтруктура +// - СправочникСсылка.ШаблоныСообщений +// - ЛюбаяСсылка - ссылка на шаблон сообщения или на владельца контекстного шаблона. +// +// Возвращаемое значение: +// см. ШаблоныСообщенийКлиентСервер.ОписаниеПараметровШаблона. +// +Функция ПараметрыШаблона(Знач Шаблон) Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.ПараметрыШаблона(Шаблон) +``` +
+ +## ВставитьПараметрыВСтрокуСогласноТаблицеПараметров +
+ +Описание, пример вызова + +```bsl + +// Обратная совместимость. + +// Подставляет в шаблон значения параметров сообщения и формирует текст сообщения. +// +// Параметры: +// ШаблонСтроки - Строка - шаблон, в который будут подставляться значения, согласно таблице параметров. +// ВставляемыеЗначения - Соответствие - соответствие, содержащее ключи параметров и значения параметров. +// Префикс - Строка - префикс параметра. +// +// Возвращаемое значение: +// Строка - строка, в которую были подставлены значения параметров шаблона. +// +Функция ВставитьПараметрыВСтрокуСогласноТаблицеПараметров(Знач ШаблонСтроки, ВставляемыеЗначения, Знач Префикс = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.ВставитьПараметрыВСтрокуСогласноТаблицеПараметров(ШаблонСтроки, ВставляемыеЗначения, Префикс); +``` +
+ +## ПараметрыИзТекстаСообщения +
+ +Описание, пример вызова + +```bsl + +// Возвращает соответствие параметров текста сообщения шаблона. +// +// Параметры: +// ПараметрыШаблона - Структура - сведения о шаблоне. +// +// Возвращаемое значение: +// Соответствие - соответствие имеющихся в тексте сообщения параметров. +// +Функция ПараметрыИзТекстаСообщения(ПараметрыШаблона) Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.ПараметрыИзТекстаСообщения(ПараметрыШаблона) +``` +
+ +## ЗаполнитьОбщиеРеквизиты +
+ +Описание, пример вызова + +```bsl + +// Заполняет общие реквизитов значениями из программы. +// После выполнения процедуры соответствие будет содержать значения: +// ТекущаяДата, ЗаголовокСистемы, АдресБазыВИнтернете, АдресБазыВЛокальнойСети +// ТекущийПользователь +// +// Параметры: +// ОбщиеРеквизиты - Соответствие из КлючИЗначение: +// * Ключ - Строка - имя общего реквизита +// * Значение - Строка - значение заполненного реквизита. +// +Процедура ЗаполнитьОбщиеРеквизиты(ОбщиеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщений.ЗаполнитьОбщиеРеквизиты(ОбщиеРеквизиты) +``` +
+ +## ИмяУзлаОбщихРеквизитов +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя узла общих реквизитов. +// +// Возвращаемое значение: +// Строка - имя общего реквизита верхнего уровня. +// +Функция ИмяУзлаОбщихРеквизитов() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщений.ИмяУзлаОбщихРеквизитов() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ШаблоныСообщенийКлиент.md b/src/content/docs/bsp/ШаблоныСообщенийКлиент.md new file mode 100644 index 0000000..0f805d6 --- /dev/null +++ b/src/content/docs/bsp/ШаблоныСообщенийКлиент.md @@ -0,0 +1,146 @@ +--- +title: Шаблоны сообщений клиент +slug: bsp/шаблоны-сообщений-клиент +--- + + +## СформироватьСообщение +
+ +Описание, пример вызова + +```bsl + + +// Открывает окно выбора шаблона для формирования электронного письма или сообщения SMS по шаблону +// для переданного в параметре ПредметСообщения предмета. +// +// Параметры: +// ПредметСообщения - ОпределяемыйТип.ПредметШаблонаСообщения +// - Строка - объект-источник данных, выводимых в сообщение. +// Для общих шаблонов необходимо передавать значение "Общий". +// Для передачи предмета сообщения строкой необходимо указывать полное имя метаданных. +// Например, "Справочник.Контрагенты". +// ВидСообщения - Строка - "Письмо" для электронного письма и "СообщениеSMS" для сообщений SMS. +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - оповещение, которое вызывается после формирования сообщения. Содержит: +// * Результат - Булево - если Истина, то сообщение было создано. +// * ПараметрыСообщения - Структура +// - Неопределено - значение, которое было передано в параметре ПараметрыСообщения. +// ВладелецШаблона - ОпределяемыйТип.ВладелецШаблонаСообщения - владелец шаблонов. Если не указан, то в +// окне выбора шаблона выводятся все доступные шаблоны для указанного +// предмета ПредметСообщения. +// ПараметрыСообщения - Структура - дополнительная информация для формирования сообщения, +// которая передается в свойство ПараметрыСообщения параметра ПараметрыШаблона +// процедуры ШаблоныСообщенийПереопределяемый.ПриФормированииСообщения. +// +Процедура СформироватьСообщение(ПредметСообщения, ВидСообщения, ОписаниеОповещенияОЗакрытии = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийКлиент.СформироватьСообщение(ПредметСообщения, ВидСообщения, ОписаниеОповещенияОЗакрытии, ); +``` +
+ +## ВыбратьШаблон +
+ +Описание, пример вызова + +```bsl + +// Открывает форму для выбора шаблона. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение, которое будет вызвано после выбора шаблона: +// * Результат - СправочникСсылка.ШаблоныСообщений - выбранный шаблон. +// * ДополнительныеПараметры - Структура - значение, которое было указано при создании объекта ОписаниеОповещения. +// ВидСообщения - Строка - "Письмо" для электронного письма и "СообщениеSMS" для сообщений SMS. +// ПредметШаблона - ЛюбаяСсылка +// - Строка - ссылка на объект, являющийся предметом, или его полное имя. +// ВладелецШаблона - ОпределяемыйТип.ВладелецШаблонаСообщения - владелец шаблонов. Если не указан, то в окне выбора шаблона +// выводятся все доступные шаблоны для указанного предмета ПредметСообщения. +// +Процедура ВыбратьШаблон(Оповещение, ВидСообщения = "Письмо", ПредметШаблона = Неопределено, ВладелецШаблона = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийКлиент.ВыбратьШаблон(Оповещение, ВидСообщения, ПредметШаблона, ВладелецШаблона); +``` +
+ +## ПоказатьФормуШаблона +
+ +Описание, пример вызова + +```bsl + +// Показывает форму шаблона сообщения. +// +// Параметры: +// Значение - СправочникСсылка.ШаблоныСообщений +// - Структура +// - ЛюбаяСсылка - если передана ссылка на шаблон сообщения, + // то будет открыт этот шаблон сообщения. + // Если передана структура, то будет открыто окно нового шаблона сообщения заполненного из полей +// структуры. Описание полей. см. ШаблоныСообщенийКлиентСервер.ОписаниеПараметровШаблона. +// Если ссылка из состава типов ОпределяемыйТип.ВладелецШаблонаСообщения, то будет открыт шаблон +// сообщения по владельцу. +// ПараметрыОткрытия - Структура - параметры открытия формы: +// * Владелец - Произвольный - форма или элемент управления другой формы. +// * Уникальность - Произвольный - ключ, значение которого будет использоваться для поиска уже открытых форм. +// * НавигационнаяСсылка - Строка - задает навигационную ссылку, возвращаемую формой. +// * ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - содержит описание процедуры, которая будет вызвана после +// закрытия формы. +// * РежимОткрытияОкна - РежимОткрытияОкнаФормы - указывает режим открытия окна управляемой формы. +// +Процедура ПоказатьФормуШаблона(Значение, ПараметрыОткрытия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийКлиент.ПоказатьФормуШаблона(Значение, ПараметрыОткрытия); +``` +
+ +## ПараметрыФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры открытия формы шаблона сообщения. +// +// Параметры: +// ДанныеЗаполнения - Произвольный - значение, на основании которого выполняется заполнение. +// Значение данного параметра не может быть следующих типов: +// Неопределено, Null, Число, Строка, Дата, Булево, Дата. +// +// Возвращаемое значение: +// Структура - список параметров открытия формы: +// * Владелец - Произвольный - форма или элемент управления другой формы. +// * Уникальность - Произвольный - ключ, значение которого будет использоваться для поиска уже открытых форм. +// * НавигационнаяСсылка - Строка - задает навигационную ссылку, возвращаемую формой. +// * ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - содержит описание процедуры, которая будет вызвана после +// закрытия формы. +// * РежимОткрытияОкна - РежимОткрытияОкнаФормы - указывает режим открытия окна управляемой формы. +// +Функция ПараметрыФормы(ДанныеЗаполнения) Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщенийКлиент.ПараметрыФормы(ДанныеЗаполнения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ШаблоныСообщенийКлиентСервер.md b/src/content/docs/bsp/ШаблоныСообщенийКлиентСервер.md new file mode 100644 index 0000000..c042b29 --- /dev/null +++ b/src/content/docs/bsp/ШаблоныСообщенийКлиентСервер.md @@ -0,0 +1,127 @@ +--- +title: Шаблоны сообщений клиент сервер +slug: bsp/шаблоны-сообщений-клиент-сервер +--- + + +## ДобавитьПараметрШаблона +
+ +Описание, пример вызова + +```bsl + +// Описывает параметр шаблона для использования их во внешних обработках. +// +// Параметры: +// ТаблицаПараметров - ТаблицаЗначений - таблица с параметрами. +// ИмяПараметра - Строка - имя используемого параметра. +// ОписаниеТипа - ОписаниеТипов - тип параметра. +// ЭтоПредопределенныйПараметр - Булево - если Ложь, то это произвольный параметр, иначе основной. +// ПредставлениеПараметра - Строка - выводимое представление параметра. +// +Процедура ДобавитьПараметрШаблона(ТаблицаПараметров, ИмяПараметра, ОписаниеТипа, ЭтоПредопределенныйПараметр, ПредставлениеПараметра = "") Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийКлиентСервер.ДобавитьПараметрШаблона(ТаблицаПараметров, ИмяПараметра, ОписаниеТипа, ЭтоПредопределенныйПараметр, ПредставлениеПараметра); +``` +
+ +## ИнициализироватьСтруктуруСообщения +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру сообщения по шаблону, которую должна вернуть внешняя обработка. +// +// Возвращаемое значение: +// Структура - созданная структура. +// +Функция ИнициализироватьСтруктуруСообщения() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщенийКлиентСервер.ИнициализироватьСтруктуруСообщения() +``` +
+ +## ИнициализироватьСтруктуруПолучатели +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру Получатели для заполнения возможных получателей сообщения. +// +// Возвращаемое значение: +// Структура - созданная структура. +// +Функция ИнициализироватьСтруктуруПолучатели() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщенийКлиентСервер.ИнициализироватьСтруктуруПолучатели() +``` +
+ +## ОписаниеПараметровШаблона +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров шаблона. +// +// Возвращаемое значение: +// Структура - список параметров шаблона, где: +// * Тема - Строка - тема шаблонов (для электронных писем). +// * Текст - Строка - текст шаблона; +// * ПодписьИПечать - Булево - признак подписи и печати в печатных формах; +// * ПараметрыСообщения - Структура - дополнительные параметры сообщения; +// * Наименование - Строка - наименование шаблона сообщения; +// * Ссылка - Неопределено - ссылка на элемент справочника; +// * ВладелецШаблона - Неопределено - владельца контекстного шаблона; +// * ПараметрыСКД - Соответствие - набор параметров при получении данных с использованием СКД; +// * Параметры - Соответствие - параметры шаблона; +// * Макет - Строка - имя макета СКД; +// * ВыбранныеВложения - Соответствие - выбранные печатные формы и вложения в шаблон; +// * ФорматыВложений - СписокЗначений - формат, в котором сохраняются печатные формы; +// * РазворачиватьСсылочныеРеквизиты - Булево - если Истина, то у ссылочных реквизитов доступны их реквизиты. +// * ШаблонПоВнешнейОбработке - Булево - если Истина, то шаблон формирует внешней обработкой; +// * ВнешняяОбработка - Неопределено - ссылка на внешнюю обработку; +// * Отправитель - Строка - электронная почта отправителя; +// * ПеревестиВТранслит - Булево - если Истина, то сформированные печатные формы и файлы будут иметь имена, +// содержащие только латинские буквы и цифры, для возможности переноса между +// различными операционными системами. Например, файл "Счет на оплату.PDF" +// будет сохранен с именем "Schet na oplaty.PDF"; +// * УпаковатьВАрхив - Булево - признак того, что вложения и печатные формы должны быть упакованы в архив +// при отправке; +// * ФорматПисьма - ПеречислениеСсылка.СпособыРедактированияЭлектронныхПисем - вид текста письма: HTML или ОбычныйТекст; +// * ПолноеИмяТипаНазначения - Строка - полное имя объекта метаданных, на основании которого создается сообщения; +// * Назначение - Строка - назначение шаблона сообщений; +// * ТипШаблона - Строка - варианты: "Письмо" или "SMS". +// +Функция ОписаниеПараметровШаблона() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщенийКлиентСервер.ОписаниеПараметровШаблона() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ШаблоныСообщенийПереопределяемый.md b/src/content/docs/bsp/ШаблоныСообщенийПереопределяемый.md new file mode 100644 index 0000000..0d4914a --- /dev/null +++ b/src/content/docs/bsp/ШаблоныСообщенийПереопределяемый.md @@ -0,0 +1,279 @@ +--- +title: Шаблоны сообщений переопределяемый +slug: bsp/шаблоны-сообщений-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Определяет состав назначений и общие реквизиты в шаблонах сообщений +// +// Параметры: +// Настройки - Структура: +// * ПредметыШаблонов - ТаблицаЗначений - содержит варианты предметов для шаблонов. Колонки: +// ** Имя - Строка - уникальное имя назначения. +// ** Представление - Строка - представление варианта. +// ** Макет - Строка - имя макета СКД, если состав реквизитов определяется посредством СКД. +// ** ЗначенияПараметровСКД - Структура - значения параметров СКД для текущего предмета шаблона сообщения. +// * ОбщиеРеквизиты - ДеревоЗначений - содержит описание общих реквизитов доступных во всех шаблонах. Колонки: +// ** Имя - Строка - уникальное имя общего реквизита. +// ** Представление - Строка - представление общего реквизита. +// ** Тип - Тип - тип общего реквизита. По умолчанию строка. +// * ИспользоватьПроизвольныеПараметры - Булево - указывает, можно ли использовать произвольные пользовательские +// параметры в шаблонах сообщений. +// * ЗначенияПараметровСКД - Структура - общие значения параметров СКД, для всех макетов, где состав реквизитов +// определяется средствами СКД. +// * РасширенныйСписокПолучателей - Булево - если Истина, то для получателей письма можно указывать вариант отправки +// и контакт в исходящих писем подсистемы Взаимодействия. +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриПодготовкеШаблонаСообщения +
+ +Описание, пример вызова + +```bsl + +// Вызывается при подготовке шаблонов сообщений и позволяет переопределить список реквизитов и вложений. +// +// Параметры: +// Реквизиты - КоллекцияСтрокДереваЗначений - список реквизитов шаблона: +// * Имя - Строка - уникальное имя реквизита. +// * Представление - Строка - представление реквизита. +// * ПолноеПредставление - Строка - расширенное представление реквизита. +// * Тип - Тип - тип реквизита. +// * Подсказка - Строка - расширенная информация о реквизите. +// * ПроизвольныйПараметр - Булево - признак, что реквизит интерактивно добавлен пользователем. +// * Формат - Строка - формат вывода значения для чисел, дат, строк и булевых значений. +// Например, "ДЛФ=D" для даты. +// * Родитель - СтрокаДереваЗначений, Неопределено - строка, которой принадлежит данная коллекция строк. +// Вложения - ТаблицаЗначений - печатные формы и вложения, где: +// * Имя - Строка - уникальное имя вложения. +// * Идентификатор - Строка - идентификатор вложения. +// * Представление - Строка - представление варианта. +// * Подсказка - Строка - расширенная информация о вложении. +// * ТипФайла - Строка - тип вложения, который соответствует расширению файла: "PDF", "png", "jpg", mxl" и др. +// * ИмяПараметра - Строка - служебный параметр. Не предназначен для использования. +// * Реквизит - Строка - служебный параметр. Не предназначен для использования. +// * Статус - Строка - служебный параметр. Не предназначен для использования. +// * МенеджерПечати - Строка - служебный параметр. Не предназначен для использования. +// * ПараметрыПечати - Структура - служебный параметр. Не предназначен для использования. +// НазначениеШаблона - Строка - назначение шаблона сообщения, например, "ОповещениеКлиентаИзменениеЗаказа". +// ДополнительныеПараметры - см. ШаблоныСообщений.ОписаниеПараметровШаблона +// +Процедура ПриПодготовкеШаблонаСообщения(Реквизиты, Вложения, НазначениеШаблона, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийПереопределяемый.ПриПодготовкеШаблонаСообщения(Реквизиты, Вложения, НазначениеШаблона, ДополнительныеПараметры) +``` +
+ +## ПриФормированииСообщения +
+ +Описание, пример вызова + +```bsl + +// Вызывается в момент создания сообщений по шаблону для заполнения значений реквизитов и вложений. +// +// Параметры: +// Сообщение - Структура: +// * ЗначенияРеквизитов - Соответствие из КлючИЗначение - список используемых в шаблоне реквизитов: +// ** Ключ - Строка - имя реквизита в шаблоне; +// ** Значение - Строка - значение заполнения в шаблоне. +// * ЗначенияОбщихРеквизитов - Соответствие из КлючИЗначение - список используемых в шаблоне общих реквизитов: +// ** Ключ - Строка - имя реквизита в шаблоне; +// ** Значение - Строка - значение заполнения в шаблоне. +// * Вложения - Соответствие из КлючИЗначение: +// ** Ключ - Строка - имя вложения в шаблоне; +// ** Значение - ДвоичныеДанные +// - Строка - двоичные данные или адрес во временном хранилище вложения. +// * ДополнительныеПараметры - Структура: +// ** ВидСообщения - Строка - вид шаблона: "Письмо", "SMS", "Произвольный". +// ** ЗначенияПараметровСКД - Структура - значения параметров СКД. Состав реквизитов определяется средствами СКД. +// ** ОтправитьСразу - Булево - если истина, то письмо или сообщение будет отправлено адресату сразу после создания. +// ** ПараметрыСообщения - Структура - дополнительные параметры переданные в функциях СформироватьСообщение +// или СформироватьСообщениеИОтправить программного интерфейса общего модуля ШаблоныСообщений. +// ** УчетнаяЗапись - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты, Неопределено - учетная запись +// от которой будет отправлено письмо, если не заполнена, то используется системная учетная запись. +// ** ПроизвольныеПараметры - Соответствие - параметры добавленные пользователем. +// ** ПечатныеФормы - Массив - список печатных форм шаблона сообщений. +// ** ПреобразовыватьHTMLДляФорматированногоДокумента - Булево - определяет, необходимо ли преобразование +// HTML-текста сообщения, содержащего картинки в тексте письма, +// из-за особенностей вывода изображений в форматированном документе. +// ** НастройкиСохранения - см. УправлениеПечатью.НастройкиСохранения. +// НазначениеШаблона - Строка - полное имя назначения шаблон сообщения. +// ПредметСообщения - ЛюбаяСсылка - ссылка на объект являющийся источником данных. +// ПараметрыШаблона - см. ШаблоныСообщений.ОписаниеПараметровШаблона +// +Процедура ПриФормированииСообщения(Сообщение, НазначениеШаблона, ПредметСообщения, ПараметрыШаблона) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийПереопределяемый.ПриФормированииСообщения(Сообщение, НазначениеШаблона, ПредметСообщения, ПараметрыШаблона) +``` +
+ +## ПриЗаполненииТелефоновПолучателейВСообщении +
+ +Описание, пример вызова + +```bsl + +// Заполняет список получателей SMS при отправке сообщения сформированного по шаблону. +// +// Параметры: +// ПолучателиSMS - ТаблицаЗначений: +// * НомерТелефона - Строка - номер телефона, куда будет отправлено сообщение SMS; +// * Представление - Строка - представление получателя сообщения SMS; +// * Контакт - Произвольный - контакт, которому принадлежит номер телефона. +// НазначениеШаблона - Строка - идентификатор назначения шаблона +// ПредметСообщения - ЛюбаяСсылка - ссылка на объект, являющийся источником данных. +// - Структура - структура описывающая параметры шаблона: +// * Предмет - ЛюбаяСсылка - ссылка на объект, являющийся источником данных; +// * ВидСообщения - Строка - вид формируемого сообщения: "ЭлектроннаяПочта" или "СообщениеSMS"; +// * ПроизвольныеПараметры - Соответствие - заполненный список произвольных параметров; +// * ОтправитьСразу - Булево - признак мгновенной отправки; +// * ПараметрыСообщения - Структура - дополнительные параметры сообщения. +// +Процедура ПриЗаполненииТелефоновПолучателейВСообщении(ПолучателиSMS, НазначениеШаблона, ПредметСообщения) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийПереопределяемый.ПриЗаполненииТелефоновПолучателейВСообщении(ПолучателиSMS, НазначениеШаблона, ПредметСообщения) +``` +
+ +## ПриЗаполненииПочтыПолучателейВСообщении +
+ +Описание, пример вызова + +```bsl + +// Заполняет список получателей почты при отправке сообщения сформированного по шаблону. +// +// Параметры: +// ПолучателиПисьма - ТаблицаЗначений - список получается письма: +// * ВариантОтправки - Строка - вариант отправки для получателя письма: Кому, Копия, СкрытаяКопия, ОбратныйАдрес; +// * Адрес - Строка - адрес электронной почты получателя; +// * Представление - Строка - представление получателя письма; +// * Контакт - Произвольный - контакт, которому принадлежит адрес электронной почты. +// НазначениеШаблона - Строка - идентификатор назначения шаблона. +// ПредметСообщения - ЛюбаяСсылка - ссылка на объект, являющийся источником данных. +// - Структура - структура описывающая параметры шаблона: +// * Предмет - ЛюбаяСсылка - ссылка на объект, являющийся источником данных; +// * ВидСообщения - Строка - вид формируемого сообщения: "ЭлектроннаяПочта" или "СообщениеSMS"; +// * ПроизвольныеПараметры - Соответствие - заполненный список произвольных параметров; +// * ОтправитьСразу - Булево - признак мгновенной отправки письма; +// * ПараметрыСообщения - Структура - дополнительные параметры сообщения; +// * ПреобразовыватьHTMLДляФорматированногоДокумента - Булево - признак преобразование HTML текста +// сообщения содержащего картинки в тексте письма из-за особенностей вывода изображений +// в форматированном документе; +// * УчетнаяЗапись - СправочникСсылка.УчетныеЗаписиЭлектроннойПочты - учетная запись для отправки письма. +// +Процедура ПриЗаполненииПочтыПолучателейВСообщении(ПолучателиПисьма, НазначениеШаблона, ПредметСообщения) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийПереопределяемый.ПриЗаполненииПочтыПолучателейВСообщении(ПолучателиПисьма, НазначениеШаблона, ПредметСообщения) +``` +
+ +## ПриНастройкеНачальногоЗаполненияЭлементов +
+ +Описание, пример вызова + +```bsl + +// Начальное заполнение предопределенных шаблонов сообщений + +// Смотри также ОбновлениеИнформационнойБазыПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов +// +// Параметры: +// Настройки - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов.Настройки +// +Процедура ПриНастройкеНачальногоЗаполненияЭлементов(Настройки) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов(Настройки) +``` +
+ +## ПриНачальномЗаполненииЭлементов +
+ +Описание, пример вызова + +```bsl + +// Смотри также ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов +// +// Параметры: +// КодыЯзыков - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов.КодыЯзыков +// Элементы - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов.Элементы +// ТабличныеЧасти - см. ОбновлениеИнформационнойБазыПереопределяемый.ПриНачальномЗаполненииЭлементов.ТабличныеЧасти +// +Процедура ПриНачальномЗаполненииЭлементов(КодыЯзыков, Элементы, ТабличныеЧасти) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийПереопределяемый.ПриНачальномЗаполненииЭлементов(КодыЯзыков, Элементы, ТабличныеЧасти) +``` +
+ +## ПриНачальномЗаполненииЭлемента +
+ +Описание, пример вызова + +```bsl + +// Смотри также ОбновлениеИнформационнойБазыПереопределяемый.ПриНастройкеНачальногоЗаполненияЭлементов +// +// Параметры: +// Объект - СправочникОбъект.РолиИсполнителей - заполняемый объект. +// Данные - СтрокаТаблицыЗначений - данные заполнения объекта. +// ДополнительныеПараметры - Структура: +// * ПредопределенныеДанные - ТаблицаЗначений - данные заполненные в процедуре ПриНачальномЗаполненииЭлементов. +// +Процедура ПриНачальномЗаполненииЭлемента(Объект, Данные, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ШаблоныСообщенийПереопределяемый.ПриНачальномЗаполненииЭлемента(Объект, Данные, ДополнительныеПараметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ШаблоныСообщенийСервер.md b/src/content/docs/bsp/ШаблоныСообщенийСервер.md new file mode 100644 index 0000000..bf55b5b --- /dev/null +++ b/src/content/docs/bsp/ШаблоныСообщенийСервер.md @@ -0,0 +1,39 @@ +--- +title: Шаблоны сообщений сервер +slug: bsp/шаблоны-сообщений-сервер +--- + + +## ТаблицаПараметров +
+ +Описание, пример вызова + +```bsl + +// Обратная совместимость. +// Создает описание таблицы параметров шаблона сообщения. +// +// Возвращаемое значение: +// ТаблицаЗначений - сформированная пустая таблица значений: +// * ИмяПараметра - Строка - имя параметра. +// * ОписаниеТипа - ОписаниеТипов - описание типа параметра. +// * ЭтоПредопределенныйПараметр - Булево - является ли параметр предопределенным. +// * ПредставлениеПараметра - Строка - представление параметра. +// +Функция ТаблицаПараметров() Экспорт +``` + +Пример вызова +```bsl +Результат = ШаблоныСообщенийСервер.ТаблицаПараметров() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодпись.md b/src/content/docs/bsp/ЭлектроннаяПодпись.md new file mode 100644 index 0000000..28397b4 --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодпись.md @@ -0,0 +1,935 @@ +--- +title: Электронная подпись +slug: bsp/электронная-подпись +--- + + +## ИспользоватьЭлектронныеПодписи +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую настройку использования электронных подписей. +// +// Возвращаемое значение: +// Булево - если Истина, электронные подписи используются. +// +Функция ИспользоватьЭлектронныеПодписи() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ИспользоватьЭлектронныеПодписи() +``` +
+ +## ИспользоватьШифрование +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую настройку использования шифрования. +// +// Возвращаемое значение: +// Булево - если Истина, шифрование используется. +// +Функция ИспользоватьШифрование() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ИспользоватьШифрование() +``` +
+ +## ПроверятьЭлектронныеПодписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую настройку проверки электронных подписей на сервере. +// +// Возвращаемое значение: +// Булево - если Истина, электронные подписи будут проверяться на сервере. +// +Функция ПроверятьЭлектронныеПодписиНаСервере() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ПроверятьЭлектронныеПодписиНаСервере() +``` +
+ +## СоздаватьЭлектронныеПодписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую настройку создания электронных подписей на сервере. +// Настройка также предполагает шифрование и расшифровку на сервере. +// +// Возвращаемое значение: +// Булево - если Истина, электронные подписи будут создаваться на сервере. +// +Функция СоздаватьЭлектронныеПодписиНаСервере() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.СоздаватьЭлектронныеПодписиНаСервере() +``` +
+ +## РазрешенДоступКИнтернетСервисам +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что разрешена работа с Интернет-сервисами электронной подписи из приложения. +// Параметры: +// ПоказатьОшибку - Булево - вызвать исключение. +// +// Возвращаемое значение: +// Булево +// +Функция РазрешенДоступКИнтернетСервисам(ПоказатьОшибку = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.РазрешенДоступКИнтернетСервисам(ПоказатьОшибку); +``` +
+ +## ПодписиОбъекта +
+ +Описание, пример вызова + +```bsl + +// Получает подписи объекта и возвращает их. +// +// Параметры: +// Объект - ОпределяемыйТип.ПодписанныйОбъект - ссылка на подписанный объект. +// Объект должен иметь реквизит ПодписанЭП. +// +// ДополнительныеПараметры - см. НовыйПараметрыПолученияПодписейОбъекта +// +// Возвращаемое значение: +// Массив из см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи +// +Функция ПодписиОбъекта(Объект, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ПодписиОбъекта(Объект, ДополнительныеПараметры); +``` +
+ +## ДобавитьПодпись +
+ +Описание, пример вызова + +```bsl + +// Добавляет подпись к объекту и записывает его. +// Устанавливает реквизиту ПодписанЭП значение Истина. +// +// Параметры: +// Объект - ОпределяемыйТип.ПодписанныйОбъект - по ссылке будет получен объект, +// заблокирован, изменен, записан. Объект должен иметь реквизит ПодписанЭП. +// Либо передать сразу объект указанного выше типа, тогда он +// будет изменен без блокировки и без записи. +// +// СвойстваПодписи - Строка - адрес временного хранилища, содержащий описанную ниже структуру. +// - Структура - см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи. +// - Массив из Строка +// - Массив из см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи. +// +// ИдентификаторФормы - УникальныйИдентификатор - идентификатор формы, используемый для блокировки, +// если передана ссылка на объект. +// +// ВерсияОбъекта - Строка - версия данных объекта, если передана ссылка на объект, используемая +// для блокировки объекта перед записью с учетом того, что подписание +// выполняется на клиенте и за время подписания объект мог быть изменен. +// +// ЗаписанныйОбъект - Произвольный - объект, который был получен и записан, если передавалась ссылка. +// +Процедура ДобавитьПодпись(Объект, Знач СвойстваПодписи, ИдентификаторФормы = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодпись.ДобавитьПодпись(Объект, СвойстваПодписи, ИдентификаторФормы, ); +``` +
+ +## ОбновитьПодпись +
+ +Описание, пример вызова + +```bsl + +// Обновляет подпись объекта. +// +// Параметры: +// Объект - ОпределяемыйТип.ПодписанныйОбъект - ссылка на подписанный объект, +// для которого требуется обновить подпись. +// +// СвойстваПодписи - Строка - адрес временного хранилища, содержащий описанную ниже структуру. +// - Структура - см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи. +// ОбновитьПоПорядковомуНомеру - Булево - (по умолчанию Ложь) подпись обновляется по порядковому номеру, +// т.к. двоичные данные подписи изменились при усовершенствовании. +// +Процедура ОбновитьПодпись(Объект, Знач СвойстваПодписи, ОбновитьПоПорядковомуНомеру = Ложь) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодпись.ОбновитьПодпись(Объект, СвойстваПодписи, ОбновитьПоПорядковомуНомеру); +``` +
+ +## УдалитьПодпись +
+ +Описание, пример вызова + +```bsl + +// Удаляет подпись объекта и записывает его. +// +// Параметры: +// Объект - ОпределяемыйТип.ПодписанныйОбъект - по ссылке будет получен объект, +// заблокирован, изменен, записан. Объект должен иметь реквизит ПодписанЭП. +// Либо передать сразу объект указанного выше типа, тогда он +// будет изменен без блокировки и без записи. +// +// ПорядковыйНомер - Число - порядковый номер подписи. +// - Массив - значения указанного выше типа. +// +// ИдентификаторФормы - УникальныйИдентификатор - идентификатор формы, используемый для блокировки, +// если передана ссылка на объект. +// +// ВерсияОбъекта - Строка - версия данных объекта, если передана ссылка на объект, используемая +// для блокировки объекта перед записью, с учетом того, что подписание +// выполняется на клиенте и за время подписания объект мог быть изменен. +// +// ЗаписанныйОбъект - Произвольный - объект, который был получен и записан, если передавалась ссылка. +// +Процедура УдалитьПодпись(Объект, ПорядковыйНомер, ИдентификаторФормы = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодпись.УдалитьПодпись(Объект, ПорядковыйНомер, ИдентификаторФормы, ); +``` +
+ +## СертификатыШифрования +
+ +Описание, пример вызова + +```bsl + +// Возвращает сертификаты шифрования для указанного объекта. +// +// Параметры: +// Объект - ОпределяемыйТип.ПодписанныйОбъект - ссылка на зашифрованный объект. +// +// Возвращаемое значение: +// Массив из Структура: +// * Отпечаток - Строка +// * Представление - Строка +// * Сертификат - ДвоичныеДанные +// * ПорядковыйНомер - Число +// +Функция СертификатыШифрования(Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.СертификатыШифрования(Объект) +``` +
+ +## ЗаписатьСертификатыШифрования +
+ +Описание, пример вызова + +```bsl + +// Помещает сертификаты шифрования в регистр сведений и записывает объект. +// Устанавливает реквизит Зашифрован по наличию сертификатов в регистре сведений СертификатаШифрования. +// +// Параметры: +// Объект - ОпределяемыйТип.ПодписанныйОбъект - по ссылке будет получен объект, +// заблокирован, изменен, записан. Объект должен иметь реквизит Зашифрован. +// Либо передать сразу объект указанного выше типа, тогда он +// будет изменен без блокировки и без записи. +// +// СертификатыШифрования - Строка - адрес временного хранилища, содержащий описанный ниже массив. +// - Массив - массив описанных ниже структур: +// * Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// * Представление - Строка - сохраненное представление субъекта, +// полученное из двоичных данных сертификата. +// * Сертификат - ДвоичныеДанные - содержит выгрузку сертификата, +// который использовался для шифрования. +// +// ИдентификаторФормы - УникальныйИдентификатор - идентификатор формы, используемый для блокировки, +// если передана ссылка на объект. +// +// ВерсияОбъекта - Строка - версия данных объекта, если передана ссылка на объект, используемая +// для блокировки объекта перед записью, с учетом того, что подписание +// выполняется на клиенте и за время подписания объект мог быть изменен. +// +// ЗаписанныйОбъект - Произвольный - объект, который был получен и записан, если передавалась ссылка. +// +Процедура ЗаписатьСертификатыШифрования(Объект, Знач СертификатыШифрования, ИдентификаторФормы = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодпись.ЗаписатьСертификатыШифрования(Объект, СертификатыШифрования, ИдентификаторФормы, ); +``` +
+ +## ДатаПодписания +
+ +Описание, пример вызова + +```bsl + +// Возвращает дату, извлеченную из двоичных данных подписи, или Неопределено. +// +// Параметры: +// Подпись - ДвоичныеДанные - данные подписи из которых нужно извлечь дату. +// ПривестиКЧасовомуПоясуСеанса - Булево - привести универсальное время к времени сеанса. +// +// Возвращаемое значение: +// Дата - успешно извлеченная дата подписи. +// Неопределено - не удалось извлечь дату из данных подписи. +// +Функция ДатаПодписания(Подпись, ПривестиКЧасовомуПоясуСеанса = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ДатаПодписания(Подпись, ПривестиКЧасовомуПоясуСеанса); +``` +
+ +## СсылкаНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на сертификат по его двоичным данным или отпечатку. +// +// Параметры: +// Сертификат - СертификатКриптографии - сертификат. +// - ДвоичныеДанные - двоичные данные сертификата. +// - Строка - строка (28), отпечаток сертификата в формате Base64. +// - Строка - адрес временного хранилища, содержащего двоичные данные сертификата. +// +// Возвращаемое значение: +// СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования +// Неопределено - сертификат не существует в справочнике. +// +Функция СсылкаНаСертификат(Знач Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.СсылкаНаСертификат(Сертификат) +``` +
+ +## СсылкиНаСертификаты +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылки на сертификаты по их двоичным данным или отпечатку. +// +// Параметры: +// Сертификаты - Массив из СертификатКриптографии +// - Массив из ДвоичныеДанные - двоичные данные сертификатов. +// - Массив из Строка - строка (28), отпечатки сертификатов в формате Base64. +// - Массив из Строка - адреса временных хранилищ, содержащих двоичные данные сертификатов. +// ВозвращатьНесуществующие - Булево - если указать Истина, то в возвращаемое значение будут включены пустые +// ссылки для сертификатов, отсутствующих в справочнике СертификатыКлючейЭлектроннойПодписиИШифрования. +// +// Возвращаемое значение: +// Массив из СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования +// +Функция СсылкиНаСертификаты(Знач Сертификаты, Знач ВозвращатьНесуществующие = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.СсылкиНаСертификаты(Сертификаты, ВозвращатьНесуществующие); +``` +
+ +## ЗаписатьСертификатВСправочник +
+ +Описание, пример вызова + +```bsl + +// Позволяет создать и обновить элемент справочника СертификатыКлючейЭлектроннойПодписиИШифрования по +// указанному сертификату криптографии. +// Для добавления сертификата на клиенте см. ЭлектроннаяПодписьКлиент.ДобавитьСертификат. +// +// Параметры: +// Сертификат - СертификатКриптографии - сертификат. +// - ДвоичныеДанные - двоичные данные сертификата. +// - Строка - адрес временного хранилища, содержащего двоичные данные сертификата. +// +// ДополнительныеПараметры - Неопределено - без дополнительных параметров. +// - Структура - с произвольным составом из следующих свойств: +// * Наименование - Строка - представление сертификата в списке. +// +// * Пользователь - СправочникСсылка.Пользователи - пользователь, которому принадлежит сертификат. +// Значение используется при получении списка личных сертификатов пользователя +// в формах подписания и шифрования данных. +// +// * Организация - ОпределяемыйТип.Организация - организация, к которой относится сертификат. +// * ФизическоеЛицо - ОпределяемыйТип.ФизическоеЛицо - лицо, которому выдан сертификат. +// +// * Программа - СправочникСсылка.ПрограммыЭлектроннойПодписиИШифрования - программа, которая +// требуется для подписания и расшифровки. +// +// * ВводитьПарольВПрограммеЭлектроннойПодписи - Булево - флажок "Вводить пароль в программе электронной подписи", +// требуется Истина, когда сертификат был установлен на компьютере с усиленной +// защитой закрытого ключа, которая означает поддержку только пустого пароля на +// уровне 1С:Предприятия (пароль у пользователя не запрашивается - это делает +// операционная система, которая не принимает от 1С:Предприятия непустой пароль). +// +// Возвращаемое значение: +// СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - ссылка на сертификат. +// +Функция ЗаписатьСертификатВСправочник(Знач Сертификат, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ЗаписатьСертификатВСправочник(Сертификат, ДополнительныеПараметры); +``` +
+ +## ШтампВизуализацииЭлектроннойПодписи +
+ +Описание, пример вызова + +```bsl + +// Возвращает табличный документ, содержащий штамп визуализации электронной подписи. +// +// Параметры: +// Подпись - см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи +// ДатаПодписи - Дата - дата подписания документа. +// ТекстОтметки - Строка - текст, выводящийся непосредственно под штампом и описывающий +// расположение подлинника документа. +// ЛоготипОрганизации - Картинка - если не указан, то будет использована стандартная картинка. +// +// Возвращаемое значение: +// ТабличныйДокумент - табличный документ, содержащий готовый штамп электронной подписи. +// +Функция ШтампВизуализацииЭлектроннойПодписи(Знач Подпись, Знач ДатаПодписи = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ШтампВизуализацииЭлектроннойПодписи(Подпись, ДатаПодписи, ); +``` +
+ +## ШтампыВизуализацииЭлектронныхПодписей +
+ +Описание, пример вызова + +```bsl + +// Возвращает табличные документы со штампами электронных подписей, которыми подписан указанный документ. +// +// Параметры: +// ПодписанныйФайл - ОпределяемыйТип.ПодписанныйОбъект - подписанный документ. +// Должен иметь реквизит ПодписанЭП. +// ЭлектронныеПодписи - Массив из см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи - если указан, то +// штампы будут сформированы по указанным электронным подписям, а не по тем, +// которым подписан ПодписанныйФайл. +// ТекстыОтметок - Массив из Строка - текст, выводящийся непосредственно под штампом и описывающий +// расположение подлинника документа. +// +// Возвращаемое значение: +// Массив из ТабличныйДокумент +// +Функция ШтампыВизуализацииЭлектронныхПодписей(Знач ПодписанныйФайл, Знач ЭлектронныеПодписи = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ШтампыВизуализацииЭлектронныхПодписей(ПодписанныйФайл, ЭлектронныеПодписи, ); +``` +
+ +## ДобавитьШтампыВТабличныйДокумент +
+ +Описание, пример вызова + +```bsl + +// Размещает штампы в переданном табличном документе. +// +// Параметры: +// Документ - ТабличныйДокумент - табличный документ, в который требуется добавить штампы. +// ОписаниеШтампов - Массив из ТабличныйДокумент - штампы, полученные функцией +// ЭлектроннаяПодпись.ШтампВизуализацииЭлектроннойПодписи. +// Переданные штампы будут выведены в конец документа, либо в области для размещения +// штампов, если они определены в макете табличного документа: +// а) имя области задано как "ШтампЭП" + порядковый номер штампа, +// например: "ШтампЭП1" и т.д. +// б) область вывода штампа размером в две колонки и семь строк, с произвольной +// шириной колонок. +// В таком случае штампы будут выведены в заданные области в порядке +// их следования в параметре ОписаниеШтампов. +// - Соответствие из КлючИЗначение - описывает места вывода штампов, где: +// * Ключ - Строка - имя области, куда выводить штамп. Для такой области должна +// быть установлена произвольная ширина колонок, +// отличная от ширины колонок остального документа. +// * Значение - ТабличныйДокумент - штамп, полученный функцией +// ЭлектроннаяПодпись.ШтампВизуализацииЭлектроннойПодписи. +// Размеры - Структура - позволяет изменять размеры штампа, со свойствами: +// * ЛеваяКолонка - Число - ширина левой колонки штампа, содержащей заголовки свойств. +// По умолчанию - 10. +// * ПраваяКолонка - Число - ширина правой колонки штампа, содержащей значения свойств. +// По умолчанию - 30. +// +Процедура ДобавитьШтампыВТабличныйДокумент(Документ, ОписаниеШтампов, Размеры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодпись.ДобавитьШтампыВТабличныйДокумент(Документ, ОписаниеШтампов, Размеры); +``` +
+ +## ПредставлениеСертификата +
+ +Описание, пример вызова + +```bsl + +// См. ЭлектроннаяПодписьКлиент.ПредставлениеСертификата. +Функция ПредставлениеСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ПредставлениеСертификата(Сертификат) +``` +
+ +## ПредставлениеСубъекта +
+ +Описание, пример вызова + +```bsl + +// См. ЭлектроннаяПодписьКлиент.ПредставлениеСубъекта. +Функция ПредставлениеСубъекта(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ПредставлениеСубъекта(Сертификат) +``` +
+ +## ПредставлениеИздателя +
+ +Описание, пример вызова + +```bsl + +// См. ЭлектроннаяПодписьКлиент.ПредставлениеИздателя. +Функция ПредставлениеИздателя(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ПредставлениеИздателя(Сертификат) +``` +
+ +## СвойстваСертификата +
+ +Описание, пример вызова + +```bsl + +// Возвращает основные свойства сертификата. +// +// Параметры: +// Сертификат - СертификатКриптографии - сертификат криптографии. +// - ДвоичныеДанные - двоичные данные сертификата в кодировке DER. +// +// Возвращаемое значение: +// Структура: +// * Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// * СерийныйНомер - ДвоичныеДанные - свойство сертификата СерийныйНомер. +// * Представление - см. ЭлектроннаяПодписьКлиент.ПредставлениеСертификата. +// * КомуВыдан - см. ЭлектроннаяПодписьКлиент.ПредставлениеСубъекта. +// * КемВыдан - см. ЭлектроннаяПодписьКлиент.ПредставлениеИздателя. +// * ДатаНачала - Дата - свойство сертификата ДатаНачала в часовом поясе сеанса. +// * ДатаОкончания - Дата - свойство сертификата ДатаОкончания в часовом поясе сеанса. +// * ДатаНачалаЗакрытогоКлюча - Дата - свойство сертификата, указанное в OID 2.5.29.16 в часовом поясе сеанса. +// * ДатаОкончанияЗакрытогоКлюча - Дата - свойство сертификата, указанное в OID 2.5.29.16 в часовом поясе сеанса. +// * ДействителенДо - Дата - минимальная дата из ДатаОкончания и ДатаОкончанияЗакрытогоКлюча (если указана в сертификате). +// * Назначение - Строка - описание расширенного свойства сертификата EKU. +// * Подписание - Булево - свойство сертификата ИспользоватьДляПодписи. +// * Шифрование - Булево - свойство сертификата ИспользоватьДляШифрования. +// На платформе 8.3.27 и выше структура содержит свойства: +// * ИдентификаторКлючаУдостоверяющегоЦентра - Строка - идентификатор ключа издателя. +// * АлгоритмПодписи - Строка - OID алгоритма подписи сертификата. +// * АлгоритмОткрытогоКлюча - Строка - OID алгоритма открытого ключа сертификата. +// * АдресаСписковОтзыва - Массив из Строка +// +Функция СвойстваСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.СвойстваСертификата(Сертификат) +``` +
+ +## СвойстваСубъектаСертификата +
+ +Описание, пример вызова + +```bsl + +// См. ЭлектроннаяПодписьКлиент.СвойстваСубъектаСертификата. +Функция СвойстваСубъектаСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.СвойстваСубъектаСертификата(Сертификат) +``` +
+ +## СвойстваИздателяСертификата +
+ +Описание, пример вызова + +```bsl + +// См. ЭлектроннаяПодписьКлиент.СвойстваИздателяСертификата. +Функция СвойстваИздателяСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.СвойстваИздателяСертификата(Сертификат) +``` +
+ +## ОшибкаПоКлассификатору +
+ +Описание, пример вызова + +```bsl + +// Возвращает причины возникновения и способы устранения проблемы по классификатору типовых проблем +// при работе с электронной подписью. +// Рекомендуется вызывать после всех неудачных криптографических операций на сервере для записи в журнал регистрации. +// +// Параметры: +// ТекстДляПоискаВКлассификаторе - Строка - описание проблемы, по которому осуществляется поиск в классификаторе. +// ОшибкаНаСервере - Булево - место возникновения проблемы, т.к. причины и решения +// на клиенте и сервере могут отличаться. По умолчанию Ложь. +// +// Возвращаемое значение: +// Неопределено - проблема не описана в классификаторе. +// Структура: +// * Причина - Строка - возможные причины возникновения проблемы. +// * Решение - Строка - возможные способы решения возникшей проблемы. +// * СпособУстранения - Строка - идентификатор способа автоматического устранения проблемы. +// * Ссылка - Строка - идентификатора якоря в статье на сайте ИТС. +// +Функция ОшибкаПоКлассификатору(ТекстДляПоискаВКлассификаторе, ОшибкаНаСервере = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ОшибкаПоКлассификатору(ТекстДляПоискаВКлассификаторе, ОшибкаНаСервере); +``` +
+ +## УсовершенствоватьПодпись +
+ +Описание, пример вызова + +```bsl + +// Усовершенствует подпись до переданного типа, если подпись позволяет. +// Добавляет архивную метку времени в архивную подпись (CAdES-A). +// Возвращает только изменившиеся в процессе усовершенствования свойства подписи. +// +// Параметры: +// Подпись - ДвоичныеДанные - двоичные данные электронной подписи. +// ТипПодписи - ПеречислениеСсылка.ТипыПодписиКриптографии - тип подписи, +// до которого требуется усовершенствование. Если фактический ТипПодписи +// тот же или выше, тогда никаких действий произведено не будет. +// ДобавитьАрхивнуюМеткуВремени - Булево - если указано Истина и фактический ТипПодписи архивная, +// тогда будет добавлена метка времени. +// ДополнительныеПараметры - Структура: +// * МенеджерКриптографии - Неопределено - получить менеджер криптографии для проверки +// - МенеджерКриптографии - использовать указанный менеджер криптографии. +// * ИгнорироватьСрокДействияСертификата - Булево - по умолчанию Ложь, не проверять +// срок действия сертификата подписи перед усовершенствованием. +// - Неопределено - получить менеджер криптографии для проверки +// электронных подписей, как настроил администратор. +// - МенеджерКриптографии - использовать указанный менеджер криптографии. +// +// Возвращаемое значение: +// Структура: +// * Успех - Булево - Истина, если усовершенствование прошло успешно или не требовалось. +// * ТекстОшибки - Строка - заполнен, если Успех = Ложь. +// * СвойстваПодписи - см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи. +// +Функция УсовершенствоватьПодпись(Подпись, ТипПодписи, ДобавитьАрхивнуюМеткуВремени = Ложь, Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.УсовершенствоватьПодпись(Подпись, ТипПодписи, ДобавитьАрхивнуюМеткуВремени, ); +``` +
+ +## УсовершенствоватьПодписьОбъекта +
+ +Описание, пример вызова + +```bsl + +// Усовершенствует подпись объекта до переданного типа, если подпись позволяет. +// Добавляет архивную метку времени в архивную подпись (CAdES-A). +// Обновляет данные подписи объекта (Тип подписи, Срок действия последней метки времени). +// +// Параметры: +// ПодписанныйОбъект - ОпределяемыйТип.ПодписанныйОбъект - ссылка по которой будет получена подпись для +// усовершенствования и для блокировки при обновлении. +// +// ПорядковыйНомер - Число - порядковый номер подписи. +// +// ТипПодписи - ПеречислениеСсылка.ТипыПодписиКриптографии - тип подписи, +// до которого требуется усовершенствование. Если фактический ТипПодписи +// тот же или выше, тогда никаких действий произведено не будет. +// +// ДобавитьАрхивнуюМеткуВремени - Булево - если указано Истина и ТипПодписи указан архивная, +// и фактический ТипПодписи архивная, тогда будет добавлена метка времени. +// +// ИдентификаторФормы - УникальныйИдентификатор - идентификатор формы, используемый для блокировки, +// если передана ссылка на объект. +// +// ДополнительныеПараметры - Структура: +// * МенеджерКриптографии - Неопределено, МенеджерКриптографии - описание ниже. +// * ИгнорироватьСрокДействияСертификата - Булево - по умолчанию Ложь, не проверять +// срок действия сертификата подписи перед усовершенствованием. +// - Неопределено - получить менеджер криптографии для проверки +// электронных подписей, как настроил администратор. +// - МенеджерКриптографии - использовать указанный менеджер криптографии. +// +// Возвращаемое значение: +// Структура: +// * Успех - Булево - Истина, если усовершенствование прошло успешно или не требовалось. +// * ТекстОшибки - Строка - заполнен, если Успех = Ложь. +// * СвойстваПодписи - см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи +// +Функция УсовершенствоватьПодписьОбъекта(ПодписанныйОбъект, ПорядковыйНомер, ТипПодписи, ДобавитьАрхивнуюМеткуВремени = Ложь, Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.УсовершенствоватьПодписьОбъекта(ПодписанныйОбъект, ПорядковыйНомер, ТипПодписи, ДобавитьАрхивнуюМеткуВремени, ); +``` +
+ +## НовыйПараметрыПолученияПодписейОбъекта +
+ +Описание, пример вызова + +```bsl + +// Конструктор для описания дополнительных параметров получения электронных подписей объекта. +// +// Возвращаемое значение: +// Структура: +// * ПорядковыйНомер - Число - порядковый номер подписи для отбора. +// - Массив из Число - массив из порядковых номеров подписи для отбора. +// * ВозвращатьДанныеМЧД - Булево - если Истина и для подписи есть МЧД, будет заполнено свойство РезультатПроверкиПодписиПоМЧД +// * ВозвращатьСертификатыИзПодписей - Булево - если Истина, будет выполнено получение сертификатов из двоичных +// данных подписей. +// +Функция НовыйПараметрыПолученияПодписейОбъекта() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.НовыйПараметрыПолученияПодписейОбъекта() +``` +
+ +## СертификатИзДвоичныхДанныхПодписи +
+ +Описание, пример вызова + +```bsl + +// Извлекает сертификат из двоичных данных подписи. +// +// Параметры: +// Подпись - ДвоичныеДанные - результат подписания +// +// Возвращаемое значение: +// ДвоичныеДанные - двоичные данные сертификата. +// Неопределено - подпись не содержит сертификатов криптографии. +// +Функция СертификатИзДвоичныхДанныхПодписи(Подпись) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.СертификатИзДвоичныхДанныхПодписи(Подпись) +``` +
+ +## ДоступностьСозданияЗаявления +
+ +Описание, пример вызова + +```bsl + +// Возвращает доступность создания заявления на выпуск +// квалифицированных сертификатов для организаций и физических лиц. +// Требуется для скрытия команд, использующих процедуру +// ДобавитьСертификат общего модуля ЭлектроннаяПодписьКлиент +// в режиме создания заявления. +// +// Возвращаемое значение: +// Структура: +// * ДляФизическихЛиц - Булево +// * ДляРуководителейЮридическихЛиц - Булево +// * ДляСотрудниковЮридическихЛиц - Булево +// * ДляИндивидуальныхПредпринимателей - Булево +// +Функция ДоступностьСозданияЗаявления() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ДоступностьСозданияЗаявления() +``` +
+ +## ДоступнаУсовершенствованнаяПодпись +
+ +Описание, пример вызова + +```bsl + +// Устарела. Всегда возвращает Истина. +// +// Возвращаемое значение: +// Булево - если Истина, электронные подписи используются. +// +Функция ДоступнаУсовершенствованнаяПодпись() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.ДоступнаУсовершенствованнаяПодпись() +``` +
+ +## УстановленныеПодписи +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ПодписиОбъекта. +// Получает подписи объекта и возвращает их. +// +// Параметры: +// Объект - ОпределяемыйТип.ПодписанныйОбъект - ссылка на подписанный объект. +// Объект должен иметь реквизит ПодписанЭП. +// +// ПорядковыйНомер - Число +// - Массив из Число +// ВозвращатьДанныеМЧД - Булево - если Истина и для подписи есть МЧД будет заполнено свойство РезультатПроверкиПодписиПоМЧД +// +// Возвращаемое значение: +// Массив из см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи +// +Функция УстановленныеПодписи(Объект, ПорядковыйНомер = Неопределено, ВозвращатьДанныеМЧД = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодпись.УстановленныеПодписи(Объект, ПорядковыйНомер, ВозвращатьДанныеМЧД); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервиса.md b/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервиса.md new file mode 100644 index 0000000..a4304ed --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервиса.md @@ -0,0 +1,166 @@ +--- +title: Электронная подпись в модели сервиса +slug: bsp/электронная-подпись-в-модели-сервиса +--- + + +## ИспользованиеВозможно +
+ +Описание, пример вызова + +```bsl + +// Возможность использования электронной подписи в модели сервиса. +// +// Возвращаемое значение: +// Булево +Функция ИспользованиеВозможно() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьВМоделиСервиса.ИспользованиеВозможно() +``` +
+ +## ДолговременныйТокенИспользованиеВозможно +
+ +Описание, пример вызова + +```bsl + +// Возможность использованиея долговременного токена. +// +// Возвращаемое значение: +// Булево +Функция ДолговременныйТокенИспользованиеВозможно() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьВМоделиСервиса.ДолговременныйТокенИспользованиеВозможно() +``` +
+ +## СвойстваРасшифрованияПодписанияСертификата +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки сертификата: использование долговременного токена и его значение +// +// Параметры: +// Сертификат - Структура, Строка - содержит свойства сертификата, наличие свойства "Идентификатор" обязательно. +// +// Возвращаемое значение: +// Структура - состоит из полей: +// * СпособПодтвержденияКриптоОпераций - Произвольный - +// * Токен - Произвольный - +// * Идентификатор - Произвольный - +// * Отпечаток - Произвольный - +// +Функция СвойстваРасшифрованияПодписанияСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьВМоделиСервиса.СвойстваРасшифрованияПодписанияСертификата(Сертификат) +``` +
+ +## УдалитьСвойстваРасшифрованияПодписания +
+ +Описание, пример вызова + +```bsl + +// Удаляет настройки для использования долговременного токена +// +// Параметры: +// Сертификат - Структура - поля: +// * Идентификатор - Строка - обязательно. +// - Строка - содержит свойства сертификата, наличие свойства "Идентификатор" обязательно. +// +Процедура УдалитьСвойстваРасшифрованияПодписания(Сертификат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьВМоделиСервиса.УдалитьСвойстваРасшифрованияПодписания(Сертификат) +``` +
+ +## УстановитьСвойстваРасшифрованияПодписания +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройки для использования долговременного токена +// +// Параметры: +// Сертификат - Структура - поля: +// * Идентификатор - Строка - обязательно. +// - Строка - содержит свойства сертификата, наличие свойства "Идентификатор" обязательно. +// +Процедура УстановитьСвойстваРасшифрованияПодписания(Сертификат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьВМоделиСервиса.УстановитьСвойстваРасшифрованияПодписания(Сертификат) +``` +
+ +## НастроитьИспользованиеДолговременногоТокена +
+ +Описание, пример вызова + +```bsl + +Процедура НастроитьИспользованиеДолговременногоТокена(СпособПодтвержденияКриптоопераций, Сертификат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьВМоделиСервиса.НастроитьИспользованиеДолговременногоТокена(СпособПодтвержденияКриптоопераций, Сертификат) +``` +
+ +## НайтиСертификатПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Найти сертификат по идентификатору +// +// Параметры: +// Сертификат - Произвольный +// +// Возвращаемое значение: +// ДвоичныеДанные - Найти сертификат по идентификатору. +Функция НайтиСертификатПоИдентификатору(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьВМоделиСервиса.НайтиСертификатПоИдентификатору(Сертификат) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервисаКлиент.md b/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервисаКлиент.md new file mode 100644 index 0000000..688d35f --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервисаКлиент.md @@ -0,0 +1,101 @@ +--- +title: Электронная подпись в модели сервиса клиент +slug: bsp/электронная-подпись-в-модели-сервиса-клиент +--- + + +## ИспользованиеВозможно +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Булево +// +Функция ИспользованиеВозможно() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьВМоделиСервисаКлиент.ИспользованиеВозможно() +``` +
+ +## ИзменитьНастройкиПолученияВременныхПаролей +
+ +Описание, пример вызова + +```bsl + +// Процедура - Изменить настройки получения временных паролей +// +// Параметры: +// Сертификат - Произвольный - сертификат +// ОповещениеОЗавершении - ОписаниеОповещения - оповещение о завершении. +// ПараметрыФормы - Структура - необязательный, содержит дополнительные параметры при открытии формы +// +Процедура ИзменитьНастройкиПолученияВременныхПаролей(Сертификат, Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьВМоделиСервисаКлиент.ИзменитьНастройкиПолученияВременныхПаролей(Сертификат, ); +``` +
+ +## ИзменитьСпособПодтвержденияКриптоопераций +
+ +Описание, пример вызова + +```bsl + +// Процедура - Изменить способ подтверждения криптооперация +// +// Параметры: +// Сертификат - Произвольный - сертификат +// ОповещениеОЗавершении - ОписаниеОповещения - оповещение о завершении. +// ПараметрыФормы - Структура - необязательный, содержит дополнительные параметры при открытии формы +// +Процедура ИзменитьСпособПодтвержденияКриптоопераций(Сертификат, Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьВМоделиСервисаКлиент.ИзменитьСпособПодтвержденияКриптоопераций(Сертификат, ); +``` +
+ +## ОтключитьПодтвержденияКриптоопераций +
+ +Описание, пример вызова + +```bsl + +// Процедура - Отключить подтверждения криптоопераций +// +// Параметры: +// Сертификат - Произвольный - сертификат +// ОповещениеОЗавершении - ОписаниеОповещения - оповещение о завершении. +// ПараметрыФормы - Структура - необязательный, содержит дополнительные параметры при открытии формы +// +Процедура ОтключитьПодтвержденияКриптоопераций(Сертификат, Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьВМоделиСервисаКлиент.ОтключитьПодтвержденияКриптоопераций(Сертификат, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервисаКлиентСервер.md b/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервисаКлиентСервер.md new file mode 100644 index 0000000..0955885 --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервисаКлиентСервер.md @@ -0,0 +1,77 @@ +--- +title: Электронная подпись в модели сервиса клиент сервер +slug: bsp/электронная-подпись-в-модели-сервиса-клиент-сервер +--- + + +## ПолучитьПредставлениеТелефона +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Телефон - Строка +// +// Возвращаемое значение: +// Строка +// +Функция ПолучитьПредставлениеТелефона(Телефон) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьВМоделиСервисаКлиентСервер.ПолучитьПредставлениеТелефона(Телефон) +``` +
+ +## ПолучитьОписаниеСпособовПодтвержденияКриптоопераций +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Строка +// +Функция ПолучитьОписаниеСпособовПодтвержденияКриптоопераций() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьВМоделиСервисаКлиентСервер.ПолучитьОписаниеСпособовПодтвержденияКриптоопераций() +``` +
+ +## ИспользованиеВозможно +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. ЭлектроннаяПодписьВМоделиСервисаКлиент.ИспользованиеВозможно. +// См. ЭлектроннаяПодписьВМоделиСервиса.ИспользованиеВозможно. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользованиеВозможно() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьВМоделиСервисаКлиентСервер.ИспользованиеВозможно() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервисаПереопределяемый.md b/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервисаПереопределяемый.md new file mode 100644 index 0000000..c52ba67 --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьВМоделиСервисаПереопределяемый.md @@ -0,0 +1,31 @@ +--- +title: Электронная подпись в модели сервиса переопределяемый +slug: bsp/электронная-подпись-в-модели-сервиса-переопределяемый +--- + + +## ПриВключенииСервисаКриптографии +
+ +Описание, пример вызова + +```bsl + +// @skip-warning ПустойМетод - переопределяемый метод. +// +Процедура ПриВключенииСервисаКриптографии() Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьВМоделиСервисаПереопределяемый.ПриВключенииСервисаКриптографии() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьКлиент.md b/src/content/docs/bsp/ЭлектроннаяПодписьКлиент.md new file mode 100644 index 0000000..1cda59a --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьКлиент.md @@ -0,0 +1,1859 @@ +--- +title: Электронная подпись клиент +slug: bsp/электронная-подпись-клиент +--- + + +## ИспользоватьЭлектронныеПодписи +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую настройку использования электронных подписей. +// +// Возвращаемое значение: +// Булево - если Истина, электронные подписи используются. +// +Функция ИспользоватьЭлектронныеПодписи() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ИспользоватьЭлектронныеПодписи() +``` +
+ +## ИспользоватьШифрование +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую настройку использования шифрования. +// +// Возвращаемое значение: +// Булево - если Истина, шифрование используется. +// +Функция ИспользоватьШифрование() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ИспользоватьШифрование() +``` +
+ +## ПроверятьЭлектронныеПодписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую настройку проверки электронных подписей на сервере. +// +// Возвращаемое значение: +// Булево - если Истина, электронные подписи будут проверяться на сервере. +// +Функция ПроверятьЭлектронныеПодписиНаСервере() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПроверятьЭлектронныеПодписиНаСервере() +``` +
+ +## СоздаватьЭлектронныеПодписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую настройку создания электронных подписей на сервере. +// Настройка также предполагает шифрование и расшифровку на сервере. +// +// Возвращаемое значение: +// Булево - если Истина, электронные подписи будут создаваться на сервере. +// +Функция СоздаватьЭлектронныеПодписиНаСервере() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.СоздаватьЭлектронныеПодписиНаСервере() +``` +
+ +## Подписать +
+ +Описание, пример вызова + +```bsl + +// Подписывает данные, возвращает подпись и добавляет подпись в объект, если указано. +// +// Общий подход к обработке значений свойств с типом ОписаниеОповещения в параметре ОписаниеДанных. +// При выполнении обработки оповещения в нее передается структура параметров, в которой всегда есть +// свойство "Оповещение" типа ОписаниеОповещения, обработку которого нужно выполнить для продолжения. +// Кроме того, в структуре всегда есть свойство ОписаниеДанных, полученное при вызове процедуры. +// При вызове оповещения в качестве значения должна передаваться структура. Если в процессе асинхронного +// выполнения возникает ошибка, тогда в эту структуру нужно вставить свойство ОписаниеОшибки типа Строка. +// +// Параметры: +// ОписаниеДанных - Структура: +// * Операция - Строка - заголовок формы подписания данных, например Подписание файла. +// * ЗаголовокДанных - Строка - заголовок элемента или набора данных, например Файл. +// * СообщитьОЗавершении - Булево - (необязательный) - если Ложь, то не будет показано оповещение о успешном +// завершении операции для представления данных, указанного рядом с заголовком. +// * ПоказатьКомментарий - Булево - (необязательный) - разрешает ввод комментария в форме +// подписания данных. Если не указан, значит Ложь. +// * ОтборСертификатов - Массив - (необязательный) - содержит ссылки на элементы справочника. +// СертификатыЭлектроннойПодписиИШифрования, которые могут быть выбраны +// пользователем. Отбор блокирует возможность выбора других сертификатов +// из личного хранилища. +// - Структура: +// * Организация - ОпределяемыйТип.Организация - содержит ссылку на организацию, +// по которой будет установлен отбор в списке сертификатов пользователя. +// * БезПодтверждения - Булево - (необязательный) - пропустить подтверждение пользователя, если +// в свойстве ОтборСертификатов только один сертификат и: +// а) либо для сертификата указано "Вводить пароль в программе электронной подписи"; +// б) либо пользователь запомнил пароль к сертификату на время сеанса; +// в) либо пароль установлен ранее методом УстановитьПарольСертификата. +// Если в процессе подписания возникла ошибка, тогда будет открыта форма +// с возможностью указать пароль. Параметр ПоказатьКомментарий игнорируется. +// * ПередВыполнением - ОписаниеОповещения - (необязательный) - описание обработчика дополнительной +// подготовки данных после выбора сертификата, которым будут подписаны данные. +// В этом обработчике можно заполнить параметр Данные, если он зависит +// от сертификата, который в момент вызова уже вставлен в ОписаниеДанных +// как ВыбранныйСертификат (смотри ниже). +// Также можно переопределить параметр ВыбраннаяДоверенность в ОписаниеДанных. +// Следует учесть общий подход (смотри выше). +// * ВыполнятьНаСервере - Неопределено +// - Булево - (необязательный) - когда не указан или Неопределено, +// тогда выполнение будет определено автоматически: если есть сервер, то сначала +// на сервере, потом (при неудаче) на клиенте, потом сообщение о двух ошибках. +// Когда Истина: если разрешено выполнение на сервере, тогда выполнение +// только на сервере, при неудаче одно сообщение об ошибке на сервере. +// Когда Ложь: выполнение только на клиенте, как будто нет сервера. +// * ПараметрыДополнительныхДействий - Произвольный - (необязательный) - если указан, то передается +// на сервер в процедуру ПередНачаломОперации общего модуля +// ЭлектроннаяПодписьПереопределяемый как ВходныеПараметры. +// * КонтекстОперации - Неопределено - (необязательный) - если указан, тогда в свойство будет +// установлено определенное значение произвольного типа, которое позволяет +// выполнить действие с тем же сертификатом повторно (у пользователя +// не запрашивается ни пароль, ни подтверждение действия). +// В случае ошибки после вызова процедуры, повторное действие, выполненное +// с полученным контекстом, может быть также ошибочно. +// - Произвольный - (необязательный) - если определено, то действие будет выполнено +// с тем же сертификатом без запроса пароля или подтверждения. +// Параметр БезПодтверждения считается равным Истина. +// Параметры Операция, ЗаголовокДанных, ПоказатьКомментарий, ОтборСертификатов +// и ВыполнятьНаСервере игнорируются, их значения остаются такими же, как при первом вызове. +// Параметр ПараметрыДополнительныхДействий игнорируется. +// Процедура ПередНачаломОперации не вызывается. +// Если передать контекст, возвращенный процедурой Расшифровать, тогда +// пароль, введенный для сертификата, может быть использован, как если бы +// пароль был сохранен на время сеанса. В остальном контекст игнорируется. +// * ПрекратитьВыполнение - Произвольный - если свойство существует и в процессе асинхронного выполнения возникает +// ошибка, выполнение прекращается без отображения формы операции или с закрытием этой формы, +// если она была открыта. +// +// Вариант 1. +// * Данные - ДвоичныеДанные - данные для подписания. +// - Строка - адрес временного хранилища, содержащего двоичные данные. +// - ОписаниеОповещения - обработчик получения данных, который возвращает +// их в свойстве Данные (смотри выше общий подход). В момент вызова +// в ОписаниеДанных уже вставлен параметр ВыбранныйСертификат (смотри ниже). +// - Структура: +// * КонвертXML - см. ЭлектроннаяПодписьКлиент.КонвертXML +// * ПараметрыXMLDSig - см. ЭлектроннаяПодписьКлиент.ПараметрыXMLDSig +// - Структура: +// * ПараметрыCMS - см. ЭлектроннаяПодписьКлиент.ПараметрыCMS +// * Данные - Строка - произвольная строка для подписания, +// - ДвоичныеДанные - двоичные данные для подписания. +// * Объект - ЛюбаяСсылка - (необязательный) - ссылка на объект , к которому нужно добавить подпись. +// Если не указан, то подпись не требуется добавлять. +// - ОписаниеОповещения - (необязательный) - обработчик добавления подписи в +// регистр сведений ЭлектронныеПодписи. Следует учесть общий подход (смотри выше). +// В момент вызова в ОписаниеДанных уже вставлен параметр СвойстваПодписи. +// В случае параметра НаборДанных, в ОписаниеДанных вставляется +// свойство ТекущийЭлементНабораДанных, содержащее параметр СвойстваПодписи. +// * ВерсияОбъекта - Строка - (необязательный) - версия данных объекта для проверки и +// блокировки объекта перед добавлением подписи. +// * Представление - ЛюбаяСсылка - (необязательный), если параметр не указан, +// тогда представление вычисляется по значению свойства Объект. +// - Строка +// - Структура: +// ** Значение - ЛюбаяСсылка +// - ОписаниеОповещения - для открытия. +// ** Представление - Строка - представление значения. +// Вариант 2. +// * НаборДанных - Массив - структуры со свойствами, описанными в Варианте 1. +// * ПредставлениеНабора - Строка - представления нескольких элементов набора данных, например, "Файлы (%1)". +// В это представление в параметр %1 заполняется количество элементов. +// По гиперссылке можно открыть список. +// Если в наборе данных 1 элемент, тогда используется значение +// в свойстве Представление свойства НаборДанных, если не указано, тогда +// представление вычисляется по значению свойства Объект элемента набора данных. +// * СписокПредставлений - СписокЗначений +// - Массив - (необязательный) - произвольный список элементов +// или массив со значениями, как у свойства Представление, которые +// сможет открыть пользователь. Если не указан, то заполняется из +// свойств Представление или Объект в свойстве НаборДанных. +// +// Форма - ФормаКлиентскогоПриложения - форма, из которой нужно получить уникальный идентификатор, +// который будет использоваться при блокировке объекта. +// - УникальныйИдентификатор - уникальный идентификатор, который будет +// использоваться при блокировке объекта. +// - Неопределено - использовать стандартную форму. +// +// ОбработкаРезультата - ОписаниеОповещения - +// Требуется для нестандартной обработки результата, например, если не указан параметр Объект и/или Форма. +// В результат передается входной параметр ОписаниеДанных, который в успешном случае дополняется свойствами: +// # Успех - Булево - Истина, если все прошло успешно. Если Успех = Ложь, то частичное завершение +// определяется по наличию свойства СвойстваПодписи. Если есть, то шаг выполнен. +// # Отказ - Булево - Истина, если пользователь отменил операцию интерактивно. +// # ПользовательНажалКнопкуПодписать - Булево - если Истина, то пользователь хотя бы раз +// нажал на кнопку Подписать. Используется для сценариев, когда для продолжения бизнес-процесса +// достаточно простой подписи (намерения установить подпись), а установка квалифицированной подписи +// является дополнением, которое можно реализовать позднее, если возникли технические проблемы. +// # ВыбранныйСертификат - Структура - содержит свойства сертификата: +// ## Ссылка - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - ссылка на сертификат. +// ## Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// ## Данные - Строка - адрес временного хранилища, содержащего двоичные данные сертификата. +// # ВыбраннаяДоверенность - ЛюбаяСсылка +// # СвойстваПодписи = Строка - адрес временного хранилища, содержащего описанную ниже структуру, +// если подписание произошло на сервере. +// = Структура: +// * ТипПодписи - ПеречислениеСсылка.ТипыПодписиКриптографии +// * СрокДействияПоследнейМеткиВремени - Дата, Неопределено - заполняется только с помощью +// менеджера криптографии. +// * ДатаПодписиИзМетки - Дата, Неопределено - самый ранний штамп времени +// * НеподтвержденнаяДатаПодписи - Дата - неподтвержденная дата подписи. +// * Сертификат - ДвоичныеДанные - сертификат для проверки подписи. +// * Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// * КомуВыданСертификат - Строка - представление субъекта, полученное из двоичных данных сертификата. +// При передаче параметра НаборДанных, свойство нужно проверять в нем. +// +// ПараметрыПодписи - см. НовыйТипПодписи +// +Процедура Подписать(ОписаниеДанных, Форма = Неопределено, ОбработкаРезультата = Неопределено, ПараметрыПодписи = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.Подписать(ОписаниеДанных, Форма, ОбработкаРезультата, ПараметрыПодписи); +``` +
+ +## НовыйТипПодписи +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра ТипПодписи для процедуры Подписать. +// Игнорируется для подписи конверта XML. +// +// Параметры: +// ТипПодписи - ПеречислениеСсылка.ТипыПодписиКриптографии +// +// Возвращаемое значение: +// Структура: +// * ТипыПодписи - Массив - массив типов подписей для выбора. +// * Видимость - Булево - видимость типа подписи на форме подписания. +// * Доступность - Булево - доступность типа подписи на форме подписания. +// * ВыборДоверенности - Булево - показывать поле выбора доверенности. +// * ПроверятьСертификат - Строка - режим проверки квалифицированности ЭП: +// "ПроверятьКвалифицированные" - (по умолчанию) разрешать подписывать НЭП и проверять КЭП на действительность +// с учетом списка разрешенных неаккредитованных УЦ. +// "ТолькоКвалифицированные" - разрешать подписывать только КЭП и не учитывать список разрешенных +// неаккредитованных УЦ. +// "НеПроверятьСертификат" - не выполнять проверку сертификата. +// +Функция НовыйТипПодписи(ТипПодписи = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.НовыйТипПодписи(ТипПодписи); +``` +
+ +## ДобавитьПодписьИзФайла +
+ +Описание, пример вызова + +```bsl + +// Предлагает пользователю выбрать файлы подписей для добавления к объекту и добавляет их. +// +// Общий подход к обработке значений свойств с типом ОписаниеОповещения в параметре ОписаниеДанных. +// При выполнении обработки оповещения в нее передается структура параметров, в которой всегда есть +// свойство "Оповещение" типа ОписаниеОповещения, обработку которого нужно выполнить для продолжения. +// Кроме того, в структуре всегда есть свойство ОписаниеДанных, полученное при вызове процедуры. +// При вызове оповещения в качестве значения должна передаваться структура. Если в процессе асинхронного +// выполнения возникает ошибка, тогда в эту структуру нужно вставить свойство ОписаниеОшибки типа Строка. +// +// Параметры: +// ОписаниеДанных - Структура: +// * ЗаголовокДанных - Строка - заголовок элемента данных, например Файл. +// * ПоказатьКомментарий - Булево - (необязательный) - разрешает ввод комментария в форме +// добавления подписей. Если не указан, значит Ложь. +// * Объект - ЛюбаяСсылка - (необязательный) - ссылка на объект , к которому нужно добавить подпись. +// - ОписаниеОповещения - (необязательный) - обработчик добавления подписи в +// регистр сведений ЭлектронныеПодписи. Следует учесть общий подход (смотри выше). +// В момент вызова в ОписаниеДанных уже вставлен параметр Подписи. +// * ВерсияОбъекта - Строка - (необязательный) - версия данных объекта для проверки и +// блокировки объекта перед добавлением подписи. +// * Представление - ЛюбаяСсылка +// - Строка - (необязательный), если не указан, тогда +// представление вычисляется по значению свойства Объект. +// * Данные - ДвоичныеДанные - (необязательный) - данные для проверки подписи. +// - Строка - (необязательный) - адрес временного хранилища, содержащего двоичные данные. +// - ОписаниеОповещения - (необязательный) - обработчик получения данных, который +// возвращает их в свойстве Данные (смотри выше общий подход). +// +// Форма - ФормаКлиентскогоПриложения - форма, из которой нужно получить уникальный идентификатор, +// который будет использоваться при блокировке объекта. +// - УникальныйИдентификатор - уникальный идентификаторы, который будет +// использоваться при блокировке объекта. +// - Неопределено - использовать стандартную форму. +// +// ОбработкаРезультата - ОписаниеОповещения - +// Требуется для нестандартной обработки результата - например, если не указан параметр Объект и/или Форма. +// В результат передается входной параметр ОписаниеДанных, который в успешном случае дополняется свойствами: +// # Успех - Булево - Истина, если все прошло успешно. +// # Отказ - Булево - Истина, если пользователь отменил операцию интерактивно. +// # Подписи - Массив - который содержит элементы: +// ## СвойстваПодписи = Строка - адрес временного хранилища, содержащего описанную ниже структуру. +// = Структура - развернутое описание подписи +// ### Подпись - ДвоичныеДанные - результат подписания. +// ### УстановившийПодпись - СправочникСсылка.Пользователи - пользователь, который +// подписал объект информационной базы. +// ### Комментарий - Строка - комментарий, если он был введен при подписании. +// ### ИмяФайлаПодписи - Строка - имя файла, из которого добавлена подпись. +// ### ДатаПодписи - Дата - дата, когда подпись была сделана. Имеет смысл для случаев, +// когда дату невозможно извлечь из данных подписи. Если не +// указана или пустая, тогда используется текущая дата сеанса. +// ### ДатаПроверкиПодписи - Дата - дата проверки подписи после добавления из файла, если +// не указано свойство Данные в параметре ОписаниеДанных, +// возвращает пустую дату. +// ### ПодписьВерна - Булево - результат проверки подписи после добавления из файла, если +// не указано свойство Данные в параметре ОписаниеДанных, +// возвращает Ложь. +// +// Производные свойства: +// ### Сертификат - ДвоичныеДанные - содержит выгрузку сертификата, +// который использовался для подписания (содержится в подписи). +// ### Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// ### КомуВыданСертификат - Строка - представление субъекта, полученное из двоичных данных сертификата. +// +Процедура ДобавитьПодписьИзФайла(ОписаниеДанных, Форма = Неопределено, ОбработкаРезультата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.ДобавитьПодписьИзФайла(ОписаниеДанных, Форма, ОбработкаРезультата); +``` +
+ +## СохранитьДанныеВместеСПодписью +
+ +Описание, пример вызова + +```bsl + +// Предлагает пользователю выбрать подписи для сохранения вместе с данными объекта. +// +// Общий подход к обработке значений свойств с типом ОписаниеОповещения в параметре ОписаниеДанных. +// При выполнении обработки оповещения в нее передается структура параметров, в которой всегда есть +// свойство "Оповещение" типа ОписаниеОповещения, обработку которого нужно выполнить для продолжения. +// Кроме того, в структуре всегда есть свойство ОписаниеДанных, полученное при вызове процедуры. +// При вызове оповещения в качестве значения должна передаваться структура. Если в процессе асинхронного +// выполнения возникает ошибка, тогда в эту структуру нужно вставить свойство ОписаниеОшибки типа Строка. +// +// Параметры: +// ОписаниеДанных - Структура: +// * ЗаголовокДанных - Строка - заголовок элемента данных, например Файл. +// * ПоказатьКомментарий - Булево - (необязательный) - разрешает ввод комментария в форме +// добавления подписей. Если не указан, значит Ложь. +// * Представление - ЛюбаяСсылка +// - Строка - (необязательный), если не указан, тогда +// представление вычисляется по значению свойства Объект. +// * Объект - ЛюбаяСсылка - ссылка на объект, из которого нужно получить список подписей. +// - Строка - адрес временного хранилища массива подписей с составом свойств, +// как возвращает процедура ДобавитьПодписьИзФайла. +// * Данные - ОписаниеОповещения - обработчик сохранения данных и получения полного имени +// файла с путем (после его сохранения), возвращаемое в свойстве ПолноеИмяФайла +// типа Строка для сохранения электронных подписей (смотри выше общий подход). +// Если расширение для работы с 1С:Предприятием не подключено, то нужно вернуть +// имя файла без пути. +// Если свойство не будет вставлено или заполнено - это считается отказом +// от продолжения и будет вызвана ОбработкаРезультата с результатом Ложь. +// +// Для пакетного запроса разрешений у пользователя веб-клиента на сохранение файла данных +// и подписей нужно вставить параметр ОбработкаЗапросаРазрешений типа ОписаниеОповещения. +// В процедуру будет передана Структура со свойствами +// # Вызовы - Массив - с описанием вызовов для сохранения подписей. +// # ОбработкаПродолжения - ОписаниеОповещения - оповещение, которое нужно выполнить +// после запроса разрешений, - параметры процедуры как у +// оповещения для метода НачатьЗапросРазрешенияПользователя. +// Если разрешение не получено, значит, все отменено. +// +// ОбработкаРезультата - ОписаниеОповещения - +// В результат передается параметр типа Булево - Истина, если все прошло успешно. +// +Процедура СохранитьДанныеВместеСПодписью(ОписаниеДанных, ОбработкаРезультата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.СохранитьДанныеВместеСПодписью(ОписаниеДанных, ОбработкаРезультата); +``` +
+ +## ПроверитьПодпись +
+ +Описание, пример вызова + +```bsl + +// Проверяет действительность подписи и сертификата. +// Сертификат всегда проверяется на сервере, если администратор +// настроил проверку электронных подписей на сервере. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение о результате выполнения следующих типов: +// = Булево - Истина, если проверка выполнена успешно - если ПараметрыПроверки - Неопределено +// = Строка - описание ошибки проверки подписи. +// = Неопределено - не удалось получить менеджер криптографии (когда не указан). +// = см. ЭлектроннаяПодписьКлиентСервер.РезультатПроверкиПодписи - если +// ПараметрыПроверки.РезультатВВидеСтруктуры - Истина. +// ИсходныеДанные - ДвоичныеДанные - двоичные данные, которые были подписаны. +// Математическая проверка выполняется на стороне клиента, даже когда +// администратор настроил проверку электронных подписей на сервере, +// если указан менеджер криптографии или его удалось получить без ошибки. +// Это повышает производительность, а также безопасность, когда проверяется подпись +// в расшифрованном файле (он не будет передан на сервер). +// - Строка - адрес временного хранилища, содержащего исходные двоичные данные. +// - Структура: +// * КонвертXML - Строка - подписанный КонвертXML, +// смотри также функцию КонвертXML. +// * ПараметрыXMLDSig - см. ЭлектроннаяПодписьКлиент.ПараметрыXMLDSig +// - Структура: +// * ПараметрыCMS - см. ЭлектроннаяПодписьКлиент.ПараметрыCMS +// * Данные - Строка - произвольная строка для подписания, +// - ДвоичныеДанные - двоичные данные для подписания. +// Подпись - ДвоичныеДанные - двоичные данные электронной подписи. +// - Строка - адрес временного хранилища, содержащего двоичные данные. +// - Неопределено - если ИсходныеДанные - конверт SOAP. +// МенеджерКриптографии - Неопределено - получить менеджер криптографии по умолчанию +// (менеджер первой программы в списке, как настроил администратор). +// - МенеджерКриптографии - использовать указанный менеджер криптографии. +// НаДату - Дата - проверить сертификат на указанную дату, +// если дату не удалось извлечь из подписи или если проверяется КонвертXML. +// Если параметр не заполнен, тогда проверять на текущую дату сеанса, +// если дату не удалось извлечь из подписи или если проверяется КонвертXML. +// ПараметрыПроверки - см. ПараметрыПроверкиПодписи +// - Неопределено - показать ошибку создания менеджера криптографии (когда не указан). +// +Процедура ПроверитьПодпись(Оповещение, ИсходныеДанные, Подпись, Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.ПроверитьПодпись(Оповещение, ИсходныеДанные, Подпись, ); +``` +
+ +## ПараметрыПроверкиПодписи +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра "ПараметрыПроверки" для процедуры "ПроверитьПодпись". +// +// Возвращаемое значение: +// Структура: +// * ПоказатьОшибкуСозданияМенеджераКриптографии - Булево - показать ошибку +// создания менеджера криптографии (когда не указан). +// * РезультатВВидеСтруктуры - Булево - если Истина, результат будет в виде +// см. ЭлектроннаяПодписьКлиентСервер.РезультатПроверкиПодписи +// * ПроверятьСертификат - Строка - режим проверки квалифицированности ЭП, применяется, если РезультатВВидеСтруктуры = +// Истина иначе проверка работает в режиме "ПроверятьКвалифицированные". +// "ПроверятьКвалифицированные" - (по умолчанию) разрешать подписывать НЭП и проверять КЭП на действительность +// с учетом списка разрешенных неаккредитованных УЦ. +// "ТолькоКвалифицированные" - разрешать подписывать только КЭП и не учитывать список разрешенных +// неаккредитованных УЦ. +// "НеПроверятьСертификат" - не выполнять проверку сертификата подписи. +// +Функция ПараметрыПроверкиПодписи() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПараметрыПроверкиПодписи() +``` +
+ +## Зашифровать +
+ +Описание, пример вызова + +```bsl + +// Шифрует данные, возвращает сертификаты шифрования и добавляет их в объект, если указано. +// +// Общий подход к обработке значений свойств с типом ОписаниеОповещения в параметре ОписаниеДанных. +// При выполнении обработки оповещения в нее передается структура параметров, в которой всегда есть +// свойство "Оповещение" типа ОписаниеОповещения, обработку которого нужно выполнить для продолжения. +// Кроме того, в структуре всегда есть свойство ОписаниеДанных, полученное при вызове процедуры. +// При вызове оповещения в качестве значения должна передаваться структура. Если в процессе асинхронного +// выполнения возникает ошибка, тогда в эту структуру нужно вставить свойство ОписаниеОшибки типа Строка. +// +// Параметры: +// ОписаниеДанных - Структура: +// * Операция - Строка - заголовок формы шифрования данных, например Шифрование файла. +// * ЗаголовокДанных - Строка - заголовок элемента или набора данных, например Файл. +// * СообщитьОЗавершении - Булево - (необязательный) - если Ложь, то не будет показано оповещение об успешном +// завершении операции для представления данных, указанного рядом с заголовком. +// * НаборСертификатов - Строка - (необязательный) адрес временного хранилища, содержащего массив, описанный ниже. +// - Массив - (необязательный) содержит значения +// типа СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования или +// типа ДвоичныеДанные (выгрузка сертификата). +// - ЛюбаяСсылка - (необязательный) - ссылка на объект, для которого необходимо получить сертификаты. +// * ИзменятьНабор - Булево - если Истина и НаборСертификатов задан и содержит только ссылки +// на сертификаты, тогда будет возможность изменить состав сертификатов. +// * БезПодтверждения - Булево - (необязательный) - пропустить подтверждение пользователя, +// если указано свойство ОтборСертификатов. +// * ВыполнятьНаСервере - Неопределено +// - Булево - (необязательный) - когда не указан или Неопределено, +// тогда выполнение будет определено автоматически: если есть сервер, то сначала +// на сервере, потом (при неудаче) на клиенте, потом сообщение о двух ошибках. +// Когда Истина: если разрешено выполнение на сервере, тогда выполнение +// только на сервере, при неудаче одно сообщение об ошибке на сервере. +// Когда Ложь: выполнение только на клиенте, как будто нет сервера. +// * КонтекстОперации - Неопределено - (необязательный) - если указан, тогда в свойство будет +// установлено определенное значение произвольного типа, которое позволяет +// выполнить действие с теми же сертификатами шифрования повторно (у пользователя +// не запрашивается подтверждение действия). +// - Произвольный - (необязательный) - если определено, то действие будет выполнено +// с теми же сертификатами шифрования. +// Параметр БезПодтверждения считается равным Истина. +// Параметры Операция, ЗаголовокДанных, НаборСертификатов, ИзменятьНабор +// и ВыполнятьНаСервере игнорируются, их значения остаются такими же, как при первом вызове. +// * ПрекратитьВыполнение - Произвольный - если свойство существует и в процессе асинхронного выполнения возникает +// ошибка, выполнение прекращается без отображения формы операции или с закрытием этой формы, +// если она была открыта. +// * АлгоритмШифрования - Строка - (необязательный) - содержит явное название ("Магма", "Кузнечик", "ГОСТ 28147-89"), +// OID или представление алгоритма шифрования,которым будет переопределен алгоритм шифрования +// по умолчанию. Например, если передается представление "Магма", то это наименование будет +// преобразовано в название алгоритма шифрования той программы, которой выполняется шифрование. +// +// Вариант 1. +// * Данные - ДвоичныеДанные - данные для шифрования. +// - Строка - адрес временного хранилища, содержащего двоичные данные. +// - ОписаниеОповещения - обработчик получения данных, который возвращает +// их в свойстве Данные (смотри выше общий подход). +// * РазмещениеРезультата - Неопределено - (необязательный) - описывает куда поместить зашифрованные данные. +// Если не указан или Неопределено, тогда через параметр ОбработкаРезультата. +// - ОписаниеОповещения - обработчик сохранения зашифрованных данных. +// Следует учесть общий подход (смотри выше). +// В момент вызова в ОписаниеДанных уже вставлен параметр ЗашифрованныеДанные. +// В случае параметра НаборДанных, в ОписаниеДанных вставляется +// свойство ТекущийЭлементНабораДанных, содержащее параметр ЗашифрованныеДанные. +// * Объект - ЛюбаяСсылка - (необязательный) - ссылка на объект, который необходимо зашифровать. +// Если не указан, то сертификаты шифрования не требуется добавлять. +// * ВерсияОбъекта - Строка - (необязательный) - версия данных объекта для проверки и +// блокировки объекта перед добавлением сертификатов шифрования. +// * Представление - ЛюбаяСсылка - (необязательный), если параметр не указан, +// тогда представление вычисляется по значению свойства Объект. +// - Строка +// - Структура: +// ** Значение - ЛюбаяСсылка +// - ОписаниеОповещения - для открытия. +// ** Представление - Строка - представление значения. +// +// Вариант 2. +// * НаборДанных - Массив - структуры со свойствами, описанными в Варианте 1. +// * ПредставлениеНабора - Строка - представления нескольких элементов набора данных, например, "Файлы (%1)". +// В это представление в параметр %1 заполняется количество элементов. +// По гиперссылке можно открыть список. +// Если в наборе данных 1 элемент, тогда используется значение +// в свойстве Представление свойства НаборДанных, если не указано, тогда +// представление вычисляется по значению свойства Объект элемента набора данных. +// * СписокПредставлений - СписокЗначений +// - Массив - (необязательный) - произвольный список элементов +// или массив со значениями, как у свойства Представление, которые +// сможет открыть пользователь. Если не указан, то заполняется из +// свойств Представление или Объект в свойстве НаборДанных. +// +// Форма - ФормаКлиентскогоПриложения - форма, из которой нужно получить уникальный идентификатор, который будет +// использоваться при помещении зашифрованных данных во временное хранилище. +// - УникальныйИдентификатор - уникальный идентификатор, который будет +// использоваться при помещении зашифрованных данных во временное хранилище. +// - Неопределено - использовать стандартную форму. +// +// ОбработкаРезультата - ОписаниеОповещения - +// Требуется для нестандартной обработки результата, если не указан параметр Форма и/или РазмещениеРезультата. +// В результат передается входной параметр ОписаниеДанных, который в успешном случае дополняется свойствами: +// # Успех - Булево - Истина, если все прошло успешно. Если Успех = Ложь, то частичное завершение +// определяется по наличию свойства ЗашифрованныеДанные. Если есть, то шаг выполнен. +// # Отказ - Булево - Истина, если пользователь отменил операцию интерактивно. +// # СертификатыШифрования = Строка - адрес временного хранилища, содержащего массив, описанный ниже. +// = Массив - помещается перед началом шифрования и после этого не изменяется. +// ## Значение - Структура +// ### Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// ### Представление - Строка - сохраненное представление субъекта, +// полученное из двоичных данных сертификата. +// ### Сертификат - ДвоичныеДанные - содержит выгрузку сертификата, +// который использовался для шифрования. +// # ЗашифрованныеДанные = ДвоичныеДанные - результат шифрования. +// При передаче параметра НаборДанных свойство нужно проверять в нем. +// = Строка - адрес временного хранилища, содержащего результат шифрования. +// +Процедура Зашифровать(ОписаниеДанных, Форма = Неопределено, ОбработкаРезультата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.Зашифровать(ОписаниеДанных, Форма, ОбработкаРезультата); +``` +
+ +## Расшифровать +
+ +Описание, пример вызова + +```bsl + +// Расшифровывает данные, возвращает их и помещает в объект, если указано. +// +// Общий подход к обработке значений свойств с типом ОписаниеОповещения в параметре ОписаниеДанных. +// При выполнении обработки оповещения в нее передается структура параметров, в которой всегда есть +// свойство "Оповещение" типа ОписаниеОповещения, обработку которого нужно выполнить для продолжения. +// Кроме того, в структуре всегда есть свойство ОписаниеДанных, полученное при вызове процедуры. +// При вызове оповещения в качестве значения должна передаваться структура. Если в процессе асинхронного +// выполнения возникает ошибка, тогда в эту структуру нужно вставить свойство ОписаниеОшибки типа Строка. +// +// Параметры: +// ОписаниеДанных - Структура: +// * Операция - Строка - заголовок формы расшифровки данных, например, Расшифровка файла. +// * ЗаголовокДанных - Строка - заголовок элемента или набора данных, например Файл. +// * СообщитьОЗавершении - Булево - (необязательный) - если Ложь, то не будет показано оповещение о успешном +// завершении операции для представления данных, указанного рядом с заголовком. +// * ОтборСертификатов - Массив - (необязательный) - содержит ссылки на элементы справочника. +// СертификатыЭлектроннойПодписиИШифрования, которые могут быть выбраны +// пользователем. Отбор блокирует возможность выбора других сертификатов +// из личного хранилища. +// * БезПодтверждения - Булево - (необязательный) - пропустить подтверждение пользователя, если +// в свойстве ОтборСертификатов только один сертификат и: +// а) либо для сертификата указано "Вводить пароль в программе электронной подписи"; +// б) либо пользователь запомнил пароль к сертификату на время сеанса; +// в) либо пароль установлен ранее методом УстановитьПарольСертификата. +// Если в процессе расшифровки возникла ошибка, тогда будет открыта форма +// с возможностью указать пароль. +// * ЭтоАутентификация - Булево - (необязательный) - если Истина, то вместо кнопки Расшифровать +// будет показана кнопка ОК. А также скорректированы некоторые надписи. +// Кроме того, параметр СообщитьОЗавершении устанавливается в Ложь. +// * ПередВыполнением - ОписаниеОповещения - (необязательный) - описание обработчика дополнительной +// подготовки данных после выбора сертификата, которым будут расшифрованы данные. +// В этом обработчике можно заполнить параметр Данные, если необходимо. +// В момент вызова в ОписаниеДанных уже вставлен выбранный сертификат, +// как ВыбранныйСертификат (смотри ниже). Следует учесть общий подход (смотри выше). +// * ВыполнятьНаСервере - Неопределено +// - Булево - (необязательный) - когда не указан или Неопределено, +// тогда выполнение будет определено автоматически: если есть сервер, то сначала +// на сервере, потом (при неудаче) на клиенте, потом сообщение о двух ошибках. +// Когда Истина: если разрешено выполнение на сервере, тогда выполнение +// только на сервере, при неудаче одно сообщение об ошибке на сервере. +// Когда Ложь: выполнение только на клиенте, как будто нет сервера. +// * ПараметрыДополнительныхДействий - Произвольный - (необязательный) - если указан, то передается +// на сервер в процедуру ПередНачаломОперации общего модуля. +// ЭлектроннаяПодписьПереопределяемый, как ВходныеПараметры. +// * КонтекстОперации - Неопределено - (необязательный) - если указан, тогда в свойство будет +// установлено определенное значение произвольного типа, которое позволяет +// выполнить действие с тем же сертификатом повторно (у пользователя +// не запрашивается ни пароль, ни подтверждение действия). +// В случае ошибки после вызова процедуры, повторное действие, выполненное +// с полученным контекстом, может быть также ошибочно. +// - Произвольный - (необязательный) - если определено, то действие будет выполнено +// с тем же сертификатом без запроса пароля или подтверждения. +// Параметр БезПодтверждения считается равным Истина. +// Параметры Операция, ЗаголовокДанных, ОтборСертификатов, ЭтоАутентификация +// и ВыполнятьНаСервере игнорируются, их значения остаются такими же, как при первом вызове. +// Параметр ПараметрыДополнительныхДействий игнорируется. +// Процедура ПередНачаломОперации не вызывается. +// Если передать контекст, возвращенный процедурой Подписать, тогда +// пароль, введенный для сертификата, может быть использован, как если бы +// пароль был сохранен на время сеанса. В остальном контекст игнорируется. +// * ПрекратитьВыполнение - Произвольный - если свойство существует и в процессе асинхронного выполнения возникает +// ошибка, выполнение прекращается без отображения формы операции или с закрытием этой формы, +// если она была открыта. +// +// Вариант 1. +// * Данные - ДвоичныеДанные - данные для расшифровки. +// - Строка - адрес временного хранилища, содержащего двоичные данные. +// - ОписаниеОповещения - обработчик получения данных, который возвращает +// их в свойстве Данные (смотри выше общий подход). В момент вызова +// в ОписаниеДанных уже вставлен параметр ВыбранныйСертификат (смотри ниже). +// * РазмещениеРезультата - Неопределено - (необязательный) - описывает, куда поместить расшифрованные данные. +// Если не указан или Неопределено, тогда через параметр ОбработкаРезультата. +// - ОписаниеОповещения - обработчик сохранения расшифрованных данных. +// Следует учесть общий подход (смотри выше). +// В момент вызова в ОписаниеДанных уже вставлен параметр РасшифрованныеДанные. +// В случае параметра НаборДанных, в ОписаниеДанных вставляется +// свойство ТекущийЭлементНабораДанных, содержащее параметр РасшифрованныеДанные. +// * Объект - ЛюбаяСсылка - (необязательный) - ссылка на объект, который необходимо расшифровать, +// а также очистить записи из регистра сведений СертификатыШифрования +// после успешного завершения расшифровки. +// Если не указан, то сертификаты не требуется получать из объекта и очищать. +// - Строка - адрес временного хранилища, содержащий +// ## Массив из Структура - массив сертификатов шифрования +// ### Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// ### Представление - Строка - сохраненное представление субъекта, +// полученное из двоичных данных сертификата. +// ### Сертификат - ДвоичныеДанные - содержит выгрузку сертификата, +// который использовался для шифрования. +// * Представление - ЛюбаяСсылка - (необязательный), если параметр не указан, +// тогда представление вычисляется по значению свойства Объект. +// - Строка +// - Структура: +// ** Значение - ЛюбаяСсылка +// - ОписаниеОповещения - для открытия. +// ** Представление - Строка - представление значения. +// +// Вариант 2. +// * НаборДанных - Массив - структуры со свойствами, описанными в Варианте 1. +// * ПредставлениеНабора - Строка - представления нескольких элементов набора данных, например, "Файлы (%1)". +// В это представление в параметр %1 заполняется количество элементов. +// По гиперссылке можно открыть список. +// Если в наборе данных 1 элемент, тогда используется значение +// в свойстве Представление свойства НаборДанных, если не указано, тогда +// представление вычисляется по значению свойства Объект элемента набора данных. +// * СписокПредставлений - СписокЗначений +// - Массив - (необязательный) - произвольный список элементов +// или массив со значениями, как у свойства Представление, которые +// сможет открыть пользователь. Если не указан, то заполняется из +// свойств Представление или Объект в свойстве НаборДанных. +// * СертификатыШифрования - Массив - (необязательный) значения, как у параметра Объект. Используется +// для извлечения списков сертификатов шифрования для элементов, указанных +// в параметре СписокПредставлений (порядок должен соответствовать). +// Когда указан, параметр Объект не используется. +// +// Форма - ФормаКлиентскогоПриложения - форма, из которой нужно получить уникальный идентификатор, который будет +// использоваться при помещении расшифрованных данных во временное хранилище. +// - УникальныйИдентификатор - уникальный идентификатор, который будет использоваться +// при помещении расшифрованных данных во временное хранилище. +// - Неопределено - использовать стандартную форму. +// +// ОбработкаРезультата - ОписаниеОповещения - +// Требуется для нестандартной обработки результата, если не указан параметр Форма и/или РазмещениеРезультата. +// В результат передается входной параметр ОписаниеДанных, который в успешном случае, дополняется свойствами: +// # Успех - Булево - Истина, если все прошло успешно. Если Успех = Ложь, то частичное завершение +// определяется по наличию свойства РасшифрованныеДанные. Если есть, то шаг выполнен. +// # Отказ - Булево - Истина, если пользователь отменил операцию интерактивно. +// # ВыбранныйСертификат - Структура - содержит свойства сертификата: +// ## Ссылка - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - ссылка на сертификат. +// ## Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// ## Данные - Строка - адрес временного хранилища, содержащего двоичные данные сертификата. +// # РасшифрованныеДанные = ДвоичныеДанные - результат расшифровки. +// При передаче параметра НаборДанных, свойство нужно проверять в нем. +// = Строка - адрес временного хранилища, содержащего результат расшифровки. +// +Процедура Расшифровать(ОписаниеДанных, Форма = Неопределено, ОбработкаРезультата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.Расшифровать(ОписаниеДанных, Форма, ОбработкаРезультата); +``` +
+ +## УсовершенствоватьПодпись +
+ +Описание, пример вызова + +```bsl + +// Усовершенствует одну или несколько подписей до указанного типа. +// +// Параметры: +// ОписаниеДанных - Структура: +// * ТипПодписи - ПеречислениеСсылка.ТипыПодписиКриптографии - тип подписи, +// до которого требуется усовершенствование. Если фактический ТипПодписи +// тот же или выше, тогда никаких действий произведено не будет. +// * ДобавитьАрхивнуюМеткуВремени - Булево - если указано Истина и ТипПодписи указан архивная, +// и фактический ТипПодписи архивная, тогда будет добавлена метка времени. +// +// * Подпись - ДвоичныеДанные - данные подписи. +// - Строка - адрес временного хранилища, содержащего двоичные данные. +// - Структура: +// ** ПодписанныйОбъект - ЛюбаяСсылка - ссылка на объект, подписи которого нужно усовершенствовать. +// ** ПорядковыйНомер - Число - порядковый номер подписи. +// - Массив - значения указанного выше типа. +// - Неопределено - все подписи объекта. +// ** Подпись - ДвоичныеДанные - (необязательный) данные подписи, если порядковый номер +// подписи - число +// - Строка - адрес временного хранилища, содержащего двоичные данные подписи, +// если порядковый номер подписи - число. +// - Массив из ДвоичныеДанные. +// - Массив из Строка - как для строки указанной выше. +// - Массив из Структура - как структура, указанная выше. +// +// * Представление - ЛюбаяСсылка - (необязательный), если параметр не указан, +// тогда представление вычисляется по значению свойств Объект и ПорядковыйНомер. +// - Строка +// - Структура: +// ** Значение - ЛюбаяСсылка +// - ОписаниеОповещения - для открытия. +// ** Представление - Строка - представление значения. +// - СписокЗначений +// - Массив - (необязательный) - произвольный список элементов +// или массив со значениями, как у описано выше, которые +// сможет открыть пользователь. Если не указан, то заполняется из +// свойств свойств Объект и ПорядковыйНомер. +// +// Форма - ФормаКлиентскогоПриложения - форма, из которой нужно получить уникальный идентификатор, +// который будет использоваться при блокировке объекта. +// - УникальныйИдентификатор - уникальный идентификатор, который будет +// использоваться при блокировке объекта. +// +// ПрерыватьОбработкуМассиваПриОшибке - Булево - по умолчанию Истина - при ошибке обработка следующих элементов будет прервана. +// ИгнорироватьСрокДействияСертификата - Булево - по умолчанию Ложь - не проверять срок действия сертификата подписи +// перед усовершенствованием. +// +// ОбработкаРезультата - ОписаниеОповещения - +// Требуется для нестандартной обработки результата, например, если не указана ссылка на объект и порядковый номер подписи. +// Структура: +// # Успех = Булево - Истина, если все прошло успешно. Если Успех = Ложь, то частичное завершение +// определяется по наличию свойства СвойстваПодписи. Если есть, то шаг выполнен. +// # ТекстОшибки = Строка +// # СвойстваПодписей = Массив из Структура - +// ## Подпись = ДвоичныеДанные - Подпись, которую надо усовершенствовать. +// = Строка - адрес во временном хранилище. +// ## ПодписанныйОбъект - ЛюбаяСсылка - если есть. +// ## ПорядковыйНомер - Число - если есть. +// ## ТипПодписи - ПеречислениеСсылка.ТипыПодписиКриптографии - тип подписи, +// если подпись не удалось усовершенствовать, но удалось определить тип. +// ## СрокДействияПоследнейМеткиВремени - Дата - срок действия, +// если подпись не удалось усовершенствовать, но удалось определить срок действия. +// ## СвойстваПодписи = см. ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи - +// свойства усовершенствованной подписи (заполнены только изменившиеся). +// ## Ошибка = Строка - текст ошибки при попытке усовершенствования. Если произошла ошибка, +// то структура не будет содержать свойств подписи, которую не удалось усовершенствовать. +// = Строка - адрес временного хранилища, содержащего массив указанный выше. +// +Процедура УсовершенствоватьПодпись(ОписаниеДанных, Форма, ОбработкаРезультата = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.УсовершенствоватьПодпись(ОписаниеДанных, Форма, ОбработкаРезультата, ); +``` +
+ +## ПроверитьСертификат +
+ +Описание, пример вызова + +```bsl + +// Проверяет действительность сертификата криптографии. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение о результате выполнения следующих типов +// = Булево - Истина, если проверка выполнена успешно. +// = Строка - описание ошибки проверки сертификата. +// = Неопределено - не удалось получить менеджер криптографии (когда не указан). +// +// Сертификат - СертификатКриптографии - сертификат. +// - ДвоичныеДанные - двоичные данные сертификата. +// - Строка - адрес временного хранилища, содержащего двоичные данные сертификата. +// +// МенеджерКриптографии - Неопределено - получить менеджер криптографии автоматически. +// - МенеджерКриптографии - использовать указанный менеджер криптографии +// (проверка на сервере не будет выполнена). +// +// НаДату - Дата - проверить сертификат на указанную дату в часовом поясе информационной базы. +// Если параметр не указан или указана пустая дата, +// тогда проверять на текущую дату сеанса. +// ПараметрыПроверки - см. ПараметрыПроверкиСертификата. +// +Процедура ПроверитьСертификат(Оповещение, Сертификат, МенеджерКриптографии = Неопределено, НаДату = Неопределено, ПараметрыПроверки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.ПроверитьСертификат(Оповещение, Сертификат, МенеджерКриптографии, НаДату, ПараметрыПроверки); +``` +
+ +## ПараметрыПроверкиСертификата +
+ +Описание, пример вызова + +```bsl + +// Дополнительные параметры проверки сертификата. +// +// Возвращаемое значение: +// Структура - дополнительные параметры проверки сертификата: +// * ВыполнятьПроверкуУдостоверяющегоЦентра - Строка - режим проверки квалифицированности ЭП: +// "ПроверятьКвалифицированные" - (по умолчанию) разрешать подписывать НЭП и проверять КЭП на действительность +// с учетом списка разрешенных неаккредитованных УЦ. +// "ТолькоКвалифицированные" - разрешать подписывать только КЭП и не учитывать список разрешенных +// неаккредитованных УЦ. +// "НеПроверятьСертификат" - не выполнять проверку удостоверяющего центра сертификата. +// * ИгнорироватьПроверкуВСпискеОтозванныхСертификатов - Булево - не проверять сертификат в списке отзыва. +// * УказанаДатаМеткиВремени - Булево - в параметре НаДату указана дата, на которую будет выполнена проверка отзыва и +// цепочки сертификатов. +// +Функция ПараметрыПроверкиСертификата() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПараметрыПроверкиСертификата() +``` +
+ +## ПроверитьСертификатСправочника +
+ +Описание, пример вызова + +```bsl + +// Открывает форму ПроверкаСертификата и возвращает результат проверки. +// +// Параметры: +// Сертификат - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - проверяемый сертификат. +// +// ДополнительныеПараметры - Неопределено - обычная проверка сертификата. +// - Структура - с необязательными свойствами: +// * ВладелецФормы - ФормаКлиентскогоПриложения - другая форма. +// * ЗаголовокФормы - Строка - если указан, тогда заменяет заголовок формы. +// * ПроверкаПриВыборе - Булево - если Истина, тогда кнопка Проверить будет называться +// "Проверить и продолжить", а кнопка Закрыть будет называться "Отмена". +// * ОбработкаРезультата - ОписаниеОповещения - вызывается сразу после проверки, в процедуру +// передается Результат.ПроверкиПройдены (смотри ниже) с начальным значением Ложь. +// В режиме ПроверкаПриВыборе, если не установить Истина, +// форма не будет закрыта после возврата из процедуры оповещения и +// будет показано предупреждение о невозможности продолжения. +// * БезПодтверждения - Булево - если установить Истина, тогда при наличии пароля +// проверка будет выполнена сразу без открытия формы. +// Если режим ПроверкаПриВыборе и установлен параметр ОбработкаРезультата, то +// форма не будет открыта, если параметр ПроверкиПройдены установлен Истина. +// * ОбработкаЗавершения - ОписаниеОповещения - вызывается при закрытии формы, в качестве результата +// передается Неопределено или значение ПроверкиПройдены (смотри ниже). +// * КонтекстОперации - Произвольный - если передать контекст, возвращенный процедурами Подписать, +// Расшифровать и т.д., пароль, введенный для сертификата, может быть использован, +// как если бы он был сохранен на время сеанса. +// При повторном вызове параметр БезПодтверждения считается равным Истина. +// * НеПоказыватьРезультаты - Булево - если параметр принимает значение Истина и параметр КонтекстОперации +// содержит контекст предыдущей операции, результаты проверки не будут показаны +// пользователю. +// * ТипПодписи - ПеречислениеСсылка.ТипыПодписиКриптографии - по умолчанию тип, указанный в настройках, +// если передан КонтекстОперации, возвращенный процедурой Подписать, то тип берется из него. +// * ВыполнятьПроверкуУдостоверяющегоЦентра - см. ПараметрыПроверкиСертификата.ВыполнятьПроверкуУдостоверяющегоЦентра +// * ИгнорироватьПроверкуВСпискеОтозванныхСертификатов - см. ПараметрыПроверкиСертификата.ИгнорироватьПроверкуВСпискеОтозванныхСертификатов +// * Результат - Неопределено - проверка ни разу не выполнялась. +// - Структура - возвращаемое значение. Вставляется перед обработкой результата: +// * ПроверкиПройдены - Булево - возвращаемое значение. Устанавливается в процедуре параметра ОбработкаРезультата. +// * ПроверкиНаСервере - Неопределено - проверка не выполнялась на сервере: +// - Структура - со свойствами, как в следующем параметре. +// * ПроверкиНаКлиенте - Структура: +// * НаличиеСертификата - Булево +// - Неопределено - если Истина, тогда проверка прошла успешно, +// если Ложь - проверка прошла не успешно, если Неопределено - не выполнялась. +// Если стандартные проверки скрыты в процедуре ПриСозданииФормыПроверкаСертификата, +// общего модуля ЭлектроннаяПодписьПереопределяемый, тогда свойства нет. +// * ДанныеСертификата - Булево +// - Неопределено - так же, как указано выше. +// * НаличиеПрограммы - Булево +// - Неопределено - так же, как указано выше. +// * Подписание - Булево +// - Неопределено - так же, как указано выше. +// * ПроверкаПодписи - Булево +// - Неопределено - так же, как указано выше. +// * Шифрование - Булево +// - Неопределено - так же, как указано выше. +// * Расшифровка - Булево +// - Неопределено - так же, как указано выше. +// <Имя дополнительной проверки> имя дополнительной проверки, определенной +// в общем модуле ПриСозданииФормыПроверкаСертификата +// с типами, как указано выше. +// <Имя дополнительной проверки>Ошибка имя дополнительной проверки с окончанием Ошибка и +// типом Строка (содержит текст ошибки, если проверка имеет значение Ложь). +// +// * ПараметрыДополнительныхПроверок - Произвольный - параметры, которые передаются в процедуру +// ПриСозданииФормыПроверкаСертификата общего модуля ЭлектроннаяПодписьПереопределяемый. +// +Процедура ПроверитьСертификатСправочника(Сертификат, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.ПроверитьСертификатСправочника(Сертификат, ДополнительныеПараметры); +``` +
+ +## УстановитьРасширение +
+ +Описание, пример вызова + +```bsl + +// Показывает диалог установки расширения для работы с электронной подписью и шифрованием. +// Только для работы через средства платформы (МенеджерКриптографии). +// +// Параметры: +// БезВопроса - Булево - если указано Истина, тогда вопроса показано не будет. +// Требуется, если пользователь нажал на кнопку Установить расширение. +// +// ОбработчикРезультата - ОписаниеОповещения - описание процедуры, принимающей результат выбора +// РасширениеУстановлено типов: +// = Булево +// Истина - Пользователь подтвердил установку, после установки расширение было успешно подключено. +// Ложь - Пользователь подтвердил установку, однако после установки расширение не удалось подключить. +// = Неопределено - Пользователь отказался от установки. +// +// ТекстВопроса - Строка - текст вопроса. +// ЗаголовокВопроса - Строка - заголовок вопроса. +// +// +Процедура УстановитьРасширение(БезВопроса, ОбработчикРезультата = Неопределено, ТекстВопроса = "", ЗаголовокВопроса = "") Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.УстановитьРасширение(БезВопроса, ОбработчикРезультата, ТекстВопроса, ЗаголовокВопроса); +``` +
+ +## ОткрытьНастройкиЭлектроннойПодписиИШифрования +
+ +Описание, пример вызова + +```bsl + +// Открывает или активизирует форму настроек электронной подписи и шифрования. +// +// Параметры: +// Страница - Строка - допустимы строки "Сертификаты", "Настройки", "Программы". +// +Процедура ОткрытьНастройкиЭлектроннойПодписиИШифрования(Страница = "Сертификаты") Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.ОткрытьНастройкиЭлектроннойПодписиИШифрования(Страница); +``` +
+ +## ОткрытьФормуРасширенногоПредставленияОшибки +
+ +Описание, пример вызова + +```bsl + +// Открывает форму диагностики с причинами и вариантами решения известных проблем при работе с электронной подписью. +// Эти рекомендации автоматически загружаются из классификатора через Интернет. Также в форме можно отправить информацию +// в службу технической поддержки. Рекомендуется вызывать эту функцию вместо вывода пользователю технологического +// сообщения об ошибке во всех случаях после неуспешной операции с электронной подписью. +// +// Параметры: +// ПараметрыФормы - см. ПараметрыФормыРасширенногоПредставленияОшибки. +// ФормаВладелец - ФормаКлиентскогоПриложения - владелец формы. +// ОповещениеОЗавершении - ОписаниеОповещения - оповещение о закрытии формы ошибки. +// +// Пример: +// ПараметрыФормы = ПараметрыФормыРасширенногоПредставленияОшибки(); +// ПараметрыФормы.ЗаголовокПредупреждения = НСтр("ru = 'Не удалось выполнить рассылку отчетов'"); +// ПараметрыФормы.ТекстОшибкиСервер = ТекстОшибкиШифрованияНаСервере; +// ПараметрыФормы.ДополнительныеДанные.Вставить("Сертификат", Результат.СертификатДляШифрования); +// ПараметрыФормы.ПоказатьТребуетсяПомощь = Истина; +// ПараметрыФормы.ПоказатьИнструкцию = Истина; +// МодульЭлектроннаяПодписьКлиент = ОбщегоНазначенияКлиент.ОбщийМодуль("ЭлектроннаяПодписьКлиент"); +// МодульЭлектроннаяПодписьКлиент.ОткрытьФормуРасширенногоПредставленияОшибки(ПараметрыФормы); +// +Процедура ОткрытьФормуРасширенногоПредставленияОшибки(ПараметрыФормы, ФормаВладелец = Неопределено, ОповещениеОЗавершении = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.ОткрытьФормуРасширенногоПредставленияОшибки(ПараметрыФормы, ФормаВладелец, ОповещениеОЗавершении); +``` +
+ +## ПараметрыФормыРасширенногоПредставленияОшибки +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров формы расширенного представления ошибки. +// +// Возвращаемое значение: +// Структура - параметры формы расширенного представления ошибки: +// * ЗаголовокПредупреждения - Строка - заголовок формы ошибки. +// * ИнформацияДляПоддержки - ФорматированнаяСтрока - заголовок элемента для обращения в техподдержку. +// * ТекстОшибкиКлиент - Строка - текст, по которому будет производиться поиск причин и решений на клиенте, +// заполняется в случае, если важен контекст возникновения ошибки +// или текст общей ошибки, если она одна. +// * ТекстОшибкиСервер - Строка - текст, по которому будет производиться поиск причин и решений на сервере +// заполняется в случае, если важен контекст возникновения ошибки. +// * ДополнительныеДанные - Структура: +// ** ДанныеПодписи - Строка - (необязательный) адрес данных подписи во временном хранилище, если ошибка подписи. +// ** Сертификат - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - (необязательный) ссылка +// на сертификат, с которым связана ошибка. +// ** ДанныеСертификата - Строка - (необязательный) адрес данных сертификата во временном хранилище. +// * ПоказатьТребуетсяПомощь - Булево - показать группу Требуется помощь и кнопки установки расширения и настройки приложений. +// * ПоказатьПереходКНастройкеПрограмм - Булево - если ПоказатьТребуетсяПомощь = Истина, +// показать кнопку для перехода к настройке приложений для работы с электронной подписью. +// * ПоказатьУстановкуРасширения - Булево - если ПоказатьТребуетсяПомощь = Истина, +// показать кнопку для установки расширения криптографии. +// * ПоказатьИнструкцию - Булево - если ПоказатьТребуетсяПомощь = Истина, показывать гиперссылку Требуется помощь. +// * ТекстДополнительнойСсылки - Строка - заголовок дополнительной ссылки, по которой будет запускаться +// обработчик оповещения ОбработчикДополнительнойСсылки, с результатом типа Структура: +// # НавигационнаяСсылка - Строка - ссылка, указанная в ТекстДополнительнойСсылки. +// # ПараметрОбработчикаДополнительнойСсылки - описан ниже. +// * ОбработчикДополнительнойСсылки - Строка - имя обработчика оповещения из общего модуля, +// например, "ОбработкаНеисправностейБЭД.ОткрытьМастерДиагностики". +// * ПараметрОбработчикаДополнительнойСсылки - Произвольный - параметр обработчика ОбработчикДополнительнойСсылки. +// +Функция ПараметрыФормыРасширенногоПредставленияОшибки() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПараметрыФормыРасширенногоПредставленияОшибки() +``` +
+ +## ОткрытьИнструкциюПоРаботеСПрограммами +
+ +Описание, пример вызова + +```bsl + +// Открывает ссылку на раздел ИТС "Инструкции по работе с программами электронной подписи и шифрования". +// +Процедура ОткрытьИнструкциюПоРаботеСПрограммами() Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.ОткрытьИнструкциюПоРаботеСПрограммами() +``` +
+ +## ДатаПодписания +
+ +Описание, пример вызова + +```bsl + +// Возвращает дату, извлеченную из двоичных данных подписи, или Неопределено. +// +// Параметры: +// Оповещение - ОписаниеОповещения - вызывается для передачи возвращаемого значения типов: +// = Дата - успешно извлеченная дата подписи, +// = Неопределено - не удалось извлечь дату из данных подписи. +// Подпись - ДвоичныеДанные - данные подписи, из которых нужно извлечь дату. +// ПривестиКЧасовомуПоясуСеанса - Булево - привести универсальное время к времени сеанса. +// +Процедура ДатаПодписания(Оповещение, Подпись, ПривестиКЧасовомуПоясуСеанса = Истина) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.ДатаПодписания(Оповещение, Подпись, ПривестиКЧасовомуПоясуСеанса); +``` +
+ +## ПредставлениеСертификата +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление сертификата в справочнике, формируемое +// из представления субъекта (КомуВыдан) и срока действия сертификата. +// +// Параметры: +// Сертификат - СертификатКриптографии - сертификат криптографии. +// - Структура: +// * ДействителенДо - см. ЭлектроннаяПодпись.СвойстваСертификата.ДействителенДо +// * Сертификат - СертификатКриптографии - сертификат криптографии. +// +// Возвращаемое значение: +// Строка - представление сертификата в справочнике. +// +Функция ПредставлениеСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПредставлениеСертификата(Сертификат) +``` +
+ +## ПредставлениеСубъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление субъекта сертификата (КомуВыдан). +// +// Параметры: +// Сертификат - СертификатКриптографии - сертификат криптографии. +// +// Возвращаемое значение: +// Строка - представление субъекта в формате "Фамилия Имя, Организация, Подразделение, Должность". +// Если ФИО не удалось определить, тогда оно заменяется на ОбщееИмя. +// Организация, Подразделение и Должность могут отсутствовать, если не указаны или +// их не удалось определить. +// +Функция ПредставлениеСубъекта(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПредставлениеСубъекта(Сертификат) +``` +
+ +## ПредставлениеИздателя +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление издателя сертификата (КемВыдан). +// +// Параметры: +// Сертификат - СертификатКриптографии - сертификат криптографии. +// +// Возвращаемое значение: +// Строка - представление издателя в формате "ОбщееИмя, Организация, Подразделение", +// Организация и Подразделение могут отсутствовать, если не указаны. +// +Функция ПредставлениеИздателя(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПредставлениеИздателя(Сертификат) +``` +
+ +## СвойстваСертификата +
+ +Описание, пример вызова + +```bsl + +// Возвращает основные свойства сертификата в виде структуры. +// +// Параметры: +// Сертификат - СертификатКриптографии - сертификат криптографии. +// +// Возвращаемое значение: +// Структура: +// * Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// * СерийныйНомер - ДвоичныеДанные - свойство сертификата СерийныйНомер. +// * Представление - см. ЭлектроннаяПодписьКлиент.ПредставлениеСертификата. +// * КомуВыдан - см. ЭлектроннаяПодписьКлиент.ПредставлениеСубъекта. +// * КемВыдан - см. ЭлектроннаяПодписьКлиент.ПредставлениеИздателя. +// * ДатаНачала - Дата - свойство сертификата ДатаНачала в часовом поясе сеанса. +// * ДатаОкончания - Дата - свойство сертификата ДатаОкончания в часовом поясе сеанса. +// * Назначение - Строка - описание расширенного свойства сертификата EKU. +// * Подписание - Булево - свойство сертификата ИспользоватьДляПодписи. +// * Шифрование - Булево - свойство сертификата ИспользоватьДляШифрования. +// На платформах 8.3.27 и выше структура содержит свойства: +// * ДействителенДо - Дата - минимальная дата из ДатаОкончания и ДатаОкончанияЗакрытогоКлюча (если указана в сертификате). +// * ДатаНачалаЗакрытогоКлюча - Дата - свойство сертификата, указанное в OID 2.5.29.16 в часовом поясе сеанса. +// * ДатаОкончанияЗакрытогоКлюча - Дата - свойство сертификата, указанное в OID 2.5.29.16 в часовом поясе сеанса. +// * ИдентификаторКлючаУдостоверяющегоЦентра - Строка - идентификатор ключа издателя. +// * АлгоритмПодписи - Строка - OID алгоритма подписи сертификата. +// * АлгоритмОткрытогоКлюча - Строка - OID алгоритма открытого ключа сертификата. +// * АдресаСписковОтзыва - Массив из Строка +// +Функция СвойстваСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.СвойстваСертификата(Сертификат) +``` +
+ +## СвойстваСубъектаСертификата +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства субъекта сертификата криптографии. +// +// Параметры: +// Сертификат - СертификатКриптографии - для которого нужно вернуть свойства субъекта. +// +// Возвращаемое значение: +// Структура - со свойствами, состав которых зависит от национальной специфики. Пример для Российской Федерации: +// * ОбщееИмя - Строка - (64) - извлекается из поля CN. +// ЮЛ - в зависимости от типа конечного владельца СКПЭП +// а) наименование организации; +// б) название автоматизированной системы; +// в) другое отображаемое имя по требованиям информационной системы. +// ФЛ - ФИО. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Страна - Строка - (2) - извлекается из поля C - двухсимвольный код страны +// согласно ИСО 3166-1:1997 (ГОСТ 7.67-2003). +// - Неопределено - свойство сертификата не существует. +// +// * Регион - Строка - (128) - извлекается из поля S - наименование субъекта РФ. +// ЮЛ - по адресу местонахождения. +// ФЛ - по адресу регистрации. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * НаселенныйПункт - Строка - (128) - извлекается из поля L - наименование населенного пункта. +// ЮЛ - по адресу местонахождения. +// ФЛ - по адресу регистрации. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Улица - Строка - (128) - извлекается из поля Street - наименование улицы, дома, офиса. +// ЮЛ - по адресу местонахождения. +// ФЛ - по адресу регистрации. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Организация - Строка - (64) - извлекается из поля O. +// ЮЛ - полное или сокращенное наименование организации. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Подразделение - Строка - (64) - извлекается из поля OU. +// ЮЛ - в случае выпуска СКПЭП на должностное лицо - подразделение организации. +// Подразделение - это территориальная структурная единица крупной организации, +// которое обычно не заполняется в сертификате. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * ЭлектроннаяПочта - Строка - (128) - извлекается из поля E - адрес электронной почты. +// ЮЛ - адрес электронной почты должностного лица. +// ФЛ - адрес электронной почты физического лица. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Должность - Строка - (64) - извлекается из поля T. +// ЮЛ - в случае выпуска СКПЭП на должностное лицо - его должность. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * ОГРН - Строка - (13) - извлекается из поля OGRN. +// ЮЛ - ОГРН организации. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * ОГРНИП - Строка - (15) - извлекается из поля OGRNIP. +// ИП - ОГРН индивидуального предпринимателя. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * СНИЛС - Строка - (11) - извлекается из поля SNILS. +// ФЛ - СНИЛС +// ЮЛ - не обязательно, в случае выпуска СКПЭП на должностное лицо - его СНИЛС. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * ИНН - Строка - (12) - извлекается из поля INN. +// ФЛ - ИНН. +// ИП - ИНН. +// ЮЛ - не обязательно, но может быть заполнен в старых сертификатах. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * ИННЮЛ - Строка - (10) - извлекается из поля INNLE. +// ЮЛ - обязательно, но может отсутствовать в старых сертификатах. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Фамилия - Строка - (64) - извлекается из поля SN, если заполнено. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Имя - Строка - (64) - извлекается из поля GN, если заполнено. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Отчество - Строка - (64) - извлекается из поля GN, если заполнено. +// - Неопределено - такое свойство сертификата отсутствует. +// +Функция СвойстваСубъектаСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.СвойстваСубъектаСертификата(Сертификат) +``` +
+ +## СвойстваИздателяСертификата +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства издателя сертификата криптографии. +// +// Параметры: +// Сертификат - СертификатКриптографии - для которого нужно вернуть свойства издателя. +// +// Возвращаемое значение: +// Структура - со свойствами, состав которых зависит от национальной специфики. +// Пример для Российской Федерации: +// * ОбщееИмя - Строка - (64) - извлекается из поля CN - псевдоним удостоверяющего центра. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Страна - Строка - (2) - извлекается из поля C - двухсимвольный код страны +// согласно ИСО 3166-1:1997 (ГОСТ 7.67-2003). +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Регион - Строка - (128) - извлекается из поля S - наименование субъекта РФ +// по адресу местонахождения ПАК УЦ. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * НаселенныйПункт - Строка - (128) - извлекается из поля L - наименование населенного пункта +// по адресу местонахождения ПАК УЦ. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Улица - Строка - (128) - извлекается из поля Street - наименование улицы, дома, офиса +// по адресу местонахождения ПАК УЦ. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Организация - Строка - (64) - извлекается из поля O - полное или сокращенное наименование организации. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * Подразделение - Строка - (64) - извлекается из поля OU - подразделение организации. +// Подразделение - это территориальная структурная единица крупной организации, +// которое обычно не заполняется в сертификате. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * ЭлектроннаяПочта - Строка - (128) - извлекается из поля E - адрес электронной почты удостоверяющего центра. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * ОГРН - Строка - (13) - извлекается из поля OGRN - ОГРН организации удостоверяющего центра. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * ИНН - Строка - (12) - извлекается из поля INN - ИНН организации удостоверяющего центра. +// ЮЛ - необязательно, но может присутствовать в старых сертификатах. +// - Неопределено - такое свойство сертификата отсутствует. +// +// * ИННЮЛ - Строка - (10) - извлекается из поля INNLE - ИНН организации удостоверяющего центра. +// ЮЛ - обязательно, но может отсутствовать в старых сертификатах. +// - Неопределено - такое свойство сертификата отсутствует. +// +Функция СвойстваИздателяСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.СвойстваИздателяСертификата(Сертификат) +``` +
+ +## КонвертXML +
+ +Описание, пример вызова + +```bsl + +// Возвращает шаблон формата XML, содержащий один стандартный элемент +// Signature (см. стандарт https://www.w3.org/TR/xmldsig-core1) +// с одним элементом Reference и заполненным атрибутом URI +// (ссылка на сообщение XML, которое будет подписано). +// +// Возвращаемый шаблон содержит параметры %SignatureMethod%, %DigestMethod%, +// %DigestValue%, %SignatureValue%, %BinarySecurityToken%, +// которые автоматически заполняются при подписании. +// Параметры %SignatureMethod% (алгоритм подписи в формате xml) и +// %DigestMethod% (алгоритм хеширования в формате xml) вычисляются по +// алгоритму открытого ключа сертификата, которым выполняется подписание, +// сначала по таблице, указанной в ПараметрыXMLDSig, затем +// если таблица не заполнена или соответствие не найдено, +// по внутренней таблице соответствия (рекомендуется). +// +// Поддерживаются также шаблоны с несколькими элементами Signature +// и несколькими элементами Reference. +// Подпись будет добавлена в первый найденный элемент Signature, не содержащий значение подписи. +// +// Поддерживаются алгоритмы подписания и хеширования ГОСТ 94…2012. +// Поддерживаются алгоритмы канонизации: +// Exclusive XML Canonicalization 1.0 +// HTTP://www.w3.org/2001/10/xml-exc-c14n# +// HTTP://www.w3.org/2001/10/xml-exc-c14n#WithComments +// Canonical XML 1.0 +// HTTP://www.w3.org/TR/2001/REC-xml-c14n-20010315 +// HTTP://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments +// Canonical XML 1.1 +// HTTP://www.w3.org/2006/12/xml-c14n11 +// HTTP://www.w3.org/2006/12/xml-c14n11#WithComments +// Enveloped signature (по факту игнорируется, так как +// не поддерживается пустой URI в элементе SignedInfo.Reference): +// HTTP://www.w3.org/2000/09/xmldsig#enveloped-signature +// СМЭВ рекомендации 3.5.0.1, "АЛГОРИТМ трансформации XML": +// urn://smev-gov-ru/xmldsig/transform +// +// Сертификат может быть указан в KeyInfo, как base64 значение: +// - либо в виде элемента X509Data.X509Certificate +// - либо в виде элемента KeyInfoReference.Reference или +// SecurityTokenReference.Reference с URI на элемент со значением. +// +// Параметры: +// Параметры - см. ЭлектроннаяПодписьКлиент.ПараметрыКонвертаXML +// - Неопределенно - использовать параметры по умолчанию. +// +// Возвращаемое значение: +// Строка +// +// Пример: +// ПараметрыКонверта = ЭлектроннаяПодписьКлиент.ПараметрыКонвертаXML(); +// ПараметрыКонверта.Вариант = "furs.mark.crpt.ru_v1"; +// ПараметрыКонверта.СообщениеXML = +// " +// | +// | 12345 +// | Стакан граненый +// | Стакан граненый. 250 мл. +// | 9.95 +// | +// | 840 +// | USD +// | $ +// | US dollar +// | 2 +// | +// | true +// | +// | "; +// +// КонвертXML = ЭлектроннаяПодписьКлиент.КонвертXML(Параметры); +// +Функция КонвертXML(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.КонвертXML(Параметры); +``` +
+ +## ПараметрыКонвертаXML +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры, которые можно задать для конверта XML. +// +// Возвращаемое значение: +// Структура: +// * Вариант - Строка - вариант типового шаблона XML для обмена с сервисом: +// "furs.mark.crpt.ru_v1" (начальное значение) или "dmdk.goznak.ru_v1". +// Возможны другие форматы, если удовлетворяют требованиям, +// указанным в описании функции КонвертXML. +// +// * СообщениеXML - Строка - сообщение в формате XML, которое вставлено в шаблон. +// Если не заполнено, остается параметр %MessageXML%. +// +Функция ПараметрыКонвертаXML() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПараметрыКонвертаXML() +``` +
+ +## ПараметрыXMLDSig +
+ +Описание, пример вызова + +```bsl + +// Формирует структуру свойств для настройки нестандартной обработки +// конверта XML и алгоритмов подписания и хеширования. +// +// Рекомендуется не заполнять параметры XPathSignedInfo и XPathПодписываемыйТег +// Параметр XPathSignedInfo вычисляется по алгоритмам канонизации, +// а параметр XPathПодписываемыйТег вычисляется по ссылке +// в атрибуте URI элемента SignedInfo.Reference конверта XML. +// Параметры оставлены для обратной совместимости. Если указаны, работает по-старому: +// не выполняется извлечение параметров из конверта XML и их контроль, при этом +// конверт должен содержать алгоритмы канонизации и иметь элементы +// размещения сертификата, как в варианте конверта "furs.mark.crpt.ru_v1". +// +// Не требуется заполнять алгоритмы для использования сертификатов +// с алгоритмами открытого ключа ГОСТ 94, ГОСТ 2001, ГОСТ 2012/256 и ГОСТ 2012/512. +// Алгоритмы подписания и хеширования вычисляются по алгоритму открытого ключа, +// извлекаемого из сертификата, которым выполняется подписание. Сначала +// по переданной таблице, затем если таблица не заполнена или соответствие +// не найдено, по внутренней таблице соответствия (рекомендуется). +// +// Возвращаемое значение: +// Структура: +// * XPathSignedInfo - Строка - по умолчанию: "(//. | //@* | //namespace::*)[ancestor-or-self::*[local-name()='SignedInfo']]". +// * XPathПодписываемыйТег - Строка - по умолчанию: "(//. | //@* | //namespace::*)[ancestor-or-self::soap:Body]". +// +// * OIDАлгоритмаОткрытогоКлюча - Строка - например, "1.2.643.2.2.19" + Символы.ПС + "1.2.643.7.1.1.1.1" + ... +// * ИмяАлгоритмаПодписи - Строка - например, "GOST R 34.10-2001" + Символы.ПС + "GOST R 34.11-2012" + ... +// * OIDАлгоритмаПодписи - Строка - например, "1.2.643.2.2.3" + Символы.ПС + "1.2.643.7.1.1.3.2" + ... +// * ИмяАлгоритмаХеширования - Строка - например, "GOST R 34.11-94" + Символы.ПС + "GOST R 34.11-12" + ... +// * OIDАлгоритмаХеширования - Строка - например, "1.2.643.2.2.9" + Символы.ПС + "1.2.643.7.1.1.2.2" + ... +// * АлгоритмПодписи - Строка - например, "HTTP://www.w3.org/2001/04/xmldsig-more#gostr34102001-gostr3411" +// + Символы.ПС + +// "urn:ietf:params:xml:ns:cpxmlsec:algorithms:gostr34102012-gostr34112012-256" + ... +// * АлгоритмХеширования - Строка - например, "HTTP://www.w3.org/2001/04/xmldsig-more#gostr3411" +// + Символы.ПС + "urn:ietf:params:xml:ns:cpxmlsec:algorithms:gostr34112012-256" + ... +// +Функция ПараметрыXMLDSig() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПараметрыXMLDSig() +``` +
+ +## ПараметрыCMS +
+ +Описание, пример вызова + +```bsl + +// Формирует структуру свойств для подписания данных в формате CMS. +// +// Возвращаемое значение: +// Структура: +// * ТипПодписи - Строка - "CAdES-BES" - остальные варианты пока не используются. +// * Открепленная - Булево - Ложь (по умолчанию) - включать данные в контейнер подписи. +// Истина - не включать данные в контейнер подписи. +// * ВключениеСертификатовВПодпись - РежимВключенияСертификатовКриптографии - определяет длину цепочки +// сертификатов, включаемых в подпись. Значение ВключатьЦепочкуБезКорневого +// не поддерживается и считается равным значению ВключатьПолнуюЦепочку. +// +Функция ПараметрыCMS() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПараметрыCMS() +``` +
+ +## ПараметрыЗаписиСертификата +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для добавления сертификата +// в справочник СертификатыКлючейЭлектроннойПодписиИШифрования. +// Для использования в процедуре ЗаписатьСертификатВСправочник. +// +// Возвращаемое значение: +// Структура: +// * Наименование - Строка - представление сертификата в списке. +// Значение по умолчанию - "". +// * Пользователь - СправочникСсылка.Пользователи - пользователь, которому принадлежит сертификат. +// Значение используется при получении списка личных сертификатов пользователя +// в формах подписания и шифрования данных. +// Значение по умолчанию - Неопределено. +// * Организация - ОпределяемыйТип.Организация - организация, к которой относится сертификат. +// Значение по умолчанию - Неопределено. +// * ФизическоеЛицо - ОпределяемыйТип.ФизическоеЛицо - физическое лицо, к которому относится сертификат. +// Значение по умолчанию - Неопределено. +// * Программа - СправочникСсылка.ПрограммыЭлектроннойПодписиИШифрования - программа, которая +// требуется для подписания и расшифровки. +// Значение по умолчанию - Неопределено. +// * ВводитьПарольВПрограммеЭлектроннойПодписи - Булево - флажок "Вводить пароль в программе электронной подписи", +// требуется Истина, когда сертификат был установлен на компьютере с усиленной +// защитой закрытого ключа, которая означает поддержку только пустого пароля на +// уровне 1С:Предприятия (пароль у пользователя не запрашивается - это делает +// операционная система, которая не принимает от 1С:Предприятия непустой пароль). +// Значение по умолчанию - Ложь. +// +Функция ПараметрыЗаписиСертификата() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПараметрыЗаписиСертификата() +``` +
+ +## ЗаписатьСертификатВСправочник +
+ +Описание, пример вызова + +```bsl + +// Осуществляет проверку сертификата и, в случае успеха, добавляет новый или обновляет существующий сертификат +// в справочнике СертификатыКлючейЭлектроннойПодписиИШифрования. Если проверка не пройдена, показывает +// информацию о возникших ошибках. +// Для добавления сертификата на сервере смотри ЭлектроннаяПодпись.ЗаписатьСертификатВСправочник. +// +// Параметры: +// ОбработчикЗавершения - ОписаниеОповещения - вызывается после добавления сертификата +// для передачи возвращаемого значения типов: +// = Неопределено - при проверке или добавлении сертификата произошла ошибка. +// = СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - добавленный сертификат. +// Сертификат - ДвоичныеДанные - двоичные данные сертификата. +// - Строка - двоичные данные сертификата электронной подписи или +// адрес данных во временном хранилище. +// ПарольСертификата - Строка - пароль сертификата для проверки операций с закрытым ключом. +// ДляШифрования - Булево - определяет состав проверок, +// выполняемых перед добавлением сертификата. Если параметр принимает значение Истина, +// выполняется проверка шифрования и расшифровки, иначе - подписания и проверки подписи. +// ДополнительныеПараметры - Неопределено - без дополнительных параметров. +// - см. ПараметрыЗаписиСертификата +// +Процедура ЗаписатьСертификатВСправочник(ОбработчикЗавершения, Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.ЗаписатьСертификатВСправочник(ОбработчикЗавершения, ); +``` +
+ +## ПараметрыДобавленияСертификата +
+ +Описание, пример вызова + +```bsl + +// Инициализирует структуру параметров для интерактивного добавления сертификата. +// Если параметр СоздатьЗаявление - Истина и ИзЛичногоХранилища - Ложь, открывает новое заявление +// на выпуск сертификата. +// Если параметр СоздатьЗаявление - Ложь и ИзЛичногоХранилища - Истина, добавляет сертификат из +// личного хранилища. +// Если параметр СоздатьЗаявление - Истина и ИзЛичногоХранилища - Истина, открывает окно выбора +// способа добавления сертификата. +// Для использования в ЭлектроннаяПодписьКлиент.ДобавитьСертификат +// +// Возвращаемое значение: +// Структура: +// * ВЛичныйСписок - Булево - если параметр принимает значение Истина, то реквизит Пользователь +// будет заполнен текущим пользователем, иначе - реквизит не будет заполнен. +// Значение по умолчанию - Ложь. +// * Организация - ОпределяемыйТип.Организация - организация, к которой относится сертификат. +// Значение по умолчанию - Неопределено. +// В случае, когда параметр используется для создания заявления, тогда значение +// передается в процедуру ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат +// общего модуля ЗаявлениеНаСертификатПереопределяемый без изменения, а после вызова +// приводится к составу типов свойства ТипОрганизации. +// * СоздатьЗаявление - Булево - если параметр принимает значение Истина, добавляет возможность +// создать новое заявление на выпуск сертификата. +// Значение по умолчанию - Истина. +// * ИзЛичногоХранилища - Булево - если параметр принимает значение Истина, добавляет возможность +// выбрать сертификат из установленных в личном хранилище. +// Значение по умолчанию - Истина. +// * ФизическоеЛицо - СправочникСсылка - физическое лицо, для которого нужно создать заявление +// на выпуск сертификата (когда заполнено, имеет приоритет над организацией). +// Значение по умолчанию - Неопределено. +// Значение передается в процедуру ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат +// общего модуля ЗаявлениеНаСертификатПереопределяемый без изменения, а после вызова +// приводится к составу типов свойства ТипВладельца. +// * НаТокене - Булево - по умолчанию выбирать в заявлении на сертификат токен. +// +Функция ПараметрыДобавленияСертификата() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиент.ПараметрыДобавленияСертификата() +``` +
+ +## ДобавитьСертификат +
+ +Описание, пример вызова + +```bsl + +// Интерактивно добавляет сертификат из установленных на компьютере или создает заявление на выпуск сертификата. +// +// Параметры: +// ОбработчикЗавершения - ОписаниеОповещения - вызывается после добавления сертификата со значением одного из типов: +// = Неопределено - при проверке или добавлении сертификата произошла ошибка. +// = Структура: +// # Ссылка - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - добавленный сертификат. +// # Добавлен - Булево - признак того, что сертификат успешно добавлен. Если сертификат добавляется +// с помощью заявления на выпуск нового квалифицированного сертификата, признак принимает +// значение Ложь пока заявление не будет исполнено и сертификат не будет установлен на +// компьютере. +// ПараметрыДобавления - Неопределено - без дополнительных параметров. +// - см. ЭлектроннаяПодписьКлиент.ПараметрыДобавленияСертификата +// +// Пример: +// 1) Добавление сертификата из установленных в личном хранилище: +// ПараметрыДобавления = ЭлектроннаяПодписьКлиент.ПараметрыДобавленияСертификата(); +// ПараметрыДобавления.СоздатьЗаявление = Ложь; +// ЭлектроннаяПодписьКлиент.ДобавитьСертификат(, ПараметрыДобавления); +// +// 2) Создание заявления на выпуск сертификата: +// ПараметрыДобавления = ЭлектроннаяПодписьКлиент.ПараметрыДобавленияСертификата(); +// ПараметрыДобавления.ИзЛичногоХранилища = Ложь; +// ЭлектроннаяПодписьКлиент.ДобавитьСертификат(, ПараметрыДобавления); +// +// 3) Интерактивный выбор способа добавления сертификата: +// ЭлектроннаяПодписьКлиент.ДобавитьСертификат(); +// +Процедура ДобавитьСертификат(ОбработчикЗавершения = Неопределено, ПараметрыДобавления = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиент.ДобавитьСертификат(ОбработчикЗавершения, ПараметрыДобавления); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьКлиентЛокализация.md b/src/content/docs/bsp/ЭлектроннаяПодписьКлиентЛокализация.md new file mode 100644 index 0000000..7966749 --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьКлиентЛокализация.md @@ -0,0 +1,238 @@ +--- +title: Электронная подпись клиент локализация +slug: bsp/электронная-подпись-клиент-локализация +--- + + +## ПриОпределенииПолучателяОбращенияВТехническуюПоддержку +
+ +Описание, пример вызова + +```bsl + +// Код линии технической поддержки. +// +// Параметры: +// Получатель - Строка +// +Процедура ПриОпределенииПолучателяОбращенияВТехническуюПоддержку(Получатель) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентЛокализация.ПриОпределенииПолучателяОбращенияВТехническуюПоддержку(Получатель) +``` +
+ +## ПриПолученииФильтраДляВыбораПодписей +
+ +Описание, пример вызова + +```bsl + +// Фильтр для выбора подписей. +// +// Параметры: +// Фильтр - Строка +// +Процедура ПриПолученииФильтраДляВыбораПодписей(Фильтр) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентЛокализация.ПриПолученииФильтраДляВыбораПодписей(Фильтр) +``` +
+ +## ПриПолученииСпискаВыбораМашиночитаемыхДоверенностей +
+ +Описание, пример вызова + +```bsl + +// При получении списка выбора машиночитаемых доверенностей в форме добавления подписей из файла. +// +// Параметры: +// Форма - см. ОбщаяФорма.ДобавлениеЭлектроннойПодписиИзФайла +// ТекущиеДанные - ДанныеФормыЭлементКоллекции - строка подписи в форме ОбщаяФорма.ДобавлениеЭлектроннойПодписиИзФайла +// СписокВыбора - СписокЗначений +// +Процедура ПриПолученииСпискаВыбораМашиночитаемыхДоверенностей(Форма, ТекущиеДанные, СписокВыбора) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентЛокализация.ПриПолученииСпискаВыбораМашиночитаемыхДоверенностей(Форма, ТекущиеДанные, СписокВыбора) +``` +
+ +## ПриВыбореМашиночитаемойДоверенности +
+ +Описание, пример вызова + +```bsl + +// При выборе машиночитаемой доверенности в форме добавления подписей из файла. +// +// Параметры: +// ОбработчикЗавершения - ОписаниеОповещения +// ТекущиеДанные - ДанныеФормыЭлементКоллекции - строка подписи в форме ОбщаяФорма.ДобавлениеЭлектроннойПодписиИзФайла +// +Процедура ПриВыбореМашиночитаемойДоверенности(ОбработчикЗавершения, ТекущиеДанные) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентЛокализация.ПриВыбореМашиночитаемойДоверенности(ОбработчикЗавершения, ТекущиеДанные) +``` +
+ +## ПриОпределенииФайловМашиночитаемыхДоверенностей +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список сохраняемых файлы машиночитаемых доверенностей при сохранении подписей. +// +// Параметры: +// ФайлыМашиночитаемыхДоверенностей - Соответствие +// КоллекцияПодписей - ДанныеФормыКоллекция +// +Процедура ПриОпределенииФайловМашиночитаемыхДоверенностей(ФайлыМашиночитаемыхДоверенностей, Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентЛокализация.ПриОпределенииФайловМашиночитаемыхДоверенностей(ФайлыМашиночитаемыхДоверенностей, ); +``` +
+ +## ПриПроверкеКонфликтаПрограммКриптографии +
+ +Описание, пример вызова + +```bsl + +// При проверке конфликта программ криптографии. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// РезультатПроверки - Структура +// +Процедура ПриПроверкеКонфликтаПрограммКриптографии(Форма, РезультатПроверки) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентЛокализация.ПриПроверкеКонфликтаПрограммКриптографии(Форма, РезультатПроверки) +``` +
+ +## ПриПроверкеУстановленныхПрограммКриптографии +
+ +Описание, пример вызова + +```bsl + +// При проверке установленных программ криптографии. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// РезультатПроверки - Структура +// ЕстьПроверяемыеПрограммы - Булево +// +Процедура ПриПроверкеУстановленныхПрограммКриптографии(Форма, РезультатПроверки, ЕстьПроверяемыеПрограммы) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентЛокализация.ПриПроверкеУстановленныхПрограммКриптографии(Форма, РезультатПроверки, ЕстьПроверяемыеПрограммы) +``` +
+ +## ЭтоОшибкаНеправильныйПинКод +
+ +Описание, пример вызова + +```bsl + +// Текст ошибки содержит информацию, что введен неправильный пин-код токена. +// +// Параметры: +// ТекстОшибки - Строка - текст ошибки +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоОшибкаНеправильныйПинКод(ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентЛокализация.ЭтоОшибкаНеправильныйПинКод(ТекстОшибки) +``` +
+ +## ПриОткрытииФормыУстановкиПрограммКриптопровайдеров +
+ +Описание, пример вызова + +```bsl + +// Открывает форму установки программ криптопровайдеров. +// +// Параметры: +// Параметры - Структура +// Владелец - ФормаКлиентскогоПриложения +// Оповещение - ОписаниеОповещения +// СтандартнаяОбработка - Булево +// +Процедура ПриОткрытииФормыУстановкиПрограммКриптопровайдеров(Параметры, Владелец, Оповещение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентЛокализация.ПриОткрытииФормыУстановкиПрограммКриптопровайдеров(Параметры, Владелец, Оповещение, СтандартнаяОбработка) +``` +
+ +## ПриПроверкеУстановкиПрограммКриптографии +
+ +Описание, пример вызова + +```bsl + +// Только для внутреннего использования. +// Проверяет установку программ криптографии в рамках проверки установки компонент для работы с электронной подписью. +// +// Параметры: +// Результат - Булево - если Истина, то требуется установка дополнительных компонент. +// Компоненты - см. ЭлектроннаяПодписьСлужебныйКлиент.НовыйКомпонентыРаботыСКриптографией. +// +Процедура ПриПроверкеУстановкиПрограммКриптографии(Результат, Компоненты) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентЛокализация.ПриПроверкеУстановкиПрограммКриптографии(Результат, Компоненты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьКлиентПереопределяемый.md b/src/content/docs/bsp/ЭлектроннаяПодписьКлиентПереопределяемый.md new file mode 100644 index 0000000..a76b752 --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьКлиентПереопределяемый.md @@ -0,0 +1,138 @@ +--- +title: Электронная подпись клиент переопределяемый +slug: bsp/электронная-подпись-клиент-переопределяемый +--- + + +## ПередНачаломОперации +
+ +Описание, пример вызова + +```bsl + +// Вызывается после создания на сервере, но до открытия форм ПодписаниеДанных, РасшифровкаДанных. +// Используется для дополнительных действий, которые требуют серверного вызова, чтобы не +// вызывать сервер лишний раз. +// +// Параметры: +// Операция - Строка - строка Подписание или Расшифровка. +// +// ВходныеПараметры - Произвольный - значение свойства ПараметрыДополнительныхДействий +// параметра ОписаниеДанных методов Подписать, Расшифровать общего +// модуля ЭлектроннаяПодписьКлиент. +// +// ВыходныеПараметры - Произвольный - произвольные данные, которые были возвращены +// с сервера из одноименной процедуры общего модуля. +// ЭлектроннаяПодписьПереопределяемый. +// +Процедура ПередНачаломОперации(Операция, ВходныеПараметры, ВыходныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентПереопределяемый.ПередНачаломОперации(Операция, ВходныеПараметры, ВыходныеПараметры) +``` +
+ +## ПриДополнительнойПроверкеСертификата +
+ +Описание, пример вызова + +```bsl + +// Вызывается из формы ПроверкаСертификата, если при создании формы были добавлены дополнительные проверки. +// +// Параметры: +// Параметры - Структура: +// * ОжидатьПродолжения - Булево - возвращаемое значение. Если Истина, тогда дополнительная проверка +// будет выполнятся асинхронно, продолжение возобновится после выполнения оповещения. +// Начальное значение Ложь. +// * Оповещение - ОписаниеОповещения - обработка, которую нужно вызывать для продолжения +// после асинхронного выполнения дополнительной проверки. +// * Сертификат - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - проверяемый сертификат. +// * Проверка - Строка - имя проверки, добавленное в процедуре ПриСозданииФормыПроверкаСертификата +// общего модуля ЭлектроннаяПодписьПереопределяемый. +// * МенеджерКриптографии - МенеджерКриптографии - подготовленный менеджер криптографии для +// выполнения проверки. +// - Неопределено - если стандартные проверки отключены в процедуре +// ПриСозданииФормыПроверкаСертификата общего модуля ЭлектроннаяПодписьПереопределяемый. +// * ОписаниеОшибки - Строка - возвращаемое значение. Описание ошибки, полученной при выполнении проверки. +// Это описание сможет увидеть пользователь при нажатии на картинку результата. +// * ЭтоПредупреждение - Булево - возвращаемое значение. Вид картинки Ошибка/Предупреждение, +// начальное значение - Ложь. +// * Пароль - Строка - пароль, введенный пользователем. +// - Неопределено - если свойство ВводитьПароль установлено в Ложь в процедуре +// ПриСозданииФормыПроверкаСертификата общего модуля ЭлектроннаяПодписьПереопределяемый. +// * РезультатыПроверок - Структура: +// * Ключ - Строка - имя стандартной или дополнительной проверки или имя ошибки. Ключ свойства, содержащего +// ошибку, содержит имя проверки с окончанием Ошибка. +// * Значение - Неопределено - проверка не выполнялась (ОписаниеОшибки осталось Неопределено). +// - Булево - результат выполнения дополнительной проверки. +// - Строка - когда ключ свойства содержит окончание Ошибка и результат выполненной проверки Ложь, +// содержит описание возникшей ошибки. +// +Процедура ПриДополнительнойПроверкеСертификата(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентПереопределяемый.ПриДополнительнойПроверкеСертификата(Параметры) +``` +
+ +## ПриОпределенииРазделаСтатьиНаИТС +
+ +Описание, пример вызова + +```bsl + +// Вызывается при открытии инструкции по работе с программами электронной подписи и шифрования. +// +// Параметры: +// Раздел - Строка - начальное значение "БухгалтерскийИНалоговыйУчет", +// можно указать "УчетВГосударственныхУчреждениях". +// +Процедура ПриОпределенииРазделаСтатьиНаИТС(Раздел) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентПереопределяемый.ПриОпределенииРазделаСтатьиНаИТС(Раздел) +``` +
+ +## ПослеДобавленияВСправочникСертификатовЭлектроннойПодписи +
+ +Описание, пример вызова + +```bsl + +// Вызывается после интерактивного добавления в справочник сертификатов электронной подписи. +// +// Параметры: +// Параметры - Структура: +// * Сертификаты - Массив из Структура: +// ** НовыйСертификат - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - добавленный сертификат. +// ** СтарыйСертификат - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования, Неопределено - найденный сертификат +// с аналогичными свойствами субъекта, подлежащий замене. +// +Процедура ПослеДобавленияВСправочникСертификатовЭлектроннойПодписи(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентПереопределяемый.ПослеДобавленияВСправочникСертификатовЭлектроннойПодписи(Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьКлиентСервер.md b/src/content/docs/bsp/ЭлектроннаяПодписьКлиентСервер.md new file mode 100644 index 0000000..47ef0d5 --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьКлиентСервер.md @@ -0,0 +1,371 @@ +--- +title: Электронная подпись клиент сервер +slug: bsp/электронная-подпись-клиент-сервер +--- + + +## НовыеСвойстваПодписи +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметра СвойстваПодписи для добавления и обновления данных электронной подписи. +// Содержит развернутое описание подписи. +// +// Возвращаемое значение: +// Структура: +// * Подпись - ДвоичныеДанные - результат подписания. +// - Строка - подписанный КонвертXML, если передавался в данных. +// * УстановившийПодпись - СправочникСсылка.Пользователи - пользователь, который +// подписал объект информационной базы. +// * Комментарий - Строка - комментарий, если он был введен при подписании. +// * ИмяФайлаПодписи - Строка - если подпись добавлена из файла. +// * ДатаПодписи - Дата - дата, когда подпись была сделана. Имеет смысл для случаев, +// когда дату невозможно извлечь из данных подписи. +// * ПропуститьПриПродлении - Булево - не подлежит усовершенствованию, например, +// достоверность обеспечивается оператором электронного документооборота. +// +// Используются при обновлении результата проверки подписи: +// * ДатаПроверкиПодписи - Дата - дата последней проверки подписи. +// * ПодписьВерна - Булево - результат последней проверки подписи. +// * ТребуетсяПроверка - Булево - не удалось проверить подпись. +// * ПодписьМатематическиВерна - Булево - вычисляется при проверке подписи без дополнительных атрибутов. +// * ОшибкаМатематическойПроверкиПодписи - Строка - ошибка при ПроверитьПодпись с флагом +// ПроверитьДополнительныеАтрибуты = Ложь +// * ОшибкаПроверкиДополнительныхАтрибутов - Строка - ошибка при проверке сертификата и атрибутов +// усовершенствованной подписи, таких как метка времени. +// * ДополнительныеАтрибутыПровереныВручную - Булево - признак ПодписьВерна в части доп. атрибутов установлен +// вручную (в случае ПодписьМатематическиВерна = Ложь - Исключение при ручной установке) +// * АвторРучнойПроверкиДополнительныхАтрибутов - СправочникСсылка.Пользователи +// * ОбоснованиеРучнойПроверкиДополнительныхАтрибутов - Строка - ссылка на организацию, подтвердившую достоверность +// подписи, например, Оператор ЭДО +// +// Используются при обновлении усовершенствованной подписи: +// * ПодписанныйОбъект - ОпределяемыйТип.ПодписанныйОбъект - объект, с которым связана подпись. +// Игнорируется в методах, в которые объект передается как параметр. +// * ПорядковыйНомер - Число - идентификатор подписи, по которому можно упорядочивать их в списке. +// Не заполнен, если подпись не связана с объектом. +// * ОшибкаПриАвтоматическомПродлении - Булево - не использовать, служебный, заполняется регламентным заданием. +// Используются для связи с машиночитаемой доверенностью: +// * ИдентификаторПодписи - УникальныйИдентификатор +// * РезультатПроверкиПодписиПоМЧД - Массив из Структура, Структура - МашиночитаемыеДоверенностиФНС.РезультатПроверкиПодписиПоМЧД +// +// Производные свойства подписи: +// * ТипПодписи - ПеречислениеСсылка.ТипыПодписиКриптографии +// * СрокДействияПоследнейМеткиВремени - Дата - срок действия сертификата, которым подписана +// последняя метка времени (или пустая дата, если нет метки времени), +// если удалось определить с помощью МенеджерКриптографии +// * Сертификат - ХранилищеЗначения - содержит выгрузку сертификата, +// который использовался для подписания (содержится в подписи). +// - ДвоичныеДанные +// * Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// * КомуВыданСертификат - Строка - представление субъекта, полученное из двоичных данных сертификата. +// * ОписаниеСертификата - Структура - свойство, требуемое для сертификатов, которые +// не могут быть переданы в метод платформы СертификатКриптографии, со свойствами: +// ** СерийныйНомер - Строка - серийный номер сертификата, как у объекта платформы СертификатКриптографии. +// ** КемВыдан - Строка - как возвращает функция ПредставлениеИздателя. +// ** КомуВыдан - Строка - как возвращает функция ПредставлениеСубъекта. +// ** ДатаНачала - Строка - дата сертификата, как у объекта платформы СертификатКриптографии в формате "ДЛФ=D". +// ** ДатаОкончания - Строка - дата сертификата, как у объекта платформы СертификатКриптографии в формате "ДЛФ=D". +// ** ДействителенДо - Строка - (необязательный) минимальная дата из дат окончания открытого и закрытого ключа +// (если указана в сертификате) в формате "ДЛФ=D". +// +Функция НовыеСвойстваПодписи() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.НовыеСвойстваПодписи() +``` +
+ +## РезультатПроверкиПодписи +
+ +Описание, пример вызова + +```bsl + +// Результат проверки подписи. +// +// Возвращаемое значение: +// Структура: +// * Результат - Булево - Истина, если проверка выполнена успешно. +// - Строка - описание ошибки проверки подписи. +// - Неопределено - не удалось получить менеджер криптографии (когда не указан). +// * ПодписьВерна - Булево, Неопределено - результат последней проверки подписи. +// * СертификатОтозван - Булево - ошибка связана с тем, что сертификат отозван. +// * ТребуетсяПроверка - Булево - не удалось проверить подпись. +// * ПодписьМатематическиВерна - Булево - вычисляется при проверке подписи без проверки сертификатов +// и атрибутов усовершенствованной подписи, таких как метка времени. +// * ОшибкаМатематическойПроверкиПодписи - Строка - ошибка при ПроверитьПодпись с флагом +// ПроверитьДополнительныеАтрибуты = Ложь +// * ОшибкаПроверкиДополнительныхАтрибутов - Строка - ошибка при проверке сертификата и атрибутов усовершенствованной +// подписи, таких как метка времени. +// * ПараметрыПроверкиСертификата - см. ЭлектроннаяПодписьКлиент.ПараметрыПроверкиПодписи.ПроверятьСертификат +// +// * ТипПодписи - ПеречислениеСсылка.ТипыПодписиКриптографии - не заполнен при проверке подписей конверта XML. +// * СрокДействияПоследнейМеткиВремени - Дата - срок действия сертификата, которым подписана +// последняя метка времени (или пустая дата, если нет метки времени), если удалось определить с помощью МенеджерКриптографии. +// * НеподтвержденнаяДатаПодписи - Дата - неподтвержденная дата подписи. +// - Неопределено - неподтвержденная дата подписи отсутствует в данных подписи и для +// конверта XML. +// * ДатаПодписиИзМетки - Дата - дата самой ранней метки времени. +// - Неопределено - метка времени отсутствует в данных подписи и при проверке конверта XML. +// * Сертификат - ДвоичныеДанные - сертификат подписанта +// * Отпечаток - Строка - отпечаток сертификата в формате строки Base64. +// * КомуВыданСертификат - Строка - представление субъекта, полученное из двоичных данных сертификата. +// +Функция РезультатПроверкиПодписи() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.РезультатПроверкиПодписи() +``` +
+ +## РезультатПроверкиПодписиВФорме +
+ +Описание, пример вызова + +```bsl + +// Конструктор для заполнения результата проверки подписи в форме. +// +// Возвращаемое значение: +// Структура - результат проверки подписи в форме: +// * ПорядковыйНомер - см. НовыеСвойстваПодписи.ПорядковыйНомер +// * Объект - см. НовыеСвойстваПодписи.ПодписанныйОбъект +// * ДатаПодписи - см. НовыеСвойстваПодписи.ДатаПодписи +// * Комментарий - см. НовыеСвойстваПодписи.Комментарий +// * АдресПодписи - Строка - адрес подписи во временном хранилище. +// * Отпечаток - см. НовыеСвойстваПодписи.Отпечаток +// * АдресСертификата - Строка - адрес сертификата во временном хранилище. +// * ПодписьВерна - см. НовыеСвойстваПодписи.ПодписьВерна +// * ДатаПроверкиПодписи - см. НовыеСвойстваПодписи.ДатаПроверкиПодписи +// * КомуВыданСертификат - см. НовыеСвойстваПодписи.КомуВыданСертификат +// * ТребуетсяПроверка - см. НовыеСвойстваПодписи.ТребуетсяПроверка +// * УстановившийПодпись - см. НовыеСвойстваПодписи.УстановившийПодпись +// * ТипПодписи - см. НовыеСвойстваПодписи.ТипПодписи +// * СрокДействияПоследнейМеткиВремени - см. НовыеСвойстваПодписи.СрокДействияПоследнейМеткиВремени +// * МашиночитаемаяДоверенность - СправочникСсылка.МашиночитаемыеДоверенности +// * МашиночитаемаяДоверенностьВерна - Булево +// * РезультатПроверкиПодписиПоМЧД - см. НовыеСвойстваПодписи.РезультатПроверкиПодписиПоМЧД +// * РезультатПроверки - Структура - свойства результата проверки подписи для хранения в базе: +// ** ПодписьМатематическиВерна - Булево +// ** ОшибкаМатематическойПроверкиПодписи - Строка - текст ошибки. +// ** ОшибкаПроверкиДополнительныхАтрибутов - Строка - текст ошибки. +// ** ДополнительныеАтрибутыПровереныВручную - Булево - признак ручной проверки подписи. +// ** АвторРучнойПроверкиДополнительныхАтрибутов - СправочникСсылка.Пользователи +// ** ОбоснованиеРучнойПроверкиДополнительныхАтрибутов - Строка +// * РезультатПроверкиКраткий - Строка - для отображения результата проверки подписи в форме. +// +Функция РезультатПроверкиПодписиВФорме() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.РезультатПроверкиПодписиВФорме() +``` +
+ +## ЗаполнитьСтатусПодписи +
+ +Описание, пример вызова + +```bsl + +// Заполняет для отображения в форме текст проверки подписи и помещает его в атрибут РезультатПроверкиКраткий . +// +// Параметры: +// СвойстваПодписи - см. РезультатПроверкиПодписиВФорме +// ДатаСеанса - Дата +// +Процедура ЗаполнитьСтатусПодписи(СвойстваПодписи, ДатаСеанса) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСервер.ЗаполнитьСтатусПодписи(СвойстваПодписи, ДатаСеанса) +``` +
+ +## ИмяФайлаПодписи +
+ +Описание, пример вызова + +```bsl + +// Формирует имя файла подписи по шаблону. +// +// Параметры: +// ИмяБезРасширения - Строка - исходное имя файла без расширения. Например, ПодписанныйОбъект.Наименование. +// КомуВыданСертификат - Строка - владелец сертификата (фамилия, имя, организация, должность). +// РасширениеДляФайловПодписи - Строка - расширение для файлов подписи, добавляемое к имени файла. +// ТребуетсяРазделитель - Булево - признак дополнительной установки разделителя в имени файла. +// +// Возвращаемое значение: +// Строка +// +Функция ИмяФайлаПодписи(ИмяБезРасширения, КомуВыданСертификат, РасширениеДляФайловПодписи, ТребуетсяРазделитель = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.ИмяФайлаПодписи(ИмяБезРасширения, КомуВыданСертификат, РасширениеДляФайловПодписи, ТребуетсяРазделитель); +``` +
+ +## ПредставлениеСертификата +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. ЭлектроннаяПодписьКлиент.ПредставлениеСертификата. +// См. ЭлектроннаяПодпись.ПредставлениеСертификата. +// +Функция ПредставлениеСертификата(Сертификат, Отчество = Ложь, СрокДействия = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.ПредставлениеСертификата(Сертификат, Отчество, СрокДействия); +``` +
+ +## ПредставлениеСубъекта +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. ЭлектроннаяПодписьКлиент.ПредставлениеСубъекта. +// См. ЭлектроннаяПодпись.ПредставлениеСубъекта. +// +Функция ПредставлениеСубъекта(Сертификат, Отчество = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.ПредставлениеСубъекта(Сертификат, Отчество); +``` +
+ +## ПредставлениеИздателя +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. ЭлектроннаяПодписьКлиент.ПредставлениеИздателя. +// См. ЭлектроннаяПодпись.ПредставлениеИздателя. +// +Функция ПредставлениеИздателя(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.ПредставлениеИздателя(Сертификат) +``` +
+ +## ЗаполнитьСтруктуруСертификата +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. ЭлектроннаяПодписьКлиент.СвойстваСертификата. +// См. ЭлектроннаяПодпись.СвойстваСертификата. +// +Функция ЗаполнитьСтруктуруСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.ЗаполнитьСтруктуруСертификата(Сертификат) +``` +
+ +## СвойстваСубъектаСертификата +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. ЭлектроннаяПодписьКлиент.СвойстваСубъектаСертификата. +// См. ЭлектроннаяПодпись.СвойстваСубъектаСертификата. +// +Функция СвойстваСубъектаСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.СвойстваСубъектаСертификата(Сертификат) +``` +
+ +## СвойстваИздателяСертификата +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. ЭлектроннаяПодписьКлиент.СвойстваИздателяСертификата. +// См. ЭлектроннаяПодпись.СвойстваИздателяСертификата. +// +Функция СвойстваИздателяСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.СвойстваИздателяСертификата(Сертификат) +``` +
+ +## ПараметрыXMLDSig +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// См. ЭлектроннаяПодписьКлиент.ПараметрыXMLDSig. +// См. ЭлектроннаяПодпись.ПараметрыXMLDSig. +// +Функция ПараметрыXMLDSig() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСервер.ПараметрыXMLDSig() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьКлиентСерверЛокализация.md b/src/content/docs/bsp/ЭлектроннаяПодписьКлиентСерверЛокализация.md new file mode 100644 index 0000000..32bd490 --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьКлиентСерверЛокализация.md @@ -0,0 +1,504 @@ +--- +title: Электронная подпись клиент сервер локализация +slug: bsp/электронная-подпись-клиент-сервер-локализация +--- + + +## ПриПолученииПредставленияСертификата +
+ +Описание, пример вызова + +```bsl + +// Переопределяет представление сертификата. +// +// Параметры: +// Сертификат - СертификатКриптографии +// РазницаСУниверсальнымВременем - Число +// Представление - Строка +// +Процедура ПриПолученииПредставленияСертификата(Знач Сертификат, Знач РазницаСУниверсальнымВременем, Представление) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриПолученииПредставленияСертификата(Сертификат, РазницаСУниверсальнымВременем, Представление) +``` +
+ +## ПриПолученииПредставленияСубъекта +
+ +Описание, пример вызова + +```bsl + +// Переопределяет представление субъекта сертификата. +// +// Параметры: +// Сертификат - СертификатКриптографии +// Представление - Строка +// +Процедура ПриПолученииПредставленияСубъекта(Знач Сертификат, Представление) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриПолученииПредставленияСубъекта(Сертификат, Представление) +``` +
+ +## ПриПолученииРасширенныхСвойствСубъектаСертификата +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру расширенных свойств субъекта сертификата. +// +// Параметры: +// Субъект - ФиксированнаяСтруктура +// Свойства - Структура +// +Процедура ПриПолученииРасширенныхСвойствСубъектаСертификата(Знач Субъект, Свойства) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриПолученииРасширенныхСвойствСубъектаСертификата(Субъект, Свойства) +``` +
+ +## ПриПолученииРасширенныхСвойствИздателяСертификата +
+ +Описание, пример вызова + +```bsl + +// Переопределяет структуру расширенных свойств издателя сертификата. +// +// Параметры: +// Издатель - ФиксированнаяСтруктура +// Свойства - Структура +// +Процедура ПриПолученииРасширенныхСвойствИздателяСертификата(Знач Издатель, Свойства) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриПолученииРасширенныхСвойствИздателяСертификата(Издатель, Свойства) +``` +
+ +## ПриСравненииСертификатов +
+ +Описание, пример вызова + +```bsl + +// Переопределяет результат сравнения сертификатов по свойствам субъекта. +// +// Параметры: +// СвойстваНового - Структура +// СвойстваСтарого - Структура +// Результат - Булево +// +Процедура ПриСравненииСертификатов(СвойстваНового, СвойстваСтарого, Результат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриСравненииСертификатов(СвойстваНового, СвойстваСтарого, Результат) +``` +
+ +## ПриПолученииКонвертаXML +
+ +Описание, пример вызова + +```bsl + +// При получении конверта XML. +// +// Параметры: +// Параметры - Структура +// КонвертXML - Строка +// +Процедура ПриПолученииКонвертаXML(Параметры, КонвертXML) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриПолученииКонвертаXML(Параметры, КонвертXML) +``` +
+ +## ПриПолученииВариантаКонвертаПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// При получении варианта конверта по умолчанию. +// +// Параметры: +// КонвертXML - Строка +// +Процедура ПриПолученииВариантаКонвертаПоУмолчанию(КонвертXML) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриПолученииВариантаКонвертаПоУмолчанию(КонвертXML) +``` +
+ +## АдресСпискаОтзываВнутренний +
+ +Описание, пример вызова + +```bsl + +// Адрес списка отзыва, расположенного на другом ресурсе. +// +// Параметры: +// ИмяИздателя - Строка - имя издателя латиницей в нижнем регистре +// СвойстваСертификата - ДвоичныеДанные - данные сертификата. +// - Строка - адрес данных сертификата. +// - Структура - см. ЭлектроннаяПодписьСлужебныйКлиентСервер.СвойстваСертификата +// КаталогиСписковОтзываУЦ - Строка - имена каталогов для кэширования списков отзыва на собственном ресурсе +// из настроек классификатора аккредитованных УЦ, совпадают с именами издателя сертификата. +// +// Возвращаемое значение: +// Структура: +// * АдресВнутренний - Строка - идентификатор для поиска в базе +// * АдресВнешний - Строка - адрес ресурса для скачивания +// +Функция АдресСпискаОтзываВнутренний(ИмяИздателя, СвойстваСертификата, КаталогиСписковОтзываУЦ) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСерверЛокализация.АдресСпискаОтзываВнутренний(ИмяИздателя, СвойстваСертификата, КаталогиСписковОтзываУЦ) +``` +
+ +## КаталогиСписковОтзываУЦ +
+ +Описание, пример вызова + +```bsl + +// Каталоги списков отзыва УЦ. +// +// Параметры: +// АккредитованныеУдостоверяющиеЦентры - Структура +// +// Возвращаемое значение: +// Строка - каталоги списков отзыва УЦ +// +Функция КаталогиСписковОтзываУЦ(АккредитованныеУдостоверяющиеЦентры) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСерверЛокализация.КаталогиСписковОтзываУЦ(АккредитованныеУдостоверяющиеЦентры) +``` +
+ +## ДанныеУдостоверяющегоЦентра +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные для проверки удостоверяющего центра. +// +// Параметры: +// ЗначенияПоиска - Строка +// АккредитованныеУдостоверяющиеЦентры - Структура +// +// Возвращаемое значение: +// Неопределено +// Структура: +// * Государственный - Булево +// * РазрешенныйНеаккредитованный - Булево +// * ПериодыДействия - Неопределено, Массив из Структура: +// **ДатаС - Дата +// **ДатаПо - Дата, Неопределено +// * ДатаОкончанияДействия - Неопределено, Дата +// * ДатаОбновления - Неопределено, Дата +// * ДругиеНастройки - Соответствие +// +Функция ДанныеУдостоверяющегоЦентра(ЗначенияПоиска, АккредитованныеУдостоверяющиеЦентры) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСерверЛокализация.ДанныеУдостоверяющегоЦентра(ЗначенияПоиска, АккредитованныеУдостоверяющиеЦентры) +``` +
+ +## ПриОпределенииСсылкиНаИнструкциюПоРаботеСПрограммами +
+ +Описание, пример вызова + +```bsl + +// При определении ссылки на инструкцию по работе с программами. +// +// Параметры: +// Раздел - Строка +// НавигационнаяСсылка - Строка +// +Процедура ПриОпределенииСсылкиНаИнструкциюПоРаботеСПрограммами(Раздел, НавигационнаяСсылка) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриОпределенииСсылкиНаИнструкциюПоРаботеСПрограммами(Раздел, НавигационнаяСсылка) +``` +
+ +## ПриОпределенииСсылкиНаПоискПоОшибкамПриРаботеСЭлектроннойПодписью +
+ +Описание, пример вызова + +```bsl + +// При определении ссылки на поиск по ошибкам при работе с электронной подписью. +// +// Параметры: +// НавигационнаяСсылка - Строка +// СтрокаПоиска - Строка - строка поиска +// +Процедура ПриОпределенииСсылкиНаПоискПоОшибкамПриРаботеСЭлектроннойПодписью(НавигационнаяСсылка, СтрокаПоиска = "") Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриОпределенииСсылкиНаПоискПоОшибкамПриРаботеСЭлектроннойПодписью(НавигационнаяСсылка, СтрокаПоиска); +``` +
+ +## ПреобразованныйАлгоритмШифрования +
+ +Описание, пример вызова + +```bsl + +// Преобразование передаваемого названия алгоритма в зависимости от передаваемого представления. +// +// Параметры: +// АлгоритмШифрования - Строка +// +// Возвращаемое значение: +// Строка +// +Функция ПреобразованныйАлгоритмШифрования(АлгоритмШифрования) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСерверЛокализация.ПреобразованныйАлгоритмШифрования(АлгоритмШифрования) +``` +
+ +## ПриУстановкеПараметровМенеджераКриптографии +
+ +Описание, пример вызова + +```bsl + +// Реализует альтернативную установку параметров менеджера криптографии. +// Например, если требуется учесть специфику программы электронной подписи и шифрования. +// +// Параметры: +// ОписаниеПрограммы - см. ЭлектроннаяПодписьСлужебныйПовтИсп.ОписаниеПрограммы +// Менеджер - МенеджерКриптографии +// АлгоритмШифрования - Строка +// Результат - Булево +// +Процедура ПриУстановкеПараметровМенеджераКриптографии(ОписаниеПрограммы, Менеджер, АлгоритмШифрования, Результат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриУстановкеПараметровМенеджераКриптографии(ОписаниеПрограммы, Менеджер, АлгоритмШифрования, Результат) +``` +
+ +## ПриУстановкеНаборовАлгоритмовДляСозданияПодписи +
+ +Описание, пример вызова + +```bsl + +// Добавляет наборы алгоритмов для создания подписи с национальной спецификой. +// +// Параметры: +// Наборы - Массив +// +Процедура ПриУстановкеНаборовАлгоритмовДляСозданияПодписи(Наборы) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриУстановкеНаборовАлгоритмовДляСозданияПодписи(Наборы) +``` +
+ +## ПриУстановкеНаборовАлгоритмовШифрования +
+ +Описание, пример вызова + +```bsl + +// Добавляет наборы алгоритмов шифрования с национальной спецификой. +// +// Параметры: +// Наборы - Массив +// +Процедура ПриУстановкеНаборовАлгоритмовШифрования(Наборы) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриУстановкеНаборовАлгоритмовШифрования(Наборы) +``` +
+ +## АктуальныеАлгоритмыПрограмм +
+ +Описание, пример вызова + +```bsl + +// Добавляет национальные алгоритмы подписи в список актуальных алгоритмов. +// +// Возвращаемое значение: +// Массив +// +Функция АктуальныеАлгоритмыПрограмм() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСерверЛокализация.АктуальныеАлгоритмыПрограмм() +``` +
+ +## РезультатПроверкиУдостоверяющегоЦентраСертификата +
+ +Описание, пример вызова + +```bsl + + +// Только для внутреннего использования. +// +// Параметры: +// Сертификат - СертификатКриптографии +// КонтекстПроверки - см. КонтекстПроверкиУдостоверяющегоЦентраСертификата +// +// Возвращаемое значение: +// См. ЭлектроннаяПодписьСлужебныйКлиентСервер.РезультатПроверкиУдостоверяющегоЦентраПоУмолчанию +// +Функция РезультатПроверкиУдостоверяющегоЦентраСертификата(Сертификат, КонтекстПроверки) Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСерверЛокализация.РезультатПроверкиУдостоверяющегоЦентраСертификата(Сертификат, КонтекстПроверки) +``` +
+ +## ПриПолученииИмениПрограммыЭлектроннойПодписи +
+ +Описание, пример вызова + +```bsl + +// При получении имени программы электронной подписи. +// +// Параметры: +// Криптопровайдер - Структура +// Результат - Строка +// +Процедура ПриПолученииИмениПрограммыЭлектроннойПодписи(Криптопровайдер, Результат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриПолученииИмениПрограммыЭлектроннойПодписи(Криптопровайдер, Результат) +``` +
+ +## ПриОпределенииОшибкиЗагрузкиБиблиотекТокена +
+ +Описание, пример вызова + +```bsl + +// Это ошибка из-за не установленных библиотек токена. +// +// Параметры: +// ТекстОшибки - Строка +// Результат - Булево +// +Процедура ПриОпределенииОшибкиЗагрузкиБиблиотекТокена(ТекстОшибки, Результат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьКлиентСерверЛокализация.ПриОпределенииОшибкиЗагрузкиБиблиотекТокена(ТекстОшибки, Результат) +``` +
+ +## СсылкаНаСтатьюОбУдостоверяющихЦентрах +
+ +Описание, пример вызова + +```bsl + +// Ссылка на статью об удостоверяющих центрах. +// +// Возвращаемое значение: +// Строка - ссылка на статью об удостоверяющих центрах +// +Функция СсылкаНаСтатьюОбУдостоверяющихЦентрах() Экспорт +``` + +Пример вызова +```bsl +Результат = ЭлектроннаяПодписьКлиентСерверЛокализация.СсылкаНаСтатьюОбУдостоверяющихЦентрах() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьЛокализация.md b/src/content/docs/bsp/ЭлектроннаяПодписьЛокализация.md new file mode 100644 index 0000000..1885600 --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьЛокализация.md @@ -0,0 +1,531 @@ +--- +title: Электронная подпись локализация +slug: bsp/электронная-подпись-локализация +--- + + +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// При создании на сервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// +Процедура ПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриСозданииНаСервере(Форма) +``` +
+ +## ПриЗаполненииПредставленияТипаПодписи +
+ +Описание, пример вызова + +```bsl + +// Переопределяет представление типа подписи в форме настроек панели администрирования и тест подсказки в форме подписания. +// +// Параметры: +// ТипПодписи - ПеречислениеСсылка.ТипыПодписиКриптографии +// ПредставлениеПодписи - Строка +// +Процедура ПриЗаполненииПредставленияТипаПодписи(ТипПодписи, ПредставлениеПодписи) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриЗаполненииПредставленияТипаПодписи(ТипПодписи, ПредставлениеПодписи) +``` +
+ +## ПриЗагрузкеМашиночитаемыхДоверенностей +
+ +Описание, пример вызова + +```bsl + + +// При загрузке машиночитаемых доверенностей. +// +// Параметры: +// Форма - см. ОбщаяФорма.ДобавлениеЭлектроннойПодписиИзФайла +// +Процедура ПриЗагрузкеМашиночитаемыхДоверенностей(Форма) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриЗагрузкеМашиночитаемыхДоверенностей(Форма) +``` +
+ +## ПриПолученииСостоянияЗаявленияНаВыпускСертификата +
+ +Описание, пример вызова + +```bsl + +// При получении состояния заявления на выпуск сертификата. +// +// Параметры: +// Сертификат - см. ЭлектроннаяПодпись.СостояниеЗаявленияНаВыпускСертификата.Сертификат +// Результат - см. ЭлектроннаяПодпись.СостояниеЗаявленияНаВыпускСертификата +// +Процедура ПриПолученииСостоянияЗаявленияНаВыпускСертификата(Сертификат, Результат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриПолученииСостоянияЗаявленияНаВыпускСертификата(Сертификат, Результат) +``` +
+ +## ПриЗаполненииМашиночитаемыхДоверенностей +
+ +Описание, пример вызова + +```bsl + +// При заполнении машиночитаемых доверенностей. +// +// Параметры: +// Форма - см. ОбщаяФорма.ДобавлениеЭлектроннойПодписиИзФайла +// ПодписанныйОбъект - ОпределяемыйТип.ПодписанныйОбъект +// +Процедура ПриЗаполненииМашиночитаемыхДоверенностей(Форма, ПодписанныйОбъект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриЗаполненииМашиночитаемыхДоверенностей(Форма, ПодписанныйОбъект); +``` +
+ +## ПриЗаполненииМашиночитаемойДоверенностиВСтроке +
+ +Описание, пример вызова + +```bsl + +// При заполнении машиночитаемой доверенности в строке. +// +// Параметры: +// Форма - см. ОбщаяФорма.ДобавлениеЭлектроннойПодписиИзФайла +// ПодписанныйОбъект - ОпределяемыйТип.ПодписанныйОбъект +// ИдентификаторСтроки - Число +// +Процедура ПриЗаполненииМашиночитаемойДоверенностиВСтроке(Форма, ИдентификаторСтроки, ПодписанныйОбъект) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриЗаполненииМашиночитаемойДоверенностиВСтроке(Форма, ИдентификаторСтроки, ПодписанныйОбъект) +``` +
+ +## ПриДобавленииКлассификаторов +
+ +Описание, пример вызова + +```bsl + +// См. РаботаСКлассификаторамиПереопределяемый.ПриДобавленииКлассификаторов. +Процедура ПриДобавленииКлассификаторов(Классификаторы) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриДобавленииКлассификаторов(Классификаторы) +``` +
+ +## ПриЗагрузкеКлассификатора +
+ +Описание, пример вызова + +```bsl + +// См. РаботаСКлассификаторамиПереопределяемый.ПриЗагрузкеКлассификатора. +Процедура ПриЗагрузкеКлассификатора(Идентификатор, Версия, Адрес, Обработан, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриЗагрузкеКлассификатора(Идентификатор, Версия, Адрес, Обработан, ДополнительныеПараметры) +``` +
+ +## ПриДобавленииСтрокНаСервере +
+ +Описание, пример вызова + +```bsl + +// При добавлении строк на сервере. +// +// Параметры: +// Форма - см. ОбщаяФорма.ДобавлениеЭлектроннойПодписиИзФайла +// ПомещенныеФайлы - Массив +// ДругиеФайлы - Соответствие +// ОшибкиПриЗагрузкеДоверенностей - Строка +// УникальныйИдентификатор - УникальныйИдентификатор +// +Процедура ПриДобавленииСтрокНаСервере(Форма, ПомещенныеФайлы, ДругиеФайлы, ОшибкиПриЗагрузкеДоверенностей, УникальныйИдентификатор) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриДобавленииСтрокНаСервере(Форма, ПомещенныеФайлы, ДругиеФайлы, ОшибкиПриЗагрузкеДоверенностей, УникальныйИдентификатор) +``` +
+ +## ПриПроверкеПодписейПоМЧД +
+ +Описание, пример вызова + +```bsl + +// При проверке подписей по МЧД. +// +// Параметры: +// Подписи - Массив +// ПодписанныйОбъект - ОпределяемыйТип.ПодписанныйОбъект +// РезультатыПроверок - Массив +// +Процедура ПриПроверкеПодписейПоМЧД(Подписи, ПодписанныйОбъект, РезультатыПроверок) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриПроверкеПодписейПоМЧД(Подписи, ПодписанныйОбъект, РезультатыПроверок) +``` +
+ +## ПриОпределенииДоступностиСозданияЗаявления +
+ +Описание, пример вызова + +```bsl + +// При определении доступности создания заявления. +// +// Параметры: +// ДоступностьСозданияЗаявления - см. ЭлектроннаяПодпись.ДоступностьСозданияЗаявления +// +Процедура ПриОпределенииДоступностиСозданияЗаявления(ДоступностьСозданияЗаявления) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриОпределенииДоступностиСозданияЗаявления(ДоступностьСозданияЗаявления) +``` +
+ +## ПриЗаполненииРезультатаПроверкиУдостоверяющегоЦентра +
+ +Описание, пример вызова + +```bsl + +// При заполнении результата проверки удостоверяющего центра. +// +// Параметры: +// Результат - см. ЭлектроннаяПодписьСлужебныйКлиентСервер.РезультатПроверкиУдостоверяющегоЦентраПоУмолчанию +// СертификатКриптографии - СертификатКриптографии +// НаДату - Дата +// ПараметрыПроверки - Структура +// СвойстваСертификата - см. ЭлектроннаяПодпись.СвойстваСертификата +// +Процедура ПриЗаполненииРезультатаПроверкиУдостоверяющегоЦентра( Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриЗаполненииРезультатаПроверкиУдостоверяющегоЦентра(); +``` +
+ +## ПриПолученииАккредитованныхУдостоверяющихЦентров +
+ +Описание, пример вызова + +```bsl + +// При получении аккредитованных удостоверяющих центров. +// +// Параметры: +// АккредитованныеУдостоверяющиеЦентры - Структура +// +Процедура ПриПолученииАккредитованныхУдостоверяющихЦентров(АккредитованныеУдостоверяющиеЦентры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриПолученииАккредитованныхУдостоверяющихЦентров(АккредитованныеУдостоверяющиеЦентры) +``` +
+ +## ПриПолученииКлассификатораОшибокКриптографии +
+ +Описание, пример вызова + +```bsl + +// При получении классификатора ошибок криптографии. +// +// Параметры: +// ДанныеКлассификатора - Неопределено, Структура +// +Процедура ПриПолученииКлассификатораОшибокКриптографии(ДанныеКлассификатора) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриПолученииКлассификатораОшибокКриптографии(ДанныеКлассификатора) +``` +
+ +## ПриОпределенииДоступностиПроверкиПоСпискуУЦ +
+ +Описание, пример вызова + +```bsl + +// При определении доступности проверки по списку УЦ. +// +// Параметры: +// ПроверкаДоступна - Булево +// +Процедура ПриОпределенииДоступностиПроверкиПоСпискуУЦ(ПроверкаДоступна) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриОпределенииДоступностиПроверкиПоСпискуУЦ(ПроверкаДоступна) +``` +
+ +## ПриПолученииДистрибутива +
+ +Описание, пример вызова + +```bsl + +// При получении дистрибутива. +// +// Параметры: +// Параметры - Структура +// Идентификатор - Строка +// Результат - см. ДлительныеОперации.ВыполнитьФункцию +// +Процедура ПриПолученииДистрибутива(Параметры, Идентификатор, Результат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриПолученииДистрибутива(Параметры, Идентификатор, Результат) +``` +
+ +## ПриОбработкеРезультатаПолученияДистрибутива +
+ +Описание, пример вызова + +```bsl + +// При обработке результата получения дистрибутива. +// +// Параметры: +// ДлительнаяОперация - Структура: +// * АдресРезультата - Строка - адрес во временном хранилище +// ИдентификаторФормы - УникальныйИдентификатор +// Результат - Структура +// +Процедура ПриОбработкеРезультатаПолученияДистрибутива(ДлительнаяОперация, ИдентификаторФормы, Результат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриОбработкеРезультатаПолученияДистрибутива(ДлительнаяОперация, ИдентификаторФормы, Результат) +``` +
+ +## ПриОпределенииИспользованияСервисаОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +// При определении использования сервиса облачной подписи. +// +// Параметры: +// Результат - Булево +// +Процедура ПриОпределенииИспользованияСервисаОблачнойПодписи(Результат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриОпределенииИспользованияСервисаОблачнойПодписи(Результат) +``` +
+ +## ПриОпределенииТипаПрограммыСервисаПодписи +
+ +Описание, пример вызова + +```bsl + +// При определении типа программы сервиса подписи. +// +// Параметры: +// Результат - Тип +// +Процедура ПриОпределенииТипаПрограммыСервисаПодписи(Результат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриОпределенииТипаПрограммыСервисаПодписи(Результат) +``` +
+ +## ПриПолученииАдресовСерверовМетокВремени +
+ +Описание, пример вызова + +```bsl + +// При получении адресов серверов меток времени. +// +// Параметры: +// АдресаСерверовМетокВремени - Строка +// +Процедура ПриПолученииАдресовСерверовМетокВремени(АдресаСерверовМетокВремени) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриПолученииАдресовСерверовМетокВремени(АдресаСерверовМетокВремени) +``` +
+ +## ПриПолученииОтпечатковОблачногоСервиса +
+ +Описание, пример вызова + +```bsl + +// При получении отпечатков облачного сервиса. +// +// Параметры: +// МассивОтпечатков - Массив +// +Процедура ПриПолученииОтпечатковОблачногоСервиса(МассивОтпечатков) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриПолученииОтпечатковОблачногоСервиса(МассивОтпечатков) +``` +
+ +## ПриДобавленииСвойствСертификатовОблачногоСервиса +
+ +Описание, пример вызова + +```bsl + +// При добавлении свойств сертификатов облачного сервиса. +// +// Параметры: +// ТаблицаСвойствСертификатов - ТаблицаЗначений +// БезОтбора - Булево +// +Процедура ПриДобавленииСвойствСертификатовОблачногоСервиса(ТаблицаСвойствСертификатов, БезОтбора) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриДобавленииСвойствСертификатовОблачногоСервиса(ТаблицаСвойствСертификатов, БезОтбора) +``` +
+ +## ПриОпределенииНастроенногоОблачногоСервиса +
+ +Описание, пример вызова + +```bsl + +// При определении настроенного облачного сервиса. +// +// Параметры: +// Результат - Булево +// +Процедура ПриОпределенииНастроенногоОблачногоСервиса(Результат) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриОпределенииНастроенногоОблачногоСервиса(Результат) +``` +
+ +## ПриЗаполненииСертификатовОблачногоСервиса +
+ +Описание, пример вызова + +```bsl + +// При заполнении сертификатов облачного сервиса. +// +// Параметры: +// ОтпечаткиСертификатовНаКлиенте - Массив +// +Процедура ПриЗаполненииСертификатовОблачногоСервиса(ОтпечаткиСертификатовНаКлиенте) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьЛокализация.ПриЗаполненииСертификатовОблачногоСервиса(ОтпечаткиСертификатовНаКлиенте) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/bsp/ЭлектроннаяПодписьПереопределяемый.md b/src/content/docs/bsp/ЭлектроннаяПодписьПереопределяемый.md new file mode 100644 index 0000000..6302180 --- /dev/null +++ b/src/content/docs/bsp/ЭлектроннаяПодписьПереопределяемый.md @@ -0,0 +1,251 @@ +--- +title: Электронная подпись переопределяемый +slug: bsp/электронная-подпись-переопределяемый +--- + + +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Переопределяет стандартное поведение подсистемы ЭлектроннаяПодпись. +// +// Параметры: +// Настройки - Структура: +// * ФизическоеЛицоИспользуется - Булево - по умолчанию Истина. Когда Истина, тогда реквизит физическое лицо +// с типом см. ОпределяемыйТип.ФизическоеЛицо выводится в карточке сертификата и в заявлении на электронную подпись. +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьПереопределяемый.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПередНачаломРедактированияСертификатаКлюча +
+ +Описание, пример вызова + +```bsl + +// Вызывается в форме элемента справочника СертификатыКлючейЭлектроннойПодписиИШифрования и в других местах, +// где создаются или обновляются сертификаты, например в форме ВыборСертификатаДляПодписанияИлиРасшифровки. +// Допускается вызов исключения, если требуется остановить действие и что-то сообщить пользователю - +// например, при попытке создать элемент - копию сертификата, доступ к которому ограничен. +// +// Параметры: +// Ссылка - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - пустая для нового элемента. +// +// Сертификат - СертификатКриптографии - сертификат, для которого создается или обновляется элемент справочника. +// +// ПараметрыРеквизитов - ТаблицаЗначений: +// * ИмяРеквизита - Строка - имя реквизита, для которого можно уточнить параметры. +// * ТолькоПросмотр - Булево - если установить Истина, редактирование будет запрещено. +// * ПроверкаЗаполнения - Булево - если установить Истина, заполнение будет проверяться. +// * Видимость - Булево - если установить Истина, реквизит станет невидимым. +// * ЗначениеЗаполнения - Произвольный - начальное значение реквизита нового объекта. +// - Неопределено - заполнение не требуется. +// +Процедура ПередНачаломРедактированияСертификатаКлюча(Ссылка, Сертификат, ПараметрыРеквизитов) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьПереопределяемый.ПередНачаломРедактированияСертификатаКлюча(Ссылка, Сертификат, ПараметрыРеквизитов) +``` +
+ +## ПередНачаломОперации +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании на сервере форм ПодписаниеДанных, РасшифровкаДанных. +// Используется для дополнительных действий, которые требуют серверного вызова, чтобы не +// вызывать сервер лишний раз. +// +// Параметры: +// Операция - Строка - строка Подписание или Расшифровка. +// +// ВходныеПараметры - Произвольный - значение свойства ПараметрыДополнительныхДействий +// параметра ОписаниеДанных методов Подписать, Расшифровать общего +// модуля ЭлектроннаяПодписьКлиент. +// +// ВыходныеПараметры - Произвольный - произвольные возвращаемые данные, которые +// будут помещены в одноименную процедуру в общем модуле. +// ЭлектроннаяПодписьКлиентПереопределяемый после создания формы +// на сервере, но до ее открытия. +// +Процедура ПередНачаломОперации(Операция, ВходныеПараметры, ВыходныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьПереопределяемый.ПередНачаломОперации(Операция, ВходныеПараметры, ВыходныеПараметры) +``` +
+ +## ПриСозданииФормыПроверкаСертификата +
+ +Описание, пример вызова + +```bsl + +// Вызывается для расширения состава выполняемых проверок. +// +// Параметры: +// Сертификат - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - проверяемый сертификат. +// +// ДополнительныеПроверки - ТаблицаЗначений: +// * Имя - Строка - имя дополнительной проверки, например, АвторизацияВТакском. +// * Представление - Строка - пользовательское имя проверки, например, "Авторизация на сервере Такском". +// * Подсказка - Строка - подсказка, которая будет показана пользователю при нажатии на знак вопроса. +// +// ПараметрыДополнительныхПроверок - Произвольный - значение одноименного параметра, указанное +// в процедуре ПроверитьСертификатСправочника общего модуля ЭлектроннаяПодписьКлиент. +// +// СтандартныеПроверки - Булево - если установить Ложь, тогда все стандартные проверки будут +// пропущены и скрыты. Скрытые проверки не попадают в свойство Результат +// процедуры ПроверитьСертификатСправочника общего модуля ЭлектроннаяПодписьКлиент, кроме того +// параметр МенеджерКриптографии не будет определен в процедурах ПриДополнительнойПроверкеСертификата +// общих модулей ЭлектроннаяПодписьПереопределяемый и ЭлектроннаяПодписьКлиентПереопределяемый. +// +// ВводитьПароль - Булево - если установить Ложь, тогда ввод пароля для закрытой части ключа сертификата будет скрыт. +// Не учитывается, если параметр СтандартныеПроверки не установлен в Ложь. +// +Процедура ПриСозданииФормыПроверкаСертификата(Сертификат, ДополнительныеПроверки, ПараметрыДополнительныхПроверок, СтандартныеПроверки, ВводитьПароль = Истина) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьПереопределяемый.ПриСозданииФормыПроверкаСертификата(Сертификат, ДополнительныеПроверки, ПараметрыДополнительныхПроверок, СтандартныеПроверки, ВводитьПароль); +``` +
+ +## ПриДополнительнойПроверкеСертификата +
+ +Описание, пример вызова + +```bsl + +// Вызывается из формы ПроверкаСертификата, если при создании формы были добавлены дополнительные проверки. +// +// Параметры: +// Параметры - Структура: +// * Сертификат - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - проверяемый сертификат. +// * Проверка - Строка - имя проверки, добавленное в процедуре ПриСозданииФормыПроверкаСертификата +// общего модуля ЭлектроннаяПодписьПереопределяемый. +// * МенеджерКриптографии - МенеджерКриптографии - подготовленный менеджер криптографии для +// выполнения проверки. +// - Неопределено - если стандартные проверки отключены в процедуре +// ПриСозданииФормыПроверкаСертификата общего модуля ЭлектроннаяПодписьПереопределяемый. +// * ОписаниеОшибки - Строка - возвращаемое значение. Описание ошибки, полученной при выполнении проверки. +// Это описание сможет увидеть пользователь при нажатии на картинку результата. +// * ЭтоПредупреждение - Булево - возвращаемое значение. Вид картинки Ошибка/Предупреждение, +// начальное значение - Ложь. +// * Пароль - Строка - пароль, введенный пользователем. +// - Неопределено - если свойство ВводитьПароль установлено в Ложь в процедуре +// ПриСозданииФормыПроверкаСертификата общего модуля ЭлектроннаяПодписьПереопределяемый. +// * РезультатыПроверок - Структура: +// * Ключ - Строка - имя дополнительной проверки, которая уже выполнена. +// * Значение - Неопределено - дополнительная проверка не выполнялась (ОписаниеОшибки осталось Неопределено). +// - Булево - результат выполнения дополнительной проверки. +// +Процедура ПриДополнительнойПроверкеСертификата(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьПереопределяемый.ПриДополнительнойПроверкеСертификата(Параметры) +``` +
+ +## ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат. +// +Процедура ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьПереопределяемый.ПриЗаполненииРеквизитовОрганизацииВЗаявленииНаСертификат(Параметры) +``` +
+ +## ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат. +// +Процедура ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьПереопределяемый.ПриЗаполненииРеквизитовВладельцаВЗаявленииНаСертификат(Параметры) +``` +
+ +## ПриЗаполненииРеквизитовРуководителяВЗаявленииНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовРуководителяВЗаявленииНаСертификат. +// +Процедура ПриЗаполненииРеквизитовРуководителяВЗаявленииНаСертификат(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьПереопределяемый.ПриЗаполненииРеквизитовРуководителяВЗаявленииНаСертификат(Параметры) +``` +
+ +## ПриЗаполненииРеквизитовПартнераВЗаявленииНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЗаявлениеНаСертификатПереопределяемый.ПриЗаполненииРеквизитовПартнераВЗаявленииНаСертификат. +// +Процедура ПриЗаполненииРеквизитовПартнераВЗаявленииНаСертификат(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЭлектроннаяПодписьПереопределяемый.ПриЗаполненииРеквизитовПартнераВЗаявленииНаСертификат(Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx new file mode 100644 index 0000000..59b1932 --- /dev/null +++ b/src/content/docs/index.mdx @@ -0,0 +1,8 @@ +--- +title: Обшие модули ЗУП +description: Методы программного интерфейса ЗУП +--- + +export const layout = 'doc'; + +{/* Пустая страница, но с лэйаутом документации — будет сайдбар */} diff --git a/src/content/docs/zup/АвтоматическоеЗаполнениеОтчетности.md b/src/content/docs/zup/АвтоматическоеЗаполнениеОтчетности.md new file mode 100644 index 0000000..095630e --- /dev/null +++ b/src/content/docs/zup/АвтоматическоеЗаполнениеОтчетности.md @@ -0,0 +1,56 @@ +--- +title: Автоматическое заполнение отчетности +slug: zup/автоматическое-заполнение-отчетности +--- + + +## ОписаниеПоказателей_РасчетПоНалогуНаПрибыль_2015Кв1 +
+ +Описание, пример вызова + +```bsl + +// Процедура составляет перечень заполняемых библиотекой показателей. +// +// Параметры: +// ПоказателиОтчета - Структура - состав полей определяет БРО +// +Процедура ОписаниеПоказателей_РасчетПоНалогуНаПрибыль_2015Кв1(ПоказателиОтчета) Экспорт +``` + +Пример вызова +```bsl +АвтоматическоеЗаполнениеОтчетности.ОписаниеПоказателей_РасчетПоНалогуНаПрибыль_2015Кв1(ПоказателиОтчета) +``` +
+ +## ЗначенияПоказателей_РасчетПоНалогуНаПрибыль_2015Кв1 +
+ +Описание, пример вызова + +```bsl + +// Процедура заполняет в переданном "контейнере" известные библиотеке показатели. +// +// Параметры: +// ПараметрыОтчета - Структура - состав полей определяет БРО +// Контейнер - Структура - состав полей определяет БРО +// +Процедура ЗначенияПоказателей_РасчетПоНалогуНаПрибыль_2015Кв1(ПараметрыОтчета, Контейнер) Экспорт +``` + +Пример вызова +```bsl +АвтоматическоеЗаполнениеОтчетности.ЗначенияПоказателей_РасчетПоНалогуНаПрибыль_2015Кв1(ПараметрыОтчета, Контейнер) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/АвторизацияВСистемеБронирования.md b/src/content/docs/zup/АвторизацияВСистемеБронирования.md new file mode 100644 index 0000000..736c05d --- /dev/null +++ b/src/content/docs/zup/АвторизацияВСистемеБронирования.md @@ -0,0 +1,47 @@ +--- +title: Авторизация в системе бронирования +slug: zup/авторизация-в-системе-бронирования +--- + + +## ЗаполнитьНастройкиСистемыБронирования +
+ +Описание, пример вызова + +```bsl + +// См. БронированиеКомандировокПереопределяемый.ЗаполнитьНастройкиСистемыБронирования. +Процедура ЗаполнитьНастройкиСистемыБронирования(Настройки, СистемаБронирования) Экспорт +``` + +Пример вызова +```bsl +АвторизацияВСистемеБронирования.ЗаполнитьНастройкиСистемыБронирования(Настройки, СистемаБронирования) +``` +
+ +## СохранитьНастройкиСистемыБронирования +
+ +Описание, пример вызова + +```bsl + +// См. БронированиеКомандировокПереопределяемый.СохранитьНастройкиСистемыБронирования. +Процедура СохранитьНастройкиСистемыБронирования(Настройки, СистемаБронирования) Экспорт +``` + +Пример вызова +```bsl +АвторизацияВСистемеБронирования.СохранитьНастройкиСистемыБронирования(Настройки, СистемаБронирования) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/АккредитацияСпециалистов.md b/src/content/docs/zup/АккредитацияСпециалистов.md new file mode 100644 index 0000000..e8c328b --- /dev/null +++ b/src/content/docs/zup/АккредитацияСпециалистов.md @@ -0,0 +1,46 @@ +--- +title: Аккредитация специалистов +slug: zup/аккредитация-специалистов +--- + + +## ПриПолученииПредопределенныхНаборовСвойств +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеСвойствамиПереопределяемый.ПриПолученииПредопределенныхНаборовСвойств. +Процедура ПриПолученииПредопределенныхНаборовСвойств(Наборы) Экспорт +``` + +Пример вызова +```bsl +АккредитацияСпециалистов.ПриПолученииПредопределенныхНаборовСвойств(Наборы) +``` +
+ +## ПриСозданииНаСервереФормыОбразованиеКвалификация +
+ +Описание, пример вызова + +```bsl + +Процедура ПриСозданииНаСервереФормыОбразованиеКвалификация(Форма, РодительскаяГруппа, ГруппаПередКоторойДобавить) Экспорт +``` + +Пример вызова +```bsl +АккредитацияСпециалистов.ПриСозданииНаСервереФормыОбразованиеКвалификация(Форма, РодительскаяГруппа, ГруппаПередКоторойДобавить) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/АккредитацияСпециалистовКлиент.md b/src/content/docs/zup/АккредитацияСпециалистовКлиент.md new file mode 100644 index 0000000..e4624bc --- /dev/null +++ b/src/content/docs/zup/АккредитацияСпециалистовКлиент.md @@ -0,0 +1,45 @@ +--- +title: Аккредитация специалистов клиент +slug: zup/аккредитация-специалистов-клиент +--- + + +## ОткрытьФормуИзмененияАккредитаций +
+ +Описание, пример вызова + +```bsl + +Процедура ОткрытьФормуИзмененияАккредитаций(Форма) Экспорт +``` + +Пример вызова +```bsl +АккредитацияСпециалистовКлиент.ОткрытьФормуИзмененияАккредитаций(Форма) +``` +
+ +## ОбработкаОповещенияФормыОбразованиеКвалификация +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаОповещенияФормыОбразованиеКвалификация(Форма, ИмяСобытия, Параметр) Экспорт +``` + +Пример вызова +```bsl +АккредитацияСпециалистовКлиент.ОбработкаОповещенияФормыОбразованиеКвалификация(Форма, ИмяСобытия, Параметр) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/АттестацииСотрудниковКлиентСервер.md b/src/content/docs/zup/АттестацииСотрудниковКлиентСервер.md new file mode 100644 index 0000000..051c869 --- /dev/null +++ b/src/content/docs/zup/АттестацииСотрудниковКлиентСервер.md @@ -0,0 +1,30 @@ +--- +title: Аттестации сотрудников клиент сервер +slug: zup/аттестации-сотрудников-клиент-сервер +--- + + +## ТипыМногофункциональныхДокументов +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыРасширенныйКлиентСервер.ТипыМногофункциональныхДокументов +Функция ТипыМногофункциональныхДокументов() Экспорт +``` + +Пример вызова +```bsl +Результат = АттестацииСотрудниковКлиентСервер.ТипыМногофункциональныхДокументов() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БазовыеСправочныеДанные.md b/src/content/docs/zup/БазовыеСправочныеДанные.md new file mode 100644 index 0000000..eadaefe --- /dev/null +++ b/src/content/docs/zup/БазовыеСправочныеДанные.md @@ -0,0 +1,81 @@ +--- +title: Базовые справочные данные +slug: zup/базовые-справочные-данные +--- + + +## ПриПолученииПредопределенныхНаборовСвойств +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеСвойствамиПереопределяемый.ПриПолученииПредопределенныхНаборовСвойств. +Процедура ПриПолученииПредопределенныхНаборовСвойств(Наборы) Экспорт +``` + +Пример вызова +```bsl +БазовыеСправочныеДанные.ПриПолученииПредопределенныхНаборовСвойств(Наборы) +``` +
+ +## ЗаполнитьРеквизитыОбъектаДокументооборота +
+ +Описание, пример вызова + +```bsl + +// См. ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ЗаполнитьРеквизитыИзПотребителя. +Процедура ЗаполнитьРеквизитыОбъектаДокументооборота(Прокси, ОбъектXDTO, СсылкаНаПотребитель) Экспорт +``` + +Пример вызова +```bsl +БазовыеСправочныеДанные.ЗаполнитьРеквизитыОбъектаДокументооборота(Прокси, ОбъектXDTO, СсылкаНаПотребитель) +``` +
+ +## ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO +
+ +Описание, пример вызова + +```bsl + +// См. ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO. +Процедура ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO(Результат, ЗначениеЗаполнения, ТипРеквизита, ИмяРеквизита, Экспорт +``` + +Пример вызова +```bsl +БазовыеСправочныеДанные.ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO(Результат, ЗначениеЗаполнения, ТипРеквизита, ИмяРеквизита, ); +``` +
+ +## ДополнитьСоответствиеТипов +
+ +Описание, пример вызова + +```bsl + +// См. ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ДополнитьСоответствиеТипов. +Процедура ДополнитьСоответствиеТипов(Таблица) Экспорт +``` + +Пример вызова +```bsl +БазовыеСправочныеДанные.ДополнитьСоответствиеТипов(Таблица) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БанковскиеКарты.md b/src/content/docs/zup/БанковскиеКарты.md new file mode 100644 index 0000000..0eedfc6 --- /dev/null +++ b/src/content/docs/zup/БанковскиеКарты.md @@ -0,0 +1,200 @@ +--- +title: Банковские карты +slug: zup/банковские-карты +--- + + +## РазрешенПросмотрПолногоНомераКарты +
+ +Описание, пример вызова + +```bsl + +// Показывает установку права просмотра основного номера держателя карты +// для текущего пользователя на момент выполнения текущей строчки кода. +// +// Возвращаемое значение: +// Булево - Истина, если есть право просмотра основного номера держателя карты. +// Если в момент выполнения метода установлен привилегированный режим, +// то всегда возвращается Истина +// +Функция РазрешенПросмотрПолногоНомераКарты() Экспорт +``` + +Пример вызова +```bsl +Результат = БанковскиеКарты.РазрешенПросмотрПолногоНомераКарты() +``` +
+ +## МаскированныйНомерКарты +
+ +Описание, пример вызова + +```bsl + +// Возвращает маскированный номер карты (первые 6 и 4 последних цифры номера, остальное - *). +// +// Параметры: +// Карта - СправочникСсылка.БанковскиеКартыКонтрагентов - карта, номер которой нужно получить +// +// Возвращаемое значение: +// Строка - маскированный номер карты. +// +Функция МаскированныйНомерКарты(Знач Карта) Экспорт +``` + +Пример вызова +```bsl +Результат = БанковскиеКарты.МаскированныйНомерКарты(Карта) +``` +
+ +## МаскированныеНомераКарт +
+ +Описание, пример вызова + +```bsl + +// Возвращает маскированные номера карт (первые 6 и 4 последних цифры номера, остальное - *). +// +// Параметры: +// Карты - Массив из СправочникСсылка.БанковскиеКартыКонтрагентов, +// ФиксированныйМассив из СправочникСсылка.БанковскиеКартыКонтрагентов - карты, номера которых нужно получить. +// +// Возвращаемое значение: +// Соответствие: +// * Ключ - СправочникСсылка.БанковскиеКартыКонтрагентов, +// * Значение - Строка. +// +Функция МаскированныеНомераКарт(Знач Карты) Экспорт +``` + +Пример вызова +```bsl +Результат = БанковскиеКарты.МаскированныеНомераКарт(Карты) +``` +
+ +## ПолныйНомерКарты +
+ +Описание, пример вызова + +```bsl + +// Возвращает полный номер карты (основной номер держателя карты). +// +// Параметры: +// Карта - СправочникСсылка.БанковскиеКартыКонтрагентов - карта, номер которой нужно получить +// +// Возвращаемое значение: +// Строка - полный номер карты. +// +Функция ПолныйНомерКарты(Знач Карта) Экспорт +``` + +Пример вызова +```bsl +Результат = БанковскиеКарты.ПолныйНомерКарты(Карта) +``` +
+ +## ПолныеНомераКарт +
+ +Описание, пример вызова + +```bsl + +// Возвращает полные номера карт (основные номера держателей карт). +// +// Параметры: +// Карты - Массив из СправочникСсылка.БанковскиеКартыКонтрагентов, +// ФиксированныйМассив из СправочникСсылка.БанковскиеКартыКонтрагентов - карты, номера которых нужно получить. +// +// Возвращаемое значение: +// Соответствие: +// * Ключ - СправочникСсылка.БанковскиеКартыКонтрагентов, +// * Значение - Строка. +// +Функция ПолныеНомераКарт(Знач Карты) Экспорт +``` + +Пример вызова +```bsl +Результат = БанковскиеКарты.ПолныеНомераКарт(Карты) +``` +
+ +## ЭтоНациональныйПлатежныйИнструмент +
+ +Описание, пример вызова + +```bsl + +// Показывает, что является ли карта национальным платежным инструментом (картой «Мир»). +// Если передана ссылка, то результат определяется значением свойства ЭтоНациональныйПлатежныйИнструмент элемента. +// Если указана строка, то результат вычисляется по БИН переданного номера карты. +// +// Параметры: +// Карта - СправочникСсылка.БанковскиеКартыКонтрагентов - карта +// - Строка - полный номер карты (основной номер держателя карты) +// +// Возвращаемое значение: +// Булево - Истина, если карта является национальным платежным инструментом (картой «Мир»). +// +Функция ЭтоНациональныйПлатежныйИнструмент(Знач Карта) Экспорт +``` + +Пример вызова +```bsl +Результат = БанковскиеКарты.ЭтоНациональныйПлатежныйИнструмент(Карта) +``` +
+ +## Добавить +
+ +Описание, пример вызова + +```bsl + +// Добавляет в хранилище новую банковскую карту с указанным номером или реквизитами. +// Если у владельца уже есть карта с указанным номером, то обновляется существующий элемент справочника. +// Если действующая карта с указанным номером уже зарегистрирована на другого держателя, то возникнет исключение. +// +// Параметры: +// ДержательКарты - Справочник.ФизическиеЛица - держатель карты. +// Карта - Строка - полный номер карты (основной номер держателя карты) +// - Структура, ФиксированнаяСтруктура - основные реквизиты карты, может содержать свойства: +// * ОсновнойНомерДержателяКарты - Строка - Основной номер держателя карты; +// * ИмяДержателяКарты - Строка - Имя держателя карты (эмбоссированный текст); +// * ДатаИстеченияСрокаДействияКарты - Дата - Дата истечения срока действия карты +// Свойства - Структура, ФиксированнаяСтруктура - свойства карты, может содержать свойства: +// * ЭтоНациональныйПлатежныйИнструмент - Булево; +// * ЭтоМеждународнаяПлатежнаяКарта - Булево; +// +// Возвращаемое значение: +// СправочникСсылка.БанковскиеКартыКонтрагентов - созданная карта. +// +Функция Добавить(Знач ДержательКарты, Знач Карта, Знач Свойства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = БанковскиеКарты.Добавить(ДержательКарты, Карта, Свойства); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БанковскиеКартыСлужебныйКлиентСервер.md b/src/content/docs/zup/БанковскиеКартыСлужебныйКлиентСервер.md new file mode 100644 index 0000000..50059ae --- /dev/null +++ b/src/content/docs/zup/БанковскиеКартыСлужебныйКлиентСервер.md @@ -0,0 +1,61 @@ +--- +title: Банковские карты служебный клиент сервер +slug: zup/банковские-карты-служебный-клиент-сервер +--- + + +## МаскированныйНомер +
+ +Описание, пример вызова + +```bsl + +Функция МаскированныйНомер(Знач ПолныйНомер) Экспорт +``` + +Пример вызова +```bsl +Результат = БанковскиеКартыСлужебныйКлиентСервер.МаскированныйНомер(ПолныйНомер) +``` +
+ +## ЭтоНомерНациональногоПлатежногоИнструмента +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоНомерНациональногоПлатежногоИнструмента(Знач ОсновнойНомерДержателяКарты) Экспорт +``` + +Пример вызова +```bsl +Результат = БанковскиеКартыСлужебныйКлиентСервер.ЭтоНомерНациональногоПлатежногоИнструмента(ОсновнойНомерДержателяКарты) +``` +
+ +## ОшибкиОсновногоНомераДержателяКарты +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкиОсновногоНомераДержателяКарты(ОсновнойНомерДержателяКарты, ЭтоНациональныйПлатежныйИнструмент = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = БанковскиеКартыСлужебныйКлиентСервер.ОшибкиОсновногоНомераДержателяКарты(ОсновнойНомерДержателяКарты, ЭтоНациональныйПлатежныйИнструмент); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковВызовСервера.md b/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковВызовСервера.md new file mode 100644 index 0000000..fac71a7 --- /dev/null +++ b/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковВызовСервера.md @@ -0,0 +1,109 @@ +--- +title: Бизнес процессы заявок сотрудников вызов сервера +slug: zup/бизнес-процессы-заявок-сотрудников-вызов-сервера +--- + + +## ФормаОткрытияТекущейЗадачиБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +Функция ФормаОткрытияТекущейЗадачиБизнесПроцесса(БизнесПроцесс) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыЗаявокСотрудниковВызовСервера.ФормаОткрытияТекущейЗадачиБизнесПроцесса(БизнесПроцесс) +``` +
+ +## ФайлЗаявки +
+ +Описание, пример вызова + +```bsl + +Функция ФайлЗаявки(БизнесПроцесс) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыЗаявокСотрудниковВызовСервера.ФайлЗаявки(БизнесПроцесс) +``` +
+ +## ВыполненоВыполнить +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполненоВыполнить(Заявка, СостояниеЗапроса, Исполнитель) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковВызовСервера.ВыполненоВыполнить(Заявка, СостояниеЗапроса, Исполнитель) +``` +
+ +## Отказать +
+ +Описание, пример вызова + +```bsl + +Процедура Отказать(Заявка, СостояниеЗапроса, Исполнитель) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковВызовСервера.Отказать(Заявка, СостояниеЗапроса, Исполнитель) +``` +
+ +## ЭтоЗаявкаСотрудника +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоЗаявкаСотрудника(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыЗаявокСотрудниковВызовСервера.ЭтоЗаявкаСотрудника(Ссылка) +``` +
+ +## ОбращенияСотрудникаСоШтампами +
+ +Описание, пример вызова + +```bsl + +Функция ОбращенияСотрудникаСоШтампами(ЭлектронныйДокумент) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыЗаявокСотрудниковВызовСервера.ОбращенияСотрудникаСоШтампами(ЭлектронныйДокумент) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковКлиент.md b/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковКлиент.md new file mode 100644 index 0000000..0930140 --- /dev/null +++ b/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковКлиент.md @@ -0,0 +1,397 @@ +--- +title: Бизнес процессы заявок сотрудников клиент +slug: zup/бизнес-процессы-заявок-сотрудников-клиент +--- + + +## ПриОткрытии +
+ +Описание, пример вызова + +```bsl + +Процедура ПриОткрытии(Форма, Отказ) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ПриОткрытии(Форма, Отказ) +``` +
+ +## ОбработкаВыбора +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаВыбора(Форма, ВыбранноеЗначение, ИсточникВыбора, КонтекстВыбора) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ОбработкаВыбора(Форма, ВыбранноеЗначение, ИсточникВыбора, КонтекстВыбора) +``` +
+ +## ОбработкаОповещения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) +``` +
+ +## ПослеЗаписи +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеЗаписи(Форма, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ПослеЗаписи(Форма, ПараметрыЗаписи) +``` +
+ +## ПредметНажатие +
+ +Описание, пример вызова + +```bsl + +Процедура ПредметНажатие(Форма, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ПредметНажатие(Форма, СтандартнаяОбработка) +``` +
+ +## ИнфоНадписьЗаголовокОбработкаНавигационнойСсылки +
+ +Описание, пример вызова + +```bsl + +Процедура ИнфоНадписьЗаголовокОбработкаНавигационнойСсылки(Форма, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ИнфоНадписьЗаголовокОбработкаНавигационнойСсылки(Форма, СтандартнаяОбработка) +``` +
+ +## ИсполнительНачалоВыбора +
+ +Описание, пример вызова + +```bsl + +Процедура ИсполнительНачалоВыбора(Форма, Элемент, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ИсполнительНачалоВыбора(Форма, Элемент, СтандартнаяОбработка) +``` +
+ +## ИсполнительПриИзменении +
+ +Описание, пример вызова + +```bsl + +Процедура ИсполнительПриИзменении(Форма, ОткрытаФормаВыбораИсполнителя, КонтекстВыбора, ИспользуетсяСОбъектамиАдресации) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ИсполнительПриИзменении(Форма, ОткрытаФормаВыбораИсполнителя, КонтекстВыбора, ИспользуетсяСОбъектамиАдресации) +``` +
+ +## ИсполнительОбработкаВыбора +
+ +Описание, пример вызова + +```bsl + +Процедура ИсполнительОбработкаВыбора(Форма, Элемент, ВыбранноеЗначение, СтандартнаяОбработка, ОткрытаФормаВыбораИсполнителя) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ИсполнительОбработкаВыбора(Форма, Элемент, ВыбранноеЗначение, СтандартнаяОбработка, ОткрытаФормаВыбораИсполнителя) +``` +
+ +## ИсполнительАвтоПодбор +
+ +Описание, пример вызова + +```bsl + +Процедура ИсполнительАвтоПодбор(Текст, ДанныеВыбора, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ИсполнительАвтоПодбор(Текст, ДанныеВыбора, СтандартнаяОбработка) +``` +
+ +## ИсполнительОкончаниеВводаТекста +
+ +Описание, пример вызова + +```bsl + +Процедура ИсполнительОкончаниеВводаТекста(Элемент, Текст, ДанныеВыбора, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ИсполнительОкончаниеВводаТекста(Элемент, Текст, ДанныеВыбора, СтандартнаяОбработка) +``` +
+ +## СрокИсполненияПриИзменении +
+ +Описание, пример вызова + +```bsl + +Процедура СрокИсполненияПриИзменении(Форма, Элемент) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.СрокИсполненияПриИзменении(Форма, Элемент) +``` +
+ +## ЗаписатьИЗакрыть +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаписатьИЗакрыть(Форма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ЗаписатьИЗакрыть(Форма) +``` +
+ +## Остановить +
+ +Описание, пример вызова + +```bsl + +Процедура Остановить(Форма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.Остановить(Форма) +``` +
+ +## ПродолжитьБизнесПроцесс +
+ +Описание, пример вызова + +```bsl + +Процедура ПродолжитьБизнесПроцесс(Форма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ПродолжитьБизнесПроцесс(Форма) +``` +
+ +## НастроитьОтложенныйСтарт +
+ +Описание, пример вызова + +```bsl + +Процедура НастроитьОтложенныйСтарт(Форма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.НастроитьОтложенныйСтарт(Форма) +``` +
+ +## УстановитьДокументОбращенияСотрудника +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьДокументОбращенияСотрудника(УправляемаяФорма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.УстановитьДокументОбращенияСотрудника(УправляемаяФорма) +``` +
+ +## ПринятьЗадачуКИсполнению +
+ +Описание, пример вызова + +```bsl + +Процедура ПринятьЗадачуКИсполнению(Форма, ТекущийПользователь) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ПринятьЗадачуКИсполнению(Форма, ТекущийПользователь) +``` +
+ +## ПодписатьЭПФайлыОтвета +
+ +Описание, пример вызова + +```bsl + +Процедура ПодписатьЭПФайлыОтвета(Форма, ОписаниеОповещения, МассивФайлов, ЭтоФайлПечатнойФормы = Ложь) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ПодписатьЭПФайлыОтвета(Форма, ОписаниеОповещения, МассивФайлов, ЭтоФайлПечатнойФормы); +``` +
+ +## ПодписатьЗаявкуЭП +
+ +Описание, пример вызова + +```bsl + +Процедура ПодписатьЗаявкуЭП(Форма, ИмяПроцедуры) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ПодписатьЗаявкуЭП(Форма, ИмяПроцедуры) +``` +
+ +## СохранитьШаблонОтвета +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьШаблонОтвета(Форма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.СохранитьШаблонОтвета(Форма) +``` +
+ +## ВыполненоВыполнитьЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполненоВыполнитьЗавершение(Форма, Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ВыполненоВыполнитьЗавершение(Форма, Результат, ДополнительныеПараметры) +``` +
+ +## ОтказатьЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ОтказатьЗавершение(Форма, Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ОтказатьЗавершение(Форма, Результат, ДополнительныеПараметры) +``` +
+ +## ПоказатьОснованиеДокументаКадровогоЭДО +
+ +Описание, пример вызова + +```bsl + +Процедура ПоказатьОснованиеДокументаКадровогоЭДО(ОснованиеДокумента, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиент.ПоказатьОснованиеДокументаКадровогоЭДО(ОснованиеДокумента, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковКлиентСервер.md b/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковКлиентСервер.md new file mode 100644 index 0000000..57e3d77 --- /dev/null +++ b/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковКлиентСервер.md @@ -0,0 +1,63 @@ +--- +title: Бизнес процессы заявок сотрудников клиент сервер +slug: zup/бизнес-процессы-заявок-сотрудников-клиент-сервер +--- + + +## УстановитьСвойстваЭлементовФормы +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьСвойстваЭлементовФормы(Форма) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковКлиентСервер.УстановитьСвойстваЭлементовФормы(Форма) +``` +
+ +## РазмерФайлаСтрокой +
+ +Описание, пример вызова + +```bsl + +// Принимает размер в байтах. +// Возвращает строку, например: 7.2 Кбайт, 35 Кбайт, 5.5 Мбайт, 12 Мбайт +Функция РазмерФайлаСтрокой(Размер) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыЗаявокСотрудниковКлиентСервер.РазмерФайлаСтрокой(Размер) +``` +
+ +## СообщениеОСтатусеЗадания +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеОСтатусеЗадания(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = БизнесПроцессыЗаявокСотрудниковКлиентСервер.СообщениеОСтатусеЗадания(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковСобытия.md b/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковСобытия.md new file mode 100644 index 0000000..0a535cc --- /dev/null +++ b/src/content/docs/zup/БизнесПроцессыЗаявокСотрудниковСобытия.md @@ -0,0 +1,45 @@ +--- +title: Бизнес процессы заявок сотрудников события +slug: zup/бизнес-процессы-заявок-сотрудников-события +--- + + +## ЗавершитьЗаявкиСотрудниковПослеПодписанияСправок +
+ +Описание, пример вызова + +```bsl + +Процедура ЗавершитьЗаявкиСотрудниковПослеПодписанияСправок() Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковСобытия.ЗавершитьЗаявкиСотрудниковПослеПодписанияСправок() +``` +
+ +## ОтметитьОжидающиеПодписиЗаявкиСотрудника +
+ +Описание, пример вызова + +```bsl + +Процедура ОтметитьОжидающиеПодписиЗаявкиСотрудника(Источник) Экспорт +``` + +Пример вызова +```bsl +БизнесПроцессыЗаявокСотрудниковСобытия.ОтметитьОжидающиеПодписиЗаявкиСотрудника(Источник) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БлокировкаИзмененияОбъектов.md b/src/content/docs/zup/БлокировкаИзмененияОбъектов.md new file mode 100644 index 0000000..759264e --- /dev/null +++ b/src/content/docs/zup/БлокировкаИзмененияОбъектов.md @@ -0,0 +1,130 @@ +--- +title: Блокировка изменения объектов +slug: zup/блокировка-изменения-объектов +--- + + +## ПриСозданииНаСервереФормыОбъекта +
+ +Описание, пример вызова + +```bsl + +// В форме нового документа выводит группу с информацией о причинах блокировки +// Вызывается из события ПриСозданииНаСервере формы объекта. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// Отказ - Булево +// СтандартнаяОбработка - Булево +// +Процедура ПриСозданииНаСервереФормыОбъекта(УправляемаяФорма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БлокировкаИзмененияОбъектов.ПриСозданииНаСервереФормыОбъекта(УправляемаяФорма, Отказ, СтандартнаяОбработка) +``` +
+ +## ПриЧтенииНаСервереФормыОбъекта +
+ +Описание, пример вызова + +```bsl + +// В форме существующего документа выводит группу с информацией о причинах блокировки +// Вызывается из события ПриЧтенииНаСервере формы объекта. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// ТекущийОбъект - ДокументОбъект - объект, который будет прочитан. +// +Процедура ПриЧтенииНаСервереФормыОбъекта(УправляемаяФорма, ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +БлокировкаИзмененияОбъектов.ПриЧтенииНаСервереФормыОбъекта(УправляемаяФорма, ТекущийОбъект) +``` +
+ +## ПослеЗаписиНаСервереФормыОбъекта +
+ +Описание, пример вызова + +```bsl + +// В форме документа обновляет сведения о блокировках +// Вызывается из события ПослеЗаписиНаСервере формы объекта. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// ТекущийОбъект - ДокументОбъект - объект. +// ПараметрыЗаписи - Структура +// +Процедура ПослеЗаписиНаСервереФормыОбъекта(УправляемаяФорма, ТекущийОбъект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +БлокировкаИзмененияОбъектов.ПослеЗаписиНаСервереФормыОбъекта(УправляемаяФорма, ТекущийОбъект, ПараметрыЗаписи) +``` +
+ +## ПриСозданииНаСервереФормыСписка +
+ +Описание, пример вызова + +```bsl + +// В форме списка документа в меню Еще выводит команду отмены блокировки документов +// Вызывается из события ПриСозданииНаСервере формы списка. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// КоманднаяПанель - ГруппаФормы - командная панель или группа команд, в которую выводится команда. +// +Процедура ПриСозданииНаСервереФормыСписка(УправляемаяФорма, КоманднаяПанель) Экспорт +``` + +Пример вызова +```bsl +БлокировкаИзмененияОбъектов.ПриСозданииНаСервереФормыСписка(УправляемаяФорма, КоманднаяПанель) +``` +
+ +## ПриСозданииНаСервереЗаблокированнойФормыСписка +
+ +Описание, пример вызова + +```bsl + +// Открывает для просмотра форму списка независимого регистра сведений. Для полноправного пользователя в меню Еще выводит команду разблокировки. +// Вызывается из события ПриСозданииНаСервере формы списка. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// КоманднаяПанель - ГруппаФормы - командная панель или группа команд, в которую выводится команда. +// +Процедура ПриСозданииНаСервереЗаблокированнойФормыСписка(УправляемаяФорма, КоманднаяПанель) Экспорт +``` + +Пример вызова +```bsl +БлокировкаИзмененияОбъектов.ПриСозданииНаСервереЗаблокированнойФормыСписка(УправляемаяФорма, КоманднаяПанель) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БлокировкаИзмененияОбъектовБазовый.md b/src/content/docs/zup/БлокировкаИзмененияОбъектовБазовый.md new file mode 100644 index 0000000..f0c60da --- /dev/null +++ b/src/content/docs/zup/БлокировкаИзмененияОбъектовБазовый.md @@ -0,0 +1,29 @@ +--- +title: Блокировка изменения объектов базовый +slug: zup/блокировка-изменения-объектов-базовый +--- + + +## ПараметрыБлокировкиИзмененияОбъекта +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыБлокировкиИзмененияОбъекта(СсылкаНаОбъект, УправляемаяФорма) Экспорт +``` + +Пример вызова +```bsl +Результат = БлокировкаИзмененияОбъектовБазовый.ПараметрыБлокировкиИзмененияОбъекта(СсылкаНаОбъект, УправляемаяФорма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БлокировкаИзмененияОбъектовВнутренний.md b/src/content/docs/zup/БлокировкаИзмененияОбъектовВнутренний.md new file mode 100644 index 0000000..2aa2884 --- /dev/null +++ b/src/content/docs/zup/БлокировкаИзмененияОбъектовВнутренний.md @@ -0,0 +1,29 @@ +--- +title: Блокировка изменения объектов внутренний +slug: zup/блокировка-изменения-объектов-внутренний +--- + + +## ПараметрыБлокировкиИзмененияОбъекта +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыБлокировкиИзмененияОбъекта(СсылкаНаОбъект, УправляемаяФорма) Экспорт +``` + +Пример вызова +```bsl +Результат = БлокировкаИзмененияОбъектовВнутренний.ПараметрыБлокировкиИзмененияОбъекта(СсылкаНаОбъект, УправляемаяФорма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БлокировкаИзмененияОбъектовВызовСервера.md b/src/content/docs/zup/БлокировкаИзмененияОбъектовВызовСервера.md new file mode 100644 index 0000000..fffffb5 --- /dev/null +++ b/src/content/docs/zup/БлокировкаИзмененияОбъектовВызовСервера.md @@ -0,0 +1,45 @@ +--- +title: Блокировка изменения объектов вызов сервера +slug: zup/блокировка-изменения-объектов-вызов-сервера +--- + + +## ПараметрыБлокировкиИзмененияОбъекта +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыБлокировкиИзмененияОбъекта(СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = БлокировкаИзмененияОбъектовВызовСервера.ПараметрыБлокировкиИзмененияОбъекта(СсылкаНаОбъект) +``` +
+ +## ДлительнаяОперацияРазблокировкиОбъектовСписка +
+ +Описание, пример вызова + +```bsl + +Функция ДлительнаяОперацияРазблокировкиОбъектовСписка(ОбъектыДляРазблокировки, УникальныйИдентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = БлокировкаИзмененияОбъектовВызовСервера.ДлительнаяОперацияРазблокировкиОбъектовСписка(ОбъектыДляРазблокировки, УникальныйИдентификатор) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БлокировкаИзмененияОбъектовКлиент.md b/src/content/docs/zup/БлокировкаИзмененияОбъектовКлиент.md new file mode 100644 index 0000000..c16a18a --- /dev/null +++ b/src/content/docs/zup/БлокировкаИзмененияОбъектовКлиент.md @@ -0,0 +1,79 @@ +--- +title: Блокировка изменения объектов клиент +slug: zup/блокировка-изменения-объектов-клиент +--- + + +## РазблокироватьФормуОбъекта +
+ +Описание, пример вызова + +```bsl + +// Разблокирует форму документа для редактирования. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// СсылкаНаОбъект - ДокументСсылка +// +Процедура РазблокироватьФормуОбъекта(УправляемаяФорма, СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +БлокировкаИзмененияОбъектовКлиент.РазблокироватьФормуОбъекта(УправляемаяФорма, СсылкаНаОбъект) +``` +
+ +## РазблокироватьОбъектыСписка +
+ +Описание, пример вызова + +```bsl + +// Разблокирует объекты выделенных строк списка документов для редактирования. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// Список - ДинамическийСписок +// ВыделенныеСтроки - Массив +// +Процедура РазблокироватьОбъектыСписка(УправляемаяФорма, Список, ВыделенныеСтроки) Экспорт +``` + +Пример вызова +```bsl +БлокировкаИзмененияОбъектовКлиент.РазблокироватьОбъектыСписка(УправляемаяФорма, Список, ВыделенныеСтроки) +``` +
+ +## РазблокироватьФормуСписка +
+ +Описание, пример вызова + +```bsl + +// Разблокирует форму списка, открытую в режиме просмотра. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// +Процедура РазблокироватьФормуСписка(УправляемаяФорма) Экспорт +``` + +Пример вызова +```bsl +БлокировкаИзмененияОбъектовКлиент.РазблокироватьФормуСписка(УправляемаяФорма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БлокировкаИзмененияОбъектовКлиентСервер.md b/src/content/docs/zup/БлокировкаИзмененияОбъектовКлиентСервер.md new file mode 100644 index 0000000..068afda --- /dev/null +++ b/src/content/docs/zup/БлокировкаИзмененияОбъектовКлиентСервер.md @@ -0,0 +1,45 @@ +--- +title: Блокировка изменения объектов клиент сервер +slug: zup/блокировка-изменения-объектов-клиент-сервер +--- + + +## ОбновитьГруппуБлокировкиИзмененияОбъекта +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьГруппуБлокировкиИзмененияОбъекта(УправляемаяФорма, ОбновитьПараметрыБлокировкиИзмененияОбъекта = Ложь, РазрешитьИзменениеОбъекта = Неопределено) Экспорт +``` + +Пример вызова +```bsl +БлокировкаИзмененияОбъектовКлиентСервер.ОбновитьГруппуБлокировкиИзмененияОбъекта(УправляемаяФорма, ОбновитьПараметрыБлокировкиИзмененияОбъекта, РазрешитьИзменениеОбъекта); +``` +
+ +## ФормаПроинициализирована +
+ +Описание, пример вызова + +```bsl + +Функция ФормаПроинициализирована(УправляемаяФорма) Экспорт +``` + +Пример вызова +```bsl +Результат = БлокировкаИзмененияОбъектовКлиентСервер.ФормаПроинициализирована(УправляемаяФорма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БлокировкаИзмененияОбъектовРасширенный.md b/src/content/docs/zup/БлокировкаИзмененияОбъектовРасширенный.md new file mode 100644 index 0000000..32cd007 --- /dev/null +++ b/src/content/docs/zup/БлокировкаИзмененияОбъектовРасширенный.md @@ -0,0 +1,29 @@ +--- +title: Блокировка изменения объектов расширенный +slug: zup/блокировка-изменения-объектов-расширенный +--- + + +## ПараметрыБлокировкиИзмененияОбъекта +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыБлокировкиИзмененияОбъекта(СсылкаНаОбъект, УправляемаяФорма) Экспорт +``` + +Пример вызова +```bsl +Результат = БлокировкаИзмененияОбъектовРасширенный.ПараметрыБлокировкиИзмененияОбъекта(СсылкаНаОбъект, УправляемаяФорма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БлокировкаИзмененияОбъектовСобытия.md b/src/content/docs/zup/БлокировкаИзмененияОбъектовСобытия.md new file mode 100644 index 0000000..182c82a --- /dev/null +++ b/src/content/docs/zup/БлокировкаИзмененияОбъектовСобытия.md @@ -0,0 +1,29 @@ +--- +title: Блокировка изменения объектов события +slug: zup/блокировка-изменения-объектов-события +--- + + +## ЗапретитьИзменениеДокументаПоФизическомуЛицу +
+ +Описание, пример вызова + +```bsl + +Процедура ЗапретитьИзменениеДокументаПоФизическомуЛицу(Источник) Экспорт +``` + +Пример вызова +```bsl +БлокировкаИзмененияОбъектовСобытия.ЗапретитьИзменениеДокументаПоФизическомуЛицу(Источник) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БронированиеКомандировок.md b/src/content/docs/zup/БронированиеКомандировок.md new file mode 100644 index 0000000..5840e05 --- /dev/null +++ b/src/content/docs/zup/БронированиеКомандировок.md @@ -0,0 +1,70 @@ +--- +title: Бронирование командировок +slug: zup/бронирование-командировок +--- + + +## НовыеНастройкиСистемыБронирования +
+ +Описание, пример вызова + +```bsl + +// Создает новую структуру настроек подключения к сервису +// +// Возвращаемое значение: +// Структура: +// * Логин - Строка, +// * Пароль - Строка. +// +Функция НовыеНастройкиСистемыБронирования() Экспорт +``` + +Пример вызова +```bsl +Результат = БронированиеКомандировок.НовыеНастройкиСистемыБронирования() +``` +
+ +## ЗаполнитьНастройкиСистемыБронирования +
+ +Описание, пример вызова + +```bsl + +// См. БронированиеКомандировокПереопределяемый.ЗаполнитьНастройкиСистемыБронирования. +Процедура ЗаполнитьНастройкиСистемыБронирования(Настройки, СистемаБронирования) Экспорт +``` + +Пример вызова +```bsl +БронированиеКомандировок.ЗаполнитьНастройкиСистемыБронирования(Настройки, СистемаБронирования) +``` +
+ +## СохранитьНастройкиСистемыБронирования +
+ +Описание, пример вызова + +```bsl + +// См. БронированиеКомандировокПереопределяемый.СохранитьНастройкиСистемыБронирования. +Процедура СохранитьНастройкиСистемыБронирования(Настройки, СистемаБронирования) Экспорт +``` + +Пример вызова +```bsl +БронированиеКомандировок.СохранитьНастройкиСистемыБронирования(Настройки, СистемаБронирования) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БронированиеКомандировокПереопределяемый.md b/src/content/docs/zup/БронированиеКомандировокПереопределяемый.md new file mode 100644 index 0000000..405d74a --- /dev/null +++ b/src/content/docs/zup/БронированиеКомандировокПереопределяемый.md @@ -0,0 +1,59 @@ +--- +title: Бронирование командировок переопределяемый +slug: zup/бронирование-командировок-переопределяемый +--- + + +## ЗаполнитьНастройкиСистемыБронирования +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру настроек подключения к сервису системы бронирования командировок +// +// Параметры: +// Настройки - Структура - см. БронированиеКомандировок.НовыеНастройкиСистемыБронирования, +// СистемаБронирования - Перечисления.СистемыБронированияКомандировок +// СтандартнаяОбработка - Булево - флаг необходимости дальнейшего заполнения настроек подключения. +// +Процедура ЗаполнитьНастройкиСистемыБронирования(Настройки, СистемаБронирования, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БронированиеКомандировокПереопределяемый.ЗаполнитьНастройкиСистемыБронирования(Настройки, СистемаБронирования, СтандартнаяОбработка) +``` +
+ +## СохранитьНастройкиСистемыБронирования +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройки подключения к системе бронирования командировок +// +// Параметры: +// Настройки - Структура - см. БронированиеКомандировок.НовыеНастройкиСистемыБронирования, +// СистемаБронирования - Перечисления.СистемыБронированияКомандировок. +// СтандартнаяОбработка - Булево - флаг необходимости дальнейшего сохранения настроек подключения. +// +Процедура СохранитьНастройкиСистемыБронирования(Настройки, СистемаБронирования, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +БронированиеКомандировокПереопределяемый.СохранитьНастройкиСистемыБронирования(Настройки, СистемаБронирования, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БухучетХозрасчетныхОрганизаций.md b/src/content/docs/zup/БухучетХозрасчетныхОрганизаций.md new file mode 100644 index 0000000..700011c --- /dev/null +++ b/src/content/docs/zup/БухучетХозрасчетныхОрганизаций.md @@ -0,0 +1,139 @@ +--- +title: Бухучет хозрасчетных организаций +slug: zup/бухучет-хозрасчетных-организаций +--- + + +## ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения(ИсточникиДанных) Экспорт +``` + +Пример вызова +```bsl +БухучетХозрасчетныхОрганизаций.ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения(ИсточникиДанных) +``` +
+ +## ПриЗаполненииСписковСОграничениемДоступа +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступомПереопределяемый.ПриЗаполненииСписковСОграничениемДоступа. +Процедура ПриЗаполненииСписковСОграничениемДоступа(Списки) Экспорт +``` + +Пример вызова +```bsl +БухучетХозрасчетныхОрганизаций.ПриЗаполненииСписковСОграничениемДоступа(Списки) +``` +
+ +## ПриОпределенииОбъектовСКомандамиПечати +
+ +Описание, пример вызова + +```bsl + +// Определяет объекты, в которых есть процедура ДобавитьКомандыПечати(). +// Подробнее см. УправлениеПечатьюПереопределяемый. +// +// Параметры: +// СписокОбъектов - Массив - список менеджеров объектов. +// +Процедура ПриОпределенииОбъектовСКомандамиПечати(СписокОбъектов) Экспорт +``` + +Пример вызова +```bsl +БухучетХозрасчетныхОрганизаций.ПриОпределенииОбъектовСКомандамиПечати(СписокОбъектов) +``` +
+ +## НастроитьВариантыОтчетов +
+ +Описание, пример вызова + +```bsl + +// Содержит настройки размещения вариантов отчетов в панели отчетов. +// Описание см. ЗарплатаКадрыВариантыОтчетов.НастроитьВариантыОтчетов. +// +Процедура НастроитьВариантыОтчетов(Настройки) Экспорт +``` + +Пример вызова +```bsl +БухучетХозрасчетныхОрганизаций.НастроитьВариантыОтчетов(Настройки) +``` +
+ +## ЗаполнитьИмяДокументаОтраженияВБухучете +
+ +Описание, пример вызова + +```bsl + +// Определяет имя документа, которым выполняется отражение зарплаты в бухгалтерском учете. +// +Процедура ЗаполнитьИмяДокументаОтраженияВБухучете(ИмяДокументаОтраженияВБухучете) Экспорт +``` + +Пример вызова +```bsl +БухучетХозрасчетныхОрганизаций.ЗаполнитьИмяДокументаОтраженияВБухучете(ИмяДокументаОтраженияВБухучете) +``` +
+ +## ПриПолученииПредопределенныхНаборовСвойств +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеСвойствамиПереопределяемый.ПриПолученииПредопределенныхНаборовСвойств. +Процедура ПриПолученииПредопределенныхНаборовСвойств(Наборы) Экспорт +``` + +Пример вызова +```bsl +БухучетХозрасчетныхОрганизаций.ПриПолученииПредопределенныхНаборовСвойств(Наборы) +``` +
+ +## ЗарегистрироватьОбработчикиОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазыЗарплатаКадрыБазовый.ПриДобавленииОбработчиковОбновления. +Процедура ЗарегистрироватьОбработчикиОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +БухучетХозрасчетныхОрганизаций.ЗарегистрироватьОбработчикиОбновления(Обработчики) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/БухучетХозрасчетныхОрганизацийКлиент.md b/src/content/docs/zup/БухучетХозрасчетныхОрганизацийКлиент.md new file mode 100644 index 0000000..ea6c6de --- /dev/null +++ b/src/content/docs/zup/БухучетХозрасчетныхОрганизацийКлиент.md @@ -0,0 +1,29 @@ +--- +title: Бухучет хозрасчетных организаций клиент +slug: zup/бухучет-хозрасчетных-организаций-клиент +--- + + +## ОткрытьФормуСпискаДокументаОтражениеЗарплатыВБухучете +
+ +Описание, пример вызова + +```bsl + +Процедура ОткрытьФормуСпискаДокументаОтражениеЗарплатыВБухучете(ПараметрыФормы = Неопределено, ВладелецФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +БухучетХозрасчетныхОрганизацийКлиент.ОткрытьФормуСпискаДокументаОтражениеЗарплатыВБухучете(ПараметрыФормы, ВладелецФормы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыБазовый.md b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыБазовый.md new file mode 100644 index 0000000..a5c75b6 --- /dev/null +++ b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыБазовый.md @@ -0,0 +1,341 @@ +--- +title: Ведомость на выплату зарплаты базовый +slug: zup/ведомость-на-выплату-зарплаты-базовый +--- + + +## МенеджерДокументаПоВидуМестаВыплаты +
+ +Описание, пример вызова + +```bsl + +Функция МенеджерДокументаПоВидуМестаВыплаты(ВидМестаВыплаты) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыБазовый.МенеджерДокументаПоВидуМестаВыплаты(ВидМестаВыплаты) +``` +
+ +## ДобавитьКомандыПечатиПриВыплатеНаКарточки +
+ +Описание, пример вызова + +```bsl + +/// Печать + +Процедура ДобавитьКомандыПечатиПриВыплатеНаКарточки(КомандыПечати) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.ДобавитьКомандыПечатиПриВыплатеНаКарточки(КомандыПечати) +``` +
+ +## ПечатьПриВыплатеНаКарточки +
+ +Описание, пример вызова + +```bsl + +Процедура ПечатьПриВыплатеНаКарточки(МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.ПечатьПриВыплатеНаКарточки(МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) +``` +
+ +## ДобавитьКомандыПечатиПриВыплатеНаличными +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьКомандыПечатиПриВыплатеНаличными(КомандыПечати) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.ДобавитьКомандыПечатиПриВыплатеНаличными(КомандыПечати) +``` +
+ +## ПечатьПриВыплатеНаличными +
+ +Описание, пример вызова + +```bsl + +Процедура ПечатьПриВыплатеНаличными(МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.ПечатьПриВыплатеНаличными(МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) +``` +
+ +## ПечатьТ49 +
+ +Описание, пример вызова + +```bsl + +Функция ПечатьТ49(МассивОбъектов, ОбъектыПечати) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыБазовый.ПечатьТ49(МассивОбъектов, ОбъектыПечати)); +``` +
+ +## ПечатьТ53 +
+ +Описание, пример вызова + +```bsl + +Функция ПечатьТ53(МассивОбъектов, ОбъектыПечати) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыБазовый.ПечатьТ53(МассивОбъектов, ОбъектыПечати)); +``` +
+ +## МестоВыплатыКасса +
+ +Описание, пример вызова + +```bsl + +/// Места выплаты + +Функция МестоВыплатыКасса(Ведомость) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыБазовый.МестоВыплатыКасса(Ведомость) +``` +
+ +## УстановитьМестоВыплатыКасса +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьМестоВыплатыКасса(Ведомость, Значение) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.УстановитьМестоВыплатыКасса(Ведомость, Значение) +``` +
+ +## МожноЗаполнитьЗарплату +
+ +Описание, пример вызова + +```bsl + +//// Заполнение и расчет документа. + +Функция МожноЗаполнитьЗарплату(Ведомость) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыБазовый.МожноЗаполнитьЗарплату(Ведомость) +``` +
+ +## ПараметрыЗаполненияПоОбъекту +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыЗаполненияПоОбъекту(Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыБазовый.ПараметрыЗаполненияПоОбъекту(Объект) +``` +
+ +## ОграничитьЗарплатыСотрудниковПоСпособуМестуВыплат +
+ +Описание, пример вызова + +```bsl + +Процедура ОграничитьЗарплатыСотрудниковПоСпособуМестуВыплат(Зарплата, Регистратор, СпособВыплаты, ВидМестаВыплаты, МестоВыплаты, Округление) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.ОграничитьЗарплатыСотрудниковПоСпособуМестуВыплат(Зарплата, Регистратор, СпособВыплаты, ВидМестаВыплаты, МестоВыплаты, Округление) +``` +
+ +## СоздатьВТСотрудникиДляВедомостиПоШапке +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьВТСотрудникиДляВедомостиПоШапке(МенеджерВременныхТаблиц, ОписаниеОперации, ОтборСотрудников) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.СоздатьВТСотрудникиДляВедомостиПоШапке(МенеджерВременныхТаблиц, ОписаниеОперации, ОтборСотрудников) +``` +
+ +## СоздатьВТСотрудникиДляВедомостиПоМестуРаботы +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьВТСотрудникиДляВедомостиПоМестуРаботы(МенеджерВременныхТаблиц, ОписаниеОперации, ОтборСотрудников, ИмяВТСотрудники) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.СоздатьВТСотрудникиДляВедомостиПоМестуРаботы(МенеджерВременныхТаблиц, ОписаниеОперации, ОтборСотрудников, ИмяВТСотрудники)); +``` +
+ +## СоздатьВТСотрудникиДляВедомостиПоМестуВыплаты +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьВТСотрудникиДляВедомостиПоМестуВыплаты(МенеджерВременныхТаблиц, ОписаниеОперации, ОтборСотрудников, ИмяВТСотрудники) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.СоздатьВТСотрудникиДляВедомостиПоМестуВыплаты(МенеджерВременныхТаблиц, ОписаниеОперации, ОтборСотрудников, ИмяВТСотрудники)); +``` +
+ +## СоздатьВТСотрудникиДляВедомостиПоФизическимЛицам +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьВТСотрудникиДляВедомостиПоФизическимЛицам(МенеджерВременныхТаблиц, ФизическиеЛица, ОписаниеОперации, ОтборСотрудников) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.СоздатьВТСотрудникиДляВедомостиПоФизическимЛицам(МенеджерВременныхТаблиц, ФизическиеЛица, ОписаниеОперации, ОтборСотрудников) +``` +
+ +## ПараметрыПолученияСотрудниковПоШапкеВедомости +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыПолученияСотрудниковПоШапкеВедомости(ОписаниеОперации, ОтборСотрудников) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыБазовый.ПараметрыПолученияСотрудниковПоШапкеВедомости(ОписаниеОперации, ОтборСотрудников)); +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +///// Обработчики событий модуля объекта документов Ведомости. + +Процедура ОбработкаПроверкиЗаполнения(Ведомость, Отказ, ПроверяемыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.ОбработкаПроверкиЗаполнения(Ведомость, Отказ, ПроверяемыеРеквизиты) +``` +
+ +## СообщитьПользователюНезаполненоЗначениеСпособаЗачисления +
+ +Описание, пример вызова + +```bsl + +Процедура СообщитьПользователюНезаполненоЗначениеСпособаЗачисления(Строка, Поле, НаименованиеЗначения, Ведомость, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.СообщитьПользователюНезаполненоЗначениеСпособаЗачисления(Строка, Поле, НаименованиеЗначения, Ведомость, Отказ)); +``` +
+ +## ЗарегистрироватьВыплатуВУчетеНДФЛ +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьВыплатуВУчетеНДФЛ(Ведомость, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыБазовый.ЗарегистрироватьВыплатуВУчетеНДФЛ(Ведомость, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыВнутренний.md b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыВнутренний.md new file mode 100644 index 0000000..0a41cd8 --- /dev/null +++ b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыВнутренний.md @@ -0,0 +1,257 @@ +--- +title: Ведомость на выплату зарплаты внутренний +slug: zup/ведомость-на-выплату-зарплаты-внутренний +--- + + +## ПриИзмененииБанковскогоСчета +
+ +Описание, пример вызова + +```bsl + +Процедура ПриИзмененииБанковскогоСчета(БанковскийСчет, РеквизитыСчета) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.ПриИзмененииБанковскогоСчета(БанковскийСчет, РеквизитыСчета) +``` +
+ +## МенеджерДокументаПоВидуМестаВыплаты +
+ +Описание, пример вызова + +```bsl + +Функция МенеджерДокументаПоВидуМестаВыплаты(ВидМестаВыплаты) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыВнутренний.МенеджерДокументаПоВидуМестаВыплаты(ВидМестаВыплаты) +``` +
+ +## ДобавитьКомандыПечатиПриВыплатеНаКарточки +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьКомандыПечатиПриВыплатеНаКарточки(КомандыПечати) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.ДобавитьКомандыПечатиПриВыплатеНаКарточки(КомандыПечати) +``` +
+ +## ПечатьПриВыплатеНаКарточки +
+ +Описание, пример вызова + +```bsl + +Процедура ПечатьПриВыплатеНаКарточки(МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.ПечатьПриВыплатеНаКарточки(МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) +``` +
+ +## ДобавитьКомандыПечатиПриВыплатеНаличными +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьКомандыПечатиПриВыплатеНаличными(КомандыПечати) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.ДобавитьКомандыПечатиПриВыплатеНаличными(КомандыПечати) +``` +
+ +## ПечатьПриВыплатеНаличными +
+ +Описание, пример вызова + +```bsl + +Процедура ПечатьПриВыплатеНаличными(МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.ПечатьПриВыплатеНаличными(МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода) +``` +
+ +## МестоВыплатыКасса +
+ +Описание, пример вызова + +```bsl + +Функция МестоВыплатыКасса(Ведомость) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыВнутренний.МестоВыплатыКасса(Ведомость) +``` +
+ +## УстановитьМестоВыплатыКасса +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьМестоВыплатыКасса(Ведомость, Значение) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.УстановитьМестоВыплатыКасса(Ведомость, Значение) +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +/// Обработчики событий модуля объекта документов Ведомости. + +Процедура ОбработкаПроверкиЗаполнения(ДокументОбъект, Отказ, ПроверяемыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.ОбработкаПроверкиЗаполнения(ДокументОбъект, Отказ, ПроверяемыеРеквизиты) +``` +
+ +## ЗарегистрироватьВыплатуВУчетеНДФЛ +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьВыплатуВУчетеНДФЛ(Ведомость, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.ЗарегистрироватьВыплатуВУчетеНДФЛ(Ведомость, Отказ) +``` +
+ +## СоздатьВТСотрудникиДляВедомостиПоШапке +
+ +Описание, пример вызова + +```bsl + +/// Заполнение и расчет документа. + +Процедура СоздатьВТСотрудникиДляВедомостиПоШапке(МенеджерВременныхТаблиц, ОписаниеОперации, ОтборСотрудников) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.СоздатьВТСотрудникиДляВедомостиПоШапке(МенеджерВременныхТаблиц, ОписаниеОперации, ОтборСотрудников) +``` +
+ +## СоздатьВТСотрудникиДляВедомостиПоФизическимЛицам +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьВТСотрудникиДляВедомостиПоФизическимЛицам(МенеджерВременныхТаблиц, ФизическиеЛица, ОписаниеОперации, ОтборСотрудников) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.СоздатьВТСотрудникиДляВедомостиПоФизическимЛицам(МенеджерВременныхТаблиц, ФизическиеЛица, ОписаниеОперации, ОтборСотрудников) +``` +
+ +## ОграничитьЗарплатыСотрудниковПоСпособуМестуВыплат +
+ +Описание, пример вызова + +```bsl + +Процедура ОграничитьЗарплатыСотрудниковПоСпособуМестуВыплат(Зарплата, Регистратор, СпособВыплаты, ВидМестаВыплаты, МестоВыплаты, Округление) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыВнутренний.ОграничитьЗарплатыСотрудниковПоСпособуМестуВыплат(Зарплата, Регистратор, СпособВыплаты, ВидМестаВыплаты, МестоВыплаты, Округление) +``` +
+ +## МожноЗаполнитьЗарплату +
+ +Описание, пример вызова + +```bsl + +Функция МожноЗаполнитьЗарплату(Ведомость) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыВнутренний.МожноЗаполнитьЗарплату(Ведомость) +``` +
+ +## ПараметрыЗаполненияПоОбъекту +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыЗаполненияПоОбъекту(Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыВнутренний.ПараметрыЗаполненияПоОбъекту(Объект) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыРасширенный.md b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыРасширенный.md new file mode 100644 index 0000000..e79f6ef --- /dev/null +++ b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыРасширенный.md @@ -0,0 +1,93 @@ +--- +title: Ведомость на выплату зарплаты расширенный +slug: zup/ведомость-на-выплату-зарплаты-расширенный +--- + + +## МенеджерДокументаПоВидуМестаВыплаты +
+ +Описание, пример вызова + +```bsl + +Функция МенеджерДокументаПоВидуМестаВыплаты(ВидМестаВыплаты) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыРасширенный.МенеджерДокументаПоВидуМестаВыплаты(ВидМестаВыплаты) +``` +
+ +## СтатьяФинансированияИспользуется +
+ +Описание, пример вызова + +```bsl + +Функция СтатьяФинансированияИспользуется() Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыРасширенный.СтатьяФинансированияИспользуется() +``` +
+ +## СтатьяФинансированияОбязательна +
+ +Описание, пример вызова + +```bsl + +Функция СтатьяФинансированияОбязательна() Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыРасширенный.СтатьяФинансированияОбязательна() +``` +
+ +## СтатьяРасходовОбязательна +
+ +Описание, пример вызова + +```bsl + +Функция СтатьяРасходовОбязательна() Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыРасширенный.СтатьяРасходовОбязательна() +``` +
+ +## ПредставлениеРеквизитаСтатьяРасходов +
+ +Описание, пример вызова + +```bsl + +Функция ПредставлениеРеквизитаСтатьяРасходов() Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыРасширенный.ПредставлениеРеквизитаСтатьяРасходов() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыФормыБазовый.md b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыФормыБазовый.md new file mode 100644 index 0000000..eb8243f --- /dev/null +++ b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыФормыБазовый.md @@ -0,0 +1,45 @@ +--- +title: Ведомость на выплату зарплаты формы базовый +slug: zup/ведомость-на-выплату-зарплаты-формы-базовый +--- + + +## РедактированиеЗарплатыСтрокиНастроитьЭлементы +
+ +Описание, пример вызова + +```bsl + +Процедура РедактированиеЗарплатыСтрокиНастроитьЭлементы(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыФормыБазовый.РедактированиеЗарплатыСтрокиНастроитьЭлементы(Форма) +``` +
+ +## РедактированиеНДФЛСтрокиНастроитьЭлементы +
+ +Описание, пример вызова + +```bsl + +Процедура РедактированиеНДФЛСтрокиНастроитьЭлементы(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыФормыБазовый.РедактированиеНДФЛСтрокиНастроитьЭлементы(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыФормыВнутренний.md b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыФормыВнутренний.md new file mode 100644 index 0000000..65f1248 --- /dev/null +++ b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыФормыВнутренний.md @@ -0,0 +1,45 @@ +--- +title: Ведомость на выплату зарплаты формы внутренний +slug: zup/ведомость-на-выплату-зарплаты-формы-внутренний +--- + + +## РедактированиеЗарплатыСтрокиНастроитьЭлементы +
+ +Описание, пример вызова + +```bsl + +Процедура РедактированиеЗарплатыСтрокиНастроитьЭлементы(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыФормыВнутренний.РедактированиеЗарплатыСтрокиНастроитьЭлементы(Форма) +``` +
+ +## РедактированиеНДФЛСтрокиНастроитьЭлементы +
+ +Описание, пример вызова + +```bsl + +Процедура РедактированиеНДФЛСтрокиНастроитьЭлементы(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьНаВыплатуЗарплатыФормыВнутренний.РедактированиеНДФЛСтрокиНастроитьЭлементы(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыФормыПовтИсп.md b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыФормыПовтИсп.md new file mode 100644 index 0000000..8b85363 --- /dev/null +++ b/src/content/docs/zup/ВедомостьНаВыплатуЗарплатыФормыПовтИсп.md @@ -0,0 +1,45 @@ +--- +title: Ведомость на выплату зарплаты формы повт исп +slug: zup/ведомость-на-выплату-зарплаты-формы-повт-исп +--- + + +## ПредставленияСтатейФинансирования +
+ +Описание, пример вызова + +```bsl + +Функция ПредставленияСтатейФинансирования() Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыФормыПовтИсп.ПредставленияСтатейФинансирования() +``` +
+ +## ПредставленияСтатейРасходов +
+ +Описание, пример вызова + +```bsl + +Функция ПредставленияСтатейРасходов(ПолеПредставления = "Код") Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьНаВыплатуЗарплатыФормыПовтИсп.ПредставленияСтатейРасходов(ПолеПредставления); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВедомостьПрочихДоходов.md b/src/content/docs/zup/ВедомостьПрочихДоходов.md new file mode 100644 index 0000000..ec9a5c9 --- /dev/null +++ b/src/content/docs/zup/ВедомостьПрочихДоходов.md @@ -0,0 +1,549 @@ +--- +title: Ведомость прочих доходов +slug: zup/ведомость-прочих-доходов +--- + + +## МожноЗаполнитьВыплаты +
+ +Описание, пример вызова + +```bsl + +Функция МожноЗаполнитьВыплаты(Ведомость) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.МожноЗаполнитьВыплаты(Ведомость) +``` +
+ +## ЗаполнитьВыплаты +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьВыплаты(Ведомость) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ЗаполнитьВыплаты(Ведомость) +``` +
+ +## ДополнитьВыплаты +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьВыплаты(Ведомость, ФизическиеЛица) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ДополнитьВыплаты(Ведомость, ФизическиеЛица) +``` +
+ +## ЗапросОстатковВыплат +
+ +Описание, пример вызова + +```bsl + +Функция ЗапросОстатковВыплат(Ведомость, ФизическиеЛица = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.ЗапросОстатковВыплат(Ведомость, ФизическиеЛица); +``` +
+ +## ЗаполнитьПоТаблицеВыплат +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьПоТаблицеВыплат(Ведомость, ТаблицаВыплат, КлючевыеПоляСостава = "ФизическоеЛицо") Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ЗаполнитьПоТаблицеВыплат(Ведомость, ТаблицаВыплат, КлючевыеПоляСостава); +``` +
+ +## ДополнитьПоТаблицеВыплат +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьПоТаблицеВыплат(Ведомость, ТаблицаВыплат, КлючевыеПоляСостава = "ФизическоеЛицо") Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ДополнитьПоТаблицеВыплат(Ведомость, ТаблицаВыплат, КлючевыеПоляСостава); +``` +
+ +## СгруппироватьТаблицуВыплат +
+ +Описание, пример вызова + +```bsl + +Процедура СгруппироватьТаблицуВыплат(Ведомость, ТаблицаВыплат, КлючевыеПоляСостава) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.СгруппироватьТаблицуВыплат(Ведомость, ТаблицаВыплат, КлючевыеПоляСостава)); +``` +
+ +## СоставПоТаблицеВыплат +
+ +Описание, пример вызова + +```bsl + +Функция СоставПоТаблицеВыплат(Ведомость, ТаблицаВыплат, КлючевыеПоляСостава) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.СоставПоТаблицеВыплат(Ведомость, ТаблицаВыплат, КлючевыеПоляСостава)); +``` +
+ +## ОчиститьСостав +
+ +Описание, пример вызова + +```bsl + +Процедура ОчиститьСостав(Ведомость) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ОчиститьСостав(Ведомость)); +``` +
+ +## ДополнитьСостав +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьСостав(Ведомость, Состав) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ДополнитьСостав(Ведомость, Состав)); +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПроверкиЗаполнения(ДокументОбъект, Отказ, ПроверяемыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ОбработкаПроверкиЗаполнения(ДокументОбъект, Отказ, ПроверяемыеРеквизиты) +``` +
+ +## СоздатьВТСписокСотрудниковПоТаблицеВыплат +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьВТСписокСотрудниковПоТаблицеВыплат(МенеджерВременныхТаблиц, ТаблицаВыплат, Ведомость) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.СоздатьВТСписокСотрудниковПоТаблицеВыплат(МенеджерВременныхТаблиц, ТаблицаВыплат, Ведомость)); +``` +
+ +## ПередЗаписью +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗаписью(ДокументОбъект, Отказ, РежимЗаписи) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ПередЗаписью(ДокументОбъект, Отказ, РежимЗаписи) +``` +
+ +## ОбновитьНДФЛ +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьНДФЛ(Ведомость, Физлица) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ОбновитьНДФЛ(Ведомость, Физлица) +``` +
+ +## НДФЛПоТаблицеВыплат +
+ +Описание, пример вызова + +```bsl + +Функция НДФЛПоТаблицеВыплат(Ведомость, ТаблицаВыплат) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.НДФЛПоТаблицеВыплат(Ведомость, ТаблицаВыплат)); +``` +
+ +## УстановитьВзыскания +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьВзыскания(Ведомость, ТаблицаВыплат) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.УстановитьВзыскания(Ведомость, ТаблицаВыплат) +``` +
+ +## ВзысканияПоИсполнительнымДокументам +
+ +Описание, пример вызова + +```bsl + +Функция ВзысканияПоИсполнительнымДокументам(ТаблицаВыплат) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.ВзысканияПоИсполнительнымДокументам(ТаблицаВыплат)); +``` +
+ +## ОбработкаПроведения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПроведения(Ведомость, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ОбработкаПроведения(Ведомость, Отказ) +``` +
+ +## НоваяТаблицаВыплаченногоДоходаПоТабличнойЧасти +
+ +Описание, пример вызова + +```bsl + +// Создает новую таблицу значений для данных о выплаченных доходах по переданной табличной части. +// +// Параметры: +// ТабличнаяЧасть - ТабличнаяЧасть - данные о выплаченных доходах. +// ОписаниеСоответствияКолонок - Структура - см. НовоеОписаниеСоответствияКолонокДляТаблицыВыплаченнойЗарплаты. +// +// Возвращаемое значение: +// ТаблицаЗначений - см. НоваяТаблицаВыплаченногоДохода(). +// +Функция НоваяТаблицаВыплаченногоДоходаПоТабличнойЧасти(ТабличнаяЧасть, ОписаниеСоответствияКолонок) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.НоваяТаблицаВыплаченногоДоходаПоТабличнойЧасти(ТабличнаяЧасть, ОписаниеСоответствияКолонок)); +``` +
+ +## КолонкиТаблицыВыплаченногоДохода +
+ +Описание, пример вызова + +```bsl + +Функция КолонкиТаблицыВыплаченногоДохода() Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.КолонкиТаблицыВыплаченногоДохода()); +``` +
+ +## НовоеОписаниеСоответствияКолонокДляТаблицыВыплаченногоДохода +
+ +Описание, пример вызова + +```bsl + +// Создает описание соответствия колонок входной таблицы колонкам таблицы выплаченного дохода. +// Предназначена для использования в функциях- конструкторах. +// см. НоваяТаблицаВыплаченногоДохода(), см. НоваяТаблицаВыплаченнойЗарплатыПоТабличнойЧасти(). +// +// Возвращаемое значение: +// Структура - Ключ содержит имя колонки таблицы выплаченной зарплаты, значение - имя колонки входной таблицы. +// +Функция НовоеОписаниеСоответствияКолонокДляТаблицыВыплаченногоДохода() Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.НовоеОписаниеСоответствияКолонокДляТаблицыВыплаченногоДохода()); +``` +
+ +## ЗарегистрироватьУдержанныеНалоги +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьУдержанныеНалоги(Ведомость, Отказ = Ложь) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ЗарегистрироватьУдержанныеНалоги(Ведомость, Отказ); +``` +
+ +## ЗарегистрироватьУдержанныйНалогПоВременнымТаблицам +
+ +Описание, пример вызова + +```bsl + +// Выполняет регистрацию удержанного налога +// Параметры: +// Регистратор - ДокументОбъект +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - должен содержать временные таблицы +// ВТСписокСотрудников и ВТНалогУдержанный, см. УчетНДФЛ. +// +Процедура ЗарегистрироватьУдержанныйНалогПоВременнымТаблицам(Регистратор, Отказ, Организация, ДатаОперации, ДатаВыплаты, МенеджерВременныхТаблиц) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ЗарегистрироватьУдержанныйНалогПоВременнымТаблицам(Регистратор, Отказ, Организация, ДатаОперации, ДатаВыплаты, МенеджерВременныхТаблиц)); +``` +
+ +## ЗарегистрироватьПеречислениеНДФЛ +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьПеречислениеНДФЛ(Ведомость, Отказ = Ложь) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ЗарегистрироватьПеречислениеНДФЛ(Ведомость, Отказ); +``` +
+ +## ОбработкаЗаполнения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаЗаполнения(Ведомость, ДанныеЗаполнения, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходов.ОбработкаЗаполнения(Ведомость, ДанныеЗаполнения, СтандартнаяОбработка) +``` +
+ +## ДанныеЗаполненияВедомости +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, используемую для заполнения ведомостей на выплату прочих доходов. +// +Функция ДанныеЗаполненияВедомости() Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.ДанныеЗаполненияВедомости() +``` +
+ +## ЭтоДанныеЗаполненияВедомости +
+ +Описание, пример вызова + +```bsl + +// Проверяет, являются ли переданные данные структурой, используемой для заполнения документа +// (см. функцию ДанныеЗаполнения). +// +Функция ЭтоДанныеЗаполненияВедомости(ДанныеЗаполнения) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.ЭтоДанныеЗаполненияВедомости(ДанныеЗаполнения)); +``` +
+ +## ТекстЗапросаДанныеДляОплаты +
+ +Описание, пример вызова + +```bsl + +Функция ТекстЗапросаДанныеДляОплаты(ИмяТипа, ИмяПараметраВедомости = "Ведомости", ИмяПараметраФизическиеЛица = "ФизическиеЛица") Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.ТекстЗапросаДанныеДляОплаты(ИмяТипа, ИмяПараметраВедомости, ИмяПараметраФизическиеЛица); +``` +
+ +## ТекстЗапросаДанныеДляОплатыБезналично +
+ +Описание, пример вызова + +```bsl + +Функция ТекстЗапросаДанныеДляОплатыБезналично( Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.ТекстЗапросаДанныеДляОплатыБезналично(); +``` +
+ +## ВедомостиПоПрочимДоходамЗаМесяцДляПлатежейПоРезультатамРасчета +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обслуживание обработки ПлатежиПоРезультатамРасчетаЗарплаты. + +// Возвращает список проведенных ведомостей, у которых сумма к выплате не равна нулю. +// +// Параметры: +// Организации - Массив - содержит ссылки на организации (СправочникСсылка.Организации) +// по которым получается список ведомостей. +// МесяцНачисления - Дата +// ШаблонСпискаВедомостей - ТаблицаЗначений, пустая таблица, используется как шаблон для выходных данных. +// +// Возвращаемое значение: +// Структура +// *Касса - таблица значений, колонки таблицы соответствуют таблице ШаблонСпискаВедомостей +// ** Организация - СправочникСсылка.Организации +// ** СпособВыплаты - ПеречислениеСсылка.СпособыВыплатыПрочихДоходов +// ** Сумма - Число +// ** Ведомость - Строка +// ** СтатьяФинансирования - СправочникСсылка.СтатьиФинансированияЗарплата +// ** СтатьяРасходов - СправочникСсылка.СтатьиРасходовЗарплата +// *Банк - таблица значений +// ** Организация - СправочникСсылка.Организации +// ** МестоВыплаты - Строка или СправочникСсылка.ЗарплатныеПроекты или СправочникСсылка.КлассификаторБанков +// ** СпособВыплаты - ПеречислениеСсылка.СпособыВыплатыПрочихДоходов +// ** Сумма - Число +// ** Ведомость - Строка +// ** СтатьяФинансирования - СправочникСсылка.СтатьиФинансированияЗарплата +// ** СтатьяРасходов - СправочникСсылка.СтатьиРасходовЗарплата +// +Функция ВедомостиПоПрочимДоходамЗаМесяцДляПлатежейПоРезультатамРасчета(Организации, МесяцНачисления, ШаблонСпискаВедомостей) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходов.ВедомостиПоПрочимДоходамЗаМесяцДляПлатежейПоРезультатамРасчета(Организации, МесяцНачисления, ШаблонСпискаВедомостей) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВедомостьПрочихДоходовКлиент.md b/src/content/docs/zup/ВедомостьПрочихДоходовКлиент.md new file mode 100644 index 0000000..1744739 --- /dev/null +++ b/src/content/docs/zup/ВедомостьПрочихДоходовКлиент.md @@ -0,0 +1,221 @@ +--- +title: Ведомость прочих доходов клиент +slug: zup/ведомость-прочих-доходов-клиент +--- + + +## ОбработкаОповещения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.ОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) +``` +
+ +## ПредставлениеОснованийНажатие +
+ +Описание, пример вызова + +```bsl + +Процедура ПредставлениеОснованийНажатие(Форма, Элемент, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.ПредставлениеОснованийНажатие(Форма, Элемент, СтандартнаяОбработка) +``` +
+ +## ПеречислениеНДФЛВыполненоПриИзменении +
+ +Описание, пример вызова + +```bsl + +Процедура ПеречислениеНДФЛВыполненоПриИзменении(Форма, Элемент) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.ПеречислениеНДФЛВыполненоПриИзменении(Форма, Элемент) +``` +
+ +## ДатаПриИзменении +
+ +Описание, пример вызова + +```bsl + +Процедура ДатаПриИзменении(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.ДатаПриИзменении(Форма) +``` +
+ +## ДатаВыплатыПриИзменении +
+ +Описание, пример вызова + +```bsl + +Процедура ДатаВыплатыПриИзменении(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.ДатаВыплатыПриИзменении(Форма) +``` +
+ +## СоставВыбор +
+ +Описание, пример вызова + +```bsl + +Процедура СоставВыбор(Форма, Элемент, ВыбраннаяСтрока, Поле, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.СоставВыбор(Форма, Элемент, ВыбраннаяСтрока, Поле, СтандартнаяОбработка) +``` +
+ +## СоставПередУдалением +
+ +Описание, пример вызова + +```bsl + +Процедура СоставПередУдалением(Форма, Элемент, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.СоставПередУдалением(Форма, Элемент, Отказ) +``` +
+ +## СоставКВыплатеОткрытие +
+ +Описание, пример вызова + +```bsl + +Процедура СоставКВыплатеОткрытие(Форма, Элемент, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.СоставКВыплатеОткрытие(Форма, Элемент, СтандартнаяОбработка) +``` +
+ +## Заполнить +
+ +Описание, пример вызова + +```bsl + +Процедура Заполнить(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.Заполнить(Форма) +``` +
+ +## Подобрать +
+ +Описание, пример вызова + +```bsl + +Процедура Подобрать(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.Подобрать(Форма) +``` +
+ +## Очистить +
+ +Описание, пример вызова + +```bsl + +Процедура Очистить(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.Очистить(Форма) +``` +
+ +## РедактироватьВыплатуСтроки +
+ +Описание, пример вызова + +```bsl + +Процедура РедактироватьВыплатуСтроки(Форма, ДанныеСтроки) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.РедактироватьВыплатуСтроки(Форма, ДанныеСтроки) +``` +
+ +## РедактироватьВыплатуСтрокиЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура РедактироватьВыплатуСтрокиЗавершение(РезультатыРедактирования, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиент.РедактироватьВыплатуСтрокиЗавершение(РезультатыРедактирования, ДополнительныеПараметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВедомостьПрочихДоходовКлиентСервер.md b/src/content/docs/zup/ВедомостьПрочихДоходовКлиентСервер.md new file mode 100644 index 0000000..5cb0855 --- /dev/null +++ b/src/content/docs/zup/ВедомостьПрочихДоходовКлиентСервер.md @@ -0,0 +1,109 @@ +--- +title: Ведомость прочих доходов клиент сервер +slug: zup/ведомость-прочих-доходов-клиент-сервер +--- + + +## НастроитьПолеВидДоходаИсполнительногоПроизводства +
+ +Описание, пример вызова + +```bsl + +Процедура НастроитьПолеВидДоходаИсполнительногоПроизводства(Форма, ИмяЭлемента = "ВидДоходаИсполнительногоПроизводства") Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиентСервер.НастроитьПолеВидДоходаИсполнительногоПроизводства(Форма, ИмяЭлемента); +``` +
+ +## ВидДоходаИсполнительногоПроизводстваОбязателен +
+ +Описание, пример вызова + +```bsl + +Функция ВидДоходаИсполнительногоПроизводстваОбязателен(Ведомость) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходовКлиентСервер.ВидДоходаИсполнительногоПроизводстваОбязателен(Ведомость) +``` +
+ +## УстановитьПредставлениеОснований +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьПредставлениеОснований(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиентСервер.УстановитьПредставлениеОснований(Форма) +``` +
+ +## УстановитьОтображениеВХО +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьОтображениеВХО(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиентСервер.УстановитьОтображениеВХО(Форма) +``` +
+ +## УстановитьОтображениеВХОВыплатыДоходов +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьОтображениеВХОВыплатыДоходов(Форма) Экспорт +``` + +Пример вызова +```bsl +ВедомостьПрочихДоходовКлиентСервер.УстановитьОтображениеВХОВыплатыДоходов(Форма)); +``` +
+ +## ДатаВыплаты +
+ +Описание, пример вызова + +```bsl + +Функция ДатаВыплаты(Ведомость) Экспорт +``` + +Пример вызова +```bsl +Результат = ВедомостьПрочихДоходовКлиентСервер.ДатаВыплаты(Ведомость) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВзаиморасчетыПоПрочимДоходам.md b/src/content/docs/zup/ВзаиморасчетыПоПрочимДоходам.md new file mode 100644 index 0000000..c579be5 --- /dev/null +++ b/src/content/docs/zup/ВзаиморасчетыПоПрочимДоходам.md @@ -0,0 +1,40 @@ +--- +title: Взаиморасчеты по прочим доходам +slug: zup/взаиморасчеты-по-прочим-доходам +--- + + +## ЗарегистрироватьНачисленияУдержанияПоКонтрагентамАкционерам +
+ +Описание, пример вызова + +```bsl + +// Регистрирует начисления и удержания по прочим доходам в учете. +// +// Параметры: +// Движения - КоллекцияДвижений - коллекция наборов записей движений расчетного документа. +// Отказ - Булево - признак отказа выполнения операции. +// Организация - СправочникСсылка.Организации +// ПериодРегистрации - Дата - первое число месяца периода регистрации. +// СпособРасчетов - ПеречисленияСсылка.СпособыРасчетовСФизическимиЛицами +// Начисления - ТаблицаЗначений - соответствует структуре регистра накопления НачисленияУдержанияПоКонтрагентамАкционерам. +// Удержания - ТаблицаЗначений - соответствует структуре регистра накопления НачисленияУдержанияПоКонтрагентамАкционерам. +// +Процедура ЗарегистрироватьНачисленияУдержанияПоКонтрагентамАкционерам(Движения, Отказ, Организация, ПериодРегистрации, СпособРасчетов, Начисления = Неопределено, Удержания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыПоПрочимДоходам.ЗарегистрироватьНачисленияУдержанияПоКонтрагентамАкционерам(Движения, Отказ, Организация, ПериодРегистрации, СпособРасчетов, Начисления, Удержания); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВзаиморасчетыПоПрочимДоходамКлиент.md b/src/content/docs/zup/ВзаиморасчетыПоПрочимДоходамКлиент.md new file mode 100644 index 0000000..36602bf --- /dev/null +++ b/src/content/docs/zup/ВзаиморасчетыПоПрочимДоходамКлиент.md @@ -0,0 +1,36 @@ +--- +title: Взаиморасчеты по прочим доходам клиент +slug: zup/взаиморасчеты-по-прочим-доходам-клиент +--- + + +## ИмяСобытияИзмененияОплатыВедомости +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя события оповещения об изменении состояния оплаты ведомости на выплату прочих доходов. +// Уместно использовать в платежных документах в вызовах Оповестить: +// Оповестить(ВзаиморасчетыПоПрочимДоходамКлиент.ИмяСобытияИзмененияОплатыВедомости()); +// +// Возвращаемое значение: +// Строка - имя события +// +Функция ИмяСобытияИзмененияОплатыВедомости() Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыПоПрочимДоходамКлиент.ИмяСобытияИзмененияОплатыВедомости() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВзаиморасчетыССотрудниками.md b/src/content/docs/zup/ВзаиморасчетыССотрудниками.md new file mode 100644 index 0000000..77bbed2 --- /dev/null +++ b/src/content/docs/zup/ВзаиморасчетыССотрудниками.md @@ -0,0 +1,586 @@ +--- +title: Взаиморасчеты с сотрудниками +slug: zup/взаиморасчеты-с-сотрудниками +--- + + +## ЗарегистрироватьНачисленнуюЗарплату +
+ +Описание, пример вызова + +```bsl + +// Регистрирует факт начисления зарплаты с целью учета взаиморасчетов. +// +// Параметры: +// Движения - КоллекцияДвижений - коллекция наборов записей движений расчетного документа. +// Отказ - Булево - признак отказа выполнения операции. +// Организация - СправочникСсылка.Организации - организация +// ПериодРегистрации - Дата - первое число месяца периода регистрации. +// ПорядокВыплаты - ПеречисленияСсылка.ХарактерВыплатыЗарплаты - порядок выплаты. +// Начисления - ТаблицаЗначений - см. НоваяТаблицаНачисленнойЗарплаты(). +// Удержания - ТаблицаЗначений - см. НоваяТаблицаНачисленнойЗарплаты(). +// +Процедура ЗарегистрироватьНачисленнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, ПорядокВыплаты, Начисления = Неопределено, Удержания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.ЗарегистрироватьНачисленнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, ПорядокВыплаты, Начисления, Удержания); +``` +
+ +## ЗарегистрироватьНачисленныйАванс +
+ +Описание, пример вызова + +```bsl + +// Регистрирует факт начисления авансов с целью учета взаиморасчетов. +// +// Параметры: +// Движения - КоллекцияДвижений - коллекция наборов записей движений расчетного документа. +// Отказ - Булево - признак отказа выполнения операции. +// Организация - СправочникСсылка.Организации +// ПериодРегистрации - Дата - первое число месяца периода регистрации. +// Начисления - ТаблицаЗначений - см. НоваяТаблицаНачисленнойЗарплаты(). +// Удержания - ТаблицаЗначений - см. НоваяТаблицаНачисленнойЗарплаты(). +// +Процедура ЗарегистрироватьНачисленныйАванс(Движения, Отказ, Организация, ПериодРегистрации, Начисления = Неопределено, Удержания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.ЗарегистрироватьНачисленныйАванс(Движения, Отказ, Организация, ПериодРегистрации, Начисления, Удержания); +``` +
+ +## ЗарегистрироватьНалогиПереданныеВНалоговыйОрган +
+ +Описание, пример вызова + +```bsl + +// Регистрирует факт передачи налогов в налоговый орган с целью учета взаиморасчетов. +// +// Параметры: +// Движения - КоллекцияДвижений - коллекция наборов записей движений расчетного документа. +// Отказ - Булево - признак отказа выполнения операции. +// Организация - СправочникСсылка.Организации +// ПериодРегистрации - Дата - первое число месяца периода регистрации. +// Налоги - ТаблицаЗначений - см. НоваяТаблицаНалоговПередаваемыхВНалоговыйОрган. +// ДокументОснование - ДокументСсылка - документ основание для РН "Зарплата к выплате" (ссылка может не входить в составной тип). +// +Процедура ЗарегистрироватьНалогиПереданныеВНалоговыйОрган(Движения, Отказ, Организация, ПериодРегистрации, Налоги, ДокументОснование = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.ЗарегистрироватьНалогиПереданныеВНалоговыйОрган(Движения, Отказ, Организация, ПериодРегистрации, Налоги, ДокументОснование); +``` +
+ +## ЗарегистрироватьВыплаченнуюЗарплату +
+ +Описание, пример вызова + +```bsl + +// Регистрирует факт выплаты зарплаты с целью учета взаиморасчетов. +// +// Параметры: +// Движения - КоллекцияДвижений - коллекция наборов записей движений ведомости. +// Отказ - Булево - признак отказа в проведении. +// Организация - СправочникСсылка.Организации - организация. +// ПериодРегистрации - Дата - первое число месяца периода регистрации. +// Зарплата - ТаблицаЗначений - см. НоваяТаблицаВыплаченнойЗарплаты +// ПорядокВыплаты - ПеречисленияСсылка.ХарактерВыплатыЗарплаты - порядок выплаты. +// +Процедура ЗарегистрироватьВыплаченнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, Зарплата, Знач ПорядокВыплаты = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.ЗарегистрироватьВыплаченнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, Зарплата, ПорядокВыплаты); +``` +
+ +## ЗарегистрироватьНачальныеОстатки +
+ +Описание, пример вызова + +```bsl + +// Регистрирует начальные остатки по взаиморасчетам с сотрудниками. +// +// Колонки СуммаПоБухучету и ВыплатыЗаПрошлыеПериоды не обязательны, при отсутствии будут добавлены автоматически. +// СуммаПоБухучету будет установлена равной значению поля Сумма, ВыплатыЗаПрошлыеПериоды будет присвоено равно нулю. +// +// Параметры: +// Движения - КоллекцияДвижений - наборы записей движений документа ввода начальных остатков. +// Отказ - Булево - признак отказа в проведении. +// Организация - СправочникСсылка.Организации +// ПериодРегистрации - Дата - период регистрации (начало месяца). +// Остатки - ТаблицаЗначений - см. НоваяТаблицаНачальныхОстатков +// +Процедура ЗарегистрироватьНачальныеОстатки(Движения, Отказ, Организация, ПериодРегистрации, Остатки) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.ЗарегистрироватьНачальныеОстатки(Движения, Отказ, Организация, ПериодРегистрации, Остатки) +``` +
+ +## НоваяТаблицаНачисленнойЗарплаты +
+ +Описание, пример вызова + +```bsl + +// Возвращает новую пустую таблицу значений для данных о начисленной зарплате. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица с колонками: +// * Организация - СправочникСсылка.Организации - организация, которая начислила зарплату. +// * Сотрудник - СправочникСсылка.Сотрудники - сотрудник, которому начислена зарплата. +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица - физическое лицо сотрудника. +// * Подразделение - СправочникСсылка.ПодразделенияОрганизаций - подразделение, в котором начислена зарплата. +// * СтатьяФинансирования - СправочникСсылка.СтатьиФинансированияЗарплата - статья финансирования. +// * СтатьяРасходов - СправочникСсылка.СтатьиРасходовЗарплата - статья расходов. +// * ВидДоходаИсполнительногоПроизводства - ПеречислениеСсылка.ВидыДоходовИсполнительногоПроизводства. +// * ПервичныйРегистратор - ОпределяемыйТип.ДокументОснованиеЗарплатыКВыплате - документ-основание. +// * Сумма - Число - суммы начисленной зарплаты. +// * СуммаКорректировкиВыплаты - Число - НДФЛ к возврату (отрицательный и ранее уже удержанный НДФЛ). +// +Функция НоваяТаблицаНачисленнойЗарплаты() Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудниками.НоваяТаблицаНачисленнойЗарплаты() +``` +
+ +## НоваяТаблицаНалоговПередаваемыхВНалоговыйОрган +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает новую таблицу значений для данных о налогах, переданных в налоговый орган. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица значений с колонками: +// * Сотрудник - СправочникСсылка.Сотрудники - сотрудник, которому начислена зарплата. +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица - физическое лицо сотрудника. +// * Подразделение - СправочникСсылка.ПодразделенияОрганизаций - подразделение, в котором начислена зарплата. +// * СтатьяФинансирования - СправочникСсылка.СтатьиФинансированияЗарплата - статья финансирования. +// * СтатьяРасходов - СправочникСсылка.СтатьиРасходовЗарплата - статья расходов. +// * ВидДоходаИсполнительногоПроизводства - ПеречислениеСсылка.ВидыДоходовИсполнительногоПроизводства. +// * Сумма - Число - суммы начисленной зарплаты. +// +Функция НоваяТаблицаНалоговПередаваемыхВНалоговыйОрган() Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудниками.НоваяТаблицаНалоговПередаваемыхВНалоговыйОрган() +``` +
+ +## НоваяТаблицаНачальныхОстатков +
+ +Описание, пример вызова + +```bsl + +// Возвращает новую пустую таблицу значений для начальных остатков. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица с колонками: +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица - физическое лицо сотрудника. +// * Сотрудник - СправочникСсылка.Сотрудники - сотрудник, которому начислена зарплата. +// * Подразделение - СправочникСсылка.ПодразделенияОрганизаций - подразделение, в котором начислена зарплата. +// * СтатьяФинансирования - СправочникСсылка.СтатьиФинансированияЗарплата - статья финансирования. +// * СтатьяРасходов - СправочникСсылка.СтатьиРасходовЗарплата - статья расходов. +// * ВидДоходаИсполнительногоПроизводства - ПеречислениеСсылка.ВидыДоходовИсполнительногоПроизводства. +// * ПериодВзаиморасчетов - Дата - начало месяца периода взаиморасчетов. +// * Сумма - Число - суммы начисленной зарплаты. +// * СуммаПоБухучету - Число - сумма начального остатка бухгалтерских взаиморасчетов (приход). +// * ВыплатыЗаПрошлыеПериоды - Число - сумма начального остатка бухгалтерских взаиморасчетов (расход). +// +Функция НоваяТаблицаНачальныхОстатков() Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудниками.НоваяТаблицаНачальныхОстатков() +``` +
+ +## НоваяТаблицаВыплаченнойЗарплаты +
+ +Описание, пример вызова + +```bsl + +// Создает новую пустую таблицу значений для данных о выплаченной зарплате. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица значений с колонками: +// * Сотрудник - СправочникСсылка.Сотрудники - сотрудник, которому выплачена зарплата +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица - физическое лицо сотрудника +// * Подразделение - СправочникСсылка.ПодразделенияОрганизаций - подразделение +// * ПериодВзаиморасчетов - Дата - период, в котором выплачивается зарплата +// * СтатьяФинансирования - СправочникСсылка.СтатьиФинансированияЗарплата - статья финансирования +// * СтатьяРасходов - СправочникСсылка.СтатьиРасходовЗарплата - статья расходов +// * ДокументОснование - ОпределяемыйТип.ДокументОснованиеЗарплатыКВыплате - документ-основание +// * Сумма - Число - выплачиваемая сумма. +// +Функция НоваяТаблицаВыплаченнойЗарплаты() Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудниками.НоваяТаблицаВыплаченнойЗарплаты() +``` +
+ +## НоваяТаблицаВыплаченнойЗарплатыПоТабличнойЧасти +
+ +Описание, пример вызова + +```bsl + +// Создает новую таблицу значений для данных о выплаченной зарплате по переданной табличной части. +// +// Параметры: +// ТабличнаяЧасть - ТабличнаяЧасть - данные о выплаченной зарплате. +// ОписаниеСоответствияКолонок - Структура - см. НовоеОписаниеСоответствияКолонокДляТаблицыВыплаченнойЗарплаты. +// +// Возвращаемое значение: +// ТаблицаЗначений - см. НоваяТаблицаВыплаченнойЗарплаты(). +// +Функция НоваяТаблицаВыплаченнойЗарплатыПоТабличнойЧасти(ТабличнаяЧасть, ОписаниеСоответствияКолонок) Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудниками.НоваяТаблицаВыплаченнойЗарплатыПоТабличнойЧасти(ТабличнаяЧасть, ОписаниеСоответствияКолонок) +``` +
+ +## НовоеОписаниеСоответствияКолонокДляТаблицыВыплаченнойЗарплаты +
+ +Описание, пример вызова + +```bsl + +// Создает описание соответствия колонок входной таблицы колонкам таблицы выплаченной зарплаты. +// Предназначена для использования в функциях- конструкторах таблицы выплаченной зарплаты. +// см. НоваяТаблицаВыплаченнойЗарплаты(), см. НоваяТаблицаВыплаченнойЗарплатыПоТабличнойЧасти(). +// +// Возвращаемое значение: +// Структура - Ключ содержит имя колонки таблицы выплаченной зарплаты, значение - имя колонки входной таблицы. +// +Функция НовоеОписаниеСоответствияКолонокДляТаблицыВыплаченнойЗарплаты() Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудниками.НовоеОписаниеСоответствияКолонокДляТаблицыВыплаченнойЗарплаты() +``` +
+ +## ЗаписатьДвижения +
+ +Описание, пример вызова + +```bsl + +// Записывает движения подсистемы взаиморасчетов в базу данных. +// +// Параметры: +// Движения - КоллекцияДвижений - Коллекция наборов записей. +// Замещать - Булево - Определяет режим замещения существующей записи. +// Значение по умолчанию: Истина. +// +Процедура ЗаписатьДвижения(Движения, Замещать = Истина) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.ЗаписатьДвижения(Движения, Замещать); +``` +
+ +## ДанныеВедомостейДляОплатыДокументом +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает информацию для оплаты платежным документом указанных ведомостей. +// Удобна для использования в процедурах заполнения платежных документов. +// Возвращаются суммы в разрезе ведомостей и физических лиц с учетом состояния оплаты +// (все, оплаченные, только неоплаченные). +// Оплаты, проведенные самим документом, не учитываются. +// +// Параметры: +// Документ - ДокументСсылка - платежный документ +// Ведомости - Массив из ОпределяемыйТип.ВедомостьЗарплатаКадры - оплачиваемые ведомости +// ФизическиеЛица - Массив из СправочникСсылка.ФизическиеЛица - физические лица +// Оплаченные - Булево, Неопределено - статус оплаты: +// Истина - только оплаченные +// Ложь - не оплаченные +// Неопределено - состояние оплаты не учитывается. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица с колонками: +// * Ведомость - ОпределяемыйТип.ВедомостьЗарплатаКадры - ведомость. +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица - физическое лицо. +// * СуммаКВыплате - ОпределяемыйТип.ДенежнаяСуммаНеотрицательная - выплачиваемая зарплата. +// * ВзысканнаяСумма - ОпределяемыйТип.ДенежнаяСуммаНеотрицательная - сумма, взысканная по +// исполнительным листам. +// * КомпенсацияЗаЗадержкуЗарплаты - ОпределяемыйТип.ДенежнаяСуммаНеотрицательная - компенсация за задержку зарплаты. +// +Функция ДанныеВедомостейДляОплатыДокументом(Документ, Ведомости, ФизическиеЛица = Неопределено, Оплаченные = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудниками.ДанныеВедомостейДляОплатыДокументом(Документ, Ведомости, ФизическиеЛица, Оплаченные); +``` +
+ +## УпорядочитьДанныеВедомостейДляОплаты +
+ +Описание, пример вызова + +```bsl + +// Упорядочивает информацию для оплаты по представлениям ведомостей и физических лиц +// Может использоваться при заполнении платежных документов для предсказуемого порядка следования строк +// +// Параметры: +// ДанныеВедомостейДляОплаты - ТаблицаЗначений - см. ДанныеВедомостейДляОплатыДокументом +// +Процедура УпорядочитьДанныеВедомостейДляОплаты(ДанныеВедомостейДляОплаты) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.УпорядочитьДанныеВедомостейДляОплаты(ДанныеВедомостейДляОплаты) +``` +
+ +## ПроверкиОплатыВедомостейДокументом +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей правила контроля данных об оплате. +// Предназначения для создания параметра Проверки процедуры ПроверитьОплатуВедомостейДокументом. +// +// Возвращаемое значение: +// Структура - содержит свойства: +// * ВедомостьПроведена - Булево - проверять, что ведомость проведена. +// * РаботникВВедомости - Булево - проверять наличие указанного работника в ведомости. +// * ПовторнаяВыплата - Булево - контроль повторной выплаты по строке ведомости. +// +Функция ПроверкиОплатыВедомостейДокументом() Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудниками.ПроверкиОплатыВедомостейДокументом() +``` +
+ +## ПроверитьОплатуВедомостейДокументом +
+ +Описание, пример вызова + +```bsl + +// Проверяет данные по оплате зарплаты. +// Удобна для использования при проведении. +// Контролируется: +// проведенность ведомости +// соответствие ведомости и работника (наличие такого в ведомости) +// попытка повторной выплаты +// Объем проверок может настраиваться параметром Проверки. +// +// Параметры: +// Документ - ДокументОбъект, ДокументСсылка - платежный документ (его оплаты не учитываются). +// Отказ - Булево - признак наличия ошибок в проверяемых данных ведомостей. +// ОплатаВедомостей - ТаблицаЗначений - таблица сведений об оплате с колонками: +// * Ведомость - ДокументСсылка +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// Проверки - Структура - выполняемые проверки, см. ПроверкиОплатыВедомостейДокументом(). +// +Процедура ПроверитьОплатуВедомостейДокументом(Документ, Отказ, ОплатаВедомостей, Проверки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.ПроверитьОплатуВедомостейДокументом(Документ, Отказ, ОплатаВедомостей, Проверки); +``` +
+ +## ЗарегистрироватьОплатуВедомостейДокументом +
+ +Описание, пример вызова + +```bsl + +// Регистрирует выдачу зарплаты работникам по ведомостям. +// +// Параметры: +// Документ - ДокументОбъект - платежный документ. +// Отказ - Булево - признак отказа в выполнении операции. +// ОплатаВедомостей - ТаблицаЗначений - таблица сведений об оплате с колонками: +// * Ведомость - ДокументСсылка +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// +Процедура ЗарегистрироватьОплатуВедомостейДокументом(Документ, Отказ, ОплатаВедомостей) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.ЗарегистрироватьОплатуВедомостейДокументом(Документ, Отказ, ОплатаВедомостей) +``` +
+ +## ЗарегистрироватьОплатуВедомостей +
+ +Описание, пример вызова + +```bsl + +// Регистрирует выдачу зарплаты работникам по ведомостям. +// +// Параметры: +// ПлатежныйДокумент - ДокументОбъект - платежный документ. +// Организация - СправочникСсылка.Организации - организация документа. +// Ведомости - Массив из ОпределяемыйТип.ВедомостьЗарплатаКадры - ведомости, по которым выдается зарплата +// ФизическиеЛица - Массив из СправочникСсылка.ФизическиеЛица - физические лица, которым выдается зарплата +// Оплаченные - Булево, Неопределено - статус оплаты: +// Истина - только оплаченные +// Ложь - не оплаченные +// Неопределено - состояние оплаты не учитывается. +// Отказ - Булево - признак отказа в выполнении операции. +// +Процедура ЗарегистрироватьОплатуВедомостей(ПлатежныйДокумент, Организация, Ведомости, ФизическиеЛица = Неопределено, Оплаченные = Ложь, Отказ = Ложь) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.ЗарегистрироватьОплатуВедомостей(ПлатежныйДокумент, Организация, Ведомости, ФизическиеЛица, Оплаченные, Отказ); +``` +
+ +## ЕстьОплатаПоВедомости +
+ +Описание, пример вызова + +```bsl + +// Проверяет, есть ли выплаты по ведомости. +// +// Параметры: +// Ведомость - ДокументСсылка - ведомость, оплату которой нужно проверить. +// +// Возвращаемое значение: +// Булево - Истина, если по ведомости производилась оплата. +// +Функция ЕстьОплатаПоВедомости(Ведомость) Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудниками.ЕстьОплатаПоВедомости(Ведомость) +``` +
+ +## ТекстЗапросаДанныеДляОплатыБезналично +
+ +Описание, пример вызова + +```bsl + +// Возвращает текст запроса для безналичной оплаты +// +// Параметры: +// ИмяТипа - Строка - полное имя объекта метаданных. +// ИмяПараметраВедомости - Строка - имя параметра, в котором будут переданы оплачиваемые ведомости. +// ИмяПараметраФизическиеЛица - Строка - имя параметра, в котором будут переданы физические лица. +// +// Возвращаемое значение: +// Строка - текст запроса для оплаты безналично +// +Функция ТекстЗапросаДанныеДляОплатыБезналично( Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудниками.ТекстЗапросаДанныеДляОплатыБезналично(); +``` +
+ +## ЗарегистрироватьОплатуВедомостейВБухгалтерскихВзаиморасчетах +
+ +Описание, пример вызова + +```bsl + +// Устарела: предпочтительно использовать ЗарплатаКадры.ЗарегистрироватьОплатуВедомостей. +// Регистрирует оплату ведомостей в бухгалтерских взаиморасчетах +// +// Параметры: +// ПлатежныйДокумент - ДокументОбъект - платежный документ, регистрирующий оплату ведомостей. +// Организация - СправочникСсылка.Организации - организация. +// Ведомости - Массив - ведомости, оплату которых требуется зарегистрировать +// ФизическиеЛица - Массив - физические лица, для которых требуется зарегистрировать оплату. Если не указан - для всех физических лиц. +// ДатаОперации - Дата - дата платежа. +// Отказ - Булево - признак отказа в проведении. +// +Процедура ЗарегистрироватьОплатуВедомостейВБухгалтерскихВзаиморасчетах(ПлатежныйДокумент, Организация, Ведомости, ФизическиеЛица, ДатаОперации, Отказ) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудниками.ЗарегистрироватьОплатуВедомостейВБухгалтерскихВзаиморасчетах(ПлатежныйДокумент, Организация, Ведомости, ФизическиеЛица, ДатаОперации, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВзаиморасчетыССотрудникамиБазовый.md b/src/content/docs/zup/ВзаиморасчетыССотрудникамиБазовый.md new file mode 100644 index 0000000..6b85506 --- /dev/null +++ b/src/content/docs/zup/ВзаиморасчетыССотрудникамиБазовый.md @@ -0,0 +1,173 @@ +--- +title: Взаиморасчеты с сотрудниками базовый +slug: zup/взаиморасчеты-с-сотрудниками-базовый +--- + + +## ПриЗаполненииСписковСОграничениемДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ПриЗаполненииСписковСОграничениемДоступа(Списки) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиБазовый.ПриЗаполненииСписковСОграничениемДоступа(Списки) +``` +
+ +## ПриЗаполненииВидовОграниченийПравОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +Процедура ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиБазовый.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) +``` +
+ +## ЗарегистрироватьНачальныеОстатки +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьНачальныеОстатки(Движения, Отказ, Организация, ПериодРегистрации, Остатки) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиБазовый.ЗарегистрироватьНачальныеОстатки(Движения, Отказ, Организация, ПериодРегистрации, Остатки) +``` +
+ +## ЗарегистрироватьНачисленнуюЗарплату +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьНачисленнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, ПорядокВыплаты, Начисления = Неопределено, Удержания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиБазовый.ЗарегистрироватьНачисленнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, ПорядокВыплаты, Начисления, Удержания); +``` +
+ +## ЗарегистрироватьНачисленныйАванс +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьНачисленныйАванс(Движения, Отказ, Организация, ПериодРегистрации, Начисления = Неопределено, Удержания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиБазовый.ЗарегистрироватьНачисленныйАванс(Движения, Отказ, Организация, ПериодРегистрации, Начисления, Удержания); +``` +
+ +## ЗарегистрироватьВыплаченнуюЗарплату +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьВыплаченнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, ПорядокВыплаты, Зарплата) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиБазовый.ЗарегистрироватьВыплаченнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, ПорядокВыплаты, Зарплата) +``` +
+ +## ЗарегистрироватьВыданнуюЗарплату +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьВыданнуюЗарплату(Движения, Отказ, Организация, ДатаОперации, Зарплата, ПорядокВыплаты) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиБазовый.ЗарегистрироватьВыданнуюЗарплату(Движения, Отказ, Организация, ДатаОперации, Зарплата, ПорядокВыплаты) +``` +
+ +## СоздатьВТЗарплатаКВыплате +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьВТЗарплатаКВыплате(МенеджерВременныхТаблиц, ТолькоРазрешенные, Параметры, ИмяВТСотрудники) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиБазовый.СоздатьВТЗарплатаКВыплате(МенеджерВременныхТаблиц, ТолькоРазрешенные, Параметры, ИмяВТСотрудники) +``` +
+ +## СоздатьВТПлановыйАванс +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьВТПлановыйАванс(МенеджерВременныхТаблиц, ТолькоРазрешенные, Параметры, ИмяВТСотрудники, КадровыеДанные) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиБазовый.СоздатьВТПлановыйАванс(МенеджерВременныхТаблиц, ТолькоРазрешенные, Параметры, ИмяВТСотрудники, КадровыеДанные) +``` +
+ +## ВидВзаиморасчетовССотрудникамиПоХарактеруВыплатыЗарплаты +
+ +Описание, пример вызова + +```bsl + +Функция ВидВзаиморасчетовССотрудникамиПоХарактеруВыплатыЗарплаты(ПорядокВыплаты) Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудникамиБазовый.ВидВзаиморасчетовССотрудникамиПоХарактеруВыплатыЗарплаты(ПорядокВыплаты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВзаиморасчетыССотрудникамиВХОРасширенный.md b/src/content/docs/zup/ВзаиморасчетыССотрудникамиВХОРасширенный.md new file mode 100644 index 0000000..0c3bbd3 --- /dev/null +++ b/src/content/docs/zup/ВзаиморасчетыССотрудникамиВХОРасширенный.md @@ -0,0 +1,126 @@ +--- +title: Взаиморасчеты с сотрудниками вхо расширенный +slug: zup/взаиморасчеты-с-сотрудниками-вхо-расширенный +--- + + +## ПриПолученииПредопределенныхНаборовСвойств +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеСвойствамиПереопределяемый.ПриПолученииПредопределенныхНаборовСвойств. +Процедура ПриПолученииПредопределенныхНаборовСвойств(Наборы) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВХОРасширенный.ПриПолученииПредопределенныхНаборовСвойств(Наборы) +``` +
+ +## ПриЗаполненииСписковСОграничениемДоступа +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступомПереопределяемый.ПриЗаполненииСписковСОграничениемДоступа. +Процедура ПриЗаполненииСписковСОграничениемДоступа(Списки) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВХОРасширенный.ПриЗаполненииСписковСОграничениемДоступа(Списки) +``` +
+ +## ПриЗаполненииВидовОграниченийПравОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступомПереопределяемый.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных. +Процедура ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВХОРасширенный.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) +``` +
+ +## ПриОпределенииОбъектовСКомандамиПечати +
+ +Описание, пример вызова + +```bsl + +// Определяет объекты, в которых есть процедура ДобавитьКомандыПечати(). +// Подробнее см. УправлениеПечатьюПереопределяемый. +// +// Параметры: +// СписокОбъектов - Массив - список менеджеров объектов. +// +Процедура ПриОпределенииОбъектовСКомандамиПечати(СписокОбъектов) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВХОРасширенный.ПриОпределенииОбъектовСКомандамиПечати(СписокОбъектов) +``` +
+ +## ЗарегистрироватьОбработчикиОбновления +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список Обработчики процедуры-обработчики обновления, +// необходимые данной подсистеме. +// +// Параметры: +// Обработчики - ТаблицаЗначений - см. описание функции НоваяТаблицаОбработчиковОбновления +// общего модуля ОбновлениеИнформационнойБазы. +// +Процедура ЗарегистрироватьОбработчикиОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВХОРасширенный.ЗарегистрироватьОбработчикиОбновления(Обработчики) +``` +
+ +## ЗаполнитьСведенияОПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьСведенияОПерсональныхДанных. +Процедура ЗаполнитьСведенияОПерсональныхДанных(ТаблицаСведений) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВХОРасширенный.ЗаполнитьСведенияОПерсональныхДанных(ТаблицаСведений) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВзаиморасчетыССотрудникамиВнутренний.md b/src/content/docs/zup/ВзаиморасчетыССотрудникамиВнутренний.md new file mode 100644 index 0000000..253d1a2 --- /dev/null +++ b/src/content/docs/zup/ВзаиморасчетыССотрудникамиВнутренний.md @@ -0,0 +1,173 @@ +--- +title: Взаиморасчеты с сотрудниками внутренний +slug: zup/взаиморасчеты-с-сотрудниками-внутренний +--- + + +## ПриЗаполненииСписковСОграничениемДоступа +
+ +Описание, пример вызова + +```bsl + +Процедура ПриЗаполненииСписковСОграничениемДоступа(Списки) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВнутренний.ПриЗаполненииСписковСОграничениемДоступа(Списки) +``` +
+ +## ПриЗаполненииВидовОграниченийПравОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +Процедура ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВнутренний.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) +``` +
+ +## ЗарегистрироватьНачисленнуюЗарплату +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьНачисленнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, ПорядокВыплаты, Начисления = Неопределено, Удержания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВнутренний.ЗарегистрироватьНачисленнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, ПорядокВыплаты, Начисления, Удержания); +``` +
+ +## ЗарегистрироватьНачисленныйАванс +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьНачисленныйАванс(Движения, Отказ, Организация, ПериодРегистрации, Начисления = Неопределено, Удержания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВнутренний.ЗарегистрироватьНачисленныйАванс(Движения, Отказ, Организация, ПериодРегистрации, Начисления, Удержания); +``` +
+ +## ЗарегистрироватьВыплаченнуюЗарплату +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьВыплаченнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, ПорядокВыплаты, Зарплата) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВнутренний.ЗарегистрироватьВыплаченнуюЗарплату(Движения, Отказ, Организация, ПериодРегистрации, ПорядокВыплаты, Зарплата) +``` +
+ +## ЗарегистрироватьНачальныеОстатки +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьНачальныеОстатки(Движения, Отказ, Организация, ПериодРегистрации, Остатки) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВнутренний.ЗарегистрироватьНачальныеОстатки(Движения, Отказ, Организация, ПериодРегистрации, Остатки) +``` +
+ +## ЗарегистрироватьВыданнуюЗарплату +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьВыданнуюЗарплату(Движения, Отказ, Организация, ДатаОперации, Зарплата, ПорядокВыплаты) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВнутренний.ЗарегистрироватьВыданнуюЗарплату(Движения, Отказ, Организация, ДатаОперации, Зарплата, ПорядокВыплаты) +``` +
+ +## СоздатьВТЗарплатаКВыплате +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьВТЗарплатаКВыплате(МенеджерВременныхТаблиц, ТолькоРазрешенные, Параметры, ИмяВТСотрудники) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВнутренний.СоздатьВТЗарплатаКВыплате(МенеджерВременныхТаблиц, ТолькоРазрешенные, Параметры, ИмяВТСотрудники) +``` +
+ +## СоздатьВТПлановыйАванс +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьВТПлановыйАванс(МенеджерВременныхТаблиц, ТолькоРазрешенные, Параметры, ИмяВТСотрудники, КадровыеДанные) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиВнутренний.СоздатьВТПлановыйАванс(МенеджерВременныхТаблиц, ТолькоРазрешенные, Параметры, ИмяВТСотрудники, КадровыеДанные) +``` +
+ +## ВидВзаиморасчетовССотрудникамиПоХарактеруВыплатыЗарплаты +
+ +Описание, пример вызова + +```bsl + +Функция ВидВзаиморасчетовССотрудникамиПоХарактеруВыплатыЗарплаты(ХарактерВыплаты) Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудникамиВнутренний.ВидВзаиморасчетовССотрудникамиПоХарактеруВыплатыЗарплаты(ХарактерВыплаты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВзаиморасчетыССотрудникамиКлиент.md b/src/content/docs/zup/ВзаиморасчетыССотрудникамиКлиент.md new file mode 100644 index 0000000..8b724c5 --- /dev/null +++ b/src/content/docs/zup/ВзаиморасчетыССотрудникамиКлиент.md @@ -0,0 +1,36 @@ +--- +title: Взаиморасчеты с сотрудниками клиент +slug: zup/взаиморасчеты-с-сотрудниками-клиент +--- + + +## ИмяСобытияИзмененияОплатыВедомости +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя события оповещения об изменении состояния оплаты ведомости на выплату зарплаты. +// Уместно использовать в платежных документах в вызовах Оповестить: +// Оповестить(ВзаиморасчетыССотрудникамиКлиент.ИмяСобытияИзмененияОплатыВедомости()); +// +// Возвращаемое значение: +// Строка - имя события +// +Функция ИмяСобытияИзмененияОплатыВедомости() Экспорт +``` + +Пример вызова +```bsl +Результат = ВзаиморасчетыССотрудникамиКлиент.ИмяСобытияИзмененияОплатыВедомости() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВзаиморасчетыССотрудникамиРасширенный.md b/src/content/docs/zup/ВзаиморасчетыССотрудникамиРасширенный.md new file mode 100644 index 0000000..8cccbc7 --- /dev/null +++ b/src/content/docs/zup/ВзаиморасчетыССотрудникамиРасширенный.md @@ -0,0 +1,30 @@ +--- +title: Взаиморасчеты с сотрудниками расширенный +slug: zup/взаиморасчеты-с-сотрудниками-расширенный +--- + + +## ЗарегистрироватьНачисленныйАванс +
+ +Описание, пример вызова + +```bsl + +// См. ВзаиморасчетыССотрудниками.ЗарегистрироватьНачисленныйАванс +Процедура ЗарегистрироватьНачисленныйАванс(Движения, Отказ, Организация, ПериодРегистрации, Начисления = Неопределено, Удержания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ВзаиморасчетыССотрудникамиРасширенный.ЗарегистрироватьНачисленныйАванс(Движения, Отказ, Организация, ПериодРегистрации, Начисления, Удержания); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВнешниеМодулиДокументооборотаСКОВМоделиСервиса.md b/src/content/docs/zup/ВнешниеМодулиДокументооборотаСКОВМоделиСервиса.md new file mode 100644 index 0000000..60e10d0 --- /dev/null +++ b/src/content/docs/zup/ВнешниеМодулиДокументооборотаСКОВМоделиСервиса.md @@ -0,0 +1,96 @@ +--- +title: Внешние модули документооборота сков модели сервиса +slug: zup/внешние-модули-документооборота-сков-модели-сервиса +--- + + +## ЗарегистрироватьОбработчикиПоставляемыхДанных +
+ +Описание, пример вызова + +```bsl + +// Регистрирует обработчики поставляемых данных за день и за все время +// +Процедура ЗарегистрироватьОбработчикиПоставляемыхДанных(Знач Обработчики) Экспорт +``` + +Пример вызова +```bsl +ВнешниеМодулиДокументооборотаСКОВМоделиСервиса.ЗарегистрироватьОбработчикиПоставляемыхДанных(Обработчики) +``` +
+ +## ДоступныНовыеДанные +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении уведомления о новых данных. +// В теле следует проверить, необходимы ли эти данные приложению, +// и если да - установить флажок Загружать +// +// Параметры: +// Дескриптор - ОбъектXDTO Descriptor. +// Загружать - булево, возвращаемое +// +Процедура ДоступныНовыеДанные(Знач Дескриптор, Загружать) Экспорт +``` + +Пример вызова +```bsl +ВнешниеМодулиДокументооборотаСКОВМоделиСервиса.ДоступныНовыеДанные(Дескриптор, Загружать) +``` +
+ +## ОбработатьНовыеДанные +
+ +Описание, пример вызова + +```bsl + +// Вызывается после вызова ДоступныНовыеДанные, позволяет разобрать данные. +// +// Параметры: +// Дескриптор - ОбъектXDTO Дескриптор. +// ПутьКФайлу - строка. Полное имя извлеченного файла. Файл будет автоматически удален +// после завершения процедуры. +// +Процедура ОбработатьНовыеДанные(Знач Дескриптор, Знач ПутьКФайлу) Экспорт +``` + +Пример вызова +```bsl +ВнешниеМодулиДокументооборотаСКОВМоделиСервиса.ОбработатьНовыеДанные(Дескриптор, ПутьКФайлу) +``` +
+ +## ОбработкаДанныхОтменена +
+ +Описание, пример вызова + +```bsl + +// Вызывается при отмене обработки данных в случае сбоя +// +Процедура ОбработкаДанныхОтменена(Знач Дескриптор) Экспорт +``` + +Пример вызова +```bsl +ВнешниеМодулиДокументооборотаСКОВМоделиСервиса.ОбработкаДанныхОтменена(Дескриптор) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВнешниеРегламентированныеОтчетыВМоделиСервиса.md b/src/content/docs/zup/ВнешниеРегламентированныеОтчетыВМоделиСервиса.md new file mode 100644 index 0000000..9c1cca2 --- /dev/null +++ b/src/content/docs/zup/ВнешниеРегламентированныеОтчетыВМоделиСервиса.md @@ -0,0 +1,96 @@ +--- +title: Внешние регламентированные отчеты в модели сервиса +slug: zup/внешние-регламентированные-отчеты-в-модели-сервиса +--- + + +## ЗарегистрироватьОбработчикиПоставляемыхДанных +
+ +Описание, пример вызова + +```bsl + +// Регистрирует обработчики поставляемых данных за день и за все время +// +Процедура ЗарегистрироватьОбработчикиПоставляемыхДанных(Знач Обработчики) Экспорт +``` + +Пример вызова +```bsl +ВнешниеРегламентированныеОтчетыВМоделиСервиса.ЗарегистрироватьОбработчикиПоставляемыхДанных(Обработчики) +``` +
+ +## ДоступныНовыеДанные +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении уведомления о новых данных. +// В теле следует проверить, необходимы ли эти данные приложению, +// и если да - установить флажок Загружать +// +// Параметры: +// Дескриптор - ОбъектXDTO Descriptor. +// Загружать - булево, возвращаемое +// +Процедура ДоступныНовыеДанные(Знач Дескриптор, Загружать) Экспорт +``` + +Пример вызова +```bsl +ВнешниеРегламентированныеОтчетыВМоделиСервиса.ДоступныНовыеДанные(Дескриптор, Загружать) +``` +
+ +## ОбработатьНовыеДанные +
+ +Описание, пример вызова + +```bsl + +// Вызывается после вызова ДоступныНовыеДанные, позволяет разобрать данные. +// +// Параметры: +// Дескриптор - ОбъектXDTO Дескриптор. +// ПутьКФайлу - строка. Полное имя извлеченного файла. Файл будет автоматически удален +// после завершения процедуры. +// +Процедура ОбработатьНовыеДанные(Знач Дескриптор, Знач ПутьКФайлу) Экспорт +``` + +Пример вызова +```bsl +ВнешниеРегламентированныеОтчетыВМоделиСервиса.ОбработатьНовыеДанные(Дескриптор, ПутьКФайлу) +``` +
+ +## ОбработкаДанныхОтменена +
+ +Описание, пример вызова + +```bsl + +// Вызывается при отмене обработки данных в случае сбоя +// +Процедура ОбработкаДанныхОтменена(Знач Дескриптор) Экспорт +``` + +Пример вызова +```bsl +ВнешниеРегламентированныеОтчетыВМоделиСервиса.ОбработкаДанныхОтменена(Дескриптор) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВозвратНДФЛБазовый.md b/src/content/docs/zup/ВозвратНДФЛБазовый.md new file mode 100644 index 0000000..ed22a20 --- /dev/null +++ b/src/content/docs/zup/ВозвратНДФЛБазовый.md @@ -0,0 +1,45 @@ +--- +title: Возврат НДФЛ базовый +slug: zup/возврат-ндфл-базовый +--- + + +## УдержанияПоРабочимМестам +
+ +Описание, пример вызова + +```bsl + +Функция УдержанияПоРабочимМестам(РеквизитыДляПроведения) Экспорт +``` + +Пример вызова +```bsl +Результат = ВозвратНДФЛБазовый.УдержанияПоРабочимМестам(РеквизитыДляПроведения) +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПроверкиЗаполнения(Документ, Отказ, ПроверяемыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛБазовый.ОбработкаПроверкиЗаполнения(Документ, Отказ, ПроверяемыеРеквизиты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВозвратНДФЛВнутренний.md b/src/content/docs/zup/ВозвратНДФЛВнутренний.md new file mode 100644 index 0000000..da96007 --- /dev/null +++ b/src/content/docs/zup/ВозвратНДФЛВнутренний.md @@ -0,0 +1,45 @@ +--- +title: Возврат НДФЛ внутренний +slug: zup/возврат-ндфл-внутренний +--- + + +## УдержанияПоРабочимМестам +
+ +Описание, пример вызова + +```bsl + +Функция УдержанияПоРабочимМестам(РеквизитыДляПроведения) Экспорт +``` + +Пример вызова +```bsl +Результат = ВозвратНДФЛВнутренний.УдержанияПоРабочимМестам(РеквизитыДляПроведения) +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПроверкиЗаполнения(Документ, Отказ, ПроверяемыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛВнутренний.ОбработкаПроверкиЗаполнения(Документ, Отказ, ПроверяемыеРеквизиты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВозвратНДФЛРасширенный.md b/src/content/docs/zup/ВозвратНДФЛРасширенный.md new file mode 100644 index 0000000..f9323df --- /dev/null +++ b/src/content/docs/zup/ВозвратНДФЛРасширенный.md @@ -0,0 +1,45 @@ +--- +title: Возврат НДФЛ расширенный +slug: zup/возврат-ндфл-расширенный +--- + + +## УдержанияПоРабочимМестам +
+ +Описание, пример вызова + +```bsl + +Функция УдержанияПоРабочимМестам(РеквизитыДляПроведения) Экспорт +``` + +Пример вызова +```bsl +Результат = ВозвратНДФЛРасширенный.УдержанияПоРабочимМестам(РеквизитыДляПроведения) +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПроверкиЗаполнения(Документ, Отказ, ПроверяемыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛРасширенный.ОбработкаПроверкиЗаполнения(Документ, Отказ, ПроверяемыеРеквизиты) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВозвратНДФЛФормыВнутренний.md b/src/content/docs/zup/ВозвратНДФЛФормыВнутренний.md new file mode 100644 index 0000000..84d8722 --- /dev/null +++ b/src/content/docs/zup/ВозвратНДФЛФормыВнутренний.md @@ -0,0 +1,77 @@ +--- +title: Возврат НДФЛ формы внутренний +slug: zup/возврат-ндфл-формы-внутренний +--- + + +## ПослеПолученияДанныхНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеПолученияДанныхНаСервере(Форма, ОписаниеТаблицыНДФЛ) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛФормыВнутренний.ПослеПолученияДанныхНаСервере(Форма, ОписаниеТаблицыНДФЛ) +``` +
+ +## РеквизитыВДанные +
+ +Описание, пример вызова + +```bsl + +Процедура РеквизитыВДанные(Форма, ТекущийОбъект, ОписаниеТаблицыНДФЛ) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛФормыВнутренний.РеквизитыВДанные(Форма, ТекущийОбъект, ОписаниеТаблицыНДФЛ) +``` +
+ +## РаспределитьПоИсточникамФинансирования +
+ +Описание, пример вызова + +```bsl + +Процедура РаспределитьПоИсточникамФинансирования(Объект) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛФормыВнутренний.РаспределитьПоИсточникамФинансирования(Объект) +``` +
+ +## ДополнитьФормуДокумента +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьФормуДокумента(Форма) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛФормыВнутренний.ДополнитьФормуДокумента(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВозвратНДФЛФормыРасширенный.md b/src/content/docs/zup/ВозвратНДФЛФормыРасширенный.md new file mode 100644 index 0000000..5bd2348 --- /dev/null +++ b/src/content/docs/zup/ВозвратНДФЛФормыРасширенный.md @@ -0,0 +1,109 @@ +--- +title: Возврат НДФЛ формы расширенный +slug: zup/возврат-ндфл-формы-расширенный +--- + + +## ПослеПолученияДанныхНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеПолученияДанныхНаСервере(Форма, ОписаниеТаблицыНДФЛ) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛФормыРасширенный.ПослеПолученияДанныхНаСервере(Форма, ОписаниеТаблицыНДФЛ) +``` +
+ +## РеквизитыВДанные +
+ +Описание, пример вызова + +```bsl + +Процедура РеквизитыВДанные(Форма, ТекущийОбъект, ОписаниеТаблицыНДФЛ) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛФормыРасширенный.РеквизитыВДанные(Форма, ТекущийОбъект, ОписаниеТаблицыНДФЛ) +``` +
+ +## РаспределитьПоИсточникамФинансирования +
+ +Описание, пример вызова + +```bsl + +Процедура РаспределитьПоИсточникамФинансирования(Объект) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛФормыРасширенный.РаспределитьПоИсточникамФинансирования(Объект) +``` +
+ +## ДополнитьФормуДокумента +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьФормуДокумента(Форма) Экспорт +``` + +Пример вызова +```bsl +ВозвратНДФЛФормыРасширенный.ДополнитьФормуДокумента(Форма) +``` +
+ +## ОписаниеДокумента +
+ +Описание, пример вызова + +```bsl + +Функция ОписаниеДокумента(ОписаниеТаблицыНДФЛ) Экспорт +``` + +Пример вызова +```bsl +Результат = ВозвратНДФЛФормыРасширенный.ОписаниеДокумента(ОписаниеТаблицыНДФЛ)); +``` +
+ +## ОписанияТаблиц +
+ +Описание, пример вызова + +```bsl + +Функция ОписанияТаблиц(ОписаниеТаблицыНДФЛ) Экспорт +``` + +Пример вызова +```bsl +Результат = ВозвратНДФЛФормыРасширенный.ОписанияТаблиц(ОписаниеТаблицыНДФЛ)); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВыплатыПоДоговорамОпекиКлиент.md b/src/content/docs/zup/ВыплатыПоДоговорамОпекиКлиент.md new file mode 100644 index 0000000..cca258b --- /dev/null +++ b/src/content/docs/zup/ВыплатыПоДоговорамОпекиКлиент.md @@ -0,0 +1,77 @@ +--- +title: Выплаты по договорам опеки клиент +slug: zup/выплаты-по-договорам-опеки-клиент +--- + + +## ВводОграниченийПоВозрасту +
+ +Описание, пример вызова + +```bsl + +Процедура ВводОграниченийПоВозрасту(ПараметрыОграничений, ЭлементПредставления) Экспорт +``` + +Пример вызова +```bsl +ВыплатыПоДоговорамОпекиКлиент.ВводОграниченийПоВозрасту(ПараметрыОграничений, ЭлементПредставления) +``` +
+ +## ПараметрыОграниченийПоВозрасту +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыОграниченийПоВозрасту() Экспорт +``` + +Пример вызова +```bsl +Результат = ВыплатыПоДоговорамОпекиКлиент.ПараметрыОграниченийПоВозрасту() +``` +
+ +## ВводДанныхДляРасчетаРазмераВыплаты +
+ +Описание, пример вызова + +```bsl + +Процедура ВводДанныхДляРасчетаРазмераВыплаты(ПараметрыРасчетаРазмераВыплаты, ЭлементПредставления) Экспорт +``` + +Пример вызова +```bsl +ВыплатыПоДоговорамОпекиКлиент.ВводДанныхДляРасчетаРазмераВыплаты(ПараметрыРасчетаРазмераВыплаты, ЭлементПредставления) +``` +
+ +## СуммаВыплатыНаДатуРасчета +
+ +Описание, пример вызова + +```bsl + +Функция СуммаВыплатыНаДатуРасчета(Размер, Коэффициент, ВозрастОт, ВозрастДо, ВозрастНаДатуРасчета) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыплатыПоДоговорамОпекиКлиент.СуммаВыплатыНаДатуРасчета(Размер, Коэффициент, ВозрастОт, ВозрастДо, ВозрастНаДатуРасчета) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ВыплатыПоДоговорамОпекиКлиентСервер.md b/src/content/docs/zup/ВыплатыПоДоговорамОпекиКлиентСервер.md new file mode 100644 index 0000000..37dd3f0 --- /dev/null +++ b/src/content/docs/zup/ВыплатыПоДоговорамОпекиКлиентСервер.md @@ -0,0 +1,77 @@ +--- +title: Выплаты по договорам опеки клиент сервер +slug: zup/выплаты-по-договорам-опеки-клиент-сервер +--- + + +## ОграниченияПоВозрастуПредставление +
+ +Описание, пример вызова + +```bsl + +Функция ОграниченияПоВозрастуПредставление(ВозрастОт, ВозрастДо, ИсключаяДатуОт, ВключаяДатуДо) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыплатыПоДоговорамОпекиКлиентСервер.ОграниченияПоВозрастуПредставление(ВозрастОт, ВозрастДо, ИсключаяДатуОт, ВключаяДатуДо) +``` +
+ +## РасчетРазмераВыплатыПредставление +
+ +Описание, пример вызова + +```bsl + +Функция РасчетРазмераВыплатыПредставление(СпособРасчета, ПрожиточныйМинимум, Размер, Коэффициент) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыплатыПоДоговорамОпекиКлиентСервер.РасчетРазмераВыплатыПредставление(СпособРасчета, ПрожиточныйМинимум, Размер, Коэффициент) +``` +
+ +## ВозрастНаДатуРасчета +
+ +Описание, пример вызова + +```bsl + +Функция ВозрастНаДатуРасчета(ДатаРождения, ДатаРасчета) Экспорт +``` + +Пример вызова +```bsl +Результат = ВыплатыПоДоговорамОпекиКлиентСервер.ВозрастНаДатуРасчета(ДатаРождения, ДатаРасчета) +``` +
+ +## ОбновитьФормуОсобенностиПредприятияПоНастройкам +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьФормуОсобенностиПредприятияПоНастройкам(Форма) Экспорт +``` + +Пример вызова +```bsl +ВыплатыПоДоговорамОпекиКлиентСервер.ОбновитьФормуОсобенностиПредприятияПоНастройкам(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ГруппыСотрудников.md b/src/content/docs/zup/ГруппыСотрудников.md new file mode 100644 index 0000000..bd44dcb --- /dev/null +++ b/src/content/docs/zup/ГруппыСотрудников.md @@ -0,0 +1,292 @@ +--- +title: Группы сотрудников +slug: zup/группы-сотрудников +--- + + +## ГруппыСотрудников +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений с колонками Сотрудник и Группа, содержащую +// сотрудников и группы в которые сотрудники относится. +// +// Параметры: +// Сотрудники - Массив, ссылок на элементы справочника сотрудники +// - СправочникСсылка.Сотрудники +// ОбрабатыватьГруппыПоиска - Булево, позволяет исключить из обработки +// группы поиска. +// +// Возвращаемое значение; +// ТаблицаЗначений +// * Сотрудник - СправочникСсылка.Сотрудники +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// * Группа - СправочникСсылка.ГруппыСотрудников +// +Функция ГруппыСотрудников(Сотрудники, ОбрабатыватьГруппыПоиска = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ГруппыСотрудников.ГруппыСотрудников(Сотрудники, ОбрабатыватьГруппыПоиска); +``` +
+ +## ГруппыСотрудниковФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений с колонками Сотрудник, физическоеЛицо +// +// Параметры: +// ФизическиеЛица - Массив, ссылок на элементы справочника сотрудники +// - СправочникСсылка.ФизическиеЛица +// ОбрабатыватьГруппыПоиска - Булево, позволяет исключить из обработки +// группы поиска. +// +// Возвращаемое значение; +// ТаблицаЗначений +// * Сотрудник - СправочникСсылка.Сотрудники +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// * Группа - СправочникСсылка.ГруппыСотрудников +// +Функция ГруппыСотрудниковФизическихЛиц(ФизическиеЛица, ОбрабатыватьГруппыПоиска = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ГруппыСотрудников.ГруппыСотрудниковФизическихЛиц(ФизическиеЛица, ОбрабатыватьГруппыПоиска); +``` +
+ +## СотрудникиГруппыПоискаПоНастройкам +
+ +Описание, пример вызова + +```bsl + +// Возвращает сотрудников, соответствующих критериям поиска +// +// Параметры: +// НастройкиЗаполнения - настройки СКД отчета по сотрудникам. +// ГруппаПоиска - СправочникСсылка.ГруппыСотрудников +// +// ТаблицаЗначений +// * Сотрудник - СправочникСсылка.Сотрудники +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// +Функция СотрудникиГруппыПоискаПоНастройкам(НастройкиЗаполнения, ГруппаПоиска) Экспорт +``` + +Пример вызова +```bsl +Результат = ГруппыСотрудников.СотрудникиГруппыПоискаПоНастройкам(НастройкиЗаполнения, ГруппаПоиска) +``` +
+ +## СотрудникиГруппыПоиска +
+ +Описание, пример вызова + +```bsl + +// Возвращает сотрудников группы поиска +// +// Параметры: +// ГруппаПоиска - СправочникСсылка.ГруппыСотрудников +// +// Возвращаемое значение: +// ТаблицаЗначений +// * Сотрудник - СправочникСсылка.Сотрудники +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// Неопределено, если настройки не заданы. +// +Функция СотрудникиГруппыПоиска(ГруппаПоиска) Экспорт +``` + +Пример вызова +```bsl +Результат = ГруппыСотрудников.СотрудникиГруппыПоиска(ГруппаПоиска) +``` +
+ +## СоставГруппСотрудников +
+ +Описание, пример вызова + +```bsl + +// Возвращает список сотрудников входящих в состав одной из групп, переданных в параметрах. +// +// Параметры: +// ГруппыСотрудников - Массив ссылок на группы сотрудников +// - СправочникСсылка.ГруппыСотрудников +// ДополнятьСоставомПодчиненныхГрупп - Булево +// +// Возвращаемое значение: +// ТаблицаЗначений +// * Сотрудник - СправочникСсылка.Сотрудники +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// * Группа - СправочникСсылка.ГруппыСотрудников +// +Функция СоставГруппСотрудников(СписокГруппСотрудников, ДополнятьСоставомПодчиненныхГрупп = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ГруппыСотрудников.СоставГруппСотрудников(СписокГруппСотрудников, ДополнятьСоставомПодчиненныхГрупп); +``` +
+ +## СоздатьВТГруппыСотрудников +
+ +Описание, пример вызова + +```bsl + +// Создает в менеджере временных таблиц временную таблицу содержащую поля Сотрудник, ФизическоеЛицо, Группа. +// +// Параметры: +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +// Сотрудники - Массив сотрудников +// СправочникСсылка.Сотрудники +// ОбрабатыватьГруппыПоиска - Булево +// ИмяВТГруппыСотрудников - Строка +// +// Возвращаемое значение: +// РезультатЗапроса +// +Функция СоздатьВТГруппыСотрудников(МенеджерВременныхТаблиц, Сотрудники, ОбрабатыватьГруппыПоиска = Истина, ИмяВТГруппыСотрудников = "ВТГруппыСотрудников") Экспорт +``` + +Пример вызова +```bsl +Результат = ГруппыСотрудников.СоздатьВТГруппыСотрудников(МенеджерВременныхТаблиц, Сотрудники, ОбрабатыватьГруппыПоиска, ИмяВТГруппыСотрудников); +``` +
+ +## СоздатьВТГруппыСотрудниковФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Создает в менеджере временных таблиц временную таблицу содержащую поля Сотрудник, ФизическоеЛицо, Группа. +// +// Параметры: +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +// ФизическиеЛица - Массив сотрудников +// СправочникСсылка.ФизическиеЛица +// ОбрабатыватьГруппыПоиска - Булево +// ИмяВТГруппыСотрудниковФизическихЛиц - Строка +// +// Возвращаемое значение: +// РезультатЗапроса +// +Функция СоздатьВТГруппыСотрудниковФизическихЛиц(МенеджерВременныхТаблиц, ФизическиеЛица, ОбрабатыватьГруппыПоиска = Истина, ИмяВТГруппыСотрудниковФизическихЛиц = "ВТГруппыСотрудниковФизическихЛиц") Экспорт +``` + +Пример вызова +```bsl +Результат = ГруппыСотрудников.СоздатьВТГруппыСотрудниковФизическихЛиц(МенеджерВременныхТаблиц, ФизическиеЛица, ОбрабатыватьГруппыПоиска, ИмяВТГруппыСотрудниковФизическихЛиц); +``` +
+ +## ТаблицаГруппСотрудников +
+ +Описание, пример вызова + +```bsl + +Функция ТаблицаГруппСотрудников(СписокСотрудников, ПоСправочникуСотрудники, ОбрабатыватьГруппыПоиска) Экспорт +``` + +Пример вызова +```bsl +Результат = ГруппыСотрудников.ТаблицаГруппСотрудников(СписокСотрудников, ПоСправочникуСотрудники, ОбрабатыватьГруппыПоиска)); +``` +
+ +## СотрудникиГруппСотрудниковВФоне +
+ +Описание, пример вызова + +```bsl + +Процедура СотрудникиГруппСотрудниковВФоне(Параметры, АдресХранилища) Экспорт +``` + +Пример вызова +```bsl +ГруппыСотрудников.СотрудникиГруппСотрудниковВФоне(Параметры, АдресХранилища) +``` +
+ +## ДинамическийСписокГруппСотрудниковПриПолученииДанныхНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ДинамическийСписокГруппСотрудниковПриПолученииДанныхНаСервере(ИмяЭлемента, Настройки, Строки) Экспорт +``` + +Пример вызова +```bsl +ГруппыСотрудников.ДинамическийСписокГруппСотрудниковПриПолученииДанныхНаСервере(ИмяЭлемента, Настройки, Строки) +``` +
+ +## ВосстановлениеПараметровДинамическихГрупп +
+ +Описание, пример вызова + +```bsl + +Процедура ВосстановлениеПараметровДинамическихГрупп(ПараметрыОбновления = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ГруппыСотрудников.ВосстановлениеПараметровДинамическихГрупп(ПараметрыОбновления); +``` +
+ +## ЗаменитьПараметрРекурсивно +
+ +Описание, пример вызова + +```bsl + +Функция ЗаменитьПараметрРекурсивно(ЭлементыОтбора) Экспорт +``` + +Пример вызова +```bsl +Результат = ГруппыСотрудников.ЗаменитьПараметрРекурсивно(ЭлементыОтбора)); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ГруппыСотрудниковВызовСервера.md b/src/content/docs/zup/ГруппыСотрудниковВызовСервера.md new file mode 100644 index 0000000..175d851 --- /dev/null +++ b/src/content/docs/zup/ГруппыСотрудниковВызовСервера.md @@ -0,0 +1,29 @@ +--- +title: Группы сотрудников вызов сервера +slug: zup/группы-сотрудников-вызов-сервера +--- + + +## СотрудникиГруппСотрудников +
+ +Описание, пример вызова + +```bsl + +Функция СотрудникиГруппСотрудников(СписокГруппСотрудников, ДополнятьСоставомПодчиненныхГрупп = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ГруппыСотрудниковВызовСервера.СотрудникиГруппСотрудников(СписокГруппСотрудников, ДополнятьСоставомПодчиненныхГрупп); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДанныеВыбораБЗК.md b/src/content/docs/zup/ДанныеВыбораБЗК.md new file mode 100644 index 0000000..95816b7 --- /dev/null +++ b/src/content/docs/zup/ДанныеВыбораБЗК.md @@ -0,0 +1,59 @@ +--- +title: Данные выбора БЗК +slug: zup/данные-выбора-бзк +--- + + +## ЗаполнитьДляКлассификатораСПорядкомПоКоду +
+ +Описание, пример вызова + +```bsl + +// Обработчик получения данных выбора для справочников, упорядоченных по коду. +// Готовит данные выбора для справочников-классификаторов, упорядочивает по коду и наименованию. +// +// Вызывается из обработчика ОбработкаПолученияДанныхВыбора для формирования списка при вводе по строке, +// автоподборе текста и быстром выборе, а также при выполнении метода ПолучитьДанныеВыбора. +// +// Параметры: +// Источник - СправочникМенеджер - объект, для которого формируется список выбора. +// ДанныеВыбора - СписокЗначений - данные для выбора. +// Параметры - Структура - содержит параметры выбора. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// +Процедура ЗаполнитьДляКлассификатораСПорядкомПоКоду( Экспорт +``` + +Пример вызова +```bsl +ДанныеВыбораБЗК.ЗаполнитьДляКлассификатораСПорядкомПоКоду(); +``` +
+ +## ЗаполнитьДляКлассификатораСПорядкомПоДопРеквизиту +
+ +Описание, пример вызова + +```bsl + +// Обработчик получения данных выбора для справочников, упорядоченных по реквизиту допупорядочивания. +// +Процедура ЗаполнитьДляКлассификатораСПорядкомПоДопРеквизиту( Экспорт +``` + +Пример вызова +```bsl +ДанныеВыбораБЗК.ЗаполнитьДляКлассификатораСПорядкомПоДопРеквизиту(); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДепонированиеЗарплатыФормыБазовый.md b/src/content/docs/zup/ДепонированиеЗарплатыФормыБазовый.md new file mode 100644 index 0000000..b38beb6 --- /dev/null +++ b/src/content/docs/zup/ДепонированиеЗарплатыФормыБазовый.md @@ -0,0 +1,41 @@ +--- +title: Депонирование зарплаты формы базовый +slug: zup/депонирование-зарплаты-формы-базовый +--- + + +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Для вызова из модуля формы и расширенной реализации. +// Не следует использовать для вызова из других подсистем. + +// Обработчик события ПриСозданииНаСервере формы документа ДепонированиеЗарплаты. +// Устанавливает первоначальные значения реквизитов объекта. +// Инициализирует реквизиты формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, которая создается. +// Отказ - Булево - признак отказа от создания формы. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// +Процедура ПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ДепонированиеЗарплатыФормыБазовый.ПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДепонированиеЗарплатыФормыВнутренний.md b/src/content/docs/zup/ДепонированиеЗарплатыФормыВнутренний.md new file mode 100644 index 0000000..cfc7c6f --- /dev/null +++ b/src/content/docs/zup/ДепонированиеЗарплатыФормыВнутренний.md @@ -0,0 +1,29 @@ +--- +title: Депонирование зарплаты формы внутренний +slug: zup/депонирование-зарплаты-формы-внутренний +--- + + +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ДепонированиеЗарплатыФормыВнутренний.ПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДепонированиеЗарплатыФормыРасширенный.md b/src/content/docs/zup/ДепонированиеЗарплатыФормыРасширенный.md new file mode 100644 index 0000000..55903d4 --- /dev/null +++ b/src/content/docs/zup/ДепонированиеЗарплатыФормыРасширенный.md @@ -0,0 +1,38 @@ +--- +title: Депонирование зарплаты формы расширенный +slug: zup/депонирование-зарплаты-формы-расширенный +--- + + +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриСозданииНаСервере формы документа. +// Устанавливает первоначальные значения реквизитов объекта. +// Инициализирует реквизиты формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, которая создается. +// Отказ - Булево - признак отказа от создания формы. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// +Процедура ПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ДепонированиеЗарплатыФормыРасширенный.ПриСозданииНаСервере(Форма, Отказ, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДеревоЭлектронногоДокументаБЭДСлужебный.md b/src/content/docs/zup/ДеревоЭлектронногоДокументаБЭДСлужебный.md new file mode 100644 index 0000000..e0da4b2 --- /dev/null +++ b/src/content/docs/zup/ДеревоЭлектронногоДокументаБЭДСлужебный.md @@ -0,0 +1,899 @@ +--- +title: Дерево электронного документа БЭД служебный +slug: zup/дерево-электронного-документа-бэд-служебный +--- + + +## ТипОбъекта +
+ +Описание, пример вызова + +```bsl + +// Определяет тип объекта по текстовому представлению. +// +// Параметры: +// ОписаниеТипаОбъекта - Строка - текстовое представление типа объекта. +// +// Возвращаемое значение: +// Строка - тип справочника. +// +Функция ТипОбъекта(ОписаниеТипаОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ТипОбъекта(ОписаниеТипаОбъекта) +``` +
+ +## ЗаполнитьПараметрыОбработкиОшибокВСтрокеДерева +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьПараметрыОбработкиОшибокВСтрокеДерева(СтрокаДерева, ПараметрыОбработкиОшибок) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ЗаполнитьПараметрыОбработкиОшибокВСтрокеДерева(СтрокаДерева, ПараметрыОбработкиОшибок) +``` +
+ +## ДеревоЭлектронногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Формирует дерево данных для заполнения или чтения прикладным решением. +// +// Параметры: +// Макет - Макет - Макет с описанием структуры дерева (см. Обработка.ОбменСКонтрагентами.Макеты). +// +// Возвращаемое значение: +// ДеревоЗначений - Дерево документа. +// +Функция ДеревоЭлектронногоДокумента(Макет) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ДеревоЭлектронногоДокумента(Макет) +``` +
+ +## КолонкиДереваДокумента +
+ +Описание, пример вызова + +```bsl + +// Возвращает список колонок, добавляемых в дерево данных электронного документа помимо объявленных в макете. +// +// Возвращаемое значение: +// ФиксированныйМассив - массив колонок. +// +Функция КолонкиДереваДокумента() Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.КолонкиДереваДокумента()); +``` +
+ +## РекурсивноЗаполнитьСтрокиДерева +
+ +Описание, пример вызова + +```bsl + +Процедура РекурсивноЗаполнитьСтрокиДерева(ДеревоЗначений, Знач НомерУровня, КолУровней, Знач ПолныйПутьВДереве, ТЗ, НомерСтрокиТЗ) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.РекурсивноЗаполнитьСтрокиДерева(ДеревоЗначений, НомерУровня, КолУровней, ПолныйПутьВДереве, ТЗ, НомерСтрокиТЗ)); +``` +
+ +## ОписаниеТипаПоПараметрам +
+ +Описание, пример вызова + +```bsl + +// Преобразует текстовое описание типа в объект ОписаниеТипов. +// +// Параметры: +// Типы - Массив, Строка - см. ОписаниеТипов(). +// ОписаниеЧисла - Строка - см. КвалификаторыЧислаПоОписанию(). +// ОписаниеСтроки - Строка - см. КвалификаторыСтрокиПоОписанию(). +// ОписаниеДаты - Строка - см. КвалификаторыДатыПоОписанию(). +// +// Возвращаемое значение: +// ОписаниеТипов - сформированное описание типов. +// +Функция ОписаниеТипаПоПараметрам(Типы, ОписаниеЧисла, ОписаниеСтроки, ОписаниеДаты) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ОписаниеТипаПоПараметрам(Типы, ОписаниеЧисла, ОписаниеСтроки, ОписаниеДаты)); +``` +
+ +## КвалификаторыСтрокиПоОписанию +
+ +Описание, пример вызова + +```bsl + +// Формирует квалификатор строки по текстовому описанию. +// +// Параметры: +// ОписаниеСтроки - Строка - содержит значения параметров конструктора "КвалификаторыСтроки", перечисленные через +// запятую. В качестве допустимого знака указывается имя одного из значений системного +// перечисления "ДопустимаяДлина". Пример: "100, Переменная". +// +// Возвращаемое значение: +// КвалификаторыСтроки - сформированный квалификатор. +// +Функция КвалификаторыСтрокиПоОписанию(ОписаниеСтроки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.КвалификаторыСтрокиПоОписанию(ОписаниеСтроки)); +``` +
+ +## КвалификаторыДатыПоОписанию +
+ +Описание, пример вызова + +```bsl + +// Формирует квалификатор даты по текстовому описанию. +// +// Параметры: +// ОписаниеДаты - Строка - содержит значения параметров конструктора "КвалификаторыДаты", перечисленные через +// запятую. В качестве допустимого знака указывается имя одного из значений системного +// перечисления "ЧастиДаты". Пример: "ДатаВремя". +// +// Возвращаемое значение: +// КвалификаторыДаты - сформированный квалификатор. +// +Функция КвалификаторыДатыПоОписанию(ОписаниеДаты) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.КвалификаторыДатыПоОписанию(ОписаниеДаты)); +``` +
+ +## КвалификаторыЧислаПоОписанию +
+ +Описание, пример вызова + +```bsl + +// Формирует квалификатор числа по текстовому описанию. +// +// Параметры: +// ОписаниеЧисла - Строка - содержит значения параметров конструктора "КвалификаторыЧисла", перечисленные через +// запятую. В качестве допустимого знака указывается имя одного из значений системного +// перечисления "ДопустимыйЗнак". Пример: "15, 3, Неотрицательный". +// +// Возвращаемое значение: +// КвалификаторыЧисла - сформированный квалификатор. +// +Функция КвалификаторыЧислаПоОписанию(ОписаниеЧисла) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.КвалификаторыЧислаПоОписанию(ОписаниеЧисла)); +``` +
+ +## ДобавитьСлужебныеКолонкиВТаблицуДереваДокумента +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьСлужебныеКолонкиВТаблицуДереваДокумента(ТаблицаДерева) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ДобавитьСлужебныеКолонкиВТаблицуДереваДокумента(ТаблицаДерева)); +``` +
+ +## ДанныеЭлементаДереваЭлектронногоДокумента +
+ +Описание, пример вызова + +```bsl + +// См. ЭлектронноеВзаимодействие.ДанныеЭлементаДереваЭлектронногоДокумента +Функция ДанныеЭлементаДереваЭлектронногоДокумента(Знач Дерево, Знач Путь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ДанныеЭлементаДереваЭлектронногоДокумента(Дерево, Путь) +``` +
+ +## ЭтоНоменклатура +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоНоменклатура(СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ЭтоНоменклатура(СсылкаНаОбъект) +``` +
+ +## ДанныеГруппыДереваЭлектронногоДокумента +
+ +Описание, пример вызова + +```bsl + +Функция ДанныеГруппыДереваЭлектронногоДокумента(Знач ГруппаДерева) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ДанныеГруппыДереваЭлектронногоДокумента(ГруппаДерева)); +``` +
+ +## ДанныеВыбораДереваЭлектронногоДокумента +
+ +Описание, пример вызова + +```bsl + +Функция ДанныеВыбораДереваЭлектронногоДокумента(Знач ВыборДерева) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ДанныеВыбораДереваЭлектронногоДокумента(ВыборДерева)); +``` +
+ +## ДанныеТаблицыДереваЭлектронногоДокумента +
+ +Описание, пример вызова + +```bsl + +Функция ДанныеТаблицыДереваЭлектронногоДокумента(Знач ТаблицаДерева) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ДанныеТаблицыДереваЭлектронногоДокумента(ТаблицаДерева)); +``` +
+ +## ДанныеЗначенияДереваЭлектронногоДокумента +
+ +Описание, пример вызова + +```bsl + +Функция ДанныеЗначенияДереваЭлектронногоДокумента(Знач ЗначениеДерева) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ДанныеЗначенияДереваЭлектронногоДокумента(ЗначениеДерева)); +``` +
+ +## ДобавитьСтрокиТипаВТаблицуДереваДокумента +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьСтрокиТипаВТаблицуДереваДокумента(ТаблицаМакета, СтрокаТаблицы, Макет) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ДобавитьСтрокиТипаВТаблицуДереваДокумента(ТаблицаМакета, СтрокаТаблицы, Макет)); +``` +
+ +## ПроверитьЗаполнениеРеквизитовДереваДанных +
+ +Описание, пример вызова + +```bsl + +// Проверяет заполнение обязательных реквизитов дерева. +// Только для внутреннего использования. +// Параметры: +// ДеревоДанных - деревоЗначений - дерево с данными. +// Ошибки - Массив - ошибки, накопленные за время обработки. Элементами массива являются структуры. +// Состав структур см. в ОбщегоНазначенияБЭДКлиентСервер.НовыеПараметрыОшибки(). +// ЭтоТаблица - Булево - если Истина, то проверяется табличная часть. +// НомерСтроки - Число, Неопределено - номер проверяемой строки табличной части. +// ПроверятьОбязательностьПараметровОшибки - Булево - определяет, нужно ли проверять, заданы ли параметры обработки ошибок +// в тех реквизитах, для которых это обязательно. +// ДатаПоФорматуФНС - Булево - если установлена в Истину, значения типа "Дата" будут проверяться дополнительно +// на вхождение в диапазон лет 1900-2099 (требование схем ФНС). +// +Процедура ПроверитьЗаполнениеРеквизитовДереваДанных(ДеревоДанных, Ошибки, ЭтоТаблица, Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ПроверитьЗаполнениеРеквизитовДереваДанных(ДеревоДанных, Ошибки, ЭтоТаблица, ); +``` +
+ +## ТекстОшибкиНеЗаполненногоЗначенияДерева +
+ +Описание, пример вызова + +```bsl + +// Возвращает стандартный текст ошибки для незаполненного значения дерева. +// +// Возвращаемое значение: +// Строка - текст ошибки. +// +Функция ТекстОшибкиНеЗаполненногоЗначенияДерева() Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ТекстОшибкиНеЗаполненногоЗначенияДерева() +``` +
+ +## ДобавитьОшибкуПроверкиДереваДанных +
+ +Описание, пример вызова + +```bsl + +// Добавляет в ошибку в хранилище накопленных ошибок. +// +// Параметры: +// Ошибки - Массив - ошибки, накопленные за время обработки. Элементами массива являются структуры. +// Состав структур см. ОбщегоНазначенияБЭДКлиентСервер.НовыеПараметрыОшибки. +// СтрокаДерева - СтрокаДереваЗначений - строка дерева электронного документа, по реквизиту которой +// фиксируется ошибка. +// ТекстОшибки - Строка - текст фиксируемой ошибки. +// ПодставлятьИмяРеквизита - Булево - если Истина, в начало сообщения об ошибке будет подставлено +// прикладное имя реквизита. +// НомерСтрокиДанных - Число - если указана, будет подставлена в имя реквизита. +// ПрикладноеПредставлениеРеквизита - Строка - если указано, представление реквизита не будет получаться по строке дерева - +// будет использовано указанное представление. +// +Процедура ДобавитьОшибкуПроверкиДереваДанных(Ошибки, СтрокаДерева, ТекстОшибки, ПодставлятьИмяРеквизита = Истина, Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ДобавитьОшибкуПроверкиДереваДанных(Ошибки, СтрокаДерева, ТекстОшибки, ПодставлятьИмяРеквизита, ); +``` +
+ +## ПрикладноеПредставлениеПоСтрокеДерева +
+ +Описание, пример вызова + +```bsl + +// Формирует прикладное представление реквизита дерева электронного документа. +// +// Параметры: +// СтрокаДереваДанных - СтрокаДереваЗначений - строка реквизита дерева электронного документа. +// НомерСтрокиДанных - Число - номер строки, который будет подставлен по возможности в представление. +// +// Возвращаемое значение: +// Строка - прикладное представление реквизита дерева. +// +Функция ПрикладноеПредставлениеПоСтрокеДерева(СтрокаДереваДанных, НомерСтрокиДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ПрикладноеПредставлениеПоСтрокеДерева(СтрокаДереваДанных, НомерСтрокиДанных); +``` +
+ +## ПрикладноеПредставлениеРеквизита +
+ +Описание, пример вызова + +```bsl + +// Прикладное представление реквизита по коду. +// +// Параметры: +// Код - Строка - код реквизита. +// +// Возвращаемое значение: +// Строка - представления реквизита. +// +Функция ПрикладноеПредставлениеРеквизита(Код) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ПрикладноеПредставлениеРеквизита(Код)); +``` +
+ +## ПараметрыОбработкиОшибкиУказаны +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыОбработкиОшибкиУказаны(СтрокаДерева) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ПараметрыОбработкиОшибкиУказаны(СтрокаДерева)); +``` +
+ +## ПолучитьПредставлениеТипаПоСтрокеДерева +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПредставлениеТипаПоСтрокеДерева(Строка, ДатаПоФорматуФНС = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ПолучитьПредставлениеТипаПоСтрокеДерева(Строка, ДатаПоФорматуФНС); +``` +
+ +## ЗначениеВСтрокеДереваСоответствуетТипу +
+ +Описание, пример вызова + +```bsl + +Функция ЗначениеВСтрокеДереваСоответствуетТипу(СтрокаДерева, ДатаПоФорматуФНС = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ЗначениеВСтрокеДереваСоответствуетТипу(СтрокаДерева, ДатаПоФорматуФНС); +``` +
+ +## ПараметрыОшибкиПоСтрокеДерева +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыОшибкиПоСтрокеДерева(СтрокаДерева) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ПараметрыОшибкиПоСтрокеДерева(СтрокаДерева)); +``` +
+ +## ПроверитьЗаполненностьПараметровОбработкиОшибок +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьЗаполненностьПараметровОбработкиОшибок(СтрокаДерева) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ПроверитьЗаполненностьПараметровОбработкиОшибок(СтрокаДерева)); +``` +
+ +## ПроверитьЗаполнениеРеквизитаДереваДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьЗаполнениеРеквизитаДереваДанных(СтрокаДерева, ПроверятьОбязательностьПараметровОшибки, ДатаПоФорматуФНС, ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ПроверитьЗаполнениеРеквизитаДереваДанных(СтрокаДерева, ПроверятьОбязательностьПараметровОшибки, ДатаПоФорматуФНС, ТекстОшибки)); +``` +
+ +## ИзвлечьСопоставлениеНоменклатурыИзДереваДокумента +
+ +Описание, пример вызова + +```bsl + + +// Извлекает данные для сопоставления номенклатуры из строки товара дерева документа. +// +// Параметры: +// СтрокаТовара - СтрокаДереваЗначений - строка товара дерева документа, из которой нужно извлечь данные. +// +// Возвращаемое значение: +// Структура - информация для сопоставления товаров. +// +Функция ИзвлечьСопоставлениеНоменклатурыИзДереваДокумента(Знач СтрокаТовара) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ИзвлечьСопоставлениеНоменклатурыИзДереваДокумента(СтрокаТовара) +``` +
+ +## ДобавитьСсылкуНаОбъект +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьСсылкуНаОбъект(СсылкиНаОбъектыПоИндексам, СсылкаНаОбъект, ИндексСтроки) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ДобавитьСсылкуНаОбъект(СсылкиНаОбъектыПоИндексам, СсылкаНаОбъект, ИндексСтроки) +``` +
+ +## ЭтоСсылочныйОбъект +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоСсылочныйОбъект(ТипОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ЭтоСсылочныйОбъект(ТипОбъекта) +``` +
+ +## СтруктураКолонокТаблицыДерева +
+ +Описание, пример вызова + +```bsl + +Функция СтруктураКолонокТаблицыДерева(Дерево, НазваниеТаблицы) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.СтруктураКолонокТаблицыДерева(Дерево, НазваниеТаблицы) +``` +
+ +## НазваниеКолонки +
+ +Описание, пример вызова + +```bsl + +// Возвращает название реквизита из полного пути +// +// Параметры: +// ПолныйПуть - Строка - Полный путь до реквизита в дереве. +// +// Возвращаемое значение: +// Строка - Название реквизита +// +Функция НазваниеКолонки(ПолныйПуть) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.НазваниеКолонки(ПолныйПуть) +``` +
+ +## ДанныеШапкиДерева +
+ +Описание, пример вызова + +```bsl + +Функция ДанныеШапкиДерева(ДеревоДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ДанныеШапкиДерева(ДеревоДанных) +``` +
+ +## ДанныеТаблицыДерева +
+ +Описание, пример вызова + +```bsl + +Функция ДанныеТаблицыДерева(ДеревоДанных, НазваниеТаблицы) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ДанныеТаблицыДерева(ДеревоДанных, НазваниеТаблицы) +``` +
+ +## СкопироватьСтрокиДереваДляТаблицыРекурсивно +
+ +Описание, пример вызова + +```bsl + +Процедура СкопироватьСтрокиДереваДляТаблицыРекурсивно(СтрокаПолучатель, СтрокаИсточник) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.СкопироватьСтрокиДереваДляТаблицыРекурсивно(СтрокаПолучатель, СтрокаИсточник) +``` +
+ +## СтрокаДерева +
+ +Описание, пример вызова + +```bsl + +// Возвращает строку дерева значений для заполнения в прикладном решении +// +// Параметры: +// ДеревоДанных - ДеревоЗначений - дерево с данными +// НазваниеПоля - Строка - название поля в дереве, содержащее полный путь к реквизиту +// НайтиРекурсивно - Булево, Истина - если требуется рекурсивный поиск. +// +// Возвращаемое значение: +// Строка таблицы значений - содержит строку дерева. +// +Функция СтрокаДерева(ДеревоДанных, НазваниеПоля, НайтиРекурсивно = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.СтрокаДерева(ДеревоДанных, НазваниеПоля, НайтиРекурсивно); +``` +
+ +## ДобавитьДопДанныеВДерево +
+ +Описание, пример вызова + +```bsl + +// В процедуре происходит добавление данных из СтруктурыДанных в ДеревоЗначений. +// +// Параметры: +// СтрокаДерева - ДеревоЗначений, СтрокаДереваЗначений - содержит данные. +// СтруктураДопДанных - Структура - данные, которые необходимо поместить в дерево. +// ЮридическиЗначимый - Булево - если Истина - то текущие данные необходимо по возможности поместить в основной ЭД. +// ДобавлятьНовыеСтроки - Булево - если Истина - разрешает добавление строк с одинаковым путем в дерево. +// +Процедура ДобавитьДопДанныеВДерево(СтрокаДерева, СтруктураДопДанных, ЮридическиЗначимый = Ложь, ДобавлятьНовыеСтроки = Ложь) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ДобавитьДопДанныеВДерево(СтрокаДерева, СтруктураДопДанных, ЮридическиЗначимый, ДобавлятьНовыеСтроки); +``` +
+ +## ЗагрузитьТаблицуВДерево +
+ +Описание, пример вызова + +```bsl + +// Записывает данные из таблицы значений в дерево значений. +// +// Параметры: +// Дерево - ДеревоЗначений - дерево данных, в котором необходимо сохранить данные. +// ТаблицаДанных - таблицаЗначений - записываемые в дерево данные. Таблица может предварительно дополняться данными +// для обработки ошибок: +// см. ЭлектронноеВзаимодействие.ДобавитьВТаблицуОбработкуОшибкиЧерезСообщениеПользователю, +// ЭлектронноеВзаимодействие.ДобавитьВТаблицуОбработкуОшибкиЧерезНавигационнуюСсылку, +// ЭлектронноеВзаимодействие.ДобавитьВТаблицуОбработкуОшибкиЧерезОткрытиеФормы. +// +// НазваниеТаблицы - Строка - название таблицы в дереве. +// +Процедура ЗагрузитьТаблицуВДерево(Дерево, ТаблицаДанных, НазваниеТаблицы) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ЗагрузитьТаблицуВДерево(Дерево, ТаблицаДанных, НазваниеТаблицы) +``` +
+ +## ЗагрузитьСтруктуруВГруппуДерева +
+ +Описание, пример вызова + +```bsl + +// Записывает данные из структуры в группу дерева значений +// +// Параметры: +// Дерево - ДеревоЗначений - дерево данных, в котором необходимо сохранить данные +// СтруктураДанных - Структура - данные, которые должны быть загружены в группу +// Путь - Строка - название группы в дереве. +// +Процедура ЗагрузитьСтруктуруВГруппуДерева(Дерево, СтруктураДанных, Путь) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ЗагрузитьСтруктуруВГруппуДерева(Дерево, СтруктураДанных, Путь) +``` +
+ +## ОбработатьРеквизитДереваСУчетомПризнака +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработатьРеквизитДереваСУчетомПризнака(СтрокаДанных, ТекущаяСтрока, СтрокаРеквизита, Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ОбработатьРеквизитДереваСУчетомПризнака(СтрокаДанных, ТекущаяСтрока, СтрокаРеквизита, ); +``` +
+ +## ПодготовитьВходныеПараметрыДляДобавленияОбработкиОшибки +
+ +Описание, пример вызова + +```bsl + +Процедура ПодготовитьВходныеПараметрыДляДобавленияОбработкиОшибки(СтрокиТаблицы, НаборСтрок) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ПодготовитьВходныеПараметрыДляДобавленияОбработкиОшибки(СтрокиТаблицы, НаборСтрок) +``` +
+ +## ДобавитьПараметрыОбработкиОшибкиВНабор +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьПараметрыОбработкиОшибкиВНабор(СтрокаТаблицыДанных, ПолеТаблицы, ПараметрыОбработкиОшибки) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ДобавитьПараметрыОбработкиОшибкиВНабор(СтрокаТаблицыДанных, ПолеТаблицы, ПараметрыОбработкиОшибки) +``` +
+ +## ЭтоСсылочноеЗначениеДереваРазбора +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоСсылочноеЗначениеДереваРазбора(ДеревоРазбора, Значение, СтрокаПоСсылке = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебный.ЭтоСсылочноеЗначениеДереваРазбора(ДеревоРазбора, Значение, СтрокаПоСсылке); +``` +
+ +## ЗаполнитьТаблицуРекурсивно +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьТаблицуРекурсивно(ТаблицаЗначений, СтрокиДерева, НазваниеТаблицы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДеревоЭлектронногоДокументаБЭДСлужебный.ЗаполнитьТаблицуРекурсивно(ТаблицаЗначений, СтрокиДерева, НазваниеТаблицы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДеревоЭлектронногоДокументаБЭДСлужебныйПовтИсп.md b/src/content/docs/zup/ДеревоЭлектронногоДокументаБЭДСлужебныйПовтИсп.md new file mode 100644 index 0000000..bc5d15a --- /dev/null +++ b/src/content/docs/zup/ДеревоЭлектронногоДокументаБЭДСлужебныйПовтИсп.md @@ -0,0 +1,38 @@ +--- +title: Дерево электронного документа БЭД служебный повт исп +slug: zup/дерево-электронного-документа-бэд-служебный-повт-исп +--- + + +## ДеревоЭлектронногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Формирует дерево данных для заполнения или чтения прикладным решением. +// +// Параметры: +// ПутьКМакету - Строка - путь к макету в формате "ИмяОбработки.ИмяМакета", например, +// "ОбменСКонтрагентами.Акт501_Исполнитель" (см. Обработка.ОбменСКонтрагентами.Макеты). +// +// Возвращаемое значение: +// ДеревоЗначений - Дерево документа. +// +Функция ДеревоЭлектронногоДокумента(ПутьКМакету) Экспорт +``` + +Пример вызова +```bsl +Результат = ДеревоЭлектронногоДокументаБЭДСлужебныйПовтИсп.ДеревоЭлектронногоДокумента(ПутьКМакету) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДистанционнаяРаботаКлиентСервер.md b/src/content/docs/zup/ДистанционнаяРаботаКлиентСервер.md new file mode 100644 index 0000000..02210b4 --- /dev/null +++ b/src/content/docs/zup/ДистанционнаяРаботаКлиентСервер.md @@ -0,0 +1,34 @@ +--- +title: Дистанционная работа клиент сервер +slug: zup/дистанционная-работа-клиент-сервер +--- + + +## КадровыйПереводУстановитьДоступностьЭлементов +
+ +Описание, пример вызова + +```bsl + +// Устанавливает доступность. +// +// Параметры: +// Форма - Форма - имя форма кадрового перевода". +// +Процедура КадровыйПереводУстановитьДоступностьЭлементов(Форма) Экспорт +``` + +Пример вызова +```bsl +ДистанционнаяРаботаКлиентСервер.КадровыйПереводУстановитьДоступностьЭлементов(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДлительнаяОтправка.md b/src/content/docs/zup/ДлительнаяОтправка.md new file mode 100644 index 0000000..fdbfc5a --- /dev/null +++ b/src/content/docs/zup/ДлительнаяОтправка.md @@ -0,0 +1,31 @@ +--- +title: Длительная отправка +slug: zup/длительная-отправка +--- + + +## ПриУстановкеПараметровСеанса +
+ +Описание, пример вызова + +```bsl + +// Инициализация параметров сеанса. Необходимо по стандарту. Вызывается методами БСП. +// +Процедура ПриУстановкеПараметровСеанса(ИмяПараметра = Неопределено, УстановленныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправка.ПриУстановкеПараметровСеанса(ИмяПараметра, УстановленныеПараметры); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДлительнаяОтправкаВызовСервера.md b/src/content/docs/zup/ДлительнаяОтправкаВызовСервера.md new file mode 100644 index 0000000..73a4303 --- /dev/null +++ b/src/content/docs/zup/ДлительнаяОтправкаВызовСервера.md @@ -0,0 +1,109 @@ +--- +title: Длительная отправка вызов сервера +slug: zup/длительная-отправка-вызов-сервера +--- + + +## ОшибкиСервер +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкиСервер() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаВызовСервера.ОшибкиСервер() +``` +
+ +## ИзменитьПараметрыДлительнойОтправкиСервер +
+ +Описание, пример вызова + +```bsl + +Процедура ИзменитьПараметрыДлительнойОтправкиСервер(КлючПараметра, НовоеЗначение) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаВызовСервера.ИзменитьПараметрыДлительнойОтправкиСервер(КлючПараметра, НовоеЗначение) +``` +
+ +## ОчиститьПараметрыДлительнойОтправкиСервер +
+ +Описание, пример вызова + +```bsl + +Процедура ОчиститьПараметрыДлительнойОтправкиСервер() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаВызовСервера.ОчиститьПараметрыДлительнойОтправкиСервер() +``` +
+ +## ПолучитьОшибкиПоследнегоОбмена +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьОшибкиПоследнегоОбмена(ИмяПользователя = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаВызовСервера.ПолучитьОшибкиПоследнегоОбмена(ИмяПользователя); +``` +
+ +## СохранитьОшибкиПоследнегоОбмена +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьОшибкиПоследнегоОбмена(СведенияПоОшибкам, ИмяПользователя = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаВызовСервера.СохранитьОшибкиПоследнегоОбмена(СведенияПоОшибкам, ИмяПользователя); +``` +
+ +## ТекущийЭтапОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ТекущийЭтапОтправки(ОтчетСсылка, НаименованиеКонтролирующегоОргана = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаВызовСервера.ТекущийЭтапОтправки(ОтчетСсылка, НаименованиеКонтролирующегоОргана); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДлительнаяОтправкаКлиент.md b/src/content/docs/zup/ДлительнаяОтправкаКлиент.md new file mode 100644 index 0000000..f4a1665 --- /dev/null +++ b/src/content/docs/zup/ДлительнаяОтправкаКлиент.md @@ -0,0 +1,741 @@ +--- +title: Длительная отправка клиент +slug: zup/длительная-отправка-клиент +--- + + +## ПоказатьФормуДлительнойОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПоказатьФормуДлительнойОтправки(ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ПоказатьФормуДлительнойОтправки(ДополнительныеПараметры) +``` +
+ +## ОповеститьОбУдачнойОтправке +
+ +Описание, пример вызова + +```bsl + +// Процедура - Оповестить об удачной отправке +// +// Параметры: +// Параметры - Неопределено, Структура - Параметры оповещения: +// * ПараметрыАвтозапроса - Структура - Параметры для выполнения автозапроса. +// * РезультатОтправки - Булево - Отчет отправлен или нет. +// * ВыполняемоеОповещение - ОписаниеОповещения - описание оповещения действия, +// которое должно быть выполнено после закрытия формы длительной операции. +// +Процедура ОповеститьОбУдачнойОтправке(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОбУдачнойОтправке(Параметры); +``` +
+ +## ОповеститьОНеудачнойОтправке +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Параметры - Неопределено, Структура - Параметры оповещения: +// * НетДоступаВИнтернет - Булево - Флаг, сообщающий об неудачной отправки в связи с отсуствием Интернета. +// * ПараметрыАвтозапроса - Структура - Параметры для выполнения автозапроса. +// * РезультатОтправки - Булево - Отчет отправлен или нет. +// * ВыполняемоеОповещение - ОписаниеОповещения - описание оповещения действия, +// которое должно быть выполнено после закрытия формы длительной операции. +// +Процедура ОповеститьОНеудачнойОтправке(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОНеудачнойОтправке(Параметры); +``` +
+ +## ОповеститьОНеудачномДействии +
+ +Описание, пример вызова + +```bsl + +Процедура ОповеститьОНеудачномДействии(ТекстОшибки = "") Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОНеудачномДействии(ТекстОшибки); +``` +
+ +## ОповеститьОРезультатеПроверкиВИнтернете +
+ +Описание, пример вызова + +```bsl + +Процедура ОповеститьОРезультатеПроверкиВИнтернете(Успешно, Параметры) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОРезультатеПроверкиВИнтернете(Успешно, Параметры) +``` +
+ +## ЗакрытьФормуДлительнойОтправкиБезДальнейшихДействий +
+ +Описание, пример вызова + +```bsl + +Процедура ЗакрытьФормуДлительнойОтправкиБезДальнейшихДействий() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ЗакрытьФормуДлительнойОтправкиБезДальнейшихДействий() +``` +
+ +## ВывестиСообщенияССервераНаКлиенте +
+ +Описание, пример вызова + +```bsl + +// При отправке в ФСРАР и ФТС сообщения копятся на сервере, а затем выводятся на клиенте за один раз. +Процедура ВывестиСообщенияССервераНаКлиенте(СообщенияПользователю) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ВывестиСообщенияССервераНаКлиенте(СообщенияПользователю) +``` +
+ +## ПараметрыДлительнойОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыДлительнойОтправки() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ПараметрыДлительнойОтправки() +``` +
+ +## ПоказатьПростуюФормуОжидания +
+ +Описание, пример вызова + +```bsl + +Процедура ПоказатьПростуюФормуОжидания(Форма) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ПоказатьПростуюФормуОжидания(Форма) +``` +
+ +## ЗакрытьПростуюФормуОжидания +
+ +Описание, пример вызова + +```bsl + +Процедура ЗакрытьПростуюФормуОжидания(Форма) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ЗакрытьПростуюФормуОжидания(Форма) +``` +
+ +## ФормаГрупповойОтправкиЕстьСредиОткрытых +
+ +Описание, пример вызова + +```bsl + +Функция ФормаГрупповойОтправкиЕстьСредиОткрытых(УчитыватьВыполнениеОтправкиИлиПроверки = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ФормаГрупповойОтправкиЕстьСредиОткрытых(УчитыватьВыполнениеОтправкиИлиПроверки); +``` +
+ +## ФормаГрупповойОтправкиИзОткрытых +
+ +Описание, пример вызова + +```bsl + +Функция ФормаГрупповойОтправкиИзОткрытых(УчитыватьВыполнениеОтправкиИлиПроверки = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ФормаГрупповойОтправкиИзОткрытых(УчитыватьВыполнениеОтправкиИлиПроверки); +``` +
+ +## ОповещениеОЗавершенииГрупповогоДействия +
+ +Описание, пример вызова + +```bsl + +Функция ОповещениеОЗавершенииГрупповогоДействия(Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ОповещениеОЗавершенииГрупповогоДействия(Значение) +``` +
+ +## ПоказатьФормуДлительногоОбмена +
+ +Описание, пример вызова + +```bsl + +Функция ПоказатьФормуДлительногоОбмена(ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ПоказатьФормуДлительногоОбмена(ДополнительныеПараметры) +``` +
+ +## ОповеститьОСменеЭтапаОбмена +
+ +Описание, пример вызова + +```bsl + +// Оповещение формы бублика о начале нового этапа обмена. +// Используется для наращивания процента. +// +Процедура ОповеститьОСменеЭтапаОбмена( Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОСменеЭтапаОбмена(); +``` +
+ +## ОповеститьОСменеЭтапаРасшифровки +
+ +Описание, пример вызова + +```bsl + +// Оповещение формы бублика о начале нового этапа обмена. +// Используется для наращивания процента. +// +Процедура ОповеститьОСменеЭтапаРасшифровки(Параметры) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОСменеЭтапаРасшифровки(Параметры) +``` +
+ +## ОповеститьОЗавершенииОбмена +
+ +Описание, пример вызова + +```bsl + +Процедура ОповеститьОЗавершенииОбмена() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОЗавершенииОбмена() +``` +
+ +## ОповеститьОЗавершенииРасшифровки +
+ +Описание, пример вызова + +```bsl + +Процедура ОповеститьОЗавершенииРасшифровки(Параметры) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОЗавершенииРасшифровки(Параметры) +``` +
+ +## ПараметрыДлительногоОбмена +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыДлительногоОбмена() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ПараметрыДлительногоОбмена() +``` +
+ +## ОповеститьОНевозможностиОбновитьСтатусОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ОповеститьОНевозможностиОбновитьСтатусОтчета() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОНевозможностиОбновитьСтатусОтчета() +``` +
+ +## ОткрытьФормуОжиданияЗагрузкиМодуля +
+ +Описание, пример вызова + +```bsl + +Функция ОткрытьФормуОжиданияЗагрузкиМодуля(ДополнительныеПараметры, КонтекстЭДО = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ОткрытьФормуОжиданияЗагрузкиМодуля(ДополнительныеПараметры, КонтекстЭДО); +``` +
+ +## ЗакрытьФормуОжиданияЗагрузкиМодуля +
+ +Описание, пример вызова + +```bsl + +// Процедура - Закрыть форму ожидания загрузки модуля +// +// Параметры: +// ОставитьОткрытой - Булево - Если обновление выполняется из мастера, то ОставитьОткрытой = Ложь. +// И только в момент открытия мастера ОставитьОткрытой = Истина. Т.е. закрытие бублика выполняется из мастера. +// УдалосьОбновитьМодуль - Булево, Неопределено. Неопределено - если форму бублика нужно закрыть молча без +// отображения результата обновления. +// +Процедура ЗакрытьФормуОжиданияЗагрузкиМодуля(ОставитьОткрытой = Ложь, УдалосьОбновитьМодуль = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ЗакрытьФормуОжиданияЗагрузкиМодуля(ОставитьОткрытой, УдалосьОбновитьМодуль); +``` +
+ +## ОбновитьНадписьИЗаголовок +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьНадписьИЗаголовок( Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОбновитьНадписьИЗаголовок(); +``` +
+ +## СообщитьОНачалеОбновленияМодуля +
+ +Описание, пример вызова + +```bsl + +Процедура СообщитьОНачалеОбновленияМодуля(ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.СообщитьОНачалеОбновленияМодуля(ВходящийКонтекст)); +``` +
+ +## ПоказатьФормуДлительнойОтправкиЗаявления +
+ +Описание, пример вызова + +```bsl + +Функция ПоказатьФормуДлительнойОтправкиЗаявления(ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ПоказатьФормуДлительнойОтправкиЗаявления(ДополнительныеПараметры) +``` +
+ +## ПараметрыДлительнойОтправкиЗаявления +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыДлительнойОтправкиЗаявления() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ПараметрыДлительнойОтправкиЗаявления() +``` +
+ +## ОповеститьОбУдачнойОтправкеЗаявления +
+ +Описание, пример вызова + +```bsl + +Процедура ОповеститьОбУдачнойОтправкеЗаявления(Организация, Заявление = Неопределено, ТекстПояснения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОбУдачнойОтправкеЗаявления(Организация, Заявление, ТекстПояснения); +``` +
+ +## ОповеститьОНеудачнойОтправкеЗаявления +
+ +Описание, пример вызова + +```bsl + +Процедура ОповеститьОНеудачнойОтправкеЗаявления() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОповеститьОНеудачнойОтправкеЗаявления() +``` +
+ +## ПоказатьУниверсальнуюФормуДлительногоДействия +
+ +Описание, пример вызова + +```bsl + +Функция ПоказатьУниверсальнуюФормуДлительногоДействия(ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ПоказатьУниверсальнуюФормуДлительногоДействия(ДополнительныеПараметры) +``` +
+ +## ПараметрыЗапускаУниверсальногоДлительногоДействия +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыЗапускаУниверсальногоДлительногоДействия() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ПараметрыЗапускаУниверсальногоДлительногоДействия() +``` +
+ +## ПараметрыСостоянияУниверсальногоДлительногоДействия +
+ +Описание, пример вызова + +```bsl + +// Для метода ВывестиСостояниеВФормуДлительногоДействия +Функция ПараметрыСостоянияУниверсальногоДлительногоДействия() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ПараметрыСостоянияУниверсальногоДлительногоДействия() +``` +
+ +## ВывестиСостояниеВФормуДлительногоДействия +
+ +Описание, пример вызова + +```bsl + +Процедура ВывестиСостояниеВФормуДлительногоДействия(ПараметрыФормы) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ВывестиСостояниеВФормуДлительногоДействия(ПараметрыФормы) +``` +
+ +## ВывестиСостояние +
+ +Описание, пример вызова + +```bsl + + +// Отправляет в форму длительной операции оповещение о том, +// какое действие сейчас выполняется после нажатия на кнопку Отправить. +// Если форма закрыта, то текст выводится в всплывающее окно состояния. +// +// Эта процедура так же вызывается из модуля РегламентированнаяОтчетностьКлиент! +// +Процедура ВывестиСостояние(ТекстСообщения, Картинка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ВывестиСостояние(ТекстСообщения, Картинка); +``` +
+ +## ЗапомнитьКонтекстДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +Процедура ЗапомнитьКонтекстДлительнойОперации( Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ЗапомнитьКонтекстДлительнойОперации(); +``` +
+ +## КонтекстДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +Функция КонтекстДлительнойОперации(ИмяПараметраПриложения = "БРО.ПараметрыОбновленияОтправкиИзПанелиОтправки") Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.КонтекстДлительнойОперации(ИмяПараметраПриложения); +``` +
+ +## ОшибкиКлиент +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкиКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ОшибкиКлиент() +``` +
+ +## ОшибкиКлиентСервер +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкиКлиентСервер() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ОшибкиКлиентСервер() +``` +
+ +## ИзменитьПараметрыДлительнойОтправкиКлиентСервер +
+ +Описание, пример вызова + +```bsl + +Процедура ИзменитьПараметрыДлительнойОтправкиКлиентСервер(КлючПараметра, НовоеЗначение) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ИзменитьПараметрыДлительнойОтправкиКлиентСервер(КлючПараметра, НовоеЗначение) +``` +
+ +## ОчиститьПараметрыДлительнойОтправкиКлиентСервер +
+ +Описание, пример вызова + +```bsl + +Процедура ОчиститьПараметрыДлительнойОтправкиКлиентСервер() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ОчиститьПараметрыДлительнойОтправкиКлиентСервер() +``` +
+ +## ЭтоФормаОтправкиОтчетности +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоФормаОтправкиОтчетности(КраткоеИмяФормы, ИмяФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ЭтоФормаОтправкиОтчетности(КраткоеИмяФормы, ИмяФормы) +``` +
+ +## ЗапретитьВыводСостояния +
+ +Описание, пример вызова + +```bsl + +Процедура ЗапретитьВыводСостояния() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.ЗапретитьВыводСостояния() +``` +
+ +## СброситьЗапретВыводаСостояния +
+ +Описание, пример вызова + +```bsl + +Процедура СброситьЗапретВыводаСостояния() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиент.СброситьЗапретВыводаСостояния() +``` +
+ +## ВыводСостоянияЗапрещен +
+ +Описание, пример вызова + +```bsl + +Функция ВыводСостоянияЗапрещен() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиент.ВыводСостоянияЗапрещен() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДлительнаяОтправкаКлиентГлобальный.md b/src/content/docs/zup/ДлительнаяОтправкаКлиентГлобальный.md new file mode 100644 index 0000000..ef4f469 --- /dev/null +++ b/src/content/docs/zup/ДлительнаяОтправкаКлиентГлобальный.md @@ -0,0 +1,93 @@ +--- +title: Длительная отправка клиент глобальный +slug: zup/длительная-отправка-клиент-глобальный +--- + + +## Подключаемый_ОсуществитьОбменПоОрганизацииИзПанелиОтправки +
+ +Описание, пример вызова + +```bsl + +Процедура Подключаемый_ОсуществитьОбменПоОрганизацииИзПанелиОтправки() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиентГлобальный.Подключаемый_ОсуществитьОбменПоОрганизацииИзПанелиОтправки() +``` +
+ +## Подключаемый_ОтложенноПоказатьРезультатОбновления +
+ +Описание, пример вызова + +```bsl + +Процедура Подключаемый_ОтложенноПоказатьРезультатОбновления() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиентГлобальный.Подключаемый_ОтложенноПоказатьРезультатОбновления() +``` +
+ +## Подключаемый_ОсуществитьОбменПоОрганизациям +
+ +Описание, пример вызова + +```bsl + +Процедура Подключаемый_ОсуществитьОбменПоОрганизациям() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиентГлобальный.Подключаемый_ОсуществитьОбменПоОрганизациям() +``` +
+ +## Подключаемый_ЗарегистрироватьМЧДРРВыгрузка +
+ +Описание, пример вызова + +```bsl + +Процедура Подключаемый_ЗарегистрироватьМЧДРРВыгрузка() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиентГлобальный.Подключаемый_ЗарегистрироватьМЧДРРВыгрузка() +``` +
+ +## Подключаемый_ОтменитьМЧДРРВыгрузка +
+ +Описание, пример вызова + +```bsl + +Процедура Подключаемый_ОтменитьМЧДРРВыгрузка() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиентГлобальный.Подключаемый_ОтменитьМЧДРРВыгрузка() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДлительнаяОтправкаКлиентСервер.md b/src/content/docs/zup/ДлительнаяОтправкаКлиентСервер.md new file mode 100644 index 0000000..8757c21 --- /dev/null +++ b/src/content/docs/zup/ДлительнаяОтправкаКлиентСервер.md @@ -0,0 +1,761 @@ +--- +title: Длительная отправка клиент сервер +slug: zup/длительная-отправка-клиент-сервер +--- + + +## ЭтоФормаГрупповойОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоФормаГрупповойОтправки(Значение = Неопределено, УчитыватьВыполнениеОтправкиИлиПроверки = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ЭтоФормаГрупповойОтправки(Значение, УчитыватьВыполнениеОтправкиИлиПроверки); +``` +
+ +## ЭтоФормаГрупповойОтправкиПоФорме +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоФормаГрупповойОтправкиПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ЭтоФормаГрупповойОтправкиПоФорме(Форма) +``` +
+ +## ФормаГрупповойОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ФормаГрупповойОтправки(Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ФормаГрупповойОтправки(Значение) +``` +
+ +## ПолучитьФормуГрупповойОтправкиРекурсивно +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьФормуГрупповойОтправкиРекурсивно(Значение, Результат) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиентСервер.ПолучитьФормуГрупповойОтправкиРекурсивно(Значение, Результат) +``` +
+ +## ИмяФормыПоПолномуИмени +
+ +Описание, пример вызова + +```bsl + +Функция ИмяФормыПоПолномуИмени(ПолноеИмяФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ИмяФормыПоПолномуИмени(ПолноеИмяФормы) +``` +
+ +## РазностьВремениВЧасахИМинутах +
+ +Описание, пример вызова + +```bsl + +Функция РазностьВремениВЧасахИМинутах(ВремяЗавершения, ВремяНачала) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.РазностьВремениВЧасахИМинутах(ВремяЗавершения, ВремяНачала) +``` +
+ +## СообщениеПриПопыткеИзмененияСтатуса +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеПриПопыткеИзмененияСтатуса() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеПриПопыткеИзмененияСтатуса() +``` +
+ +## СообщениеНетУчетнойЗаписи +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеНетУчетнойЗаписи() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеНетУчетнойЗаписи() +``` +
+ +## СообщениеНаправлениеНеПодключено +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеНаправлениеНеПодключено() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеНаправлениеНеПодключено() +``` +
+ +## Сообщение1СОтчетностьНеПодключено +
+ +Описание, пример вызова + +```bsl + +Функция Сообщение1СОтчетностьНеПодключено() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.Сообщение1СОтчетностьНеПодключено() +``` +
+ +## СообщениеНетИнтернета +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеНетИнтернета() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеНетИнтернета() +``` +
+ +## Сообщение1СОтчетностьНеПодключеноНоЕстьЗаявление +
+ +Описание, пример вызова + +```bsl + +Функция Сообщение1СОтчетностьНеПодключеноНоЕстьЗаявление() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.Сообщение1СОтчетностьНеПодключеноНоЕстьЗаявление() +``` +
+ +## Сообщение1СОтчетностьНеПодключеноНоЕстьНенастроенноеЗаявление +
+ +Описание, пример вызова + +```bsl + +Функция Сообщение1СОтчетностьНеПодключеноНоЕстьНенастроенноеЗаявление() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.Сообщение1СОтчетностьНеПодключеноНоЕстьНенастроенноеЗаявление() +``` +
+ +## Сообщение1СОтчетностьНеПодключеноЗаявлениеОтклонено +
+ +Описание, пример вызова + +```bsl + +Функция Сообщение1СОтчетностьНеПодключеноЗаявлениеОтклонено() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.Сообщение1СОтчетностьНеПодключеноЗаявлениеОтклонено() +``` +
+ +## СообщениеИстеклаЛицензия +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеИстеклаЛицензия() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеИстеклаЛицензия() +``` +
+ +## СообщениеИстекСертификатИЛицензия +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеИстекСертификатИЛицензия() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеИстекСертификатИЛицензия() +``` +
+ +## СообщениеИстекСертификат +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеИстекСертификат() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеИстекСертификат() +``` +
+ +## СообщениеНеПодключенаКЭДОПФР +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеНеПодключенаКЭДОПФР() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеНеПодключенаКЭДОПФР() +``` +
+ +## ОповещениеНеуспешнаяПроверкаВИнтернете +
+ +Описание, пример вызова + +```bsl + +Функция ОповещениеНеуспешнаяПроверкаВИнтернете() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ОповещениеНеуспешнаяПроверкаВИнтернете() +``` +
+ +## ОповещениеУспешнаяПроверкаВИнтернете +
+ +Описание, пример вызова + +```bsl + +Функция ОповещениеУспешнаяПроверкаВИнтернете() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ОповещениеУспешнаяПроверкаВИнтернете() +``` +
+ +## СообщениеОшибокНеОбнаружено +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеОшибокНеОбнаружено() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеОшибокНеОбнаружено() +``` +
+ +## СообщениеОбнаруженыОшибки +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеОбнаруженыОшибки() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеОбнаруженыОшибки() +``` +
+ +## СообщениеИстекСрокДействияКлюча +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеИстекСрокДействияКлюча() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СообщениеИстекСрокДействияКлюча() +``` +
+ +## ФормаДлительнойОтправкиОткрыта +
+ +Описание, пример вызова + +```bsl + +Функция ФормаДлительнойОтправкиОткрыта() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ФормаДлительнойОтправкиОткрыта() +``` +
+ +## ВывестиОшибку +
+ +Описание, пример вызова + +```bsl + +// Вывод ошибок. Если открыта форма длительной операции - все ошибки будут в ней накапливаться и затем показаны в отдельном окне ошибок. +// Если форма не открыта, но указан идентификатор формы-получателя сообщений, то сообщения выводятся в эту форму. +// В противном случае текст выводится обычным способом в нижнюю часть активной формы. +// +// Параметры: +// ТекстСообщения - Строка - Текст выводимого сообщения. +// +Процедура ВывестиОшибку( Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиентСервер.ВывестиОшибку(); +``` +
+ +## ВывестиПредупреждение +
+ +Описание, пример вызова + +```bsl + +Процедура ВывестиПредупреждение( Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиентСервер.ВывестиПредупреждение(); +``` +
+ +## СерверныйКлюч +
+ +Описание, пример вызова + +```bsl + +Функция СерверныйКлюч() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.СерверныйКлюч() +``` +
+ +## КлиентскийКлюч +
+ +Описание, пример вызова + +```bsl + +Функция КлиентскийКлюч() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.КлиентскийКлюч() +``` +
+ +## ОчиститьПараметрыДлительнойОтправки +
+ +Описание, пример вызова + +```bsl + +Процедура ОчиститьПараметрыДлительнойОтправки() Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиентСервер.ОчиститьПараметрыДлительнойОтправки() +``` +
+ +## ИзменитьПараметрыДлительнойОтправки +
+ +Описание, пример вызова + +```bsl + +// Запоминаем параметры бублика в ПараметрыПриложения +// чтобы потом их можно было использовать не только из ЭДО, +// но и из модулей рег. отчетности. +// Список ключей - в процедуре ЗначенияПараметровПоУмолчанию. +Процедура ИзменитьПараметрыДлительнойОтправки(КлючПараметра, НовоеЗначение) Экспорт +``` + +Пример вызова +```bsl +ДлительнаяОтправкаКлиентСервер.ИзменитьПараметрыДлительнойОтправки(КлючПараметра, НовоеЗначение) +``` +
+ +## ЗначенияПараметровПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +Функция ЗначенияПараметровПоУмолчанию() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ЗначенияПараметровПоУмолчанию() +``` +
+ +## ЗначенияПараметровДлительнойОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ЗначенияПараметровДлительнойОтправки() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ЗначенияПараметровДлительнойОтправки() +``` +
+ +## ЗначениеПараметраДлительнойОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ЗначениеПараметраДлительнойОтправки(КлючПараметра) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ЗначениеПараметраДлительнойОтправки(КлючПараметра) +``` +
+ +## ДобавитьОшибку +
+ +Описание, пример вызова + +```bsl + +Функция ДобавитьОшибку(Знач Ошибки, Знач НоваяОшибка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ДобавитьОшибку(Ошибки, НоваяОшибка) +``` +
+ +## ТакаяОшибкаУжеЕсть +
+ +Описание, пример вызова + +```bsl + +// Не только проверяет наличие ошибки. При нахождении повторной ошибки дополняет новым контекстом +Функция ТакаяОшибкаУжеЕсть(Ошибки, Знач НоваяОшибка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ТакаяОшибкаУжеЕсть(Ошибки, НоваяОшибка) +``` +
+ +## НоваяОшибка +
+ +Описание, пример вызова + +```bsl + +Функция НоваяОшибка(Знач ОписаниеОшибки, Знач ОбъектОснование = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.НоваяОшибка(ОписаниеОшибки, ОбъектОснование); +``` +
+ +## ВидОбъекта +
+ +Описание, пример вызова + +```bsl + +Функция ВидОбъекта(СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ВидОбъекта(СсылкаНаОбъект) +``` +
+ +## НазваниеОбъектаВИменительномПадеже +
+ +Описание, пример вызова + +```bsl + +Функция НазваниеОбъектаВИменительномПадеже(СсылкаНаОбъект, ПерваяБукваЗаглавная = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.НазваниеОбъектаВИменительномПадеже(СсылкаНаОбъект, ПерваяБукваЗаглавная); +``` +
+ +## НазваниеОбъектаВРодительномПадеже +
+ +Описание, пример вызова + +```bsl + +Функция НазваниеОбъектаВРодительномПадеже(СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.НазваниеОбъектаВРодительномПадеже(СсылкаНаОбъект) +``` +
+ +## КоличествоОшибокОтменыДействия +
+ +Описание, пример вызова + +```bsl + +Функция КоличествоОшибокОтменыДействия(Ошибки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.КоличествоОшибокОтменыДействия(Ошибки) +``` +
+ +## НовыеПараметрыСохранения +
+ +Описание, пример вызова + +```bsl + +Функция НовыеПараметрыСохранения(ЭтоАвтозапрос) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.НовыеПараметрыСохранения(ЭтоАвтозапрос) +``` +
+ +## ДобавитьСтроку +
+ +Описание, пример вызова + +```bsl + +Функция ДобавитьСтроку(ПредыдущиеЗначения, НовоеСообщение, Разделитель = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ДобавитьСтроку(ПредыдущиеЗначения, НовоеСообщение, Разделитель); +``` +
+ +## ЧислоИПредметИсчисления +
+ +Описание, пример вызова + +```bsl + +Функция ЧислоИПредметИсчисления( Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ЧислоИПредметИсчисления(); +``` +
+ +## ПредметИсчисленияБезЧисла +
+ +Описание, пример вызова + +```bsl + +Функция ПредметИсчисленияБезЧисла( Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ПредметИсчисленияБезЧисла(); +``` +
+ +## ЗаменитьПоследнююЗапятуюНаИ +
+ +Описание, пример вызова + +```bsl + +Функция ЗаменитьПоследнююЗапятуюНаИ(ИсходнаяСтрока, Разделитель = ", ") Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.ЗаменитьПоследнююЗапятуюНаИ(ИсходнаяСтрока, Разделитель, ") +``` +
+ +## РазделительСтрок +
+ +Описание, пример вызова + +```bsl + +Функция РазделительСтрок() Экспорт +``` + +Пример вызова +```bsl +Результат = ДлительнаяОтправкаКлиентСервер.РазделительСтрок() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДоговорыГПХРасширенный.md b/src/content/docs/zup/ДоговорыГПХРасширенный.md new file mode 100644 index 0000000..539c2fe --- /dev/null +++ b/src/content/docs/zup/ДоговорыГПХРасширенный.md @@ -0,0 +1,137 @@ +--- +title: Договоры гпх расширенный +slug: zup/договоры-гпх-расширенный +--- + + +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазыБСП.ПриДобавленииОбработчиковОбновления. +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ДоговорыГПХРасширенный.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ПриДобавленииОбработчиковПереходаСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазыБСП.ПриДобавленииОбработчиковПереходаСДругойПрограммы. +Процедура ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ДоговорыГПХРасширенный.ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) +``` +
+ +## ПриОпределенииОбъектовСКомандамиПечати +
+ +Описание, пример вызова + +```bsl + +// Определяет объекты, в которых есть процедура ДобавитьКомандыПечати(). +// Подробнее см. УправлениеПечатьюПереопределяемый. +// +// Параметры: +// СписокОбъектов - Массив - список менеджеров объектов. +// +Процедура ПриОпределенииОбъектовСКомандамиПечати(СписокОбъектов) Экспорт +``` + +Пример вызова +```bsl +ДоговорыГПХРасширенный.ПриОпределенииОбъектовСКомандамиПечати(СписокОбъектов) +``` +
+ +## ПриПолученииПредопределенныхНаборовСвойств +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеСвойствамиПереопределяемый.ПриПолученииПредопределенныхНаборовСвойств. +Процедура ПриПолученииПредопределенныхНаборовСвойств(Наборы) Экспорт +``` + +Пример вызова +```bsl +ДоговорыГПХРасширенный.ПриПолученииПредопределенныхНаборовСвойств(Наборы) +``` +
+ +## ПриЗаполненииСписковСОграничениемДоступа +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступомПереопределяемый.ПриЗаполненииСписковСОграничениемДоступа. +Процедура ПриЗаполненииСписковСОграничениемДоступа(Списки) Экспорт +``` + +Пример вызова +```bsl +ДоговорыГПХРасширенный.ПриЗаполненииСписковСОграничениемДоступа(Списки) +``` +
+ +## ПриЗаполненииВидовОграниченийПравОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступомПереопределяемый.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных. +Процедура ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) Экспорт +``` + +Пример вызова +```bsl +ДоговорыГПХРасширенный.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) +``` +
+ +## ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения +
+ +Описание, пример вызова + +```bsl + +// См. ДатыЗапретаИзмененияПереопределяемый.ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения. +Процедура ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения(ИсточникиДанных) Экспорт +``` + +Пример вызова +```bsl +ДоговорыГПХРасширенный.ЗаполнитьИсточникиДанныхДляПроверкиЗапретаИзменения(ИсточникиДанных) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотРегистрацияВФНС.md b/src/content/docs/zup/ДокументооборотРегистрацияВФНС.md new file mode 100644 index 0000000..7ebb12e --- /dev/null +++ b/src/content/docs/zup/ДокументооборотРегистрацияВФНС.md @@ -0,0 +1,984 @@ +--- +title: Документооборот регистрация вфн с +slug: zup/документооборот-регистрация-вфн-с +--- + + +## СервисРегистрацииФНСПодключение +
+ +Описание, пример вызова + +```bsl + +// Инициализирует подключение к сервису регистрации +// Общая схема работы с сервисом: +// - получение временного токена см. СервисРегистрацииФНСПодключение +// - подписание данных токена с помощью СЭП +// - получение токена авторизации см. СервисРегистрацииФНСАвторизация +// - выполнение запросов к сервису регистрации с помощью токена полученного на предыдущем шаге +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * СрокДействия - Дата - дата и время окончания действия полученного токена +// * Токен - Строка - токен авторизации в формате Base64 +// +Функция СервисРегистрацииФНСПодключение() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСПодключение() +``` +
+ +## СервисРегистрацииФНСАвторизация +
+ +Описание, пример вызова + +```bsl + +// Получает токен авторизации, требующийся для выполнения всех последующих операций +// +// Параметры: +// Токен - Строка - строка с содержимым токена авторизации +// Подпись - ДвоичныеДанные, Строка - сформированная ЭП в формате PKSC#7 +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * СрокДействия - Дата - дата и время окончания действия полученного токена +// * Токен - Строка - токен авторизации в формате Base64 +// +Функция СервисРегистрацииФНСАвторизация(Токен, Подпись) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСАвторизация(Токен, Подпись) +``` +
+ +## СервисРегистрацииФНССписокЗаявок +
+ +Описание, пример вызова + +```bsl + +// Получает список ранее принятых заявлений в сервисе регистрации +// +// Параметры: +// Токен - Строка - строка с содержимым токена авторизации в формате Base64 +// ИмяФайла - Строка - имя файла контейнера для фильтрации запроса +// Период - Строка - период для фильтрации запроса +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Заявления - Массив из Структур - каждая строка содержит поля +// ** ИдентификаторЗаявления - Строка - идентификатор принятого заявления +// ** ИмяФайла - Строка - имя файла транспортного контейнера +// ** ДатаПолучения - Дата - дата получения заявления +// ** КодСостояния - Строка - код состояния ответа +// ** Описание - Строка - описание состояния ответа +// +Функция СервисРегистрацииФНССписокЗаявок(Токен, ИмяФайла = Неопределено, Период = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНССписокЗаявок(Токен, ИмяФайла, Период); +``` +
+ +## СервисРегистрацииФНСОтправитьЗаявку +
+ +Описание, пример вызова + +```bsl + +// Получает содержимое файла транспортного контейнера отправленного заявления в сервис регистрации +// Требуется уточнение описания метода, т.к. наблюдаются противоречия в документации +// +// Параметры: +// Токен - Строка - строка с содержимым токена авторизации в формате Base64 +// ИмяФайла - Строка - имя файла транспортного контейнера +// ДанныеФайла - ДвоичныеДанные - содержимое транспортного контейнера (ZIP) +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Идентификатор - Строка - идентификатор, присвоенный заявлению сервисом регистрации в случае успешной проверки +// * ДатаОтправки - Дата - дата и время успешной отправки +// +Функция СервисРегистрацииФНСОтправитьЗаявку(Токен, ИмяФайла, ДанныеФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСОтправитьЗаявку(Токен, ИмяФайла, ДанныеФайла) +``` +
+ +## СервисРегистрацииФНСПолучитьЗаявку +
+ +Описание, пример вызова + +```bsl + +// Получает содержимое файла транспортного контейнера отправленного заявления в сервис регистрации +// +// Параметры: +// Токен - Строка - строка с содержимым токена авторизации в формате Base64 +// ИдентификаторЗаявления - Строка - идентификатор, присвоенный сервисом после получения заявления +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Файл - ДвоичныеДанные - содержимое транспортного контейнера (ZIP) +// +Функция СервисРегистрацииФНСПолучитьЗаявку(Токен, ИдентификаторЗаявления) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСПолучитьЗаявку(Токен, ИдентификаторЗаявления) +``` +
+ +## СервисРегистрацииФНСИнформацияОЗаявке +
+ +Описание, пример вызова + +```bsl + +// Получает состояние принятого сервисом регистрации заявления +// +// Параметры: +// Токен - Строка - строка с содержимым токена авторизации в формате Base64 +// ИдентификаторЗаявления - Строка - идентификатор, присвоенный сервисом после получения заявления +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * ИмяФайла - Строка - имя файла транспортного контейнера отправленного заявления +// * ДатаПолучения - Дата - дата приема заявления сервисом регистрации +// * ДатаПолученияНО - Дата - дата приема заявления в налоговом органе +// * КодНО - Строка - код налогового органа, принявшее заявление в обработку +// * НаименованиеНО - Строка - наименование налогового органа, принявшее заявление в обработку +// * КодСостояния - Строка - код состояния ответа +// * Описание - Строка - описание состояния ответа +// * СообщениеПроверки - Строка - сообщение проверки +// * НаименованиеОрганизации - Строка - наименование регистрируемой организации +// * Идентификатор - Строка +// * ИдентификаторЗаявления - Строка - наименование регистрируемой организации +// * СписокОтветов - Массив - содержит структуры см. ПодготовитьРеестрОтветовНаЗаявления +// +Функция СервисРегистрацииФНСИнформацияОЗаявке(Токен, ИдентификаторЗаявления) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСИнформацияОЗаявке(Токен, ИдентификаторЗаявления) +``` +
+ +## СервисРегистрацииФНССписокОтветов +
+ +Описание, пример вызова + +```bsl + +// Получает список сформированных ответов сервисом регистрации на ранее отправленное заявление +// +// Параметры: +// Токен - Строка - строка с содержимым токена авторизации в формате Base64 +// ИдентификаторЗаявления - Строка - идентификатор, присвоенный сервисом после получения заявления +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Ответы - Массив - каждая строка содержит структуру см. ПодготовитьРеестрОтветовНаЗаявления +// +Функция СервисРегистрацииФНССписокОтветов(Токен, ИдентификаторЗаявления) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНССписокОтветов(Токен, ИдентификаторЗаявления) +``` +
+ +## СервисРегистрацииФНСФайлОтвета +
+ +Описание, пример вызова + +```bsl + +// Получает файл транспортного контейнера (ZIP) c ответом сервиса регистрации на ранее отправленное заявление +// +// Параметры: +// Токен - Строка - строка с содержимым токена авторизации в формате Base64 +// ИдентификаторЗаявления - Строка - идентификатор, присвоенный сервисом после получения заявления +// ИдентификаторОтвета - Строка - идентификатор ответа, полученный с помощью функции СервисРегистрацииФНССписокОтветов +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Файл - ДвоичныеДанные - содержимое файла +// +Функция СервисРегистрацииФНСФайлОтвета(Токен, ИдентификаторЗаявления, ИдентификаторОтвета) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСФайлОтвета(Токен, ИдентификаторЗаявления, ИдентификаторОтвета) +``` +
+ +## СервисРегистрацииФНСПлатежныйДокумент +
+ +Описание, пример вызова + +```bsl + +// Получает файл в PDF формате содержащий платежный документ +// +// Параметры: +// Токен - Строка - строка с содержимым токена авторизации в формате Base64 +// ПлатежныйДокумент - Структура - содержит поля +// * КодНО - Строка - код налогового органа +// * ОКАТО - Строка - код ОКАТО +// * КБК - Строка - код КБК +// * Сумма - Число - сумма для оплаты +// * ИННПлательщика - Строка - ИНН физического лица плательщика +// * Фамилия - Строка - фамилия физического лица плательщика +// * Имя - Строка - имя физического лица плательщик +// * Отчество - Строка - отчество физического лица плательщика +// * АдресПлательщика - Строка - адрес физического лица плательщика +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Файл - ДвоичныеДанные - содержимое файла +// +Функция СервисРегистрацииФНСПлатежныйДокумент(Токен, ПлатежныйДокумент) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСПлатежныйДокумент(Токен, ПлатежныйДокумент) +``` +
+ +## СервисРегистрацииФНСОтправитьЗаявку_20 +
+ +Описание, пример вызова + +```bsl + +// Получает содержимое файла транспортного контейнера отправленного заявления в сервис регистрации +// Требуется уточнение описания метода, т.к. наблюдаются противоречия в документации +// +// Параметры: +// ИмяФайла - Строка - имя файла транспортного контейнера +// ДанныеФайла - ДвоичныеДанные - содержимое транспортного контейнера (ZIP) +// СвойстваЗаявления - Структура - см. СвойстваЗаявленияРегистрацииЮЛ() +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Идентификатор - Строка - идентификатор, присвоенный заявлению сервисом регистрации в случае успешной проверки +// * ДатаОтправки - Дата - дата и время успешной отправки +// +Функция СервисРегистрацииФНСОтправитьЗаявку_20(ИмяФайла, ДанныеФайла, СвойстваЗаявления) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСОтправитьЗаявку_20(ИмяФайла, ДанныеФайла, СвойстваЗаявления) +``` +
+ +## СервисРегистрацииФНСИнформацияОЗаявке_20 +
+ +Описание, пример вызова + +```bsl + +// Получает состояние принятого сервисом регистрации заявления +// +// Параметры: +// ИдентификаторЗаявления - Строка - идентификатор, присвоенный сервисом после получения заявления +// ИдентификаторПредмета - Строка - уникальный идентификатор предмета отправки +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * ИмяФайла - Строка - имя файла транспортного контейнера отправленного заявления +// * ДатаПолучения - Дата - дата приема заявления сервисом регистрации +// * ДатаПолученияНО - Дата - дата приема заявления в налоговом органе +// * КодНО - Строка - код налогового органа, принявшее заявление в обработку +// * НаименованиеНО - Строка - наименование налогового органа, принявшее заявление в обработку +// * КодСостояния - Строка - код состояния ответа +// * Описание - Строка - описание состояния ответа +// * СообщениеПроверки - Строка - сообщение проверки +// * НаименованиеОрганизации - Строка - наименование регистрируемой организации +// * Идентификатор - Строка +// * ИдентификаторЗаявления - Строка +// * СписокОтветов - Массив - содержит структуры см. ПодготовитьРеестрОтветовНаЗаявления +// +Функция СервисРегистрацииФНСИнформацияОЗаявке_20(ИдентификаторЗаявления, ИдентификаторПредмета) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСИнформацияОЗаявке_20(ИдентификаторЗаявления, ИдентификаторПредмета) +``` +
+ +## СервисРегистрацииФНСФайлОтвета_20 +
+ +Описание, пример вызова + +```bsl + +// Получает файл транспортного контейнера (ZIP) c ответом сервиса регистрации на ранее отправленное заявление +// +// Параметры: +// ИдентификаторЗаявления - Строка - идентификатор, присвоенный сервисом после получения заявления +// ИдентификаторОтвета - Строка - идентификатор ответа, полученный с помощью функции СервисРегистрацииФНССписокОтветов +// ИдентификаторПредмета - Строка - уникальный идентификатор предмета отправки +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Файл - ДвоичныеДанные - содержимое файла +// +Функция СервисРегистрацииФНСФайлОтвета_20(ИдентификаторЗаявления, ИдентификаторОтвета, ИдентификаторПредмета) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСФайлОтвета_20(ИдентификаторЗаявления, ИдентификаторОтвета, ИдентификаторПредмета) +``` +
+ +## СервисРегистрацииФНСПолучитьКодПодтверждения +
+ +Описание, пример вызова + +```bsl + +// Отправляет код подтверждения на указанный предмет проверки - телефон или электронную почту +// +// Параметры: +// ПараметрыОперации - Структура - см. ПараметрыОтправкиКодаПодтверждения +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Идентификатор - Строка - идентификатор высланного кода, если задействован режим идентификатора, иначе поле "Код" +// * Код - Строка - высланный код +// * СрокДействия - Дата - срок окончания действия кода +// * НомерОтправки - Число - порядковый номер отправки +// * Попыток - Число - остаток попыток для указанного идентификатора +// +Функция СервисРегистрацииФНСПолучитьКодПодтверждения(ПараметрыОперации) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСПолучитьКодПодтверждения(ПараметрыОперации) +``` +
+ +## СервисРегистрацииФНСПроверитьКодПодтверждения +
+ +Описание, пример вызова + +```bsl + +// Проверяет введенный код пользователем с ожидаемым по идентификатору отправки +// +// Параметры: +// Идентификатор - Строка - идентификатор отправки +// КодПроверки - Строка - проверяемый код +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Успешно - Булево - статус проверки +// * СрокДействия - Дата - срок окончания действия кода +// * Попыток - Число - остаток попыток для указанного идентификатора +// +Функция СервисРегистрацииФНСПроверитьКодПодтверждения(Идентификатор, КодПроверки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСПроверитьКодПодтверждения(Идентификатор, КодПроверки) +``` +
+ +## СервисРегистрацииФНСРаботоспособность +
+ +Описание, пример вызова + +```bsl + +// Проверяет доступность промежуточного сервиса приема заявлений для регистрации ЮЛ +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// +Функция СервисРегистрацииФНСРаботоспособность() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СервисРегистрацииФНСРаботоспособность() +``` +
+ +## ПараметрыОтправкиКодаПодтверждения +
+ +Описание, пример вызова + +```bsl + +// Формирует список параметров, необходимых для отправки кодов подтверждения +// +// Возвращаемое значение: +// Структура: +// * Тип - Строка - "Телефон" или "Почта" +// * ПредметОтправки - Строка - номер телефона или адрес электронной почты +// * ПовторнаяОтправка - Булево +// * Идентификатор - Строка - для режима повторной отправки +// * ШаблонСообщения - Строка +// * НужнаПроверка - Булево +// +Функция ПараметрыОтправкиКодаПодтверждения() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ПараметрыОтправкиКодаПодтверждения() +``` +
+ +## СоздатьОтправкуРегистрацииЮЛ +
+ +Описание, пример вызова + +```bsl + +// Отправка пакета на сервер ФНС, регистрация факта отправки +// +// Параметры: +// ПараметрыОтправки - Структура - содержит поля для отправки заявления: +// * Токен - Строка +// * ИмяФайлаТранспортногоКонтейнера - Строка - имя файла для отправляемого контейнера +// * ДанныеФайла - ДвоичныеДанные - содержимое транспортного контейнера +// * ПредметОтправки - ДокументСсылка.УведомлениеОСпецрежимахНалогообложения +// * ОтпечатокСертификата - Строка - отпечаток сертификата с помощью которого создавалась отправка +// * КодНО - Строка - необязательный, содержит код налогового органа +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево +// * Ошибка - Строка +// * Отправка - СправочникСсылка.ОтправкиРегистрацияЮЛ - присутствует, если Выполнено = Истина +// * ИдентификаторЗаявления- Строка +// +Функция СоздатьОтправкуРегистрацииЮЛ(ПараметрыОтправки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СоздатьОтправкуРегистрацииЮЛ(ПараметрыОтправки) +``` +
+ +## ОбновитьСтатусОтправкиРегистрацииЮЛ +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие ответов по заявке, обрабатывает их и меняет статус в ИБ +// +// Параметры: +// ПараметрыОтправки - Структура - содержит поля: +// * Токен - Строка - строка с содержимым токена авторизации в формате Base64 +// * ОтправкаСсылка - СправочникСсылка - ссылка на объект отправки +// * Принудительно - Булево - обновляет все этапы +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * Файлы - Массив - +// +Функция ОбновитьСтатусОтправкиРегистрацииЮЛ(ПараметрыОтправки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ОбновитьСтатусОтправкиРегистрацииЮЛ(ПараметрыОтправки) +``` +
+ +## ОбновитьОтправкуРегистрацииЮЛ +
+ +Описание, пример вызова + +```bsl + +// Обновляет данные справочника ОтправкиРегистрацияЮЛ, и статусы отправки при необходимости +// +// Параметры: +// ОтправкаСсылка - СправочникСсылка.ОтправкиРегистрацияЮЛ +// ИзменяемыеРеквизиты - Структура - содержит поля для обновления реквизитов справочника +// +// Возвращаемое значение: +// Булево - Истина, когда успешно обновлен элемент справочника +// +Функция ОбновитьОтправкуРегистрацииЮЛ(ОтправкаСсылка, ИзменяемыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ОбновитьОтправкуРегистрацииЮЛ(ОтправкаСсылка, ИзменяемыеРеквизиты) +``` +
+ +## ПроверитьСтатусЗакрытия +
+ +Описание, пример вызова + +```bsl + +// Проверяет статус закрытия объекта отправки при его записи +// +// Параметры: +// ОбъектОтправки - СправочникОбъект.ОтправкиРегистрацияЮЛ +// +Процедура ПроверитьСтатусЗакрытия(ОбъектОтправки) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотРегистрацияВФНС.ПроверитьСтатусЗакрытия(ОбъектОтправки) +``` +
+ +## ПрисоединитьФайлОтправкиРегистрацииЮЛ +
+ +Описание, пример вызова + +```bsl + +//Присоединяет файл к отправке регистрации ЮЛ +// +// Параметры: +// СвойстваФайла - Структура - содержит поля: +// * ОтправкаСсылка - СправочникСсылка.ОтправкиРегистрацияЮЛ +// * АдресФайла - Строка - адрес временного хранилища +// * НазначениеФайла - ПеречислениеСсылка.НазначенияФайловРегистрацииЮЛ +// * Идентификатор - Строка - идентификатор ответа +// * КодОтвета - Строка +// * ИмяФайла - Строка - имя исходного файла +// * Описание - Строка - описание содержимого файла +// * ОписаниеСервиса - Строка - описание состояния заявления +// * ТипСодержимого - ПеречислениеСсылка.ТипыСодержимогоФайлов +// +// Возвращаемое значение: +// СправочникСсылка.ОтправкиРегистрацияЮЛПрисоединенныеФайлы +// +Функция ПрисоединитьФайлОтправкиРегистрацииЮЛ(СвойстваФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ПрисоединитьФайлОтправкиРегистрацииЮЛ(СвойстваФайла) +``` +
+ +## СвойстваОтправкиРегистрацииЮЛ +
+ +Описание, пример вызова + +```bsl + +// Формирует базовую информацию об отправке +// +// Параметры: +// СсылкаПоиска - СправочникСсылка.ОтправкиРегистрацияЮЛ, ДокументСсылка - можно передать как саму отправку, так и предмет отправки +// +// Возвращаемое значение: +// Структура - содержит поля +// * ОтпечатокСертификата - Строка - отпечаток сертификата который использовался при подключении к сервису +// * ОтправкаСсылка - СправочникСсылка.ОтправкиРегистрацияЮЛ +// * ПредметОтправки - ДокументСсылка +// * ИдентификаторЗаявления - Строка - присвоенный сервером идентификатор заявки при отправке +// * ДатаОтправки - Дата +// * ОписаниеОтвета - Строка - описание состояния заявки полученное при обновлении статусов +// * КодОтвета - Строка - код состояния заявки полученное при обновлении статусов +// * СтатусОтправки - ПеречислениеСсылка.СтатусыОтправки +// * ВерсияОбмена - Число +// +Функция СвойстваОтправкиРегистрацииЮЛ(СсылкаПоиска) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СвойстваОтправкиРегистрацииЮЛ(СсылкаПоиска) +``` +
+ +## СвойстваЗаявленияРегистрацииЮЛ +
+ +Описание, пример вызова + +```bsl + +// Формирует базовую информацию об заявлении на регистрацию +// +// Параметры: +// СсылкаПоиска - ДокументСсылка - можно передать как саму отправку, так и предмет отправки +// +// Возвращаемое значение: +// Структура - содержит поля из СвойстваОтправкиРегистрацииЮЛ() и дополнительные поля +// * ИНН - Строка +// * ЭлектроннаяПочта - Строка +// * Телефон - Строка +// * КодНО - Строка +// * СпособПредоставленияОтвета - ПеречислениеСсылка.СпособыПолученияОтветаНаЭлГосРегистрацию +// * Организация - СправочникСсылка.Органзация +// * ВидДокумента - ПеречислениеСсылка.ВидыУведомленийОСпецрежимахНалогообложения +// * ИдентификаторПредмета - Строка +// +Функция СвойстваЗаявленияРегистрацииЮЛ(СсылкаПоиска) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СвойстваЗаявленияРегистрацииЮЛ(СсылкаПоиска) +``` +
+ +## ПоследняяОтправкаПоПредмету +
+ +Описание, пример вызова + +```bsl + +// Ищет последнюю отправку по указанному предмету отправки +// +// Параметры: +// ПредметОтправки - ДокументСсылка +// +// Возвращаемое значение: +// СправочникСсылка.ОтправкиРегистрацияЮЛ +// +Функция ПоследняяОтправкаПоПредмету(ПредметОтправки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ПоследняяОтправкаПоПредмету(ПредметОтправки) +``` +
+ +## СформироватьЭтапыОтправки +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию о текущем состоянии отправленного заявления +// +// Параметры: +// ОтправкаСсылка - СправочникСсылка.ОтправкиРегистрацияЮЛ +// +// Возвращаемое значение: +// Структура - содержит поля +// * Отправлено - Структура - подробнее в ТекущееСостояниеЭтапа() +// * ПринятВОбработку - Структура - подробнее в ТекущееСостояниеЭтапа() +// * Рассмотрение - Структура - подробнее в ТекущееСостояниеЭтапа() +// +Функция СформироватьЭтапыОтправки(ОтправкаСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СформироватьЭтапыОтправки(ОтправкаСсылка) +``` +
+ +## ТаблицаЭтаповОтправки +
+ +Описание, пример вызова + +```bsl + +// Формирует таблицу этапов для отображения в общих механизмах подсистемы +// +// Параметры: +// ПредметОтправки - СправочникСсылка.ОтправкиРегистрацияЮЛ +// ДополнительныеПараметры - Структура - может содержать поле "Отправка" +// +// Возвращаемое значение: +// ТаблицаЗначений +// +Функция ТаблицаЭтаповОтправки(ПредметОтправки, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ТаблицаЭтаповОтправки(ПредметОтправки, ДополнительныеПараметры) +``` +
+ +## ПредставлениеСтатусаОтправки +
+ +Описание, пример вызова + +```bsl + +// Получает представление текущего статуса отправки +// +// Параметры: +// ОтправкаСсылка - СправочникСсылка.ОтправкиРегистрацияЮЛ +// +// Возвращаемое значение: +// Строка +// +Функция ПредставлениеСтатусаОтправки(ОтправкаСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ПредставлениеСтатусаОтправки(ОтправкаСсылка) +``` +
+ +## СтатусыЭтаповОтправки +
+ +Описание, пример вызова + +```bsl + +// Формирует описание всех статусов используемых в подсистеме +// +// Параметры: +// ЗаявлениеНаИзменение - Булево - формирует с учетом вида заявления +// +// Возвращаемое значение: +// Структура +// +Функция СтатусыЭтаповОтправки(ЗаявлениеНаИзменение = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.СтатусыЭтаповОтправки(ЗаявлениеНаИзменение); +``` +
+ +## ВидыФайловОбменаСКонтролирующимОрганом +
+ +Описание, пример вызова + +```bsl + +// Формирует описание видов файлов необходимых для конфигураций потребителей +// +// Возвращаемое значение: +// Структура +// +Функция ВидыФайловОбменаСКонтролирующимОрганом() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ВидыФайловОбменаСКонтролирующимОрганом() +``` +
+ +## ПолучитьОтправкиПоОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает реестр не завершенных отправок заявления в сервис регистрации ЮЛ ФНС. +// В формируемый список добавляются только элементы, которые не требуют авторизации +// и отправленные в течении 2 месяцев +// +// Параметры: +// Организация - СправочникСсылка.Организация +// +// Возвращаемое значение: +// Массив из СправочникСсылка.ОтправкиРегистрацияЮЛ +// +Функция ПолучитьОтправкиПоОрганизации(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ПолучитьОтправкиПоОрганизации(Организация) +``` +
+ +## ИспользуетОбмен +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность отправки / обмена с сервисом для указанной организации +// +// Параметры: +// ОрганизацияСсылка - СправочникСсылка.Организации +// +// Возвращаемое значение: +// Булево +// +Функция ИспользуетОбмен(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ИспользуетОбмен(ОрганизацияСсылка) +``` +
+ +## ПодготовитьВыгрузкуФайлов +
+ +Описание, пример вызова + +```bsl + +// Формируется файловый архив на основе переданных данных и помещает его во временное хранилище +// +// Параметры: +// ОписаниеПакета - Структура - где "Ключ" имя папки, "Значение" массив из СправочникСсылка.ОтправкиРегистрацияЮЛПрисоединенныеФайлы (или другие). +// Если передан ключ "Корень", то файлы помещаются вне папок +// +// Возвращаемое значение: +// Структура - содержит поля +// * Выполнено - Булево - Истина, если функция успешно выполнена +// * Ошибка - Строка - описание ошибки, в случае если Выполнено = Ложь +// * АдресФайла - Строка - адрес во временном хранилище +// +Функция ПодготовитьВыгрузкуФайлов(ОписаниеПакета) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ПодготовитьВыгрузкуФайлов(ОписаниеПакета) +``` +
+ +## ОписаниеОбъектовПодсистемы +
+ +Описание, пример вызова + +```bsl + +// Формирует описание основных объектов подсистемы. +// +// Возвращаемое значение: +// Структура: +// * ТипСправочникаОтправки - Тип +// +Функция ОписаниеОбъектовПодсистемы() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНС.ОписаниеОбъектовПодсистемы() +``` +
+ +## ЗаписьЖурналаРегистрацииДляОшибки +
+ +Описание, пример вызова + +```bsl + +// Формирует запись в журнале регистрации в рамках этой подсистемы +// +// Параметры: +// ПодробныйТекстОшибки - Строка +// ДанныеБазы - Неопределено +// - СправочникСсылка.ОтправкиРегистрацияЮЛ +// +Процедура ЗаписьЖурналаРегистрацииДляОшибки(ПодробныйТекстОшибки, ДанныеБазы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотРегистрацияВФНС.ЗаписьЖурналаРегистрацииДляОшибки(ПодробныйТекстОшибки, ДанныеБазы); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотРегистрацияВФНСВызовСервера.md b/src/content/docs/zup/ДокументооборотРегистрацияВФНСВызовСервера.md new file mode 100644 index 0000000..9783366 --- /dev/null +++ b/src/content/docs/zup/ДокументооборотРегистрацияВФНСВызовСервера.md @@ -0,0 +1,185 @@ +--- +title: Документооборот регистрация вфнс вызов сервера +slug: zup/документооборот-регистрация-вфнс-вызов-сервера +--- + + +## ВыполнитьВФоне +
+ +Описание, пример вызова + +```bsl + +// Предназначен для запуска фонового задания для организации асинхронной обработки операций +// +// Параметры: +// ИмяПроцедуры - Строка - полный путь запускаемой процедуры в общем модуле +// ПараметрыПроцедуры - Структура - содержит именованные параметры для запуска процедур и функций +// +// Возвращаемое значение: +// Структура - содержит описание созданного фононовое задание см. ДлительныеОперации.ВыполнитьВФоне() +// +Функция ВыполнитьВФоне(ИмяПроцедуры, ПараметрыПроцедуры) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСВызовСервера.ВыполнитьВФоне(ИмяПроцедуры, ПараметрыПроцедуры) +``` +
+ +## ПолучитьРезультатВыполненияВФоне +
+ +Описание, пример вызова + +```bsl + +// Получение и подготовка результатов выполнения функции в фоне. +// +// Параметры: +// ДлительнаяОперация - Структура +// РеквизитыВХранилище - Строка +// +// Возвращаемое значение: +// Структура +// +Функция ПолучитьРезультатВыполненияВФоне(ДлительнаяОперация, РеквизитыВХранилище = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСВызовСервера.ПолучитьРезультатВыполненияВФоне(ДлительнаяОперация, РеквизитыВХранилище); +``` +
+ +## СвойстваОтправкиРегистрацииЮЛ +
+ +Описание, пример вызова + +```bsl + +// Обертка для получения данных о свойствах отправки +// +// Параметры: +// ПредметОтправки - СправочникСсылка.ОтправкиРегистрацияЮЛ +// +// Возвращаемое значение: +// см. ДокументооборотРегистрацияВФНС.СвойстваОтправкиРегистрацииЮЛ +// +Функция СвойстваОтправкиРегистрацииЮЛ(ПредметОтправки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСВызовСервера.СвойстваОтправкиРегистрацииЮЛ(ПредметОтправки) +``` +
+ +## СвойстваЗаявленияРегистрацииЮЛ +
+ +Описание, пример вызова + +```bsl + +// Обертка для получения данных о свойствах отправки. +// +// Параметры: +// ПредметОтправки - ДокументСсылка.УведомлениеОСпецрежимахНалогообложения +// +// Возвращаемое значение: +// см. ДокументооборотРегистрацияВФНС.СвойстваЗаявленияРегистрацииЮЛ +// +Функция СвойстваЗаявленияРегистрацииЮЛ(ПредметОтправки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСВызовСервера.СвойстваЗаявленияРегистрацииЮЛ(ПредметОтправки) +``` +
+ +## ПолучитьДанныеПоНавигационнойСсылке +
+ +Описание, пример вызова + +```bsl + +// Получает реальную ссылку на объект базы по ее навигационной ссылке +// +// Параметры: +// НавигационнаяСсылка - Строка +// +// Возвращаемое значение: +// СправочникСсылка.ОтправкиРегистрацияЮЛПрисоединенныеФайлы +// +Функция ПолучитьДанныеПоНавигационнойСсылке(НавигационнаяСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСВызовСервера.ПолучитьДанныеПоНавигационнойСсылке(НавигационнаяСсылка) +``` +
+ +## СформироватьЭтапыОтправки +
+ +Описание, пример вызова + +```bsl + +// Обертка для получения состояния этапов отправки. +// +// Параметры: +// ОтправкаСсылка - СправочникСсылка.ОтправкиРегистрацияЮЛ +// +// Возвращаемое значение: +// см. ДокументооборотРегистрацияВФНС.СформироватьЭтапыОтправки +// +Функция СформироватьЭтапыОтправки(ОтправкаСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСВызовСервера.СформироватьЭтапыОтправки(ОтправкаСсылка) +``` +
+ +## ПолучитьОтправкиПоОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает реестр не завершенных отправок заявления в сервис регистрации ЮЛ ФНС. +// В формируемый список добавляются только элементы, которые не требуют авторизации +// и отправленные в течении 2 месяцев +// +// Параметры: +// Организация - СправочникСсылка.Организация +// +// Возвращаемое значение: +// Массив из СправочникСсылка.ОтправкиРегистрацияЮЛ +// +Функция ПолучитьОтправкиПоОрганизации(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСВызовСервера.ПолучитьОтправкиПоОрганизации(Организация) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотРегистрацияВФНСКлиентСервер.md b/src/content/docs/zup/ДокументооборотРегистрацияВФНСКлиентСервер.md new file mode 100644 index 0000000..d07647b --- /dev/null +++ b/src/content/docs/zup/ДокументооборотРегистрацияВФНСКлиентСервер.md @@ -0,0 +1,129 @@ +--- +title: Документооборот регистрация вфнс клиент сервер +slug: zup/документооборот-регистрация-вфнс-клиент-сервер +--- + + +## ПараметрыПрорисовкиКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +// Описывает правила прорисовки интерфейсных элементов +// +// Параметры: +// ОрганизацияСсылка - СправочникСсылка.Организации +// +// Возвращаемое значение: +// Структура +// +Функция ПараметрыПрорисовкиКнопокОтправки(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСКлиентСервер.ПараметрыПрорисовкиКнопокОтправки(ОрганизацияСсылка) +``` +
+ +## ПриИнициализацииФормыРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +// Вызывается при открытии формы отчетности +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// ПараметрыПрорисовкиПанели - Структура - возвращает параметры +// +Процедура ПриИнициализацииФормыРегламентированногоОтчета(Форма, ПараметрыПрорисовкиПанели = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотРегистрацияВФНСКлиентСервер.ПриИнициализацииФормыРегламентированногоОтчета(Форма, ПараметрыПрорисовкиПанели); +``` +
+ +## ПолучитьСсылкуДанных +
+ +Описание, пример вызова + +```bsl + +// Определяет по источнику данных ссылку на документ, используемый в обмене. +// +// Параметры: +// ИсточникДанных - ДокументСсылка.УведомлениеОСпецрежимахНалогообложения, ФормаКлиентскогоПриложения +// +// Возвращаемое значение: +// ДокументСсылка.УведомлениеОСпецрежимахНалогообложения, Неопределено +// +Функция ПолучитьСсылкуДанных(ИсточникДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСКлиентСервер.ПолучитьСсылкуДанных(ИсточникДанных) +``` +
+ +## ПолучитьОрганизациюПоФорме +
+ +Описание, пример вызова + +```bsl + +// Определяет организацию по источнику данных +// +// Параметры: +// Форма - ДокументСсылка.УведомлениеОСпецрежимахНалогообложения, ФормаКлиентскогоПриложения +// +// Возвращаемое значение: +// СправочникСсылка.Организации, Неопределено +// +Функция ПолучитьОрганизациюПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСКлиентСервер.ПолучитьОрганизациюПоФорме(Форма) +``` +
+ +## ВерсияОбменаПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Определяет транспорт подключения к сервису приема заявлений +// Если 0 - прямое подключение к сервису ФНС, 1 - через промежуточный жлюз +// +// Возвращаемое значение: +// Число +// +Функция ВерсияОбменаПоУмолчанию() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотРегистрацияВФНСКлиентСервер.ВерсияОбменаПоУмолчанию() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСКО.md b/src/content/docs/zup/ДокументооборотСКО.md new file mode 100644 index 0000000..ab3249a --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСКО.md @@ -0,0 +1,412 @@ +--- +title: Документооборот СКО +slug: zup/документооборот-ско +--- + + +## ПолучитьСведенияОбОрганизацииЧерезПопытку +
+ +Описание, пример вызова + +```bsl + +// Получает сведения об организации с записью ошибок в журнал и попыткой получения сведений поштучно в попытке +// Не допускается передача пустого СписокПоказателей +// +Функция ПолучитьСведенияОбОрганизацииЧерезПопытку(Знач Организация, Знач ДатаЗначения = Неопределено, Знач СписокПоказателей) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.ПолучитьСведенияОбОрганизацииЧерезПопытку(Организация, ДатаЗначения, СписокПоказателей) +``` +
+ +## РеквизитОрганизацииЧерезПопытку +
+ +Описание, пример вызова + +```bsl + +Функция РеквизитОрганизацииЧерезПопытку(Знач Организация, Знач ДатаЗначения = Неопределено, Знач Показатель) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.РеквизитОрганизацииЧерезПопытку(Организация, ДатаЗначения, Показатель) +``` +
+ +## ПолучитьОбработкуЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьОбработкуЭДО(ТекстСообщения = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.ПолучитьОбработкуЭДО(ТекстСообщения); +``` +
+ +## ОбработчикиИнициализацииПараметровСеанса +
+ +Описание, пример вызова + +```bsl + +// Для задания обработчиков параметров сеанса следует использовать шаблон: +// Обработчики.Вставить("<ИмяПараметраСеанса>|<НачалоИмениПараметраСеанса*>", "Обработчик"); +// +// Примечание. Символ '*'используется в конце имени параметра сеанса и обозначает, +// что один обработчик будет вызван для инициализации всех параметров сеанса +// с именем, начинающимся на слово НачалоИмениПараметраСеанса +// +Процедура ОбработчикиИнициализацииПараметровСеанса(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.ОбработчикиИнициализацииПараметровСеанса(Обработчики) +``` +
+ +## ПараметрыИнформационнойПанелиБРО +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров, необходимых для создания информационной панели в объектах ЕНП/ЕНС +// +// Возвращаемое значение: +// Структура - Параметры, необходимые для создания информационной панели в объектах ЕНП/ЕНС +// +Функция ПараметрыИнформационнойПанелиБРО() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.ПараметрыИнформационнойПанелиБРО() +``` +
+ +## УстановитьПараметрСеансаТекущийСеансДокументооборотаСКО +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьПараметрСеансаТекущийСеансДокументооборотаСКО(ИмяПараметра = Неопределено, УстановленныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.УстановитьПараметрСеансаТекущийСеансДокументооборотаСКО(ИмяПараметра, УстановленныеПараметры); +``` +
+ +## НачатьСеансДокументооборотаСКО +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьСеансДокументооборотаСКО(ИнициаторСеанса, УчетнаяЗапись = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.НачатьСеансДокументооборотаСКО(ИнициаторСеанса, УчетнаяЗапись); +``` +
+ +## ЗакончитьСеансДокументооборотаСКО +
+ +Описание, пример вызова + +```bsl + +Процедура ЗакончитьСеансДокументооборотаСКО(УчетнаяЗапись = Неопределено, Успешно = Истина) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.ЗакончитьСеансДокументооборотаСКО(УчетнаяЗапись, Успешно); +``` +
+ +## ТекущийСеансДокументооборотаСКО +
+ +Описание, пример вызова + +```bsl + +Функция ТекущийСеансДокументооборотаСКО() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.ТекущийСеансДокументооборотаСКО() +``` +
+ +## УстановитьСоединениеССерверомИнтернета +
+ +Описание, пример вызова + +```bsl + +Функция УстановитьСоединениеССерверомИнтернета(URLСервера, ОписаниеОшибки = "", Таймаут = 60) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.УстановитьСоединениеССерверомИнтернета(URLСервера, ОписаниеОшибки, Таймаут); +``` +
+ +## ВыполнитьОбмен +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполнитьОбмен(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.ВыполнитьОбмен(УчетнаяЗапись) +``` +
+ +## ПолучитьСообщения +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСообщения(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.ПолучитьСообщения(УчетнаяЗапись) +``` +
+ +## ОтправитьСообщения +
+ +Описание, пример вызова + +```bsl + +Процедура ОтправитьСообщения(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.ОтправитьСообщения(УчетнаяЗапись) +``` +
+ +## НастроитьОбменПоУчетнойЗаписи +
+ +Описание, пример вызова + +```bsl + +Процедура НастроитьОбменПоУчетнойЗаписи(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.НастроитьОбменПоУчетнойЗаписи(УчетнаяЗапись) +``` +
+ +## ВключитьОбменПоУчетнойЗаписи +
+ +Описание, пример вызова + +```bsl + +Процедура ВключитьОбменПоУчетнойЗаписи(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.ВключитьОбменПоУчетнойЗаписи(УчетнаяЗапись) +``` +
+ +## ОтключитьОбменПоУчетнойЗаписи +
+ +Описание, пример вызова + +```bsl + +Процедура ОтключитьОбменПоУчетнойЗаписи(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.ОтключитьОбменПоУчетнойЗаписи(УчетнаяЗапись) +``` +
+ +## ПолучитьПочтовоеСоединение +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПочтовоеСоединение(ПочтовыйПрофиль) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.ПолучитьПочтовоеСоединение(ПочтовыйПрофиль) +``` +
+ +## ОткрытьСоединениеДляПолученияПочты +
+ +Описание, пример вызова + +```bsl + +Функция ОткрытьСоединениеДляПолученияПочты(ПараметрыПодключения) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.ОткрытьСоединениеДляПолученияПочты(ПараметрыПодключения) +``` +
+ +## ОткрытьСоединениеДляОтправкиПочты +
+ +Описание, пример вызова + +```bsl + +Функция ОткрытьСоединениеДляОтправкиПочты(ПараметрыПодключения) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.ОткрытьСоединениеДляОтправкиПочты(ПараметрыПодключения) +``` +
+ +## ЗакрытьПочтовоеСоединение +
+ +Описание, пример вызова + +```bsl + +Процедура ЗакрытьПочтовоеСоединение(ПочтовоеСоединение) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.ЗакрытьПочтовоеСоединение(ПочтовоеСоединение) +``` +
+ +## ПеренестиТранспортныеСообщенияВПрисоединенныеФайлы +
+ +Описание, пример вызова + +```bsl + +Процедура ПеренестиТранспортныеСообщенияВПрисоединенныеФайлы() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.ПеренестиТранспортныеСообщенияВПрисоединенныеФайлы() +``` +
+ +## ПараметрыРаботыКлиентаПриЗапуске +
+ +Описание, пример вызова + +```bsl + +Процедура ПараметрыРаботыКлиентаПриЗапуске(Параметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.ПараметрыРаботыКлиентаПриЗапуске(Параметры) +``` +
+ +## ПриДобавленииПараметровРаботыКлиента +
+ +Описание, пример вызова + +```bsl + +Процедура ПриДобавленииПараметровРаботыКлиента(Параметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКО.ПриДобавленииПараметровРаботыКлиента(Параметры) +``` +
+ +## ТекущиеУчетныеЗаписиНалогоплательщика +
+ +Описание, пример вызова + +```bsl + +Функция ТекущиеУчетныеЗаписиНалогоплательщика() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКО.ТекущиеУчетныеЗаписиНалогоплательщика() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСКОВызовСервера.md b/src/content/docs/zup/ДокументооборотСКОВызовСервера.md new file mode 100644 index 0000000..57d09ca --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСКОВызовСервера.md @@ -0,0 +1,1890 @@ +--- +title: Документооборот СКО вызов сервера +slug: zup/документооборот-ско-вызов-сервера +--- + + +## ИспользоватьВнешнийМодуль +
+ +Описание, пример вызова + +```bsl + +Функция ИспользоватьВнешнийМодуль() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ИспользоватьВнешнийМодуль() +``` +
+ +## ИнициализироватьКонтекстДокументооборотаСНалоговымиОрганами +
+ +Описание, пример вызова + +```bsl + +Функция ИнициализироватьКонтекстДокументооборотаСНалоговымиОрганами(ИндексСледующейОбработкиЭДО = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ИнициализироватьКонтекстДокументооборотаСНалоговымиОрганами(ИндексСледующейОбработкиЭДО); +``` +
+ +## ЕстьПравоНаДОсКО +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьПравоНаДОсКО(ПравоНаВнешнюю) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЕстьПравоНаДОсКО(ПравоНаВнешнюю) +``` +
+ +## ЕстьДоступНаЧтение +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьДоступНаЧтение() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЕстьДоступНаЧтение()); +``` +
+ +## ПодключатьВнешнююОбработкуЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ПодключатьВнешнююОбработкуЭДО() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПодключатьВнешнююОбработкуЭДО() +``` +
+ +## СоздатьВнешнююОбработкуЭДО +
+ +Описание, пример вызова + +```bsl + +Функция СоздатьВнешнююОбработкуЭДО() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.СоздатьВнешнююОбработкуЭДО()); +``` +
+ +## ЗаполнитьПараметрыФормы +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьПараметрыФормы(ПараметрыФормы, Параметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОВызовСервера.ЗаполнитьПараметрыФормы(ПараметрыФормы, Параметры) +``` +
+ +## ТекущемуПользователюАОДоступен +
+ +Описание, пример вызова + +```bsl + +Функция ТекущемуПользователюАОДоступен() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ТекущемуПользователюАОДоступен() +``` +
+ +## ТекущемуПользователюЭДОДоступен +
+ +Описание, пример вызова + +```bsl + +Функция ТекущемуПользователюЭДОДоступен() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ТекущемуПользователюЭДОДоступен() +``` +
+ +## ЕстьОрганизацииСНастройкамиСЭДОБезУчетныхЗаписей +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьОрганизацииСНастройкамиСЭДОБезУчетныхЗаписей() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЕстьОрганизацииСНастройкамиСЭДОБезУчетныхЗаписей()); +``` +
+ +## ПолучитьВыбранныйCSPИзВременныхНастроек +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьВыбранныйCSPИзВременныхНастроек() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьВыбранныйCSPИзВременныхНастроек() +``` +
+ +## ПриИнициализацииФормыРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// + +Процедура ПриИнициализацииФормыРегламентированногоОтчета(Отчет, ОрганизацияОтчета, КонтролирующийОрган, ПараметрыПрорисовкиКнопокОтправки, ПараметрыПрорисовкиПанели) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОВызовСервера.ПриИнициализацииФормыРегламентированногоОтчета(Отчет, ОрганизацияОтчета, КонтролирующийОрган, ПараметрыПрорисовкиКнопокОтправки, ПараметрыПрорисовкиПанели) +``` +
+ +## ПараметрыПрорисовкиКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыПрорисовкиКнопокОтправки(ОрганизацияОтчета, КонтролирующийОрган, Отчет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПараметрыПрорисовкиКнопокОтправки(ОрганизацияОтчета, КонтролирующийОрган, Отчет); +``` +
+ +## УчетнаяЗаписьПредназначенаДляДокументооборотаСФНС +
+ +Описание, пример вызова + +```bsl + +Функция УчетнаяЗаписьПредназначенаДляДокументооборотаСФНС(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.УчетнаяЗаписьПредназначенаДляДокументооборотаСФНС(УчетнаяЗапись) +``` +
+ +## УчетнаяЗаписьПредназначенаДляДокументооборотаСПФР +
+ +Описание, пример вызова + +```bsl + +Функция УчетнаяЗаписьПредназначенаДляДокументооборотаСПФР(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.УчетнаяЗаписьПредназначенаДляДокументооборотаСПФР(УчетнаяЗапись) +``` +
+ +## УчетнаяЗаписьПредназначенаДляДокументооборотаСФСГС +
+ +Описание, пример вызова + +```bsl + +Функция УчетнаяЗаписьПредназначенаДляДокументооборотаСФСГС(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.УчетнаяЗаписьПредназначенаДляДокументооборотаСФСГС(УчетнаяЗапись) +``` +
+ +## УчетнаяЗаписьПредназначенаДляДокументооборотаСЦБ +
+ +Описание, пример вызова + +```bsl + +Функция УчетнаяЗаписьПредназначенаДляДокументооборотаСЦБ(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.УчетнаяЗаписьПредназначенаДляДокументооборотаСЦБ(УчетнаяЗапись) +``` +
+ +## ПолучитьСообщенияЦиклаОбмена +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСообщенияЦиклаОбмена(ЦиклОбмена, ТипыСообщений = Неопределено, ПомеченныеНаУдаление = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьСообщенияЦиклаОбмена(ЦиклОбмена, ТипыСообщений, ПомеченныеНаУдаление); +``` +
+ +## СообщениеЗашифровано +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеЗашифровано(Сообщение) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.СообщениеЗашифровано(Сообщение) +``` +
+ +## СообщениеРасшифровано +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеРасшифровано(Сообщение) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.СообщениеРасшифровано(Сообщение) +``` +
+ +## ПолучитьПоследнийЦиклОбмена +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПоследнийЦиклОбмена(Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьПоследнийЦиклОбмена(Объект) +``` +
+ +## ПолучитьСсылкуНаПротоколПоЦиклуОбмена +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСсылкуНаПротоколПоЦиклуОбмена(ЦиклОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьСсылкуНаПротоколПоЦиклуОбмена(ЦиклОбмена)); +``` +
+ +## ПолучитьСвойстваАктуальногоПротокола +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСвойстваАктуальногоПротокола(СсылкаНаОтчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьСвойстваАктуальногоПротокола(СсылкаНаОтчет) +``` +
+ +## УстановитьПараметрСеансаТекущиеУчетныеЗаписиНалогоплательщика +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьПараметрСеансаТекущиеУчетныеЗаписиНалогоплательщика(ИмяПараметра = Неопределено, УстановленныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОВызовСервера.УстановитьПараметрСеансаТекущиеУчетныеЗаписиНалогоплательщика(ИмяПараметра, УстановленныеПараметры); +``` +
+ +## ПриНажатииНаКнопкуОтправкиВКонтролирующийОрган +
+ +Описание, пример вызова + +```bsl + +Процедура ПриНажатииНаКнопкуОтправкиВКонтролирующийОрган(ОрганизацияОтчета, КонтролирующийОрган, НастроенОбменВУниверсальномФормате, УчетнаяЗаписьПредназначенаДляДокументооборотаСКО) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОВызовСервера.ПриНажатииНаКнопкуОтправкиВКонтролирующийОрган(ОрганизацияОтчета, КонтролирующийОрган, НастроенОбменВУниверсальномФормате, УчетнаяЗаписьПредназначенаДляДокументооборотаСКО) +``` +
+ +## ПолучитьНастройкиФСС +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьНастройкиФСС(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьНастройкиФСС(ОрганизацияСсылка) +``` +
+ +## ПолучитьНастройкиФСРАР +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьНастройкиФСРАР(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьНастройкиФСРАР(ОрганизацияСсылка) +``` +
+ +## ПолучитьНастройкиРПН +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьНастройкиРПН(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьНастройкиРПН(ОрганизацияСсылка) +``` +
+ +## ПолучитьНастройкиФТС +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьНастройкиФТС(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьНастройкиФТС(ОрганизацияСсылка) +``` +
+ +## УчетнаяЗаписьОрганизации +
+ +Описание, пример вызова + +```bsl + +Функция УчетнаяЗаписьОрганизации(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.УчетнаяЗаписьОрганизации(Организация) +``` +
+ +## ПараметрыПрорисовкиПанелиОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыПрорисовкиПанелиОтправки(Знач Ссылка, Знач Организация = Неопределено, Знач КонтролирующийОрган = "ФНС") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПараметрыПрорисовкиПанелиОтправки(Ссылка, Организация, КонтролирующийОрган); +``` +
+ +## ПараметрыПрорисовкиСтатуса +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыПрорисовкиСтатуса(Знач Ссылка, КонтролирующийОрган = "ФНС", ПолучатьДаты = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПараметрыПрорисовкиСтатуса(Ссылка, КонтролирующийОрган, ПолучатьДаты); +``` +
+ +## ЗаполнитьРегистрЖурналОтправокВКонтролирующиеОрганы +
+ +Описание, пример вызова + +```bsl + +// Обновление ИБ +Процедура ЗаполнитьРегистрЖурналОтправокВКонтролирующиеОрганы(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОВызовСервера.ЗаполнитьРегистрЖурналОтправокВКонтролирующиеОрганы(Параметры); +``` +
+ +## КоличествоОбъектовНеЗаписанныхВРегистрЖурналОтправокВКонтролирующиеОрганы +
+ +Описание, пример вызова + +```bsl + +Функция КоличествоОбъектовНеЗаписанныхВРегистрЖурналОтправокВКонтролирующиеОрганы() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.КоличествоОбъектовНеЗаписанныхВРегистрЖурналОтправокВКонтролирующиеОрганы() +``` +
+ +## ВыборкаОбъектовНеЗаписанныхВРегистрЖурналОтправокВКонтролирующиеОрганы +
+ +Описание, пример вызова + +```bsl + +Функция ВыборкаОбъектовНеЗаписанныхВРегистрЖурналОтправокВКонтролирующиеОрганы() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ВыборкаОбъектовНеЗаписанныхВРегистрЖурналОтправокВКонтролирующиеОрганы() +``` +
+ +## ТипыОбъектовЭДООтображаемыхВФорме1СОтчетность +
+ +Описание, пример вызова + +```bsl + +Функция ТипыОбъектовЭДООтображаемыхВФорме1СОтчетность() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ТипыОбъектовЭДООтображаемыхВФорме1СОтчетность() +``` +
+ +## ЦветФонаПанелиОтправкиПоСтатусу +
+ +Описание, пример вызова + +```bsl + +Функция ЦветФонаПанелиОтправкиПоСтатусу(СостояниеСдачиОтчетности, ТекстСтатуса = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЦветФонаПанелиОтправкиПоСтатусу(СостояниеСдачиОтчетности, ТекстСтатуса); +``` +
+ +## ЕстьДоступККонтекстуЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьДоступККонтекстуЭДО() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЕстьДоступККонтекстуЭДО() +``` +
+ +## ПолучитьОписьВходящихДокументовПоТребованию +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьОписьВходящихДокументовПоТребованию(ТребованиеСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьОписьВходящихДокументовПоТребованию(ТребованиеСсылка) +``` +
+ +## ТипыЦикловОбмена +
+ +Описание, пример вызова + +```bsl + +Функция ТипыЦикловОбмена() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ТипыЦикловОбмена() +``` +
+ +## ТипПервичныхСообщений +
+ +Описание, пример вызова + +```bsl + +Функция ТипПервичныхСообщений() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ТипПервичныхСообщений() +``` +
+ +## ИспользуетсяРежимТестирования +
+ +Описание, пример вызова + +```bsl + +// Функцию нельзя переносить в повторное использование, так как режим могут поменять, +// а функция будет возвращать прежнее значение. +Функция ИспользуетсяРежимТестирования() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ИспользуетсяРежимТестирования() +``` +
+ +## ТипыСодержимогоТранспортногоКонтейнераПервичныхСообщений +
+ +Описание, пример вызова + +```bsl + +Функция ТипыСодержимогоТранспортногоКонтейнераПервичныхСообщений() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ТипыСодержимогоТранспортногоКонтейнераПервичныхСообщений() +``` +
+ +## ЭтоРегламентированныйОтчетРеестрНДС +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоРегламентированныйОтчетРеестрНДС(СсылкаНаОтчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЭтоРегламентированныйОтчетРеестрНДС(СсылкаНаОтчет) +``` +
+ +## ЭтоРегламентированныйОтчетРеестрАкцизы +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоРегламентированныйОтчетРеестрАкцизы(СсылкаНаОтчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЭтоРегламентированныйОтчетРеестрАкцизы(СсылкаНаОтчет) +``` +
+ +## ОрганизацияПодключенаКИнспекции +
+ +Описание, пример вызова + +```bsl + +Функция ОрганизацияПодключенаКИнспекции(СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ОрганизацияПодключенаКИнспекции(СсылкаНаОбъект) +``` +
+ +## ПутьКОбъекту +
+ +Описание, пример вызова + +```bsl + +Функция ПутьКОбъекту() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПутьКОбъекту() +``` +
+ +## ВФонеОбработатьИзменившиесяКодыФСГС +
+ +Описание, пример вызова + +```bsl + +Процедура ВФонеОбработатьИзменившиесяКодыФСГС() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОВызовСервера.ВФонеОбработатьИзменившиесяКодыФСГС() +``` +
+ +## ПредставлениеКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +Функция ПредставлениеКонтактнойИнформации(ЗначениеАдреса) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПредставлениеКонтактнойИнформации(ЗначениеАдреса) +``` +
+ +## ПреобразоватьАдресВФорматXML +
+ +Описание, пример вызова + +```bsl + +Процедура ПреобразоватьАдресВФорматXML(Адрес, ВидКонтактнойИнформации) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОВызовСервера.ПреобразоватьАдресВФорматXML(Адрес, ВидКонтактнойИнформации) +``` +
+ +## ПолучитьКодВидаДокументаФизическогоЛица +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьКодВидаДокументаФизическогоЛица(ДокументФизическогоЛица) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьКодВидаДокументаФизическогоЛица(ДокументФизическогоЛица) +``` +
+ +## ПолучитьВидДокументаПоКодуИлиНаименованию +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьВидДокументаПоКодуИлиНаименованию(КодВидаДокумента, НаименованиеВидаДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьВидДокументаПоКодуИлиНаименованию(КодВидаДокумента, НаименованиеВидаДокумента) +``` +
+ +## РазложитьФИО +
+ +Описание, пример вызова + +```bsl + +Функция РазложитьФИО(Знач ФамилияИмяОтчество) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.РазложитьФИО(ФамилияИмяОтчество) +``` +
+ +## ПолучитьСвойстваОрганизации +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСвойстваОрганизации(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьСвойстваОрганизации(Организация) +``` +
+ +## ПолучитьСвойстваКонтрагента +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСвойстваКонтрагента(Контрагент) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьСвойстваКонтрагента(Контрагент) +``` +
+ +## ПолучитьСвойстваФизическогоЛица +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСвойстваФизическогоЛица(ФизическоеЛицо) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьСвойстваФизическогоЛица(ФизическоеЛицо) +``` +
+ +## ЭтоЮридическоеЛицо +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоЮридическоеЛицо(ОрганизацияКонтрагентИлиФизическоеЛицо, ЗначениеПоУмолчанию = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЭтоЮридическоеЛицо(ОрганизацияКонтрагентИлиФизическоеЛицо, ЗначениеПоУмолчанию); +``` +
+ +## НайтиФизическоеЛицо +
+ +Описание, пример вызова + +```bsl + +Функция НайтиФизическоеЛицо(ФИО) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.НайтиФизическоеЛицо(ФИО) +``` +
+ +## ВыгрузитьМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузитьМЧДРР( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ВыгрузитьМЧДРР(); +``` +
+ +## ЗагрузитьМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ЗагрузитьМЧДРР( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗагрузитьМЧДРР(); +``` +
+ +## ПроверитьМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьМЧДРР(Знач ОбъектИлиСсылка, Знач ПараметрыОперации = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПроверитьМЧДРР(ОбъектИлиСсылка, ПараметрыОперации); +``` +
+ +## НайтиМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция НайтиМЧДРР(НомерДоверенности, ИННДоверителя = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.НайтиМЧДРР(НомерДоверенности, ИННДоверителя); +``` +
+ +## ЗарегистрированныеМЧДФНС +
+ +Описание, пример вызова + +```bsl + +Функция ЗарегистрированныеМЧДФНС( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗарегистрированныеМЧДФНС(); +``` +
+ +## НедействительныеМЧДФНС +
+ +Описание, пример вызова + +```bsl + +Функция НедействительныеМЧДФНС( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.НедействительныеМЧДФНС(); +``` +
+ +## РегистрацииВНалоговомОргане +
+ +Описание, пример вызова + +```bsl + +Функция РегистрацииВНалоговомОргане(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.РегистрацииВНалоговомОргане(ОрганизацияСсылка) +``` +
+ +## КодыНалоговыхОргановМЧДФНС +
+ +Описание, пример вызова + +```bsl + +Функция КодыНалоговыхОргановМЧДФНС(ДоверенностьСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.КодыНалоговыхОргановМЧДФНС(ДоверенностьСсылка) +``` +
+ +## ФИОМЧДФНС +
+ +Описание, пример вызова + +```bsl + +Функция ФИОМЧДФНС(ДоверенностьСсылка, СубъектДоверенности) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ФИОМЧДФНС(ДоверенностьСсылка, СубъектДоверенности) +``` +
+ +## ВыгрузитьЗаявлениеНаОтменуМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузитьЗаявлениеНаОтменуМЧДРР( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ВыгрузитьЗаявлениеНаОтменуМЧДРР(); +``` +
+ +## АвторизоватьсяНаСервереМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция АвторизоватьсяНаСервереМЧДРР() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.АвторизоватьсяНаСервереМЧДРР() +``` +
+ +## ПолучитьНомерМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьНомерМЧДРР(ТокенДоступа = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьНомерМЧДРР(ТокенДоступа); +``` +
+ +## ЗарегистрироватьМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ЗарегистрироватьМЧДРР( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗарегистрироватьМЧДРР(); +``` +
+ +## ПолучитьСтатусТранзакцииМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСтатусТранзакцииМЧДРР(ИдентификаторТранзакции, ТокенДоступа = "", НомерДоверенности = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьСтатусТранзакцииМЧДРР(ИдентификаторТранзакции, ТокенДоступа, НомерДоверенности); +``` +
+ +## ПолучитьЧастичныеДанныеДоверенностиНаСервереМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьЧастичныеДанныеДоверенностиНаСервереМЧДРР(НомерДоверенности, ТокенДоступа = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьЧастичныеДанныеДоверенностиНаСервереМЧДРР(НомерДоверенности, ТокенДоступа); +``` +
+ +## ПолучитьПолныеДанныеДоверенностиНаСервереМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПолныеДанныеДоверенностиНаСервереМЧДРР( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьПолныеДанныеДоверенностиНаСервереМЧДРР(); +``` +
+ +## ПолучитьХронологическиеДанныеДоверенностиНаСервереМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьХронологическиеДанныеДоверенностиНаСервереМЧДРР( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПолучитьХронологическиеДанныеДоверенностиНаСервереМЧДРР(); +``` +
+ +## ОтменитьМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ОтменитьМЧДРР( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ОтменитьМЧДРР(); +``` +
+ +## ОбновитьСостояниеМЧДРР +
+ +Описание, пример вызова + +```bsl + +Функция ОбновитьСостояниеМЧДРР(СсылкаНаДоверенность = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ОбновитьСостояниеМЧДРР(СсылкаНаДоверенность); +``` +
+ +## ВыгрузитьМЧД +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузитьМЧД( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ВыгрузитьМЧД(); +``` +
+ +## ЗагрузитьМЧД +
+ +Описание, пример вызова + +```bsl + +Функция ЗагрузитьМЧД(ВходящиеДанные, ОбновлятьСуществующийИлиСсылка = Ложь, Подпись = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗагрузитьМЧД(ВходящиеДанные, ОбновлятьСуществующийИлиСсылка, Подпись); +``` +
+ +## ПроверитьМЧД +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьМЧД(Знач ОбъектИлиСсылка, Знач НастройкиПроверки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПроверитьМЧД(ОбъектИлиСсылка, НастройкиПроверки); +``` +
+ +## ПроверитьЗаявлениеОбОтзывеМЧДФНС +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьЗаявлениеОбОтзывеМЧДФНС(Знач ОбъектИлиСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПроверитьЗаявлениеОбОтзывеМЧДФНС(ОбъектИлиСсылка) +``` +
+ +## ЗагрузитьЗаявлениеОбОтзывеМЧДФНС +
+ +Описание, пример вызова + +```bsl + +Функция ЗагрузитьЗаявлениеОбОтзывеМЧДФНС(ВходящиеДанные, ОбновлятьСуществующий = Ложь, Подпись = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗагрузитьЗаявлениеОбОтзывеМЧДФНС(ВходящиеДанные, ОбновлятьСуществующий, Подпись); +``` +
+ +## ВыгрузитьЗаявлениеОбОтзывеМЧДФНС +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузитьЗаявлениеОбОтзывеМЧДФНС( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ВыгрузитьЗаявлениеОбОтзывеМЧДФНС(); +``` +
+ +## СохранитьПодписьМЧДФНС +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьПодписьМЧДФНС( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОВызовСервера.СохранитьПодписьМЧДФНС(); +``` +
+ +## ВыгрузитьМЧДФСС +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузитьМЧДФСС( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ВыгрузитьМЧДФСС(); +``` +
+ +## ЗагрузитьМЧДФСС +
+ +Описание, пример вызова + +```bsl + +Функция ЗагрузитьМЧДФСС(ВходящиеДанные, ОбновлятьСуществующийИлиСсылка = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗагрузитьМЧДФСС(ВходящиеДанные, ОбновлятьСуществующийИлиСсылка); +``` +
+ +## ПроверитьМЧДФСС +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьМЧДФСС(Знач ОбъектИлиСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПроверитьМЧДФСС(ОбъектИлиСсылка) +``` +
+ +## ПараметрыОтзываМашиночитаемойДоверенностиФСС +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыОтзываМашиночитаемойДоверенностиФСС( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПараметрыОтзываМашиночитаемойДоверенностиФСС(); +``` +
+ +## ПараметрыЗапросаМашиночитаемойДоверенностиФСС +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыЗапросаМашиночитаемойДоверенностиФСС( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПараметрыЗапросаМашиночитаемойДоверенностиФСС(); +``` +
+ +## ПараметрыЗапросаСправочникаПолномочийМашиночитаемыхДоверенностейФСС +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыЗапросаСправочникаПолномочийМашиночитаемыхДоверенностейФСС(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПараметрыЗапросаСправочникаПолномочийМашиночитаемыхДоверенностейФСС(Организация) +``` +
+ +## СведенияОбОтправкеСЭДО +
+ +Описание, пример вызова + +```bsl + +Функция СведенияОбОтправкеСЭДО(АвтозапросПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.СведенияОбОтправкеСЭДО(АвтозапросПараметры) +``` +
+ +## ВыгрузитьМЧДЦБ +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузитьМЧДЦБ( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ВыгрузитьМЧДЦБ(); +``` +
+ +## ЗагрузитьМЧДЦБ +
+ +Описание, пример вызова + +```bsl + +Функция ЗагрузитьМЧДЦБ(ВходящиеДанные, ОбновлятьСуществующий = Ложь, Подпись = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗагрузитьМЧДЦБ(ВходящиеДанные, ОбновлятьСуществующий, Подпись); +``` +
+ +## ПроверитьМЧДЦБ +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьМЧДЦБ(Знач ОбъектИлиСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПроверитьМЧДЦБ(ОбъектИлиСсылка) +``` +
+ +## ЗаписатьМЧДЦБСПодписью +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаписатьМЧДЦБСПодписью( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОВызовСервера.ЗаписатьМЧДЦБСПодписью(); +``` +
+ +## ВыгрузитьУведомлениеОПредоставленииПолномочийПредставителю +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузитьУведомлениеОПредоставленииПолномочийПредставителю( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ВыгрузитьУведомлениеОПредоставленииПолномочийПредставителю(); +``` +
+ +## ЗагрузитьУПУП +
+ +Описание, пример вызова + +```bsl + +Функция ЗагрузитьУПУП(ВходящиеДанные, ОбновлятьСуществующий = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗагрузитьУПУП(ВходящиеДанные, ОбновлятьСуществующий); +``` +
+ +## ПроверитьУПУП +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьУПУП(Знач ОбъектИлиСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПроверитьУПУП(ОбъектИлиСсылка) +``` +
+ +## ВыгрузитьУведомлениеОПрекращенииПолномочийПредставителя +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузитьУведомлениеОПрекращенииПолномочийПредставителя( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ВыгрузитьУведомлениеОПрекращенииПолномочийПредставителя(); +``` +
+ +## ЗагрузитьУПРУП +
+ +Описание, пример вызова + +```bsl + +Функция ЗагрузитьУПРУП(ВходящиеДанные, ОбновлятьСуществующий = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗагрузитьУПРУП(ВходящиеДанные, ОбновлятьСуществующий); +``` +
+ +## ПроверитьУПРУП +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьУПРУП(Знач ОбъектИлиСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПроверитьУПРУП(ОбъектИлиСсылка) +``` +
+ +## УстановитьПараметрыПодключенияОтключенияМЧД +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьПараметрыПодключенияОтключенияМЧД(Запрос, ПроверяемыеМЧДФНС, ВыбранныеОрганизации) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОВызовСервера.УстановитьПараметрыПодключенияОтключенияМЧД(Запрос, ПроверяемыеМЧДФНС, ВыбранныеОрганизации)); +``` +
+ +## ЗапросМЧДВРегистрациях +
+ +Описание, пример вызова + +```bsl + +Функция ЗапросМЧДВРегистрациях() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗапросМЧДВРегистрациях()); +``` +
+ +## УточнитьРеквизитыПредставителяМЧДФНС +
+ +Описание, пример вызова + +```bsl + +Функция УточнитьРеквизитыПредставителяМЧДФНС( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.УточнитьРеквизитыПредставителяМЧДФНС(); +``` +
+ +## ОрганизацияМЧДЕдиногоФормата +
+ +Описание, пример вызова + +```bsl + +Функция ОрганизацияМЧДЕдиногоФормата(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ОрганизацияМЧДЕдиногоФормата(Ссылка) +``` +
+ +## ПредставителиМЧДЕдиногоФормата +
+ +Описание, пример вызова + +```bsl + +Функция ПредставителиМЧДЕдиногоФормата(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ПредставителиМЧДЕдиногоФормата(Ссылка) +``` +
+ +## СвойстваМЧДЕдиногоФормата +
+ +Описание, пример вызова + +```bsl + +Функция СвойстваМЧДЕдиногоФормата(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.СвойстваМЧДЕдиногоФормата(Ссылка) +``` +
+ +## ВыгрузитьМЧДЕдиногоФормата +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузитьМЧДЕдиногоФормата(Ссылка, ПараметрыВозврата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ВыгрузитьМЧДЕдиногоФормата(Ссылка, ПараметрыВозврата); +``` +
+ +## ОрганизацияПоОбъектуОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ОрганизацияПоОбъектуОтправки(ОбъектСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ОрганизацияПоОбъектуОтправки(ОбъектСсылка) +``` +
+ +## ЗаполненыДанныеАутентификацииПользователяИнтернетПоддержки +
+ +Описание, пример вызова + +```bsl + +Функция ЗаполненыДанныеАутентификацииПользователяИнтернетПоддержки() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЗаполненыДанныеАутентификацииПользователяИнтернетПоддержки() +``` +
+ +## ДатаИзСтрокиРазныхФорматов +
+ +Описание, пример вызова + +```bsl + +Функция ДатаИзСтрокиРазныхФорматов(СтрокаДаты) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ДатаИзСтрокиРазныхФорматов(СтрокаДаты) +``` +
+ +## ЧислоВШестнадцатеричномПредставлении +
+ +Описание, пример вызова + +```bsl + +Функция ЧислоВШестнадцатеричномПредставлении(Знач Число, Знач КоличествоБайт = 32) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ЧислоВШестнадцатеричномПредставлении(Число, КоличествоБайт); +``` +
+ +## АдресаСерверовМетокВремени +
+ +Описание, пример вызова + +```bsl + +Функция АдресаСерверовМетокВремени(СтрокаИлиМассивПоУмолчанию = "HTTP://dss.1stdss.1c.ru/TSP/tsp.srf") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.АдресаСерверовМетокВремени(СтрокаИлиМассивПоУмолчанию); +``` +
+ +## ДобавитьШтампыЭЦПКСодержимомуТабличногоДокумента +
+ +Описание, пример вызова + +```bsl + +Функция ДобавитьШтампыЭЦПКСодержимомуТабличногоДокумента(ТабличныйДокумент, ТабДокШтампыЭЦП) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ДобавитьШтампыЭЦПКСодержимомуТабличногоДокумента(ТабличныйДокумент, ТабДокШтампыЭЦП) +``` +
+ +## НастройкиОбменаЕГАИС +
+ +Описание, пример вызова + +```bsl + +Функция НастройкиОбменаЕГАИС(Организация, НастройкиОбмена = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.НастройкиОбменаЕГАИС(Организация, НастройкиОбмена); +``` +
+ +## ОтформатироватьДату +
+ +Описание, пример вызова + +```bsl + +Функция ОтформатироватьДату(Дата) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.ОтформатироватьДату(Дата) +``` +
+ +## КраткоеНаименованиеОрганизации +
+ +Описание, пример вызова + +```bsl + +Функция КраткоеНаименованиеОрганизации(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОВызовСервера.КраткоеНаименованиеОрганизации(Организация) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСКОГлобальный.md b/src/content/docs/zup/ДокументооборотСКОГлобальный.md new file mode 100644 index 0000000..a18336e --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСКОГлобальный.md @@ -0,0 +1,191 @@ +--- +title: Документооборот СКО глобальный +slug: zup/документооборот-ско-глобальный +--- + + +## ПолучитьИнформациюОВходящихСообщениях +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьИнформациюОВходящихСообщениях() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.ПолучитьИнформациюОВходящихСообщениях() +``` +
+ +## ОбработатьИзменившиесяКодыФСГС +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработатьИзменившиесяКодыФСГС() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.ОбработатьИзменившиесяКодыФСГС() +``` +
+ +## ПолучитьИнформациюОВходящихСообщенияхДляПользователяЭДО +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьИнформациюОВходящихСообщенияхДляПользователяЭДО() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.ПолучитьИнформациюОВходящихСообщенияхДляПользователяЭДО() +``` +
+ +## ПредупредитьОПроблемах1СОтчетности +
+ +Описание, пример вызова + +```bsl + +Процедура ПредупредитьОПроблемах1СОтчетности() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.ПредупредитьОПроблемах1СОтчетности() +``` +
+ +## ПредупредитьОЗаявленияхЭДОПФР +
+ +Описание, пример вызова + +```bsl + +Процедура ПредупредитьОЗаявленияхЭДОПФР() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.ПредупредитьОЗаявленияхЭДОПФР() +``` +
+ +## ПредупредитьОНекорректныхСтатусахОтправки2НДФЛ +
+ +Описание, пример вызова + +```bsl + +Процедура ПредупредитьОНекорректныхСтатусахОтправки2НДФЛ() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.ПредупредитьОНекорректныхСтатусахОтправки2НДФЛ() +``` +
+ +## ПредупредитьОКонфликтеКриптопровайдеров +
+ +Описание, пример вызова + +```bsl + +Процедура ПредупредитьОКонфликтеКриптопровайдеров() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.ПредупредитьОКонфликтеКриптопровайдеров() +``` +
+ +## Подключаемый_ОткрытьФормуМастераЗаявленияНаПодключение +
+ +Описание, пример вызова + +```bsl + +Процедура Подключаемый_ОткрытьФормуМастераЗаявленияНаПодключение() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.Подключаемый_ОткрытьФормуМастераЗаявленияНаПодключение() +``` +
+ +## ПредупредитьОбАстралМ +
+ +Описание, пример вызова + +```bsl + +Процедура ПредупредитьОбАстралМ() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.ПредупредитьОбАстралМ() +``` +
+ +## ПолучитьИнформациюОТребованиях +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ожидания по проверки наличия необработанных требований ФНС. +// +Процедура ПолучитьИнформациюОТребованиях() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.ПолучитьИнформациюОТребованиях() +``` +
+ +## ПоказатьПриглашенияПользователям +
+ +Описание, пример вызова + +```bsl + +Процедура ПоказатьПриглашенияПользователям() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОГлобальный.ПоказатьПриглашенияПользователям() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСКОКлиент.md b/src/content/docs/zup/ДокументооборотСКОКлиент.md new file mode 100644 index 0000000..e0cf401 --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСКОКлиент.md @@ -0,0 +1,1133 @@ +--- +title: Документооборот СКО клиент +slug: zup/документооборот-ско-клиент +--- + + +## ПолучитьКонтекстЭДО +
+ +Описание, пример вызова + +```bsl + +// Процедура получает Контекст ЭДО и возвращает его в Обработку оповещения, +// переданную в параметрах к этой процедуре. +// +// +// Параметры: +// ВыполняемоеОповещение - ОписаниеОповещения - Описание оповещения, которое будет вызвано после получения Контекста ЭДО. +// В качестве результата описания оповещения передается структура с ключами: +// * КонтекстЭДО - Форма обработки, либо неопределено +// * ТекстОшибки - Текст сообщения об ошибке, из-за которой не удалось получить контекст +// ВызовИзМастераПодключенияК1СОтчетности - Булево - . +// +Процедура ПолучитьКонтекстЭДО( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПолучитьКонтекстЭДО(); +``` +
+ +## ОбновитьИПолучитьКонтекстЭДО +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьИПолучитьКонтекстЭДО(ВыполняемоеОповещение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОбновитьИПолучитьКонтекстЭДО(ВыполняемоеОповещение); +``` +
+ +## КлючВК +
+ +Описание, пример вызова + +```bsl + +Функция КлючВК() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиент.КлючВК()); +``` +
+ +## ПолучитьПутьВК +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПутьВК(Принудительно = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиент.ПолучитьПутьВК(Принудительно); +``` +
+ +## ОбновитьПутьВК +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьПутьВК(ПослеЗапускаСистемы = Ложь) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОбновитьПутьВК(ПослеЗапускаСистемы); +``` +
+ +## ОтправитьОтчеты +
+ +Описание, пример вызова + +```bsl + +Процедура ОтправитьОтчеты(ВыполняемоеОповещение, Ссылки) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОтправитьОтчеты(ВыполняемоеОповещение, Ссылки) +``` +
+ +## ОтправитьОтчеты_ПослеПолучениеКонтекста +
+ +Описание, пример вызова + +```bsl + +Процедура ОтправитьОтчеты_ПослеПолучениеКонтекста(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОтправитьОтчеты_ПослеПолучениеКонтекста(Результат, ВходящийКонтекст) +``` +
+ +## ПриНажатииНаКнопкуОтправкиВКонтролирующийОрган +
+ +Описание, пример вызова + +```bsl + +Процедура ПриНажатииНаКнопкуОтправкиВКонтролирующийОрган( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПриНажатииНаКнопкуОтправкиВКонтролирующийОрган(); +``` +
+ +## ПродолжитьОтправкуПослеСохраненияРегОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ПродолжитьОтправкуПослеСохраненияРегОтчета(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПродолжитьОтправкуПослеСохраненияРегОтчета(Результат, ДополнительныеПараметры) +``` +
+ +## ПроверитьЧтоЭДОПодключенИПродолжитьОтправку +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьЧтоЭДОПодключенИПродолжитьОтправку(ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьЧтоЭДОПодключенИПродолжитьОтправку(ДополнительныеПараметры)); +``` +
+ +## ПроверитьЧтоЭДОПодключенПослеПолученияКонтекста_ПослеПроверкиЗаявления +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьЧтоЭДОПодключенПослеПолученияКонтекста_ПослеПроверкиЗаявления(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьЧтоЭДОПодключенПослеПолученияКонтекста_ПослеПроверкиЗаявления(Результат, ВходящийКонтекст) +``` +
+ +## ПроверитьЧтоЭДОПодключенПослеПолученияКонтекста +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьЧтоЭДОПодключенПослеПолученияКонтекста(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьЧтоЭДОПодключенПослеПолученияКонтекста(Результат, ДополнительныеПараметры) +``` +
+ +## ПроверитьЧтоЭДОПодключенПослеДобавленияКонтекстаВПараметры +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьЧтоЭДОПодключенПослеДобавленияКонтекстаВПараметры(ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьЧтоЭДОПодключенПослеДобавленияКонтекстаВПараметры(ДополнительныеПараметры) +``` +
+ +## ПроверитьЧтоЭДОПодключенПослеДобавленияКонтекстаВПараметры_ПослеНастройкиЗаявления +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьЧтоЭДОПодключенПослеДобавленияКонтекстаВПараметры_ПослеНастройкиЗаявления(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьЧтоЭДОПодключенПослеДобавленияКонтекстаВПараметры_ПослеНастройкиЗаявления(Результат, ДополнительныеПараметры) +``` +
+ +## ОрганизацияПодключенаКНаправлению +
+ +Описание, пример вызова + +```bsl + +Функция ОрганизацияПодключенаКНаправлению(ОрганизацияОтчета, КонтролирующийОрган) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиент.ОрганизацияПодключенаКНаправлению(ОрганизацияОтчета, КонтролирующийОрган) +``` +
+ +## ОповеститьОЗавершенииОтправкиИПерерисоватьПанельОтправки +
+ +Описание, пример вызова + +```bsl + +Процедура ОповеститьОЗавершенииОтправкиИПерерисоватьПанельОтправки(РезультатОтправки, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОповеститьОЗавершенииОтправкиИПерерисоватьПанельОтправки(РезультатОтправки, ДополнительныеПараметры) +``` +
+ +## ОтправкаВКонтролирующийОрганПослеПодтвержденияОтправки +
+ +Описание, пример вызова + +```bsl + +Процедура ОтправкаВКонтролирующийОрганПослеПодтвержденияОтправки(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОтправкаВКонтролирующийОрганПослеПодтвержденияОтправки(Результат, ВходящийКонтекст) +``` +
+ +## ПроверитьВИнтернете +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьВИнтернете(Форма, КонтролирующийОрган = "ФНС", АдресГотовыхДанных = Неопределено, ИмяФайлаГотовыхДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьВИнтернете(Форма, КонтролирующийОрган, АдресГотовыхДанных, ИмяФайлаГотовыхДанных); +``` +
+ +## ПроверитьВИнтернетеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьВИнтернетеЗавершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьВИнтернетеЗавершение(Результат, ДополнительныеПараметры) +``` +
+ +## ПроверитьВИнтернетеПослеСохранения +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьВИнтернетеПослеСохранения(Форма, КонтролирующийОрган, СсылкаНаОтчет, АдресГотовыхДанных = Неопределено, ИмяФайлаГотовыхДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьВИнтернетеПослеСохранения(Форма, КонтролирующийОрган, СсылкаНаОтчет, АдресГотовыхДанных, ИмяФайлаГотовыхДанных); +``` +
+ +## ПроверитьВИнтернетеПослеПолученияКонтекста +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьВИнтернетеПослеПолученияКонтекста(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьВИнтернетеПослеПолученияКонтекста(Результат, ДополнительныеПараметры) +``` +
+ +## ПроверитьВИнтернетеПоСсылке +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьВИнтернетеПоСсылке(Ссылка, КонтролирующийОрган = "ФНС", АдресГотовыхДанных = Неопределено, ИмяФайлаГотовыхДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьВИнтернетеПоСсылке(Ссылка, КонтролирующийОрган, АдресГотовыхДанных, ИмяФайлаГотовыхДанных); +``` +
+ +## ПослеЗапускаСистемы +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеЗапускаСистемы() Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПослеЗапускаСистемы() +``` +
+ +## ПредупредитьОбАстралМЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПредупредитьОбАстралМЗавершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПредупредитьОбАстралМЗавершение(Результат, ДополнительныеПараметры) +``` +
+ +## ПредупредитьОЗаявленияхЭДОПФРЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПредупредитьОЗаявленияхЭДОПФРЗавершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПредупредитьОЗаявленияхЭДОПФРЗавершение(Результат, ДополнительныеПараметры) +``` +
+ +## ПодключениеОбработчикаОжиданияАвтообмена +
+ +Описание, пример вызова + +```bsl + +Процедура ПодключениеОбработчикаОжиданияАвтообмена(Подключать = Истина) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПодключениеОбработчикаОжиданияАвтообмена(Подключать); +``` +
+ +## ОткрытьМастерПодключенияК1СОтчетности +
+ +Описание, пример вызова + +```bsl + +Процедура ОткрытьМастерПодключенияК1СОтчетности(СохраненныеНастройки) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОткрытьМастерПодключенияК1СОтчетности(СохраненныеНастройки)); +``` +
+ +## ОткрытьМастерПодключенияК1СОтчетностиЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ОткрытьМастерПодключенияК1СОтчетностиЗавершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОткрытьМастерПодключенияК1СОтчетностиЗавершение(Результат, ДополнительныеПараметры) +``` +
+ +## ПолучитьИнформациюОВходящихСообщенияхЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьИнформациюОВходящихСообщенияхЗавершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПолучитьИнформациюОВходящихСообщенияхЗавершение(Результат, ДополнительныеПараметры) +``` +
+ +## ПолучитьИнформациюОВходящихСообщенияхДляПользователяЭДОЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьИнформациюОВходящихСообщенияхДляПользователяЭДОЗавершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПолучитьИнформациюОВходящихСообщенияхДляПользователяЭДОЗавершение(Результат, ДополнительныеПараметры) +``` +
+ +## ПредупредитьОПроблемах1СОтчетностиЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПредупредитьОПроблемах1СОтчетностиЗавершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПредупредитьОПроблемах1СОтчетностиЗавершение(Результат, ДополнительныеПараметры) +``` +
+ +## ПредупредитьОНекорректныхСтатусахОтправки2НДФЛПослеПолученияКонтекста +
+ +Описание, пример вызова + +```bsl + +Процедура ПредупредитьОНекорректныхСтатусахОтправки2НДФЛПослеПолученияКонтекста(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПредупредитьОНекорректныхСтатусахОтправки2НДФЛПослеПолученияКонтекста(Результат, ДополнительныеПараметры) +``` +
+ +## СоздатьЭлектронноеПредставлениеРегламентированныхОтчетовИзФайлов +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьЭлектронноеПредставлениеРегламентированныхОтчетовИзФайлов(Файлы, Адрес) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.СоздатьЭлектронноеПредставлениеРегламентированныхОтчетовИзФайлов(Файлы, Адрес) +``` +
+ +## СоздатьЭлектронноеПредставлениеРегламентированныхОтчетовИзФайловЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьЭлектронноеПредставлениеРегламентированныхОтчетовИзФайловЗавершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.СоздатьЭлектронноеПредставлениеРегламентированныхОтчетовИзФайловЗавершение(Результат, ДополнительныеПараметры) +``` +
+ +## ПроверитьСтатусПодключенияПередОтправкой +
+ +Описание, пример вызова + +```bsl + +// Проверяет, было ли отправлено и одобрено заявление на подключение к 1С-Отчетности. +// Если было, то предлагает завершить настройку 1С-Отчетности и повторяет отправку объекта, +// если указан параметр ВыполняемоеОповещение. +// Если заявления отправлено не было, то показывает предложение подключиться к 1С-Отчетности. +// +// Параметры: +// СсылкаНаОбъект - ДокументСсылка, СправочникСсылка - Отправляемый объект +// ВыполняемоеОповещение - ОписаниеОповещения, Неопределено - Описание действия, которое должно быть повторено после +// успешной настройки заявления по 1С-Отчетности. Неопределено - если отправку повторять не нужно. + +Процедура ПроверитьСтатусПодключенияПередОтправкой(СсылкаНаОбъект, ВыполняемоеОповещение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьСтатусПодключенияПередОтправкой(СсылкаНаОбъект, ВыполняемоеОповещение); +``` +
+ +## ПроверитьСтатусПодключенияПередОтправкойПослеПолученияКонтекста +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьСтатусПодключенияПередОтправкойПослеПолученияКонтекста(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьСтатусПодключенияПередОтправкойПослеПолученияКонтекста(Результат, ДополнительныеПараметры) +``` +
+ +## ЗавершитьНастройкуЗаявленияНаИзменение +
+ +Описание, пример вызова + +```bsl + +// Проверяет, было ли отправлено и одобрено заявление на изменение подключения к 1С-Отчетности. +// Если было, то предлагает завершить его настройку и затем продолжает отправку. +// +// Параметры: +// СсылкаНаОбъект - ДокументСсылка, СправочникСсылка - Отправляемый объект +// ВыполняемоеОповещение - ОписаниеОповещения, Неопределено - Описание действия, которое должно быть выполнено +// после настройки заявления на изменение 1С-Отчетности. +// +Процедура ЗавершитьНастройкуЗаявленияНаИзменение(СсылкаНаОбъект, ВыполняемоеОповещение) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ЗавершитьНастройкуЗаявленияНаИзменение(СсылкаНаОбъект, ВыполняемоеОповещение) +``` +
+ +## ЗавершитьНастройкуЗаявленияНаИзменениеПоСсылке_ПослеПолученияКонтекста +
+ +Описание, пример вызова + +```bsl + +Процедура ЗавершитьНастройкуЗаявленияНаИзменениеПоСсылке_ПослеПолученияКонтекста(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ЗавершитьНастройкуЗаявленияНаИзменениеПоСсылке_ПослеПолученияКонтекста(Результат, ДополнительныеПараметры) +``` +
+ +## СообщитьОНеподключенномНаправлении +
+ +Описание, пример вызова + +```bsl + +// Показывает предупреждение о том, что направление сдачи отчетности не подключено и предлагает +// отправить заявление для подключения этого направления. +// Если заявление было отправлено, то предлагает завершить настройку заявления, если оно одобрено +// или сообщает о том, что оно еще не одобрено. +// По завершению работы вызывается процедура, указанная в параметре ВыполняемоеОповещение +// с результатом, указанным в параметре РезультатОтправки. +// +// Параметры: +// СсылкаНаОбъект - ДокументСсылка, СправочникСсылка - Отправляемый объект +// ВыполняемоеОповещение - ОписаниеОповещения, Неопределено - Действие, которое должно быть выполенено в случае неуспешной отправки. +// РезультатОтправки - Произвольный - Результат, который должен быть возвращен в случае неуспешной отправки отчета. +// +Процедура СообщитьОНеподключенномНаправлении(СсылкаНаОбъект, ВыполняемоеОповещение = Неопределено, РезультатОтправки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.СообщитьОНеподключенномНаправлении(СсылкаНаОбъект, ВыполняемоеОповещение, РезультатОтправки); +``` +
+ +## СообщитьОНеподключенномНаправленииПослеПолученияКонтекста +
+ +Описание, пример вызова + +```bsl + +Процедура СообщитьОНеподключенномНаправленииПослеПолученияКонтекста(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.СообщитьОНеподключенномНаправленииПослеПолученияКонтекста(Результат, ДополнительныеПараметры) +``` +
+ +## СформироватьПакетПоЕГРЮЛ +
+ +Описание, пример вызова + +```bsl + +Процедура СформироватьПакетПоЕГРЮЛ(Параметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.СформироватьПакетПоЕГРЮЛ(Параметры) +``` +
+ +## СформироватьПакетПоЕГРЮЛ_ПослеПолученияКонтекста +
+ +Описание, пример вызова + +```bsl + +Процедура СформироватьПакетПоЕГРЮЛ_ПослеПолученияКонтекста(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.СформироватьПакетПоЕГРЮЛ_ПослеПолученияКонтекста(Результат, ВходящийКонтекст) +``` +
+ +## ПолучитьСвойстваПрограммыМенеджераКриптографии +
+ +Описание, пример вызова + +```bsl + +// УниверсальныйКриптопровайдер - Булево - если Истина, то возвращается провайдер Microsoft Base Cryptographic Provider v1.0 +Процедура ПолучитьСвойстваПрограммыМенеджераКриптографии( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПолучитьСвойстваПрограммыМенеджераКриптографии(); +``` +
+ +## ОтобразитьПредставленияСертификатов +
+ +Описание, пример вызова + +```bsl + +Процедура ОтобразитьПредставленияСертификатов( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОтобразитьПредставленияСертификатов(); +``` +
+ +## ОтобразитьПредставлениеСертификата +
+ +Описание, пример вызова + +```bsl + +Процедура ОтобразитьПредставлениеСертификата( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОтобразитьПредставлениеСертификата(); +``` +
+ +## ПолучитьСертификаты +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьСертификаты(ОписаниеОповещения, Параметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПолучитьСертификаты(ОписаниеОповещения, Параметры) +``` +
+ +## НаименованиеСертификата +
+ +Описание, пример вызова + +```bsl + +Функция НаименованиеСертификата(СертификатКриптографии) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиент.НаименованиеСертификата(СертификатКриптографии) +``` +
+ +## СтуктураДанныхСертификатаВСтроку +
+ +Описание, пример вызова + +```bsl + +Функция СтуктураДанныхСертификатаВСтроку(Структура) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиент.СтуктураДанныхСертификатаВСтроку(Структура) +``` +
+ +## ОпределитьУстановленныеКрипторовайдеры +
+ +Описание, пример вызова + +```bsl + +Процедура ОпределитьУстановленныеКрипторовайдеры(ОповещениеОбратногоВызова) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ОпределитьУстановленныеКрипторовайдеры(ОповещениеОбратногоВызова) +``` +
+ +## СоздатьМенеджерКриптографии +
+ +Описание, пример вызова + +```bsl + +// Создает и возвращает менеджер криптографии (на клиенте) для указанной программы. +// +// Параметры: +// Оповещение - ОписаниеОповещения - описание оповещения для возврата из процедуры +// СвойстваПрограммы - ФиксированнаяСтруктура - структура со свойствами программы менеджера криптографии +// Алгоритмы - Структура - структура со свойствами: +// * АлгоритмПодписи - Строка - алгоритм подписи +// * АлгоритмХеширования - Строка - алгоритм подписи +// * АлгоритмШифрования - Строка - алгоритм подписи +Процедура СоздатьМенеджерКриптографии(Оповещение, СвойстваПрограммы, Алгоритмы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.СоздатьМенеджерКриптографии(Оповещение, СвойстваПрограммы, Алгоритмы); +``` +
+ +## НайтиСертификатПоОтпечатку +
+ +Описание, пример вызова + +```bsl + +Процедура НайтиСертификатПоОтпечатку( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.НайтиСертификатПоОтпечатку(); +``` +
+ +## НайтиСертификатПоСерийномуНомеру +
+ +Описание, пример вызова + +```bsl + +Процедура НайтиСертификатПоСерийномуНомеру( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.НайтиСертификатПоСерийномуНомеру(); +``` +
+ +## НайтиСертификатПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +Процедура НайтиСертификатПоИдентификатору( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.НайтиСертификатПоИдентификатору(); +``` +
+ +## ПроверитьСертификат +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьСертификат( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПроверитьСертификат(); +``` +
+ +## ЭкспортироватьСертификатВФайл +
+ +Описание, пример вызова + +```bsl + +Процедура Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ЭкспортироватьСертификатВФайл(); +``` +
+ +## ПодписатьCadesBes +
+ +Описание, пример вызова + +```bsl + +Процедура ПодписатьCadesBes(ОповещениеОбратногоВызова, ПараметрыПодписи) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПодписатьCadesBes(ОповещениеОбратногоВызова, ПараметрыПодписи) +``` +
+ +## ПодключениеОбработчикаОжиданияИнформацияПоТребованиям +
+ +Описание, пример вызова + +```bsl + +// Подключает/отключает обработчик ожидания для проверки состояния требований от ФНС. +// +// Параметры: +// Подключать - Булево +// ПериодОповещения - Число +// +Процедура ПодключениеОбработчикаОжиданияИнформацияПоТребованиям(Подключать = Истина, Интервал = 0) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПодключениеОбработчикаОжиданияИнформацияПоТребованиям(Подключать, Интервал); +``` +
+ +## ПолучитьИнформациюОТребованияхЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьИнформациюОТребованияхЗавершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПолучитьИнформациюОТребованияхЗавершение(Результат, ДополнительныеПараметры) +``` +
+ +## ИнформационнаяПанельБРОНажатие +
+ +Описание, пример вызова + +```bsl + +// Метод отрабатывает нажатие на элементы в информационной панели БРО +// +// Параметры: +// Форма - УправляемаяФорма - Форма, в которой располагается элемент. +// Ссылка - Строка - Значение, которое пришло в метод формы Подключаемый_ИнформационнаяПанельБРООбработкаНавигационнойСсылки +// в парамете НавигационнаяСсылкаФорматированнойСтроки. +// СтандартнаяОбработка - Булево - Значение, которое пришло в метод формы +// Подключаемый_ИнформационнаяПанельБРООбработкаНавигационнойСсылки в параметре ОбработкаНавигационнойСсылки. +// +Процедура ИнформационнаяПанельБРОНажатие(Форма, Ссылка, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ИнформационнаяПанельБРОНажатие(Форма, Ссылка, СтандартнаяОбработка) +``` +
+ +## ПредлагатьУстановкуРасширения +
+ +Описание, пример вызова + +```bsl + +Функция ПредлагатьУстановкуРасширения() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиент.ПредлагатьУстановкуРасширения() +``` +
+ +## ПолучитьТабДокОтчетаСЭЦП +
+ +Описание, пример вызова + +```bsl + +// Добавляет в табличный документ отчета, отправленного в ФНС, СФР (бывш. ПФР) или Росстат штамп эл. подписи. +// +// Параметры: +// Источник - ФормаКлиентскогоПриложения, ДокументСсылка, ДокументСсылка - +// Форма или ссылка на печатаемый отчет +// Если передается форма, то в методе ЭлектронныйДокументооборотСКонтролирующимиОрганамиКлиентСервер.СсылкаНаОтчетПоФорме +// должно быть запрограммировано получение ссылки на этот отчет. +// ТабличныйДокумент - ТабличныйДокумент, Неопределено - Табличный документ отчета, куда надо добавить штамп эл. подписи. +// Если ТабличныйДокумент не указан, то результат будет содержать xml содержимое отчета (эл. представление) со штампом эл. подписи. +// ВыполняемоеОповещение - ОписаниеОповещения - После завершения работы управление будет передано в этот метод со следующим результатом: +// Выполнено – Булево - Показывает, успешно ли выполнена процедура добавления штамп эл. подписи. +// ТабличныйДокумент - ТабличныйДокумент - Табличный документ отчета с добавленным штампом эл. подписи. +// др. вспомогательные свойства. +// +Процедура ПолучитьТабДокОтчетаСЭЦП(Источник, ТабличныйДокумент = Неопределено, ВыполняемоеОповещение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПолучитьТабДокОтчетаСЭЦП(Источник, ТабличныйДокумент, ВыполняемоеОповещение); +``` +
+ +## ПолучитьОтчетСЭЦППродолжение +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьОтчетСЭЦППродолжение(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПолучитьОтчетСЭЦППродолжение(Результат, ВходящийКонтекст) +``` +
+ +## ПолучитьОтчетСЭЦППроверкаРезультата +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьОтчетСЭЦППроверкаРезультата(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПолучитьОтчетСЭЦППроверкаРезультата(Результат, ВходящийКонтекст) +``` +
+ +## ПолучитьОтчетСЭЦПЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьОтчетСЭЦПЗавершение(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ПолучитьОтчетСЭЦПЗавершение(Результат, ВходящийКонтекст) +``` +
+ +## ВыбратьНастройкиОбменаЕГАИС +
+ +Описание, пример вызова + +```bsl + +Процедура ВыбратьНастройкиОбменаЕГАИС(ОбработчикЗакрытияФормы, Организация, СписокЗначенийНастроекОбмена) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиент.ВыбратьНастройкиОбменаЕГАИС(ОбработчикЗакрытияФормы, Организация, СписокЗначенийНастроекОбмена) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСКОКлиентПереопределяемый.md b/src/content/docs/zup/ДокументооборотСКОКлиентПереопределяемый.md new file mode 100644 index 0000000..95d7ac7 --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСКОКлиентПереопределяемый.md @@ -0,0 +1,81 @@ +--- +title: Документооборот СКО клиент переопределяемый +slug: zup/документооборот-ско-клиент-переопределяемый +--- + + +## ПерейтиКСверкеПоИмущественномуНалогу +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды перехода к сверке имущественного налога из входящего сообщения ФНС +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой выполняется открытие сверки +// Сообщение - СправочникСсылка.ДокументыРеализацииПолномочийНалоговыхОрганов - входящее сообщение из ФНС +// с расчетом имущественных налогов +// +Процедура ПерейтиКСверкеПоИмущественномуНалогу(Форма, Сообщение) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиентПереопределяемый.ПерейтиКСверкеПоИмущественномуНалогу(Форма, Сообщение) +``` +
+ +## СформироватьВыгрузкуПлатежныхПоручений +
+ +Описание, пример вызова + +```bsl + +// Переходит к форме выгрузки документов вида "Платежное поручение" +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой выполняется открытие сверки +// МассивПлатежныхПоручений - Массив из Ссылка - ссылки на сформированные документы платежей в потребителе +// - Массив из Строка - навигационные ссылки на сформированные документы платежей в потребителе +// +Процедура СформироватьВыгрузкуПлатежныхПоручений(Форма, МассивПлатежныхПоручений) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиентПереопределяемый.СформироватьВыгрузкуПлатежныхПоручений(Форма, МассивПлатежныхПоручений) +``` +
+ +## ОткрытьПлатежноеПоручениеТребования +
+ +Описание, пример вызова + +```bsl + +// Открывает форму платежного поручения в конфигурации потребителя +// +// Параметры: +// ПараметрыФормы - Структура - параметры для открытия формы +// Открыта - Булево - статус открытия формы, если не ИСТИНА, то открывается стандартная форма объекта +// +Процедура ОткрытьПлатежноеПоручениеТребования(ПараметрыФормы, Открыта) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиентПереопределяемый.ОткрытьПлатежноеПоручениеТребования(ПараметрыФормы, Открыта) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСКОКлиентСервер.md b/src/content/docs/zup/ДокументооборотСКОКлиентСервер.md new file mode 100644 index 0000000..9ce7f47 --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСКОКлиентСервер.md @@ -0,0 +1,585 @@ +--- +title: Документооборот СКО клиент сервер +slug: zup/документооборот-ско-клиент-сервер +--- + + +## ЭтоВебКлиент +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоВебКлиент() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ЭтоВебКлиент() +``` +
+ +## ПоддерживаетсяФормированиеПакетаДляВнесенияИзмененийВЕГРЮЛ +
+ +Описание, пример вызова + +```bsl + +Функция ПоддерживаетсяФормированиеПакетаДляВнесенияИзмененийВЕГРЮЛ() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПоддерживаетсяФормированиеПакетаДляВнесенияИзмененийВЕГРЮЛ() +``` +
+ +## ВерсияДляФормированиеПакетаЕГРЮЛ +
+ +Описание, пример вызова + +```bsl + +Функция ВерсияДляФормированиеПакетаЕГРЮЛ() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ВерсияДляФормированиеПакетаЕГРЮЛ() +``` +
+ +## ПриИнициализацииФормыРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ПриИнициализацииФормыРегламентированногоОтчета(Форма, КонтролирующийОрган = "ФНС", ПараметрыПрорисовкиПанели = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиентСервер.ПриИнициализацииФормыРегламентированногоОтчета(Форма, КонтролирующийОрган, ПараметрыПрорисовкиПанели); +``` +
+ +## ПолучитьОрганизациюПоФорме +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьОрганизациюПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПолучитьОрганизациюПоФорме(Форма) +``` +
+ +## УстановитьВидимостьГруппыКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +///////////////////////////////////////////////////////////// +// ВНИМАНИЕ!!! +// Не удалять метод. Используется в 1С:УП Калуги Астрал +///////////////////////////////////////////////////////////// + +Процедура УстановитьВидимостьГруппыКнопокОтправки(Форма, ПараметрыПрорисовкиКнопокОтправки) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиентСервер.УстановитьВидимостьГруппыКнопокОтправки(Форма, ПараметрыПрорисовкиКнопокОтправки) +``` +
+ +## ПолучитьПараметрыПрорисовкиПанелиОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПараметрыПрорисовкиПанелиОтправки(Форма, КонтролирующийОрган) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПолучитьПараметрыПрорисовкиПанелиОтправки(Форма, КонтролирующийОрган) +``` +
+ +## СообщитьПользователю +
+ +Описание, пример вызова + +```bsl + +Процедура СообщитьПользователю( Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОКлиентСервер.СообщитьПользователю(); +``` +
+ +## ЭтоВидОтправляемогоДокументаРеестраНДС +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоВидОтправляемогоДокументаРеестраНДС(ВидОтчета) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ЭтоВидОтправляемогоДокументаРеестраНДС(ВидОтчета) +``` +
+ +## ВидыОтправляемыхДокументовРеестровНДС +
+ +Описание, пример вызова + +```bsl + +Функция ВидыОтправляемыхДокументовРеестровНДС() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ВидыОтправляемыхДокументовРеестровНДС() +``` +
+ +## ЭтоВидОтправляемогоДокументаРеестраАкцизов +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоВидОтправляемогоДокументаРеестраАкцизов(ВидОтчета) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ЭтоВидОтправляемогоДокументаРеестраАкцизов(ВидОтчета) +``` +
+ +## ВидыОтправляемыхДокументовРеестровАкцизов +
+ +Описание, пример вызова + +```bsl + +Функция ВидыОтправляемыхДокументовРеестровАкцизов() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ВидыОтправляемыхДокументовРеестровАкцизов() +``` +
+ +## УдалитьРазделители +
+ +Описание, пример вызова + +```bsl + +Функция УдалитьРазделители(Знач АнализируемаяСтрока) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.УдалитьРазделители(АнализируемаяСтрока) +``` +
+ +## ПроверитьЦифровойКодЗаданнойДлины +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьЦифровойКодЗаданнойДлины(Параметр, Длина, ПропускатьПустой = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПроверитьЦифровойКодЗаданнойДлины(Параметр, Длина, ПропускатьПустой); +``` +
+ +## ПроверитьКПП +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьКПП(КПП) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПроверитьКПП(КПП) +``` +
+ +## ПроверитьРегистрационныйНомерПФР +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьРегистрационныйНомерПФР(Параметр, ПропускатьПустой = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПроверитьРегистрационныйНомерПФР(Параметр, ПропускатьПустой); +``` +
+ +## ЭтоФНС +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоФНС(КонтролирующийОрган) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ЭтоФНС(КонтролирующийОрган) +``` +
+ +## НайденыЗапрещенныеСимволы +
+ +Описание, пример вызова + +```bsl + +Функция НайденыЗапрещенныеСимволы(АнализируемаяСтрока, НаименованиеРеквизита, Поле, ТихийРежим = Ложь, ТекстОшибки = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.НайденыЗапрещенныеСимволы(АнализируемаяСтрока, НаименованиеРеквизита, Поле, ТихийРежим, ТекстОшибки); +``` +
+ +## ЗапрещенныеСимволыВСтроке +
+ +Описание, пример вызова + +```bsl + +Функция ЗапрещенныеСимволыВСтроке(АнализируемаяСтрока) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ЗапрещенныеСимволыВСтроке(АнализируемаяСтрока) +``` +
+ +## ПараметрыОткрытияМастера +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыОткрытияМастера() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПараметрыОткрытияМастера() +``` +
+ +## ПроверитьСНИЛС +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьСНИЛС(Параметр, ПропускатьПустой = Ложь, ПроверятьКонтрольноеЧисло = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПроверитьСНИЛС(Параметр, ПропускатьПустой, ПроверятьКонтрольноеЧисло); +``` +
+ +## РезультатПроверкиРеквизитов +
+ +Описание, пример вызова + +```bsl + +Функция РезультатПроверкиРеквизитов() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.РезультатПроверкиРеквизитов() +``` +
+ +## ВывестиОшибкуПроверкиРеквизита +
+ +Описание, пример вызова + +```bsl + +Функция ВывестиОшибкуПроверкиРеквизита(МастерДалее, РезультатПроверки, ВыводитьСообщения) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ВывестиОшибкуПроверкиРеквизита(МастерДалее, РезультатПроверки, ВыводитьСообщения) +``` +
+ +## СравнитьВерсииФормата +
+ +Описание, пример вызова + +```bsl + +// Сравнивает одну версию формата с другой, например "5.05" и "5.04" +// Написана на базе ОбщегоНазначенияКлиентСервер.СравнитьВерсии +// +// Возвращаемое значение: +// Число - отрицательное, если первая меньше второй. +// - 0, если равны. +// - положительное, если первая больше второй. +Функция СравнитьВерсииФормата(Знач СтрокаВерсии1, Знач СтрокаВерсии2) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.СравнитьВерсииФормата(СтрокаВерсии1, СтрокаВерсии2) +``` +
+ +## ДобавитьРеквизит +
+ +Описание, пример вызова + +```bsl + +Функция ДобавитьРеквизит(Текст, ДобСтрока, Префикс, ДобавлятьПрефиксПриЗаполненномТексте = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ДобавитьРеквизит(Текст, ДобСтрока, Префикс, ДобавлятьПрефиксПриЗаполненномТексте); +``` +
+ +## ПолучитьПредставлениеФИО +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПредставлениеФИО(СтрокаФИО, ПрефиксИмени = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПолучитьПредставлениеФИО(СтрокаФИО, ПрефиксИмени); +``` +
+ +## ПолучитьПредставлениеУдостоверение +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПредставлениеУдостоверение(СтрокаУдостоверения, ПрефиксИмени = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПолучитьПредставлениеУдостоверение(СтрокаУдостоверения, ПрефиксИмени); +``` +
+ +## ПроверитьИННВладельцаЭП +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьИННВладельцаЭП(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ПроверитьИННВладельцаЭП(Форма) +``` +
+ +## ФамилияИнициалы +
+ +Описание, пример вызова + +```bsl + +Функция ФамилияИнициалы(Фамилия, Имя, Отчество) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ФамилияИнициалы(Фамилия, Имя, Отчество) +``` +
+ +## ИспользуетсяРежимТестирования +
+ +Описание, пример вызова + +```bsl + +Функция ИспользуетсяРежимТестирования() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ИспользуетсяРежимТестирования() +``` +
+ +## КоличествоПолномочийМЧДЦБ +
+ +Описание, пример вызова + +```bsl + +Функция КоличествоПолномочийМЧДЦБ() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.КоличествоПолномочийМЧДЦБ() +``` +
+ +## ОбозначениеПолномочияМЧДЦБПоКоду +
+ +Описание, пример вызова + +```bsl + +Функция ОбозначениеПолномочияМЧДЦБПоКоду(ПолномочиеПредставителя, ВернутьНаименование = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ОбозначениеПолномочияМЧДЦБПоКоду(ПолномочиеПредставителя, ВернутьНаименование); +``` +
+ +## ФамилияИнициалыПоСсылке +
+ +Описание, пример вызова + +```bsl + +Функция ФамилияИнициалыПоСсылке(СсылкаНаФизЛицо) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ФамилияИнициалыПоСсылке(СсылкаНаФизЛицо) +``` +
+ +## ОтправитьHTTPЗапрос +
+ +Описание, пример вызова + +```bsl + +Функция ОтправитьHTTPЗапрос(ТранспортныйМодуль, Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ОтправитьHTTPЗапрос(ТранспортныйМодуль, Параметры) +``` +
+ +## ДатаСВременемЕслиЕсть +
+ +Описание, пример вызова + +```bsl + +Функция ДатаСВременемЕслиЕсть(ДатаИлиДатаИВремя, Префикс = "", Постфикс = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКОКлиентСервер.ДатаСВременемЕслиЕсть(ДатаИлиДатаИВремя, Префикс, Постфикс); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСКООблачнаяПодписьВызовСервера.md b/src/content/docs/zup/ДокументооборотСКООблачнаяПодписьВызовСервера.md new file mode 100644 index 0000000..8232ed0 --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСКООблачнаяПодписьВызовСервера.md @@ -0,0 +1,146 @@ +--- +title: Документооборот СКО облачная подпись вызов сервера +slug: zup/документооборот-ско-облачная-подпись-вызов-сервера +--- + + +## СтатусПодготовкиСертификата +
+ +Описание, пример вызова + +```bsl + +// Вычисляет статус проверки легитимности сертификата для обмена с КО +// Предназначена для предварительной проверки сертификата, прежде чем получать подпись к сертификату +// +// Параметры: +// Сертификат - ДвоичныеДанные, Строка, Структура +// ДанныеСертификата - Неопределено - используется для возрата содержимого сертификата +// ДанныеПодписи - Неопределено - используется для возрата содержимого подписи +// ОтпечатокСертификата - Строка - используется для возрата отпечатка сертификата +// +// Возвращаемое значение: +// - Булево - Истина, если сертификат допустим для дальнейшей работы +// - Неопределено - если подсистема недоступна или проверка невозможна +// +Функция СтатусПодготовкиСертификата(Сертификат, ДанныеСертификата = Неопределено, ДанныеПодписи = Неопределено, ОтпечатокСертификата = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКООблачнаяПодписьВызовСервера.СтатусПодготовкиСертификата(Сертификат, ДанныеСертификата, ДанныеПодписи, ОтпечатокСертификата); +``` +
+ +## ПодготовитьСертификат +
+ +Описание, пример вызова + +```bsl + +// Проверяет легитимность использования сертификата для обмена с КО +// +// Параметры: +// ДанныеСертификата - ДвоичныеДанные - если передана структура, то она должна содержать поле "Отпечаток", служит +// полем поиска в регистре сведений "ХранилищеСертификатовПолучателей" +// ДанныеПодписи - Неопределено, ДвоичныеДанные - если Неопределено, то проверяется только издатель сертификата, иначе ожидается "голая" подпись +// +// Возвращаемое значение: +// Булево - Истина, если использование сертификата легитимно +// +Функция ПодготовитьСертификат(ДанныеСертификата, ДанныеПодписи = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКООблачнаяПодписьВызовСервера.ПодготовитьСертификат(ДанныеСертификата, ДанныеПодписи); +``` +
+ +## ПодготовитьСертификатСПараметрами +
+ +Описание, пример вызова + +```bsl + +// Обертка для функции ПодготовитьСертификат +// +// Параметры: +// ПараметрыОперации - Струтура - содержит следующие поля +// * Сертификат - Строка, Структура, ДвоичныеДанные - если передана структура, то она должна содержать поле "Отпечаток", служит +// полем поиска в регистре сведений "ХранилищеСертификатовПолучателей" +// * Подпись - Неопределено, ДвоичныеДанные - если Неопределено, то проверяется только издатель сертификата, иначе ожидается "голая" подпись +// +// Возвращаемое значение: +// Булево - Истина, если использование сертификата легитимно +// +Функция ПодготовитьСертификатСПараметрами(ПараметрыОперации, АдресРезультата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКООблачнаяПодписьВызовСервера.ПодготовитьСертификатСПараметрами(ПараметрыОперации, АдресРезультата); +``` +
+ +## ЗначениеХешГОСТ2012 +
+ +Описание, пример вызова + +```bsl + +// Выполняет расчет значения хеша с использованием алгоритма ГОСТ2012 +// +// Параметры: +// ТелоСодержимого - ДвоичныеДанные - содержимое для вычисления значения хеша +// ДлинаЗначения - Число - ожидаемые значения 256, 512 +// +// Возвращаемое значение: +// Строка - HEX представление вычисленного значения, для варианта 256 бит содержит 64 символа, для 512 бит - 128 символов +// +Функция ЗначениеХешГОСТ2012(ТелоСодержимого, ДлинаЗначения = 512) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКООблачнаяПодписьВызовСервера.ЗначениеХешГОСТ2012(ТелоСодержимого, ДлинаЗначения); +``` +
+ +## ПроверитьПодписьГОСТ2012 +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку подписи по стандарту ГОСТ2012 +// +// Параметры: +// ИсходныеДанные - ДвоичныеДанные - исходный содержимое документа +// ДанныеПодписи - ДвоичныеДанные - содержимое подписи +// СертификатПроверки - ДвоичныеДанные - содержит данные сертификата +// +// Возвращаемое значение: +// Булево - Истина, если проверка пройдена +// +Функция ПроверитьПодписьГОСТ2012(ИсходныеДанные, ДанныеПодписи, СертификатПроверки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСКООблачнаяПодписьВызовСервера.ПроверитьПодписьГОСТ2012(ИсходныеДанные, ДанныеПодписи, СертификатПроверки); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСКОПереопределяемый.md b/src/content/docs/zup/ДокументооборотСКОПереопределяемый.md new file mode 100644 index 0000000..19cf8f2 --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСКОПереопределяемый.md @@ -0,0 +1,205 @@ +--- +title: Документооборот СКО переопределяемый +slug: zup/документооборот-ско-переопределяемый +--- + + +## ПослеЗаписиДокументаРеализацииПолномочийНалоговыхОрганов +
+ +Описание, пример вызова + +```bsl + +// Срабатывает после записи объекта ДокументРеализацииПолномочийНалоговыхОрганов, когда уже записаны его файлы. +// +// Параметры: +// Ссылка - ДокументСсылка.ДокументРеализацииПолномочийНалоговыхОрганов - Входящее сообщение от ФНС +// Файлы - Массив структур - Массив описания вложений документа - структура +// * Адрес - Строка - Адрес во временном хранилище +// * ИмяФайла - Строка - Имя файла с расширением +// +Процедура ПослеЗаписиДокументаРеализацииПолномочийНалоговыхОрганов(Ссылка, Файлы) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОПереопределяемый.ПослеЗаписиДокументаРеализацииПолномочийНалоговыхОрганов(Ссылка, Файлы) +``` +
+ +## ПроверитьРеализованаСверкаИмущественныхНалогов +
+ +Описание, пример вызова + +```bsl + +// Определяет наличие в конфигурации-потребителе механизма сверки имущественных налогов. +// +// Параметры: +// РеализованаСверка - Булево - параметр будет установлен в Истина, если в конфигурации предусмотрена сверка +// +Процедура ПроверитьРеализованаСверкаИмущественныхНалогов(РеализованаСверка) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОПереопределяемый.ПроверитьРеализованаСверкаИмущественныхНалогов(РеализованаСверка) +``` +
+ +## КонфигурацияПоддерживаетТарифПромоЕНС +
+ +Описание, пример вызова + +```bsl + +// Указывает, поддерживает ли конфигурация тариф Промо ЕНС +// +// Параметры: +// Поддерживает - Булево - Если конфигурация поддерживает тариф Промо ЕНС, то присваивать Поддерживает = Истина +// +Процедура КонфигурацияПоддерживаетТарифПромоЕНС(Поддерживает) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОПереопределяемый.КонфигурацияПоддерживаетТарифПромоЕНС(Поддерживает) +``` +
+ +## КонфигурацияПоддерживаетПлатежныеПоручения +
+ +Описание, пример вызова + +```bsl + +// Указывает, поддерживает ли конфигурация возможность оформления платежных поручений +// +// Параметры: +// ПоддерживаетСоздание - Булево +// ПоддерживаетВыгрузку - Булево +// +Процедура КонфигурацияПоддерживаетПлатежныеПоручения(ПоддерживаетСоздание, ПоддерживаетВыгрузку) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОПереопределяемый.КонфигурацияПоддерживаетПлатежныеПоручения(ПоддерживаетСоздание, ПоддерживаетВыгрузку) +``` +
+ +## СформироватьПлатежныеПоручения +
+ +Описание, пример вызова + +```bsl + +// Формирует документы вида "Платежное поручение" на основе переданных реквизитов +// +// Параметры: +// ДокументКонтролирующегоОргана - Ссылка - ссылка на объект основание (справочник) +// РеквизитыПлатежныхПоручений - Массив из Структура +// * Организация - СправочникСсылка.Организации - плательщик +// * КодНО - Строка - код налогового органа +// * ИНН - Строка - ИНН организации, полученный в результате обработки исходных данных +// * КПП - Строка - КПП организации +// * Сумма - Число - сумма платежного поручения +// * КБК - Строка - код бюджетной классификации +// * ОКТМО - Строка +// * Статус - Строка - статус платежного поручения +// * УИН - Строка - идентификатор платежа +// * БИК - Строка - код банка получателя +// * БанкНаименование - Строка - наименование банка получателя +// * КоррСчет - Строка - корреспондентский счет банка получателя +// * РасчетныйСчет - Строка - расчетный счет получателя +// * ИННПолучателя - Строка - ИНН получателя платежа +// * КПППолучателя - Строка - КПП получателя платежа +// * НаименованиеПолучателя - Строка - наименование получателя +// МассивПлатежныхПоручений - Массив из Ссылка - ссылки на сформированные документы платежей в потребителе +// ТекстОшибки - Строка - описание ошибки, если не удалось сфомировать документы +// +Процедура СформироватьПлатежныеПоручения(ДокументКонтролирующегоОргана, РеквизитыПлатежныхПоручений, МассивПлатежныхПоручений, ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОПереопределяемый.СформироватьПлатежныеПоручения(ДокументКонтролирующегоОргана, РеквизитыПлатежныхПоручений, МассивПлатежныхПоручений, ТекстОшибки) +``` +
+ +## СкрытьЗаявленияЕГРЮЛ_ЕГРИП +
+ +Описание, пример вызова + +```bsl + +// Определяет, нужно ли скрывать элементы создания заявлений ЕГРЮЛ и ЕГРИП в форме 1С-Отчетность +// +// Параметры: +// Скрыть - Булево - По умолчанию = Ложь +// +Процедура СкрытьЗаявленияЕГРЮЛ_ЕГРИП(Скрыть) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОПереопределяемый.СкрытьЗаявленияЕГРЮЛ_ЕГРИП(Скрыть) +``` +
+ +## ОбновитьИЗаполнитьТребованияФНС +
+ +Описание, пример вызова + +```bsl + +// Обновляет уже созданные или создает новые задачи бухгалтера для требования ФНС. +// +// Параметры: +// Организация - СправочникСсылка.Организации - организация +// Дата - Дата - дата требования +// +Процедура ОбновитьИЗаполнитьТребованияФНС(Организация, Дата) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОПереопределяемый.ОбновитьИЗаполнитьТребованияФНС(Организация, Дата) +``` +
+ +## ЗарегистрироватьИзменениеСтатусаЗадачТребованиеФНС +
+ +Описание, пример вызова + +```bsl + +// Обновляет статус по задаче с требованием ФНС. +// +// Параметры: +// Ссылка - СправочникСсылка.ДокументыРеализацииПолномочийНалоговыхОрганов +// +Процедура ЗарегистрироватьИзменениеСтатусаЗадачТребованиеФНС(Ссылка) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСКОПереопределяемый.ЗарегистрироватьИзменениеСтатусаЗадачТребованиеФНС(Ссылка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСРПНКлиентСервер.md b/src/content/docs/zup/ДокументооборотСРПНКлиентСервер.md new file mode 100644 index 0000000..49474eb --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСРПНКлиентСервер.md @@ -0,0 +1,109 @@ +--- +title: Документооборот СРПН клиент сервер +slug: zup/документооборот-српн-клиент-сервер +--- + + +## УстановитьВидимостьГруппыКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьВидимостьГруппыКнопокОтправки(Форма, ПараметрыПрорисовкиКнопокОтправки) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСРПНКлиентСервер.УстановитьВидимостьГруппыКнопокОтправки(Форма, ПараметрыПрорисовкиКнопокОтправки) +``` +
+ +## ПриИнициализацииФормыРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ПриИнициализацииФормыРегламентированногоОтчета(Форма, ПараметрыПрорисовкиПанели = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСРПНКлиентСервер.ПриИнициализацииФормыРегламентированногоОтчета(Форма, ПараметрыПрорисовкиПанели); +``` +
+ +## ПараметрыПрорисовкиКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыПрорисовкиКнопокОтправки(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСРПНКлиентСервер.ПараметрыПрорисовкиКнопокОтправки(ОрганизацияСсылка) +``` +
+ +## ПолучитьПараметрыПрорисовкиПанелиОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПараметрыПрорисовкиПанелиОтправки(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСРПНКлиентСервер.ПолучитьПараметрыПрорисовкиПанелиОтправки(Форма) +``` +
+ +## СсылкаНаОтчетПоФорме +
+ +Описание, пример вызова + +```bsl + +Функция СсылкаНаОтчетПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСРПНКлиентСервер.СсылкаНаОтчетПоФорме(Форма) +``` +
+ +## ПолучитьОрганизациюПоФорме +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьОрганизациюПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСРПНКлиентСервер.ПолучитьОрганизациюПоФорме(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСФСРАРКлиентСервер.md b/src/content/docs/zup/ДокументооборотСФСРАРКлиентСервер.md new file mode 100644 index 0000000..ed72b06 --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСФСРАРКлиентСервер.md @@ -0,0 +1,109 @@ +--- +title: Документооборот с ФСРАР клиент сервер +slug: zup/документооборот-с-фсрар-клиент-сервер +--- + + +## УстановитьВидимостьГруппыКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьВидимостьГруппыКнопокОтправки(Форма, ПараметрыПрорисовкиКнопокОтправки) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСФСРАРКлиентСервер.УстановитьВидимостьГруппыКнопокОтправки(Форма, ПараметрыПрорисовкиКнопокОтправки) +``` +
+ +## ПриИнициализацииФормыРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ПриИнициализацииФормыРегламентированногоОтчета(Форма, ПараметрыПрорисовкиПанели = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСФСРАРКлиентСервер.ПриИнициализацииФормыРегламентированногоОтчета(Форма, ПараметрыПрорисовкиПанели); +``` +
+ +## ПараметрыПрорисовкиКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыПрорисовкиКнопокОтправки(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФСРАРКлиентСервер.ПараметрыПрорисовкиКнопокОтправки(ОрганизацияСсылка) +``` +
+ +## ПолучитьПараметрыПрорисовкиПанелиОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПараметрыПрорисовкиПанелиОтправки(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФСРАРКлиентСервер.ПолучитьПараметрыПрорисовкиПанелиОтправки(Форма) +``` +
+ +## СсылкаНаОтчетПоФорме +
+ +Описание, пример вызова + +```bsl + +Функция СсылкаНаОтчетПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФСРАРКлиентСервер.СсылкаНаОтчетПоФорме(Форма) +``` +
+ +## ПолучитьОрганизациюПоФорме +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьОрганизациюПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФСРАРКлиентСервер.ПолучитьОрганизациюПоФорме(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСФССКлиентСервер.md b/src/content/docs/zup/ДокументооборотСФССКлиентСервер.md new file mode 100644 index 0000000..0ee4dd8 --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСФССКлиентСервер.md @@ -0,0 +1,380 @@ +--- +title: Документооборот с ФСС клиент сервер +slug: zup/документооборот-с-фсс-клиент-сервер +--- + + +## УстановитьВидимостьГруппыКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьВидимостьГруппыКнопокОтправки(Форма, ПараметрыПрорисовкиКнопокОтправки) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСФССКлиентСервер.УстановитьВидимостьГруппыКнопокОтправки(Форма, ПараметрыПрорисовкиКнопокОтправки) +``` +
+ +## ПриИнициализацииФормыРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ПриИнициализацииФормыРегламентированногоОтчета(Форма, ПараметрыПрорисовкиПанели = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСФССКлиентСервер.ПриИнициализацииФормыРегламентированногоОтчета(Форма, ПараметрыПрорисовкиПанели); +``` +
+ +## ПараметрыПрорисовкиКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыПрорисовкиКнопокОтправки(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ПараметрыПрорисовкиКнопокОтправки(ОрганизацияСсылка) +``` +
+ +## ПриИзмененииОрганизацииВРегламентированномОтчете +
+ +Описание, пример вызова + +```bsl + +Процедура ПриИзмененииОрганизацииВРегламентированномОтчете(Форма) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСФССКлиентСервер.ПриИзмененииОрганизацииВРегламентированномОтчете(Форма) +``` +
+ +## ПолучитьПараметрыПрорисовкиПанелиОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПараметрыПрорисовкиПанелиОтправки(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ПолучитьПараметрыПрорисовкиПанелиОтправки(Форма) +``` +
+ +## СсылкаНаОтчетПоФорме +
+ +Описание, пример вызова + +```bsl + +Функция СсылкаНаОтчетПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.СсылкаНаОтчетПоФорме(Форма) +``` +
+ +## ПолучитьОрганизациюПоФорме +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьОрганизациюПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ПолучитьОрганизациюПоФорме(Форма) +``` +
+ +## ЭтоРеестрСведенийНаВыплатуПособийФСС +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает признак того, является ли документ, ссылка на который +// передается в параметре, реестром сведений ФСС на выплату пособий, +// предназначенным для формирования и отправки файла выгрузки в ФСС +// +// Параметры: +// Ссылка на документ. +// +// Результат: +// Булево. +// +Функция ЭтоРеестрСведенийНаВыплатуПособийФСС(ОбъектСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ЭтоРеестрСведенийНаВыплатуПособийФСС(ОбъектСсылка) +``` +
+ +## ЭтоРеестрДанныхЭЛНЗаполняемыхРаботодателем +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает признак того, является ли документ, ссылка на который +// передается в параметре, реестром данных ЭЛН, заполняемых работодателем, +// предназначенным для формирования и отправки файла выгрузки в ФСС +// +// Параметры: +// ОбъектСсылка - Ссылка на документ. +// ОбъектМетаданныхПоУмолчаниюСуществует - Булево. +// +// Результат: +// Булево. +// +Функция ЭтоРеестрДанныхЭЛНЗаполняемыхРаботодателем(ОбъектСсылка, ОбъектМетаданныхПоУмолчаниюСуществует = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ЭтоРеестрДанныхЭЛНЗаполняемыхРаботодателем(ОбъектСсылка, ОбъектМетаданныхПоУмолчаниюСуществует); +``` +
+ +## ЭтоРеестрСтимулирующихВыплатМедицинскимИСоциальнымРаботникам +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает признак того, является ли документ, ссылка на который +// передается в параметре, реестром стимулирующих выплат медицинским и социальным работникам +// +// Параметры: +// ОбъектСсылка - Ссылка на документ. +// ОбъектМетаданныхПоУмолчаниюСуществует - Булево. +// +// Результат: +// Булево. +// +Функция ЭтоРеестрСтимулирующихВыплатМедицинскимИСоциальнымРаботникам( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ЭтоРеестрСтимулирующихВыплатМедицинскимИСоциальнымРаботникам(); +``` +
+ +## ТипыСообщенийСЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ТипыСообщенийСЭДО(ВозвращатьСтроковыеПредставленияКодов = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ТипыСообщенийСЭДО(ВозвращатьСтроковыеПредставленияКодов); +``` +
+ +## ТипВзаимодействияСтраховательСЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ТипВзаимодействияСтраховательСЭДО() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ТипВзаимодействияСтраховательСЭДО() +``` +
+ +## ТипВзаимодействияОрганизацияСЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ТипВзаимодействияОрганизацияСЭДО() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ТипВзаимодействияОрганизацияСЭДО() +``` +
+ +## НастройкиМЧДФСС +
+ +Описание, пример вызова + +```bsl + +Функция НастройкиМЧДФСС() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.НастройкиМЧДФСС() +``` +
+ +## ТипВзаимодействияСЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ТипВзаимодействияСЭДО( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ТипВзаимодействияСЭДО(); +``` +
+ +## НастройкиТекстовЗапросовСЭДОФСС +
+ +Описание, пример вызова + +```bsl + +Функция НастройкиТекстовЗапросовСЭДОФСС() Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.НастройкиТекстовЗапросовСЭДОФСС() +``` +
+ +## ТекстПараметровТипаВзаимодействияСЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ТекстПараметровТипаВзаимодействияСЭДО(РегистрационныйНомерФСС, Настройки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ТекстПараметровТипаВзаимодействияСЭДО(РегистрационныйНомерФСС, Настройки) +``` +
+ +## ПараметрыОтправкиВидаДокументаЧерезСЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыОтправкиВидаДокументаЧерезСЭДО( Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ПараметрыОтправкиВидаДокументаЧерезСЭДО(); +``` +
+ +## ВыгрузкаПодтвержденияВидаДеятельностиДляСЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузкаПодтвержденияВидаДеятельностиДляСЭДО(ТекстВыгрузки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ВыгрузкаПодтвержденияВидаДеятельностиДляСЭДО(ТекстВыгрузки)); +``` +
+ +## Выгрузка4ФССДляСЭДО +
+ +Описание, пример вызова + +```bsl + +Функция Выгрузка4ФССДляСЭДО(ТекстВыгрузки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.Выгрузка4ФССДляСЭДО(ТекстВыгрузки)); +``` +
+ +## ВыгрузкаРеестраСтимулирующихВыплатМедицинскимИСоциальнымРаботникамДляСЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузкаРеестраСтимулирующихВыплатМедицинскимИСоциальнымРаботникамДляСЭДО(ТекстВыгрузки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФССКлиентСервер.ВыгрузкаРеестраСтимулирующихВыплатМедицинскимИСоциальнымРаботникамДляСЭДО(ТекстВыгрузки)); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументооборотСФТСКлиентСервер.md b/src/content/docs/zup/ДокументооборотСФТСКлиентСервер.md new file mode 100644 index 0000000..dbd7fc9 --- /dev/null +++ b/src/content/docs/zup/ДокументооборотСФТСКлиентСервер.md @@ -0,0 +1,109 @@ +--- +title: Документооборот с ФТС клиент сервер +slug: zup/документооборот-с-фтс-клиент-сервер +--- + + +## УстановитьВидимостьГруппыКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьВидимостьГруппыКнопокОтправки(Форма, ПараметрыПрорисовкиКнопокОтправки) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСФТСКлиентСервер.УстановитьВидимостьГруппыКнопокОтправки(Форма, ПараметрыПрорисовкиКнопокОтправки) +``` +
+ +## ПриИнициализацииФормыРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ПриИнициализацииФормыРегламентированногоОтчета(Форма, ПараметрыПрорисовкиПанели = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ДокументооборотСФТСКлиентСервер.ПриИнициализацииФормыРегламентированногоОтчета(Форма, ПараметрыПрорисовкиПанели); +``` +
+ +## ПараметрыПрорисовкиКнопокОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыПрорисовкиКнопокОтправки(ОрганизацияСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФТСКлиентСервер.ПараметрыПрорисовкиКнопокОтправки(ОрганизацияСсылка) +``` +
+ +## ПолучитьПараметрыПрорисовкиПанелиОтправки +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПараметрыПрорисовкиПанелиОтправки(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФТСКлиентСервер.ПолучитьПараметрыПрорисовкиПанелиОтправки(Форма) +``` +
+ +## СсылкаНаОтчетПоФорме +
+ +Описание, пример вызова + +```bsl + +Функция СсылкаНаОтчетПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФТСКлиентСервер.СсылкаНаОтчетПоФорме(Форма) +``` +
+ +## ПолучитьОрганизациюПоФорме +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьОрганизациюПоФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументооборотСФТСКлиентСервер.ПолучитьОрганизациюПоФорме(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДокументыФизическихЛицКлиентСервер.md b/src/content/docs/zup/ДокументыФизическихЛицКлиентСервер.md new file mode 100644 index 0000000..f6862ee --- /dev/null +++ b/src/content/docs/zup/ДокументыФизическихЛицКлиентСервер.md @@ -0,0 +1,139 @@ +--- +title: Документы физических лиц клиент сервер +slug: zup/документы-физических-лиц-клиент-сервер +--- + + +## ТипСерииДокументаУдостоверяющегоЛичность +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип серии документа удостоверяющего личность. +// +// Параметры: +// ВидДокумента - СправочникСсылка.ВидыДокументовФизическихЛиц +// +// Возвращаемое значение: +// Число - тип серии для документа, 0 - требований к серии нет. +// +Функция ТипСерииДокументаУдостоверяющегоЛичность(ВидДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументыФизическихЛицКлиентСервер.ТипСерииДокументаУдостоверяющегоЛичность(ВидДокумента) +``` +
+ +## ТипНомераДокументаУдостоверяющегоЛичность +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип номера документа удостоверяющего личность. +// +// Параметры: +// ВидДокумента - СправочникСсылка.ВидыДокументовФизическихЛиц +// +// Возвращаемое значение: +// Число - тип номера для документа, 0 - требований к номеру нет. +// +Функция ТипНомераДокументаУдостоверяющегоЛичность(ВидДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументыФизическихЛицКлиентСервер.ТипНомераДокументаУдостоверяющегоЛичность(ВидДокумента) +``` +
+ +## СерияДокументаУказанаПравильно +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что серия документа для переданного вида документа указана правильно. +// +// Параметры: +// ВидДокумента - СправочникСсылка.ВидыДокументовФизическихЛиц - вид документа, для которого необходимо +// проверить правильность серии. +// Серия - Строка - серия документа. +// ТекстОшибки - Строка - текст ошибки, если серия указана неправильно. +// +// Возвращаемое значение: +// Булево - результат проверки, Истина - правильно, Ложь - нет. +// +Функция СерияДокументаУказанаПравильно(ВидДокумента, Знач Серия , ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументыФизическихЛицКлиентСервер.СерияДокументаУказанаПравильно(ВидДокумента, Серия, ТекстОшибки) +``` +
+ +## НомерДокументаУказанПравильно +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что номер документа для переданного вида документа указан правильно. +// +// Параметры: +// ВидДокумента - СправочникСсылка.ВидыДокументовФизическихЛиц - вид документа, для которого необходимо +// проверить правильность номера. +// Номер - Строка - номер документа. +// ТекстОшибки - Строка - текст ошибки, если номер указан неправильно. +// +// Возвращаемое значение: +// Булево - результат проверки, Истина - правильно, Ложь - нет. +// +Функция НомерДокументаУказанПравильно(ВидДокумента, Знач Номер, ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументыФизическихЛицКлиентСервер.НомерДокументаУказанПравильно(ВидДокумента, Номер, ТекстОшибки) +``` +
+ +## МаскаВводаКодаПодразделения +
+ +Описание, пример вызова + +```bsl + +// Возвращает маску для поля ввода кода подразделения +// +// Параметры: +// ВидДокумента - СправочникСсылка.ВидыДокументовФизическихЛиц - вид документа. +// +// Возвращаемое значение: +// Строка +// +Функция МаскаВводаКодаПодразделения(ВидДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = ДокументыФизическихЛицКлиентСервер.МаскаВводаКодаПодразделения(ВидДокумента) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДолжностиБЗК.md b/src/content/docs/zup/ДолжностиБЗК.md new file mode 100644 index 0000000..36c50f9 --- /dev/null +++ b/src/content/docs/zup/ДолжностиБЗК.md @@ -0,0 +1,98 @@ +--- +title: Должности БЗК +slug: zup/должности-бзк +--- + + +## РеквизитыРедактируемыеВГрупповойОбработке +
+ +Описание, пример вызова + +```bsl + +// Возвращает реквизиты объекта, которые разрешается редактировать +// с помощью обработки группового изменения реквизитов. +// +// Возвращаемое значение: +// Массив - список имен реквизитов объекта. +Функция РеквизитыРедактируемыеВГрупповойОбработке() Экспорт +``` + +Пример вызова +```bsl +Результат = ДолжностиБЗК.РеквизитыРедактируемыеВГрупповойОбработке() +``` +
+ +## ОбработкаПолученияДанныхВыбора +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПолученияДанныхВыбора(ДанныеВыбора, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗК.ОбработкаПолученияДанныхВыбора(ДанныеВыбора, Параметры, СтандартнаяОбработка) +``` +
+ +## ЗаполнитьДополнительныеСведенияКлассификатора +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьДополнительныеСведенияКлассификатора(ДолжностьОбъект, ДополнительныеСведения) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗК.ЗаполнитьДополнительныеСведенияКлассификатора(ДолжностьОбъект, ДополнительныеСведения) +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПроверкиЗаполнения(ДолжностьОбъект, ПроверяемыеРеквизиты, Отказ) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗК.ОбработкаПроверкиЗаполнения(ДолжностьОбъект, ПроверяемыеРеквизиты, Отказ) +``` +
+ +## ПередЗаписью +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗаписью(ДолжностьОбъект, Отказ) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗК.ПередЗаписью(ДолжностьОбъект, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДолжностиБЗКБазовый.md b/src/content/docs/zup/ДолжностиБЗКБазовый.md new file mode 100644 index 0000000..1d9d58e --- /dev/null +++ b/src/content/docs/zup/ДолжностиБЗКБазовый.md @@ -0,0 +1,30 @@ +--- +title: Должности БЗК базовый +slug: zup/должности-бзк-базовый +--- + + +## РеквизитыРедактируемыеВГрупповойОбработке +
+ +Описание, пример вызова + +```bsl + +// См. ДолжностиБЗК.РеквизитыРедактируемыеВГрупповойОбработке. +Функция РеквизитыРедактируемыеВГрупповойОбработке() Экспорт +``` + +Пример вызова +```bsl +Результат = ДолжностиБЗКБазовый.РеквизитыРедактируемыеВГрупповойОбработке() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДолжностиБЗКВнутренний.md b/src/content/docs/zup/ДолжностиБЗКВнутренний.md new file mode 100644 index 0000000..dffc943 --- /dev/null +++ b/src/content/docs/zup/ДолжностиБЗКВнутренний.md @@ -0,0 +1,94 @@ +--- +title: Должности БЗК внутренний +slug: zup/должности-бзк-внутренний +--- + + +## РеквизитыРедактируемыеВГрупповойОбработке +
+ +Описание, пример вызова + +```bsl + +// См. ДолжностиБЗК.РеквизитыРедактируемыеВГрупповойОбработке. +Функция РеквизитыРедактируемыеВГрупповойОбработке() Экспорт +``` + +Пример вызова +```bsl +Результат = ДолжностиБЗКВнутренний.РеквизитыРедактируемыеВГрупповойОбработке() +``` +
+ +## ОбработкаПолученияДанныхВыбора +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПолученияДанныхВыбора(ДанныеВыбора, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗКВнутренний.ОбработкаПолученияДанныхВыбора(ДанныеВыбора, Параметры, СтандартнаяОбработка) +``` +
+ +## ЗаполнитьДополнительныеСведенияКлассификатора +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьДополнительныеСведенияКлассификатора(ДолжностьОбъект, ДополнительныеСведения) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗКВнутренний.ЗаполнитьДополнительныеСведенияКлассификатора(ДолжностьОбъект, ДополнительныеСведения) +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПроверкиЗаполнения(ДолжностьОбъект, ПроверяемыеРеквизиты, Отказ) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗКВнутренний.ОбработкаПроверкиЗаполнения(ДолжностьОбъект, ПроверяемыеРеквизиты, Отказ) +``` +
+ +## ПередЗаписью +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗаписью(ДолжностьОбъект, Отказ) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗКВнутренний.ПередЗаписью(ДолжностьОбъект, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДолжностиБЗКРасширенный.md b/src/content/docs/zup/ДолжностиБЗКРасширенный.md new file mode 100644 index 0000000..228eaae --- /dev/null +++ b/src/content/docs/zup/ДолжностиБЗКРасширенный.md @@ -0,0 +1,104 @@ +--- +title: Должности БЗК расширенный +slug: zup/должности-бзк-расширенный +--- + + +## РеквизитыРедактируемыеВГрупповойОбработке +
+ +Описание, пример вызова + +```bsl + +// См. ДолжностиБЗК.РеквизитыРедактируемыеВГрупповойОбработке. +Функция РеквизитыРедактируемыеВГрупповойОбработке() Экспорт +``` + +Пример вызова +```bsl +Результат = ДолжностиБЗКРасширенный.РеквизитыРедактируемыеВГрупповойОбработке() +``` +
+ +## ИмяПланаВидовПодключаемыхХарактеристикЗарплатаКадры +
+ +Описание, пример вызова + +```bsl + +// ЗарплатаКадрыРасширеннаяПодсистемы.ПодключаемыеХарактеристики + +// Возвращает имя плана видов характеристик, +// в котором хранятся подключаемые характеристики экземпляров этого типа. +// +// Возвращаемое значение: +// Строка - имя плана видов характеристик. +// +Функция ИмяПланаВидовПодключаемыхХарактеристикЗарплатаКадры() Экспорт +``` + +Пример вызова +```bsl +Результат = ДолжностиБЗКРасширенный.ИмяПланаВидовПодключаемыхХарактеристикЗарплатаКадры() +``` +
+ +## ОбработкаПолученияДанныхВыбора +
+ +Описание, пример вызова + +```bsl + +// Конец ЗарплатаКадрыРасширеннаяПодсистемы.ПодключаемыеХарактеристики + +Процедура ОбработкаПолученияДанныхВыбора(ДанныеВыбора, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗКРасширенный.ОбработкаПолученияДанныхВыбора(ДанныеВыбора, Параметры, СтандартнаяОбработка) +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаПроверкиЗаполнения(ДолжностьОбъект, ПроверяемыеРеквизиты, Отказ) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗКРасширенный.ОбработкаПроверкиЗаполнения(ДолжностьОбъект, ПроверяемыеРеквизиты, Отказ) +``` +
+ +## ПередЗаписью +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗаписью(ДолжностьОбъект, Отказ) Экспорт +``` + +Пример вызова +```bsl +ДолжностиБЗКРасширенный.ПередЗаписью(ДолжностьОбъект, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ДополнительныеОтчетыИОбработкиВызовСервера.md b/src/content/docs/zup/ДополнительныеОтчетыИОбработкиВызовСервера.md new file mode 100644 index 0000000..52a158c --- /dev/null +++ b/src/content/docs/zup/ДополнительныеОтчетыИОбработкиВызовСервера.md @@ -0,0 +1,66 @@ +--- +title: Дополнительные отчеты и обработки вызов сервера +slug: zup/дополнительные-отчеты-и-обработки-вызов-сервера +--- + + +## ПодключитьВнешнююОбработку +
+ +Описание, пример вызова + +```bsl + +// Подключает внешнюю обработку (отчет). +// Подробнее см. ДополнительныеОтчетыИОбработки.ПодключитьВнешнююОбработку. +// +// Параметры: +// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - подключаемая обработка. +// +// Возвращаемое значение: +// Строка - имя подключенного отчета или обработки. +// Неопределено - если передана некорректная ссылка. +// +Функция ПодключитьВнешнююОбработку(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиВызовСервера.ПодключитьВнешнююОбработку(Ссылка) +``` +
+ +## ОбъектВнешнейОбработки +
+ +Описание, пример вызова + +```bsl + +// Создает и возвращает экземпляр внешней обработки (отчета). +// Подробнее см. ДополнительныеОтчетыИОбработки.ОбъектВнешнейОбработки. +// +// Параметры: +// Ссылка - СправочникСсылка.ДополнительныеОтчетыИОбработки - подключаемый отчет или обработка. +// +// Возвращаемое значение: +// ВнешняяОбработка +// ВнешнийОтчет +// Неопределено - если передана некорректная ссылка. +// +Функция ОбъектВнешнейОбработки(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ДополнительныеОтчетыИОбработкиВызовСервера.ОбъектВнешнейОбработки(Ссылка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЖурналРегистрацииВызовСервера.md b/src/content/docs/zup/ЖурналРегистрацииВызовСервера.md new file mode 100644 index 0000000..f408a0c --- /dev/null +++ b/src/content/docs/zup/ЖурналРегистрацииВызовСервера.md @@ -0,0 +1,40 @@ +--- +title: Журнал регистрации вызов сервера +slug: zup/журнал-регистрации-вызов-сервера +--- + + +## ЗаписатьСобытияВЖурналРегистрации +
+ +Описание, пример вызова + +```bsl + +// Процедура пакетной записи сообщений в журнал регистрации. +// После записи переменная СобытияДляЖурналаРегистрации очищается. +// +// Параметры: +// СобытияДляЖурналаРегистрации - СписокЗначений - где Значение - структура со свойствами: +// * ИмяСобытия - Строка - имя записываемого события. +// * ПредставлениеУровня - Строка - представление значений коллекции УровеньЖурналаРегистрации. +// Доступные значения: "Информация", "Ошибка", "Предупреждение", "Примечание". +// * Комментарий - Строка - комментарий события. +// * ДатаСобытия - Дата - дата события, подставляется в комментарий при записи. +// +Процедура ЗаписатьСобытияВЖурналРегистрации(СобытияДляЖурналаРегистрации) Экспорт +``` + +Пример вызова +```bsl +ЖурналРегистрацииВызовСервера.ЗаписатьСобытияВЖурналРегистрации(СобытияДляЖурналаРегистрации) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗаймыСотрудникам.md b/src/content/docs/zup/ЗаймыСотрудникам.md new file mode 100644 index 0000000..9e862e7 --- /dev/null +++ b/src/content/docs/zup/ЗаймыСотрудникам.md @@ -0,0 +1,204 @@ +--- +title: Займы сотрудникам +slug: zup/займы-сотрудникам +--- + + +## ЗарегистрироватьПредоставлениеЗайма +
+ +Описание, пример вызова + +```bsl + +// Метод регистрирует во взаиморасчетах выдачу займа (или очередного транша) сотруднику. +// Может быть использован кассовыми документами +// для регистрации операции по займам сотрудникам. +// +// Параметры: +// - Движения - коллекция движений документа. +// - Договор - ссылка на договор займа (документ). +// - Сумма - выданная сумма +// - ДатаПредоставления - дата операции. +// - Организация +// - ФизическоеЛицо +// - Отказ. +// +Процедура ЗарегистрироватьПредоставлениеЗайма(Движения, Договор, Сумма, ДатаПредоставления, Организация, ФизическоеЛицо, Отказ) Экспорт +``` + +Пример вызова +```bsl +ЗаймыСотрудникам.ЗарегистрироватьПредоставлениеЗайма(Движения, Договор, Сумма, ДатаПредоставления, Организация, ФизическоеЛицо, Отказ) +``` +
+ +## ЗарегистрироватьЧастичноПогашенныйЗаем +
+ +Описание, пример вызова + +```bsl + +// Метод регистрирует во взаиморасчетах частичное погашение займа сотрудником. +// +// Параметры: +// - Движения - коллекция движений документа. +// - Договор - ссылка на договор займа (документ). +// - СуммаЗайма - погашенная сумма. +// - Проценты - сумма погашенных процентов. +// - ДатаРегистрации - дата операции. +// - Организация +// - ФизическоеЛицо +// - Отказ. +// +Процедура ЗарегистрироватьЧастичноПогашенныйЗаем(Движения, Договор, СуммаЗайма, Проценты, ДатаРегистрации, Организация, ФизическоеЛицо, Отказ) Экспорт +``` + +Пример вызова +```bsl +ЗаймыСотрудникам.ЗарегистрироватьЧастичноПогашенныйЗаем(Движения, Договор, СуммаЗайма, Проценты, ДатаРегистрации, Организация, ФизическоеЛицо, Отказ) +``` +
+ +## ЗарегистрироватьПогашениеЗайма +
+ +Описание, пример вызова + +```bsl + +// Метод регистрирует внеочередное погашение займа сотруднику. +// Внеочередные погашения отличаются от погашения из зарплаты тем, +// что они не уменьшают сумму ежемесячного платежа. +// +// Может быть использован кассовыми документами +// для регистрации операции по займам сотрудникам. +// +// Параметры: +// - Движения - коллекция движений документа. +// - Договор - ссылка на договор займа (документ). +// - Сумма - внесенная сумма +// - ДатаПогашения - дата операции. +// - Организация +// - ФизическоеЛицо +// - Регистратор - ссылка на документ-владелец движений. +// - Отказ. +// +Процедура ЗарегистрироватьПогашениеЗайма(Движения, Договор, Сумма, ДатаПогашения, Организация, ФизическоеЛицо, Регистратор, Отказ) Экспорт +``` + +Пример вызова +```bsl +ЗаймыСотрудникам.ЗарегистрироватьПогашениеЗайма(Движения, Договор, Сумма, ДатаПогашения, Организация, ФизическоеЛицо, Регистратор, Отказ) +``` +
+ +## ОстатокЗадолженности +
+ +Описание, пример вызова + +```bsl + +// Определяет полный остаток задолженности по договору займа. +// +// Параметры: +// - Договор - договор займа (ссылка на документ). +// - ДатаАктуальности - дата, на которую определяется задолженность. +// - Регистратор - необязательный, позволяет исключить движения отдельного регистратора. +// +// Возвращаемое значение - структура с полями ОбщаяСумма, СуммаЗайма, Проценты, Валюта. +// +Функция ОстатокЗадолженности(Договор, ДатаАктуальности, Регистратор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗаймыСотрудникам.ОстатокЗадолженности(Договор, ДатаАктуальности, Регистратор); +``` +
+ +## ИнформацияОЗадолженности +
+ +Описание, пример вызова + +```bsl + +// Формирует информационный текст, содержащий сведения о состоянии задолженности. +// +// Параметры: +// - Договор - договор займа (ссылка на документ). +// - ДатаДокумента - дата, на которую определяется задолженность. +// - ДокументСсылка - необязательный, позволяет исключить движения отдельного регистратора. +// +// Возвращаемое значение - строка. +// +Функция ИнформацияОЗадолженности(Договор, ДатаДокумента, ДокументСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗаймыСотрудникам.ИнформацияОЗадолженности(Договор, ДатаДокумента, ДокументСсылка) +``` +
+ +## ДействующиеДоговорыЗаймаПоФизическомуЛицу +
+ +Описание, пример вызова + +```bsl + +// Получает действующие договоры займа по физическому лица на указанную дату. +// +// Параметры: +// - Организация +// - ФизическоеЛицо +// - ДатаАктуальности - необязательный, дата, на которую требуется получить действующие договоры. +// - ВключатьНевыданныеДоговоры - необязательный, указывает на необходимость включить в выборку договора, по которым +// не выдано ни одного транша. +// +Функция ДействующиеДоговорыЗаймаПоФизическомуЛицу(Организация, ФизическоеЛицо, ДатаАктуальности = Неопределено, ВключатьНевыданныеДоговоры = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗаймыСотрудникам.ДействующиеДоговорыЗаймаПоФизическомуЛицу(Организация, ФизическоеЛицо, ДатаАктуальности, ВключатьНевыданныеДоговоры); +``` +
+ +## ИзмененияУсловийЗаймаЗаМесяц +
+ +Описание, пример вызова + +```bsl + +// Определяет изменения условий договора займа за месяц +// +// Параметры: +// - Договор - договор займа (ссылка на документ). +// - Регистратор - изменение договора займа (ссылка на документ), убирает движения регистратора. +// - ДатаАктуальности - необязательный, дата до которой определяются изменения условий за месяц. +// +// Возвращаемое значение - массив соответствий с полями ДатаИзменений, ПроцентнаяСтавка, +// РазмерПлатежа, РазмерПогашения, КоличествоДней. +// +Функция ИзмененияУсловийЗаймаЗаМесяц(Договор, Регистратор, ДатаАктуальности = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗаймыСотрудникам.ИзмененияУсловийЗаймаЗаМесяц(Договор, Регистратор, ДатаАктуальности); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗаполнениеСтатистическойОтчетности.md b/src/content/docs/zup/ЗаполнениеСтатистическойОтчетности.md new file mode 100644 index 0000000..2c32af3 --- /dev/null +++ b/src/content/docs/zup/ЗаполнениеСтатистическойОтчетности.md @@ -0,0 +1,109 @@ +--- +title: Заполнение статистической отчетности +slug: zup/заполнение-статистической-отчетности +--- + + +## ЗаполнитьДаннымиПредидущегоПериодаПоДокументу +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьДаннымиПредидущегоПериодаПоДокументу(Форма, МакетПереноса, ДанныеПП) Экспорт +``` + +Пример вызова +```bsl +ЗаполнениеСтатистическойОтчетности.ЗаполнитьДаннымиПредидущегоПериодаПоДокументу(Форма, МакетПереноса, ДанныеПП)); +``` +
+ +## ЗаполнитьМногострочнымиДаннымиПредидущегоПериодаПоДокументу +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьМногострочнымиДаннымиПредидущегоПериодаПоДокументу(Форма, МакетПереноса, ДанныеПП) Экспорт +``` + +Пример вызова +```bsl +ЗаполнениеСтатистическойОтчетности.ЗаполнитьМногострочнымиДаннымиПредидущегоПериодаПоДокументу(Форма, МакетПереноса, ДанныеПП)); +``` +
+ +## ПолучитьДокументПредидущегоПериода +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьДокументПредидущегоПериода(ИсточникОтчета, Организация, Начало, Конец, ТекстОписанияПроблемы, ОбособленноеПодразделение) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗаполнениеСтатистическойОтчетности.ПолучитьДокументПредидущегоПериода(ИсточникОтчета, Организация, Начало, Конец, ТекстОписанияПроблемы, ОбособленноеПодразделение)); +``` +
+ +## ПолучитьДокументыПредидущихПериодов +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьДокументыПредидущихПериодов(Форма, МакетПереноса, ТекстОписанияПроблемы, ОбособленноеПодразделение) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗаполнениеСтатистическойОтчетности.ПолучитьДокументыПредидущихПериодов(Форма, МакетПереноса, ТекстОписанияПроблемы, ОбособленноеПодразделение)); +``` +
+ +## ПолучитьДатуПоФормуле +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьДатуПоФормуле(ИсходноеЗначение, Формула) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗаполнениеСтатистическойОтчетности.ПолучитьДатуПоФормуле(ИсходноеЗначение, Формула)); +``` +
+ +## ВсеКлючиВСтрокеЗаполнены +
+ +Описание, пример вызова + +```bsl + +Функция ВсеКлючиВСтрокеЗаполнены(СтрокаТаблицы, Ключи) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗаполнениеСтатистическойОтчетности.ВсеКлючиВСтрокеЗаполнены(СтрокаТаблицы, Ключи)); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадры.md b/src/content/docs/zup/ЗарплатаКадры.md new file mode 100644 index 0000000..6380d13 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадры.md @@ -0,0 +1,618 @@ +--- +title: Зарплата кадры +slug: zup/зарплата-кадры +--- + + +## ОрганизацииФормаЭлементаПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Выполняет действия в форме Организации, связанные с зарплатно-кадровой спецификой. +// Вызов процедуры необходимо выполнять в обработчике ПриСозданииНаСервере +// формы организации. +Процедура ОрганизацииФормаЭлементаПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ОрганизацииФормаЭлементаПриСозданииНаСервере(Форма) +``` +
+ +## ОрганизацииФормаЭлементаПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Выполняет действия в форме Организации, связанные с зарплатно-кадровой спецификой. +// Вызов процедуры необходимо выполнять в обработчике ПриЧтенииНаСервере +// формы организации. +Процедура ОрганизацииФормаЭлементаПриЧтенииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ОрганизацииФормаЭлементаПриЧтенииНаСервере(Форма) +``` +
+ +## ОрганизацииФормаЭлементаПередЗаписьюНаСервере +
+ +Описание, пример вызова + +```bsl + +// Выполняет действия в форме Организации, связанные с зарплатно-кадровой спецификой. +// Вызов процедуры необходимо выполнять в обработчике ПередЗаписьюНаСервере +// формы организации. +Процедура ОрганизацииФормаЭлементаПередЗаписьюНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ОрганизацииФормаЭлементаПередЗаписьюНаСервере(Форма) +``` +
+ +## ОрганизацииФормаЭлементаПослеЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Выполняет действия в форме Организации, связанные с зарплатно-кадровой спецификой. +// Вызов процедуры необходимо выполнять в обработчике ПослеЗаписиНаСервере +// формы организации. +Процедура ОрганизацииФормаЭлементаПослеЗаписиНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ОрганизацииФормаЭлементаПослеЗаписиНаСервере(Форма) +``` +
+ +## ОрганизацииФормаЭлементаОбработкаПроверкиЗаполненияНаСервере +
+ +Описание, пример вызова + +```bsl + +// Выполняет действия в форме Организации, связанные с зарплатно-кадровой спецификой. +// Вызов процедуры необходимо выполнять в обработчике ОбработкаПроверкиЗаполненияНаСервере +// формы организации. +Процедура ОрганизацииФормаЭлементаОбработкаПроверкиЗаполненияНаСервере(Форма, Отказ) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ОрганизацииФормаЭлементаОбработкаПроверкиЗаполненияНаСервере(Форма, Отказ) +``` +
+ +## ЗарегистрироватьОплатуВедомостей +
+ +Описание, пример вызова + +```bsl + +// Регистрация оплаты ведомостей. +// +// Параметры: +// ПлатежныйДокумент - ДокументОбъект - платежный документ. +// Организация - СправочникСсылка.Организации - организация, выплачивающая зарплату. +// Ведомости - Массив - оплачиваемые ведомости (ОпределяемыйТип.ВедомостьЗарплатаКадры) +// ФизическиеЛица - Массив - физические лица (СправочникСсылка.ФизическиеЛица), получившие выплаты по ведомостям +// ДатаОперации - Дата - дата фактического выполнения оплаты. Если не указана, используется дата платежного документа. +// Отказ - Булево - признак отказа от выполнения операции. +// +Процедура ЗарегистрироватьОплатуВедомостей(ПлатежныйДокумент, Организация, Ведомости, ФизическиеЛица = Неопределено, ДатаОперации = Неопределено, Отказ = Ложь) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЗарегистрироватьОплатуВедомостей(ПлатежныйДокумент, Организация, Ведомости, ФизическиеЛица, ДатаОперации, Отказ); +``` +
+ +## ЗаполнитьНаборыПоОрганизацииИСотрудникам +
+ +Описание, пример вызова + +```bsl + +// Выполняет формирование таблицы с набором значений доступа объекта (документа), +// содержащего ссылки на организацию и сотрудника (сотрудников). +// Вызывается из процедуры ЗаполнитьНаборыЗначенийДоступа, реализованной в модуле таких +// документов, доступ к которым выполняется через наборы значений доступа. +// Параметры: +// Объект +// Таблица - переданная таблица значений. +// ПутьОрганизация - строка с именем реквизита, содержащего организацию. +// ПутьСотрудник - строка с именем реквизита, содержащего сотрудника. +// Может быть идентификатором реквизита объекта (например, "Сотрудник") или +// путем к реквизиту табличной части в +// формате <ИмяТабличнойЧасти>.<ИмяРеквизита> +// (например, "Начисления.Сотрудник"). +// +Процедура ЗаполнитьНаборыПоОрганизацииИСотрудникам(Объект, Таблица, ПутьОрганизация, ПутьСотрудник) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЗаполнитьНаборыПоОрганизацииИСотрудникам(Объект, Таблица, ПутьОрганизация, ПутьСотрудник) +``` +
+ +## СписокЗастрахованныхЛицОрганизацииЗаОтчетныйПериодПФР +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает сведения о сотрудниках (застрахованных в ПФР), работавших в организации в указанном отчетном +// периоде. +// +// Параметры: +// Организация - СправочникСсылка.Организации, организация (головная, +// либо обособленное подразделение с выделенным балансом) +// по которой требуется получить сведения. +// ОтчетныйПериод - дата, определяет отчетный период ПФР (квартал). +// +// Возвращаемое значение: +// ТаблицаЗначений с колонками "Фамилия", "Имя", "Отчество" и "СтраховойНомерПФР", в которых +// содержится информация о фамилии, имени, отчестве и страховом номере (СНИЛС) каждого +// из сотрудников (застрахованных лиц) организации соответственно. +// +Функция СписокЗастрахованныхЛицОрганизацииЗаОтчетныйПериодПФР(Организация, ОтчетныйПериод) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.СписокЗастрахованныхЛицОрганизацииЗаОтчетныйПериодПФР(Организация, ОтчетныйПериод) +``` +
+ +## РегистрацияВНалоговомОргане +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на "Регистрацию в налоговом органе" по состоянию на некоторую ДатаАктуальности. +// +// Параметры: +// СтруктурнаяЕдиница - организация или подразделение. +// ДатаАктуальности - дата, на которую берется регистрация в налоговом органе. +// +// Возвращаемое значение: +// СправочникСсылка.РегистрацииВНалоговомОргане +// +Функция РегистрацияВНалоговомОргане(СтруктурнаяЕдиница, Знач ДатаАктуальности = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.РегистрацияВНалоговомОргане(СтруктурнаяЕдиница, ДатаАктуальности); +``` +
+ +## РегистрацияВНалоговомОрганеОрганизации +
+ +Описание, пример вызова + +```bsl + +// Используется для получения ссылки на регистрацию в налоговом органе организации. +// +// Параметры: +// Организация - СправочникСсылка.Организации - организация, для которой нужно получить регистрацию. +// ДатаАктуальности - Дата - дата, на которую необходимо получить регистрацию в НО. +// +// Возвращаемое значение: +// СправочникСсылка.РегистрацииВНалоговомОргане - ссылка на существующую регистрацию, либо ПустаяСсылка(). +// +Функция РегистрацияВНалоговомОрганеОрганизации(Организация, Знач ДатаАктуальности = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.РегистрацияВНалоговомОрганеОрганизации(Организация, ДатаАктуальности); +``` +
+ +## РегистрацияВНалоговомОрганеПодразделения +
+ +Описание, пример вызова + +```bsl + +// Используется для получения ссылки на регистрацию в налоговом органе подразделения. +// +// Параметры: +// ПодразделениеОрганизации - СправочникСсылка.ПодразделенияОрганизаций - подразделение, для которого нужно получить регистрацию. +// ДатаАктуальности - Дата - дата, на которую необходимо получить +// регистрацию в НО. +// +// Возвращаемое значение: +// СправочникСсылка.РегистрацииВНалоговомОргане - ссылка на существующую регистрацию, либо ПустаяСсылка(). +// +Функция РегистрацияВНалоговомОрганеПодразделения(ПодразделениеОрганизации, Знач ДатаАктуальности = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.РегистрацияВНалоговомОрганеПодразделения(ПодразделениеОрганизации, ДатаАктуальности); +``` +
+ +## ИспользоватьСтатьиФинансированияЗарплата +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает значение настройки использования учета по статьям финансирования. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользоватьСтатьиФинансированияЗарплата() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.ИспользоватьСтатьиФинансированияЗарплата() +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииПраваОбработкиЭД +
+ +Описание, пример вызова + +```bsl + +// ЭлектронноеВзаимодействие + +// Устарела в версии БЭД 1.3.10. См. ЭлектронноеВзаимодействиеПереопределяемый.ЕстьПравоОбработкиЭД. +Функция ЭлектронноеВзаимодействиеПриОпределенииПраваОбработкиЭД() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииПраваОбработкиЭД() +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииПраваЧтенияЭД +
+ +Описание, пример вызова + +```bsl + +// Устарела в версии БЭД 1.3.10. См. ЭлектронноеВзаимодействиеПереопределяемый.ЕстьПравоЧтенияЭД. +Функция ЭлектронноеВзаимодействиеПриОпределенииПраваЧтенияЭД() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииПраваЧтенияЭД() +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииСоответствияСправочников +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЭлектронноеВзаимодействиеБЗК.ПолучитьСоответствиеСправочников +// См. ЭлектронноеВзаимодействиеПереопределяемый.ПолучитьСоответствиеСправочников. +Процедура ЭлектронноеВзаимодействиеПриОпределенииСоответствияСправочников(СоответствиеСправочников) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииСоответствияСправочников(СоответствиеСправочников) +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииСоответствияФункциональныхОпций +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЭлектронноеВзаимодействиеБЗК.ПолучитьСоответствиеФункциональныхОпций +// См. ЭлектронноеВзаимодействиеПереопределяемый.ПолучитьСоответствиеФункциональныхОпций. +Процедура ЭлектронноеВзаимодействиеПриОпределенииСоответствияФункциональныхОпций(СоответствиеФО) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииСоответствияФункциональныхОпций(СоответствиеФО) +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииТекстаСообщенияОНеобходимостиНастройкиСистемы +
+ +Описание, пример вызова + +```bsl + +// Устарела в версии БЭД 1.7.2. Следует отказаться от использования. +Процедура ЭлектронноеВзаимодействиеПриОпределенииТекстаСообщенияОНеобходимостиНастройкиСистемы(ВидОперации, ТекстСообщения) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииТекстаСообщенияОНеобходимостиНастройкиСистемы(ВидОперации, ТекстСообщения) +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииСообщенияОбОшибке +
+ +Описание, пример вызова + +```bsl + +// Устарела в версии БЭД 1.7.2. Следует отказаться от использования. +Процедура ЭлектронноеВзаимодействиеПриОпределенииСообщенияОбОшибке(КодОшибки, ТекстОшибки) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииСообщенияОбОшибке(КодОшибки, ТекстОшибки) +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииСсылкиНаОбъект +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЭлектронноеВзаимодействиеБЗК.НайтиСсылкуНаОбъект +// См. ЭлектронноеВзаимодействиеПереопределяемый.НайтиСсылкуНаОбъект. +Процедура ЭлектронноеВзаимодействиеПриОпределенииСсылкиНаОбъект(ТипОбъекта, Результат, ИдОбъекта, ДополнительныеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииСсылкиНаОбъект(ТипОбъекта, Результат, ИдОбъекта, ДополнительныеРеквизиты) +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииПечатногоНомераДокумента +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЭлектронноеВзаимодействиеБЗК.ПолучитьПечатныйНомерДокумента +// См. ЭлектронноеВзаимодействиеПереопределяемый.ПолучитьПечатныйНомерДокумента. +Функция ЭлектронноеВзаимодействиеПриОпределенииПечатногоНомераДокумента(СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииПечатногоНомераДокумента(СсылкаНаОбъект) +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииГотовностиИсточников +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЭлектронноеВзаимодействиеБЗК.ПроверитьГотовностьИсточников +// См. ЭлектронноеВзаимодействиеПереопределяемый.ПроверитьГотовностьИсточников. +Процедура ЭлектронноеВзаимодействиеПриОпределенииГотовностиИсточников(ДокументыМассив, ФормаИсточник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииГотовностиИсточников(ДокументыМассив, ФормаИсточник); +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииДанныхЮрФизЛица +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЭлектронноеВзаимодействиеБЗК.ПолучитьДанныеЮрФизЛица +// См. ЭлектронноеВзаимодействиеПереопределяемый.ПолучитьДанныеЮрФизЛица. +Функция ЭлектронноеВзаимодействиеПриОпределенииДанныхЮрФизЛица(ЮрФизЛицо) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииДанныхЮрФизЛица(ЮрФизЛицо) +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииПраваОткрытияЖурналаРегистрации +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЭлектронноеВзаимодействиеБЗК.ЕстьПравоОткрытияЖурналаРегистрации +// См. ЭлектронноеВзаимодействиеПереопределяемый.ЕстьПравоОткрытияЖурналаРегистрации. +Функция ЭлектронноеВзаимодействиеПриОпределенииПраваОткрытияЖурналаРегистрации() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииПраваОткрытияЖурналаРегистрации() +``` +
+ +## ЭлектронноеВзаимодействиеПриОпределенииОписанияОрганизации +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ЭлектронноеВзаимодействиеБЗК.ОписаниеОрганизации +// См. ЭлектронноеВзаимодействиеПереопределяемый.ОписаниеОрганизации. +Функция ЭлектронноеВзаимодействиеПриОпределенииОписанияОрганизации(СведенияОКонтрагенте, Список = "", СПрефиксом = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадры.ЭлектронноеВзаимодействиеПриОпределенииОписанияОрганизации(СведенияОКонтрагенте, Список, СПрефиксом); +``` +
+ +## ЗаполнитьАктуальныеВидыЭД +
+ +Описание, пример вызова + +```bsl + +// Конец ЭлектронноеВзаимодействие + +// ЭлектронноеВзаимодействие.ОбменСБанками + +// Устарела. Следует использовать ОбменСБанкамиБЗК.ПолучитьАктуальныеВидыЭД(). +// См. ОбменСБанкамиПереопределяемый.ПолучитьАктуальныеВидыЭД. +Процедура ЗаполнитьАктуальныеВидыЭД(Массив) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЗаполнитьАктуальныеВидыЭД(Массив) +``` +
+ +## ЗаполнитьПараметрыЭДПоИсточнику +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбменСБанкамиБЗК.ЗаполнитьПараметрыЭДПоИсточнику +// См. ОбменСБанкамиПереопределяемый.ЗаполнитьПараметрыЭДПоИсточнику. +Процедура ЗаполнитьПараметрыЭДПоИсточнику(Источник, ПараметрыЭД) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЗаполнитьПараметрыЭДПоИсточнику(Источник, ПараметрыЭД) +``` +
+ +## ПодготовитьСтруктуруОбъектовКомандЭДО +
+ +Описание, пример вызова + +```bsl + +// Устарела в версии БЭД 1.6.1. Следует отказаться от использования. +// Устарела. Следует использовать ОбменСБанкамиБЗК.ПодготовитьСтруктуруОбъектовКомандЭДО +// См. ОбменСБанкамиПереопределяемый.ПодготовитьСтруктуруОбъектовКомандЭДО. +Процедура ПодготовитьСтруктуруОбъектовКомандЭДО(СоставКомандЭДО) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ПодготовитьСтруктуруОбъектовКомандЭДО(СоставКомандЭДО) +``` +
+ +## ПриФормированииXMLФайла +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбменСБанкамиБЗК.ПриФормированииXMLФайла +// См. ОбменСБанкамиПереопределяемый.ПриФормированииXMLФайла. +Процедура ПриФормированииXMLФайла(ОбъектДляВыгрузки, ИмяФайла, АдресФайла) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ПриФормированииXMLФайла(ОбъектДляВыгрузки, ИмяФайла, АдресФайла) +``` +
+ +## ЗаполнитьТабличныйДокументПоПрямомуОбменуСБанками +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбменСБанкамиБЗК.ЗаполнитьТабличныйДокумент +// См. ОбменСБанкамиПереопределяемый.ЗаполнитьТабличныйДокумент. +Процедура ЗаполнитьТабличныйДокументПоПрямомуОбменуСБанками(ИмяФайла, ТабличныйДокумент) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ЗаполнитьТабличныйДокументПоПрямомуОбменуСБанками(ИмяФайла, ТабличныйДокумент) +``` +
+ +## ПриПолученииXMLФайла +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбменСБанкамиБЗК.ПриПолученииXMLФайла +// См. ОбменСБанкамиПереопределяемый.ПриПолученииXMLФайла. +Процедура ПриПолученииXMLФайла(АдресДанныхФайла, ИмяФайла, ОбъектВладелец, ДанныеОповещения) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадры.ПриПолученииXMLФайла(АдресДанныхФайла, ИмяФайла, ОбъектВладелец, ДанныеОповещения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыБазоваяВерсия.md b/src/content/docs/zup/ЗарплатаКадрыБазоваяВерсия.md new file mode 100644 index 0000000..29484c1 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыБазоваяВерсия.md @@ -0,0 +1,63 @@ +--- +title: Зарплата кадры базовая версия +slug: zup/зарплата-кадры-базовая-версия +--- + + +## ЗарегистрироватьОбработчикиОбновления +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список процедуры-обработчики обновления данных ИБ +// для всех поддерживаемых версий библиотеки или конфигурации. +// Вызывается перед началом обновления данных ИБ для построения плана обновления. +// +// +// Параметры: +// Обработчики - это таблица значений, возвращаемая функцией +// НоваяТаблицаОбработчиковОбновления модуля ОбновлениеИнформационнойБазы. +// +// Пример добавления процедуры-обработчика в список: +// Обработчик = Обработчики.Добавить(); +// Обработчик.Версия = "1.0.0.0"; +// Обработчик.Процедура = "ОбновлениеИБ.ПерейтиНаВерсию_1_0_0_0"; +// +// Все свойства обработчика см. в комментарии к функции +// НоваяТаблицаОбработчиковОбновления в модуле ОбновлениеИнформационнойБазы. +// +Процедура ЗарегистрироватьОбработчикиОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыБазоваяВерсия.ЗарегистрироватьОбработчикиОбновления(Обработчики) +``` +
+ +## ПриДобавленииОбработчиковПереходаСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазыБСП.ПриДобавленииОбработчиковПереходаСДругойПрограммы. +Процедура ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыБазоваяВерсия.ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыГлобальный.md b/src/content/docs/zup/ЗарплатаКадрыГлобальный.md new file mode 100644 index 0000000..2a15ade --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыГлобальный.md @@ -0,0 +1,29 @@ +--- +title: Зарплата кадры глобальный +slug: zup/зарплата-кадры-глобальный +--- + + +## ПоказатьТекущиеДелаПоСЭДО +
+ +Описание, пример вызова + +```bsl + +Процедура ПоказатьТекущиеДелаПоСЭДО() Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыГлобальный.ПоказатьТекущиеДелаПоСЭДО() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыКлиент.md b/src/content/docs/zup/ЗарплатаКадрыКлиент.md new file mode 100644 index 0000000..0c7dff9 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыКлиент.md @@ -0,0 +1,176 @@ +--- +title: Зарплата кадры клиент +slug: zup/зарплата-кадры-клиент +--- + + +## ФормаОрганизацииПередЗаписью +
+ +Описание, пример вызова + +```bsl + +// Выполняет необходимые проверки и запросы пользователю перед записью организации. +// При ответе пользователя о необходимости обработки вызывает сервер. +// Параметры: +// ДанныеОрганизации - данные формы, соответствующие Организации. +// Форма - форма справочника +// Отказ - признак отказа от записи. +// ОповещениеЗавершения - описание оповещения, выполняемого после завершения процедуры. +Процедура ФормаОрганизацииПередЗаписью(ДанныеОрганизации, Форма, Отказ, ОповещениеЗавершения = Неопределено, ЗакрытьПослеЗаписи = Истина) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиент.ФормаОрганизацииПередЗаписью(ДанныеОрганизации, Форма, Отказ, ОповещениеЗавершения, ЗакрытьПослеЗаписи); +``` +
+ +## ОрганизацииФормаЭлементаОбработкаОповещения +
+ +Описание, пример вызова + +```bsl + +// Выполняет действия в форме Организации, связанные с зарплатно-кадровой спецификой. +// Вызов процедуры необходимо выполнять в обработчике ОбработкаОповещения +// формы организации. +Процедура ОрганизацииФормаЭлементаОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиент.ОрганизацииФормаЭлементаОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) +``` +
+ +## ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодПриИзменении +
+ +Описание, пример вызова + +```bsl + +// Выполняет действия в форме Организации, связанные с зарплатно-кадровой спецификой. +// Вызов процедуры необходимо выполнять в обработчике ИсторияРегистрацийВОрганеПФРПериодПриИзменении +// формы организации. +Процедура ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодПриИзменении(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиент.ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодПриИзменении(Форма) +``` +
+ +## ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодНачалоВыбора +
+ +Описание, пример вызова + +```bsl + +// Выполняет действия в форме Организации, связанные с зарплатно-кадровой спецификой. +// Вызов процедуры необходимо выполнять в обработчике ИсторияРегистрацийВОрганеПФРПериодНачалоВыбора +// формы организации. +Процедура ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодНачалоВыбора(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиент.ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодНачалоВыбора(Форма) +``` +
+ +## ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодНачалоВыбораЗавершение +
+ +Описание, пример вызова + +```bsl + +// Продолжение процедуры ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодНачалоВыбора. +// +Процедура ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодНачалоВыбораЗавершение(ВыбранноеЗначение, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиент.ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодНачалоВыбораЗавершение(ВыбранноеЗначение, ДополнительныеПараметры) +``` +
+ +## ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодРегулирование +
+ +Описание, пример вызова + +```bsl + +// Выполняет действия в форме Организации, связанные с зарплатно-кадровой спецификой. +// Вызов процедуры необходимо выполнять в обработчике ИсторияРегистрацийВОрганеПФРПериодРегулирование +// формы организации. +Процедура ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодРегулирование(Форма, Направление) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиент.ОрганизацииФормаЭлементаИсторияРегистрацийВОрганеПФРПериодРегулирование(Форма, Направление) +``` +
+ +## ВосстановитьНачальныеЗначения +
+ +Описание, пример вызова + +```bsl + +// Запускает фоновое задание, восстанавливающее начальные значения законодательных классификаторов. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - Форма, в которой расположена команда вызывающая команда. +// Обновление вызывающей формы может быть реализовано в процедуре ОбработкаОповещения +// с условием ИмяСобытия = "ВосстановленыНачальныеЗначения". +// +Процедура ВосстановитьНачальныеЗначения(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиент.ВосстановитьНачальныеЗначения(Форма) +``` +
+ +## РаботаСФайламиЗаписатьТекст +
+ +Описание, пример вызова + +```bsl + +// Устарела. +// Параметры: +// ДанныеФайла - Структура - см. РаботаСФайламиСлужебныйВызовСервера.ДанныеФайла +// ТекстовыйДокумент - ТекстовыйДокумент +// ИмяФайла - Строка +// Кодировка - КодировкаТекста, Строка +// +Процедура РаботаСФайламиЗаписатьТекст(ДанныеФайла, ТекстовыйДокумент, ИмяФайла, Кодировка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиент.РаботаСФайламиЗаписатьТекст(ДанныеФайла, ТекстовыйДокумент, ИмяФайла, Кодировка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыКлиентБазовый.md b/src/content/docs/zup/ЗарплатаКадрыКлиентБазовый.md new file mode 100644 index 0000000..068d33f --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыКлиентБазовый.md @@ -0,0 +1,202 @@ +--- +title: Зарплата кадры клиент базовый +slug: zup/зарплата-кадры-клиент-базовый +--- + + +## ПередНачаломРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияКлиентПереопределяемый.ПередНачаломРаботыСистемы +Процедура ПередНачаломРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.ПередНачаломРаботыСистемы(Параметры) +``` +
+ +## ПриНачалеРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияКлиентПереопределяемый.ПриНачалеРаботыСистемы +Процедура ПриНачалеРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.ПриНачалеРаботыСистемы(Параметры) +``` +
+ +## ОткрытьРасшифровкуРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +// См. РегламентированнаяОтчетностьКлиентПереопределяемый.ОткрытьРасшифровкуОтчета. +Процедура ОткрытьРасшифровкуРегламентированногоОтчета(ИДОтчета, ИДРедакцииОтчета, ИДИменПоказателей, ПараметрыОтчета) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.ОткрытьРасшифровкуРегламентированногоОтчета(ИДОтчета, ИДРедакцииОтчета, ИДИменПоказателей, ПараметрыОтчета) +``` +
+ +## ПечатьДокументаОтчетности +
+ +Описание, пример вызова + +```bsl + +// См. РегламентированнаяОтчетностьКлиентПереопределяемый.Печать. +Процедура ПечатьДокументаОтчетности(Ссылка, ИмяМакетаДляПечати, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.ПечатьДокументаОтчетности(Ссылка, ИмяМакетаДляПечати, СтандартнаяОбработка) +``` +
+ +## ВыгрузитьДокументОтчетности +
+ +Описание, пример вызова + +```bsl + +// См. РегламентированнаяОтчетностьКлиентПереопределяемый.Выгрузить. +Процедура ВыгрузитьДокументОтчетности(Ссылка, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.ВыгрузитьДокументОтчетности(Ссылка, УникальныйИдентификаторФормы) +``` +
+ +## СоздатьНовыйДокументОтчетности +
+ +Описание, пример вызова + +```bsl + +// См. РегламентированнаяОтчетностьКлиентПереопределяемый.СоздатьНовыйОбъект. +Процедура СоздатьНовыйДокументОтчетности(Организация, Тип, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.СоздатьНовыйДокументОтчетности(Организация, Тип, СтандартнаяОбработка) +``` +
+ +## ОбработкаВыбораПоляОбособленныхПодразделений +
+ +Описание, пример вызова + +```bsl + +// См. РегламентированнаяОтчетностьКлиентПереопределяемый.ОбработкаВыбораПоляОбособленныхПодразделений +Процедура ОбработкаВыбораПоляОбособленныхПодразделений(Форма, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.ОбработкаВыбораПоляОбособленныхПодразделений(Форма, СтандартнаяОбработка) +``` +
+ +## ОткрытьФормуСведенийОтветственныхЛиц +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.ОткрытьФормуСведенийОтветственныхЛиц. +Процедура ОткрытьФормуСведенийОтветственныхЛиц(Организация) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.ОткрытьФормуСведенийОтветственныхЛиц(Организация) +``` +
+ +## ОткрытьОбработкуРедактированиеЗаконодательныхЗначений +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.ОткрытьОбработкуРедактированиеЗаконодательныхЗначений. +Процедура ОткрытьОбработкуРедактированиеЗаконодательныхЗначений() Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.ОткрытьОбработкуРедактированиеЗаконодательныхЗначений() +``` +
+ +## ПечатьДокументовВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// СтандартныеПодсистемы.УправлениеПечатью + +// См. УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовВыполнитьКоманду +Процедура ПечатьДокументовВыполнитьКоманду(Форма, Команда, ПродолжитьВыполнениеНаСервере, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.ПечатьДокументовВыполнитьКоманду(Форма, Команда, ПродолжитьВыполнениеНаСервере, ДополнительныеПараметры) +``` +
+ +## ПечатьДокументовПослеОткрытия +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовПослеОткрытия +Процедура ПечатьДокументовПослеОткрытия(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентБазовый.ПечатьДокументовПослеОткрытия(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыКлиентВнутренний.md b/src/content/docs/zup/ЗарплатаКадрыКлиентВнутренний.md new file mode 100644 index 0000000..8b331b6 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыКлиентВнутренний.md @@ -0,0 +1,216 @@ +--- +title: Зарплата кадры клиент внутренний +slug: zup/зарплата-кадры-клиент-внутренний +--- + + +## ПередНачаломРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.ПередНачаломРаботыСистемы +Процедура ПередНачаломРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ПередНачаломРаботыСистемы(Параметры) +``` +
+ +## ПриНачалеРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.ПриНачалеРаботыСистемы +Процедура ПриНачалеРаботыСистемы(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ПриНачалеРаботыСистемы(Параметры) +``` +
+ +## ОткрытьРасшифровкуРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.ОткрытьРасшифровкуРегламентированногоОтчета +Процедура ОткрытьРасшифровкуРегламентированногоОтчета(ИДОтчета, ИДРедакцииОтчета, ИДИменПоказателей, ПараметрыОтчета) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ОткрытьРасшифровкуРегламентированногоОтчета(ИДОтчета, ИДРедакцииОтчета, ИДИменПоказателей, ПараметрыОтчета) +``` +
+ +## ПечатьДокументаОтчетности +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.ПечатьДокументаОтчетности +Процедура ПечатьДокументаОтчетности(Ссылка, ИмяМакетаДляПечати, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ПечатьДокументаОтчетности(Ссылка, ИмяМакетаДляПечати, СтандартнаяОбработка) +``` +
+ +## ВыгрузитьДокументОтчетности +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.ВыгрузитьДокументОтчетности +Процедура ВыгрузитьДокументОтчетности(Ссылка, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ВыгрузитьДокументОтчетности(Ссылка, УникальныйИдентификаторФормы) +``` +
+ +## СоздатьНовыйДокументОтчетности +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.СоздатьНовыйДокументОтчетности +Процедура СоздатьНовыйДокументОтчетности(Организация, Тип, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.СоздатьНовыйДокументОтчетности(Организация, Тип, СтандартнаяОбработка) +``` +
+ +## ОбработкаВыбораПоляОбособленныхПодразделений +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.ОбработкаВыбораПоляОбособленныхПодразделений +Процедура ОбработкаВыбораПоляОбособленныхПодразделений(Форма, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ОбработкаВыбораПоляОбособленныхПодразделений(Форма, СтандартнаяОбработка) +``` +
+ +## ОткрытьФормуСведенийОтветственныхЛиц +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.ОткрытьФормуСведенийОтветственныхЛиц +Процедура ОткрытьФормуСведенийОтветственныхЛиц(Организация) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ОткрытьФормуСведенийОтветственныхЛиц(Организация) +``` +
+ +## ОткрытьОбработкуРедактированиеЗаконодательныхЗначений +
+ +Описание, пример вызова + +```bsl + +// См. ЗарплатаКадрыКлиент.ОткрытьОбработкуРедактированиеЗаконодательныхЗначений +Процедура ОткрытьОбработкуРедактированиеЗаконодательныхЗначений() Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ОткрытьОбработкуРедактированиеЗаконодательныхЗначений() +``` +
+ +## ДобавитьОписаниеМодификацииДинамическогоСписка +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьОписаниеМодификацииДинамическогоСписка(Описание, СтрокаПараметра) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ДобавитьОписаниеМодификацииДинамическогоСписка(Описание, СтрокаПараметра) +``` +
+ +## ПечатьДокументовВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовВыполнитьКоманду +Процедура ПечатьДокументовВыполнитьКоманду(Форма, Команда, ПродолжитьВыполнениеНаСервере, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ПечатьДокументовВыполнитьКоманду(Форма, Команда, ПродолжитьВыполнениеНаСервере, ДополнительныеПараметры) +``` +
+ +## ПечатьДокументовПослеОткрытия +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовПослеОткрытия +Процедура ПечатьДокументовПослеОткрытия(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентВнутренний.ПечатьДокументовПослеОткрытия(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыКлиентСерверБазовый.md b/src/content/docs/zup/ЗарплатаКадрыКлиентСерверБазовый.md new file mode 100644 index 0000000..2545cc7 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыКлиентСерверБазовый.md @@ -0,0 +1,47 @@ +--- +title: Зарплата кадры клиент сервер базовый +slug: zup/зарплата-кадры-клиент-сервер-базовый +--- + + +## ПриОпределенииВозможныхПредметов +
+ +Описание, пример вызова + +```bsl + +// См. ВзаимодействияКлиентСерверПереопределяемый.ПриОпределенииВозможныхПредметов +Процедура ПриОпределенииВозможныхПредметов(ТипыПредметов) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентСерверБазовый.ПриОпределенииВозможныхПредметов(ТипыПредметов) +``` +
+ +## ПриОпределенииВозможныхКонтактов +
+ +Описание, пример вызова + +```bsl + +// См. ВзаимодействияКлиентСерверПереопределяемый.ПриОпределенииВозможныхКонтактов +Процедура ПриОпределенииВозможныхКонтактов(ТипыКонтактов) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентСерверБазовый.ПриОпределенииВозможныхКонтактов(ТипыКонтактов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыКлиентСерверВнутренний.md b/src/content/docs/zup/ЗарплатаКадрыКлиентСерверВнутренний.md new file mode 100644 index 0000000..94c641f --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыКлиентСерверВнутренний.md @@ -0,0 +1,45 @@ +--- +title: Зарплата кадры клиент сервер внутренний +slug: zup/зарплата-кадры-клиент-сервер-внутренний +--- + + +## ПриОпределенииВозможныхПредметов +
+ +Описание, пример вызова + +```bsl + +Процедура ПриОпределенииВозможныхПредметов(ТипыПредметов) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентСерверВнутренний.ПриОпределенииВозможныхПредметов(ТипыПредметов) +``` +
+ +## ПриОпределенииВозможныхКонтактов +
+ +Описание, пример вызова + +```bsl + +Процедура ПриОпределенииВозможныхКонтактов(ТипыКонтактов) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыКлиентСерверВнутренний.ПриОпределенииВозможныхКонтактов(ТипыКонтактов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыОбщиеНаборыДанных.md b/src/content/docs/zup/ЗарплатаКадрыОбщиеНаборыДанных.md new file mode 100644 index 0000000..2fdf98c --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыОбщиеНаборыДанных.md @@ -0,0 +1,40 @@ +--- +title: Зарплата кадры общие наборы данных +slug: zup/зарплата-кадры-общие-наборы-данных +--- + + +## ДобавитьВКоллекциюОтбор +
+ +Описание, пример вызова + +```bsl + +// Добавляет в коллекцию описание отбора. +// +// Параметры: +// КоллекцияОтборов - Массив +// ЛевоеЗначение - Строка +// ВидСравнения - Строка, допустимы условия, применяемые в текстах запросов. +// ПравоеЗначение - Любое значение, допустимое в условиях текстов запросов. +// ОтносительныйПуть - Булево, если истина, то в параметре ЛевоеЗначение должно содержаться +// имя измерения, ресурса, реквизита регистра и перед именем через точку будет +// подставляться имя таблицы из которой осуществляется выборка. +// +Процедура ДобавитьВКоллекциюОтбор(КоллекцияОтборов, ЛевоеЗначение, ВидСравнения, ПравоеЗначение, ОтносительныйПуть = Истина) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОбщиеНаборыДанных.ДобавитьВКоллекциюОтбор(КоллекцияОтборов, ЛевоеЗначение, ВидСравнения, ПравоеЗначение, ОтносительныйПуть); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыОтображениеОшибок.md b/src/content/docs/zup/ЗарплатаКадрыОтображениеОшибок.md new file mode 100644 index 0000000..359d8f6 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыОтображениеОшибок.md @@ -0,0 +1,646 @@ +--- +title: Зарплата кадры отображение ошибок +slug: zup/зарплата-кадры-отображение-ошибок +--- + + +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ПриСозданииНаСервере(Форма, ОписаниеЭлементовСИндикациейОшибок, ОписаниеПодчиненностиДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ПриСозданииНаСервере(Форма, ОписаниеЭлементовСИндикациейОшибок, ОписаниеПодчиненностиДанных); +``` +
+ +## ПослеПроверкиЗаполненияВФорме +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеПроверкиЗаполненияВФорме(Форма, ПроверяемыеДанные, ОписаниеСвязиДанныхОбъектаСДаннымиФормы, ОписаниеПодчиненностиДанных = Неопределено, ИмяОсновногоРеквизитаФормы = "") Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ПослеПроверкиЗаполненияВФорме(Форма, ПроверяемыеДанные, ОписаниеСвязиДанныхОбъектаСДаннымиФормы, ОписаниеПодчиненностиДанных, ИмяОсновногоРеквизитаФормы); +``` +
+ +## ПриЧтенииДанныхВФорме +
+ +Описание, пример вызова + +```bsl + +Процедура ПриЧтенииДанныхВФорме(Форма, ДанныеОбъекта, ОписаниеСвязиДанныхОбъектаСДаннымиФормы, ОписаниеПодчиненностиДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ПриЧтенииДанныхВФорме(Форма, ДанныеОбъекта, ОписаниеСвязиДанныхОбъектаСДаннымиФормы, ОписаниеПодчиненностиДанных); +``` +
+ +## ПередЗаписьюДанныхВФорме +
+ +Описание, пример вызова + +```bsl + +Процедура ПередЗаписьюДанныхВФорме(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ПередЗаписьюДанныхВФорме(Форма) +``` +
+ +## ПослеЗаписиДанныхВФорме +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеЗаписиДанныхВФорме(Форма, ДанныеОбъекта, ОписаниеСвязиДанныхОбъектаСДаннымиФормы, ОписаниеПодчиненностиДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ПослеЗаписиДанныхВФорме(Форма, ДанныеОбъекта, ОписаниеСвязиДанныхОбъектаСДаннымиФормы, ОписаниеПодчиненностиДанных); +``` +
+ +## ОписаниеСвязиДанных +
+ +Описание, пример вызова + +```bsl +/// Данных объектов в термины данных формы. + +Функция ОписаниеСвязиДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.ОписаниеСвязиДанных() +``` +
+ +## ДобавитьОписаниеСвязиРеквизитов +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьОписаниеСвязиРеквизитов(ОписаниеСвязиДанных, ПутьКРеквизитуВедущихДанных, ПутьКРеквизитуСвязанныхДанных) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ДобавитьОписаниеСвязиРеквизитов(ОписаниеСвязиДанных, ПутьКРеквизитуВедущихДанных, ПутьКРеквизитуСвязанныхДанных) +``` +
+ +## ДобавитьОписаниеСвязиДанныхСтрокиТаблицыСРеквизитом +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьОписаниеСвязиДанныхСтрокиТаблицыСРеквизитом(ОписаниеСвязиДанных, ПутьКТаблицеВедущихДанных, ИмяРеквизитаТаблицыВедущихДанных, ПутьКРеквизитуСвязанныхДанных, КлючСвязи) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ДобавитьОписаниеСвязиДанныхСтрокиТаблицыСРеквизитом(ОписаниеСвязиДанных, ПутьКТаблицеВедущихДанных, ИмяРеквизитаТаблицыВедущихДанных, ПутьКРеквизитуСвязанныхДанных, КлючСвязи) +``` +
+ +## ДобавитьОписаниеСвязиРеквизитаСДаннымиСтрокиТаблицы +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьОписаниеСвязиРеквизитаСДаннымиСтрокиТаблицы(ОписаниеСвязиДанных, ПутьКРеквизитуВедущихДанных, ПутьКТаблицеСвязанныхДанных, ИмяРеквизитаТаблицыСвязанныхДанных, КлючСвязи = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ДобавитьОписаниеСвязиРеквизитаСДаннымиСтрокиТаблицы(ОписаниеСвязиДанных, ПутьКРеквизитуВедущихДанных, ПутьКТаблицеСвязанныхДанных, ИмяРеквизитаТаблицыСвязанныхДанных, КлючСвязи); +``` +
+ +## ДобавитьОписаниеСвязиДанныхСтрокТаблиц +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьОписаниеСвязиДанныхСтрокТаблиц(ОписаниеСвязиДанных, ПутьКТаблицеВедущихДанных, ИмяРеквизитаТаблицыВедущихДанных, ПутьКТаблицеСвязанныхДанных, ИмяРеквизитаТаблицыСвязанныхДанных, КлючСвязи = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ДобавитьОписаниеСвязиДанныхСтрокТаблиц(ОписаниеСвязиДанных, ПутьКТаблицеВедущихДанных, ИмяРеквизитаТаблицыВедущихДанных, ПутьКТаблицеСвязанныхДанных, ИмяРеквизитаТаблицыСвязанныхДанных, КлючСвязи); +``` +
+ +## КлючСвязиДанныхСтрокТаблиц +
+ +Описание, пример вызова + +```bsl + +Функция КлючСвязиДанныхСтрокТаблиц() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.КлючСвязиДанныхСтрокТаблиц() +``` +
+ +## ДобавитьЭлементКлючаСвязиПоПолямСтрокТаблиц +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьЭлементКлючаСвязиПоПолямСтрокТаблиц(КлючСвязи, ИмяРеквизитаЛевойТаблицы, ИмяРеквизитаПравойТаблицы) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ДобавитьЭлементКлючаСвязиПоПолямСтрокТаблиц(КлючСвязи, ИмяРеквизитаЛевойТаблицы, ИмяРеквизитаПравойТаблицы) +``` +
+ +## ДобавитьЭлементКлючаСвязиПоФиксированномуЗначениюПоляВедущейТаблицы +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьЭлементКлючаСвязиПоФиксированномуЗначениюПоляВедущейТаблицы(КлючСвязи, ИмяРеквизитаТаблицы, ФиксированноеЗначение) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ДобавитьЭлементКлючаСвязиПоФиксированномуЗначениюПоляВедущейТаблицы(КлючСвязи, ИмяРеквизитаТаблицы, ФиксированноеЗначение) +``` +
+ +## ДобавитьЭлементКлючаСвязиПоФиксированномуЗначениюПоляПодчиненнойТаблицы +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьЭлементКлючаСвязиПоФиксированномуЗначениюПоляПодчиненнойТаблицы(КлючСвязи, ИмяРеквизитаТаблицы, ФиксированноеЗначение) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ДобавитьЭлементКлючаСвязиПоФиксированномуЗначениюПоляПодчиненнойТаблицы(КлючСвязи, ИмяРеквизитаТаблицы, ФиксированноеЗначение) +``` +
+ +## ПреобразоватьПутиКДаннымВСообщенияхПользователю +
+ +Описание, пример вызова + +```bsl + +Процедура ПреобразоватьПутиКДаннымВСообщенияхПользователю(ДанныеОбъекта, ПодчиненныеДанные, СообщенияПользователю, ОписаниеСвязиДанных, ПутьКДаннымОбъектаВФорме = "") Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ПреобразоватьПутиКДаннымВСообщенияхПользователю(ДанныеОбъекта, ПодчиненныеДанные, СообщенияПользователю, ОписаниеСвязиДанных, ПутьКДаннымОбъектаВФорме); +``` +
+ +## ОписаниеПодчиненностиДанныхФормы +
+ +Описание, пример вызова + +```bsl + +Функция ОписаниеПодчиненностиДанныхФормы() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.ОписаниеПодчиненностиДанныхФормы() +``` +
+ +## ДобавитьОписаниеПодчиненностиРеквизитов +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьОписаниеПодчиненностиРеквизитов(ОписаниеПодчиненностиДанных, ПутьКДаннымВедущегоРеквизита, ПутьКДаннымПодчиненногоРеквизита) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ДобавитьОписаниеПодчиненностиРеквизитов(ОписаниеПодчиненностиДанных, ПутьКДаннымВедущегоРеквизита, ПутьКДаннымПодчиненногоРеквизита) +``` +
+ +## ДобавитьОписаниеПодчиненностиДанныхСтрокТаблиц +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьОписаниеПодчиненностиДанныхСтрокТаблиц(ОписаниеПодчиненностиДанных, ПутьКВедущейТаблице, ПутьКПодчиненнойТаблице, КлючСвязи) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ДобавитьОписаниеПодчиненностиДанныхСтрокТаблиц(ОписаниеПодчиненностиДанных, ПутьКВедущейТаблице, ПутьКПодчиненнойТаблице, КлючСвязи) +``` +
+ +## ДобавитьОписаниеПодчиненностиДанныхСтрокиРеквизиту +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьОписаниеПодчиненностиДанныхСтрокиРеквизиту(ОписаниеПодчиненностиДанных, ПутьКДаннымВедущегоРеквизита, ПутьКПодчиненнойТаблице, КлючСвязи = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ДобавитьОписаниеПодчиненностиДанныхСтрокиРеквизиту(ОписаниеПодчиненностиДанных, ПутьКДаннымВедущегоРеквизита, ПутьКПодчиненнойТаблице, КлючСвязи); +``` +
+ +## ХраненияОшибокВДанныхФормыДополнитьФорму +
+ +Описание, пример вызова + +```bsl + +Процедура ХраненияОшибокВДанныхФормыДополнитьФорму(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ХраненияОшибокВДанныхФормыДополнитьФорму(Форма) +``` +
+ +## ПоместитьСообщенияОбОшибкахВДанныеФормы +
+ +Описание, пример вызова + +```bsl + +Процедура ПоместитьСообщенияОбОшибкахВДанныеФормы(Форма, СообщенияПользователю, КлючДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ПоместитьСообщенияОбОшибкахВДанныеФормы(Форма, СообщенияПользователю, КлючДанных); +``` +
+ +## СообщенияОбОшибкахИзДанныхФормы +
+ +Описание, пример вызова + +```bsl + +Функция СообщенияОбОшибкахИзДанныхФормы(Форма, КлючДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.СообщенияОбОшибкахИзДанныхФормы(Форма, КлючДанных); +``` +
+ +## СообщениеОбОшибкахДляПередачиВФормуРедактированияСтрокиТаблицыФормы +
+ +Описание, пример вызова + +```bsl + +Функция СообщениеОбОшибкахДляПередачиВФормуРедактированияСтрокиТаблицыФормы(Форма, ПутьКДаннымСтрокиТаблицы, ОписаниеПодчиненностиДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.СообщениеОбОшибкахДляПередачиВФормуРедактированияСтрокиТаблицыФормы(Форма, ПутьКДаннымСтрокиТаблицы, ОписаниеПодчиненностиДанных); +``` +
+ +## ПоместитьСообщенияОбОшибкахИзФормыРедактированияСтрокиТаблицыФормыВОсновнуюФорму +
+ +Описание, пример вызова + +```bsl + +Функция ПоместитьСообщенияОбОшибкахИзФормыРедактированияСтрокиТаблицыФормыВОсновнуюФорму(Форма, ПутьКДаннымСтрокиТаблицы, Ошибки, ПутиКДаннымПодчиненныхТаблицФормы, ОписаниеПодчиненностиДанных = Неопределено, КлючДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.ПоместитьСообщенияОбОшибкахИзФормыРедактированияСтрокиТаблицыФормыВОсновнуюФорму(Форма, ПутьКДаннымСтрокиТаблицы, Ошибки, ПутиКДаннымПодчиненныхТаблицФормы, ОписаниеПодчиненностиДанных, КлючДанных); +``` +
+ +## УдалитьОшибкиИзДанныхФормы +
+ +Описание, пример вызова + +```bsl + +Процедура УдалитьОшибкиИзДанныхФормы(Форма, КлючДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.УдалитьОшибкиИзДанныхФормы(Форма, КлючДанных); +``` +
+ +## ОписаниеЭлементовСИндикациейОшибок +
+ +Описание, пример вызова + +```bsl + +Функция ОписаниеЭлементовСИндикациейОшибок() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.ОписаниеЭлементовСИндикациейОшибок() +``` +
+ +## ОписаниеЭлементаСИндикациейОшибокВРеквизитеШапки +
+ +Описание, пример вызова + +```bsl + +Функция ОписаниеЭлементаСИндикациейОшибокВРеквизитеШапки() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.ОписаниеЭлементаСИндикациейОшибокВРеквизитеШапки() +``` +
+ +## ДобавитьОписаниеЭлементаСИндикациейОшибокВРеквизитеШапки +
+ +Описание, пример вызова + +```bsl + +Функция ДобавитьОписаниеЭлементаСИндикациейОшибокВРеквизитеШапки(КоллекцияОписанийЭлементов, ОписаниеЭлемента) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.ДобавитьОписаниеЭлементаСИндикациейОшибокВРеквизитеШапки(КоллекцияОписанийЭлементов, ОписаниеЭлемента) +``` +
+ +## ОписаниеЭлементаСИндикациейОшибокВСтрокеТаблицы +
+ +Описание, пример вызова + +```bsl + +Функция ОписаниеЭлементаСИндикациейОшибокВСтрокеТаблицы() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.ОписаниеЭлементаСИндикациейОшибокВСтрокеТаблицы() +``` +
+ +## ДобавитьОписаниеЭлементаСИндикациейОшибокВСтрокеТаблицы +
+ +Описание, пример вызова + +```bsl + +Функция ДобавитьОписаниеЭлементаСИндикациейОшибокВСтрокеТаблицы(КоллекцияОписанийЭлементов, ОписаниеЭлемента) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.ДобавитьОписаниеЭлементаСИндикациейОшибокВСтрокеТаблицы(КоллекцияОписанийЭлементов, ОписаниеЭлемента) +``` +
+ +## ИндикацияОшибокДополнитьФорму +
+ +Описание, пример вызова + +```bsl + +Процедура ИндикацияОшибокДополнитьФорму(Форма, ОписаниеЭлементовСИндикациейОшибок, ОписаниеПодчиненностиДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ИндикацияОшибокДополнитьФорму(Форма, ОписаниеЭлементовСИндикациейОшибок, ОписаниеПодчиненностиДанных); +``` +
+ +## УстановитьФлагиНаличияОшибокПоСообщениямОбОшибках +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьФлагиНаличияОшибокПоСообщениямОбОшибках(Форма, Ошибки, ОписаниеПодчиненностиДанных = Неопределено, УстанавливатьФлагНаличияНепривязанныхОшибок = Истина) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.УстановитьФлагиНаличияОшибокПоСообщениямОбОшибках(Форма, Ошибки, ОписаниеПодчиненностиДанных, УстанавливатьФлагНаличияНепривязанныхОшибок); +``` +
+ +## УстановитьФлагНаличияОшибокПоПутиКДанным +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьФлагНаличияОшибокПоПутиКДанным(Форма, ПутьКДанным, ОписаниеПодчиненностиДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.УстановитьФлагНаличияОшибокПоПутиКДанным(Форма, ПутьКДанным, ОписаниеПодчиненностиДанных); +``` +
+ +## ОчиститьФлагНаличияОшибокПоПутиКДанным +
+ +Описание, пример вызова + +```bsl + +Процедура ОчиститьФлагНаличияОшибокПоПутиКДанным(Форма, ПутьКДанным, ОписаниеПодчиненностиДанных = Неопределено, СбрасыватьИндикаторНаличияОшибокВПодчиненныхДанных = Ложь) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ОчиститьФлагНаличияОшибокПоПутиКДанным(Форма, ПутьКДанным, ОписаниеПодчиненностиДанных, СбрасыватьИндикаторНаличияОшибокВПодчиненныхДанных); +``` +
+ +## ОчиститьФлагиНаличияОшибок +
+ +Описание, пример вызова + +```bsl + +Процедура ОчиститьФлагиНаличияОшибок(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.ОчиститьФлагиНаличияОшибок(Форма) +``` +
+ +## УстановленоОтображениеОшибокВДанных +
+ +Описание, пример вызова + +```bsl + +Функция УстановленоОтображениеОшибокВДанных(Форма, ПутьКДанным) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыОтображениеОшибок.УстановленоОтображениеОшибокВДанных(Форма, ПутьКДанным) +``` +
+ +## СообщитьОбОшибке +
+ +Описание, пример вызова + +```bsl + +// Устарела. См. интерфейс модулей СообщенияБЗК и СообщенияБЗККлиентСервер. +// Сообщает об ошибке заполнения и включает флажок Отказ. +// +// Параметры: +// Отказ - Булево - Для изменения. Флажок отказа от продолжения работы после проверки заполнения. +// ТекстИлиОбъектМетаданных - Строка, ОбъектМетаданных - Текст ошибки, +// либо объект метаданных, для которого будет сформирован стандартный текст ошибки (на основе представления реквизита). +// ИмяРеквизита - Строка - Имя реквизита, в котором допущена ошибка заполнения. +// ИмяТаблицы - Строка - Необязательный. Имя табличной части, в которой размещен реквизит. +// НомерСтроки - Число - Необязательный. Номер строки табличной части, в которой допущена ошибка заполнения. +// ПутьКДанным - Строка - Необязательный. В данном параметре можно указать имя объекта данных формы, +// в котором расположен указанный реквизит или табличная часть. Пример: "Объект". +// +Процедура СообщитьОбОшибке(Отказ, ТекстИлиОбъектМетаданных, ИмяРеквизита = "", ИмяТаблицы = Неопределено, НомерСтроки = 0, ПутьКДанным = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.СообщитьОбОшибке(Отказ, ТекстИлиОбъектМетаданных, ИмяРеквизита, ИмяТаблицы, НомерСтроки, ПутьКДанным); +``` +
+ +## СообщитьПользователю +
+ +Описание, пример вызова + +```bsl + +// Устарела. См. интерфейс модулей СообщенияБЗК и СообщенияБЗККлиентСервер. +// Создает сообщение пользователю. +// +// Параметры: +// Текст - Строка, ОбъектМетаданных - Текст сообщения. +// ИмяРеквизита - Строка - Имя реквизита, к которому необходимо привязать сообщение. +// ИмяТаблицы - Строка - Необязательный. Имя табличной части, в которой размещен реквизит. +// НомерСтроки - Число - Необязательный. Номер строки табличной части, к которой необходимо привязать сообщение. +// ПутьКДанным - Строка - Необязательный. В данном параметре можно указать имя объекта данных формы, +// в котором расположен указанный реквизит или табличная часть. Пример: "Объект". +// +Процедура СообщитьПользователю(Текст, ИмяРеквизита = "", ИмяТаблицы = Неопределено, НомерСтроки = 0, ПутьКДанным = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибок.СообщитьПользователю(Текст, ИмяРеквизита, ИмяТаблицы, НомерСтроки, ПутьКДанным); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыОтображениеОшибокКлиент.md b/src/content/docs/zup/ЗарплатаКадрыОтображениеОшибокКлиент.md new file mode 100644 index 0000000..3454ccf --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыОтображениеОшибокКлиент.md @@ -0,0 +1,93 @@ +--- +title: Зарплата кадры отображение ошибок клиент +slug: zup/зарплата-кадры-отображение-ошибок-клиент +--- + + +## ЭлементИндикацииПриАктивизацииЯчейки +
+ +Описание, пример вызова + +```bsl + +Процедура ЭлементИндикацииПриАктивизацииЯчейки(Форма, Элемент) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибокКлиент.ЭлементИндикацииПриАктивизацииЯчейки(Форма, Элемент) +``` +
+ +## ЭлементИндикацииОшибкиНажатие +
+ +Описание, пример вызова + +```bsl + +Процедура ЭлементИндикацииОшибкиНажатие(Форма, Элемент, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибокКлиент.ЭлементИндикацииОшибкиНажатие(Форма, Элемент, СтандартнаяОбработка) +``` +
+ +## ПриИзмененииДанныхВЭлементеСФлагомИндикацииОшибок +
+ +Описание, пример вызова + +```bsl + +Процедура ПриИзмененииДанныхВЭлементеСФлагомИндикацииОшибок(Форма, Элемент, ПутьКДанным) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибокКлиент.ПриИзмененииДанныхВЭлементеСФлагомИндикацииОшибок(Форма, Элемент, ПутьКДанным) +``` +
+ +## ПриОкончанииРедактированияСтрокиТаблицыСИндикациейОшибок +
+ +Описание, пример вызова + +```bsl + +Процедура ПриОкончанииРедактированияСтрокиТаблицыСИндикациейОшибок(Форма, Элемент, НоваяСтрока, ПутьКДаннымТаблицы) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибокКлиент.ПриОкончанииРедактированияСтрокиТаблицыСИндикациейОшибок(Форма, Элемент, НоваяСтрока, ПутьКДаннымТаблицы) +``` +
+ +## ПередУдалениемСтрокиТаблицыСИндикациейОшибок +
+ +Описание, пример вызова + +```bsl + +Процедура ПередУдалениемСтрокиТаблицыСИндикациейОшибок(Форма, Элемент, ПутьКДаннымТаблицы) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибокКлиент.ПередУдалениемСтрокиТаблицыСИндикациейОшибок(Форма, Элемент, ПутьКДаннымТаблицы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыОтображениеОшибокКлиентСервер.md b/src/content/docs/zup/ЗарплатаКадрыОтображениеОшибокКлиентСервер.md new file mode 100644 index 0000000..c58dacc --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыОтображениеОшибокКлиентСервер.md @@ -0,0 +1,29 @@ +--- +title: Зарплата кадры отображение ошибок клиент сервер +slug: zup/зарплата-кадры-отображение-ошибок-клиент-сервер +--- + + +## УдалитьОшибкиИзДанныхФормыПоПутиКДанным +
+ +Описание, пример вызова + +```bsl + +Процедура УдалитьОшибкиИзДанныхФормыПоПутиКДанным(Форма, ПутьКДанным, КлючДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтображениеОшибокКлиентСервер.УдалитьОшибкиИзДанныхФормыПоПутиКДанным(Форма, ПутьКДанным, КлючДанных); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыОтчеты.md b/src/content/docs/zup/ЗарплатаКадрыОтчеты.md new file mode 100644 index 0000000..97ec0fd --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыОтчеты.md @@ -0,0 +1,42 @@ +--- +title: Зарплата кадры отчеты +slug: zup/зарплата-кадры-отчеты +--- + + +## ВывестиВКоллекциюПечатнуюФорму +
+ +Описание, пример вызова + +```bsl + +// Выводит в коллекцию печатных форм табличный документ настраиваемой печатной формы. +// Используется при формировании настраиваемых печатных форм из модулей менеджеров отчетов - печатных форм. +// +// Параметры: +// ИмяОтчета - Строка, полное имя объекта метаданных - отчета +// МассивОбъектов - см. УправлениеПечатьюПереопределяемый.ПриПечати.ОбъектыПечати +// ПараметрыПечати - см. УправлениеПечатьюПереопределяемый.ПриПечати.ОбъектыПечати +// КоллекцияПечатныхФорм - см. УправлениеПечатьюПереопределяемый.ПриПечати.ОбъектыПечати +// ОбъектыПечати - см. УправлениеПечатьюПереопределяемый.ПриПечати.ОбъектыПечати +// ПараметрыВывода - см. УправлениеПечатьюПереопределяемый.ПриПечати.ОбъектыПечати +// ВнешниеНаборыДанных - Структура +// ДополнительныеПараметрыФормирования - Структура +// +Процедура ВывестиВКоллекциюПечатнуюФорму(ИмяОтчета, МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода, ВнешниеНаборыДанных = Неопределено, ДополнительныеПараметрыФормирования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтчеты.ВывестиВКоллекциюПечатнуюФорму(ИмяОтчета, МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода, ВнешниеНаборыДанных, ДополнительныеПараметрыФормирования); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыОтчетыПереопределяемый.md b/src/content/docs/zup/ЗарплатаКадрыОтчетыПереопределяемый.md new file mode 100644 index 0000000..6659d90 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыОтчетыПереопределяемый.md @@ -0,0 +1,32 @@ +--- +title: Зарплата кадры отчеты переопределяемый +slug: zup/зарплата-кадры-отчеты-переопределяемый +--- + + +## НастроитьВариантыОтчетов +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить выполненные настройки зарплатных и кадровых отчетов. +// Описание см. ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов. +// +Процедура НастроитьВариантыОтчетов(Настройки) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыОтчетыПереопределяемый.НастроитьВариантыОтчетов(Настройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыПереопределяемый.md b/src/content/docs/zup/ЗарплатаКадрыПереопределяемый.md new file mode 100644 index 0000000..e7a919f --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыПереопределяемый.md @@ -0,0 +1,245 @@ +--- +title: Зарплата кадры переопределяемый +slug: zup/зарплата-кадры-переопределяемый +--- + + +## ПолучитьЗначенияПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Получает "заказанные" значения по умолчанию. +// Параметры: +// ПолучаемыеЗначения - структура элементы которой имеют +// имена, идентифицирующие получаемые значения. +// Могут быть переданы имена значений: +// Организация - организация по умолчанию. +// Руководитель - руководитель организации. +// ГлавныйБухгалтер - главбух организации. +// ДолжностьРуководителя - должность руководителя организации. +// Подразделение - подразделение по умолчанию. +// +// ДатаЗначений - Дата, на которую получаются значения по умолчанию. +// +// В процедуре значения элементов структуры ПолучаемыеЗначения должны быть заполнены +// значениями, если это возможно. Если невозможно, то остается то значение, которое +// было передано в структуре. +Процедура ПолучитьЗначенияПоУмолчанию(ПолучаемыеЗначения, ДатаЗначений) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПереопределяемый.ПолучитьЗначенияПоУмолчанию(ПолучаемыеЗначения, ДатаЗначений) +``` +
+ +## ОрганизацияНаУпрощеннойСистемеНалогообложения +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак того, что организация применяет УСН. +// +// Параметры: +// Организация +// +// Возвращаемое значение: +// Булево - Истина, если применяется упрощенная система налогообложения. +// +Функция ОрганизацияНаУпрощеннойСистемеНалогообложения(Организация, Период = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПереопределяемый.ОрганизацияНаУпрощеннойСистемеНалогообложения(Организация, Период); +``` +
+ +## ЗаполнитьРеквизитОрганизацияПриОднофирменномУчете +
+ +Описание, пример вызова + +```bsl + +// Предназначена для заполнения в документах реквизита Организация единственной организацией при однофирменном учете. +// +Процедура ЗаполнитьРеквизитОрганизацияПриОднофирменномУчете(Источник, СтандартнаяОбработка, ИмяРеквизитаОрганизация) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПереопределяемый.ЗаполнитьРеквизитОрганизацияПриОднофирменномУчете(Источник, СтандартнаяОбработка, ИмяРеквизитаОрганизация) +``` +
+ +## УстановитьДоступностьИзмененияЭтоОбособленноеПодразделениеВФормеПодразделения +
+ +Описание, пример вызова + +```bsl + +// Позволяет запретить изменение признака «Это обособленное подразделение» в форме подразделения. +// +// Параметры: +// ДоступностьИзменения - булево, если в теле процедуры установить значение Ложь, +// установка признака станет недоступна в форме подразделения. +// +Процедура УстановитьДоступностьИзмененияЭтоОбособленноеПодразделениеВФормеПодразделения(ДоступностьИзменения) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПереопределяемый.УстановитьДоступностьИзмененияЭтоОбособленноеПодразделениеВФормеПодразделения(ДоступностьИзменения) +``` +
+ +## ДополнитьСоответствиеАдресовОрганизаций +
+ +Описание, пример вызова + +```bsl + +// Дополняет коллекцию соответствий видов контактной информации с типом Адрес, в +// зависимости от типа объекта, содержащего контактную информацию. +// +// Параметры: +// СоответствиеАдресовОрганизаций - Соответствие +// * Ключ - Тип, тип владельца контактной информации. +// * Значение - Соответствие. +// * Ключ - СправочникСсылка.ВидыКонтактнойИнформации +// * Значение - СправочникСсылка.ВидыКонтактнойИнформации +// (значение выбирается из видов контактной информации организаций: +// ФактАдресОрганизации или ЮрАдресОрганизации). +// Пример: +// СоответствиеВидов = Новый Соответствие; +// СоответствиеВидов.Вставить(Справочники.ВидыКонтактнойИнформации.АдресМестаПроживанияФизическиеЛица, Справочники.ВидыКонтактнойИнформации.ФактАдресОрганизации); +// СоответствиеВидов.Вставить(Справочники.ВидыКонтактнойИнформации.АдресПоПропискеФизическиеЛица, Справочники.ВидыКонтактнойИнформации.ЮрАдресОрганизации); +// СоответствиеАдресовОрганизаций.Вставить(Тип("СправочникСсылка.ФизическиеЛица"), СоответствиеВидов); +// +Процедура ДополнитьСоответствиеАдресовОрганизаций(СоответствиеАдресовОрганизаций) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПереопределяемый.ДополнитьСоответствиеАдресовОрганизаций(СоответствиеАдресовОрганизаций) +``` +
+ +## ОпределитьТипыВладельцевАдресовОрганизаций +
+ +Описание, пример вызова + +```bsl + +// Переопределяет коллекции ссылок на объекты содержащие контактную информацию организаций. +// При переопределении объектов, переопределяемые объекты: +// 1. должны быть исключены из коллекции с типом справочника Организации +// 2. поделены на коллекции (соответствия) где ключ - ссылка на объект с контактной информацией, +// а значение СправочникСсылка.Организация +// 3. полученные коллекции должны быть добавлены в КоллекцияПоТипам с ключом +// соответствующим типу содержащихся в коллекции объектов. +// +// Параметры: +// КоллекцияПоТипам - Соответствие - содержит единственный элемент КлючИЗначение +// с ключем тип СправочникСсылка.Организации и значением - массив ссылок +// на организации. +// +// +Процедура ОпределитьТипыВладельцевАдресовОрганизаций(КоллекцияПоТипам) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПереопределяемый.ОпределитьТипыВладельцевАдресовОрганизаций(КоллекцияПоТипам) +``` +
+ +## УстановитьОсновнойРежимВыполненияОбновления +
+ +Описание, пример вызова + +```bsl + +// Переопределяет основной режим выполнения обработчиков Зарплатно-кадровой библиотеки. +// По умолчанию основной режим обработчиков Зарплатно-кадровой библиотеки - "Монопольно". +// +// Параметры: +// РежимОбновления - строка, см. описание ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +// Значения, допустимые для установки параметру: "Монопольно", "Отложенно". +// +// +Процедура УстановитьОсновнойРежимВыполненияОбновления(РежимОбновления) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПереопределяемый.УстановитьОсновнойРежимВыполненияОбновления(РежимОбновления) +``` +
+ +## ПриОпределенииИмениКлиентскогоПриложения +
+ +Описание, пример вызова + +```bsl + +// Переопределяет имя клиентского приложения, используемое в запросах к веб-сервисам. +// Подробнее см. ЗарплатаКадры.ИмяКлиентскогоПриложения. +// +// Параметры: +// ИмяПриложения - Строка - имя клиентского приложения, User-Agent, +// СтандартнаяОбработка - Булево - признак формирования имени по умолчанию. +// +Процедура ПриОпределенииИмениКлиентскогоПриложения(ИмяПриложения, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПереопределяемый.ПриОпределенииИмениКлиентскогоПриложения(ИмяПриложения, СтандартнаяОбработка) +``` +
+ +## ВидыОперацийПоЗарплатеОбработкаПолученияДанныхВыбора +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ОбработкаПолученияДанныхВыбора перечисления ВидыОперацийПоЗарплате. +// Используется для переопределения стандартной обработки. +// +// Параметры: +// ДанныеВыбора - СписокЗначений - в список помещаются сформированные данные выбора. +// Параметры - Структура - содержит параметры выбора. +// СтандартнаяОбработка - Булево - в данный параметр передается признак выполнения стандартной. +// Если в теле процедуры-обработчика установить параметру СтандартнаяОбработка значение Ложь, +// стандартная обработка события производиться не будет. +// +Процедура ВидыОперацийПоЗарплатеОбработкаПолученияДанныхВыбора(ДанныеВыбора, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПереопределяемый.ВидыОперацийПоЗарплатеОбработкаПолученияДанныхВыбора(ДанныеВыбора, Параметры, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыПериодическиеРегистры.md b/src/content/docs/zup/ЗарплатаКадрыПериодическиеРегистры.md new file mode 100644 index 0000000..d6121c7 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыПериодическиеРегистры.md @@ -0,0 +1,610 @@ +--- +title: Зарплата кадры периодические регистры +slug: zup/зарплата-кадры-периодические-регистры +--- + + +## ТаблицаВТИмяРегистра +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу записей регистра. +// +// Параметры: +// ИмяРегистра - Строка - имя периодического регистра сведений, как оно +// задано в конфигураторе. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +// ТолькоРазрешенные - Булево +// ОписаниеФильтра - Структура - см. функцию ОписаниеФильтраДляСоздатьВТИмяРегистра. +// ПараметрыПостроения - Структура - см. функцию ПараметрыПостроенияДляСоздатьВТИмяРегистра. +// +// Возвращаемое значение: +// ТаблицаЗначений +// +Функция ТаблицаВТИмяРегистра(Знач ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ТаблицаВТИмяРегистра(ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения); +``` +
+ +## ТаблицаВТИмяРегистраСрезПоследних +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу среза последних регистра. +// +// Параметры: +// ИмяРегистра - Строка - имя периодического регистра сведений, как оно +// задано в конфигураторе. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +// ТолькоРазрешенные - Булево +// ОписаниеФильтра - Структура - см. функцию ОписаниеФильтраДляСоздатьВТИмяРегистра. +// ПараметрыПостроения - Структура - см. функцию ПараметрыПостроенияДляСоздатьВТИмяРегистраСрез. +// +// Возвращаемое значение: +// ТаблицаЗначений +// +Функция ТаблицаВТИмяРегистраСрезПоследних(Знач ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ТаблицаВТИмяРегистраСрезПоследних(ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения); +``` +
+ +## СоздатьВТИмяРегистра +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу записей регистра в менеджере временных таблиц, переданном в качестве параметра. +// +// Параметры: +// ИмяРегистра - Строка - имя периодического регистра сведений, как оно +// задано в конфигураторе. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +// ТолькоРазрешенные - Булево +// ОписаниеФильтра - Структура - см. функцию ОписаниеФильтраДляСоздатьВТИмяРегистра. +// ПараметрыПостроения - Структура - см. функцию ПараметрыПостроенияДляСоздатьВТИмяРегистра. +// ИмяРезультирующейТаблицы - Строка - имя создаваемой временной таблицы, если не задано, то +// имя результирующей таблицы будет сформировано каК ВТ<ИмяРегистра>. +// +Процедура СоздатьВТИмяРегистра(Знач ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения = Неопределено, ИмяРезультирующейТаблицы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПериодическиеРегистры.СоздатьВТИмяРегистра(ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения, ИмяРезультирующейТаблицы); +``` +
+ +## ТаблицаВТИмяРегистраПериоды +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу периодов регистра +// +// Параметры: +// ИмяРегистра - Строка - имя периодического регистра сведений, как оно +// задано в конфигураторе. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +// ТолькоРазрешенные - Булево +// ОписаниеФильтра - Структура - см. функцию ОписаниеФильтраДляСоздатьВТИмяРегистра. +// ПараметрыПостроения - Структура - см. функцию ПараметрыПостроенияДляСоздатьВТИмяРегистра. +// +// Возвращаемое значение: +// ТаблицаЗначений +// +Функция ТаблицаВТИмяРегистраПериоды(Знач ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ТаблицаВТИмяРегистраПериоды(ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения); +``` +
+ +## СоздатьВТИмяРегистраПериоды +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу периодов регистра в менеджере временных таблиц, переданном в качестве параметра. +// +// Параметры: +// ИмяРегистра - Строка - имя периодического регистра сведений, как оно +// задано в конфигураторе. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +// ТолькоРазрешенные - Булево +// ОписаниеФильтра - Структура - см. функцию ОписаниеФильтраДляСоздатьВТИмяРегистра. +// ПараметрыПостроения - Структура - см. функцию ПараметрыПостроенияДляСоздатьВТИмяРегистра. +// ИмяРезультирующейТаблицы - Строка - имя создаваемой временной таблицы, если не задано, то +// имя результирующей таблицы будет сформировано как ВТ<ИмяРегистра>Периоды. +// +Процедура СоздатьВТИмяРегистраПериоды(Знач ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения = Неопределено, ИмяРезультирующейТаблицы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПериодическиеРегистры.СоздатьВТИмяРегистраПериоды(ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения, ИмяРезультирующейТаблицы); +``` +
+ +## СоздатьВТИмяРегистраСрезПервых +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу среза первых регистра в менеджере временных таблиц, переданном в качестве параметра. +// +// Параметры: +// ИмяРегистра - Строка - имя периодического регистра сведений, как оно +// задано в конфигураторе. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +// ТолькоРазрешенные - Булево +// ОписаниеФильтра - Структура - см. функцию ОписаниеФильтраДляСоздатьВТИмяРегистра. +// ПараметрыПостроения - Структура - см. функцию ПараметрыПостроенияДляСоздатьВТИмяРегистраСрез. +// ИмяРезультирующейТаблицы - Строка - имя создаваемой временной таблицы, если не задано, то +// имя результирующей таблицы будет сформировано каК ВТ<ИмяРегистра>. +// +Процедура СоздатьВТИмяРегистраСрезПервых(Знач ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения = Неопределено, ИмяРезультирующейТаблицы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПериодическиеРегистры.СоздатьВТИмяРегистраСрезПервых(ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения, ИмяРезультирующейТаблицы); +``` +
+ +## СоздатьВТИмяРегистраСрезПоследних +
+ +Описание, пример вызова + +```bsl + +// Создает временную таблицу среза последних регистра в менеджере временных таблиц, переданном в качестве параметра. +// +// Параметры: +// ИмяРегистра - Строка - имя периодического регистра сведений, как оно +// задано в конфигураторе. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +// ТолькоРазрешенные - Булево +// ОписаниеФильтра - Структура - см. функцию ОписаниеФильтраДляСоздатьВТИмяРегистра. +// ПараметрыПостроения - Структура - см. функцию ПараметрыПостроенияДляСоздатьВТИмяРегистраСрез. +// ИмяРезультирующейТаблицы - Строка - имя создаваемой временной таблицы, если не задано, то +// имя результирующей таблицы будет сформировано каК ВТ<ИмяРегистра>. +// +Процедура СоздатьВТИмяРегистраСрезПоследних(Знач ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения = Неопределено, ИмяРезультирующейТаблицы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПериодическиеРегистры.СоздатьВТИмяРегистраСрезПоследних(ИмяРегистра, МенеджерВременныхТаблиц, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения, ИмяРезультирующейТаблицы); +``` +
+ +## ЗапросВТИмяРегистра +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос представления ВТИмяРегистра. +// +// Параметры: +// ИмяРегистра - Строка - Имя регистра как задано в конфигураторе. +// ТолькоРазрешенные - Булево +// ОписаниеФильтра - Структура - см. функцию ОписаниеФильтраДляСоздатьВТИмяРегистра. +// ПараметрыПостроения - Структура - см. ПараметрыПостроенияДляСоздатьВТИмяРегистра. +// ИмяСоздаваемойТаблицы - Строка - если не указано, запрос будет создавать временную таблицу ВТ<ИмяРегистра> +// +// Возвращаемое значение: +// Запрос +// +Функция ЗапросВТИмяРегистра(ИмяРегистра, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения = Неопределено, ИмяСоздаваемойТаблицы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ЗапросВТИмяРегистра(ИмяРегистра, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения, ИмяСоздаваемойТаблицы); +``` +
+ +## ЗапросВТИмяРегистраСрез +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос представления ВТИмяРегистраСрез. +// +// Параметры: +// ИмяРегистра - Строка - Имя регистра как задано в конфигураторе. +// ТолькоРазрешенные - Булево +// ОписаниеФильтра - Структура - см. функцию ОписаниеФильтраДляСоздатьВТИмяРегистра. +// ПараметрыПостроения - Структура - См. ПараметрыПостроенияДляСоздатьВТИмяРегистраСрез. +// СрезПоследних - Булево - если Истина - срез последних, если Ложь - срез первых. +// ИмяСоздаваемойТаблицы - Строка - если не указано, запрос будет создавать временную таблицу ВТ<ИмяРегистра>СрезПоследних +// или ВТ<ИмяРегистра>СрезПервых, в зависимости от значения параметра СрезПоследних +// +// Возвращаемое значение: +// Запрос +// +Функция ЗапросВТИмяРегистраСрез(ИмяРегистра, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения = Неопределено, СрезПоследних = Истина, ИмяСоздаваемойТаблицы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ЗапросВТИмяРегистраСрез(ИмяРегистра, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения, СрезПоследних, ИмяСоздаваемойТаблицы); +``` +
+ +## ЗапросВТПериодыИмяРегистра +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос представления ВТИмяРегистраПериоды. +// Получение периодов по интервальному регистру сведений. +// +// Параметры: +// ИмяРегистра - Строка - Имя регистра как задано в конфигураторе. +// ТолькоРазрешенные - Булево +// ОписаниеФильтра - Структура - См. ОписаниеФильтраДляСоздатьВТИмяРегистра. +// ПараметрыПостроения - Структура - См. ПараметрыПостроенияДляСоздатьВТИмяРегистраПериоды. +// ИмяСоздаваемойТаблицы - Строка - если не указано, запрос будет создавать временную таблицу ВТ<ИмяРегистра>Периоды +// +// Возвращаемое значение: +// Запрос +// +Функция ЗапросВТПериодыИмяРегистра(ИмяРегистра, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения = Неопределено, ИмяСоздаваемойТаблицы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ЗапросВТПериодыИмяРегистра(ИмяРегистра, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения, ИмяСоздаваемойТаблицы); +``` +
+ +## ОписаниеФильтраДляСоздатьВТИмяРегистра +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание источника данных - временная таблица. +// +// Параметры: +// ТаблицаФильтра - Строка - имя временной таблицы +// - ТаблицаЗначений +// содержат обязательные колонки: +// "Период" (для получения представлений среза первых или +// среза последних) +// "ДатаНачала" и "ДатаОкончания" (для получения таблицы регистра). +// ИзмеренияФильтра - Строка - имена колонок таблицы равные именам измерений регистра, +// по которым устанавливается фильтр, для колонок с именами отличающимися +// от имен измерений, в значениях ключа "СоответствиеИзмеренийРегистраИзмерениямФильтра", +// указывается соответствие имени измерения регистра имени колонки таблицы фильтра. +// Допускается не указывать, когда ТаблицаФильтра имеет тип ТаблицаЗначений. +// ДополнительныеПоляФильтра - Строка +// - Массив - имена колонок таблицы, по которым не устанавливается фильтр, +// но которые должны участвовать в результате запроса. +// +// Возвращаемое значение: +// Структура - см. НовыйОписаниеФильтраДляСоздатьВТИмяРегистра. +// +Функция ОписаниеФильтраДляСоздатьВТИмяРегистра(Знач ТаблицаФильтра, ИзмеренияФильтра = "", ДополнительныеПоляФильтра = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ОписаниеФильтраДляСоздатьВТИмяРегистра(ТаблицаФильтра, ИзмеренияФильтра, ДополнительныеПоляФильтра); +``` +
+ +## ОписаниеФильтраДляСоздатьВТИмяРегистраПоТаблицеЗначений +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание источника данных - временная таблица. +// +// Параметры: +// ТаблицаФильтра - ТаблицаЗначений - содержат обязательные колонки: +// "Период" (для получения представлений среза первых или +// среза последних) +// "ДатаНачала" и "ДатаОкончания" (для получения таблицы регистра). +// Измерения - Строка - имена колонок таблицы равные именам измерений регистра, +// по которым устанавливается фильтр, для колонок с именами отличающимися +// от имен измерений, в значениях ключа "СоответствиеИзмеренийРегистраИзмерениямФильтра", +// указывается соответствие имени измерения регистра имени колонки таблицы фильтра. +// Допускается не указывать, когда ТаблицаФильтра имеет тип ТаблицаЗначений. +// ДополнительныеПоля - Строка +// - Массив - имена колонок таблицы, по которым не устанавливается фильтр, +// но которые должны участвовать в результате запроса. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +// ИмяВТФильтр - Строка - имя создаваемой временной таблицы фильтра +// +// Возвращаемое значение: +// Структура - см. НовыйОписаниеФильтраДляСоздатьВТИмяРегистра. +// +Функция ОписаниеФильтраДляСоздатьВТИмяРегистраПоТаблицеЗначений(ТаблицаФильтра, Измерения = "", ДополнительныеПоля = "", МенеджерВременныхТаблиц = Неопределено, ИмяВТФильтр = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ОписаниеФильтраДляСоздатьВТИмяРегистраПоТаблицеЗначений(ТаблицаФильтра, Измерения, ДополнительныеПоля, МенеджерВременныхТаблиц, ИмяВТФильтр); +``` +
+ +## ОписаниеФильтраДляСоздатьВТИмяРегистраПоВременнойТаблице +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание источника данных - временная таблица. +// +// Параметры: +// ИмяВТФильтр - Строка - имя временной таблицы +// Измерения - Строка - имена колонок таблицы равные именам измерений регистра, +// по которым устанавливается фильтр, для колонок с именами отличающимися +// от имен измерений, в значениях ключа "СоответствиеИзмеренийРегистраИзмерениямФильтра", +// указывается соответствие имени измерения регистра имени колонки таблицы фильтра. +// Допускается не указывать, когда ТаблицаФильтра имеет тип ТаблицаЗначений. +// ДополнительныеПоля - Строка +// - Массив - имена колонок таблицы, по которым не устанавливается фильтр, +// но которые должны участвовать в результате запроса. +// +// Возвращаемое значение: +// Структура - см. НовыйОписаниеФильтраДляСоздатьВТИмяРегистра. +// +Функция ОписаниеФильтраДляСоздатьВТИмяРегистраПоВременнойТаблице(ИмяВТФильтр, Измерения = "", ДополнительныеПоля = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ОписаниеФильтраДляСоздатьВТИмяРегистраПоВременнойТаблице(ИмяВТФильтр, Измерения, ДополнительныеПоля); +``` +
+ +## ОписаниеФильтраДляСоздатьВТИмяРегистраПоЗначению +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание источника данных - временная таблица. +// +// Параметры: +// ОписаниеПериода - Структура - см. ОписаниеПериодаДляСоздатьВТИмяРегистра +// Измерение - Строка - имена колонок таблицы равные именам измерений регистра, +// по которым устанавливается фильтр, для колонок с именами отличающимися +// от имен измерений, в значениях ключа "СоответствиеИзмеренийРегистраИзмерениямФильтра", +// указывается соответствие имени измерения регистра имени колонки таблицы фильтра. +// Допускается не указывать, когда ТаблицаФильтра имеет тип ТаблицаЗначений. +// ЗначениеИзмерения - Произвольный - значение измерения. +// +// Возвращаемое значение: +// Структура - см. НовыйОписаниеФильтраДляСоздатьВТИмяРегистра. +// +Функция ОписаниеФильтраДляСоздатьВТИмяРегистраПоЗначению(ОписаниеПериода, Измерение = "", ЗначениеИзмерения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ОписаниеФильтраДляСоздатьВТИмяРегистраПоЗначению(ОписаниеПериода, Измерение, ЗначениеИзмерения); +``` +
+ +## ОписаниеФильтраДляСоздатьВТИмяРегистраПоСпискуЗначений +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание источника данных - временная таблица. +// +// Параметры: +// ОписаниеПериода - Структура - см. ОписаниеПериодаДляСоздатьВТИмяРегистра +// Измерение - Строка - имена колонок таблицы равные именам измерений регистра, +// по которым устанавливается фильтр, для колонок с именами отличающимися +// от имен измерений, в значениях ключа "СоответствиеИзмеренийРегистраИзмерениямФильтра", +// указывается соответствие имени измерения регистра имени колонки таблицы фильтра. +// Допускается не указывать, когда ТаблицаФильтра имеет тип ТаблицаЗначений. +// СписокЗначенийИзмерения - Массив - значения измерений. +// +// Возвращаемое значение: +// Структура - см. НовыйОписаниеФильтраДляСоздатьВТИмяРегистра. +// +Функция ОписаниеФильтраДляСоздатьВТИмяРегистраПоСпискуЗначений(ОписаниеПериода, Измерение = "", СписокЗначенийИзмерения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ОписаниеФильтраДляСоздатьВТИмяРегистраПоСпискуЗначений(ОписаниеПериода, Измерение, СписокЗначенийИзмерения); +``` +
+ +## ПараметрыПостроенияДляСоздатьВТИмяРегистра +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры построения для СоздатьВТИмяРегистра. +// +// Возвращаемое значение: +// Структура: +// * ИндексироватьПо - Неопределено - см. функцию ПараметрыПостроенияВТИмяРегистра. +// * Отборы - Массив - см. функцию ПараметрыПостроенияВТИмяРегистра. +// * ВключатьЗаписиНаНачалоПериода - Булево - если истина в результирующую таблицу будут +// включены значения по измерениям фильтра на начало периода +// (применимо при построении запросов к регистрам с периодичностью. +// Секунда, День, Месяц, Квартал или Год). +// * ИмяВременнойТаблицыЗаписейНаНачалоПериода - Строка - задает имя временной таблицы записей на начало периода. +// * ИспользуемоеИмяВременнойТаблицыЗаписейНаНачалоПериода - Строка - по окончании работы метода ЗапросВТИмяРегистра +// будет сохранено имя временной таблицы, содержащей записи +// на начало периода, если задано значение +// ИмяВременнойТаблицыЗаписейНаНачалоПериода, то будет +// содержать значение +// ИмяВременнойТаблицыЗаписейНаНачалоПериода. +// * ОтборыЗаписейНаНачалоПериода - Массив - описания отбора (см.ДобавитьВКоллекциюОтбор), применяется к таблице +// формирующий записи на начало периода, при формировании результирующей таблицы. +// +Функция ПараметрыПостроенияДляСоздатьВТИмяРегистра() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ПараметрыПостроенияДляСоздатьВТИмяРегистра() +``` +
+ +## ПараметрыПостроенияДляСоздатьВТИмяРегистраПериоды +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры построения для СоздатьВТИмяРегистраПериоды. +// +// Возвращаемое значение: +// Структура - содержит структуры со свойствами: +// * ИндексироватьПо - Неопределено - см. функцию ПараметрыПостроенияВТИмяРегистра. +// * Отборы - Массив - см. функцию ПараметрыПостроенияВТИмяРегистра. +// * ВключатьЗаписиНаНачалоПериода - Булево - если истина в результирующую таблицу будут +// включены значения по измерениям фильтра на начало периода +// (применимо при построении запросов к регистрам с периодичностью. +// Секунда, День, Месяц, Квартал или Год). +// * ИмяВременнойТаблицыЗаписейНаНачалоПериода - Строка - задает имя временной таблицы записей на начало периода. +// * ИспользуемоеИмяВременнойТаблицыЗаписейНаНачалоПериода - Строка - по окончании работы метода ЗапросВТИмяРегистра +// будет сохранено имя временной таблицы, содержащей записи +// на начало периода, если задано значение +// ИмяВременнойТаблицыЗаписейНаНачалоПериода, то будет +// содержать значение +// ИмяВременнойТаблицыЗаписейНаНачалоПериода. +// * ОтборыЗаписейНаНачалоПериода - Массив - описания отбора (см.ДобавитьВКоллекциюОтбор), применяется к таблице +// формирующий записи на начало периода, при формировании результирующей таблицы. +// +Функция ПараметрыПостроенияДляСоздатьВТИмяРегистраПериоды() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ПараметрыПостроенияДляСоздатьВТИмяРегистраПериоды() +``` +
+ +## ПараметрыПостроенияДляСоздатьВТИмяРегистраСрез +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры построения для СоздатьВТИмяРегистраСрез. +// +// Возвращаемое значение: +// Структура: +// * ИндексироватьПо - Неопределено - см. функцию ПараметрыПостроенияВТИмяРегистра. +// * Отборы - Массив - см. функцию ПараметрыПостроенияВТИмяРегистра. +// * ВсеЗаписи - Булево - если Истина в результирующую таблицу будут включены +// записи таблицы фильтра, для которых нет записей в регистре. +// * ВключаяГраницу - Булево - если Ложь из результирующей таблицы будут исключены +// записи с периодами равными ограничивающим. +// * ОтборыПрименяемыеКСрезу - Массив - коллекции, аналогичных коллекции ключа Отборы, но применяемый +// к полученному срезу. +// +Функция ПараметрыПостроенияДляСоздатьВТИмяРегистраСрез() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПериодическиеРегистры.ПараметрыПостроенияДляСоздатьВТИмяРегистраСрез() +``` +
+ +## СформироватьДвиженияИнтервальногоРегистраПоИзменениям +
+ +Описание, пример вызова + +```bsl + +// Формирует движения интервального регистра сведений по изменениям первичного регистра +// +// Параметры: +// ИмяРегистра - Строка - Имя регистра сведений, имеющего интервальную версию. +// НаборЗаписей - НаборЗаписей - набор записей регистра сведений. +// +Процедура СформироватьДвиженияИнтервальногоРегистраПоИзменениям(ИмяРегистра, НаборЗаписей) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПериодическиеРегистры.СформироватьДвиженияИнтервальногоРегистраПоИзменениям(ИмяРегистра, НаборЗаписей) +``` +
+ +## ОбновитьДвиженияИнтервальногоРегистра +
+ +Описание, пример вызова + +```bsl + +// Обновляет движения интервального регистра сведений +// КадроваяИсторияСотрудников +// +// Параметры: +// ИмяРегистра - Строка - Имя регистра сведений, имеющего интервальную версию. +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц +Процедура ОбновитьДвиженияИнтервальногоРегистра(ИмяРегистра, МенеджерВременныхТаблиц) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПериодическиеРегистры.ОбновитьДвиженияИнтервальногоРегистра(ИмяРегистра, МенеджерВременныхТаблиц) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыПериодическиеРегистрыВнутренний.md b/src/content/docs/zup/ЗарплатаКадрыПериодическиеРегистрыВнутренний.md new file mode 100644 index 0000000..f57d0b7 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыПериодическиеРегистрыВнутренний.md @@ -0,0 +1,29 @@ +--- +title: Зарплата кадры периодические регистры внутренний +slug: zup/зарплата-кадры-периодические-регистры-внутренний +--- + + +## ПриПолученииЗапросаВТИмяРегистраСрез +
+ +Описание, пример вызова + +```bsl + +Процедура ПриПолученииЗапросаВТИмяРегистраСрез(Запрос, ИмяРегистра, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения, СрезПоследних, ИмяСоздаваемойТаблицы) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыПериодическиеРегистрыВнутренний.ПриПолученииЗапросаВТИмяРегистраСрез(Запрос, ИмяРегистра, ТолькоРазрешенные, ОписаниеФильтра, ПараметрыПостроения, СрезПоследних, ИмяСоздаваемойТаблицы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыПовтИсп.md b/src/content/docs/zup/ЗарплатаКадрыПовтИсп.md new file mode 100644 index 0000000..7cd4899 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыПовтИсп.md @@ -0,0 +1,72 @@ +--- +title: Зарплата кадры повт исп +slug: zup/зарплата-кадры-повт-исп +--- + + +## РегистрацияВНалоговомОргане +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на "Регистрацию в налоговом органе" по состоянию на дату. +// +// Параметры: +// СтруктурнаяЕдиница - СправочникСсылка.ПодразделенияОрганизаций, +// СправочникСсылка.Организации, +// ОпределяемыйТип.ТерриторияВыполненияРабот - структурная единица для получения регистрации в НО. +// ДатаАктуальности - Дата - дата, на которую будет получена регистрация. +// +// Возвращаемое значение: +// СправочникСсылка.РегистрацияВНалоговомОргане - ссылка на существующую регистрацию, либо ПустаяСсылка(). +// +Функция РегистрацияВНалоговомОргане(СтруктурнаяЕдиница, Знач ДатаАктуальности = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПовтИсп.РегистрацияВНалоговомОргане(СтруктурнаяЕдиница, ДатаАктуальности); +``` +
+ +## ДатаВступленияВСилуНА +
+ +Описание, пример вызова + +```bsl + +Функция ДатаВступленияВСилуНА(ИмяНА) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПовтИсп.ДатаВступленияВСилуНА(ИмяНА) +``` +
+ +## ДействующийПользовательФизическогоЛица +
+ +Описание, пример вызова + +```bsl + +Функция ДействующийПользовательФизическогоЛица(ФизическоеЛицо) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПовтИсп.ДействующийПользовательФизическогоЛица(ФизическоеЛицо) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыПриложенияВызовСервера.md b/src/content/docs/zup/ЗарплатаКадрыПриложенияВызовСервера.md new file mode 100644 index 0000000..27e52f5 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыПриложенияВызовСервера.md @@ -0,0 +1,61 @@ +--- +title: Зарплата кадры приложения вызов сервера +slug: zup/зарплата-кадры-приложения-вызов-сервера +--- + + +## ЕстьНезачисленияПоВедомости +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьНезачисленияПоВедомости(Ведомость, Проведен = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПриложенияВызовСервера.ЕстьНезачисленияПоВедомости(Ведомость, Проведен); +``` +
+ +## ЕстьДепонированияПоВедомости +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьДепонированияПоВедомости(Ведомость, Проведен = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПриложенияВызовСервера.ЕстьДепонированияПоВедомости(Ведомость, Проведен); +``` +
+ +## ЕстьПодтверждениеВыплатыДоходовПоВедомости +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьПодтверждениеВыплатыДоходовПоВедомости(Ведомость) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыПриложенияВызовСервера.ЕстьПодтверждениеВыплатыДоходовПоВедомости(Ведомость) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыРасширенный.md b/src/content/docs/zup/ЗарплатаКадрыРасширенный.md new file mode 100644 index 0000000..5d838ac --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыРасширенный.md @@ -0,0 +1,158 @@ +--- +title: Зарплата кадры расширенный +slug: zup/зарплата-кадры-расширенный +--- + + +## ЗаписатьНастройкиЗарплатаКадры +
+ +Описание, пример вызова + +```bsl + +// Процедура выполняет запись настроек программы и формирование плана видов расчета по настройкам, +// переданным в параметре Параметры. +// +// Параметры: +// Параметры - структура, описание см ОписаниеПараметровНастройкиЗарплатаКадры. +// +Процедура ЗаписатьНастройкиЗарплатаКадры(Параметры) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенный.ЗаписатьНастройкиЗарплатаКадры(Параметры) +``` +
+ +## ОписаниеПараметровНастройкиЗарплатаКадры +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает структуру с описанием параметров для настройки подсистемы ЗарплатаКадры. +// +// Возвращаемое значение: +// Структура со свойствами, имеющими значение Неопределено: +// * НастройкиРасчетаЗарплаты +// * НастройкиКадровогоУчета +// * НастройкиШтатногоРасписания. +// * НастройкиВоинскогоУчета. +// * НастройкиУчетаВремени +// * НастройкиЗаймовСотрудникам. +// * НастройкиСтатистикиПерсонала. +// * ПараметрыПланВидовРасчета. +// +Функция ОписаниеПараметровНастройкиЗарплатаКадры() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыРасширенный.ОписаниеПараметровНастройкиЗарплатаКадры() +``` +
+ +## ПараметрыНастройкиЗарплатаКадрыПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает структуру с параметрами настройки подсистемы ЗарплатаКадры, +// которые можно использовать по умолчанию для максимального использования функционала подсистемы. +// +// Возвращаемое значение: +// Структура см описание ОписаниеПараметровНастройкиЗарплатаКадры, со свойствами: +// * НастройкиРасчетаЗарплаты - структура, состав свойств соответствует ресурсам регистра сведений +// НастройкиРасчетаЗарплатыРасширенный, может содержать не все ресурсы регистра. +// * НастройкиКадровогоУчета - структура, состав свойств соответствует ресурсам регистра сведений +// НастройкиКадровогоУчета, может содержать не все ресурсы регистра. +// * НастройкиШтатногоРасписания - структура, состав свойств соответствует ресурсам регистра сведений +// НастройкиШтатногоРасписания, может содержать не все ресурсы регистра. +// * НастройкиВоинскогоУчета - структура, состав свойств соответствует ресурсам регистра сведений +// НастройкиВоинскогоУчета, может содержать не все ресурсы регистра. +// * НастройкиУчетаВремени - структура, состав свойств соответствует ресурсам регистра сведений НастройкиУчетаВремени, +// может содержать не все ресурсы регистра. +// * НастройкиЗаймовСотрудникам - структура, состав свойств соответствует ресурсам регистра сведений +// НастройкиЗаймовСотрудникам, может содержать не все ресурсы регистра. +// * НастройкиСтатистикиПерсонала - структура, состав свойств соответствует ресурсам регистра сведений +// НастройкиСтатистикиПерсонала, может содержать не все ресурсы регистра. +// * ПараметрыПланВидовРасчет - структура, состав свойств см в описании +// РасчетЗарплатыРасширенный.ОписаниеПараметровПланаВидовРасчета. +// +Функция ПараметрыНастройкиЗарплатаКадрыПоУмолчанию() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыРасширенный.ПараметрыНастройкиЗарплатаКадрыПоУмолчанию() +``` +
+ +## ОбновитьДанныеПроизводственныхКалендарейПомесячно +
+ +Описание, пример вызова + +```bsl + +// Выполняет формирование сводных (помесячно) сведений о производственном календаре. +// +// Параметры: +// - УсловияОбновления - таблица значений с колонками. +// - КодПроизводственногоКалендаря - код производственного календаря, данные которого изменились, +// - Год - год, за который изменились данные. +// +Процедура ОбновитьДанныеПроизводственныхКалендарейПомесячно(УсловияОбновления) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенный.ОбновитьДанныеПроизводственныхКалендарейПомесячно(УсловияОбновления) +``` +
+ +## ПриСозданииФормыСпискаФайлов +
+ +Описание, пример вызова + +```bsl + +// См. РаботаСФайламиПереопределяемый.ПриСозданииФормыСпискаФайлов. +Процедура ПриСозданииФормыСпискаФайлов(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенный.ПриСозданииФормыСпискаФайлов(Форма) +``` +
+ +## ЗаполнитьНастройкиПечатныхФормПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьНастройкиПечатныхФормПоУмолчанию(ОписанияНастроек) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенный.ЗаполнитьНастройкиПечатныхФормПоУмолчанию(ОписанияНастроек) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыРасширенныйКлиентПереопределяемый.md b/src/content/docs/zup/ЗарплатаКадрыРасширенныйКлиентПереопределяемый.md new file mode 100644 index 0000000..1107008 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыРасширенныйКлиентПереопределяемый.md @@ -0,0 +1,42 @@ +--- +title: Зарплата кадры расширенный клиент переопределяемый +slug: zup/зарплата-кадры-расширенный-клиент-переопределяемый +--- + + +## ОткрытьФормуНастройкиОтветственныхЛиц +
+ +Описание, пример вызова + +```bsl + +// Открывает форму настройки ответственных лиц структурной единицы +// +// Параметры: +// СтруктурнаяЕдиница - ЛюбаяСсылка +// СтандартнаяОбработка - Булево +// +// Пример: +// +// СтандартнаяОбработка = Ложь; +// +// ПараметрыОткрытия = Новый Структура("ОрганизацияСсылка", СтруктурнаяЕдиница); +// ОткрытьФорму("ОбщаяФорма.ОрганизацияОтветственныеЛица", ПараметрыОткрытия); +// +Процедура ОткрытьФормуНастройкиОтветственныхЛиц(СтруктурнаяЕдиница, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйКлиентПереопределяемый.ОткрытьФормуНастройкиОтветственныхЛиц(СтруктурнаяЕдиница, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыРасширенныйПереопределяемый.md b/src/content/docs/zup/ЗарплатаКадрыРасширенныйПереопределяемый.md new file mode 100644 index 0000000..58b2a60 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыРасширенныйПереопределяемый.md @@ -0,0 +1,314 @@ +--- +title: Зарплата кадры расширенный переопределяемый +slug: zup/зарплата-кадры-расширенный-переопределяемый +--- + + +## ОпределитьДоступностьРегистрацииВыполненныхРаботДокументомВводаДанныхДляРасчетаЗарплаты +
+ +Описание, пример вызова + +```bsl + +// Позволяет отключить ввод данных о выполненных работах документом ввода данных для расчета зарплаты. +// Предназначен для случаев, когда регистрация выполненных сдельно работ осуществляется специализированными документами, +// и универсальный инструмент ввода не требуется. +// +// Параметры: +// ДоступностьРегистрации - булево, по умолчанию Истина. +// +Процедура ОпределитьДоступностьРегистрацииВыполненныхРаботДокументомВводаДанныхДляРасчетаЗарплаты(ДоступностьРегистрации) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ОпределитьДоступностьРегистрацииВыполненныхРаботДокументомВводаДанныхДляРасчетаЗарплаты(ДоступностьРегистрации) +``` +
+ +## ОпределитьДоступностьУстановкиИспользованияЗарплатаКадры +
+ +Описание, пример вызова + +```bsl + +// Предназначена для управления доступностью единого флажка включения/отключения библиотеки «Зарплата и кадры» в целом. +// +// Параметры: +// ДоступностьУстановки - булево, по умолчанию Ложь. +// +Процедура ОпределитьДоступностьУстановкиИспользованияЗарплатаКадры(ДоступностьУстановки) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ОпределитьДоступностьУстановкиИспользованияЗарплатаКадры(ДоступностьУстановки) +``` +
+ +## ОпределитьОбязательностьИспользованияШтатногоРасписания +
+ +Описание, пример вызова + +```bsl + +// Предназначена для определения необходимости использования штатного расписания по умолчанию. +// +// Параметры: +// ШтатноеРасписаниеВсегдаИспользуется - тип булево. +// +Процедура ОпределитьОбязательностьИспользованияШтатногоРасписания(ШтатноеРасписаниеВсегдаИспользуется) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ОпределитьОбязательностьИспользованияШтатногоРасписания(ШтатноеРасписаниеВсегдаИспользуется) +``` +
+ +## ПриУстановкеИспользованияЗарплатаКадры +
+ +Описание, пример вызова + +```bsl + +// Обработчик события, возникающего при включении/отключении библиотеки «Зарплата и кадры» в целом. +// +// Параметры: +// Использование - булево, устанавливаемое значение использования. +// +Процедура ПриУстановкеИспользованияЗарплатаКадры(Использование) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ПриУстановкеИспользованияЗарплатаКадры(Использование) +``` +
+ +## ЗаполнитьСведенияОбОтветственныхЛицах +
+ +Описание, пример вызова + +```bsl + +// Заполняет сведения об ответственных лицах +// Параметры: +// СписокФизическихЛиц - Массив, содержит ссылки на физические лица сведения по которым необходимо получить +// СведенияОбОтветственных - ТаблицаЗначений +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// * ПредставлениеДолжности - Строка +// * СтруктурнаяЕдиница - Неопределено +// СтандартнаяОбработка - Булево +// +Процедура ЗаполнитьСведенияОбОтветственныхЛицах(СписокФизическихЛиц, СведенияОбОтветственных, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ЗаполнитьСведенияОбОтветственныхЛицах(СписокФизическихЛиц, СведенияОбОтветственных, СтандартнаяОбработка) +``` +
+ +## ПриУстановкеСоответствияСтруктурыПредприятияСтруктуреЮридическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Устанавливает начальное значение константы СтруктураПредприятияНеСоответствуетСтруктуреЮридическихЛиц +// Параметры: +// Соответствует - Булево, соответствие структуры предприятия и юридической структуры (если Истина, константа устанавливается в Ложь). +// +Процедура ПриУстановкеСоответствияСтруктурыПредприятияСтруктуреЮридическихЛиц(Соответствует) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ПриУстановкеСоответствияСтруктурыПредприятияСтруктуреЮридическихЛиц(Соответствует) +``` +
+ +## ОпределитьИспользованиеСтруктурыПредприятияДляОтраженияВРегламентированномУчете +
+ +Описание, пример вызова + +```bsl + +// Предназначена для определения необходимости использования структуры предприятия для отражения в учете. +// +// Параметры: +// Использование - тип булево. +// +Процедура ОпределитьИспользованиеСтруктурыПредприятияДляОтраженияВРегламентированномУчете(Использование) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ОпределитьИспользованиеСтруктурыПредприятияДляОтраженияВРегламентированномУчете(Использование) +``` +
+ +## ПриОпределенииИдентификацииПриложенияДляGoogle +
+ +Описание, пример вызова + +```bsl + +// Переопределяет данные клиентского приложения, используемые для авторизации в Google +// Подробнее см. ЗарплатаКадрыРасширенный.ИдентификацияПриложенияДляGoogle(). +// +// Параметры: +// ИдентификаторПриложения - Структура +// *client_id - Строка +// *client_secret - Строка +// +Процедура ПриОпределенииИдентификацииПриложенияДляGoogle(ИдентификаторПриложения) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ПриОпределенииИдентификацииПриложенияДляGoogle(ИдентификаторПриложения) +``` +
+ +## ПриОпределенииИдентификацииПриложенияДляHeadHunter +
+ +Описание, пример вызова + +```bsl + +// Переопределяет данные клиентского приложения, используемые для авторизации на сайте hh.ru +// Подробнее см. ЗарплатаКадрыРасширенный.ИдентификацияПриложенияДляHeadHunter +// +// Параметры: +// ИдентификаторПриложения - Структура - содержит: +// *client_id - Строка +// *client_secret - Строка +// *redirect_uri - Строка +// +Процедура ПриОпределенииИдентификацииПриложенияДляHeadHunter(ИдентификаторПриложения) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ПриОпределенииИдентификацииПриложенияДляHeadHunter(ИдентификаторПриложения) +``` +
+ +## ПриОпределенииИдентификацииПриложенияДляЗарплатаРу +
+ +Описание, пример вызова + +```bsl + +// Переопределяет данные клиентского приложения, используемые для авторизации на сайте zarplata.ru +// Подробнее см. ЗарплатаКадрыРасширенный.ИдентификацияПриложенияДляЗарплатаРу +// +// Параметры: +// ИдентификаторПриложения - Структура - содержит: +// *client_id - Строка +// *client_secret - Строка +// *redirect_uri - Строка +// +Процедура ПриОпределенииИдентификацииПриложенияДляЗарплатаРу(ИдентификаторПриложения) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ПриОпределенииИдентификацииПриложенияДляЗарплатаРу(ИдентификаторПриложения) +``` +
+ +## ПриОпределенииИдентификацииПриложенияДляАвитоРабота +
+ +Описание, пример вызова + +```bsl + +// Переопределяет данные клиентского приложения, используемые для авторизации на сайте Avito +// Подробнее см. ЗарплатаКадрыРасширенный.ИдентификацияПриложенияДляАвитоРабота(). +// +// Параметры: +// ИдентификаторПриложения - Структура - содержит: +// *client_id - Строка +// *client_secret - Строка +// *redirect_uri - Строка +// +Процедура ПриОпределенииИдентификацииПриложенияДляАвитоРабота(ИдентификаторПриложения) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ПриОпределенииИдентификацииПриложенияДляАвитоРабота(ИдентификаторПриложения) +``` +
+ +## ПриОпределенииИдентификацииПриложенияДляХабрКарьера +
+ +Описание, пример вызова + +```bsl + +// Переопределяет данные клиентского приложения, используемые для авторизации на сайте career.habr.com +// Подробнее см. ЗарплатаКадрыРасширенный.ИдентификацияПриложенияДляХабрКарьера +// +// Параметры: +// ИдентификаторПриложения - Структура - содержит: +// *client_id - Строка +// *client_secret - Строка +// *redirect_uri - Строка +// +Процедура ПриОпределенииИдентификацииПриложенияДляХабрКарьера(ИдентификаторПриложения) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ПриОпределенииИдентификацииПриложенияДляХабрКарьера(ИдентификаторПриложения) +``` +
+ +## ПриОпределенииИдентификацииПриложенияДляZoom +
+ +Описание, пример вызова + +```bsl + +// Переопределяет данные клиентского приложения, используемые для авторизации на сайте zoom.us +// Подробнее см. ЗарплатаКадрыРасширенный.ИдентификацияПриложенияДляZoom +// +// Параметры: +// ИдентификаторПриложения - Структура - содержит: +// *client_id - Строка +// *client_secret - Строка +// *redirect_uri - Строка +// +Процедура ПриОпределенииИдентификацииПриложенияДляZoom(ИдентификаторПриложения) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыРасширенныйПереопределяемый.ПриОпределенииИдентификацииПриложенияДляZoom(ИдентификаторПриложения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыСоставДокументов.md b/src/content/docs/zup/ЗарплатаКадрыСоставДокументов.md new file mode 100644 index 0000000..f22e530 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыСоставДокументов.md @@ -0,0 +1,351 @@ +--- +title: Зарплата кадры состав документов +slug: zup/зарплата-кадры-состав-документов +--- + + +## НовоеОписаниеСоставаОбъекта +
+ +Описание, пример вызова + +```bsl + +// Для методов служебного API использование не контролируем +// АПК:581-выкл +// АПК:299-выкл + +// Возвращает описание состава объекта. +// +// Возвращаемое значение: +// Структура - список параметров состава объекта: +// * ИмяРеквизитаКраткийСостав - Строка - имя реквизита краткий состав объекта +// * ИмяТабличнойЧастиФизическиеЛица - Строка - имя табличной части физические лица объекта +// * ЗаполнятьТабличнуюЧастьФизическиеЛицаДокумента - Булево - заполнять табличную часть Физические лица объекта +// * ИспользоватьКраткийСостав - Булево - заполнять реквизит краткий состав объекта +// * ЗаполнятьСоставДокументов - Булево - заполнять регистр состава документов для отбора в +// списках и журналов +// * ЗаполнятьФизическиеЛицаПоСотрудникам - Булево - заполнять физические лица по сотрудникам в табличных +// частях/шапке объекта +// * ИспользоватьОграничениеДоступа - Булево - заполнять регистр Физические лица объекта для +// ограничения доступа +// * ОписаниеХраненияСотрудниковФизическихЛиц - Массив - массив структур(см ОписаниеСоставаТабличныхЧастей), +// Необходим для заполнения физических лиц и/или сотрудников +// для добавления используется ДобавитьОписаниеХраненияСотрудниковФизическихЛиц +// * ОписаниеЗаполненияФизическихЛицПоСотрудникам - Массив - массив структур(см ОписаниеСоставаТабличныхЧастей), +// Необходим для заполнения физических лиц по сотрудникам +// для добавления используется ДобавитьОписаниеХраненияСотрудниковФизическихЛиц. +// +Функция НовоеОписаниеСоставаОбъекта() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.НовоеОписаниеСоставаОбъекта() +``` +
+ +## ОписаниеХраненияСотрудниковФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание хранения сотрудников и физических лиц объекта. +// +// Возвращаемое значение: +// Структура - список параметров хранения сотрудников и физических лиц документа: +// * ИмяТаблицы - Строка - имя таблицы с сотрудниками и/или физическими лицами, если данные в шапке, +// указывать Неопределено +// * ПолеФизическоеЛицо - Строка - имя поля физическое лицо, если отсутствует, указываем Неопределено +// * ПолеСотрудник - Строка - имя поля сотрудник, если отсутствует, указываем Неопределено +// * ВключатьВКраткийСостав - Булево - включать ли физическое лицо в краткий состав документа. +// +Функция ОписаниеХраненияСотрудниковФизическихЛиц() Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.ОписаниеХраненияСотрудниковФизическихЛиц() +``` +
+ +## ДобавитьОписаниеХраненияСотрудниковФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Добавляет в массив описание хранения сотрудников физических лиц. +// +// Параметры: +// МассивОписаний - Массив - содержит структуры со свойствами см. НовоеОписаниеСоставаОбъекта. +// ИмяТаблицы - Строка - имя таблицы, хранящей сотрудников и/или физические лица +// ПолеФизическоеЛицо - Строка - имя реквизита ФизическоеЛицо. +// ПолеСотрудник - Строка - имя реквизита Сотрудник. +// +Процедура ДобавитьОписаниеХраненияСотрудниковФизическихЛиц(МассивОписаний, ИмяТаблицы = Неопределено, ПолеФизическоеЛицо = Неопределено, ПолеСотрудник = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыСоставДокументов.ДобавитьОписаниеХраненияСотрудниковФизическихЛиц(МассивОписаний, ИмяТаблицы, ПолеФизическоеЛицо, ПолеСотрудник); +``` +
+ +## ОписаниеСоставаОбъектаФизическоеЛицоВШапке +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание состава документа, в случае хранения физических лиц в табличных частях. +// +// Возвращаемое значение: +// Структура - см. НовоеОписаниеСоставаОбъекта. +// +Функция ОписаниеСоставаОбъектаФизическоеЛицоВШапке(ИмяРеквизитаФизическоеЛицо = "ФизическоеЛицо", ИмяРеквизитаСотрудник = "Сотрудник") Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.ОписаниеСоставаОбъектаФизическоеЛицоВШапке(ИмяРеквизитаФизическоеЛицо, ИмяРеквизитаСотрудник); +``` +
+ +## ОписаниеСоставаОбъектаПоМетаданнымФизическиеЛицаВТабличныхЧастях +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание состава объекта по метаданным, в случае хранения физических лиц в табличных частях. +// +// Возвращаемое значение: +// Структура - см. НовоеОписаниеСоставаОбъекта. +// +Функция ОписаниеСоставаОбъектаПоМетаданнымФизическиеЛицаВТабличныхЧастях(МетаданныеОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.ОписаниеСоставаОбъектаПоМетаданнымФизическиеЛицаВТабличныхЧастях(МетаданныеОбъекта) +``` +
+ +## СоставОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает сотрудников и физических лиц объекта +// +// Параметры: +// Источник - ДокументОбъект, СправочникОбъект - объект для которого необходимо получить состав, +// в модуле менеджера соответствующего объекта метаданных должен быть реализован метод +// ОписаниеСоставаОбъекта +// +// Возвращаемое значение: +// см. НовыйСоставОбъекта - структура с составом объекта +// +Функция СоставОбъекта(Источник) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.СоставОбъекта(Источник) +``` +
+ +## СоставОбъектаПоСсылке +
+ +Описание, пример вызова + +```bsl + +// Возвращает сотрудников и физических лиц объекта по ссылке +// +// Параметры: +// Источник - ДокументСслка, СправочникСсылка - ссылка на объект для которого необходимо получить состав, +// в модуле менеджера соответствующего объекта метаданных должен быть реализован метод +// ОписаниеСоставаОбъекта +// +// Возвращаемое значение: +// см. НовыйСоставОбъекта - структура с составом объекта +// +Функция СоставОбъектаПоСсылке(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.СоставОбъектаПоСсылке(Ссылка) +``` +
+ +## СоставОбъектаПоДаннымФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает сотрудников и физических лиц объекта +// +// Параметры: +// ДанныеФормыОбъекта - ДанныеФормыСтруктура - данные формы содержащие данные объекта +// для которого необходимо получить состав, +// в модуле менеджера соответствующего объекта метаданных должен быть реализован метод +// ОписаниеСоставаОбъекта +// +// Возвращаемое значение: +// см. НовыйСоставОбъекта - структура с составом объекта +// +Функция СоставОбъектаПоДаннымФормы(ДанныеФормыОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.СоставОбъектаПоДаннымФормы(ДанныеФормыОбъекта) +``` +
+ +## ЗарегистрироватьОбработчикиОбновления +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список Обработчики процедуры-обработчики обновления, +// необходимые данной подсистеме. +// +// Параметры: +// Обработчики - ТаблицаЗначений - см. описание функции НоваяТаблицаОбработчиковОбновления +// общего модуля ОбновлениеИнформационнойБазы. +// +Процедура ЗарегистрироватьОбработчикиОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыСоставДокументов.ЗарегистрироватьОбработчикиОбновления(Обработчики) +``` +
+ +## ДокументыФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +Функция ДокументыФизическихЛиц(МассивФизическихЛиц, ОбъектыМетаданных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.ДокументыФизическихЛиц(МассивФизическихЛиц, ОбъектыМетаданных); +``` +
+ +## ДокументыСотрудников +
+ +Описание, пример вызова + +```bsl + +Функция ДокументыСотрудников(МассивСотрудников, ОбъектыМетаданных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.ДокументыСотрудников(МассивСотрудников, ОбъектыМетаданных); +``` +
+ +## ФизическиеЛицаДокументов +
+ +Описание, пример вызова + +```bsl + +Функция ФизическиеЛицаДокументов(МассивДокументов) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.ФизическиеЛицаДокументов(МассивДокументов) +``` +
+ +## ОписаниеОбъектаПоСсылке +
+ +Описание, пример вызова + +```bsl + +Функция ОписаниеОбъектаПоСсылке(Ссылка) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.ОписаниеОбъектаПоСсылке(Ссылка) +``` +
+ +## ОписаниеОбъектаПоПолномуИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание объекта по полному имени. +// +// Параметры: +// ИмяОбъекта - Строка +// +// Возвращаемое значение: см. НовоеОписаниеСоставаОбъекта +Функция ОписаниеОбъектаПоПолномуИмени(ИмяОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ЗарплатаКадрыСоставДокументов.ОписаниеОбъектаПоПолномуИмени(ИмяОбъекта) +``` +
+ +## ПередУничтожениемПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ПередУничтожениемПерсональныхДанных +Процедура ПередУничтожениемПерсональныхДанных(Объект, Субъекты, ВыполнитьЗаписьОбъекта) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыСоставДокументов.ПередУничтожениемПерсональныхДанных(Объект, Субъекты, ВыполнитьЗаписьОбъекта) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗарплатаКадрыСоставДокументовСобытия.md b/src/content/docs/zup/ЗарплатаКадрыСоставДокументовСобытия.md new file mode 100644 index 0000000..b8d61d5 --- /dev/null +++ b/src/content/docs/zup/ЗарплатаКадрыСоставДокументовСобытия.md @@ -0,0 +1,45 @@ +--- +title: Зарплата кадры состав документов события +slug: zup/зарплата-кадры-состав-документов-события +--- + + +## ЗаполнитьСоставСотрудниковДокументаПередЗаписью +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСоставСотрудниковДокументаПередЗаписью(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыСоставДокументовСобытия.ЗаполнитьСоставСотрудниковДокументаПередЗаписью(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## ЗаполнитьСоставСотрудниковДокументаПриЗаписи +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСоставСотрудниковДокументаПриЗаписи(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ЗарплатаКадрыСоставДокументовСобытия.ЗаполнитьСоставСотрудниковДокументаПриЗаписи(Источник, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадры.md b/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадры.md new file mode 100644 index 0000000..57c2787 --- /dev/null +++ b/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадры.md @@ -0,0 +1,186 @@ +--- +title: Защита персональных данных зарплата кадры +slug: zup/защита-персональных-данных-зарплата-кадры +--- + + +## ЗаполнитьСведенияОПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьСведенияОПерсональныхДанных. +Процедура ЗаполнитьСведенияОПерсональныхДанных(ТаблицаСведений) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадры.ЗаполнитьСведенияОПерсональныхДанных(ТаблицаСведений) +``` +
+ +## ЗаполнитьОбластиПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьОбластиПерсональныхДанных. +Процедура ЗаполнитьОбластиПерсональныхДанных(КатегорииПерсональныхДанных) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадры.ЗаполнитьОбластиПерсональныхДанных(КатегорииПерсональныхДанных) +``` +
+ +## ДополнитьДанныеСубъектовПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ДополнитьДанныеСубъектовПерсональныхДанных. +Процедура ДополнитьДанныеСубъектовПерсональныхДанных(СубъектыПерсональныхДанных, ДатаАктуальности) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадры.ДополнитьДанныеСубъектовПерсональныхДанных(СубъектыПерсональныхДанных, ДатаАктуальности) +``` +
+ +## ДополнитьДанныеОрганизацииОператораПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ДополнитьДанныеОрганизацииОператораПерсональныхДанных. +Процедура ДополнитьДанныеОрганизацииОператораПерсональныхДанных(Организация, ДанныеОрганизации, ДатаАктуальности) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадры.ДополнитьДанныеОрганизацииОператораПерсональныхДанных(Организация, ДанныеОрганизации, ДатаАктуальности) +``` +
+ +## ЗаполнитьФИОФизическогоЛица +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьФИОФизическогоЛица. +Процедура ЗаполнитьФИОФизическогоЛица(ФизическоеЛицо, ФИО) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадры.ЗаполнитьФИОФизическогоЛица(ФизическоеЛицо, ФИО) +``` +
+ +## ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных. +Процедура ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных(ТаблицаСведений) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадры.ПриЗаполненииСведенийОбУничтожаемыхПерсональныхДанных(ТаблицаСведений) +``` +
+ +## ПередСкрытиемПерсональныхДанныхСубъектов +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ПередСкрытиемПерсональныхДанныхСубъектов. +Процедура ПередСкрытиемПерсональныхДанныхСубъектов(Субъекты, ТаблицаИсключений, ОтказОтСкрытия) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадры.ПередСкрытиемПерсональныхДанныхСубъектов(Субъекты, ТаблицаИсключений, ОтказОтСкрытия) +``` +
+ +## ПередУничтожениемПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ПередУничтожениемПерсональныхДанных. +Процедура ПередУничтожениемПерсональныхДанных(Объект, Субъекты, ВыполнитьЗаписьОбъекта) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадры.ПередУничтожениемПерсональныхДанных(Объект, Субъекты, ВыполнитьЗаписьОбъекта) +``` +
+ +## ПриРасчетеСроковХраненияПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ПриРасчетеСроковХраненияПерсональныхДанных +Процедура ПриРасчетеСроковХраненияПерсональныхДанных(ДанныеСубъектов, СрокиХранения) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадры.ПриРасчетеСроковХраненияПерсональныхДанных(ДанныеСубъектов, СрокиХранения) +``` +
+ +## УдалитьДанныеСубъекта +
+ +Описание, пример вызова + +```bsl + +// Удаляет данные об уничтожении персональных данных субъекта. +// +// Параметры: +// Субъект - ОпределяемыйТип.СубъектПерсональныхДанных +Процедура УдалитьДанныеСубъекта(Субъект) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадры.УдалитьДанныеСубъекта(Субъект) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадрыКлиент.md b/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадрыКлиент.md new file mode 100644 index 0000000..f059f02 --- /dev/null +++ b/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадрыКлиент.md @@ -0,0 +1,49 @@ +--- +title: Защита персональных данных зарплата кадры клиент +slug: zup/защита-персональных-данных-зарплата-кадры-клиент +--- + + +## ЛетДоУничтоженияПерсональныхДанныхСотрудниковПриИзменении +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Форма - ФормаКлиентскогоПриложения - +Процедура ЛетДоУничтоженияПерсональныхДанныхСотрудниковПриИзменении(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадрыКлиент.ЛетДоУничтоженияПерсональныхДанныхСотрудниковПриИзменении(Форма) +``` +
+ +## НастройкиУничтоженияПерсональныхДанныхПриИзменении +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Форма - ФормаКлиентскогоПриложения - настраиваемая форма. +Процедура НастройкиУничтоженияПерсональныхДанныхПриИзменении(Форма) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадрыКлиент.НастройкиУничтоженияПерсональныхДанныхПриИзменении(Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадрыРасширенныйСобытия.md b/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадрыРасширенныйСобытия.md new file mode 100644 index 0000000..db034c5 --- /dev/null +++ b/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадрыРасширенныйСобытия.md @@ -0,0 +1,29 @@ +--- +title: Защита персональных данных зарплата кадры расширенный события +slug: zup/защита-персональных-данных-зарплата-кадры-расширенный-события +--- + + +## ЗащитаПерсональныхДанныхЗарплатаКадрыПриЗаписиДокумента +
+ +Описание, пример вызова + +```bsl + +Процедура ЗащитаПерсональныхДанныхЗарплатаКадрыПриЗаписиДокумента(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадрыРасширенныйСобытия.ЗащитаПерсональныхДанныхЗарплатаКадрыПриЗаписиДокумента(Источник, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадрыСобытия.md b/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадрыСобытия.md new file mode 100644 index 0000000..c867253 --- /dev/null +++ b/src/content/docs/zup/ЗащитаПерсональныхДанныхЗарплатаКадрыСобытия.md @@ -0,0 +1,45 @@ +--- +title: Защита персональных данных зарплата кадры события +slug: zup/защита-персональных-данных-зарплата-кадры-события +--- + + +## ЗарегистрироватьИзменениеКадровойИсторииДляПерсональныхДанныхПриЗаписи +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьИзменениеКадровойИсторииДляПерсональныхДанныхПриЗаписи(Источник, Отказ, Замещение) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадрыСобытия.ЗарегистрироватьИзменениеКадровойИсторииДляПерсональныхДанныхПриЗаписи(Источник, Отказ, Замещение) +``` +
+ +## ЗарегистрироватьИзменениеПериодаДействияДоговораГПХ +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьИзменениеПериодаДействияДоговораГПХ(Источник, Отказ, Замещение) Экспорт +``` + +Пример вызова +```bsl +ЗащитаПерсональныхДанныхЗарплатаКадрыСобытия.ЗарегистрироватьИзменениеПериодаДействияДоговораГПХ(Источник, Отказ, Замещение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияSmartway.md b/src/content/docs/zup/ИнтеграцияSmartway.md new file mode 100644 index 0000000..dd60a37 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияSmartway.md @@ -0,0 +1,47 @@ +--- +title: Интеграция smartway +slug: zup/интеграция-smartway +--- + + +## ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам +
+ +Описание, пример вызова + +```bsl + +// См. РаботаВБезопасномРежимеПереопределяемый.ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам. +// +Процедура ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам(ЗапросыРазрешений) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияSmartway.ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам(ЗапросыРазрешений) +``` +
+ +## ОтправитьСотрудников +
+ +Описание, пример вызова + +```bsl + +Процедура ОтправитьСотрудников(СистемаБронирования, ДанныеФизическихЛиц, ПараметрыОтправки) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияSmartway.ОтправитьСотрудников(СистемаБронирования, ДанныеФизическихЛиц, ПараметрыОтправки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияБСПБЭДСлужебныйКлиент.md b/src/content/docs/zup/ИнтеграцияБСПБЭДСлужебныйКлиент.md new file mode 100644 index 0000000..cb1b64c --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияБСПБЭДСлужебныйКлиент.md @@ -0,0 +1,29 @@ +--- +title: Интеграция БСП БЭД служебный клиент +slug: zup/интеграция-бсп-бэд-служебный-клиент +--- + + +## ПослеПодключенияОбсуждений +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеПодключенияОбсуждений(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияБСПБЭДСлужебныйКлиент.ПослеПодключенияОбсуждений(Результат, ДополнительныеПараметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияБСПБЭДСлужебныйКлиентСервер.md b/src/content/docs/zup/ИнтеграцияБСПБЭДСлужебныйКлиентСервер.md new file mode 100644 index 0000000..5099354 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияБСПБЭДСлужебныйКлиентСервер.md @@ -0,0 +1,45 @@ +--- +title: Интеграция БСП БЭД служебный клиент сервер +slug: zup/интеграция-бсп-бэд-служебный-клиент-сервер +--- + + +## ВидОшибкиНедействительныйПользователь +
+ +Описание, пример вызова + +```bsl + +Функция ВидОшибкиНедействительныйПользователь() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияБСПБЭДСлужебныйКлиентСервер.ВидОшибкиНедействительныйПользователь() +``` +
+ +## ИндексПиктограммыФайла +
+ +Описание, пример вызова + +```bsl + +Функция ИндексПиктограммыФайла(РасширениеФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияБСПБЭДСлужебныйКлиентСервер.ИндексПиктограммыФайла(РасширениеФайла) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияКабинетСотрудника.md b/src/content/docs/zup/ИнтеграцияКабинетСотрудника.md new file mode 100644 index 0000000..022cd55 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияКабинетСотрудника.md @@ -0,0 +1,1089 @@ +--- +title: Интеграция кабинет сотрудника +slug: zup/интеграция-кабинет-сотрудника +--- + + +## СохранитьНовыеНастройкиПодключения +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьНовыеНастройкиПодключения(АдресПриложения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.СохранитьНовыеНастройкиПодключения(АдресПриложения) +``` +
+ +## НоваяТаблицаВыгружаемыеОбъекты +
+ +Описание, пример вызова + +```bsl + +Функция НоваяТаблицаВыгружаемыеОбъекты() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.НоваяТаблицаВыгружаемыеОбъекты() +``` +
+ +## НоваяТаблицаИзмененияДляОбмена +
+ +Описание, пример вызова + +```bsl + +Функция НоваяТаблицаИзмененияДляОбмена() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.НоваяТаблицаИзмененияДляОбмена() +``` +
+ +## ВыполнитьОбработчикиОбмена +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполнитьОбработчикиОбмена(МенеджерОбмена) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ВыполнитьОбработчикиОбмена(МенеджерОбмена) +``` +
+ +## ЗарегистрироватьОбработчикОбмена +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьОбработчикОбмена(ИмяОбработчика, ПроверятьРегистрацию = Истина) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ЗарегистрироватьОбработчикОбмена(ИмяОбработчика, ПроверятьРегистрацию); +``` +
+ +## ОтключитьОбработчикОбмена +
+ +Описание, пример вызова + +```bsl + +Процедура ОтключитьОбработчикОбмена(ИмяОбработчика) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ОтключитьОбработчикОбмена(ИмяОбработчика) +``` +
+ +## ИмяОбработчикаЗарегистрироватьИзмененияПлановыхУдержаний +
+ +Описание, пример вызова + +```bsl + +Функция ИмяОбработчикаЗарегистрироватьИзмененияПлановыхУдержаний() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ИмяОбработчикаЗарегистрироватьИзмененияПлановыхУдержаний() +``` +
+ +## ИмяОбработчикаЗарегистрироватьПубликациюМашиночитаемыхДоверенностей +
+ +Описание, пример вызова + +```bsl + +Функция ИмяОбработчикаЗарегистрироватьПубликациюМашиночитаемыхДоверенностей() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ИмяОбработчикаЗарегистрироватьПубликациюМашиночитаемыхДоверенностей()); +``` +
+ +## ЗарегистрироватьПубликациюМашиночитаемыхДоверенностей +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьПубликациюМашиночитаемыхДоверенностей() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ЗарегистрироватьПубликациюМашиночитаемыхДоверенностей()); +``` +
+ +## ИмяОбработчикаОбновлениеОрганизацийИДолжностей +
+ +Описание, пример вызова + +```bsl + +Функция ИмяОбработчикаОбновлениеОрганизацийИДолжностей() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ИмяОбработчикаОбновлениеОрганизацийИДолжностей()); +``` +
+ +## ЗарегистрироватьОбновлениеОрганизацийИДолжностей +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьОбновлениеОрганизацийИДолжностей() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ЗарегистрироватьОбновлениеОрганизацийИДолжностей()); +``` +
+ +## ИмяОбработчикаЗарегистрироватьВыгрузкуШаблоновДокументов +
+ +Описание, пример вызова + +```bsl + +Функция ИмяОбработчикаЗарегистрироватьВыгрузкуШаблоновДокументов() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ИмяОбработчикаЗарегистрироватьВыгрузкуШаблоновДокументов()); +``` +
+ +## ЗарегистрироватьВыгрузкуШаблоновДокументов +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьВыгрузкуШаблоновДокументов() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ЗарегистрироватьВыгрузкуШаблоновДокументов()); +``` +
+ +## ИмяОбработчикаОбновлениеОрганизаци +
+ +Описание, пример вызова + +```bsl + +Функция ИмяОбработчикаОбновлениеОрганизаци() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ИмяОбработчикаОбновлениеОрганизаци()); +``` +
+ +## ЗарегистрироватьОбновлениеОрганизаций +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьОбновлениеОрганизаций() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ЗарегистрироватьОбновлениеОрганизаций()); +``` +
+ +## ПриложениеЗаблокировано +
+ +Описание, пример вызова + +```bsl + +Функция ПриложениеЗаблокировано() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ПриложениеЗаблокировано() +``` +
+ +## ОбновитьСведенияОПубликацииФизическихЛицИсключений +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьСведенияОПубликацииФизическихЛицИсключений(ФизическиеЛица) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ОбновитьСведенияОПубликацииФизическихЛицИсключений(ФизическиеЛица) +``` +
+ +## ОрганизацииГдеФизическиеЛицаРуководители +
+ +Описание, пример вызова + +```bsl + +Функция ОрганизацииГдеФизическиеЛицаРуководители(ФизическиеЛица) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ОрганизацииГдеФизическиеЛицаРуководители(ФизическиеЛица)); +``` +
+ +## ПодразделенияДляОбновленияРуководителя +
+ +Описание, пример вызова + +```bsl + +Функция ПодразделенияДляОбновленияРуководителя(Организации) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ПодразделенияДляОбновленияРуководителя(Организации)); +``` +
+ +## СохранитьНастройкиИспользуемаяФункциональностьСервиса +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьНастройкиИспользуемаяФункциональностьСервиса(НастройкиФункциональность, СообщениеОбОшибке = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.СохранитьНастройкиИспользуемаяФункциональностьСервиса(НастройкиФункциональность, СообщениеОбОшибке); +``` +
+ +## ИспользуемаяФункциональностьСервиса +
+ +Описание, пример вызова + +```bsl + +Функция ИспользуемаяФункциональностьСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ИспользуемаяФункциональностьСервиса() +``` +
+ +## ТребуетсяОбновитьНастройкиФункциональности +
+ +Описание, пример вызова + +```bsl + +Функция ТребуетсяОбновитьНастройкиФункциональности() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ТребуетсяОбновитьНастройкиФункциональности() +``` +
+ +## УстановитьТребуетсяОбновитьНастройкиФункциональности +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьТребуетсяОбновитьНастройкиФункциональности(НовоеЗначение) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.УстановитьТребуетсяОбновитьНастройкиФункциональности(НовоеЗначение) +``` +
+ +## СистемнаяУчетнаяЗаписьНастроена +
+ +Описание, пример вызова + +```bsl + +Функция СистемнаяУчетнаяЗаписьНастроена() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.СистемнаяУчетнаяЗаписьНастроена()); +``` +
+ +## ТребуетсяОбновитьНастройкиЗаявленийНаОтпуск +
+ +Описание, пример вызова + +```bsl + +Функция ТребуетсяОбновитьНастройкиЗаявленийНаОтпуск() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ТребуетсяОбновитьНастройкиЗаявленийНаОтпуск() +``` +
+ +## НастройкиЗаявленийНаОтпуск +
+ +Описание, пример вызова + +```bsl + +Функция НастройкиЗаявленийНаОтпуск() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.НастройкиЗаявленийНаОтпуск() +``` +
+ +## УстановитьТребуетсяОбновитьНастройкиЗаявленийНаОтпуск +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьТребуетсяОбновитьНастройкиЗаявленийНаОтпуск(УстановленныеНастройки) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.УстановитьТребуетсяОбновитьНастройкиЗаявленийНаОтпуск(УстановленныеНастройки) +``` +
+ +## СохранитьНастройкиЗаявокНаОтпуск +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьНастройкиЗаявокНаОтпуск(НастройкиЗаявокНаОтпуск, СообщениеОбОшибке = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.СохранитьНастройкиЗаявокНаОтпуск(НастройкиЗаявокНаОтпуск, СообщениеОбОшибке); +``` +
+ +## ЗарегистрироватьОпубликоватьОтветственного +
+ +Описание, пример вызова + +```bsl + +Функция ЗарегистрироватьОпубликоватьОтветственного(Ответственный) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ЗарегистрироватьОпубликоватьОтветственного(Ответственный) +``` +
+ +## Перенос_ИзмененияДляОбменаКабинетСотрудника +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_ИзмененияДляОбменаКабинетСотрудника() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_ИзмененияДляОбменаКабинетСотрудника()); +``` +
+ +## Перенос_ВыгружаемыеОбъектыКабинетСотрудника +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_ВыгружаемыеОбъектыКабинетСотрудника() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_ВыгружаемыеОбъектыКабинетСотрудника()); +``` +
+ +## Перенос_ИдентификаторыНезагруженныхОбъектовКабинетСотрудника +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_ИдентификаторыНезагруженныхОбъектовКабинетСотрудника() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_ИдентификаторыНезагруженныхОбъектовКабинетСотрудника()); +``` +
+ +## Перенос_ОбъектыСОшибкамиЗаполненияКабинетСотрудника +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_ОбъектыСОшибкамиЗаполненияКабинетСотрудника() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_ОбъектыСОшибкамиЗаполненияКабинетСотрудника()); +``` +
+ +## Перенос_ПравилаПубликацииКабинетСотрудника +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_ПравилаПубликацииКабинетСотрудника() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_ПравилаПубликацииКабинетСотрудника()); +``` +
+ +## Перенос_РезультатОбменаКабинетСотрудника +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_РезультатОбменаКабинетСотрудника() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_РезультатОбменаКабинетСотрудника()); +``` +
+ +## Перенос_СотрудникиДляОбновленияПубликуемыхОбъектов +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_СотрудникиДляОбновленияПубликуемыхОбъектов() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_СотрудникиДляОбновленияПубликуемыхОбъектов()); +``` +
+ +## Перенос_НеобработанныеРезультатыСогласованияКабинетСотрудника +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_НеобработанныеРезультатыСогласованияКабинетСотрудника() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_НеобработанныеРезультатыСогласованияКабинетСотрудника()); +``` +
+ +## Перенос_ВерсияИзмененийКабинетСотрудника +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_ВерсияИзмененийКабинетСотрудника() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_ВерсияИзмененийКабинетСотрудника()); +``` +
+ +## Перенос_НастройкиИнтеграцииУправлениеПерсоналом +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_НастройкиИнтеграцииУправлениеПерсоналом() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_НастройкиИнтеграцииУправлениеПерсоналом()); +``` +
+ +## Перенос_ВыгруженныеОбъекты +
+ +Описание, пример вызова + +```bsl + +Процедура Перенос_ВыгруженныеОбъекты() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.Перенос_ВыгруженныеОбъекты()); +``` +
+ +## ЗаполнитьПубличныеИдентификаторы +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьПубличныеИдентификаторы() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ЗаполнитьПубличныеИдентификаторы()); +``` +
+ +## ТипОбъектаПоТипуОбъектаКС +
+ +Описание, пример вызова + +```bsl + +Функция ТипОбъектаПоТипуОбъектаКС() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ТипОбъектаПоТипуОбъектаКС()); +``` +
+ +## ТипЗначенияТипОбъекта +
+ +Описание, пример вызова + +```bsl + +// Используется только для переноса данных. +// Описание состава соответсвует прежней версии. +// +Функция ТипЗначенияТипОбъекта() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ТипЗначенияТипОбъекта()); +``` +
+ +## ПеренестиДанныеВНовыеРегистры +
+ +Описание, пример вызова + +```bsl + +Процедура ПеренестиДанныеВНовыеРегистры() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ПеренестиДанныеВНовыеРегистры() +``` +
+ +## ОбновитьВыгруженныеДанные +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьВыгруженныеДанные(ПараметрыОбновления = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ОбновитьВыгруженныеДанные(ПараметрыОбновления); +``` +
+ +## ЗарегистрироватьОграничениеДоступаКРабочимКонтактам +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьОграничениеДоступаКРабочимКонтактам(ПараметрыОбновления = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ЗарегистрироватьОграничениеДоступаКРабочимКонтактам(ПараметрыОбновления); +``` +
+ +## ЗаполнитьНастройкиПодключения +
+ +Описание, пример вызова + +```bsl + +Функция ЗаполнитьНастройкиПодключения(НастройкиПодключения) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ЗаполнитьНастройкиПодключения(НастройкиПодключения) +``` +
+ +## ТипЗаявкиТипОбъекта +
+ +Описание, пример вызова + +```bsl + +Функция ТипЗаявкиТипОбъекта() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ТипЗаявкиТипОбъекта() +``` +
+ +## ДобавитьБлокировкуРегистрацияОбъектовДляОбмена +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьБлокировкуРегистрацияОбъектовДляОбмена(Блокировка, ОбъектыДляРегистрации) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ДобавитьБлокировкуРегистрацияОбъектовДляОбмена(Блокировка, ОбъектыДляРегистрации) +``` +
+ +## ЗаписатьОбъектыДляОбмена +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаписатьОбъектыДляОбмена(ОбъектыДляРегистрации) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ЗаписатьОбъектыДляОбмена(ОбъектыДляРегистрации) +``` +
+ +## ФизическиеЛицаИсключения +
+ +Описание, пример вызова + +```bsl + +Функция ФизическиеЛицаИсключения() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ФизическиеЛицаИсключения() +``` +
+ +## ДоступнаВерсияDTO_2_0 +
+ +Описание, пример вызова + +```bsl + +Функция ДоступнаВерсияDTO_2_0() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ДоступнаВерсияDTO_2_0()); +``` +
+ +## ОбновитьАктуальностьИнформацииОбОтпуске +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьАктуальностьИнформацииОбОтпуске(ОбработанныеСотрудники, АктуальностьИнформацииОбОтпуске) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ОбновитьАктуальностьИнформацииОбОтпуске(ОбработанныеСотрудники, АктуальностьИнформацииОбОтпуске) +``` +
+ +## ИменаСобытийЖР +
+ +Описание, пример вызова + +```bsl + +Функция ИменаСобытийЖР() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ИменаСобытийЖР() +``` +
+ +## ДоступнаПубликацияРасчетныхЛистков +
+ +Описание, пример вызова + +```bsl + +Функция ДоступнаПубликацияРасчетныхЛистков() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ДоступнаПубликацияРасчетныхЛистков() +``` +
+ +## ИспользуетсяКадровыйЭДО +
+ +Описание, пример вызова + +```bsl + +Функция ИспользуетсяКадровыйЭДО() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ИспользуетсяКадровыйЭДО() +``` +
+ +## СпособПолученияСогласияНаПрисоединениеККЭДО +
+ +Описание, пример вызова + +```bsl + +Функция СпособПолученияСогласияНаПрисоединениеККЭДО() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.СпособПолученияСогласияНаПрисоединениеККЭДО()); +``` +
+ +## ЗарегистрироватьПубликациюВидовСправок +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьПубликациюВидовСправок() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ЗарегистрироватьПубликациюВидовСправок() +``` +
+ +## ВключитьСборГрафиковОтпусков +
+ +Описание, пример вызова + +```bsl + +Процедура ВключитьСборГрафиковОтпусков() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ВключитьСборГрафиковОтпусков() +``` +
+ +## ОтключитьКабинетыНепубликуемыхСотрудников +
+ +Описание, пример вызова + +```bsl + +Функция ОтключитьКабинетыНепубликуемыхСотрудников() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ОтключитьКабинетыНепубликуемыхСотрудников()); +``` +
+ +## ОтключитьКабинетыПоИдентификаторам +
+ +Описание, пример вызова + +```bsl + +Функция ОтключитьКабинетыПоИдентификаторам(Идентификаторы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ОтключитьКабинетыПоИдентификаторам(Идентификаторы) +``` +
+ +## ИмяКомандыПодписатьФормыПечатьДокументов +
+ +Описание, пример вызова + +```bsl + + +Функция ИмяКомандыПодписатьФормыПечатьДокументов() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ИмяКомандыПодписатьФормыПечатьДокументов()); +``` +
+ +## ДобавитьПолеСведенийОДатахОтключенияФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +Функция ДобавитьПолеСведенийОДатахОтключенияФизическихЛиц(ИмяПоля, ТекстыОписанияПолей, ИсточникиДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ДобавитьПолеСведенийОДатахОтключенияФизическихЛиц(ИмяПоля, ТекстыОписанияПолей, ИсточникиДанных) +``` +
+ +## НеобходимыДатыОтключенияФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +Функция НеобходимыДатыОтключенияФизическихЛиц(ИмяПоля) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.НеобходимыДатыОтключенияФизическихЛиц(ИмяПоля) +``` +
+ +## ПутьКДаннымСведенийОДатахОтключенияФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +Функция ПутьКДаннымСведенийОДатахОтключенияФизическихЛиц(ИмяПоля) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ПутьКДаннымСведенийОДатахОтключенияФизическихЛиц(ИмяПоля)); +``` +
+ +## ЗапросВТСведенияОДатахОтключенияФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +Функция ЗапросВТСведенияОДатахОтключенияФизическихЛиц(ТолькоРазрешенные, ОписательВременнойТаблицыОтборов) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияКабинетСотрудника.ЗапросВТСведенияОДатахОтключенияФизическихЛиц(ТолькоРазрешенные, ОписательВременнойТаблицыОтборов)); +``` +
+ +## ДобавитьТекстЗапросаВТСведенияОДатахОтключенияФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьТекстЗапросаВТСведенияОДатахОтключенияФизическихЛиц(Запрос, ТолькоРазрешенные, ОписательВременнойТаблицыОтборов, ИсточникиДанных) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудника.ДобавитьТекстЗапросаВТСведенияОДатахОтключенияФизическихЛиц(Запрос, ТолькоРазрешенные, ОписательВременнойТаблицыОтборов, ИсточникиДанных) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияКабинетСотрудникаВызовСервера.md b/src/content/docs/zup/ИнтеграцияКабинетСотрудникаВызовСервера.md new file mode 100644 index 0000000..73437b8 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияКабинетСотрудникаВызовСервера.md @@ -0,0 +1,29 @@ +--- +title: Интеграция кабинет сотрудника вызов сервера +slug: zup/интеграция-кабинет-сотрудника-вызов-сервера +--- + + +## ОбработкаСлужебногоОповещения +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаСлужебногоОповещения(ОписаниеСообщения, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудникаВызовСервера.ОбработкаСлужебногоОповещения(ОписаниеСообщения, ДополнительныеПараметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияКабинетСотрудникаОбсуждения.md b/src/content/docs/zup/ИнтеграцияКабинетСотрудникаОбсуждения.md new file mode 100644 index 0000000..6cafd59 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияКабинетСотрудникаОбсуждения.md @@ -0,0 +1,29 @@ +--- +title: Интеграция кабинет сотрудника обсуждения +slug: zup/интеграция-кабинет-сотрудника-обсуждения +--- + + +## ПриДобавленииРазделенныхПараметровРаботыКлиентаПриЗапуске +
+ +Описание, пример вызова + +```bsl + +Процедура ПриДобавленииРазделенныхПараметровРаботыКлиентаПриЗапуске(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияКабинетСотрудникаОбсуждения.ПриДобавленииРазделенныхПараметровРаботыКлиентаПриЗапуске(Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборот.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборот.md new file mode 100644 index 0000000..f2518bf --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборот.md @@ -0,0 +1,997 @@ +--- +title: Интеграция с 1С документооборот +slug: zup/интеграция-с-1с-документооборот +--- + + +## ИспользоватьИнтеграцию +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию, включена ли интеграция с 1С:Документооборотом редакции 2. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользоватьИнтеграцию() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ИспользоватьИнтеграцию() +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Добавляет команды Документооборота на форму объекта при создании на сервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана процедура. +// МестоРазмещенияКоманд - ГруппаФормы - место для размещения, по умолчанию - командная панель формы. +// ПараметрыОповещения - Структура - параметры, где может быть установлен источник команды. +// Ссылка - ЛюбаяСсылка - ссылка на объект ИС, являющийся основным объектом формы. +// +Процедура ПриСозданииНаСервере(Форма, МестоРазмещенияКоманд = Неопределено, ПараметрыОповещения = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ПриСозданииНаСервере(Форма, МестоРазмещенияКоманд, ПараметрыОповещения, ); +``` +
+ +## ПередЗаписьюНаСервере +
+ +Описание, пример вызова + +```bsl + +// Помещает в дополнительные свойства идентификатор объекта-основания. Вызывается перед записью объекта. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма записываемого объекта. +// Объект - ДокументОбъект, СправочникОбъект - записываемый объект. +// ПараметрыЗаписи - Структура - структура, содержащая параметры записи. +// +Процедура ПередЗаписьюНаСервере(Форма, Объект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ПередЗаписьюНаСервере(Форма, Объект, ПараметрыЗаписи) +``` +
+ +## ПолучитьНовыйОбъект +
+ +Описание, пример вызова + +```bsl + +// Получает заполненный по-умолчанию объект из Документооборота. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Тип - Строка - имя типа XDTO объекта. +// Предмет - Структура - Используется для получения бизнес-процессов: +// * ID - Строка - уникальный идентификатор объекта в Документооборот. +// * type - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMGetNewObjectResponse. +// +Функция ПолучитьНовыйОбъект(Прокси, Тип, Предмет) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ПолучитьНовыйОбъект(Прокси, Тип, Предмет) +``` +
+ +## ПолучитьФайлыСвязанныхДокументов +
+ +Описание, пример вызова + +```bsl + +// Начинает получение файлов связанных документов. +// +// Параметры: +// СвязанныеДокументы - Массив из Структура: +// * ID - Строка - идентификатор связанного документа. +// * Тип - Строка - тип связанного документа. +// +// Возвращаемое значение: +// Строка - адрес во временном хранилище, куда будет помещен результат. +// +Функция ПолучитьФайлыСвязанныхДокументов(СвязанныеДокументы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ПолучитьФайлыСвязанныхДокументов(СвязанныеДокументы) +``` +
+ +## ПолучитьФайлыСвязанныхДокументовАсинхронно +
+ +Описание, пример вызова + +```bsl + +// Асинхронно, в фоновом задании, получает файлы связанных документов. +// +// Параметры: +// Адрес - Строка - адрес для результата выполнения во временном хранилище. +// СвязанныеДокументы - Массив из Структура: +// * ID - Строка - идентификатор связанного документа. +// * Тип - Строка - тип связанного документа. +// ИмяПользователя - Строка - имя пользователя ДО, сохраненного в настройках пользователя, +// из сеанса которого инициирован асинхронный вызов. +// Пароль - Строка - пароль этого пользователя. +// +Процедура ПолучитьФайлыСвязанныхДокументовАсинхронно(Адрес, СвязанныеДокументы, ИмяПользователя, Пароль) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ПолучитьФайлыСвязанныхДокументовАсинхронно(Адрес, СвязанныеДокументы, ИмяПользователя, Пароль) +``` +
+ +## ПолучитьПодходящиеОбъектыДляДобавленияСвязей +
+ +Описание, пример вызова + +```bsl + +// Получает список объектов по ссылкам из указанного объекта ИС, подходящих для автоматического +// добавления связей (имеющих настроенные правила интеграции). Учитывает табличные части. +// +// Параметры: +// СсылкаНаОбъектИС - ЛюбаяСсылка - объект ИС, связи к которому добавляются. +// +// Возвращаемое значение: +// Массив из ЛюбаяСсылка - ссылки на подходящие объекты ИС. +// +Функция ПолучитьПодходящиеОбъектыДляДобавленияСвязей(СсылкаНаОбъектИС) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ПолучитьПодходящиеОбъектыДляДобавленияСвязей(СсылкаНаОбъектИС) +``` +
+ +## ПояснениеСостоянияСогласования +
+ +Описание, пример вызова + +```bsl + +// Получает пояснение к состоянию согласования, предназначенное для чтения пользователем. +// +// Параметры: +// Установил - Строка - представление пользователя, установившего новое состояние. +// ДатаУстановки - Дата - дата и время установки нового состояния. +// +// Возвращаемое значение: +// Строка - пояснение к состоянию согласования. +// +Функция ПояснениеСостоянияСогласования(Установил, ДатаУстановки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ПояснениеСостоянияСогласования(Установил, ДатаУстановки) +``` +
+ +## ПрисоединяемыеПечатныеФормы +
+ +Описание, пример вызова + +```bsl + +// Формирует универсальную таблицу присоединяемых печатных форм для последующего создания. +// +// Параметры: +// ПечатныеФормы - ТаблицаЗначений - табличная часть справочника ПравилаИнтеграцииС1СДокументооборотом: +// * ИмяКоманды - Строка +// * МенеджерПечати - Строка +// * Обновлять - Булево +// * ПредставлениеКоманды - Строка +// * ДополнительныеПараметры - Строка +// +// Возвращаемое значение: +// ТаблицаЗначений - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПрисоединяемыеПечатныеФормы +// +Функция ПрисоединяемыеПечатныеФормы(ПечатныеФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ПрисоединяемыеПечатныеФормы(ПечатныеФормы) +``` +
+ +## УстановитьПравилаЗаполненияПриВыгрузкеПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Заполняет правила заполнения при выгрузке по умолчанию. +// +// Параметры: +// ПравилаЗаполнения - Соответствие из КлючИЗначение - соответствие имен реквизитов свойствам XDTO: +// * Ключ - Строка - имя реквизита. +// * Значение - Строка - наименование свойства XDTO. +// Приемник - Строка - имя XDTO-типа приемника. +// Источник - Строка - полное имя объекта метаданных-источника. +// +Процедура УстановитьПравилаЗаполненияПриВыгрузкеПоУмолчанию(ПравилаЗаполнения, Приемник, Источник) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.УстановитьПравилаЗаполненияПриВыгрузкеПоУмолчанию(ПравилаЗаполнения, Приемник, Источник) +``` +
+ +## УстановитьПравилаЗаполненияПриЗагрузкеПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Заполняет правила заполнения при загрузке по умолчанию. +// +// Параметры: +// ПравилаЗаполнения - Соответствие из КлючИЗначение - соответствие имен реквизитов свойствам XDTO: +// * Ключ - Строка - имя реквизита. +// * Значение - Строка - наименование свойства XDTO. +// Приемник - Строка - полное имя объекта метаданных-приемника. +// Источник - Строка - имя XDTO-типа источника. +// +Процедура УстановитьПравилаЗаполненияПриЗагрузкеПоУмолчанию(ПравилаЗаполнения, Приемник, Источник) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.УстановитьПравилаЗаполненияПриЗагрузкеПоУмолчанию(ПравилаЗаполнения, Приемник, Источник) +``` +
+ +## ОписаниеВебСервисов +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание веб-сервиса 1С:Документооборота. +// +// Возвращаемое значение: +// Строка +// +Функция ОписаниеВебСервисов() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ОписаниеВебСервисов() +``` +
+ +## ПроверитьОбновитьДанныеСвязанныхОбъектов +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие связанных объектов, если их не оказывается, получает сведения о них из Документооборота. +// +Процедура ПроверитьОбновитьДанныеСвязанныхОбъектов() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ПроверитьОбновитьДанныеСвязанныхОбъектов() +``` +
+ +## НовыйБизнесПроцессПоШаблону +
+ +Описание, пример вызова + +```bsl + +// Получает объект XDTO бизнес-процесса, заполненный по данным переданных предмета и шаблона. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Тип - Строка - тип бизнес-процесса. +// Шаблон - Структура: +// * ID - Строка - идентификатор шаблона. +// * type - Строка - тип шаблона. +// Предмет - Структура: +// * ID - Строка - идентификатор предмета. +// * type - Строка - тип предмета. +// +// Возвращаемое значение: +// ОбъектXDTO - XDTO объект с типом бизнес-процесса. +// +Функция НовыйБизнесПроцессПоШаблону(Прокси, Тип, Шаблон, Предмет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.НовыйБизнесПроцессПоШаблону(Прокси, Тип, Шаблон, Предмет); +``` +
+ +## ЗапуститьБизнесПроцесс +
+ +Описание, пример вызова + +```bsl + +// Выполняет сохранение и запуск бизнес-процесса. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Объект - ОбъектXDTO - XDTO объект, хранящий данные бизнес-процесса. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект типа DMLaunchBusinessProcessResponse. +// +Функция ЗапуститьБизнесПроцесс(Прокси, Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ЗапуститьБизнесПроцесс(Прокси, Объект) +``` +
+ +## ИндексКартинкиПометкиЗавершения +
+ +Описание, пример вызова + +```bsl + +// Возвращает индекс картинки пометки завершения процесса или задачи по значению пометки. +// +// Параметры: +// Значение - Строка - значение пометки. +// +// Возвращаемое значение: +// Число - индекс картинки. +// +Функция ИндексКартинкиПометкиЗавершения(Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ИндексКартинкиПометкиЗавершения(Значение) +``` +
+ +## ПолучитьОбъектXDTOПроцесса +
+ +Описание, пример вызова + +```bsl + +// Возвращает объект XDTO бизнес-процесса, заполненный в соответствие с параметрами. +// +// Параметры: +// ТипПроцессаXDTO - Строка - тип бизнес-процесса. +// Параметры - Структура: +// * ID - Строка - идентификатор бизнес-процесса. +// * type - Строка - тип бизнес-процесса. +// * Шаблон - Структура: +// ** ID - Строка - идентификатор шаблона. +// ** type - Строка - тип шаблона. +// * Предмет - Структура: +// ** ID - Строка - идентификатор предмета. +// ** type - Строка - тип предмета. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция ПолучитьОбъектXDTOПроцесса(ТипПроцессаXDTO, Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ПолучитьОбъектXDTOПроцесса(ТипПроцессаXDTO, Параметры) +``` +
+ +## ПринятьЗадачуКИсполнению +
+ +Описание, пример вызова + +```bsl + +// Выполняет принятие задач к исполнению. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Задачи - Массив из Строка - массив идентификаторов задач Документооборота, которые нужно принять к исполнению. +// +// Возвращаемое значение: +// Булево - признак успеха принятия задач к исполнению. +// +Функция ПринятьЗадачуКИсполнению(Прокси, Задачи) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ПринятьЗадачуКИсполнению(Прокси, Задачи) +``` +
+ +## ОтменитьПринятиеЗадачКИсполнению +
+ +Описание, пример вызова + +```bsl + +// Выполняет отмену принятия задач к исполнению. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Задачи - Массив из Строка - массив идентификаторов задач Документооборота, +// принятие к исполнению которых нужно отменить. +// +// Возвращаемое значение: +// Булево - признак успеха отмены принятия задач к исполнению. +// +Функция ОтменитьПринятиеЗадачКИсполнению(Прокси, Задачи) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.ОтменитьПринятиеЗадачКИсполнению(Прокси, Задачи) +``` +
+ +## КраткоеИмяТочкиМаршрута +
+ +Описание, пример вызова + +```bsl + +// Возвращает краткое имя точки маршрута. +// +// Параметры: +// ПроцессТип - Строка - тип процесса. +// ПолноеИмя - Строка - полное имя точки маршрута +// +// Возвращаемое значение: +// Строка - краткое имя точки маршрута. +// +Функция КраткоеИмяТочкиМаршрута(ПроцессТип, ПолноеИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.КраткоеИмяТочкиМаршрута(ПроцессТип, ПолноеИмя) +``` +
+ +## НовыйБизнесПроцесс +
+ +Описание, пример вызова + +```bsl + +// Получает объект XDTO бизнес-процесса. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Тип - Строка - тип бизнес-процесса. +// Предмет - Структура: +// * ID - Строка - идентификатор предмета. +// * type - Строка - тип предмета. +// +// Возвращаемое значение: +// ОбъектXDTO, Неопределено - XDTO объект с бизнес-процессом заданного типа. +// +Функция НовыйБизнесПроцесс(Прокси, Тип, Предмет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.НовыйБизнесПроцесс(Прокси, Тип, Предмет); +``` +
+ +## УчастникЗадач +
+ +Описание, пример вызова + +```bsl + +// Формирует объект XDTO, описывающий участника задачи. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Исполнитель - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ОсновнойОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ДополнительныйОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMBusinessProcessTaskExecutor. +// +Функция УчастникЗадач(Прокси, Исполнитель, ОсновнойОбъектАдресации = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.УчастникЗадач(Прокси, Исполнитель, ОсновнойОбъектАдресации, ); +``` +
+ +## УчастникПроцессаСогласование +
+ +Описание, пример вызова + +```bsl + +// Формирует объект XDTO, описывающий согласующего в бизнес-процессе "Согласование" в Документообороте. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Исполнитель - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ОсновнойОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ДополнительныйОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMBusinessProcessApprovalParticipant. +// +Функция УчастникПроцессаСогласование(Прокси, Исполнитель, ОсновнойОбъектАдресации = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.УчастникПроцессаСогласование(Прокси, Исполнитель, ОсновнойОбъектАдресации, ); +``` +
+ +## УчастникПроцессаПриглашение +
+ +Описание, пример вызова + +```bsl + +// Формирует объект XDTO, описывающий участника бизнес-процесса "Приглашение" в Документообороте. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Исполнитель - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ОсновнойОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ДополнительныйОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMBusinessProcessInvitationParticipant. +// +Функция УчастникПроцессаПриглашение(Прокси, Исполнитель, ОсновнойОбъектАдресации = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.УчастникПроцессаПриглашение(Прокси, Исполнитель, ОсновнойОбъектАдресации, ); +``` +
+ +## УчастникПроцессаИсполнение +
+ +Описание, пример вызова + +```bsl + +// Формирует объект XDTO, описывающий исполнителя в бизнес-процессе "Исполнение" в Документообороте. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Исполнитель - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ОсновнойОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ДополнительныйОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMBusinessProcessPerformanceParticipant. +// +Функция УчастникПроцессаИсполнение(Прокси, Исполнитель, ОсновнойОбъектАдресации = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.УчастникПроцессаИсполнение(Прокси, Исполнитель, ОсновнойОбъектАдресации, ); +``` +
+ +## НастроитьФормуДокументаСогласноВидуДокументаXDTO +
+ +Описание, пример вызова + +```bsl + +// Настраивает форму документа согласно его виду. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма документа 1С:Документооборота. +// documentType - ОбъектXDTO - вид документа. +// organization - ОбъектXDTO - организация. +// +Процедура НастроитьФормуДокументаСогласноВидуДокументаXDTO(Форма, documentType, organization = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.НастроитьФормуДокументаСогласноВидуДокументаXDTO(Форма, documentType, organization); +``` +
+ +## ЗаполнитьСвойствоXDTOизСтруктурыРеквизитов +
+ +Описание, пример вызова + +```bsl + +// Заполняет свойство объекта XDTO из структуры реквизитов исходного объекта ИС. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ОбъектXDTO - ОбъектXDTO - заполняемый объект ДО. +// ИмяСвойства - Строка - имя заполняемого свойства объекта XDTO. +// СтруктураРеквизитов - Структура, ДанныеФормыСтруктура - предварительно заполненная структура +// с данными объекта. +// ПутьДанных - Структура, Строка - имя исходного реквизита. +// +Процедура ЗаполнитьСвойствоXDTOизСтруктурыРеквизитов(Прокси, ОбъектXDTO, ИмяСвойства, СтруктураРеквизитов, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ЗаполнитьСвойствоXDTOизСтруктурыРеквизитов(Прокси, ОбъектXDTO, ИмяСвойства, СтруктураРеквизитов, ); +``` +
+ +## ЗаполнитьОбъектXDTOИзФормы +
+ +Описание, пример вызова + +```bsl + +// Заполняет реквизиты формы из свойств объекта XDTO по соответствию свойств и реквизитов. +// +// Параметры: +// ОбъектXDTO - ОбъектXDTO - заполняемый объект XDTO. +// Форма - ФормаКлиентскогоПриложения - источник данных заполнения. +// РеквизитыИСвойства - Соответствие - ключ - свойство XDTO, значение - реквизит. +// +Процедура ЗаполнитьОбъектXDTOИзФормы(ОбъектXDTO, Форма, РеквизитыИСвойства) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ЗаполнитьОбъектXDTOИзФормы(ОбъектXDTO, Форма, РеквизитыИСвойства) +``` +
+ +## ЗаполнитьФормуИзОбъектаXDTO +
+ +Описание, пример вызова + +```bsl + +// Заполняет реквизиты формы из свойств объекта XDTO по соответствию свойств и реквизитов. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - заполняемая форма. +// ОбъектXDTO - ОбъектXDTO - источник данных заполнения. +// РеквизитыИСвойства - Соответствие - ключ - свойство XDTO, значение - реквизит. +// +Процедура ЗаполнитьФормуИзОбъектаXDTO(Форма, ОбъектXDTO, РеквизитыИСвойства) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ЗаполнитьФормуИзОбъектаXDTO(Форма, ОбъектXDTO, РеквизитыИСвойства) +``` +
+ +## СоздатьОбъектДОПоПравилу +
+ +Описание, пример вызова + +```bsl + +// Создает новый объект Документооборота по объекту ИС и указанному правилу. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ОбъектИС - ЛюбаяСсылка - объект ИС, источник данных заполнения. +// Правило - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом - правило заполнения. +// +// Возвращаемое значение: +// ОбъектXDTO - созданный объект: +// * name - Строка +// * objectID - ОбъектXDTO: +// ** ID - Строка +// ** type - Строка +// Строка - сообщение об ошибке. +// +Функция СоздатьОбъектДОПоПравилу(Прокси, ОбъектИС, Правило) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.СоздатьОбъектДОПоПравилу(Прокси, ОбъектИС, Правило) +``` +
+ +## СтруктураРеквизитовЗаполняемогоВидаДокументовДО +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру Вида документа ДО для заполнения по переданному имени типа. +// +// Параметры: +// ТипОбъектаДО - Строка - тип объекта: DMInternalDocumentType или DMIncomingDocumentType или DMOutgoingDocumentType. +// +// Возвращаемое значение: +// Структура - реквизиты объекта указанного типа, подлежащие заполнению. +// +Функция СтруктураРеквизитовЗаполняемогоВидаДокументовДО(ТипОбъектаДО) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.СтруктураРеквизитовЗаполняемогоВидаДокументовДО(ТипОбъектаДО) +``` +
+ +## СоздатьВидДокументаВДО +
+ +Описание, пример вызова + +```bsl + +// Создает вид документов с указанными свойствами. +// +// Параметры: +// Свойства - См. ИнтеграцияС1СДокументооборот.СтруктураРеквизитовЗаполняемогоВидаДокументовДО. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DM<...>DocumentType или DMError. +// +Функция СоздатьВидДокументаВДО(Свойства) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.СоздатьВидДокументаВДО(Свойства) +``` +
+ +## НайтиСоздатьВидДокументаВДО +
+ +Описание, пример вызова + +```bsl + +// Ищет виды документов в ДО по типу объекта и по точному совпадению наименования. Создает новый +// вид документов с указанными свойствами, если ничего не найдено. +// +// Параметры: +// Свойства - См. ИнтеграцияС1СДокументооборот.СтруктураРеквизитовЗаполняемогоВидаДокументовДО. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DM<...>DocumentType или DMError. +// +Функция НайтиСоздатьВидДокументаВДО(Свойства) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.НайтиСоздатьВидДокументаВДО(Свойства) +``` +
+ +## СтруктураРеквизитовЗаполняемойПапкиВнутреннихДокументов +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру Папки внутренних документов ДО для заполнения. +// +// Возвращаемое значение: +// Структура - реквизиты объекта указанного типа, подлежащие заполнению. +// +Функция СтруктураРеквизитовЗаполняемойПапкиВнутреннихДокументов() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.СтруктураРеквизитовЗаполняемойПапкиВнутреннихДокументов() +``` +
+ +## СоздатьПапкуВнутреннихДокументовВДО +
+ +Описание, пример вызова + +```bsl + +// Создает папку внутренних документов с указанными свойствами. +// +// Параметры: +// Свойства - См. ИнтеграцияС1СДокументооборот.СтруктураРеквизитовЗаполняемойПапкиВнутреннихДокументов. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DMInternalDocumentFolder или DMError. +// +Функция СоздатьПапкуВнутреннихДокументовВДО(Свойства) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.СоздатьПапкуВнутреннихДокументовВДО(Свойства) +``` +
+ +## НайтиСоздатьПапкуВнутреннихДокументовВДО +
+ +Описание, пример вызова + +```bsl + +// Ищет папки внутренних документов в ДО по точному совпадению наименования. Создает новую +// папку с указанными свойствами, если ничего не найдено. +// +// Параметры: +// Свойства - См. ИнтеграцияС1СДокументооборот.СтруктураРеквизитовЗаполняемойПапкиВнутреннихДокументов. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DMInternalDocumentFolder или DMError. +// +Функция НайтиСоздатьПапкуВнутреннихДокументовВДО(Свойства) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот.НайтиСоздатьПапкуВнутреннихДокументовВДО(Свойства) +``` +
+ +## ПроверитьСоответствиеПравилИнтеграцииМетаданным +
+ +Описание, пример вызова + +```bsl + +// Обработчик, проверяющий соответствие правил интеграции метаданным конфигурации. +// +Процедура ПроверитьСоответствиеПравилИнтеграцииМетаданным() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ПроверитьСоответствиеПравилИнтеграцииМетаданным() +``` +
+ +## ПерейтиНаВерсию_1_1_6_1 +
+ +Описание, пример вызова + +```bsl + +// Обработчик обновления БИД на версию 1.1.6.1. Обновление наименований правил интеграции +// и установка реквизита Ключевой у видов документов ДО. +// +Процедура ПерейтиНаВерсию_1_1_6_1() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ПерейтиНаВерсию_1_1_6_1() +``` +
+ +## ПерейтиНаВерсию_1_1_8_4 +
+ +Описание, пример вызова + +```bsl + +// Обработчик обновления БИД на версию 1.1.8.4. Установка флага "Не создавать связи по ссылкам". +// +Процедура ПерейтиНаВерсию_1_1_8_4() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ПерейтиНаВерсию_1_1_8_4() +``` +
+ +## ПерейтиНаВерсию_1_1_12_2 +
+ +Описание, пример вызова + +```bsl + +// Обработчик обновления БИД на версию 1.1.12.2. Установка режима изменения данных проведенного документа. +// +Процедура ПерейтиНаВерсию_1_1_12_2() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот.ПерейтиНаВерсию_1_1_12_2() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборот3.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборот3.md new file mode 100644 index 0000000..511fd13 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборот3.md @@ -0,0 +1,1721 @@ +--- +title: Интеграция с 1С документооборот3 +slug: zup/интеграция-с-1с-документооборот3 +--- + + +## ПолучитьHTMLПредпросмотрОбъектаВФоне +
+ +Описание, пример вызова + +```bsl + +// Получает HTML предпросмотр объекта из Документооборота в фоновом задании. +// +// Параметры: +// Параметры - Структура: +// * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения +// * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка +// * ИнтеграцияС1СДокументооборотИмяПользователя - Строка +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево +// * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка +// * ИнтеграцияС1СДокументооборотПароль - Строка +// * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево +// * ID - Строка +// * Тип - Строка +// * ИгнорироватьМаксРазмер - Булево - позволяет игнорировать настройку Документооборота +// "Предельный размер файла для предпросмотра". +// АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса. +// +Процедура ПолучитьHTMLПредпросмотрОбъектаВФоне(Параметры, АдресХранилища) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ПолучитьHTMLПредпросмотрОбъектаВФоне(Параметры, АдресХранилища) +``` +
+ +## ОбработатьУниверсальноеСообщение +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат обработки универсальных сообщений. +// +// Параметры: +// Сообщение - ОбъектXDTO - потомок DMILRequest. +// +// Возвращаемое значение: +// ОбъектXDTO - потомок DMILResponse. +// +Функция ОбработатьУниверсальноеСообщение(Сообщение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ОбработатьУниверсальноеСообщение(Сообщение) +``` +
+ +## URIПространстваИменВебСервисаБИД +
+ +Описание, пример вызова + +```bsl + +// Возвращает URI пространства имен веб-сервиса БИД. +// +// Возвращаемое значение: +// Строка +// +Функция URIПространстваИменВебСервисаБИД() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.URIПространстваИменВебСервисаБИД() +``` +
+ +## ОписаниеОшибкиXDTO +
+ +Описание, пример вызова + +```bsl + +// Создает объект DMILError. +// +// Параметры: +// Предмет - Строка - тема сообщения об ошибке. +// Описание - Строка - текстовое описание ошибки, а также отладочная информация. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция ОписаниеОшибкиXDTO(Предмет = "", Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ОписаниеОшибкиXDTO(Предмет, Описание); +``` +
+ +## ПодготовитьВычисляемоеВыражениеКПередачеНаСторонуДО +
+ +Описание, пример вызова + +```bsl + +// Заполняет XDTO объект, описывающий выражение на встроенном языке, +// которое требуется передать и выполнить на стороне ДО. +// +// Параметры: +// ВыражениеПравилаXDTO - ОбъектXDTO - объект XDTO, описывающий выражение на встроенном языке. +// ВыражениеДляВыполненияНаСторонеДО - СтрокаТаблицыЗначений - строка табличной части правила интеграции. +// см. Справочники.ПравилаИнтеграцииС1СДокументооборотом3.ВыраженияДляВыполненияНаСторонеДО +// +Процедура ПодготовитьВычисляемоеВыражениеКПередачеНаСторонуДО(ВыражениеПравилаXDTO, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ПодготовитьВычисляемоеВыражениеКПередачеНаСторонуДО(ВыражениеПравилаXDTO, ); +``` +
+ +## ПолучитьОписаниеОшибки +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание ошибки. +// +// Параметры: +// Инфо - ИнформацияОбОшибке +// +// Возвращаемое значение: +// Строка - текст детального описания ошибки. +// +Функция ПолучитьОписаниеОшибки(Инфо) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ПолучитьОписаниеОшибки(Инфо) +``` +
+ +## ПолучитьСсылкуПоObjectID +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на объект ИС по ObjectID +// +// Параметры: +// ObjectID - ОбъектXDTO - объект XDTO типа DMILObjectID. +// +// Возвращаемое значение: +// ЛюбаяСсылка - ссылка на объект ИС. +// +Функция ПолучитьСсылкуПоObjectID(ObjectID) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ПолучитьСсылкуПоObjectID(ObjectID) +``` +
+ +## ПроверитьТипБИД +
+ +Описание, пример вызова + +```bsl + +// Проверяет тип объекта XDTO. +// +// Параметры: +// ОбъектXDTO - ОбъектXDTO - проверяемый объект. +// Тип - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево - Истина, если объект является объектом указанного типа. +// +Функция ПроверитьТипБИД(ОбъектXDTO, Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ПроверитьТипБИД(ОбъектXDTO, Тип) +``` +
+ +## СоздатьОбъектБИД +
+ +Описание, пример вызова + +```bsl + +// Создает XDTO объект указанного типа из пространства имен веб-сервиса БИД. +// +// Параметры: +// ТипОбъекта - Строка - имя типа XDTO +// +// Возвращаемое значение: +// ОбъектXDTO - созданный объект указанного типа +// +Функция СоздатьОбъектБИД(ТипОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.СоздатьОбъектБИД(ТипОбъекта) +``` +
+ +## HTMLПредпросмотрОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает HTML предпросмотр объекта. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ID - Строка - идентификатор объекта XDTO. +// Тип - Строка - тип объекта XDTO. +// ИгнорироватьМаксРазмер - Булево - позволяет игнорировать настройку Документооборота +// "Предельный размер файла для предпросмотра". +// +// Возвращаемое значение: +// Структура - структура предпросмотра объекта: +// * ПредставлениеHTML - Строка - HTML предпросмотр объекта. +// * ПредпросмотрУрезан - Булево - предпросмотр объекта урезан. +// +Функция HTMLПредпросмотрОбъекта(Прокси, ID, Тип, ИгнорироватьМаксРазмер = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.HTMLПредпросмотрОбъекта(Прокси, ID, Тип, ИгнорироватьМаксРазмер); +``` +
+ +## HTMLПредпросмотрОбъектаЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос к 1С:Документообороту на получение HTML предпросмотра объекта. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ID - Строка - идентификатор объекта XDTO. +// Тип - Строка - тип объекта XDTO. +// ИгнорироватьМаксРазмер - Булево - позволяет игнорировать настройку Документооборота +// "Предельный размер файла для предпросмотра". +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMGetObjectsHTMLPresentationsRequest. +// +Функция HTMLПредпросмотрОбъектаЗапрос(Прокси, ID, Тип, ИгнорироватьМаксРазмер = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.HTMLПредпросмотрОбъектаЗапрос(Прокси, ID, Тип, ИгнорироватьМаксРазмер); +``` +
+ +## ВходящиеДанныеОбъектаИС +
+ +Описание, пример вызова + +```bsl + +// Формирует универсальную структуру входящих данных, предназначенную для загрузки объектов в 1С:Документооборот. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// СсылкаНаОбъектИС - ЛюбаяСсылка - объект ИС, источник данных заполнения. +// СписокВыражений - Массив из Строка - список выражений на встроенном языке, которые требуется выполнить на +// стороне ИС. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMIncomingData. +// +Функция ВходящиеДанныеОбъектаИС(Прокси, СсылкаНаОбъектИС, СписокВыражений) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ВходящиеДанныеОбъектаИС(Прокси, СсылкаНаОбъектИС, СписокВыражений) +``` +
+ +## ДанныеФлага +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные флага. +// +// Параметры: +// Флаг - Строка - имя флага, принимает значения перечисления DMObjectFlag (HTTP://www.1c.ru/dm). +// +// Возвращаемое значение: +// Структура: +// * ИндексКартинки - Число - индекс картинки в коллекции КоллекцияФлаговПисем. +// * Картинка - Картинка - картинка флага. +// * Представление - Строка - представление флага. +// +Функция ДанныеФлага(Флаг) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ДанныеФлага(Флаг) +``` +
+ +## ДоступенФункционалФайлов +
+ +Описание, пример вызова + +```bsl + +// Проверяет поддерживает ли веб-сервис Документооборота работу с файлами. +// +// Возвращаемое значение: +// Булево +// +Функция ДоступенФункционалФайлов() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ДоступенФункционалФайлов() +``` +
+ +## ИспользоватьИнтеграцию +
+ +Описание, пример вызова + +```bsl + +// Возвращает информацию, включена ли интеграция с 1С:Документооборотом редакции 3. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользоватьИнтеграцию() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ИспользоватьИнтеграцию() +``` +
+ +## КопияОбъектаXDTO +
+ +Описание, пример вызова + +```bsl + +// Возвращает копию объекта XDTO. +// +// Параметры: +// Источник - ОбъектXDTO - от куда копировать. +// ПроксиДО - WSПрокси - объект для подключения к web-сервисам Документооборота. Если указан - копируется объект +// DMService, если не указан - копируется объект DMILService. +// +// Возвращаемое значение: +// ОбъектXDTO - копия объекта-источника. +// +Функция КопияОбъектаXDTO(Источник, ПроксиДО = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.КопияОбъектаXDTO(Источник, ПроксиДО); +``` +
+ +## ОбновитьПредставлениеБыстрогоПоиска +
+ +Описание, пример вызова + +```bsl + +// Обновляет представление быстрого поиска. Возвращает представление фильтров. +// +// Параметры: +// БыстрыйПоиск - ДанныеФормыКоллекция - таблица "Быстрый поиск" на форме списка задач. +// КнопкаСброситьОтбор - КнопкаФормы - кнопка "Сбросить отбор". +// +// Возвращаемое значение: +// Строка - представление фильтров +// +Функция ОбновитьПредставлениеБыстрогоПоиска(БыстрыйПоиск, КнопкаСброситьОтбор) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ОбновитьПредставлениеБыстрогоПоиска(БыстрыйПоиск, КнопкаСброситьОтбор) +``` +
+ +## ОписаниеВебСервисов +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание веб-сервиса 1С:Документооборота. +// +// Возвращаемое значение: +// Строка +// +Функция ОписаниеВебСервисов() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ОписаниеВебСервисов() +``` +
+ +## ПредварительныеДанныеДляВыгрузкиВДО +
+ +Описание, пример вызова + +```bsl + +// Возвращает список выражений на встроенном языке, которые требуется выполнить на стороне интегрированной системы, а +// также список печатных форм, которые требуется сформировать на стороне интегрированной системы, для последующей +// передачи результатов на сторону 1С:Документооборот. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// СписокОбъектовИС - Массив из ЛюбаяСсылка - объекты ИС, для которых требуется найти соответствующие правила. +// СоответствиеПравилЗагрузкиВДООбъектамИС - Соответствие из КлючИЗначение - соответствующие правила загрузки в ДО: +// * Ключ - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС. +// * Значение - ОбъектXDTO - объект XDTO типа DMDataLoadingRule. +// - Неопределено - если подходящее правило загрузки не было найдено. +// ТребуетсяСписокВыражений - Булево - требуется получение списка выражений на встроенном языке. +// ТребуютсяПечатныеФормы - Булево - требуется получение списка и типа файлов печатных форм. +// +// Возвращаемое значение: +// Структура: +// * СоответствиеСпискаВыраженийОбъектамИС - Соответствие из КлючИЗначение: +// ** Ключ - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС. +// ** Значение - Массив из Строка - список выражений на встроенном языке. +// * СоответствиеПечатныхФормОбъектамИС - Соответствие из КлючИЗначение: +// ** Ключ - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС. +// ** Значение - СписокXDTO - таблица печатных форм к передаче в ДО. +// * ТипыФайловПечатныхФорм - Соответствие из КлючИЗначение: +// ** Ключ - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС. +// ** Значение - Строка - тип файлов сохранения печатных форм. +// +Функция ПредварительныеДанныеДляВыгрузкиВДО(Прокси, СписокОбъектовИС, СоответствиеПравилЗагрузкиВДООбъектамИС, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ПредварительныеДанныеДляВыгрузкиВДО(Прокси, СписокОбъектовИС, СоответствиеПравилЗагрузкиВДООбъектамИС, ); +``` +
+ +## ПрисоединяемыеПечатныеФормы +
+ +Описание, пример вызова + +```bsl + +// Формирует универсальную таблицу присоединяемых печатных форм для последующего создания. +// +// Параметры: +// ПечатныеФормы - Массив из ОбъектXDTO - список объектов XDTO типа DMPrintedForm. +// +// Возвращаемое значение: +// см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПрисоединяемыеПечатныеФормы +// +Функция ПрисоединяемыеПечатныеФормы(ПечатныеФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ПрисоединяемыеПечатныеФормы(ПечатныеФормы) +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Добавляет команды Документооборота на форму объекта при создании на сервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана процедура. +// МестоРазмещенияКоманд - ГруппаФормы - место для размещения, по умолчанию - командная панель формы. +// ПараметрыОповещения - Структура - параметры, где может быть установлен источник команды. +// +Процедура ПриСозданииНаСервере(Форма, МестоРазмещенияКоманд = Неопределено, ПараметрыОповещения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ПриСозданииНаСервере(Форма, МестоРазмещенияКоманд, ПараметрыОповещения); +``` +
+ +## РезультатВыполненияКомандыПоОбъекту +
+ +Описание, пример вызова + +```bsl + +// Обрабатывает результат действия над задачей или с обработкой. +// +// Параметры: +// РезультатДействияСтрока - Строка - результат действия, преобразованный в строку. +// ДанныеДляОбновления - ОбъектXDTO - неявно возвращаемое значение, в которое будут переданы данные, +// необходимые для обновления формы. +// +// Возвращаемое значение: +// Структура: +// * Успешно - Булево +// * ТекстПредупреждения - Строка +// * ТребуемоеИнтерактивноеДействие - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ТребуемоеИнтерактивноеДействие +// +Функция РезультатВыполненияКомандыПоОбъекту(РезультатДействияСтрока, ДанныеДляОбновления) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.РезультатВыполненияКомандыПоОбъекту(РезультатДействияСтрока, ДанныеДляОбновления) +``` +
+ +## РезультатВыраженияНаВстроенномЯзыке +
+ +Описание, пример вызова + +```bsl + +// Возвращает результат выполнения выражения на встроенном языке. Выражение может использоваться только для вычисления +// какого-либо значения, которое в итоге вернет функция. Никакие изменения в базу данных при этом вноситься не +// должны, поэтому выражение выполняется в транзакции, которая откатывается после завершения выполнения. +// +// Параметры: +// ВычисляемоеВыражение - Строка - выражение на встроенном языке. +// Источник - Произвольный - источник данных. +// Приемник - Произвольный - приемник данных. +// ТекущаяСтрока - Произвольный - передается в случае, если выражение используется для заполнения реквизита +// строки табличной части. +// +// Возвращаемое значение: +// Произвольный - результат выполнения выражения на встроенном языке. +// +Функция РезультатВыраженияНаВстроенномЯзыке(ВычисляемоеВыражение, Знач Источник, Приемник = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.РезультатВыраженияНаВстроенномЯзыке(ВычисляемоеВыражение, Источник, Приемник, ); +``` +
+ +## СброситьБыстрыйПоиск +
+ +Описание, пример вызова + +```bsl + +// Сбрасывает быстрый поиск (отбор объектов). +// +// Параметры: +// БыстрыйПоиск - ДанныеФормыКоллекция - таблица "Быстрый поиск" на форме списка задач. +// КнопкаСброситьОтбор - КнопкаФормы - кнопка "Сбросить отбор". +// +Процедура СброситьБыстрыйПоиск(БыстрыйПоиск, КнопкаСброситьОтбор) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.СброситьБыстрыйПоиск(БыстрыйПоиск, КнопкаСброситьОтбор) +``` +
+ +## СкопироватьОбъектXDTO +
+ +Описание, пример вызова + +```bsl + +// Копирует объект XDTO. +// +// Параметры: +// Приемник - ОбъектXDTO - куда копировать. +// Источник - ОбъектXDTO - от куда копировать. +// ПроксиДО - WSПрокси - объект для подключения к web-сервисам Документооборота. Если указан - копируется объект +// DMService, если не указан - копируется объект DMILService. +// +Процедура СкопироватьОбъектXDTO(Приемник, Источник, ПроксиДО = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.СкопироватьОбъектXDTO(Приемник, Источник, ПроксиДО); +``` +
+ +## СоздатьОбъектДОПоПравилу +
+ +Описание, пример вызова + +```bsl + +// Создает новый объект Документооборота по объекту ИС и указанному правилу. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ОбъектИС - ЛюбаяСсылка - объект ИС, источник данных заполнения. +// Правило - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - правило заполнения. +// +// Возвращаемое значение: +// ОбъектXDTO - созданный объект: +// * name - Строка +// * objectID - ОбъектXDTO: +// ** ID - Строка +// ** type - Строка +// Строка - сообщение об ошибке. +// +Функция СоздатьОбъектДОПоПравилу(Прокси, ОбъектИС, Правило) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.СоздатьОбъектДОПоПравилу(Прокси, ОбъектИС, Правило) +``` +
+ +## СоздатьОбъектыДОПоПравилам +
+ +Описание, пример вызова + +```bsl + +// Создает новые объекты Документооборота для списка объектов ИС по соответствующих им правилам. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// СписокОбъектовИС - Массив из ЛюбаяСсылка - объекты ИС, источник данных заполнения. +// ПодходящиеПравилаИнтеграции - Соответствие из КлючИЗначение - соответствующие правила интеграции: +// * Ключ - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС. +// * Значение - Массив из СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - список подходящих правил. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС. +// * Значение - Структура - результат по объекту ИС: +// ** Успешно - Булево - Истина, если связанный объект в ДО был создан успешно, Ложь, если возникли ошибки. +// ** ТекстОшибки - Строка - сообщение об ошибке. +// ** ОбъектXDTO - ОбъектXDTO - созданный в ДО объект. +// +Функция СоздатьОбъектыДОПоПравилам(Прокси, СписокОбъектовИС, ПодходящиеПравилаИнтеграции) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.СоздатьОбъектыДОПоПравилам(Прокси, СписокОбъектовИС, ПодходящиеПравилаИнтеграции) +``` +
+ +## СоответствиеПравилЗагрузкиВДООбъектамИС +
+ +Описание, пример вызова + +```bsl + +// Находит на стороне 1С:Документооборот правила загрузки данных в 1С:Документооборот, соответствующие +// переданным объектам интегрированной системы. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// СписокОбъектовИС - Массив из ЛюбаяСсылка - объекты ИС, для которых требуется найти соответствующие правила. +// ПодходящиеПравилаИнтеграции - Соответствие из КлючИЗначение - соответствующие правила интеграции: +// * Ключ - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС. +// * Значение - Массив из СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - список подходящих правил. +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС. +// * Значение - ОбъектXDTO - объект XDTO типа DMDataLoadingRule. +// - Неопределено - если подходящее правило загрузки не было найдено. +// +Функция СоответствиеПравилЗагрузкиВДООбъектамИС(Прокси, СписокОбъектовИС, ПодходящиеПравилаИнтеграции) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.СоответствиеПравилЗагрузкиВДООбъектамИС(Прокси, СписокОбъектовИС, ПодходящиеПравилаИнтеграции) +``` +
+ +## УстановитьУсловноеОформлениеТаблицыБыстрыйПоиск +
+ +Описание, пример вызова + +```bsl + +// Устанавливает условное оформление таблицы "Быстрый поиск". +// +// Параметры: +// УсловноеОформление - УсловноеОформлениеКомпоновкиДанных. +// ТаблицаБыстрыйПоиск - ТаблицаФормы - таблица "Быстрый поиск". +// ЯчейкаЗначение - ПолеФормы - ячейка "Значение" таблицы "Быстрый поиск". +// +Процедура УстановитьУсловноеОформлениеТаблицыБыстрыйПоиск(УсловноеОформление, ТаблицаБыстрыйПоиск, ЯчейкаЗначение) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.УстановитьУсловноеОформлениеТаблицыБыстрыйПоиск(УсловноеОформление, ТаблицаБыстрыйПоиск, ЯчейкаЗначение) +``` +
+ +## ЭтоДокументДО3 +
+ +Описание, пример вызова + +```bsl + +// Проверяет описывает ли переданный тип документ ДО3. +// +// Параметры: +// ТипОбъектаXDTO - Строка - тип объекта. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоДокументДО3(ТипОбъектаXDTO) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ЭтоДокументДО3(ТипОбъектаXDTO) +``` +
+ +## ВзятьЗадачуВРаботуЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос на взятие задачи в работу. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеПоЗадаче - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеПоЗадаче +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMAcceptTasksRequest. +// +Функция ВзятьЗадачуВРаботуЗапрос(Прокси, ДанныеПоЗадаче) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ВзятьЗадачуВРаботуЗапрос(Прокси, ДанныеПоЗадаче) +``` +
+ +## ВыполнитьДействиеЗадачиЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос на выполнение действия задачи в Документообороте. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеПоЗадаче - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеПоЗадаче +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMExecuteTaskActionRequest. +// +Функция ВыполнитьДействиеЗадачиЗапрос(Прокси, ДанныеПоЗадаче) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ВыполнитьДействиеЗадачиЗапрос(Прокси, ДанныеПоЗадаче) +``` +
+ +## ДополнительныеДанныеПоЗадаче +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру дополнительных данных задачи. +// +// Параметры: +// ЗадачаXDTO - ОбъектXDTO - объект XDTO типа DMTaskAction. +// ТекущийПользовательИСотрудники - Массив из ОбъектXDTO - Объект XDTO типа DMUser, DMEmployee или Неопределено. +// +// Возвращаемое значение: +// Структура: +// * ОбластьДействия - см. ИнтеграцияС1СДокументооборот3.НоваяОбластьДействияЗадачи +// * ДеревоПриложений - см. ИнтеграцияС1СДокументооборот3.НовоеДеревоПриложений +// +Функция ДополнительныеДанныеПоЗадаче(ЗадачаXDTO, ТекущийПользовательИСотрудники = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ДополнительныеДанныеПоЗадаче(ЗадачаXDTO, ТекущийПользовательИСотрудники); +``` +
+ +## ДополнитьФильтрыОтбораЗадач +
+ +Описание, пример вызова + +```bsl + +// Преобразует таблицу "Быстрый поиск" в набор фильтров для запроса к веб-сервису Документооборота +// на получение списка задач. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Фильтры - СписокЗначений из Произвольный - отборы, которые требуется наложить на список задач. +// БыстрыйПоиск - ДанныеФормыКоллекция - таблица "Быстрый поиск" на форме списка задач. +// +Процедура ДополнитьФильтрыОтбораЗадач(Прокси, Фильтры, БыстрыйПоиск) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ДополнитьФильтрыОтбораЗадач(Прокси, Фильтры, БыстрыйПоиск) +``` +
+ +## НоваяСтраницаКомандСозданияНаОснованииЗадачи +
+ +Описание, пример вызова + +```bsl + +// Создает на форме задачи или списка задач новую группу команд создания на основании с подходящими правилами. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма задачи или списка задач. +// ПодходящиеПравила - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПравилаИнтеграции +// +// Возвращаемое значение: +// Строка - ключ созданной страницы задач. +// +Функция НоваяСтраницаКомандСозданияНаОснованииЗадачи(Форма, ПодходящиеПравила) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.НоваяСтраницаКомандСозданияНаОснованииЗадачи(Форма, ПодходящиеПравила) +``` +
+ +## ОбновитьОбластьДействияЗадачи +
+ +Описание, пример вызова + +```bsl + +// Выполняет перерисовку области действия в форме задачи и в форме списка задач. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма с областью действия задачи. +// ОбластьДействия - см. ИнтеграцияС1СДокументооборот3.НоваяОбластьДействияЗадачи +// СохраненныйКомментарий - Строка - результат действия текстом. +// ИзменятьШрифт - Булево - будет изменен шрифт элементов формы при необходимости. +// +Процедура ОбновитьОбластьДействияЗадачи(Форма, ОбластьДействия, СохраненныйКомментарий = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ОбновитьОбластьДействияЗадачи(Форма, ОбластьДействия, СохраненныйКомментарий, ); +``` +
+ +## ОсновнойПредметЗадачи +
+ +Описание, пример вызова + +```bsl + +// Читает основной предмет из объекта XDTO типа DMTaskAction. +// +// Параметры: +// ЗадачаXDTO - ОбъектXDTO - объект XDTO типа DMTaskAction. +// +// Возвращаемое значение: +// Структура: +// * mainApplication - ОбъектXDTO +// - Неопределено +// * ID - Строка +// * Тип - Строка +// * ТипОбъектаДО - Строка +// * ВидДокументаДОID - Строка +// +Функция ОсновнойПредметЗадачи(ЗадачаXDTO) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ОсновнойПредметЗадачи(ЗадачаXDTO) +``` +
+ +## ОтменитьВзятиеЗадачиВРаботуЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос на отмену взятия задачи в работу. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеПоЗадаче - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеПоЗадаче +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMRevokeTaskAcceptanceRequest. +// +Функция ОтменитьВзятиеЗадачиВРаботуЗапрос(Прокси, ДанныеПоЗадаче) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ОтменитьВзятиеЗадачиВРаботуЗапрос(Прокси, ДанныеПоЗадаче) +``` +
+ +## СписокЗадачЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос к 1С:Документообороту на получение списка задач. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ТекущаяСтраница - Число - номер текущей страницы списка. +// РазмерСтраницыДинамическогоСписка - Число - количество задач на одной странице. +// ПолеДляСортировки - Строка - имя реквизита, по которому будет отсортирован список. +// НаправлениеСортировкиПоля - Булево - если Ложь, то сортировка по возрастанию, если Истина, то по убыванию. +// Фильтры - СписокЗначений из Произвольный - отборы, которые требуется наложить на список задач. +// ОтображениеКарточкиЗадачи - ПеречислениеСсылка.ВариантыОтображенияОбластиЧтения - вариант отображения области +// чтения задачи. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMGetDynamicListRequest. +// +Функция СписокЗадачЗапрос(Прокси, ТекущаяСтраница, РазмерСтраницыДинамическогоСписка, ПолеДляСортировки, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.СписокЗадачЗапрос(Прокси, ТекущаяСтраница, РазмерСтраницыДинамическогоСписка, ПолеДляСортировки, ); +``` +
+ +## УстановитьФлагЗадачиЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос на установку флага задачи. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеПоЗадаче - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеПоЗадаче +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMSetFlagRequest. +// +Функция УстановитьФлагЗадачиЗапрос(Прокси, ДанныеПоЗадаче) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.УстановитьФлагЗадачиЗапрос(Прокси, ДанныеПоЗадаче) +``` +
+ +## УчастникЗадачXDTO +
+ +Описание, пример вызова + +```bsl + +// Формирует объект XDTO, описывающий участника задачи. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Исполнитель - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ОсновнойОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ДополнительныйОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMTaskParticipant. +// +Функция УчастникЗадачXDTO(Прокси, Исполнитель, ОсновнойОбъектАдресации = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.УчастникЗадачXDTO(Прокси, Исполнитель, ОсновнойОбъектАдресации, ); +``` +
+ +## УчастникЗадачДО +
+ +Описание, пример вызова + +```bsl + +// Заполняет реквизит, являющийся участником задач ДО, в приемнике по объекту УчастникЗадачXDTO. +// +// Параметры: +// Приемник - Произвольный - объект, содержащий реквизиты или свойства, +// которые должны быть заполнены по свойству объекта XDTO. +// УчастникЗадачXDTO - ОбъектXDTO - объект XDTO типа DMTaskParticipant. +// ИмяРеквизита - Строка - имя объектного реквизита. +// ЗаполнятьПредставление - Булево - признак необходимости заполнения реквизита представления +// по свойству objectID.presentation. +// +Процедура УчастникЗадачДО(Приемник, УчастникЗадачXDTO, ИмяРеквизита, ЗаполнятьПредставление = Истина) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.УчастникЗадачДО(Приемник, УчастникЗадачXDTO, ИмяРеквизита, ЗаполнятьПредставление); +``` +
+ +## ЗаполнитьОбработкуВФорме +
+ +Описание, пример вызова + +```bsl + +// Выполняет перерисовку обработки в форме. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма с деревом обработки. +// ДанныеОбОбработкеXDTO - ОбъектXDTO - объект XDTO типа DMGetCurrentObjectProcessingResponse. +// +Процедура ЗаполнитьОбработкуВФорме(Форма, ДанныеОбОбработкеXDTO) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ЗаполнитьОбработкуВФорме(Форма, ДанныеОбОбработкеXDTO) +``` +
+ +## ЗаполнитьОбработкуЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос на заполнение обработки. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеОбработки - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеОбработки +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMFillProcessingRequest. +// +Функция ЗаполнитьОбработкуЗапрос(Прокси, ДанныеОбработки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ЗаполнитьОбработкуЗапрос(Прокси, ДанныеОбработки) +``` +
+ +## НачатьОбработкуЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос на запуск обработки. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеОбработки - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеОбработки +// ВнешнийОбъект - ЛюбаяСсылка - ссылка на объект ИС. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMStartProcessingRequest. +// +Функция НачатьОбработкуЗапрос(Прокси, ДанныеОбработки, ВнешнийОбъект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.НачатьОбработкуЗапрос(Прокси, ДанныеОбработки, ВнешнийОбъект); +``` +
+ +## ОбъектДОПоддерживаетОбработку +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможно ли запустить обработку объекта указанного типа. +// +// Параметры: +// ТипОбъектаXDTO - Строка - тип объекта. +// +// Возвращаемое значение: +// Булево +// +Функция ОбъектДОПоддерживаетОбработку(ТипОбъектаXDTO) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ОбъектДОПоддерживаетОбработку(ТипОбъектаXDTO) +``` +
+ +## ОстановитьОбработкуЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос на остановку обработки. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеОбработки - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеОбработки +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMStopContinueProcessingRequest. +// +Функция ОстановитьОбработкуЗапрос(Прокси, ДанныеОбработки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ОстановитьОбработкуЗапрос(Прокси, ДанныеОбработки) +``` +
+ +## ПерезапуститьОбработкуЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос на перезапуск обработки. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеОбработки - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеОбработки +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMRestartProcessingRequest. +// +Функция ПерезапуститьОбработкуЗапрос(Прокси, ДанныеОбработки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ПерезапуститьОбработкуЗапрос(Прокси, ДанныеОбработки) +``` +
+ +## ПрерватьОбработкуЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос на прерывание обработки. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеОбработки - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеОбработки +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMTerminateProcessingRequest. +// +Функция ПрерватьОбработкуЗапрос(Прокси, ДанныеОбработки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ПрерватьОбработкуЗапрос(Прокси, ДанныеОбработки) +``` +
+ +## ПродолжитьОбработкуЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос на продолжение обработки. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеОбработки - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеОбработки +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMStopContinueProcessingRequest. +// +Функция ПродолжитьОбработкуЗапрос(Прокси, ДанныеОбработки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ПродолжитьОбработкуЗапрос(Прокси, ДанныеОбработки) +``` +
+ +## ТекущаяОбработкаОбъектаЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос к 1С:Документообороту на получение текущей обработки объекта. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ID - Строка - идентификатор объекта XDTO. +// Тип - Строка - тип объекта XDTO. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMGetCurrentObjectProcessingRequest. +// +Функция ТекущаяОбработкаОбъектаЗапрос(Прокси, ID, Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ТекущаяОбработкаОбъектаЗапрос(Прокси, ID, Тип) +``` +
+ +## ДочерниеУчастникиДействия +
+ +Описание, пример вызова + +```bsl + +// Возвращает дочерних участников действия. +// +// Параметры: +// Участники - СписокXDTO - список участников действия. +// ИдентификаторРодителя - Строка - идентификатор вышестоящего участника. +// +// Возвращаемое значение: +// Массив Из ОбъектXDTO +// +Функция ДочерниеУчастникиДействия(Участники, ИдентификаторРодителя) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ДочерниеУчастникиДействия(Участники, ИдентификаторРодителя) +``` +
+ +## ЗаполнитьСостоянияИРезультатыВФормеДействия +
+ +Описание, пример вызова + +```bsl + +// Заполняет состояния действий конкретных участников в форме действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// ДействиеXDTO - ОбъектXDTO - объект XDTO типа, наследующего DMAction. +// +Процедура ЗаполнитьСостоянияИРезультатыВФормеДействия(Форма, ДействиеXDTO) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ЗаполнитьСостоянияИРезультатыВФормеДействия(Форма, ДействиеXDTO) +``` +
+ +## ЗаполнитьСтрокуXDTOИзУчастникаДействия +
+ +Описание, пример вызова + +```bsl + +// Заполняет строку участника действия XDTO из строки дерева значений Участники в форме действия. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// СтрокаXDTO - ОбъектXDTO - объект XDTO типа, наследующего DMActionParticipantRow. +// СтрокаУчастника - ДанныеФормыЭлементДерева - строка дерева значений Участники в форме действия. +// +Процедура ЗаполнитьСтрокуXDTOИзУчастникаДействия(Прокси, СтрокаXDTO, СтрокаУчастника) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ЗаполнитьСтрокуXDTOИзУчастникаДействия(Прокси, СтрокаXDTO, СтрокаУчастника) +``` +
+ +## ЗаполнитьСтрокуУчастникаДействияИзXDTO +
+ +Описание, пример вызова + +```bsl + +// Заполняет строку дерева значений Участники в форме действия. +// +// Параметры: +// СтрокаУчастника - ДанныеФормыЭлементДерева - строка дерева значений Участники в форме действия. +// СтрокаXDTO - ОбъектXDTO - объект XDTO типа, наследующего DMActionParticipantRow. +// +Процедура ЗаполнитьСтрокуУчастникаДействияИзXDTO(СтрокаУчастника, СтрокаXDTO) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ЗаполнитьСтрокуУчастникаДействияИзXDTO(СтрокаУчастника, СтрокаXDTO) +``` +
+ +## ЗаполнитьТаблицуУчастниковДействия +
+ +Описание, пример вызова + +```bsl + +// Заполняет таблицу участников действия из объекта XDTO. +// +// Параметры: +// ТаблицаУчастников - ТаблицаЗначений: +// * УчастникID - Строка +// * УчастникТип - Строка +// * ОсновнойОбъектАдресацииУчастникID - Строка +// * ОсновнойОбъектАдресацииУчастникТип - Строка +// * ДополнительныйОбъектАдресацииУчастникID - Строка +// * ДополнительныйОбъектАдресацииУчастникТип - Строка +// * Идентификатор - Строка +// ДействиеXDTO - ОбъектXDTO - объект XDTO типа, наследующего DMAction. +// +Процедура ЗаполнитьТаблицуУчастниковДействия(ТаблицаУчастников, ДействиеXDTO) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ЗаполнитьТаблицуУчастниковДействия(ТаблицаУчастников, ДействиеXDTO) +``` +
+ +## ОбработатьОтветВебСервисаНаПолучениеДействия +
+ +Описание, пример вызова + +```bsl + +// Обработчик, который вызывается после получения данных ДО в форме действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// ДействиеXDTO - ОбъектXDTO - объект XDTO типа, наследующего DMAction. +// +Процедура ОбработатьОтветВебСервисаНаПолучениеДействия(Форма, ДействиеXDTO) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ОбработатьОтветВебСервисаНаПолучениеДействия(Форма, ДействиеXDTO) +``` +
+ +## ПодготовитьДействиеДляЗаписи +
+ +Описание, пример вызова + +```bsl + +// Формирует объект XDTO для записи в Документообороте по данным из формы действия. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа, наследующего DMAction. +// +Функция ПодготовитьДействиеДляЗаписи(Прокси, Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ПодготовитьДействиеДляЗаписи(Прокси, Форма) +``` +
+ +## ПодсказкаКнопкиРазныеСрокиДействия +
+ +Описание, пример вызова + +```bsl + +// Подсказка кнопки "Разные сроки" в некоторых формах действий. +// +// Параметры: +// ПоПунктам - Булево - действие выполняется по пунктам. +// ПоЭтапам - Булево - действие выполняется по этапам. +// +// Возвращаемое значение: +// Строка - подсказка. +// +Функция ПодсказкаКнопкиРазныеСрокиДействия(ПоПунктам, ПоЭтапам) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.ПодсказкаКнопкиРазныеСрокиДействия(ПоПунктам, ПоЭтапам) +``` +
+ +## ПриСозданииНаСервереФормыДействия +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриСозданииНаСервере формы действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// Параметры - Структура - структура параметров формы действия: +// * ID - Строка +// * type - Строка +// +Процедура ПриСозданииНаСервереФормыДействия(Форма, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ПриСозданииНаСервереФормыДействия(Форма, Параметры) +``` +
+ +## УстановитьВидимостьНаправленияНовымУчастникамДействия +
+ +Описание, пример вызова + +```bsl + +// Устанавливает видимость команды направления действия с новыми участниками. +// В 1С:Документооборот см. ДействияСервер.УстановитьВидимостьНаправленияНовымУчастникам. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// СостояниеДействия - Строка - перечисление XDTO типа DMActionExecutionState. +// Разрешения - СписокXDTO - список XDTO типа DMActionPermissionRows. +// +Процедура УстановитьВидимостьНаправленияНовымУчастникамДействия(Форма, СостояниеДействия, Разрешения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.УстановитьВидимостьНаправленияНовымУчастникамДействия(Форма, СостояниеДействия, Разрешения) +``` +
+ +## УстановитьВидимостьУсловийУчастниковДействия +
+ +Описание, пример вызова + +```bsl + +// Устанавливает видимость колонки "Условие", если в действии есть участники с условиями. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// ДействиеXDTO - ОбъектXDTO - объект XDTO типа, наследующего DMAction. +// +Процедура УстановитьВидимостьУсловийУчастниковДействия(Форма, ДействиеXDTO) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.УстановитьВидимостьУсловийУчастниковДействия(Форма, ДействиеXDTO) +``` +
+ +## УстановитьДоступностьИзмененияУчастниковДействия +
+ +Описание, пример вызова + +```bsl + +// Устанавливает форме признак Только просмотр, если у по действию нет разрешения на изменение. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// Разрешения - ТаблицаЗначений - таблица разрешений: +// * ИдентификаторЭтапа - Строка +// * Разрешение - Строка +// +Процедура УстановитьДоступностьИзмененияУчастниковДействия(Форма, Разрешения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.УстановитьДоступностьИзмененияУчастниковДействия(Форма, Разрешения) +``` +
+ +## УчастникДействияXDTO +
+ +Описание, пример вызова + +```bsl + +// Формирует объект XDTO, описывающий участника действия. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Исполнитель - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ОсновнойОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ДополнительныйОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMActionParticipant. +// +Функция УчастникДействияXDTO(Прокси, Исполнитель, ОсновнойОбъектАдресации = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.УчастникДействияXDTO(Прокси, Исполнитель, ОсновнойОбъектАдресации, ); +``` +
+ +## УчастникДействияДО +
+ +Описание, пример вызова + +```bsl + +// Заполняет реквизит, являющийся участником действия ДО, в приемнике по объекту УчастникДействияXDTO. +// +// Параметры: +// Приемник - Произвольный - объект, содержащий реквизиты или свойства, +// которые должны быть заполнены по свойству объекта XDTO. +// УчастникДействияXDTO - ОбъектXDTO - объект XDTO типа DMActionParticipant. +// ИмяРеквизита - Строка - имя объектного реквизита. +// ЗаполнятьПредставление - Булево - признак необходимости заполнения реквизита представления +// по свойству objectID.presentation. +// +Процедура УчастникДействияДО(Приемник, УчастникДействияXDTO, ИмяРеквизита, ЗаполнятьПредставление = Истина) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.УчастникДействияДО(Приемник, УчастникДействияXDTO, ИмяРеквизита, ЗаполнятьПредставление); +``` +
+ +## УчастникиДействияСФункцией +
+ +Описание, пример вызова + +```bsl + +// Возвращает участников с указанной функцией. +// +// Параметры: +// ВсеУчастники - СписокXDTO - список всех участников действия. +// ФункцияУчастника - Строка - функция участника. +// +// Возвращаемое значение: +// Массив Из ОбъектXDTO +// +Функция УчастникиДействияСФункцией(ВсеУчастники, ФункцияУчастника) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3.УчастникиДействияСФункцией(ВсеУчастники, ФункцияУчастника) +``` +
+ +## ПерейтиНаВерсию_3_0_2_5 +
+ +Описание, пример вызова + +```bsl + +// Обработчик обновления БИД на версию 3.0.2.5. Замена идентификатора вида действия для заполнения состояния документа. +// +Процедура ПерейтиНаВерсию_3_0_2_5() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3.ПерейтиНаВерсию_3_0_2_5() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборот3Клиент.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборот3Клиент.md new file mode 100644 index 0000000..3cb8531 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборот3Клиент.md @@ -0,0 +1,1794 @@ +--- +title: Интеграция с 1С документооборот3 клиент +slug: zup/интеграция-с-1с-документооборот3-клиент +--- + + +## ВыбратьСтраницуДинамическогоСписка +
+ +Описание, пример вызова + +```bsl + +// Обработчик события нажатия на кнопку динамического списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, на которой находится динамический список. +// Команда - КомандаФормы - команда формы, имя которой соответствует нажатой кнопке. +// ТекущаяСтраница - Число - номер текущей страницы. +// ВсегоСтраниц - Число - максимальное количество страниц. +// ОписаниеОповещения - ОписаниеОповещения - описание оповещения, куда будет передан номер выбранной страницы. +// +Процедура ВыбратьСтраницуДинамическогоСписка(Форма, Команда, ТекущаяСтраница, ВсегоСтраниц, ОписаниеОповещения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ВыбратьСтраницуДинамическогоСписка(Форма, Команда, ТекущаяСтраница, ВсегоСтраниц, ОписаниеОповещения) +``` +
+ +## ЗаголовокКомандыУпорядочивания +
+ +Описание, пример вызова + +```bsl + +// Возвращает заголовок кнопки упорядочивания в контекстном меню динамического списка. +// +// Параметры: +// ЭлементСписок - ТаблицаФормы - элемент формы, где находится динамический список. +// ПолеДляСортировки - Строка - имя реквизита динамического списка, по которому выполняется сортировка. +// НаправлениеСортировкиПоля - Булево - если Ложь, то сортировка по возрастанию, если Истина, то по убыванию. +// ВозможныеПоляДляСортировки - Соответствие: +// * Ключ - Строка - имя реквизита динамического списка на форме, по которому может выполняться сортировка. +// * Значение - Строка - имя реквизита XDTO объекта, по которому нужно выполнить сортировку. +// +// Возвращаемое значение: +// Строка +// +Функция ЗаголовокКомандыУпорядочивания(ЭлементСписок, ПолеДляСортировки, НаправлениеСортировкиПоля, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Клиент.ЗаголовокКомандыУпорядочивания(ЭлементСписок, ПолеДляСортировки, НаправлениеСортировкиПоля, ); +``` +
+ +## КомандаУпорядочить +
+ +Описание, пример вызова + +```bsl + +// Меняет поле и направление сортировки, обновляет шапку динамического списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, на которой находится динамический список. +// ЭлементСписок - ТаблицаФормы - элемент формы, где находится динамический список. +// ЭлементКомандаУпорядочить - КнопкаФормы - кнопка упорядочивания в контекстном меню динамического списка. +// ПолеДляСортировки - Строка - имя реквизита динамического списка, по которому выполняется сортировка. +// НаправлениеСортировкиПоля - Булево - если Ложь, то сортировка по возрастанию, если Истина, то по убыванию. +// ВозможныеПоляДляСортировки - Соответствие: +// * Ключ - Строка - имя реквизита динамического списка на форме, по которому может выполняться сортировка. +// * Значение - Строка - имя реквизита XDTO объекта, по которому нужно выполнить сортировку. +// КлючФормы - Строка - идентификатор формы для сохранения настроек сортировки в хранилище. +// +Процедура КомандаУпорядочить(Форма, ЭлементСписок, ЭлементКомандаУпорядочить, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.КомандаУпорядочить(Форма, ЭлементСписок, ЭлементКомандаУпорядочить, ); +``` +
+ +## ОбновитьСортировкуВЗаголовкеЯчейки +
+ +Описание, пример вызова + +```bsl + +// Добавляет в шапку динамического списка символ направления сортировки для соответствующего поля. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, на которой находится динамический список. +// ЭлементСписок - ТаблицаФормы - элемент формы, где находится динамический список. +// ЭлементКомандаУпорядочить - КнопкаФормы - кнопка упорядочивания в контекстном меню динамического списка. +// ПолеДляСортировки - Строка - имя реквизита динамического списка, по которому выполняется сортировка. +// НаправлениеСортировкиПоля - Булево - если Ложь, то сортировка по возрастанию, если Истина, то по убыванию. +// ВозможныеПоляДляСортировки - Соответствие: +// * Ключ - Строка - имя реквизита динамического списка на форме, по которому может выполняться сортировка. +// * Значение - Строка - имя реквизита XDTO объекта, по которому нужно выполнить сортировку. +// +Процедура ОбновитьСортировкуВЗаголовкеЯчейки(Форма, ЭлементСписок, ЭлементКомандаУпорядочить, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ОбновитьСортировкуВЗаголовкеЯчейки(Форма, ЭлементСписок, ЭлементКомандаУпорядочить, ); +``` +
+ +## ВыбратьЗначениеИзСписка +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора значения из списка объектов документооборота и помещает выбранное значение на форме. +// +// Параметры: +// ТипОбъектаВыбора - Строка - имя класса XDTO, соответствующего типу выбираемого объекта. +// Реквизит - Строка - имя реквизита формы, в который будет помещено значение, выбранное из документооборота. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызывается форма выбора. +// Отбор - Структура - условия, накладываемые на список. +// +Процедура ВыбратьЗначениеИзСписка(ТипОбъектаВыбора, Реквизит, ФормаВладелец, Отбор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ВыбратьЗначениеИзСписка(ТипОбъектаВыбора, Реквизит, ФормаВладелец, Отбор); +``` +
+ +## ВыбратьЗначениеИзСпискаВТаблице +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора значения реквизита в таблице из списка объектов документооборота. +// +// Параметры: +// ТипОбъектаВыбора - Строка - имя класса XDTO, соответствующего типу выбираемого объекта. +// Реквизит - Строка - имя реквизита формы, в который будет помещено значение, выбранное из документооборота. +// ТекущиеДанные - ДанныеФормыЭлементКоллекции +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызывается форма выбора. +// Отбор - Структура - условия, накладываемые на список. +// +Процедура ВыбратьЗначениеИзСпискаВТаблице(ТипОбъектаВыбора, Реквизит, ТекущиеДанные, ФормаВладелец, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ВыбратьЗначениеИзСпискаВТаблице(ТипОбъектаВыбора, Реквизит, ТекущиеДанные, ФормаВладелец, ); +``` +
+ +## ВыбратьЗначениеПоТипуОбъекта +
+ +Описание, пример вызова + +```bsl + +// Начинает процесс выбора объекта ДО указанного типа, возвращая результат вызовом оповещения. +// +// Параметры: +// ОписаниеОповещения - ОписаниеОповещения - вызывается после завершения выбора с передачей структуры, +// описывающей выбранный объект. +// ТипОбъектаВыбора - Строка - тип выбираемого объекта (XDTO, например, "DMCorrespondent"). +// Отбор - Структура - накладываемый отбор. +// ВыбранноеЗначение - Строка - идентификатор ранее выбранного значения. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызван выбор. +// +Процедура ВыбратьЗначениеПоТипуОбъекта(ОписаниеОповещения, ТипОбъектаВыбора, Отбор = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ВыбратьЗначениеПоТипуОбъекта(ОписаниеОповещения, ТипОбъектаВыбора, Отбор, ); +``` +
+ +## ВыбратьСотрудникаИзДереваПодразделений +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора сотрудника в разрезе подразделений, и помещает выбранного сотрудника в реквизит формы. +// +// Параметры: +// Реквизит - Строка - имя реквизита формы, в который будет помещен выбранный сотрудник. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызывается форма выбора сотрудника. +// ЗаполнятьПредставление - Булево - признак необходимости заполнения представления сотрудника. +// +Процедура ВыбратьСотрудникаИзДереваПодразделений(Реквизит, ФормаВладелец, ЗаполнятьПредставление = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ВыбратьСотрудникаИзДереваПодразделений(Реквизит, ФормаВладелец, ЗаполнятьПредставление); +``` +
+ +## ВызванаИнтерактивнаяОбработка +
+ +Описание, пример вызова + +```bsl + +// Выполняет требуемое интерактивное действие, и сообщает о том была ли вызвана интерактивная обработка или нет. +// +// Параметры: +// РезультатДействия - см. ИнтеграцияС1СДокументооборот3.РезультатВыполненияКомандыПоОбъекту +// ТипОперации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ТипОперацииНадЗадачей +// ПовторноеДействие - ОписаниеОповещения - метод, который будет вызван по завершении интерактивной обработки. +// +// Возвращаемое значение: +// Булево +// +Функция ВызванаИнтерактивнаяОбработка(РезультатДействия, ТипОперации, ПовторноеДействие) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Клиент.ВызванаИнтерактивнаяОбработка(РезультатДействия, ТипОперации, ПовторноеДействие) +``` +
+ +## ВыполнитьПодключаемуюКомандуИнтеграцииЗавершение +
+ +Описание, пример вызова + +```bsl + +// Продолжает выполнение подключаемой команды интеграции после проверки подключения. +// +// Параметры: +// Команда - КомандаФормы - вызванная команда. +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызывается команда. +// Источник - ДанныеФормыСтруктура +// +Процедура ВыполнитьПодключаемуюКомандуИнтеграцииЗавершение(Команда, Форма, Источник) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ВыполнитьПодключаемуюКомандуИнтеграцииЗавершение(Команда, Форма, Источник) +``` +
+ +## ЗаполнитьСоответствиеФорм +
+ +Описание, пример вызова + +```bsl + +// Заполняет соответствие форм БИД объектам документооборота. +// +// Параметры: +// СоответствиеФорм - Соответствие - неявно возвращаемое значение, соответствие форм. +// +Процедура ЗаполнитьСоответствиеФорм(СоответствиеФорм) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ЗаполнитьСоответствиеФорм(СоответствиеФорм) +``` +
+ +## ИзменитьОтносительныйСрок +
+ +Описание, пример вызова + +```bsl + +// Меняет относительный срок (дни, часы, минуты), добавляя переданную длительность. +// Если заполнены минуты, то меняются только минуты. +// Если минут нет и заполнены часы, то меняются только часы. +// Если заполнены только дни, то меняются только они. +// +// Параметры: +// Дни - Число - длительность, дней. +// Часы - Число - длительность, часов. +// Минуты - Число - длительность, минут. +// Длительность - Число - добавляемая длительность. Для уменьшения срока используется "-1", для увеличения "1". +// +Процедура ИзменитьОтносительныйСрок(Дни, Часы, Минуты, Длительность) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ИзменитьОтносительныйСрок(Дни, Часы, Минуты, Длительность) +``` +
+ +## КлючСтрокиДерева +
+ +Описание, пример вызова + +```bsl + +// Формирует ключ строки дерева формы. +// +// Параметры: +// ТипДерева - см. ИнтеграцияС1СДокументооборот3Клиент.ТипДерева +// СтрокаДерева - СтрокаДереваЗначений +// +// Возвращаемое значение: +// Строка +// +Функция КлючСтрокиДерева(ТипДерева, СтрокаДерева) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Клиент.КлючСтрокиДерева(ТипДерева, СтрокаДерева) +``` +
+ +## НачатьСозданиеСвязанногоОбъектаДО +
+ +Описание, пример вызова + +```bsl + +// Выполняет создание объекта ДО, его заполнение по объекту ИС и установку связи после записи. При +// необходимости предлагает пользователю выбор правила. +// +// Параметры: +// ОбъектИС - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС, +// на основании которого создается объект ДО. +// ОписаниеОповещения - ОписаниеОповещения - обработчик, вызываемый после создания. +// ИспользоватьПриоритетныеПравила - Булево - нужно ли задавать вопрос пользователю, в случае если +// для объекта ИС настроено несколько различных правил интеграции, или нужно использовать наиболее +// приоритетное по ключевым реквизитам правило. +// +Процедура НачатьСозданиеСвязанногоОбъектаДО(ОбъектИС, ОписаниеОповещения = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.НачатьСозданиеСвязанногоОбъектаДО(ОбъектИС, ОписаниеОповещения, ); +``` +
+ +## НачатьСозданиеСвязанногоОбъектаДОПослеВыбораПравила +
+ +Описание, пример вызова + +```bsl + +// Выполняет создание объекта ДО, его заполнение по объекту ИС и установку связи после записи. При +// необходимости предлагает пользователю выбор правила. +// +// Параметры: +// Результат - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом - правило заполнения. +// Параметры - Структура: +// * ОбъектИС - Произвольный - объект ИС, на основании которого создается объект ДО. +// * ОписаниеОповещения - ОписаниеОповещения - обработчик, вызываемый после создания. +// +Процедура НачатьСозданиеСвязанногоОбъектаДОПослеВыбораПравила(Знач Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.НачатьСозданиеСвязанногоОбъектаДОПослеВыбораПравила(Результат, Параметры) +``` +
+ +## ОткрытьОбъектДО +
+ +Описание, пример вызова + +```bsl + +// Запускает интегрированную базу ДО и переходит по указанной ссылке. +// +// Параметры: +// СсылкаНаОбъектДО - Строка - навигационная ссылка по которой требуется перейти в базе ДО. +// Если параметр не задан, то ссылка будет браться из параметра сеанса ИнтеграцияС1СДокументооборотОбъектДО. +// +Процедура ОткрытьОбъектДО(Знач СсылкаНаОбъектДО = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ОткрытьОбъектДО(СсылкаНаОбъектДО); +``` +
+ +## РазвернутьДерево +
+ +Описание, пример вызова + +```bsl + +// Разворачивает дерево на форме. +// +// Параметры: +// ТипДерева - см. ИнтеграцияС1СДокументооборот3Клиент.ТипДерева +// СтрокиДерева - ДанныеФормыКоллекцияЭлементовДерева - данные дерева на форме. +// ТаблицаФормы - ТаблицаФормы - элемент формы, куда выводится дерево. +// ТекущееСостояниеДерева - см. ИнтеграцияС1СДокументооборот3Клиент.ТекущееСостояниеДерева +// +Процедура РазвернутьДерево(ТипДерева, СтрокиДерева, ТаблицаФормы, ТекущееСостояниеДерева = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.РазвернутьДерево(ТипДерева, СтрокиДерева, ТаблицаФормы, ТекущееСостояниеДерева); +``` +
+ +## ТекущееСостояниеДерева +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущее состояние дерева на форме. +// +// Параметры: +// ТипДерева - см. ИнтеграцияС1СДокументооборот3Клиент.ТипДерева +// СтрокиДерева - ДанныеФормыКоллекцияЭлементовДерева - данные дерева на форме. +// ТаблицаФормы - ТаблицаФормы - элемент формы, куда выводится дерево. +// +// Возвращаемое значение: +// Структура: +// * СостояниеРазвернут - Соответствие: +// ** Ключ - Строка +// ** Значение - Булево +// * КлючТекущейСтрокиДерева - Строка +// +Функция ТекущееСостояниеДерева(ТипДерева, СтрокиДерева, ТаблицаФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Клиент.ТекущееСостояниеДерева(ТипДерева, СтрокиДерева, ТаблицаФормы) +``` +
+ +## ТипДерева +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей тип дерева. +// +// Возвращаемое значение: +// Структура: +// * ЭтоДеревоПриложений - Булево +// * ЭтоДеревоОбработки - Булево +// +Функция ТипДерева() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Клиент.ТипДерева() +``` +
+ +## ОбработкаКомандыНачатьОбработку +
+ +Описание, пример вызова + +```bsl + +// Обработчик общей команды ИнтеграцияС1СДокументооборотНачатьОбработку +// +// Параметры: +// МассивСсылок - Произвольный - в параметр передается значение от источника, в котором реализована команда. +// Может содержать как единичное значение, так и массив значений. +// ПараметрыВыполнения - ПараметрыВыполненияКоманды - в обработчике команды можно изменить значение свойств +// параметра. +// +Процедура ОбработкаКомандыНачатьОбработку(МассивСсылок, ПараметрыВыполнения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ОбработкаКомандыНачатьОбработку(МассивСсылок, ПараметрыВыполнения) +``` +
+ +## ЗаменитьРольФайлов +
+ +Описание, пример вызова + +```bsl + +// Изменяет роли файлов. +// +// Параметры: +// СписокФайлов - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла +// ВыбраннаяРольID - Строка - идентификатор новой роли файлов. +// ВладелецФайлов - Строка - идентификатор владельца файлов. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ЗаменитьРольФайлов(СписокФайлов, ВыбраннаяРольID, ВладелецФайлов, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ЗаменитьРольФайлов(СписокФайлов, ВыбраннаяРольID, ВладелецФайлов, ); +``` +
+ +## ПеренестиФайлыИСвДО +
+ +Описание, пример вызова + +```bsl + +// Копирует присоединенные файлы объекта, хранящиеся на стороне ИС в связанный объект на стороне ДО. +// +// Параметры: +// ПрисоединенныеФайлыВИС - СписокЗначений из ЛюбаяСсылка - список присоединенных файлов в ИС. +// ВладелецID - Строка - идентификатор владельца файла в Документообороте. +// ВладелецТип - Строка - тип XDTO владельца файла в Документообороте. +// ВладелецПредставление - Строка - представление владельца файла. +// Владелец - ЛюбаяСсылка - владелец файла. +// РольФайлаID - Строка - роль файла. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ПеренестиФайлыИСвДО(ПрисоединенныеФайлыВИС, ВладелецID, ВладелецТип, ВладелецПредставление, Владелец, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПеренестиФайлыИСвДО(ПрисоединенныеФайлыВИС, ВладелецID, ВладелецТип, ВладелецПредставление, Владелец, ); +``` +
+ +## ТекущаяРольФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает идентификатор текущей роли файлов. +// +// Параметры: +// ДеревоФайлов - ДанныеФормыДерево - дерево файлов. +// ТекущаяСтрока - Число - идентификатор текущей строки. +// +// Возвращаемое значение: +// Строка - текущая роль файлов. +// Неопределено - никакая роль не найдена. +// +Функция ТекущаяРольФайла(ДеревоФайлов, ТекущаяСтрока) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Клиент.ТекущаяРольФайла(ДеревоФайлов, ТекущаяСтрока) +``` +
+ +## ДанныеПоЗадаче +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные по задаче, заполненные из данных формы задачи или формы списка задач. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма задачи или списка задач. +// ID - Строка - идентификатор задачи Документооборота. +// Тип - Строка - XDTO-тип задачи Документооборота. +// Заголовок - Строка - заголовок задачи. +// ПараметрыОперации - Структура: +// * РезультатВариантаНомер - Строка - имя реквизита формы, содержащего выбранный пользователем вариант +// выполнения действия задачи. +// * Флаг - Строка - имя флага, принимает значения перечисления DMObjectFlag (HTTP://www.1c.ru/dm). +// +// Возвращаемое значение: +// см. ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеПоЗадаче +// +Функция ДанныеПоЗадаче(Форма, ID, Тип, Заголовок, ПараметрыОперации = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Клиент.ДанныеПоЗадаче(Форма, ID, Тип, Заголовок, ПараметрыОперации); +``` +
+ +## ДеревоПриложенийЗадачиПередНачаломИзменения +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед началом интерактивного изменения строки дерева приложений. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// Отказ - Булево - признак отказа от редактирования строки. +// +Процедура ДеревоПриложенийЗадачиПередНачаломИзменения(СтрокаДереваПриложений, Отказ) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ДеревоПриложенийЗадачиПередНачаломИзменения(СтрокаДереваПриложений, Отказ) +``` +
+ +## ОткрытьКарточкуПриложенияЗадачи +
+ +Описание, пример вызова + +```bsl + +// Открывает карточку приложения. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// +Процедура ОткрытьКарточкуПриложенияЗадачи(СтрокаДереваПриложений) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ОткрытьКарточкуПриложенияЗадачи(СтрокаДереваПриложений) +``` +
+ +## ОткрытьПриложениеЗадачиНаПросмотр +
+ +Описание, пример вызова + +```bsl + +// Открывает приложение на просмотр. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ОткрытьПриложениеЗадачиНаПросмотр(СтрокаДереваПриложений, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ОткрытьПриложениеЗадачиНаПросмотр(СтрокаДереваПриложений, УникальныйИдентификаторФормы) +``` +
+ +## Подключаемый_СоздатьСвязанныйОбъект +
+ +Описание, пример вызова + +```bsl + +// Команды с этим обработчиком создаются программно согласно предметам активной задачи. +// +// Параметры: +// Команда - КомандаФормы - команда создания на основании. +// ОсновнойПредметID - Строка - идентификатор основного объекта задачи. +// ОсновнойПредметТип - Строка - тип основного объекта задачи. +// +Процедура Подключаемый_СоздатьСвязанныйОбъект(Команда, ОсновнойПредметID, ОсновнойПредметТип) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.Подключаемый_СоздатьСвязанныйОбъект(Команда, ОсновнойПредметID, ОсновнойПредметТип) +``` +
+ +## ПриложенияЗадачиФайлыВставитьКартинкуИзБуфера +
+ +Описание, пример вызова + +```bsl + +// Добавляет к приложению картинку из буфера. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ПриложенияЗадачиФайлыВставитьКартинкуИзБуфера(СтрокаДереваПриложений, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПриложенияЗадачиФайлыВставитьКартинкуИзБуфера(СтрокаДереваПриложений, УникальныйИдентификаторФормы) +``` +
+ +## ПриложенияЗадачиФайлыДобавить +
+ +Описание, пример вызова + +```bsl + +// Добавляет к приложению файл с диска. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ПриложенияЗадачиФайлыДобавить(СтрокаДереваПриложений, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПриложенияЗадачиФайлыДобавить(СтрокаДереваПриложений, УникальныйИдентификаторФормы) +``` +
+ +## ПриложенияЗадачиФайлыУдалить +
+ +Описание, пример вызова + +```bsl + +// Удаляет приложение. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ПриложенияЗадачиФайлыУдалить(СтрокаДереваПриложений, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПриложенияЗадачиФайлыУдалить(СтрокаДереваПриложений, УникальныйИдентификаторФормы) +``` +
+ +## ПриложенияЗадачиФайлыРедактировать +
+ +Описание, пример вызова + +```bsl + +// Открывает файл для редактирования. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ПриложенияЗадачиФайлыРедактировать(СтрокаДереваПриложений, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПриложенияЗадачиФайлыРедактировать(СтрокаДереваПриложений, УникальныйИдентификаторФормы) +``` +
+ +## ПриложенияЗадачиФайлыЗакончитьРедактирование +
+ +Описание, пример вызова + +```bsl + +// Заканчивает редактирование файла, помещая его в ДО и снимая захват, если необходимо. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ПриложенияЗадачиФайлыЗакончитьРедактирование(СтрокаДереваПриложений, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПриложенияЗадачиФайлыЗакончитьРедактирование(СтрокаДереваПриложений, УникальныйИдентификаторФормы) +``` +
+ +## ПриложенияЗадачиФайлыОсвободить +
+ +Описание, пример вызова + +```bsl + +// Отменяет редактирование ранее захваченного файла. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ПриложенияЗадачиФайлыОсвободить(СтрокаДереваПриложений, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПриложенияЗадачиФайлыОсвободить(СтрокаДереваПриложений, УникальныйИдентификаторФормы) +``` +
+ +## ПриложенияЗадачиФайлыОбновитьИзФайлаНаДиске +
+ +Описание, пример вызова + +```bsl + +// Обновляет файл ДО из файла на диске. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ПриложенияЗадачиФайлыОбновитьИзФайлаНаДиске(СтрокаДереваПриложений, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПриложенияЗадачиФайлыОбновитьИзФайлаНаДиске(СтрокаДереваПриложений, УникальныйИдентификаторФормы) +``` +
+ +## ПриложенияЗадачиФайлыСохранитьКак +
+ +Описание, пример вызова + +```bsl + +// Сохраняет файлы из дерева приложений на диск, в указанный пользователем каталог. +// +// Параметры: +// СтрокаДереваПриложений - ДанныеФормыЭлементДерева - текущая строка дерева приложений. +// Форма - ФормаКлиентскогоПриложения - форма задачи или списка задач. +// +Процедура ПриложенияЗадачиФайлыСохранитьКак(СтрокаДереваПриложений, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПриложенияЗадачиФайлыСохранитьКак(СтрокаДереваПриложений, Форма) +``` +
+ +## УстановитьДоступностьКомандПриложенийЗадачи +
+ +Описание, пример вызова + +```bsl + +// Устанавливает видимость и доступность команд в дереве приложений. +// +// Параметры: +// ТекущаяСтрока - Число - номер текущей строки дерева приложений. +// КлючСтрокиДереваПриложений - Строка - ключ строки для предотвращения зацикливания. +// ЗадачаID - Строка - идентификатор текущей задачи. +// Форма - ФормаКлиентскогоПриложения - форма задачи или списка задач. +// ЭтоТонкийWindowsКлиент - Булево - требуется для установки доступности команды вставки из буфера обмена. +// +Процедура УстановитьДоступностьКомандПриложенийЗадачи(ТекущаяСтрока, КлючСтрокиДереваПриложений, ЗадачаID, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.УстановитьДоступностьКомандПриложенийЗадачи(ТекущаяСтрока, КлючСтрокиДереваПриложений, ЗадачаID, ); +``` +
+ +## НачатьОбработку +
+ +Описание, пример вызова + +```bsl + +// Стартует обработку связанного объекта ДО. При передаче в качестве предмета ссылки на объект ИС +// создает связанный объект ДО, если эта связь не была установлена ранее. +// +// Параметры: +// Предмет - ЛюбаяСсылка +// - Структура: +// * ID - Строка +// * type - Строка +// * name - Строка +// * ВнешнийОбъект - ЛюбаяСсылка +// ОписаниеОповещения - ОписаниеОповещения - описание оповещения, вызываемого при завершении. +// ИспользоватьПриоритетныеПравила - Булево - нужно ли задавать вопрос пользователю при создании нового объекта ДО +// по правилам интеграции, в случае если для объекта ИС настроено несколько различных правил интеграции, +// или нужно использовать наиболее приоритетное по ключевым реквизитам правило. +// +Процедура НачатьОбработку(Предмет = Неопределено, ОписаниеОповещения = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.НачатьОбработку(Предмет, ОписаниеОповещения, ); +``` +
+ +## НачатьОбработкуПослеПоискаСвязанногоОбъектаДО +
+ +Описание, пример вызова + +```bsl + +// Продолжает создание бизнес-процесса после поиска связанного объекта ДО. +// +// Параметры: +// Результат - Неопределено +// - Структура: +// * ID - Строка +// * type - Строка +// * name - Строка +// Параметры - Структура: +// * ГлавнаяЗадача- Структура: +// ** ID - Строка +// ** type - Строка +// ** name - Строка +// * ОписаниеОповещения - ОписаниеОповещения - описание оповещения, вызываемого при завершении. +// * Предмет - ЛюбаяСсылка, +// - Структура: +// ** ID - Строка +// ** type - Строка +// ** name - Строка +// ** ВнешнийОбъект - ЛюбаяСсылка +// +Процедура НачатьОбработкуПослеПоискаСвязанногоОбъектаДО(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.НачатьОбработкуПослеПоискаСвязанногоОбъектаДО(Результат, Параметры) +``` +
+ +## ДобавитьЭтапДействия +
+ +Описание, пример вызова + +```bsl + +// Добавляет новый этап действия в таблицу Участники. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// ФункцияЭтапа - Строка - функция участников этапа. +// +Процедура ДобавитьЭтапДействия(Форма, ФункцияЭтапа) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ДобавитьЭтапДействия(Форма, ФункцияЭтапа) +``` +
+ +## ЗаполнитьДоступностьПеремещенияЭтаповУчастниковДействия +
+ +Описание, пример вызова + +```bsl + +// Заполняет доступность перемещения этапов и учатников в карточке действия согласования или подписания. +// +// Параметры: +// СтрокиДерева - ДанныеФормыДерево +// - ДанныеФормыКоллекцияЭлементовДерева - дерево этапов или участников. +// ЗаполнениеВсегоДерева - Булево - Истина, если заполнять все дерево. +// +Процедура ЗаполнитьДоступностьПеремещенияЭтаповУчастниковДействия(СтрокиДерева, ЗаполнениеВсегоДерева = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ЗаполнитьДоступностьПеремещенияЭтаповУчастниковДействия(СтрокиДерева, ЗаполнениеВсегоДерева); +``` +
+ +## ИзменитьПризнакУчастникаДействияЗащищенный +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды Защищенный в формах настроек действий и самих действий. +// Устанавливает/снимает отметку защищенности в форме для выделенного участника или этапа. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура ИзменитьПризнакУчастникаДействияЗащищенный(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ИзменитьПризнакУчастникаДействияЗащищенный(Форма) +``` +
+ +## ОписаниеОтложенногоНачалаВыполненияДействияНажатие +
+ +Описание, пример вызова + +```bsl + +// Обработчик нажатия на поле ОписаниеОтложенногоНачалаВыполнения. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// +Процедура ОписаниеОтложенногоНачалаВыполненияДействияНажатие(Форма, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ОписаниеОтложенногоНачалаВыполненияДействияНажатие(Форма, СтандартнаяОбработка) +``` +
+ +## ОписаниеОтложенногоНачалаВыполненияДействияНажатиеПродолжение +
+ +Описание, пример вызова + +```bsl + +// Продолжение процедуры ОписаниеОтложенногоНачалаВыполненияДействияНажатие. +// +// Параметры: +// Результат - Структура: +// * Дни - Число +// * Часы - Число +// * ОтложеннаяДата - Дата +// Параметры - Структура: +// * Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура ОписаниеОтложенногоНачалаВыполненияДействияНажатиеПродолжение(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ОписаниеОтложенногоНачалаВыполненияДействияНажатиеПродолжение(Результат, Параметры) +``` +
+ +## ОчиститьЗадержкуДействия +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды ПереместитьВверх в форме действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура ОчиститьЗадержкуДействия(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ОчиститьЗадержкуДействия(Форма) +``` +
+ +## ПараметрыДобавленияУчастниковДействия +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей параметры добавления участников действия. +// +// Возвращаемое значение: +// Структура: +// * СЭтапами - Булево - у действия есть этапы. +// * ВозможныДочерниеИсполнители - Булево - действие поддерживает дочерних исполнителей. +// * ПоПунктам - Булево - действие исполняется по пунктам. +// * МожноДобавлятьЭтапы - Булево - можно добавлять этапы действия. +// * МожноТолькоДобавлятьУчастников - Булево - можно только добавлять участников действия. +// * ФункцияУчастника - Строка - функция участника действия. +// +Функция ПараметрыДобавленияУчастниковДействия() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Клиент.ПараметрыДобавленияУчастниковДействия() +``` +
+ +## ПереместитьУчастникаДействияВверх +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды ПереместитьВверх в форме действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// МожноМенятьПорядокЭтапов - Булево - действие позволяет изменять порядок этапов. +// ПоПунктам - Булево - действие исполняется по пунктам. +// +Процедура ПереместитьУчастникаДействияВверх(Форма, МожноМенятьПорядокЭтапов = Истина, ПоПунктам = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПереместитьУчастникаДействияВверх(Форма, МожноМенятьПорядокЭтапов, ПоПунктам); +``` +
+ +## ПереместитьУчастникаДействияВниз +
+ +Описание, пример вызова + +```bsl + +// Обработчик команды ПереместитьВниз в форме действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// МожноМенятьПорядокЭтапов - Булево - действие позволяет изменять порядок этапов. +// ПоПунктам - Булево - действие исполняется по пунктам. +// +Процедура ПереместитьУчастникаДействияВниз(Форма, МожноМенятьПорядокЭтапов = Истина, ПоПунктам = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПереместитьУчастникаДействияВниз(Форма, МожноМенятьПорядокЭтапов, ПоПунктам); +``` +
+ +## ПорядокВыполненияДейстияУчастникамиПриИзменении +
+ +Описание, пример вызова + +```bsl + +// Обработчик ПриИзменении в поле Порядок в форме действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура ПорядокВыполненияДейстияУчастникамиПриИзменении(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПорядокВыполненияДейстияУчастникамиПриИзменении(Форма) +``` +
+ +## ПорядокВыполненияДейстияУчастникамиОбработкаВыбора +
+ +Описание, пример вызова + +```bsl + +// Обработчик ОбработкаВыбора в поле Порядок в форме действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// ВыбранноеЗначение - Произвольный - выбранное значение, которое будет установлено как значения поля ввода. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// +Процедура ПорядокВыполненияДейстияУчастникамиОбработкаВыбора(Форма, ВыбранноеЗначение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПорядокВыполненияДейстияУчастникамиОбработкаВыбора(Форма, ВыбранноеЗначение, СтандартнаяОбработка) +``` +
+ +## ПослеПредупрежденияОЗащищенностиУчастникаДействия +
+ +Описание, пример вызова + +```bsl + +// Сохраняет значение галки "Больше не показывать" после предупреждения о защищенности участников. +// +// Параметры: +// Результат - Структура: +// * БольшеНеЗадаватьЭтотВопрос - Булево +// * Значение - КодВозвратаДиалога +// ДополнительныеПараметры - Неопределено +// +Процедура ПослеПредупрежденияОЗащищенностиУчастникаДействия(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПослеПредупрежденияОЗащищенностиУчастникаДействия(Результат, ДополнительныеПараметры) +``` +
+ +## ПредставлениеУчастникаДействияНачалоВыбора +
+ +Описание, пример вызова + +```bsl + +// Обработчик события НачалоВыбора элемента ПредставлениеСтроки в таблице участников действия. +// +// Параметры: +// Элемент - ПолеФормы - элемент ПредставлениеСтроки в таблице участников действия. +// ДанныеВыбора - СписокЗначений из Структура - наполняемый список: +// * ID - Строка +// * type - Строка +// * name - Строка +// * presentation - Строка +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура ПредставлениеУчастникаДействияНачалоВыбора(Элемент, ДанныеВыбора, СтандартнаяОбработка, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПредставлениеУчастникаДействияНачалоВыбора(Элемент, ДанныеВыбора, СтандартнаяОбработка, Форма) +``` +
+ +## ПредставлениеУчастникаДействияНачалоВыбораЗавершение +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПредставлениеУчастникаДействияНачалоВыбораЗавершение. +// +// Параметры: +// Результат - Структура: +// * Исполнитель - Строка +// * ИсполнительID - Строка +// * ИсполнительТип - Строка +// * ОсновнойОбъектАдресации - Строка +// * ОсновнойОбъектАдресацииID - Строка +// * ОсновнойОбъектАдресацииТип - Строка +// * ДополнительныйОбъектАдресации - Строка +// * ДополнительныйОбъектАдресацииID - Строка +// * ДополнительныйОбъектАдресацииТип - Строка +// ПараметрыОповещения - Структура: +// * Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// * ТекущиеДанные - ДанныеФормыЭлементДерева +// +Процедура ПредставлениеУчастникаДействияНачалоВыбораЗавершение(Результат, ПараметрыОповещения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПредставлениеУчастникаДействияНачалоВыбораЗавершение(Результат, ПараметрыОповещения) +``` +
+ +## ПредставлениеУчастникаДействияАвтоПодбор +
+ +Описание, пример вызова + +```bsl + +// Обработчик события АвтоПодбор элемента ПредставлениеСтроки в таблице участников действия. +// +// Параметры: +// Элемент - ПолеФормы - элемент ПредставлениеСтроки в таблице участников действия. +// Текст - Строка - строка текста, введенная в поле ввода. +// ДанныеВыбора - СписокЗначений из Структура - наполняемый список: +// * ID - Строка +// * type - Строка +// * name - Строка +// * presentation - Строка +// ПараметрыПолученияДанных - Структура: +// * ВыборГруппИЭлементов - ИспользованиеГруппИЭлементов +// * Отбор - Неопределено +// * ПолнотекстовыйПоиск - Неопределено +// * РежимПолученияДанныхВыбора - РежимПолученияДанныхВыбораПриВводеПоСтроке +// * СпособПоискаСтроки - Неопределено +// * СтрокаПоиска - Строка +// Ожидание - Число - интервал в секундах после ввода текста, через который произошло событие. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура ПредставлениеУчастникаДействияАвтоПодбор(Элемент, Текст, ДанныеВыбора, ПараметрыПолученияДанных, Ожидание, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПредставлениеУчастникаДействияАвтоПодбор(Элемент, Текст, ДанныеВыбора, ПараметрыПолученияДанных, Ожидание, ); +``` +
+ +## ПредставлениеУчастникаДействияОкончаниеВводаТекста +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ОкончаниеВводаТекста элемента ПредставлениеСтроки в таблице участников действия. +// +// Параметры: +// Элемент - ПолеФормы - элемент ПредставлениеСтроки в таблице участников действия. +// Текст - Строка - строка текста, введенная в поле ввода. +// ДанныеВыбора - СписокЗначений из Структура - наполняемый список: +// * ID - Строка +// * type - Строка +// * name - Строка +// * presentation - Строка +// ПараметрыПолученияДанных - Структура: +// * ВыборГруппИЭлементов - ИспользованиеГруппИЭлементов +// * Отбор - Неопределено +// * ПолнотекстовыйПоиск - Неопределено +// * РежимПолученияДанныхВыбора - РежимПолученияДанныхВыбораПриВводеПоСтроке +// * СпособПоискаСтроки - Неопределено +// * СтрокаПоиска - Строка +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура ПредставлениеУчастникаДействияОкончаниеВводаТекста(Элемент, Текст, ДанныеВыбора, ПараметрыПолученияДанных, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПредставлениеУчастникаДействияОкончаниеВводаТекста(Элемент, Текст, ДанныеВыбора, ПараметрыПолученияДанных, ); +``` +
+ +## ПредставлениеУчастникаДействияОбработкаВыбора +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ОбработкаВыбора элемента ПредставлениеСтроки в таблице участников действия. +// +// Параметры: +// Элемент - ПолеФормы - элемент ПредставлениеСтроки в таблице участников действия. +// ВыбранноеЗначение - Произвольный - выбранное значение, которое будет установлено как значения поля ввода. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура ПредставлениеУчастникаДействияОбработкаВыбора(Элемент, ВыбранноеЗначение, СтандартнаяОбработка, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПредставлениеУчастникаДействияОбработкаВыбора(Элемент, ВыбранноеЗначение, СтандартнаяОбработка, Форма) +``` +
+ +## ПредставлениеУчастникаДействияОчистка +
+ +Описание, пример вызова + +```bsl + +// Обработчик события Очистка элемента ПредставлениеСтроки в таблице участников действия. +// +// Параметры: +// Элемент - ПолеФормы - элемент ПредставлениеСтроки в таблице участников действия. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура ПредставлениеУчастникаДействияОчистка(Элемент, СтандартнаяОбработка, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПредставлениеУчастникаДействияОчистка(Элемент, СтандартнаяОбработка, Форма) +``` +
+ +## ПриОткрытииФормыДействия +
+ +Описание, пример вызова + +```bsl + +// Вызывает код, который выполняется в обработчике события ПриОткрытии формы действия на стороне ДО. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура ПриОткрытииФормыДействия(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПриОткрытииФормыДействия(Форма) +``` +
+ +## ПроверитьУчастниковИЗаписатьДействие +
+ +Описание, пример вызова + +```bsl + +// Проверяет участников, и записывает действие в случае успешной проверки. +// +// Параметры: +// ДействиеXDTOСтрока - Строка - строковое представление объекта XDTO типа, наследующего DMAction. +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// ОповещениеОЗавершении - ОписаниеОповещения - вызывает процедуру формы после записи объекта. +// +Процедура ПроверитьУчастниковИЗаписатьДействие(ДействиеXDTOСтрока, Форма, ОповещениеОЗавершении) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПроверитьУчастниковИЗаписатьДействие(ДействиеXDTOСтрока, Форма, ОповещениеОЗавершении) +``` +
+ +## ПроверитьУчастниковИЗаписатьДействиеЗавершение +
+ +Описание, пример вызова + +```bsl + +// Вызывается после выполнения запроса к ДО на проверку участников действия в фоновом задании. +// +// Параметры: +// Результат - см. ДлительныеОперации.ОперацияВыполнена +// ПараметрыДляЗаписи - Структура: +// * ДействиеXDTOСтрока - Строка - строковое представление объекта XDTO типа, наследующего DMAction. +// * Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// * ОповещениеОЗавершении - ОписаниеОповещения - вызывает процедуру формы после записи объекта. +// +Процедура ПроверитьУчастниковИЗаписатьДействиеЗавершение(Результат, ПараметрыДляЗаписи) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.ПроверитьУчастниковИЗаписатьДействиеЗавершение(Результат, ПараметрыДляЗаписи) +``` +
+ +## РазвернутьДеревоУчастниковДействия +
+ +Описание, пример вызова + +```bsl + +// Разворачивает строки дерева участников действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура РазвернутьДеревоУчастниковДействия(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.РазвернутьДеревоУчастниковДействия(Форма) +``` +
+ +## СрокВыполненияДействияУчастникомПриИзменении +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПриИзменении в поле СрокПредставление в форме действия. +// В 1С:Документооборот см. ДействияКлиент.СрокПредставлениеПриИзменении. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// ЗаполнитьСоисполнителей - Булево - если Истина, то заполняем те же сроки у соисполнителей. +// +Процедура СрокВыполненияДействияУчастникомПриИзменении(Форма, ЗаполнитьСоисполнителей = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.СрокВыполненияДействияУчастникомПриИзменении(Форма, ЗаполнитьСоисполнителей); +``` +
+ +## СрокВыполненияДействияУчастникомРегулирование +
+ +Описание, пример вызова + +```bsl + +// Обработчик события Регулирование в поле СрокПредставление в форме действия. +// В 1С:Документооборот см. ДействияКлиент.СрокПредставлениеРегулирование. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// Направление - Число - при нажатии вверх параметр равен 1, при нажатии вниз параметр равен -1. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// ЗаполнитьСоисполнителей - Булево - если Истина, то заполняем те же сроки у соисполнителей. +// +Процедура СрокВыполненияДействияУчастникомРегулирование(Форма, Направление, СтандартнаяОбработка, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.СрокВыполненияДействияУчастникомРегулирование(Форма, Направление, СтандартнаяОбработка, ); +``` +
+ +## УстановитьДоступностьКнопкиРазныеСроки +
+ +Описание, пример вызова + +```bsl + +// Определяет доступность кнопки "Разные сроки" - она есть не во всех видах действий, и доступна не при любых условиях. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура УстановитьДоступностьКнопкиРазныеСроки(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.УстановитьДоступностьКнопкиРазныеСроки(Форма)); +``` +
+ +## УстановитьОдинаковыйСрокДействияРекурсивно +
+ +Описание, пример вызова + +```bsl + +// Рекурсивно устанавливает одинаковый срок всем участникам в пределах каждого этапа. При отключении опции "Разные +// сроки" в некоторых формах действий. +// В 1С:Документооборот см. ДействияКлиент.УстановитьОдинаковыйСрокРекурсивно. +// +// Параметры: +// СтрокиДерева - ДанныеФормыКоллекцияЭлементовДерева - текущая ветка из дерева "Участники" на формах действий. +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура УстановитьОдинаковыйСрокДействияРекурсивно(СтрокиДерева, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.УстановитьОдинаковыйСрокДействияРекурсивно(СтрокиДерева, Форма) +``` +
+ +## УстановитьПометкуКнопкиРазныеСрокиДействияРекурсивно +
+ +Описание, пример вызова + +```bsl + +// Если хоть в одной ветке дерева есть разные сроки, то кнопка "Разные сроки" делается включенной. +// В 1С:Документооборот см. ДействияКлиент.УстановитьПометкуКнопкиРазныеСрокиРекурсивно. +// +// Параметры: +// СтрокиДерева - ДанныеФормыКоллекцияЭлементовДерева - текущая ветка из дерева "Участники" на формах действий. +// КнопкаРазныеСроки - КнопкаФормы - кнопка "Разные сроки" из формы действия. +// +Процедура УстановитьПометкуКнопкиРазныеСрокиДействияРекурсивно(СтрокиДерева, КнопкаРазныеСроки) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.УстановитьПометкуКнопкиРазныеСрокиДействияРекурсивно(СтрокиДерева, КнопкаРазныеСроки) +``` +
+ +## УчастникиДействияВыбор +
+ +Описание, пример вызова + +```bsl + +// Обработчик события Выбор таблицы Участники. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// ВыбраннаяСтрока - Число - значение выбранной строки. +// Поле - ПолеФормы - активное поле (колонка). +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// ОткрыватьОсобоеНаименованиеИОписание - Булево - доступно открытие отдельной формы для ввода описания. +// ТолькоПросмотрОсобогоНаименованияИОписания - Булево - только просмотр особого наименования и описания задачи. +// ИзменятьНаименованиеЗадачи - Булево - помимо описания требуется таже изменять наименование задачи. +// +Процедура УчастникиДействияВыбор(Форма, ВыбраннаяСтрока, Поле, СтандартнаяОбработка, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.УчастникиДействияВыбор(Форма, ВыбраннаяСтрока, Поле, СтандартнаяОбработка, ); +``` +
+ +## УчастникиДействияПередНачаломДобавления +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПередНачаломДобавления таблицы Участники. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// Отказ - Булево - отказ из обработчика события формы. +// Копирование - Булево - определяет режим копирования. +// ПараметрыДобавленияУчастников - см. ИнтеграцияС1СДокументооборот3Клиент.ПараметрыДобавленияУчастниковДействия +// +Процедура УчастникиДействияПередНачаломДобавления(Форма, Отказ, Копирование, ПараметрыДобавленияУчастников) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.УчастникиДействияПередНачаломДобавления(Форма, Отказ, Копирование, ПараметрыДобавленияУчастников) +``` +
+ +## УчастникиДействияПередНачаломИзменения +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПередНачаломИзменения таблицы Участники. +// Проверяет защищенность строки, не дает изменять исполнителя, если он защищен. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// Отказ - Булево - отказ из обработчика события формы. +// СЭтапами - Булево - у действия есть этапы. +// +Процедура УчастникиДействияПередНачаломИзменения(Форма, Отказ, СЭтапами = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.УчастникиДействияПередНачаломИзменения(Форма, Отказ, СЭтапами); +``` +
+ +## УчастникиДействияПередУдалением +
+ +Описание, пример вызова + +```bsl + +// Обработчик события ПередУдалением таблицы Участники. +// Проверяет защищенность строки, не дает удалить исполнителя, если он защищен или выполнил задачу. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// Отказ - Булево - отказ из обработчика события формы. +// СЭтапами - Булево - у действия есть этапы. +// МожноУдалятьЭтапы - Булево - этап можно удалить, если в действии есть больше одного этапа с одинаковой функцией. +// ПоПунктам - Булево - действие исполняется по пунктам. +// +Процедура УчастникиДействияПередУдалением(Форма, Отказ, СЭтапами = Ложь, МожноУдалятьЭтапы = Ложь, ПоПунктам = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.УчастникиДействияПередУдалением(Форма, Отказ, СЭтапами, МожноУдалятьЭтапы, ПоПунктам); +``` +
+ +## УчастникиДействияПриАктивизацииСтроки +
+ +Описание, пример вызова + +```bsl + +// Обработчик активизации строки в таблице участников действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +Процедура УчастникиДействияПриАктивизацииСтроки(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3Клиент.УчастникиДействияПриАктивизацииСтроки(Форма) +``` +
+ +## ЭтапыДействияУникальны +
+ +Описание, пример вызова + +```bsl + +// Проверяет уникальность этапов действия. +// +// Параметры: +// Участники - ДанныеФормыДерево - дерево с участниками действия. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтапыДействияУникальны(Участники) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Клиент.ЭтапыДействияУникальны(Участники) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборот3КлиентСервер.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборот3КлиентСервер.md new file mode 100644 index 0000000..6ee1936 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборот3КлиентСервер.md @@ -0,0 +1,755 @@ +--- +title: Интеграция с 1С документооборот3 клиент сервер +slug: zup/интеграция-с-1с-документооборот3-клиент-сервер +--- + + +## ВариантыУстановкиСрокаИсполнения +
+ +Описание, пример вызова + +```bsl + +// Возвращает варианты установки срока исполнения. +// +// Возвращаемое значение: +// Структура: +// * ТочныйСрок - Строка +// * ОтносительныйСрок - Строка +// +Функция ВариантыУстановкиСрокаИсполнения() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ВариантыУстановкиСрокаИсполнения() +``` +
+ +## ДанныеОбработки +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей данные обработки. +// +// Параметры: +// ПредметID - Строка - идентификатор предмета обработки. +// ПредметТип - Строка - XDTO-тип предмета обработки. +// ТекущееСостояние - Строка - текущее состояние обработки. Перечисление типа DMObjectProcessingState. +// ПричинаПрерывания - Строка - причина прерывания обработки. +// +// Возвращаемое значение: +// Структура: +// * ПредметID - Строка +// * ПредметТип - Строка +// * ТекущееСостояние - Строка +// * ПричинаПрерывания - Строка +// * ТребуемоеИнтерактивноеДействие - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ТребуемоеИнтерактивноеДействие +// +Функция ДанныеОбработки(ПредметID, ПредметТип, ТекущееСостояние = "", ПричинаПрерывания = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеОбработки(ПредметID, ПредметТип, ТекущееСостояние, ПричинаПрерывания); +``` +
+ +## ДанныеПоЗадаче +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей задачу. +// +// Параметры: +// ID - Строка - идентификатор задачи Документооборота. +// Тип - Строка - XDTO-тип задачи Документооборота. +// Заголовок - Строка - заголовок задачи. +// НавигационнаяСсылка - Строка - навигационная ссылка на объект ДО. +// +// Возвращаемое значение: +// Структура: +// * ДействиеЗадачи - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// * Новое - Булево +// * Просрочено - Булево +// * ПредставлениеHTML - Строка +// * АдресДополнительныхДанных - Строка +// * Флаг - Строка +// * РезультатДействия - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// * РезультатДействияТекстом - Строка +// * ВерсияДанныхДействияЗадачи - Строка +// * ТребуемоеИнтерактивноеДействие - см. ИнтеграцияС1СДокументооборот3КлиентСервер.ТребуемоеИнтерактивноеДействие +// +Функция ДанныеПоЗадаче(ID, Тип, Заголовок = "", НавигационнаяСсылка = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ДанныеПоЗадаче(ID, Тип, Заголовок, НавигационнаяСсылка); +``` +
+ +## ИдентификаторЗаполнен +
+ +Описание, пример вызова + +```bsl + +// Определяет является ли идентификатор пустым или заполненным. +// +// Параметры: +// СтрокаИдентификатора - Строка - строковое представление идентификатора. +// +// Возвращаемое значение: +// Булево +// +Функция ИдентификаторЗаполнен(СтрокаИдентификатора) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ИдентификаторЗаполнен(СтрокаИдентификатора) +``` +
+ +## КолонкиБыстрогоПоиска +
+ +Описание, пример вызова + +```bsl + +// Список колонок таблицы "Быстрый поиск", подлежащие заполнению. +// +// Возвращаемое значение: +// Строка +// +Функция КолонкиБыстрогоПоиска() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.КолонкиБыстрогоПоиска() +``` +
+ +## ОбновитьКнопкиДинамическогоСписка +
+ +Описание, пример вызова + +```bsl + +// Перерисовывает на форме список кнопок переключения страниц динамического списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, на которой находится динамический список. +// ТекущаяСтраница - Число - номер текущей страницы. +// ВсегоСтраниц - Число - максимальное количество страниц. +// +Процедура ОбновитьКнопкиДинамическогоСписка(Форма, ТекущаяСтраница, ВсегоСтраниц) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3КлиентСервер.ОбновитьКнопкиДинамическогоСписка(Форма, ТекущаяСтраница, ВсегоСтраниц) +``` +
+ +## ПараметрыИзмененияСрокаПоПредставлению +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей параметры изменения срока по представлению. +// +// Возвращаемое значение: +// Структура: +// * ТекстСообщенияПредупреждения - Строка - возвращаемый текст сообщения/предупреждения в случае ошибки. +// * Исполнитель - Строка +// * ИсполнительID - Строка +// * ИсполнительТип - Строка +// * ОсновнойОбъектАдресацииИсполнитель - Строка +// * ОсновнойОбъектАдресацииИсполнительID - Строка +// * ОсновнойОбъектАдресацииИсполнительТип - Строка +// * ДополнительныйОбъектАдресацииИсполнитель - Строка +// * ДополнительныйОбъектАдресацииИсполнительID - Строка +// * ДополнительныйОбъектАдресацииИсполнительТип - Строка +// +Функция ПараметрыИзмененияСрокаПоПредставлению() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ПараметрыИзмененияСрокаПоПредставлению() +``` +
+ +## ПараметрыФормыСпискаЗадач +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей параметры формы списка задач. +// +// Возвращаемое значение: +// Структура: +// * ТекущаяСтраница - Число +// * РазмерСтраницыДинамическогоСписка - Число +// * ПолеДляСортировки - Строка +// * НаправлениеСортировкиПоля - Строка +// * Фильтры - СписокЗначений +// * БыстрыйПоиск - ТаблицаЗначений +// * ОтображениеКарточкиЗадачи - ПеречислениеСсылка.ВариантыОтображенияОбластиЧтения +// +Функция ПараметрыФормыСпискаЗадач() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ПараметрыФормыСпискаЗадач() +``` +
+ +## ПредставлениеСрокаИсполнения +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление срока исполнения в виде дата (длительность) или длительность (дата). +// +// Параметры: +// Дата - Дата - срок исполнения датой. +// Дни - Число - длительность, дней. +// Часы - Число - длительность, часов. +// Минуты - Число - длительность, минут. +// ИспользоватьДатуИВремяВСроках - Булево - признак использования даты и времени в сроках. +// ВариантУстановкиСрока - Строка - вариант установки срока исполнения. +// +// Возвращаемое значение: +// Строка +// +Функция ПредставлениеСрокаИсполнения(Дата, Дни, Часы, Минуты, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ПредставлениеСрокаИсполнения(Дата, Дни, Часы, Минуты, ); +``` +
+ +## ПредставлениеТипаОбъектаXDTO +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление типа объекта XDTO Документооборота по имени типа. +// +// Параметры: +// ТипXDTO - Строка - имя типа объекта XDTO. +// Режим - Строка - принимает значения: "ЕдинственноеЧисло", "МножественноеЧисло", "ЗаголовокФормыВыбора". +// +// Возвращаемое значение: +// Строка - представление типа объекта XDTO Документооборота по имени типа. +// +Функция ПредставлениеТипаОбъектаXDTO(ТипXDTO, Режим = "МножественноеЧисло") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ПредставлениеТипаОбъектаXDTO(ТипXDTO, Режим); +``` +
+ +## ПредставлениеПорядкаВыполненияЭтапаДействия +
+ +Описание, пример вызова + +```bsl + +// Формирует представление порядка выполнения этапа действия. +// +// Параметры: +// ПорядокXDTO - Строка - перечисление типа DMOrderOfExecutionActionStage. +// +// Возвращаемое значение: +// Строка +// +Функция ПредставлениеПорядкаВыполненияЭтапаДействия(ПорядокXDTO) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ПредставлениеПорядкаВыполненияЭтапаДействия(ПорядокXDTO) +``` +
+ +## ПредставлениеУчастника +
+ +Описание, пример вызова + +```bsl + +// Формирует представление участника действия. +// +// Параметры: +// СтрокаУчастника - ДанныеФормыЭлементДерева - строка дерева значений Участники в форме действия. +// ДополнительноеОписание - Строка - дополнительное описание участника. +// ПрефиксСтроки - Строка - префикс строки участника. +// +// Возвращаемое значение: +// Строка - представление участника действия. +// +Функция ПредставлениеУчастника(СтрокаУчастника, ДополнительноеОписание = "", ПрефиксСтроки = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ПредставлениеУчастника(СтрокаУчастника, ДополнительноеОписание, ПрефиксСтроки); +``` +
+ +## ТипОперацииСОбработкой +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей тип операции над задачей. +// +// Возвращаемое значение: +// Структура: +// * Начать - Булево +// * Прервать - Булево +// * Остановить - Булево +// * Продолжить - Булево +// * Заполнить - Булево +// * Перезапустить - Булево +// +Функция ТипОперацииСОбработкой() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ТипОперацииСОбработкой() +``` +
+ +## ТребуемоеИнтерактивноеДействие +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей требуемое интерактивное действие. +// +// Возвращаемое значение: +// Структура: +// * ВыбратьИсполнителяЗадачи - Булево +// * ИзменитьПараметрыПроцесса - Булево +// * Контекст - Произвольный +// * КешПредыдущихРезультатов - Строка +// +Функция ТребуемоеИнтерактивноеДействие() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ТребуемоеИнтерактивноеДействие() +``` +
+ +## ЕстьЗащищенныеУчастникиДействия +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие хотя бы одного защищенного участника в переданном этапе действия. +// +// Параметры: +// Этап - ДанныеФормыЭлементДерева - строка этапа из дерева участников обработки. +// +// Возвращаемое значение: +// Булево - есть защищенные участники. +// +Функция ЕстьЗащищенныеУчастникиДействия(Этап) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ЕстьЗащищенныеУчастникиДействия(Этап) +``` +
+ +## ЕстьЭтапыДействия +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие этапов действия. +// +// Параметры: +// Участники - ДанныеФормыДерево - дерево с участниками. +// ИдентификаторЭтапа - Строка - предопределенный идентификатор участника действия, который мы не учитываем. +// ИдентификаторОбрабатывающегоРезультат - Строка - предопределенный идентификатор обрабатывающего результат действия, +// который мы не учитываем. +// +// Возвращаемое значение: +// Булево - есть защищенные участники. +// +Функция ЕстьЭтапыДействия(Участники, ИдентификаторЭтапа, ИдентификаторОбрабатывающегоРезультат) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ЕстьЭтапыДействия(Участники, ИдентификаторЭтапа, ИдентификаторОбрабатывающегоРезультат) +``` +
+ +## ИменаПолейТаблицыУчастниковДействия +
+ +Описание, пример вызова + +```bsl + +// Возвращает имена полей таблицы участников действия на форме. +// +// Возвращаемое значение: +// Строка +// +Функция ИменаПолейТаблицыУчастниковДействия() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ИменаПолейТаблицыУчастниковДействия() +``` +
+ +## НастроитьОтображениеОтложенногоНачалаВыполненияДействия +
+ +Описание, пример вызова + +```bsl + +// Устанавливает описание, подсказку и отображение задержки начала выполнения действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// ПредставлениеЗапуска - Строка - описание задержки запуска. +// ОчиститьЗадержкуПодсказка - Строка - неявно возвращаемое значение, подсказка команды формы ОчиститьЗадержку. +// ОписаниеОтложенногоНачалаВыполненияПодсказка - Строка - неявно возвращаемое значение, подсказка элемента +// формы ОписаниеОтложенногоНачалаВыполнения. +// +Процедура НастроитьОтображениеОтложенногоНачалаВыполненияДействия(Форма, ПредставлениеЗапуска = "", Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборот3КлиентСервер.НастроитьОтображениеОтложенногоНачалаВыполненияДействия(Форма, ПредставлениеЗапуска, ); +``` +
+ +## НомерКартинкиРезультатаВыполненияДействия +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер картинки из КоллекцияРезультатыВыполненияДействий. +// +// Параметры: +// Результат - Строка - результат действия. +// Состояние - Строка - состояние действия. +// ЕстьЗаявкаОтказа - Булево +// +// Возвращаемое значение: +// Число +// +Функция НомерКартинкиРезультатаВыполненияДействия(Результат, Состояние = Неопределено, ЕстьЗаявкаОтказа = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.НомерКартинкиРезультатаВыполненияДействия(Результат, Состояние, ЕстьЗаявкаОтказа); +``` +
+ +## ОбщийРезультатДействия +
+ +Описание, пример вызова + +```bsl + +// Возвращает общий результат двух результатов участников действия. +// +// +// Параметры: +// Результат1 - Строка - результат действия. +// Результат2 - Строка - результат действия. +// +// Возвращаемое значение: +// Строка +// +Функция ОбщийРезультатДействия(Результат1, Результат2) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ОбщийРезультатДействия(Результат1, Результат2) +``` +
+ +## ОбщееСостояниеДействия +
+ +Описание, пример вызова + +```bsl + +// Возвращает общее состояние двух участников действия. +// +// Параметры: +// Состояние1 - Строка - состояние действия. +// Состояние2 - Строка - состояние действия. +// +// Возвращаемое значение: +// Строка +// +Функция ОбщееСостояниеДействия(Состояние1, Состояние2) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ОбщееСостояниеДействия(Состояние1, Состояние2) +``` +
+ +## УчастникиДействияИзмененыВКарточке +
+ +Описание, пример вызова + +```bsl + +// Проверяет факт изменения участников в карточке действия. +// Работает в паре с процедурой ИнтеграцияС1СДокументооборот3.ЗаполнитьТаблицуУчастниковДействия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма элемента одного из справочников действий, участвующих в обработке. +// +// Возвращаемое значение: +// Булево +// +Функция УчастникиДействияИзмененыВКарточке(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.УчастникиДействияИзмененыВКарточке(Форма) +``` +
+ +## ЭтоДействиеИсполнения +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если указанное действие является действием исполнения. +// +// Параметры: +// ТипДействия - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоДействиеИсполнения(ТипДействия) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ЭтоДействиеИсполнения(ТипДействия) +``` +
+ +## ЭтоДействиеСогласования +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если указанное действие является действием согласования. +// +// Параметры: +// ТипДействия - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоДействиеСогласования(ТипДействия) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ЭтоДействиеСогласования(ТипДействия) +``` +
+ +## ЭтоДействиеОзнакомления +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если указанное действие является действием ознакомления. +// +// Параметры: +// ТипДействия - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоДействиеОзнакомления(ТипДействия) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ЭтоДействиеОзнакомления(ТипДействия) +``` +
+ +## ЭтоДействиеПодписания +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если указанное действие является действием подписания. +// +// Параметры: +// ТипДействия - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоДействиеПодписания(ТипДействия) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ЭтоДействиеПодписания(ТипДействия) +``` +
+ +## ЭтоДействиеРегистрации +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если указанное действие является действием регистрации. +// +// Параметры: +// ТипДействия - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоДействиеРегистрации(ТипДействия) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ЭтоДействиеРегистрации(ТипДействия) +``` +
+ +## ЭтоДействиеУтверждения +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если указанное действие является действием утверждения. +// +// Параметры: +// ТипДействия - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоДействиеУтверждения(ТипДействия) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ЭтоДействиеУтверждения(ТипДействия) +``` +
+ +## ЭтоФункцияОбработатьРезультат +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если параметр является функцией участника, обрабатывающего результат. +// +// Параметры: +// ФункцияУчастника - Строка - функция участника действия. +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоФункцияОбработатьРезультат(ФункцияУчастника) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3КлиентСервер.ЭтоФункцияОбработатьРезультат(ФункцияУчастника) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборот3Обмен.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборот3Обмен.md new file mode 100644 index 0000000..4eb782c --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборот3Обмен.md @@ -0,0 +1,99 @@ +--- +title: Интеграция с 1С документооборот3 обмен +slug: zup/интеграция-с-1с-документооборот3-обмен +--- + + +## ЗаписатьИзмененияОбъектов +
+ +Описание, пример вызова + +```bsl + +// Помещает изменения в базу и возвращает ответ на запрос DMILPutChangesRequest. +// +// Параметры: +// Сообщение - ОбъектXDTO - объект XDTO типа DMILPutChangesRequest: +// * messageData - ДвоичныеДанные +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMILPutChangesResponse или DMILError. +// +Функция ЗаписатьИзмененияОбъектов(Сообщение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Обмен.ЗаписатьИзмененияОбъектов(Сообщение) +``` +
+ +## ЗарегистрированныеДанные +
+ +Описание, пример вызова + +```bsl + +// Возвращает измененные объекты, интегрированные с 1С:Документооборотом, и готовые к выгрузке. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// УзелОбмена - ПланОбменаСсылка.ИнтеграцияС1СДокументооборотомПереопределяемый - узел, по которому нужно +// получить изменения. +// ОбъектыКУдалениюИзРегистрацииИзменений - Массив из ЛюбаяСсылка - неявно возвращаемое значение, +// содержит ссылки на объекты, не требующие выгрузки, и на успешно отправленные объекты. +// +// Возвращаемое значение: +// Массив из Структура: +// * Объект - ЛюбаяСсылка +// * ТипОбъектаДО - Строка +// * ИдентификаторОбъектаДО - Строка +// * СписокВыражений - СписокXDTO +// * ПечатныеФормы - СписокXDTO +// * ТипыФайловПечатныхФорм - СписокXDTO +// * ПравилоЗагрузкиВДО - ОбъектXDTO +// +Функция ЗарегистрированныеДанные(Прокси, УзелОбмена, ОбъектыКУдалениюИзРегистрацииИзменений) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Обмен.ЗарегистрированныеДанные(Прокси, УзелОбмена, ОбъектыКУдалениюИзРегистрацииИзменений) +``` +
+ +## ПолучитьXDTOИзмененийИзОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает объект XDTO, содержащий обновляемые изменения объекта. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеОбъекта - См. ИнтеграцияС1СДокументооборот3Обмен.ЗарегистрированныеДанные +// КонтрольОтправкиФайлов - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.КонтрольОтправкиФайлов +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция ПолучитьXDTOИзмененийИзОбъекта(Прокси, ДанныеОбъекта, КонтрольОтправкиФайлов) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборот3Обмен.ПолучитьXDTOИзмененийИзОбъекта(Прокси, ДанныеОбъекта, КонтрольОтправкиФайлов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборотБЗК.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБЗК.md new file mode 100644 index 0000000..0026277 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБЗК.md @@ -0,0 +1,157 @@ +--- +title: Интеграция с 1С документооборот БЗК +slug: zup/интеграция-с-1с-документооборот-бзк +--- + + +## ЗаполнитьИнформациюОПользователе +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьИнформациюОПользователе(Прокси, ОбъектXDTO, СсылкаНаПотребитель) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБЗК.ЗаполнитьИнформациюОПользователе(Прокси, ОбъектXDTO, СсылкаНаПотребитель) +``` +
+ +## ЗаполнитьРуководителяПодразделения +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьРуководителяПодразделения(Прокси, ОбъектXDTO, Подразделение) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБЗК.ЗаполнитьРуководителяПодразделения(Прокси, ОбъектXDTO, Подразделение) +``` +
+ +## ЗаполнитьФизическоеЛицо +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьФизическоеЛицо(ФизическоеЛицо, Прокси, ОбъектXDTO) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБЗК.ЗаполнитьФизическоеЛицо(ФизическоеЛицо, Прокси, ОбъектXDTO) +``` +
+ +## ЗаполнитьПодразделение +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьПодразделение(Подразделение, Прокси, ОбъектXDTO, ЗаполнятьПодразделение, ЗаполнятьРуководителя) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБЗК.ЗаполнитьПодразделение(Подразделение, Прокси, ОбъектXDTO, ЗаполнятьПодразделение, ЗаполнятьРуководителя) +``` +
+ +## ЗаполнитьПользователя +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьПользователя(Пользователь, Прокси, ОбъектXDTO) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБЗК.ЗаполнитьПользователя(Пользователь, Прокси, ОбъектXDTO) +``` +
+ +## ЗаполнитьДолжность +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьДолжность(Должность, Прокси, ОбъектXDTO) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБЗК.ЗаполнитьДолжность(Должность, Прокси, ОбъектXDTO) +``` +
+ +## ПриСозданииЮрЛицаПоСсылке +
+ +Описание, пример вызова + +```bsl + +Процедура ПриСозданииЮрЛицаПоСсылке(ОбъектИС, ОбъектXDTO, ЗаполняемыйОбъектИС, ИсточникXDTO = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБЗК.ПриСозданииЮрЛицаПоСсылке(ОбъектИС, ОбъектXDTO, ЗаполняемыйОбъектИС, ИсточникXDTO); +``` +
+ +## СостояниеСогласованияДО +
+ +Описание, пример вызова + +```bsl + +Функция СостояниеСогласованияДО(ЗначениеЗаполнения) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБЗК.СостояниеСогласованияДО(ЗначениеЗаполнения) +``` +
+ +## СостояниеСогласованияБЗК +
+ +Описание, пример вызова + +```bsl + +Функция СостояниеСогласованияБЗК(ТипРеквизита, СостояниеДО) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБЗК.СостояниеСогласованияБЗК(ТипРеквизита, СостояниеДО) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональность.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональность.md new file mode 100644 index 0000000..d92e4f6 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональность.md @@ -0,0 +1,3419 @@ +--- +title: Интеграция с 1С документооборот базовая функциональность +slug: zup/интеграция-с-1с-документооборот-базовая-функциональность +--- + + +## ВыполнитьЗапросАсинхронно +
+ +Описание, пример вызова + +```bsl + +// Выполняет запрос к сервису 1С:Документооборот в фоновом задании. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Запрос - ОбъектXDTO - выполняемый запрос. +// УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор формы, из которой выполняется запрос. +// НаименованиеФоновогоЗадания - Строка - представление длительной операции, которое будет выведено в интерфейс. +// +// Возвращаемое значение: +// см. ДлительныеОперации.ВыполнитьВФоне +// +Функция ВыполнитьЗапросАсинхронно(Прокси, Запрос, УникальныйИдентификатор, НаименованиеФоновогоЗадания = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьЗапросАсинхронно(Прокси, Запрос, УникальныйИдентификатор, НаименованиеФоновогоЗадания); +``` +
+ +## ВыполнитьЗапросВФоне +
+ +Описание, пример вызова + +```bsl + +// Выполняет запрос к сервису 1С:Документооборот из фонового задания. +// +// Параметры: +// Параметры - Структура: +// * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения +// * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка +// * ИнтеграцияС1СДокументооборотИмяПользователя - Строка +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево +// * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка +// * ИнтеграцияС1СДокументооборотПароль - Строка +// * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево +// * ЗапросСтрока - Строка +// АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса. +// +Процедура ВыполнитьЗапросВФоне(Параметры, АдресХранилища) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьЗапросВФоне(Параметры, АдресХранилища) +``` +
+ +## ВыполнитьПакетныйЗапросАсинхронно +
+ +Описание, пример вызова + +```bsl + +// Выполняет пакетный запрос к сервису 1С:Документооборот в фоновом задании. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Запросы - Массив из ОбъектXDTO - запросы пакета. +// УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор формы, из которой выполняется запрос. +// НаименованиеФоновогоЗадания - Строка - представление длительной операции, которое будет выведено в интерфейс. +// ПроверятьПодчиненные - Булево - указывает требуется ли проверять результаты запросов, входящих в пакет. +// +// Возвращаемое значение: +// см. ДлительныеОперации.ВыполнитьВФоне +// +Функция ВыполнитьПакетныйЗапросАсинхронно(Прокси, Запросы, УникальныйИдентификатор, НаименованиеФоновогоЗадания = "", Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьПакетныйЗапросАсинхронно(Прокси, Запросы, УникальныйИдентификатор, НаименованиеФоновогоЗадания, ); +``` +
+ +## ВыполнитьПакетныйЗапросВФоне +
+ +Описание, пример вызова + +```bsl + +// Выполняет запрос к сервису 1С:Документооборот из фонового задания. +// +// Параметры: +// Параметры - Структура: +// * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения +// * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка +// * ИнтеграцияС1СДокументооборотИмяПользователя - Строка +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево +// * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка +// * ИнтеграцияС1СДокументооборотПароль - Строка +// * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево +// * ЗапросыСтрока - Массив из Строка +// * ПроверятьПодчиненные - Булево +// АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса. +// +Процедура ВыполнитьПакетныйЗапросВФоне(Параметры, АдресХранилища) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьПакетныйЗапросВФоне(Параметры, АдресХранилища) +``` +
+ +## ЗаписатьОбъектВФоне +
+ +Описание, пример вызова + +```bsl + +// Записывает изменения объекта в Документообороте в фоновом задании. +// +// Параметры: +// Параметры - Структура: +// * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения +// * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка +// * ИнтеграцияС1СДокументооборотИмяПользователя - Строка +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево +// * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка +// * ИнтеграцияС1СДокументооборотПароль - Строка +// * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево +// * ОбъектСтрока - Строка - строковое предствление объекта XDTO с сохраняемыми данными. +// АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса. +// +Процедура ЗаписатьОбъектВФоне(Параметры, АдресХранилища) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьОбъектВФоне(Параметры, АдресХранилища) +``` +
+ +## ОбъектXDTOВСтроку +
+ +Описание, пример вызова + +```bsl + +// Преобразует объект XDTO из пространства имен "HTTP://www.1c.ru/dm" в строку. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ОбъектXDTO - ОбъектXDTO - объект XDTO xml представление которого требуется получить. +// +// Возвращаемое значение: +// Строка +// +Функция ОбъектXDTOВСтроку(Прокси, ОбъектXDTO) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ОбъектXDTOВСтроку(Прокси, ОбъектXDTO) +``` +
+ +## ПараметрыДлительнойОперации +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров для обращения к сервису 1С:Документооборот в фоновом задании. +// +// Параметры: +// ИспользоватьКэш - Булево - при проверке возможности авторизации без пароля не требуется использовать кэш. +// +// Возвращаемое значение: +// Структура: +// * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения +// * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка +// * ИнтеграцияС1СДокументооборотИмяПользователя - Строка +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево +// * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка +// * ИнтеграцияС1СДокументооборотПароль - Строка +// * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево +// +Функция ПараметрыДлительнойОперации(ИспользоватьКэш = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПараметрыДлительнойОперации(ИспользоватьКэш); +``` +
+ +## ПодключитьсяИПолучитьВерсиюСервисаВФоне +
+ +Описание, пример вызова + +```bsl + +// Выполняет подключение к сервису 1С:Документооборот из фонового задания, и делает запрос версии сервиса. +// +// Параметры: +// Параметры - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПараметрыДлительнойОперации +// АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса. +// +Процедура ПодключитьсяИПолучитьВерсиюСервисаВФоне(Параметры, АдресХранилища = "") Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПодключитьсяИПолучитьВерсиюСервисаВФоне(Параметры, АдресХранилища); +``` +
+ +## ПолучитьОбъектВФоне +
+ +Описание, пример вызова + +```bsl + +// Получает объект из Документооборота в фоновом задании. +// +// Параметры: +// Параметры - Структура: +// * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения +// * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка +// * ИнтеграцияС1СДокументооборотИмяПользователя - Строка +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево +// * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка +// * ИнтеграцияС1СДокументооборотПароль - Строка +// * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево +// * Тип - Строка +// * ID - Строка +// * Колонки - Массив из Строка - необязательно, состав заполняемых колонок. +// - Строка - если список колонок разделен через запятую. +// * ПравилоИнтеграции - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - правило интеграции для +// заполнения объекта ИС. +// * ВнешнийОбъектИС - ЛюбаяСсылка - передается для заполнения свойства externalObject. +// АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса. +// +Процедура ПолучитьОбъектВФоне(Параметры, АдресХранилища) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьОбъектВФоне(Параметры, АдресХранилища) +``` +
+ +## ПолучитьПроксиВФоне +
+ +Описание, пример вызова + +```bsl + +// Создает прокси веб-сервиса Документооборота в фоновом задании, с настройками, переданными напрямую. +// +// Параметры: +// Параметры - Структура: +// * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения +// * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка +// * ИнтеграцияС1СДокументооборотИмяПользователя - Строка +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево +// * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево +// * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка +// * ИнтеграцияС1СДокументооборотПароль - Строка +// * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево +// +// Возвращаемое значение: +// WSПрокси - прокси веб-сервиса Документооборота. +// Неопределено - в случае, если прокси веб-сервиса получить не удалось. +// +Функция ПолучитьПроксиВФоне(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьПроксиВФоне(Параметры) +``` +
+ +## СтрокаВОбъектXDTO +
+ +Описание, пример вызова + +```bsl + +// Преобразует строку в объект XDTO из пространства имен "HTTP://www.1c.ru/dm". +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Строка - Строка - xml представление объекта XDTO. +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция СтрокаВОбъектXDTO(Прокси, Строка) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СтрокаВОбъектXDTO(Прокси, Строка) +``` +
+ +## ВыполнитьОбменДанными +
+ +Описание, пример вызова + +```bsl + +// Выполняет обмен данными с 1С:Документооборотом по правилам интеграции. +// +Процедура ВыполнитьОбменДанными() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьОбменДанными() +``` +
+ +## АдресВебСервиса1СДокументооборот +
+ +Описание, пример вызова + +```bsl + +// Получает адрес публикации веб-сервиса Документооборот. +// +// Возвращаемое значение: +// Строка - адрес сервиса. +// +Функция АдресВебСервиса1СДокументооборот() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.АдресВебСервиса1СДокументооборот() +``` +
+ +## ВерсияСервиса +
+ +Описание, пример вызова + +```bsl + +// Получает версию сервиса из параметров сеанса. +// +// Возвращаемое значение: +// Строка - версия сервиса. +// +Функция ВерсияСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВерсияСервиса() +``` +
+ +## ВыполнитьЗапрос +
+ +Описание, пример вызова + +```bsl + +// Выполняет запрос к сервису, превращая сообщения об ошибках в вид, понятный пользователю. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Запрос - ОбъектXDTO - выполняемый запрос. +// +// Возвращаемое значение: +// ОбъектXDTO - результат выполнения запроса. +// +Функция ВыполнитьЗапрос(Прокси, Запрос) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьЗапрос(Прокси, Запрос) +``` +
+ +## ВыполнитьПакетныйЗапрос +
+ +Описание, пример вызова + +```bsl + +// Выполняет пакет запросов к сервису Документооборота. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Запросы - Массив из ОбъектXDTO - запросы пакета. +// ПроверятьПодчиненные - Булево - указывает требуется ли проверять результаты запросов, входящих в пакет. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMBatchResponse. +// +Функция ВыполнитьПакетныйЗапрос(Прокси, Запросы, ПроверятьПодчиненные = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьПакетныйЗапрос(Прокси, Запросы, ПроверятьПодчиненные); +``` +
+ +## ДобавитьСтрокуИнвертируемыхКонстант +
+ +Описание, пример вызова + +```bsl + +// Добавляет строку инвертируемых констант в таблицу зависимости констант. +// +// Параметры: +// ТаблицаКонстант - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗависимостиКонстант +// ИмяРодительскойКонстанты - Строка - имя родительской константы как оно задано в конфигураторе. +// ИмяПодчиненнойКонстанты - Строка - имя подчиненной константы как оно задано в конфигураторе. +// +Процедура ДобавитьСтрокуИнвертируемыхКонстант(ТаблицаКонстант, ИмяРодительскойКонстанты, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуИнвертируемыхКонстант(ТаблицаКонстант, ИмяРодительскойКонстанты, ); +``` +
+ +## ДобавитьСтрокуСоответствияТипов +
+ +Описание, пример вызова + +```bsl + +// Добавляет строку в таблицу соответствия типов. +// +// Параметры: +// Таблица - ТаблицаЗначений - таблица соответствия типов. +// ИмяТипаXDTO - Строка - имя типа XDTO +// ТипОбъектаИС - Тип - тип объекта ИС. +// +Процедура ДобавитьСтрокуСоответствияТипов(Таблица, ИмяТипаXDTO, ТипОбъектаИС) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов(Таблица, ИмяТипаXDTO, ТипОбъектаИС) +``` +
+ +## ДобавитьСтрокуТаблицыЗависимостиКонстант +
+ +Описание, пример вызова + +```bsl + +// Добавляет строку в таблицу зависимости констант. +// +// Параметры: +// ТаблицаКонстант - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗависимостиКонстант +// ИмяРодительскойКонстанты - Строка - имя родительской константы как оно задано в конфигураторе +// ЗначениеРодительскойКонстанты - Произвольный - значение родительской константы +// ИмяПодчиненнойКонстанты - Строка - имя подчиненной константы как оно задано в конфигураторе +// ЗначениеПодчиненнойКонстанты - Произвольный - значение подчиненной константы +// +Процедура ДобавитьСтрокуТаблицыЗависимостиКонстант(ТаблицаКонстант, ИмяРодительскойКонстанты, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуТаблицыЗависимостиКонстант(ТаблицаКонстант, ИмяРодительскойКонстанты, ); +``` +
+ +## ДопРеквизитПоИмени +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на дополнительный реквизит по уникальному имени. +// +// Параметры: +// ИмяДопРеквизита - Строка - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИмяДопРеквизита +// +// Возвращаемое значение: +// ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения +// +Функция ДопРеквизитПоИмени(ИмяДопРеквизита) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДопРеквизитПоИмени(ИмяДопРеквизита) +``` +
+ +## ДоступенФункционалВерсииСервиса +
+ +Описание, пример вызова + +```bsl + +// Получает доступность функционала версии web-сервиса Документооборота. +// +// Параметры: +// ВерсияСервиса - Строка - версия web-сервиса Документооборота, содержащая требуемый функционал. +// Оптимистично - Булево - признак необходимости вернуть Истина, если версия сервиса пока неизвестна. +// +// Возвращаемое значение: +// Булево - Истина, если web-сервис Документооборота указанной версии доступен. +// +Функция ДоступенФункционалВерсииСервиса(ВерсияСервиса = "", Оптимистично = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДоступенФункционалВерсииСервиса(ВерсияСервиса, Оптимистично); +``` +
+ +## ЕстьПодсистемаДО2 +
+ +Описание, пример вызова + +```bsl + +// Определяет, встроены ли в конфигурации модули БИД, предназначенные для интеграции с 1С:Документооборотом редакции 2. +// +// Возвращаемое значение: +// Булево +// +Функция ЕстьПодсистемаДО2() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЕстьПодсистемаДО2() +``` +
+ +## ЕстьПодсистемаДО3 +
+ +Описание, пример вызова + +```bsl + +// Определяет, встроены ли в конфигурации модули БИД, предназначенные для интеграции с 1С:Документооборотом редакции 3. +// +// Возвращаемое значение: +// Булево +// +Функция ЕстьПодсистемаДО3() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЕстьПодсистемаДО3() +``` +
+ +## ЕстьУникальныйИдентификатор +
+ +Описание, пример вызова + +```bsl + +// Проверяет значение на объектный тип, содержащий уникальный идентификатор. +// +// Параметры: +// Значение - Произвольный - проверяемое значение. +// +// Возвращаемое значение: +// Булево - Признак наличия у объекта уникального идентификатора. +// +Функция ЕстьУникальныйИдентификатор(Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЕстьУникальныйИдентификатор(Значение) +``` +
+ +## ЗависимостиКонстант +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу, описывающую зависимость констант в конфигурации. +// Каждая строка таблицы означает: +// для родительской константы со значением Х допустимо только значение Y для подчиненной константы. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ИмяРодительскойКонстанты - Строка +// * ИмяПодчиненнойКонстанты - Строка +// * ЗначениеРодительскойКонстанты - Произвольный +// * ЗначениеПодчиненнойКонстанты - Произвольный +// +Функция ЗависимостиКонстант() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗависимостиКонстант() +``` +
+ +## ЗаписатьОбъект +
+ +Описание, пример вызова + +```bsl + +// Записывает изменения объекта в Документообороте. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Объект - ОбъектXDTO - XDTO объект с сохраняемыми данными. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DMUpdateResponse. +// +Функция ЗаписатьОбъект(Прокси, Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьОбъект(Прокси, Объект) +``` +
+ +## ЗаписатьОбъекты +
+ +Описание, пример вызова + +```bsl + +// Записывает изменения объектов в Документообороте. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Объекты - Массив из ОбъектXDTO - массив XDTO объектов с сохраняемыми данными. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DMUpdateResponse. +// +Функция ЗаписатьОбъекты(Прокси, Объекты) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьОбъекты(Прокси, Объекты) +``` +
+ +## ЗаписатьОбъектыЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос для записи изменений объектов в Документообороте. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Объекты - Массив из ОбъектXDTO - массив XDTO объектов с сохраняемыми данными. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DMUpdateRequest. +// +Функция ЗаписатьОбъектыЗапрос(Прокси, Объекты) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьОбъектыЗапрос(Прокси, Объекты) +``` +
+ +## ЗаписатьОшибку +
+ +Описание, пример вызова + +```bsl + +// Записывает ошибку в ЖР. +// +// Параметры: +// ТекстОшибки - Строка - текст ошибки. +// СобытиеВторогоУровня - Строка - имя события, добавляемое через точку к имени события по умолчанию. +// +Процедура ЗаписатьОшибку(ТекстОшибки, СобытиеВторогоУровня = "") Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьОшибку(ТекстОшибки, СобытиеВторогоУровня); +``` +
+ +## ЗаписатьПредупреждение +
+ +Описание, пример вызова + +```bsl + +// Записывает предупреждение в ЖР. +// +// Параметры: +// ТекстПредупреждения - Строка - текст предупреждения. +// СобытиеВторогоУровня - Строка - имя события, добавляемое через точку к имени события по умолчанию. +// +Процедура ЗаписатьПредупреждение(ТекстПредупреждения, СобытиеВторогоУровня = "") Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьПредупреждение(ТекстПредупреждения, СобытиеВторогоУровня); +``` +
+ +## ЗаполнитьЗначенияСвойствXDTO +
+ +Описание, пример вызова + +```bsl + +// Заполняет свойства объекта-приемника по объекту-источнику. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Приемник - ОбъектXDTO - заполняемый объект. +// Источник - ОбъектXDTO - источник данных заполнения. +// +Процедура ЗаполнитьЗначенияСвойствXDTO(Прокси, Приемник, Источник) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьЗначенияСвойствXDTO(Прокси, Приемник, Источник) +``` +
+ +## ЗаполнитьОбъектXDTOИзОбъектногоРеквизита +
+ +Описание, пример вызова + +```bsl + +// Заполняет объект XDTO (приемник) по реквизиту (источник). +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Источник - ФормаКлиентскогоПриложения, Структура - содержит реквизиты или свойства, +// по которым заполняется объект XDTO. +// ИмяРеквизита - Строка - имя объектного реквизита источника. +// Приемник - ОбъектXDTO - содержит заполняемое свойство. +// ТипОбъектаXDTO - Строка - тип XDTO заполняемого свойства. +// ЗаполнятьВсегда - Булево - признак заполнения, даже если объектный реквизит не заполнен. +// +Процедура ЗаполнитьОбъектXDTOИзОбъектногоРеквизита(Прокси, Источник, ИмяРеквизита, Приемник, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьОбъектXDTOИзОбъектногоРеквизита(Прокси, Источник, ИмяРеквизита, Приемник, ); +``` +
+ +## ЗаполнитьОбъектныйРеквизит +
+ +Описание, пример вызова + +```bsl + +// Заполняет объектный реквизит (приемник) по объекту XDTO (источник). +// +// Параметры: +// Приемник - Произвольный - объект, содержащий реквизиты или свойства, +// которые должны быть заполнены по свойству объекта XDTO. +// Источник - ОбъектXDTO, СвойствоXDTO - объект XDTO или его свойство, по которому будет заполнен объектный реквизит. +// ИмяРеквизита - Строка - имя объектного реквизита. +// ЗаполнятьПредставление - Булево - признак необходимости заполнения реквизита представления +// по свойству objectID.presentation. +// +Процедура ЗаполнитьОбъектныйРеквизит(Приемник, Источник, ИмяРеквизита, ЗаполнятьПредставление = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьОбъектныйРеквизит(Приемник, Источник, ИмяРеквизита, ЗаполнятьПредставление); +``` +
+ +## ЗаполнитьПодписиОбъектаXDTO +
+ +Описание, пример вызова + +```bsl + +// Заполняет объект XDTO электронными подписями. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ОбъектXDTO - ОбъектXDTO - объект XDTO со свойством signatures, куда будут добавлены подписи. +// МассивПодписей - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи +// +Процедура ЗаполнитьПодписиОбъектаXDTO(Прокси, ОбъектXDTO, МассивПодписей) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьПодписиОбъектаXDTO(Прокси, ОбъектXDTO, МассивПодписей) +``` +
+ +## ЗаполнитьРеквизитФормыИзXDTO +
+ +Описание, пример вызова + +```bsl + +// Заполняет указанный реквизит формы по свойству объекта XDTO. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, реквизит которой заполняется. +// ИмяРеквизитаФормы - Строка - имя заполняемого реквизита. +// ОбъектXDTO - ОбъектXDTO - источник данных заполнения. +// ИмяСвойстваXDTO - Строка - имя свойства-источника данных. +// +Процедура ЗаполнитьРеквизитФормыИзXDTO(Форма, ИмяРеквизитаФормы, ОбъектXDTO, ИмяСвойстваXDTO) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьРеквизитФормыИзXDTO(Форма, ИмяРеквизитаФормы, ОбъектXDTO, ИмяСвойстваXDTO) +``` +
+ +## ЗаполнитьРеквизитыИзПотребителя +
+ +Описание, пример вызова + +```bsl + +// Заполняет реквизиты объекта XDTO по объекту ИС. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ОбъектXDTO - ОбъектXDTO - заполняемый объект. +// ОбъектИС - ЛюбаяСсылка - источник заполнения. +// +Процедура ЗаполнитьРеквизитыИзПотребителя(Прокси, ОбъектXDTO, ОбъектИС) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьРеквизитыИзПотребителя(Прокси, ОбъектXDTO, ОбъектИС) +``` +
+ +## ЗначениеРеквизитаПоОбъектуXDTO +
+ +Описание, пример вызова + +```bsl + +// Возвращает значение реквизита объекта ИС по значению реквизита объекта ДО. +// +// Параметры: +// ОбъектXDTO - ОбъектXDTO - исходный объект, соответствие которому нужно найти. +// ТипРеквизита - Тип - тип заполняемого реквизита объекта ИС. +// ИмяРеквизита - Строка - имя заполняемого реквизита ИС. +// ТипОбъекта - Тип - тип заполняемого объекта ИС. +// Объект - Произвольный - заполняемый объект ИС. +// ЭтоДополнительноеСвойство - Булево - истина, если переданный объект является доп. свойством. +// Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - свойство-владелец. +// ПараметрыВыбора - Соответствие из КлючИЗначение - параметры выбора: +// * Ключ - Строка - имя параметра вида "Отбор.Владелец". +// * Значение - Произвольный - значение параметра (отбора). +// СоздаватьЕслиНеНайден - Булево - автоматически создавать новый элемент справочника ИС, в случае, +// если не удалось подобрать существующий элемент по значению реквизита объекта ДО. +// +// Возвращаемое значение: +// ЛюбаяСсылка - ссылка на найденный или созданный объект. +// +Функция ЗначениеРеквизитаПоОбъектуXDTO(ОбъектXDTO, ТипРеквизита, ИмяРеквизита = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗначениеРеквизитаПоОбъектуXDTO(ОбъектXDTO, ТипРеквизита, ИмяРеквизита, ); +``` +
+ +## ИмяДопРеквизита +
+ +Описание, пример вызова + +```bsl + +// Возвращает уникальное имя дополнительного реквизита для последующего использования в правилах интеграции. +// +// Параметры: +// ДопРеквизит - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - дополнительный реквизит. +// +// Возвращаемое значение: +// Строка - имя дополнительного реквизита. +// +Функция ИмяДопРеквизита(ДопРеквизит) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИмяДопРеквизита(ДопРеквизит) +``` +
+ +## ИмяСобытияЖурналаРегистрации +
+ +Описание, пример вызова + +```bsl + +// Возвращает локализованное имя события журнала регистрации для интеграции с ДО. +// +// Параметры: +// СобытиеВторогоУровня - Строка - имя события, добавляемое через точку к имени события по умолчанию. +// +// Возвращаемое значение: +// Строка - Интеграция с 1С:Документооборотом +// или Интеграция с 1С:Документооборотом.<ИмяСобытияВторогоУровня>. +// +Функция ИмяСобытияЖурналаРегистрации(СобытиеВторогоУровня = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИмяСобытияЖурналаРегистрации(СобытиеВторогоУровня); +``` +
+ +## ИндексКартинкиЭлементаСправочника +
+ +Описание, пример вызова + +```bsl + +// Возвращает индекс картинки элемента справочника. +// +// Возвращаемое значение: +// Число - индекс картинки. +// +Функция ИндексКартинкиЭлементаСправочника() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИндексКартинкиЭлементаСправочника() +``` +
+ +## ИнтеграцияС1СДокументооборотПередЗаписьюДокумента +
+ +Описание, пример вызова + +```bsl + +// Назначает новому документу идентификатор основания, если это возможно. +// +// Параметры: +// Источник - ДокументОбъект - записываемый документ. +// Отказ - Булево - признак необходимости отказаться от записи. +// РежимЗаписи - РежимЗаписиДокумента - режим записи документа. +// РежимПроведения - РежимПроведенияДокумента - режим проведения документа. +// +Процедура ИнтеграцияС1СДокументооборотПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИнтеграцияС1СДокументооборотПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## ИнтеграцияС1СДокументооборотПередЗаписьюСправочника +
+ +Описание, пример вызова + +```bsl + +// Назначает новому элементу справочника идентификатор основания, если это возможно. +// +// Параметры: +// Источник - СправочникОбъект - записываемый справочник. +// Отказ - Булево - признак необходимости отказаться от записи. +// +Процедура ИнтеграцияС1СДокументооборотПередЗаписьюСправочника(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИнтеграцияС1СДокументооборотПередЗаписьюСправочника(Источник, Отказ) +``` +
+ +## ИспользоватьПрисоединенныеФайлы1СДокументооборота +
+ +Описание, пример вызова + +```bsl + +// Проверяет, используются ли присоединенные файлы ДО. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользоватьПрисоединенныеФайлы1СДокументооборота() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИспользоватьПрисоединенныеФайлы1СДокументооборота() +``` +
+ +## НайтиСписокОбъектов +
+ +Описание, пример вызова + +```bsl + +// Получает значения, доступные для выбора по запросу DMGetObjectListRequest. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ТипОбъектаВыбораXDTO - Строка - имя типа объекта, значения которого требуется получить. +// УсловияОтбораОбъектов - ОбъектXDTO - объект XDTO типа DMObjectListQuery. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMGetObjectListResponse. +// +Функция НайтиСписокОбъектов(Прокси, ТипОбъектаВыбораXDTO, УсловияОтбораОбъектов = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.НайтиСписокОбъектов(Прокси, ТипОбъектаВыбораXDTO, УсловияОтбораОбъектов); +``` +
+ +## НайтиСписокОбъектовЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос DMGetObjectListRequest для получения значений, доступных для выбора. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ТипОбъектаВыбораXDTO - Строка - имя типа объекта, значения которого требуется получить. +// УсловияОтбораОбъектов - ОбъектXDTO - объект XDTO типа DMObjectListQuery: +// * columnConformity - СписокXDTO +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMGetObjectListRequest. +// +Функция НайтиСписокОбъектовЗапрос(Прокси, ТипОбъектаВыбораXDTO, УсловияОтбораОбъектов = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.НайтиСписокОбъектовЗапрос(Прокси, ТипОбъектаВыбораXDTO, УсловияОтбораОбъектов); +``` +
+ +## НовоеИсходящееПисьмо +
+ +Описание, пример вызова + +```bsl + +// Получает объект XDTO исходящего письма, заполненный по умолчанию. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Предмет - Структура - описание предмета (ID, type). +// +// Возвращаемое значение: +// ОбъектXDTO - новое исходящее письмо. +// +Функция НовоеИсходящееПисьмо(Прокси, Предмет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.НовоеИсходящееПисьмо(Прокси, Предмет); +``` +
+ +## ОбновитьПовторноИспользуемыеПараметры +
+ +Описание, пример вызова + +```bsl + +// Очищает все сохраненные значения функций с повторным использованием возвращаемых значений и параметры сеанса. +// +Процедура ОбновитьПовторноИспользуемыеПараметры() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ОбновитьПовторноИспользуемыеПараметры() +``` +
+ +## ОбработкаЗаполненияДокументы +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ОбработкаЗаполнения для документов. +// +// Параметры: +// Источник - ОпределяемыйТип.ИнтеграцияС1СДокументооборотДокументыОбъектыПереопределяемый +// ДанныеЗаполнения - Произвольный - значение, которое используется как основание для заполнения. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// +Процедура ОбработкаЗаполненияДокументы(Источник, ДанныеЗаполнения, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ОбработкаЗаполненияДокументы(Источник, ДанныеЗаполнения, СтандартнаяОбработка) +``` +
+ +## ОбработкаЗаполненияСправочники +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ОбработкаЗаполнения для справочников. +// +// Параметры: +// Источник - ОпределяемыйТип.ИнтеграцияС1СДокументооборотСправочникиОбъектыПереопределяемый +// ДанныеЗаполнения - Произвольный - значение, которое используется как основание для заполнения. +// ТекстЗаполнения - Строка +// - Неопределено +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// +Процедура ОбработкаЗаполненияСправочники(Источник, ДанныеЗаполнения, ТекстЗаполнения, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ОбработкаЗаполненияСправочники(Источник, ДанныеЗаполнения, ТекстЗаполнения, СтандартнаяОбработка) +``` +
+ +## ОписаниеВебСервисов +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание веб-сервиса 1С:Документооборота. +// +// Возвращаемое значение: +// Строка +// +Функция ОписаниеВебСервисов() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ОписаниеВебСервисов() +``` +
+ +## ПередЗаписьюНаСервере +
+ +Описание, пример вызова + +```bsl + +// Помещает в дополнительные свойства идентификатор объекта-основания. Вызывается перед записью объекта. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма записываемого объекта. +// Объект - ДокументОбъект, СправочникОбъект - записываемый объект. +// ПараметрыЗаписи - Структура - структура, содержащая параметры записи. +// +Процедура ПередЗаписьюНаСервере(Форма, Объект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПередЗаписьюНаСервере(Форма, Объект, ПараметрыЗаписи) +``` +
+ +## ПоддерживаетсяАутентификацияОС +
+ +Описание, пример вызова + +```bsl + +// Определяет возможность использования аутентификации ОС платформой 1С:Предприятия. +// Возвращает Истина для версий 8.3.7 и старше под MS Windows, и Ложь в остальных случаях. +// +// Возвращаемое значение: +// Булево +// +Функция ПоддерживаетсяАутентификацияОС() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПоддерживаетсяАутентификацияОС() +``` +
+ +## ПодходящийТип +
+ +Описание, пример вызова + +```bsl + +// Возвращает подходящий тип потребителя для объекта XDTO. +// +// Параметры: +// ТипыКандидаты - Массив из Тип - массив типов, из которых требуется выбрать подходящий. +// ЗначениеСвойстваXDTO - ОбъектXDTO - значение свойства объекта XDTO, в соответствии с типом которого +// нужно выбрать подходящий тип. +// ТипТекущегоЗначения - Тип - если реквизит объекта ИС имеет составной тип, и в нем уже установлено какое-то +// определенное значение, тип текущего значения будет более приоритетным при выборе подходящего типа. +// +// Возвращаемое значение: +// Тип - один из элементов массива ТипыКандидаты, подходящий для типа объекта XDTO. +// +Функция ПодходящийТип(ТипыКандидаты, ЗначениеСвойстваXDTO = Неопределено, ТипТекущегоЗначения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПодходящийТип(ТипыКандидаты, ЗначениеСвойстваXDTO, ТипТекущегоЗначения); +``` +
+ +## ПолучитьНастройки +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки базы Документооборота. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура: +// * НужноИзвлечьТекст - Булево +// * ИспользоватьЭлектронныеЦифровыеПодписи - Булево +// * ДобавлятьРаботуВЕжедневныйОтчетПриВыполненииЗадачи - Булево +// * ФактическийИсполнительЗадач - Строка - объект XDTO типа DMActualTasksPerformer. +// * ВестиУчетСканКопийОригиналовДокументов - Булево +// * ПоказыватьЗанятыеФайлыПриЗавершенииРаботы - Булево +// * ИспользоватьАвтозаполнениеФайлов - Булево +// * ИзменятьЗаданияЗаднимЧислом - Булево +// * СписокИсполнителейЗадач - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// * ЗаголовокСообщенияВОбластиПредпросмотра - Строка +// * СписокРасширенийСканКопийОригиналов - Строка +// * ДоступныЗадачиМне - Булево +// +Функция ПолучитьНастройки() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьНастройки() +``` +
+ +## ПолучитьНастройкиЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос для получения настроек базы Документооборота. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMGetSettingsRequest. +// +Функция ПолучитьНастройкиЗапрос(Прокси) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьНастройкиЗапрос(Прокси) +``` +
+ +## ПолучитьНовыйОбъект +
+ +Описание, пример вызова + +```bsl + +// Получает заполненный по-умолчанию объект из Документооборота. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Тип - Строка - имя типа XDTO объекта. +// Предмет - Структура - Используется для получения бизнес-процессов: +// * ID - Строка - уникальный идентификатор объекта в Документооборот. +// * type - Строка - имя типа XDTO. +// Колонки - Массив из Строка - необязательно, состав заполняемых колонок. +// - Строка - если список колонок разделен через запятую. +// ВидДокументаДОID - Строка - идентификатор вида документа, если требуется получить новый документ данного вида. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMGetNewObjectResponse. +// +Функция ПолучитьНовыйОбъект(Прокси, Тип, Предмет = Неопределено, Колонки = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьНовыйОбъект(Прокси, Тип, Предмет, Колонки, ); +``` +
+ +## ПолучитьНовыйОбъектЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос для получения заполненного по-умолчанию объекта из Документооборота. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Тип - Строка - имя типа XDTO объекта. +// Колонки - Массив из Строка - необязательно, состав заполняемых колонок. +// - Строка - если список колонок разделен через запятую. +// ВидДокументаДОID - Строка - идентификатор вида документа, если требуется получить новый документ данного вида. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMGetNewObjectRequest. +// +Функция ПолучитьНовыйОбъектЗапрос(Прокси, Тип, Колонки = Неопределено, ВидДокументаДОID = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьНовыйОбъектЗапрос(Прокси, Тип, Колонки, ВидДокументаДОID); +``` +
+ +## ПолучитьОбъект +
+ +Описание, пример вызова + +```bsl + +// Получает объект из Документооборота. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Тип - Строка - имя типа XDTO. +// ID - Строка - уникальный идентификатор объекта в Документообороте. +// Колонки - Массив из Строка - необязательно, состав заполняемых колонок. +// - Строка - если список колонок разделен через запятую. +// ПравилоИнтеграции - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - правило интеграции для +// заполнения объекта ИС. +// ВнешнийОбъектИС - ЛюбаяСсылка - передается для заполнения свойства externalObject. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO заданного типа. +// +Функция ПолучитьОбъект(Прокси, Тип, ID, Колонки = Неопределено, ПравилоИнтеграции = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьОбъект(Прокси, Тип, ID, Колонки, ПравилоИнтеграции, ); +``` +
+ +## ПолучитьОбъекты +
+ +Описание, пример вызова + +```bsl + +// Получает объекты из Документооборота. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Объекты - Массив из Структура: +// * ID - Строка +// * Тип - Строка +// * ВнешнийОбъектИС - ЛюбаяСсылка - передается для заполнения свойства externalObject. +// Колонки - Массив из Строка - необязательно, состав заполняемых колонок. +// - Строка - если список колонок разделен через запятую. +// ПравилоИнтеграции - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - правило интеграции для +// заполнения объекта ИС. +// +// Возвращаемое значение: +// СписокXDTO - список объектов XDTO заданного типа. +// +Функция ПолучитьОбъекты(Прокси, Объекты, Колонки = Неопределено, ПравилоИнтеграции = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьОбъекты(Прокси, Объекты, Колонки, ПравилоИнтеграции); +``` +
+ +## ПолучитьОбъектыЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос для получения объектов из Документооборота. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Объекты - Массив из Структура: +// * ID - Строка +// * Тип - Строка +// * ВнешнийОбъектИС - ЛюбаяСсылка - передается для заполнения свойства externalObject. +// Колонки - Массив из Строка - необязательно, состав заполняемых колонок. +// - Строка - если список колонок разделен через запятую. +// ПравилоИнтеграции - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - правило интеграции для +// заполнения объекта ИС. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMRetrieveRequest. +// +Функция ПолучитьОбъектыЗапрос(Прокси, Объекты, Колонки = Неопределено, ПравилоИнтеграции = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьОбъектыЗапрос(Прокси, Объекты, Колонки, ПравилоИнтеграции); +``` +
+ +## ПолучитьПрокси +
+ +Описание, пример вызова + +```bsl + +// Создает прокси веб-сервиса Документооборота с настройками авторизации из параметров сеанса или, если это +// невозможно, например, при создании прокси в фоновом задании, с настройками, переданными напрямую. +// +// Параметры: +// ВызыватьИсключение - Булево - Истина, если при невозможности получения следует вызвать исключение. +// ИмяПользователя - Строка - имя пользователя ДО, или +// - Неопределено - признак необходимости получить имя, сохраненное в параметрах сеанса. +// Пароль - Строка - пароль пользователя ДО, или +// - Неопределено - признак необходимости получить пароль, сохраненное в параметрах сеанса. +// АдресВебСервисаДокументооборота - Строка - адрес веб-сервиса ДО, или +// - Неопределено - признак необходимости использовать ранее сохраненный адрес. +// ИспользуетсяАутентификацияОС - Булево - неявно возвращаемое значение, +// признак необходимости использовать аутентификацию ОС (8.3.7 и выше). +// ИспользуетсяАутентификацияJWT - Булево - неявно возвращаемое значение, +// признак необходимости использовать аутентификацию через JWT-токены (8.3.21 и выше). +// ТекстСообщенияОбОшибке - Строка - неявно возвращаемое значение, текст сообщения об ошибке. +// ПользовательЗаданияОбмена - Булево - вызов выполняется для настройки пользователя задания обмена. +// Параметры сеанса текущего пользователя изменяться не будут. +// +// Возвращаемое значение: +// WSПрокси - прокси веб-сервиса Документооборота. +// Неопределено - в случае, если прокси веб-сервиса получить не удалось. +// +Функция ПолучитьПрокси(ВызыватьИсключение = Истина, ИмяПользователя = Неопределено, Пароль = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьПрокси(ВызыватьИсключение, ИмяПользователя, Пароль, ); +``` +
+ +## ПолучитьРеквизитыОбъектаИС +
+ +Описание, пример вызова + +```bsl + +// Возвращает реквизиты объекта потребителя указанного типа. +// +// Параметры: +// ТипОбъектаИС - Строка - полное имя метаданных объекта. +// ДляВыражения - Булево - возвращает список реквизитов для составления выражения на встроенном языке. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Имя - Строка +// * Представление - Строка +// * Тип - ОписаниеТипов +// * ЭтоТаблица - Булево +// * Таблица - Строка +// * ТаблицаДляСортировки - Строка +// * ЭтоДополнительныйРеквизитИС - Булево +// * ДополнительныйРеквизитИС - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения +// * СвязиПараметровВыбора - Массив из Структура: +// ** Имя - Строка +// ** ПутьКДанным - Строка +// * Порядок - Число +// +Функция ПолучитьРеквизитыОбъектаИС(ТипОбъектаИС, ДляВыражения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьРеквизитыОбъектаИС(ТипОбъектаИС, ДляВыражения); +``` +
+ +## ПользователюРазрешеноИспользованиеИнтеграции +
+ +Описание, пример вызова + +```bsl + +// Определяет доступность интеграции для текущего пользователя. Может переопределяться +// при отказе от использования поставляемой роли ИспользованиеИнтеграцииС1СДокументооборотом. +// +// Возвращаемое значение: +// Булево - Истина, если использование интеграции разрешено. +// +Функция ПользователюРазрешеноИспользованиеИнтеграции() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПользователюРазрешеноИспользованиеИнтеграции() +``` +
+ +## ПометитьНаУдалениеСнятьПометкуОбъекта +
+ +Описание, пример вызова + +```bsl + +// Помечает объект на удаление или снимает пометку. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ID - Строка - идентификатор помечаемого на удаление объекта в Документообороте. +// Тип - Строка - имя типа XDTO помечаемого на удаление объекта. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DMDeleteResponse. +// +Функция ПометитьНаУдалениеСнятьПометкуОбъекта(Прокси, ID, Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПометитьНаУдалениеСнятьПометкуОбъекта(Прокси, ID, Тип) +``` +
+ +## ПометитьНаУдалениеСнятьПометкуОбъектов +
+ +Описание, пример вызова + +```bsl + +// Помечает объекты на удаление или снимает пометку. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Объекты - Массив из Структура: +// * ID - Строка +// * Тип - Строка +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DMDeleteResponse. +// +Функция ПометитьНаУдалениеСнятьПометкуОбъектов(Прокси, Объекты) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПометитьНаУдалениеСнятьПометкуОбъектов(Прокси, Объекты) +``` +
+ +## ПометитьНаУдалениеСнятьПометкуОбъектовЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос для пометки объектов на удаление или для снятия пометки. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Объекты - Массив из Структура: +// * ID - Строка +// * Тип - Строка +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DMDeleteRequest. +// +Функция ПометитьНаУдалениеСнятьПометкуОбъектовЗапрос(Прокси, Объекты) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПометитьНаУдалениеСнятьПометкуОбъектовЗапрос(Прокси, Объекты) +``` +
+ +## ПравилоЗаполненияИзРеквизитаОбъектаДО +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей правило заполнения из реквизита объекта ДО. +// +// Параметры: +// Имя - Строка - имя реквизита объекта XDTO. +// Представление - Строка - представление реквизита объекта ДО. +// Обновлять - Булево - требуется ли обновлять реквизит объекта ИС из реквизита объекта ДО. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка +// * Представление - Строка +// * Обновлять - Булево +// +Функция ПравилоЗаполненияИзРеквизитаОбъектаДО(Имя, Представление = "", Обновлять = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПравилоЗаполненияИзРеквизитаОбъектаДО(Имя, Представление, Обновлять); +``` +
+ +## ПредельноеКоличествоВыбираемыхОбъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает предельное количество объектов, выбираемых сервисом при получении списков. +// +// Параметры: +// Тип - Строка - тип объекта XDTO +// +// Возвращаемое значение: +// Число - предельное количество элементов, выбираемых за раз +// +Функция ПредельноеКоличествоВыбираемыхОбъектов(Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПредельноеКоличествоВыбираемыхОбъектов(Тип) +``` +
+ +## ПредопределенноеЗначениеДО +
+ +Описание, пример вызова + +```bsl + +// Запрашивает ссылку на предопределенный объект Документооборота по заданному имени и типу. +// +// Параметры: +// ТипОбъекта - Строка - Имя класса XDTO, предопределенный объект которого требуется получить. +// ИмяПредопределенногоЭлемента - Строка - Имя предопределенного элемента. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DMObject. +// +Функция ПредопределенноеЗначениеДО(ТипОбъекта, ИмяПредопределенногоЭлемента) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПредопределенноеЗначениеДО(ТипОбъекта, ИмяПредопределенногоЭлемента) +``` +
+ +## ПредставлениеТипаОбъектаXDTO +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление типа объекта XDTO Документооборота по имени типа. +// +// Параметры: +// ТипXDTO - Строка - имя типа объекта XDTO. +// +// Возвращаемое значение: +// Строка - представление типа объекта XDTO Документооборота по имени типа. +// +Функция ПредставлениеТипаОбъектаXDTO(ТипXDTO) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПредставлениеТипаОбъектаXDTO(ТипXDTO) +``` +
+ +## ПриЗаписиКонстанты +
+ +Описание, пример вызова + +```bsl + +// Вызывается при записи констант подсистемы Интеграция с 1С:Документооборотом. +// +// Параметры: +// Источник - КонстантаМенеджерЗначения - записываемая константа. +// Отказ - Булево - флаг отказа от выполнения записи. +// +Процедура ПриЗаписиКонстанты(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриЗаписиКонстанты(Источник, Отказ) +``` +
+ +## ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO +
+ +Описание, пример вызова + +```bsl + +// Вызывается при заполнении реквизита объекта ИС по значению реквизита объекта ДО. +// +// Параметры: +// Результат - Произвольный - заполняемое значение реквизита объекта ИС. +// ЗначениеЗаполнения - ОбъектXDTO - исходный объект, соответствие которому нужно найти. +// - Структура - структура со свойствами: +// * ТипXDTOОбъекта - Строка - тип XDTO объекта, из значения свойства которого выполняется заполнение. +// * ИмяСвойства - Строка - имя свойства, из значения свойства которого выполняется заполнение. +// * ЗначениеСвойства - Произвольный - значение заполнения, соответствие которому нужно найти. +// ТипРеквизита - Тип - тип заполняемого реквизита объекта ИС. +// ИмяРеквизита - Строка - имя заполняемого реквизита ИС. +// ТипОбъекта - Тип - тип заполняемого объекта ИС. +// Объект - Произвольный - заполняемый объект ИС. +// ЭтоДополнительноеСвойство - Булево - истина, если переданный объект является доп. свойством. +// Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - свойство-владелец. +// ПараметрыВыбора - Соответствие из КлючИЗначение - параметры выбора: +// * Ключ - Строка - имя параметра вида "Отбор.Владелец". +// * Значение - Произвольный - значение параметра (отбора). +// +Процедура ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO(Результат, ЗначениеЗаполнения, ТипРеквизита, ИмяРеквизита, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO(Результат, ЗначениеЗаполнения, ТипРеквизита, ИмяРеквизита, ); +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Добавляет команды Документооборота на форму объекта при создании на сервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана процедура. +// МестоРазмещенияКоманд - ГруппаФормы - место для размещения, по умолчанию - командная панель формы. +// ПараметрыОповещения - Структура - параметры, где может быть установлен источник команды. +// Ссылка - ЛюбаяСсылка - ссылка на объект ИС, являющийся основным объектом формы. +// +Процедура ПриСозданииНаСервере(Форма, МестоРазмещенияКоманд = Неопределено, ПараметрыОповещения = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриСозданииНаСервере(Форма, МестоРазмещенияКоманд, ПараметрыОповещения, ); +``` +
+ +## ПриСозданииНаСервереФормРазмещаемыхНаРабочемСтоле +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании форм интеграции, размещаемых на рабочем столе. +// Позволяет отказаться от их создания при работе в неразделенном сеансе или при выполнении обновления ИБ. +// +// Параметры: +// Отказ - Булево - отказ от создания. +// +Процедура ПриСозданииНаСервереФормРазмещаемыхНаРабочемСтоле(Отказ) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриСозданииНаСервереФормРазмещаемыхНаРабочемСтоле(Отказ) +``` +
+ +## ПриложениеЯвляетсяВебКлиентом +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истину, если клиентское приложение является веб клиентом, иначе Ложь. +// +// Возвращаемое значение: +// Булево +// +Функция ПриложениеЯвляетсяВебКлиентом() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриложениеЯвляетсяВебКлиентом() +``` +
+ +## ПроверитьВозвратВебСервиса +
+ +Описание, пример вызова + +```bsl + +// Проверяет возврат WEB-сервиса. В случае возврата объекта типа DMError вызывает исключение. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Ответ - ОбъектXDTO - проверяемый результат вызова сервиса. +// +Процедура ПроверитьВозвратВебСервиса(Прокси, Ответ) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПроверитьВозвратВебСервиса(Прокси, Ответ) +``` +
+ +## ПроверитьТип +
+ +Описание, пример вызова + +```bsl + +// Проверяет тип объекта XDTO. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ОбъектXDTO - ОбъектXDTO - проверяемый объект +// Тип - Строка - имя типа для проверки +// +// Возвращаемое значение: +// Булево - Истина если объект является объектом указанного типа и Ложь в противном случае. +// +Функция ПроверитьТип(Прокси, ОбъектXDTO, Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПроверитьТип(Прокси, ОбъектXDTO, Тип) +``` +
+ +## СвойствоСуществует +
+ +Описание, пример вызова + +```bsl + +// Определяет существует ли свойство в объекте XDTO. +// +// Параметры: +// ОбъектXDTO - ОбъектXDTO - исходный объект, свойство которого нужно проверить. +// ИмяСвойства - Строка - имя свойства. +// ВызыватьИсключение - Булево - вызывать исключение в случае, если не существует свойства с указанным именем. +// +// Возвращаемое значение: +// Булево - свойство существует. +// +Функция СвойствоСуществует(ОбъектXDTO, ИмяСвойства, ВызыватьИсключение = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СвойствоСуществует(ОбъектXDTO, ИмяСвойства, ВызыватьИсключение); +``` +
+ +## СвойствоУстановлено +
+ +Описание, пример вызова + +```bsl + +// Определяет было ли установлено свойство в объекте XDTO. +// +// Параметры: +// ОбъектXDTO - ОбъектXDTO - исходный объект, свойство которого нужно проверить. +// ИмяСвойства - Строка - имя свойства. +// +// Возвращаемое значение: +// Булево - свойство установлено. +// +Функция СвойствоУстановлено(ОбъектXDTO, ИмяСвойства) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СвойствоУстановлено(ОбъектXDTO, ИмяСвойства) +``` +
+ +## СерверРаботаетПодWindows +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если сервер работает под Windows, и Ложь в противном случае. +// +// Возвращаемое значение: +// Булево +// +Функция СерверРаботаетПодWindows() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СерверРаботаетПодWindows() +``` +
+ +## СогласованВ1СДокументооборот +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак состояния "Согласован" по данным документооборота. +// +// Параметры: +// СсылкаНаОбъект - ЛюбаяСсылка - ссылка на объект ИС. +// +// Возвращаемое значение: +// Булево - состояние согласования в ДО. +// +Функция СогласованВ1СДокументооборот(СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СогласованВ1СДокументооборот(СсылкаНаОбъект) +``` +
+ +## СоздатьDMLink +
+ +Описание, пример вызова + +```bsl + +// Создает объект DMLink. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ИдентификаторОбъектаДО - Строка - идентификатор объекта ДО. +// ТипОбъектаДО - Строка - тип объекта XDTO. +// ОбъектИС - ЛюбаяСсылка - ссылка на объект ИС. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMLink. +// +Функция СоздатьDMLink(Прокси, ИдентификаторОбъектаДО = "", ТипОбъектаДО = "", ОбъектИС = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьDMLink(Прокси, ИдентификаторОбъектаДО, ТипОбъектаДО, ОбъектИС); +``` +
+ +## СоздатьExternalObject +
+ +Описание, пример вызова + +```bsl + +// Создает объект ExternalObject. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ВнешнийОбъектИС - ЛюбаяСсылка - ссылка на внешний объект ИС. +// ID - Строка - идентификатор внешнего объекта ИС. +// Тип - Строка - тип внешнего объекта ИС. +// Наименование - Строка - наименование внешнего объекта ИС. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа ExternalObject. +// +Функция СоздатьExternalObject(Прокси, ВнешнийОбъектИС = Неопределено, ID = "", Тип = "", Наименование = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьExternalObject(Прокси, ВнешнийОбъектИС, ID, Тип, Наименование); +``` +
+ +## СоздатьExternalObjectID +
+ +Описание, пример вызова + +```bsl + +// Создает объект ExternalObjectID. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ВнешнийОбъектИС - ЛюбаяСсылка - ссылка на внешний объект ИС. +// ID - Строка - идентификатор внешнего объекта ИС. +// Тип - Строка - тип внешнего объекта ИС. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа ExternalObjectID. +// +Функция СоздатьExternalObjectID(Прокси, ВнешнийОбъектИС = Неопределено, ID = "", Тип = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьExternalObjectID(Прокси, ВнешнийОбъектИС, ID, Тип); +``` +
+ +## СоздатьObjectID +
+ +Описание, пример вызова + +```bsl + +// Создает объект DMObjectID. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ID - Строка - идентификатор объекта XDTO. +// Тип - Строка - тип объекта XDTO. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMObjectID. +// +Функция СоздатьObjectID(Прокси, ID = "", Тип = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьObjectID(Прокси, ID, Тип); +``` +
+ +## СоздатьИзДанныхСсылочногоОбъектаДО +
+ +Описание, пример вызова + +```bsl + +// Создает объект XDTO из структуры данных ссылочного объекта ДО. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеСсылочногоОбъектаДО - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO, наследуемый от типа DMObject. +// +Функция СоздатьИзДанныхСсылочногоОбъектаДО(Прокси, ДанныеСсылочногоОбъектаДО) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьИзДанныхСсылочногоОбъектаДО(Прокси, ДанныеСсылочногоОбъектаДО) +``` +
+ +## СоздатьНовыйОбъект +
+ +Описание, пример вызова + +```bsl + +// Создает новый объект в Документообороте. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Объект - ОбъектXDTO - описание создаваемого объекта. +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO типа DMCreateResponse или DMError. +// +Функция СоздатьНовыйОбъект(Прокси, Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьНовыйОбъект(Прокси, Объект) +``` +
+ +## СоздатьОбъект +
+ +Описание, пример вызова + +```bsl + +// Создает XDTO объект указанного типа из пространства имен веб-сервиса Документооборота. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ТипОбъекта - Строка - тип объекта XDTO. +// ВнешнийОбъектИС - ЛюбаяСсылка - передается для заполнения свойств name и externalObject. +// ЗаполнитьИзВнешнегоОбъекта - Булево - требуется заполнить объект XDTO из внешнего объекта ИС. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO указанного типа. +// +Функция СоздатьОбъект(Прокси, ТипОбъекта, ВнешнийОбъектИС = Неопределено, ЗаполнитьИзВнешнегоОбъекта = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьОбъект(Прокси, ТипОбъекта, ВнешнийОбъектИС, ЗаполнитьИзВнешнегоОбъекта); +``` +
+ +## СоздатьОбъектXDTOДляСохраненияПодписей +
+ +Описание, пример вызова + +```bsl + +// Создает XDTO объект для передачи массива подписей в Документооборот. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеВладельцаПодписи - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеВладельцаПодписи +// +// Возвращаемое значение: +// ОбъектXDTO - Объект XDTO с заполненным свойством signatures. +// +Функция СоздатьОбъектXDTOДляСохраненияПодписей(Прокси, ДанныеВладельцаПодписи) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьОбъектXDTOДляСохраненияПодписей(Прокси, ДанныеВладельцаПодписи) +``` +
+ +## СокращенноеНаименованиеКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Возвращает сокращенное наименование интегрируемой конфигурации для вывода в заголовках и декорациях. +// +// Возвращаемое значение: +// Строка - сокращенное наименование конфигурации. +// +Функция СокращенноеНаименованиеКонфигурации() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СокращенноеНаименованиеКонфигурации() +``` +
+ +## СсылкаИзUUID +
+ +Описание, пример вызова + +```bsl + +// Получает ссылку на объект по имени объекта конфигурации и ID. +// +// Параметры: +// Тип - Строка - тип объекта конфигурации. +// UUID - Строка - идентификатор объекта конфигурации. +// +// Возвращаемое значение: +// ЛюбаяСсылка - ссылка на объект. +// +Функция СсылкаИзUUID(Тип, UUID) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СсылкаИзUUID(Тип, UUID) +``` +
+ +## СсылкиПоВнешнимОбъектам +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылки на объекты этой конфигурации по информации о них в объекте ДО. +// +// Параметры: +// ОбъектXDTO - ОбъектXDTO - потомок DMObject, объект ДО. +// - Структура - содержит идентификатор и тип внешнего объекта: +// * ID - Строка - идентификатор внешнего объекта по данным 1С:Документооборота; +// * type - Строка - тип внешнего объекта по данным 1С:Документооборота. +// +// Возвращаемое значение: +// Массив из ЛюбаяСсылка - массив ссылок на связанные объекты этой конфигурации. +// +Функция СсылкиПоВнешнимОбъектам(ОбъектXDTO) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СсылкиПоВнешнимОбъектам(ОбъектXDTO) +``` +
+ +## ТаймаутСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает таймаут прокси веб-сервиса Документооборота, возможно, переопределенный в настройках. +// +// Возвращаемое значение: +// Число - таймаут в секундах. +// +Функция ТаймаутСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ТаймаутСервиса() +``` +
+ +## ТекущийПользовательДокументооборота +
+ +Описание, пример вызова + +```bsl + +// Получает текущего пользователя 1С:Документооборота. +// +// Возвращаемое значение: +// Массив из ОбъектXDTO - Объект XDTO типа DMUser, DMEmployee или Неопределено. +// +Функция ТекущийПользовательДокументооборота() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ТекущийПользовательДокументооборота() +``` +
+ +## ТекущийПользовательДокументооборотаЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос для получения текущего пользователя 1С:Документооборота. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMGetCurrentUserRequest. +// +Функция ТекущийПользовательДокументооборотаЗапрос(Прокси) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ТекущийПользовательДокументооборотаЗапрос(Прокси) +``` +
+ +## УстановитьВерсиюСервиса +
+ +Описание, пример вызова + +```bsl + +// Устанавливает версию сервиса в параметрах сеанса. +// +// Параметры: +// ИзФоновогоЗадания - Булево - процедура запускается из фонового задания. +// ТекстОшибки - Строка - неявно возвращаемое значение, текст сообщения об ошибке, +// полученный при определении версии сервиса. +// +Процедура УстановитьВерсиюСервиса(ИзФоновогоЗадания = Ложь, ТекстОшибки = "") Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.УстановитьВерсиюСервиса(ИзФоновогоЗадания, ТекстОшибки); +``` +
+ +## УстановитьПараметрыСеанса +
+ +Описание, пример вызова + +```bsl + +// Устанавливает параметры сеанса работы с подсистемой "Интеграция с 1С:Документооборотом". +// +// Параметры: +// ИмяПараметра - Строка +// УстановленныеПараметры - Массив из Строка +// +Процедура УстановитьПараметрыСеанса(ИмяПараметра, УстановленныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.УстановитьПараметрыСеанса(ИмяПараметра, УстановленныеПараметры) +``` +
+ +## УстановитьПараметрыСеансаПоМассивуИмен +
+ +Описание, пример вызова + +```bsl + +// Устанавливает параметры сеанса по массиву имен. +// +// Параметры: +// ИменаПараметров - Массив из Строка - массив строк с именами параметров сеанса к установке. +// +Процедура УстановитьПараметрыСеансаПоМассивуИмен(ИменаПараметров) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.УстановитьПараметрыСеансаПоМассивуИмен(ИменаПараметров) +``` +
+ +## УстановитьШтрихкод +
+ +Описание, пример вызова + +```bsl + +// Добавляет в связанный документ в ДО штрихкод по объекту ИС. +// +// Параметры: +// ОбъектИС - ЛюбаяСсылка - объект ИС, источник данных заполнения. +// ID - Строка - идентификатор объекта Документооборота. +// Тип - Строка - XDTO-тип объекта Документооборота +// +Процедура УстановитьШтрихкод(ОбъектИС, ID, Тип) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.УстановитьШтрихкод(ОбъектИС, ID, Тип) +``` +
+ +## ЭтоОбъектноеЗначение +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли значение объектным, т.е. наследуется от типа DMObject. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Значение - Произвольный - проверяемое значение. +// +// Возвращаемое значение: +// Булево - Истина, в случае, если значение является потомком типа DMObject, иначе Ложь. +// +Функция ЭтоОбъектноеЗначение(Прокси, Значение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЭтоОбъектноеЗначение(Прокси, Значение) +``` +
+ +## ЭтоОбъектноеСвойство +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли свойство объектным, т.е. наследуется от типа DMObject. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ОбъектXDTO - ОбъектXDTO - объект, содержащий проверяемое свойство +// ИмяСвойстваXDTO - Строка - имя проверяемого свойства +// +// Возвращаемое значение: +// Булево - Истина, в случае, если свойство является потомком типа DMObject, иначе Ложь +// +Функция ЭтоОбъектноеСвойство(Прокси, ОбъектXDTO, ИмяСвойстваXDTO) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЭтоОбъектноеСвойство(Прокси, ОбъектXDTO, ИмяСвойстваXDTO) +``` +
+ +## ДанныеФайловОбъектаИС +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные хранящихся на стороне ДО файлов. +// +// Параметры: +// Источник - ЛюбаяСсылка - ссылка на исходный объект ИС. +// ИдентификаторФормы - УникальныйИдентификатор - идентификатор форма-владельца хранилища. +// СписокРасширений - Строка - список расширений файлов, которые требуется получать из ДО через запятую. +// +// Возвращаемое значение: +// Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла +// +Функция ДанныеФайловОбъектаИС(Источник, ИдентификаторФормы, Знач СписокРасширений = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДанныеФайловОбъектаИС(Источник, ИдентификаторФормы, СписокРасширений); +``` +
+ +## ДобавитьКомандуПечати +
+ +Описание, пример вызова + +```bsl + +// Добавляет команду печати в таблицу печатных форм объекта. +// +// Параметры: +// ПечатныеФормы - ТаблицаЗначений: +// * МенеджерПечати - Строка - имя объекта, в модуле менеджера которого располагается +// процедура Печать, формирующая табличные документы для этой команды. +// * ИмяКоманды - Строка +// * ПредставлениеКоманды - Строка +// * ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати. +// КомандаПечати - см. УправлениеПечатью.КомандыПечатиФормы +// +Процедура ДобавитьКомандуПечати(ПечатныеФормы, КомандаПечати) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьКомандуПечати(ПечатныеФормы, КомандаПечати) +``` +
+ +## ЗаполнитьКоллекциюПечатныхФорм +
+ +Описание, пример вызова + +```bsl + +// Заполняет коллекцию печатных форм объекта по имени менеджера печати и команде менеджера печати. +// +// Параметры: +// ВнешнийОбъект - ЛюбаяСсылка - внешний объект. +// ИмяКоманды - Строка - имя команды. +// ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати. +// КоллекцияПечатныхФорм - ТаблицаЗначений - неявно возвращаемое значение. +// +Процедура ЗаполнитьКоллекциюПечатныхФорм(ВнешнийОбъект, ИмяКоманды, ДополнительныеПараметры, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьКоллекциюПечатныхФорм(ВнешнийОбъект, ИмяКоманды, ДополнительныеПараметры, ); +``` +
+ +## ЗаполнитьТаблицуМенеджеровПечатиОбъекта +
+ +Описание, пример вызова + +```bsl + +// Получает таблицу менеджеров печати форм объектов. +// +// Параметры: +// МенеджерОбъекта - Строка - полное имя метаданных менеджера объекта. +// ПечатныеФормы - ТаблицаЗначений: +// * МенеджерПечати - Строка - имя объекта, в модуле менеджера которого располагается +// процедура Печать, формирующая табличные документы для этой команды. +// * ИмяКоманды - Строка +// * ПредставлениеКоманды - Строка +// * ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати. +// +Процедура ЗаполнитьТаблицуМенеджеровПечатиОбъекта(МенеджерОбъекта, ПечатныеФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьТаблицуМенеджеровПечатиОбъекта(МенеджерОбъекта, ПечатныеФормы) +``` +
+ +## ИмяПечатнойФормы +
+ +Описание, пример вызова + +```bsl + +// Формирует имя файла печатной формы объекта ИС для помещения в ДО. +// +// Параметры: +// Источник - ЛюбаяСсылка - ссылка на исходный объект ИС. +// ПредставлениеКоманды - Строка - синоним команды печати. +// СинонимМакета - Строка - синоним макета печатной формы. +// ИмяМакета - Строка - имя макета печатной формы. +// +// Возвращаемое значение: +// Строка +// +Функция ИмяПечатнойФормы(Источник, ПредставлениеКоманды, СинонимМакета, ИмяМакета) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИмяПечатнойФормы(Источник, ПредставлениеКоманды, СинонимМакета, ИмяМакета) +``` +
+ +## ИндексПиктограммыФайла +
+ +Описание, пример вызова + +```bsl + +// Получается индекс пиктограммы файла - индекс в картинке КоллекцияПиктограммФайлов. +// +// Параметры: +// Расширение - Строка - расширение файла. +// ПометкаУдаления - Булево - файл помечен на удаление. +// +// Возвращаемое значение: +// Число +// +Функция ИндексПиктограммыФайла(Расширение, ПометкаУдаления = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИндексПиктограммыФайла(Расширение, ПометкаУдаления); +``` +
+ +## КоличествоФайловСвязанногоОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает количество прикрепленных файлов к связанному объекту 1С:Документооборот. +// +// Параметры: +// ID - Строка - идентификатор объекта Документооборота. +// Тип - Строка - XDTO-тип объекта Документооборота. +// ВключаяУдаленные - Булево - учитывать ли помеченные на удаление файлы. +// +// Возвращаемое значение: +// Число - количество прикрепленных файлов. +// +Функция КоличествоФайловСвязанногоОбъекта(ID, Тип, ВключаяУдаленные = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.КоличествоФайловСвязанногоОбъекта(ID, Тип, ВключаяУдаленные); +``` +
+ +## КомандыПечатиФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает команды печати формы. +// +// Параметры: +// ИмяФормы - Строка - имя формы объекта. +// +// Возвращаемое значение: +// см. УправлениеПечатью.КомандыПечатиФормы +// +Функция КомандыПечатиФормы(ИмяФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.КомандыПечатиФормы(ИмяФормы) +``` +
+ +## КонтрольОтправкиФайлов +
+ +Описание, пример вызова + +```bsl + +// Конструктор таблицы, кэширующей значения для последующего внесения в регистр +// сведений КонтрольОтправкиФайловВ1СДокументооборот. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * Источник - ЛюбаяСсылка - ссылка на исходный объект ИС. +// * ИмяФайла - Строка - имя печатной формы. +// * ТабличныйДокумент - ТабличныйДокумент - сформированная печатная форма. +// +Функция КонтрольОтправкиФайлов() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.КонтрольОтправкиФайлов() +``` +
+ +## МенеджерыПечати +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений с информацией о менеджерах печати объекта. +// +// Параметры: +// МенеджерОбъекта - Строка - полное имя метаданных менеджера объекта. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ИмяКоманды - Строка - имя команды менеджера печати. +// * МенеджерПечати - Строка - имя объекта, в модуле менеджера которого располагается +// процедура Печать, формирующая табличные документы для этой команды. +// * ПредставлениеКоманды - Строка - представление команды печати для отображения на формах. +// * ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати. +// +Функция МенеджерыПечати(МенеджерОбъекта) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.МенеджерыПечати(МенеджерОбъекта) +``` +
+ +## ПечатныеФормыКСозданию +
+ +Описание, пример вызова + +```bsl + +// Формирует параметры создания файлов объекта ДО из печатных форм объекта ИС. +// +// Параметры: +// Источник - ЛюбаяСсылка - ссылка на исходный объект ИС. +// ПрисоединяемыеПечатныеФормы - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПрисоединяемыеПечатныеФормы +// ТипФайловСохраненияПечатныхФорм - ПеречислениеСсылка.ТипыФайловСохраненияПечатныхФормОбъектов - тип файла, +// в котором сохраняется печатная форма. +// КонтрольОтправкиФайлов - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.КонтрольОтправкиФайлов +// ТолькоОбновление - Булево - Истина, если выполняется только обновление существующих форм. +// ИдентификаторФормы - УникальныйИдентификатор - идентификатор форма-владельца хранилища. +// +// Возвращаемое значение: +// Массив Из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.НовыеПараметрыСозданияФайла +// +Функция ПечатныеФормыКСозданию(Источник, ПрисоединяемыеПечатныеФормы, ТипФайловСохраненияПечатныхФорм, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПечатныеФормыКСозданию(Источник, ПрисоединяемыеПечатныеФормы, ТипФайловСохраненияПечатныхФорм, ); +``` +
+ +## ПриОпределенииНаличияПрисоединенныхФайлов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при определении наличия файлов, хранимых в интегрируемой конфигурации. +// +// Параметры: +// ВладелецФайлов - Произвольный - объект-владелец. +// ЕстьФайлы - Булево, Неопределено - неявно возвращаемое значение, признак наличия присоединенных файлов. +// +Процедура ПриОпределенииНаличияПрисоединенныхФайлов(ВладелецФайлов, ЕстьФайлы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриОпределенииНаличияПрисоединенныхФайлов(ВладелецФайлов, ЕстьФайлы) +``` +
+ +## ПрисоединенныеФайлыВИС +
+ +Описание, пример вызова + +```bsl + +// Возвращает список присоединенных файлов, хранимых в ИС. +// +// Параметры: +// ВладелецФайлов - Произвольный - объект-владелец. +// +// Возвращаемое значение: +// Массив из ЛюбаяСсылка - список ссылок на прикрепленные файлы. +// +Функция ПрисоединенныеФайлыВИС(ВладелецФайлов) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПрисоединенныеФайлыВИС(ВладелецФайлов) +``` +
+ +## ПрисоединяемыеПечатныеФормы +
+ +Описание, пример вызова + +```bsl + +// Конструктор таблицы значений, описывающей присоединяемые печатные формы. +// +// Возвращаемое значение: +// ТаблицаЗначений: +// * ИмяКоманды - Строка - имя команды менеджера печати. +// * ПредставлениеКоманды - Строка - представление команды печати для отображения на формах. +// * МенеджерПечати - Строка - имя менеджера печати, как оно задано в конфигураторе. +// * Обновлять - Булево - обновлять значение. +// * РольФайлаID - Строка - идентификатор роли файла печатной формы на стороне ДО. +// * ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати. +// +Функция ПрисоединяемыеПечатныеФормы() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПрисоединяемыеПечатныеФормы() +``` +
+ +## ПриПолученииПрисоединенныхФайлов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении присоединенных файлов. +// +// Параметры: +// ВладелецФайлов - Произвольный - объект-владелец. +// ДанныеФайлов - Массив из см. РаботаСФайлами.ДанныеФайла +// +Процедура ПриПолученииПрисоединенныхФайлов(ВладелецФайлов, ДанныеФайлов) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриПолученииПрисоединенныхФайлов(ВладелецФайлов, ДанныеФайлов) +``` +
+ +## ПриПоявленииПрисоединенныхФайловДокументооборота +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак наличия присоединенных файлов ДО для объекта ИС. Вызывается при добавлении +// связи с объектом ДО, имеющим файлы, при добавлении файла из интерфейса ИС и при фоновом обновлении. +// +// Параметры: +// ID - Строка - идентификатор объекта Документооборота. +// Тип - Строка - XDTO-тип объекта Документооборота. +// ОбъектИС - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект ИС. +// НаличиеПрисоединенныхФайлов - Булево - Истина, если в ДО есть присоединенные файлы. +// +Процедура ПриПоявленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриПоявленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС, ); +``` +
+ +## ПриУдаленииПрисоединенныхФайловДокументооборота +
+ +Описание, пример вызова + +```bsl + +// Снимает признак наличия присоединенных файлов для объекта ИС, если их нет в самой ИС. Вызывается при +// удалении связи с объектом ДО и при фоновом обновлении. +// +// Параметры: +// ID - Строка - идентификатор объекта Документооборота. +// Тип - Строка - XDTO-тип объекта Документооборота. +// ОбъектИС - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект ИС. +// +Процедура ПриУдаленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриУдаленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС) +``` +
+ +## РасширениеСохраняемойПечатнойФормы +
+ +Описание, пример вызова + +```bsl + +// Возвращает расширение по типу файла сохраняемой печатной формы. +// +// Параметры: +// ТипФайла - ПеречислениеСсылка.ТипыФайловСохраненияПечатныхФормОбъектов - тип сохраняемого файла. +// +// Возвращаемое значение: +// Строка - расширение файла. +// +Функция РасширениеСохраняемойПечатнойФормы(ТипФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.РасширениеСохраняемойПечатнойФормы(ТипФайла) +``` +
+ +## СоздатьФайлЗапрос +
+ +Описание, пример вызова + +```bsl + +// Возвращает запрос для создания файла в Документообороте. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ФайлXDTO - ОбъектXDTO - объект XDTO типа DMFile. +// ВладелецID - Строка - идентификатор владельца файла в Документообороте. +// ВладелецТип - Строка - тип владельца файла в Документообороте. +// ВладелецПредставление - Строка - представление владельца файла в Документообороте. +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMAddFileRequest. +// +Функция СоздатьФайлЗапрос(Прокси, ФайлXDTO, ВладелецID, ВладелецТип, ВладелецПредставление = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьФайлЗапрос(Прокси, ФайлXDTO, ВладелецID, ВладелецТип, ВладелецПредставление); +``` +
+ +## ТипФайлаСохраняемойПечатнойФормыПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Возвращает тип файла сохраняемой печатной формы по умолчанию. +// +// Возвращаемое значение: +// ПеречислениеСсылка.ТипыФайловСохраненияПечатныхФормОбъектов - тип по умолчанию. +// +Функция ТипФайлаСохраняемойПечатнойФормыПоУмолчанию() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ТипФайлаСохраняемойПечатнойФормыПоУмолчанию() +``` +
+ +## ФайлXDTOИзПараметровСоздания +
+ +Описание, пример вызова + +```bsl + +// Создает и заполняет объект XDTO типа DMFile по данным из параметров создания. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ПараметрыСоздания - Структура - ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.НовыеПараметрыСозданияФайла +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMFile. +// +Функция ФайлXDTOИзПараметровСоздания(Прокси, ПараметрыСоздания) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ФайлXDTOИзПараметровСоздания(Прокси, ПараметрыСоздания) +``` +
+ +## ЗаполнитьПолнуюРоль +
+ +Описание, пример вызова + +```bsl + +// Заполняет объект XDTO, описывающий полную роль. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ПолнаяРольXDTO - ОбъектXDTO - объект XDTO типа DMCompleteRole. +// Роль - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ОсновнойОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ДополнительныйОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// +Процедура ЗаполнитьПолнуюРоль(Прокси, ПолнаяРольXDTO, Роль, ОсновнойОбъектАдресации = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьПолнуюРоль(Прокси, ПолнаяРольXDTO, Роль, ОсновнойОбъектАдресации, ); +``` +
+ +## УчастникЗадач +
+ +Описание, пример вызова + +```bsl + +// Формирует объект XDTO, описывающий участника задачи. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// Исполнитель - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ОсновнойОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// ДополнительныйОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО +// +// Возвращаемое значение: +// ОбъектXDTO - объект XDTO типа DMTaskParticipant. +// +Функция УчастникЗадач(Прокси, Исполнитель, ОсновнойОбъектАдресации = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.УчастникЗадач(Прокси, Исполнитель, ОсновнойОбъектАдресации, ); +``` +
+ +## URIПространстваИменВебСервисаДокументооборота +
+ +Описание, пример вызова + +```bsl + +// Возвращает URI пространства имен веб-сервиса 1С:Документооборот. +// +// Возвращаемое значение: +// Строка +// +Функция URIПространстваИменВебСервисаДокументооборота() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.URIПространстваИменВебСервисаДокументооборота() +``` +
+ +## ИмяВебСервисаДокументооборота +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя веб-сервиса 1С:Документооборот. +// +// Возвращаемое значение: +// Строка +// +Функция ИмяВебСервисаДокументооборота() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИмяВебСервисаДокументооборота() +``` +
+ +## КлючСопоставленияПользователяТокенаДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращает ключ сопоставления пользователя, который будет передан в токена доступа. +// Ключ зависит от текущих настроек, это может быть имя пользователя ИБ или пользователь ОС. +// +// Возвращаемое значение: +// Строка +// +Функция КлючСопоставленияПользователяТокенаДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.КлючСопоставленияПользователяТокенаДоступа() +``` +
+ +## ПараметрыТокенаДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров, необходимую для формирования токена доступа. +// +// Возвращаемое значение: +// Структура: +// * Эмитент - Строка +// * ВремяСоздания - Число +// * ВремяЖизни - Число +// * Идентификатор - УникальныйИдентификатор +// * Получатели - Массив из Строка +// * КлючСопоставленияПользователя - Строка +// +Функция ПараметрыТокенаДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПараметрыТокенаДоступа() +``` +
+ +## ПолучателиТокенаДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив получателей, необходимый для формирования токена доступа. +// +// Возвращаемое значение: +// Массив из Строка +// +Функция ПолучателиТокенаДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучателиТокенаДоступа() +``` +
+ +## ПсевдонимВебСервисаДокументооборота +
+ +Описание, пример вызова + +```bsl + +// Возвращает псевдоним веб-сервиса 1С:Документооборот. +// +// Возвращаемое значение: +// Строка +// +Функция ПсевдонимВебСервисаДокументооборота() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПсевдонимВебСервисаДокументооборота() +``` +
+ +## ТекстТокенаДоступа +
+ +Описание, пример вызова + +```bsl + +// Формирует текстовое представление JWT-токена для авторизации в веб-сервисе Документооборота. +// +// Возвращаемое значение: +// Строка +// +Функция ТекстТокенаДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ТекстТокенаДоступа() +``` +
+ +## ЭмитентТокенаДоступа +
+ +Описание, пример вызова + +```bsl + +// Возвращает эмитента, необходимого для формирования токена доступа. +// +// Возвращаемое значение: +// Строка +// +Функция ЭмитентТокенаДоступа() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЭмитентТокенаДоступа() +``` +
+ +## ДанныеПодписей +
+ +Описание, пример вызова + +```bsl + +// Преобразует таблицу подписей на форме в массив структурированных данных подписей. +// +// Параметры: +// ТаблицаПодписей - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// +// Возвращаемое значение: +// Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи +// +Функция ДанныеПодписей(ТаблицаПодписей) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДанныеПодписей(ТаблицаПодписей) +``` +
+ +## ДанныеПодписи +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные, из которых будет формироваться XDTO объект DMSignature, для передачи в ДО. +// +// Параметры: +// Подпись - ДвоичныеДанные - двоичные данные подписи. +// ДвоичныеДанныеСертификата - ДвоичныеДанные - двоичные данные сертификата. +// СвойстваПодписи - Структура - тут может быть или структура СвойстваПодписи, которую возвращает БСП при +// добавлении новой подписи, или строка таблицы подписей, если это уже существующая на стороне ДО подпись. +// +// Возвращаемое значение: +// см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи +// +Функция ДанныеПодписи(Подпись, ДвоичныеДанныеСертификата, СвойстваПодписи) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДанныеПодписи(Подпись, ДвоичныеДанныеСертификата, СвойстваПодписи) +``` +
+ +## ПроверитьПодписи +
+ +Описание, пример вызова + +```bsl + +// Проверяет подписи из массива ВыделенныеСтроки. Если массив выделенных строк не передан - проверяет все +// подписи из таблицы подписей. +// +// Параметры: +// МенеджерКриптографии - МенеджерКриптографии - объект Менеджера криптографии. +// ТаблицаПодписей - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// УникальныйИдентификатор - УникальныйИдентификатор - идентификатор управляемой формы объекта Документооборота. +// ВыделенныеПодписи - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыделенныеПодписи +// АдресСлепкаДокумента - Строка - адрес временного хранилища двоичных данных документа Документооборота. +// +Процедура ПроверитьПодписи(МенеджерКриптографии, ТаблицаПодписей, УникальныйИдентификатор, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПроверитьПодписи(МенеджерКриптографии, ТаблицаПодписей, УникальныйИдентификатор, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьВызовСервераПереопределяемый.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьВызовСервераПереопределяемый.md new file mode 100644 index 0000000..00f411c --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьВызовСервераПереопределяемый.md @@ -0,0 +1,51 @@ +--- +title: Интеграция с 1С документооборот базовая функциональность вызов сервера переопределяемый +slug: zup/интеграция-с-1с-документооборот-базовая-функциональность-вызов-сервера-переопределяемый +--- + + +## ПриСозданииПравилИнтеграцииАвтоматически +
+ +Описание, пример вызова + +```bsl + +// Создает правила интеграции для указанного типа объекта ИС. +// +// Параметры: +// ИмяТипаОбъекта - Строка, ЛюбаяСсылка - полное имя типа объекта ИС, как в метаданных, или ссылка на объект ИС. +// ПравилаИнтеграции - Массив из Структура: +// * Ссылка - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом +// * ТипОбъектаИС - Строка +// * ТипОбъектаДО - Строка +// * ПредставлениеОбъектаИС - Строка +// * ПредставлениеОбъектаДО - Строка +// * ИдентификаторВидаДокумента - Строка +// * ТипВидаДокумента - Строка +// +// Пример: +// Если ИмяТипаОбъекта = "Документ.ПоступлениеТоваровУслуг" Тогда +// // Создаем правила интеграции и добавляем в массив +// ПравилаИнтеграции = НачатьАвтоматическуюНастройкуИнтеграцииПоступлениеТоваровУслуг(); +// ИначеЕсли ИмяТипаОбъекта = "Документ.ЗаявкаНаРасходованиеДенежныхСредств" Тогда +// // Создаем правила интеграции и добавляем в массив +// ПравилаИнтеграции = НачатьАвтоматическуюНастройкуИнтеграцииЗаявкаНаОперацию(); +// КонецЕсли; +// +Процедура ПриСозданииПравилИнтеграцииАвтоматически(Знач ИмяТипаОбъекта, ПравилаИнтеграции) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьВызовСервераПереопределяемый.ПриСозданииПравилИнтеграцииАвтоматически(ИмяТипаОбъекта, ПравилаИнтеграции) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.md new file mode 100644 index 0000000..9a79af1 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.md @@ -0,0 +1,2004 @@ +--- +title: Интеграция с 1С документооборот базовая функциональность клиент +slug: zup/интеграция-с-1с-документооборот-базовая-функциональность-клиент +--- + + +## АвторизацияПредложена +
+ +Описание, пример вызова + +```bsl + +// Возвращает сохраненный ранее признак состоявшегося показа окна авторизации. +// +// Возвращаемое значение: +// Булево - Истина, если авторизация была предложена в этом сеансе, и Ложь в противном случае. +// +Функция АвторизацияПредложена() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.АвторизацияПредложена() +``` +
+ +## ВыбратьЗначениеДополнительногоРеквизита +
+ +Описание, пример вызова + +```bsl + +// Открывает форму для указания значения дополнительного реквизита. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, на которой осуществляется работа с дополнительным реквизитом +// и из которой вызывается форма заполнения. +// Элемент - ПолеФормы - элемент формы, в который будет помещено указанной значение. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// +Процедура ВыбратьЗначениеДополнительногоРеквизита(Форма, Элемент, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыбратьЗначениеДополнительногоРеквизита(Форма, Элемент, СтандартнаяОбработка) +``` +
+ +## ВыбратьЗначениеРеквизитаДО +
+ +Описание, пример вызова + +```bsl + +// Универсальный метод для выбора произвольного значения в поле ввода. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызывается команда. +// Элемент - ПолеФормы - поле, куда должно быть помещено выбранное значение. +// Типы - СписокЗначений из Тип - тип значения, которое требуется выбрать. +// - Массив из Тип +// Представление - Строка - представление реквизита, для которого выбирается значение. +// ЗначениеРеквизита - Строка - текущее значение в поле ввода. +// ЗначениеРеквизитаID - Строка - текущее значение в поле ввода. +// ЗначениеРеквизитаТип - Строка - текущее значение в поле ввода. +// Оповещение - ОписаниеОповещения - вызывает процедуру формы, в которую передается выбранное значение. +// +Процедура ВыбратьЗначениеРеквизитаДО(Форма, Элемент, Типы, Представление, ЗначениеРеквизита, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыбратьЗначениеРеквизитаДО(Форма, Элемент, Типы, Представление, ЗначениеРеквизита, ); +``` +
+ +## ВыбратьЗначениеРеквизитаИС +
+ +Описание, пример вызова + +```bsl + +// Универсальный метод для выбора произвольного значения в поле ввода. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызывается команда. +// Элемент - ПолеФормы - поле, куда должно быть помещено выбранное значение. +// Тип - ОписаниеТипов - тип значения, которое требуется выбрать. +// Представление - Строка - представление реквизита, для которого выбирается значение. +// ЗначениеРеквизита - Произвольный - текущее значение в поле ввода. +// Оповещение - ОписаниеОповещения - вызывает процедуру формы, в которую передается выбранное значение. +// +Процедура ВыбратьЗначениеРеквизитаИС(Форма, Элемент, Тип, Представление, ЗначениеРеквизита, Оповещение) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыбратьЗначениеРеквизитаИС(Форма, Элемент, Тип, Представление, ЗначениеРеквизита, Оповещение) +``` +
+ +## ВыполнитьЗапросАсинхронно +
+ +Описание, пример вызова + +```bsl + +// Начинает длительную операцию запроса к сервису 1С:Документооборот, а также отображает на форме признак выполнения +// длительной операции. +// +// Параметры: +// Владелец - ФормаКлиентскогоПриложения - форма, из которой вызывается команда. +// - ОбщийМодуль - клиентский модуль, из которого вызывается команда. +// ДлительнаяОперация - см. ДлительныеОперации.ВыполнитьВФоне +// ОповещениеОЗавершении - ОписаниеОповещения - вызывает процедуру формы, в которую передается результат запроса. +// ВыводитьОкноОжидания - Булево - если Истина, то открыть окно ожидания с визуальной индикацией длительной операции. +// ТекстСообщения - Строка - текст сообщения, выводимый на форме ожидания. +// СкрыватьИнтерфейс - Булево - если окно ожидания не выводится, то данный параметр указывает нужно ли использовать +// переключение страниц, который скроет весь интерфейс, либо же нужно не скрывать интерфейс, а сделать видимой +// группу элементов длительной операции. +// +Процедура ВыполнитьЗапросАсинхронно(Владелец, ДлительнаяОперация, ОповещениеОЗавершении, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыполнитьЗапросАсинхронно(Владелец, ДлительнаяОперация, ОповещениеОЗавершении, ); +``` +
+ +## ВыполнитьКомандуПечати +
+ +Описание, пример вызова + +```bsl + +// Формирует и выводит на экран печатные формы. +// +// Параметры: +// ИмяМенеджераПечати - Строка - менеджер печати для печатаемых объектов; +// ИменаМакетов - Строка - идентификаторы печатных форм; +// МассивОбъектов - ЛюбаяСсылка +// - Массив из ЛюбаяСсылка - объекты печати; +// ВладелецФормы - ФормаКлиентскогоПриложения - форма, из которой выполняется печать; +// +Процедура ВыполнитьКомандуПечати(ИмяМенеджераПечати, ИменаМакетов, МассивОбъектов, ВладелецФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыполнитьКомандуПечати(ИмяМенеджераПечати, ИменаМакетов, МассивОбъектов, ВладелецФормы) +``` +
+ +## ВыполнитьПодключаемуюКомандуИнтеграции +
+ +Описание, пример вызова + +```bsl + +// Выполняет подключаемую команду интеграции с 1С:Документооборотом из формы объекта или списка. +// +// Параметры: +// Команда - КомандаФормы - вызванная команда. +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызывается команда. +// Источник - ДанныеФормыСтруктура, ДанныеФормыКоллекция - данные, уточняющие параметр команды. +// +Процедура ВыполнитьПодключаемуюКомандуИнтеграции(Команда, Форма, Источник) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыполнитьПодключаемуюКомандуИнтеграции(Команда, Форма, Источник) +``` +
+ +## ВыполнитьПодключаемуюКомандуИнтеграцииЗавершение +
+ +Описание, пример вызова + +```bsl + +// Продолжает выполнение подключаемой команды интеграции после проверки подключения. +// +// Параметры: +// Результат - Булево - Истина, если подключение успешно. +// Параметры - Структура: +// * Команда - КомандаФормы - вызванная команда. +// * Форма - ФормаКлиентскогоПриложения - форма, из которой вызывается команда. +// * Источник - ДанныеФормыСтруктура: +// ** Ссылка - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый +// - ДанныеФормыКоллекция +// +Процедура ВыполнитьПодключаемуюКомандуИнтеграцииЗавершение(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыполнитьПодключаемуюКомандуИнтеграцииЗавершение(Результат, Параметры) +``` +
+ +## ВыполнитьПроверкуЗаписиИПродолжить +
+ +Описание, пример вызова + +```bsl + +// Проверяет записан ли объект интегрированной системы. Если не записан - предлагает пользователю записать. +// +// Параметры: +// СсылкаНаОбъектИС - ЛюбаяСсылка - проверяемый объект ИС. +// ФормаОбъектаИС - ФормаКлиентскогоПриложения - форма, из которой вызвана команда. +// ОповещениеПродолжения - ОписаниеОповещения - действие, вызываемое после проверки. +// Действие - Строка - наименование действия. +// +Процедура ВыполнитьПроверкуЗаписиИПродолжить(СсылкаНаОбъектИС, ФормаОбъектаИС, ОповещениеПродолжения, Действие) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыполнитьПроверкуЗаписиИПродолжить(СсылкаНаОбъектИС, ФормаОбъектаИС, ОповещениеПродолжения, Действие) +``` +
+ +## ЕстьПодсистемаДО2 +
+ +Описание, пример вызова + +```bsl + +// Определяет, встроены ли в конфигурации модули БИД, предназначенные для интеграции с 1С:Документооборотом редакции 2. +// +// Возвращаемое значение: +// Булево +// +Функция ЕстьПодсистемаДО2() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ЕстьПодсистемаДО2() +``` +
+ +## ЕстьПодсистемаДО3 +
+ +Описание, пример вызова + +```bsl + +// Определяет, встроены ли в конфигурации модули БИД, предназначенные для интеграции с 1С:Документооборотом редакции 3. +// +// Возвращаемое значение: +// Булево +// +Функция ЕстьПодсистемаДО3() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ЕстьПодсистемаДО3() +``` +
+ +## ЗаписатьОбъектАсинхронно +
+ +Описание, пример вызова + +```bsl + +// Записывает изменения объекта в Документообороте в фоновом задании. +// +// Параметры: +// УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор формы, из которой выполняется запрос. +// ОбъектСтрока - Строка - строковое предствление объекта XDTO с сохраняемыми данными. +// ОповещениеОЗавершении - ОписаниеОповещения - вызывает процедуру формы после записи объекта. +// +Процедура ЗаписатьОбъектАсинхронно(УникальныйИдентификатор, ОбъектСтрока, ОповещениеОЗавершении) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ЗаписатьОбъектАсинхронно(УникальныйИдентификатор, ОбъектСтрока, ОповещениеОЗавершении) +``` +
+ +## НачатьПоискСвязанногоОбъектаДО +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск связанного объекта ДО, при необходимости создавая его на основании объекта ИС +// с заполнением по правилам интеграции, если подходящее правило существует. +// +// Параметры: +// ОбъектИС - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС, +// для которого разыскивается связанный объект ДО. +// ОписаниеОповещения - ОписаниеОповещения - обработчик, вызываемый после создания с +// передачей в качестве параметра Структуры (ID, type, name). +// ПолучатьНДПС - Булево - требуется получить настройки доступности по состоянию на стороне Документооборота. +// ИспользоватьПриоритетныеПравила - Булево - нужно ли задавать вопрос пользователю при создании нового объекта ДО +// по правилам интеграции, в случае если для объекта ИС настроено несколько различных правил интеграции, +// или нужно использовать наиболее приоритетное по ключевым реквизитам правило. Параметр используется только в +// случае интеграции с ДО 3. +// +Процедура НачатьПоискСвязанногоОбъектаДО(ОбъектИС, ОписаниеОповещения, ПолучатьНДПС = Ложь, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.НачатьПоискСвязанногоОбъектаДО(ОбъектИС, ОписаниеОповещения, ПолучатьНДПС, ); +``` +
+ +## ОбработкаВыбораДанныхДляАвтоПодбора +
+ +Описание, пример вызова + +```bsl + +// Заполняет реквизиты формы по выбранному значению. +// +// Параметры: +// Реквизит - Строка - строка с именем реквизита формы. +// ВыбранноеЗначение - Строка, Структура - выбранное значение. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, содержащая заполняемый реквизит. +// ЭтоТаблица - Булево - признак, указывающий на то что заполнить требуется реквизит строки табличной части. +// Элемент - ПолеФормы - поле табличной части, в которое пользователь вводит значение. +// УстанавливатьМодифицированность - Булево - устанавливать модифицированность формы-владельца. +// +Процедура ОбработкаВыбораДанныхДляАвтоПодбора(Реквизит, ВыбранноеЗначение, СтандартнаяОбработка, ФормаВладелец, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОбработкаВыбораДанныхДляАвтоПодбора(Реквизит, ВыбранноеЗначение, СтандартнаяОбработка, ФормаВладелец, ); +``` +
+ +## ОперацияВыполнена +
+ +Описание, пример вызова + +```bsl + +// Проверяет выполнена ли длительная операция. +// +// Параметры: +// Результат - см. ДлительныеОперации.ОперацияВыполнена +// НужноОбработатьФорму - Булево - неявно возвращаемое значение, Истина, в случае если требуется обработать форму. +// ВыводитьПодробноеПредставлениеОшибки - Булево - в случае ошибки требуется вызвать +// исключение с подробным представлением. +// +// Возвращаемое значение: +// Булево - Истина, если длительная операция выполнена, Ложь, если операция еще выполняется или возникла ошибка. +// +Функция ОперацияВыполнена(Результат, НужноОбработатьФорму = Ложь, ВыводитьПодробноеПредставлениеОшибки = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОперацияВыполнена(Результат, НужноОбработатьФорму, ВыводитьПодробноеПредставлениеОшибки); +``` +
+ +## Оповестить_ДобавлениеСвязи +
+ +Описание, пример вызова + +```bsl + +// Создает оповещение при добавлении связи на клиенте. +// +// Параметры: +// ID - Строка - идентификатор объекта Документооборота. +// Тип - Строка - тип XDTO объекта Документооборота. +// СсылкаНаОбъект - ЛюбаяСсылка - ссылка на объект системы. +// +Процедура Оповестить_ДобавлениеСвязи(ID, Тип, СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.Оповестить_ДобавлениеСвязи(ID, Тип, СсылкаНаОбъект) +``` +
+ +## Оповестить_УдалениеСвязи +
+ +Описание, пример вызова + +```bsl + +// Создает оповещение при удалении связи на клиенте. +// +// Параметры: +// ID - Строка - идентификатор объекта Документооборота. +// Тип - Строка - тип XDTO объекта Документооборота. +// СсылкаНаОбъект - ЛюбаяСсылка - ссылка на объект системы. +// +Процедура Оповестить_УдалениеСвязи(ID, Тип, СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.Оповестить_УдалениеСвязи(ID, Тип, СсылкаНаОбъект) +``` +
+ +## ОтборПриВыбореСвязанногоОбъекта +
+ +Описание, пример вызова + +```bsl + +// Устанавливает отбор при выборе объекта ДО, связанного с объектом ИС. +// +// Параметры: +// СвязываемыйОбъект - ЛюбаяСсылка - объект ИС, связываемый с объектом ДО. +// ТипОбъектаДокументооборота - Строка - тип выбираемого объекта ДО. +// ВидДокументаДО - Структура - заполняется для объектов ДО типа Документ: +// * Значение - Строка - наименование вида документа. +// * ЗначениеID - Строка - идентификатор вида документа. +// +// Возвращаемое значение: +// Неопределено, Структура - структура отбора, накладываемого перед предъявлением пользователю: +// * documentType - Неопределено +// - Структура - заполняется для объектов ДО типа Документ: +// ** Значение - Строка - наименование вида документа. +// ** ЗначениеID - Строка - идентификатор вида документа. +// +Функция ОтборПриВыбореСвязанногоОбъекта(СвязываемыйОбъект, ТипОбъектаДокументооборота, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОтборПриВыбореСвязанногоОбъекта(СвязываемыйОбъект, ТипОбъектаДокументооборота, ); +``` +
+ +## ОткрытьЗадачиМне +
+ +Описание, пример вызова + +```bsl + +// Открывает нужную версию формы "Задачи мне", в зависимости от того какая редакция 1С:Документооборот используется. +// +// Параметры: +// Владелец - ОкноКлиентскогоПриложения , ФормаКлиентскогоПриложения - форма или элемент управления другой формы. +// Уникальность - Произвольный - ключ, значение которого будет использоваться для поиска уже открытых форм. +// Окно - ОкноКлиентскогоПриложения - окно приложения, в котором будет открыта форма. +// +Процедура ОткрытьЗадачиМне(Владелец, Уникальность, Окно) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОткрытьЗадачиМне(Владелец, Уникальность, Окно) +``` +
+ +## ОткрытьОбъект +
+ +Описание, пример вызова + +```bsl + +// Открывает объект Документооборота. +// +// Параметры: +// ТипОбъекта - Строка - тип объекта XDTO Документооборота. +// ID - Строка - идентификатор объекта Документооборота. +// ВладелецФормы - Произвольный - произвольное значение, устанавливаемое в качестве владельца формы. +// ДополнительныеПараметры - Структура - параметры, передаваемые в открываемый объект. +// Оповещение - ОписаниеОповещения - оповещение при закрытии формы. +// +Процедура ОткрытьОбъект(ТипОбъекта, ID, ВладелецФормы = Неопределено, ДополнительныеПараметры = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОткрытьОбъект(ТипОбъекта, ID, ВладелецФормы, ДополнительныеПараметры, ); +``` +
+ +## ПередВыполнениемКоманды +
+ +Описание, пример вызова + +```bsl + +// Проверяет необходимость добавить связь, в случае если объект ИС был создан на основании объекта ДО. +// +// Параметры: +// Источник - ФормаКлиентскогоПриложения - форма нового объекта ИС. +// +Процедура ПередВыполнениемКоманды(Источник) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПередВыполнениемКоманды(Источник) +``` +
+ +## ПоказатьВопросДаНет +
+ +Описание, пример вызова + +```bsl + +// Показывает вопрос "Да" / "Нет", принимая Esc и закрытие формы крестиком как ответ "Нет". +// +// Параметры: +// ОписаниеОповещенияОЗавершении - ОписаниеОповещения - процедура, вызываемая после закрытия с +// передачей параметра КодВозвратаДиалога.Да или КодВозвратаДиалога.Нет. +// ТекстВопроса - Строка - текст задаваемого вопроса. +// ТекстКнопкиДа - Строка - необязательный, текст кнопки "Да". +// ТекстКнопкиНет - Строка - необязательный, текст кнопки "Нет". +// КнопкаПоУмолчанию - РежимДиалогаВопрос - необязательный, кнопка по умолчанию. +// Заголовок - Строка - необязательный, содержит заголовок окна вопроса. +// +Процедура ПоказатьВопросДаНет(ОписаниеОповещенияОЗавершении, ТекстВопроса, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПоказатьВопросДаНет(ОписаниеОповещенияОЗавершении, ТекстВопроса, ); +``` +
+ +## ПоказатьВопросДаНетЗавершение +
+ +Описание, пример вызова + +```bsl + +// Вызывается после закрытия окна с вопросом "Да" / "Нет" и вызывает ранее переданный обработчик +// оповещения с передачей ответа пользователя. +// +// Параметры: +// Результат - КодВозвратаДиалога - ответ пользователя, +// КодВозвратаДиалога.ОК или КодВозвратаДиалога.Отмена. +// ОписаниеОповещения - ОписаниеОповещения - описание вызываемого оповещения. +// +Процедура ПоказатьВопросДаНетЗавершение(Результат, ОписаниеОповещения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПоказатьВопросДаНетЗавершение(Результат, ОписаниеОповещения) +``` +
+ +## ПриАвторизации +
+ +Описание, пример вызова + +```bsl + +// Управляет активностью обработчика обновления токена доступа в ДО. +// +// Параметры: +// ИспользуетсяАутентификацияJWT - Булево - текущий пользователь использует авторизацию через JWT-токен. +// +Процедура ПриАвторизации(ИспользуетсяАутентификацияJWT) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПриАвторизации(ИспользуетсяАутентификацияJWT) +``` +
+ +## ПроверитьОшибкиПриОбновленииФормы +
+ +Описание, пример вызова + +```bsl + +// Проверяет результат выполнения длительной операции на наличие ошибок, и, при необходимости, переключает +// интерфейс формы на страницу ошибки при обновлении. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой выполняется обновление. +// Результат - см. ДлительныеОперации.ОперацияВыполнена +// НужноОбработатьФорму - Булево - неявно возвращаемое значение, Истина, в случае если требуется обработать форму. +// +Процедура ПроверитьОшибкиПриОбновленииФормы(Форма, Результат, НужноОбработатьФорму = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПроверитьОшибкиПриОбновленииФормы(Форма, Результат, НужноОбработатьФорму); +``` +
+ +## ПроверитьПодключение +
+ +Описание, пример вызова + +```bsl + +// Проверяет подключение к 1С:Документообороту, при необходимости запрашивая имя пользователя и пароль. +// +// Параметры: +// +// ОписаниеОповещения - ОписаниеОповещения - описание оповещения, вызываемого после проверки подключения с параметром +// типа Булево. +// Владелец - ФормаКлиентскогоПриложения - форма, в которой следует вызвать повторную попытку подключения. +// - ОбщийМодуль - клиентский модуль, из которого вызывается команда. +// ПовторноПоказыватьОкноАвторизации - Булево - Истина, если при отсутствии подключения необходимо +// повторно показать окно авторизации, даже если оно было показано ранее. +// ВыводитьОкноОжидания - Булево - если Истина, то открыть окно ожидания с визуальной индикацией длительной операции. +// СкрыватьИнтерфейс - Булево - если окно ожидания не выводится, то данный параметр указывает нужно ли использовать +// переключение страниц, который скроет весь интерфейс, либо же нужно не скрывать интерфейс, а сделать видимой +// группу элементов длительной операции. +// +Процедура ПроверитьПодключение(ОписаниеОповещения, Владелец, ПовторноПоказыватьОкноАвторизации = Ложь, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПроверитьПодключение(ОписаниеОповещения, Владелец, ПовторноПоказыватьОкноАвторизации, ); +``` +
+ +## ПроверитьПодключениеПослеОкнаАвторизации +
+ +Описание, пример вызова + +```bsl + +// Вызывается после закрытия окна авторизации. Вызывает обработчик, переданный вызвавшей формой. +// +// Параметры: +// Результат - Булево - Истина, если в окне авторизации нажата ОК и подключение успешно. +// Параметры - Структура: +// ОписаниеОповещения - ОписаниеОповещения - обработчик вызвавшей формы. +// +Процедура ПроверитьПодключениеПослеОкнаАвторизации(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПроверитьПодключениеПослеОкнаАвторизации(Результат, Параметры) +``` +
+ +## ПрочитатьНастройкиАвторизации +
+ +Описание, пример вызова + +```bsl + +// Получает имя пользователя и пароль для доступа к 1С:Документообороту. +// В веб-клиенте возвращается только имя пользователя. Только имя пользователя возвращается и +// тогда, когда в предыдущий раз настройки были сохранены в веб-клиенте или на другом компьютере. +// +// Параметры: +// ИмяПользователя - Строка - имя пользователя ДО. +// ПарольСохранен - Булево - Истина, если пароль сохранен пользователем. +// Пароль - Строка - пароль пользователя ДО. +// ИспользуетсяАутентификацияОС - Булево - Истина, если используется аутентификация ОС. +// ИспользуетсяАутентификацияJWT - Булево - Истина, если используется аутентификация JWT. +// +Процедура ПрочитатьНастройкиАвторизации(ИмяПользователя, ПарольСохранен, Пароль, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПрочитатьНастройкиАвторизации(ИмяПользователя, ПарольСохранен, Пароль, ); +``` +
+ +## СоздатьИнтегрированныйОбъектИзДанныхЗаполнения +
+ +Описание, пример вызова + +```bsl + +// Создает объект ИС, заполняет его по переданным данным и устанавливает связь. +// +// Параметры: +// ДанныеЗаполнения - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьВызовСервера.ДанныеЗаполненияИнтегрируемогоОбъекта +// Форма - ФормаКлиентскогоПриложения - форма объекта ДО или иная форма, требующая оповещения. +// +Процедура СоздатьИнтегрированныйОбъектИзДанныхЗаполнения(ДанныеЗаполнения, Форма = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СоздатьИнтегрированныйОбъектИзДанныхЗаполнения(ДанныеЗаполнения, Форма); +``` +
+ +## СохранитьАвторизацияПредложена +
+ +Описание, пример вызова + +```bsl + +// Запоминает факт показа окна авторизации, чтобы больше не беспокоить пользователя в пределах сеанса. +// +Процедура СохранитьАвторизацияПредложена() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СохранитьАвторизацияПредложена() +``` +
+ +## СохранитьНастройкиАвторизации +
+ +Описание, пример вызова + +```bsl + +// Сохраняет имя пользователя и пароль для доступа к 1С:Документообороту. +// В веб-клиенте сохраняется только имя пользователя. +// +// Параметры: +// ИмяПользователя - Строка - имя пользователя ДО. +// Пароль - Строка - необязательный, пароль пользователя ДО. +// ИспользуетсяАутентификацияОС - Булево - Истина, если используется аутентификация операционной системы. +// ИспользуетсяАутентификацияJWT - Булево - Истина, если используется аутентификация через JWT-токены. +// +Процедура СохранитьНастройкиАвторизации(ИмяПользователя, Пароль = "", ИспользуетсяАутентификацияОС = Ложь, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СохранитьНастройкиАвторизации(ИмяПользователя, Пароль, ИспользуетсяАутентификацияОС, ); +``` +
+ +## ТипОбъектаИСНачалоВыбора +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора объекта метаданных интегрированной системы. +// +// Параметры: +// ТипОбъектаИС - Строка - текущий тип объекта метаданных интегрированной системы. +// ОписаниеОповещения - ОписаниеОповещения - описание вызываемого оповещения. +// +Процедура ТипОбъектаИСНачалоВыбора(ТипОбъектаИС, ОписаниеОповещения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ТипОбъектаИСНачалоВыбора(ТипОбъектаИС, ОписаниеОповещения) +``` +
+ +## УстановитьЗаголовокПриОткрытии +
+ +Описание, пример вызова + +```bsl + +// Вызывается при открытии форм связанных данных ДО и устанавливает заголовок согласно владельцу. +// +// Параметры: +// Форма - РасширениеФормыКлиентскогоПриложенияДляОбъектов - форма, заголовок которой следует уточнить из владельца: +// * Заголовок - Строка +// * ВладелецФормы - ФормаКлиентскогоПриложения: +// ** Заголовок - Строка +// +Процедура УстановитьЗаголовокПриОткрытии(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.УстановитьЗаголовокПриОткрытии(Форма) +``` +
+ +## ХранилищеОбщихНастроекСохранитьМассив +
+ +Описание, пример вызова + +```bsl + +// Сохраняет массив пользовательских настроек МассивСтруктур. Может применяться для случаев вызова с клиента. +// +// Параметры: +// МассивСтруктур - Массив из Структура: +// * Объект - Строка +// * Настройка - Строка +// * Автообновление - Булево +// НужноОбновитьПовторноИспользуемыеЗначения - Булево - требуется обновить повторно используемые значения +// +Процедура ХранилищеОбщихНастроекСохранитьМассив(МассивСтруктур, НужноОбновитьПовторноИспользуемыеЗначения = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ХранилищеОбщихНастроекСохранитьМассив(МассивСтруктур, НужноОбновитьПовторноИспользуемыеЗначения); +``` +
+ +## ВыделенныеФайлы +
+ +Описание, пример вызова + +```bsl + +// Возвращает выделенные в таблице файлы, игнорируя роли файлов. +// +// Параметры: +// КоллекцияФайлы - ДанныеФормыКоллекция - таблица или дерево файлов. +// ВыделенныеСтроки - Массив из Число - идентификаторы выделенных строк коллекции. +// +// Возвращаемое значение: +// Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла +// +Функция ВыделенныеФайлы(КоллекцияФайлы, ВыделенныеСтроки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыделенныеФайлы(КоллекцияФайлы, ВыделенныеСтроки) +``` +
+ +## ДобавитьФайлСДискаКОбъектуИС +
+ +Описание, пример вызова + +```bsl + +// Начинает добавление файла с диска к объекту ДО, связанному с указанным объектом ИС. +// +// Параметры: +// ВладелецФайла - ЛюбаяСсылка - источник команды, объект ИС - владелец файлов. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ДобавитьФайлСДискаКОбъектуИС(ВладелецФайла, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ДобавитьФайлСДискаКОбъектуИС(ВладелецФайла, УникальныйИдентификаторФормы) +``` +
+ +## ЗакончитьРедактированиеФайла +
+ +Описание, пример вызова + +```bsl + +// Заканчивает редактирование файла, помещая его в ДО и снимая захват, если необходимо. +// +// Параметры: +// ID - Строка - идентификатор файла ДО. +// Наименование - Строка - имя редактируемого файла. +// Расширение - Строка - расширение редактируемого файла. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// ОписаниеОповещенияОЗавершении - ОписаниеОповещения - необязательный, вызывается при успешном завершении. +// ВладелецID - Строка - идентификатор владельца файла. +// +Процедура ЗакончитьРедактированиеФайла(ID, Наименование, Расширение, УникальныйИдентификаторФормы, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ЗакончитьРедактированиеФайла(ID, Наименование, Расширение, УникальныйИдентификаторФормы, ); +``` +
+ +## ИзвлечьТекст +
+ +Описание, пример вызова + +```bsl + +// Извлекает текст из файла и возвращает его в виде строки. +// +// Параметры: +// ПолноеИмяФайла - Строка - полное имя файла. +// +// Возвращаемое значение: +// Строка - извлеченный текст. +// +Функция ИзвлечьТекст(ПолноеИмяФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ИзвлечьТекст(ПолноеИмяФайла) +``` +
+ +## ИндексПиктограммыФайла +
+ +Описание, пример вызова + +```bsl + +// Получается индекс пиктограммы файла - индекс в картинке КоллекцияПиктограммФайлов. +// +// Параметры: +// Расширение - Строка - расширение файла. +// ПометкаУдаления - Булево - файл помечен на удаление. +// +// Возвращаемое значение: +// Число +// +Функция ИндексПиктограммыФайла(Расширение, ПометкаУдаления = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ИндексПиктограммыФайла(Расширение, ПометкаУдаления); +``` +
+ +## ИнформироватьОбИзмененииФайла +
+ +Описание, пример вызова + +```bsl + +// По окончании подписания создает оповещение о подписании файла. +// +// Параметры: +// Событие - Строка - имя события, произошедшего с файлом. +// ИмяФайла - Строка - имя файла для вывода в сообщение. +// ИдентификаторФайла - Строка - идентификатор файла Документооборота. +// ВладелецФайла - Строка - идентификатор владельца файла. +// ТекстСообщения - Строка - текст состояния. +// ОповещатьКарточкуДокумента - Булево - требуется ли вызывать обработку оповещения в карточке документа. +// Например, если изменение произошло в карточке файла - вызвать оповещение в карточке документа нужно. +// Если, например, из самой карточки документа идет групповое подписание 10 файлов - дополнительно 10 раз +// вызывать оповещение в карточке документа не нужно. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ИнформироватьОбИзмененииФайла(Событие, ИмяФайла, ИдентификаторФайла, ВладелецФайла, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ИнформироватьОбИзмененииФайла(Событие, ИмяФайла, ИдентификаторФайла, ВладелецФайла, ); +``` +
+ +## ИспользоватьДОДляХраненияФайловОбъекта +
+ +Описание, пример вызова + +```bsl + +// Проверяет используется ли 1С:Документооборот для хранения файлов объекта. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма владельца файла. +// Команда - КомандаФормы - выполняемая команда управления присоединенными файлами. +// ВладелецПрисоединенныхФайлов - ЛюбаяСсылка - владелец присоединенных файлов. +// +// Возвращаемое значение: +// Булево +// +Функция ИспользоватьДОДляХраненияФайловОбъекта(Форма, Команда, ВладелецПрисоединенныхФайлов) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ИспользоватьДОДляХраненияФайловОбъекта(Форма, Команда, ВладелецПрисоединенныхФайлов) +``` +
+ +## НапечататьФайлы +
+ +Описание, пример вызова + +```bsl + +// Отправляет файлы на печать. +// +// Параметры: +// КоллекцияФайлы - ДанныеФормыКоллекция - таблица или дерево файлов. +// ВыделенныеСтроки - Массив из Число - идентификаторы выделенных строк коллекции. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура НапечататьФайлы(КоллекцияФайлы, ВыделенныеСтроки, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.НапечататьФайлы(КоллекцияФайлы, ВыделенныеСтроки, УникальныйИдентификаторФормы) +``` +
+ +## НачатьСохранениеВыделенныхФайлов +
+ +Описание, пример вызова + +```bsl + +// Начинает сохранение выделенных файлов. +// +// Параметры: +// КоллекцияФайлы - ДанныеФормыКоллекция - таблица файлов с колонками ID, Наименование, Расширение. +// ВыделенныеСтроки - Массив из Число - идентификаторы выделенных строк коллекции. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// ОписаниеОповещения - ОписаниеОповещения - необязательный, обработчик, вызываемый с передачей имени файла +// после его сохранения. +// +Процедура НачатьСохранениеВыделенныхФайлов(КоллекцияФайлы, ВыделенныеСтроки, УникальныйИдентификаторФормы, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.НачатьСохранениеВыделенныхФайлов(КоллекцияФайлы, ВыделенныеСтроки, УникальныйИдентификаторФормы, ); +``` +
+ +## ОбновитьИзФайлаНаДиске +
+ +Описание, пример вызова + +```bsl + +// Обновляет файл ДО из файла на диске. +// +// Параметры: +// ID - Строка - Идентификатор файла ДО. +// Наименование - Строка - имя редактируемого файла. +// Расширение - Строка - расширение редактируемого файла. +// ДатаМодификации - Дата - дата модификации редактируемого файла. Местное время. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// ОписаниеОповещенияОЗавершении - ОписаниеОповещения - необязательный, вызывается при успешном завершении. +// ВладелецID - Строка - идентификатор владельца файла. +// +Процедура ОбновитьИзФайлаНаДиске(ID, Наименование, Расширение, ДатаМодификации, УникальныйИдентификаторФормы, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОбновитьИзФайлаНаДиске(ID, Наименование, Расширение, ДатаМодификации, УникальныйИдентификаторФормы, ); +``` +
+ +## ОткрытьВерсиюФайла +
+ +Описание, пример вызова + +```bsl + +// Открывает версию файла для просмотра. +// +// Параметры: +// ID - Строка - идентификатор версии в ДО. +// Наименование - Строка - имя версии. +// Расширение - Строка - расширение версии. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ОткрытьВерсиюФайла(ID, Наименование, Расширение, УникальныйИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОткрытьВерсиюФайла(ID, Наименование, Расширение, УникальныйИдентификаторФормы) +``` +
+ +## ОткрытьКаталогФайла +
+ +Описание, пример вызова + +```bsl + +// Открывает каталог файла, в котором он сохранен на просмотр или редактирование. +// +// Параметры: +// ID - Строка - идентификатор файла в ДО. +// +Процедура ОткрытьКаталогФайла(ID) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОткрытьКаталогФайла(ID) +``` +
+ +## ОткрытьПрисоединенныеФайлы +
+ +Описание, пример вызова + +```bsl + +// Открывает список файлов, присоединенных к объекту ИС. +// +// Параметры: +// ВладелецФайла - ЛюбаяСсылка - источник команды, объект ИС - владелец файлов. +// ТекущийФайл - Строка - идентификатор текущего файла, на котором нужно спозиционировать список. +// ТолькоПросмотр - Булево - режим открытия формы. +// ВладелецФормы - ФормаКлиентскогоПриложения - форма, из которой вызвана команда. +// Уникальность - Произвольный - ключ уникальности, с которым должна быть открыта форма присоединенных файлов. +// Окно - ОкноКлиентскогоПриложения - необязательный параметр, окно формы-владельца. +// ПравилоИнтеграции - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом +// - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - подходящее правило интеграции. +// ВладелецФайлаID - Строка - идентификатор объекта ДО, являющегося владельцем файла. +// ВладелецФайлаТип - Строка - тип объекта ДО, являющегося владельцем файла. +// ПредставлениеВладельца - Строка - представление объекта ДО, являющегося владельцем файла. +// +Процедура ОткрытьПрисоединенныеФайлы(ВладелецФайла, ТекущийФайл = Неопределено, ТолькоПросмотр = Ложь, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОткрытьПрисоединенныеФайлы(ВладелецФайла, ТекущийФайл, ТолькоПросмотр, ); +``` +
+ +## ОткрытьФайл +
+ +Описание, пример вызова + +```bsl + +// Открывает файл для просмотра или редактирования. +// +// Параметры: +// ID - Строка - идентификатор файла в ДО. +// Наименование - Строка - имя файла. +// Расширение - Строка - расширение файла. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// НаЧтение - Булево - Истина, если файл открывается для чтения, и Ложь, если для редактирования. +// ОписаниеОповещенияОЗавершении - ОписаниеОповещения - вызывается при успешном открытии файла. +// ВладелецID - Строка - идентификатор владельца файла. +// +Процедура ОткрытьФайл(ID, Наименование, Расширение, УникальныйИдентификаторФормы, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОткрытьФайл(ID, Наименование, Расширение, УникальныйИдентификаторФормы, ); +``` +
+ +## ОтменитьРедактированиеФайла +
+ +Описание, пример вызова + +```bsl + +// Отменяет редактирование ранее захваченного файла. +// +// Параметры: +// ID - Строка - идентификатор файла в ДО. +// ОписаниеОповещенияОЗавершении - ОписаниеОповещения - необязательный параметр, описание оповещения, +// вызываемого после отмены. +// ВладелецID - Строка - идентификатор владельца файла. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ОтменитьРедактированиеФайла(ID, ОписаниеОповещенияОЗавершении = Неопределено, ВладелецID = "", Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОтменитьРедактированиеФайла(ID, ОписаниеОповещенияОЗавершении, ВладелецID, ); +``` +
+ +## ПометитьНаУдалениеСнятьПометкуФайлов +
+ +Описание, пример вызова + +```bsl + +// Изменяет пометку удаления файлов. +// +// Параметры: +// ВыделенныеФайлы - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла +// ТекущаяПометкаУдаления - Булево - текущее значение пометки удаления файлов, которую нужно +// изменить на противоположную. +// ОписаниеОповещенияОЗавершении - ОписаниеОповещения - необязательный параметр, описание оповещения, +// вызываемого после отмены. +// ВладелецID - Строка - идентификатор владельца файлов. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ПометитьНаУдалениеСнятьПометкуФайлов(ВыделенныеФайлы, ТекущаяПометкаУдаления, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПометитьНаУдалениеСнятьПометкуФайлов(ВыделенныеФайлы, ТекущаяПометкаУдаления, ); +``` +
+ +## ПроверитьНеобходимостьДобавленияСканКопииИПродолжить +
+ +Описание, пример вызова + +```bsl + +// Проверяет можно ли добавить только скан-копию и задает вопрос пользователю. +// +// Параметры: +// СостояниеРазрешаетДобавлениеСканКопии - Булево - можно добавить скан-копию. +// СостояниеРазрешаетДобавлениеФайла - Булево - можно добавить файл. +// ОповещениеПродолжение - ОписаниеОповещения - описание оповещения, вызываемого далее. +// +Процедура ПроверитьНеобходимостьДобавленияСканКопииИПродолжить(СостояниеРазрешаетДобавлениеСканКопии, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПроверитьНеобходимостьДобавленияСканКопииИПродолжить(СостояниеРазрешаетДобавлениеСканКопии, ); +``` +
+ +## РазложитьПолноеИмяФайла +
+ +Описание, пример вызова + +```bsl + +// Раскладывает полное имя файла на составляющие. +// +// Параметры: +// ПолноеИмяФайла - Строка - полный путь к файлу. +// ЭтоПапка - Булево - признак того, что требуется разложить полное имя папки, а не файла. +// +// Возвращаемое значение: +// см. ОбщегоНазначенияКлиентСервер.РазложитьПолноеИмяФайла +// +Функция РазложитьПолноеИмяФайла(Знач ПолноеИмяФайла, ЭтоПапка = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.РазложитьПолноеИмяФайла(ПолноеИмяФайла, ЭтоПапка); +``` +
+ +## СделатьВерсиюАктивной +
+ +Описание, пример вызова + +```bsl + +// Делает активной указанную версию файла. +// +// Параметры: +// ИмяФайла - Строка - имя файла-владельца версии. +// ИдентификаторФайла - Строка - идентификатор . +// ВладелецФайла - Строка - идентификатор владельца файла-владельца версии. +// ИдентификаторВерсии - Строка - идентификатор версии, которую следует сделать активной. +// ОписаниеОповещения - ОписаниеОповещения - описание оповещения, вызываемого при успешном изменении. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура СделатьВерсиюАктивной(ИмяФайла, ИдентификаторФайла, ВладелецФайла, ИдентификаторВерсии, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СделатьВерсиюАктивной(ИмяФайла, ИдентификаторФайла, ВладелецФайла, ИдентификаторВерсии, ); +``` +
+ +## СоздатьФайлКопированием +
+ +Описание, пример вызова + +```bsl + +// Создает файл копированием. +// +// Параметры: +// ОригиналID - Строка - идентификатор оригинала файла. +// ОписаниеОповещения - ОписаниеОповещения - описание оповещения, вызываемого при успешном создании файла. +// +Процедура СоздатьФайлКопированием(ОригиналID, ОписаниеОповещения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СоздатьФайлКопированием(ОригиналID, ОписаниеОповещения); +``` +
+ +## СоздатьФайлИзБуфера +
+ +Описание, пример вызова + +```bsl + +// Начало создания файла из картинки из буфера. +// +// Параметры: +// ВладелецID - Строка - идентификатор владельца файла в Документообороте. +// ВладелецТип - Строка - тип XDTO владельца файла в Документообороте. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// ВладелецПредставление - Строка - представление владельца файла. +// Владелец - ЛюбаяСсылка - владелец файла. +// ЯвляетсяСканКопией - Булево - признак скан-копии. +// РольФайлаID - Строка - роль файла. +// ОписаниеОповещения - ОписаниеОповещения - вызывается при успешном завершении. +// - Неопределено - вызывать ничего не нужно. +// +Процедура СоздатьФайлИзБуфера(ВладелецID, ВладелецТип, УникальныйИдентификаторФормы, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СоздатьФайлИзБуфера(ВладелецID, ВладелецТип, УникальныйИдентификаторФормы, ); +``` +
+ +## СоздатьФайлСДиска +
+ +Описание, пример вызова + +```bsl + +// Начало создания файла из файла на диске. +// +// Параметры: +// ВладелецID - Строка - идентификатор владельца файла в Документообороте. +// ВладелецТип - Строка - тип XDTO владельца файла в Документообороте. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// ВладелецПредставление - Строка - представление владельца файла. +// Владелец - ЛюбаяСсылка - владелец файла. +// ЯвляетсяСканКопией - Булево - признак скан-копии. +// РольФайлаID - Строка - роль файла. +// ОписаниеОповещения - ОписаниеОповещения - вызывается при успешном завершении. +// - Неопределено - вызывать ничего не нужно. +// +Процедура СоздатьФайлСДиска(ВладелецID, ВладелецТип, УникальныйИдентификаторФормы, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СоздатьФайлСДиска(ВладелецID, ВладелецТип, УникальныйИдентификаторФормы, ); +``` +
+ +## СоздатьФайлСДискаПеретаскиванием +
+ +Описание, пример вызова + +```bsl + +// Начало создания файла из файла на диске. +// +// Параметры: +// Файл - Файл - перетаскиваемый файл. +// ВладелецID - Строка - идентификатор владельца файла в Документообороте. +// ВладелецТип - Строка - тип XDTO владельца файла в Документообороте. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// ВладелецПредставление - Строка - представление владельца файла. +// Владелец - ЛюбаяСсылка - владелец файла. +// ЯвляетсяСканКопией - Булево - признак скан-копии. +// РольФайлаID - Строка - роль файла. +// ОписаниеОповещения - ОписаниеОповещения - вызывается при успешном завершении. +// - Неопределено - вызывать ничего не нужно. +// +Процедура СоздатьФайлСДискаПеретаскиванием(Файл, ВладелецID, ВладелецТип, УникальныйИдентификаторФормы, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СоздатьФайлСДискаПеретаскиванием(Файл, ВладелецID, ВладелецТип, УникальныйИдентификаторФормы, ); +``` +
+ +## СохранитьВерсиюКак +
+ +Описание, пример вызова + +```bsl + +// Сохраняет версию файла на диск в указанный пользователем каталог. +// +// Параметры: +// ID - Строка - идентификатор версии Документооборота. +// Наименование - Строка - имя версии файла. +// Расширение - Строка - расширение версии файла. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// ОписаниеОповещения - ОписаниеОповещения - необязательный, обработчик, вызываемый с передачей имени файла +// после его сохранения. +// +Процедура СохранитьВерсиюКак(ID, Наименование, Расширение, УникальныйИдентификаторФормы, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СохранитьВерсиюКак(ID, Наименование, Расширение, УникальныйИдентификаторФормы, ); +``` +
+ +## СохранитьИзмененияРедактируемогоФайла +
+ +Описание, пример вызова + +```bsl + +// Сохраняет изменения файла в ДО, не снимая захвата. +// +// Параметры: +// ID - Строка - Идентификатор файла ДО. +// Наименование - Строка - имя редактируемого файла. +// Расширение - Строка - расширение редактируемого файла. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// ОписаниеОповещенияОЗавершении - ОписаниеОповещения - необязательный, вызывается при успешном завершении. +// ВладелецID - Строка - идентификатор владельца файла. +// +Процедура СохранитьИзмененияРедактируемогоФайла(ID, Наименование, Расширение, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СохранитьИзмененияРедактируемогоФайла(ID, Наименование, Расширение, ); +``` +
+ +## СохранитьФайлКак +
+ +Описание, пример вызова + +```bsl + +// Сохраняет файл на диск в указанный пользователем каталог. +// +// Параметры: +// ID - Строка - идентификатор файла Документооборота. +// Наименование - Строка - имя файла. +// Расширение - Строка - расширение файла. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// ОписаниеОповещения - ОписаниеОповещения - необязательный, обработчик, вызываемый с передачей имени файла +// после его сохранения. +// +Процедура СохранитьФайлКак(ID, Наименование, Расширение, УникальныйИдентификаторФормы, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СохранитьФайлКак(ID, Наименование, Расширение, УникальныйИдентификаторФормы, ); +``` +
+ +## СохранитьФайлыКакНачало +
+ +Описание, пример вызова + +```bsl + +// Сохраняет файл или версию на диск в указанный пользователем каталог. Общая точка входа для файла и версии. +// +// Параметры: +// Параметры - Структура: +// * ТекущийФайл - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла +// * ОставшиесяФайлы - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла +// * УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// * ОписаниеОповещения - ОписаниеОповещения - вызывается при успешном завершении. +// - Неопределено - вызов не требуется. +// +Процедура СохранитьФайлыКакНачало(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СохранитьФайлыКакНачало(Параметры) +``` +
+ +## ВыделенныеПодписи +
+ +Описание, пример вызова + +```bsl + +// Получает таблицу значений выделенных строк подписей по выделенным срокам. +// +// Параметры: +// ВыделенныеСтроки - Массив из Число - массив индексов выделенных строк подписей. +// ТаблицаПодписей - ДанныеФормыКоллекция - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// ОбъектID - Строка - идентификатор объекта-владельца подписей. +// +// Возвращаемое значение: +// Массив из Структура: +// * НомерСтроки - Число +// * ОбъектID - Строка +// +Функция ВыделенныеПодписи(ВыделенныеСтроки, ТаблицаПодписей, ОбъектID = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыделенныеПодписи(ВыделенныеСтроки, ТаблицаПодписей, ОбъектID); +``` +
+ +## ДанныеПодписей +
+ +Описание, пример вызова + +```bsl + +// Преобразует таблицу подписей на форме в массив структурированных данных подписей. +// +// Параметры: +// ТаблицаПодписей - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// +// Возвращаемое значение: +// Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи +// +Функция ДанныеПодписей(ТаблицаПодписей) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ДанныеПодписей(ТаблицаПодписей) +``` +
+ +## ДанныеПодписи +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные, из которых будет формироваться XDTO объект DMSignature, для передачи в ДО. +// +// Параметры: +// Подпись - ДвоичныеДанные - двоичные данные подписи. +// ДвоичныеДанныеСертификата - ДвоичныеДанные - двоичные данные сертификата. +// СвойстваПодписи - Структура - тут может быть или структура СвойстваПодписи, которую возвращает БСП при +// добавлении новой подписи, или строка таблицы подписей, если это уже существующая на стороне ДО подпись. +// +// Возвращаемое значение: +// см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи +// +Функция ДанныеПодписи(Подпись, ДвоичныеДанныеСертификата, СвойстваПодписи) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ДанныеПодписи(Подпись, ДвоичныеДанныеСертификата, СвойстваПодписи) +``` +
+ +## ИнформироватьОПодписании +
+ +Описание, пример вызова + +```bsl + +// По окончании подписания отображает состояние установки подписи объекту. +// +// Параметры: +// Представление - Строка - представление подписанного объекта для информирования пользователя о подписании. +// ДобавленныеПодписиОбъектов - Соответствие из КлючИЗначение: +// * Ключ - Строка - идентификатор объекта ДО, являющегося владельцем подписи. +// * Значение - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеВладельцаПодписи +// ДокументID - Строка - идентификатор подписанного документа. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ИнформироватьОПодписании(Представление, ДобавленныеПодписиОбъектов, ДокументID, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ИнформироватьОПодписании(Представление, ДобавленныеПодписиОбъектов, ДокументID, ); +``` +
+ +## МассивПодписей +
+ +Описание, пример вызова + +```bsl + +// Преобразует 2-уровневое дерево в массив. +// +// Параметры: +// ДеревоПодписей - ДанныеФормыДерево - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// +// Возвращаемое значение: +// Массив из Число - идентификаторы строк подписей. +// +Функция МассивПодписей(ДеревоПодписей) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.МассивПодписей(ДеревоПодписей) +``` +
+ +## НачатьДобавлениеЭПИзФайла +
+ +Описание, пример вызова + +```bsl + +// Добавляет подпись из файла. +// +// Параметры: +// СвойстваФайла - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СвойстваФайла +// +Процедура НачатьДобавлениеЭПИзФайла(СвойстваФайла) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.НачатьДобавлениеЭПИзФайла(СвойстваФайла) +``` +
+ +## НачатьСохранениеВместеСЭП +
+ +Описание, пример вызова + +```bsl + +// Сохраняет файл и подпись на диск. +// +// Параметры: +// ID - Строка - идентификатор файла Документооборота. +// Расширение - Строка - расширение файла. +// Наименование - Строка - имя файла. +// Размер - Число - размер файла в байтах. +// ДатаМодификацииУниверсальная - Дата - дата модификации файла универсальная. +// УникальныйИдентификаторФормы - Строка - идентификатор вызвавшей формы. +// Подписи - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураПодписи +// +Процедура НачатьСохранениеВместеСЭП(ID, Расширение, Наименование, Размер, ДатаМодификацииУниверсальная, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.НачатьСохранениеВместеСЭП(ID, Расширение, Наименование, Размер, ДатаМодификацииУниверсальная, ); +``` +
+ +## НачатьФормированиеПодписиОбъекта +
+ +Описание, пример вызова + +```bsl + +// Формирует подпись для объекта Документооборот и всех его вложенных файлов. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения: +// * Наименование - Строка +// * Файлы - ДанныеФормыКоллекция +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения: +// * ДополнительныеПараметры - Структура: +// ** МассивАдресов - Массив из Строка +// ** МассивДанныхДляЗанесенияВБазу - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеВладельцаПодписи +// +Процедура НачатьФормированиеПодписиОбъекта(Форма, ОписаниеОповещенияОЗакрытии) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.НачатьФормированиеПодписиОбъекта(Форма, ОписаниеОповещенияОЗакрытии) +``` +
+ +## ОткрытьПодпись +
+ +Описание, пример вызова + +```bsl + +// Открывает форму просмотра подписи ЭП. +// +// Параметры: +// ТаблицаПодписейТекущиеДанные - ДанныеФормыЭлементКоллекции - строка текущей подписи. +// +Процедура ОткрытьПодпись(ТаблицаПодписейТекущиеДанные) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ОткрытьПодпись(ТаблицаПодписейТекущиеДанные) +``` +
+ +## ПодписатьФайл +
+ +Описание, пример вызова + +```bsl + +// Подписывает файл в Документообороте. +// +// Параметры: +// ИдентификаторФайла - Строка - идентификатор объекта Документооборота. +// ИмяФайла - Строка - имя файла. +// ВладелецФайла - Строка - идентификатор владельца файла. +// Редактируется - Булево - признак редактирования файла. +// Зашифрован - Булево - признак шифрования файла. +// ОписаниеФайла - Строка - описание файла. +// ДанныеПодписейФайла - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура ПодписатьФайл(ИдентификаторФайла, ИмяФайла, ВладелецФайла, Редактируется, Зашифрован, ОписаниеФайла, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПодписатьФайл(ИдентификаторФайла, ИмяФайла, ВладелецФайла, Редактируется, Зашифрован, ОписаниеФайла, ); +``` +
+ +## ПроверитьПодписи +
+ +Описание, пример вызова + +```bsl + +// Проверяет все выделенные подписи. +// +// Параметры: +// ТаблицаПодписей - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// ОписаниеОповещения - ОписаниеОповещения - необязательный, обработчик, вызываемый после проверки подписей. +// ВыделенныеПодписи - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыделенныеПодписи +// АдресСлепкаДокумента - Строка - адрес временного хранилища двоичных данных документа Документооборота. +// +Процедура ПроверитьПодписи(ТаблицаПодписей, УникальныйИдентификаторФормы, ОписаниеОповещения = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПроверитьПодписи(ТаблицаПодписей, УникальныйИдентификаторФормы, ОписаниеОповещения, ); +``` +
+ +## СохранитьПодпись +
+ +Описание, пример вызова + +```bsl + +// Сохраняет подпись на диск. +// +// Параметры: +// ТаблицаПодписейТекущиеДанные - ДанныеФормыЭлементКоллекции - строка текущей подписи. +// +Процедура СохранитьПодпись(ТаблицаПодписейТекущиеДанные) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.СохранитьПодпись(ТаблицаПодписейТекущиеДанные) +``` +
+ +## УдалитьПодписи +
+ +Описание, пример вызова + +```bsl + +// Удаляет подписи документа и его файлов. +// +// Параметры: +// УдаленныеСтроки - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыделенныеПодписи +// ТаблицаПодписей - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// ВладелецФайла - Строка - идентификатор общего владельца всех файлов, входящих в таблицу подписей. +// ОписаниеОповещения - ОписаниеОповещения - необязательный, обработчик, вызываемый после удаления подписей. +// УникальныйИдентификаторФормы - УникальныйИдентификатор - идентификатор вызвавшей формы. +// +Процедура УдалитьПодписи(УдаленныеСтроки, ТаблицаПодписей, ВладелецФайла, ОписаниеОповещения = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.УдалитьПодписи(УдаленныеСтроки, ТаблицаПодписей, ВладелецФайла, ОписаниеОповещения, ); +``` +
+ +## УстановитьКомпоненту +
+ +Описание, пример вызова + +```bsl + +// Устанавливает компоненту сканирования. +// +// Параметры: +// ОбработчикРезультата - ОписаниеОповещения +// +Процедура УстановитьКомпоненту(ОбработчикРезультата) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.УстановитьКомпоненту(ОбработчикРезультата) +``` +
+ +## НачатьУстановкуВнешнейКомпонентыПродолжение +
+ +Описание, пример вызова + +```bsl + +// Продолжение установки компоненты. +// +// Параметры: +// ПараметрыВыполнения - Структура: +// * ОбработчикРезультата - ОписаниеОповещения +// +Процедура НачатьУстановкуВнешнейКомпонентыПродолжение(ПараметрыВыполнения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.НачатьУстановкуВнешнейКомпонентыПродолжение(ПараметрыВыполнения) +``` +
+ +## НачатьПодключениеВнешнейКомпонентыПродолжение +
+ +Описание, пример вызова + +```bsl + +// Продолжение установки компоненты. +// +// Параметры: +// Подключена - Булево - компонента подключена. +// ПараметрыВыполнения - Структура: +// * ОбработчикРезультата - ОписаниеОповещения +// +Процедура НачатьПодключениеВнешнейКомпонентыПродолжение(Подключена, ПараметрыВыполнения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.НачатьПодключениеВнешнейКомпонентыПродолжение(Подключена, ПараметрыВыполнения) +``` +
+ +## ПроинициализироватьКомпоненту +
+ +Описание, пример вызова + +```bsl + +// Проинициализировать компоненту сканирования. +// +// Возвращаемое значение: +// Булево +// +Функция ПроинициализироватьКомпоненту() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПроинициализироватьКомпоненту() +``` +
+ +## ВерсияКомпоненты +
+ +Описание, пример вызова + +```bsl + +// Вернет версию компоненты сканирования. +// +// Возвращаемое значение: +// Строка +// +Функция ВерсияКомпоненты() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВерсияКомпоненты() +``` +
+ +## ПоказатьПолучениеОбъектовАдресацииРоли +
+ +Описание, пример вызова + +```bsl + +// Открывает формы получения объектов адресации роли. +// +// Параметры: +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - описание оповещения о закрытии. +// ИмяРоли - Строка - имя роли для получения объектов адресации. +// ТипРоли - Строка - тип роли для получения объектов адресации. +// IDРоли - Строка - идентификатор роли в Документообороте. +// ФормаВладелец - ФормаКлиентскогоПриложения - управляемая форма, на которой выбирается роль. +// +Процедура ПоказатьПолучениеОбъектовАдресацииРоли(ОписаниеОповещенияОЗакрытии, ИмяРоли, ТипРоли, IDРоли, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ПоказатьПолучениеОбъектовАдресацииРоли(ОписаниеОповещенияОЗакрытии, ИмяРоли, ТипРоли, IDРоли, ); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.md new file mode 100644 index 0000000..d94e877 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.md @@ -0,0 +1,284 @@ +--- +title: Интеграция с 1С документооборот базовая функциональность клиент переопределяемый +slug: zup/интеграция-с-1с-документооборот-базовая-функциональность-клиент-переопределяемый +--- + + +## ВыполнитьКомандуПечатиЛистаСогласования +
+ +Описание, пример вызова + +```bsl + +// Вызывается из форм согласуемых объектов. Предназначена для вывода листа согласования в случаях, +// когда добавление команды в подменю печати невозможно или нежелательно, а также для внедрения в конфигурации +// без подсистемы БСП УправлениеПечатью. +// +// Параметры: +// ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// ВладелецФормы - ФормаКлиентскогоПриложения - необязательный, форма-источник команды. +// +Процедура ВыполнитьКомандуПечатиЛистаСогласования(ПредметСогласования, ВладелецФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.ВыполнитьКомандуПечатиЛистаСогласования(ПредметСогласования, ВладелецФормы); +``` +
+ +## ВыполнитьПрограммноДобавленнуюКоманду +
+ +Описание, пример вызова + +```bsl + +// Вызывается из форм обработки, соответствующих процессам, документам и задачам ДО. Предназначена для обработки +// команд, добавленных программно при вызове процедуры ДополнительнаяОбработкаФормы<...> переопределяемого модуля. +// +// Параметры: +// Команда - КомандаФормы - вызванная пользователем команда. +// ЭтаФорма - ФормаКлиентскогоПриложения - форма обработки, откуда вызвана команда. +// +Процедура ВыполнитьПрограммноДобавленнуюКоманду(Команда, ЭтаФорма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.ВыполнитьПрограммноДобавленнуюКоманду(Команда, ЭтаФорма) +``` +
+ +## ОткрытьПанельАдминистрированияБИД +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед выполнением команды ОткрытьПанель обработки ПанельАдминистрированияБИД. +// Позволяет переопределить форму НастройкаИнтеграцииС1СДокументооборотом. +// +// Параметры: +// ПараметрыВыполненияКоманды - Произвольный - Параметры выполнения команды ОткрытьПанель. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная +// форма НастройкаИнтеграцииС1СДокументооборотом открыта не будет. +// +// Пример: +// СтандартнаяОбработка = Ложь; +// ОткрытьФорму( +// "Обработка.ПанельАдминистрированияБИД.Форма.НастройкаИнтеграцииС1СДокументооборотомПереопределяемый", +// Новый Структура, +// ПараметрыВыполненияКоманды.Источник, +// "Обработка.ПанельАдминистрированияБИД.Форма.НастройкаИнтеграцииС1СДокументооборотомПереопределяемый" +// + ?(ПараметрыВыполненияКоманды.Окно = Неопределено, ".ОтдельноеОкно", ""), +// ПараметрыВыполненияКоманды.Окно); +// +Процедура ОткрытьПанельАдминистрированияБИД(ПараметрыВыполненияКоманды, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.ОткрытьПанельАдминистрированияБИД(ПараметрыВыполненияКоманды, СтандартнаяОбработка) +``` +
+ +## ПередСозданиемБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед созданием бизнес-процесса и позволяет отказаться от запуска. +// +// Параметры: +// Предмет - ЛюбаяСсылка - ссылка на объект интегрируемой системы, или +// - Структура - описание объекта ДО, со свойствами: +// ID - Строка - идентификатор; +// type - Строка - тип; +// name - Строка - наименование предмета. +// Отказ - Булево - при установке в Истина процесс запущен не будет. +// +// Пример: +// Если ТипЗнч(Предмет) = Тип("ДокументСсылка._ДемоЗаказПокупателя") Тогда +// ТекстСообщения = ""; +// Если Не ПродажиВызовСервера.ЗаказЗаполненКорректно(Предмет, ТекстСообщения) Тогда +// Отказ = Истина; +// ПоказатьПредупреждение(, ТекстСообщения); +// КонецЕсли; +// КонецЕсли; +// +Процедура ПередСозданиемБизнесПроцесса(Предмет, Отказ) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.ПередСозданиемБизнесПроцесса(Предмет, Отказ) +``` +
+ +## ПриИзмененииСостоянияСогласования +
+ +Описание, пример вызова + +```bsl + +// Вызывается при изменении состояния согласования в ДО. Предназначен для изменения формы +// согласуемого объекта, если доработка самого модуля формы нежелательна. +// +// Параметры: +// ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// Источник - ФормаКлиентскогоПриложения - форма-источник вызова. +// Состояние - ПеречислениеСсылка.СостоянияСогласованияВДокументообороте. +// ВызовИзФормыОбъекта - Булево - Истина, если изменение состояния вызвано пользователем из формы объекта. +// +Процедура ПриИзмененииСостоянияСогласования(ПредметСогласования, Источник, Состояние, ВызовИзФормыОбъекта) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.ПриИзмененииСостоянияСогласования(ПредметСогласования, Источник, Состояние, ВызовИзФормыОбъекта) +``` +
+ +## ПриОпределенииПредложенияАвторизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает сохраненный ранее признак состоявшегося показа окна авторизации. +// +// Параметры: +// АвторизацияПредложена - Булево - неявно возвращаемое значение, +// Истина, если авторизация была предложена в этом сеансе, и Ложь в противном случае. +// +Процедура ПриОпределенииПредложенияАвторизации(АвторизацияПредложена) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.ПриОпределенииПредложенияАвторизации(АвторизацияПредложена) +``` +
+ +## ПриРазложенииПолногоИмениФайла +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить разложение полного имени файла на составляющие. +// +// Параметры: +// СтруктураИмениФайла - Структура: +// * ПолноеИмя - Строка - Содержит полный путь к файлу, т.е. полностью соответствует входному +// параметру ПолноеИмяФайла. +// * Путь - Строка - Содержит путь к каталогу, в котором лежит файл. +// * Имя - Строка - Содержит имя файла с расширением, без пути к файлу. +// * Расширение - Строка - Содержит расширение файла. +// * ИмяБезРасширения - Строка - Содержит имя файла без расширения и без пути к файлу. +// +Процедура ПриРазложенииПолногоИмениФайла(СтруктураИмениФайла) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.ПриРазложенииПолногоИмениФайла(СтруктураИмениФайла) +``` +
+ +## ПриСохраненииНастроекПользователя +
+ +Описание, пример вызова + +```bsl + +// Вызывается при сохранении массива пользовательских настроек МассивСтруктур. +// +// Параметры: +// МассивСтруктур - Массив - массив структур с полями "Объект", "Настройка", "Значение". +// НужноОбновитьПовторноИспользуемыеЗначения - Булево - требуется обновить повторно используемые значения. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная +// обработка вызываться не будет. +// +Процедура ПриСохраненииНастроекПользователя(МассивСтруктур, НужноОбновитьПовторноИспользуемыеЗначения, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.ПриСохраненииНастроекПользователя(МассивСтруктур, НужноОбновитьПовторноИспользуемыеЗначения, ); +``` +
+ +## ПриСохраненииПредложенияАвторизации +
+ +Описание, пример вызова + +```bsl + +// Запоминает факт показа окна авторизации, чтобы больше не беспокоить пользователя в пределах сеанса. +// +Процедура ПриСохраненииПредложенияАвторизации() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.ПриСохраненииПредложенияАвторизации() +``` +
+ +## ПриУстановкеОтбораПриВыбореСвязанногоОбъекта +
+ +Описание, пример вызова + +```bsl + +// Устанавливает отбор при выборе объекта ДО, связанного с объектом ИС. +// +// Параметры: +// СвязываемыйОбъект - ЛюбаяСсылка - объект ИС, связываемый с объектом ДО. +// ТипОбъектаДокументооборота - Строка - тип выбираемого объекта ДО. +// Отбор - Структура, Неопределено - неявно возвращаемое значение, отбор, накладываемый перед +// предъявлением пользователю. +// +// Пример: +// Если ТипЗнч(СвязываемыйОбъект) = Тип("СправочникСсылка.Контрагенты") +// И ТипОбъектаДокументооборота = "DMCorrespondent" Тогда +// ЗначенияРеквизитов = ОбщегоНазначенияУТВызовСервера.ЗначенияРеквизитовОбъекта( +// СвязываемыйОбъект, "Наименование, ИНН, КПП"); +// Если ЗначениеЗаполнено(ЗначенияРеквизитов.ИНН) Тогда +// Отбор = Новый Структура; +// Отбор.Вставить("inn", ЗначенияРеквизитов.ИНН); +// Отбор.Вставить("kpp", ЗначенияРеквизитов.КПП); +// ИначеЕсли ЗначениеЗаполнено(ЗначенияРеквизитов.Наименование) Тогда +// Отбор = Новый Структура; +// Отбор.Вставить("name", ЗначенияРеквизитов.Наименование); +// КонецЕсли; +// КонецЕсли; +// +Процедура ПриУстановкеОтбораПриВыбореСвязанногоОбъекта(СвязываемыйОбъект, ТипОбъектаДокументооборота, Отбор) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентПереопределяемый.ПриУстановкеОтбораПриВыбореСвязанногоОбъекта(СвязываемыйОбъект, ТипОбъектаДокументооборота, Отбор) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.md new file mode 100644 index 0000000..7ab1459 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.md @@ -0,0 +1,972 @@ +--- +title: Интеграция с 1С документооборот базовая функциональность клиент сервер +slug: zup/интеграция-с-1с-документооборот-базовая-функциональность-клиент-сервер +--- + + +## ДанныеПравилаИнтеграции +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей ключевые данные правила интеграции. +// +// Возвращаемое значение: +// Структура: +// * Ссылка - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом - правило. +// - Неопределено +// * ПредставлениеОбъектаДО - Строка - представление объекта ДО. +// * ПредставлениеОбъектаИС - Строка - представление объекта ИС. +// * ТипОбъектаДО - Строка - тип объекта ДО. +// * ТипОбъектаИС - Строка - тип объекта ИС. +// * ИдентификаторВидаДокумента - Строка - идентификатор вида документа ДО. +// * ТипВидаДокумента - Строка - тип вида документа ДО. +// +Функция ДанныеПравилаИнтеграции() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПравилаИнтеграции() +``` +
+ +## ДанныеРеквизита +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей реквизит объекта ДО. +// +// Возвращаемое значение: +// Структура: +// * Имя - Строка +// * Тип - Строка +// * Представление - Строка +// * ЭтоДополнительныйРеквизитДО - Булево +// * ДополнительныйРеквизитДОID - Строка +// * ДополнительныйРеквизитДОТип - Строка +// * ЭтоТаблица - Булево +// * Таблица - Строка +// +Функция ДанныеРеквизита() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеРеквизита() +``` +
+ +## ДанныеСсылочногоОбъектаДО +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру данных объекта 1С:Документооборот ссылочного типа. +// +// Параметры: +// ID - Строка - идентификатор объекта ДО. +// Тип - Строка - тип объекта XDTO. +// Наименование - Строка - имя объекта ДО. +// Представление - Строка - представление объекта ДО. +// НавигационнаяСсылка - Строка - навигационная ссылка на объект ДО. +// +// Возвращаемое значение: +// Структура - данные владельца подписей: +// * ID - Строка - идентификатор объекта ДО. +// * Тип - Строка - тип объекта XDTO. +// * Наименование - Строка - имя объекта ДО. +// * Представление - Строка - представление объекта ДО. +// * НавигационнаяСсылка - Строка - навигационная ссылка на объект ДО. +// +Функция ДанныеСсылочногоОбъектаДО(ID, Тип, Наименование = "", Представление = "", НавигационнаяСсылка = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО(ID, Тип, Наименование, Представление, НавигационнаяСсылка); +``` +
+ +## ДанныеФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру данных файла. +// +// Параметры: +// Наименование - Строка - имя объекта ДО. +// ID - Строка - идентификатор объекта ДО. +// Тип - Строка - тип объекта XDTO. +// Расширение - Строка - расширение файла. +// РольФайлаID - Строка - роль файла. +// +// Возвращаемое значение: +// Структура - данные владельца подписей: +// * Наименование - Строка - имя объекта ДО. +// * ID - Строка - идентификатор объекта ДО. +// * Тип - Строка - тип объекта XDTO. +// * Расширение - Строка - расширение файла. +// * РольФайлаID - Строка - роль файла. +// - Неопределено +// * СсылкаНаДвоичныеДанныеФайла - Строка - адрес данных файла во временном хранилище. +// * Описание - Строка - описание файла. +// * Размер - Число - размер файла. +// * ДатаМодификации - Дата - дата модификации файла. +// * ДатаМодификацииУниверсальная - Дата - дата модификации файла универсальная. +// * ИмяФайла - Строка - имя файла с расширением. +// * Текст - Строка - текст файла. +// +Функция ДанныеФайла(Наименование, ID, Тип, Расширение = "", РольФайлаID = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла(Наименование, ID, Тип, Расширение, РольФайлаID); +``` +
+ +## ИзвлечьТекстOpenDocument +
+ +Описание, пример вызова + +```bsl + +// Извлечь текст из файла OpenDocument и возвратить его в виде строки. +// +// Параметры: +// ПутьКФайлу - Строка - Полное имя файла. +// Отказ - Булево - Отказ. +// +// Возвращаемое значение: +// Строка - Извлеченный текст. +// +Функция ИзвлечьТекстOpenDocument(ПутьКФайлу, Отказ) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ИзвлечьТекстOpenDocument(ПутьКФайлу, Отказ) +``` +
+ +## ИзвлечьТекстИзТекстовогоФайла +
+ +Описание, пример вызова + +```bsl + +// Извлекает текст в соответствии с кодировкой. +// Если кодировка не задана - сама вычисляет кодировку. +// +// Параметры: +// ПолноеИмяФайла - Строка - Полное имя файла. +// Кодировка - Строка - Кодировка. +// Отказ - Булево - Отказ. +// +// Возвращаемое значение: +// Строка - Извлеченный текст. +// +Функция ИзвлечьТекстИзТекстовогоФайла(ПолноеИмяФайла, Кодировка, Отказ) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ИзвлечьТекстИзТекстовогоФайла(ПолноеИмяФайла, Кодировка, Отказ) +``` +
+ +## ИмяСРасширением +
+ +Описание, пример вызова + +```bsl + +// Получает имя с расширением (если расширение пусто - только имя). +// +// Параметры: +// ПолноеНаименование - Строка - полное наименование файла. +// Расширение - Строка - расширение файла. +// +// Возвращаемое значение: +// Строка - Имя с расширением. Если расширение пусто - только имя. +// +Функция ИмяСРасширением(ПолноеНаименование, Расширение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ИмяСРасширением(ПолноеНаименование, Расширение) +``` +
+ +## КраткоеПредставлениеРазмера +
+ +Описание, пример вызова + +```bsl + +// Возвращает строку с размером файла в кратком и удобном для чтения формате. +// +// Параметры: +// Размер - Число - размер файла в байтах. +// +// Возвращаемое значение: +// Строка - размер файла в виде 123.4 Кб +// +Функция КраткоеПредставлениеРазмера(Знач Размер) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.КраткоеПредставлениеРазмера(Размер) +``` +
+ +## НовыеПараметрыСозданияФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустые параметры создания файла для вызова +// ИнтеграцияС1СДокументооборотБазоваяФункциональностьВызовСервера.СоздатьФайлВДокументообороте. +// +// Параметры: +// ТекущийФайл - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла +// +// Возвращаемое значение: +// Структура: +// * ТекущийФайл - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла +// * АдресВременногоХранилищаФайла - Неопределено +// * Владелец - Неопределено +// * ЯвляетсяСканКопией - Булево +// * ШаблонID - Строка +// * ВнешнийОбъект - Структура: +// ** ID - Строка +// ** type - Строка +// ** name - Строка +// +Функция НовыеПараметрыСозданияФайла(ТекущийФайл) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.НовыеПараметрыСозданияФайла(ТекущийФайл) +``` +
+ +## ПредставлениеУчастникаЗадачи +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление участника задачи ДО. +// +// Параметры: +// Исполнитель - Строка - представление исполнителя. Роль или сотрудник. +// ОсновнойОбъектАдресации - Строка - представление основного объекта адресации. +// ДополнительныйОбъектАдресации - Строка - представление дополнительного объекта адресации. +// +// Возвращаемое значение: +// Строка +// +Функция ПредставлениеУчастникаЗадачи(Исполнитель, ОсновнойОбъектАдресации, ДополнительныйОбъектАдресации) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ПредставлениеУчастникаЗадачи(Исполнитель, ОсновнойОбъектАдресации, ДополнительныйОбъектАдресации) +``` +
+ +## РазмерВКб +
+ +Описание, пример вызова + +```bsl + +// Возвращает размер файла в килобайтах. +// +// Параметры: +// Размер - Число - размер файла в байтах. +// +// Возвращаемое значение: +// Число - размер файла в Кб. +// +Функция РазмерВКб(Знач Размер) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.РазмерВКб(Размер) +``` +
+ +## РазмерВМб +
+ +Описание, пример вызова + +```bsl + +// Возвращает размер файла в мегабайтах. +// +// Параметры: +// Размер - Число - размер файла в байтах. +// +// Возвращаемое значение: +// Число - размер файла в Мб. +// +Функция РазмерВМб(Знач Размер) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.РазмерВМб(Размер) +``` +
+ +## ПодробноеПредставлениеРазмера +
+ +Описание, пример вызова + +```bsl + +// Возвращает строку с размером файла в удобном для чтения формате с указанием количества байт. +// +// Параметры: +// Размер - Число - размер файла в байтах. +// +// Возвращаемое значение: +// Строка - размер файла в виде 123.4 Кб (123 456 байт) +// +Функция ПодробноеПредставлениеРазмера(Знач Размер) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ПодробноеПредставлениеРазмера(Размер) +``` +
+ +## ПолучитьСтрокуСРазмеромФайла +
+ +Описание, пример вызова + +```bsl + +// Получить строку с представлением размера файла - например для отображения в Состояние при передаче файла. +// +// Параметры: +// РазмерВМб - Число - Размер в Мб. +// +// Возвращаемое значение: +// Строка - размера файла. +// +Функция ПолучитьСтрокуСРазмеромФайла(Знач РазмерВМб) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ПолучитьСтрокуСРазмеромФайла(РазмерВМб) +``` +
+ +## РазмерФайлаПревышаетМаксимальноДопустимый +
+ +Описание, пример вызова + +```bsl + +// Сверяет размер файла с максимально допустимым размером, заданным в настройках интеграции. +// +// Параметры: +// МаксРазмерФайла - Число - максимально допустимый размер файла. +// Размер - Число - размер файла в байтах. +// ИмяФайла - Строка - наименование файла. +// ВызыватьИсключение - Булево - вызывать исключение если максимальный размер превышен. +// ТекстСообщения - Строка - неявно возвращаемое значение, текст сообщения пользователю. +// +// Возвращаемое значение: +// Булево - размер файла превышает максимально допустимый. +// +Функция РазмерФайлаПревышаетМаксимальноДопустимый(МаксРазмерФайла, Размер, ИмяФайла, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.РазмерФайлаПревышаетМаксимальноДопустимый(МаксРазмерФайла, Размер, ИмяФайла, ); +``` +
+ +## РазделитьПароль +
+ +Описание, пример вызова + +```bsl + +// Разделяет пароль на две независимые части для последующего восстановления функцией СобратьПароль. +// +// Параметры: +// Пароль - Строка - разделяемый пароль. +// +// Возвращаемое значение: +// Массив из Строка - массив из двух строк, содержащих шестнадцатиричное представление пароля. +// +Функция РазделитьПароль(Пароль) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.РазделитьПароль(Пароль) +``` +
+ +## РасширениеФайлаВСписке +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если файл с таким расширением находится в списке расширений. +// +// Параметры: +// СписокРасширений - Строка - Список расширений. +// РасширениеФайла - Строка - Расширение файла. +// +// Возвращаемое значение: +// Булево +// +Функция РасширениеФайлаВСписке(СписокРасширений, РасширениеФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.РасширениеФайлаВСписке(СписокРасширений, РасширениеФайла) +``` +
+ +## СвойстваФайла +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей свойства файла. +// +// Возвращаемое значение: +// Структура: +// * ИдентификаторФайла - Строка - идентификатор файла в 1С:Документооборот. +// - Неопределено +// * ИмяФайла - Строка - имя файла. +// - Неопределено +// * ОписаниеФайла - Строка - описание файла. +// - Неопределено +// * Редактируется - Булево - файл находится на редактировании. +// - Неопределено +// * Зашифрован - Булево - файл зашифрован. +// - Неопределено +// * ДанныеПодписейФайла - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи +// - Неопределено +// * УникальныйИдентификатор - УникальныйИдентификатор - идентификатор управляемой формы объекта. +// - Неопределено +// * ВладелецФайла - Строка - идентификатор владельца файла в 1С:Документооборот. +// - Неопределено +// +Функция СвойстваФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СвойстваФайла() +``` +
+ +## СервисДоступен +
+ +Описание, пример вызова + +```bsl + +// Определяет доступность сервиса ДО по номеру версии. +// +// Параметры: +// ВерсияСервиса - Строка - версия сервиса ДО. +// +// Возвращаемое значение: +// Булево +// +Функция СервисДоступен(ВерсияСервиса) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СервисДоступен(ВерсияСервиса) +``` +
+ +## СобратьПароль +
+ +Описание, пример вызова + +```bsl + +// Собирает пароль из двух частей, ранее разделенных функцией РазделитьПароль. +// В случае повреждения строк возвращает Неопределено. +// +// Параметры: +// РазделенныйПароль - Массив из Строка - две строки, содержащие разделенный пароль. +// +// Возвращаемое значение: +// Строка - собранный пароль или +// Неопределено - если строки повреждены. +// +Функция СобратьПароль(Знач РазделенныйПароль) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СобратьПароль(РазделенныйПароль) +``` +
+ +## СообщениеВПредпросмотр +
+ +Описание, пример вызова + +```bsl + +// Выводит сообщение в HTML представление, которое будет отображаться в области предпросмотра. +// +// Параметры: +// Сообщение - Строка - сообщение для области предпросмотра. +// ЗаголовокСообщенияВОбластиПредпросмотра - Строка - заголовок, содержащий настройки вывода сообщения. +// +// Возвращаемое значение: +// Строка - HTML представление сообщения. +// +Функция СообщениеВПредпросмотр(Сообщение, ЗаголовокСообщенияВОбластиПредпросмотра) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СообщениеВПредпросмотр(Сообщение, ЗаголовокСообщенияВОбластиПредпросмотра) +``` +
+ +## СтрокаСообщенияОНедопустимостиПодписанияЗашифрованногоФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает Строку сообщения о недопустимости подписания зашифрованного файла. +// +// Параметры: +// ФайлСсылка - ЛюбаяСсылка - Ссылка на файл. +// +// Возвращаемое значение: +// Строка +// +Функция СтрокаСообщенияОНедопустимостиПодписанияЗашифрованногоФайла(ФайлСсылка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтрокаСообщенияОНедопустимостиПодписанияЗашифрованногоФайла(ФайлСсылка); +``` +
+ +## ТипОперацииНадЗадачей +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей тип операции над задачей. +// +// Возвращаемое значение: +// Структура: +// * ВыполнитьДействиеЗадачи - Булево +// * ВзятьВРаботу - Булево +// * ОтменитьВзятиеВРаботу - Булево +// * Перенаправить - Булево +// * УстановитьФлаг - Булево +// * ВыполнитьПодключаемоеДействиеЗадачи - Булево +// * ВыполнитьДействиеЗадачиПоШаблону - Булево +// +Функция ТипОперацииНадЗадачей() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ТипОперацииНадЗадачей() +``` +
+ +## ЭтоРасширениеСканКопии +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданное значение расширением скан-копии. +// +// Параметры: +// Расширение - Строка - расширение файла. +// СписокРасширенийСканКопийОригиналов - Строка - список расширений скан-копий. +// +// Возвращаемое значение: +// Булево - Истина, если переданное значение является расширением скан-копии. +// +Функция ЭтоРасширениеСканКопии(Расширение, Знач СписокРасширенийСканКопийОригиналов) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ЭтоРасширениеСканКопии(Расширение, СписокРасширенийСканКопийОригиналов) +``` +
+ +## ДанныеВладельцаПодписи +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру данных владельца подписи. +// +// Параметры: +// Наименование - Строка - имя объекта ДО. +// ID - Строка - идентификатор объекта ДО. +// Тип - Строка - тип объекта XDTO. +// Зашифрован - Булево - владелец подписи зашифрован. +// МассивПодписей - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи +// +// Возвращаемое значение: +// Структура - данные владельца подписей: +// * Наименование - Строка - имя объекта ДО. +// * ID - Строка - идентификатор объекта ДО. +// * Тип - Строка - тип объекта XDTO. +// * Зашифрован - Булево - владелец подписи зашифрован. +// * МассивПодписей - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи +// - Неопределено +// +Функция ДанныеВладельцаПодписи(Наименование, ID, Тип, Зашифрован, МассивПодписей = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеВладельцаПодписи(Наименование, ID, Тип, Зашифрован, МассивПодписей); +``` +
+ +## ДанныеПодписи +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные, из которых будет формироваться XDTO объект DMSignature, для передачи в ДО. +// +// Параметры: +// Подпись - ДвоичныеДанные - двоичные данные подписи. +// ДвоичныеДанныеСертификата - ДвоичныеДанные - двоичные данные сертификата. +// СвойстваПодписи - Структура - тут может быть или структура СвойстваПодписи, которую возвращает БСП при +// добавлении новой подписи, или строка таблицы подписей, если это уже существующая на стороне ДО подпись. +// +// Возвращаемое значение: +// см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураПодписи +// +Функция ДанныеПодписи(Подпись, ДвоичныеДанныеСертификата, СвойстваПодписи) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи(Подпись, ДвоичныеДанныеСертификата, СвойстваПодписи) +``` +
+ +## ДополнитьПодписиОбъектов +
+ +Описание, пример вызова + +```bsl + +// Дополняет соответствие подписей объектов. +// +// Параметры: +// ПодписиОбъектов - Соответствие из КлючИЗначение: +// * Ключ - Строка - идентификатор объекта ДО, являющегося владельцем подписи. +// * Значение - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеВладельцаПодписи +// Наименование - Строка - имя объекта ДО. +// ID - Строка - идентификатор объекта ДО. +// Тип - Строка - тип объекта XDTO. +// Зашифрован - Булево - владелец подписи зашифрован. +// МассивПодписей - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи +// +Процедура ДополнитьПодписиОбъектов(ПодписиОбъектов, Наименование, ID, Тип, Зашифрован, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДополнитьПодписиОбъектов(ПодписиОбъектов, Наименование, ID, Тип, Зашифрован, ); +``` +
+ +## ПараметрыПроверкиЭП +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров для проверки электронно-цифровой подписи. +// +// Параметры: +// ДанныеСтроки - ДанныеФормыЭлементДерева - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// СоответствиеИдОбъектаИДвоичныхДанных - Соответствие из КлючИЗначение: +// * Ключ - Строка - идентификатор объекта. +// * Значение - ДвоичныеДанные - двоичные данные объекта. +// АдресСлепкаДокумента - Строка - адрес временного хранилища двоичных данных документа Документооборота. +// +// Возвращаемое значение: +// Структура: +// * ФорматДатыПроверки - Строка +// * ДвоичныеДанныеОбъекта - ДвоичныеДанные +// - Неопределено +// * Подпись - ДвоичныеДанные +// - Неопределено +// +Функция ПараметрыПроверкиЭП(ДанныеСтроки, СоответствиеИдОбъектаИДвоичныхДанных, АдресСлепкаДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ПараметрыПроверкиЭП(ДанныеСтроки, СоответствиеИдОбъектаИДвоичныхДанных, АдресСлепкаДокумента) +``` +
+ +## ПодписьВыделена +
+ +Описание, пример вызова + +```bsl + +// Определяет выделена ли подпись в переданных данных строки строки из таблицы подписей. +// +// Параметры: +// ВыделенныеПодписи - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыделенныеПодписи +// ДанныеСтроки - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// +// Возвращаемое значение: +// Булево +// +Функция ПодписьВыделена(ВыделенныеПодписи, ДанныеСтроки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ПодписьВыделена(ВыделенныеПодписи, ДанныеСтроки) +``` +
+ +## СтрокаСообщенияОНедопустимостиПодписанияЗанятогоФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает Строку сообщения о недопустимости подписания занятого файла. +// +// Параметры: +// ФайлСсылка - ЛюбаяСсылка - Ссылка на файл. +// +// Возвращаемое значение: +// Строка +// +Функция СтрокаСообщенияОНедопустимостиПодписанияЗанятогоФайла(ФайлСсылка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтрокаСообщенияОНедопустимостиПодписанияЗанятогоФайла(ФайлСсылка); +``` +
+ +## СтруктураПодписи +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей данные электронной подписи. +// +// Возвращаемое значение: +// Структура: +// * Подпись - ДвоичныеДанные +// - Неопределено +// * ДвоичныеДанныеСертификата - ДвоичныеДанные +// - Неопределено +// * Сертификат - ХранилищеЗначения +// - Неопределено +// * Отпечаток - Строка +// - Неопределено +// * ДатаПодписи - Дата +// - Неопределено +// * Комментарий - Строка +// - Неопределено +// * ИмяФайлаПодписи - Строка +// - Неопределено +// * КомуВыданСертификат - Строка +// - Неопределено +// * УстановившийПодпись - Строка +// - Неопределено +// * УстановившийПодписьИд - Строка +// - Неопределено +// +Функция СтруктураПодписи() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураПодписи() +``` +
+ +## СтруктураСтрокиДереваПодписей +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры, описывающей строку дерева подписей. +// +// Параметры: +// СтрокаДереваПодписей - ДанныеФормыЭлементДерева - строка дерева подписей: +// * АдресПодписи - Строка +// * АдресСертификата - Строка +// * ДатаПодписи - Дата +// * ДатаПодписиИКомментарий - Строка +// * Зашифрован - Булево +// * ИмяФайлаПодписи - Строка +// * ИндексКартинки - Число +// * Комментарий - Строка +// * КомуВыданСертификат - Строка +// * КомуВыданСертификатИСтатус - Строка +// * Неверна - Булево +// * НомерСтроки - Число +// * Объект - Строка +// * ОбъектИд - Строка +// * ОбъектИмя - Строка +// * ОбъектТип - Строка +// * Отпечаток - Строка +// * ПодписьВерна - Булево +// * Статус - Строка +// * УстановившийПодпись - Строка +// * УстановившийПодписьИд - Строка +// +// Возвращаемое значение: +// Структура: +// * АдресПодписи - Строка +// * АдресСертификата - Строка +// * ДатаПодписи - Дата +// * ДатаПодписиИКомментарий - Строка +// * Зашифрован - Булево +// * ИмяФайлаПодписи - Строка +// * ИндексКартинки - Число +// * Комментарий - Строка +// * КомуВыданСертификат - Строка +// * КомуВыданСертификатИСтатус - Строка +// * Неверна - Булево +// * НомерСтроки - Число +// * Объект - Строка +// * ОбъектИд - Строка +// * ОбъектИмя - Строка +// * ОбъектТип - Строка +// * Отпечаток - Строка +// * ПодписьВерна - Булево +// * Статус - Строка +// * УстановившийПодпись - Строка +// * УстановившийПодписьИд - Строка +// +Функция СтруктураСтрокиДереваПодписей(СтрокаДереваПодписей) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей(СтрокаДереваПодписей) +``` +
+ +## ТаблицаПодписей +
+ +Описание, пример вызова + +```bsl + +// Преобразует 2-уровневое дерево в массив. +// +// Параметры: +// ДеревоПодписей - ДанныеФормыДерево - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// ВыделенныеСтроки - Массив из Число - выделенные строки в дереве подписей. +// ОбъектID - Строка - заполняется если нужно получить подписи конкретного объекта. +// +// Возвращаемое значение: +// Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей +// +Функция ТаблицаПодписей(ДеревоПодписей, ВыделенныеСтроки = Неопределено, ОбъектID = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ТаблицаПодписей(ДеревоПодписей, ВыделенныеСтроки, ОбъектID); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.md new file mode 100644 index 0000000..ccc3d7f --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.md @@ -0,0 +1,1516 @@ +--- +title: Интеграция с 1С документооборот базовая функциональность переопределяемый +slug: zup/интеграция-с-1с-документооборот-базовая-функциональность-переопределяемый +--- + + +## ПриПоявленииПрисоединенныхФайловДокументооборота +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак наличия присоединенных файлов ДО для объекта ИС. Вызывается при добавлении +// связи с объектом ДО, имеющим файлы, при добавлении файла из интерфейса ИС и при фоновом обновлении. +// +// Параметры: +// ID - Строка - идентификатор объекта Документооборота. +// Тип - Строка - XDTO-тип объекта Документооборота. +// ОбъектИС - ЛюбаяСсылка - объект ИС. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная обработка +// производиться не будет. +// +Процедура ПриПоявленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриПоявленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС, СтандартнаяОбработка) +``` +
+ +## ПриУдаленииПрисоединенныхФайловДокументооборота +
+ +Описание, пример вызова + +```bsl + +// Снимает признак наличия присоединенных файлов для объекта ИС, если их нет в самой ИС. Вызывается при +// удалении связи с объектом ДО и при фоновом обновлении. +// +// Параметры: +// ID - Строка - идентификатор объекта Документооборота. +// Тип - Строка - XDTO-тип объекта Документооборота. +// ОбъектИС - ЛюбаяСсылка - объект ИС. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная обработка +// производиться не будет. +// +Процедура ПриУдаленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриУдаленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС, СтандартнаяОбработка) +``` +
+ +## ПриОпределенииНаличияПрисоединенныхФайлов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при определении наличия файлов, хранимых в интегрируемой конфигурации. +// +// Параметры: +// ВладелецФайлов - Произвольный - объект-владелец. +// ЕстьФайлы - Булево, Неопределено - неявно возвращаемое значение, признак наличия присоединенных файлов. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная обработка +// производиться не будет. +// +Процедура ПриОпределенииНаличияПрисоединенныхФайлов(ВладелецФайлов, ЕстьФайлы, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииНаличияПрисоединенныхФайлов(ВладелецФайлов, ЕстьФайлы, СтандартнаяОбработка) +``` +
+ +## ПриПолученииПрисоединенныхФайлов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении присоединенных файлов. +// +// Параметры: +// ВладелецФайлов - Произвольный - объект-владелец. +// ДанныеФайлов - Массив из см. РаботаСФайлами.ДанныеФайла +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная обработка +// производиться не будет. +// +Процедура ПриПолученииПрисоединенныхФайлов(ВладелецФайлов, ДанныеФайлов, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриПолученииПрисоединенныхФайлов(ВладелецФайлов, ДанныеФайлов, СтандартнаяОбработка) +``` +
+ +## ДополнительнаяОбработкаФормыБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании форм бизнес-процессов 1С:Документооборота. Позволяет выполнить дополнительные действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма бизнес-процесса Документооборота. +// Отказ - Булево - признак отказа от создания формы. +// СтандартнаяОбработка - Булево - стандартная обработка при создании формы на сервере. +// +Процедура ДополнительнаяОбработкаФормыБизнесПроцесса(Форма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ДополнительнаяОбработкаФормыБизнесПроцесса(Форма, Отказ, СтандартнаяОбработка) +``` +
+ +## ДополнительнаяОбработкаФормыДокумента +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании форм документов Документооборота. Позволяет выполнить дополнительные действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма документа Документооборота. +// Отказ - Булево - признак отказа от создания формы. +// СтандартнаяОбработка - Булево - стандартная обработка при создании формы на сервере. +// +Процедура ДополнительнаяОбработкаФормыДокумента(Форма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ДополнительнаяОбработкаФормыДокумента(Форма, Отказ, СтандартнаяОбработка) +``` +
+ +## ДополнительнаяОбработкаФормыЗадачи +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании формы задачи Документооборота. Позволяет выполнить дополнительные действия. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма задачи Документооборота. +// Отказ - Булево - признак отказа от создания формы. +// СтандартнаяОбработка - Булево - стандартная обработка при создании формы на сервере. +// +Процедура ДополнительнаяОбработкаФормыЗадачи(Форма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ДополнительнаяОбработкаФормыЗадачи(Форма, Отказ, СтандартнаяОбработка) +``` +
+ +## ДополнитьСоответствиеТипов +
+ +Описание, пример вызова + +```bsl + +// Дополняет таблицу соответствия поддерживаемых типов. +// +// Параметры: +// Таблица - ТаблицаЗначений - неявно возвращаемое значение с колонками: +// * ИмяТипаXDTO - Строка - имя типа XDTO. +// * ТипОбъектаИС - Тип - тип объекта ИС. +// +// Пример: +// ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов( +// Таблица, "DMBankAccount", Тип("СправочникСсылка._ДемоБанковскиеСчета")); +// ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов( +// Таблица, "DMMeasurementUnit", Тип("СправочникСсылка._ДемоЕдиницыИзмерения")); +// ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов( +// Таблица, "DMContactPerson", Тип("СправочникСсылка._ДемоКонтактныеЛица")); +// ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов( +// Таблица, "DMCorrespondent", Тип("СправочникСсылка._ДемоКонтрагенты")); +// ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов( +// Таблица, "DMProduct", Тип("СправочникСсылка._ДемоНоменклатура")); +// ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов( +// Таблица, "DMOrganization", Тип("СправочникСсылка._ДемоОрганизации")); +// ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов( +// Таблица, "DMSubdivision", Тип("СправочникСсылка._ДемоПодразделения")); +// ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов( +// Таблица, "DMCashFlowItem", Тип("СправочникСсылка._ДемоСтатьиДвиженияДенежныхСредств")); +// ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов( +// Таблица, "DMEmployee", Тип("СправочникСсылка._ДемоСотрудники")); +// +Процедура ДополнитьСоответствиеТипов(Таблица) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ДополнитьСоответствиеТипов(Таблица) +``` +
+ +## ЗаполнитьРеквизитыИзПотребителя +
+ +Описание, пример вызова + +```bsl + +// Заполняет свойства объекта XDTO из реквизитов объекта конфигурации-потребителя. По умолчанию заполняется +// только наименование и идентификатор. При необходимости обеспечить заполнение других реквизитов объектов +// ДО, создаваемых по ссылкам, следует заполнить соответствующие свойства объекта XDTO. Эти же значения будут +// использованы при поиске соответствий для справочников, имеющих внешние ключи (ИНН, КПП). +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ОбъектXDTO - ОбъектXDTO - заполняемый объект. +// СсылкаНаПотребитель - ЛюбаяСсылка - ссылка на исходный объект конфигурации-потребителя. +// +// Пример: +// Если ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПроверитьТип(Прокси, ОбъектXDTO, "DMCorrespondent") +// И ТипЗнч(СсылкаНаПотребитель) = Тип("СправочникСсылка._ДемоКонтрагенты") Тогда +// Реквизиты = ОбщегоНазначения.ЗначенияРеквизитовОбъекта(СсылкаНаПотребитель, "ИНН, КПП, ЮрФизЛицо"); +// ОбъектXDTO.inn = Реквизиты.ИНН; +// ОбъектXDTO.kpp = Реквизиты.КПП; +// Если Реквизиты.ЮрФизЛицо = Перечисления._ДемоЮрФизЛицо.ЮрЛицо Тогда +// ОбъектXDTO.legalPrivatePerson = "LglPerson"; +// ИначеЕсли Реквизиты.ЮрФизЛицо = Перечисления._ДемоЮрФизЛицо.ФизЛицо Тогда +// ОбъектXDTO.legalPrivatePerson = "Individ"; +// ИначеЕсли Реквизиты.ЮрФизЛицо = Перечисления._ДемоЮрФизЛицо.ИндивидуальныйПредприниматель Тогда +// ОбъектXDTO.legalPrivatePerson = "IndividualEntrepreneur"; +// ИначеЕсли Реквизиты.ЮрФизЛицо = Перечисления._ДемоЮрФизЛицо.ЮрЛицоНеРезидент Тогда +// ОбъектXDTO.legalPrivatePerson = "LglPersonNonResident"; +// КонецЕсли; +// ИначеЕсли ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПроверитьТип(Прокси, ОбъектXDTO, "DMOrganization") +// И ТипЗнч(СсылкаНаПотребитель) = Тип("СправочникСсылка._ДемоОрганизации") Тогда +// Реквизиты = ОбщегоНазначения.ЗначенияРеквизитовОбъекта(СсылкаНаПотребитель, "ИНН, КПП"); +// ОбъектXDTO.inn = Реквизиты.ИНН; +// ОбъектXDTO.kpp = Реквизиты.КПП; +// ИначеЕсли ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПроверитьТип(Прокси, ОбъектXDTO, "DMBankAccount") +// И ТипЗнч(СсылкаНаПотребитель) = Тип("СправочникСсылка._ДемоБанковскиеСчета") Тогда +// Реквизиты = ОбщегоНазначения.ЗначенияРеквизитовОбъекта(СсылкаНаПотребитель, "Владелец, НомерСчета"); +// ОбъектXDTO.number = Реквизиты.НомерСчета; +// Если ТипЗнч(Реквизиты.Владелец) = Тип("СправочникСсылка._ДемоКонтрагенты") Тогда +// ТипВладельцаXDTO = "DMCorrespondent"; +// ИначеЕсли ТипЗнч(Реквизиты.Владелец) = Тип("СправочникСсылка._ДемоОрганизации") Тогда +// ТипВладельцаXDTO = "DMOrganization"; +// КонецЕсли; +// ОбъектXDTO.owner = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьОбъект( +// Прокси, +// ТипВладельцаXDTO, +// Реквизиты.Владелец); +// Если ЗначениеЗаполнено(Реквизиты.Банк) Тогда +// ОбъектXDTO.bank = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьОбъект( +// Прокси, +// "DMBank", +// Реквизиты.Банк); +// КонецЕсли; +// Иначе //... +// КонецЕсли; +// +Процедура ЗаполнитьРеквизитыИзПотребителя(Прокси, ОбъектXDTO, СсылкаНаПотребитель) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ЗаполнитьРеквизитыИзПотребителя(Прокси, ОбъектXDTO, СсылкаНаПотребитель) +``` +
+ +## ЗаполнитьФормуИзПотребителя +
+ +Описание, пример вызова + +```bsl + +// Заполняет реквизиты формы по данным объекта интегрированной системы. +// +// Параметры: +// ВнешнийОбъект - ЛюбаяСсылка - ссылка на объект-основание. +// Форма - ФормаКлиентскогоПриложения - форма обработки ИнтеграцияС1СДокументооборот, соответствующая заполняемому +// объекту Документооборота. +// +Процедура ЗаполнитьФормуИзПотребителя(ВнешнийОбъект, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ЗаполнитьФормуИзПотребителя(ВнешнийОбъект, Форма) +``` +
+ +## ПередЗаписьюДокумента +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед записью входящих, исходящих, внутренних документов Документооборота. +// Позволяет выполнить дополнительные проверки перед записью, и отказаться от записи. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ОбъектXDTO - ОбъектXDTO - заполняемый объект. Тип DMInternalDocument, DMIncomingDocument, DMOutgoingDocument. +// Форма - ФормаКлиентскогоПриложения - форма документа Документооборота. +// Отказ - Булево - признак отказа от записи документа. +// +Процедура ПередЗаписьюДокумента(Прокси, ОбъектXDTO, Форма, Отказ) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПередЗаписьюДокумента(Прокси, ОбъектXDTO, Форма, Отказ) +``` +
+ +## ПередЗаписьюОбъектаИС +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед записью объектов интегрированной системы через механизм обмена с 1С:Документооборот. +// Позволяет выполнить дополнительные проверки перед записью, изменить ДополнительныеСвойства и отказаться от записи. +// +// Параметры: +// ОбъектИС - ДокументОбъект +// - СправочникОбъект - изменяемый объект ИС. +// Отказ - Булево - признак отказа от записи. +// РежимЗаписиДокумента - РежимЗаписиДокумента - позволяет изменить режим записи. +// РежимПроведенияДокумента - РежимПроведенияДокумента - позволяет изменить режим проведения документа. +// +Процедура ПередЗаписьюОбъектаИС(ОбъектИС, Отказ, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПередЗаписьюОбъектаИС(ОбъектИС, Отказ, ); +``` +
+ +## ПолучитьРеквизитыОбъектаИС +
+ +Описание, пример вызова + +```bsl + +// Заполняет таблицу реквизитов объекта по типу объекта. +// +// Параметры: +// ИмяОбъектаИС - Строка - имя типа объекта потребителя. +// Реквизиты - ТаблицаЗначений - Таблица описания реквизитов. +// +Процедура ПолучитьРеквизитыОбъектаИС(ИмяОбъектаИС, Реквизиты) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПолучитьРеквизитыОбъектаИС(ИмяОбъектаИС, Реквизиты) +``` +
+ +## ПриДобавленииПодсистемыВДеревоИнтегрируемыхОбъектов +
+ +Описание, пример вызова + +```bsl + +// Вызывается при добавлении подсистемы в дерево интегрируемых объектов, с помощью которого настраивается +// интеграция. По умолчанию выводятся подсистемы первого уровня, включаемые в командный интерфейс, и +// подчиненные им. +// +// Параметры: +// Подсистема - ОбъектМетаданных - добавляемая подсистема, содержащая интегрируемые объекты. +// Отказ - Булево - при установке в Ложь подсистема будет пропущена вместе со всеми подчиненными. +// +Процедура ПриДобавленииПодсистемыВДеревоИнтегрируемыхОбъектов(Подсистема, Отказ) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриДобавленииПодсистемыВДеревоИнтегрируемыхОбъектов(Подсистема, Отказ) +``` +
+ +## ПриЗаписиКонстанты +
+ +Описание, пример вызова + +```bsl + +// Вызывается при записи констант подсистемы Интеграция с 1С:Документооборотом. +// +// Параметры: +// Источник - КонстантаМенеджерЗначения - записываемая константа. +// Отказ - Булево - флаг отказа от выполнения записи. +// +Процедура ПриЗаписиКонстанты(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриЗаписиКонстанты(Источник, Отказ) +``` +
+ +## ПриЗаполненииКоллекцииПечатныхФорм +
+ +Описание, пример вызова + +```bsl + +// Заполняет коллекцию печатных форм объекта по имени менеджера печати и команде менеджера печати. +// +// Параметры: +// ВнешнийОбъект - ЛюбаяСсылка - внешний объект. +// ИмяКоманды - Строка - имя команды. +// ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати. +// КоллекцияПечатныхФорм - ТаблицаЗначений - неявно возвращаемое значение. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная обработка +// производиться не будет. +// +Процедура ПриЗаполненииКоллекцииПечатныхФорм(ВнешнийОбъект, ИмяКоманды, ДополнительныеПараметры, КоллекцияПечатныхФорм, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриЗаполненииКоллекцииПечатныхФорм(ВнешнийОбъект, ИмяКоманды, ДополнительныеПараметры, КоллекцияПечатныхФорм, ); +``` +
+ +## ПриЗаполненииСвойстваОбъектаXDTOПоЗначению +
+ +Описание, пример вызова + +```bsl + +// Вызывается при заполнении свойства объекта XDTO по значению в ИС (например, по значению реквизита объекта ИС). +// +// Параметры: +// Значение - Произвольный - значение, которым заполняются свойства объекта XDTO для передачи в ДО. +// Свойства - ФормаКлиентскогоПриложения +// - СтрокаТаблицыЗначений - заполняемый набор данных, которым будет заполнен объект XDTO для передачи в ДО. +// - см. ИнтеграцияС1СДокументооборот.СтруктураРеквизитовЗаполняемогоОбъектаДО +// ТипОбъекта - Строка - тип заполняемого объекта, например, "DMInternalObject". +// ИмяСвойства - Строка - имя заполняемого свойства, например, "Контрагент", "СостояниеСогласование". +// ТипСвойства - Строка - тип заполняемого свойства, например, "DMCorrespondent", "DMDocumentStatus". +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартное заполнение +// свойства по значению Значение производиться не будет. +// +// Пример: +// Если ТипСвойства = "DMDocumentStatus" И ИмяСвойства = "СостояниеСогласование" Тогда +// Если Значение = Перечисления._ДемоСостоянияЗаказаПокупателя.Согласован Тогда +// Свойства[ИмяСвойства] = "Approved"; +// СтандартнаяОбработка = Ложь; +// КонецЕсли; +// КонецЕсли; +// +Процедура ПриЗаполненииСвойстваОбъектаXDTOПоЗначению(Значение, Свойства, ТипОбъекта, ИмяСвойства, ТипСвойства, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриЗаполненииСвойстваОбъектаXDTOПоЗначению(Значение, Свойства, ТипОбъекта, ИмяСвойства, ТипСвойства, ); +``` +
+ +## ПриЗаполненииТаблицыМенеджеровПечатиОбъекта +
+ +Описание, пример вызова + +```bsl + +// Получает таблицу менеджеров печати форм объектов. +// +// Параметры: +// МенеджерОбъекта - Строка - полное имя метаданных менеджера объекта. +// ПечатныеФормы - ТаблицаЗначений: +// * МенеджерПечати - Строка - имя объекта, в модуле менеджера которого располагается +// процедура Печать, формирующая табличные документы для этой команды. +// * ИмяКоманды - Строка +// * ПредставлениеКоманды - Строка +// * ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная обработка +// производиться не будет. +// +// Пример: +// КомандыПечати = ИнтеграцияС1СДокументооборотБазоваяФункциональность.КомандыПечатиФормы( +// МенеджерОбъекта + ".Форма.ФормаСписка"); +// +// Для Каждого Команда Из КомандыПечати Цикл +// Строка = ПечатныеФормы.Добавить(); +// Строка.МенеджерПечати = Команда.МенеджерПечати; +// Строка.ИмяКоманды = Команда.Идентификатор; +// Строка.ПредставлениеКоманды = Команда.Представление; +// КонецЦикла; +// +Процедура ПриЗаполненииТаблицыМенеджеровПечатиОбъекта(МенеджерОбъекта, ПечатныеФормы, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриЗаполненииТаблицыМенеджеровПечатиОбъекта(МенеджерОбъекта, ПечатныеФормы, СтандартнаяОбработка) +``` +
+ +## ПриЗаполненииФормыОбъектаДОПоОбъектуИС +
+ +Описание, пример вызова + +```bsl + +// Вызывается при заполнении формы объекта ДО при его создании на основании объекта ИС. Позволяет дозаполнить объект +// ДО способом, не поддерживаемым правилами интеграции. +// +// Параметры: +// ОбъектИС - Произвольный - ссылка на объект ИС. +// Форма - ФормаКлиентскогоПриложения - форма объекта 1С:Документооборота. +// Правило - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом - применяемое правило. +// +Процедура ПриЗаполненииФормыОбъектаДОПоОбъектуИС(ОбъектИС, Форма, Правило) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриЗаполненииФормыОбъектаДОПоОбъектуИС(ОбъектИС, Форма, Правило) +``` +
+ +## ПриИзмененииСостоянияСогласования +
+ +Описание, пример вызова + +```bsl + +// Вызывается при изменении состояния согласования в ДО. Предназначена для изменения согласуемого объекта. +// +// Параметры: +// ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// Состояние - ПеречислениеСсылка.СостоянияСогласованияВДокументообороте. +// ВызовИзФормыОбъекта - Булево - Истина, если изменение состояния вызвано пользователем из формы объекта. +// Установил - Строка - представление пользователя, установившего новое состояние. +// ДатаУстановки - Дата - Дата установки нового состояния. +// +// Пример: +// Если ВызовИзФормыОбъекта Тогда +// Возврат; +// КонецЕсли; +// +// Если ТипЗнч(ПредметСогласования) = Тип("ДокументСсылка._ДемоЗаказПокупателя") Тогда +// +// Объект = ПредметСогласования.ПолучитьОбъект(); +// Если Состояние = Перечисления.СостоянияСогласованияВДокументообороте.НаСогласовании Тогда +// Объект.Состояние = Перечисления._ДемоСостоянияЗаказаПокупателя.НаСогласовании; +// ИначеЕсли Состояние = Перечисления.СостоянияСогласованияВДокументообороте.НеСогласован Тогда +// Объект.Состояние = Перечисления._ДемоСостоянияЗаказаПокупателя.НеСогласован; +// ИначеЕсли Состояние = Перечисления.СостоянияСогласованияВДокументообороте.Согласован Тогда +// Объект.Состояние = Перечисления._ДемоСостоянияЗаказаПокупателя.Согласован; +// Иначе +// Объект.Состояние = Перечисления._ДемоСостоянияЗаказаПокупателя.Подготовлен; +// КонецЕсли; +// Объект.Записать(РежимЗаписиДокумента.Запись); +// +// КонецЕсли; +// +Процедура ПриИзмененииСостоянияСогласования(ПредметСогласования, Состояние, ВызовИзФормыОбъекта, Установил, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриИзмененииСостоянияСогласования(ПредметСогласования, Состояние, ВызовИзФормыОбъекта, Установил, ); +``` +
+ +## ПриОбработкеУниверсальногоСообщения +
+ +Описание, пример вызова + +```bsl + +// Дополнительная обработка сообщения XDTO. +// +// Параметры: +// Сообщение - ОбъектXDTO - объект XDTO, потомок DMILRequest. +// Результат - ОбъектXDTO - неявно возвращаемое значение. Объект XDTO, +// потомок DMILResponse, если сообщение считается обработанным. +// - Неопределено - если сообщение требует дальнейшей обработки. +// +Процедура ПриОбработкеУниверсальногоСообщения(Сообщение, Результат) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОбработкеУниверсальногоСообщения(Сообщение, Результат) +``` +
+ +## ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO +
+ +Описание, пример вызова + +```bsl + +// Вызывается при заполнении реквизита объекта ИС по значению реквизита объекта ДО. При установке +// в параметр Результат значения, отличного от Неопределено, стандартное заполнение не выполняется. +// +// Параметры: +// Результат - Произвольный - заполняемое значение реквизита объекта ИС. +// ЗначениеЗаполнения - ОбъектXDTO - исходный объект, соответствие которому нужно найти. +// - Структура - структура со свойствами: +// * ТипXDTOОбъекта - Строка - тип XDTO объекта, из значения свойства которого выполняется заполнение. +// * ИмяСвойства - Строка - имя свойства, из значения свойства которого выполняется заполнение. +// * ЗначениеСвойства - Произвольный - значение заполнения, соответствие которому нужно найти. +// ТипРеквизита - Тип - тип заполняемого реквизита объекта ИС. +// ИмяРеквизита - Строка - имя заполняемого реквизита ИС. +// ТипОбъекта - Тип - тип заполняемого объекта ИС. +// Объект - Произвольный - заполняемый объект ИС. +// ЭтоДополнительноеСвойство - Булево - истина, если переданный объект является доп. свойством. +// Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - свойство-владелец. +// ПараметрыВыбора - Соответствие из КлючИЗначение - параметры выбора: +// * Ключ - Строка - имя параметра вида "Отбор.Владелец". +// * Значение - Произвольный - значение параметра (отбора). +// +// Пример: +// Если ИнтеграцияС1СДокументооборотБазоваяФункциональность.СвойствоУстановлено(ОбъектXDTO, "objectID") +// И ОбъектXDTO.objectID.type = "DMDocumentStatus" +// И ТипРеквизита = Тип("Булево") +// И ИмяРеквизита = "Согласован" Тогда +// Результат = (ОбъектXDTO.objectID.ID = "Согласован"); +// КонецЕсли; +// Если ТипРеквизита = Тип("СправочникСсылка._ДемоЕдиницыИзмерения") +// И ПараметрыВыбора <> Неопределено Тогда +// Запрос = Новый Запрос( +// "ВЫБРАТЬ ПЕРВЫЕ 1 +// | Ссылка +// |ИЗ +// | Справочник._ДемоЕдиницыИзмерения +// |ГДЕ +// | Владелец = &Владелец +// | И Наименование = &Наименование +// |"); +// Запрос.УстановитьПараметр("Наименование", ОбъектXDTO.name); +// Запрос.УстановитьПараметр("Владелец", ПараметрыВыбора["Отбор.Владелец"]); +// Выборка = Запрос.Выполнить().Выбрать(); +// Если Выборка.Следующий() Тогда +// Результат = Выборка.Ссылка; +// КонецЕсли; +// КонецЕсли; +// Если ТипРеквизита = Тип("СправочникСсылка._ДемоБанковскиеСчета") +// И ОбъектXDTO.Свойства().Получить("number") <> Неопределено +// И ИнтеграцияС1СДокументооборотБазоваяФункциональность.СвойствоУстановлено(ОбъектXDTO, "number") Тогда +// Запрос = Новый Запрос( +// "ВЫБРАТЬ ПЕРВЫЕ 1 +// | Ссылка +// |ИЗ +// | Справочник._ДемоБанковскиеСчета +// |ГДЕ +// | НомерСчета = &НомерСчета +// |"); +// Запрос.УстановитьПараметр("НомерСчета", ОбъектXDTO.number); +// Выборка = Запрос.Выполнить().Выбрать(); +// Если Выборка.Следующий() Тогда +// Результат = Выборка.Ссылка; +// КонецЕсли; +// КонецЕсли; +// +Процедура ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO(Результат, ЗначениеЗаполнения, ТипРеквизита, ИмяРеквизита, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO(Результат, ЗначениеЗаполнения, ТипРеквизита, ИмяРеквизита, ); +``` +
+ +## ПриОпределенииИндексаКартинкиЭлементаСправочника +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить индекс картинки элемента справочника. +// +// Параметры: +// ИндексаКартинки - Число - индекс картинки. +// +Процедура ПриОпределенииИндексаКартинкиЭлементаСправочника(ИндексаКартинки) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииИндексаКартинкиЭлементаСправочника(ИндексаКартинки) +``` +
+ +## ПриОпределенииНеобходимостиВыводитьКомандуПрисоединенныхФайловДО +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить проверку необходимости вывода команды присоединенных файлов из библиотеки +// интеграции с 1С:Документооборотом на форму объекта ИС. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - проверяемая форма. +// Результат - Булево - неявно возвращаемое значение, результат проверки. Если результат равен Истина, +// команда "Файлы ДО" будет выводиться на форму. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная проверка +// производиться не будет. +// +// Пример: +// ИмяФормыМассив = СтрРазделить(Форма.ИмяФормы, "."); +// ИмяТипаОбъектаФормы = СтрШаблон("%1.%2", ИмяФормыМассив[0], ИмяФормыМассив[1]); +// Правила = ИнтеграцияС1СДокументооборотВызовСервера.ПодходящиеПравила(,,ИмяТипаОбъектаФормы); +// +// Если Правила.Количество() = 0 Тогда +// // Возможно в переопределяемом модуле прописано автоматическое создание правил для данного типа объекта ИС +// СозданныеПравила = ИнтеграцияС1СДокументооборотВызовСервера.СоздатьПравилаИнтеграцииАвтоматически( +// ИмяТипаОбъектаФормы); +// Если СозданныеПравила.Количество() > 0 Тогда +// Правила = ИнтеграцияС1СДокументооборотВызовСервера.ПодходящиеПравила(,,ИмяТипаОбъектаФормы); +// КонецЕсли; +// КонецЕсли; +// +// Результат = (Правила.Количество() <> 0); +// +Процедура ПриОпределенииНеобходимостиВыводитьКомандуПрисоединенныхФайловДО(Форма, Результат, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииНеобходимостиВыводитьКомандуПрисоединенныхФайловДО(Форма, Результат, ); +``` +
+ +## ПриОпределенииОбновляемыхРеквизитовПроведенногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Определяет реквизиты проведенного документа, подлежащие обновлению при их изменении в ДО. +// +// Параметры: +// ПолноеИмя - Строка - полное имя объекта, как оно задано в метаданных, напр., Документ.ЗаказКлиента. +// ОбновляемыеРеквизиты - Массив из Строка - неявно возвращаемое значение, имена реквизитов, обновление которых возможно. +// +// Пример: +// ОбновляемыеРеквизиты.Добавить("Комментарий"); +// Если ПолноеИмя = "Документ.ЗаказКлиента" Тогда +// ОбновляемыеРеквизиты.Добавить("Состояние"); +// КонецЕсли; +// +Процедура ПриОпределенииОбновляемыхРеквизитовПроведенногоДокумента(ПолноеИмя, ОбновляемыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииОбновляемыхРеквизитовПроведенногоДокумента(ПолноеИмя, ОбновляемыеРеквизиты) +``` +
+ +## ПриОпределенииОбъектовПоддерживающихАвтонастройку +
+ +Описание, пример вызова + +```bsl + +// Вызывается при построении списка интегрируемых объектов. В переданную таблицу следует добавить +// типы объектов, поддерживающих автоматическую настройку бесшовной интеграции с созданием правил +// интеграции и заполнением связанных данных. +// +// Параметры: +// Объекты - ТаблицаЗначений - заполняемая таблица с колонками: +// ИмяТипаОбъекта - Строка - полное имя типа, как задано в метаданных. +// ОписаниеВыполняемыхДействий - Строка - необязательна, краткое описание действий, выполняемых +// при автоматической настройке. +// +// Пример: +// Строка = Объекты.Добавить(); +// Строка.ИмяТипаОбъекта = "Справочник._ДемоДоговорыКонтрагентов"; +// Строка.ОписаниеВыполняемыхДействий = +// НСтр("ru = 'Будут созданы правила интеграции и виды внутренних документов для всех видов договоров.'"); +// +Процедура ПриОпределенииОбъектовПоддерживающихАвтонастройку(Объекты) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииОбъектовПоддерживающихАвтонастройку(Объекты) +``` +
+ +## ПриОпределенииПодходящихОбъектовДляДобавленияСвязи +
+ +Описание, пример вызова + +```bsl + +// Вызывается при добавлении связи к объекту ИС, связанному с объектом ДО. +// Позволяет дополнить список подходящих объектов, предъявляемый пользователю, +// теми объектами, которые не могут быть определены автоматически по ссылкам +// из шапки или из табличных частей объекта ИС. +// +// Параметры: +// ОбъектИС - Произвольный - ссылка на объект ИС. +// ПодходящиеОбъекты - Массив из ЛюбаяСсылка - дополняемый массив объектов ИС, подходящих для добавления связи. +// +Процедура ПриОпределенииПодходящихОбъектовДляДобавленияСвязи(ОбъектИС, ПодходящиеОбъекты) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииПодходящихОбъектовДляДобавленияСвязи(ОбъектИС, ПодходящиеОбъекты) +``` +
+ +## ПриОпределенииПоясненияСостоянияСогласования +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить получение пояснения к состоянию согласования, предназначенное для чтения пользователем. +// +// Параметры: +// Установил - Строка - представление пользователя, установившего новое состояние. +// ДатаУстановки - Дата - дата и время установки нового состояния. +// Пояснение - Строка - пояснение к состоянию согласования. +// +Процедура ПриОпределенииПоясненияСостоянияСогласования(Установил, ДатаУстановки, Пояснение) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииПоясненияСостоянияСогласования(Установил, ДатаУстановки, Пояснение) +``` +
+ +## ПриОпределенииПредельногоКоличестваВыбираемыхОбъектов +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить предельное количество объектов, выбираемых сервисом при получении списков. +// +// Параметры: +// Тип - Строка - тип объекта XDTO +// ПредельноеКоличество - Число - предельное количество элементов, выбираемых за раз. +// +// Пример: +// Если Тип = "DMCorrespondent" Тогда ПредельноеКоличество = 50 ИначеЕсли <...> +// +Процедура ПриОпределенииПредельногоКоличестваВыбираемыхОбъектов(Тип, ПредельноеКоличество) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииПредельногоКоличестваВыбираемыхОбъектов(Тип, ПредельноеКоличество) +``` +
+ +## ПриОпределенииПредельногоКоличестваОбъектовВСообщенииОбмена +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить предельное количество объектов, которые будут выгружены в сообщение +// обмена с 1С:Документооборот. +// +// Параметры: +// ПредельноеКоличествоОбъектовВСообщении - Число - предельное количество объектов. +// +// Пример: +// ПредельноеКоличествоОбъектовВСообщении = 100; +// +Процедура ПриОпределенииПредельногоКоличестваОбъектовВСообщенииОбмена(ПредельноеКоличествоОбъектовВСообщении) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииПредельногоКоличестваОбъектовВСообщенииОбмена(ПредельноеКоличествоОбъектовВСообщении) +``` +
+ +## ПриОпределенииПредставленияВидаОбъектаПотребителя +
+ +Описание, пример вызова + +```bsl + +// Переопределяет представление вида объекта интегрируемой конфигурации. +// +// Параметры: +// Правило - СправочникОбъект.ПравилаИнтеграцииС1СДокументооборотом +// - СправочникОбъект.ПравилаИнтеграцииС1СДокументооборотом3 - правило, для которого +// определяется представление. +// ПредставлениеВидаОбъектаПотребителя - Строка - неявно возвращаемое значение, переопределяемое представление +// вида объекта. По умолчанию определяется как представление объекта с ключевыми реквизитами. +// +// Пример: +// Если Правило.ТипОбъектаИС = "Документ.ПоступлениеТоваровУслуг" Тогда +// СтруктураПоиска = Новый Структура; +// СтруктураПоиска.Вставить("Ключевой", Истина); +// СтруктураПоиска.Вставить("ИмяРеквизитаОбъектаИС", "ВидОперации"); +// КлючевыеРеквизиты = Правило.ПравилаЗаполненияРеквизитовИС.НайтиСтроки(СтруктураПоиска); +// Если КлючевыеРеквизиты.Количество() > 0 Тогда +// ВидОперации = КлючевыеРеквизиты[0].ЗначениеРеквизитаИС; +// Если ВидОперации = Перечисления.ВидыОперацийПоступлениеТоваровУслуг.Товары Тогда +// ПредставлениеВидаОбъектаПотребителя = НСтр("ru = 'Товары (накладная)'"); +// КонецЕсли; +// КонецЕсли; +// КонецЕсли; +// +Процедура ПриОпределенииПредставленияВидаОбъектаПотребителя(Правило, ПредставлениеВидаОбъектаПотребителя) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииПредставленияВидаОбъектаПотребителя(Правило, ПредставлениеВидаОбъектаПотребителя) +``` +
+ +## ПриОпределенииПредставленияОбъектаПотребителя +
+ +Описание, пример вызова + +```bsl + +// Переопределяет представление объекта интегрируемой конфигурации. Используется, если стандартное +// представление из синонима и ключевых реквизитов через запятую оказывается недостаточно читабельным. +// +// Параметры: +// Правило - СправочникОбъект.ПравилаИнтеграцииС1СДокументооборотом +// - СправочникОбъект.ПравилаИнтеграцииС1СДокументооборотом3 - правило, для которого +// определяется представление. +// ПредставлениеОбъектаПотребителя - Строка - неявно возвращаемое значение, переопределяемое представление +// объекта. По умолчанию собирается из синонима объекта и значений ключевых реквизитов правила. +// +// Пример: +// Если Правило.ТипОбъектаИС = "Документ.ПоступлениеТоваровУслуг" Тогда +// СтруктураПоиска = Новый Структура; +// СтруктураПоиска.Вставить("Ключевой", Истина); +// СтруктураПоиска.Вставить("ИмяРеквизитаОбъектаИС", "ВидОперации"); +// КлючевыеРеквизиты = Правило.ПравилаЗаполненияРеквизитовИС.НайтиСтроки(СтруктураПоиска); +// Если КлючевыеРеквизиты.Количество() > 0 Тогда +// ВидОперации = КлючевыеРеквизиты[0].ЗначениеРеквизитаИС; +// Если ВидОперации = Перечисления.ВидыОперацийПоступлениеТоваровУслуг.Товары Тогда +// ПредставлениеОбъектаПотребителя = НСтр("ru = 'Поступление товаров'"); +// ИначеЕсли ВидОперации = Перечисления.ВидыОперацийПоступлениеТоваровУслуг.Услуги Тогда +// ПредставлениеОбъектаПотребителя = НСтр("ru = 'Поступление услуг'"); +// КонецЕсли; +// КонецЕсли; +// КонецЕсли; +// +Процедура ПриОпределенииПредставленияОбъектаПотребителя(Правило, ПредставлениеОбъектаПотребителя) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииПредставленияОбъектаПотребителя(Правило, ПредставлениеОбъектаПотребителя) +``` +
+ +## ПриОпределенииРазрешенияПользователяИспользоватьИнтеграцию +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить получение доступности интеграции для текущего пользователя. Может переопределяться +// при отказе от использования поставляемой роли ИспользованиеИнтеграцииС1СДокументооборотом. +// +// Параметры: +// Разрешено - Булево - Истина, если использование интеграции разрешено. +// +Процедура ПриОпределенииРазрешенияПользователяИспользоватьИнтеграцию(Разрешено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииРазрешенияПользователяИспользоватьИнтеграцию(Разрешено) +``` +
+ +## ПриОпределенииРазрешенияПользователяНаЗапускСогласования +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить получение возможности запуска согласования в ДО. +// +// Параметры: +// ПредметСогласования - ЛюбаяСсылка - согласуемый объект ИС. +// ТекстПредупреждения - Строка - неявно возвращаемое значение, текст предупреждения. +// Разрешено - Булево - Истина, если запуск согласования разрешен, Ложь - запрещен, Неопределено - согласно ролям. +// +// Пример: +// Если ТипЗнч(ПредметСогласования) = Тип("ДокументСсылка._ДемоЗаказПокупателя") Тогда +// Если ПредметСогласования.Состояние <> Перечисления._ДемоСостоянияЗаказаПокупателя.НаСогласовании Тогда +// ТекстПредупреждения = НСтр("ru = 'Создание процесса согласования разрешено только на основании +// |документов в состоянии ""На согласовании"".'"); +// Разрешено = Ложь; +// КонецЕсли; +// КонецЕсли; +// +Процедура ПриОпределенииРазрешенияПользователяНаЗапускСогласования(ПредметСогласования, ТекстПредупреждения, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииРазрешенияПользователяНаЗапускСогласования(ПредметСогласования, ТекстПредупреждения, ); +``` +
+ +## ПриОпределенииРазрешенияПользователяНаПрерываниеСогласования +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить получение возможности прерывания согласования в ДО. +// +// Параметры: +// ПредметСогласования - ЛюбаяСсылка - согласуемый объект ИС. +// ПредметДО - Структура - описание связанного объекта ДО: +// name - Строка - представление связанного объекта. +// ID - Строка - идентификатор связанного объекта. +// type - Строка - имя типа XDTO. +// ТекстПредупреждения - Строка - неявно возвращаемое значение, текст предупреждения. +// Разрешено- Булево - Истина, если прерывание согласования разрешено, Ложь - запрещено, Неопределено - согласно ролям. +// +Процедура ПриОпределенииРазрешенияПользователяНаПрерываниеСогласования(ПредметСогласования, ПредметДО, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииРазрешенияПользователяНаПрерываниеСогласования(ПредметСогласования, ПредметДО, ); +``` +
+ +## ПриОпределенииСокращенногоНаименованияКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Уточняет сокращенное наименование интегрируемой конфигурации для вывода в заголовках и декорациях. +// +// Параметры: +// СокращенноеНаименование - Строка - неявно возвращаемое значение, краткое название конфигурации. +// +// Пример: +// СокращенноеНаименование = НСтр("ru = '1С:ERP УП'"); +// +Процедура ПриОпределенииСокращенногоНаименованияКонфигурации(СокращенноеНаименование) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииСокращенногоНаименованияКонфигурации(СокращенноеНаименование) +``` +
+ +## ПриОпределенииТаймаутаСервиса +
+ +Описание, пример вызова + +```bsl + +// Вызывается при определении таймаута веб-сервиса. При необходимости таймаут может быть вынесен в +// настройки администратора интеграции и переопределен в этой процедуре. +// +// Параметры: +// Таймаут - Число - неявно возвращаемое значение, время в секундах, по истечении которого вызов +// веб-сервиса Документооборота считается неудачным. +// +Процедура ПриОпределенииТаймаутаСервиса(Таймаут) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииТаймаутаСервиса(Таймаут) +``` +
+ +## ПриОпределенииТиповОбъектовПоддерживающихИнтеграцию +
+ +Описание, пример вызова + +```bsl + +// Переопределяет типы объектов ИС, поддерживающие бесшовную интеграцию. По умолчанию заполняется всеми +// типами, входящими в состав типов параметров общих команд подсистемы ИнтеграцияС1СДокументооборотом. +// +// Параметры: +// Типы - Массив из Тип - массив объектов типа Тип. +// +Процедура ПриОпределенииТиповОбъектовПоддерживающихИнтеграцию(Типы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииТиповОбъектовПоддерживающихИнтеграцию(Типы) +``` +
+ +## ПриОпределенииШтрихкодаДокумента +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить получение штрихкода документа для присвоения связанному документу ДО. +// +// Параметры: +// Документ - ЛюбаяСсылка - объект ИС, на основании которого создается документ ДО. +// Штрихкод - Строка - штрихкод для присвоения связанному документу ДО. +// +// Пример: +// Если ПолучитьФункциональнуюОпцию("ИспользоватьШтрихкодированиеПечатныхФормОбъектов") Тогда +// ШестнадцатиричноеЧисло = НРег(СтрЗаменить(Документ.УникальныйИдентификатор(), "-", "")); +// ДлинаСтроки = СтрДлина(ШестнадцатиричноеЧисло); +// Результат = 0; +// Для НомерСимвола = 1 По ДлинаСтроки Цикл +// Результат = Результат * 16 + Найти("0123456789abcdef", +// Сред(ШестнадцатиричноеЧисло, НомерСимвола, 1)) - 1; +// КонецЦикла; +// Штрихкод = Формат(Результат, "ЧГ=0"); +// Иначе +// Штрихкод = ""; +// КонецЕсли; +// +Процедура ПриОпределенииШтрихкодаДокумента(Документ, Штрихкод) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриОпределенииШтрихкодаДокумента(Документ, Штрихкод) +``` +
+ +## ПриПолученииWSПрокси +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении WSПрокси. Переопределяется, если в конфигурации есть возможность настройки интернет-прокси. +// +// Параметры: +// ИнтернетПрокси - Неопределено - неявно возвращаемое значение, может быть инициализировано значением +// типа ИнтернетПрокси. +// +Процедура ПриПолученииWSПрокси(ИнтернетПрокси) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриПолученииWSПрокси(ИнтернетПрокси) +``` +
+ +## ПриПолученииТаблицыЗависимостиКонстант +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить или дополнить список зависимых друг от друга констант. Необходимо, когда при +// включении одной константы, какие-либо другие константы должны выключаться и наоборот. +// +// Параметры: +// ТаблицаКонстант - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗависимостиКонстант +// +// Пример: +// ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуТаблицыЗависимостиКонстант( +// ТаблицаКонстант, +// "ИспользоватьСогласованиеЧерез1СДокументооборот", +// Истина, +// "ИспользоватьВнутреннееСогласованиеЗаявокНаВозвратТоваровОтКлиентов", +// Ложь); +// +Процедура ПриПолученииТаблицыЗависимостиКонстант(ТаблицаКонстант) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриПолученииТаблицыЗависимостиКонстант(ТаблицаКонстант) +``` +
+ +## ПриПолученииТокенаДоступа +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить получение JWT-токена для авторизации в веб-сервисе Документооборота. +// +// Параметры: +// ТекстТокенаДоступа - Строка - неявно возвращаемое значение, JWT-токен строкой. +// +// Пример: +// ТокенДоступа = Новый ТокенДоступа; +// ПараметрыТокена = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПараметрыТокенаДоступа(); +// ЗаполнитьЗначенияСвойств(ТокенДоступа, ПараметрыТокена); +// КлючПодписиТокена = Константы.КлючПодписиТокенаДоступа1СДокументооборот.Получить(); +// ТокенДоступа.Подписать(АлгоритмПодписиТокенаДоступа.HS256, КлючПодписиТокена); +// ТекстТокенаДоступа = Строка(ТокенДоступа); +// +Процедура ПриПолученииТокенаДоступа(ТекстТокенаДоступа) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриПолученииТокенаДоступа(ТекстТокенаДоступа) +``` +
+ +## ПриПроверкеСоответствияПравилаФункциональнымОпциям +
+ +Описание, пример вызова + +```bsl + +// Проверяет соответствие правила интеграции функциональным опциям. Вызывается при выборе подходящего правила +// и позволяет отказаться от правил, связанных с объектами, выключенными по ФО. +// +// Параметры: +// Правило - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом - проверяемое правило. +// ТипОбъектаДО - Строка - Тип объекта ДО. +// ТипОбъектаИС - Строка - Тип объекта ИС (полное имя в метаданных). +// Отказ - Булево - при установке в Истина правило не будет использоваться. +// ИмяКлючевогоРеквизита - Строка - имя ключевого реквизита правила. +// ЗначениеКлючевогоРеквизита - Произвольный - значение ключевого реквизита правила. +// +// Пример: +// Если ТипОбъектаИС = "Документ.ПоступлениеНМА" +// И Не ПолучитьФункциональнуюОпцию("ВедетсяУчетНМА") Тогда +// Отказ = Истина; +// Возврат; +// КонецЕсли; +// +Процедура ПриПроверкеСоответствияПравилаФункциональнымОпциям(Правило, ТипОбъектаДО, ТипОбъектаИС, Отказ, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриПроверкеСоответствияПравилаФункциональнымОпциям(Правило, ТипОбъектаДО, ТипОбъектаИС, Отказ, ); +``` +
+ +## ПриСозданииНаСервереФормыВыбораПравила +
+ +Описание, пример вызова + +```bsl + +// Переопределяет представление формы выбора правила интеграции. Используется при неоднозначности правил и +// позволяет предложить пользователю менее техногенную форму выбора. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма ВыборПравила обработки ИнтеграцияС1СДокументооборот. +// +// Пример: +// Форма.Заголовок = НСтр("ru = 'Форма документа'"); +// Форма.Автозаголовок = Ложь; +// Форма.Пояснение = НСтр("ru = 'Выберите вид документа:'"); +// Форма.Элементы.Пояснение.Видимость = Истина; +// +Процедура ПриСозданииНаСервереФормыВыбораПравила(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриСозданииНаСервереФормыВыбораПравила(Форма) +``` +
+ +## ПриСозданииПоСсылке +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании объекта ИС по ссылке в реквизите объекта ДО. Может использоваться для +// дозаполнения реквизитов нового объекта ИС, например, если стандартный обработчик заполнения не +// заполняет обязательные реквизиты по умолчанию. +// Внимание, поскольку данная процедура может выполняться в ходе обмена данными с ДО, в ней +// не рекомендуется выполнять никакие обращения к веб-сервису ДО, а также получать прокси сервиса ДО. +// +// Параметры: +// ОбъектИС - Произвольный - созданный, но еще не записанный объект ИС. +// ОбъектXDTO - ОбъектXDTO - исходный объект, соответствие которому не найдено в текущей ИБ. +// ЗаполняемыйОбъектИС - Произвольный - объект ИС, в ходе заполнения которого вызывается создание +// ОбъектИС по ссылке. Обеспечивает контекст, необходимый для заполнения ОбъектИС. +// +// Пример: +// Если ТипЗнч(ОбъектИС) = Тип("СправочникОбъект._ДемоОрганизации") Тогда +// ОбъектИС.ЮрФизЛицо = Перечисления.ЮрФизЛицо.ЮрЛицо; +// Если ОбъектXDTO.objectID.type = "DMOrganization" +// И ОбъектXDTO.objectID.ID = "ИндивидуальныйПредприниматель" Тогда +// ОбъектИС.ЮрФизЛицо = Перечисления.ЮрФизЛицо.ИндивидуальныйПредприниматель; +// КонецЕсли; +// КонецЕсли; +// Если ТипЗнч(ОбъектИС) = Тип("СправочникОбъект._ДемоБанковскиеСчета") +// И ОбъектXDTO.objectID.type = "DMBankAccount" Тогда +// ОбъектИС.НомерСчета = ОбъектXDTO.number; +// КонецЕсли; +// +Процедура ПриСозданииПоСсылке(ОбъектИС, ОбъектXDTO, ЗаполняемыйОбъектИС = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриСозданииПоСсылке(ОбъектИС, ОбъектXDTO, ЗаполняемыйОбъектИС); +``` +
+ +## ПриУстановкеПравилаЗаполненияПриВыгрузкеПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить установку правила заполнения при выгрузке по умолчанию. +// +// Параметры: +// ПравилаЗаполнения - Соответствие из КлючИЗначение - соответствие имен реквизитов свойствам XDTO: +// * Ключ - Строка - имя реквизита. +// * Значение - Строка - наименование свойства XDTO. +// Приемник - Строка - имя XDTO-типа приемника. +// Источник - Строка - полное имя объекта метаданных-источника. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная обработка +// производиться не будет. +// +Процедура ПриУстановкеПравилаЗаполненияПриВыгрузкеПоУмолчанию(ПравилаЗаполнения, Приемник, Источник, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриУстановкеПравилаЗаполненияПриВыгрузкеПоУмолчанию(ПравилаЗаполнения, Приемник, Источник, ); +``` +
+ +## ПриУстановкеПравилаЗаполненияПриЗагрузкеПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить установку правила заполнения при загрузке по умолчанию. +// +// Параметры: +// ПравилаЗаполнения - Соответствие из КлючИЗначение - соответствие имен реквизитов свойствам XDTO: +// * Ключ - Строка - имя реквизита. +// * Значение - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПравилоЗаполненияИзРеквизитаОбъектаДО +// Приемник - Строка - полное имя объекта метаданных-приемника. +// Источник - Строка - имя XDTO-типа источника. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная обработка +// производиться не будет. +// +Процедура ПриУстановкеПравилаЗаполненияПриЗагрузкеПоУмолчанию(ПравилаЗаполнения, Приемник, Источник, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПриУстановкеПравилаЗаполненияПриЗагрузкеПоУмолчанию(ПравилаЗаполнения, Приемник, Источник, ); +``` +
+ +## ПроверитьСоответствиеОпределяемыхТиповИПланаОбмена +
+ +Описание, пример вызова + +```bsl + +// Вызывается при обновлении БИД, и сверяет корректность состав определяемых типов с планом обмена. +// +// Параметры: +// Ошибки - Массив из Строка - список ошибок, выявленных в ходе проверки. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная проверка +// производиться не будет. +// +Процедура ПроверитьСоответствиеОпределяемыхТиповИПланаОбмена(Ошибки, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПроверитьСоответствиеОпределяемыхТиповИПланаОбмена(Ошибки, СтандартнаяОбработка) +``` +
+ +## ПроверитьСоответствиеОпределяемыхТиповМеждуСобой +
+ +Описание, пример вызова + +```bsl + +// Вызывается при обновлении БИД, и сверяет корректность состав определяемых типов между собой. +// +// Параметры: +// Ошибки - Массив из Строка - список ошибок, выявленных в ходе проверки. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная проверка +// производиться не будет. +// +Процедура ПроверитьСоответствиеОпределяемыхТиповМеждуСобой(Ошибки, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.ПроверитьСоответствиеОпределяемыхТиповМеждуСобой(Ошибки, СтандартнаяОбработка) +``` +
+ +## УстановитьРежимыИзмененияВПроведенномДокументе +
+ +Описание, пример вызова + +```bsl + +// Устанавливает доступные для выбора режимы изменения реквизита в проведенном документе. +// +// Параметры: +// ТипОбъектаИС - Строка - представление типа объекта интегрированной системы. +// РеквизитИС - Строка - представление реквизита интегрированной системы. +// СписокВыбора - СписокЗначений из ПеречислениеСсылка.РежимИзмененияПроведенногоДокументаДанными1СДокументооборота - +// доступные значения режимов изменения реквизита. +// +// Пример: +// Если ТипОбъектаИС = "Документ.ЗаказКлиента" И РеквизитИС = "Статус" Тогда +// СписокВыбора.Очистить(); +// СписокВыбора.Добавить( +// Перечисления.РежимИзмененияПроведенногоДокументаДанными1СДокументооборота.РазрешеноСПерепроведением); +// СписокВыбора.Добавить( +// Перечисления.РежимИзмененияПроведенногоДокументаДанными1СДокументооборота.Запрещено); +// КонецЕсли; +// +Процедура УстановитьРежимыИзмененияВПроведенномДокументе(ТипОбъектаИС, РеквизитИС, СписокВыбора) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотБазоваяФункциональностьПереопределяемый.УстановитьРежимыИзмененияВПроведенномДокументе(ТипОбъектаИС, РеквизитИС, СписокВыбора) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборотКлиент.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборотКлиент.md new file mode 100644 index 0000000..b6e1a7d --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборотКлиент.md @@ -0,0 +1,2173 @@ +--- +title: Интеграция с 1С документооборот клиент +slug: zup/интеграция-с-1с-документооборот-клиент +--- + + +## ВыбратьПользователяИзДереваПодразделений +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора пользователей в разрезе подразделений и помещает выбранного пользователя в реквизит формы. +// +// Параметры: +// Реквизит - Строка - имя реквизита формы, в который будет помещен выбранный пользователь. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызывается форма выбора пользователя. +// +Процедура ВыбратьПользователяИзДереваПодразделений(Реквизит, ФормаВладелец) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыбратьПользователяИзДереваПодразделений(Реквизит, ФормаВладелец) +``` +
+ +## ВыбратьЗначениеРеквизитаСоставногоТипаВТаблице +
+ +Описание, пример вызова + +```bsl + +// Открывает форму для указания значения реквизита составного типа. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, на которой осуществляется работа с реквизитом +// и из которой вызывается форма заполнения. +// ТекущиеДанные - ДанныеФормыЭлементКоллекции +// Реквизит - Строка - имя реквизита из ТекущиеДанные. +// СтандартнаяОбработка - Булево- параметр обработки, используемый в обработчике на форме, +// из которой вызывается заполнение значения доп. реквизита. +// +Процедура ВыбратьЗначениеРеквизитаСоставногоТипаВТаблице(Форма, ТекущиеДанные, Реквизит, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыбратьЗначениеРеквизитаСоставногоТипаВТаблице(Форма, ТекущиеДанные, Реквизит, СтандартнаяОбработка) +``` +
+ +## ВыполнитьПодключаемуюКомандуИнтеграцииЗавершение +
+ +Описание, пример вызова + +```bsl + +// Продолжает выполнение подключаемой команды интеграции после проверки подключения. +// +// Параметры: +// Команда - КомандаФормы - вызванная команда. +// Форма - ФормаКлиентскогоПриложения - форма, из которой вызывается команда. +// Источник - ДанныеФормыСтруктура +// +Процедура ВыполнитьПодключаемуюКомандуИнтеграцииЗавершение(Команда, Форма, Источник) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыполнитьПодключаемуюКомандуИнтеграцииЗавершение(Команда, Форма, Источник) +``` +
+ +## ОчиститьСсылочныйРеквизит +
+ +Описание, пример вызова + +```bsl + +// Очищает ID и Тип при очистке реквизита объекта Документооборота на форме. +// +// Параметры: +// Реквизит - Строка - имя реквизита формы. +// ФормаВладелец - ФормаКлиентскогоПриложения - управляемая форма, содержащая очищаемые реквизиты. +// +Процедура ОчиститьСсылочныйРеквизит(Реквизит, ФормаВладелец) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОчиститьСсылочныйРеквизит(Реквизит, ФормаВладелец) +``` +
+ +## ПрименитьВыборЗначенияРеквизитаВСписке +
+ +Описание, пример вызова + +```bsl + +// Устанавливает выбранное значение в элемент списка. +// +// Параметры: +// ЭлементСписок - ТаблицаФормы - элемент управляемой формы. +// ВыбранноеЗначение - Структура: +// * ID - Строка - идентификатор объекта. +// * type - Строка - тип объекта. +// * name - Строка - представление объекта. +// СтандартнаяОбработка - Булево - неявно возвращаемое значение, признак того, что стандартная обработка +// производиться не будет. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызывается метод. +// +Процедура ПрименитьВыборЗначенияРеквизитаВСписке(ЭлементСписок, ВыбранноеЗначение, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ПрименитьВыборЗначенияРеквизитаВСписке(ЭлементСписок, ВыбранноеЗначение, ); +``` +
+ +## Оповестить_ЗаписьДокумента +
+ +Описание, пример вызова + +```bsl + +// Создает оповещение при записи документов Документооборота. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма документа Документооборота. +// +Процедура Оповестить_ЗаписьДокумента(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.Оповестить_ЗаписьДокумента(Форма) +``` +
+ +## Оповестить_ЗаписьБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Создает оповещение при записи бизнес-процессов Документооборота. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма бизнес-процесса Документооборота. +// Стартован - Булево - признак, указывающий запущен ли бизнес-процесс. +// +Процедура Оповестить_ЗаписьБизнесПроцесса(Форма, Стартован) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.Оповестить_ЗаписьБизнесПроцесса(Форма, Стартован) +``` +
+ +## Оповестить_ЗаписьИсходящегоПисьма +
+ +Описание, пример вызова + +```bsl + +// Создает оповещение при записи исходящего письма Документооборота. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма исходящего письма Документооборота. +// +Процедура Оповестить_ЗаписьИсходящегоПисьма(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.Оповестить_ЗаписьИсходящегоПисьма(Форма) +``` +
+ +## Оповестить_ЗаписьОбъекта +
+ +Описание, пример вызова + +```bsl + +// Создает оповещение при записи объекта Документооборота. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта Документооборота. +// ВнешнийОбъект - ЛюбаяСсылка - ссылка на объект ИС. +// +Процедура Оповестить_ЗаписьОбъекта(Форма, ВнешнийОбъект = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.Оповестить_ЗаписьОбъекта(Форма, ВнешнийОбъект); +``` +
+ +## ВыбратьЗначениеИзСписка +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора значения из списка объектов Документооборота и помещает выбранное значение на форме. +// +// Параметры: +// ТипОбъектаВыбора - Строка - имя класса XDTO, соответствующего типу выбираемого объекта. +// Реквизит - Строка - имя реквизита формы, в который будет помещено значение, выбранное из документооборота. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызывается форма выбора. +// Отбор - Структура - условия, накладываемые на список. +// +Процедура ВыбратьЗначениеИзСписка(ТипОбъектаВыбора, Реквизит, ФормаВладелец, Отбор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыбратьЗначениеИзСписка(ТипОбъектаВыбора, Реквизит, ФормаВладелец, Отбор); +``` +
+ +## ВыбратьЗначениеИзСпискаЗавершение +
+ +Описание, пример вызова + +```bsl + +// Обработка выбора значения из списка. +// +// Параметры: +// Результат - Структура: +// * РеквизитID - Строка +// * РеквизитПредставление - Строка +// * РеквизитТип - Строка +// Параметры - Структура: +// * Реквизит - Строка +// * ФормаВладелец - ФормаКлиентскогоПриложения +// +Процедура ВыбратьЗначениеИзСпискаЗавершение(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыбратьЗначениеИзСпискаЗавершение(Результат, Параметры) +``` +
+ +## ВыбратьЗначениеИзСпискаВТаблице +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора значения реквизита в таблице из списка объектов Документооборота. +// +// Параметры: +// ТипОбъектаВыбора - Строка - имя класса XDTO, соответствующего типу выбираемого объекта. +// Реквизит - Строка - имя реквизита формы, в который будет помещено значение, выбранное из документооборота. +// ТекущиеДанные - ДанныеФормыЭлементКоллекции +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызывается форма выбора. +// Отбор - Структура - условия, накладываемые на список. +// +Процедура ВыбратьЗначениеИзСпискаВТаблице(ТипОбъектаВыбора, Реквизит, ТекущиеДанные, ФормаВладелец, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыбратьЗначениеИзСпискаВТаблице(ТипОбъектаВыбора, Реквизит, ТекущиеДанные, ФормаВладелец, ); +``` +
+ +## ВыбратьЗначениеИзСпискаВТаблицеЗавершение +
+ +Описание, пример вызова + +```bsl + +// Обработка выбора значения в таблице из списка. +// +// Параметры: +// Результат - Структура: +// * РеквизитID - Строка +// * РеквизитПредставление - Строка +// * РеквизитТип - Строка +// Параметры - Структура: +// * Реквизит - Строка +// * ФормаВладелец - ФормаКлиентскогоПриложения +// * ТекущиеДанные - ДанныеФормыЭлементКоллекции +// +Процедура ВыбратьЗначениеИзСпискаВТаблицеЗавершение(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыбратьЗначениеИзСпискаВТаблицеЗавершение(Результат, Параметры) +``` +
+ +## ВыбратьЗначениеИзВыпадающегоСписка +
+ +Описание, пример вызова + +```bsl + +// Открывает список выбора значения из списка объектов документооборота и помещает выбранное значение на форме. +// +// Параметры: +// ТипОбъектаВыбора - Строка - имя класса XDTO, соответствующего типу выбираемого объекта. +// Реквизит - Строка - имя реквизита формы, в который будет помещено значение, выбранное из документооборота. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызывается форма выбора. +// Отбор - Структура - условия, накладываемые на список. +// ЭтоТаблица - Булево - указывает что значение выбирается в табличной части. +// Элемент - ПолеФормы - элемент формы, в котором выбирается значение. +// +Процедура ВыбратьЗначениеИзВыпадающегоСписка(ТипОбъектаВыбора, Реквизит, ФормаВладелец, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыбратьЗначениеИзВыпадающегоСписка(ТипОбъектаВыбора, Реквизит, ФормаВладелец, ); +``` +
+ +## ВыбратьЗначениеИзВыпадающегоСпискаЗавершение +
+ +Описание, пример вызова + +```bsl + +// Обработка выбора значения из выпадающего списка. +// +// Параметры: +// Результат - Произвольный +// Параметры - Структура: +// * Форма - ФормаКлиентскогоПриложения +// * Элемент - ТаблицаФормы +// +Процедура ВыбратьЗначениеИзВыпадающегоСпискаЗавершение(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыбратьЗначениеИзВыпадающегоСпискаЗавершение(Результат, Параметры) +``` +
+ +## ВыбратьЗначениеПоТипуОбъекта +
+ +Описание, пример вызова + +```bsl + +// Начинает процесс выбора объекта ДО указанного типа, возвращая результат вызовом оповещения. +// +// Параметры: +// ОписаниеОповещения - ОписаниеОповещения - вызывается после завершения выбора с передачей структуры, +// описывающей выбранный объект. +// ТипОбъектаВыбора - Строка - тип выбираемого объекта (XDTO, например, "DMCorrespondent"). +// Отбор - Структура - накладываемый отбор. +// ВыбранноеЗначение - Строка - идентификатор ранее выбранного значения. +// ФормаВладелец - ФормаКлиентскогоПриложения - форма, из которой вызван выбор. +// +Процедура ВыбратьЗначениеПоТипуОбъекта(ОписаниеОповещения, ТипОбъектаВыбора, Отбор = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыбратьЗначениеПоТипуОбъекта(ОписаниеОповещения, ТипОбъектаВыбора, Отбор, ); +``` +
+ +## УстановитьПометкуКнопкиПереключитьХронометраж +
+ +Описание, пример вызова + +```bsl + +// Вызывается после переключения хронометража в форме объекта ИС. +// +// Параметры: +// Результат - Булево +// ПараметрыОповещения - ЭлементыФормы +// +Процедура УстановитьПометкуКнопкиПереключитьХронометраж(Результат, ПараметрыОповещения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.УстановитьПометкуКнопкиПереключитьХронометраж(Результат, ПараметрыОповещения) +``` +
+ +## ПолучитьДлительностьРаботы +
+ +Описание, пример вызова + +```bsl + +// Возвращает длительность работы в секундах от начала события до текущей даты. +// +// Параметры: +// ДатаНачалаХронометража - Дата - дата начала хронометраже. +// +// Возвращаемое значение: +// Число - длительность работы в секундах. +// +Функция ПолучитьДлительностьРаботы(ДатаНачалаХронометража) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиент.ПолучитьДлительностьРаботы(ДатаНачалаХронометража) +``` +
+ +## НачатьСозданиеСвязанногоОбъектаДО +
+ +Описание, пример вызова + +```bsl + +// Выполняет создание объекта ДО, его заполнение по объекту ИС и установку связи после записи. При +// необходимости предлагает пользователю выбор правила. +// +// Параметры: +// ОбъектИС - ОпределяемыйТип.ИнтеграцияС1СДокументооборотВсеСсылкиПереопределяемый - объект ИС, +// на основании которого создается объект ДО. +// ОписаниеОповещения - ОписаниеОповещения - обработчик, вызываемый после создания. +// ОткрытьФорму - Булево - Истина, если нужно открыть форму созданного объекта, и Ложь, если +// связанный объект следует создать молча. В случае ошибок записи форма все равно будет открыта. +// +Процедура НачатьСозданиеСвязанногоОбъектаДО(ОбъектИС, ОписаниеОповещения, ОткрытьФорму = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьСозданиеСвязанногоОбъектаДО(ОбъектИС, ОписаниеОповещения, ОткрытьФорму); +``` +
+ +## НачатьСозданиеСвязанногоОбъектаДОПослеВыбораТипа +
+ +Описание, пример вызова + +```bsl + +// Продолжает создание объекта ДО после выбора типа. +// +// Параметры: +// Тип - Строка - тип создаваемого объекта, например, "DMInternalDocument". +// Параметры - Структура: +// ОбъектИС - Произвольный - объект ИС, на основании которого создается объект ДО. +// ОписаниеОповещения - ОписаниеОповещения - обработчик, вызываемый после создания. +// ОткрытьФорму - Булево - Истина, если нужно открыть форму созданного объекта, и Ложь, если +// связанный объект следует создать молча. +// +Процедура НачатьСозданиеСвязанногоОбъектаДОПослеВыбораТипа(Тип, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьСозданиеСвязанногоОбъектаДОПослеВыбораТипа(Тип, Параметры) +``` +
+ +## НачатьСозданиеСвязанногоОбъектаДОПослеВыбораПравила +
+ +Описание, пример вызова + +```bsl + +// Выполняет создание объекта ДО, его заполнение по объекту ИС и установку связи после записи. При +// необходимости предлагает пользователю выбор правила. +// +// Параметры: +// Правило - Структура - подходящее правило: +// Ссылка - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом. +// ТипОбъектаИС - Строка. +// ТипОбъектаДО - Строка. +// ПредставлениеОбъектаИС - Строка. +// ПредставлениеОбъектаДО - Строка. +// Параметры - Структура: +// ОбъектИС - Произвольный - объект ИС, на основании которого создается объект ДО. +// ОписаниеОповещения - ОписаниеОповещения - обработчик, вызываемый после создания. +// ОткрытьФорму - Булево - Истина, если нужно открыть форму созданного объекта, и Ложь, если +// связанный объект следует создать молча. +// +Процедура НачатьСозданиеСвязанногоОбъектаДОПослеВыбораПравила(Правило, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьСозданиеСвязанногоОбъектаДОПослеВыбораПравила(Правило, Параметры) +``` +
+ +## НачатьСозданиеСвязанногоОбъектаДОПослеПредупреждения +
+ +Описание, пример вызова + +```bsl + +// Продолжает создание связанного объекта ДО после показа предупреждение о невозможности записи +// автоматически созданного объекта. Открывает его форму для интерактивного заполнения. +// +// Параметры: +// Параметры - Структура: +// ОбъектИС - Произвольный - объект ИС, на основании которого создается объект ДО. +// ОписаниеОповещения - ОписаниеОповещения - обработчик, вызываемый после создания. +// ОткрытьФорму - Булево - Истина, если нужно открыть форму созданного объекта, и Ложь, если +// связанный объект следует создать молча. +// +Процедура НачатьСозданиеСвязанногоОбъектаДОПослеПредупреждения(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьСозданиеСвязанногоОбъектаДОПослеПредупреждения(Параметры) +``` +
+ +## СоздатьИнтегрированныйОбъектПоДаннымФормы +
+ +Описание, пример вызова + +```bsl + +// Создает объект ИС по данным формы объекта ДО. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта Документооборота или иная форма, требующая оповещения. +// Правило - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом - используемое правило. +// +Процедура СоздатьИнтегрированныйОбъектПоДаннымФормы(Форма, Правило) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СоздатьИнтегрированныйОбъектПоДаннымФормы(Форма, Правило) +``` +
+ +## СоздатьИнтегрированныйОбъектПоТипу +
+ +Описание, пример вызова + +```bsl + +// Создает объект ИС по указанному объекту ДО и известному типу. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта ДО или иная форма, требующая оповещения. +// ТипОбъектаИС - Строка - тип объекта ИС. +// ТипОбъектаДО - Строка - тип объекта ДО. +// ИдентификаторОбъектаДО - Строка - идентификатор объекта ДО. +// +Процедура СоздатьИнтегрированныйОбъектПоТипу(Форма, ТипОбъектаИС, ТипОбъектаДО, ИдентификаторОбъектаДО) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СоздатьИнтегрированныйОбъектПоТипу(Форма, ТипОбъектаИС, ТипОбъектаДО, ИдентификаторОбъектаДО) +``` +
+ +## СоздатьИнтегрированныйОбъектПоТипуПослеВыбораПравила +
+ +Описание, пример вызова + +```bsl + +// Продолжает создание объекта ИС при неоднозначности правил после выбора правила. +// +// Параметры: +// Результат - Структура: +// * Ссылка - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом - выбранное правило. +// Параметры - Структура: +// * Форма - ФормаКлиентскогоПриложения - форма объекта ДО или иная форма, требующая оповещения. +// * ТипОбъектаДО - Строка - тип объекта ДО. +// * ИдентификаторОбъектаДО - Строка - идентификатор объекта ДО. +// +Процедура СоздатьИнтегрированныйОбъектПоТипуПослеВыбораПравила(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СоздатьИнтегрированныйОбъектПоТипуПослеВыбораПравила(Результат, Параметры) +``` +
+ +## СоздатьИнтегрированныйОбъектПоПравилу +
+ +Описание, пример вызова + +```bsl + +// Создает объект ИС по указанному объекту ДО, заполняет его и устанавливает связь. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта ДО или иная форма, требующая оповещения. +// Правило - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом - используемое правило. +// ТипОбъектаДО - Строка - тип объекта ДО. +// ИдентификаторОбъектаДО - Строка - идентификатор объекта ДО. +// +Процедура СоздатьИнтегрированныйОбъектПоПравилу(Форма, Правило, ТипОбъектаДО, ИдентификаторОбъектаДО) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СоздатьИнтегрированныйОбъектПоПравилу(Форма, Правило, ТипОбъектаДО, ИдентификаторОбъектаДО) +``` +
+ +## СоздатьИнтегрированныйОбъектБезПравила +
+ +Описание, пример вызова + +```bsl + +// Создает объект ИС по указанному объекту ДО, заполняет его и устанавливает связь. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма объекта ДО или иная форма, требующая оповещения. +// ТипОбъектаИС - Строка - полное имя типа объекта ИС. +// ТипОбъектаДО - Строка - тип объекта ДО. +// ИдентификаторОбъектаДО - Строка - идентификатор объекта ДО. +// +Процедура СоздатьИнтегрированныйОбъектБезПравила(Форма, ТипОбъектаИС, ТипОбъектаДО, ИдентификаторОбъектаДО) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СоздатьИнтегрированныйОбъектБезПравила(Форма, ТипОбъектаИС, ТипОбъектаДО, ИдентификаторОбъектаДО) +``` +
+ +## НачатьАвтоматическуюНастройкуИнтеграции +
+ +Описание, пример вызова + +```bsl + +// Вызывается при выборе автоматической настройки интеграции. +// +// Параметры: +// ИмяТипаОбъекта - Строка - полное имя типа объекта ИС, как в метаданных. +// +Процедура НачатьАвтоматическуюНастройкуИнтеграции(ИмяТипаОбъекта) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьАвтоматическуюНастройкуИнтеграции(ИмяТипаОбъекта) +``` +
+ +## ЗаполнитьСоответствиеФорм +
+ +Описание, пример вызова + +```bsl + +// Заполняет соответствие форм БИД объектам документооборота. +// +// Параметры: +// СоответствиеФорм - Соответствие из КлючИЗначение - неявно возвращаемое значение, соответствие форм: +// * Ключ - Строка - тип объекта XDTO. +// * Значение - Строка - имя формы. +// +Процедура ЗаполнитьСоответствиеФорм(СоответствиеФорм) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ЗаполнитьСоответствиеФорм(СоответствиеФорм) +``` +
+ +## УстановитьПараметрыАвтообновленияСписка +
+ +Описание, пример вызова + +```bsl + +// Открывает модальную форму настройки автообновления списка. При завершении диалога +// устанавливает выбранные параметры автообновления списка. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - уникальный идентификатор открытой формы. +// ИмяСписка - Строка - имя реквизита списка на форме. +// +Процедура УстановитьПараметрыАвтообновленияСписка(Форма, ИмяСписка) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.УстановитьПараметрыАвтообновленияСписка(Форма, ИмяСписка) +``` +
+ +## УстановитьПараметрыАвтообновленияСпискаЗавершение +
+ +Описание, пример вызова + +```bsl + +// Завершает установку параметров автообновления списка после закрытия окна настроек. +// +// Параметры: +// Результат - Структура: +// * Автообновление - Булево. +// * ПериодАвтообновления - Число - период в секундах. +// ПараметрыОповещения - Структура: +// * Форма - ФормаКлиентскогоПриложения +// * ИмяСписка - Строка +// +Процедура УстановитьПараметрыАвтообновленияСпискаЗавершение(Результат, ПараметрыОповещения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.УстановитьПараметрыАвтообновленияСпискаЗавершение(Результат, ПараметрыОповещения) +``` +
+ +## ОткрытьСостоянияДокумента +
+ +Описание, пример вызова + +```bsl + +// Открывает окно состояний документа на редактирование или просмотр. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма обработки, соответствующая документу. +// ТолькоПросмотр - Булево - Истина, если форму следует открыть на просмотр. +// +Процедура ОткрытьСостоянияДокумента(Форма, ТолькоПросмотр = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьСостоянияДокумента(Форма, ТолькоПросмотр); +``` +
+ +## ОткрытьСостоянияДокументаЗавершение +
+ +Описание, пример вызова + +```bsl + +// После закрытия окна состояний документа переносит изменения в форму документа. +// +// Параметры: +// Результат - Структура: +// * СостояниеИсполнение - Строка +// * СостояниеИсполнениеID - Строка +// * СостояниеИсполнениеТип - Строка +// * СостояниеПодписание - Строка +// * СостояниеПодписаниеID - Строка +// * СостояниеПодписаниеТип - Строка +// * СостояниеРассмотрение - Строка +// * СостояниеРассмотрениеID - Строка +// * СостояниеРассмотрениеТип - Строка +// * СостояниеРегистрация - Строка +// * СостояниеРегистрацияID - Строка +// * СостояниеРегистрацияТип - Строка +// * СостояниеСогласование - Строка +// * СостояниеСогласованиеID - Строка +// * СостояниеСогласованиеТип - Строка +// * СостояниеУтверждение - Строка +// * СостояниеУтверждениеID - Строка +// * СостояниеУтверждениеТип - Строка +// Форма - ФормаКлиентскогоПриложения +// +Процедура ОткрытьСостоянияДокументаЗавершение(Результат, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьСостоянияДокументаЗавершение(Результат, Форма) +``` +
+ +## ОткрытьСрокДействияДокумента +
+ +Описание, пример вызова + +```bsl + +// Открывает окно изменения срока действия документа на редактирование или просмотр. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения: +// * Наименование - Строка +// ТолькоПросмотр - Булево - Истина, если форму следует открыть на просмотр. +// +Процедура ОткрытьСрокДействияДокумента(Форма, ТолькоПросмотр = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьСрокДействияДокумента(Форма, ТолькоПросмотр); +``` +
+ +## ОткрытьСрокДействияДокументаЗавершение +
+ +Описание, пример вызова + +```bsl + +// После закрытия окна срока действия документа переносит изменения в форму документа. +// +// Параметры: +// Результат - Структура: +// * Бессрочный - Булево +// * ДатаНачалаДействия - Дата +// * ДатаОкончанияДействия - Дата +// * ПорядокПродления - Строка +// * ПорядокПродленияID - Строка +// * ПорядокПродленияТип - Строка +// Форма - ФормаКлиентскогоПриложения +// +Процедура ОткрытьСрокДействияДокументаЗавершение(Результат, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьСрокДействияДокументаЗавершение(Результат, Форма) +``` +
+ +## ОткрытьВизуСогласования +
+ +Описание, пример вызова + +```bsl + +// Открывает визу согласования документа. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма документа-владельца. +// ВизаСогласования - ДанныеФормыСтруктура: +// * СогласующееЛицо - Строка +// * СогласующееЛицоID - Строка +// * СогласующееЛицоТип - Строка +// * Дата - Дата +// * Результат - Строка +// * РезультатID - Строка +// * РезультатТип - Строка +// * Комментарий - Строка +// * КартинкаСтатусаПодписи - Картинка +// * Внес - Строка +// * ВнесID - Строка +// * ВнесТип - Строка +// * ID - Строка +// * Тип - Строка +// * Наименование - Строка +// +Процедура ОткрытьВизуСогласования(Форма, ВизаСогласования) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьВизуСогласования(Форма, ВизаСогласования) +``` +
+ +## ОткрытьСоставДокумента +
+ +Описание, пример вызова + +```bsl + +// Открывает окно состава документа. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма обработки, соответствующая документу. +// +Процедура ОткрытьСоставДокумента(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьСоставДокумента(Форма) +``` +
+ +## ОткрытьСоставДокументаЗавершение +
+ +Описание, пример вызова + +```bsl + +// После закрытия окна состава документа переносит изменения в форму документа. +// +// Параметры: +// Результат - Структура: +// * КоличествоЛистов - Число +// * КоличествоПриложений - Число +// * КоличествоЭкземпляров - Число +// * ЛистовВПриложениях - Число +// Форма - ФормаКлиентскогоПриложения +// +Процедура ОткрытьСоставДокументаЗавершение(Результат, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьСоставДокументаЗавершение(Результат, Форма) +``` +
+ +## ОткрытьНоменклатуруДел +
+ +Описание, пример вызова + +```bsl + +// Открывает окно выбора номенклатуры дел. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма обработки, соответствующая документу. +// +Процедура ОткрытьНоменклатуруДел(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьНоменклатуруДел(Форма) +``` +
+ +## ОткрытьНоменклатуруДелЗавершение +
+ +Описание, пример вызова + +```bsl + +// После закрытия окна состава документа переносит изменения в форму документа. +// +// Параметры: +// Результат - Структура: +// * НоменклатураДел - Строка +// * НоменклатураДелID - Строка +// * НоменклатураДелТип - Строка +// * НоменклатураДелГод - Число +// Форма - ФормаКлиентскогоПриложения +// +Процедура ОткрытьНоменклатуруДелЗавершение(Результат, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьНоменклатуруДелЗавершение(Результат, Форма) +``` +
+ +## ОткрытьДелоХраненияДокументов +
+ +Описание, пример вызова + +```bsl + +// Открывает окно выбора дела хранения документов. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма обработки, соответствующая документу. +// +Процедура ОткрытьДелоХраненияДокументов(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьДелоХраненияДокументов(Форма) +``` +
+ +## ОткрытьДелоХраненияДокументовЗавершение +
+ +Описание, пример вызова + +```bsl + +// После закрытия окна состава документа переносит изменения в форму документа. +// +// Параметры: +// Результат - Структура: +// * Дело - Строка +// * ДелоID - Строка +// * ДелоТип - Строка +// Форма - ФормаКлиентскогоПриложения +// +Процедура ОткрытьДелоХраненияДокументовЗавершение(Результат, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОткрытьДелоХраненияДокументовЗавершение(Результат, Форма) +``` +
+ +## СоздатьБизнесПроцессПоОбъектуДО +
+ +Описание, пример вызова + +```bsl + +// Создает бизнес-процесс на основании документа ДО. +// +// Параметры: +// Идентификатор - Строка - идентификатор документа-основания. +// Тип - Строка - тип документа-основания. +// Наименование - Строка - наименование документа-основания. +// ВнешнийОбъект - ЛюбаяСсылка - ссылка на связанный объект ИС. +// +Процедура СоздатьБизнесПроцессПоОбъектуДО(Идентификатор, Тип, Наименование, ВнешнийОбъект) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СоздатьБизнесПроцессПоОбъектуДО(Идентификатор, Тип, Наименование, ВнешнийОбъект) +``` +
+ +## СоздатьБизнесПроцесс +
+ +Описание, пример вызова + +```bsl + +// Создает бизнес-процесс. При передаче в качестве предмета ссылки на объект ИС создает связанный +// объект ДО, если эта связь не была установлена ранее. +// +// Параметры: +// Предмет - ЛюбаяСсылка +// - Структура: +// * ID - Строка +// * type - Строка +// * name - Строка +// * ВнешнийОбъект - ЛюбаяСсылка +// ГлавнаяЗадача - Структура: +// * ID - Строка +// * type - Строка +// * name - Строка +// ОписаниеОповещения - ОписаниеОповещения - описание оповещения, вызываемого при завершении. +// +Процедура СоздатьБизнесПроцесс(Предмет = Неопределено, ГлавнаяЗадача = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СоздатьБизнесПроцесс(Предмет, ГлавнаяЗадача, ); +``` +
+ +## СоздатьБизнесПроцессПослеПоискаСвязанногоОбъектаДО +
+ +Описание, пример вызова + +```bsl + +// Продолжает создание бизнес-процесса после поиска связанного объекта ДО. +// +// Параметры: +// Результат - Неопределено +// - Структура: +// * ID - Строка +// * type - Строка +// * name - Строка +// Параметры - Структура: +// * ГлавнаяЗадача- Структура: +// ** ID - Строка +// ** type - Строка +// ** name - Строка +// * ОписаниеОповещения - ОписаниеОповещения - описание оповещения, вызываемого при завершении. +// * Предмет - ЛюбаяСсылка, +// - Структура: +// ** ID - Строка +// ** type - Строка +// ** name - Строка +// ** ВнешнийОбъект - ЛюбаяСсылка +// +Процедура СоздатьБизнесПроцессПослеПоискаСвязанногоОбъектаДО(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СоздатьБизнесПроцессПослеПоискаСвязанногоОбъектаДО(Результат, Параметры) +``` +
+ +## ПрименитьВыборУчастникаБизнесПроцессаВСписке +
+ +Описание, пример вызова + +```bsl + +// Устанавливает в строку таблицы участников бизнес-процесса результат выбора участника бизнес-процесса +// из списка, который формируется при автоподборе. +// +// Параметры: +// Элемент - ТаблицаФормы - таблица участников бизнес-процесса. +// ВыбранноеЗначение - ЛюбаяСсылка - структура выбранного значения. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// Форма - ФормаКлиентскогоПриложения - форма с таблицей участников бизнес-процесса. +// +Процедура ПрименитьВыборУчастникаБизнесПроцессаВСписке(Элемент, ВыбранноеЗначение, СтандартнаяОбработка, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ПрименитьВыборУчастникаБизнесПроцессаВСписке(Элемент, ВыбранноеЗначение, СтандартнаяОбработка, Форма) +``` +
+ +## ПрименитьВыборУчастникаБизнесПроцессаВПоле +
+ +Описание, пример вызова + +```bsl + +// Устанавливает в поле на форме результат выбора участника бизнес-процесса из списка, +// который формируется при автоподборе. +// +// Параметры: +// ИмяПоля - Строка - имя реквизита участника бизнес-процесса формы. +// ИмяПоляОбъектаАдресации - Строка - имя реквизита объекта адресации. +// ВыбранноеЗначение - Структура: +// * name - Строка - наименование выбранного участника бизнес-процесса. +// * ID - Строка - идентификатор выбранного участника бизнес-процесса. +// * type - Строка - тип выбранного участника бизнес-процесса. +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// Форма - ФормаКлиентскогоПриложения - управляемая форма с полем выбора участника бизнес-процесса. +// +Процедура ПрименитьВыборУчастникаБизнесПроцессаВПоле(ИмяПоля, ИмяПоляОбъектаАдресации, ВыбранноеЗначение, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ПрименитьВыборУчастникаБизнесПроцессаВПоле(ИмяПоля, ИмяПоляОбъектаАдресации, ВыбранноеЗначение, ); +``` +
+ +## НачатьВыборТипаБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Выбрать тип бизнес-процесса. +// Открывает диалог выбора типа бизнес-процесса для старта. +// +// Параметры: +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения +// +Процедура НачатьВыборТипаБизнесПроцесса(ОписаниеОповещенияОЗакрытии) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьВыборТипаБизнесПроцесса(ОписаниеОповещенияОЗакрытии) +``` +
+ +## НачатьВыборШаблонаБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора шаблона бизнес-процесса из списка. +// +// Параметры: +// ОписаниеОповещенияОЗакрытии - ОписаниеОповещения - описание оповещения о закрытии +// Форма - ФормаКлиентскогоПриложения - форма бизнес-процесса Документооборота +// +Процедура НачатьВыборШаблонаБизнесПроцесса(ОписаниеОповещенияОЗакрытии, Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьВыборШаблонаБизнесПроцесса(ОписаниеОповещенияОЗакрытии, Форма) +``` +
+ +## НачатьСогласование +
+ +Описание, пример вызова + +```bsl + +// Запускает процесс согласования в ДО по указанному объекту. +// +// Параметры: +// Параметры - Структура: +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успешного запуска. +// +Процедура НачатьСогласование(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьСогласование(Параметры) +``` +
+ +## НачатьСогласованиеПослеПоискаСвязанногоОбъекта +
+ +Описание, пример вызова + +```bsl + +// Продолжает процесс согласования после нахождения или создания связанного объекта. +// +// Параметры: +// Результат - Структура: +// * name - Строка +// * ID - Строка +// * type - Строка +// Параметры - Структура: +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успешного запуска. +// +Процедура НачатьСогласованиеПослеПоискаСвязанногоОбъекта(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьСогласованиеПослеПоискаСвязанногоОбъекта(Результат, Параметры) +``` +
+ +## НачатьСогласованиеПослеВопроса +
+ +Описание, пример вызова + +```bsl + +// Продолжает запуск согласования в ДО после показа вопроса о перезапуске ранее запущенных процессов. +// +// Параметры: +// Результат - КодВозвратаДиалога +// Параметры - Структура: +// * Предмет - Структура: +// ** name - Строка +// ** ID - Строка +// ** type - Строка +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успешного запуска. +// +Процедура НачатьСогласованиеПослеВопроса(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьСогласованиеПослеВопроса(Результат, Параметры) +``` +
+ +## НачатьСогласованиеПослеВыбораШаблона +
+ +Описание, пример вызова + +```bsl + +// Продолжает запуск согласования в ДО после выбора шаблона согласования. +// +// Параметры: +// Результат - Структура: +// * РеквизитПредставление - Строка +// * РеквизитID - Строка +// * РеквизитТип - Строка +// Параметры - Структура: +// * Предмет - Структура: +// ** name - Строка +// ** ID - Строка +// ** type - Строка +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успешного запуска. +// +Процедура НачатьСогласованиеПослеВыбораШаблона(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьСогласованиеПослеВыбораШаблона(Результат, Параметры) +``` +
+ +## НачатьСогласованиеПослеИнтерактивногоЗапуска +
+ +Описание, пример вызова + +```bsl + +// Завершает запуск согласования в ДО после открытия формы бизнес-процесса. +// +// Параметры: +// Результат - Булево +// Параметры - Структура: +// * Предмет - Структура: +// ** name - Строка +// ** ID - Строка +// ** type - Строка +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успешного запуска. +// * Состояние - ПеречислениеСсылка.СостоянияСогласованияВДокументообороте +// +Процедура НачатьСогласованиеПослеИнтерактивногоЗапуска(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьСогласованиеПослеИнтерактивногоЗапуска(Результат, Параметры) +``` +
+ +## ПрерватьСогласование +
+ +Описание, пример вызова + +```bsl + +// Прерывает процессы согласования в ДО по указанному объекту. +// +// Параметры: +// Параметры - Структура: +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успеха. +// +Процедура ПрерватьСогласование(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ПрерватьСогласование(Параметры) +``` +
+ +## ПрерватьСогласованиеПослеВопроса +
+ +Описание, пример вызова + +```bsl + +// Продолжает процесс прерывания согласования после показа вопроса. +// +// Параметры: +// Результат - КодВозвратаДиалога +// Параметры - Структура: +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успеха. +// +Процедура ПрерватьСогласованиеПослеВопроса(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ПрерватьСогласованиеПослеВопроса(Результат, Параметры) +``` +
+ +## ВыполнитьСогласование +
+ +Описание, пример вызова + +```bsl + +// Выполняет согласование по указанному объекту с указанным результатом. +// +// Параметры: +// Параметры - Структура: +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * Результат - Строка - "Согласовано", "СогласованоСЗамечаниями", "НеСогласовано". +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успеха. +// +Процедура ВыполнитьСогласование(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыполнитьСогласование(Параметры) +``` +
+ +## ВыполнитьСогласованиеПослеВопроса +
+ +Описание, пример вызова + +```bsl + +// Завершает работу команд согласования после вывода вопроса. +// +// Параметры: +// Результат - Строка +// Параметры - Структура: +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * Результат - Строка - "Согласовано", "СогласованоСЗамечаниями", "НеСогласовано". +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успеха. +// +Процедура ВыполнитьСогласованиеПослеВопроса(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыполнитьСогласованиеПослеВопроса(Результат, Параметры) +``` +
+ +## ВыполнитьСогласованиеПослеВводаКомментария +
+ +Описание, пример вызова + +```bsl + +// Завершает работу команд согласования после ввода комментария. +// +// Параметры: +// Результат - Строка +// Параметры - Структура: +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * Результат - Строка - "Согласовано", "СогласованоСЗамечаниями", "НеСогласовано". +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успеха. +// * Предмет - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьВызовСервера.ДанныеОбъектаДОПоВнешнемуОбъекту +// * ЗадачиСогласования - см. ИнтеграцияС1СДокументооборотВызовСервера.ПолучитьЗадачиСогласования +// +Процедура ВыполнитьСогласованиеПослеВводаКомментария(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ВыполнитьСогласованиеПослеВводаКомментария(Результат, Параметры) +``` +
+ +## КомандыСогласованияПослеПредупреждения +
+ +Описание, пример вызова + +```bsl + +// Завершает работу команд согласования после вывода предупреждения о проблеме. +// +// Параметры: +// Параметры - Структура: +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Источник - ФормаКлиентскогоПриложения - необязательный, источник команды. +// * Результат - Строка - "Согласовано", "СогласованоСЗамечаниями", "НеСогласовано". +// * ОписаниеОповещения - ОписаниеОповещения - необязательный, вызывается в случае успеха. +// * Предмет - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьВызовСервера.ДанныеОбъектаДОПоВнешнемуОбъекту +// * ЗадачиСогласования - см. ИнтеграцияС1СДокументооборотВызовСервера.ПолучитьЗадачиСогласования +// +Процедура КомандыСогласованияПослеПредупреждения(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.КомандыСогласованияПослеПредупреждения(Параметры) +``` +
+ +## ПриИзмененииСостоянияСогласования +
+ +Описание, пример вызова + +```bsl + +// Вызывается при изменении состояния согласования в ДО. Меняет состояние на стороне ИС. +// +// Параметры: +// Параметры - Структура: +// * ПредметСогласования - ЛюбаяСсылка - согласуемый объект. +// * Предмет - Структура - описание связанного объекта ДО. +// * Состояние - ПеречислениеСсылка.СостоянияСогласованияВДокументообороте - новое состояние. +// - Неопределено - в случае прерывания согласования. +// * Источник - ФормаКлиентскогоПриложения: +// ** Объект - ОпределяемыйТип.ИнтеграцияС1СДокументооборотДокументыОбъектыПереопределяемый +// - ОпределяемыйТип.ИнтеграцияС1СДокументооборотСправочникиОбъектыПереопределяемый +// +Процедура ПриИзмененииСостоянияСогласования(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ПриИзмененииСостоянияСогласования(Параметры) +``` +
+ +## ДобавитьПредмет +
+ +Описание, пример вызова + +```bsl + +// Начинает процесс добавления предмета к процессу или задаче. +// +// Параметры: +// ФормаВладельца - ФормаКлиентскогоПриложения - форма обработки, соответствующая процессу или задаче. +// РольПредмета - Строка - роль добавляемого предмета, соответствует перечислению РолиПредметов. +// ОписаниеОповещения - ОписаниеОповещения - необязательный, оповещение, вызываемое после успешного добавления +// предмета с передачей структуры, содержащей его описание. +// +Процедура ДобавитьПредмет(ФормаВладельца, РольПредмета, ОписаниеОповещения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ДобавитьПредмет(ФормаВладельца, РольПредмета, ОписаниеОповещения); +``` +
+ +## ДобавитьПредметПослеВыбораТипа +
+ +Описание, пример вызова + +```bsl + +// Продолжает процесс добавления предмета после выбора его типа. +// +// Параметры: +// Результат - Структура: +// * Вариант - Строка +// * Отбор - СписокЗначений из ЛюбаяСсылка +// Параметры - Структура - см. ДобавитьПредмет. +// +Процедура ДобавитьПредметПослеВыбораТипа(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ДобавитьПредметПослеВыбораТипа(Результат, Параметры) +``` +
+ +## ДобавитьПредметПослеВыбораОбъектаДО +
+ +Описание, пример вызова + +```bsl + +// Продолжает процесс добавления предмета после выбора объекта 1С:Документооборота. +// +// Параметры: +// ОбъектДО - Структура - РеквизитID, РеквизитТип, РеквизитПредставление. +// Параметры - Структура - см. ДобавитьПредмет. +// +Процедура ДобавитьПредметПослеВыбораОбъектаДО(ОбъектДО, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ДобавитьПредметПослеВыбораОбъектаДО(ОбъектДО, Параметры) +``` +
+ +## ДобавитьПредметПослеВыбораОбъектаИС +
+ +Описание, пример вызова + +```bsl + +// Продолжает процесс добавления предмета после выбора объекта интегрированной системы. +// +// Параметры: +// ОбъектИС - ЛюбаяСсылка - выбранный объект ИС. +// Параметры - Структура - см. ДобавитьПредмет. +// +Процедура ДобавитьПредметПослеВыбораОбъектаИС(ОбъектИС, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ДобавитьПредметПослеВыбораОбъектаИС(ОбъектИС, Параметры) +``` +
+ +## ДобавитьПредметПослеПоискаСвязанногоОбъектаДО +
+ +Описание, пример вызова + +```bsl + +// Продолжает процесс добавления предмета после поиска связанного объекта ДО. +// +// Параметры: +// Результат - Структура - найденный или созданный объект ДО (name, ID, type). +// Параметры - Структура - см. ДобавитьПредмет. +// +Процедура ДобавитьПредметПослеПоискаСвязанногоОбъектаДО(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ДобавитьПредметПослеПоискаСвязанногоОбъектаДО(Результат, Параметры) +``` +
+ +## ДобавитьПредметПослеДобавленияФайла +
+ +Описание, пример вызова + +```bsl + +// Продолжает процесс добавления предмета после добавления файла с диска. +// +// Параметры: +// ОписаниеФайла - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла +// Параметры - Структура - см. ДобавитьПредмет. +// +Процедура ДобавитьПредметПослеДобавленияФайла(ОписаниеФайла, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ДобавитьПредметПослеДобавленияФайла(ОписаниеФайла, Параметры) +``` +
+ +## ОстановитьПроцесс +
+ +Описание, пример вызова + +```bsl + +// Останавливает процесс ДО. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма бизнес-процесса. +// +Процедура ОстановитьПроцесс(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОстановитьПроцесс(Форма) +``` +
+ +## ПрерватьПроцесс +
+ +Описание, пример вызова + +```bsl + +// Прерывает активный или остановленный процесс ДО. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма бизнес-процесса. +// +Процедура ПрерватьПроцесс(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ПрерватьПроцесс(Форма) +``` +
+ +## ПродолжитьПроцесс +
+ +Описание, пример вызова + +```bsl + +// Продолжает остановленный процесс ДО. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма бизнес-процесса. +// +Процедура ПродолжитьПроцесс(Форма) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ПродолжитьПроцесс(Форма) +``` +
+ +## ЕстьНеЗаполненныеПредметы +
+ +Описание, пример вызова + +```bsl + +// Проверяет есть ли среди предметов задачи не введенные заполняемые предметы. +// +// Параметры: +// Предметы - ДанныеФормыКоллекцияЭлементовДерева - все предметы задачи. +// ИмяКолонкиID - Строка - имя колонки, содержащей идентификатор предмета. +// ИмяКолонкиПредмет - Строка - имя колонки, содержащей представление предмета. +// +// Возвращаемое значение: +// Булево +// +Функция ЕстьНеЗаполненныеПредметы(Предметы, ИмяКолонкиID, ИмяКолонкиПредмет) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиент.ЕстьНеЗаполненныеПредметы(Предметы, ИмяКолонкиID, ИмяКолонкиПредмет) +``` +
+ +## НачатьДобавлениеСвязи +
+ +Описание, пример вызова + +```bsl + +// Начинает добавление связи с указанным документом ДО. Вызывает оповещение при успехе. +// +// Параметры: +// ID - Строка - идентификатор исходного документа. +// Тип - Строка - тип исходного документа. +// Представление - Строка - представление исходного документа. +// ТипДобавляемогоДокумента - Строка - тип документа, связь с которым добавляется, или +// - Неопределено - признак необходимости предоставить пользователю выбор. +// ОписаниеОповещения - ОписаниеОповещения - оповещение, вызываемое при успехе, с передачей +// структуры (ИсходныйДокумент, СвязанныйДокумент, ТипСвязи). +// Отбор - Структура - описание предустановленного отбора в терминах пакета XDTO. +// +Процедура НачатьДобавлениеСвязи(ID, Тип, Представление, ТипДобавляемогоДокумента = Неопределено, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьДобавлениеСвязи(ID, Тип, Представление, ТипДобавляемогоДокумента, ); +``` +
+ +## НачатьДобавлениеСвязиПослеФормыСозданияСвязи +
+ +Описание, пример вызова + +```bsl + +// Продолжает добавление связи после показа формы "Создание связи". +// +// Параметры: +// Результат - Структура - описание выбора со свойствами: +// РеквизитТип - Строка - тип выбранного объекта. +// РеквизитID - Строка - идентификатор выбранного объекта. +// ПараметрыОповещения - Структура - дополнительные параметры, необходимые для продолжения: +// * ID - Строка - идентификатор исходного документа. +// * Тип - Строка - тип исходного документа. +// * Представление - Строка - представление исходного документа. +// * ОписаниеОповещения - ОписаниеОповещения - описание оповещения, вызываемого после добавления. +// * Отбор - Структура - описание отбора, накладываемого при открытии карточки поиска. +// +Процедура НачатьДобавлениеСвязиПослеФормыСозданияСвязи(Результат, ПараметрыОповещения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьДобавлениеСвязиПослеФормыСозданияСвязи(Результат, ПараметрыОповещения) +``` +
+ +## НачатьДобавлениеСвязиПослеВыбораТипа +
+ +Описание, пример вызова + +```bsl + +// Начинает добавление связи с документом ДО указанного типа. Вызывает оповещение при успехе. +// +// Параметры: +// ID - Строка - идентификатор исходного документа. +// Тип - Строка - тип исходного документа. +// Представление - Строка - представление исходного документа. +// ТипДобавляемогоДокумента - Строка - тип документа, связь с которым добавляется. +// ОписаниеОповещения - ОписаниеОповещения - оповещение, вызываемое при успехе, с передачей +// структуры (ИсходныйДокумент, СвязанныйДокумент, ТипСвязи). +// Отбор - Структура - описание предустановленного отбора в терминах пакета XDTO. +// +Процедура НачатьДобавлениеСвязиПослеВыбораТипа(ID, Тип, Представление, ТипДобавляемогоДокумента, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьДобавлениеСвязиПослеВыбораТипа(ID, Тип, Представление, ТипДобавляемогоДокумента, ); +``` +
+ +## НачатьДобавлениеСвязиПослеВыбораДокумента +
+ +Описание, пример вызова + +```bsl + +// Продолжает добавление связи после выбора связываемого документа ДО. +// +// Параметры: +// Результат - Структура - результат выбора: +// РеквизитID - Строка - идентификатор выбранного документа. +// РеквизитТип - Строка - тип выбранного документа. +// РеквизитПредставление - Строка - представление выбранного документа. +// Параметры - Структура - см. НачатьДобавлениеСвязи. +// +Процедура НачатьДобавлениеСвязиПослеВыбораДокумента(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьДобавлениеСвязиПослеВыбораДокумента(Результат, Параметры) +``` +
+ +## НачатьДобавлениеСвязиПослеВыбораТипаСвязи +
+ +Описание, пример вызова + +```bsl + +// Продолжает добавление связи после выбора типа связи. +// +// Параметры: +// Результат - Структура - результат выбора: +// * РеквизитID - Строка - идентификатор выбранного типа связи. +// * РеквизитТип - Строка - тип выбранного типа связи. +// * РеквизитПредставление - Строка - представление выбранного типа связи. +// Параметры - Структура: +// * ИсходныйДокумент - Структура - описание исходного документа. +// * СвязанныйДокумент - Структура - описание связываемого документа. +// * ОписаниеОповещения - ОписаниеОповещения - оповещение, вызываемое при успехе. +// +Процедура НачатьДобавлениеСвязиПослеВыбораТипаСвязи(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьДобавлениеСвязиПослеВыбораТипаСвязи(Результат, Параметры) +``` +
+ +## НачатьУдалениеСвязи +
+ +Описание, пример вызова + +```bsl + +// Начинает удаление связи указанного типа между двумя документами. +// +// Параметры: +// ИсходныйДокумент - Структура - исходный документ. +// СвязанныйДокумент - Структура - связанный документ. +// ТипСвязи - Структура - тип связи. Свойства структур: +// ID - Строка - идентификатор объекта ДО. +// Тип - Строка - тип объекта ДО. +// Представление - Строка - представление объекта ДО. +// ОписаниеОповещения - ОписаниеОповещения - вызывается при успехе с передачей +// структуры (ИсходныйДокумент, СвязанныйДокумент, ТипСвязи). +// +Процедура НачатьУдалениеСвязи(ИсходныйДокумент, СвязанныйДокумент, ТипСвязи, Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьУдалениеСвязи(ИсходныйДокумент, СвязанныйДокумент, ТипСвязи, ); +``` +
+ +## НачатьУдалениеСвязиПослеВопроса +
+ +Описание, пример вызова + +```bsl + +// Продолжает удаление связи после вопроса пользователю. +// +// Параметры: +// Результат - КодВозвратаДиалога - результат выбора. +// Параметры - Структура: +// * ИсходныйДокумент - Структура: +// ** ID - Строка - идентификатор объекта ДО. +// ** Тип - Строка - тип объекта ДО. +// ** Представление - Строка - представление объекта ДО. +// * СвязанныйДокумент - Структура: +// ** ID - Строка - идентификатор объекта ДО. +// ** Тип - Строка - тип объекта ДО. +// ** Представление - Строка - представление объекта ДО. +// * ТипСвязи - Структура: +// ** ID - Строка - идентификатор объекта ДО. +// ** Тип - Строка - тип объекта ДО. +// ** Представление - Строка - представление объекта ДО. +// * ОписаниеОповещения - ОписаниеОповещения - вызывается при успехе. +// +Процедура НачатьУдалениеСвязиПослеВопроса(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.НачатьУдалениеСвязиПослеВопроса(Результат, Параметры) +``` +
+ +## СогласованиеВозможно +
+ +Описание, пример вызова + +```bsl + +// Запускает асинхронный метод, который по окончании работы вызывает оповещение, +// в параметры которого передается информация о возможности согласования. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, откуда совершен вызов. +// ПредметСогласования - ЛюбаяСсылка - предмет согласования. +// ОповещениеОЗавершении - ОписаниеОповещения - оповещение с результатом выполнения. +// +Процедура СогласованиеВозможно(Форма, ПредметСогласования, ОповещениеОЗавершении) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СогласованиеВозможно(Форма, ПредметСогласования, ОповещениеОЗавершении) +``` +
+ +## СогласоватьАсинхронно +
+ +Описание, пример вызова + +```bsl + +// Запускает асинхронный метод, который отправляет предмет на согласование, и по окончании работы +// вызывает оповещение, в параметры которого передается информация о результатах запуска согласования. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения: +// * Объект - ОпределяемыйТип.ИнтеграцияС1СДокументооборотДокументыОбъектыПереопределяемый +// - ОпределяемыйТип.ИнтеграцияС1СДокументооборотСправочникиОбъектыПереопределяемый +// ПредметСогласования - ЛюбаяСсылка - предмет согласования. +// ОповещениеОЗавершении - ОписаниеОповещения - оповещение с результатом выполнения. +// +Процедура СогласоватьАсинхронно(Форма, ПредметСогласования, ОповещениеОЗавершении) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СогласоватьАсинхронно(Форма, ПредметСогласования, ОповещениеОЗавершении) +``` +
+ +## ПрерываниеСогласованияВозможно +
+ +Описание, пример вызова + +```bsl + +// Запускает асинхронный метод, который по окончании работы вызывает оповещение, +// в параметры которого передается информация о возможности прервать согласование. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, откуда совершен вызов. +// ПредметСогласования - ЛюбаяСсылка - предмет согласования. +// ОповещениеОЗавершении - ОписаниеОповещения - оповещение с результатом выполнения. +// +Процедура ПрерываниеСогласованияВозможно(Форма, ПредметСогласования, ОповещениеОЗавершении) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ПрерываниеСогласованияВозможно(Форма, ПредметСогласования, ОповещениеОЗавершении) +``` +
+ +## ПрерватьСогласованиеАсинхронно +
+ +Описание, пример вызова + +```bsl + +// Запускает асинхронный метод, который прерывает согласование предмета, и по окончании работы +// вызывает оповещение, в параметры которого передается информация о результатах прерывания согласования. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения: +// * Объект - ОпределяемыйТип.ИнтеграцияС1СДокументооборотДокументыОбъектыПереопределяемый +// - ОпределяемыйТип.ИнтеграцияС1СДокументооборотСправочникиОбъектыПереопределяемый +// ПредметСогласования - ЛюбаяСсылка - предмет согласования. +// ОповещениеОЗавершении - ОписаниеОповещения - оповещение с результатом выполнения. +// +Процедура ПрерватьСогласованиеАсинхронно(Форма, ПредметСогласования, ОповещениеОЗавершении) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ПрерватьСогласованиеАсинхронно(Форма, ПредметСогласования, ОповещениеОЗавершении) +``` +
+ +## СостояниеСогласования +
+ +Описание, пример вызова + +```bsl + +// Запускает асинхронный метод, который по окончании работы вызывает оповещение, +// в параметры которого передается информация о состоянии согласования. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, откуда совершен вызов. +// ПредметСогласования - ЛюбаяСсылка - предмет согласования. +// ОповещениеОЗавершении - ОписаниеОповещения - оповещение с результатом выполнения. +// +Процедура СостояниеСогласования(Форма, ПредметСогласования, ОповещениеОЗавершении) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.СостояниеСогласования(Форма, ПредметСогласования, ОповещениеОЗавершении) +``` +
+ +## ОбработкаКомандыСоздатьБизнесПроцесс +
+ +Описание, пример вызова + +```bsl + +// Обработчик общей команды ИнтеграцияС1СДокументооборотСоздатьБизнесПроцесс +// +// Параметры: +// МассивСсылок - Произвольный - в параметр передается значение от источника, в котором реализована команда. +// Может содержать как единичное значение, так и массив значений. +// ПараметрыВыполнения - ПараметрыВыполненияКоманды - в обработчике команды можно изменить значение свойств +// параметра. +// +Процедура ОбработкаКомандыСоздатьБизнесПроцесс(МассивСсылок, ПараметрыВыполнения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОбработкаКомандыСоздатьБизнесПроцесс(МассивСсылок, ПараметрыВыполнения) +``` +
+ +## ОбработкаКомандыИсходящееПисьмо +
+ +Описание, пример вызова + +```bsl + +// Обработчик общей команды ИнтеграцияС1СДокументооборотСоздатьПисьмо +// +// Параметры: +// МассивСсылок - Произвольный - в параметр передается значение от источника, в котором реализована команда. +// Может содержать как единичное значение, так и массив значений. +// ПараметрыВыполнения - ПараметрыВыполненияКоманды - в обработчике команды можно изменить значение свойств +// параметра. +// +Процедура ОбработкаКомандыИсходящееПисьмо(МассивСсылок, ПараметрыВыполнения) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиент.ОбработкаКомандыИсходящееПисьмо(МассивСсылок, ПараметрыВыполнения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборотКлиентСервер.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборотКлиентСервер.md new file mode 100644 index 0000000..3cc510b --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборотКлиентСервер.md @@ -0,0 +1,406 @@ +--- +title: Интеграция с 1С документооборот клиент сервер +slug: zup/интеграция-с-1с-документооборот-клиент-сервер +--- + + +## ПредставлениеТипаОбъектаXDTO +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление типа объекта XDTO Документооборота по имени типа. +// +// Параметры: +// ТипXDTO - Строка - имя типа объекта XDTO. +// +// Возвращаемое значение: +// Строка - представление типа объекта XDTO Документооборота по имени типа. +// +Функция ПредставлениеТипаОбъектаXDTO(ТипXDTO) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ПредставлениеТипаОбъектаXDTO(ТипXDTO) +``` +
+ +## ЧислоВСтроку +
+ +Описание, пример вызова + +```bsl + +// Преобразует длительность интервала времени в строку вида час:мин. +// +// Параметры: +// Длительность - Число - длительность интервала времени в секундах. +// ПредставлениеНуля - Строка - представление интервала нулевой длительности. +// +// Возвращаемое значение: +// Строка - представление интервала в виде час:мин. +// +Функция ЧислоВСтроку(Длительность, ПредставлениеНуля = "'") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ЧислоВСтроку(Длительность, ПредставлениеНуля); +``` +
+ +## ЧислоИзСтроки +
+ +Описание, пример вызова + +```bsl + +// Преобразует строку вида час:мин в длительность интервала времени. +// +// Параметры: +// ДлительностьСтр - Строка - представление интервала времени в виде строки час:мин. +// +// Возвращаемое значение: +// Число - длительность интервала времени в секундах. +// +Функция ЧислоИзСтроки(ДлительностьСтр) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ЧислоИзСтроки(ДлительностьСтр) +``` +
+ +## ПроверитьФормат +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку строки на соответствие представлению интервала времени в виде час:мин. +// +// Параметры: +// ДлительностьСтр - Строка - проверяемая строка. +// +// Возвращаемое значение: +// Булево - Истина, если переданная строка соответствует виду час:мин, и Ложь в противном случае. +// +Функция ПроверитьФормат(ДлительностьСтр) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ПроверитьФормат(ДлительностьСтр) +``` +
+ +## ПредставлениеПроектаЗадачи +
+ +Описание, пример вызова + +```bsl + +// Возвращает строку представления проекта и проектной задачи для одного поля. +// +// Параметры: +// Проект - ЛюбаяСсылка, Строка - ссылка или строка представления проекта. +// ПроектнаяЗадача - ЛюбаяСсылка, Строка - ссылка или строка представления проектной задачи. +// +// Возвращаемое значение: +// Строка +// +Функция ПредставлениеПроектаЗадачи(Проект, ПроектнаяЗадача) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ПредставлениеПроектаЗадачи(Проект, ПроектнаяЗадача) +``` +
+ +## ДобавитьЗначениеКСтрокеЧерезРазделитель +
+ +Описание, пример вызова + +```bsl + +// Добавляет к Строке Разделитель и ДобавляемоеЗначение в случае, если Строка и +// ДобавляемоеЗначение не пустые. Если Строка пустая или ДобавляемоеЗначение +// не заполнено - то добавляет к Строке ДобавляемоеЗначение. +// +// Параметры: +// ИсходнаяСтрока - Строка - Модифицируется в процедуре. +// Разделитель - Строка - Разделитель. +// ДобавляемоеЗначение - Строка - Добавляемое значение. +// +Процедура ДобавитьЗначениеКСтрокеЧерезРазделитель(ИсходнаяСтрока, Разделитель, ДобавляемоеЗначение) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотКлиентСервер.ДобавитьЗначениеКСтрокеЧерезРазделитель(ИсходнаяСтрока, Разделитель, ДобавляемоеЗначение) +``` +
+ +## КартинкаПоРолиПредмета +
+ +Описание, пример вызова + +```bsl + +// Получает картинку предмета из библиотеки согласно его роли. +// +// Параметры: +// РольПредмета - Строка - роль предмета. +// +// Возвращаемое значение: +// Картинка - картинка из библиотеки. +// +Функция КартинкаПоРолиПредмета(РольПредмета) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.КартинкаПоРолиПредмета(РольПредмета) +``` +
+ +## НомерКартинкиПоРолиПредмета +
+ +Описание, пример вызова + +```bsl + +// Получает номер картинки предмета в коллекции согласно его роли. +// +// Параметры: +// РольПредмета - Строка - роль предмета. +// +// Возвращаемое значение: +// Число - номер картинки из КоллекцияРолиПредметов +// +Функция НомерКартинкиПоРолиПредмета(РольПредмета) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.НомерКартинкиПоРолиПредмета(РольПредмета) +``` +
+ +## ЭтоСправочник +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли справочником тип объекта ДО. +// +// Параметры: +// Тип - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево - истина, если тип соответствует справочнику ДО. +// +Функция ЭтоСправочник(Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ЭтоСправочник(Тип) +``` +
+ +## ЭтоДокумент +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли документом в прикладном смысле тип объекта ДО. +// +// Параметры: +// Тип - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево - истина, если тип соответствует документу ДО (в прикладном смысле). +// +Функция ЭтоДокумент(Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ЭтоДокумент(Тип) +``` +
+ +## ЭтоБизнесПроцесс +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли тип объекта ДО бизнес-процессом. +// +// Параметры: +// Тип - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево - истина, если тип соответствует бизнес-процессу ДО. +// +Функция ЭтоБизнесПроцесс(Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ЭтоБизнесПроцесс(Тип) +``` +
+ +## ЭтоЗадачаБизнесПроцесса +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли тип объекта ДО задачей бизнес-процесса. +// +// Параметры: +// Тип - Строка - имя типа XDTO. +// +// Возвращаемое значение: +// Булево - истина, если тип соответствует задаче ДО. +// +Функция ЭтоЗадачаБизнесПроцесса(Тип) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ЭтоЗадачаБизнесПроцесса(Тип) +``` +
+ +## ПредставлениеСрокаДействияДокумента +
+ +Описание, пример вызова + +```bsl + +// Получает строковое представление срока действия по значениям реквизитов формы. +// +// Параметры: +// ДатаНачала - Дата - дата начала действия. +// Бессрочный - Булево - Истина, если документ бессрочный. +// ДатаОкончания - Дата - дата окончания действия. +// ПорядокПродленияID - Строка - порядок продления. +// ПорядокПродления - Строка - описание порядка продления. +// +// Возвращаемое значение: +// Строка - представление срока действия. +// +Функция ПредставлениеСрокаДействияДокумента(ДатаНачала, Бессрочный, ДатаОкончания, ПорядокПродленияID, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ПредставлениеСрокаДействияДокумента(ДатаНачала, Бессрочный, ДатаОкончания, ПорядокПродленияID, ); +``` +
+ +## ПолучитьОбзорДокумента +
+ +Описание, пример вызова + +```bsl + +// Возвращает HTML-представление документа для показа в карточке по объекту XDTO. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма обработки ИнтеграцияС1СДокументооборот с данными документа. +// +// Возвращаемое значение: +// Строка - HTML-представление документа. +// +Функция ПолучитьОбзорДокумента(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ПолучитьОбзорДокумента(Форма) +``` +
+ +## ПолучитьСтрокуСоставДокумента +
+ +Описание, пример вызова + +```bsl + +// Формирует текстовое представление состава документа. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма обработки ИнтеграцияС1СДокументооборот с данными документа. +// +// Возвращаемое значение: +// Строка - текстовое представление состава документа. +// +Функция ПолучитьСтрокуСоставДокумента(Форма) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.ПолучитьСтрокуСоставДокумента(Форма) +``` +
+ +## РазностьДатВДнях +
+ +Описание, пример вызова + +```bsl + +// Строковое описание разности дат в днях с учетом склонений +// +// Параметры: +// Дата1 - Дата - первая дата. +// Дата2 - Дата - вторая дата. +// ИспользоватьДатуИВремяВСрокахЗадач - Булево - признак использования даты в сроках задач. +// +// Возвращаемое значение: +// Строка - текстовое представление разности дат. +// +Функция РазностьДатВДнях(Дата1, Дата2, ИспользоватьДатуИВремяВСрокахЗадач = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотКлиентСервер.РазностьДатВДнях(Дата1, Дата2, ИспользоватьДатуИВремяВСрокахЗадач); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияС1СДокументооборотОбмен.md b/src/content/docs/zup/ИнтеграцияС1СДокументооборотОбмен.md new file mode 100644 index 0000000..05b4284 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияС1СДокументооборотОбмен.md @@ -0,0 +1,89 @@ +--- +title: Интеграция с 1С документооборот обмен +slug: zup/интеграция-с-1с-документооборот-обмен +--- + + +## ЗарегистрированныеДанные +
+ +Описание, пример вызова + +```bsl + +// Возвращает измененные объекты, интегрированные с 1С:Документооборотом, и готовые к выгрузке. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// УзелОбмена - ПланОбменаСсылка.ИнтеграцияС1СДокументооборотомПереопределяемый - узел, по которому нужно +// получить изменения. +// ОбъектыКУдалениюИзРегистрацииИзменений - Массив из ЛюбаяСсылка - неявно возвращаемое значение, +// содержит ссылки на объекты, не требующие выгрузки, и на успешно отправленные объекты. +// +// Возвращаемое значение: +// Массив из Структура: +// * Объект - ЛюбаяСсылка +// * ТипОбъектаДО - Строка +// * ИдентификаторОбъектаДО - Строка +// * ПравилоЗаполнения - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом +// +Функция ЗарегистрированныеДанные(Прокси, УзелОбмена, ОбъектыКУдалениюИзРегистрацииИзменений) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотОбмен.ЗарегистрированныеДанные(Прокси, УзелОбмена, ОбъектыКУдалениюИзРегистрацииИзменений) +``` +
+ +## ПолучитьДанные +
+ +Описание, пример вызова + +```bsl + +// Получает данные из Документооборота. +// +Процедура ПолучитьДанные() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияС1СДокументооборотОбмен.ПолучитьДанные() +``` +
+ +## ПолучитьXDTOИзмененийИзОбъекта +
+ +Описание, пример вызова + +```bsl + +// Возвращает объект XDTO, содержащий обновляемые изменения объекта. +// +// Параметры: +// Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота. +// ДанныеОбъекта - См. ИнтеграцияС1СДокументооборотОбмен.ЗарегистрированныеДанные +// КонтрольОтправкиФайлов - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.КонтрольОтправкиФайлов +// +// Возвращаемое значение: +// ОбъектXDTO +// +Функция ПолучитьXDTOИзмененийИзОбъекта(Прокси, ДанныеОбъекта, КонтрольОтправкиФайлов) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияС1СДокументооборотОбмен.ПолучитьXDTOИзмененийИзОбъекта(Прокси, ДанныеОбъекта, КонтрольОтправкиФайлов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияСРаботаВРоссии.md b/src/content/docs/zup/ИнтеграцияСРаботаВРоссии.md new file mode 100644 index 0000000..5a0599e --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияСРаботаВРоссии.md @@ -0,0 +1,120 @@ +--- +title: Интеграция с работа в россии +slug: zup/интеграция-с-работа-в-россии +--- + + +## ДоступнаПередачаДокументовНаРаботаВРоссии +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую настройку использования передачи на портале Работа в России. +// +// Возвращаемое значение: +// Булево - если Истина, передача доступна. +// +Функция ДоступнаПередачаДокументовНаРаботаВРоссии() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияСРаботаВРоссии.ДоступнаПередачаДокументовНаРаботаВРоссии() +``` +
+ +## ПередатьНаПортал +
+ +Описание, пример вызова + +```bsl + +// Производит передачу на портал присоединенного файла +// +// Параметры: +// ПрисоединенныйФайл - Справочник, ссылка на присоединенный файл. +// +Процедура ПередатьНаПортал(ПрисоединенныйФайл) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияСРаботаВРоссии.ПередатьНаПортал(ПрисоединенныйФайл) +``` +
+ +## НастройкиАвторизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки авторизации на портале, сохраненные в безопасном хранилище +// +// Возвращаемое значение: +// Структура - с ключами: +// * Пароль - Строка +// * Логин - Строка +// * Идентификатор - Строка +// +Функция НастройкиАвторизации() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияСРаботаВРоссии.НастройкиАвторизации() +``` +
+ +## ЗапомнитьНастройкиАвторизации +
+ +Описание, пример вызова + +```bsl + +// Сохраняет настройки авторизации на портале в безопасном хранилище. +// +// Параметры: +// Пароль - Строка +// Логин - Строка +// Идентификатор - Строка +// +Процедура ЗапомнитьНастройкиАвторизации(Логин, Пароль, Идентификатор) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияСРаботаВРоссии.ЗапомнитьНастройкиАвторизации(Логин, Пароль, Идентификатор) +``` +
+ +## ВыполнитьПередачуПечатныхФорм +
+ +Описание, пример вызова + +```bsl + +// Выполняет в фоновом режиме передачу готовых для этого печатных форм. +// +Процедура ВыполнитьПередачуПечатныхФорм() Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияСРаботаВРоссии.ВыполнитьПередачуПечатныхФорм() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияСРаботаВРоссииВызовСервера.md b/src/content/docs/zup/ИнтеграцияСРаботаВРоссииВызовСервера.md new file mode 100644 index 0000000..f3ea67b --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияСРаботаВРоссииВызовСервера.md @@ -0,0 +1,29 @@ +--- +title: Интеграция с работа в россии вызов сервера +slug: zup/интеграция-с-работа-в-россии-вызов-сервера +--- + + +## ПередатьДокументыПоОписаниямПечатныхФорм +
+ +Описание, пример вызова + +```bsl + +Процедура ПередатьДокументыПоОписаниямПечатныхФорм(ОписанияПечатныхФорм) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияСРаботаВРоссииВызовСервера.ПередатьДокументыПоОписаниямПечатныхФорм(ОписанияПечатныхФорм) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияСРаботаВРоссииКлиент.md b/src/content/docs/zup/ИнтеграцияСРаботаВРоссииКлиент.md new file mode 100644 index 0000000..74672b1 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияСРаботаВРоссииКлиент.md @@ -0,0 +1,47 @@ +--- +title: Интеграция с работа в россии клиент +slug: zup/интеграция-с-работа-в-россии-клиент +--- + + +## ПечатьДокументовВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовВыполнитьКоманду +// +Процедура ПечатьДокументовВыполнитьКоманду(Форма, Команда, ПродолжитьВыполнениеНаСервере, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияСРаботаВРоссииКлиент.ПечатьДокументовВыполнитьКоманду(Форма, Команда, ПродолжитьВыполнениеНаСервере, ДополнительныеПараметры) +``` +
+ +## ПередатьДокументы +
+ +Описание, пример вызова + +```bsl + +Процедура ПередатьДокументы(ПечатныеФормы) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияСРаботаВРоссииКлиент.ПередатьДокументы(ПечатныеФормы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияУправлениеПерсоналомКлиентСервер.md b/src/content/docs/zup/ИнтеграцияУправлениеПерсоналомКлиентСервер.md new file mode 100644 index 0000000..0f43346 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияУправлениеПерсоналомКлиентСервер.md @@ -0,0 +1,30 @@ +--- +title: Интеграция управление персоналом клиент сервер +slug: zup/интеграция-управление-персоналом-клиент-сервер +--- + + +## МаксимальныйРазмерПринимаемогоФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает максимальный размер принимаемого файла в байтах. +Функция МаксимальныйРазмерПринимаемогоФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияУправлениеПерсоналомКлиентСервер.МаксимальныйРазмерПринимаемогоФайла() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияУправлениеПерсоналомПереопределяемый.md b/src/content/docs/zup/ИнтеграцияУправлениеПерсоналомПереопределяемый.md new file mode 100644 index 0000000..1982075 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияУправлениеПерсоналомПереопределяемый.md @@ -0,0 +1,34 @@ +--- +title: Интеграция управление персоналом переопределяемый +slug: zup/интеграция-управление-персоналом-переопределяемый +--- + + +## ИнициализацияПараметровМенеджераОбмена +
+ +Описание, пример вызова + +```bsl + +// Уточняет инициализацию параметров менеджера обмена. +// +// Параметры: +// МенеджерОбмена - ОбработкаОбъект.МенеджерОбменаУправлениеПерсоналом. +// +Процедура ИнициализацияПараметровМенеджераОбмена(МенеджерОбмена) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияУправлениеПерсоналомПереопределяемый.ИнициализацияПараметровМенеджераОбмена(МенеджерОбмена) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтеграцияУправлениеПерсоналомСобытияВнутренний.md b/src/content/docs/zup/ИнтеграцияУправлениеПерсоналомСобытияВнутренний.md new file mode 100644 index 0000000..285ab67 --- /dev/null +++ b/src/content/docs/zup/ИнтеграцияУправлениеПерсоналомСобытияВнутренний.md @@ -0,0 +1,125 @@ +--- +title: Интеграция управление персоналом события внутренний +slug: zup/интеграция-управление-персоналом-события-внутренний +--- + + +## ИменаКонтролируемыхРеквизитов +
+ +Описание, пример вызова + +```bsl + +Функция ИменаКонтролируемыхРеквизитов(Объект) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтеграцияУправлениеПерсоналомСобытияВнутренний.ИменаКонтролируемыхРеквизитов(Объект) +``` +
+ +## ОбработчикПриЗаписиОбъекта +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработчикПриЗаписиОбъекта(Источник) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияУправлениеПерсоналомСобытияВнутренний.ОбработчикПриЗаписиОбъекта(Источник) +``` +
+ +## ЗарегистрироватьОбновлениеРуководителейПодразделений +
+ +Описание, пример вызова + +```bsl + +Процедура ЗарегистрироватьОбновлениеРуководителейПодразделений(ПозицииШР) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияУправлениеПерсоналомСобытияВнутренний.ЗарегистрироватьОбновлениеРуководителейПодразделений(ПозицииШР) +``` +
+ +## ТекущиеКадровыеДанныеСотрудниковПередЗаписью +
+ +Описание, пример вызова + +```bsl + +Процедура ТекущиеКадровыеДанныеСотрудниковПередЗаписью(НаборЗаписей) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияУправлениеПерсоналомСобытияВнутренний.ТекущиеКадровыеДанныеСотрудниковПередЗаписью(НаборЗаписей) +``` +
+ +## ТекущиеКадровыеДанныеСотрудниковПриЗаписи +
+ +Описание, пример вызова + +```bsl + +Процедура ТекущиеКадровыеДанныеСотрудниковПриЗаписи(НаборЗаписей) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияУправлениеПерсоналомСобытияВнутренний.ТекущиеКадровыеДанныеСотрудниковПриЗаписи(НаборЗаписей) +``` +
+ +## ПлановыеУдержанияПередЗаписью +
+ +Описание, пример вызова + +```bsl + +Процедура ПлановыеУдержанияПередЗаписью(НаборЗаписей) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияУправлениеПерсоналомСобытияВнутренний.ПлановыеУдержанияПередЗаписью(НаборЗаписей) +``` +
+ +## ПлановыеУдержанияПриЗаписи +
+ +Описание, пример вызова + +```bsl + +Процедура ПлановыеУдержанияПриЗаписи(НаборЗаписей) Экспорт +``` + +Пример вызова +```bsl +ИнтеграцияУправлениеПерсоналомСобытияВнутренний.ПлановыеУдержанияПриЗаписи(НаборЗаписей) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтервальныеРегистрыБЗК.md b/src/content/docs/zup/ИнтервальныеРегистрыБЗК.md new file mode 100644 index 0000000..42d8574 --- /dev/null +++ b/src/content/docs/zup/ИнтервальныеРегистрыБЗК.md @@ -0,0 +1,34 @@ +--- +title: Интервальные регистры БЗК +slug: zup/интервальные-регистры-бзк +--- + + +## ПоддерживатьНесколькоВложенныхПериодическихСобытий +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак поддержки стека периодических событий. +// +// Возвращаемое значение: +// Булево +// +Функция ПоддерживатьНесколькоВложенныхПериодическихСобытий() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтервальныеРегистрыБЗК.ПоддерживатьНесколькоВложенныхПериодическихСобытий() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтернетПоддержкаПользователейБРОКлиент.md b/src/content/docs/zup/ИнтернетПоддержкаПользователейБРОКлиент.md new file mode 100644 index 0000000..c577dc3 --- /dev/null +++ b/src/content/docs/zup/ИнтернетПоддержкаПользователейБРОКлиент.md @@ -0,0 +1,45 @@ +--- +title: Интернет поддержка пользователей БРО клиент +slug: zup/интернет-поддержка-пользователей-бро-клиент +--- + + +## ПроверитьВозможностьВыполненияОперации +
+ +Описание, пример вызова + +```bsl + +// Проверяет разрешение на выполнение операции. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, +// иначе - была ошибка при выполнении проверки. +// * ВыполнениеРазрешено - Булево - если Истина, то продолжение выполнения разрешено. +// +// ВладелецФормы - ФормаКлиентскогоПриложения - форма, которая будет использования в качестве +// владельца открываемых служебных окон. +// +// ПараметрыАутентификации - Структура - параметры доступа к сайту поддержки пользователей. +// * Логин - Строка - логин пользователя. +// * пароль - Строка - пароль пользователя. +// +Процедура ПроверитьВозможностьВыполненияОперации(ОповещениеОЗавершении, ВладелецФормы = Неопределено, ПараметрыАутентификации = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтернетПоддержкаПользователейБРОКлиент.ПроверитьВозможностьВыполненияОперации(ОповещениеОЗавершении, ВладелецФормы, ПараметрыАутентификации); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтерпретаторКонтрольныхСоотношенийРосстата.md b/src/content/docs/zup/ИнтерпретаторКонтрольныхСоотношенийРосстата.md new file mode 100644 index 0000000..46a90c7 --- /dev/null +++ b/src/content/docs/zup/ИнтерпретаторКонтрольныхСоотношенийРосстата.md @@ -0,0 +1,1954 @@ +--- +title: Интерпретатор контрольных соотношений росстата +slug: zup/интерпретатор-контрольных-соотношений-росстата +--- + + +## СформироватьКонтекстДляПроверок +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьКонтекстДляПроверок(Шаблон, ФайлВырузки, ВыгрузкаПрошлогоПериода = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.СформироватьКонтекстДляПроверок(Шаблон, ФайлВырузки, ВыгрузкаПрошлогоПериода); +``` +
+ +## ПолныеАргументыСуммированияВВыражении +
+ +Описание, пример вызова + +```bsl + +Функция ПолныеАргументыСуммированияВВыражении(Контекст, Выражение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолныеАргументыСуммированияВВыражении(Контекст, Выражение)); +``` +
+ +## ЭтоСкалярныйАргумент +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоСкалярныйАргумент(Контекст, Выражение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЭтоСкалярныйАргумент(Контекст, Выражение)); +``` +
+ +## УдалениеОператораСуммированияСкаляровВВыражении +
+ +Описание, пример вызова + +```bsl + +Функция УдалениеОператораСуммированияСкаляровВВыражении(Контекст, Выражение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.УдалениеОператораСуммированияСкаляровВВыражении(Контекст, Выражение)); +``` +
+ +## УдалениеОператораСуммированияСкаляров +
+ +Описание, пример вызова + +```bsl + +Процедура УдалениеОператораСуммированияСкаляров(Контекст) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.УдалениеОператораСуммированияСкаляров(Контекст)); +``` +
+ +## ОтобратьМножественныеСтроки +
+ +Описание, пример вызова + +```bsl + +Функция ОтобратьМножественныеСтроки(Таблица) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ОтобратьМножественныеСтроки(Таблица)); +``` +
+ +## ДополнитьКонтекстТаблицейВариацийСтрок +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьКонтекстТаблицейВариацийСтрок(Контекст) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ДополнитьКонтекстТаблицейВариацийСтрок(Контекст)); +``` +
+ +## ДополнитьКонтекстТаблицейДиапазонов +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьКонтекстТаблицейДиапазонов(Контекст) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ДополнитьКонтекстТаблицейДиапазонов(Контекст)); +``` +
+ +## СформироватьСоответствиеЗамен +
+ +Описание, пример вызова + +```bsl + +Процедура СформироватьСоответствиеЗамен(Контекст) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.СформироватьСоответствиеЗамен(Контекст)); +``` +
+ +## ПреобразоватьАргументСуммы +
+ +Описание, пример вызова + +```bsl + +Функция ПреобразоватьАргументСуммы(Выражение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПреобразоватьАргументСуммы(Выражение)); +``` +
+ +## ПреобразоватьЦепочкуСравнений +
+ +Описание, пример вызова + +```bsl + +Функция ПреобразоватьЦепочкуСравнений(Выражение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПреобразоватьЦепочкуСравнений(Выражение)); +``` +
+ +## ПреобразоватьНезаполненныеАргументы +
+ +Описание, пример вызова + +```bsl + +Функция ПреобразоватьНезаполненныеАргументы(Выражение, ЗаменыФункций) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПреобразоватьНезаполненныеАргументы(Выражение, ЗаменыФункций)); +``` +
+ +## ОкруглитьОперанды +
+ +Описание, пример вызова + +```bsl + +Функция ОкруглитьОперанды(Выражение, ЗаменыФункций, ЗнаковОкругления) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ОкруглитьОперанды(Выражение, ЗаменыФункций, ЗнаковОкругления)); +``` +
+ +## ПроверкаВыражения +
+ +Описание, пример вызова + +```bsl + +Функция ПроверкаВыражения(Результат) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверкаВыражения(Результат)); +``` +
+ +## ПривестиВыражениеККаноническомуВиду +
+ +Описание, пример вызова + +```bsl + +Функция ПривестиВыражениеККаноническомуВиду(Контекст, Выражение, ЗнаковОкругления = 2) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПривестиВыражениеККаноническомуВиду(Контекст, Выражение, ЗнаковОкругления); +``` +
+ +## _Абс +
+ +Описание, пример вызова + +```bsl + +Функция _Абс(p) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата._Абс(p) +``` +
+ +## _Соединение +
+ +Описание, пример вызова + +```bsl + +Функция _Соединение(p1 = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата._Соединение(p1, ); +``` +
+ +## _БлижЦел +
+ +Описание, пример вызова + +```bsl + +Функция _БлижЦел(p) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата._БлижЦел(p) +``` +
+ +## _ЕстьНулл +
+ +Описание, пример вызова + +```bsl + +Функция _ЕстьНулл(p1, p2) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата._ЕстьНулл(p1, p2) +``` +
+ +## _НуллИф +
+ +Описание, пример вызова + +```bsl + +Функция _НуллИф(p1, p2) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата._НуллИф(p1, p2) +``` +
+ +## _Окр +
+ +Описание, пример вызова + +```bsl + +Функция _Окр(p1, p2 = 0, p3 = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата._Окр(p1, p2, p3); +``` +
+ +## ПолучитьПустуюТаблицуТиповСтрок +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПустуюТаблицуТиповСтрок() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьПустуюТаблицуТиповСтрок()); +``` +
+ +## ПолучитьПустуюТаблицуМножественныхСтрок +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПустуюТаблицуМножественныхСтрок() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьПустуюТаблицуМножественныхСтрок()); +``` +
+ +## ПолучитьПустуюТаблицуПроверокКонтролей +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПустуюТаблицуПроверокКонтролей() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьПустуюТаблицуПроверокКонтролей()); +``` +
+ +## ПолучитьПустуюТаблицуДанныхОтчета +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПустуюТаблицуДанныхОтчета(КоличествоКолонок) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьПустуюТаблицуДанныхОтчета(КоличествоКолонок)); +``` +
+ +## ПолучитьПустуюТаблицуКонтрольныхСоотношений +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПустуюТаблицуКонтрольныхСоотношений() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьПустуюТаблицуКонтрольныхСоотношений()); +``` +
+ +## ПолучитьПустуюТаблицуКодовПериодичности +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПустуюТаблицуКодовПериодичности() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьПустуюТаблицуКодовПериодичности()); +``` +
+ +## ДополнительныеПреобразованияУсловия +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнительныеПреобразованияУсловия(ПреобразованноеУсловие) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ДополнительныеПреобразованияУсловия(ПреобразованноеУсловие)); +``` +
+ +## ДанныеОтчетаВТаблицу +
+ +Описание, пример вызова + +```bsl + +Процедура ДанныеОтчетаВТаблицу(ФайлВырузки, Контекст, Заголовок) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ДанныеОтчетаВТаблицу(ФайлВырузки, Контекст, Заголовок)); +``` +
+ +## СформироватьТаблицуОбязательныхДляВводаГраф +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьТаблицуОбязательныхДляВводаГраф(ДокументDOM, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.СформироватьТаблицуОбязательныхДляВводаГраф(ДокументDOM, Контекст)); +``` +
+ +## СформироватьТаблицуЗапрещенныхДляВводаГраф +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьТаблицуЗапрещенныхДляВводаГраф(ДокументDOM) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.СформироватьТаблицуЗапрещенныхДляВводаГраф(ДокументDOM)); +``` +
+ +## ПолучитьТаблицуДанныеШаблона +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьТаблицуДанныеШаблона(Шаблон, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьТаблицуДанныеШаблона(Шаблон, Контекст) +``` +
+ +## ЗамененныйПериодВУсловииНаПериод +
+ +Описание, пример вызова + +```bsl + +Функция ЗамененныйПериодВУсловииНаПериод(Период, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЗамененныйПериодВУсловииНаПериод(Период, Контекст)); +``` +
+ +## ПроверитьУсловиеНаПериод +
+ +Описание, пример вызова + +```bsl + +// По результатам перебора всех шаблонов Росстата нашли такие типы условий: +// (&NP in(1,2,3,4,5,6,7,8,9,10,11)) +// (&NP>1 ),(&NP=1 ),(&NP>=1 ),(&NP<>3 ),(&NP<3 ),(&NP<=3 ) +// (&NP=1 or &NP=3) +// (&NP in(1203,1206,1209,1212)) +Функция ПроверитьУсловиеНаПериод(Контекст, УсловиеНаПериод) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверитьУсловиеНаПериод(Контекст, УсловиеНаПериод)); +``` +
+ +## ЗаменитьСуммуВУсловии +
+ +Описание, пример вызова + +```bsl + +Функция ЗаменитьСуммуВУсловии(Условие) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЗаменитьСуммуВУсловии(Условие)); +``` +
+ +## ЭтоВариацияПоСпецификам +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоВариацияПоСпецификам(Контекст, Условие, Соотношение, Строки, Специфики) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЭтоВариацияПоСпецификам(Контекст, Условие, Соотношение, Строки, Специфики)); +``` +
+ +## ПреобразованныйАругмент +
+ +Описание, пример вызова + +```bsl + +Функция ПреобразованныйАругмент(Контекст, ИсходныйАргумент) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПреобразованныйАругмент(Контекст, ИсходныйАргумент)); +``` +
+ +## ЭтоОшибочноМногострочноеВыражение +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоОшибочноМногострочноеВыражение(Контекст, Выражение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЭтоОшибочноМногострочноеВыражение(Контекст, Выражение)); +``` +
+ +## ЭтоВариацияПоСтрокам +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоВариацияПоСтрокам(Контекст, Условие, Строки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЭтоВариацияПоСтрокам(Контекст, Условие, Строки)); +``` +
+ +## ЭтоЗапрещеннаяДляВводаКолонка +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоЗапрещеннаяДляВводаКолонка(Контекст, Секция, Строка, Колонка) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЭтоЗапрещеннаяДляВводаКолонка(Контекст, Секция, Строка, Колонка)); +``` +
+ +## ЭтоВариацияПоГрафам +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоВариацияПоГрафам(Контекст, Условие, Графы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЭтоВариацияПоГрафам(Контекст, Условие, Графы)); +``` +
+ +## ЧислоВходитВДиапазон +
+ +Описание, пример вызова + +```bsl + +Функция ЧислоВходитВДиапазон(Контекст, Число, Диапазон) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЧислоВходитВДиапазон(Контекст, Число, Диапазон)); +``` +
+ +## СпецификаВходитВДиапазон +
+ +Описание, пример вызова + +```bsl + +Функция СпецификаВходитВДиапазон(Специфика, Диапазон, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.СпецификаВходитВДиапазон(Специфика, Диапазон, Контекст)); +``` +
+ +## ПреобразованиеУсловияСуммированияМножественныхСтрокИСкаляров +
+ +Описание, пример вызова + +```bsl + +Процедура ПреобразованиеУсловияСуммированияМножественныхСтрокИСкаляров(Контекст, Выражение) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ПреобразованиеУсловияСуммированияМножественныхСтрокИСкаляров(Контекст, Выражение)); +``` +
+ +## ПодстановкаИзвестныхСкалярныхАргументов +
+ +Описание, пример вызова + +```bsl + +Процедура ПодстановкаИзвестныхСкалярныхАргументов(Контекст, Условие, РазрядностьОкругления) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ПодстановкаИзвестныхСкалярныхАргументов(Контекст, Условие, РазрядностьОкругления)); +``` +
+ +## ЭтоСкалярноеУсловие +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоСкалярноеУсловие(Контекст, Условие) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЭтоСкалярноеУсловие(Контекст, Условие)); +``` +
+ +## ЗаменитьВыражение +
+ +Описание, пример вызова + +```bsl + +Функция ЗаменитьВыражение(ИсходнаяСтрока, НаЧтоЗаменяем, ЧтоЗаменили, ОткрывающийСимвол) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЗаменитьВыражение(ИсходнаяСтрока, НаЧтоЗаменяем, ЧтоЗаменили, ОткрывающийСимвол)); +``` +
+ +## ВычислитьСкалярноеУсловие +
+ +Описание, пример вызова + +```bsl + +Функция ВычислитьСкалярноеУсловие(Условие, Контекст, РазрядностьОкругления = 2) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ВычислитьСкалярноеУсловие(Условие, Контекст, РазрядностьОкругления); +``` +
+ +## НеявноеСуммированиеМножественныхСтрок +
+ +Описание, пример вызова + +```bsl + +Функция НеявноеСуммированиеМножественныхСтрок(Контекст, Условие, Колонка) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.НеявноеСуммированиеМножественныхСтрок(Контекст, Условие, Колонка)); +``` +
+ +## ВычислитьУсловиеПоГрафам +
+ +Описание, пример вызова + +```bsl + +Функция ВычислитьУсловиеПоГрафам(Условие, Контекст, РазрядностьОкругления = 2, Графы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ВычислитьУсловиеПоГрафам(Условие, Контекст, РазрядностьОкругления, Графы); +``` +
+ +## ЗаменитьСкалярныеАргументыВВыраженииПоСтроке +
+ +Описание, пример вызова + +```bsl + +Функция ЗаменитьСкалярныеАргументыВВыраженииПоСтроке(Выражение, Контекст, АргументПоискаСтроки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЗаменитьСкалярныеАргументыВВыраженииПоСтроке(Выражение, Контекст, АргументПоискаСтроки)); +``` +
+ +## ЗаменитьСкалярныеАргументыВВыражении +
+ +Описание, пример вызова + +```bsl + +Функция ЗаменитьСкалярныеАргументыВВыражении(Выражение, Контекст, Колонка = Неопределено, СтрокаОтбора = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЗаменитьСкалярныеАргументыВВыражении(Выражение, Контекст, Колонка, СтрокаОтбора); +``` +
+ +## ПолучитьЕдинственныйАргументВыражения +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьЕдинственныйАргументВыражения(АргументСуммирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьЕдинственныйАргументВыражения(АргументСуммирования)); +``` +
+ +## СтрокаВходитВДиапазон +
+ +Описание, пример вызова + +```bsl + +Функция СтрокаВходитВДиапазон(Контекст, Выборка, Стр) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.СтрокаВходитВДиапазон(Контекст, Выборка, Стр)); +``` +
+ +## КолонкаВходитВДиапазон +
+ +Описание, пример вызова + +```bsl + +Функция КолонкаВходитВДиапазон(Контекст, Выборка, Кол) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.КолонкаВходитВДиапазон(Контекст, Выборка, Кол)); +``` +
+ +## ВычислитьАргументСуммированияВУсловии +
+ +Описание, пример вызова + +```bsl + +Функция ВычислитьАргументСуммированияВУсловии(АргументСуммирования, Контекст, ОтборПоКолонкам = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ВычислитьАргументСуммированияВУсловии(АргументСуммирования, Контекст, ОтборПоКолонкам); +``` +
+ +## ВычислитьАргументСуммированияВУсловииПоСтроке +
+ +Описание, пример вызова + +```bsl + +Функция ВычислитьАргументСуммированияВУсловииПоСтроке(АргументСуммирования, Контекст, СтрокаОтбора) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ВычислитьАргументСуммированияВУсловииПоСтроке(АргументСуммирования, Контекст, СтрокаОтбора)); +``` +
+ +## ЭтоВариацияПоСтрокамИлиГрафам +
+ +Описание, пример вызова + +```bsl + +Функция ЭтоВариацияПоСтрокамИлиГрафам(Контекст, Условие, СтрокиИГрафы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЭтоВариацияПоСтрокамИлиГрафам(Контекст, Условие, СтрокиИГрафы)); +``` +
+ +## ОбработкаВставкиСтрокиВТаблицуИзФормата +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаВставкиСтрокиВТаблицуИзФормата(Контекст, Операнд, СтрокиИГрафы) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ОбработкаВставкиСтрокиВТаблицуИзФормата(Контекст, Операнд, СтрокиИГрафы)); +``` +
+ +## ОбработкаВставкиСтрокиВТаблицу +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаВставкиСтрокиВТаблицу(Контекст, СтрокаТаблицы, Операнд, СтрокиИГрафы) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ОбработкаВставкиСтрокиВТаблицу(Контекст, СтрокаТаблицы, Операнд, СтрокиИГрафы)); +``` +
+ +## ВычислитьУсловиеПоСпецификамСУсловием +
+ +Описание, пример вызова + +```bsl + +Функция ВычислитьУсловиеПоСпецификамСУсловием(ОтборУсловие, Условие, Контекст, РазрядностьОкругления = 2, Специфики = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ВычислитьУсловиеПоСпецификамСУсловием(ОтборУсловие, Условие, Контекст, РазрядностьОкругления, Специфики); +``` +
+ +## ВычислитьУсловиеПоСтрокам +
+ +Описание, пример вызова + +```bsl + +Функция ВычислитьУсловиеПоСтрокам(Условие, Контекст, РазрядностьОкругления = 2, Строки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ВычислитьУсловиеПоСтрокам(Условие, Контекст, РазрядностьОкругления, Строки); +``` +
+ +## ВычислитьБезусловноеВыражениеПоСтрокамИГрафам +
+ +Описание, пример вызова + +```bsl + +Функция ВычислитьБезусловноеВыражениеПоСтрокамИГрафам(Контекст, Выражение, РазрядностьОкругления = 2) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ВычислитьБезусловноеВыражениеПоСтрокамИГрафам(Контекст, Выражение, РазрядностьОкругления); +``` +
+ +## ПолучитьВсеАргументыКромеСуммированийВВыражении +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьВсеАргументыКромеСуммированийВВыражении(Контекст, Выражение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьВсеАргументыКромеСуммированийВВыражении(Контекст, Выражение)); +``` +
+ +## ПолучитьВсеАргументыВыражения +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьВсеАргументыВыражения(Контекст, Выражение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьВсеАргументыВыражения(Контекст, Выражение)); +``` +
+ +## ПолучитьВариацииГраф +
+ +Описание, пример вызова + +```bsl + +функция ПолучитьВариацииГраф(Контекст, ВсеАргументы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьВариацииГраф(Контекст, ВсеАргументы)); +``` +
+ +## ЗаменитьВариациюПоГрафамВВыражении +
+ +Описание, пример вызова + +```bsl + +функция ЗаменитьВариациюПоГрафамВВыражении(Выражение, ВсеАргументы, Контекст, ВариацииГраф, Колонка) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЗаменитьВариациюПоГрафамВВыражении(Выражение, ВсеАргументы, Контекст, ВариацииГраф, Колонка)); +``` +
+ +## ПолучитьАргументСкобки +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьАргументСкобки(Выражение, НомерСкобки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьАргументСкобки(Выражение, НомерСкобки)); +``` +
+ +## ВычислитьУсловиеПоСтрокамИлиГрафам +
+ +Описание, пример вызова + +```bsl + +Функция ВычислитьУсловиеПоСтрокамИлиГрафам(Условие, Контекст, РазрядностьОкругления = 2, СтрокиИГрафы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ВычислитьУсловиеПоСтрокамИлиГрафам(Условие, Контекст, РазрядностьОкругления, СтрокиИГрафы); +``` +
+ +## ПодставитьАргументыВВыражениеДляМножественныхСтрокПоГрафам +
+ +Описание, пример вызова + +```bsl + +Функция ПодставитьАргументыВВыражениеДляМножественныхСтрокПоГрафам(Выражение, Контекст, ДополнительнаяИнформация, ДанныеТекущейСтроки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПодставитьАргументыВВыражениеДляМножественныхСтрокПоГрафам(Выражение, Контекст, ДополнительнаяИнформация, ДанныеТекущейСтроки)); +``` +
+ +## ВычислитьУсловиеДляМножественныхСтрокПоГрафам +
+ +Описание, пример вызова + +```bsl + +Функция ВычислитьУсловиеДляМножественныхСтрокПоГрафам(Условие, Контекст, СтрокиИГрафы, ДополнительнаяИнформация, РазрядностьОкругления = 2) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ВычислитьУсловиеДляМножественныхСтрокПоГрафам(Условие, Контекст, СтрокиИГрафы, ДополнительнаяИнформация, РазрядностьОкругления); +``` +
+ +## ОбработатьУсловиеПоСтрокам +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработатьУсловиеПоСтрокам(Условие, Контекст, РазрядностьОкругления = 2, Строки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ОбработатьУсловиеПоСтрокам(Условие, Контекст, РазрядностьОкругления, Строки); +``` +
+ +## ОбработатьУсловиеПоСтрокамИлиГрафам +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработатьУсловиеПоСтрокамИлиГрафам(Условие, Контекст, РазрядностьОкругления = 2, СтрокиИГрафы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ОбработатьУсловиеПоСтрокамИлиГрафам(Условие, Контекст, РазрядностьОкругления, СтрокиИГрафы); +``` +
+ +## СтруктурироватьВыражение +
+ +Описание, пример вызова + +```bsl + +Функция СтруктурироватьВыражение(Выражение, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.СтруктурироватьВыражение(Выражение, Контекст)); +``` +
+ +## УсловиеИКонтрольИзРазныхРазделов +
+ +Описание, пример вызова + +```bsl + +Функция УсловиеИКонтрольИзРазныхРазделов(Контекст, condition, rule) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.УсловиеИКонтрольИзРазныхРазделов(Контекст, condition, rule)); +``` +
+ +## ДополнениеСтрокИГраф +
+ +Описание, пример вызова + +```bsl + +Функция ДополнениеСтрокИГраф(condition, rule, СтрокиИГрафы, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ДополнениеСтрокИГраф(condition, rule, СтрокиИГрафы, Контекст)); +``` +
+ +## УдалениеОшибочноМножественныхСтрок +
+ +Описание, пример вызова + +```bsl + +Процедура УдалениеОшибочноМножественныхСтрок(Контекст, Выражение) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.УдалениеОшибочноМножественныхСтрок(Контекст, Выражение)); +``` +
+ +## ПроверитьКонтрольноеСоотношение +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьКонтрольноеСоотношение(СтрокаТаблицы, Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверитьКонтрольноеСоотношение(СтрокаТаблицы, Контекст) +``` +
+ +## ПолучитьСведенияОШаблоне +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСведенияОШаблоне(Форма, ИмяМакетаАтрибутов) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьСведенияОШаблоне(Форма, ИмяМакетаАтрибутов)); +``` +
+ +## ПроверкаСоотношенийПриОтсутствииФормата +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверкаСоотношенийПриОтсутствииФормата(ПараметрыДляПроверки, АдресХранилища) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверкаСоотношенийПриОтсутствииФормата(ПараметрыДляПроверки, АдресХранилища) +``` +
+ +## ПроверитьКонтрольныеСоотношенияИзШаблона +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьКонтрольныеСоотношенияИзШаблона(Форма, ПараметрыПроверкиКонтрольныхСоотношений) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверитьКонтрольныеСоотношенияИзШаблона(Форма, ПараметрыПроверкиКонтрольныхСоотношений) +``` +
+ +## ПроверитьКонтрольныеСоотношенияВОтчетеВФоне +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьКонтрольныеСоотношенияВОтчетеВФоне(ПараметрыДляПроверки, АдресХранилища) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверитьКонтрольныеСоотношенияВОтчетеВФоне(ПараметрыДляПроверки, АдресХранилища) +``` +
+ +## ИзменитьВерсиюФорматаСПроверкойСовместимостиШаблонов +
+ +Описание, пример вызова + +```bsl + +Процедура ИзменитьВерсиюФорматаСПроверкойСовместимостиШаблонов(МодульОтчета, ПараметрыДляПроверки, ИтоговыйФайл) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ИзменитьВерсиюФорматаСПроверкойСовместимостиШаблонов(МодульОтчета, ПараметрыДляПроверки, ИтоговыйФайл) +``` +
+ +## ПроверитьСпецификиНаЗаполненность +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьСпецификиНаЗаполненность(Контекст, Результат, Инд, ПараметрыДляПроверки) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверитьСпецификиНаЗаполненность(Контекст, Результат, Инд, ПараметрыДляПроверки)); +``` +
+ +## ПроверитьСпецификиНаДублирование +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьСпецификиНаДублирование(Контекст, Результат, Инд, ПараметрыДляПроверки) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверитьСпецификиНаДублирование(Контекст, Результат, Инд, ПараметрыДляПроверки)); +``` +
+ +## ПроверитьЗаполненностьПолейТитула +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьЗаполненностьПолейТитула(Контекст, Результат, Инд, ПараметрыДляПроверки) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверитьЗаполненностьПолейТитула(Контекст, Результат, Инд, ПараметрыДляПроверки)); +``` +
+ +## ПроверитьГодОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьГодОтчета(Контекст, Результат, Инд, ПараметрыДляПроверки) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверитьГодОтчета(Контекст, Результат, Инд, ПараметрыДляПроверки)); +``` +
+ +## ПроверитьОбязательныеДляЗаполненияГрафы +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьОбязательныеДляЗаполненияГрафы(Контекст, Результат, Инд, ПараметрыДляПроверки) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверитьОбязательныеДляЗаполненияГрафы(Контекст, Результат, Инд, ПараметрыДляПроверки)); +``` +
+ +## ДобавитьПустыеОбязательныеМножественныеСтроки +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьПустыеОбязательныеМножественныеСтроки(Контекст) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ДобавитьПустыеОбязательныеМножественныеСтроки(Контекст)); +``` +
+ +## ПроверкаДиапазонов +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверкаДиапазонов(Контекст, Результат, ПараметрыДляПроверки, Инд) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверкаДиапазонов(Контекст, Результат, ПараметрыДляПроверки, Инд)); +``` +
+ +## СформироватьИнформациюОПоляхОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура СформироватьИнформациюОПоляхОтчета(Контекст) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.СформироватьИнформациюОПоляхОтчета(Контекст)); +``` +
+ +## ИнформацияПоПолю +
+ +Описание, пример вызова + +```bsl + +Функция ИнформацияПоПолю(Контекст, Секция, Строка, Колонка) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ИнформацияПоПолю(Контекст, Секция, Строка, Колонка)); +``` +
+ +## ЧисловойСписокИзОписания +
+ +Описание, пример вызова + +```bsl + +Функция ЧисловойСписокИзОписания(Контекст, Аргумент) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЧисловойСписокИзОписания(Контекст, Аргумент)); +``` +
+ +## РасшифровкаПоОшибке +
+ +Описание, пример вызова + +```bsl + +Процедура РасшифровкаПоОшибке(Контекст, Условие, ТекстовоеПредставление, Инд) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.РасшифровкаПоОшибке(Контекст, Условие, ТекстовоеПредставление, Инд)); +``` +
+ +## ПроверитьКонтрольныеСоотношенияВОтчете +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьКонтрольныеСоотношенияВОтчете(ПараметрыДляПроверки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПроверитьКонтрольныеСоотношенияВОтчете(ПараметрыДляПроверки)); +``` +
+ +## ДатаВерсии +
+ +Описание, пример вызова + +```bsl + +Функция ДатаВерсии(СтрДата) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ДатаВерсии(СтрДата)); +``` +
+ +## ЗаменитьЕстьНулл +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаменитьЕстьНулл(Контекст, Формула, ФормулаПодходит) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ЗаменитьЕстьНулл(Контекст, Формула, ФормулаПодходит)); +``` +
+ +## УстановитьТипРасчета +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьТипРасчета(Контекст, ОтобранныеКонтрольныеСоотношения) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.УстановитьТипРасчета(Контекст, ОтобранныеКонтрольныеСоотношения)); +``` +
+ +## ПолучитьПервыйКлючСоответствия +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПервыйКлючСоответствия(Соотв) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьПервыйКлючСоответствия(Соотв)); +``` +
+ +## ПорядковыйНомерПериодаВГоду +
+ +Описание, пример вызова + +```bsl + +Функция ПорядковыйНомерПериодаВГоду(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПорядковыйНомерПериодаВГоду(Контекст)); +``` +
+ +## ПервичныйОтборКонтрольныхСоотношений +
+ +Описание, пример вызова + +```bsl + +Функция ПервичныйОтборКонтрольныхСоотношений(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПервичныйОтборКонтрольныхСоотношений(Контекст)); +``` +
+ +## ПервичныйОтборДляМножественныхСтрок +
+ +Описание, пример вызова + +```bsl + +Функция ПервичныйОтборДляМножественныхСтрок(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПервичныйОтборДляМножественныхСтрок(Контекст)); +``` +
+ +## УстановитьАргументСкобкиВВвражении +
+ +Описание, пример вызова + +```bsl + +Функция УстановитьАргументСкобкиВВвражении(Контекст, Выражение, НомерСкобки, НовоеВыражение) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.УстановитьАргументСкобкиВВвражении(Контекст, Выражение, НомерСкобки, НовоеВыражение)); +``` +
+ +## ОтброситьДублирующиеКонтрольныеСоотношенияВРазделе +
+ +Описание, пример вызова + +```bsl + +Процедура ОтброситьДублирующиеКонтрольныеСоотношенияВРазделе(Контекст, ОтобранныеКонтрольныеСоотношенияВРазделе, Секция) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ОтброситьДублирующиеКонтрольныеСоотношенияВРазделе(Контекст, ОтобранныеКонтрольныеСоотношенияВРазделе, Секция)); +``` +
+ +## ОтброситьДублирующиеКонтрольныеСоотношения +
+ +Описание, пример вызова + +```bsl + +Процедура ОтброситьДублирующиеКонтрольныеСоотношения(Контекст, ОтобранныеКонтрольныеСоотношения) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ОтброситьДублирующиеКонтрольныеСоотношения(Контекст, ОтобранныеКонтрольныеСоотношения)); +``` +
+ +## ПолучитьПодвыражениеСуммирования +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьПодвыражениеСуммирования(Выражение, ИндексСуммы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьПодвыражениеСуммирования(Выражение, ИндексСуммы)); +``` +
+ +## ЗаменитьСуммуВРасчете +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаменитьСуммуВРасчете(Контекст, ОтобранныеКонтрольныеСоотношения) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ЗаменитьСуммуВРасчете(Контекст, ОтобранныеКонтрольныеСоотношения)); +``` +
+ +## ОтброситьНекорректныеВыражения +
+ +Описание, пример вызова + +```bsl + +Процедура ОтброситьНекорректныеВыражения(Контекст, ОтобранныеКонтрольныеСоотношения) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ОтброситьНекорректныеВыражения(Контекст, ОтобранныеКонтрольныеСоотношения)); +``` +
+ +## ОтброситьРасчетЗапрещенныхДляВводаГраф +
+ +Описание, пример вызова + +```bsl + +Процедура ОтброситьРасчетЗапрещенныхДляВводаГраф(Контекст, ОтобранныеКонтрольныеСоотношения) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ОтброситьРасчетЗапрещенныхДляВводаГраф(Контекст, ОтобранныеКонтрольныеСоотношения)); +``` +
+ +## СортированныеПараметры +
+ +Описание, пример вызова + +```bsl + +Функция СортированныеПараметры(ИсходныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.СортированныеПараметры(ИсходныеПараметры)); +``` +
+ +## СформироватьДанныеАвторасчета +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьДанныеАвторасчета(Шаблон, ПараметрыПериода) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.СформироватьДанныеАвторасчета(Шаблон, ПараметрыПериода) +``` +
+ +## РаскрытьФормулы +
+ +Описание, пример вызова + +```bsl + +Процедура РаскрытьФормулы(Контекст, Таблица) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.РаскрытьФормулы(Контекст, Таблица)); +``` +
+ +## ПолучитьФормулыАвторасчетаДляСтрокиСекции +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьФормулыАвторасчетаДляСтрокиСекции(Контекст, ОтобранныеКонтрольныеСоотношенияДляСтроки, Секция, Строка) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьФормулыАвторасчетаДляСтрокиСекции(Контекст, ОтобранныеКонтрольныеСоотношенияДляСтроки, Секция, Строка)); +``` +
+ +## ПолучитьФормулыАвторасчетаДляГрафыСекции +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьФормулыАвторасчетаДляГрафыСекции(Контекст, ОтобранныеКонтрольныеСоотношенияДляГрафы, Секция, Графа) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьФормулыАвторасчетаДляГрафыСекции(Контекст, ОтобранныеКонтрольныеСоотношенияДляГрафы, Секция, Графа)); +``` +
+ +## ПолучитьКольцевуюЗависимость +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьКольцевуюЗависимость(ГрафЗависимостией) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьКольцевуюЗависимость(ГрафЗависимостией)); +``` +
+ +## ЕстьКольцеваяЗависимостьРек +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьКольцеваяЗависимостьРек(ГрафЗависимостией, ПройденныеВершины, ТекущаяВершина) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ЕстьКольцеваяЗависимостьРек(ГрафЗависимостией, ПройденныеВершины, ТекущаяВершина)); +``` +
+ +## ПолучитьФормулыАвторасчетаДляСекции +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьФормулыАвторасчетаДляСекции(Контекст, ОтобранныеКонтрольныеСоотношенияДляСекции, Секция) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.ПолучитьФормулыАвторасчетаДляСекции(Контекст, ОтобранныеКонтрольныеСоотношенияДляСекции, Секция)); +``` +
+ +## ДополнитьРасчитываемыеЯчейки +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьРасчитываемыеЯчейки(Контекст, РасчитываемыеЯчейки, ОтобранныеКонтрольныеСоотношенияДляСекции, Секция, Многострочный = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ДополнитьРасчитываемыеЯчейки(Контекст, РасчитываемыеЯчейки, ОтобранныеКонтрольныеСоотношенияДляСекции, Секция, Многострочный); +``` +
+ +## ДополнитьЗависимости +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьЗависимости(Контекст, Зависимости, ОтобранныеКонтрольныеСоотношенияДляСекции, Секция, Многострочный = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтерпретаторКонтрольныхСоотношенийРосстата.ДополнитьЗависимости(Контекст, Зависимости, ОтобранныеКонтрольныеСоотношенияДляСекции, Секция, Многострочный); +``` +
+ +## СформироватьФормулыАвторасчета +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьФормулыАвторасчета(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.СформироватьФормулыАвторасчета(Контекст)); +``` +
+ +## СформироватьФормулыАвторасчетаМножественныхСтрок +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьФормулыАвторасчетаМножественныхСтрок(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерпретаторКонтрольныхСоотношенийРосстата.СформироватьФормулыАвторасчетаМножественныхСтрок(Контекст)); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтерфейсыВзаимодействияБРО.md b/src/content/docs/zup/ИнтерфейсыВзаимодействияБРО.md new file mode 100644 index 0000000..cc542c8 --- /dev/null +++ b/src/content/docs/zup/ИнтерфейсыВзаимодействияБРО.md @@ -0,0 +1,3575 @@ +--- +title: Интерфейсы взаимодействия БРО +slug: zup/интерфейсы-взаимодействия-бро +--- + + +## ЭтоИностраннаяОрганизацияПоИНН +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает признак - является ли организация иностранной в зависимости от ИНН. +// +// Параметры: +// Организация - СправочникСсылка.Организации - ссылка на элемент справочника "Организации". +// +// Возвращаемое значение: +// Истина - организация является иностранной; +// Ложь - организация не является иностранной. +// +// +Функция ЭтоИностраннаяОрганизацияПоИНН(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЭтоИностраннаяОрганизацияПоИНН(Организация) +``` +
+ +## СоответствиеЗаменяемыхКодовОргановФСГС +
+ +Описание, пример вызова + +```bsl + +// Коды органов ФСГС, заменяемые в связи с поддержкой взаимодействия с ЦЕМПОС. +// +// Возвращаемое значение: +// Соответствие - для кодов органов ФСГС возвращаются коды, на которые их следует заменить в справочниках +// (организаций, подразделений). +// +Функция СоответствиеЗаменяемыхКодовОргановФСГС(Знач ОпрашиватьСервис = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СоответствиеЗаменяемыхКодовОргановФСГС(ОпрашиватьСервис); +``` +
+ +## АвтономноеСоответствиеЗаменяемыхКодовТОГС +
+ +Описание, пример вызова + +```bsl + +Функция АвтономноеСоответствиеЗаменяемыхКодовТОГС() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.АвтономноеСоответствиеЗаменяемыхКодовТОГС()); +``` +
+ +## ПоляКоторыеНеВсегдаТребуетсяЗаполнять +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции интерфейса взаимодействия с прикладным кодом +// автоматического заполнения данных статистической отчетности. + +// Возвращает поля, которые не требуется заполнять. +// +Функция ПоляКоторыеНеВсегдаТребуетсяЗаполнять(ИмяРеглОтчета, ИмяФормы, Период) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПоляКоторыеНеВсегдаТребуетсяЗаполнять(ИмяРеглОтчета, ИмяФормы, Период) +``` +
+ +## КраткоеПредставлениеФормы +
+ +Описание, пример вызова + +```bsl + +// Краткое представление формы, которое выводится, например, в заголовке диалога настройки. +// +// Параметры: +// РегламентированныйОтчет - ДокументСсылка.РегламентированныйОтчет +// +// Возвращаемое значение: +// Строка - краткое представление формы. +// +Функция КраткоеПредставлениеФормы(РегламентированныйОтчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.КраткоеПредставлениеФормы(РегламентированныйОтчет) +``` +
+ +## ВидыКлассификаторов +
+ +Описание, пример вызова + +```bsl + +// Возвращает список классификаторов, про которые знает БРО. +// +// Возвращаемое значение: +// СписокЗначений - "ВидыДеятельности", "ВидыПродукцииОпт", "ВидыПродукцииПроизводство", +// "ВидыПродукцииРозница", "УслугиНаселению". +// +Функция ВидыКлассификаторов() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ВидыКлассификаторов() +``` +
+ +## ВерсииКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Возвращает список версий классификатора +// +// Параметры: +// ВидКласификатора - строка +// +// Возвращаемое значение: +// СписокЗначений - версии классификатора. +// Например: для ВидКласификатора = "ВидыПродукцииОпт" +// вернем список версий ("2010кв1", "2012кв1", "2013кв1", "2013кв4", "2014кв1") +// с представлением. +// +Функция ВерсииКлассификатора(ВидКласификатора) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ВерсииКлассификатора(ВидКласификатора) +``` +
+ +## ДанныеКлассификатора +
+ +Описание, пример вызова + +```bsl + +// По классификатору и версии вернем таблицу значений +// +// Параметры: +// ВидКласификатора - строка +// Версия - строка +// +// Возвращаемое значение: +// ТаблицаЗначений - данные классификатора. +// Возвращаем таблицу значений с 4 колонками: +// Код, Наименование, НаименованиеЕдиницыИзмерения, КодЕдиницыИзмерения +// Все колонки имеют тип "строка" +// +Функция ДанныеКлассификатора(ВидКласификатора, ВерсияКлассификатора) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ДанныеКлассификатора(ВидКласификатора, ВерсияКлассификатора) +``` +
+ +## ПолучитьПоляФормыСтатистики +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции описания форм статистики. + +// Функция читает структуру XML переданной формы статистики. +// +// Параметры: +// ИмяОтчета - Строка - имя отчета. +// ИмяСхемыВыгрузки - Строка - имя схемы выгрузки. +// +// Возвращаемое значение: +// ТаблицаЗначений - содежит иерархию полей формы статистики. +// +Функция ПолучитьПоляФормыСтатистики(ИмяОтчета, ИмяСхемыВыгрузки) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПолучитьПоляФормыСтатистики(ИмяОтчета, ИмяСхемыВыгрузки) +``` +
+ +## ПолучитьВерсииСписковОтчета +
+ +Описание, пример вызова + +```bsl + +// Функция считывает версии списков отчета. +// +// Парамеры: +// ИмяОтчета - Строка - идентификатор отчета, для которого нужно вернуть версии списков. +// +// Возвращаемое значение: +// СписокЗначений - версии списков отчета. +// +Функция ПолучитьВерсииСписковОтчета(ИмяОтчета) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПолучитьВерсииСписковОтчета(ИмяОтчета) +``` +
+ +## ПолучитьРасположениеКлассификатораСтатистики +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает структуру содержащую 2 параметра: +// +// Параметры: +// ИмяКлассификатора - Строка +// Назначение - Строка +// Возвращаемое значение: +// Структура - расположение классификатор форм статистики. +// +Функция ПолучитьРасположениеКлассификатораСтатистики(ИмяКлассификатора, Назначение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПолучитьРасположениеКлассификатораСтатистики(ИмяКлассификатора, Назначение); +``` +
+ +## ПолучитьЗначенияИзСпискаВыбораОтчета +
+ +Описание, пример вызова + +```bsl + +// Получает данные переданного списка выбора отчета. +// +// Параметры: +// ИмяОтчета - Строка - Идентификатор отчета содежащего искомый список. +// ИмяМакета - Строка - Идентификатор макета в котором хранятся списки отчета. +// ИмяСписка - Строка - Имя искомого списка в макете "Списки" отчета. +// ДополнятьКодСлева - Булево - дополнять код слева (по умолчанию) символом "0" +// до длины кода (по умолчанию) 12, длина кода и символ дополнения могут быть определены +// параметрами. +// ДлинаКода - Число - длина кода классификатора, коды классификатора будут приведены к этой длине. +// СимволДополненияКода - Строка - символ которым нужно дополнить код слева, до заданной длины. +// +// Возвращаемое значение: +// ТаблицаЗначений - данные списка. +// +Функция ПолучитьЗначенияИзСпискаВыбораОтчета(ИмяОтчета, ИмяМакета, ИмяСписка, ДополнятьКодСлева = Ложь, ДлинаКода = Неопределено, СимволДополненияКода = "0") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПолучитьЗначенияИзСпискаВыбораОтчета(ИмяОтчета, ИмяМакета, ИмяСписка, ДополнятьКодСлева, ДлинаКода, СимволДополненияКода); +``` +
+ +## СформироватьАвтоматическиРеглОтчетВФоне +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции интерфейса взаимодействия с потребителями БРО. + +// Формирует автоматически в фоне формы регламентированных отчетов для выбранных налоговых органов. +// Предназначена для автоформирования регл. отчетов: +// "6-НДФЛ (с 2021 года)"; +// "6-НДФЛ"; +// "Декларация по ЕНВД (за периоды, начиная с 01.01.2016)". +// +// Параметры: +// СтруктураПараметров - Структура - ключи: +// "ИмяОтчета" - Строка - имя регламентированного отчета; +// "Организация" - СправочникСсылка.Организации - ссылка на организацию; +// "ДатаНачалаПериодаОтчета" - Дата - дата начала периода отчета; +// "ДатаКонцаПериодаОтчета" - Дата - дата конца периода отчета; +// "НалоговыеОрганы" - СписокЗначений - список элементов справочника "РегистрацииВНалоговомОргане"; +// "АдресВоВременномХранилищеРезультатаАвтоформирования" - Строка - адрес во временном хранилище результата автоформирования; +// НеиспользуемыйАдресХранилища - Строка - обязателен для совместимости с БСП, если процедура применяется как +// диспетчер запуска автоформирования регламентированных отчетов в фоне +// (необязателен в остальных случаях). +// +Процедура СформироватьАвтоматическиРеглОтчетВФоне(СтруктураПараметров, НеиспользуемыйАдресХранилища = "") Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчетВФоне(СтруктураПараметров, НеиспользуемыйАдресХранилища); +``` +
+ +## ОбновитьДанныеРеглОтчета +
+ +Описание, пример вызова + +```bsl + +// Процедура обновляет сохраненные данные регламентированного отчета +// заданного вида для указанной организации за нужный отчетный период. +// +// Параметры: +// ИсточникОтчета - Строка - строка с наименованием регламентированного отчета (совпадает с именем объекта метаданных). +// Организация - СправочникСсылка.Организации - ссылка на элемент справочника организаций. +// ДатаНачала - Дата - дата начала отчетного периода (левая граница отчетного преиода). +// ДатаОкончания - Дата - дата окончания отчетного периода (правая граница отчетного периода). +// СсылкаНаСохрРеглОтчет - ДокументСсылка.РегламентированныйОтчет - ссылка на сохраненный регламентированный отчет, данные которого нужно получить. +// +// Пример: +// ИнтерфейсыВзаимодействия.ОбновитьДанныеРеглОтчета("РегламентированныйОтчетРСВ1", Организация, '20120101', '20121231', СсылкаНаСохрРеглОтчет); +// +Процедура ОбновитьДанныеРеглОтчета(ИсточникОтчета, Организация, ДатаНачала, ДатаОкончания, СсылкаНаСохрРеглОтчет) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ОбновитьДанныеРеглОтчета(ИсточникОтчета, Организация, ДатаНачала, ДатаОкончания, СсылкаНаСохрРеглОтчет) +``` +
+ +## СформироватьАвтоматическиРеглОтчет +
+ +Описание, пример вызова + +```bsl + +// Функция автоматически формирует регламентированный отчет заданного вида для указанной организации +// за нужный отчетный период, сохраняет его в ИБ и возвращает ссылку. +// +// Параметры: +// ИсточникОтчета - Строка - строка с наименованием регламентированного отчета (совпадает с именем объекта метаданных). +// Организация - СправочникСсылка.Организации - ссылка на элемент справочника организаций. +// ДатаНачала - Дата - дата начала отчетного периода (левая граница отчетного преиода). +// ДатаОкончания - Дата - дата окончания отчетного периода (правая граница отчетного периода). +// КорректирующийОтчет - Булево - признак корректирующего отчета. +// ИмяФормыОтчета - Строка - строка с именем формы регламентированного отчета (определяет нужную из форм, +// действующих в отчетном периоде). +// ПараметрыАвтоФормирования - Структура - параметры автоматического формирования регл. отчета. +// +// Возвращемое значение: +// ДокументСсылка.РегламентированныйОтчет - ссылка на документ "РегламентированныйОтчет". +// +// Пример: +// ИнтерфейсыВзаимодействия.СформироватьАвтоматическиРеглОтчет("РегламентированныйОтчетРСВ1", Организация, '20120101', '20121231'); +// +Функция СформироватьАвтоматическиРеглОтчет(ИсточникОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет = Ложь, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчет(ИсточникОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ); +``` +
+ +## УстановитьВидФормыРСВ_1 +
+ +Описание, пример вызова + +```bsl + +// Процедура устанавливает значение реквизита "Вид" формы РСВ-1. +// +// Параметры: +// Ссылка - ДокументСсылка.РегламентированныйОтчет - ссылка на регл. отчет. +// КорректирующаяФорма - Булево - признак корректирующей формы. +// +Процедура УстановитьВидФормыРСВ_1(Ссылка, КорректирующаяФорма) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.УстановитьВидФормыРСВ_1(Ссылка, КорректирующаяФорма) +``` +
+ +## ПодключенДокументооборотСКонтролирующимОрганом +
+ +Описание, пример вызова + +```bsl + +// Функция определяет для организации, подключен ли документооборот с контролирующим органом. +// +// Параметры: +// Организация - СправочникСсылка.Организации - Организация, для которой определяется +// наличие подключенного документооборота с контролирующим органом. +// КонтролирующийОрган - Перечисление.ТипыКонтролирующихОрганов - контролирующий орган, для +// которого определяется наличие подключения. +// ПроверятьДляТекущегоПользователя - Булево - Если истина, доступ проверяется для текущего пользователя +// иначе в целом по организации. Если Организация не указана, то флаг ПроверятьДляТекущегоПользователя игнорируется +// Возвращаемое значение: +// Булево - Истина, если документооборот с контролирующим органом подключен. +Функция ПодключенДокументооборотСКонтролирующимОрганом( Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПодключенДокументооборотСКонтролирующимОрганом(); +``` +
+ +## ОрганизацияИмеетУчетнуюЗапись +
+ +Описание, пример вызова + +```bsl + +// Функция определяет, имеет ли организация учетную запись. +// +// Параметры: +// Организация - СправочникСсылка.Организации - Организация, для которой определяется +// наличие подключенного документооборота с контролирующим органом. +// Возвращаемое значение: +// Булево - Истина, учетная запись есть. +Функция ОрганизацияИмеетУчетнуюЗапись(Организация = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ОрганизацияИмеетУчетнуюЗапись(Организация); +``` +
+ +## НовыйПараметрыАвтоформированияОтчета +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров автоматического формирования регламентированных отчетов без открытия формы. +// +// Возвращаемое значение: +// Структура - Содержит ключи с параметрами автоформирования. +// +Функция НовыйПараметрыАвтоформированияОтчета() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.НовыйПараметрыАвтоформированияОтчета() +``` +
+ +## СправкиОДоходахИСуммахНалогаФизическихЛицИзОтчетов6_НДФЛ +
+ +Описание, пример вызова + +```bsl + +// Возвращает справки о доходах и суммах налога физических лиц из регламентированных отчетов "6-НДФЛ (с 2021 года)". +// +// Параметры: +// СтруктураПараметров - Структура - свойства: +// * Организация - СправочникСсылка.Организации - организация, для которой будет выполняться поиск +// отчетов "6-НДФЛ (с 2021 года)"; +// * ДатаОкончания - Дата - дата окончания отчетного периода для поиска отчетов "6-НДФЛ (с 2021 года)"; +// * ИмяФормыОтчета - Строка - имя формы отчета "6-НДФЛ (с 2021 года)", например, "ФормаОтчета2024Кв2" +// (необязательное свойство; если отсутствует, значение будет получено автоматически). +// +// Возвращаемое значение: +// Массив - массив структур с данными отчетов (пустой массив, если отчетов не найдено). +// Каждая структура (случай непустого массива) - Структура - имеет свойства: +// * НомерКорректировки - Число - номер корректировки из отчета "6-НДФЛ (с 2021 года)"; +// * КПП - Строка - КПП из отчета "6-НДФЛ (с 2021 года)"; +// * ОКТМО - Строка - код по ОКТМО из отчета "6-НДФЛ (с 2021 года)"; +// * СправкиОДоходахИСуммахНалогаФизическихЛиц - ДеревоЗначений - справки о доходах и +// суммах налога физических лиц из отчета "6-НДФЛ (с 2021 года)". +// +Функция СправкиОДоходахИСуммахНалогаФизическихЛицИзОтчетов6_НДФЛ(СтруктураПараметров) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СправкиОДоходахИСуммахНалогаФизическихЛицИзОтчетов6_НДФЛ(СтруктураПараметров) +``` +
+ +## ПерсонифицированныеСведенияОЗастрахованныхЛицахИзРасчетовПоСтраховымВзносам +
+ +Описание, пример вызова + +```bsl + +// Возвращает персонифицированные сведения о застрахованных лицах из регламентированных отчетов +// "Расчет по страховым взносам". +// +// Параметры: +// СтруктураПараметров - Структура - свойства: +// * Организация - СправочникСсылка.Организации - организация, для которой будет выполняться поиск отчетов +// "Расчет по страховым взносам"; +// * ДатаОкончания - Дата - дата окончания отчетного периода для поиска отчетов "Расчет по страховым взносам"; +// * ИмяФормыОтчета - Строка - имя формы отчета "Расчет по страховым взносам", например, "ФормаОтчета2023Кв1" +// (необязательное свойство; если отсутствует, значение будет получено автоматически). +// +// Возвращаемое значение: +// Массив - массив структур с данными отчетов (пустой массив, если отчетов не найдено). +// Каждая структура (случай непустого массива) - Структура - имеет свойства: +// * НомерКорректировки - Число - номер корректировки из отчета "Расчет по страховым взносам"; +// * ПерсонифицированныеСведенияОЗастрахованныхЛицах - ДеревоЗначений - персонифицированные +// сведения о застрахованных лицах из отчета "Расчет по страховым взносам". +// +Функция ПерсонифицированныеСведенияОЗастрахованныхЛицахИзРасчетовПоСтраховымВзносам(СтруктураПараметров) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПерсонифицированныеСведенияОЗастрахованныхЛицахИзРасчетовПоСтраховымВзносам(СтруктураПараметров) +``` +
+ +## ПерсональныеДанныеИВыплатыИзПерсонифицированныхСведенийОФизическихЛицах +
+ +Описание, пример вызова + +```bsl + +// Возвращает персональные данные физических лиц и сведения о суммах выплат и иных вознаграждений в их пользу +// из регламентированных отчетов "Персонифицированные сведения о физических лицах". +// +// Параметры: +// СтруктураПараметров - Структура - свойства: +// * Организация - СправочникСсылка.Организации - организация, для которой будет выполняться поиск отчетов +// "Персонифицированные сведения о физических лицах"; +// * ДатаОкончания - Дата - дата окончания отчетного периода для поиска отчетов "Персонифицированные сведения +// о физических лицах"; +// * ИмяФормыОтчета - Строка - имя формы отчета "Персонифицированные сведения о физических лицах", например, +// "ФормаОтчета2023Кв1" (необязательное свойство; если отсутствует, значение будет получено +// автоматически). +// +// Возвращаемое значение: +// Массив - массив структур с данными отчетов (пустой массив, если отчетов не найдено). +// Каждая структура (случай непустого массива) - Структура - имеет свойства: +// * НомерКорректировки - Число - номер корректировки из отчета "Персонифицированные сведения о физических лицах"; +// * ПерсональныеДанныеИВыплаты - ДеревоЗначений - персональные данные физических лиц и сведения о суммах выплат +// и иных вознаграждений в их пользу из из отчета "Персонифицированные сведения о +// физических лицах". +// +Функция ПерсональныеДанныеИВыплатыИзПерсонифицированныхСведенийОФизическихЛицах(СтруктураПараметров) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПерсональныеДанныеИВыплатыИзПерсонифицированныхСведенийОФизическихЛицах(СтруктураПараметров) +``` +
+ +## РассчитатьПоказателиРеглОтчета +
+ +Описание, пример вызова + +```bsl + +// Рассчитывает значения показателей экземпляра раздела регламентированного отчета. +// Для работы требуется наличие одноименной экспортной процедуры в модуле объекта +// регламентированного отчета, для которой предусмотрена аналогичная параметризация. +// +// Параметры: +// ПараметрыРасчета - Cтруктура со свойствами: +// * ИмяОтчета - Строка - имя регламентированного отчета (обязательное); +// * ИмяФормы - Строка - имя формы регламентированного отчета (обязательное); +// * ИмяРаздела - Строка - имя раздела регламентированного отчета (обязательное); +// * Разрядность - Число - число знаков дробной части, до которых округлять (0 - до целого, 1 - до десятых, т.д.), +// значение по умолчанию 0. +// * Класс - Число - соответствует формату отображаемого значения (1 - в единицах, 1000 - в тысячах, +// 1000000 - в миллионах, т.д.), значение по умолчанию 1. +// Данные - Структура - немногострочные данные раздела регламентированного отчета: ключ - имя показателя, +// значение - значение показателя. +// +// Пример параметризации: +// ПараметрыРасчета = Новый Структура; +// ПараметрыРасчета.Вставить("ИмяОтчета", "РегламентированныйОтчетЗемельныйНалог"); +// ПараметрыРасчета.Вставить("ИмяФормы", "ФормаОтчета2018Кв1"); +// ПараметрыРасчета.Вставить("ИмяРаздела", "Раздел2"); +// +Процедура РассчитатьПоказателиРеглОтчета(ПараметрыРасчета, Данные) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РассчитатьПоказателиРеглОтчета(ПараметрыРасчета, Данные) +``` +
+ +## ПерсонифицированныеСведенияОЗастрахованныхЛицахДляПечати +
+ +Описание, пример вызова + +```bsl + +// Машиночитаемые бланки персонифицированных сведений о застрахованных лицах, сформированные алгоритмами печати +// отчета "Расчет по страховым взносам". +// +// Параметры: +// СтруктураПараметров - Структура - свойства: +// * Организация (обязательное) - СправочникСсылка.Организации - организация (см. в форме "Расчет по страховым +// взносам"); +// * МассивФизическихЛиц (обязательное) - Массив - произвольные идентификаторы, используемые для отбора сведений, +// а также устанавливаемые в качестве Ключей в возвращаемое Соответствие (в случае отсутствия +// указанных идентификаторов, в качестве Ключей в возвращаемое Соответствие устанавливаются +// сгенерированные значения уникальных идентификаторов); +// * ДатаПодписи (обязательное) - Дата - дата подписи (см. в форме "Расчет по страховым взносам"); +// * ДатаКонцаПериодаОтчета (обязательное) - Дата - дата конца квартала, определяющая расчетный (отчетный) период +// (см. в форме "Расчет по страховым взносам"); +// * ДатаНачалаПериодаОтчета (необязательное) - Дата - дата начала расчетного (отчетного) периода (см. в форме +// "Расчет по страховым взносам"; если отсутствует, будет установлена дата начала календарного года, +// получанная из ДатаКонцаПериодаОтчета). +// +// Возвращаемое значение: +// Соответствие или Неопределено. Ключи Соответствия идентифицируют физических лиц, а сопоставляемые с ними Значения - +// Массивы Табличных документов (бланков). Неопределено будет возвращено, если отсутствует возможность сформировать +// бланки при заданных параметрах. +// +Функция ПерсонифицированныеСведенияОЗастрахованныхЛицахДляПечати(ПараметрыПечати) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПерсонифицированныеСведенияОЗастрахованныхЛицахДляПечати(ПараметрыПечати) +``` +
+ +## РазделБРО +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции автозаполнения по данным ИБ конфигурации - потребителя БРО. + +// Процедура получает из коллекции раздел отчета и проверяет, что он может быть заполнен в этом модуле +// +// Параметры: +// Контейнер - Структура - данные регл. отчета. +// ИмяРазделаБРО - Строка - имя раздела регл. отчета. +// +// Возвращаемое значение: +// ТаблицаЗначений - разделы отчета. +// +Функция РазделБРО(Контейнер, ИмяРазделаБРО) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.РазделБРО(Контейнер, ИмяРазделаБРО) +``` +
+ +## ДобавитьСтраницуБРО +
+ +Описание, пример вызова + +```bsl + +// Добавляет новую страницу. +// +Процедура ДобавитьСтраницуБРО(РазделБРО) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ДобавитьСтраницуБРО(РазделБРО) +``` +
+ +## РаспаковатьПоказателиБРО +
+ +Описание, пример вызова + +```bsl + +// Распаковывает показатели. +// +Функция РаспаковатьПоказателиБРО(СтраницаБРО) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.РаспаковатьПоказателиБРО(СтраницаБРО) +``` +
+ +## ПоместитьЗначениеПоказателяНаСтраницуБРО +
+ +Описание, пример вызова + +```bsl + +// Помещает значение показателя на страницу. +// +Процедура ПоместитьЗначениеПоказателяНаСтраницуБРО(СтраницаБРО, НомерЯчейкиБРО, Значение) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ПоместитьЗначениеПоказателяНаСтраницуБРО(СтраницаБРО, НомерЯчейкиБРО, Значение) +``` +
+ +## ВидКонтролирующегоОргана +
+ +Описание, пример вызова + +```bsl + +// Определяет вид государственного органа, в который сдается отчет переданного вида. +// +// Параметры: +// ИмяОтчета - Строка - название регламентированного отчета, см. ИмяРеглОтчета(). +// +// Возвращаемое значение: +// ПеречислениеСсылка.ТипыКонтролирующихОрганов - вид государственного органа. +// +Функция ВидКонтролирующегоОргана(ИмяОтчета) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ВидКонтролирующегоОргана(ИмяОтчета) +``` +
+ +## РеглОтчетыИсполнителиТребований +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции интерфейса взаимодействия с сервисом "Список задач +// бухгалтера". + +// Описывает перечень требований, которые могут быть исполнены объектами БРО. +// +// Возвращаемое значение: +// Соответствие - +// Ключ - Строка, имя требования (может содержать точку - ".") +// Значение - Строка, имя регл. отчета +Функция РеглОтчетыИсполнителиТребований() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.РеглОтчетыИсполнителиТребований() +``` +
+ +## РеглОтчетыИсполнителиЗадачБухгалтера +
+ +Описание, пример вызова + +```bsl + +// Описывает перечень задач бухгалтера (налогов, отчетов), которые могут быть исполнены объектами БРО. +// +// Возвращаемое значение: +// Соответствие - +// Ключ - Строка, имя задачи (не содержит точку - ".") +// Значение - Массив строк - имен регл. отчетов +Функция РеглОтчетыИсполнителиЗадачБухгалтера() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.РеглОтчетыИсполнителиЗадачБухгалтера() +``` +
+ +## ТребованиеОбрабатывается +
+ +Описание, пример вызова + +```bsl + +// Определяет, обрабатывает ли БРО указанное требование. +// +// Параметры: +// Требование - Строка - имя требования (может содержать точку - "."). +// +// Возвращаемое значение: +// Булево - признак обработки БРО указанных требований. +// +Функция ТребованиеОбрабатывается(Требование) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ТребованиеОбрабатывается(Требование) +``` +
+ +## ОписаниеФормыРеглОтчета +
+ +Описание, пример вызова + +```bsl + +// Описывает форму нового или существующего регл. отчета, который позволяет выполнить требование +// +// Параметры: +// Требование - Строка - имя требования (может содержать точку - "."). +// Организация - СправочникСсылка.Организации - ссылка на элемент справочника "Организации". +// РегистрацияВНалоговомОргане - СправочникСсылка.РегистрацииВНалоговомОргане - ссылка на элемент справочника "РегистрацииВНалоговомОргане". +// НачалоПериода - Дата - дата начала периода. +// КонецПериода - Дата - дата окончания периода. +// Периодичность - ПеречислениеСсылка.Периодичность - периодичность. +// +// Возвращаемое значение: +// Структура - содержит ключи: +// * Имя - Строка - имя формы; +// * Параметры - Структура - параметры формы. +// +Функция ОписаниеФормыРеглОтчета(Требование, Организация, РегистрацияВНалоговомОргане, Знач НачалоПериода, Знач КонецПериода, Знач Периодичность) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ОписаниеФормыРеглОтчета(Требование, Организация, РегистрацияВНалоговомОргане, НачалоПериода, КонецПериода, Периодичность) +``` +
+ +## ДанныеРеглОтчетаДляУплатыНалога +
+ +Описание, пример вызова + +```bsl + +// Получает данные, сохраненные в регл. отчете - о суммах, которые следует уплатить по декларации. +// +// Параметры: +// Требование - Строка - имя требования (может содержать точку - "."). +// Организация - СправочникСсылка.Организации - ссылка на организацию. +// РегистрацияВНалоговомОргане - СправочникСсылка.РегистрацииВНалоговомОргане - ссылка на элемент справочника "РегистрацииВНалоговомОргане". +// ПериодДекларации - Дата - дата окончания периода (без времени). +// ДополнительныеПараметры - Структура - дополнительные параметры, если необходимо уточнение получения данных (необязательный параметр), +// при этом функция "ДанныеРеглОтчета" соответствующего регламентированного отчета должна поддерживать работу с этим параметром +// (пример см. в модуле менеджера отчета "РегламентированныйОтчетНДС"). +// Также нужно для поиска декларации по налогу на прибыль, см. АктуальныйОтчет. +// +// Возвращаемое значение: +// Неопределено, +// ТаблицаЗначений - описанная в НовыйТаблицаДанныхРеглОтчета(). +// +Функция ДанныеРеглОтчетаДляУплатыНалога(Требование, Организация, РегистрацияВНалоговомОргане, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ДанныеРеглОтчетаДляУплатыНалога(Требование, Организация, РегистрацияВНалоговомОргане, ); +``` +
+ +## АктуальныйОтчет +
+ +Описание, пример вызова + +```bsl + +// Возвращает последний отчет за налоговый период +// +// Параметры: +// ИсточникОтчета - Строка - наименование регламентированного отчета (совпадает с именем объекта метаданных) +// Организация - СправочникСсылка.Организации +// ПериодДекларации - Дата - правая граница отчетного периода +// РегистрацияВНалоговомОргане - СправочникСсылка.РегистрацииВНалоговомОргане +// ФормаОтчета - Строка +// ДополнительныеПараметры - Структура +// +// Возвращаемое значение: +// РегламентированныйОтчетСсылка +// +Функция АктуальныйОтчет(ИсточникОтчета, Организация, ПериодДекларации, РегистрацияВНалоговомОргане = Неопределено, ФормаОтчета = "", ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.АктуальныйОтчет(ИсточникОтчета, Организация, ПериодДекларации, РегистрацияВНалоговомОргане, ФормаОтчета, ДополнительныеПараметры); +``` +
+ +## ДанныеУведомленияДляУплатыНалога +
+ +Описание, пример вызова + +```bsl + +// Получает данные, сохраненные в уведомлении/уведомлениях - о суммах, которые следует уплатить по декларации. +// +// Параметры: +// Требование - Строка - имя требования (может содержать точку - "."). +// Организация - СправочникСсылка.Организации - ссылка на элемент справочника организаций. +// Конец - Дата - дата окончания периода (без времени). +// +// Возвращаемое значение: +// Неопределено, +// ТаблицаЗначений - описанная в НовыйТаблицаДанныхРеглОтчета(). +// +Функция ДанныеУведомленияДляУплатыНалога(Требование, Организация, Конец) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ДанныеУведомленияДляУплатыНалога(Требование, Организация, Конец) +``` +
+ +## ПлательщикТорговогоСбора +
+ +Описание, пример вызова + +```bsl + +// Информирует о необходимости платить торговый сбор в указанном периоде (по наличию/отсутствию уведомлений по форме ТС-1/ТС-2). +// +// Параметры: +// Организация - СправочникСсылка.Организации - ссылка на элемент справочника организаций. +// НачалоПериода - Дата - дата начала периода (без времени). +// КонецПериода - Дата - дата окончания периода (без времени). +// +// Возвращаемое значение: +// Булево - Истина - организация должно платить торговый сбор в периоде (есть соответствующие уведомления), +// Ложь - иначе. +// +Функция ПлательщикТорговогоСбора(НачалоПериода, КонецПериода, Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПлательщикТорговогоСбора(НачалоПериода, КонецПериода, Организация) +``` +
+ +## НовыйТаблицаДанныхРеглОтчета +
+ +Описание, пример вызова + +```bsl + +// Описывает структуру таблицы значений с данными регл. отчета +// +// Возвращаемое значение: +// ТаблицаЗначений - данные регл. отчета. +// +Функция НовыйТаблицаДанныхРеглОтчета() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.НовыйТаблицаДанныхРеглОтчета() +``` +
+ +## ПредставлениеФормыРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +// Предоставляет пользовательское представление формы регл. отчета. +// +// Параметры: +// Требование - Строка - имя требования (может содержать точку - "."). +// ПериодОтчета - Дата - дата окончания периода (без времени). +// +// Возвращаемое значение: +// Строка - представление формы регламентированного отчета. +// +Функция ПредставлениеФормыРегламентированногоОтчета(Требование, ПериодОтчета) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПредставлениеФормыРегламентированногоОтчета(Требование, ПериодОтчета) +``` +
+ +## РеглОтчетыСверхТребований +
+ +Описание, пример вызова + +```bsl + +// Определяет список регл. отчетов, которые не предназначены для выполнения каких-либо формализованных требований. +// Служит для проверки, что в календаре бухгалтера внесены все требования, которые может исполнять программа. +// +// Возвращаемое значение: +// Массив - массив строк. +// +Функция РеглОтчетыСверхТребований() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.РеглОтчетыСверхТребований() +``` +
+ +## ИмяРеглОтчета +
+ +Описание, пример вызова + +```bsl + +// Определяет имя регл. отчета, который позволяет исполнить требование. +// +// Параметры: +// Требование - Строка - имя требования (может содержать точку - "."). +// ИсполнителиТребований - Соответствие - возвращаемое РеглОтчетыИсполнителиТребований(). +// Следует передавать, если функция используется многократно (в цикле). +// +// Возвращаемое значение: +// Строка - имя регламентированного отчета. +// +Функция ИмяРеглОтчета(Знач Требование, ИсполнителиТребований = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ИмяРеглОтчета(Требование, ИсполнителиТребований); +``` +
+ +## РеглОтчетыКоторыеНельзяСкрыватьНастройкамиКонфигурации +
+ +Описание, пример вызова + +```bsl + +// Описывает регл. отчеты, экземпляры которых присутствуют в информационной базе. +// Такие отчеты должны быть видны в списке экземпляров отчетов, несмотря на настройки конфигурации. +// +// Параметры: +// Организации - СправочникСсылка.Организации - ссылка на организацию. +// РеглОтчеты - Массив - массив строк имен регл. отчетов, среди которых надо найти те, которые нельзя скрывать. +// +// Возвращаемое значение: +// Массив строк - имена объектов метаданных "Отчет". +// +Функция РеглОтчетыКоторыеНельзяСкрыватьНастройкамиКонфигурации(Организации, РеглОтчеты = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.РеглОтчетыКоторыеНельзяСкрыватьНастройкамиКонфигурации(Организации, РеглОтчеты); +``` +
+ +## ИмяНалогаОтчета +
+ +Описание, пример вызова + +```bsl + +// Определяет имя задачи бухгалтера (налога, отчета) по имени требования. +// Имя требования начинается с имени задач. Имя задачи отделено точкой - "." +// +// Параметры: +// Требование - Строка - имя требования (содержит точку - "."). +// +// Возвращаемое значение: +// Строка - имя задачи (не содержит точку - "."). +// +Функция ИмяНалогаОтчета(Требование) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ИмяНалогаОтчета(Требование) +``` +
+ +## ЗаполнитьСсылкиНаРеглОтчеты +
+ +Описание, пример вызова + +```bsl + +// Процедура получает ссылки на сохраненные регламентированные отчеты заданного вида. +// В переданную таблицу ПараметрыРеглОтчетов добавляется колонка Документы с колонками: +// * Ссылка - ДокументСсылка.РегламетированныйОтчет - Ссылка на отчет. +// * Дата - Дата - Дата подписи регламентированного отчета. +// * Статус - Строка - Описание статуса сдачи отчета. +// * СостояниеСдачиОтчетности - ПеречислениеСсылка.СостояниеСдачиОтчетности - Статус отправки через 1С-Отчетность. +// * НаименованиеОтчета - Строка - Пользовательское представление отчета. +// * ФинансовыйПериод - Строка - Пользовательское представление периода отчета. +// * ВариантОтчета - Строка - Описание варианта отчета (П - первичный, К/N - корректировочный). +// * ПредставлениеКонтролирующегоОргана - Строка - Название контролирующего органа, в который предоставляется отчет. +// * Комментарий - Строка - Пользовательский комментарий к отчету. +// +// Ссылки на регл. отчеты отсортированы в хронологическом порядке по убыванию. +// +// Параметры: +// * ПараметрыРеглОтчетов - ТаблицаЗначений - Определяет параметры отбора отчетов: +// ** ИсточникОтчета - Строка - Наименование регламентированного отчета (совпадает с именем объекта метаданных). +// ** Организация - СправочникСсылка.Организации - Организация отчета. +// ** ДатаОкончания - Дата (без времени) - Дата окончания отчетного периода (правая граница отчетного периода). +// ** РегистрацияВНалоговомОргане - СправочникСсылка.РегистрацииВНалоговомОргане - Налоговый орган. +// ** Правило - СправочникСсылка.ПравилаПредставленияОтчетовУплатыНалогов - Может не заполняться, но должна присутствовать в таблице. +// * ОтборПоВыбраннойФормеРеглОтчета - Булево - Признак, нужно ли, чтобы отчет был по форме, действующей в отчетном периоде. +// +Процедура ЗаполнитьСсылкиНаРеглОтчеты(ПараметрыРеглОтчетов, ОтборПоВыбраннойФормеРеглОтчета = Ложь) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСсылкиНаРеглОтчеты(ПараметрыРеглОтчетов, ОтборПоВыбраннойФормеРеглОтчета); +``` +
+ +## ПредставлениеСостоянияДокумента +
+ +Описание, пример вызова + +```bsl + +// Определяет пользовательское представление состояния передачи в учреждение отчета или иного документа +// - при передаче в электронном виде - состояние отправки; +// - при передаче иным способом - статус, установленный пользователем. +// +// Параметры: +// Документ - ДокументСсылка, СправочникСсылка - отправляемый документ (отчет или уведомление). +// +// Возвращаемое значение: +// Строка - представление состояния передачи в учреждение. +// +Функция ПредставлениеСостоянияДокумента(Документ) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПредставлениеСостоянияДокумента(Документ) +``` +
+ +## СостояниеДокумента +
+ +Описание, пример вызова + +```bsl + +// Определяет сведения о состоянии передачи в учреждение отчета или иного документа +// - при передаче в электронном виде - состояние отправки; +// - при передаче иным способом - статус, установленный пользователем. +// +// Параметры: +// Документ - ДокументСсылка, СправочникСсылка - отправляемый документ (отчет или уведомление). +// КонтролирующийОрган - Строка +// +// Возвращаемое значение: +// Структура +// * Представление - Строка - представление состояния передачи в учреждение. +// * Сдано - Булево - Истина, если отчет сдан любым способом. +// * Отправлено - Булево - Истина, если отчет отправлен в учреждение в электронном виде. +// +Функция СостояниеДокумента(Документ, КонтролирующийОрган = "ФНС") Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СостояниеДокумента(Документ, КонтролирующийОрган); +``` +
+ +## СохранитьСтатусОтправкиУведомления +
+ +Описание, пример вызова + +```bsl + +// Записывает в регистр сведений "Журнал отправок в контролирующие органы" значение статуса отправки, +// установленного вручную для объекта регламентированной отчетности, отображаемого на закладке "Уведомления" +// формы "1С-Отчетность". +// +// Параметры: +// Документ - ДокументСсылка, СправочникСсылка - ссылка на объект регламентированной отчетности. +// Статус - Строка - сохраняемый статус. +// +Процедура СохранитьСтатусОтправкиУведомления(Документ, Статус) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьСтатусОтправкиУведомления(Документ, Статус) +``` +
+ +## СвойстваОтчета +
+ +Описание, пример вызова + +```bsl + +// Определяет основные сведения о регламентированном отчете или уведомлении. +// +// Параметры: +// Документ - ДокументСсылка - ссылка на регл. отчет. +// +// Возвращаемое значение: +// Структура - структура +// из ЭлектронныйДокументооборотСКонтролирующимиОрганамиВызовСервера.ПараметрыОтображенияВЖурналеОтчетов() +// дополненная ключом "ИсточникОтчета" - имя отчета или полное имя объекта метаданных +// (для отчетов не обрабатываемых БРО). +// +Функция СвойстваОтчета(Документ) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СвойстваОтчета(Документ) +``` +
+ +## ДопускаетсяРучнойСтатус +
+ +Описание, пример вызова + +```bsl + +Функция ДопускаетсяРучнойСтатус(Ссылка, Статус, СостояниеСдачиОтчетности) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ДопускаетсяРучнойСтатус(Ссылка, Статус, СостояниеСдачиОтчетности) +``` +
+ +## ПараметрыОткрытияФормыРеглОтчета +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру с параметрами по умолчанию для открытия формы регламентированного отчета. +// +// Параметры: +// ИмяРеглОтчета - Строка - Имя регламентированного отчета (совпадает с именем объекта метаданных). +// Организация - СправочникСсылка.Организации - Организации, по которой формируется отчет. +// РегистрацияВНалоговомОргане - СправочникСсылка.РегистрацииВНалоговомОргане - Регистрация в налоговом органе. Может быть не заполнена. +// НачалоПериода - Дата - Дата начала периода. +// КонецПериода - Дата - Дата окончания периода. +// Периодичность - ПеречислениеСсылка.Периодичность - Периодичность предоставления отчета. +// +// Возвращаемое значение: +// Структура или Неопределено - Параметры открытия формы или Неопределено, если отчет не доступен. +// +Функция ПараметрыОткрытияФормыРеглОтчета(ИмяРеглОтчета, Организация, РегистрацияВНалоговомОргане, НачалоПериода, КонецПериода, Периодичность) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПараметрыОткрытияФормыРеглОтчета(ИмяРеглОтчета, Организация, РегистрацияВНалоговомОргане, НачалоПериода, КонецПериода, Периодичность) +``` +
+ +## ВыгрузитьРегламентированныйОтчет +
+ +Описание, пример вызова + +```bsl + +// Выгружает сохраненный регламентированный отчет без открытия формы в соответствии с форматом выгрузки. +// Выгрузка без открытия формы возможна только при условии, что данный отчет ее поддерживает. +// +// Параметры: +// СохраненныйОтчет - ДокументСсылка.РегламентированныйОтчет - ссылка на сохраненный регл. отчет. +// ДополнительныеПараметрыВыгрузки - Структура - необязательный параметр, используемый для передачи +// дополнительных параметров выгрузки регламентированного отчета: +// * РеглОтчетВыгружаетсяВБанк - Булево - признак выгрузки регламентированного отчета в кредитную организацию. +// Истина - регламентированный отчет выгружается в кредитную организацию. +// Ложь - регламентированный отчет выгружается в гос. орган. +// Используется при выгрузке следующих отчетов: +// - "РегламентированныйОтчетБухОтчетность", +// - "РегламентированныйОтчетБухОтчетностьМП". +// * КешСхемВыгрузки - Структура - для оптимизации кешированием. +// * Отбор - Структура - ключ = имя поля отбора; значение = значение отбора. +// +// Возвращаемое значение: +// Структура - результат выгрузки (см. РегламентированнаяОтчетность.НовыйРезультатВыгрузкиРеглОтчета()). +// +Функция ВыгрузитьРегламентированныйОтчет(СохраненныйОтчет, ДополнительныеПараметрыВыгрузки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ВыгрузитьРегламентированныйОтчет(СохраненныйОтчет, ДополнительныеПараметрыВыгрузки); +``` +
+ +## ВыгрузитьПакетПоСдачеОтчетностиВФНС +
+ +Описание, пример вызова + +```bsl + +// Для переданного регламентированного отчета получает файлы документооборота с ФНС, в котором участвовал этот отчет. +// +// Параметры: +// РегламентированныйОтчет - ДокументСсылка.РегламентированныйОтчет - отчет, по которому происходило электронное взаимодействие с ФНС. +// +// Возвращаемое значение: +// Структура - описание архива с файлами отчета, квитанций и ЭЦП: +// * ИмяФайла - имя архива с файлами; +// * Адрес - адрес временного хранилища, куда был помещен файл архива; +// * Всего - количество файлов в архиве; +// * ОписаниеОшибки - если заполнено, то содержит текст ошибки, из-за которой не удалось сформировать архив. +// ВключитьДополнительныеСведения - Булево - Если Истина, то в выгрузку добавляются PDF-файлы квитанций и извещение о вводе +// +Функция ВыгрузитьПакетПоСдачеОтчетностиВФНС(РегламентированныйОтчет, ВключитьДополнительныеСведения = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ВыгрузитьПакетПоСдачеОтчетностиВФНС(РегламентированныйОтчет, ВключитьДополнительныеСведения); +``` +
+ +## ПечатныйБланкРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +// Формирует печатный бланк без штрихкода PDF417 сохраненного регламентированного отчета без открытия формы. +// +// Параметры: +// СохраненныйОтчет - ДокументСсылка.РегламентированныйОтчет - ссылка на сохраненный регламентированный отчет. +// ДополнительныеПараметрыПечати - Структура - необязательный параметр, используемый для передачи +// дополнительных параметров печати регламентированного отчета: +// * ПечататьЭкраннуюФормуРазделов8_12 - Булево - признак печати разделов 8-12 декларации по НДС в виде экранной формы. +// Истина - разделы 8-12 декларации по НДС выводятся на печать в виде экранной формы. +// Ложь - разделы 8-12 декларации по НДС выводятся на печать в виде утвержденного печатного бланка. +// Используется при печати следующих отчетов: +// - "РегламентированныйОтчетНДС". +// +// Возвращаемое значение: +// Структура - содержит ключи: +// * АдресПечатногоБланка - Строка - адрес во временном хранилище, в котором располагается в формате +// PDF сформированный печатный бланк без штрихкода PDF417; +// * ИмяФайлаПечатногоБланка - Строка - имя файла сформированного печатного бланка для сохранения. +// Если печатный бланк не сформирован, вместо структуры возвращается пустая строка. +// +Функция ПечатныйБланкРегламентированногоОтчета(СохраненныйОтчет, ДополнительныеПараметрыПечати = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПечатныйБланкРегламентированногоОтчета(СохраненныйОтчет, ДополнительныеПараметрыПечати); +``` +
+ +## ВыгрузитьДанныеАлгоритмамиРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +// Выгружает внешние данные алгоритмами выгрузки регламентированного отчета, +// в соответствии с форматом выгрузки, без сохранения регламентированного отчета. +// Такая выгрузка возможна только при условии, что данный отчет ее поддерживает. +// +// Параметры: +// Контейнер - Структура - см. СтруктураКонтейнераДанных(Параметры). +// ДополнительныеПараметры - Структура - необязательный параметр, используемый +// для передачи дополнительных параметров. +// +// Возвращаемое значение: +// Структура - результат выгрузки (см. РегламентированнаяОтчетность.НовыйРезультатВыгрузкиРеглОтчета()). +// +// Пример реализации: +// Парам = Новый Структура; +// Парам.Вставить("ИсточникОтчета", "РегламентированныйОтчетПрослеживаемыеТоварыОстатки"); +// Парам.Вставить("ВыбраннаяФорма", "ФормаОтчета2021Кв3"); +// Парам.Вставить("ВерсияФормата", "5.01"); +// Парам.Вставить("СсылкаНаВнешнийОбъект", СсылкаНаДокумент); +// Контейнер = ИнтерфейсыВзаимодействияБРО.СтруктураКонтейнераДанных(Парам); +// Результат = ИнтерфейсыВзаимодействияБРО.ВыгрузитьДанныеАлгоритмамиРегламентированногоОтчета(Контейнер); +// +Функция ВыгрузитьДанныеАлгоритмамиРегламентированногоОтчета(Контейнер, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ВыгрузитьДанныеАлгоритмамиРегламентированногоОтчета(Контейнер, ДополнительныеПараметры); +``` +
+ +## ПечатныйБланкСформированныйАлгоритмамиРегламентированныхОтчетов +
+ +Описание, пример вызова + +```bsl + +// Формирует печатный бланк без штрихкода PDF417 по внешним данным алгоритмами печати регламентированного отчета, без +// сохранения регламентированного отчета. Такая печать возможна только при условии, что данный отчет ее поддерживает. +// +// Параметры: +// Контейнер - Структура - см. СтруктураКонтейнераДанных(Параметры). +// +// Возвращаемое значение: +// Массив - адреса во временном хранилище, в котором располагаются табличные документы - страницы сформированного +// печатного бланка без штрихкода PDF417. +// Если печатный бланк не сформирован, вместо массива возвращается пустая строка. +// +// Пример реализации: +// Парам = Новый Структура; +// Парам.Вставить("ИсточникОтчета", "РегламентированныйОтчетПрослеживаемыеТоварыОстатки"); +// Парам.Вставить("ВыбраннаяФорма", "ФормаОтчета2021Кв3"); +// Парам.Вставить("ВерсияФормата", "5.01"); +// Парам.Вставить("СсылкаНаВнешнийОбъект", СсылкаНаДокумент); +// Контейнер = ИнтерфейсыВзаимодействияБРО.СтруктураКонтейнераДанных(Парам); +// Результат = ИнтерфейсыВзаимодействияБРО.ПечатныйБланкСформированныйАлгоритмамиРегламентированныхОтчетов(Контейнер); +// +Функция ПечатныйБланкСформированныйАлгоритмамиРегламентированныхОтчетов(Контейнер) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПечатныйБланкСформированныйАлгоритмамиРегламентированныхОтчетов(Контейнер) +``` +
+ +## СтруктураКонтейнераДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает контейнер для наполнения внешними данными и последующей передачи в алгоритмы +// выгрузки или печати регламентированного отчета, без сохранения регламентированного отчета. +// Получение такого контейнера возможно только при условии, что данный отчет поддерживает +// выгрузку или печать регламентированного отчета, без сохранения регламентированного отчета. +// +// Параметры: +// Параметры - Структура - данные, необходимые для получения контейнера: +// * ИсточникОтчета - Строка - имя объекта регламентированного отчета. +// * ВыбраннаяФорма - Строка - имя формы объекта регламентированного отчета. +// * ВерсияФормата - Строка - версия формата выгрузки. +// * СсылкаНаВнешнийОбъект - Любая ссылка - ссылка на объект данных (например, ссылка на документ, +// для которого выполняется получение контейнера). +// +// Возвращаемое значение: +// Структура - контейнер для наполнения внешними данными. +// +// Пример реализации: +// Парам = Новый Структура; +// Парам.Вставить("ИсточникОтчета", "РегламентированныйОтчетПрослеживаемыеТоварыОстатки"); +// Парам.Вставить("ВыбраннаяФорма", "ФормаОтчета2021Кв3"); +// Парам.Вставить("ВерсияФормата", "5.01"); +// Парам.Вставить("СсылкаНаВнешнийОбъект", СсылкаНаДокумент); +// Контейнер = ИнтерфейсыВзаимодействияБРО.СтруктураКонтейнераДанных(Парам); +// +Функция СтруктураКонтейнераДанных(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СтруктураКонтейнераДанных(Параметры) +``` +
+ +## СохранитьСтатусОтправки +
+ +Описание, пример вызова + +```bsl + +// Записывает в регистр сведений "Журнал отчетов статусы" значение статуса отправки, +// установленного вручную в экранной форме объекта, отображаемого на закладке "Отчеты" +// формы "1С-Отчетность". +// +// Параметры: +// СтруктураПараметров - Cтруктура со свойствами: +// * СсылкаНаОбъект - ДокументСсылка, СправочникСсылка - ссылка на объект, отображаемый +// на закладке "Отчеты" формы "1С-Отчетность"; +// * Форма - ФормаКлиентскогоПриложения - экранная форма объекта, отображаемого на закладке "Отчеты" +// формы "1С-Отчетность". +// * Статус - Строка +// +Процедура СохранитьСтатусОтправки(СтруктураПараметров) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьСтатусОтправки(СтруктураПараметров) +``` +
+ +## НачалоНалоговогоПериода +
+ +Описание, пример вызова + +```bsl + +// Определяет дату начала налогового периода с учетом даты регистрации организации (требований ст. 55 НК РФ). Налоговый +// период может быть расширен или отсутствовать, если организация зарегистрирована в конце обычного периода (например, +// 30 декабря). Налоговый период может быть сокращен, если организация зарегистрирована не в конце обычного периода +// (например, 10 января). +// +// Параметры: +// Организация - СправочникСсылка.Организации - организация, для которой определяется +// дата начала налогового периода; +// Период - Дата - дата в периоде, начало которого определяется; +// ВариантРасширенногоПервогоПериода - ПеречислениеСсылка.ВариантыРасширенногоПервогоНалоговогоПериода - +// проверяемый вариант требований закона; +// СтандартнаяДлительностьНалоговогоПериода - ПеречислениеСсылка.Периодичность - длительность налогового периода; +// СокращатьНалоговыйПериод - Булево - Ложь, если для совместимости важно, чтобы дата регистрации +// возвращалась только для расширенного периода (не сокращенного), +// при этом ст. 55 будет выполнена в неполном объеме); +// Истина, если требуется выполнение ст. 55 в части сокращения +// периода. +// ДатаРегистрации - Дата - дата регистрации организации; +// если не передана, определяется из свойств организации. +// ДатаПостановкиНаУчет - Дата - дата постановки на учет в качестве налогоплательщика; +// +// Возвращаемое значение (варианты): +// Дата - дата начала налогового периода; +// Неопределено - в этом периоде обязанностей налогоплательщика у организации нет. +// +Функция НачалоНалоговогоПериода(Организация, Период, ВариантРасширенногоПервогоПериода, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.НачалоНалоговогоПериода(Организация, Период, ВариантРасширенногоПервогоПериода, ); +``` +
+ +## БлижайшийНалоговыйПериод +
+ +Описание, пример вызова + +```bsl + +// Определяет границы ближайшего налогового периода с учетом даты регистрации (постановки на учет в качестве налогоплательщика). +// +// Параметры: +// Организация - СправочникСсылка.Организации - организация, для которой определяются +// границы ближайшего налогового периода; +// Период - Дата - дата в периоде, границы которого определяются; +// ВариантРасширенногоПервогоПериода - ПеречислениеСсылка.ВариантыРасширенногоПервогоНалоговогоПериода - +// проверяемый вариант требований закона; +// СтандартнаяДлительностьНалоговогоПериода - ПеречислениеСсылка.Периодичность - длительность налогового периода. +// ДатаРегистрации - Дата - дата регистрации организации; +// если не передана, определяется из свойств организации. +// ДатаПостановкиНаУчет - Дата - дата постановки на учет в качестве налогоплательщика; +// +// Возвращаемое значение: +// Структура - границы периода +// * Период - Дата - стандартное начало налогового периода (например, 01 июля для третьего квартала); +// * Начало - Дата - фактическое начало налогового периода (может совпадать со стандартным началом или +// датой регистрации организации; +// * Конец - Дата - дата с указанием времени. +// +Функция БлижайшийНалоговыйПериод(Организация, Знач ПроверяемыйПериод, ВариантРасширенногоПервогоПериода, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.БлижайшийНалоговыйПериод(Организация, ПроверяемыйПериод, ВариантРасширенногоПервогоПериода, ); +``` +
+ +## СтандартнаяДлительностьНалоговогоПериода +
+ +Описание, пример вызова + +```bsl + +// Определяет стандартную длительность налогового периода по переданному варианту периода регистрации организации. +// +// Параметры: +// ВариантРасширенногоПервогоПериода - ПеречислениеСсылка.ВариантыРасширенногоПервогоНалоговогоПериода - вариант +// требований закона. +// +// Возвращаемое значение: +// ПеречислениеСсылка.Периодичность - длительность периода; пустая ссылка, если установить не удалось. +// +Функция СтандартнаяДлительностьНалоговогоПериода(Вариант) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СтандартнаяДлительностьНалоговогоПериода(Вариант) +``` +
+ +## ПропущенныйНалоговыйПериод +
+ +Описание, пример вызова + +```bsl + +// Определяет налоговый период, относящийся к дате регистрации (постановки на учет), пропускаемый для целей уплаты налогов +// (представления отчетов). Требования установлены ст. 55 НК РФ и п. 3 ст. 15 закона "О бухгалтерском учете". +// +// Например, если организация зарегистрирована в конце года, то некоторую отчетность за этот год она не представляет +// (и некоторые налоги не платит), а показатели деятельности за период с даты регистрации до конца следующего года +// включает в отчетность за следующий год. Таким образом, первый налоговый период у организации может быть длинее, +// чем последующие (т.е., может быть "расширенным"). +// +// Другими словами, если дата регистрации попадает в определенные периоды, то не требуется представлять отчетность +// и/или уплачивать налоги за эти периоды. +// +// Законом определены несколько вариантов периодов, в зависимости от даты регистрации организации. +// +// Параметры: +// Вариант - ПеречислениеСсылка.ВариантыРасширенногоПервогоНалоговогоПериода - вариант требований закона; +// Организация - СправочникСсылка.Организации - организация, для которой определяется пропущенный период; +// ДатаРегистрации - Дата - дата регистрации организации; если не передана, определяется из свойств организации; +// ДатаПостановкиНаУчет - Дата - дата постановки на учет в качестве налогоплательщика; +// +// Возвращаемое значение (варианты): +// Дата - дата начала пропущенного периода; +// Неопределено - нет оснований для пропуска периода. +// +Функция ПропущенныйНалоговыйПериод(Вариант, Организация, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПропущенныйНалоговыйПериод(Вариант, Организация, ); +``` +
+ +## НалоговыйПериодПропущен +
+ +Описание, пример вызова + +```bsl + +// Определяет, что не требуется сдавать отчетность и уплачивать налог за переданный период. +// +// Параметры: +// Организация - СправочникСсылка.Организации - проверяемая организация +// Период - Дата - проверяемый период +// ВариантРасширенногоПервогоПериода - ПеречислениеСсылка.ВариантыРасширенногоПервогоНалоговогоПериода - вариант требований закона; +// ДатаРегистрации - Дата - дата регистрации организации; если не передана, определяется из свойств организации; +// ДатаПостановкиНаУчет - Дата - дата постановки на учет в качестве налогоплательщика; +// +// Возвращаемое значение: +// Булево - Если ИСТИНА, это пропущенный период +// (организация зарегистрирована в декабре переданного года, и для нее актуальны требования п.2 статьи 55 НК РФ). +// +Функция НалоговыйПериодПропущен(Организация, Период, ВариантРасширенногоПервогоПериода, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.НалоговыйПериодПропущен(Организация, Период, ВариантРасширенногоПервогоПериода, ); +``` +
+ +## ПервыйНалоговыйПериодНачинаетсяСДатыПостановкиНаУчет +
+ +Описание, пример вызова + +```bsl + +// Определяет какой период расширяется в соответствии с выбранным вариантом. +// +// Параметры: +// ВариантРасширенногоПервогоПериода - ПеречислениеСсылка.ВариантыРасширенногоПервогоНалоговогоПериода - вариант требований закона; +// +// Возвращаемое значение: +// Истина - расширяемый налоговый период начинается с даты постановки на учет в качестве налогоплательщика; +// Ложь - расширяемый налоговый период начинается с даты регистрации организации. +// +Функция ПервыйНалоговыйПериодНачинаетсяСДатыПостановкиНаУчет(ВариантРасширенногоПервогоПериода) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПервыйНалоговыйПериодНачинаетсяСДатыПостановкиНаУчет(ВариантРасширенногоПервогоПериода) +``` +
+ +## АдресВФорматеФИАС +
+ +Описание, пример вызова + +```bsl + +// См. РегламентированнаяОтчетность.АдресВФорматеФИАС. +Функция АдресВФорматеФИАС(Адрес, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.АдресВФорматеФИАС(Адрес, ДополнительныеПараметры); +``` +
+ +## ПараметрыСпискаРеглОтчетов +
+ +Описание, пример вызова + +```bsl + +// Устарела. Ранее функция использовалась в функционале "Монитор налогов и отчетности". +// Описывает структуру таблицы значений для получения списка регл. отчетов. +// +// Возвращаемое значение: +// ТаблицаЗначений - подготовленная таблица для получения списка регл. отчетов по периодам. +// +Функция ПараметрыСпискаРеглОтчетов() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПараметрыСпискаРеглОтчетов() +``` +
+ +## ПолучитьСписокРеглОтчетовПоПериодам +
+ +Описание, пример вызова + +```bsl + +// Устарела. Ранее процедура использовалась в функционале "Монитор налогов и отчетности". +// Помещает в переданный менеджер временных таблиц сформированные сведения о регламентированной отчетности +// в разрезе запрашиваемых правил и отчетных периодов. +// +// Параметры: +// МенеджерВТ - МенеджерВременныхТаблиц - исх. параметр, в менеджер помещается временная таблица "ВТ_РеглОтчеты" со следующими колонками: +// * Ссылка - ДокументСсылка.РегламентированныйОтчет - ссылка на отчет; +// * ПериодСобытия - Дата - финансовый период, к которому относится отчет; +// * ПолноеИмяПравила - Строка - скомпонованное имя правила, формируемое как идентификатор(код) задачи-владельца правила + "." + идентификатор(код) самого правила; +// * Статус - Строка - состояние отправки отчета в контролирующие органы. +// Организация - СправочникСсылка.Организации - организация, по которой запрашивается отчетность. +// ПараметрыСпискаРеглОтчетов - ТаблицаЗначений - см. функцию ПараметрыСпискаРеглОтчетов(). +// +Процедура ПолучитьСписокРеглОтчетовПоПериодам(МенеджерВТ, Организация, ПараметрыСпискаРеглОтчетов) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ПолучитьСписокРеглОтчетовПоПериодам(МенеджерВТ, Организация, ПараметрыСпискаРеглОтчетов) +``` +
+ +## ЭтоДекларацияПоНалогуНаПрибыльОбособленногоПодразделения +
+ +Описание, пример вызова + +```bsl + +// Устарела. Можно сразу использовать Отчеты[ИмяРеглОтчета].ЭтоДекларацияПоНалогуНаПрибыльОбособленногоПодразделения() +Функция ЭтоДекларацияПоНалогуНаПрибыльОбособленногоПодразделения(СсылкаНаРеглОтчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЭтоДекларацияПоНалогуНаПрибыльОбособленногоПодразделения(СсылкаНаРеглОтчет) +``` +
+ +## УТекущегоПользователяЕстьДоступКЭДО +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие доступа к электронному документообороту. +// +// Возвращаемое значение: +// Булево - Истина, если доступ есть +// +Функция УТекущегоПользователяЕстьДоступКЭДО() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.УТекущегоПользователяЕстьДоступКЭДО() +``` +
+ +## ПолучитьОтветыНаЗапросИОН +
+ +Описание, пример вызова + +```bsl + +// Функция - Получить ответы на запрос ИОН +// +// Параметры: +// Запрос - ДокументСсылка.ЗапросНаИнформационноеОбслуживаниеНалогоплательщика - ссылка на запрос +// +// Возвращаемое значение: +// ТаблицаЗначений или Неопределено. Таблица значений имеет поля: ИмяФайла, Размер, ТипСодержимого, Данные, ВАрхиве. +// Неопределено будет возвращено если у пользователя нет доступа к ЭДО. +// +Функция ПолучитьОтветыНаЗапросИОН(Запрос) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПолучитьОтветыНаЗапросИОН(Запрос) +``` +
+ +## ФайлыРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +// Возвращает файлы регламентированного отчета, сохраненного в информационной базе, для передачи в банк +// +// Параметры: +// СохраненныйОтчет - ДокументСсылка.РегламентированныйОтчет +// БезБланков - Булево +// +// Возвращаемое значение: +// Структура: +// ОписаниеОшибки: +// Строка - Подробное описание ошибки или пустая строка, если ошибок не было. +// ФайлыОтчета: +// Массив - содержит структуры: +// * ВидФайла - Строка - вид файла отчета +// * ИмяФайла - Строка - имя файла +// * СодержимоеФайла - Произвольный - содержимое файла +// +Функция ФайлыРегламентированногоОтчета(СохраненныйОтчет, БезБланков = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ФайлыРегламентированногоОтчета(СохраненныйОтчет, БезБланков); +``` +
+ +## ПараметрыАвтозаполненияРегламентированногоОтчета +
+ +Описание, пример вызова + +```bsl + +// Конструктор параметров автозаполнения регламентированного отчета. +// +// Параметры: +// ИсточникОтчета - Строка - наименование регламентированного отчета (совпадает с именем объекта метаданных). +// ИмяФормыОтчета - Строка - имя формы регламентированного отчета, для которой требуются параметры автозаполнения. +// ДополнительныеПараметры - Структура - необязательный параметр, используемый для передачи дополнительных параметров. +// +// Возвращаемое значение: +// Структура - содержит элементы, необходимые для работы процедур автозаполнения отчета. +// +Функция ПараметрыАвтозаполненияРегламентированногоОтчета(ИсточникОтчета, ИмяФормыОтчета, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПараметрыАвтозаполненияРегламентированногоОтчета(ИсточникОтчета, ИмяФормыОтчета, ); +``` +
+ +## СведенияПоЗарегистрированнымЛицамИзОтчетовЕФС1СЗПГос +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения по зарегистрированным лицам из регламентированных отчетов "ЕФС-1: Сведения о заработной плате +// и условиях осуществления деятельности работников государственных (муниципальных) учреждений". +// +// Параметры: +// СтруктураПараметров - Структура - свойства: +// * Организация - СправочникСсылка.Организации - организация, для которой будет выполняться поиск отчетов +// "ЕФС-1: Сведения о заработной плате и условиях осуществления деятельности работников +// государственных (муниципальных) учреждений"; +// * ДатаОкончания - Дата - дата окончания отчетного периода для поиска отчетов "ЕФС-1: Сведения о заработной +// плате и условиях осуществления деятельности работников государственных (муниципальных) +// учреждений"; +// * ПоискПоИмениФормыОтчета - Булево - признак использования имени формы при поиске отчетов "ЕФС-1: Сведения +// о заработной плате и условиях осуществления деятельности работников государственных +// (муниципальных) учреждений" (необязательное свойство; если отсутствует или если Истина, +// тогда имя формы отчета используется при поиске; если Ложь, тогда имя формы отчета +// не используется при поиске); +// * ИмяФормыОтчета - Строка - имя формы отчета "ЕФС-1: Сведения о заработной плате и условиях осуществления +// деятельности работников государственных (муниципальных) учреждений", например, +// "ФормаОтчета2024Кв1" (необязательное свойство; не используется при +// ПоискПоИмениФормыОтчета = Ложь; если отсутствует, то при ПоискПоИмениФормыОтчета = Истина +// значение будет получено автоматически). +// +// Возвращаемое значение: +// Массив - массив структур с данными отчетов (пустой массив, если отчетов не найдено). +// Каждая структура (случай непустого массива) - Структура - имеет свойства: +// * НомерКорректировки - Число - номер корректировки из отчета "ЕФС-1: Сведения о заработной плате и условиях +// осуществления деятельности работников государственных (муниципальных) учреждений"; +// * СведенияПоЗЛ - ДеревоЗначений - сведения по зарегистрированным лицам из отчета "ЕФС-1: Сведения о заработной +// плате и условиях осуществления деятельности работников государственных (муниципальных) +// учреждений". +// +Функция СведенияПоЗарегистрированнымЛицамИзОтчетовЕФС1СЗПГос(СтруктураПараметров) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СведенияПоЗарегистрированнымЛицамИзОтчетовЕФС1СЗПГос(СтруктураПараметров) +``` +
+ +## ПолучитьДоверенностиОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив ссылок МЧД ФНС +// +// Параметры: +// Отбор - структура: +// * Доверитель - ОпределяемыйТип.Организация - Организация предприятия +// * Сертификат - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования, СертификатКриптографии - +// Сертификат представителя. +// * ПредставительИНН - Строка - ИНН представителя, используется, если Сертификат равен Неопределено. +// +// Возвращаемое значение: +// Массив из СправочникСсылка.МашиночитаемыеДоверенностиФНС, +// СправочникСсылка.МашиночитаемыеДоверенностиРаспределенныйРеестр +// +Функция ПолучитьДоверенностиОрганизации(Отбор) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ПолучитьДоверенностиОрганизации(Отбор) +``` +
+ +## ДанныеДляЗаполненияОтчетаВПомощнике +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные для заполнения регламентированного отчета "Налог на прибыль" в помощнике. +// +// Параметры: +// Организация - СправочникСсылка.Организации - организация +// ДатаКонцаПериода - Дата - дата конца периода отчета +// +// Возвращаемое значение: +// Структура: +// * ОтчетМожноЗаполнитьВПомощнике - Булево - Истина, если отчет можно заполнить в форме помощника +// * ПараметрыПравила - Структура - параметры правила для списка задач бухгалтера +// +Функция ДанныеДляЗаполненияОтчетаВПомощнике(Организация, ДатаКонцаПериода) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ДанныеДляЗаполненияОтчетаВПомощнике(Организация, ДатаКонцаПериода) +``` +
+ +## СформироватьАвтоматическиРеглОтчет6НДФЛФормаОтчета2017Кв4 +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчет6НДФЛФормаОтчета2017Кв4(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчет6НДФЛФормаОтчета2017Кв4(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования)); +``` +
+ +## СформироватьАвтоматическиРеглОтчет6НДФЛФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчет6НДФЛФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчет6НДФЛФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования)); +``` +
+ +## ЗаполнитьРеглОтчет6НДФЛФормаОтчета2017Кв4 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаполнитьРеглОтчет6НДФЛФормаОтчета2017Кв4(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаполнитьРеглОтчет6НДФЛФормаОтчета2017Кв4(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования)); +``` +
+ +## ЗаполнитьРеглОтчет6НДФЛФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаполнитьРеглОтчет6НДФЛФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаполнитьРеглОтчет6НДФЛФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования)); +``` +
+ +## СохранитьДанныеРазделаРеглОтчет6НДФЛФормаОтчета2017Кв4 +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьДанныеРазделаРеглОтчет6НДФЛФормаОтчета2017Кв4(НаимРаздела, ТабличныйДокумент, РазделыОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьДанныеРазделаРеглОтчет6НДФЛФормаОтчета2017Кв4(НаимРаздела, ТабличныйДокумент, РазделыОтчета)); +``` +
+ +## СохранитьДанныеРазделаРеглОтчет6НДФЛФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьДанныеРазделаРеглОтчет6НДФЛФормаОтчета2016Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьДанныеРазделаРеглОтчет6НДФЛФормаОтчета2016Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета)); +``` +
+ +## ФормироватьСтруктуруСтраницРеглОтчет6НДФЛФормаОтчета2017Кв4 +
+ +Описание, пример вызова + +```bsl + +Процедура ФормироватьСтруктуруСтраницРеглОтчет6НДФЛФормаОтчета2017Кв4(ДеревоСтраницОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ФормироватьСтруктуруСтраницРеглОтчет6НДФЛФормаОтчета2017Кв4(ДеревоСтраницОтчета)); +``` +
+ +## ФормироватьСтруктуруСтраницРеглОтчет6НДФЛФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ФормироватьСтруктуруСтраницРеглОтчет6НДФЛФормаОтчета2016Кв1(ДеревоСтраницОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ФормироватьСтруктуруСтраницРеглОтчет6НДФЛФормаОтчета2016Кв1(ДеревоСтраницОтчета)); +``` +
+ +## ЗаписатьРеглОтчет6НДФЛФормаОтчета2017Кв4 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписатьРеглОтчет6НДФЛФормаОтчета2017Кв4(ИсточникОтчета, ИмяФормыОтчета, РазделыОтчета, ДанныеРеглОтчета, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаписатьРеглОтчет6НДФЛФормаОтчета2017Кв4(ИсточникОтчета, ИмяФормыОтчета, РазделыОтчета, ДанныеРеглОтчета, ); +``` +
+ +## ЗаписатьРеглОтчет6НДФЛФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписатьРеглОтчет6НДФЛФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, РазделыОтчета, ДанныеРеглОтчета, Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаписатьРеглОтчет6НДФЛФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, РазделыОтчета, ДанныеРеглОтчета, ); +``` +
+ +## ЗаполнитьСведенияОбОрганизацииРеглОтчет6НДФЛФормаОтчета2017Кв4 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОбОрганизацииРеглОтчет6НДФЛФормаОтчета2017Кв4(Организация, РазделыОтчета, ДатаПодписи, Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОбОрганизацииРеглОтчет6НДФЛФормаОтчета2017Кв4(Организация, РазделыОтчета, ДатаПодписи, ); +``` +
+ +## ЗаполнитьСведенияОбОрганизацииРеглОтчет6НДФЛФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОбОрганизацииРеглОтчет6НДФЛФормаОтчета2016Кв1(Организация, РазделыОтчета, ДатаПодписи, Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОбОрганизацииРеглОтчет6НДФЛФормаОтчета2016Кв1(Организация, РазделыОтчета, ДатаПодписи, ); +``` +
+ +## СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2018Кв4 +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2018Кв4(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2018Кв4(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования)); +``` +
+ +## СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2018Кв3 +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2018Кв3(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2018Кв3(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования)); +``` +
+ +## СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2018Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2018Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2018Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования)); +``` +
+ +## СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2017Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2017Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2017Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования)); +``` +
+ +## СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчетЕНВДФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, КорректирующийОтчет, ПараметрыАвтоФормирования)); +``` +
+ +## ЗаполнитьРеглОтчетЕНВДФормаОтчета2018Кв4 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаполнитьРеглОтчетЕНВДФормаОтчета2018Кв4(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаполнитьРеглОтчетЕНВДФормаОтчета2018Кв4(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования)); +``` +
+ +## ЗаполнитьРеглОтчетЕНВДФормаОтчета2018Кв3 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаполнитьРеглОтчетЕНВДФормаОтчета2018Кв3(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаполнитьРеглОтчетЕНВДФормаОтчета2018Кв3(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования)); +``` +
+ +## ЗаполнитьРеглОтчетЕНВДФормаОтчета2018Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаполнитьРеглОтчетЕНВДФормаОтчета2018Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаполнитьРеглОтчетЕНВДФормаОтчета2018Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования)); +``` +
+ +## ЗаполнитьРеглОтчетЕНВДФормаОтчета2017Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаполнитьРеглОтчетЕНВДФормаОтчета2017Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаполнитьРеглОтчетЕНВДФормаОтчета2017Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования)); +``` +
+ +## ЗаполнитьРеглОтчетЕНВДФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаполнитьРеглОтчетЕНВДФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаполнитьРеглОтчетЕНВДФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ПараметрыАвтоФормирования)); +``` +
+ +## РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2018Кв4 +
+ +Описание, пример вызова + +```bsl + +Процедура РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2018Кв4(ТаблицаРаздела2, ДатаНачала, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2018Кв4(ТаблицаРаздела2, ДатаНачала, ДатаОкончания)); +``` +
+ +## РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2018Кв3 +
+ +Описание, пример вызова + +```bsl + +Процедура РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2018Кв3(ТаблицаРаздела2, ДатаНачала, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2018Кв3(ТаблицаРаздела2, ДатаНачала, ДатаОкончания)); +``` +
+ +## РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2018Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2018Кв1(ТаблицаРаздела2, ДатаНачала, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2018Кв1(ТаблицаРаздела2, ДатаНачала, ДатаОкончания)); +``` +
+ +## РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2017Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2017Кв1(ТаблицаРаздела2, ДатаНачала, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2017Кв1(ТаблицаРаздела2, ДатаНачала, ДатаОкончания)); +``` +
+ +## РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2016Кв1(ТаблицаРаздела2, ДатаНачала, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РассчитатьДниОсуществленияДеятельностиЕНВДФормаОтчета2016Кв1(ТаблицаРаздела2, ДатаНачала, ДатаОкончания)); +``` +
+ +## СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2018Кв4 +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2018Кв4(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2018Кв4(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры)); +``` +
+ +## СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2018Кв3 +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2018Кв3(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2018Кв3(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры)); +``` +
+ +## СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2018Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2018Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2018Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры)); +``` +
+ +## СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2017Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2017Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2017Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры)); +``` +
+ +## СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2016Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьДанныеРазделаРеглОтчетЕНВДФормаОтчета2016Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры)); +``` +
+ +## ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2018Кв4 +
+ +Описание, пример вызова + +```bsl + +Процедура ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2018Кв4(ДеревоСтраницОтчета, Организация) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2018Кв4(ДеревоСтраницОтчета, Организация)); +``` +
+ +## ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2018Кв3 +
+ +Описание, пример вызова + +```bsl + +Процедура ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2018Кв3(ДеревоСтраницОтчета, Организация) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2018Кв3(ДеревоСтраницОтчета, Организация)); +``` +
+ +## ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2018Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2018Кв1(ДеревоСтраницОтчета, Организация) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2018Кв1(ДеревоСтраницОтчета, Организация)); +``` +
+ +## ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2017Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2017Кв1(ДеревоСтраницОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2017Кв1(ДеревоСтраницОтчета)); +``` +
+ +## ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2016Кв1(ДеревоСтраницОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ФормироватьСтруктуруСтраницРеглОтчетЕНВДФормаОтчета2016Кв1(ДеревоСтраницОтчета)); +``` +
+ +## ЗаписатьРеглОтчетЕНВДФормаОтчета2018Кв4 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписатьРеглОтчетЕНВДФормаОтчета2018Кв4(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ДанныеРеглОтчета, СсылкаНаСохрРеглОтчет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаписатьРеглОтчетЕНВДФормаОтчета2018Кв4(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ДанныеРеглОтчета, СсылкаНаСохрРеглОтчет); +``` +
+ +## ЗаписатьРеглОтчетЕНВДФормаОтчета2018Кв3 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписатьРеглОтчетЕНВДФормаОтчета2018Кв3(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ДанныеРеглОтчета, СсылкаНаСохрРеглОтчет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаписатьРеглОтчетЕНВДФормаОтчета2018Кв3(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ДанныеРеглОтчета, СсылкаНаСохрРеглОтчет); +``` +
+ +## ЗаписатьРеглОтчетЕНВДФормаОтчета2018Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписатьРеглОтчетЕНВДФормаОтчета2018Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ДанныеРеглОтчета, СсылкаНаСохрРеглОтчет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаписатьРеглОтчетЕНВДФормаОтчета2018Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ДанныеРеглОтчета, СсылкаНаСохрРеглОтчет); +``` +
+ +## ЗаписатьРеглОтчетЕНВДФормаОтчета2017Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписатьРеглОтчетЕНВДФормаОтчета2017Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ДанныеРеглОтчета, СсылкаНаСохрРеглОтчет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаписатьРеглОтчетЕНВДФормаОтчета2017Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ДанныеРеглОтчета, СсылкаНаСохрРеглОтчет); +``` +
+ +## ЗаписатьРеглОтчетЕНВДФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписатьРеглОтчетЕНВДФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ДанныеРеглОтчета, СсылкаНаСохрРеглОтчет = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаписатьРеглОтчетЕНВДФормаОтчета2016Кв1(ИсточникОтчета, ИмяФормыОтчета, Организация, ДатаНачала, ДатаОкончания, РазделыОтчета, ДанныеРеглОтчета, СсылкаНаСохрРеглОтчет); +``` +
+ +## ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2018Кв4 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2018Кв4(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2018Кв4(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания)); +``` +
+ +## ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2018Кв3 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2018Кв3(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2018Кв3(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания)); +``` +
+ +## ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2018Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2018Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2018Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания)); +``` +
+ +## ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2017Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2017Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2017Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания)); +``` +
+ +## ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2016Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОбОрганизацииРеглОтчетЕНВДФормаОтчета2016Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания)); +``` +
+ +## РасчетРеглОтчетЕНВДФормаОтчета2018Кв4 +
+ +Описание, пример вызова + +```bsl + +Процедура РасчетРеглОтчетЕНВДФормаОтчета2018Кв4(РазделыОтчета, ИмяРаздела = "", ДатаОкончания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РасчетРеглОтчетЕНВДФормаОтчета2018Кв4(РазделыОтчета, ИмяРаздела, ДатаОкончания); +``` +
+ +## РасчетРеглОтчетЕНВДФормаОтчета2018Кв3 +
+ +Описание, пример вызова + +```bsl + +Процедура РасчетРеглОтчетЕНВДФормаОтчета2018Кв3(РазделыОтчета, ИмяРаздела = "", ДатаОкончания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РасчетРеглОтчетЕНВДФормаОтчета2018Кв3(РазделыОтчета, ИмяРаздела, ДатаОкончания); +``` +
+ +## РасчетРеглОтчетЕНВДФормаОтчета2018Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура РасчетРеглОтчетЕНВДФормаОтчета2018Кв1(РазделыОтчета, ИмяРаздела = "", ДатаОкончания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РасчетРеглОтчетЕНВДФормаОтчета2018Кв1(РазделыОтчета, ИмяРаздела, ДатаОкончания); +``` +
+ +## РасчетРеглОтчетЕНВДФормаОтчета2017Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура РасчетРеглОтчетЕНВДФормаОтчета2017Кв1(РазделыОтчета, ИмяРаздела = "", ДатаОкончания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РасчетРеглОтчетЕНВДФормаОтчета2017Кв1(РазделыОтчета, ИмяРаздела, ДатаОкончания); +``` +
+ +## РасчетРеглОтчетЕНВДФормаОтчета2016Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура РасчетРеглОтчетЕНВДФормаОтчета2016Кв1(РазделыОтчета, ИмяРаздела = "", ДатаОкончания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РасчетРеглОтчетЕНВДФормаОтчета2016Кв1(РазделыОтчета, ИмяРаздела, ДатаОкончания); +``` +
+ +## СформироватьАвтоматическиРеглОтчетУСНФормаОтчета2023Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчетУСНФормаОтчета2023Кв1(ПараметрыАвтоформирования, КорректирующийОтчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчетУСНФормаОтчета2023Кв1(ПараметрыАвтоформирования, КорректирующийОтчет)); +``` +
+ +## СформироватьАвтоматическиРеглОтчетУСНФормаОтчета2021Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчетУСНФормаОтчета2021Кв1(ПараметрыАвтоформирования, КорректирующийОтчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчетУСНФормаОтчета2021Кв1(ПараметрыАвтоформирования, КорректирующийОтчет)); +``` +
+ +## СформироватьАвтоматическиРеглОтчетУСНФормаОтчета2015Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчетУСНФормаОтчета2015Кв1(ПараметрыАвтоформирования, КорректирующийОтчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчетУСНФормаОтчета2015Кв1(ПараметрыАвтоформирования, КорректирующийОтчет)); +``` +
+ +## НовыйРазделыРеглОтчетаУСНФормаОтчета2023Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция НовыйРазделыРеглОтчетаУСНФормаОтчета2023Кв1() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.НовыйРазделыРеглОтчетаУСНФормаОтчета2023Кв1()); +``` +
+ +## НовыйРазделыРеглОтчетаУСНФормаОтчета2021Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция НовыйРазделыРеглОтчетаУСНФормаОтчета2021Кв1() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.НовыйРазделыРеглОтчетаУСНФормаОтчета2021Кв1()); +``` +
+ +## НовыйРазделыРеглОтчетаУСНФормаОтчета2015Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция НовыйРазделыРеглОтчетаУСНФормаОтчета2015Кв1() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.НовыйРазделыРеглОтчетаУСНФормаОтчета2015Кв1()); +``` +
+ +## ЗаполнитьРеглОтчетУСНФормаОтчета2023Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьРеглОтчетУСНФормаОтчета2023Кв1(ПараметрыАвтоформирования, КорректирующийОтчет, РазделыОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьРеглОтчетУСНФормаОтчета2023Кв1(ПараметрыАвтоформирования, КорректирующийОтчет, РазделыОтчета)); +``` +
+ +## ЗаполнитьРеглОтчетУСНФормаОтчета2021Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьРеглОтчетУСНФормаОтчета2021Кв1(ПараметрыАвтоформирования, КорректирующийОтчет, РазделыОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьРеглОтчетУСНФормаОтчета2021Кв1(ПараметрыАвтоформирования, КорректирующийОтчет, РазделыОтчета)); +``` +
+ +## ЗаполнитьРеглОтчетУСНФормаОтчета2015Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьРеглОтчетУСНФормаОтчета2015Кв1(ПараметрыАвтоформирования, КорректирующийОтчет, РазделыОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьРеглОтчетУСНФормаОтчета2015Кв1(ПараметрыАвтоформирования, КорректирующийОтчет, РазделыОтчета)); +``` +
+ +## РасчетРеглОтчетУСНФормаОтчета2023Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура РасчетРеглОтчетУСНФормаОтчета2023Кв1(РазделыОтчета, ИмяРаздела = "", ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РасчетРеглОтчетУСНФормаОтчета2023Кв1(РазделыОтчета, ИмяРаздела, ДопПараметры)); +``` +
+ +## РасчетРеглОтчетУСНФормаОтчета2021Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура РасчетРеглОтчетУСНФормаОтчета2021Кв1(РазделыОтчета, ИмяРаздела = "", ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РасчетРеглОтчетУСНФормаОтчета2021Кв1(РазделыОтчета, ИмяРаздела, ДопПараметры)); +``` +
+ +## РасчетРеглОтчетУСНФормаОтчета2015Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура РасчетРеглОтчетУСНФормаОтчета2015Кв1(РазделыОтчета, ИмяРаздела = "", ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.РасчетРеглОтчетУСНФормаОтчета2015Кв1(РазделыОтчета, ИмяРаздела, ДопПараметры)); +``` +
+ +## ЗаполнитьСведенияОбОрганизацииРеглОтчетУСНФормаОтчета2023Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОбОрганизацииРеглОтчетУСНФормаОтчета2023Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОбОрганизацииРеглОтчетУСНФормаОтчета2023Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания)); +``` +
+ +## ЗаполнитьСведенияОбОрганизацииРеглОтчетУСНФормаОтчета2021Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОбОрганизацииРеглОтчетУСНФормаОтчета2021Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОбОрганизацииРеглОтчетУСНФормаОтчета2021Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания)); +``` +
+ +## ЗаполнитьСведенияОбОрганизацииРеглОтчетУСНФормаОтчета2015Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОбОрганизацииРеглОтчетУСНФормаОтчета2015Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОбОрганизацииРеглОтчетУСНФормаОтчета2015Кв1(Организация, РазделыОтчета, ДатаПодписи, ДатаОкончания)); +``` +
+ +## СохранитьДанныеРазделаРеглОтчетУСНФормаОтчета2023Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьДанныеРазделаРеглОтчетУСНФормаОтчета2023Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьДанныеРазделаРеглОтчетУСНФормаОтчета2023Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры)); +``` +
+ +## СохранитьДанныеРазделаРеглОтчетУСНФормаОтчета2021Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьДанныеРазделаРеглОтчетУСНФормаОтчета2021Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьДанныеРазделаРеглОтчетУСНФормаОтчета2021Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры)); +``` +
+ +## СохранитьДанныеРазделаРеглОтчетУСНФормаОтчета2015Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура СохранитьДанныеРазделаРеглОтчетУСНФормаОтчета2015Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СохранитьДанныеРазделаРеглОтчетУСНФормаОтчета2015Кв1(НаимРаздела, ТабличныйДокумент, РазделыОтчета, ДопПараметры)); +``` +
+ +## ЗаписатьРеглОтчетУСНФормаОтчета2023Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписатьРеглОтчетУСНФормаОтчета2023Кв1(ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаписатьРеглОтчетУСНФормаОтчета2023Кв1(ПараметрыЗаписи)); +``` +
+ +## ЗаписатьРеглОтчетУСНФормаОтчета2021Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписатьРеглОтчетУСНФормаОтчета2021Кв1(ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаписатьРеглОтчетУСНФормаОтчета2021Кв1(ПараметрыЗаписи)); +``` +
+ +## ЗаписатьРеглОтчетУСНФормаОтчета2015Кв1 +
+ +Описание, пример вызова + +```bsl + +Функция ЗаписатьРеглОтчетУСНФормаОтчета2015Кв1(ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ЗаписатьРеглОтчетУСНФормаОтчета2015Кв1(ПараметрыЗаписи)); +``` +
+ +## ФормироватьСтруктуруСтраницРеглОтчетУСНФормаОтчета2023Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ФормироватьСтруктуруСтраницРеглОтчетУСНФормаОтчета2023Кв1(ДеревоСтраницОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ФормироватьСтруктуруСтраницРеглОтчетУСНФормаОтчета2023Кв1(ДеревоСтраницОтчета)); +``` +
+ +## ФормироватьСтруктуруСтраницРеглОтчетУСНФормаОтчета2021Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ФормироватьСтруктуруСтраницРеглОтчетУСНФормаОтчета2021Кв1(ДеревоСтраницОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ФормироватьСтруктуруСтраницРеглОтчетУСНФормаОтчета2021Кв1(ДеревоСтраницОтчета)); +``` +
+ +## ФормироватьСтруктуруСтраницРеглОтчетУСНФормаОтчета2015Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура ФормироватьСтруктуруСтраницРеглОтчетУСНФормаОтчета2015Кв1(ДеревоСтраницОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ФормироватьСтруктуруСтраницРеглОтчетУСНФормаОтчета2015Кв1(ДеревоСтраницОтчета)); +``` +
+ +## СкрытьРазделыПоОбъектуНалогообложенияРеглОтчетУСНФормаОтчета2023Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура СкрытьРазделыПоОбъектуНалогообложенияРеглОтчетУСНФормаОтчета2023Кв1(Организация, ПериодОтчета, ДеревоСтраницОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СкрытьРазделыПоОбъектуНалогообложенияРеглОтчетУСНФормаОтчета2023Кв1(Организация, ПериодОтчета, ДеревоСтраницОтчета)); +``` +
+ +## СкрытьРазделыПоОбъектуНалогообложенияРеглОтчетУСНФормаОтчета2021Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура СкрытьРазделыПоОбъектуНалогообложенияРеглОтчетУСНФормаОтчета2021Кв1(Организация, ПериодОтчета, ДеревоСтраницОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СкрытьРазделыПоОбъектуНалогообложенияРеглОтчетУСНФормаОтчета2021Кв1(Организация, ПериодОтчета, ДеревоСтраницОтчета)); +``` +
+ +## СкрытьРазделыПоОбъектуНалогообложенияРеглОтчетУСНФормаОтчета2015Кв1 +
+ +Описание, пример вызова + +```bsl + +Процедура СкрытьРазделыПоОбъектуНалогообложенияРеглОтчетУСНФормаОтчета2015Кв1(Организация, ПериодОтчета, ДеревоСтраницОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.СкрытьРазделыПоОбъектуНалогообложенияРеглОтчетУСНФормаОтчета2015Кв1(Организация, ПериодОтчета, ДеревоСтраницОтчета)); +``` +
+ +## СформироватьАвтоматическиРеглОтчетСтатистикаФорма1Предприниматель +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьАвтоматическиРеглОтчетСтатистикаФорма1Предприниматель(ПараметрыАвтоФормирования, КорректирующийОтчет) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СформироватьАвтоматическиРеглОтчетСтатистикаФорма1Предприниматель(ПараметрыАвтоФормирования, КорректирующийОтчет) +``` +
+ +## ЗаполнитьСведенияОПодписантах +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьСведенияОПодписантах(Организация, РазделыОтчета, ДатаПодписи, ПереопределяемыеИменаПоказателей = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьСведенияОПодписантах(Организация, РазделыОтчета, ДатаПодписи, ПереопределяемыеИменаПоказателей); +``` +
+ +## ЗаполнитьНачальныеНастройки +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьНачальныеНастройки(ИсточникОтчета, ИмяФормыОтчета, ИмяМакета, СтруктураВариантыЗаполнения) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьНачальныеНастройки(ИсточникОтчета, ИмяФормыОтчета, ИмяМакета, СтруктураВариантыЗаполнения)); +``` +
+ +## ЗаполнитьПоказателиОтчета +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьПоказателиОтчета(РазделыОтчета, ПоказателиОтчета) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьПоказателиОтчета(РазделыОтчета, ПоказателиОтчета)); +``` +
+ +## ЗаполнитьПустыеСтруктурыДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьПустыеСтруктурыДанных(ИсточникОтчета, ИмяФормыОтчета, РазделыОтчета, ДопПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьПустыеСтруктурыДанных(ИсточникОтчета, ИмяФормыОтчета, РазделыОтчета, ДопПараметры); +``` +
+ +## ОбновитьСтруктуруМногострочногоРаздела +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьСтруктуруМногострочногоРаздела(ДанныеДопСтрок, ТабличныйДокумент) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ОбновитьСтруктуруМногострочногоРаздела(ДанныеДопСтрок, ТабличныйДокумент)); +``` +
+ +## СуммаПоказателяПоВсемСтраницам +
+ +Описание, пример вызова + +```bsl + +Функция СуммаПоказателяПоВсемСтраницам(ДанныеРаздела, Показатель, Условия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СуммаПоказателяПоВсемСтраницам(ДанныеРаздела, Показатель, Условия); +``` +
+ +## ЗаполнитьЗначенияСвойствСтруктурыПоИсточнику +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьЗначенияСвойствСтруктурыПоИсточнику(СтруктураПриемник, СтруктураИсточник) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьЗначенияСвойствСтруктурыПоИсточнику(СтруктураПриемник, СтруктураИсточник)); +``` +
+ +## ВыполняютсяУсловияЗаполнения +
+ +Описание, пример вызова + +```bsl + +Функция ВыполняютсяУсловияЗаполнения(СтруктураДанных, Условия) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ВыполняютсяУсловияЗаполнения(СтруктураДанных, Условия)); +``` +
+ +## СобратьДанные +
+ +Описание, пример вызова + +```bsl + +Функция СобратьДанные(ТабличныйДокумент) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СобратьДанные(ТабличныйДокумент)); +``` +
+ +## ОкруглитьЧислоПоФормату +
+ +Описание, пример вызова + +```bsl + +Функция ОкруглитьЧислоПоФормату(СтруктураРеквизитов, ИсходноеЧисло) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.ОкруглитьЧислоПоФормату(СтруктураРеквизитов, ИсходноеЧисло)); +``` +
+ +## СтруктураРеквизитовОтчета +
+ +Описание, пример вызова + +```bsl + +Функция СтруктураРеквизитовОтчета(ДанныеОтчета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.СтруктураРеквизитовОтчета(ДанныеОтчета); +``` +
+ +## РелевантнаяДатаОкончанияОтчетногоПериода +
+ +Описание, пример вызова + +```bsl + +Функция РелевантнаяДатаОкончанияОтчетногоПериода(СвойстваОтчета) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРО.РелевантнаяДатаОкончанияОтчетногоПериода(СвойстваОтчета)); +``` +
+ +## НайтиОбластиТабличногоДокументаПоНачалуИмени +
+ +Описание, пример вызова + +```bsl + +Процедура НайтиОбластиТабличногоДокументаПоНачалуИмени(ИменаОбластей, ТабличныйДокумент, Знач НачалоИмени, Исключения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.НайтиОбластиТабличногоДокументаПоНачалуИмени(ИменаОбластей, ТабличныйДокумент, НачалоИмени, Исключения); +``` +
+ +## ЗаполнитьАктуальныйОтчет +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьАктуальныйОтчет(АктуальныйОтчет, РеглОтчеты, ИсточникОтчета, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРО.ЗаполнитьАктуальныйОтчет(АктуальныйОтчет, РеглОтчеты, ИсточникОтчета, ДополнительныеПараметры)); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтерфейсыВзаимодействияБРОВызовСервера.md b/src/content/docs/zup/ИнтерфейсыВзаимодействияБРОВызовСервера.md new file mode 100644 index 0000000..495522f --- /dev/null +++ b/src/content/docs/zup/ИнтерфейсыВзаимодействияБРОВызовСервера.md @@ -0,0 +1,590 @@ +--- +title: Интерфейсы взаимодействия БРО вызов сервера +slug: zup/интерфейсы-взаимодействия-бро-вызов-сервера +--- + + +## СведенияОПредставителеПоРегистрацииВНалоговомОргане +
+ +Описание, пример вызова + +```bsl + +// Предназначена для получения сведений об уполномоченном представителе организации в налоговом органе. +// Параметры: +// РегистрацияВНалоговомОргане - СправочникСсылка.РегистрацииВНалоговомОргане - должно быть непустым значением. +// ДатаПодписи - дата - дата, по состоянию на которую будут читаться данные представителя-физлица. +// +// Возвращаемое значение: +// Структура - структура с полями: +// * ТипПодписанта - строка со значениями "1", "2"; +// * ПредставительЮрЛицо - Булево - признак представителя юр. лица; +// * НаименованиеОрганизацииПредставителя - Строка - наименование организации представителя; +// * ДокументПредставителя - Строка - документ представителя; +// * Фамилия - Строка - фамилия; +// * Имя - Строка - имя; +// * Отчество - Строка - отчество; +// * ФИОПредставителя - Строка - ФИО представителя. +// +Функция СведенияОПредставителеПоРегистрацииВНалоговомОргане(РегистрацияВНалоговомОргане, ДатаПодписи) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.СведенияОПредставителеПоРегистрацииВНалоговомОргане(РегистрацияВНалоговомОргане, ДатаПодписи) +``` +
+ +## ДатаПодключения1СОтчетности +
+ +Описание, пример вызова + +```bsl + +// Возвращает дату подключения учетной записи документооборота для организации или наименьшую дату одобрения заявления. +Функция ДатаПодключения1СОтчетности(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.ДатаПодключения1СОтчетности(Организация) +``` +
+ +## СведенияКвитанцииОПриемеЗаявления +
+ +Описание, пример вызова + +```bsl + +// Предназначена для получения информации о регистрации заявления о ввозе товаров в налоговом органе. +// Параметры: +// ЗаявлениеОВвозеТоваровИлиМассив - ДокументСсылка.ЗаявлениеОВвозеТоваров, Массив. +// +// Возвращаемое значение: +// Структура, Массив: +// * Выполнено - Булево - если Истина, то функция успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * ОписаниеОшибки - Строка - описание ошибки (недостаточно прав, некорректная структура квитанции). +// * ЗаявлениеОВвозеТоваров - ДокументСсылка.ЗаявлениеОВвозеТоваров. +// * ЕстьКвитанцияОПриеме - Булево. +// * РегНом - Строка - регистрационный номер заявления, присвоенный налоговым органом, регламентирован формат +// до 16 символов. +// * ДатаРег - Строка - дата регистрации заявления в налоговом органе, регламентирован формат ДД.ММ.ГГГГ. +// +Функция СведенияКвитанцииОПриемеЗаявления(ЗаявлениеОВвозеТоваровИлиМассив) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.СведенияКвитанцииОПриемеЗаявления(ЗаявлениеОВвозеТоваровИлиМассив) +``` +
+ +## СведенияКвитанцийОтчета +
+ +Описание, пример вызова + +```bsl + +// Предназначена для получения квитанций и протоколов отчета. +// Параметры: +// СсылкаНаОтчет - Ссылка из определяемого типа ПредметЦиклаОбмена - например, +// ДокументСсылка.РегламентированныйОтчет, +// СправочникСсылка.ЭлектронныеПредставленияРегламентированныхОтчетов, +// ДокументСсылка.СведенияОТрудовойДеятельностиРаботниковСЗВ_ТД +// ТипТранспортногоСообщения - Перечисления.ТипыТранспортныхСообщений - например, +// Перечисления.ТипыТранспортныхСообщений.ПротоколПФР +// - Строка - контролирующий орган и имя поля объекта отправки, например "ФССКвитанция", +// значение ТипыСодержимогоТранспортногоКонтейнера в этом случае не учитывается +// ТипыСодержимогоТранспортногоКонтейнера - Перечисления.ТипыСодержимогоТранспортногоКонтейнера - например, +// Перечисления.ТипыСодержимогоТранспортногоКонтейнера.ПротоколПФР +// для получения XML протокола СЗВ-ТД, +// Перечисления.ТипыСодержимогоТранспортногоКонтейнера.ПротоколПриложениеПФР +// для получения XML и HTML приложений к протоколу СЗВ-М +// +// Возвращаемое значение: +// Структура: +// * Выполнено - Булево - если Истина, то функция успешно выполнена, иначе см. ОписаниеОшибки. +// * ОписаниеОшибки - Строка - описание ошибки, например, недостаточно прав. +// * Сведения - ТаблицаЗначений - содержимое РегистрСведений.СодержимоеТранспортныхКонтейнеров, +// основные колонки (при строковом значении параметра "ТипТранспортногоСообщения" +// возващается одна запись только с этими колонками): +// ИмяФайла - Строка +// ВАрхиве - Булкво - при Истина содерджмое недоступно +// Данные - ХранилищеЗначения - ДвоичныеДанные квитанции/протокола +// ТипСодержимогоФайла - Перечисления.ТипыСодержимогоФайлов - например, +// Перечисления.ТипыСодержимогоФайлов.Xml +// Содержимое - колонка присутствует при строковом значении параметра +// "ТипТранспортногоСообщения", при значении "ФССКвитанция" для реестра +// стимулирующих выплат медицинским и социальным работникам содержит +// структуру: +// ИдентификаторОтправки - Строка - значение узла "recriveID", +// СтатусОбработки - Число - значение узла "statusGeneral", +// ДатаВремяОбработки - Дата - значение узла "dateTimeReceive", +// СообщенияОбОшибках - Строка - все сообщения из узла "firstErrorList" +// с кодами ошибок в скобках, разделенные переводами строк, +// ОшибкиПервичнойОбработки - Массив - из узла "firstErrorList": +// КодОшибки - Строка - узел "errorCode", +// ОписаниеОшибки - Строка - узел "errorDescription", +// ПротоколОбработки - Массив - из узла "protocol" - "failedList" - +// "failedBatchNoDetail": +// НомерЗаписи - Строка - узел "batchNo", +// ОшибкиОбработки - Массив - из узла "errorList": +// КодОшибки - Строка - узел "errorCode", +// ОписаниеОшибки - Строка - узел "errorDescription". +// +Функция СведенияКвитанцийОтчета( Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.СведенияКвитанцийОтчета(); +``` +
+ +## ПолучитьИмяФормыУведомленияПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Возвращает форму для уведомления +// Например: Отчет.РегламентированноеУведомлениеЛьготаТранспортЗемля.Форма.Форма2019_1 +// Параметры: +// ВидУведомления - ПеречислениеСсылка.ВидыУведомленийОСпецрежимахНалогообложения. +// ДатаСведений - Дата, на какую дату нужна форма +Функция ПолучитьИмяФормыУведомленияПоУмолчанию(ВидУведомления, ДатаСведений) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.ПолучитьИмяФормыУведомленияПоУмолчанию(ВидУведомления, ДатаСведений) +``` +
+ +## ПолучитьПроцедурыДекларированияФТСССервера +
+ +Описание, пример вызова + +```bsl + +// Получает процедуры таможенного декларирования товаров с сайта ФТС. +// +// Параметры: +// ПараметрыОтправки - Структура - параметр структуры "ПараметрыОтправки", возвращаемый процедурой +// ИнтерфейсыВзаимодействияБРОКлиент.ПолучитьПроцедурыДекларированияФТС +// при РежимыРаботы.ТолькоПолучитьНастройки = Истина; +// ПараметрыСоединения - Структура - параметр структуры "ПараметрыСоединения", возвращаемый процедурой +// ИнтерфейсыВзаимодействияБРОКлиент.ПолучитьПроцедурыДекларированияФТС +// при РежимыРаботы.ТолькоПолучитьНастройки = Истина. +// +// Возвращаемое значение: +// Массив из структур с процедурами декларирования для передачи в процедуру +// ИнтерфейсыВзаимодействияБРОКлиент.ОбработатьРезультатыПолученияПроцедурДекларированияФТС. +// +Функция ПолучитьПроцедурыДекларированияФТСССервера(Знач ПараметрыОтправки, ПараметрыСоединения) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.ПолучитьПроцедурыДекларированияФТСССервера(ПараметрыОтправки, ПараметрыСоединения) +``` +
+ +## СведенияОПрисвоенииРНПТ +
+ +Описание, пример вызова + +```bsl + +// Предназначена для получения квитанции о присвоении регистрационного номера партии товара. +// Параметры: +// СсылкаНаОтчетИлиДанныеКвитанции - Ссылка из определяемого типа ПредметЦиклаОбмена - например, ссылка, возвращенная +// ЭлектронныйДокументооборотСКонтролирующимиОрганамиВызовСервераПереопределяемый.ПриИзмененииСтатусаОтправкиДокумента +// - ДвоичныеДанные - данные квитанции о присвоении РНПТ с КНД 1169012 +// СтатусОтправки - Перечисления.СтатусыОтправки - например, статус, возвращаемый +// ЭлектронныйДокументооборотСКонтролирующимиОрганамиВызовСервераПереопределяемый.ПриИзмененииСтатусаОтправкиДокумента +// - Неопределено - не используется при предаче двоичных данных квитанции. +// +// Возвращаемое значение: +// Структура: +// * ЭтоКвитанцияОПрисвоенииРНПТ - Булево - при значении Истина заполняются остальные поля, +// * НомерУведомления - Строка - номер уведомления об остатках прослеживаемого товара, +// * ДатаУведомления - Дата - дата уведомления об остатках прослеживаемого товара, +// * ДанныеКвитанции - ДволичныеДанные - данные квитанции о присвоении РНПТ с КНД 1169012, +// * Квитанция - Структура - содержимое квитанции о присвоении РНПТ с КНД 1169012: +// ** ДатаДокумента - Дата - дата формирования документа, +// ** РНПТ - Строка - регистрационный номер партии товара, +// ** ВидДокумента - Строка - "Уведомление об имеющихся остатках товаров, подлежащих прослеживаемости" +// или "Уведомление о ввозе товаров, подлежащих прослеживаемости, с +// территории другого государства-члена Евразийского экономического +// союза на территорию Российской Федерации и иные территории, +// находящиеся под ее юрисдикцией", +// ** НомерУведомления - Строка, +// ** ДатаУведомления - Дата, +// ** НаименованиеСобственника - Строка - наименование собственника товара, если это организация, +// ** ИННСобственника - Строка - ИНН собственника товара, если это организация, +// ** КППСобственника - Строка - КПП собственника товара, если это организация, +// ** ИННФЛСобственника - Строка - ИНН собственника товара, если это физическое лицо, +// ** ФамилияСобственника - Строка - фамилия собственника товара, если это физическое лицо, +// ** ИмяСобственника - Строка - имя собственника товара, если это физическое лицо, +// ** ОтчествоСобственника - Строка - отчество собственника товара, если это физическое лицо, +// ** КодыОшибок - Массив - строки кодов ошибок, +// * ОписаниеОшибки - Строка - описание ошибки извлечения данных квитанции, например, из-за +// недостаточности прав на документооборот с гос.органами. +// +Функция СведенияОПрисвоенииРНПТ(СсылкаНаОтчетИлиДанныеКвитанции, СтатусОтправки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.СведенияОПрисвоенииРНПТ(СсылкаНаОтчетИлиДанныеКвитанции, СтатусОтправки); +``` +
+ +## ДокументыРеализацииПолномочийНО +
+ +Описание, пример вызова + +```bsl + +// По организации, номеру, дате, виду уведомления ищет документы реализации полномочий налоговых органов, +// сейчас возвращает квитанции о присвоении РНПТ. +// Параметры: +// СсылкаНаУведомление - Ссылка из определяемого типа ПредметЦиклаОбмена, +// ВозвращатьСостояние - Булево - возвращать ключ "СостояниеСдачиОтчетности". +// +// Возвращаемое значение: +// Массив из Структур - квитанции о присвоении РНПТ, КНД 1169012, по убыванию даты: +// * Ссылка - СправочникСсылка.ДокументыРеализацииПолномочийНалоговыхОрганов, +// * РНПТ - Строка, +// * ВидДокумента - Строка - "Уведомление об имеющихся остатках товаров, подлежащих прослеживаемости" +// или "Уведомление о ввозе товаров, подлежащих прослеживаемости, с +// территории другого государства-члена Евразийского экономического +// союза на территорию Российской Федерации и иные территории, +// находящиеся под ее юрисдикцией", +// * НомерУведомления - Строка, +// * ДатаУведомления - Дата, +// * НаименованиеСобственника - Строка - наименование собственника товара, если это организация, +// * ФИОСобственника - Строка - фамилия собственника товара, если это физическое лицо, +// * ИННСобственника - Строка - ИНН собственника товара - организации или физического лица, +// * КППСобственника - Строка - КПП собственника товара - организации, +// * ОшибкиНСП - Массив: +// ** КодОшибки - Строка, +// ** ТекстОшибки - Строка, +// * СостояниеСдачиОтчетности - ПеречислениеСсылка.СостояниеСдачиОтчетности - возвращается, если +// ВозвращатьСостояние = Истина. +// * ОписаниеОшибки - Строка - текст ошибки получения СостояниеСдачиОтчетности или пустая строка +// при успехе, возвращается, если ВозвращатьСостояние = Истина. +// +Функция ДокументыРеализацииПолномочийНО(СсылкаНаУведомление, ВозвращатьСостояние = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.ДокументыРеализацииПолномочийНО(СсылкаНаУведомление, ВозвращатьСостояние); +``` +
+ +## ТекстыДляЗапросаДокументовРеализацииПолномочийНО +
+ +Описание, пример вызова + +```bsl + +// Тексты колонок и левого соединения с запросом документов УведомлениеОбОстаткахПрослеживаемыхТоваров, +// УведомлениеОВвозеПрослеживаемыхТоваров для получения реквизитов квитанций о присвоении РНПТ. +// Параметры: +// ИмяДокументаВЗапросе - Строка. +// ТолькоПризнакЗаполненияРНПТ - Булево - В запрос включить только поле ДокументыРеализацииПолномочийНО_РНПТЗаполнен. +// +// Возвращаемое значение: +// Структура: +// * ПеречислениеКолонок - Строка - колонки "ДокументыРеализацииПолномочийНО_РНПТЗаполнен", +// "ДокументыРеализацииПолномочийНО_Ссылка", +// "ДокументыРеализацииПолномочийНО_РНПТ", +// "ДокументыРеализацииПолномочийНО_ВидУведомления", +// "ДокументыРеализацииПолномочийНО_НомерУведомления", +// "ДокументыРеализацииПолномочийНО_ДатаУведомления", +// "ДокументыРеализацииПолномочийНО_НаименованиеСобственника", +// "ДокументыРеализацииПолномочийНО_ФИОСобственника", +// "ДокументыРеализацииПолномочийНО_ИННСобственника", +// "ДокументыРеализацииПолномочийНО_КППСобственника", +// * СоединениеСДокументом - Строка - строка левого соединения. +// +Функция ТекстыДляЗапросаДокументовРеализацииПолномочийНО(ИмяДокументаВЗапросе = "Уведомление", ТолькоПризнакЗаполненияРНПТ = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.ТекстыДляЗапросаДокументовРеализацииПолномочийНО(ИмяДокументаВЗапросе, ТолькоПризнакЗаполненияРНПТ); +``` +
+ +## ОсновныеРеквизитыМашиночитаемыхДоверенностейФНС +
+ +Описание, пример вызова + +```bsl + +// Предназначена для получения основных реквизитов действующих МЧД ФНС и МЧД ФНС распределенного реестра, +// по убыванию даты выдачи. Включаются МЧД, которые могли быть зарегистрированы из других баз и загружены в эту +// или регистрация еще не завершилась, так как их пользователь тоже может захотеть выбрать. +// При СначалаЗарегистрированные равном Истина сначала выводятся МЧД со статусом зарегистрированных в этой базе. +// Параметры: +// Организация - СправочникСсылка.Организации - отбор выполняется при заданном значении. +// СНИЛС - Строка - СНИЛС представителя, отбор выполняется при заданном значении. +// СначалаЗарегистрированные - Булево. +// ПараметрыОтбора - Структура - отбор по реквизитам, присутствующим в справочниках +// "МашиночитаемыеДоверенностиРаспределенныйРеестр" и "МашиночитаемыеДоверенностиФНС", +// например, для отбора по ИНН и КПП организации доверителя задать: +// Новый Структура("ДоверительЮЛ_ИНН, ДоверительЮЛ_КПП", <ИНН организаци>, <КПП>) +// для отбора по ИНН физического лица доверителя задать: +// Новый Структура("ДоверительФЛ_ИНН", <ИНН физического лица доверителя>) +// для отбора по ИНН физического лица представителя задать: +// Новый Структура("ПредставительФЛ_ИНН", <ИНН физического лица представителя>) +// для отбора по ИНН и КПП организации представителя, например, филиала, задать: +// Новый Структура("ПредставительЮЛ_ИНН, ПредставительЮЛ_КПП", <ИНН>, <КПП филиала>) +// +// Возвращаемое значение: +// Массив - содержит структуры с полями: +// * Ссылка - Справочник.МашиночитаемыеДоверенностиРаспределенныйРеестр +// или Справочник.МашиночитаемыеДоверенностиФНС; +// * НомерДоверенности - Строка; +// * ДатаВыдачи - Дата; +// * ДатаОкончания - Дата; +// * ТипДоверенности - Строка - "МашиночитаемыеДоверенностиРаспределенныйРеестр" +// или "МашиночитаемыеДоверенностиФНС"; +// * Статус - Перечисление.СтатусыМашиночитаемойДоверенностиКО. +// +Функция ОсновныеРеквизитыМашиночитаемыхДоверенностейФНС( Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.ОсновныеРеквизитыМашиночитаемыхДоверенностейФНС(); +``` +
+ +## СведенияДоверенностиФНС +
+ +Описание, пример вызова + +```bsl + +// Сведения доверенности, указанной в справочнике "РегистрацииВНалоговомОргане". +// Параметры: +// РегистрацииВНалоговомОргане - Неопределено или СправочникСсылка.РегистрацииВНалоговомОргане; +// Организация - Неопределено или СправочникСсылка.Организация для поиска регистрации в налоговом +// органе, если параметр "РегистрацииВНалоговомОргане" не задан; +// КодНО - код налогового органа для поиска регистрации в налоговом органе, если параметр +// "РегистрацииВНалоговомОргане" не задан; +// КПП - КПП для поиска регистрации в налоговом органе, если параметр +// "РегистрацииВНалоговомОргане" не задан. +// +// Возвращаемое значение: +// Неопределено - если доверенность не указана или недостаточно прав. +// Структура с полями справочника "ДоверенностиНалогоплательщика", "МашиночитаемыеДоверенностиФНС" +// или "МашиночитаемыеДоверенностиРаспределенныйРеестр", а также обязательно присутствуют поля: +// * ЕдиныйРегистрационныйНомер - Строка - GUID машиночитаемой доверенности +// распределенного реестра; +// * ЭтоМашиночитаемаяДоверенность - Булево; +// * ЭтоМашиночитаемаяДоверенностьРаспределенногоРеестра - Булево; +// * Ссылка - Справочник.ДоверенностиНалогоплательщика, +// Справочник.МашиночитаемыеДоверенностиФНС или +// Справочник.МашиночитаемыеДоверенностиРаспределенныйРеестр; +// * НомерДоверенности - Строка; +// * ДатаВыдачи - Дата - может быть незаполненной только в заготовке; +// * ДатаОкончания - Дата - может быть незаполненной. +// +Функция СведенияДоверенностиФНС( Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.СведенияДоверенностиФНС(); +``` +
+ +## ПриИзмененииСтатусаДоверенности +
+ +Описание, пример вызова + +```bsl + +// При изменении статуса доверенности справочника "МашиночитаемыеДоверенности", +// описание см. МашиночитаемыеДоверенностиФНСПереопределяемый.ПриИзмененииСтатусаДоверенности +// +Функция ПриИзмененииСтатусаДоверенности(СтатусыДоверенностей, ОпределитьОрганизации = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.ПриИзмененииСтатусаДоверенности(СтатусыДоверенностей, ОпределитьОрганизации); +``` +
+ +## ПриЗаполненииНалоговыхОргановДействия +
+ +Описание, пример вызова + +```bsl + +// При заполнении налоговых органов действия доверенности справочника "МашиночитаемыеДоверенности", +// описание см. МашиночитаемыеДоверенностиФНСПереопределяемый.ПриЗаполненииНалоговыхОргановДействия +// +Процедура ПриЗаполненииНалоговыхОргановДействия(Организации, НалоговыеОрганыДействия) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОВызовСервера.ПриЗаполненииНалоговыхОргановДействия(Организации, НалоговыеОрганыДействия) +``` +
+ +## ПриПолученииСтатусаРегистрации +
+ +Описание, пример вызова + +```bsl + +// При инициализации и обновлении статуса доверенности справочника "МашиночитаемыеДоверенности", +// описание см. МашиночитаемыеДоверенностиФНСПереопределяемый.ПриИзмененииСтатусаДоверенности +// +Процедура ПриПолученииСтатусаРегистрации(Доверенность, РегистрацияВРеестре) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОВызовСервера.ПриПолученииСтатусаРегистрации(Доверенность, РегистрацияВРеестре) +``` +
+ +## ПриРегистрацииДоверенности +
+ +Описание, пример вызова + +```bsl + +// При регистрации доверенности справочника "МашиночитаемыеДоверенности", +// описание см. МашиночитаемыеДоверенностиФНСПереопределяемый.ПриРегистрацииДоверенности +// +Процедура ПриРегистрацииДоверенности(Доверенность) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОВызовСервера.ПриРегистрацииДоверенности(Доверенность) +``` +
+ +## ПриОпределенииНастроек +
+ +Описание, пример вызова + +```bsl + +// Настройки формы списка для реестра ФТС справочника "МашиночитаемыеДоверенности", +// описание см. МашиночитаемыеДоверенностиФНСПереопределяемый.ПриОпределенииНастроек +// +Процедура ПриОпределенииНастроек(Настройки) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОВызовСервера.ПриОпределенииНастроек(Настройки) +``` +
+ +## ПриПолученииСтатусов +
+ +Описание, пример вызова + +```bsl + +// Получение статусов для реестра ФТС справочника "МашиночитаемыеДоверенности", +// описание см. МашиночитаемыеДоверенностиФНСПереопределяемый.ПриПолученииСтатусов +// +Процедура ПриПолученииСтатусов(Доверенности, Статусы) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОВызовСервера.ПриПолученииСтатусов(Доверенности, Статусы) +``` +
+ +## ИспользуетсяОбменаПоСЭДОЧерезОператора +
+ +Описание, пример вызова + +```bsl + +// Получение флага обмена по СЭДО через оператора. Флаг возвращается установленным, если есть учетная запись +// Калуга Астрал, в ней подключен обмен с СФР в части отчетности бывшего ФСС, лицензия не истекла, а также событие, +// опубликованное через интернет, разрешает обмен через оператора, в настройках обмена с СФР (бывш. ФСС) +// скрытый флажок обмена напрямую не установлен. +// Параметры: +// Организация - СправочникСсылка.Организация. +// +// Возвращаемое значение: +// Булево. +// +Функция ИспользуетсяОбменаПоСЭДОЧерезОператора(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.ИспользуетсяОбменаПоСЭДОЧерезОператора(Организация) +``` +
+ +## УчетнаяЗаписьОрганизации +
+ +Описание, пример вызова + +```bsl + +// Получение учетной записи. +// Параметры: +// Организация - СправочникСсылка.Организация. +// ДопустимыеОператоры - Массив. +// +// Возвращаемое значение: +// СправочникСсылка.УчетныеЗаписиДокументооборота. +// +Функция УчетнаяЗаписьОрганизации(Организация, ДопустимыеОператоры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОВызовСервера.УчетнаяЗаписьОрганизации(Организация, ДопустимыеОператоры); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтерфейсыВзаимодействияБРОКлиент.md b/src/content/docs/zup/ИнтерфейсыВзаимодействияБРОКлиент.md new file mode 100644 index 0000000..a59888c --- /dev/null +++ b/src/content/docs/zup/ИнтерфейсыВзаимодействияБРОКлиент.md @@ -0,0 +1,519 @@ +--- +title: Интерфейсы взаимодействия БРО клиент +slug: zup/интерфейсы-взаимодействия-бро-клиент +--- + + +## ОтправитьОтчеты +
+ +Описание, пример вызова + +```bsl + +// Групповая отправка отчетов +// +// Параметры: +// ВыполняемоеОповещение - ОписаниеОповещения - описание оповещения, вызываемого после завершения отправки. +// Ссылки - Массив - Массив ссылок на рег. отчеты. +// +Процедура ОтправитьОтчеты(ВыполняемоеОповещение, Ссылки) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ОтправитьОтчеты(ВыполняемоеОповещение, Ссылки) +``` +
+ +## СформироватьИСохранитьНаДискФайлЗапросаВФНСНаПроверкуСведенийРаботников +
+ +Описание, пример вызова + +```bsl + +// Процедура создает и записывает на диск файл(-ы) для представления в налоговую инспекцию +// запроса работодателя на проверку ИНН, ФИО, СНИЛС работающих лиц в электронной форме. +// +// Параметры: +// СтруктураПараметров - Структура - варианты свойств: +// Вариант 1: +// * Организация - СправочникСсылка.Организации - организация, по работникам +// которой будут формироваться сведения для файла; +// * ДатаПодписи - Дата - дата, на которую будут формироваться сведения для файла; +// * РазмерПачки - Число - допустимое количество физических лиц в одном файле +// (необязательный параметр, по умолчанию допустимое количество равно 200; +// в случае превышения, будет записано необходимое количество файлов). +// Вариант 2: +// * РасчетПоСтраховымВзносам - ДокументСсылка.РегламентированныйОтчет - документ, +// по данным которого будут формироваться сведения для файла; +// * РазмерПачки - Число - допустимое количество физических лиц в одном файле +// (необязательный параметр, по умолчанию допустимое количество равно 200; +// в случае превышения, будет записано необходимое количество файлов). +// +Процедура СформироватьИСохранитьНаДискФайлЗапросаВФНСНаПроверкуСведенийРаботников(СтруктураПараметров) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.СформироватьИСохранитьНаДискФайлЗапросаВФНСНаПроверкуСведенийРаботников(СтруктураПараметров) +``` +
+ +## ИзменитьСтатусОтправки +
+ +Описание, пример вызова + +```bsl + +// Процедура предназначена для установки вручную статуса отправки из экранных форм объектов, +// отображаемых на закладке "Отчеты" формы "1С-Отчетность", путем выбора значения из выпадающего списка. +// +// Параметры: +// ПараметрыИзменения - Структура со свойствами: +// "Форма" - ФормаКлиентскогоПриложения - форма регл. отчета или уведомления о спецрежимах налогообложения; +// "Организация" - СправочникСсылка.Организации - организация; +// "КонтролирующийОрган" - Перечисление.ТипыКонтролирующихОрганов - контролирующий орган; +// "ТекстВопроса" (необязательный) - Строка - текст предупреждения при попытке установить статус "Сдано". +// +Процедура ИзменитьСтатусОтправки(ПараметрыИзменения) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ИзменитьСтатусОтправки(ПараметрыИзменения) +``` +
+ +## ПоказатьУведомлениеОбИзмененииОКТМО46 +
+ +Описание, пример вызова + +```bsl + +// Показывает организациям из Московской области уведомление об изменении ОКТМО в 2018 году. +// +// Параметры: +// Организация - СправочникСсылка.Организации - ссылка на организацию для которой нужно вывести уведомление. +// ОповещениеПродолжения - ОписаниеОповещения - описание оповещения, вызываемого после закрытия формы. +// +Процедура ПоказатьУведомлениеОбИзмененииОКТМО46(Организация, ОповещениеПродолжения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ПоказатьУведомлениеОбИзмененииОКТМО46(Организация, ОповещениеПродолжения); +``` +
+ +## ПолучитьПроцедурыДекларированияФТС +
+ +Описание, пример вызова + +```bsl + +// Возвращает процедуры таможенного декларирования на сайте ФТС edata.customs.ru, +// при необходимости, запрашивает логин и пароль портала ФТС и может запомнить их в 1С-Отчетности. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - структура дополнительных параметров получения при РежимыРаботы.ТолькоПолучитьНастройки = Истина, +// включает элементы "ПараметрыОтправки" и "ПараметрыСоединения" для вызова функции +// "ИнтерфейсыВзаимодействияБРОВызовСервера.ПолучитьПроцедурыДекларированияФТСССервера", иначе Массив: +// * РегистрационныйНомер - Строка - пример: "10013160/160620/0302033", "null" - не задан +// (для выпущенных и зарегистрированных ДТ всегда задан) +// * ДатаСоздания - Строка - пример: "2020-06-16T17:26:16"; +// * ТипПроцедуры - Строка - пример: "ЭК 10", "ИМ 40", число кода процедуры согласно классификатору +// в решении Комиссии Таможенного союза от 20.09.2010 N 378 +// (ред. от 21.04.2020) "О классификаторах, используемых для заполнения +// таможенных документов", приложении 1 +// HTTP://www.consultant.ru/document/cons_doc_LAW_105110/ec01d1f8f765126d090770e15d2f714e88c4bc67/ +// * Статус - Строка - пример: "10", у старых ДТ пустая строка; классификатор статусов +// есть в решении Комиссии Таможенного союза от 20.09.2010 N 378 +// (ред. от 21.04.2020) "О классификаторах, используемых для заполнения +// таможенных документов", приложении 14 +// HTTP://www.consultant.ru/document/cons_doc_LAW_105110/6b14436828c8d727b30feb8feaf7b8f9585b03cd/ +// Только для РежимПолучения = "": +// * Примечание - Строка. +// Только для РежимПолучения = "ВыпущенныеДТ": +// * ВсегоТоваровМест - Строка - пример: "3/2" +// * ОбщаяСтоимость - Строка - пример: "8 620 403,79 RUB" +// * ДатаРешения - Строка - пример: "16.06.2020" +// * Отправитель - Строка - пример: ""MICROSOFT IRELAND OPERATIONS LTD" СО СКЛАДА "TEST" ИНН КПП " +// * Получатель - Строка - пример: "ООО "Тест" ИНН 9620030509 КПП 962001001" +// * СтранаОтправления - Строка - пример: "НИДЕРЛАНДЫ" +// * СтранаНазначения - Строка - пример: "РОССИЯ" +// * СтранаПроисхождения - Строка - пример: "РАЗНЫЕ", "КИТАЙ" +// * ОтветственныйЗаФинУрегулирование - Строка - пример: "ООО "Тест" ИНН 9620030509 КПП 962001001" (при импорте) +// * Идентификатор - Строка - пример: "f9c0e49e-f5b8-3e27-b9b4-84fdf001985c" +// * ПроцедураВЛК - Строка - пример: "null" +// * ДатаРегистрации - Строка - пример: "2020-06-16T00:00:00" +// * КодРегистрации - Строка - пример: "10015160" +// * ПорядковыйНомер - Строка - пример: "0305033" +// * Декларант - Строка - пример: "ООО "Тест" ИНН 9620030509 КПП 962001001" +// * ИмяОтправителя - Строка - пример: ""MICROSOFT IRELAND OPERATIONS LTD" СО СКЛАДА "TEST"" +// * ИмяПолучателя - Строка - пример: "ООО "Тест"" +// * Модель - Строка - пример: "AUDRequest" +// * ИмяСтатуса - Строка - пример: "Saved" +// * Версия - Строка - пример: "4.2.0/1.0.0" +// Организация - СправочникСсылка.Организации - ссылка на организацию, +// настройки обмена с ФТС которой используются. +// РежимПолучения - Строка - "ВыпущенныеДТ" для выпущенных и зарегистриорванных деклараций на товары, +// примеры результатов приведены для этого варианта; +// - "" для заводимых вручную в личном кабинете ФТС процедур декларирования. +// Отборы - Структура с необязательными свойствами, по которым выполняется отбор, если свойства присутствуют, заданы: +// * ТипПроцедуры - Строка - "ЭК" - экспорт, "ИМ" - импорт; +// * ДатаРешенияС - Дата; +// * ДатаРешенияПо - Дата; +// * РегистрационныйНомер - Строка. +// РежимыРаботы - Неопределено или Структура, в которой могут быть элементы: +// * ТолькоПолучитьНастройки - Булево - по умолчанию Ложь, только получение или ввод параметров +// настройки; +// * ПовторятьЗапросПароляПриОшибке - Булево - по умолчанию Истина, в том числе учитывается в процедуре +// "ОбработатьРезультатыПолученияПроцедурДекларированияФТС"; +// * ПоказыватьДиалогПриОшибкеДоступаВИнтернет - Булево - по умолчанию Истина, в том числе учитывается в процедуре +// "ОбработатьРезультатыПолученияПроцедурДекларированияФТС". +// +Процедура ПолучитьПроцедурыДекларированияФТС( Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ПолучитьПроцедурыДекларированияФТС(); +``` +
+ +## ОбработатьРезультатыПолученияПроцедурДекларированияФТС +
+ +Описание, пример вызова + +```bsl + +// Обрабатывает результаты получения процедур таможенного декларирования товаров с сайта ФТС. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - при незаданном оповещении "ОповещениеОПолученииНастроек" принимает результат вместо него, +// а также принимает Массив с полученными таможенными декларациями, формат описан в оповещении +// процедуры "ПолучитьПроцедурыДекларированияФТС". +// ПроцедурыДекларирования - Неопределено или Массив процедур декларирования, результат функции +// "ИнтерфейсыВзаимодействияБРОВызовСервера.ПолучитьПроцедурыДекларированияФТСССервера". +// ДополнительныеПараметрыПолучения - Структура - результат вызова процедуры "ПолучитьПроцедурыДекларированияФТС" +// при РежимыРаботы.ТолькоПолучитьНастройки = Истина, +// возвращает результаты в оповещение, заданное этой процедурой. +// ОповещениеОПолученииНастроек - ОписаниеОповещения - описание процедуры, принимающей результат получения настроек, +// при незаданном значении вызывается "ОповещениеОЗавершении". +// Результат - структура дополнительных параметров получения при РежимыРаботы.ТолькоПолучитьНастройки = Истина +// вызова процедуры "ПолучитьПроцедурыДекларированияФТС" в случае повтора попытки соединения +// или ввоза пароля. +// +Процедура ОбработатьРезультатыПолученияПроцедурДекларированияФТС( Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ОбработатьРезультатыПолученияПроцедурДекларированияФТС(); +``` +
+ +## ЗапроситьВыпискуОперацийПоРасчетуСБюджетом +
+ +Описание, пример вызова + +```bsl + +Процедура ЗапроситьВыпискуОперацийПоРасчетуСБюджетом(ОповещениеОЗавершении, Организация, РегистрацияВНалоговомОргане, Год) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ЗапроситьВыпискуОперацийПоРасчетуСБюджетом(ОповещениеОЗавершении, Организация, РегистрацияВНалоговомОргане, Год) +``` +
+ +## ПодписатьФайлXMLDSig +
+ +Описание, пример вызова + +```bsl + +// Подписать файл XML в формате XMLDSig сертификатом учетной записи документообороат или заданным явно, +// по умолчанию в формате, используемом для СЗВ-ТД. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Строка - адрес временного хранилища с двоичными данными подписанного файла, +// Неопределено - при ошибке. +// ОрганизацияИлиСертификат - СправочникСсылка.Организации или +// СправочникСсылка.УчетныеЗаписиДокументооборота или, +// Строка - отпечаток сертификата или, +// Структура - структура свойств сертификата в формате +// "КриптографияЭДКОКлиент.НайтиСертификат". +// АдресДанных - Строка - адрес временного хранилища с двоичными данными файла, который нужно +// подписать. +// НастройкиПодписи - Неопределено - при незаданном значении используются настройки для подписи СЗВ-ТД, +// Структура - может передавать специфические настройки подписи, в формате, используемом +// в обработке "ДокументооборотСКонтролирующимиОрганами" +// форме "КонтейнерКлиентскихМетодов" у процедуры "ПодписатьФайлXMLDSig". +// +Процедура ПодписатьФайлXMLDSig( Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ПодписатьФайлXMLDSig(); +``` +
+ +## СформироватьПакетПоЕГРЮЛ +
+ +Описание, пример вызова + +```bsl + +// Объединяет сканы в многостраничные tif-документы, затем подписывает их и формирует пакет для ФНС. +// +// Параметры: +// Параметры - Структура - описание см в методе ПараметрыМетодаСформироватьПакетПоЕГРЮЛ +// +Процедура СформироватьПакетПоЕГРЮЛ(Параметры) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.СформироватьПакетПоЕГРЮЛ(Параметры) +``` +
+ +## ПараметрыМетодаСформироватьПакетПоЕГРЮЛ +
+ +Описание, пример вызова + +```bsl + +// Описание параметров для метода СформироватьПакетПоЕГРЮЛ +// +// Параметры: +// ОповещениеОЗавершении - ОповещениеОповещения - в данную процедуру будет передан результат: +// Структура: +// * Выполнено - Булево +// * Адрес - Строка - Адрес во временном хранилище, в котором содержатся двоичные данные пакета. +// Неопределено, если Выполнено Ложь. +// * ИмяПакета - Строка - Имя файла архива. Неопределено, если Выполнено Ложь. +// * ТекстИнформации - Строка +// * ОтправкаСсылка - СправочникСсылка.ОтправкиРегистрацияЮЛ +// * ТипОшибки - Число +// или +// Неопределено - в случае если пользователь нажал Отменить в форме выбора сертификата +// или в форме ввода пароля для облачного сертификата +// Заявление - ДокументСсылка.УведомлениеОСпецрежимахНалогообложения +// КодНО - Строка(4) - код налогового органа, в который будет подаваться заявление +// ОписаниеФайлов - Массив структур - содержит структуры с описанием приложенных сканов: +// * ВидДокумента - Перечисление.ВидыДокументовДляЭлГосРегистрации - вид документа +// * АдресаФайлов - Массив - Массив адресов сканов во временном хранилище, содержащих двоичные +// данные файлов. Последовательность адресов в массиве будет определять последовательность +// листов в итоговом tif. Разрешены следующие форматы сканов - BMP, GIF, JPEG, PNG, TIFF. +// * ТипыСодержимогоЗаявления - Перечисления.ТипыСодержимогоФайлов.XML, если заявление в формате XML, +// отсутствует или пустое в остальных случаях +// СпособПредоставленияОтвета - Перечисление.СпособыОтветаНаЭлГосРегистрацию - Способ получения ответа от ФНС +// ЭлПочтаЗаявителя - Строка - электронная почта заявителя +// ИННЗаявителя - Строка(12) - ИНН физ.лица заявителя. Пустая строка или строка из 12 нулей, если ИНН отсутствует +// ПодписатьПакет - Булево - показать кнопку "Подписать" на форме +// ОтправитьПакет - Булево - показать кнопку "Подписать и отправить" на форме +// ВыводитьСообщения - Булево - выводить сообщения пользователю об статусе отправки или формирования пакета +// +Функция ПараметрыМетодаСформироватьПакетПоЕГРЮЛ() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиент.ПараметрыМетодаСформироватьПакетПоЕГРЮЛ() +``` +
+ +## СоздатьПисьмо +
+ +Описание, пример вызова + +```bsl + +// Открыть форму отправки письма в контролирующие органы +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - владелец, +// Организация - Справочники.ОрганизацияСсылка, +// КонтролирующийОрган - Строка - "ФНС", "ПФР" или "ФСГС", +// КодКонтролирующегоОргана - Строка - при незаполненном значении подставляется из свойств организации, +// Тема - Строка - при незаполненном значении берется из имени первого вложения, +// Вложения - СписокЗначений - значение задает адрес во временном хранилище двоичных данных вложения, представление задает имя файла вложения, +// ДополнительныеРеквизиты - Структура: +// * Содержание - Строка - необязательный ключ, при незаполненном значении берется тема, +// * Комментарий - Строка - необязательный ключ, +// * Категория - Строка - необязательный ключ, определяется автоматически по имени вложения. +// +Процедура СоздатьПисьмо( Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.СоздатьПисьмо(); +``` +
+ +## ОсуществитьОбменПоОрганизациям +
+ +Описание, пример вызова + +```bsl + +// Осуществляет обмен с получением входящих документов, получением и отправкой ответных квитанций. +// Для проверки, что обмен с контролирующим органом доступен у организации, можно использовать вызов вида: +// ИнтерфейсыВзаимодействияБРО.ПодключенДокументооборотСКонтролирующимОрганом(Организация, КонтролирующийОрган, Ложь) +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - вызывающая форма, при значении Неопределено используется +// встроенная скрытая форма, форма может использоваться как владелец окон, при получении +// уникальных идентификаторов. +// Организации - СправочникСсылка.Организация или их Массив - при значении Неопределено обмен +// осуществляется по учетным записям документооборота всех организаций, кроме +// помеченных на удаление. +// ВыполняемоеОповещение - ОписаниеОповещения - описание необязательного оповещения, вызываемого после +// завершения обмена, при этом на экране может быть отображен диалог с результатами обмена. +// КонтролирующийОрган - Строка - если гос. орган задан, обмен, по возможности, выполняется только с ним, +// примеры: "ФНС", "ПФР", "ФСГС", "ФСС", "ФСРАР", "РПН", "ФТС", "БанкРоссии". +// СсылкаНаОтправляемыйОбъект - ДокументСсылка, СправочникСсылка - ссылка на отчет, если нужно обновить состояние +// только этого отчета. +// +Процедура ОсуществитьОбменПоОрганизациям( Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ОсуществитьОбменПоОрганизациям(); +``` +
+ +## НастройкиОбменаОрганизаций +
+ +Описание, пример вызова + +```bsl + +// Получение настроек обмена, свойств сертификата. Описание вызова см. в одноименной процедуре +// обработки "ДокументооборотСКонтролирующимиОрганами", формы "КонтейнерКлиентскихМетодов". +// +// Пример вызова: +// ИнтерфейсыВзаимодействияБРОКлиент.НастройкиОбменаОрганизаций(Оповещение, Организация); +// +// Пример обработки результата оповещения: +// Если Результат <> Неопределено И Результат.НастройкиОбмена[0].СвойстваСертификатаРуководителя <> Неопределено Тогда +// СвойстваСубъекта = КриптографияЭДКОКлиентСервер.РазобратьСтрокуСубъекта( +// Результат.НастройкиОбмена[0].СвойстваСертификатаРуководителя.Владелец); +// ФИО = СокрЛП(СвойстваСубъекта["SN"] + " " + СвойстваСубъекта["GN"]); +// Иначе +// ФИО = ""; +// КонецЕсли; +Процедура НастройкиОбменаОрганизаций( Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.НастройкиОбменаОрганизаций(); +``` +
+ +## ПриНачалеПодписания +
+ +Описание, пример вызова + +```bsl + +// При подписи доверенности справочника "МашиночитаемыеДоверенности", +// описание см. МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриНачалеПодписания +// +Процедура ПриНачалеПодписания(Организации, Файл, Полномочия, Оповещение, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ПриНачалеПодписания(Организации, Файл, Полномочия, Оповещение, СтандартнаяОбработка) +``` +
+ +## ПриОбработкеНавигационнойСсылки +
+ +Описание, пример вызова + +```bsl + +// При обработке навигационной ссылки доверенности справочника "МашиночитаемыеДоверенности", +// описание см. МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриОбработкеНавигационнойСсылки +// +Процедура ПриОбработкеНавигационнойСсылки( Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ПриОбработкеНавигационнойСсылки(); +``` +
+ +## ПриИзмененииСтатусаДоверенности +
+ +Описание, пример вызова + +```bsl + +// При изменении статуса доверенности справочника "МашиночитаемыеДоверенности", +// описание см. МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриИзмененииСтатусаДоверенности +// +Процедура ПриИзмененииСтатусаДоверенности(СтатусыДоверенностей) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ПриИзмененииСтатусаДоверенности(СтатусыДоверенностей) +``` +
+ +## ПриРегистрацииДоверенности +
+ +Описание, пример вызова + +```bsl + +// При изменении статуса доверенности справочника "МашиночитаемыеДоверенности", +// описание см. МашиночитаемыеДоверенностиФНСКлиентПереопределяемый.ПриРегистрацииДоверенности +// +Процедура ПриРегистрацииДоверенности(Доверенность, СтандартнаяОбработка, ОбработчикЗавершения) Экспорт +``` + +Пример вызова +```bsl +ИнтерфейсыВзаимодействияБРОКлиент.ПриРегистрацииДоверенности(Доверенность, СтандартнаяОбработка, ОбработчикЗавершения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнтерфейсыВзаимодействияБРОКлиентСервер.md b/src/content/docs/zup/ИнтерфейсыВзаимодействияБРОКлиентСервер.md new file mode 100644 index 0000000..2312398 --- /dev/null +++ b/src/content/docs/zup/ИнтерфейсыВзаимодействияБРОКлиентСервер.md @@ -0,0 +1,440 @@ +--- +title: Интерфейсы взаимодействия БРО клиент сервер +slug: zup/интерфейсы-взаимодействия-бро-клиент-сервер +--- + + +## НачалоПериода +
+ +Описание, пример вызова + +```bsl + +// Возвращает начало периода даты. +// +// Параметры: +// Периодичность - Перечисление.Периодичность - периодичность. +// Дата - Дата - дата. +// +// Возвращаемое значение: +// Дата - начало периода даты. +// +Функция НачалоПериода(Периодичность, Дата) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.НачалоПериода(Периодичность, Дата) +``` +
+ +## КонецПериода +
+ +Описание, пример вызова + +```bsl + +// Возвращает конец периода. +// +Функция КонецПериода(Периодичность, Дата) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.КонецПериода(Периодичность, Дата) +``` +
+ +## ДобавитьПериод +
+ +Описание, пример вызова + +```bsl + +// Добавляет период. +// +Функция ДобавитьПериод(Знач Дата, Периодичность, Знач КоличествоПериодов = 1) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ДобавитьПериод(Дата, Периодичность, КоличествоПериодов); +``` +
+ +## ОперацииСРегламентированнымОтчетом +
+ +Описание, пример вызова + +```bsl + +// Возвращает операции регламентированного отчета с признаками их доступности. +// +// Параметры: +// ИмяОтчета - Строка - имя регламентированного отчета, например, "РегламентированныйОтчет4ФСС". +// ИмяФормы - Строка - имя формы регламентированного отчета, например, "ФормаОтчета2017Кв1". +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - операции с регламентированным отчетом. +// * АвтоФормированиеНаСервере - Булево - признак автоматического формирования отчета в тихом режиме на сервере. +// * ВыгрузкаНаСервере - Булево - признак выгрузки отчета в тихом режиме на сервере. +// * ПечатьСоШтрихкодомPDF417НаСервере - Булево - признак печати отчета со штрихкодом PDF417 в тихом режиме +// на сервере. +// * ПечатьБезШтрихкодаPDF417НаСервере - Булево - признак печати отчета без штрихкода PDF417 в тихом режиме +// на сервере. +// +Функция ОперацииСРегламентированнымОтчетом(ИмяОтчета, ИмяФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ОперацииСРегламентированнымОтчетом(ИмяОтчета, ИмяФормы) +``` +
+ +## ПоддерживаетсяФормированиеПакетаДляВнесенияИзмененийВЕГРЮЛ +
+ +Описание, пример вызова + +```bsl + +// Определяет, можно ли использовать функцинал формирования пакета для ФНС для внесения изменений в ЕГРЮЛ +// +// Возвращаемое значение: +// Булево - Истина, если можно использовать. +// +Функция ПоддерживаетсяФормированиеПакетаДляВнесенияИзмененийВЕГРЮЛ() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПоддерживаетсяФормированиеПакетаДляВнесенияИзмененийВЕГРЮЛ() +``` +
+ +## КлассификаторОшибокПакетаПоЕГРЮЛ +
+ +Описание, пример вызова + +```bsl + +// Содержит реестр ошибок возникающие во время формирования пакет для для внесения изменений в ЕГРЮЛ. +// Используется в поле "ТипОшибки" в возвращаемом значении функции ПараметрыМетодаСформироватьПакетПоЕГРЮЛ. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура +// +Функция КлассификаторОшибокПакетаПоЕГРЮЛ() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.КлассификаторОшибокПакетаПоЕГРЮЛ() +``` +
+ +## СтатусСданоСтрокой +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Процедуры и функции интерфейса взаимодействия с сервисом "Список задач +// бухгалтера". + +// Определяет строковой статус объекта регламентированной отчетности, +// предназначенный для интерактивного изменения пользователем, +// соответствующий финальному статусу. +// +// Возвращаемое значение: +// Строка - строковое представление статуса, предназначенное для программной обработки. +// +Функция СтатусСданоСтрокой() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.СтатусСданоСтрокой() +``` +
+ +## СтатусВРаботеСтрокой +
+ +Описание, пример вызова + +```bsl + +// Определяет строковой статус объекта регламентированной отчетности, +// предназначенный для интерактивного изменения пользователем, +// соответствующий статусу отчета, находящегося в процессе подготовки. +// +// Возвращаемое значение: +// Строка - строковое представление статуса, предназначенное для программной обработки. +// +Функция СтатусВРаботеСтрокой() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.СтатусВРаботеСтрокой() +``` +
+ +## СтатусПодготовленоСтрокой +
+ +Описание, пример вызова + +```bsl + +// Определяет строковый статус объекта регламентированной отчетности, +// предназначенный для интерактивного изменения пользователем, +// соответствующий статусу подготовленной отчетности. +// +// Возвращаемое значение: +// Строка - строковое представление статуса, предназначенное для программной обработки. +// +Функция СтатусПодготовленоСтрокой() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.СтатусПодготовленоСтрокой() +``` +
+ +## ПредставлениеСтатусаНеОтправлено +
+ +Описание, пример вызова + +```bsl + +// Пользовательское представление статуса объекта регламентированной отчетности, +// соответствующего статусу по умолчанию. +// +// Возвращаемое значение: +// Строка - строковое представление статуса пользователю. +// +Функция ПредставлениеСтатусаНеОтправлено() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПредставлениеСтатусаНеОтправлено() +``` +
+ +## ПредставлениеСтатусаСдано +
+ +Описание, пример вызова + +```bsl + +// Пользовательское представление строкового статуса объекта регламентированной отчетности, +// предназначенного для интерактивного изменения пользователем, +// соответствующего финальному статусу. +// +// Возвращаемое значение: +// Строка - строковое представление статуса пользователю. +// +Функция ПредставлениеСтатусаСдано() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПредставлениеСтатусаСдано() +``` +
+ +## ПредставлениеСтатусаВРаботе +
+ +Описание, пример вызова + +```bsl + +// Пользовательское представление строкового статуса объекта регламентированной отчетности, +// предназначенного для интерактивного изменения пользователем, +// соответствующего статусу отчета, находящегося в процессе подготовки. +// +// Возвращаемое значение: +// Строка - строковое представление статуса пользователю. +// +Функция ПредставлениеСтатусаВРаботе() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПредставлениеСтатусаВРаботе() +``` +
+ +## ПредставлениеСтатусаПодготовлено +
+ +Описание, пример вызова + +```bsl + +// Пользовательское представление строкового статуса объекта регламентированной отчетности, +// предназначенного для интерактивного изменения пользователем, +// соответствующего статусу подготовленной отчетности. +// +// Возвращаемое значение: +// Строка - строковое представление статуса пользователю. +// +Функция ПредставлениеСтатусаПодготовлено() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПредставлениеСтатусаПодготовлено() +``` +
+ +## НовыйСостояниеДокумента +
+ +Описание, пример вызова + +```bsl + +// Конструктор коллекции со сведениями о состоянии передачи в учреждение отчета или иного документа +// - при передаче в электронном виде - состояние отправки; +// - при передаче иным способом - статус, установленный пользователем. +// +// Возвращаемое значение: +// Структура +// * Представление - Строка - представление состояния передачи в учреждение. +// * Статус - Строка - строковый статус объекта регламентированной отчетности. +// * Сдано - Булево - Истина, если отчет сдан любым способом. +// * Отправлено - Булево - Истина, если отчет отправлен в учреждение в электронном виде. +// * ВРаботе - Булево - Истина, если отчет редактируется и еще не отправлен в учреждение. +// +Функция НовыйСостояниеДокумента() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.НовыйСостояниеДокумента() +``` +
+ +## ВозможнаОтправкаЭлектронногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Определяет, возможна ли отправка отчета в учреждение в виде электронного документа. +// +// Параметры: +// ИмяОтчета - Строка - Имя отчета (элемента метаданных). +// +// Возвращаемое значение: +// Булево - Истина, если отчет может быть отправлен в электронном виде. +// +Функция ВозможнаОтправкаЭлектронногоДокумента(ИмяОтчета) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ВозможнаОтправкаЭлектронногоДокумента(ИмяОтчета) +``` +
+ +## ОтчетыОтправкаОграничена +
+ +Описание, пример вызова + +```bsl + +// Определяет перечень отчетов, отправка которых в учреждение невозможна в виде электронного документа. +// +// В список включены отчеты, из форм которых не вызывается +// ОнлайнСервисыРегламентированнойОтчетностиКлиент.ПередОтправкойРегламентированногоОтчета() +// +// Внимание! +// При изменении содержимого этого перечня регламентированных отчетов в конфигурации-потребителе +// БРО при обновлении но новую версию необходимо выполнить специальный обработчик обновления, +// который должен выполняться каждый раз при изменени содержимого этого перечня. +// +// Возвращаемое значение: +// ФиксированныйМассив - имена отчетов (элементов метаданных). +// +Функция ОтчетыОтправкаОграничена() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ОтчетыОтправкаОграничена() +``` +
+ +## ПредставлениеПолучателяБумажногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Определяет краткое наименование государственного органа - получателя документа, который невозможно отправить ему в электронном виде. +// Следует использовать для отчетов, для которых ВозможнаОтправкаЭлектронногоДокумента() = Ложь. +// +// Параметры: +// ИмяОтчета - Строка - Имя отчета (элемента метаданных). +// +// Возвращаемое значение: +// Строка - представление гос. органа; пустая строка, если неизвестно. +// +Функция ПредставлениеПолучателяБумажногоДокумента(ИмяОтчета) Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПредставлениеПолучателяБумажногоДокумента(ИмяОтчета) +``` +
+ +## КраткоеПредставлениеОграниченияОтправкиОтчета +
+ +Описание, пример вызова + +```bsl + +// Определяет текст для пользователя, кратко, в несколько слов описывающий суть ограничения отправки отчета. +// Такой текст выводится в дополнение к названию отчета и т.п. +// +// Возвращаемое значение: +// Строка - краткое представление ограничения отправки отчета для пользователя. +// +Функция КраткоеПредставлениеОграниченияОтправкиОтчета() Экспорт +``` + +Пример вызова +```bsl +Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.КраткоеПредставлениеОграниченияОтправкиОтчета() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ИнформированиеПользователяКлиент.md b/src/content/docs/zup/ИнформированиеПользователяКлиент.md new file mode 100644 index 0000000..30879eb --- /dev/null +++ b/src/content/docs/zup/ИнформированиеПользователяКлиент.md @@ -0,0 +1,62 @@ +--- +title: Информирование пользователя клиент +slug: zup/информирование-пользователя-клиент +--- + + +## Предупредить +
+ +Описание, пример вызова + +```bsl + +// Выводит предупреждение с кратким текстом и кнопкой для просмотра подробных сведений. +// +// Параметры: +// КраткийТекст - Строка - Текст предупреждения. +// ПодробныйТекст - Строка - Подробный текст, который выводится по нажатию на кнопку "Подробнее". +// Если не указан, то кнопка для просмотра подробных сведений тоже не выводится. +// Заголовок - Строка - Заголовок предупреждения. +// Если не указан, то выводится стандартный заголовок предупреждений 1С:Предприятия. +// Картинка - Картинка - Картинка диалога. +// +Процедура Предупредить(КраткийТекст, ПодробныйТекст = "", Заголовок = "", Картинка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнформированиеПользователяКлиент.Предупредить(КраткийТекст, ПодробныйТекст, Заголовок, Картинка); +``` +
+ +## ПоказатьПодробности +
+ +Описание, пример вызова + +```bsl + +// Выводит многострочный текст с возможностью копирования в буфер обмена. +// +// Параметры: +// ПодробныйТекст - Строка - Текст для отображения. +// Заголовок - Строка - Заголовок диалога. +// Картинка - Картинка - Картинка диалога. +// +Процедура ПоказатьПодробности(ПодробныйТекст, Заголовок = "", Картинка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ИнформированиеПользователяКлиент.ПоказатьПодробности(ПодробныйТекст, Заголовок, Картинка); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КабинетСотрудника.md b/src/content/docs/zup/КабинетСотрудника.md new file mode 100644 index 0000000..8166c60 --- /dev/null +++ b/src/content/docs/zup/КабинетСотрудника.md @@ -0,0 +1,68 @@ +--- +title: Кабинет сотрудника +slug: zup/кабинет-сотрудника +--- + + +## ЗарегистрироватьОбработчикиОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +Процедура ЗарегистрироватьОбработчикиОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +КабинетСотрудника.ЗарегистрироватьОбработчикиОбновления(Обработчики) +``` +
+ +## ПриЗаполненииВидовОграниченийПравОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступомПереопределяемый.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных. +Процедура ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) Экспорт +``` + +Пример вызова +```bsl +КабинетСотрудника.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) +``` +
+ +## ВерсияФормата +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую версию формата обмена. +// +// Возвращаемое значение: +// Строка - строка формата х.х +// +Функция ВерсияФормата() Экспорт +``` + +Пример вызова +```bsl +Результат = КабинетСотрудника.ВерсияФормата() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КабинетСотрудникаПереопределяемый.md b/src/content/docs/zup/КабинетСотрудникаПереопределяемый.md new file mode 100644 index 0000000..c741a5a --- /dev/null +++ b/src/content/docs/zup/КабинетСотрудникаПереопределяемый.md @@ -0,0 +1,38 @@ +--- +title: Кабинет сотрудника переопределяемый +slug: zup/кабинет-сотрудника-переопределяемый +--- + + +## ДополнитьВидыМестВыплатыРегистраторов +
+ +Описание, пример вызова + +```bsl + +// Дополняет соответствие ВидыМестВыплатыРегистраторов сведениями о виде места выплаты зарплаты по переданным документам. +// +// Параметры: +// ВидыМестВыплатыРегистраторов - Соответствие - дополняется видом места выплаты документов, +// переданных в параметре РегистраторыВыплат +// * Ключ - ДокументСсылка +// * Значение - ПеречислениеСсылка.ВидыМестВыплатыЗарплаты. +// РегистраторыВыплат - Массив - ссылки на документы, для которых необходимо определить вид места выплаты зарплаты. +// +Процедура ДополнитьВидыМестВыплатыРегистраторов(ВидыМестВыплатыРегистраторов, РегистраторыВыплат) Экспорт +``` + +Пример вызова +```bsl +КабинетСотрудникаПереопределяемый.ДополнитьВидыМестВыплатыРегистраторов(ВидыМестВыплатыРегистраторов, РегистраторыВыплат) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КабинетСотрудникаПовтИсп.md b/src/content/docs/zup/КабинетСотрудникаПовтИсп.md new file mode 100644 index 0000000..babaddd --- /dev/null +++ b/src/content/docs/zup/КабинетСотрудникаПовтИсп.md @@ -0,0 +1,29 @@ +--- +title: Кабинет сотрудника повт исп +slug: zup/кабинет-сотрудника-повт-исп +--- + + +## ОписаниеКлиентскогоПриложения +
+ +Описание, пример вызова + +```bsl + +Функция ОписаниеКлиентскогоПриложения() Экспорт +``` + +Пример вызова +```bsl +Результат = КабинетСотрудникаПовтИсп.ОписаниеКлиентскогоПриложения() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КабинетСотрудникаРасширенный.md b/src/content/docs/zup/КабинетСотрудникаРасширенный.md new file mode 100644 index 0000000..7837ac3 --- /dev/null +++ b/src/content/docs/zup/КабинетСотрудникаРасширенный.md @@ -0,0 +1,30 @@ +--- +title: Кабинет сотрудника расширенный +slug: zup/кабинет-сотрудника-расширенный +--- + + +## ЗарегистрироватьОбработчикиОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +Процедура ЗарегистрироватьОбработчикиОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +КабинетСотрудникаРасширенный.ЗарегистрироватьОбработчикиОбновления(Обработчики) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КабинетСотрудникаРасширенныйПереопределяемый.md b/src/content/docs/zup/КабинетСотрудникаРасширенныйПереопределяемый.md new file mode 100644 index 0000000..319ef8e --- /dev/null +++ b/src/content/docs/zup/КабинетСотрудникаРасширенныйПереопределяемый.md @@ -0,0 +1,38 @@ +--- +title: Кабинет сотрудника расширенный переопределяемый +slug: zup/кабинет-сотрудника-расширенный-переопределяемый +--- + + +## ЗаполнитьДанныеРуководителей +
+ +Описание, пример вызова + +```bsl + +// Получает сведения о руководителях подразделений предприятия и помещает их в параметр ДанныеРуководителей. +// +// Параметры: +// ДанныеРуководителей - Соответствие - заполняется руководителя подразделений. +// * Ключ - СправочникСсылка.СтруктураПредприятия +// * Значение - СправочникСсылка.ФизическоеЛицо. +// ПодразделенияПредприятия - Массив - содержит СправочникСсылка.СтруктураПредприятия, +// подразделения предприятия, по которым необходимо получить руководителей. +// +Процедура ЗаполнитьДанныеРуководителей(ДанныеРуководителей, ПодразделенияПредприятия) Экспорт +``` + +Пример вызова +```bsl +КабинетСотрудникаРасширенныйПереопределяемый.ЗаполнитьДанныеРуководителей(ДанныеРуководителей, ПодразделенияПредприятия) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйУчет.md b/src/content/docs/zup/КадровыйУчет.md new file mode 100644 index 0000000..9965e19 --- /dev/null +++ b/src/content/docs/zup/КадровыйУчет.md @@ -0,0 +1,721 @@ +--- +title: Кадровый учет +slug: zup/кадровый-учет +--- + + +## ЕстьДоговорыГПХ +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьДоговорыГПХ(ФизическоеЛицо, Организация = Неопределено, НачалоПериода = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.ЕстьДоговорыГПХ(ФизическоеЛицо, Организация, НачалоПериода); +``` +
+ +## КадровыеДанныеФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений заполненную данными физических лиц, перечисленными в +// параметре СписокНеобходимыхДанных. +// +// Параметры: +// ТолькоРазрешенные - Булево +// СписокФизическихЛиц - Массив ссылок на элементы справочника физические лица или +// СправочникСсылка.ФизическиеЛица. +// КадровыеДанные - Строка - список полей данных, перечисленных через запятую. +// - Массив строк с полями данных, которые необходимо получить. +// ДатаПолученияДанных - дата на которую необходимо получить данные физических лиц, +// применимо к данным, носящим периодический характер (например - ФИО). +// Если дату не указывать, будут получены самые последние данные. +// +// ПоляОтбораПериодическихДанных - Структура, в качестве ключа указывается имя таблицы, содержащей +// периодические данные (например ФИОФизическихЛиц, ГражданствоФизическихЛиц). +// В качестве значений коллекция условий отбора, +// соединяемых по "И" и применяемых к регистру сведений. +// Коллекция строки которой имеют поля. +// * ЛевоеЗначение - строка, имя поля регистра сведений. +// * ВидСравнения - строка, вид сравнения, допустимый в языке запросов. +// * ПравоеЗначение - значение для сравнения с полем ЛевоеЗначение. +// +// Список полей, допустимых в параметре КадровыеДанные см. КадровыйУчетВнутренний.ЗапросВТКадровыеДанныеФизическихЛиц. +// +// Возвращаемое значение: +// ТаблицаЗначений - Таблица значений, содержащая обязательные поля ФизическоеЛицо, Период поля запрошенных +// кадровых данных. +// +Функция КадровыеДанныеФизическихЛиц(ТолькоРазрешенные, СписокФизическихЛиц, КадровыеДанные, ДатаПолученияДанных = '00010101', ПоляОтбораПериодическихДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.КадровыеДанныеФизическихЛиц(ТолькоРазрешенные, СписокФизическихЛиц, КадровыеДанные, ДатаПолученияДанных, ПоляОтбораПериодическихДанных); +``` +
+ +## КадровыеДанныеСотрудников +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений заполненную данными сотрудников, перечисленными в +// параметре СписокНеобходимыхДанных. +// +// Параметры: +// ТолькоРазрешенные - Булево +// СписокСотрудников - Массив ссылок на элементы справочника сотрудники или +// СправочникСсылка.Сотрудники. +// КадровыеДанные - Строка - список полей данных, перечисленных через запятую +// или Массив строк с полями данных, которые необходимо получить. +// ДатаПолученияДанных - дата на которую необходимо получить данные сотрудников, +// применимо к данным, носящим периодический характер. +// Если дату не указывать, будут получены самые последние данные. +// +// +// ПоляОтбораПериодическихДанных - Структура, в качестве ключа указывается имя таблицы, содержащей +// периодические данные (например ФИОФизическихЛиц, ГражданствоФизическихЛиц). +// В качестве значений коллекция условий отбора, +// соединяемых по "И" и применяемых к регистру сведений. +// Коллекция строки которой имеют поля. +// * ЛевоеЗначение - строка, имя поля регистра сведений. +// * ВидСравнения - строка, вид сравнения, допустимый в языке запросов. +// * ПравоеЗначение - значение для сравнения с полем ЛевоеЗначение. +// +// Список полей, допустимых в параметре КадровыеДанные см. КадровыйУчетВнутренний.ЗапросВТКадровыеДанныеСотрудников. +// +// Возвращаемое значение: +// ТаблицаЗначений - Таблица значений, содержащая запрошенные данные. +// +Функция КадровыеДанныеСотрудников(ТолькоРазрешенные, СписокСотрудников, КадровыеДанные, ДатаПолученияДанных = '00010101', ПоляОтбораПериодическихДанных = Неопределено, ФормироватьСПериодичностьДень = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.КадровыеДанныеСотрудников(ТолькоРазрешенные, СписокСотрудников, КадровыеДанные, ДатаПолученияДанных, ПоляОтбораПериодическихДанных, ФормироватьСПериодичностьДень); +``` +
+ +## ФизическиеЛицаРаботавшиеВОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений заполненную физическими лицами, работавшими в организации в +// заданном периоде. +// +// Параметры: +// ТолькоРазрешенные - Булево +// Организация - СправочникСсылка.Организации - организация по которой необходимо отобрать работавших +// в ней физических лиц. +// НачалоПериода - Дата +// ОкончаниеПериода - Дата +// Подразделение - СправочникСсылка.ПодразделенияОрганизаций - подразделение, по которому необходимо отобрать +// работавших физических лиц. Если подразделение не указывать - будут отобраны физические +// лица по всей организации. +// +// Возвращаемое значение: +// ТаблицаЗначений - Таблица значений, содержащая поля Период (Дата, соответствует указанному параметру +// ОкончаниеПериода) и ФизическоеЛицо. +// +Функция ФизическиеЛицаРаботавшиеВОрганизации(ТолькоРазрешенные, Организация, НачалоПериода, ОкончаниеПериода, Подразделение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.ФизическиеЛицаРаботавшиеВОрганизации(ТолькоРазрешенные, Организация, НачалоПериода, ОкончаниеПериода, Подразделение); +``` +
+ +## ДокументыФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений заполненную данными документов физических лиц. +// +// Параметры: +// СписокФизическихЛиц - Массив ссылок на элементы справочника физические лица или +// СправочникСсылка.ФизическиеЛица. +// ТолькоРазрешенные - Булево +// ВидДокумента - СправочникСсылка.ВидыДокументовФизическихЛиц, вид необходимого +// документа. +// ДатаПолученияДанных - дата на которую необходимо получить данные документов физических лиц, +// если дату не указывать, данные будут получены на текущую дату. +// +// Возвращаемое значение: +// ТаблицаЗначений - Таблица значений, содержащая поля. +// Период - Дата +// ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// ВидДокумента - СправочникСсылка.ВидыДокументовФизическихЛиц +// Серия - Строка +// Номер - Строка +// ДатаВыдачи - Дата +// КемВыдан Строка +// КодПодразделения - Строка +// ЯвляетсяДокументомУдостоверяющимЛичность - Булево +// Представление - Строка +// +Функция ДокументыФизическихЛиц(СписокФизическихЛиц, ТолькоРазрешенные, ВидДокумента = Неопределено, ДатаПолученияДанных = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.ДокументыФизическихЛиц(СписокФизическихЛиц, ТолькоРазрешенные, ВидДокумента, ДатаПолученияДанных); +``` +
+ +## ПараметрыПолученияСотрудниковОрганизацийПоСпискуФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Различаются следующие подмножества сотрудников: +// * Сотрудники принятые только по трудовым договорам (1). +// * Сотрудники с которыми только заключен договор ГПХ (2). +// * Сотрудники принятые по трудовым договорам ИС которыми заключены договоры ГПХ (3). +// +// Для получения сотрудников используются параметры: +// * РаботникиПоТрудовымДоговорам. +// * РаботникиПоДоговорамГПХ. +// +// Поддерживаются следующие сочетания параметров: +// +// РаботникиПоТрудовымДоговорам = Истина +// РаботникиПоДоговорамГПХ = Ложь +// В выборку войдет только 1 подмножество сотрудников. +// +// РаботникиПоТрудовымДоговорам = Истина +// РаботникиПоДоговорамГПХ = Неопределено +// В выборку войдут 1 и 3 подмножества сотрудников. +// +// РаботникиПоТрудовымДоговорам = Истина +// РаботникиПоДоговорамГПХ = Истина +// В выборку войдут 1,2 и 3 подмножества сотрудников. +// +// РаботникиПоТрудовымДоговорам = Неопределено +// РаботникиПоДоговорамГПХ = Истина +// В выборку войдут 2 и 3 подмножества сотрудников. +// +// РаботникиПоТрудовымДоговорам = Ложь +// РаботникиПоДоговорамГПХ = Истина +// В выборку войдет только 2 подмножество сотрудников. +// +// РаботникиПоТрудовымДоговорам = Ложь +// РаботникиПоДоговорамГПХ = Ложь +// Сформирует пустую таблицу. +// +// При другом сочетании параметров будет вызвано исключение. +// +// Различаются следующие сочетания: +// РаботникиПоТрудовымДоговорам = Истина +// ПодработкиСотрудниковПоТрудовымДоговорам = Ложь +// В выборку попадут только головные сотрудники. +// +// РаботникиПоТрудовымДоговорам = Истина +// ПодработкиСотрудниковПоТрудовымДоговорам = Истина +// В выборку попадут как головные сотрудники, так и подработки. +// +// РаботникиПоТрудовымДоговорам = Неопределено +// ПодработкиСотрудниковПоТрудовымДоговорам = Истина +// В выборку попадут только подработки. +// +// При значении параметра РаботникиПоТрудовымДоговорам = Ложь, значение параметра +// ПодработкиСотрудниковПоТрудовымДоговорам игнорируется. Т.е. в выборку не попадут +// ни головные сотрудники ни подработки. +// +// При отборе подработок учитываются те же параметры отбора по периоду, организации +// и подразделению, что применяются для отбора головных сотрудников. + +// Возвращает структуру параметров для СоздатьВТСотрудникиОрганизаций. Позволяет формировать списки +// сотрудников с различными сочетаниями трудовых отношений. +// +// Возвращаемое значение: +// Структура - Содержит ключи: +// * Организация - СправочникСсылка.Организации, если параметр опустить в таблицу войдут все сотрудник +// независимо от организации. +// * ОтбиратьПоГоловнойОрганизации - если Истина, то отбор по головной организации, иначе по текущей организации. +// По умолчанию - ЛОЖЬ +// * Подразделение - СправочникСсылка.ПодразделенияОрганизаций, в таблицу войдут сотрудники указанного подразделения +// и всех подразделений, подчиненных указанному, если параметр опустить в таблицу войдут все сотрудники. +// * СписокФизическихЛиц - Массив ссылок на элементы справочника ФизическиеЛица, если параметр опустить, +// в таблицу войдут сотрудники всех физических лиц когда либо работавших в Организации. +// * НачалоПериода - Дата, значение по умолчанию '00010101'. Если параметр устанавливается, параметр ОкончаниеПериода +// обязателен к заполнению. +// * ОкончаниеПериода - Дата, значение по умолчанию '00010101'. При установке должно выполняться условие +// ОкончаниеПериода >= НачалоПериода. Используется для выборки кадровых данных сотрудников, если +// параметр не указан, выборка будет производиться на текущую дату сеанса. +// * КадровыеДанные - Строка, содержит список полей кадровых данных, см. описание к функции КадровыеДанныеСотрудников. +// См. описание параметра КадровыеДанные функции КадровыйУчетВнутренний.ЗапросВТКадровыеДанныеСотрудников. +// * Отборы - Массив, структур описывающих отборы сотрудников +// см. ЗарплатаКадрыОбщиеНаборыДанных.ДобавитьВКоллекциюОтбор, +// допустимые отборы описаны см. КритерииПоискаСотрудниковПоКоллекцииОтборов. +// * РаботникиПоТрудовымДоговорам - Булево, Неопределено (Истина - работник по ТД, Ложь - не работает по ТД +// Неопределено - неважно наличие ТД). +// * ПодработкиРаботниковПоТрудовымДоговорам - Булево. +// * РаботникиПоДоговорамГПХ - Булево, Неопределено (Истина - есть действующие договоры ГПХ, Ложь - нет +// действующих договоров ГПХ, Неопределено - неважно наличие действующего +// договора ГПХ). +// * ВыбрасыватьИсключениеДоступа - Булево, если Ложь будут проверяться право чтения к таблицам из которых +// получаются данные и если такого права нет - запросы выполняться не будут +// +Функция ПараметрыПолученияСотрудниковОрганизацийПоСпискуФизическихЛиц() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.ПараметрыПолученияСотрудниковОрганизацийПоСпискуФизическихЛиц() +``` +
+ +## ПараметрыПолученияВсехСотрудниковОрганизацийПоСпискуФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров для СоздатьВТСотрудникиОрганизаций. +// +// Возвращаемое значение: +// Структура - Содержит ключи: +// Организация - СправочникСсылка.Организации, если параметр опустить в таблицу войдут все сотрудник +// независимо от организации. +// ОтбиратьПоГоловнойОрганизации - если Истина, то отбор по головной организации, иначе по текущей организации. +// По умолчанию - ЛОЖЬ +// Подразделение - СправочникСсылка.ПодразделенияОрганизаций, в таблицу войдут сотрудники указанного подразделения +// и всех подразделений, подчиненных указанному, если параметр опустить в таблицу войдут все сотрудники. +// СписокФизическихЛиц - Массив ссылок на элементы справочника ФизическиеЛица, если параметр опустить, +// в таблицу войдут сотрудники всех физических лиц когда либо работавших в Организации. +// НачалоПериода - Дата, значение по умолчанию '00010101'. Если параметр устанавливается, параметр ОкончаниеПериода +// обязателен к заполнению. +// ОкончаниеПериода - Дата, значение по умолчанию '00010101'. При установке должно выполняться условие +// ОкончаниеПериода >= НачалоПериода. Используется для выборки кадровых данных сотрудников, если +// параметр не указан, выборка будет производиться на текущую дату сеанса. +// КадровыеДанные - Строка, содержит список полей кадровых данных, см. описание к функции КадровыеДанныеСотрудников. +// Отборы - Массив, структур описывающих отборы сотрудников +// см. ЗарплатаКадрыОбщиеНаборыДанных.ДобавитьВКоллекциюОтбор, +// допустимые отборы описаны см. КритерииПоискаСотрудниковПоКоллекцииОтборов. +// +Функция ПараметрыПолученияВсехСотрудниковОрганизацийПоСпискуФизическихЛиц() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.ПараметрыПолученияВсехСотрудниковОрганизацийПоСпискуФизическихЛиц() +``` +
+ +## ПараметрыПолученияСотрудниковОрганизацийПоВременнойТаблице +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров для СоздатьВТСотрудникиОрганизаций. +// +// Возвращаемое значение: +// Структура - Содержит ключи: +// * Организация - СправочникСсылка.Организации, если параметр опустить в таблицу войдут все сотрудник +// независимо от организации. +// * ОтбиратьПоГоловнойОрганизации - если Истина, то отбор по головной организации, иначе по текущей организации. +// По умолчанию - ЛОЖЬ +// * Подразделение - СправочникСсылка.ПодразделенияОрганизаций, в таблицу войдут сотрудники указанного подразделения +// и всех подразделений, подчиненных указанному, если параметр опустить в таблицу войдут все сотрудники. +// * ИмяВТФизическиеЛица - Строка, имя временной таблицы, содержащей физические лица (по умолчанию "ВТФизическиеЛица"). +// * ИмяПоляФизическоеЛицо - Строка, имя поля - Физическое лицо (по умолчанию "ФизическоеЛицо"). +// * НачалоПериода - Дата, значение по умолчанию '00010101'. Если параметр устанавливается, параметр ОкончаниеПериода +// обязателен к заполнению. +// * ОкончаниеПериода - Дата, значение по умолчанию '00010101'. При установке должно выполняться условие +// ОкончаниеПериода >= НачалоПериода. Используется для выборки кадровых данных сотрудников, если +// параметр не указан, выборка будет производиться на текущую дату сеанса. +// * КадровыеДанные - Строка, содержит список полей кадровых данных, см. описание к функции КадровыеДанныеСотрудников. +// * Отборы - Массив, структур описывающих отборы сотрудников +// см. ЗарплатаКадрыОбщиеНаборыДанных.ДобавитьВКоллекциюОтбор, +// допустимые отборы описаны см. КритерииПоискаСотрудниковПоКоллекцииОтборов. +// * РаботникиПоТрудовымДоговорам - Булево, Неопределено (Истина - работник по ТД, Ложь - не работает по ТД +// Неопределено - неважно наличие ТД). +// * ПодработкиРаботниковПоТрудовымДоговорам - Булево. +// * РаботникиПоДоговорамГПХ - Булево, Неопределено (Истина - есть действующие договоры ГПХ, Ложь - нет +// действующих договоров ГПХ, Неопределено - неважно наличие действующего +// договора ГПХ). +// +Функция ПараметрыПолученияСотрудниковОрганизацийПоВременнойТаблице() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.ПараметрыПолученияСотрудниковОрганизацийПоВременнойТаблице() +``` +
+ +## СотрудникиОрганизации +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений, заполненную сотрудниками. +// +// Параметры: +// ТолькоРазрешенные - Булево +// Параметры - Структура, подготовленная с помощью методов +// ПараметрыПолученияСотрудниковОрганизацийПоСпискуФизическихЛиц, +// ПараметрыПолученияСотрудниковОрганизацийПоВременнойТаблице +// +// Возвращаемое значение: +// ТаблицаЗначений - Таблица значений, содержащая поля +// * Период - Дата, равен значению ключа ОкончаниеПериода параметра Параметры +// * Сотрудник - СправочникСсылка.Сотрудники +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// <кадровые данные> - указанные в ключе КадровыеДанные параметра Параметры. +// +Функция СотрудникиОрганизации(ТолькоРазрешенные, Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.СотрудникиОрганизации(ТолькоРазрешенные, Параметры) +``` +
+ +## ОсновныеСотрудникиФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений содержащую поля ФизическоеЛицо и Сотрудник. Сотрудник отбирается по принципам: +// - Работает на указанный период. +// - Выбирается сотрудник, работающий по основному месту работы, если такового не существует, выбирается +// сотрудник, работающий по совместительству, принятый на наиболее раннюю дату. +// +// Параметры: +// СписокФизическихЛиц - Массив ссылок на элементы справочника ФизическиеЛица или +// - СправочникСсылка.ФизическиеЛица +// - Неопределено - в таблицу войдут "основные" сотрудники всех +// физических лиц когда либо работавших в организации. +// ТолькоРазрешенные - Булево +// Организация - СправочникСсылка.Организации +// Период - Дата +// +// +// Возвращаемое значение: +// ТаблицаЗначений - Таблица значений, содержащая поля Сотрудник и соответствующее сотруднику ФизическоеЛицо. +// +Функция ОсновныеСотрудникиФизическихЛиц(СписокФизическихЛиц, ТолькоРазрешенные, Организация, Период) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.ОсновныеСотрудникиФизическихЛиц(СписокФизическихЛиц, ТолькоРазрешенные, Организация, Период) +``` +
+ +## СформироватьКадровыеДвижения +
+ +Описание, пример вызова + +```bsl + +// Заполняет кадровые движения документа +// КадроваяИсторияСотрудников +// +// Параметры: +// РегистраторОбъект +// Движения - коллекция движений, в которой необходимо заполнить кадровые движения. +// КадровыеДвижения - таблица значений с полями: +// ДатаСобытия +// ВидСобытия - Перечисление.ВидыКадровыхСобытий +// Сотрудник +// ГоловнаяОрганизация +// Организация +// Подразделение +// Должность +// ВидЗанятости +// ТолькоБронированиеПозиции - Булево +// Записывать - Булево +// +Процедура СформироватьКадровыеДвижения(РегистраторОбъект, Движения, КадровыеДвижения, ТолькоБронированиеПозиции = Ложь, Записывать = Истина) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчет.СформироватьКадровыеДвижения(РегистраторОбъект, Движения, КадровыеДвижения, ТолькоБронированиеПозиции, Записывать); +``` +
+ +## СформироватьДвиженияВидовЗанятостиСотрудников +
+ +Описание, пример вызова + +```bsl + +// Заполняет движения документа по регистру сведений ВидыЗанятостиСотрудников +// +// Параметры: +// Движения - коллекция движений, в которой необходимо заполнить кадровые движения. +// КоллекцияДвиженийВидовЗанятости - таблица значений с полями: +// Сотрудник +// ГоловнаяОрганизация +// ФизическоеЛицо +// ВидЗанятости +// ДействуетДо +// Записывать - Булево +// +Процедура СформироватьДвиженияВидовЗанятостиСотрудников(Движения, КоллекцияВидовЗанятости, Записывать = Истина) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчет.СформироватьДвиженияВидовЗанятостиСотрудников(Движения, КоллекцияВидовЗанятости, Записывать); +``` +
+ +## ФизическоеЛицоПоФИОСНИЛСИОрганизации +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает ссылку на физическое лицо, найденное по переданным фамилии, имени, отчеству СНИЛС и организации +// (см. функцию ЭлектронныйДокументооборотСКонтролирующимиОрганамиВызовСервераПереопределяемый.ФизЛицоПоФИО). +// +// Параметры: +// Фамилия - Строка - Фамилия физического лица. +// Имя - Строка - Имя физического лица. +// Отчество - Строка - Отчество физического лица. +// СНИЛС - Строка - СНИЛС физического лица. +// Организация - СправочникСсылка.Организации - организация, в которой работает физическое лицо. +// +// Возвращаемое значение: +// СправочникСсылка.ФизическиеЛица +// +Функция ФизическоеЛицоПоФИОСНИЛСИОрганизации(Фамилия, Имя, Отчество, СНИЛС, Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.ФизическоеЛицоПоФИОСНИЛСИОрганизации(Фамилия, Имя, Отчество, СНИЛС, Организация) +``` +
+ +## ПериодыИзмененияФИОФизическихЛиц +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений в строках которой содержится информация о периодах +// изменения (регистрации) фамилии, имени и отчества физических лиц. +// +// Параметры: +// СписокФизическихЛиц - Массив, ссылок справочника ФизическиеЛица +// - СправочникСсылка.ФизическиеЛица. +// +// Возвращаемое значение: +// ТаблицаЗначений - содержит колонки: +// * Период - Дата +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// * Фамилия - Строка +// * Имя - Строка +// * Отчество - Строка +// +Функция ПериодыИзмененияФИОФизическихЛиц(СписокФизическихЛиц) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.ПериодыИзмененияФИОФизическихЛиц(СписокФизическихЛиц) +``` +
+ +## НовыеДанныеФизическогоЛица +
+ +Описание, пример вызова + +```bsl + +// Возвращает новую структуру для заполнения данных физического лица. +// +// Возвращаемое значение: +// Структура: +// * Фамилия - Строка - +// * Имя - Строка - +// * Отчество - Строка - +// * ДатаРождения - Дата - +// * МестоРождения - Строка - +// * ИНН - Строка - +// * СтраховойНомерПФР - Строка - +// * Пол - ПеречислениеСсылка.ПолФизическогоЛица - +// * ИмеетНаучныеТруды - Булево - +// * ИмеетИзобретения - Булево - +// * ДатаРегистрации - Дата - +// * ЛьготаПриНачисленииПособий - ПеречислениеСсылка.ОснованияФинансированияПособияФедеральнымБюджетом - +// * ОтношениеКОсобойЗоне - ПеречислениеСсылка.ОтношениеКОсобойЗоне - +// * ВидОсобойЗоны - ПеречислениеСсылка.ВидыОсобойЗоныПроживанияРаботы - +// * ПостоянноПроживалВКрыму18Марта2014Года - Булево - +// * ПрименяетсяФЗ_20_2023 - Булево - +// * АдресФотографии - Строка, УникальныйИдентификатор - +// * ГруппаДоступа - СправочникСсылка.ГруппыДоступаФизическихЛиц - +// * Образование - ТаблицаЗначений +// * СостояниеВБраке - Массив из Структура +// * Гражданство - Массив из Структура: см. РегистрыСведений.ГражданствоФизическихЛиц.НовоеГражданство +// * ТрудоваяДеятельность - Массив из Структура: +// * ЗнаниеЯзыков - Массив из Структура: +// * УченыеСтепени - Массив из Структура: +// * КонтактнаяИнформация - Массив из Структура: см. НоваяКонтактнаяИнформация +Функция НовыеДанныеФизическогоЛица() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.НовыеДанныеФизическогоЛица() +``` +
+ +## НоваяКонтактнаяИнформация +
+ +Описание, пример вызова + +```bsl + +// Новая контактная информация. +// +// Возвращаемое значение: +// Структура - Новая контактная информация: +// * ЗначенияПолей - Строка - +// * ВидИнформации - СправочникСсылка.ВидыКонтактнойИнформации - +// * ТипИнформации - ПеречислениеСсылка.ТипыКонтактнойИнформации - +Функция НоваяКонтактнаяИнформация() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.НоваяКонтактнаяИнформация() +``` +
+ +## НовоеФизическоеЛицо +
+ +Описание, пример вызова + +```bsl + +// Возвращает объект справочника ФизическиеЛица, созданный по переданным фамилии, +// имени, отчеству и другим данным (см. параметр ДанныеФизическогоЛица). +// +// Параметры: +// ФИО - Строка,Структура: +// * Фамилия - Строка +// * Имя - Строка +// * Отчество - Строка +// ДанныеФизическогоЛица - Структура: см. НовыеДанныеФизическогоЛица +// ПериодДанных - Дата - дата, на которую будет зарегистрирована запись о ФИО +// Записывать - Булево - если Истина, то физическое лицо будет записано +// +// Возвращаемое значение: +// СправочникОбъект.ФизическиеЛица +// +Функция НовоеФизическоеЛицо(Знач ФИО, Знач ДанныеФизическогоЛица = Неопределено, Знач ПериодДанных = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.НовоеФизическоеЛицо(ФИО, ДанныеФизическогоЛица, ПериодДанных, ); +``` +
+ +## СвязанныеОбъектыДанныхФизическогоЛица +
+ +Описание, пример вызова + +```bsl + +// Связанные объекты данных физического лица. +// +// Параметры: +// ДанныеФизическогоЛица - Структура: см. НовыеДанныеФизическогоЛица +// +// Возвращаемое значение: +// Структура: +// * Гражданство - Массив из Структура: см. РегистрыСведений.ГражданствоФизическихЛиц.НовоеГражданство +// * Образование - ТаблицаЗначений: см. Справочники.ОбразованиеФизическихЛиц.НовыеДанныеОбОбразовании +// * СостояниеВБраке - Массив из Структура: см. РегистрыСведений.СостоянияВБракеФизическихЛиц.НовоеСостояниеВБраке +// * ТрудоваяДеятельность - Массив из Структура: см. РегистрыСведений.ТрудоваяДеятельностьФизическихЛиц.НоваяТрудоваяДеятельность +// * ЗнаниеЯзыков - Массив из Структура: см. РегистрыСведений.ЗнаниеЯзыковФизическихЛиц.НовоеЗнаниеЯзыка +// * УченыеСтепени - Массив из Структура +// * АдресФотографии - Строка - +Функция СвязанныеОбъектыДанныхФизическогоЛица(ДанныеФизическогоЛица) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.СвязанныеОбъектыДанныхФизическогоЛица(ДанныеФизическогоЛица) +``` +
+ +## СреднесписочнаяЧисленностьРаботающих +
+ +Описание, пример вызова + +```bsl + +// Функция рассчитывает численность всех работников, женщин и инвалидов. +// При этом за переданный период считается среднесписочная численность, +// а на конец заданного периода - списочная численность. +// +// Параметры: +// Организация - СправочникСсылка.Организации +// НачалоПериода - Дата +// КонецПериода - Дата +// +// Возвращаемое значение: +// Структура - см. СтатистикаПерсонала.ДанныеОЧисленности +// +Функция СреднесписочнаяЧисленностьРаботающих(Организация, НачалоПериода, КонецПериода, ПоГоловнойОрганизации = Ложь, Точность =0) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчет.СреднесписочнаяЧисленностьРаботающих(Организация, НачалоПериода, КонецПериода, ПоГоловнойОрганизации, Точность); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйУчетБазовый.md b/src/content/docs/zup/КадровыйУчетБазовый.md new file mode 100644 index 0000000..50c4e42 --- /dev/null +++ b/src/content/docs/zup/КадровыйУчетБазовый.md @@ -0,0 +1,38 @@ +--- +title: Кадровый учет базовый +slug: zup/кадровый-учет-базовый +--- + + +## СформироватьКадровыеПриказы +
+ +Описание, пример вызова + +```bsl + +// Формирует кадровые приказы, при включении ведения кадрового учета документами, +// выполняется в фоновом задании. +// +// Параметры: +// ПараметрыЗадания - Необходим для поддержки работы длительных операций, для запуска +// в качестве фонового задания, не используется. +// АдресВоВременномХранилище - Необходим для поддержки работы длительных операций, для запуска +// в качестве фонового задания, не используется. +// +Процедура СформироватьКадровыеПриказы(ПараметрыЗадания = Неопределено, АдресВоВременномХранилище = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетБазовый.СформироватьКадровыеПриказы(ПараметрыЗадания, АдресВоВременномХранилище); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйУчетКлиент.md b/src/content/docs/zup/КадровыйУчетКлиент.md new file mode 100644 index 0000000..244e014 --- /dev/null +++ b/src/content/docs/zup/КадровыйУчетКлиент.md @@ -0,0 +1,194 @@ +--- +title: Кадровый учет клиент +slug: zup/кадровый-учет-клиент +--- + + +## ВыбратьФизическихЛицОрганизации +
+ +Описание, пример вызова + +```bsl + +// Открывает формы выбора физических лиц, работающих в организации. +// +// Параметры: +// ЭлементФормы - ФормаКлиентскогоПриложения или элемент управляемой формы, являющийся владельцем формы подбора. +// Организация - СправочникСсылка.Организации +// МножественныйВыбор - Булево +// ФиксированныеНастройки - НастройкаКомпоновкиДанных (параметр, расширения динамического списка). +// АдресСпискаПодобранныхСотрудников - Строка +// ОтбиратьПоГоловнойОрганизации - Булево, если передать Истина в список войдут сотрудники головной организации. +// ПараметрыОткрытияФормы - Структура, в которой можно определить параметры открытия формы выбора. +// +Процедура ВыбратьФизическихЛицОрганизации(ЭлементФормы, Организация, МножественныйВыбор = Истина, ФиксированныеНастройки = Неопределено, АдресСпискаПодобранныхСотрудников = "", ОтбиратьПоГоловнойОрганизации = Ложь, ПараметрыОткрытияФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетКлиент.ВыбратьФизическихЛицОрганизации(ЭлементФормы, Организация, МножественныйВыбор, ФиксированныеНастройки, АдресСпискаПодобранныхСотрудников, ОтбиратьПоГоловнойОрганизации, ПараметрыОткрытияФормы); +``` +
+ +## ПодобратьФизическихЛицОрганизации +
+ +Описание, пример вызова + +```bsl + +// Открывает формы выбора физических лиц, работающих в организации, позволяет выбрать несколько значений. +// В параметре АдресСпискаПодобранныхСотрудников передается адрес массива ссылок уже подобранных физических лиц. +// Подобранные физические лица выделяются жирным шрифтом. +// +// Параметры: +// ЭлементФормы +// Организация +// АдресСпискаПодобранныхСотрудников. +// ОтбиратьПоГоловнойОрганизации - Булево, если передать Истина в список войдут сотрудники головной организации. +// ПараметрыОткрытияФормы - Структура, в которой можно определить параметры открытия формы выбора. +// +Процедура ПодобратьФизическихЛицОрганизации(ЭлементФормы, Организация, АдресСпискаПодобранныхСотрудников, ОтбиратьПоГоловнойОрганизации = Ложь, ПараметрыОткрытияФормы = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетКлиент.ПодобратьФизическихЛицОрганизации(ЭлементФормы, Организация, АдресСпискаПодобранныхСотрудников, ОтбиратьПоГоловнойОрганизации, ПараметрыОткрытияФормы); +``` +
+ +## ОткрытьФормуПодбораИзКлассификатора +
+ +Описание, пример вызова + +```bsl + +// Открывает форму подбора значений из классификатора. +// +// Параметры: +// ИмяСправочника - Строка, имя справочника как оно задано в конфигураторе. +// ПолныйПутьКМакету - Строка - формат полного пути: +// "Документ.<ИмяДокумента>.<ИмяМакета>" +// "Обработка.<ИмяОбработки>.<ИмяМакета>" +// "ОбщийМакет.<ИмяМакета>". +// Заголовок - Строка +// Форма - ФормаКлиентскогоПриложения, форма - владелец. +// СоответствиеПолей - Соответствие, задает соответствие имен реквизитов справочника\ +// именам полей классификатора. +// ОповещениеЗавершения - ОписаниеОповещения, которое необходимо выполнить по окончании +// выбора элементов классификатора. +// ЗаполнятьДополнительныеСведения - Булево, если Истина собирает поля строки классификатора в структуру и вызывает +// реализованный в модуле объекта метод ЗаполнитьДополнительныеСведенияКлассификатора, +// заполняемого справочника. +// +Процедура ОткрытьФормуПодбораИзКлассификатора(ИмяСправочника, ПолныйПутьКМакету, Заголовок, Форма, СоответствиеПолей = Неопределено, ОповещениеЗавершения = Неопределено, ЗаполнятьДополнительныеСведения = Ложь) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетКлиент.ОткрытьФормуПодбораИзКлассификатора(ИмяСправочника, ПолныйПутьКМакету, Заголовок, Форма, СоответствиеПолей, ОповещениеЗавершения, ЗаполнятьДополнительныеСведения); +``` +
+ +## ВыбратьСотрудниковРаботающихНаДатуПоПараметрамОткрытияФормыСписка +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора справочника Сотрудники с отбором только работающих +// сотрудников на указанную дату и в указанных, организации и подразделении. +// +// Параметры: +// ВладелецФормыВыбора - Форма или элемент формы, для которого открывается форма выбора. +// Организация - СправочникСсылка.Организации, если не указана, в отбор попадают все сотрудники компании. +// Подразделение - СправочникСсылка.ПодразделенияОрганизации, если не указано - в отбор попадают все сотрудники. +// ДатаПримененияОтбора - Дата, на которую необходимо выбрать работающих сотрудников. +// МножественныйВыбор - Булево, если ложь - форма откроется для выбора одного сотрудника. +// АдресСпискаПодобранныхСотрудников - Строка, адрес массива уже подобранных сотрудников во временном хранилище. +// ПараметрыОткрытия - Структура, аналогичная структуре параметров формы списка. +// +Процедура ВыбратьСотрудниковРаботающихНаДатуПоПараметрамОткрытияФормыСписка(ВладелецФормыВыбора, Организация = Неопределено, Подразделение = Неопределено, ДатаПримененияОтбора = '00010101', МножественныйВыбор = Истина, АдресСпискаПодобранныхСотрудников = "", ПараметрыОткрытия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетКлиент.ВыбратьСотрудниковРаботающихНаДатуПоПараметрамОткрытияФормыСписка(ВладелецФормыВыбора, Организация, Подразделение, ДатаПримененияОтбора, МножественныйВыбор, АдресСпискаПодобранныхСотрудников, ПараметрыОткрытия); +``` +
+ +## ВыбратьСотрудниковРаботающихВПериодеПоПараметрамОткрытияФормыСписка +
+ +Описание, пример вызова + +```bsl + +// Открывает форму выбора справочника Сотрудники с отбором только работающих +// сотрудников в периоде. +// +// Параметры: +// ВладелецФормыВыбора - Форма или элемент формы, для которого открывается форма выбора. +// Организация - СправочникСсылка.Организации, если не указана, в отбор попадают все сотрудники компании. +// Подразделение - СправочникСсылка.ПодразделенияОрганизации, если не указано - в отбор попадают все сотрудники. +// НачалоПериодаПримененияОтбора - Дата, начало периода для отбора сотрудников. +// ОкончаниеПериодаПримененияОтбора - Дата, окончание периода для отбора сотрудников. +// МножественныйВыбор - Булево, если ложь - форма откроется для выбора одного сотрудника. +// АдресСпискаПодобранныхСотрудников - Строка, адрес массива уже подобранных сотрудников во временном хранилище. +// ПараметрыОткрытия - Структура, аналогичная структуре параметров формы списка. +// +Процедура ВыбратьСотрудниковРаботающихВПериодеПоПараметрамОткрытияФормыСписка(ВладелецФормыВыбора, Организация = Неопределено, Подразделение = Неопределено, НачалоПериодаПримененияОтбора = '00010101', ОкончаниеПериодаПримененияОтбора = '00010101', МножественныйВыбор = Истина, АдресСпискаПодобранныхСотрудников = "", ПараметрыОткрытия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетКлиент.ВыбратьСотрудниковРаботающихВПериодеПоПараметрамОткрытияФормыСписка(ВладелецФормыВыбора, Организация, Подразделение, НачалоПериодаПримененияОтбора, ОкончаниеПериодаПримененияОтбора, МножественныйВыбор, АдресСпискаПодобранныхСотрудников, ПараметрыОткрытия); +``` +
+ +## ВыбратьСотрудниковРаботающихНаДату +
+ +Описание, пример вызова + +```bsl + +// Устарела см. ВыбратьСотрудниковРаботающихНаДатуПоПараметрамОткрытияФормыСписка +// +Процедура ВыбратьСотрудниковРаботающихНаДату(ВладелецФормыВыбора, Организация = Неопределено, Подразделение = Неопределено, ДатаПримененияОтбора = '00010101', МножественныйВыбор = Истина, АдресСпискаПодобранныхСотрудников = "", СтруктураОтбора = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетКлиент.ВыбратьСотрудниковРаботающихНаДату(ВладелецФормыВыбора, Организация, Подразделение, ДатаПримененияОтбора, МножественныйВыбор, АдресСпискаПодобранныхСотрудников, СтруктураОтбора); +``` +
+ +## ВыбратьСотрудниковРаботающихВПериоде +
+ +Описание, пример вызова + +```bsl + +// Устарела см. ВыбратьСотрудниковРаботающихВПериодеПоПараметрамОткрытияФормыСписка +// +Процедура ВыбратьСотрудниковРаботающихВПериоде(ВладелецФормыВыбора, Организация = Неопределено, Подразделение = Неопределено, НачалоПериодаПримененияОтбора = '00010101', ОкончаниеПериодаПримененияОтбора = '00010101', МножественныйВыбор = Истина, АдресСпискаПодобранныхСотрудников = "", СтруктураОтбора = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетКлиент.ВыбратьСотрудниковРаботающихВПериоде(ВладелецФормыВыбора, Организация, Подразделение, НачалоПериодаПримененияОтбора, ОкончаниеПериодаПримененияОтбора, МножественныйВыбор, АдресСпискаПодобранныхСотрудников, СтруктураОтбора); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйУчетКлиентСерверБазовый.md b/src/content/docs/zup/КадровыйУчетКлиентСерверБазовый.md new file mode 100644 index 0000000..351813c --- /dev/null +++ b/src/content/docs/zup/КадровыйУчетКлиентСерверБазовый.md @@ -0,0 +1,31 @@ +--- +title: Кадровый учет клиент сервер базовый +slug: zup/кадровый-учет-клиент-сервер-базовый +--- + + +## ОбработкаПолученияДанныхВыбораВидовЗанятости +
+ +Описание, пример вызова + +```bsl + +// См. КадровыйУчетКлиентСервер.ОбработкаПолученияДанныхВыбораВидовЗанятости. +// +Процедура ОбработкаПолученияДанныхВыбораВидовЗанятости(ДанныеВыбора, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетКлиентСерверБазовый.ОбработкаПолученияДанныхВыбораВидовЗанятости(ДанныеВыбора, Параметры, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйУчетКлиентСерверВнутренний.md b/src/content/docs/zup/КадровыйУчетКлиентСерверВнутренний.md new file mode 100644 index 0000000..96d0e99 --- /dev/null +++ b/src/content/docs/zup/КадровыйУчетКлиентСерверВнутренний.md @@ -0,0 +1,31 @@ +--- +title: Кадровый учет клиент сервер внутренний +slug: zup/кадровый-учет-клиент-сервер-внутренний +--- + + +## ОбработкаПолученияДанныхВыбораВидовЗанятости +
+ +Описание, пример вызова + +```bsl + +// см. КадровыйУчетКлиентСервер.ОбработкаПолученияДанныхВыбораВидовЗанятости +// +Процедура ОбработкаПолученияДанныхВыбораВидовЗанятости(ДанныеВыбора, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетКлиентСерверВнутренний.ОбработкаПолученияДанныхВыбораВидовЗанятости(ДанныеВыбора, Параметры, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйУчетПовтИсп.md b/src/content/docs/zup/КадровыйУчетПовтИсп.md new file mode 100644 index 0000000..6f478a5 --- /dev/null +++ b/src/content/docs/zup/КадровыйУчетПовтИсп.md @@ -0,0 +1,61 @@ +--- +title: Кадровый учет повт исп +slug: zup/кадровый-учет-повт-исп +--- + + +## ОсновнойСотрудникФизическогоЛица +
+ +Описание, пример вызова + +```bsl + +Функция ОсновнойСотрудникФизическогоЛица(ФизическоеЛицо, Организация, Период) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчетПовтИсп.ОсновнойСотрудникФизическогоЛица(ФизическоеЛицо, Организация, Период) +``` +
+ +## ФизическоеЛицоСотрудника +
+ +Описание, пример вызова + +```bsl + +Функция ФизическоеЛицоСотрудника(Сотрудник) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчетПовтИсп.ФизическоеЛицоСотрудника(Сотрудник) +``` +
+ +## ПросклоненноеФизическоеЛицо +
+ +Описание, пример вызова + +```bsl + +Функция ПросклоненноеФизическоеЛицо(ФизическоеЛицо, Падеж) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчетПовтИсп.ПросклоненноеФизическоеЛицо(ФизическоеЛицо, Падеж) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйУчетРасширенныйКлиент.md b/src/content/docs/zup/КадровыйУчетРасширенныйКлиент.md new file mode 100644 index 0000000..a037025 --- /dev/null +++ b/src/content/docs/zup/КадровыйУчетРасширенныйКлиент.md @@ -0,0 +1,149 @@ +--- +title: Кадровый учет расширенный клиент +slug: zup/кадровый-учет-расширенный-клиент +--- + + +## ОткрытьФормуРедактированияСтажей +
+ +Описание, пример вызова + +```bsl + +// Открывает форму редактирования стажей сотрудника. +// +// Параметры: +// ПараметрыФормы - Структура - См. функцию ПараметрыФормыРедактированияСтажей(). +// Обработчик - ОписаниеОповещения - Описание процедуры, вызываемой при окончании редактировании стажей с параметрами. +// * РезультатРедактированияСтажей - Неопределено, КодВозвратаДиалога, Структура - +// Результат редактирования стажей. +// При успешном окончании редактирования процедура будет вызвана с параметром типа "Структура" с полями: +// ** Сотрудник - СправочникСсылка.Сотрудники +// ** ФизическоеЛицо - СправочникСсылка.ФизическиеЛица +// ** ДанныеСтажей - ДанныеФормыКоллекция +// При отказе от редактирования процедура будет вызвана с параметром типа "Неопределено" или "КодВозвратаДиалога". +// Пример чтения результатов процедуры см. в форме документа БольничныйЛист. +// * ДополнительныеПараметры - Произвольный - Значение, которое было указано при создании объекта ОписаниеОповещения. +// +Процедура ОткрытьФормуРедактированияСтажей(ПараметрыФормы, Обработчик) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетРасширенныйКлиент.ОткрытьФормуРедактированияСтажей(ПараметрыФормы, Обработчик) +``` +
+ +## ПараметрыФормыРедактированияСтажей +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры, необходимые для процедуры ОткрытьФормуРедактированияСтажей. +// +// Возвращаемое значение: +// Структура - Параметры, необходимые для вызова процедуры ОткрытьФормуРедактированияСтажей. +// * ТолькоПросмотр - Булево - Признак возможности редактирования отображаемых данных. +// * Сотрудник - СправочникСсылка.Сотрудники - Необязательный, если передан параметр "ФизическоеЛицо". +// * ФизическоеЛицо - СправочникСсылка.ФизическиеЛица - Необязательный, если передан параметр "Сотрудник". +// * ДатаСведений - Дата +// * ВидыСтажа - Массив из СправочникСсылка.ВидыСтажа +// * ДанныеСтажей - Соответствие - Данные стажей сотрудника. +// * Ключ - СправочникСсылка.ВидыСтажа +// * Значение - Структура - См. ЗарплатаКадрыРасширенныйКлиентСервер.СведенияОСтаже(). +// * Записывать - Булево - Если Истина, данные о стаже будут записаны при закрытии формы. +// * НеобязательныеВидыСтажа - ФиксированноеСоответствие - стажи, заполнение которых необязательно. +// Для этих стажей будет выведен флажок, разрешающий редактирование данных стажа. +// Эти виды стажа должны также быть перечислены в параметре ВидыСтажа. +// * ЗаголовокФормы - Строка - Заголовок формы ввода стажей. +// +Функция ПараметрыФормыРедактированияСтажей() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйУчетРасширенныйКлиент.ПараметрыФормыРедактированияСтажей() +``` +
+ +## ОткрытьФормуРедактированияСтажейСотрудника +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать КадровыйУчетРасширенныйКлиент.ОткрытьФормуРедактированияСтажей. +// Открывает форму редактирования стажей сотрудника. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// Сотрудник - СправочникСсылка.Сотрудники +// ДатаСведений - Дата +// ВидыСтажа - Массив ссылок на элементы справочника ВидыСтажа. +// ФизическоеЛицо - СправочникСсылка.ФизическиеЛица, передается если известно. +// ДанныеСтажей - Соответствие - Данные стажей сотрудника. +// * Ключ - Вид стажа; +// * Значение - Структура, сформированная методом ЗарплатаКадрыРасширенныйКлиентСервер.СведенияОСтаже(). +// Записывать - Булево - Если Истина, данные о стаже будут записаны при закрытии формы. +// НеобязательныеВидыСтажа - Фиксированное соответствие - стажи, заполнение которых необязательно. Для этих стажей будет +// выведен флажок, разрешающий редактирование данных стажа. Эти +// виды стажа должны также быть перечислены в параметре ВидыСтажа. +// * Ключ - Вид стажа; +// * Значение - Строка, заголовок флажка. +// +Процедура ОткрытьФормуРедактированияСтажейСотрудника(Форма, Сотрудник, ДатаСведений, ВидыСтажа, ФизическоеЛицо = Неопределено, ДанныеСтажей = Неопределено, Записывать = Истина, НеобязательныеВидыСтажа = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетРасширенныйКлиент.ОткрытьФормуРедактированияСтажейСотрудника(Форма, Сотрудник, ДатаСведений, ВидыСтажа, ФизическоеЛицо, ДанныеСтажей, Записывать, НеобязательныеВидыСтажа); +``` +
+ +## ВыбратьСотрудниковРаботающихНаДату +
+ +Описание, пример вызова + +```bsl + +// Устарела см. процедуру КадровыйУчетКлиент.ВыбратьСотрудниковРаботающихНаДатуПоПараметрамОткрытияФормыСписка. +// +Процедура ВыбратьСотрудниковРаботающихНаДату(ВладелецФормыВыбора, Организация = Неопределено, Подразделение = Неопределено, ДатаПримененияОтбора = '00010101', МножественныйВыбор = Истина, АдресСпискаПодобранныхСотрудников = "", СтруктураОтбора = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетРасширенныйКлиент.ВыбратьСотрудниковРаботающихНаДату(ВладелецФормыВыбора, Организация, Подразделение, ДатаПримененияОтбора, МножественныйВыбор, АдресСпискаПодобранныхСотрудников, СтруктураОтбора); +``` +
+ +## ВыбратьСотрудниковРаботающихВПериоде +
+ +Описание, пример вызова + +```bsl + +// Устарела см. процедуру КадровыйУчетКлиент.ВыбратьСотрудниковРаботающихВПериодеПоПараметрамОткрытияФормыСписка. +// +Процедура ВыбратьСотрудниковРаботающихВПериоде(ВладелецФормыВыбора, Организация = Неопределено, Подразделение = Неопределено, НачалоПериодаПримененияОтбора = '00010101', ОкончаниеПериодаПримененияОтбора = '00010101', МножественныйВыбор = Истина, АдресСпискаПодобранныхСотрудников = "", СтруктураОтбора = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетРасширенныйКлиент.ВыбратьСотрудниковРаботающихВПериоде(ВладелецФормыВыбора, Организация, Подразделение, НачалоПериодаПримененияОтбора, ОкончаниеПериодаПримененияОтбора, МножественныйВыбор, АдресСпискаПодобранныхСотрудников, СтруктураОтбора); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйУчетФормыРасширенный.md b/src/content/docs/zup/КадровыйУчетФормыРасширенный.md new file mode 100644 index 0000000..027f335 --- /dev/null +++ b/src/content/docs/zup/КадровыйУчетФормыРасширенный.md @@ -0,0 +1,33 @@ +--- +title: Кадровый учет формы расширенный +slug: zup/кадровый-учет-формы-расширенный +--- + + +## ПриПодбореСпискаФизЛиц +
+ +Описание, пример вызова + +```bsl + +// Выполняет дополнительные действия при подборе похожих физических лиц. +// +// Параметры: +// СтруктураВозврат - Структура +Процедура ПриПодбореСпискаФизЛиц(СтруктураВозврат) Экспорт +``` + +Пример вызова +```bsl +КадровыйУчетФормыРасширенный.ПриПодбореСпискаФизЛиц(СтруктураВозврат) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйЭДО.md b/src/content/docs/zup/КадровыйЭДО.md new file mode 100644 index 0000000..cd94f2c --- /dev/null +++ b/src/content/docs/zup/КадровыйЭДО.md @@ -0,0 +1,250 @@ +--- +title: Кадровый ЭДО +slug: zup/кадровый-эдо +--- + + +## ПриСозданииНаСервереФормыОбъекта +
+ +Описание, пример вызова + +```bsl + +// Дорабатывает форму нового документа, создает реквизиты наличия присоединенных файлов печатных форм. +// Вызывается из события ПриСозданииНаСервере формы объекта. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// Отказ - Булево +// СтандартнаяОбработка - Булево +// ОбъектФормы - ДанныеФормыСтруктура, основной объект формы +// +Процедура ПриСозданииНаСервереФормыОбъекта(УправляемаяФорма, Отказ, СтандартнаяОбработка, ОбъектФормы) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДО.ПриСозданииНаСервереФормыОбъекта(УправляемаяФорма, Отказ, СтандартнаяОбработка, ОбъектФормы) +``` +
+ +## ПриЧтенииНаСервереФормыОбъекта +
+ +Описание, пример вызова + +```bsl + +// Дорабатывает форму существующего документа, создает реквизиты наличия присоединенных файлов печатных форм. +// Вызывается из события ПриЧтенииНаСервере формы объекта. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// ТекущийОбъект - ДокументОбъект - объект, который будет прочитан. +// ОбъектФормы - ДанныеФормыСтруктура, основной объект формы +// +Процедура ПриЧтенииНаСервереФормыОбъекта(УправляемаяФорма, ТекущийОбъект, ОбъектФормы) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДО.ПриЧтенииНаСервереФормыОбъекта(УправляемаяФорма, ТекущийОбъект, ОбъектФормы) +``` +
+ +## ПослеЗаписиНаСервереФормыОбъекта +
+ +Описание, пример вызова + +```bsl + +// В форме документа обновляет сведения о наличии присоединенных файлов печатных форм. +// Вызывается из события ПослеЗаписиНаСервере формы объекта. +// +// Параметры: +// УправляемаяФорма - ФормаКлиентскогоПриложения - форма объекта. +// ТекущийОбъект - ДокументОбъект - объект. +// ПараметрыЗаписи - Структура +// ОбъектФормы - ДанныеФормыСтруктура, основной объект формы +// +Процедура ПослеЗаписиНаСервереФормыОбъекта(УправляемаяФорма, ТекущийОбъект, ПараметрыЗаписи, ОбъектФормы) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДО.ПослеЗаписиНаСервереФормыОбъекта(УправляемаяФорма, ТекущийОбъект, ПараметрыЗаписи, ОбъектФормы) +``` +
+ +## ПриСозданииНаСервереФормыСписка +
+ +Описание, пример вызова + +```bsl + +// Дорабатывает запрос динамического списка документов, расширяя состав полей признаками +// наличия присоединенного файла печатной формы. +// +// Параметры: +// УправляемаяФорма - УправляемаяФорма +// Список - ДинамическийСписок +// +Процедура ПриСозданииНаСервереФормыСписка(УправляемаяФорма, Список) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДО.ПриСозданииНаСервереФормыСписка(УправляемаяФорма, Список) +``` +
+ +## СписокПриПолученииДанныхНаСервере +
+ +Описание, пример вызова + +```bsl + +// Заполняет флаги существования присоединенных файлов печатных форм. +// +// Параметры: +// ИмяЭлемента - Строка +// Настройки - НастройкиКомпоновкиДанных +// Строки - СтрокиДинамическогоСписка +// +Процедура СписокПриПолученииДанныхНаСервере(ИмяЭлемента, Настройки, Строки) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДО.СписокПриПолученииДанныхНаСервере(ИмяЭлемента, Настройки, Строки) +``` +
+ +## ЗадатьДетальнуюОбластьПечати +
+ +Описание, пример вызова + +```bsl + +// Задает детальную область печати в табличном документе, позволяя более глубоко детализировать +// выводимые бланки по одной ссылке на объект. +// +// Параметры: +// ПараметрыПечати - см. УправлениеПечатьюПереопределяемый.ПриПечати +// ДокументРезультат - ТабличныйДокумент +// ИдентификаторПечатнойФормы - Строка +// НомерСтрокиНачалаОбласти - Число +// ДанныеПечати - Структура, СтрокаТаблицаЗначений, содержащая детальную информацию +// ОбъектДокумента - Ссылка на печатаемый объект +// +Процедура ЗадатьДетальнуюОбластьПечати(ПараметрыПечати, ДокументРезультат, ИдентификаторПечатнойФормы, НомерСтрокиНачалаОбласти, ДанныеПечати, ОбъектДокумента) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДО.ЗадатьДетальнуюОбластьПечати(ПараметрыПечати, ДокументРезультат, ИдентификаторПечатнойФормы, НомерСтрокиНачалаОбласти, ДанныеПечати, ОбъектДокумента) +``` +
+ +## ОписанияФайловПечатныхФормПоОбъектам +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание файлов печатных форм объектов. +// +// Параметры: +// Владельцы - Массив, ссылок на объекты с присоединенными файлами +// ИдентификаторыПечатныхФорм - Массив, идентификаторов печатных форм +// - Строка, идентификаторы печатных форм, разделенные запятыми +// +// Возвращаемое значение: +// Структура - с ключами: +// * ПечатныеФормыОбъектов - Соответствие +// * Ключ - Ссылка на владельца +// * Значение - Структура +// * Ключ - Идентификатор печатной формы +// * Значение - Массив, ссылок на присоединенные файлы +// * ОригиналыПечатныхФорм - Структура +// * Ключ - Идентификатор печатной формы +// * Значение - Структура, с Ключами +// * Наименование - Наименование печатной формы +// * Оригиналы - Соответствие +// * Ключ - Ссылка, на присоединенный файл печатной формы +// * Значение - Структура с ключами, описывающими печатную форму +// +Функция ОписанияФайловПечатныхФормПоОбъектам(Владельцы, ИдентификаторыПечатныхФорм) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДО.ОписанияФайловПечатныхФормПоОбъектам(Владельцы, ИдентификаторыПечатныхФорм) +``` +
+ +## РазблокироватьОбъектДляИзменений +
+ +Описание, пример вызова + +```bsl + +// Разблокирует объект с приложенными файлами печатных форм, помечая файлы печатных форм на удаление. +// +// Параметры: +// ОбъектДляРазблокировки - ОпределяемыйТип.ОбъектСПечатнымиФормами +// +// Возвращаемое значение: +// Строка - Пустая если все в порядке или полное описание возникшей ошибки. +// +Функция РазблокироватьОбъектДляИзменений(ОбъектДляРазблокировки) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДО.РазблокироватьОбъектДляИзменений(ОбъектДляРазблокировки) +``` +
+ +## ПечатьСтороннейПечатнойФормы +
+ +Описание, пример вызова + +```bsl + +// Вызывает процедуры печати в менеджерах объектов после переопределения массива ссылок, выводимых на печать. +// +// Параметры: +// МенеджерПечати - модуль менеджера или общий модуль, содержащий процедуру Печать +// МассивОбъектов - Массив, см. УправлениеПечатьюПереопределяемый.ПриПечати +// ПараметрыПечати - Структура, см. УправлениеПечатьюПереопределяемый.ПриПечати +// КоллекцияПечатныхФорм - ТаблицаЗначений, см. УправлениеПечатьюПереопределяемый.ПриПечати +// ОбъектыПечати - СписокЗначений, см. УправлениеПечатьюПереопределяемый.ПриПечати +// ПараметрыВывода - Структура, см. УправлениеПечатьюПереопределяемый.ПриПечати +// СписокСотрудников - Массив, ссылок на элементы справочника Сотрудники, когда производится +// печать по одному сотруднику списочного документа +// +Процедура ПечатьСтороннейПечатнойФормы(МенеджерПечати, МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода, СписокСотрудников = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДО.ПечатьСтороннейПечатнойФормы(МенеджерПечати, МассивОбъектов, ПараметрыПечати, КоллекцияПечатныхФорм, ОбъектыПечати, ПараметрыВывода, СписокСотрудников); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйЭДОБазовый.md b/src/content/docs/zup/КадровыйЭДОБазовый.md new file mode 100644 index 0000000..24f82bf --- /dev/null +++ b/src/content/docs/zup/КадровыйЭДОБазовый.md @@ -0,0 +1,61 @@ +--- +title: Кадровый ЭДО базовый +slug: zup/кадровый-эдо-базовый +--- + + +## ТипыОбъектовСоСтороннимиПечатнымиФормами +
+ +Описание, пример вызова + +```bsl + +Функция ТипыОбъектовСоСтороннимиПечатнымиФормами() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОБазовый.ТипыОбъектовСоСтороннимиПечатнымиФормами() +``` +
+ +## ЗаполнитьНастройкиПечатныхФормПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьНастройкиПечатныхФормПоУмолчанию(ОписанияНастроек) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОБазовый.ЗаполнитьНастройкиПечатныхФормПоУмолчанию(ОписанияНастроек) +``` +
+ +## ДокументКадровогоЭДОФормаСпискаПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ДокументКадровогоЭДОФормаСпискаПриСозданииНаСервере(УправляемаяФорма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОБазовый.ДокументКадровогоЭДОФормаСпискаПриСозданииНаСервере(УправляемаяФорма, Отказ, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйЭДОВнутренний.md b/src/content/docs/zup/КадровыйЭДОВнутренний.md new file mode 100644 index 0000000..587a522 --- /dev/null +++ b/src/content/docs/zup/КадровыйЭДОВнутренний.md @@ -0,0 +1,61 @@ +--- +title: Кадровый ЭДО внутренний +slug: zup/кадровый-эдо-внутренний +--- + + +## ТипыОбъектовСоСтороннимиПечатнымиФормами +
+ +Описание, пример вызова + +```bsl + +Функция ТипыОбъектовСоСтороннимиПечатнымиФормами() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОВнутренний.ТипыОбъектовСоСтороннимиПечатнымиФормами() +``` +
+ +## ЗаполнитьНастройкиПечатныхФормПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьНастройкиПечатныхФормПоУмолчанию(ОписанияНастроек) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОВнутренний.ЗаполнитьНастройкиПечатныхФормПоУмолчанию(ОписанияНастроек) +``` +
+ +## ДокументКадровогоЭДОФормаСпискаПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ДокументКадровогоЭДОФормаСпискаПриСозданииНаСервере(УправляемаяФорма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОВнутренний.ДокументКадровогоЭДОФормаСпискаПриСозданииНаСервере(УправляемаяФорма, Отказ, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйЭДОВызовСервера.md b/src/content/docs/zup/КадровыйЭДОВызовСервера.md new file mode 100644 index 0000000..169bc00 --- /dev/null +++ b/src/content/docs/zup/КадровыйЭДОВызовСервера.md @@ -0,0 +1,69 @@ +--- +title: Кадровый ЭДО вызов сервера +slug: zup/кадровый-эдо-вызов-сервера +--- + + +## ВыводимыеФайлыПечатныхФорм +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив описаний файлов для вывода на диск, отправке по почте, публикации ... +// +// Параметры: +// ФайлыДляВывода - Массив, ссылок на присоединенные файлы. +// ИдентификаторХранилища - УникальныйИдентификатор, идентификатор формы из которой выполняется вывод. +// +// Возвращаемое значение: +// Массив - описаний выводимых файлов, см. ОписаниеВыводимогоФайла +// +Функция ВыводимыеФайлыПечатныхФорм(ФайлыДляВывода, ИдентификаторХранилища = Неопределено, ПапкиЭлектронныхДокументов = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОВызовСервера.ВыводимыеФайлыПечатныхФорм(ФайлыДляВывода, ИдентификаторХранилища, ПапкиЭлектронныхДокументов); +``` +
+ +## ПечатныеФормыОбъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив данных печатных форм объектов. +// +// Параметры: +// ОписанияПечатныхФорм - Массив, структур описывающих табличные документы общей формы ПечатьДокументов +// Ключи структуры: +// * ПечатнаяФорма - ТабличныйДокумент +// * ИдентификаторПечатнойФормы - Строка +// * Название - Строка +// ОбъектыПечати - см. УправлениеПечатьюПереопределяемый.ПриПечати +// ПараметрыПечати - см. УправлениеПечатьюПереопределяемый.ПриПечати +// ИдентификаторХранилища - УникальныйИдентификатор, идентификатор формы для которой собирается коллекция. +// +// Возвращаемое значение: +// Массив - данных печатных форм, см. КадровыйЭДО.ДанныеПечатнойФормы +// +Функция ПечатныеФормыОбъектов(ОписанияПечатныхФорм, ОбъектыПечати, ПараметрыПечати, ИдентификаторХранилища) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОВызовСервера.ПечатныеФормыОбъектов(ОписанияПечатныхФорм, ОбъектыПечати, ПараметрыПечати, ИдентификаторХранилища) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйЭДОКлиент.md b/src/content/docs/zup/КадровыйЭДОКлиент.md new file mode 100644 index 0000000..8924fcd --- /dev/null +++ b/src/content/docs/zup/КадровыйЭДОКлиент.md @@ -0,0 +1,132 @@ +--- +title: Кадровый ЭДО клиент +slug: zup/кадровый-эдо-клиент +--- + + +## ОбработкаОповещения +
+ +Описание, пример вызова + +```bsl + +// Выполняет обработку оповещения о записи печатных форм объектов, обновляет +// информацию о блокировке. +// +// Параметры: +// УправляемаяФорма - УправляемаяФорма +// ИмяСобытия - Строка +// Параметр - Произвольный - См. описание одноименного параметра в синтакс-помощнике +// "ФормаКлиентскогоПриложения.ОбработкаОповещения". +// Источник - Произвольный - См. описание одноименного параметра в синтакс-помощнике +// "ФормаКлиентскогоПриложения.ОбработкаОповещения". +// +Процедура ОбработкаОповещения(УправляемаяФорма, ИмяСобытия, Параметр, Источник) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОКлиент.ОбработкаОповещения(УправляемаяФорма, ИмяСобытия, Параметр, Источник) +``` +
+ +## ОбработкаОповещенияВФормеСписка +
+ +Описание, пример вызова + +```bsl + +// Обновляет подключаемые команды в форме списка при обработке оповещения о записи печатных форм. +// +// Параметры: +// УправляемаяФорма - УправляемаяФорма +// ИмяСобытия - Строка +// Параметр - Произвольный - См. описание одноименного параметра в синтакс-помощнике +// "ФормаКлиентскогоПриложения.ОбработкаОповещения". +// Источник - Произвольный - См. описание одноименного параметра в синтакс-помощнике +// "ФормаКлиентскогоПриложения.ОбработкаОповещения". +// +Процедура ОбработкаОповещенияВФормеСписка(УправляемаяФорма, ИмяСобытия, Параметр, Источник) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОКлиент.ОбработкаОповещенияВФормеСписка(УправляемаяФорма, ИмяСобытия, Параметр, Источник) +``` +
+ +## ПечатьДокументовВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +// СтандартныеПодсистемы.УправлениеПечатью + +// См. УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовВыполнитьКоманду +// +Процедура ПечатьДокументовВыполнитьКоманду(Форма, Команда, ПродолжитьВыполнениеНаСервере, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОКлиент.ПечатьДокументовВыполнитьКоманду(Форма, Команда, ПродолжитьВыполнениеНаСервере, ДополнительныеПараметры) +``` +
+ +## ПечатьДокументовПослеОткрытия +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеПечатьюКлиентПереопределяемый.ПечатьДокументовПослеОткрытия +Процедура ПечатьДокументовПослеОткрытия(Форма) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОКлиент.ПечатьДокументовПослеОткрытия(Форма) +``` +
+ +## ПодписатьПечатныеФомыПриПечати +
+ +Описание, пример вызова + +```bsl + +// Конец СтандартныеПодсистемы.УправлениеПечатью + +// Выполняет подписание печатных форм, выведенных в общую форму ПечатьДокументов. +// +// Параметры: +// УправляемаяФорма - УправляемаяФорма, общая форма ПечатьДокументов +// ЦельПодписания - ПеречислениеСсылка.ДействияСФайламиДокументовКЭДО +// ДанныеСертификатовОрганизаций - Соответсвие +// * Ключ - Организация +// * Значение - Массив, ссылок на +// - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования +// - СправочникСсылка.Пользователи +// +Процедура ПодписатьПечатныеФомыПриПечати(УправляемаяФорма, ЦельПодписания, НастройкиПодписания = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОКлиент.ПодписатьПечатныеФомыПриПечати(УправляемаяФорма, ЦельПодписания, НастройкиПодписания); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйЭДОКлиентСервер.md b/src/content/docs/zup/КадровыйЭДОКлиентСервер.md new file mode 100644 index 0000000..7ef063a --- /dev/null +++ b/src/content/docs/zup/КадровыйЭДОКлиентСервер.md @@ -0,0 +1,37 @@ +--- +title: Кадровый ЭДО клиент сервер +slug: zup/кадровый-эдо-клиент-сервер +--- + + +## ОбновитьКоманды +
+ +Описание, пример вызова + +```bsl + +// Обновляет подключаемые команды формы, меня пиктограммы у команд печати с присоединенным файлом. +// +// Параметры: +// УправляемаяФорма - УправляемаяФорма +// ОбъектФормы - ДанныеФормыСтруктура, основной объект формы +// - ДинамическийСписок, формы списка +// ВыполнитьСтандартныйОбработчик - Булево +// +Процедура ОбновитьКоманды(УправляемаяФорма, ОбъектФормы, ВыполнитьСтандартныйОбработчик) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОКлиентСервер.ОбновитьКоманды(УправляемаяФорма, ОбъектФормы, ВыполнитьСтандартныйОбработчик) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйЭДОПовтИсп.md b/src/content/docs/zup/КадровыйЭДОПовтИсп.md new file mode 100644 index 0000000..4236c79 --- /dev/null +++ b/src/content/docs/zup/КадровыйЭДОПовтИсп.md @@ -0,0 +1,109 @@ +--- +title: Кадровый ЭДО повт исп +slug: zup/кадровый-эдо-повт-исп +--- + + +## НастройкиПечатныхФорм +
+ +Описание, пример вызова + +```bsl + +Функция НастройкиПечатныхФорм() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОПовтИсп.НастройкиПечатныхФорм() +``` +
+ +## СсылкаНаКодДокументаКадровогоМероприятия +
+ +Описание, пример вызова + +```bsl + +Функция СсылкаНаКодДокументаКадровогоМероприятия(КодДокументаКадровогоМероприятия) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОПовтИсп.СсылкаНаКодДокументаКадровогоМероприятия(КодДокументаКадровогоМероприятия) +``` +
+ +## КодКадровогоДокументаПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +Функция КодКадровогоДокументаПоУмолчанию() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОПовтИсп.КодКадровогоДокументаПоУмолчанию() +``` +
+ +## СвойстваКодаКадровогоДокумента +
+ +Описание, пример вызова + +```bsl + +Функция СвойстваКодаКадровогоДокумента(Знач КодДокументаКадровогоМероприятия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОПовтИсп.СвойстваКодаКадровогоДокумента(КодДокументаКадровогоМероприятия); +``` +
+ +## ДанныеМЧДПодписи +
+ +Описание, пример вызова + +```bsl + +Функция ДанныеМЧДПодписи(МЧД, ИдентификаторХранилища) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОПовтИсп.ДанныеМЧДПодписи(МЧД, ИдентификаторХранилища) +``` +
+ +## ДокументКЭДОЭлектронногоДокумента +
+ +Описание, пример вызова + +```bsl + +Функция ДокументКЭДОЭлектронногоДокумента(ЭлектронныйДокумент) Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОПовтИсп.ДокументКЭДОЭлектронногоДокумента(ЭлектронныйДокумент) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КадровыйЭДОРасширенный.md b/src/content/docs/zup/КадровыйЭДОРасширенный.md new file mode 100644 index 0000000..9fb3f2e --- /dev/null +++ b/src/content/docs/zup/КадровыйЭДОРасширенный.md @@ -0,0 +1,61 @@ +--- +title: Кадровый ЭДО расширенный +slug: zup/кадровый-эдо-расширенный +--- + + +## ТипыОбъектовСоСтороннимиПечатнымиФормами +
+ +Описание, пример вызова + +```bsl + +Функция ТипыОбъектовСоСтороннимиПечатнымиФормами() Экспорт +``` + +Пример вызова +```bsl +Результат = КадровыйЭДОРасширенный.ТипыОбъектовСоСтороннимиПечатнымиФормами() +``` +
+ +## ЗаполнитьНастройкиПечатныхФормПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьНастройкиПечатныхФормПоУмолчанию(ОписанияНастроек) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОРасширенный.ЗаполнитьНастройкиПечатныхФормПоУмолчанию(ОписанияНастроек) +``` +
+ +## ДокументКадровогоЭДОФормаСпискаПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ДокументКадровогоЭДОФормаСпискаПриСозданииНаСервере(УправляемаяФорма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +КадровыйЭДОРасширенный.ДокументКадровогоЭДОФормаСпискаПриСозданииНаСервере(УправляемаяФорма, Отказ, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КонтактнаяИнформацияБЗК.md b/src/content/docs/zup/КонтактнаяИнформацияБЗК.md new file mode 100644 index 0000000..7f20377 --- /dev/null +++ b/src/content/docs/zup/КонтактнаяИнформацияБЗК.md @@ -0,0 +1,671 @@ +--- +title: Контактная информация БЗК +slug: zup/контактная-информация-бзк +--- + + +## СвернутьСведенияОбАдресе +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру адреса приведенную к указанному составу полей. +// +// Параметры: +// СведенияОбАдресе - Структура - Результат одной из функций: +// • РаботаСАдресами.СведенияОбАдресе; +// • КонтактнаяИнформацияБЗК.СведенияОбАдресеСТипами. +// ИменаПолей - Строка - Имена полей возвращаемой структуры. +// Поддерживаются все поля структуры СведенияОбАдресе. +// Кроме того, поддерживаются поля "Корпус", "Строение", "Литера", "Сооружение", "Участок", "Квартира". +// Примеры: "Индекс, Регион, Район, Город, НаселенныйПункт, Территория, Улица, Дом, Корпус, Строение, Квартира", +// "Индекс, Регион, Район, НаселенныйПункт, Улица, Дом, Корпус, Квартира". +// +// Возвращаемое значение: +// Структура - Свернутая структура адреса. +// +Функция СвернутьСведенияОбАдресе(СведенияОбАдресе, ИменаПолей, Разделитель = ", ") Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.СвернутьСведенияОбАдресе(СведенияОбАдресе, ИменаПолей, Разделитель, ") +``` +
+ +## СтруктураКорпусов +
+ +Описание, пример вызова + +```bsl + +// Преобразует массив корпусов из сведений об адресе в структуру корпусов. +// +// Параметры: +// СведенияОбАдресе - Структура - См. РаботаСАдресами.СведенияОбАдресе или КонтактнаяИнформацияБЗК.СтруктураКорпусов. +// - Массив из Структура - Значение свойства "Корпуса" результата функции СведенияОбАдресе. +// +// Возвращаемое значение: +// Структура - Перечень корпусов в виде структуры: +// * Корпус - Строка +// * Строение - Строка +// * Литера - Строка +// * Сооружение - Строка +// * Участок - Строка +// +Функция СтруктураКорпусов(СведенияОбАдресе, ТребуетсяЛитера = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.СтруктураКорпусов(СведенияОбАдресе, ТребуетсяЛитера); +``` +
+ +## ПредставлениеКорпусов +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление корпусов адреса. +// +// Параметры: +// СведенияОбАдресе - Структура - См. РаботаСАдресами.СведенияОбАдресе или КонтактнаяИнформацияБЗК.СтруктураКорпусов. +// ОграничениеДлины - Число - Используется для определения переключения между полным и кратким представлением. +// Разделитель - Строка - Разделитель корпусов. +// +// Возвращаемое значение: +// Строка - Представление корпусов. +// +Функция ПредставлениеКорпусов(СведенияОбАдресе, ОграничениеДлины = 0, Разделитель = ", ") Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ПредставлениеКорпусов(СведенияОбАдресе, ОграничениеДлины, Разделитель, ") +``` +
+ +## ПредставлениеКорпусовПолное +
+ +Описание, пример вызова + +```bsl + +// Возвращает полное представление корпусов адреса. +// +// Параметры: +// СведенияОбАдресе - Структура - См. РаботаСАдресами.СведенияОбАдресе или КонтактнаяИнформацияБЗК.СтруктураКорпусов. +// Разделитель - Строка - Разделитель корпусов. +// +// Возвращаемое значение: +// Строка - Полное представление корпусов. +// +Функция ПредставлениеКорпусовПолное(СведенияОбАдресе, Разделитель = ", ") Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ПредставлениеКорпусовПолное(СведенияОбАдресе, Разделитель, ") +``` +
+ +## ПредставлениеКорпусовКраткое +
+ +Описание, пример вызова + +```bsl + +// Возвращает краткое представление корпусов адреса. +// +// Параметры: +// СведенияОбАдресе - Структура - См. РаботаСАдресами.СведенияОбАдресе или КонтактнаяИнформацияБЗК.СтруктураКорпусов. +// РазделительКорпусов - Строка - Строка вставляемая между корпусами. +// РазделительТипа - Строка - Строка вставляемая между типом и представлением корпуса. +// +// Возвращаемое значение: +// Строка - Краткое представление корпусов. +// +Функция ПредставлениеКорпусовКраткое(СведенияОбАдресе, РазделительКорпусов = ", ", РазделительТипа = ". ") Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ПредставлениеКорпусовКраткое(СведенияОбАдресе, РазделительКорпусов, ", РазделительТипа); +``` +
+ +## СтруктураПомещений +
+ +Описание, пример вызова + +```bsl + +// Преобразует массив помещений из сведений об адресе в структуру помещений. +// +// Параметры: +// СведенияОбАдресе - Структура - См. РаботаСАдресами.СведенияОбАдресе или КонтактнаяИнформацияБЗК.СтруктураКвартир. +// - Массив из Структура - Значение свойства "Помещения" результата функции СведенияОбАдресе. +// +// Возвращаемое значение: +// Структура - Перечень помещений в виде структуры: +// * Квартира - Строка +// * Офис - Строка +// * Бокс - Строка +// * Помещение - Строка +// * Комната - Строка +// * Этаж - Строка +// * АЯ - Строка +// * ПО - Строка +// * ВЧ - Строка +// +Функция СтруктураПомещений(СведенияОбАдресе) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.СтруктураПомещений(СведенияОбАдресе) +``` +
+ +## ПредставлениеПомещений +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление помещений адреса. +// +// Параметры: +// СведенияОбАдресе - Структура - См. РаботаСАдресами.СведенияОбАдресе, КонтактнаяИнформацияБЗК.СтруктураПомещений. +// ОграничениеДлины - Число - Используется для определения переключения между полным и кратким представлением. +// Разделитель - Строка - Строка вставляемая между помещениями. +// РазделительТипа - Строка - Строка вставляемая между типом и представлением помещения. +// +// Возвращаемое значение: +// Строка - Представление помещений. +// +Функция ПредставлениеПомещений(СведенияОбАдресе, ОграничениеДлины = 0, Разделитель = ", ", РазделительТипа = ". ") Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ПредставлениеПомещений(СведенияОбАдресе, ОграничениеДлины, Разделитель, ", РазделительТипа); +``` +
+ +## ПредставлениеПомещенийПолное +
+ +Описание, пример вызова + +```bsl + +// Возвращает полное представление помещений адреса. +// +// Параметры: +// СведенияОбАдресе - Структура - См. РаботаСАдресами.СведенияОбАдресе, КонтактнаяИнформацияБЗК.СтруктураПомещений. +// Разделитель - Строка - Строка вставляемая между помещениями. +// РазделительТипа - Строка - Строка вставляемая между типом и представлением помещения. +// +// Возвращаемое значение: +// Строка - Полное представление помещений. +// +Функция ПредставлениеПомещенийПолное(СведенияОбАдресе, Разделитель = ", ", РазделительТипа = ". ") Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ПредставлениеПомещенийПолное(СведенияОбАдресе, Разделитель, ", РазделительТипа); +``` +
+ +## ПредставлениеПомещенийКраткое +
+ +Описание, пример вызова + +```bsl + +// Возвращает краткое представление корпусов адреса. +// +// Параметры: +// СведенияОбАдресе - Структура - См. РаботаСАдресами.СведенияОбАдресе, КонтактнаяИнформацияБЗК.СтруктураПомещений. +// Разделитель - Строка - Строка вставляемая между помещениями. +// РазделительТипа - Строка - Строка вставляемая между типом и представлением помещения. +// +// Возвращаемое значение: +// Строка - Краткое представление помещений. +// +Функция ПредставлениеПомещенийКраткое(СведенияОбАдресе, Разделитель = ", ", РазделительТипа = ". ") Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ПредставлениеПомещенийКраткое(СведенияОбАдресе, Разделитель, ", РазделительТипа); +``` +
+ +## СведенияОбАдресеСТипами +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения об адресе в виде отдельных частей адреса и различных кодов (код региона, ОКТМО и др.). +// Возвращаемые поля содержат адресные сокращения (ул., р-н, и так далее...). +// К корпусам типы не добавляются. +// Для получения представления корпусов рекомендуется использовать функцию ПредставлениеКорпусов. +// +// Параметры: +// Адрес - Строка - адрес во внутреннем формате JSON или в XML, соответствующем XDTO-пакету Адрес. +// - ОбъектXDTO - XDTO-объект, соответствующий XDTO пакету Адрес. +// +// Возвращаемое значение: +// Структура: +// * Представление - Строка - Представление адреса по административно-территориальному делению. +// * МуниципальноеПредставление - Строка - Представление адреса по муниципальному делению. +// * ТипАдреса - Строка - Основной тип адреса (только для адресов РФ). +// Варианты: "Муниципальный", "Административно-территориальный". +// * Страна - Строка - Представление страны. +// * КодСтраны - Строка - Код страны по ОКСМ. +// * Индекс - Строка - Почтовый индекс. +// * КодРегиона - Строка - Код региона РФ. +// * Регион - Строка - Представление региона РФ. +// * Район - Строка - Представление района у адресов по административно-территориальному делению. +// * МуниципальныйРайон - Строка - Представление муниципального района для адреса по муниципальному делению. +// * КодМуниципальногоРайона - Строка - Код муниципального района: +// 1- муниципальный район; 2- городской округ; 3 - внутригородская территория +// города федерального значения; 4 - муниципальный округ. +// Если не удалось определить код, то возвращается пустая строка. +// * Город - Строка - Представление города у адресов по административно-территориальному делению. +// * Поселение - Строка - Представление поселения у адресов по муниципальному делению. +// * КодПоселения - Строка - код поселения: 1 - городское поселение; 2 - сельское поселение; 3- межселенная +// территория в составе муниципального района; 4 - внутригородской район +// городского округа; +// * ВнутригородскойРайон - Строка - Представление внутригородского района. +// * НаселенныйПункт - Строка - Представление населенного пункта. +// * Территория - Строка - Представление территории (элемента планировочной структуры). +// * Улица - Строка - Представление улицы. +// * Здание - Структура +// ** ТипЗдания - Строка - Тип объекта адресации адреса РФ согласно приказу Минфина России от 5.11.2015 г. N171н. +// ** Номер - Строка - Представление номера дома (только для адресов РФ). +// * Корпуса - Структура - Перечень корпусов адреса: "Корпус", "Строение", "Литера", "Сооружение", "Участок". +// * Квартира - Строка - Номер квартиры. +// * НомерЗемельногоУчастка - Строка - Представление номера земельного участка (только для адресов РФ). +// * Комментарий - Строка - комментарий об адресе. +// * ИдентификаторАдресногоОбъекта - УникальныйИдентификатор - идентификационный код последнего адресного объекта +// в иерархи адреса. Например, для адреса: Москва г., Дмитровское ш., д.9 это +// будет идентификатор улицы. +// Поле отсутствует, если дополнительный параметр КодыАдреса равен Ложь. +// * ИдентификаторДома - УникальныйИдентификатор - идентификационный код дома(строения) адресного объекта. +// Поле отсутствует, если дополнительный параметр КодыАдреса равен Ложь. +// Пустая строка если значение отсутствует. +// * ИдентификаторЗемельногоУчастка - УникальныйИдентификатор - идентификационный код земельного участка +// адресного объекта. При отсутствии значения - пустая строка. +// * ДополнительныеКоды - Структура - коды ОКТМО, ОКТМО, ОКАТО, КодИФНСФЛ, КодИФНСЮЛ, КодУчасткаИФНСФЛ, КодУчасткаИФНСЮЛ. +// Поле отсутствует, если дополнительный параметр КодыАдреса равен Ложь. +// +Функция СведенияОбАдресеСТипами(Адрес) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.СведенияОбАдресеСТипами(Адрес) +``` +
+ +## ИндексИПредставлениеАдреса +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру с индексом и представлением адреса без индекса. +// +// Параметры: +// ЗначениеАдреса - Строка - Адрес в формате JSON. +// +// Возвращаемое значение: +// Структура +// * Индекс - Строка - Индекс адреса. +// * Представление - Строка - Представлением адреса без индекса. +// +Функция ИндексИПредставлениеАдреса(ЗначениеАдреса) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ИндексИПредставлениеАдреса(ЗначениеАдреса) +``` +
+ +## ПредставлениеАдресаБезИндекса +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление адреса без индекса. +// +// Параметры: +// СтруктураАдреса - Структура - См. РаботаСАдресами.СведенияОбАдресе. +// +// Возвращаемое значение: +// Строка - Представление адреса без индекса. +// +Функция ПредставлениеАдресаБезИндекса(СтруктураАдреса) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ПредставлениеАдресаБезИндекса(СтруктураАдреса) +``` +
+ +## СтруктураТелефона +
+ +Описание, пример вызова + +```bsl + +// Возвращает сведения о телефоне. +// Возвращает корректные значения полей структуры в случае, +// если номер телефона изначально введен без пробелов и разделителей (например: +79992223344). +// +// Параметры: +// ЗначениеТелефона - Строка - Значение контактной информации типа "Телефон" в формате JSON. +// +// Возвращаемое значение: +// Структура - См. УправлениеКонтактнойИнформацией.СведенияОТелефоне. +// +Функция СтруктураТелефона(ЗначениеТелефона) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.СтруктураТелефона(ЗначениеТелефона) +``` +
+ +## ПредставлениеТелефона +
+ +Описание, пример вызова + +```bsl + +// Возвращает представление телефона. +// +// Параметры: +// ЗначениеТелефона - Строка - Значение контактной информации типа "Телефон" (строка json или xml). +// - Структура - Результат функции КонтактнаяИнформацияБЗК.СтруктураТелефона. +// ОграничениеДлины - Число - Ограничение длины телефона. +// ДляПечатиПоБуквам - Булево - Если Истина то будет сформировано представление для функции +// ПрямыеВыплатыПособийСоциальногоСтрахования.ВывестиТелефонПоБуквам. +// +// Возвращаемое значение: +// Строка - Удобочитаемое представление телефона, например: "+7 123 456-78-90". +// +Функция ПредставлениеТелефона(ЗначениеТелефона, ОграничениеДлины = 0, ДляПечатиПоБуквам = Ложь, ВыводитьКомментарий = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ПредставлениеТелефона(ЗначениеТелефона, ОграничениеДлины, ДляПечатиПоБуквам, ВыводитьКомментарий); +``` +
+ +## КонтактнаяИнформацияОбъектов +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу, содержащую контактную информацию нескольких объектов. +// Работает аналогично функции УправлениеКонтактнойИнформацией.КонтактнаяИнформацияОбъектов, +// однако не поднимает исключение в случае, если дата не указана, +// и поддерживает передачу одной ссылки или объекта в параметре СсылкиИлиОбъекты. +// +// Параметры: +// СсылкиИлиОбъекты - Массив, ФиксированныйМассив, ЛюбаяСсылка, Объект +// ТипыКонтактнойИнформации - Массив, ПеречислениеСсылка.ТипыКонтактнойИнформации, Неопределено +// ВидыКонтактнойИнформации - Массив, СправочникСсылка.ВидыКонтактнойИнформации, Неопределено +// Дата - Дата, Неопределено +// +// Возвращаемое значение: +// ТаблицаЗначений +// * Объект - ЛюбаяСсылка +// * Вид - СправочникСсылка.ВидыКонтактнойИнформации +// * Тип - ПеречислениеСсылка.ТипыКонтактнойИнформации +// * Значение - Строка +// * Представление - Строка +// * Дата - Дата +// * ИдентификаторСтрокиТабличнойЧасти - Число +// * ЗначенияПолей - Строка +// +Функция КонтактнаяИнформацияОбъектов(Знач СсылкиИлиОбъекты, Знач ТипыКонтактнойИнформации = Неопределено, Знач ВидыКонтактнойИнформации = Неопределено, Знач Дата = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.КонтактнаяИнформацияОбъектов(СсылкиИлиОбъекты, ТипыКонтактнойИнформации, ВидыКонтактнойИнформации, Дата); +``` +
+ +## ПредставлениеКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Получает представление контактной информации объекта заданного вида. +// +// Параметры: +// ТаблицаКИ - ТаблицаЗначений - См. УправлениеКонтактнойИнформацией.КонтактнаяИнформацияОбъектов. +// Владелец - ЛюбаяСсылка - Владелец контактной информации. +// Вид - СправочникСсылка.ВидыКонтактнойИнформации - Вид контактной информации. +// +// Возвращаемое значение: +// Строка +// +Функция ПредставлениеКонтактнойИнформации(ТаблицаКИ, Владелец = Неопределено, Вид = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ПредставлениеКонтактнойИнформации(ТаблицаКИ, Владелец, Вид); +``` +
+ +## ЗначениеКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Получает представление контактной информации объекта заданного вида. +// +// Параметры: +// ТаблицаКИ - ТаблицаЗначений - См. УправлениеКонтактнойИнформацией.КонтактнаяИнформацияОбъектов. +// Владелец - ЛюбаяСсылка - Владелец контактной информации. +// Вид - СправочникСсылка.ВидыКонтактнойИнформации - Вид контактной информации. +// +// Возвращаемое значение: +// Строка +// +Функция ЗначениеКонтактнойИнформации(ТаблицаКИ, Владелец = Неопределено, Вид = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.ЗначениеКонтактнойИнформации(ТаблицаКИ, Владелец, Вид); +``` +
+ +## НайтиКонтактнуюИнформацию +
+ +Описание, пример вызова + +```bsl + +// Находит контактную информацию объекта заданного вида. +// +// Параметры: +// ТаблицаКИ - ТаблицаЗначений - См. УправлениеКонтактнойИнформацией.КонтактнаяИнформацияОбъектов. +// Владелец - ЛюбаяСсылка - Владелец контактной информации. +// Вид - СправочникСсылка.ВидыКонтактнойИнформации - Вид контактной информации. +// +// Возвращаемое значение: +// СтрокаТаблицыЗначений, Неопределено +// +Функция НайтиКонтактнуюИнформацию(ТаблицаКИ, Владелец = Неопределено, Вид = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КонтактнаяИнформацияБЗК.НайтиКонтактнуюИнформацию(ТаблицаКИ, Владелец, Вид); +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Обработчик для события формы ПриСозданииНаСервере, вызывается после вызова соответствующего метода подсистемы +// УправлениеКонтактнойИнформации. Дополняет элементы отображения полей ввода адресов, полями +// отображающими результаты проверки адресов на корректность. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - Форма объекта-владельца, предназначенная для вывода контактной +// +Процедура ПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +КонтактнаяИнформацияБЗК.ПриСозданииНаСервере(Форма) +``` +
+ +## ОбновитьКонтактнуюИнформацию +
+ +Описание, пример вызова + +```bsl + +// Добавляет (удаляет) поле ввода или комментарий на форму. +// +Процедура ОбновитьКонтактнуюИнформацию(Форма, Результат, ЗависимостиВидовАдресов = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонтактнаяИнформацияБЗК.ОбновитьКонтактнуюИнформацию(Форма, Результат, ЗависимостиВидовАдресов); +``` +
+ +## ОбновитьПолеВводаАдреса +
+ +Описание, пример вызова + +```bsl + +// Обновляет представление и отображение поля ввода адреса. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - Обновляемая форма. +// ИмяПоляВводаПредставления - Строка - Имя поля ввода, связанного с реквизитом формы, +// в котором хранится представление контактной информации. +// Пример: "ПредставлениеАдресаОрганизации". +// ЗначениеКонтактнойИнформации - Строка - Значение контактной информации в XML или JSON. +// +Процедура ОбновитьПолеВводаАдреса(Форма, ИмяПоляВводаПредставления, ЗначениеКонтактнойИнформации) Экспорт +``` + +Пример вызова +```bsl +КонтактнаяИнформацияБЗК.ОбновитьПолеВводаАдреса(Форма, ИмяПоляВводаПредставления, ЗначениеКонтактнойИнформации) +``` +
+ +## ОбновитьПолеВводаТелефона +
+ +Описание, пример вызова + +```bsl + +// Обновляет представление и отображение поля ввода телефона. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - Обновляемая форма. +// ИмяПоляВводаПредставления - Строка - Имя поля ввода, связанного с реквизитом формы, +// в котором хранится представление контактной информации. +// Пример: "ПредставлениеАдресаОрганизации". +// ЗначениеКонтактнойИнформации - Строка - Значение контактной информации в XML или JSON. +// +Процедура ОбновитьПолеВводаТелефона(Форма, ИмяПоляВводаПредставления, ЗначениеКонтактнойИнформации) Экспорт +``` + +Пример вызова +```bsl +КонтактнаяИнформацияБЗК.ОбновитьПолеВводаТелефона(Форма, ИмяПоляВводаПредставления, ЗначениеКонтактнойИнформации) +``` +
+ +## ОбновитьПолеВводаКонтактнойИнформации +
+ +Описание, пример вызова + +```bsl + +// Обновляет представление и отображение поля ввода контактной информации. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - Обновляемая форма. +// ИмяПоляВводаПредставления - Строка - Имя поля ввода, связанного с реквизитом формы, +// в котором хранится представление контактной информации. +// Пример: "ПредставлениеАдресаОрганизации". +// ЗначениеКонтактнойИнформации - Строка - Значение контактной информации в XML или JSON. +// ТипКонтактнойИнформации - ПеречислениеСсылка.ТипыКонтактнойИнформации +// +Процедура ОбновитьПолеВводаКонтактнойИнформации(Форма, ИмяПоляВводаПредставления, ЗначениеКонтактнойИнформации, ТипКонтактнойИнформации) Экспорт +``` + +Пример вызова +```bsl +КонтактнаяИнформацияБЗК.ОбновитьПолеВводаКонтактнойИнформации(Форма, ИмяПоляВводаПредставления, ЗначениеКонтактнойИнформации, ТипКонтактнойИнформации) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КонтрольВеденияУчетаБЗК.md b/src/content/docs/zup/КонтрольВеденияУчетаБЗК.md new file mode 100644 index 0000000..70fd5ca --- /dev/null +++ b/src/content/docs/zup/КонтрольВеденияУчетаБЗК.md @@ -0,0 +1,109 @@ +--- +title: Контроль ведения учета БЗК +slug: zup/контроль-ведения-учета-бзк +--- + + +## ПриСозданииНаСервереФормыСписка +
+ +Описание, пример вызова + +```bsl + +// Доопределяет КонтрольВеденияУчета.ПриСозданииНаСервереФормыСписка, меняя значение +// КартинкаЗначений на коллекцию пиктограмм +// Для выводимой слева колонки с проблемой устанавливает значение ФиксацияВТаблице такое же +// как и у следующей колонки. +// +Процедура ПриСозданииНаСервереФормыСписка(Форма, ИменаСписков, ДополнительныеСвойства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаБЗК.ПриСозданииНаСервереФормыСписка(Форма, ИменаСписков, ДополнительныеСвойства); +``` +
+ +## ПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Переопределяет работу КонтрольВеденияУчета.ПриЧтенииНаСервере, заменяя единственное сообщение +// о наличии проблем на несколько детальных. +// +Процедура ПриЧтенииНаСервере(Форма, ТекущийОбъект) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаБЗК.ПриЧтенииНаСервере(Форма, ТекущийОбъект) +``` +
+ +## ПриПолученииДанныхНаСервере +
+ +Описание, пример вызова + +```bsl + +// Переопределяет работу обработчика (КонтрольВеденияУчета.ПриПолученииДанныхНаСервере), устанавливая значениям +// колонок с проблемами порядок самой "страшной" проблемы, учитывает, что ключи динамического списка могут быть +// более разнообразными чем одно поле (но записи при этом остаются уникальными в пределах одного из реквизитов +// ключа). +// +Процедура ПриПолученииДанныхНаСервере(Настройки, Строки, ИмяКлючевогоПоля = "Ссылка", ДополнительныеСвойства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаБЗК.ПриПолученииДанныхНаСервере(Настройки, Строки, ИмяКлючевогоПоля, ДополнительныеСвойства); +``` +
+ +## ПослеЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// После записи очищает список проблем у первой из проблем делает уточнение "Ожидает проверки" +// +Процедура ПослеЗаписиНаСервере(Форма, ТекущийОбъект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаБЗК.ПослеЗаписиНаСервере(Форма, ТекущийОбъект, ПараметрыЗаписи) +``` +
+ +## ЗаписатьПроблему +
+ +Описание, пример вызова + +```bsl + +// См. КонтрольВеденияУчета.ЗаписатьПроблему +Процедура ЗаписатьПроблему(Проблема, ПараметрыПроверки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаБЗК.ЗаписатьПроблему(Проблема, ПараметрыПроверки); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КонтрольВеденияУчетаКлиентБЗК.md b/src/content/docs/zup/КонтрольВеденияУчетаКлиентБЗК.md new file mode 100644 index 0000000..b547648 --- /dev/null +++ b/src/content/docs/zup/КонтрольВеденияУчетаКлиентБЗК.md @@ -0,0 +1,47 @@ +--- +title: Контроль ведения учета клиент БЗК +slug: zup/контроль-ведения-учета-клиент-бзк +--- + + +## ОткрытьОтчетПоПроблемамОбъекта +
+ +Описание, пример вызова + +```bsl + +// См. КонтрольВеденияУчетаКлиент.ОткрытьОтчетПоПроблемамОбъекта +Процедура ОткрытьОтчетПоПроблемамОбъекта(Форма, ПроблемныйОбъект, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаКлиентБЗК.ОткрытьОтчетПоПроблемамОбъекта(Форма, ПроблемныйОбъект, СтандартнаяОбработка) +``` +
+ +## ОткрытьОтчетПоПроблемамИзСписка +
+ +Описание, пример вызова + +```bsl + +// См. КонтрольВеденияУчетаКлиент.ОткрытьОтчетПоПроблемамИзСписка +Процедура ОткрытьОтчетПоПроблемамИзСписка(Форма, ИмяСписка, Поле, СтандартнаяОбработка, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КонтрольВеденияУчетаКлиентБЗК.ОткрытьОтчетПоПроблемамИзСписка(Форма, ИмяСписка, Поле, СтандартнаяОбработка, ДополнительныеПараметры); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КонтрольСоответствияНачисленийИВыплат.md b/src/content/docs/zup/КонтрольСоответствияНачисленийИВыплат.md new file mode 100644 index 0000000..0581487 --- /dev/null +++ b/src/content/docs/zup/КонтрольСоответствияНачисленийИВыплат.md @@ -0,0 +1,29 @@ +--- +title: Контроль соответствия начислений и выплат +slug: zup/контроль-соответствия-начислений-и-выплат +--- + + +## Отключить +
+ +Описание, пример вызова + +```bsl + +Процедура Отключить(Движения) Экспорт +``` + +Пример вызова +```bsl +КонтрольСоответствияНачисленийИВыплат.Отключить(Движения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КонфигурацииЗарплатаКадры.md b/src/content/docs/zup/КонфигурацииЗарплатаКадры.md new file mode 100644 index 0000000..a0b8502 --- /dev/null +++ b/src/content/docs/zup/КонфигурацииЗарплатаКадры.md @@ -0,0 +1,31 @@ +--- +title: Конфигурации зарплата кадры +slug: zup/конфигурации-зарплата-кадры +--- + + +## ПриОпределенииПодходящегоТипа +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует обновить БИД и использовать процедуру ДополнитьСоответствиеТипов. +// См. ИнтеграцияС1СДокументооборотПереопределяемый.ПриОпределенииПодходящегоТипа. +Процедура ПриОпределенииПодходящегоТипа(ТипОбъектаXDTO, ТипыКандидаты, ПодходящийТип) Экспорт +``` + +Пример вызова +```bsl +КонфигурацииЗарплатаКадры.ПриОпределенииПодходящегоТипа(ТипОбъектаXDTO, ТипыКандидаты, ПодходящийТип) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КонфигурацииЗарплатаКадрыБазовый.md b/src/content/docs/zup/КонфигурацииЗарплатаКадрыБазовый.md new file mode 100644 index 0000000..a5cd081 --- /dev/null +++ b/src/content/docs/zup/КонфигурацииЗарплатаКадрыБазовый.md @@ -0,0 +1,47 @@ +--- +title: Конфигурации зарплата кадры базовый +slug: zup/конфигурации-зарплата-кадры-базовый +--- + + +## ПриОпределенииОбщихПараметровБазовойФункциональности +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияПереопределяемый.ПриОпределенииОбщихПараметровБазовойФункциональности. +Процедура ПриОпределенииОбщихПараметровБазовойФункциональности(ОбщиеПараметры) Экспорт +``` + +Пример вызова +```bsl +КонфигурацииЗарплатаКадрыБазовый.ПриОпределенииОбщихПараметровБазовойФункциональности(ОбщиеПараметры) +``` +
+ +## ПриУстановкеНачальныхНастроек +
+ +Описание, пример вызова + +```bsl + +// См. ПользователиПереопределяемый.ПриУстановкеНачальныхНастроек +Процедура ПриУстановкеНачальныхНастроек(НачальныеНастройки) Экспорт +``` + +Пример вызова +```bsl +КонфигурацииЗарплатаКадрыБазовый.ПриУстановкеНачальныхНастроек(НачальныеНастройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КонфигурацииЗарплатаКадрыВнутренний.md b/src/content/docs/zup/КонфигурацииЗарплатаКадрыВнутренний.md new file mode 100644 index 0000000..1f9cbc8 --- /dev/null +++ b/src/content/docs/zup/КонфигурацииЗарплатаКадрыВнутренний.md @@ -0,0 +1,45 @@ +--- +title: Конфигурации зарплата кадры внутренний +slug: zup/конфигурации-зарплата-кадры-внутренний +--- + + +## ПриОпределенииОбщихПараметровБазовойФункциональности +
+ +Описание, пример вызова + +```bsl + +Процедура ПриОпределенииОбщихПараметровБазовойФункциональности(ОбщиеПараметры) Экспорт +``` + +Пример вызова +```bsl +КонфигурацииЗарплатаКадрыВнутренний.ПриОпределенииОбщихПараметровБазовойФункциональности(ОбщиеПараметры) +``` +
+ +## ПриУстановкеНачальныхНастроек +
+ +Описание, пример вызова + +```bsl + +Процедура ПриУстановкеНачальныхНастроек(НачальныеНастройки) Экспорт +``` + +Пример вызова +```bsl +КонфигурацииЗарплатаКадрыВнутренний.ПриУстановкеНачальныхНастроек(НачальныеНастройки) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КонфигурацииЗарплатаКадрыКлиент.md b/src/content/docs/zup/КонфигурацииЗарплатаКадрыКлиент.md new file mode 100644 index 0000000..9669983 --- /dev/null +++ b/src/content/docs/zup/КонфигурацииЗарплатаКадрыКлиент.md @@ -0,0 +1,34 @@ +--- +title: Конфигурации зарплата кадры клиент +slug: zup/конфигурации-зарплата-кадры-клиент +--- + + +## РазрешенаРаботаМобильногоКлиента +
+ +Описание, пример вызова + +```bsl + +// Определяет возможность использования программы в режиме мобильного клиента. +// Может быть переопределен в расширении, которое предоставляет функциональность для работы мобильного клиента. +// +// Возвращаемое значение: +// Булево - +Функция РазрешенаРаботаМобильногоКлиента() Экспорт +``` + +Пример вызова +```bsl +Результат = КонфигурацииЗарплатаКадрыКлиент.РазрешенаРаботаМобильногоКлиента() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КонфигурацииЗарплатаКадрыРасширенный.md b/src/content/docs/zup/КонфигурацииЗарплатаКадрыРасширенный.md new file mode 100644 index 0000000..ba065da --- /dev/null +++ b/src/content/docs/zup/КонфигурацииЗарплатаКадрыРасширенный.md @@ -0,0 +1,31 @@ +--- +title: Конфигурации зарплата кадры расширенный +slug: zup/конфигурации-зарплата-кадры-расширенный +--- + + +## ПриОпределенииПодходящегоТипа +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует обновить БИД и использовать процедуру ДополнитьСоответствиеТипов. +// См. ИнтеграцияС1СДокументооборотПереопределяемый.ПриОпределенииПодходящегоТипа. +Процедура ПриОпределенииПодходящегоТипа(ТипОбъектаXDTO, ТипыКандидаты, ПодходящийТип) Экспорт +``` + +Пример вызова +```bsl +КонфигурацииЗарплатаКадрыРасширенный.ПриОпределенииПодходящегоТипа(ТипОбъектаXDTO, ТипыКандидаты, ПодходящийТип) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КриптографияБЭДСлужебныйКлиент.md b/src/content/docs/zup/КриптографияБЭДСлужебныйКлиент.md new file mode 100644 index 0000000..b7e5b61 --- /dev/null +++ b/src/content/docs/zup/КриптографияБЭДСлужебныйКлиент.md @@ -0,0 +1,988 @@ +--- +title: Криптография БЭД служебный клиент +slug: zup/криптография-бэд-служебный-клиент +--- + + +## НовыйКонтекстПроверкиПодписи +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ВидОперации - Строка +// * Подпись - Неопределено,ДвоичныеДанные +// * ИсходныеДанные - Неопределено,ДвоичныеДанные +// * МенеджерКриптографии - Неопределено,МенеджерКриптографии +// * ОповещениеОЗавершении - ОписаниеОповещения +// * РезультатПроверки - см. КриптографияБЭДКлиентСервер.НовыйРезультатПроверкиПодписи +// * КонтекстДиагностики - см. ОбработкаНеисправностейБЭДКлиент.НовыйКонтекстДиагностики +Функция НовыйКонтекстПроверкиПодписи() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияБЭДСлужебныйКлиент.НовыйКонтекстПроверкиПодписи() +``` +
+ +## ПроверитьПодписьПослеПолученияСертификатовИзПодписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// РезультатПолучения - см. НовыйРезультатИнициализацииСертификатов +// Контекст - Структура: +// * ВидОперации - Строка +// * Подпись - ДвоичныеДанные +// * ИсходныеДанные - ДвоичныеДанные +// * МенеджерКриптографии - МенеджерКриптографии +// * ОповещениеОЗавершении - ОписаниеОповещения +// * РезультатПроверки - см. КриптографияБЭДКлиентСервер.НовыйРезультатПроверкиПодписи +// * КонтекстДиагностики - см. ОбработкаНеисправностейБЭДКлиент.НовыйКонтекстДиагностики +Процедура ПроверитьПодписьПослеПолученияСертификатовИзПодписиНаСервере(РезультатПолучения, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПроверитьПодписьПослеПолученияСертификатовИзПодписиНаСервере(РезультатПолучения, Контекст) +``` +
+ +## ОбработатьОшибкуПолученияМенеджераКриптографии +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработатьОшибкуПолученияМенеджераКриптографии(ИнформацияОбОшибке, СтандартнаяОбработка, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ОбработатьОшибкуПолученияМенеджераКриптографии(ИнформацияОбОшибке, СтандартнаяОбработка, Контекст) +``` +
+ +## ПроверитьПодписьПослеПолученияМенеджераКриптографии +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьПодписьПослеПолученияМенеджераКриптографии(МенеджерКриптографии, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПроверитьПодписьПослеПолученияМенеджераКриптографии(МенеджерКриптографии, Контекст) +``` +
+ +## ОбработатьОшибкуПолученияСертификатовИзПодписи +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке +// СтандартнаяОбработка - Булево +// Контекст - см. НовыйКонтекстПроверкиПодписи +Процедура ОбработатьОшибкуПолученияСертификатовИзПодписи(ИнформацияОбОшибке, СтандартнаяОбработка, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ОбработатьОшибкуПолученияСертификатовИзПодписи(ИнформацияОбОшибке, СтандартнаяОбработка, Контекст) +``` +
+ +## ПроверитьПодписьПослеПолученияСертификатовИзПодписи +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьПодписьПослеПолученияСертификатовИзПодписи(СертификатыПодписи, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПроверитьПодписьПослеПолученияСертификатовИзПодписи(СертификатыПодписи, Контекст) +``` +
+ +## ОбработатьОшибкуВыгрузкиСертификата +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработатьОшибкуВыгрузкиСертификата(ИнформацияОбОшибке, СтандартнаяОбработка, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ОбработатьОшибкуВыгрузкиСертификата(ИнформацияОбОшибке, СтандартнаяОбработка, Контекст) +``` +
+ +## ПроверитьПодписьПослеВыгрузкиСертификата +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьПодписьПослеВыгрузкиСертификата(ДанныеСертификата, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПроверитьПодписьПослеВыгрузкиСертификата(ДанныеСертификата, Контекст) +``` +
+ +## ПроверитьПодписьЗавершение +
+ +Описание, пример вызова + +```bsl + +// Продолжение процедуры ПроверитьПодписьПослеВыгрузкиСертификата. +// +// Параметры: +// Результат - Булево +// - Строка +// - Неопределено +// Контекст - Структура: +// * ВидОперации - Строка +// * Оповещение - ОписаниеОповещения +// * КонтекстДиагностики - См. ОбработкаНеисправностейБЭДКлиент.НовыйКонтекстДиагностики +// * ПаролиСертификатов - См. КриптографияБЭДКлиент.Подписать.ПаролиСертификатов +Процедура ПроверитьПодписьЗавершение(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПроверитьПодписьЗавершение(Результат, Контекст) +``` +
+ +## ПроверитьПодписьЗавершениеПродолжение +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьПодписьЗавершениеПродолжение(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПроверитьПодписьЗавершениеПродолжение(Результат, Контекст) +``` +
+ +## ПослеВыполненияКриптографическойОперации +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеВыполненияКриптографическойОперации(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПослеВыполненияКриптографическойОперации(Результат, Контекст) +``` +
+ +## ОбработатьОшибкиКриптографическойОперации +
+ +Описание, пример вызова + +```bsl + +// Обрабатывает ошибки криптографической операции. +// +// Параметры: +// Результат - Структура - см. описание результата, возвращаемого при выполнении оповещения, переданного в параметре +// ОбработкаРезультата метода ЭлектроннаяПодписьКлиент.Подписать +// ВидОперации - Строка +// КонтекстДиагностики - См. ОбработкаНеисправностейБЭДКлиент.НовыйКонтекстДиагностики +Процедура ОбработатьОшибкиКриптографическойОперации(Результат, ВидОперации, КонтекстДиагностики) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ОбработатьОшибкиКриптографическойОперации(Результат, ВидОперации, КонтекстДиагностики) +``` +
+ +## ДобавитьОшибкуКриптографии +
+ +Описание, пример вызова + +```bsl + +// Добавляет ошибку криптографии в контекст диагностики. +// +// Параметры: +// КонтекстДиагностики - См. ОбработкаНеисправностейБЭДКлиент.НовыйКонтекстДиагностики +// ВидОперации - Строка +// ПодробноеПредставлениеОшибки - Строка +// КраткоеПредставлениеОшибки - Строка +// ДополнительныеПараметрыОшибки - Структура +Процедура ДобавитьОшибкуКриптографии(КонтекстДиагностики, ВидОперации, ПодробноеПредставлениеОшибки, Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ДобавитьОшибкуКриптографии(КонтекстДиагностики, ВидОперации, ПодробноеПредставлениеОшибки, ); +``` +
+ +## ПолучитьОтпечаткиСертификатов +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьОтпечаткиСертификатов(Оповещение, Личные, ПоказатьОшибку = Ложь) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПолучитьОтпечаткиСертификатов(Оповещение, Личные, ПоказатьОшибку); +``` +
+ +## ПослеПолученияОтпечатков +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеПолученияОтпечатков(Отпечатки, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПослеПолученияОтпечатков(Отпечатки, Контекст) +``` +
+ +## НайтиСоздатьСертификатКриптографии +
+ +Описание, пример вызова + +```bsl + +Процедура НайтиСоздатьСертификатКриптографии(Отпечаток, Организация, Оповещение) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.НайтиСоздатьСертификатКриптографии(Отпечаток, Организация, Оповещение) +``` +
+ +## ПослеПолученияОтпечатковПолучитьМенеджерКриптографии +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеПолученияОтпечатковПолучитьМенеджерКриптографии(Отпечатки, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПослеПолученияОтпечатковПолучитьМенеджерКриптографии(Отпечатки, Контекст) +``` +
+ +## ПолучитьМенеджерКриптографииПослеПолученияСертификатаКриптографии +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьМенеджерКриптографииПослеПолученияСертификатаКриптографии(Сертификат, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПолучитьМенеджерКриптографииПослеПолученияСертификатаКриптографии(Сертификат, Контекст) +``` +
+ +## СертификатВыгрузитьПродолжить +
+ +Описание, пример вызова + +```bsl + +Процедура СертификатВыгрузитьПродолжить(ДвоичныеДанныеСертификата, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.СертификатВыгрузитьПродолжить(ДвоичныеДанныеСертификата, Контекст) +``` +
+ +## ВыполнитьДействияПослеПолученияМенеджераКриптографии +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполнитьДействияПослеПолученияМенеджераКриптографии(МенеджерКриптографии, Контекст = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ВыполнитьДействияПослеПолученияМенеджераКриптографии(МенеджерКриптографии, Контекст); +``` +
+ +## СоздатьНайтиСертификатКриптографииПользователя +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьНайтиСертификатКриптографииПользователя(ИнформацияМодуля, Контекст = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.СоздатьНайтиСертификатКриптографииПользователя(ИнформацияМодуля, Контекст); +``` +
+ +## ПроверитьНаличиеУстановленныхПрограммПослеПоискаУстановленныхПрограмм +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьНаличиеУстановленныхПрограммПослеПоискаУстановленныхПрограмм(РезультатПроверки, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПроверитьНаличиеУстановленныхПрограммПослеПоискаУстановленныхПрограмм(РезультатПроверки, Контекст) +``` +
+ +## ОбработкаРезультатаТестаСертификата +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаРезультатаТестаСертификата(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ОбработкаРезультатаТестаСертификата(Результат, ДополнительныеПараметры) +``` +
+ +## ОбработкаЗавершенияТестаСертификата +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаЗавершенияТестаСертификата(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ОбработкаЗавершенияТестаСертификата(Результат, Контекст) +``` +
+ +## ПолучитьДоступныеСертификатыПослеПолученияОтпечатков +
+ +Описание, пример вызова + +```bsl + +Процедура ПолучитьДоступныеСертификатыПослеПолученияОтпечатков(Результат, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПолучитьДоступныеСертификатыПослеПолученияОтпечатков(Результат, Контекст) +``` +
+ +## ОпределитьПрограммуСертификатаПослеИнициализацииСертификата +
+ +Описание, пример вызова + +```bsl + +Процедура ОпределитьПрограммуСертификатаПослеИнициализацииСертификата(СертификатКриптографии, Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ОпределитьПрограммуСертификатаПослеИнициализацииСертификата(СертификатКриптографии, Контекст) +``` +
+ +## НачатьОпределениеПрограммыСертификатаКриптографии +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОпределениеПрограммыСертификатаКриптографии(Знач Сертификат, Знач ОбработкаЗавершения, Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.НачатьОпределениеПрограммыСертификатаКриптографии(Сертификат, ОбработкаЗавершения, ); +``` +
+ +## ИспользоватьЭлектроннуюПодписьВМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Булево +Функция ИспользоватьЭлектроннуюПодписьВМоделиСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияБЭДСлужебныйКлиент.ИспользоватьЭлектроннуюПодписьВМоделиСервиса()); +``` +
+ +## ЗавершитьОпределениеПрограммыСертификатаКриптографии +
+ +Описание, пример вызова + +```bsl + +Процедура ЗавершитьОпределениеПрограммыСертификатаКриптографии(Знач ПроцессВыполнения) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ЗавершитьОпределениеПрограммыСертификатаКриптографии(ПроцессВыполнения)); +``` +
+ +## НовыйПроцессОпределенияПрограммыСертификатаКриптографии +
+ +Описание, пример вызова + +```bsl + +Функция НовыйПроцессОпределенияПрограммыСертификатаКриптографии(Знач Сертификат, Знач ОбработкаЗавершения, Знач Пароль) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияБЭДСлужебныйКлиент.НовыйПроцессОпределенияПрограммыСертификатаКриптографии(Сертификат, ОбработкаЗавершения, Пароль)); +``` +
+ +## ВыполнитьОпределениеПрограммыСертификатаКриптографии +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполнитьОпределениеПрограммыСертификатаКриптографии(Знач РезультатТекущегоЭтапа, Знач ПроцессВыполнения) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ВыполнитьОпределениеПрограммыСертификатаКриптографии(РезультатТекущегоЭтапа, ПроцессВыполнения) +``` +
+ +## ВыполнитьОпределениеПрограммыСертификатаКриптографии_НайтиУстановленныеПрограммы +
+ +Описание, пример вызова + +```bsl + +Функция ВыполнитьОпределениеПрограммыСертификатаКриптографии_НайтиУстановленныеПрограммы(ПроцессВыполнения) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияБЭДСлужебныйКлиент.ВыполнитьОпределениеПрограммыСертификатаКриптографии_НайтиУстановленныеПрограммы(ПроцессВыполнения)); +``` +
+ +## ВыполнитьОпределениеПрограммыСертификатаКриптографии_ВводПароля +
+ +Описание, пример вызова + +```bsl + +Функция ВыполнитьОпределениеПрограммыСертификатаКриптографии_ВводПароля(ПроцессВыполнения) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияБЭДСлужебныйКлиент.ВыполнитьОпределениеПрограммыСертификатаКриптографии_ВводПароля(ПроцессВыполнения)); +``` +
+ +## ВыполнитьОпределениеПрограммыСертификатаКриптографии_ПроверитьПрограммы +
+ +Описание, пример вызова + +```bsl + +Функция ВыполнитьОпределениеПрограммыСертификатаКриптографии_ПроверитьПрограммы(ПроцессВыполнения) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияБЭДСлужебныйКлиент.ВыполнитьОпределениеПрограммыСертификатаКриптографии_ПроверитьПрограммы(ПроцессВыполнения)); +``` +
+ +## НачатьПроверкуСертификатаКриптографииПрограммой +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПроверкуСертификатаКриптографииПрограммой(Знач Сертификат, Знач Программа, Знач Пароль, Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.НачатьПроверкуСертификатаКриптографииПрограммой(Сертификат, Программа, Пароль, ); +``` +
+ +## НачатьПроверкуСертификатаКриптографииПрограммой_ВыгрузкаСертификата +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПроверкуСертификатаКриптографииПрограммой_ВыгрузкаСертификата(Знач ДвоичныеДанныеСертификата, Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.НачатьПроверкуСертификатаКриптографииПрограммой_ВыгрузкаСертификата(ДвоичныеДанныеСертификата, ); +``` +
+ +## НачатьПроверкуСертификатаКриптографииПрограммой_СозданиеМенеджераКриптографии +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПроверкуСертификатаКриптографииПрограммой_СозданиеМенеджераКриптографии(Знач Менеджер, Знач Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.НачатьПроверкуСертификатаКриптографииПрограммой_СозданиеМенеджераКриптографии(Менеджер, Контекст) +``` +
+ +## НачатьПроверкуСертификатаКриптографииПрограммой_ПроверкаПодписания +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПроверкуСертификатаКриптографииПрограммой_ПроверкаПодписания(Знач ДанныеПодписи, Знач Контекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.НачатьПроверкуСертификатаКриптографииПрограммой_ПроверкаПодписания(ДанныеПодписи, Контекст) +``` +
+ +## НачатьПроверкуСертификатаКриптографииПрограммой_ПроверкаПодписанияОшибка +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПроверкуСертификатаКриптографииПрограммой_ПроверкаПодписанияОшибка(ИнформацияОбОшибке, Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.НачатьПроверкуСертификатаКриптографииПрограммой_ПроверкаПодписанияОшибка(ИнформацияОбОшибке, ); +``` +
+ +## УстановитьCryptoProCSPПослеВводаРегистрационныхДанных +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьCryptoProCSPПослеВводаРегистрационныхДанных(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.УстановитьCryptoProCSPПослеВводаРегистрационныхДанных(Результат, ВходящийКонтекст) +``` +
+ +## НовыеПараметрыРегистрацииПрограммыКриптографии +
+ +Описание, пример вызова + +```bsl + +Функция НовыеПараметрыРегистрацииПрограммыКриптографии() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияБЭДСлужебныйКлиент.НовыеПараметрыРегистрацииПрограммыКриптографии() +``` +
+ +## УстановитьКриптопровайдерПослеПолученияДистрибутива +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьКриптопровайдерПослеПолученияДистрибутива(ДлительнаяОперация, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.УстановитьКриптопровайдерПослеПолученияДистрибутива(ДлительнаяОперация, ВходящийКонтекст) +``` +
+ +## УстановитьКриптопровайдерПослеСозданияВременногоКаталога +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьКриптопровайдерПослеСозданияВременногоКаталога(ИмяКаталогаВременныхФайлов, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.УстановитьКриптопровайдерПослеСозданияВременногоКаталога(ИмяКаталогаВременныхФайлов, ВходящийКонтекст) +``` +
+ +## ПослеСохраненияФайловДистрибутива +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеСохраненияФайловДистрибутива(ПолученныеФайлы, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПослеСохраненияФайловДистрибутива(ПолученныеФайлы, ВходящийКонтекст) +``` +
+ +## УстановитьКриптопровайдерПослеВводаРегистрационныхДанныхПовторить +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьКриптопровайдерПослеВводаРегистрационныхДанныхПовторить(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.УстановитьКриптопровайдерПослеВводаРегистрационныхДанныхПовторить(Результат, ДополнительныеПараметры) +``` +
+ +## ЗапуститьПриложениеНаКлиенте +
+ +Описание, пример вызова + +```bsl + +Процедура ЗапуститьПриложениеНаКлиенте(СтрокаКоманды, ТекущийКаталог, ДождатьсяЗавершения, ВыводитьСообщения, Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ЗапуститьПриложениеНаКлиенте(СтрокаКоманды, ТекущийКаталог, ДождатьсяЗавершения, ВыводитьСообщения, ); +``` +
+ +## ЗапуститьПриложениеНаКлиентеПослеЗапускаПриложения +
+ +Описание, пример вызова + +```bsl + +Процедура ЗапуститьПриложениеНаКлиентеПослеЗапускаПриложения(КодВозврата, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ЗапуститьПриложениеНаКлиентеПослеЗапускаПриложения(КодВозврата, ВходящийКонтекст) +``` +
+ +## ЗапуститьПриложениеНаКлиентеПриОшибкеЗапускаПриложения +
+ +Описание, пример вызова + +```bsl + +Процедура ЗапуститьПриложениеНаКлиентеПриОшибкеЗапускаПриложения(ИнформацияОбОшибке, СтандартнаяОбработка, Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ЗапуститьПриложениеНаКлиентеПриОшибкеЗапускаПриложения(ИнформацияОбОшибке, СтандартнаяОбработка, ); +``` +
+ +## ПолучитьСертификатыИзПодписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения +// Подпись - ДвоичныеДанные +Процедура ПолучитьСертификатыИзПодписиНаСервере(ОповещениеОЗавершении, Подпись) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ПолучитьСертификатыИзПодписиНаСервере(ОповещениеОЗавершении, Подпись) +``` +
+ +## НовыйРезультатИнициализацииСертификатов +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * СертификатыКриптографии - Массив из СертификатКриптографии +// * ОписаниеОшибки - Строка +Функция НовыйРезультатИнициализацииСертификатов() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияБЭДСлужебныйКлиент.НовыйРезультатИнициализацииСертификатов()); +``` +
+ +## НовыйКонтекстИнициализацииСертификатов +
+ +Описание, пример вызова + +```bsl + +// Возвращаемое значение: +// Структура: +// * ИндексДанных - Число +// * ДвоичныеДанныеСертификатов - Массив из ДвоичныеДанные +// * СертификатыКриптографии - Массив из СертификатКриптографии +// * ОповещениеОЗавершении - ОписаниеОповещения +Функция НовыйКонтекстИнициализацииСертификатов() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияБЭДСлужебныйКлиент.НовыйКонтекстИнициализацииСертификатов()); +``` +
+ +## НачатьИнициализациюСертификатов +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения +// ДвоичныеДанныеСертификатов - Массив из ДвоичныеДанные +Процедура НачатьИнициализациюСертификатов(ОповещениеОЗавершении, ДвоичныеДанныеСертификатов) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.НачатьИнициализациюСертификатов(ОповещениеОЗавершении, ДвоичныеДанныеСертификатов)); +``` +
+ +## ИнициализироватьСертификатыПослеПодключенияРасширения +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// Подключено - Булево +// КонтекстИнициализации - см. НовыйКонтекстИнициализацииСертификатов +Процедура ИнициализироватьСертификатыПослеПодключенияРасширения(Подключено, КонтекстИнициализации) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ИнициализироватьСертификатыПослеПодключенияРасширения(Подключено, КонтекстИнициализации) +``` +
+ +## ИнициализироватьСертификаты +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// КонтекстИнициализации - см. НовыйКонтекстИнициализацииСертификатов +Процедура ИнициализироватьСертификаты(КонтекстИнициализации) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ИнициализироватьСертификаты(КонтекстИнициализации)); +``` +
+ +## ОбработатьОшибкуИнициализацииСертификата +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// ИнформацияОбОшибке - ИнформацияОбОшибке +// СтандартнаяОбработка - Булево +// КонтекстИнициализации - см. НовыйКонтекстИнициализацииСертификатов +Процедура ОбработатьОшибкуИнициализацииСертификата(ИнформацияОбОшибке, СтандартнаяОбработка, КонтекстИнициализации) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ОбработатьОшибкуИнициализацииСертификата(ИнформацияОбОшибке, СтандартнаяОбработка, КонтекстИнициализации) +``` +
+ +## ОбработатьРезультатИнициализацииСертификата +
+ +Описание, пример вызова + +```bsl + +// Параметры: +// СертификатКриптографии - СертификатКриптографии +// КонтекстИнициализации - см. НовыйКонтекстИнициализацииСертификатов +Процедура ОбработатьРезультатИнициализацииСертификата(СертификатКриптографии, КонтекстИнициализации) Экспорт +``` + +Пример вызова +```bsl +КриптографияБЭДСлужебныйКлиент.ОбработатьРезультатИнициализацииСертификата(СертификатКриптографии, КонтекстИнициализации) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КриптографияЭДКО.md b/src/content/docs/zup/КриптографияЭДКО.md new file mode 100644 index 0000000..069f495 --- /dev/null +++ b/src/content/docs/zup/КриптографияЭДКО.md @@ -0,0 +1,318 @@ +--- +title: Криптография ЭДКО +slug: zup/криптография-эдко +--- + + +## НайтиСертификат +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиска сертификата в хранилище. +Функция НайтиСертификат(Сертификат, ВыполнятьПроверку = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.НайтиСертификат(Сертификат, ВыполнятьПроверку); +``` +
+ +## НайтиОблачныйСертификат +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиска сертификата в хранилище DSS. +Функция НайтиОблачныйСертификат(Сертификат, ВыполнятьПроверку = Ложь, ТолькоЛичный = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.НайтиОблачныйСертификат(Сертификат, ВыполнятьПроверку, ТолькоЛичный); +``` +
+ +## ВычислитьИдентификаторСертификата +
+ +Описание, пример вызова + +```bsl + +Функция ВычислитьИдентификаторСертификата(СерийныйНомер, Издатель) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.ВычислитьИдентификаторСертификата(СерийныйНомер, Издатель) +``` +
+ +## НайтиСертификатПолучателя +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск сертификата получателя в хранилище сертификатов БРО +// +// Параметры: +// Сертификат - Структура - содержит поля для поиска сертификата, например поле ТипСертификата может содержать варианты: +// MY, AddressBook, CA, ROOT +// +// Возвращаемое значение: +// ФиксированнаяСтруктура +// +Функция НайтиСертификатПолучателя(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.НайтиСертификатПолучателя(Сертификат) +``` +
+ +## ДобавитьСертификатПолучателя +
+ +Описание, пример вызова + +```bsl + +// Выполняет добавление сертификата получателя в хранилище сертификатов БРО +// +// Параметры: +// Сертификат - Структура +// ТипХранилища - Строка - тип хранилища +// +// Возвращаемое значение +// Строка, Неопределено - Идентификатор сертификата в случае успеха +// +Функция ДобавитьСертификатПолучателя(Сертификат, ТипХранилища) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.ДобавитьСертификатПолучателя(Сертификат, ТипХранилища) +``` +
+ +## ПолучитьСертификатыПолучателей +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск сертификата получателя в хранилище сертификатов БРО +// +// Параметры: +// ТипХранилища - Строка - тип хранилища +// +Функция ПолучитьСертификатыПолучателей(ТипХранилища) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.ПолучитьСертификатыПолучателей(ТипХранилища) +``` +
+ +## ПолучитьСвойстваСертификатаПолучателя +
+ +Описание, пример вызова + +```bsl + +// Получает основные свойства переданного сертификата. +// +// Параметры: +// Сертификат - ДвоичныеДанные - сертификат, свойства которого необходимо получить. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - свойства сертификата: +// * Версия - Строка - версия сертификата. +// * ДатаНачала - Дата - дата начала действия сертификата (UTC). +// * ДатаОкончания - Дата - дата окончания действия сертификата (UTC). +// * Издатель - ФиксированнаяСтруктура - информация об издателе сертификата: +// ** CN - Строка - commonName +// ** O - Строка - organizationName; +// ** OU - Строка - organizationUnitName; +// ** C - Строка - countryName; +// ** ST - Строка - stateOrProvinceName; +// ** L - Строка - localityName; +// ** E - Строка - emailAddress; +// ** SN - Строка - surname; +// ** GN - Строка - givenName; +// ** T - Строка - title; +// ** STREET - Строка - streetAddress; +// ** OGRN - Строка - ОГРН; +// ** OGRNIP - Строка - ОГРНИП; +// ** INN - Строка - ИНН; +// ** SNILS - Строка - СНИЛС; +// ... +// * ИспользоватьДляПодписи - Булево - указывает, можно ли использовать данный сертификат для подписи. +// * ИспользоватьДляШифрования - Булево - указывает, можно ли использовать данный сертификат для шифрования. +// * ОткрытыйКлюч - ДвоичныеДанные - содержит данные открытого ключа. +// * Отпечаток - ДвоичныеДанные - содержит данные отпечатка. Вычисляется динамически, по алгоритму SHA-1. +// * РасширенныеСвойства - ФиксированнаяСтруктура - расширенные свойства сертификата: +// ** EKU - ФиксированныйМассив - Enhanced Key Usage. +// * СерийныйНомер - ДвоичныеДанные - серийный номер сертификата. +// * Субъект - ФиксированнаяСтруктура - информацию о субъекте сертификата. Состав см. Издатель. +// * Сертификат - ДвоичныеДанные - файл сертификата в кодировке DER. +// * Идентификатор - Строка - вычисляется по ключевым свойствам Издателя и серийному номеру по алгоритму SHA1. +// Используется для идентификации сертификата в сервисе криптографии. +// +Функция ПолучитьСвойстваСертификатаПолучателя(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.ПолучитьСвойстваСертификатаПолучателя(Сертификат) +``` +
+ +## АлгоритмКриптосообщенияИлиСертификата +
+ +Описание, пример вызова + +```bsl + +// Возвращает алгоритм зашифрованного или подписанного сообщения PKCS#7 либо сертификата X.509. +Функция АлгоритмКриптосообщенияИлиСертификата( Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.АлгоритмКриптосообщенияИлиСертификата(); +``` +
+ +## Добавить +
+ +Описание, пример вызова + +```bsl + +// Добавляет сертификат в хранилище сертификатов получателей. +// +// Параметры: +// Сертификат - ДвоичныеДанные - файл сертификата. +// - Строка - адрес файла сертификата во временном хранилище. +// ТипХранилища - Строка - тип хранилища, в которое необходимо добавить сертификат, возможные варианты: MY +// +Процедура Добавить(Сертификат, ТипХранилища) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКО.Добавить(Сертификат, ТипХранилища) +``` +
+ +## ИспользованиеОблачнойПодписиВозможно +
+ +Описание, пример вызова + +```bsl + +// Определяет доступность подсистемы облачной подписи в рамках обмена с КО (1С-Отчетность) +// +// Возвращаемое значение: +// Булево - Возвращает Истина, если база используется во Фреш и включена ФО "ЭлектроннаяОблачнаяПодпись" +// +Функция ИспользованиеОблачнойПодписиВозможно() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.ИспользованиеОблачнойПодписиВозможно() +``` +
+ +## ДоступнаПодсистемаКриптографииDSS +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие встроенной подсистемы поддержки облачной криптографии +// +// Возвращаемое значение: +// Булево - Возвращает Истина, если база используется во Фреш +// +Функция ДоступнаПодсистемаКриптографииDSS() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.ДоступнаПодсистемаКриптографииDSS() +``` +
+ +## РаботаВМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +// Определяет режим запуска приложения в коробке или модели сервиса +// +// Возвращаемое значение: +// Булево - Возвращает Истина, если база используется во Фреш +// +Функция РаботаВМоделиСервиса() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.РаботаВМоделиСервиса() +``` +
+ +## ДополнительныеНастройкиОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +// Получить дополнительные настройки для учетной записи облачной подписи в рамках обмена с КО (1С-Отчетность) +// +// Параметры: +// УчетнаяЗапись - СправочникСсылка.УчетныеЗаписиDSS, +// - СправочникСсылка.Организация +// +// Возвращаемое значение: +// Структура +// * +// +Функция ДополнительныеНастройкиОблачнойПодписи(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКО.ДополнительныеНастройкиОблачнойПодписи(УчетнаяЗапись) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КриптографияЭДКОКлиент.md b/src/content/docs/zup/КриптографияЭДКОКлиент.md new file mode 100644 index 0000000..aa9dcb5 --- /dev/null +++ b/src/content/docs/zup/КриптографияЭДКОКлиент.md @@ -0,0 +1,1883 @@ +--- +title: Криптография ЭДКО клиент +slug: zup/криптография-эдко-клиент +--- + + +## СоздатьМенеджерКриптографии +
+ +Описание, пример вызова + +```bsl + +// Создает менеджер криптографии из внешней компоненты. При необходимо компонента будет установлена. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// ПараметрыМодуляКриптографии - Структура - параметры создаваемого криптопровайдера +// * Имя - Строка - имя модуля криптографии. +// Используется, если менеджер создается для ОС Windows. +// * Путь - Строка - путь к файлу-библиотеке, реализующей требуемый набор функций. +// Используется, если менеджер создается для ОС Linux. +// * Тип - Число - тип модуля криптографии. +// +// ПредлагатьУстановкуРасширения - Булево. +// +// ПараметрыОпределенияАлгоритма - Структура - параметры для определения алгоритма: +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512", если алгоритм известен, +// при "" или ПараметрыОпределенияАлгоритма = Неопредлено используется первый алгоритм из списка +// КриптографияЭДКОКлиентСервер.ПоддерживаемыеАлгоритмы(), с поддержкой которого установлен криптопровайдер. +// - Неопределено - определить алгоритм по криптографическому сообщению или сертификату +// * Криптосообщение - ДвоичныеДанные, Строка - файл (двоичные данные, адрес во временном хранилище) в формате PKCS #7, +// из них извлекается алгоритм публичного ключа. +// - Неопределено - определить алгоритм по сертификату. +// * Сертификат - Структура - описание сертификата формата X.509, извлекается алгоритм ключа подписи. +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// ** Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// ** Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +Процедура СоздатьМенеджерКриптографии( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.СоздатьМенеджерКриптографии(); +``` +
+ +## ПолучитьКриптопровайдеры +
+ +Описание, пример вызова + +```bsl + +// Получает список поддерживаемых установленных криптопровайдеров. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * Криптопровайдеры - ФиксированныйМассив - список описаний криптопровайдеров +// ** Имя - Строка - имя модуля криптографии. +// ** Путь - Строка - путь к файлу-библиотеке, реализующей требуемый набор функций. +// ** Тип - Число - тип модуля криптографии. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// +// ТолькоПоддерживаемые - Булево - если Истина, то будут полученны криптопровайдеры из списка поддерживаемых +// (см. КриптографияЭДКОКлиентСервер.ПоддерживаемыеКриптопровайдеры). +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +Процедура ПолучитьКриптопровайдеры(ОповещениеОЗавершении, ТолькоПоддерживаемые = Истина, ВыводитьСоообщения = Истина, МенеджерКриптографии = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПолучитьКриптопровайдеры(ОповещениеОЗавершении, ТолькоПоддерживаемые, ВыводитьСоообщения, МенеджерКриптографии); +``` +
+ +## ПолучитьАлгоритмы +
+ +Описание, пример вызова + +```bsl + +// Получает список поддерживаемых алгоритмов хеширования. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * Алгоритмы - ФиксированныйМассив - список описаний алгоритмов +// ** Идентификатор - Число - идентификатор алгоритма, используется в Подписать и Зашифровать. +// ** Имя - Строка - текстовове представление алгоритма. +// ** ДлинаКлюча - Число - длина ключа в битах. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр АлгоритмИлиСертификат. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// АлгоритмИлиСертификат - Неопределено - использовать алгоритм по умолчанию КриптографияЭДКОКлиентСервер.АлгоритмПоУмолчанию(). +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// Структура - сертификат подписанта. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +Процедура ПолучитьАлгоритмы( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПолучитьАлгоритмы(); +``` +
+ +## ПолучитьКонтейнерыКлючей +
+ +Описание, пример вызова + +```bsl + +// Получает список имен контейнеров ключей. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * КонтейнерыКлючей - ФиксированныйМассив - список имен контейнеров. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// +// ПолучатьУникальныеИмена - Булево - Если Истина, то будут возвращены уникальные имена вида <носитель>\\<имя>, иначе - только <имя>. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +Процедура ПолучитьКонтейнерыКлючей(ОповещениеОЗавершении, ПолучатьУникальныеИмена = Ложь, ВыводитьСоообщения = Истина, МенеджерКриптографии = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПолучитьКонтейнерыКлючей(ОповещениеОЗавершении, ПолучатьУникальныеИмена, ВыводитьСоообщения, МенеджерКриптографии); +``` +
+ +## СгенерироватьИмяКонтейнера +
+ +Описание, пример вызова + +```bsl + +// Генерирует имя контейнера ключей на основе текущего времени и понятного пользователю наименования. +// +// Параметры: +// ОсноваИмени - Строка - например, краткое название организации. +// +// Возвращаемое значение: +// Строка - user-friendly имя контейнера ключей. +// +Функция СгенерироватьИмяКонтейнера(ОсноваИмени) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиент.СгенерироватьИмяКонтейнера(ОсноваИмени) +``` +
+ +## СоздатьКонтейнерКлючей +
+ +Описание, пример вызова + +```bsl + +// Создает контейнер с закрытым ключом. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * УникальноеИмяКонтейнера - Строка - полное имя созданного контейнера ключей. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// +// ИмяКонтейнераКлючей - Строка - имя создаваемого контейнера ключей. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - использовать алгоритм по умолчанию КриптографияЭДКОКлиентСервер.АлгоритмПоУмолчанию(). +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// +// ЭкспортируемыйКлюч - Булево. +// +Процедура СоздатьКонтейнерКлючей( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.СоздатьКонтейнерКлючей(); +``` +
+ +## СоздатьЗапросНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Создает файл запроса на сертификат. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ЗапросНаСертификат - Строка - запрос на сертификат в формате Base64-based. +// +// ТелоЗапросаНаСертификат - Строка - специально подготовленные данные для создания запроса на сертификат. +// +// ИмяКонтейнераКлючей - Строка - полное имя контейнера ключей. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - использовать алгоритм по умолчанию КриптографияЭДКОКлиентСервер.АлгоритмПоУмолчанию(). +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// +Процедура СоздатьЗапросНаСертификат( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.СоздатьЗапросНаСертификат(); +``` +
+ +## СоздатьКонтейнерИЗапросНаСертификат +
+ +Описание, пример вызова + +```bsl + +// Создает файл запроса на сертификат. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ЗапросНаСертификат - Строка - запрос на сертификат в формате Base64-based. +// * УникальноеИмяКонтейнера - Строка - полное имя созданного контейнера ключей. +// +// ТелоЗапросаНаСертификат - Строка - специально подготовленные данные для создания запроса на сертификат. +// +// ИмяКонтейнераКлючей - Строка - полное имя контейнера ключей. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - использовать алгоритм по умолчанию КриптографияЭДКОКлиентСервер.АлгоритмПоУмолчанию(). +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// +// ЭкспортируемыйКлюч - Булево. +// +Процедура СоздатьКонтейнерИЗапросНаСертификат( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.СоздатьКонтейнерИЗапросНаСертификат(); +``` +
+ +## СвязатьСертификатСКонтейнеромКлючей +
+ +Описание, пример вызова + +```bsl + +// Связывает сертификат из хранилища сертификатов с соответствующим контейнером закрытого ключа. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// +// Сертификат - Структура - описание сертификата. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// ИмяКонтейнераКлючей - Строка - полное имя контейнера ключей. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - определить алгоритм по сертификату. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// +Процедура СвязатьСертификатСКонтейнеромКлючей( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.СвязатьСертификатСКонтейнеромКлючей(); +``` +
+ +## УстановитьСертификатВКонтейнерИХранилище +
+ +Описание, пример вызова + +```bsl + +// Добавляет сертификат в хранилище сертификатов и связывает с соответствующим контейнером закрытого ключа. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// +// ИмяФайлаСертификата - Строка - файл сертификата. +// +// ИмяКонтейнераКлючей - Строка - полное имя контейнера ключей. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - определить алгоритм по сертификату. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// +Процедура УстановитьСертификатВКонтейнерИХранилище( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.УстановитьСертификатВКонтейнерИХранилище(); +``` +
+ +## ПолучитьСертификатИзКонтейнера +
+ +Описание, пример вызова + +```bsl + +// Получает файл сертификата из ключевого контейнера. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ИмяФайлаСертификата - Строка - имя файла, в который выгружен сертификат. +// +// ИмяКонтейнераКлючей - Строка. +// +// ИмяФайлаИлиРасширение - Строка - имя файла, в который необходимо сохранить результат. +// Также можно указать только расширение создаваемого файла - ".расширение". +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +Процедура ПолучитьСертификатИзКонтейнера( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПолучитьСертификатИзКонтейнера(); +``` +
+ +## ПолучитьСертификаты +
+ +Описание, пример вызова + +```bsl + +// Получает список описаний сертификатов из хранилищ сертификатов: локальном и/или облачном. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки и КодОшибки. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * КодОшибки - Строка - код ошибки выполнения. +// * Сертификаты - ФиксированныйМассив - список описаний сертификатов. +// ** Версия - Строка - версия сертификата. +// ** Наименование - Строка - представление сертификата. +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// ** ПоставщикСтруктура - ФиксированнаяСтруктура - информация об издателе сертификата: +// *** CN - commonName; 2.5.4.3, Краткое наименование организации или ФИО для физ.лица +// *** O - organizationName; 2.5.4.10, Краткое наименование организации, для физ лица отсуствует. +// *** OU - organizationUnitName; 2.5.4.11, Подразделение владельца ЭП +// *** C - countryName; 2.5.4.6, Страна +// *** ST - stateOrProvinceName; 2.5.4.8, Регион, область +// *** L - localityName; 2.5.4.7, Населенный пункт +// *** E - emailAddress; 1.2.840.113549.1.9.1, Электронная почта +// *** SN - surname; 2.5.4.4, Фамилия +// *** GN - givenName; 2.5.4.42, Имя Отчество +// *** T - title; 2.5.4.12, Должность +// *** STREET - streetAddress; 2.5.4.9, Название улицы, номер дома +// *** OGRN - ОГРН; 1.2.643.100.1, ОГРН +// *** OGRNIP - ОГРНИП; 1.2.643.100.5, ОГРНИП +// *** INN - ИНН; 1.2.643.3.131.1.1, ИНН (ФЛ) +// *** SNILS - СНИЛС; 1.2.643.100.3, СНИЛС +// *** INNLE - ИНН ЮЛ; 1.2.643.100.4, ИНН ЮЛ +// ** Владелец - Строка - владелец сертификата. +// ** ВладелецСтруктура - ФиксированнаяСтруктура - информация об владельце сертификата. См. ПоставщикСтруктура: +// ** Отпечаток - Строка - отпечаток сертификата. +// ** ИспользоватьДляПодписи - Булево - пригоден для подписывания. +// ** ИспользоватьДляШифрования - Булево - пригоден для шифрования. +// ** ДействителенС - Дата - начало срока действия. +// ** ДействителенПо - Дата - конец срока дейстия. +// ** Хранилище - Структура - описание хранилища, из которого получен сертификат +// *** Хранилище - Строка - одно из хранилищ MY, AddressBook, CA, ROOT. +// *** ЭтоЛокальноеХранилище - Булево - Ложь - хранилище сертификатов на сервере, Истина - локальное хранилище. +// +// ХранилищеСертификатов - Массив, Структура - описание хранилища, из которого необходимо получить сертификаты. +// * Хранилище - Строка - одно из хранилищ MY, AddressBook, CA, ROOT. +// * ЭтоЛокальноеХранилище - Булево - Ложь - хранилище сертификатов на сервере, Истина - локальное хранилище. +// +// ДополнительныеПараметры - Неопределено, Структура, ФиксированнаяСтруктура. +// * ПредлагатьУстановкуВнешнейКомпоненты - Булево - если Истина, то будет выведено предложение установить компоненту (если не установлена). +// Значение по умолчанию - Истина. +// * ВыводитьСообщения - Булево - если Истина, то ошибки выполнения будут выведены пользователю. +// Значение по умолчанию - Истина. +// +Процедура ПолучитьСертификаты(ОповещениеОЗавершении, ХранилищеСертификатов = Неопределено, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПолучитьСертификаты(ОповещениеОЗавершении, ХранилищеСертификатов, ДополнительныеПараметры); +``` +
+ +## ЭкспортироватьСертификатВФайл +
+ +Описание, пример вызова + +```bsl + +// Выгружает указанный сертификат хранилища в файл. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ИмяФайлаСертификата - Строка - имя файла, в который выгружен сертификат. +// +// Сертификат - Структура - описание сертификата. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// +// ИмяФайлаИлиРасширение - Строка - имя файла, в который необходимо сохранить результат. +// Также можно указать только расширение создаваемого файла - ".расширение". +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +Процедура Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ЭкспортироватьСертификатВФайл(ОповещениеОЗавершении, Сертификат, ИмяФайлаИлиРасширение, ); +``` +
+ +## ЭкспортироватьСертификатВBase64 +
+ +Описание, пример вызова + +```bsl + +// Выгружает указанный сертификат хранилища в строку base64. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * СтрокаBase64 - Строка - содержимое сертификата в Base64. +// +// Сертификат - Структура - описание сертификата. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +Процедура Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ЭкспортироватьСертификатВBase64(ОповещениеОЗавершении, Сертификат, ВыводитьСоообщения, МенеджерКриптографии, ДвоичныеДанные); +``` +
+ +## ИмпортироватьСертификат +
+ +Описание, пример вызова + +```bsl + +// Добавляет сертификат в указанное хранилище сертификатов. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * СвойстваСертификата - ФиксированнаяСтруктура - описание сертификата. +// ** Версия - Строка - версия сертификата. +// ** Наименование - Строка - представление сертификата. +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// ** Владелец - Строка - владелец сертификата. +// ** Отпечаток - Строка - отпечаток сертификата. +// ** ИспользоватьДляПодписи - Булево - пригоден для подписывания. +// ** ИспользоватьДляШифрования - Булево - пригоден для шифрования. +// ** ДействителенС - Дата - начало срока действия. +// ** ДействителенПо - Дата - конец срока дейстия. +// +// ИмяФайлаСертификата - Строка - файл сертификат. +// +// ХранилищеСертификатов - Строка - одно из хранилищ MY, AddressBook, CA, ROOT. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +Процедура ИмпортироватьСертификат(ОповещениеОЗавершении, ИмяФайлаСертификата, ХранилищеСертификатов, Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ИмпортироватьСертификат(ОповещениеОЗавершении, ИмяФайлаСертификата, ХранилищеСертификатов, ); +``` +
+ +## ПроверитьСертификат +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку сертификата. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * Валиден - Булево - сертификат соответствует требованиям проверки. +// +// Сертификат - Структура - описание сертификата. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// Проверки - Строка - при значении "ПроверитьТолькоПоСпискуУстановленныхУЦ" выполняется толко проверка соответствия списку установленных УЦ, +// при значении Неопределено выполняется проверка соответствию списка УЦ и срока действия. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - использовать автоопределение алгоритма внешней компонентой в момент операции. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(), +// при значении "*" определять алгоритм и криптопровайдер по сертификату. +// +Процедура ПроверитьСертификат( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПроверитьСертификат(); +``` +
+ +## ВыбратьСертификат +
+ +Описание, пример вызова + +```bsl + +// Открывает форму списка сертификатов для выбора. +// +// Параметры: +// МестоХраненияКлюча - Булево, Структура - определяет системное хранилище: локальное, защищенное хранилище на сервере или облачная подпись КриптоПро DSS. +// +// НачальноеЗначениеВыбора - Строка - отпечаток сертификата, на котором будет выполнено позиционирование при открытии формы выбора. +// +// ХранилищеСертификатов - Строка - задает хранилище, в котором необходимо произвести выбор. MY, AddressBook, CA, ROOT. +// +// ПоказыватьПросроченные - Булево - устанавливает признак необходимости отображать просроченные сертификаты в форме выбора. +// +// МножественныйВыбор - Булево - устанавливает признак множественного выбора сертификатов. +// +// Отпечатки - СписокЗначений - отпечатки тех сертификатов, которые должны быть отображены в списке. +// +// ЗапретитьВыборПросроченных - Булево - отпечатки тех сертификатов, которые должны быть отображены в списке. +// +Процедура ВыбратьСертификат( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ВыбратьСертификат(); +``` +
+ +## ОтобразитьПредставлениеСертификата +
+ +Описание, пример вызова + +```bsl + +// Процедура - Отображает представления сертификата или сертификатов в поле ввода +// +// Параметры: +// МестоХраненияКлюча - Булево, Структура - определяет системное хранилище: локальное, защищенное хранилище на сервере или облачная подпись КриптоПро DSS. +// ПолеВвода - ПолеФормы - поле формы, в котором выводится представление сертификата. +// Будет подкрашено красным, если в сертификате есть ошибка. +// Сертификат - Строка - отпечаток сертификата или свойства сертификата. +// - Массив - описание сертификатов. +// * Сертификат - Строка - отпечаток сертификата. +// Форма - ФормаКлиентскогоПриложения - форма, в которой выводится представление сертификата. +// ИмяРеквизитаПредставлениеСертификата - Строка - имя реквизита представления сертификат. +// ВыполняемоеОповещение - ОписаниеОповещения - описание процедуры, принимающей результат (не обязательный) +// ИспользоватьКомпонентуКриптографии - Булево - если ложь, то в коробке не будет использоваться компонента шифрования (не обязательный) +Процедура ОтобразитьПредставлениеСертификата( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ОтобразитьПредставлениеСертификата(); +``` +
+ +## ОтобразитьПредставленияСертификатов +
+ +Описание, пример вызова + +```bsl + +// Процедура - Отображает представления сертификатов в полях ввода +// +// Параметры: +// ПараметрыОтображенияСертификатов - Массив - описание параметров отображения сертификатов +// *ПолеВвода - ПолеФормы - поле формы, в котором выводится представление сертификата. +// Будет подкрашено красным, если в сертификате есть ошибка. +// *Сертификат - Строка - отпечаток сертификата или свойства сертификата. +// - Массив - описание сертификатов. +// * Сертификат - Строка - отпечаток сертификата. +// *ИмяРеквизитаПредставлениеСертификата - Строка - имя реквизита представления сертификат. +// Форма - ФормаКлиентскогоПриложения - форма, в которой выводится представление сертификата. +// МестоХраненияКлюча - Булево, Структура - определяет системное хранилище: локальное, защищенное хранилище на сервере или облачная подпись КриптоПро DSS. +// ВыполняемоеОповещение - ОписаниеОповещения - описание процедуры, принимающей результат (не обязательный) +Процедура ОтобразитьПредставленияСертификатов(ПараметрыОтображенияСертификатов, Форма, МестоХраненияКлюча, ВыполняемоеОповещение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ОтобразитьПредставленияСертификатов(ПараметрыОтображенияСертификатов, Форма, МестоХраненияКлюча, ВыполняемоеОповещение); +``` +
+ +## ПолноеПредставлениеСертификата +
+ +Описание, пример вызова + +```bsl + +// Представление и даты действия сертификата. +// +// Сертификат - Структура - описание сертификата. +// * Наименование - Строка - представление сертификата. +// * ДействителенС - Дата - начало срока действия. +// * ДействителенПо - Дата - конец срока дейстия. +// +// Возвращаемое значение: +// Строка. +// +Функция ПолноеПредставлениеСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиент.ПолноеПредставлениеСертификата(Сертификат) +``` +
+ +## НайтиСертификат +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск сертификата в хранилище по серийному номеру и издателю сертификата или по отпечатку. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * СертификатНайден - Булево - сертификат успешно найден. +// * СвойстваСертификата - ФиксированнаяСтруктура - описание сертификата. +// ** Версия - Строка - версия сертификата. +// ** Наименование - Строка - представление сертификата. +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// ** Владелец - Строка - владелец сертификата. +// ** Отпечаток - Строка - отпечаток сертификата. +// ** ИспользоватьДляПодписи - Булево - пригоден для подписывания. +// ** ИспользоватьДляШифрования - Булево - пригоден для шифрования. +// ** ДействителенС - Дата - начало срока действия. +// ** ДействителенПо - Дата - конец срока дейстия. +// ** Валиден - Булево - сертификат соответствует требованиям проверки. +// +// Сертификат - Структура - описание сертификата. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * МестоХраненияКлюча - Булево, Структура - определяет системное хранилище: локальное, защищенное хранилище на сервере или облачная подпись КриптоПро DSS. +// +// ВыполнятьПроверку - Булево - если Истина, то для найденых сертификатов будет выполняться проверка. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// АлгоритмПроверки - Неопределено - использовать автоопределение алгоритма внешней компонентой при проверке сертификата. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(), +// при значении "*" определять алгоритм и криптопровайдер по сертификату при проверке сертификата. +// +Процедура НайтиСертификат( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.НайтиСертификат(); +``` +
+ +## НайтиСертификаты +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск сертификатов в хранилище по их серийному номеру и издателю сертификата или по отпечатку. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * Сертификаты - ФиксированныйМассив - список описаний сертификатов. +// ** Версия - Строка - версия сертификата. +// ** Наименование - Строка - представление сертификата. +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// ** Владелец - Строка - владелец сертификата. +// ** Отпечаток - Строка - отпечаток сертификата. +// ** ИспользоватьДляПодписи - Булево - пригоден для подписывания. +// ** ИспользоватьДляШифрования - Булево - пригоден для шифрования. +// ** ДействителенС - Дата - начало срока действия. +// ** ДействителенПо - Дата - конец срока дейстия. +// ** Валиден - Булево - сертификат соответствует требованиям проверки. +// * НенайденныеСертификаты - Массив - сертификаты, которые не удалось найти. Состав свойств такой же как и во входящем параметры Сертификаты. +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// ** Отпечаток - Строка - отпечаток сертификата. +// +// Сертификаты - Массив - описание сертификатов. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * МестоХраненияКлюча - Булево, Структура - определяет системное хранилище: локальное, защищенное хранилище на сервере или облачная подпись КриптоПро DSS. +// +// ВыполнятьПроверку - Булево - если Истина, то для найденых сертификатов будет выполняться проверка. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// АлгоритмПроверки - Неопределено - использовать автоопределение алгоритма внешней компонентой при проверке сертификата. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(), +// при значении "*" определять алгоритм и криптопровайдер по сертификату при проверке сертификата. +// +Процедура НайтиСертификаты( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.НайтиСертификаты(); +``` +
+ +## НайтиСертификатПоОтпечатку +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск сертификата в хранилище по отпечатку сертификата. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * СертификатНайден - Булево - сертификат успешно найден. +// * СвойстваСертификата - ФиксированнаяСтруктура - описание сертификата. +// ** Версия - Строка - версия сертификата. +// ** Наименование - Строка - представление сертификата. +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// ** Владелец - Строка - владелец сертификата. +// ** Отпечаток - Строка - отпечаток сертификата. +// ** ИспользоватьДляПодписи - Булево - пригоден для подписывания. +// ** ИспользоватьДляШифрования - Булево - пригоден для шифрования. +// ** ДействителенС - Дата - начало срока действия. +// ** ДействителенПо - Дата - конец срока дейстия. +// ** Валиден - Булево - сертификат соответствует требованиям проверки. +// +// Отпечаток - Строка - отпечаток сертификата. +// +// ХранилищеСертификатов - Строка - задает хранилище для поиска. MY, AddressBook, CA, ROOT. +// +// ВыполнятьПроверку - Булево - если Истина, то для найденых сертификатов будет выполняться проверка. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// АлгоритмПроверки - Неопределено - использовать автоопределение алгоритма внешней компонентой при проверке сертификата. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(), +// при значении "*" определять алгоритм и криптопровайдер по сертификату при проверке сертификата. +// +Процедура НайтиСертификатПоОтпечатку( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.НайтиСертификатПоОтпечатку(); +``` +
+ +## НайтиСертификатыПоОтпечаткам +
+ +Описание, пример вызова + +```bsl + +// Выполняет поиск сертификатов в хранилище по их отпечаткам. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * Сертификаты - ФиксированныйМассив - список описаний сертификатов. +// ** Версия - Строка - версия сертификата. +// ** Наименование - Строка - представление сертификата. +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// ** Владелец - Строка - владелец сертификата. +// ** Отпечаток - Строка - отпечаток сертификата. +// ** ИспользоватьДляПодписи - Булево - пригоден для подписывания. +// ** ИспользоватьДляШифрования - Булево - пригоден для шифрования. +// ** ДействителенС - Дата - начало срока действия. +// ** ДействителенПо - Дата - конец срока дейстия. +// ** Валиден - Булево - сертификат соответствует требованиям проверки. +// * НенайденныеСертификаты - Массив - список отпечатков, для которых не найдены соответсвующие сертификаты. +// +// Отпечаток - Строка - отпечаток сертификата. +// +// ХранилищеСертификатов - Строка - задает хранилище для поиска. MY, AddressBook, CA, ROOT. +// +// ВыполнятьПроверку - Булево - если Истина, то для найденых сертификатов будет выполняться проверка. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// АлгоритмПроверки - Неопределено - использовать автоопределение алгоритма внешней компонентой при проверке сертификата. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(), +// при значении "*" определять алгоритм и криптопровайдер по сертификату при проверке сертификата. +// +Процедура НайтиСертификатыПоОтпечаткам( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.НайтиСертификатыПоОтпечаткам(); +``` +
+ +## ПоказатьСертификат +
+ +Описание, пример вызова + +```bsl + +// Открывает сертификат для просмотра в специализированной форме. +// +// Параметры: +// Сертификат - Структура, Массив - описание сертификата. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Адрес - Строка - адрес файла сертификата. +// +// ФормаВладелец - ФормаКлиентскогоПриложения - владелец формы. +// +Процедура ПоказатьСертификат(Сертификат, ФормаВладелец = Неопределено) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПоказатьСертификат(Сертификат, ФормаВладелец); +``` +
+ +## ПодписатьPKCS7 +
+ +Описание, пример вызова + +```bsl + +// Создает файл подписи для указанного файла данных в формате PKCS#7. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ФайлПодписи - Строка - имя файла или адрес во временном хранилище. +// +// Сертификат - Структура - описание сертификата. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// ФайлДанных - Строка - полное имя файла, который необходимо подписать, на клиенте. +// - Строка - адрес файла, который необходимо подписать, на сервере во временном хранилище. +// +// ВключатьИсходныеДанные - Булево - если Истина, то создает присоединенную подпись, иначе - отсоединенную. +// +// ИмяФайлаИлиРасширениеИлиАдрес - Неопределено - если в параметре ФайлДанных передан адрес во временном хранилище, +// то результат будет помещен во временное хранилище. +// - если передано полное имя файла на клиенте, +// то результат будет помещен во вновь созданный файл на клиенте. +// - Строка - имя файла, в который необходимо сохранить результат. +// - Строка - расширение файла результата. +// - Строка - адрес во временном хранилище, по которому необходимо сохранить результат. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - использовать автоопределение алгоритма внешней компонентой в момент операции. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(), +// при значении "*" определять алгоритм и криптопровайдер по сертификату. +// +Процедура ПодписатьPKCS7( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПодписатьPKCS7(); +``` +
+ +## ПроверитьПодписьPKCS7 +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку файла подписи в формате PKCS#7. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ПодписьВалидна - Булево - результат проверки подписи (при множественной подписи Истина, если подпись каждого подписанта валидна). +// * Подписанты - ФиксированныйМассив - описания сертификатов подписантов, при параметре ИмпортироватьСертификаты равном Ложь +// поддерживается извлечение, использование при проверке только одного подписанта. +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// ** Отпечаток - Строка - отпечаток сертификата. +// ** Выполнено - Булево - если Истина, то проверка подписи была выполнена для подписанта. +// ** ПодписьВалидна - Булево - результат проверки подписи для подписанта. +// +// МестоХраненияКлюча - Булево, Структура - определяет системное хранилище: локальное, защищенное хранилище на сервере или облачная подпись КриптоПро DSS. +// +// ФайлПодписи - Строка - полное имя файла подписи на клиенте. +// - Строка - адрес файла подписи на сервере во временном хранилище. +// +// ФайлДанных - Строка - полное имя файла данных на клиенте. +// - Строка - адрес файла данных на сервере во временном хранилище. +// +// ИмпортироватьСертификаты - Булево - добавлять сертификаты подписантов в хранилище в случае отсутствия там. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - использовать автоопределение алгоритма внешней компонентой в момент операции. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(), +// при значении "*" определять алгоритм и криптопровайдер по подписи. +// +Процедура ПроверитьПодписьPKCS7( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПроверитьПодписьPKCS7(); +``` +
+ +## ЗашифроватьPKCS7 +
+ +Описание, пример вызова + +```bsl + +// Шифрует данные по методу Диффи-Хелмана в формате PKCS#7. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ЗашифрованныйФайл - Строка - имя файла или адрес во временном хранилище. +// +// ИсходныйФайл - Строка - полное имя исходного файла на клиенте. +// - Строка - адрес исходного файла на сервере во временном хранилище. +// +// Сертификаты - Массив - список описаний сертификатов. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// ИмяФайлаИлиРасширениеИлиАдрес - Неопределено - если в параметре ИсходныйФайл передан адрес во временном хранилище, +// то результат будет помещен во временное хранилище по адресу исходного файла. +// - если передано полное имя файла на клиенте, +// то результат будет помещен во вновь созданный файл на клиенте. +// - Строка - имя файла, в который необходимо сохранить результат. +// - Строка - расширение файла результата. +// - Строка - адрес во временном хранилище, по которому необходимо сохранить результат. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// ИмяКонтейнераКлючей - Строка - имя контейнера ключей, следует задавать только при шифровании в на сервере +// +// Алгоритм - Неопределено - использовать автоопределение алгоритма внешней компонентой в момент операции. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(), +// при значении "*" определять алгоритм и криптопровайдер по первому сертификату. +// +Процедура ЗашифроватьPKCS7( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ЗашифроватьPKCS7(); +``` +
+ +## ПодписатьИЗашифроватьPKCS7 +
+ +Описание, пример вызова + +```bsl + +// Создает файл подписи и шифрует его по методу Диффи-Хелмана в формате PKCS#7. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ИмяЗашифрованногоФайла - Строка - имя файла, в который будет сохранен результат. +// +// СертификатПодписанта - Структура - описание сертификата подписанта. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// +// ИмяФайлаДанных - Строка - исходный файл данных. +// +// ВключатьИсходныеДанные - Булево - если Истина, то создает присоединенную подпись, иначе - отсоединенную. +// +// СертификатыПолучателей - Массив - список описаний сертификатов получателей. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// +// ИмяФайлаИлиРасширение - Строка - имя файла, в который необходимо сохранить результат. +// Также можно указать только расширение создаваемого файла - ".расширение". +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - использовать автоопределение алгоритма внешней компонентой в момент операции. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(), +// при значении "*" определять алгоритм и криптопровайдер по сертификату подписанта. +// +Процедура ПодписатьИЗашифроватьPKCS7( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПодписатьИЗашифроватьPKCS7(); +``` +
+ +## РасшифроватьPKCS7 +
+ +Описание, пример вызова + +```bsl + +// Расшифровывает файл формата PKCS#7. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * РасшифрованныйФайл - Строка - имя файла или адрес во временном хранилище. +// +// ЗашифрованныйФайл - Строка - полное имя зашифрованного файла на клиенте. +// - Строка - адрес зашифрованного файла на сервере во временном хранилище. +// +// ИмяФайлаИлиРасширениеИлиАдрес - Неопределено - если в параметре ЗашифрованныйФайл передан адрес во временном хранилище, +// то результат будет помещен во временное хранилище по адресу исходного файла. +// - если передано полное имя файла на клиенте, +// то результат будет помещен во вновь созданный файл на клиенте. +// - Строка - имя файла, в который необходимо сохранить результат. +// - Строка - расширение файла результата. +// - Строка - адрес во временном хранилище, по которому необходимо сохранить результат. +// +// Сертификат - Структура - приоритетный сертификат для расшифровки. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - использовать автоопределение алгоритма внешней компонентой в момент операции. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(), +// при значении "*" определять алгоритм и криптопровайдер по зашифрованному файлу. +// +Процедура РасшифроватьPKCS7( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.РасшифроватьPKCS7(); +``` +
+ +## ПолучитьПодписантовPKCS7 +
+ +Описание, пример вызова + +```bsl + +// Извлекает из файла подписи (PKCS#7) данные о подписанте: серийный номер и издатель сертификата. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * Подписанты - ФиксированныйМассив - описания сертификатов подписантов, при незаданном параметре КаталогСертификатов +// поддерживается извлечение только одного подписанта. +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// +// ИмяФайлаПодписи - Строка - файл подписи. +// +// КаталогСертификатов - Строка - каталог для сохранения сертификатов, если присутствуют в подписи, с именами <серийный номер>.cer. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - определить алгоритм по подписи. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// +Процедура ПолучитьПодписантовPKCS7( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПолучитьПодписантовPKCS7(); +``` +
+ +## Подписать +
+ +Описание, пример вызова + +```bsl + +// Создает файл подписи для указанного файла данных. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ИмяФайлаПодписи - Строка - имя файла, в который будет сохранена подпись. +// +// Сертификат - Структура - описание сертификата подписанта. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// ИмяФайлаДанных - Строка - файл, для которого необходимо сформировать подпись. +// +// ПараметрыКриптографии - Структура. +// * АлгоритмХеширования - Число - идентификатор алгоритма хеширования (см. ПолучитьАлгоритмы). +// +// ИмяФайлаИлиРасширение - Строка - имя файла, в который необходимо сохранить результат. +// Также можно указать только расширение создаваемого файла - ".расширение". +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - определить алгоритм по сертификату. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// +Процедура Подписать( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.Подписать(); +``` +
+ +## ПроверитьПодпись +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку файла для указанного файла данных. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ПодписьВалидна - Булево - результат проверки подписи. +// +// Сертификат - Структура - описание сертификата подписанта. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// ИмяФайлаПодписи - Строка - файл подписи, которую необходимо проверить. +// +// ИмяФайлаДанных - Строка - файл, для которого необходимо проверить подпись. +// +// ПараметрыКриптографии - Структура. +// * АлгоритмХеширования - Число - идентификатор алгоритма хеширования (см. ПолучитьАлгоритмы). +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - определить алгоритм по сертификату. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// +Процедура ПроверитьПодпись( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПроверитьПодпись(); +``` +
+ +## Зашифровать +
+ +Описание, пример вызова + +```bsl + +// Шифрует данные по методу Диффи-Хелмана. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * КаталогРезультатаИлиАдреса - Строка - каталог, в который будут сохранены файлы результата. +// - Структура - параметры с адресами хранилище результатов в модели сервиса. +// ** ЗашифрованныйФайл - Строка. +// ** ПубличныйКлючОтправителя - Строка. +// ** СессионныйКлюч - Строка. +// ** ИнициализационныйВектор - Строка. +// +// СертификатОтправителя - Структура, Неопределено - описание сертификата. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// ИмяФайлаДанных - Строка - шифруемый файл. +// - Строка - адрес шифруемого файла на сервере во временном хранилище, в модели сервиса. +// +// СертификатПолучателя - Структура - описание сертификата. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// ПараметрыКриптографии - Структура. +// * АлгоритмШифрования - Число - алгоритм шифрования. Если параметр не задан, идентификатор алгоритма будет браться из сертификата. +// * АлгоритмКлюча - Число - алгоритм генерации сессионного ключа. +// * Режим - Число - 0 - используется режим по умолчанию. +// 1 - Cipher block chaining +// 2 - Electronic code book +// 4 - Cipher feedback mode +// 5 - Ciphertext stealing mode +// +// КаталогРезультатаИлиАдреса - Строка - каталог, в который будут сохранены файлы результата. +// - Структура - параметры для помещения в хранилище результата в модели сервиса. +// * ЗашифрованныйФайл - УникальныйИдентификатор. +// * ПубличныйКлючОтправителя - УникальныйИдентификатор. +// * СессионныйКлюч - УникальныйИдентификатор. +// * ИнициализационныйВектор - УникальныйИдентификатор. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - определить алгоритм по сертификату получателя. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// +Процедура Зашифровать( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.Зашифровать(); +``` +
+ +## РасшифроватьФайл +
+ +Описание, пример вызова + +```bsl + +// Расшифровывает данные методу Диффи-Хелмана в блочном режиме с обратной связью. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр Алгоритм. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * РасшифрованныйФайл - Строка - имя файла или адрес во временном хранилище, в модели сервиса. +// +// СертификатПолучателя - Структура - сертификат для расшифровки. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// ИмяЗашифрованногоФайла - Строка - полное имя зашифрованного файла на клиенте. +// - Строка - адрес зашифрованного файла на сервере во временном хранилище, в модели сервиса. +// +// ПубличныйКлючОтправителя - Строка - полное имя файла публичного ключа эфемерной ключевой пары отправителя на клиенте. +// - Строка - адрес файла публичного ключа эфемерной ключевой пары отправителя во временном хранилище, в модели сервиса. +// +// СессионныйКлюч - Строка - полное имя файла сессионного ключа на клиенте. +// - Строка - адрес файла сессионного ключа на сервере во временном хранилище, в модели сервиса. +// +// ИнициализационныйВектор - Строка - полное имя файла инициализационного вектора на клиенте. +// - Строка - адрес файла инициализационного вектора во временном хранилище, в модели сервиса. +// +// ИмяФайлаИлиРасширениеИлиАдрес - Строка - имя файла, в который необходимо сохранить результат. +// Также можно указать только расширение создаваемого файла - ".расширение". +// - Строка - адрес файла, в который необходимо сохранить результат, во временном хранилище, в модели сервиса. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// Алгоритм - Неопределено - определить алгоритм по сертификату получателя. +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// +Процедура РасшифроватьФайл( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.РасшифроватьФайл(); +``` +
+ +## ХешироватьДанные +
+ +Описание, пример вызова + +```bsl + +// Создает файл подписи для указанного файла данных в формате PKCS#7. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр АлгоритмИлиСертификат. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * Хеш - Строка - шестнадцатеричное представление хеша. +// +// МестоХраненияКлюча - Булево, Структура - определяет системное хранилище: локальное, защищенное хранилище на сервере или облачная подпись КриптоПро DSS. +// +// ФайлДанных - Строка - полное имя файла, который необходимо подписать, на клиенте. +// - Строка - адрес файла, который необходимо подписать, на сервере во временном хранилище. +// +// ПараметрыКриптографии - Структура. +// * АлгоритмХеширования - Число - идентификатор алгоритма хеширования (см. ПолучитьАлгоритмы). +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан новый. +// +// АлгоритмИлиСертификат - Неопределено - использовать алгоритм по умолчанию КриптографияЭДКОКлиентСервер.АлгоритмПоУмолчанию(). +// Строка - алгоритм, возвращаемый КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// Структура - сертификат подписанта, вариант параметра не поддерживается в модели сервиса. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// ПеревернутьБайтыХеша - Булево - в возвращаемом хеше поменять местами шестнадцатеричные цифры внутри байта. +// +Процедура ХешироватьДанные( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ХешироватьДанные(); +``` +
+ +## ПолучитьУстройстваUSB +
+ +Описание, пример вызова + +```bsl + +// Возвращает все устройства USB, подключенные к системе. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе +// см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом +// запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр АлгоритмИлиСертификат. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * УстройстваUSB - Массив - список подключенных устройств USB. +// * device_name - Строка - имя устройства (примеры: "USB Composite Device", "Sentinel USB Key"). +// * hardware_id - Строка - идентификатор устройства (примеры: "USB\VID_046D&PID_C31C&REV_6400", +// примеры идентификаторов разных устройств с одинаковым именем: +// "USB\VID_0529&PID_0001&REV_0325", "USB\VID_0529&PID_0001&REV_0100"). +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан +// новый. +// +// АлгоритмИлиСертификат - Неопределено - использовать алгоритм по умолчанию +// КриптографияЭДКОКлиентСервер.АлгоритмПоУмолчанию(). +// Строка - алгоритм, возвращаемый +// КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// Структура - сертификат подписанта, вариант параметра не поддерживается в модели +// сервиса. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны +// СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется +// при определении алгоритма. +// +Процедура ПолучитьУстройстваUSB( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПолучитьУстройстваUSB(); +``` +
+ +## УстановитьОбработчикСобытия +
+ +Описание, пример вызова + +```bsl + +// Устанавливает обработчик событий при подключении/отключении устройства USB. +// Компонента должна быть на стеке, что бы событие обрабатывалось, то есть нужно сохранить в памяти "МенеджерКриптографии" +// результата оповещения о завершении. +// Информация о событии получается в рамках обработки события от внешнего компонента, для которой определить в форме: +// Процедура ВнешнееСобытие(Источник, Событие, Данные) Экспорт +// Пример: +// Источник: CCrypt +// Событие: "Подключение устройства" или "Отключение устройства" +// Данные: +// \\?\Aladdin#Vid0529&Pid0001&HaspHL#7&243274f3&2&00#{44207c5e-33d5-4bd3-89d5-ed357c08df3c} +// Описание формата строки (Данные): +// https://community.silabs.com/s/article/windows-usb-device-path?language=en_US +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе +// см. ОписаниеОшибки. +// * МенеджерКриптографии - AddIn - объект используемый для работы с файлами. Работать напрямую с объектом +// запрещено. +// * Алгоритм - Строка - алгоритм криптопровайдера созданного менеджера криптографии, при заданном +// параметре МенеджерКриптографии возвращается параметр АлгоритмИлиСертификат. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// +// Фильтр - Строка - возвращаются события устройств, в идентификаторе которых присутствует данная +// подстрока. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +// МенеджерКриптографии - AddIn - объект используемый для работы с криптографией. Если не задан, то будет создан +// новый. +// +// АлгоритмИлиСертификат - Неопределено - использовать алгоритм по умолчанию +// КриптографияЭДКОКлиентСервер.АлгоритмПоУмолчанию(). +// Строка - алгоритм, возвращаемый +// КриптографияЭДКОСлужебныйВызовСервера.ПолучитьСвойстваКриптосообщения(). +// Структура - сертификат подписанта, вариант параметра не поддерживается в модели +// сервиса. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны +// СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется +// при определении алгоритма. +// +Процедура УстановитьОбработчикСобытия( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.УстановитьОбработчикСобытия(); +``` +
+ +## ОпределитьАлгоритм +
+ +Описание, пример вызова + +```bsl + +// Возвращает алгоритм зашифрованного или подписанного сообщения PKCS#7 либо сертификата X.509. +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// +// МестоХраненияКлюча - Булево, Структура - определяет имя события при записи в журнал событий. +// +// ПараметрыОпределенияАлгоритма - Структура: +// * Алгоритм - Строка - возвращаемый алгоритм, если задано. +// * Криптосообщение - Строка - адрес во временном хранилище зашифрованного или подписанного сообщения PKCS#7. +// - Строка - имя файла зашифрованного или подписанного сообщения PKCS#7. +// * Сертификат +// ** СерийныйНомер - Строка - серийный номер сертификата. +// ** Поставщик - Строка - издатель сертификата. +// ** Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// ** Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// +Процедура ОпределитьАлгоритм( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ОпределитьАлгоритм(); +``` +
+ +## ЗашифроватьXML +
+ +Описание, пример вызова + +```bsl + +// Шифрует данные по XML, актуально только для облачной подписи +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * ЗашифрованныйФайл - Строка - имя файла или адрес во временном хранилище. +// +// ИсходныйФайл - Строка - полное имя исходного файла на клиенте. +// - Строка - адрес исходного файла на сервере во временном хранилище. +// +// Сертификаты - Массив - список описаний сертификатов. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// * Сертификат - Строка - содержимое сертификата в Base64, если поле присутствует, используется при определении алгоритма. +// +// ИмяФайлаИлиРасширениеИлиАдрес - Неопределено - если в параметре ИсходныйФайл передан адрес во временном хранилище, +// то результат будет помещен во временное хранилище по адресу исходного файла. +// - если передано полное имя файла на клиенте, +// то результат будет помещен во вновь созданный файл на клиенте. +// - Строка - имя файла, в который необходимо сохранить результат. +// - Строка - расширение файла результата. +// - Строка - адрес во временном хранилище, по которому необходимо сохранить результат. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// ПараметрыОперации - Структура +// +Процедура ЗашифроватьXML( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ЗашифроватьXML(); +``` +
+ +## РасшифроватьXML +
+ +Описание, пример вызова + +```bsl + +// Расшифровывает файл формата XML, актуально только для облачной подписи +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * ОписаниеОшибки - Строка - описание ошибки выполнения. +// * РасшифрованныйФайл - Строка - имя файла или адрес во временном хранилище. +// +// ЗашифрованныйФайл - Строка - полное имя зашифрованного файла на клиенте. +// - Строка - адрес зашифрованного файла на сервере во временном хранилище. +// +// ИмяФайлаИлиРасширениеИлиАдрес - Неопределено - если в параметре ЗашифрованныйФайл передан адрес во временном хранилище, +// то результат будет помещен во временное хранилище по адресу исходного файла. +// - если передано полное имя файла на клиенте, +// то результат будет помещен во вновь созданный файл на клиенте. +// - Строка - имя файла, в который необходимо сохранить результат. +// - Строка - расширение файла результата. +// - Строка - адрес во временном хранилище, по которому необходимо сохранить результат. +// +// Сертификат - Структура - приоритетный сертификат для расшифровки. +// * СерийныйНомер - Строка - серийный номер сертификата. +// * Поставщик - Строка - издатель сертификата. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// +// ВыводитьСообщения - Булево - устанавливает признак необходимости выводить сообщения об ошибках. +// ПараметрыОперации - Структура +// +Процедура РасшифроватьXML( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.РасшифроватьXML(); +``` +
+ +## ПакетнаяПодписьОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +// Запускает пакетный режим подписи для облачной подписи +// +// Параметры: +// ОповещениеОЗавершении - ОписаниеОповещения - описание процедуры, принимающей результат. +// Результат - Структура: +// * Выполнено - Булево - если Истина, то процедура успешно выполнена и получен результат, иначе см. ОписаниеОшибки. +// * Ошибка - Строка - описание ошибки выполнения. +// * Результат - Массив - двоичные данные или адрес во временном хранилище. +// +// УчетнаяЗаписьОблачнойПодписи - Структура, СправочникСсылка.УчетныеЗаписиDSS - данные для авторизации в сервисе +// +// МассивДокументов - Массив - двоичные данные или адрес во временном хранилище. +// +// СертификаПодписи - Структура - приоритетный сертификат для расшифровки. +// * Отпечаток - Строка - отпечаток сертификата. Используется для поиска сертификата если не указаны СерийныйНомер и Поставщик. +// +// ПараметрыОперации - Структура: +// * ПодтверждатьОперацию - Булево - (опционально) признак принудельного подтверждения операции +// * ОписаниеДокументов - Строка - (опционально) +// * ТипДокументов - Строка - (опционально) +// +Процедура ПакетнаяПодписьОблачнойПодписи( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиент.ПакетнаяПодписьОблачнойПодписи(); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КриптографияЭДКОКлиентСервер.md b/src/content/docs/zup/КриптографияЭДКОКлиентСервер.md new file mode 100644 index 0000000..8e18058 --- /dev/null +++ b/src/content/docs/zup/КриптографияЭДКОКлиентСервер.md @@ -0,0 +1,989 @@ +--- +title: Криптография ЭДКО клиент сервер +slug: zup/криптография-эдко-клиент-сервер +--- + + +## ПоддерживаемыеКриптопровайдеры +
+ +Описание, пример вызова + +```bsl + +// Возвращает список криптопровайдеров, поддерживаемых 1С-Отчетностью. +// +// Параметры: +// Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512", +// при значении "" или Неопределено возвращаются описания для всех алгоритмов. +// ЭтоLinux - Булево. +// Неопределено - возвращать описания для каждой операционной системы. +// ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров, Строка. +// Неопределено - возвращать все типы. +// Путь - Строка - путь модуля криптографии в nix-системах. +// +// Возвращаемое значение: +// ФиксированныйМассив - массив с описаниями криптопровайдеров. +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров. +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * Поддерживается - Булево - Истина. +// +Функция ПоддерживаемыеКриптопровайдеры( Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ПоддерживаемыеКриптопровайдеры(); +``` +
+ +## СвойстваКриптопровайдера +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства криптопровайдера, поддерживаемого 1С-Отчетностью, или криптопровайдера из массива. +// +// Параметры: +// Имя - Строка - имя криптопровайдера. +// Тип - Число - тип криптопровайдера. +// ПоддерживаемыеКриптопровайдеры - Неопределено - получить вызовом ПоддерживаемыеКриптопровайдеры(). +// ФиксированныйМассив - массив с описаниями криптопровайдеров. +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров, Строка. +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * Поддерживается - Булево - флаг поддержки криптопровайдера 1С-Отчетностью. +// ИндексКриптопровайдеров - Массив - имя, имя и тип или тип криптопровайдера, для ускорения поиска, +// заполняется при первом и втором вызове автоматически, +// при изменении заполненности параметров Имя, Тип +// передать с Неопределено для перезаполнения. +// +// Возвращаемое значение: +// Структура - описание криптопровайдера: +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров, Строка. +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * Поддерживается - Булево - флаг поддержки криптопровайдера 1С-Отчетностью. +// * ИндексЭлемента - Число - индекс элемента в ПоддерживаемыеКриптопровайдеры, элемент присутствует, +// если задан параметр ПоддерживаемыеКриптопровайдеры. +// Неопределено - криптопровайдер не найден. +// +Функция СвойстваКриптопровайдера( Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.СвойстваКриптопровайдера(); +``` +
+ +## АлгоритмПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Возвращает основной используемый отечественный криптографический алгоритм. +// +Функция АлгоритмПоУмолчанию() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.АлгоритмПоУмолчанию() +``` +
+ +## СвойстваКриптопровайдераПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства криптопровайдера с алгоритмом по умолчанию или заданным. +// +// Параметры: +// ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров. +// Алгоритм - Строка. +// Путь - Строка - путь модуля криптографии в nix-системах. +// +// Возвращаемое значение: +// Структура - описание криптопровайдера: +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров. +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * Поддерживается - Булево - флаг поддержки криптопровайдера 1С-Отчетностью. +// +Функция СвойстваКриптопровайдераПоУмолчанию(ТипКриптопровайдера, Алгоритм = Неопределено, Путь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.СвойстваКриптопровайдераПоУмолчанию(ТипКриптопровайдера, Алгоритм, Путь); +``` +
+ +## ИзвестныеКриптопровайдеры +
+ +Описание, пример вызова + +```bsl + +// Возвращает список всех известных криптопровайдеров, поддерживающих отечественные алгоритмы. +// +// Параметры: +// Поддерживается - Булево - поддерживается 1С-Отчетностью. +// Неопределено - возврат и поддерживаемых, и неподдерживаемых. +// Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512", +// при значении "" или Неопределено возвращаются описания для всех алгоритмов. +// ЭтоLinux - Булево. +// Неопределено - возвращать описания для каждой операционной системы. +// ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров, Строка. +// Неопределено - возвращать все типы. +// Путь - Строка - путь модуля криптографии в nix-системах. +// +// Возвращаемое значение: +// ФиксированныйМассив - массив с описаниями криптопровайдеров. +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров, Строка. +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * Поддерживается - Булево - флаг поддержки криптопровайдера 1С-Отчетностью. +// +Функция ИзвестныеКриптопровайдеры( Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ИзвестныеКриптопровайдеры(); +``` +
+ +## КриптопровайдерCryptoPro +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание криптопровайдера CryptoPro CSP. +// +// Параметры: +// Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512", +// при значении "" или Неопределено возвращается массив свойств криптопровайдеров +// всех алгоритмов и классов защиты. +// ЭтоLinux - Булево. +// - Неопределено - при пустых значениях Алгоритм или КлассЗащиты возвращаются массив свойств +// криптопровайдеров для каждой операционной системы, иначе возвращаются свойства +// криптопровайдера для текущей. +// КлассЗащиты - Число - 1, 2 или 3, +// при значении 0 или Неопределено возвращается массив свойств криптопровайдеров всех +// классов защиты. +// Путь - Строка - путь модуля криптографии в nix-системах. +// - Неопределено - определить путь модуля криптографии. +// ВсеКлассыЗащиты - Булево - возвращать имена криптопровайдеров со всеми классами защиты, а не только основной. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура или ФиксированныйМассив из ФиксированнаяСтруктура (при Алгоритм = Неопределено) - описание криптопровайдера. +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров.CryptoPro. +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * Поддерживается - Булево - Истина. +// +Функция КриптопровайдерCryptoPro( Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.КриптопровайдерCryptoPro(); +``` +
+ +## КриптопровайдерViPNet +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание криптопровайдера ViPNet CSP. +// +// Параметры: +// Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// при значении "" или Неопределено возвращается массив свойств криптопровайдеров всех алгоритмов. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура или ФиксированныйМассив из ФиксированнаяСтруктура (при Алгоритм = Неопределено) - описание криптопровайдера. +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров.VipNet. +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * Поддерживается - Булево - Истина. +// +Функция КриптопровайдерViPNet(Алгоритм = "GOST R 34.10-2012-256") Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.КриптопровайдерViPNet(Алгоритм); +``` +
+ +## КриптопровайдерSignalCOM +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание криптопровайдера Signal-COM CSP. +// +// Параметры: +// Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// при значении "" или Неопределено возвращается массив свойств криптопровайдеров всех алгоритмов. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура или ФиксированныйМассив из ФиксированнаяСтруктура (при Алгоритм = Неопределено) - описание криптопровайдера. +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Строка - "SignalCOM". +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * Поддерживается - Булево - Ложь. +// +Функция КриптопровайдерSignalCOM(Алгоритм = "GOST R 34.10-2012-256") Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.КриптопровайдерSignalCOM(Алгоритм); +``` +
+ +## КриптопровайдерЛИССИ +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание криптопровайдера ЛИССИ-CSP. +// +// Параметры: +// Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// при значении "" или Неопределено возвращается массив свойств криптопровайдеров всех алгоритмов. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура или ФиксированныйМассив из ФиксированнаяСтруктура (при Алгоритм = Неопределено) - описание криптопровайдера. +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Строка - "LISSI". +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * Поддерживается - Булево - Ложь. +// +Функция КриптопровайдерЛИССИ(Алгоритм = "GOST R 34.10-2012-256") Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.КриптопровайдерЛИССИ(Алгоритм); +``` +
+ +## КриптопровайдерCryptoProDSS +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание криптопровайдера КриптоПро DSS. +// +// Параметры: +// Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// при значении "" или Неопределено возвращается массив свойств криптопровайдеров всех алгоритмов. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - описание криптопровайдера: +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Перечисления.ТипыКриптоПровайдеров.CryptoProDSS. +// * Алгоритм - Строка - "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * Поддерживается - Булево - Ложь. +// +Функция КриптопровайдерCryptoProDSS(Алгоритм = "GOST R 34.10-2012-256") Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.КриптопровайдерCryptoProDSS(Алгоритм); +``` +
+ +## КриптопровайдерMicrosoftBaseCryptographicProvider +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание криптопровайдера Microsoft Base Cryptographic Provider v1.0. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - описание криптопровайдера. +// * Имя - Строка - имя криптопровайдера. +// * Тип - Число - тип криптопровайдера. +// * Путь - Строка - путь к модулю криптопровайдера в *nix-системах. +// * Представление - Строка - представление типа криптопровайдера для отображения в интерфейсе. +// * ТипКриптопровайдера - Строка - "MSRSA". +// * Алгоритм - Строка - "RSA". +// * Поддерживается - Булево - Ложь. +// +Функция КриптопровайдерMicrosoftBaseCryptographicProvider() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.КриптопровайдерMicrosoftBaseCryptographicProvider() +``` +
+ +## СвойстваАлгоритма +
+ +Описание, пример вызова + +```bsl + +// Возвращает свойства алгоритма. +// +// Параметры: +// Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// +// Возвращаемое значение: +// ФиксированныйМассив - массив с описаниями криптопровайдеров. +// * Имя - Строка. +// * Алгоритм - Строка - "GOST R 34.10-2001", "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// * АлгоритмХеширования - Число. +// * АлгоритмХешированияВМоделиСервиса - Строка. +// +Функция СвойстваАлгоритма(Алгоритм = "GOST R 34.10-2012-256") Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.СвойстваАлгоритма(Алгоритм); +``` +
+ +## ПоддерживаемыеАлгоритмы +
+ +Описание, пример вызова + +```bsl + +// Возвращает поддерживаемые алгоритмы для алгоритма по умолчанию. +// +// Параметры: +// ИсключитьУстаревшие - Булево - при значении Истина исключается "GOST R 34.10-2001". +// +// Возвращаемое значение: +// ФиксированныйМассив - массив строк с именами алгоритмов "GOST R 34.10-2012-256", "GOST R 34.10-2012-512". +// +Функция ПоддерживаемыеАлгоритмы(ИсключитьУстаревшие = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ПоддерживаемыеАлгоритмы(ИсключитьУстаревшие); +``` +
+ +## СертификатВЗащищенномХранилищеНаСервере +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак хранения сертификата в защищенном хранилище на сервере. +// +// Параметры: +// Сертификат - Структура - Сведения о сертификате. +// +// Возвращаемое значение: +// Булево - Истина, если сертификат хранится в защищенном хранилище на сервере. +// +Функция СертификатВЗащищенномХранилищеНаСервере(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.СертификатВЗащищенномХранилищеНаСервере(Сертификат) +``` +
+ +## СертификатОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак хранения сертификата на сервере облачной подписи. +// +// Параметры: +// Сертификат - Структура - Сведения о сертификате. +// +// Возвращаемое значение: +// Булево - Истина, если сертификат храниться на сервере облачной подписи. +// +Функция СертификатОблачнойПодписи(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.СертификатОблачнойПодписи(Сертификат) +``` +
+ +## ПодготовитьРезультат +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание результата выполнения действия. +// +// Параметры: +// Выполнено - Булево - Истина, если действие выполнено успешно, иначе Ложь. +// ИмяПоляРезультат - Строка, Неопределено - Имя поля со значением результата. +// ЗначениеРезультат - Строка, Неопределено - Значение результата. +// ВходящийКонтекст - Структура, Неопределено - Контекст выполнения. +// +// Возвращаемое значение: +// Структура - Содержит как минимум ключ: +// * Выполнено - Булево - признак выполнения. +// +Функция ПодготовитьРезультат(Выполнено, ИмяПоляРезультат = Неопределено, ЗначениеРезультат = Неопределено, ВходящийКонтекст = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ПодготовитьРезультат(Выполнено, ИмяПоляРезультат, ЗначениеРезультат, ВходящийКонтекст); +``` +
+ +## КраткоеПредставлениеОшибкиКриптосервиса +
+ +Описание, пример вызова + +```bsl + +// Возвращает текстовое представление ошибки. +// +// Параметры: +// ИнформацияОбОшибке - Строка, ИнформацияОбОшибке, Структура - Содержит информацию об ошибке. +// +// Возвращаемое значение: +// Строка - Текстовое представление ошибки. +// +Функция КраткоеПредставлениеОшибкиКриптосервиса(Знач ИнформацияОбОшибке, Знач ИнформацияОбОшибкеКомпоненты = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.КраткоеПредставлениеОшибкиКриптосервиса(ИнформацияОбОшибке, ИнформацияОбОшибкеКомпоненты); +``` +
+ +## ЭтоАдресВоВременномХранилище +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли переданная строка адресом во временном хранилище. +// +// Параметры: +// Адрес - Строка - Проверяемая строка. +// +// Возвращаемое значение: +// Булево - Истина, если строка является адресом во временном хранилище. +// +Функция ЭтоАдресВоВременномХранилище(Адрес) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ЭтоАдресВоВременномХранилище(Адрес) +``` +
+ +## ОписаниеОшибкиНеУдалосьПроверитьПодпись +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание ошибки, в случае, если не удалось проверить подпись. +// +Функция ОписаниеОшибкиНеУдалосьПроверитьПодпись() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ОписаниеОшибкиНеУдалосьПроверитьПодпись() +``` +
+ +## ЭтоКритическаяОшибкаКриптопровайдера +
+ +Описание, пример вызова + +```bsl + +// Проверяет, является ли ошибка криптопровайдера критической, свидетельствующей, что требуется настройка, +// продление лицензии или переустановка криптопровайдера. +// +// Параметры: +// ОписаниеОшибки - Строка - проверяется на подстроки критических сообщений об ошибках. +// +// Возвращаемое значение: +// Булево - Истина, если криптопровайдер работает некорректно или конфликт криптопровайдеров. +// +Функция ЭтоКритическаяОшибкаКриптопровайдера(ОписаниеОшибки) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ЭтоКритическаяОшибкаКриптопровайдера(ОписаниеОшибки) +``` +
+ +## ЭтоОшибкаНеавторизованногоУЦ +
+ +Описание, пример вызова + +```bsl + +// Проверяет, что ошибка вызвана тем, что сертификат не входит в список авторизованных фирмой "1С". +// +// Параметры: +// ОписаниеОшибки - Строка - проверяется на подстроку. +// +// Возвращаемое значение: +// Булево - Истина, если текст ошибки указывает на то, что УЦ сертификата не авторизован фирмой "1С". +// +Функция ЭтоОшибкаНеавторизованногоУЦ(ОписаниеОшибки) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ЭтоОшибкаНеавторизованногоУЦ(ОписаниеОшибки) +``` +
+ +## СвойстваМестаХраненияКлюча +
+ +Описание, пример вызова + +```bsl + +// Формирует структуру, которая хранит информацию о месте хранения ключа. +// +// Возвращаемое значение: +// Структура - Содержит ключи: +// * МодельХраненияЗакрытогоКлюча - ПеречислениеСсылка.МодельХраненияЗакрытогоКлюча - Допускает три варианта. +// * УчетнаяЗаписьОблачнойПодписи - Неопределено, СправочникСсылка.УчетныеЗаписиDSS - Заполняется для варианта, +// "Облачная подпись". +// +Функция СвойстваМестаХраненияКлюча(МодельХраненияЗакрытогоКлюча = Неопределено, УчетнаяЗаписьОблачнойПодписи = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.СвойстваМестаХраненияКлюча(МодельХраненияЗакрытогоКлюча, УчетнаяЗаписьОблачнойПодписи); +``` +
+ +## ОпределитьМестоХраненияКлюча +
+ +Описание, пример вызова + +```bsl + +// Формирует структуру, которая хранит информацию о месте хранения ключа на основе переданных данные. +// +// Возвращаемое значение: +// Структура - Содержит ключи: +// * МодельХраненияЗакрытогоКлюча - ПеречислениеСсылка.МодельХраненияЗакрытогоКлюча +// * УчетнаяЗаписьОблачнойПодписи - Неопределено, СправочникСсылка.УчетныеЗаписиDSS +// +Функция ОпределитьМестоХраненияКлюча(МодельХраненияЗакрытогоКлюча, УчетнаяЗаписьОблачнойПодписи = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ОпределитьМестоХраненияКлюча(МодельХраненияЗакрытогоКлюча, УчетнаяЗаписьОблачнойПодписи); +``` +
+ +## КонтекстМоделиХраненияКлюча +
+ +Описание, пример вызова + +```bsl + +// Основная функция для получения данных о месте хранения ключа для последующего выбора варианта выполнения криптоопераций. +// Если в первом реквизите передана структура, то будет получено его поле "МестоХраненияКлюча", +// иначе будет будет вычислено реальное место хранения ключа, на основе данных справочника "УчетныеЗаписиДокументооборота". +// Порядок вычисления для облачной подписи: +// МодельХраненияКлюча - реквизит справочника +// УчетнаяЗаписьОблачнойПодписи - по поиску отпечатка руководителя в регистре сведений "СертификатыПользователяDSS" +// +// Параметры: +// Источник - Булево, Структура, СправочникСсылка.УчетныеЗаписиДокументооборота, СправочникСсылка.Организации - Если передана структура, +// то она должна содержать поле "МестоХраненияКлюча" (см. ИмяМоделиХраненияКлюча). +// Булево используется для поддержки совместимости со старыми вызовами. +// КонтекстРаботы - Неопределено, Структура - Если передана структура, которая не содержит поля "МестоХраненияКлюча", +// то оно туда будет заполнено, иначе будет возращено его значение. +// +// Возвращаемое значение: +// Структура - см. СвойстваМестаХраненияКлюча() +// +Функция КонтекстМоделиХраненияКлюча( Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.КонтекстМоделиХраненияКлюча(); +``` +
+ +## ЗаполнитьМестоХраненияКлюча +
+ +Описание, пример вызова + +```bsl + +// Принудительно перезаполняет данные о месте хранения ключа в структуре. +// +// Параметры: +// МестоХраненияКлюча - Структура - См. СвойстваМестаХраненияКлюча(). +// КонтекстРаботы - Структура - целевая структура для заполнения. +// +Процедура ЗаполнитьМестоХраненияКлюча(МестоХраненияКлюча, КонтекстРаботы) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОКлиентСервер.ЗаполнитьМестоХраненияКлюча(МестоХраненияКлюча, КонтекстРаботы) +``` +
+ +## МодельХраненияЗакрытогоКлюча +
+ +Описание, пример вызова + +```bsl + +// Вспомогательная функция для вычисления модели хранения закрытого ключа, для реализации переходного периода. +// +// Параметры: +// МестоХраненияКлюча - Структура, Булево, ПеречислениеСсылка.МодельХраненияЗакрытогоКлюча, ПеречислениеСсылка.МодельРаботыСКлючами +// +// Возвращаемое значение: +// ПеречислениеСсылка.МодельХраненияЗакрытогоКлюча +// +Функция МодельХраненияЗакрытогоКлюча(МестоХраненияКлюча) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.МодельХраненияЗакрытогоКлюча(МестоХраненияКлюча) +``` +
+ +## ЭтоОблачнаяПодпись +
+ +Описание, пример вызова + +```bsl + +// Определяет, является ли место хранения ключа "Облачная подпись". +// +// Параметры: +// МестоХраненияКлюча - Структура, Булево, ПеречислениеСсылка.МодельХраненияЗакрытогоКлюча, ПеречислениеСсылка.МодельРаботыСКлючами - +// См. МодельХраненияЗакрытогоКлюча(). +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоОблачнаяПодпись(МестоХраненияКлюча) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ЭтоОблачнаяПодпись(МестоХраненияКлюча) +``` +
+ +## ЭтоЛокальнаяПодпись +
+ +Описание, пример вызова + +```bsl + +// Определяет, является ли место хранения ключа "локальный компьютер". +// +// Параметры: +// МестоХраненияКлюча - Структура, Булево, ПеречислениеСсылка.МодельХраненияЗакрытогоКлюча, ПеречислениеСсылка.МодельРаботыСКлючами - +// См. МодельХраненияЗакрытогоКлюча(). +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоЛокальнаяПодпись(МестоХраненияКлюча) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ЭтоЛокальнаяПодпись(МестоХраненияКлюча) +``` +
+ +## ЭтоПодписьСервиса +
+ +Описание, пример вызова + +```bsl + +// Определяет является ли место хранения ключа "подпись в модели сервиса" +// +// Параметры: +// МестоХраненияКлюча - Структура, Булево, ПеречислениеСсылка.МодельХраненияЗакрытогоКлюча, ПеречислениеСсылка.МодельРаботыСКлючами - +// См. МодельХраненияЗакрытогоКлюча(). +// +// Возвращаемое значение: +// Булево +// +Функция ЭтоПодписьСервиса(МестоХраненияКлюча) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ЭтоПодписьСервиса(МестоХраненияКлюча) +``` +
+ +## ПолучитьУчетнуюЗаписьПодписи +
+ +Описание, пример вызова + +```bsl + +// Вычисляет учетную запись облачной подписи из данных о месте хранения ключа. +// Имеет смысл, если место хранения ключа "Облачная подпись". +// +// Параметры: +// КонтекстХранения - Структура - См. СвойстваМестаХраненияКлюча() +// +// Возвращаемое значение: +// Неопределено, СправочникСсылка.СправочникСсылка.УчетныеЗаписиDSS +// +Функция ПолучитьУчетнуюЗаписьПодписи(КонтекстХранения) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ПолучитьУчетнуюЗаписьПодписи(КонтекстХранения) +``` +
+ +## ПараметрыМестаХраненияКлюча +
+ +Описание, пример вызова + +```bsl + +// Получает и / или изменяет свойства места хранения ключа +// +// Параметры: +// МестоХраненияКлюча - Структура - см. СвойстваМестаХраненияКлюча() +// ИмяСвойства - Строка +// НовоеЗначение - Произвольное - допустимые значения определяются в СвойстваМестаХраненияКлюча() +// +// Возвращаемое значение +// Неопределено, Произвольное +// +Функция ПараметрыМестаХраненияКлюча(МестоХраненияКлюча, ИмяСвойства, НовоеЗначение = Null) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ПараметрыМестаХраненияКлюча(МестоХраненияКлюча, ИмяСвойства, НовоеЗначение); +``` +
+ +## ТелефонПодтвержденияОпераций +
+ +Описание, пример вызова + +```bsl + +// Формирует номер мобильного телефона без разделителей в формате +79999999999 +// +// Параметры: +// ТелефонМобильный - Строка +// +// Возвращаемое значение: +// Строка +// +Функция ТелефонПодтвержденияОпераций(ТелефонМобильный) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ТелефонПодтвержденияОпераций(ТелефонМобильный) +``` +
+ +## РазобратьСтрокуСубъекта +
+ +Описание, пример вызова + +```bsl + +// Разбор строки владельца или издателя сертификата. +// +// Параметры: +// СтрокаДляРазбора - Строка +// +// Возвращаемое значение: +// Соответствие, основные составляющие: +// "CN" - общее имя - имя организации или ФИО (commonName); +// "SN" - фамилия (surname); +// "GN" - имя и отчество (givenName); +// "O" - организация (organizationName); +// "OU" - подразделение (organizationUnitName); +// "T" - должность (title); +// "C" - страна, "RU" для России (countryName); +// "ST" - область, например, "77 г. Москва" (stateOrProvinceName); +// "L" - населенный пункт (localityName); +// "STREET" - наименование улицы, номер дома (streetAddress); +// "E" - адрес электронной почты (emailAddress). +// +Функция РазобратьСтрокуСубъекта(СтрокаДляРазбора) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.РазобратьСтрокуСубъекта(СтрокаДляРазбора) +``` +
+ +## ТипСубъектаСертификата +
+ +Описание, пример вызова + +```bsl + +// Определение типа владельца или издателя сертификата. +// +// Параметры: +// СтрокаДляРазбораИлиСоответствие - Строка, Соответствие, ФиксированноеСоответствие +// +// Возвращаемое значение: +// "ЮЛ" - юридическое лицо, "ИП" - индивидуальный предприниматель, "ФЛ" - физическое лицо. +// +Функция ТипСубъектаСертификата(СтрокаДляРазбораИлиСоответствие) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ТипСубъектаСертификата(СтрокаДляРазбораИлиСоответствие) +``` +
+ +## ИННСертификата +
+ +Описание, пример вызова + +```bsl + +// Определение типа владельца или издателя сертификата. +// +// Параметры: +// СтрокаДляРазбораИлиСоответствие - Строка, Соответствие, ФиксированноеСоответствие +// +// Возвращаемое значение: +// ИНН организации, при отсутствии - ИНН физического лица +// +Функция ИННСертификата(СтрокаДляРазбораИлиСоответствие) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОКлиентСервер.ИННСертификата(СтрокаДляРазбораИлиСоответствие) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КриптографияЭДКОСлужебныйКлиент.md b/src/content/docs/zup/КриптографияЭДКОСлужебныйКлиент.md new file mode 100644 index 0000000..76bfc98 --- /dev/null +++ b/src/content/docs/zup/КриптографияЭДКОСлужебныйКлиент.md @@ -0,0 +1,528 @@ +--- +title: Криптография ЭДКО служебный клиент +slug: zup/криптография-эдко-служебный-клиент +--- + + +## СоздатьМенеджерКриптографии2 +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьМенеджерКриптографии2( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.СоздатьМенеджерКриптографии2(); +``` +
+ +## СоздатьМенеджерКриптографии2ПослеПодключенияВнешнейКомпоненты +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьМенеджерКриптографии2ПослеПодключенияВнешнейКомпоненты(Подключена, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.СоздатьМенеджерКриптографии2ПослеПодключенияВнешнейКомпоненты(Подключена, ВходящийКонтекст) +``` +
+ +## СоздатьМенеджерКриптографии2ПослеУстановкиВнешнейКомпоненты +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьМенеджерКриптографии2ПослеУстановкиВнешнейКомпоненты(ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.СоздатьМенеджерКриптографии2ПослеУстановкиВнешнейКомпоненты(ВходящийКонтекст) +``` +
+ +## СоздатьМенеджерКриптографии2ПослеУстановкиСвойстваНеВыводитьСообщенияОбОшибках +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьМенеджерКриптографии2ПослеУстановкиСвойстваНеВыводитьСообщенияОбОшибках(ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.СоздатьМенеджерКриптографии2ПослеУстановкиСвойстваНеВыводитьСообщенияОбОшибках(ВходящийКонтекст) +``` +
+ +## СоздатьМенеджерКриптографии2ПослеПолученияКриптопровайдеров +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьМенеджерКриптографии2ПослеПолученияКриптопровайдеров(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.СоздатьМенеджерКриптографии2ПослеПолученияКриптопровайдеров(Результат, ВходящийКонтекст) +``` +
+ +## СоздатьМенеджерКриптографии2ПослеИнициализации +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьМенеджерКриптографии2ПослеИнициализации(Результат, Параметры, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.СоздатьМенеджерКриптографии2ПослеИнициализации(Результат, Параметры, ВходящийКонтекст) +``` +
+ +## СоздатьМенеджерКриптографии2ПослеПолученияСвойстваКодОшибки +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьМенеджерКриптографии2ПослеПолученияСвойстваКодОшибки(СписокОшибок, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.СоздатьМенеджерКриптографии2ПослеПолученияСвойстваКодОшибки(СписокОшибок, ВходящийКонтекст) +``` +
+ +## ЗаполнитьДополнительныеПараметрыПриНеобходимости +
+ +Описание, пример вызова + +```bsl + +Функция ЗаполнитьДополнительныеПараметрыПриНеобходимости(ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиент.ЗаполнитьДополнительныеПараметрыПриНеобходимости(ДополнительныеПараметры) +``` +
+ +## ЗашифроватьXML +
+ +Описание, пример вызова + +```bsl + +Процедура ЗашифроватьXML( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ЗашифроватьXML(); +``` +
+ +## ЗашифроватьXMLПослеШифрованияСервисомОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +Процедура ЗашифроватьXMLПослеШифрованияСервисомОблачнойПодписи(РезультатВызова, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ЗашифроватьXMLПослеШифрованияСервисомОблачнойПодписи(РезультатВызова, ВходящийКонтекст) +``` +
+ +## ЗашифроватьXMLПослеШифрованияПослеЗаписиФайла +
+ +Описание, пример вызова + +```bsl + +Процедура ЗашифроватьXMLПослеШифрованияПослеЗаписиФайла(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ЗашифроватьXMLПослеШифрованияПослеЗаписиФайла(Результат, ВходящийКонтекст) +``` +
+ +## РасшифроватьXML +
+ +Описание, пример вызова + +```bsl + +Процедура РасшифроватьXML( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.РасшифроватьXML(); +``` +
+ +## РасшифроватьXMLПослеРасшифрования +
+ +Описание, пример вызова + +```bsl + +Процедура РасшифроватьXMLПослеРасшифрования(РезультатВызова, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.РасшифроватьXMLПослеРасшифрования(РезультатВызова, ВходящийКонтекст) +``` +
+ +## РасшифроватьXMLПодготовитьРезультат +
+ +Описание, пример вызова + +```bsl + +Процедура РасшифроватьXMLПодготовитьРезультат(РезультатВызова, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.РасшифроватьXMLПодготовитьРезультат(РезультатВызова, ВходящийКонтекст) +``` +
+ +## РасшифроватьXMLПослеШифрованияПослеЗаписиФайла +
+ +Описание, пример вызова + +```bsl + +Процедура РасшифроватьXMLПослеШифрованияПослеЗаписиФайла(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.РасшифроватьXMLПослеШифрованияПослеЗаписиФайла(Результат, ВходящийКонтекст) +``` +
+ +## ПакетнаяПодписьОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +Процедура ПакетнаяПодписьОблачнойПодписи( Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ПакетнаяПодписьОблачнойПодписи(); +``` +
+ +## ПакетнаяПодписьОблачнойПодписиПослеПодготовки +
+ +Описание, пример вызова + +```bsl + +Процедура ПакетнаяПодписьОблачнойПодписиПослеПодготовки(РезультатВызова, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ПакетнаяПодписьОблачнойПодписиПослеПодготовки(РезультатВызова, ВходящийКонтекст) +``` +
+ +## ПроверитьДанныеДляОперацииОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьДанныеДляОперацииОблачнойПодписи(ОповещениеОЗавершении, ИмяФайлаДанных, ТипОперации) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ПроверитьДанныеДляОперацииОблачнойПодписи(ОповещениеОЗавершении, ИмяФайлаДанных, ТипОперации)); +``` +
+ +## ПроверитьДанныеДляОперацииОблачнойПодписи_Продолжение +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьДанныеДляОперацииОблачнойПодписи_Продолжение(РезультатВызова, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ПроверитьДанныеДляОперацииОблачнойПодписи_Продолжение(РезультатВызова, ВходящийКонтекст) +``` +
+ +## ПроверитьДанныеДляОперацииОблачнойПодписиЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьДанныеДляОперацииОблачнойПодписиЗавершение(РезультатВызова, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ПроверитьДанныеДляОперацииОблачнойПодписиЗавершение(РезультатВызова, ВходящийКонтекст) +``` +
+ +## ПолучитьСтатусПодготовкиСертификата +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСтатусПодготовкиСертификата(СертификатОперации, ДанныеСертификата, ПодписьСертификата, ОтпечатокСертификата) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиент.ПолучитьСтатусПодготовкиСертификата(СертификатОперации, ДанныеСертификата, ПодписьСертификата, ОтпечатокСертификата)); +``` +
+ +## УстановитьСтатусПодготовкиСертификата +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьСтатусПодготовкиСертификата(ОтпечатокСертификата, НовоеЗначение, ВключаяСервер = Ложь) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.УстановитьСтатусПодготовкиСертификата(ОтпечатокСертификата, НовоеЗначение, ВключаяСервер); +``` +
+ +## ПроверитьПодготовкуОблачногоСертификата +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьПодготовкуОблачногоСертификата(СертификатОперации, ТипОперации, ОповещениеОЗавершении) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ПроверитьПодготовкуОблачногоСертификата(СертификатОперации, ТипОперации, ОповещениеОЗавершении)); +``` +
+ +## ПроверитьПодготовкуОблачногоСертификата_Окончание +
+ +Описание, пример вызова + +```bsl + +Процедура ПроверитьПодготовкуОблачногоСертификата_Окончание(ДлительнаяОперация, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ПроверитьПодготовкуОблачногоСертификата_Окончание(ДлительнаяОперация, ВходящийКонтекст) +``` +
+ +## ПроверитьПодготовкуОблачногоСертификата_Результат +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьПодготовкуОблачногоСертификата_Результат(ПодготовкаСертификата, СертификатОперации, ТипОперации, Дополнение = "") Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиент.ПроверитьПодготовкуОблачногоСертификата_Результат(ПодготовкаСертификата, СертификатОперации, ТипОперации, Дополнение); +``` +
+ +## ПреобразоватьДанныеОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +Функция ПреобразоватьДанныеОблачнойПодписи(ДанныеФайла, ТипДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиент.ПреобразоватьДанныеОблачнойПодписи(ДанныеФайла, ТипДанных) +``` +
+ +## ИспользованиеОблачнойПодписиВозможно +
+ +Описание, пример вызова + +```bsl + +Функция ИспользованиеОблачнойПодписиВозможно() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиент.ИспользованиеОблачнойПодписиВозможно() +``` +
+ +## ПолучитьУчетнуюЗаписьОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьУчетнуюЗаписьОблачнойПодписи(МестоХраненияКлюча, УчетнаяЗаписьОблачнойПодписи, ОписаниеСледующее = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиент.ПолучитьУчетнуюЗаписьОблачнойПодписи(МестоХраненияКлюча, УчетнаяЗаписьОблачнойПодписи, ОписаниеСледующее); +``` +
+ +## ПолучитьМодульПодсистемы +
+ +Описание, пример вызова + +```bsl + +// Получение модуля указанной подсистемы. +// Позволяет избежать ошибки синтаксической проверки, если подсистемы нет. +// +Функция ПолучитьМодульПодсистемы(ИмяМодуля, ИмяПодсистемы = "") Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиент.ПолучитьМодульПодсистемы(ИмяМодуля, ИмяПодсистемы); +``` +
+ +## ПроверитьНастройкиУчетнойЗаписиОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +Функция ПроверитьНастройкиУчетнойЗаписиОблачнойПодписи(УчетнаяЗаписьОблачнойПодписи, ОповещениеОЗавершении = Неопределено, ВидОперации = "") Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиент.ПроверитьНастройкиУчетнойЗаписиОблачнойПодписи(УчетнаяЗаписьОблачнойПодписи, ОповещениеОЗавершении, ВидОперации); +``` +
+ +## ДополнитьПараметрыОперацииОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьПараметрыОперацииОблачнойПодписи(ПараметрыОперации, МестоХраненияКлюча) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиент.ДополнитьПараметрыОперацииОблачнойПодписи(ПараметрыОперации, МестоХраненияКлюча)); +``` +
+ +## ПараметрыОперацииОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +Функция ПараметрыОперацииОблачнойПодписи(МестоХраненияКлюча = Неопределено, ПараметрыОперации = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиент.ПараметрыОперацииОблачнойПодписи(МестоХраненияКлюча, ПараметрыОперации); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/КриптографияЭДКОСлужебныйКлиентСервер.md b/src/content/docs/zup/КриптографияЭДКОСлужебныйКлиентСервер.md new file mode 100644 index 0000000..002182a --- /dev/null +++ b/src/content/docs/zup/КриптографияЭДКОСлужебныйКлиентСервер.md @@ -0,0 +1,724 @@ +--- +title: Криптография ЭДКО служебный клиент сервер +slug: zup/криптография-эдко-служебный-клиент-сервер +--- + + +## ОшибкаНеУдалосьПодключитьВнешнююКомпоненту +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУдалосьПодключитьВнешнююКомпоненту() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУдалосьПодключитьВнешнююКомпоненту() +``` +
+ +## ОшибкаНеУстановленКриптопровайдерCryptoPro +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУстановленКриптопровайдерCryptoPro() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУстановленКриптопровайдерCryptoPro() +``` +
+ +## ОшибкаНеУстановленКриптопровайдерViPNet +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУстановленКриптопровайдерViPNet() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУстановленКриптопровайдерViPNet() +``` +
+ +## ОшибкаНедоступенЗакрытыйКлюч +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНедоступенЗакрытыйКлюч() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНедоступенЗакрытыйКлюч() +``` +
+ +## ОшибкаНеклассифицированнаяОшибкаВыполнения +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеклассифицированнаяОшибкаВыполнения(ОписаниеОшибки) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеклассифицированнаяОшибкаВыполнения(ОписаниеОшибки) +``` +
+ +## ОшибкаСервисКриптографииНеДоступенДляИспользования +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаСервисКриптографииНеДоступенДляИспользования() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаСервисКриптографииНеДоступенДляИспользования() +``` +
+ +## ОшибкаНекорректныйФорматФайлаДляРасшифровки +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНекорректныйФорматФайлаДляРасшифровки(ОписаниеФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНекорректныйФорматФайлаДляРасшифровки(ОписаниеФайла) +``` +
+ +## ОшибкаПустойФайлДляРасшифровки +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаПустойФайлДляРасшифровки(ОписаниеФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаПустойФайлДляРасшифровки(ОписаниеФайла) +``` +
+ +## ОшибкаВнешняяКомпонентаПодключенаНоНеУдалосьСоздатьAddIn +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаВнешняяКомпонентаПодключенаНоНеУдалосьСоздатьAddIn() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаВнешняяКомпонентаПодключенаНоНеУдалосьСоздатьAddIn() +``` +
+ +## ОшибкаНеУдалосьПодключитьРасширениеДляРаботыСФайлами +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУдалосьПодключитьРасширениеДляРаботыСФайлами() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУдалосьПодключитьРасширениеДляРаботыСФайлами() +``` +
+ +## ОшибкаОтсутствуетКомпонентаДляИспользуемогоКлиентскогоПриложения +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаОтсутствуетКомпонентаДляИспользуемогоКлиентскогоПриложения() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаОтсутствуетКомпонентаДляИспользуемогоКлиентскогоПриложения() +``` +
+ +## ОшибкаНеУстановленКриптопровайдер +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУстановленКриптопровайдер(Криптопровайдер) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУстановленКриптопровайдер(Криптопровайдер) +``` +
+ +## ОшибкаВведенНеправильныйPINКод +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаВведенНеправильныйPINКод() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаВведенНеправильныйPINКод() +``` +
+ +## ОшибкаТокенЗаблокирован +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаТокенЗаблокирован() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаТокенЗаблокирован() +``` +
+ +## ОшибкаОперацияБылаОтмененаПользователем +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаОперацияБылаОтмененаПользователем() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаОперацияБылаОтмененаПользователем() +``` +
+ +## ОшибкаНеУстановленНиОдинИзПоддерживаемыхКриптопровайдеров +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУстановленНиОдинИзПоддерживаемыхКриптопровайдеров() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУстановленНиОдинИзПоддерживаемыхКриптопровайдеров() +``` +
+ +## ОшибкаНеУдалосьИнициализироватьМенеджерКриптографии +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУдалосьИнициализироватьМенеджерКриптографии(Криптопровайдер, КодОшибки) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУдалосьИнициализироватьМенеджерКриптографии(Криптопровайдер, КодОшибки) +``` +
+ +## ОшибкаСертификатНеУстановленВСистемноеХранилище +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаСертификатНеУстановленВСистемноеХранилище() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаСертификатНеУстановленВСистемноеХранилище() +``` +
+ +## ОшибкаСертификатИлиЗакрытыйКлючНеНайдены +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаСертификатИлиЗакрытыйКлючНеНайдены() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаСертификатИлиЗакрытыйКлючНеНайдены() +``` +
+ +## ОшибкаСертификатНеСвязанСЗакрытымКлючом +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаСертификатНеСвязанСЗакрытымКлючом() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаСертификатНеСвязанСЗакрытымКлючом() +``` +
+ +## ОшибкаСертификатОтключен +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаСертификатОтключен() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаСертификатОтключен() +``` +
+ +## ОшибкаСертификатОтключенНаВремяСеанса +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаСертификатОтключенНаВремяСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаСертификатОтключенНаВремяСеанса() +``` +
+ +## ОшибкаРасшифровкиСервисомКриптографии +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаРасшифровкиСервисомКриптографии(ИнформацияОбОшибке) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаРасшифровкиСервисомКриптографии(ИнформацияОбОшибке) +``` +
+ +## ОшибкаViPNetCSPНеЗарегистрирован +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаViPNetCSPНеЗарегистрирован() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаViPNetCSPНеЗарегистрирован() +``` +
+ +## ОшибкаРасшифровкиЛокальнымКриптопровайдером +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаРасшифровкиЛокальнымКриптопровайдером(Криптопровайдер = Неопределено, КодОшибки = Неопределено, ОписаниеОшибки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаРасшифровкиЛокальнымКриптопровайдером(Криптопровайдер, КодОшибки, ОписаниеОшибки); +``` +
+ +## ОшибкаУстановленоБолееОдногоКриптопровайдера +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаУстановленоБолееОдногоКриптопровайдера(УстановленныеКриптопровайдеры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаУстановленоБолееОдногоКриптопровайдера(УстановленныеКриптопровайдеры); +``` +
+ +## ОшибкаНеУдалосьРасшифроватьФайл +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУдалосьРасшифроватьФайл(ОписаниеФайла) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУдалосьРасшифроватьФайл(ОписаниеФайла) +``` +
+ +## ОшибкаНетАктивныхСертификатовДляРасшифровкиФайла +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНетАктивныхСертификатовДляРасшифровкиФайла(ОписаниеФайла = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНетАктивныхСертификатовДляРасшифровкиФайла(ОписаниеФайла); +``` +
+ +## ОшибкаНеУдалосьПолучитьСсылкуНаЗакрытыйКлюч +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУдалосьПолучитьСсылкуНаЗакрытыйКлюч(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУдалосьПолучитьСсылкуНаЗакрытыйКлюч(Сертификат) +``` +
+ +## ОшибкаНеУдалосьВыгрузитьСертификат +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУдалосьВыгрузитьСертификат(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУдалосьВыгрузитьСертификат(Сертификат) +``` +
+ +## ОшибкаНеУдалосьПолучитьСписокКлючевыхКонтейнеров +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУдалосьПолучитьСписокКлючевыхКонтейнеров(Криптопровайдер) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУдалосьПолучитьСписокКлючевыхКонтейнеров(Криптопровайдер) +``` +
+ +## ОшибкаУдостоверяющийЦентрНеАвторизованФирмой1С +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаУдостоверяющийЦентрНеАвторизованФирмой1С(УдостоверяющийЦентр) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаУдостоверяющийЦентрНеАвторизованФирмой1С(УдостоверяющийЦентр) +``` +
+ +## ОшибкаУстановкиСертификатаСервисомКриптографии +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаУстановкиСертификатаСервисомКриптографии(ИнформацияОбОшибке) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаУстановкиСертификатаСервисомКриптографии(ИнформацияОбОшибке) +``` +
+ +## ОшибкаНеУдалосьУстановитьСертификатВКонтейнерЗакрытогоКлюча +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУдалосьУстановитьСертификатВКонтейнерЗакрытогоКлюча(Сертификат, Код = 0, Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУдалосьУстановитьСертификатВКонтейнерЗакрытогоКлюча(Сертификат, Код, Описание); +``` +
+ +## ОшибкаНеУдалосьУстановитьСертификатВСистемноеХранилище +
+ +Описание, пример вызова + +```bsl + +Функция ОшибкаНеУдалосьУстановитьСертификатВСистемноеХранилище(Сертификат, Код = 0, Описание = "") Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ОшибкаНеУдалосьУстановитьСертификатВСистемноеХранилище(Сертификат, Код, Описание); +``` +
+ +## ЕстьОшибка +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьОшибка(МассивОшибок, Ошибка) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ЕстьОшибка(МассивОшибок, Ошибка) +``` +
+ +## УдалитьОшибку +
+ +Описание, пример вызова + +```bsl + +Процедура УдалитьОшибку(Ошибки, УдаляемаяОшибка) Экспорт +``` + +Пример вызова +```bsl +КриптографияЭДКОСлужебныйКлиентСервер.УдалитьОшибку(Ошибки, УдаляемаяОшибка) +``` +
+ +## АвторизованныеУдостоверяющиеЦентры +
+ +Описание, пример вызова + +```bsl + +// Возвращает описания авторизованных фирмой 1С удостоверяющих центров. +// +// Возвращаемое значение: +// ФиксированныйМассив - массив с описаниями удостоверяющих центров. +// * Наименование - Строка - наименование УЦ. +// * Идентификаторы - Массив - идентификаторы УЦ. Составляющая 'O' из издателя сертификата. +// +Функция АвторизованныеУдостоверяющиеЦентры() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.АвторизованныеУдостоверяющиеЦентры() +``` +
+ +## УЦКазначейство +
+ +Описание, пример вызова + +```bsl + +Функция УЦКазначейство() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.УЦКазначейство() +``` +
+ +## УЦБанкРоссии +
+ +Описание, пример вызова + +```bsl + +Функция УЦБанкРоссии() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.УЦБанкРоссии() +``` +
+ +## ИздательСертификата +
+ +Описание, пример вызова + +```bsl + +Функция ИздательСертификата(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ИздательСертификата(Сертификат) +``` +
+ +## ИзданУЦКазначейство +
+ +Описание, пример вызова + +```bsl + +Функция ИзданУЦКазначейство(Сертификат) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ИзданУЦКазначейство(Сертификат) +``` +
+ +## ИзданУЦ +
+ +Описание, пример вызова + +```bsl + +Функция ИзданУЦ(Сертификат, УЦ) Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ИзданУЦ(Сертификат, УЦ) +``` +
+ +## ТипКриптосообщенияЗашифрованныеДанные +
+ +Описание, пример вызова + +```bsl + +Функция ТипКриптосообщенияЗашифрованныеДанные() Экспорт +``` + +Пример вызова +```bsl +Результат = КриптографияЭДКОСлужебныйКлиентСервер.ТипКриптосообщенияЗашифрованныеДанные() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МаршрутыПодписанияБЭД.md b/src/content/docs/zup/МаршрутыПодписанияБЭД.md new file mode 100644 index 0000000..c7cf61c --- /dev/null +++ b/src/content/docs/zup/МаршрутыПодписанияБЭД.md @@ -0,0 +1,30 @@ +--- +title: Маршруты подписания БЭД +slug: zup/маршруты-подписания-бэд +--- + + +## ПриНастройкеПодчиненногоУзлаРИБ +
+ +Описание, пример вызова + +```bsl + +// См. ЭлектронноеВзаимодействие.ПриНастройкеПодчиненногоУзлаРИБ. +Процедура ПриНастройкеПодчиненногоУзлаРИБ() Экспорт +``` + +Пример вызова +```bsl +МаршрутыПодписанияБЭД.ПриНастройкеПодчиненногоУзлаРИБ() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МаршрутыПодписанияБЭДКлиентСервер.md b/src/content/docs/zup/МаршрутыПодписанияБЭДКлиентСервер.md new file mode 100644 index 0000000..f198ace --- /dev/null +++ b/src/content/docs/zup/МаршрутыПодписанияБЭДКлиентСервер.md @@ -0,0 +1,117 @@ +--- +title: Маршруты подписания БЭД клиент сервер +slug: zup/маршруты-подписания-бэд-клиент-сервер +--- + + +## ОпределитьПараметрыПодчиненныхСтрокДерева +
+ +Описание, пример вызова + +```bsl + +// Определяет параметры подчиненных строк дерева подписания, необходимые для работы механизмов отрисовки и +// редактирования. +// +// Параметры: +// СтрокаДерева - ДанныеФормыЭлементДерева - строка дерева. +// ЕстьУсловия - Булево - в параметр возвращается Истина, если в подчиненных строках указаны требования к +// подписанию. +// ЕстьПодписанты - Булево - в параметр возвращается Истина, если в подчиненных строках указаны подписанты. +// ВыбранныеЗначения - Массив - требования или подписанты, выбранные в подчиненных строках. +// +Процедура ОпределитьПараметрыПодчиненныхСтрокДерева(СтрокаДерева, ЕстьУсловия = Ложь, ЕстьПодписанты = Ложь, Экспорт +``` + +Пример вызова +```bsl +МаршрутыПодписанияБЭДКлиентСервер.ОпределитьПараметрыПодчиненныхСтрокДерева(СтрокаДерева, ЕстьУсловия, ЕстьПодписанты, ); +``` +
+ +## ЗаполнитьСлужебныеРеквизитыСтрокиДерева +
+ +Описание, пример вызова + +```bsl + +// Заполняет служебные реквизиты дерева подписания. +// +// Параметры: +// СтрокаДерева - ДанныеФормыЭлементДерева, СтрокаДереваЗначений - строка дерева. +// ИмяОсновногоРеквизита- Строка - имя реквизита дерева, который будет выводиться в основной колонке. +// +Процедура ЗаполнитьСлужебныеРеквизитыСтрокиДерева(СтрокаДерева, ИмяОсновногоРеквизита = "Подписант") Экспорт +``` + +Пример вызова +```bsl +МаршрутыПодписанияБЭДКлиентСервер.ЗаполнитьСлужебныеРеквизитыСтрокиДерева(СтрокаДерева, ИмяОсновногоРеквизита); +``` +
+ +## СоответствиеПредставленийТребованиям +
+ +Описание, пример вызова + +```bsl + +// Определяет соответствие текстовых представлений требований их ссылочным значениям. +// +// Параметры: +// СтрокаДерева - ДанныеФормыЭлементДерева - строка дерева. +// +// Возвращаемое значение: +// Соответствие - ключом является требование, значением - его текстовое представление. +// +Функция СоответствиеПредставленийТребованиям(СтрокаДерева) Экспорт +``` + +Пример вызова +```bsl +Результат = МаршрутыПодписанияБЭДКлиентСервер.СоответствиеПредставленийТребованиям(СтрокаДерева) +``` +
+ +## МаршрутУказыватьПриСоздании +
+ +Описание, пример вызова + +```bsl + +Функция МаршрутУказыватьПриСоздании() Экспорт +``` + +Пример вызова +```bsl +Результат = МаршрутыПодписанияБЭДКлиентСервер.МаршрутУказыватьПриСоздании() +``` +
+ +## МаршрутОднойДоступнойПодписью +
+ +Описание, пример вызова + +```bsl + +Функция МаршрутОднойДоступнойПодписью() Экспорт +``` + +Пример вызова +```bsl +Результат = МаршрутыПодписанияБЭДКлиентСервер.МаршрутОднойДоступнойПодписью() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/Медицина.md b/src/content/docs/zup/Медицина.md new file mode 100644 index 0000000..e1281cf --- /dev/null +++ b/src/content/docs/zup/Медицина.md @@ -0,0 +1,98 @@ +--- +title: Медицина +slug: zup/медицина +--- + + +## ДополнитьОписаниеИсточниковСведенийОШтатномРасписании +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеШтатнымРасписанием.ОписаниеИсточниковСведенийОШтатномРасписании. +Процедура ДополнитьОписаниеИсточниковСведенийОШтатномРасписании(ОписаниеИсточников) Экспорт +``` + +Пример вызова +```bsl +Медицина.ДополнитьОписаниеИсточниковСведенийОШтатномРасписании(ОписаниеИсточников) +``` +
+ +## ДополнитьФильтрПоВидуДолжностейЗаполненияПозиций +
+ +Описание, пример вызова + +```bsl + +// Добавляет в переданный отбор условие, ограничивающее выборку только медицинскими должности. +// +// Параметры: +// Отбор - массив отборов. +// ИмяКомандыЗаполнения - строка с именем команды заполнения (см. функцию ИмяКомандыЗаполненияПоВидуДолжности), +// которое определяет необходимость установки отбора. +// +Процедура ДополнитьФильтрПоВидуДолжностейЗаполненияПозиций(ИмяКомандыЗаполнения, Отбор) Экспорт +``` + +Пример вызова +```bsl +Медицина.ДополнитьФильтрПоВидуДолжностейЗаполненияПозиций(ИмяКомандыЗаполнения, Отбор) +``` +
+ +## ДополнитьФильтрПоПоОстальнымДолжностямЗаполненияПозиций +
+ +Описание, пример вызова + +```bsl + +// Добавляет в переданный отбор условия, исключающие из выборки медицинские должности. +// +// Параметры: +// Отбор - массив отборов. +// +Процедура ДополнитьФильтрПоПоОстальнымДолжностямЗаполненияПозиций(Отбор) Экспорт +``` + +Пример вызова +```bsl +Медицина.ДополнитьФильтрПоПоОстальнымДолжностямЗаполненияПозиций(Отбор) +``` +
+ +## ДобавитьКомандуЗаполненияПоВидуДолжности +
+ +Описание, пример вызова + +```bsl + +// Добавляет в массив команд заполнения данные команды для заполнения должностями медработников. +// +// Параметры: +// КомандыЗаполнения - массив команд заполнения. +// +// Возвращаемое значение: +// Булево - Истина, если команда была добавлена. +// +Функция ДобавитьКомандуЗаполненияПоВидуДолжности(КомандыЗаполнения) Экспорт +``` + +Пример вызова +```bsl +Результат = Медицина.ДобавитьКомандуЗаполненияПоВидуДолжности(КомандыЗаполнения) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МедицинскиеРегистры.md b/src/content/docs/zup/МедицинскиеРегистры.md new file mode 100644 index 0000000..ce2d51c --- /dev/null +++ b/src/content/docs/zup/МедицинскиеРегистры.md @@ -0,0 +1,189 @@ +--- +title: Медицинские регистры +slug: zup/медицинские-регистры +--- + + +## ДоступнаВыгрузкаЗаработнойПлаты +
+ +Описание, пример вызова + +```bsl + +Функция ДоступнаВыгрузкаЗаработнойПлаты() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистры.ДоступнаВыгрузкаЗаработнойПлаты() +``` +
+ +## СоздатьДополнительныеРеквизитыМедицинскихРегистров +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьДополнительныеРеквизитыМедицинскихРегистров(Форма, ПодчиненныеКлассификаторыМедрегистров, Префикс="") Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистры.СоздатьДополнительныеРеквизитыМедицинскихРегистров(Форма, ПодчиненныеКлассификаторыМедрегистров, Префикс); +``` +
+ +## ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ПриСозданииНаСервере(Форма, ИмяГруппыРеквизитовМедицинскихРегистров = "РеквизитыМедицинскихРегистров") Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистры.ПриСозданииНаСервере(Форма, ИмяГруппыРеквизитовМедицинскихРегистров); +``` +
+ +## ДобавитьПодчиненныеХарактеристики +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьПодчиненныеХарактеристики(Форма, ИмяРеквизитаВладельца, ЗаданныеКласссификаторы, ИмяГруппыРеквизитовМедицинскихРегистров = "РеквизитыМедицинскихРегистров") Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистры.ДобавитьПодчиненныеХарактеристики(Форма, ИмяРеквизитаВладельца, ЗаданныеКласссификаторы, ИмяГруппыРеквизитовМедицинскихРегистров); +``` +
+ +## ДополнитьФормуУслугами +
+ +Описание, пример вызова + +```bsl + +Процедура ДополнитьФормуУслугами(Форма, ВладелецУслуг, ИмяГруппыРеквизитовМедицинскихРегистров = "РеквизитыМедицинскихРегистров", ЗаголовокДерева = "") Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистры.ДополнитьФормуУслугами(Форма, ВладелецУслуг, ИмяГруппыРеквизитовМедицинскихРегистров, ЗаголовокДерева); +``` +
+ +## ОбновитьДеревоУслуг +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьДеревоУслуг(Форма, ВладелецУслуг) Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистры.ОбновитьДеревоУслуг(Форма, ВладелецУслуг) +``` +
+ +## ОбновитьСвязанныеХарактеристики +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьСвязанныеХарактеристики(Форма, Должность, ИмяХарактеристики) Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистры.ОбновитьСвязанныеХарактеристики(Форма, Должность, ИмяХарактеристики) +``` +
+ +## ЗапросОпределитьПолныеНаименованияУчебныхЗаведений +
+ +Описание, пример вызова + +```bsl + +Функция ЗапросОпределитьПолныеНаименованияУчебныхЗаведений(ПараметрыОбновления = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистры.ЗапросОпределитьПолныеНаименованияУчебныхЗаведений(ПараметрыОбновления); +``` +
+ +## ПослеЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеЗаписиНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистры.ПослеЗаписиНаСервере(Форма) +``` +
+ +## СоздатьЭлементСписокУслугВФорме +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьЭлементСписокУслугВФорме(Форма,ИмяРеквизита,ЭлементГруппа,ОтображатьЗаголовок=Ложь) Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистры.СоздатьЭлементСписокУслугВФорме(Форма, ИмяРеквизита, ЭлементГруппа, ОтображатьЗаголовок); +``` +
+ +## СоздатьЭлементРеквизитаМедицинскогоРегистраВФорме +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьЭлементРеквизитаМедицинскогоРегистраВФорме(Форма, ОписаниеРеквизита, ЭлементГруппа, ТолькоПросмотр = Ложь) Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистры.СоздатьЭлементРеквизитаМедицинскогоРегистраВФорме(Форма, ОписаниеРеквизита, ЭлементГруппа, ТолькоПросмотр); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МедицинскиеРегистрыВызовСервера.md b/src/content/docs/zup/МедицинскиеРегистрыВызовСервера.md new file mode 100644 index 0000000..6fc4bfe --- /dev/null +++ b/src/content/docs/zup/МедицинскиеРегистрыВызовСервера.md @@ -0,0 +1,45 @@ +--- +title: Медицинские регистры вызов сервера +slug: zup/медицинские-регистры-вызов-сервера +--- + + +## КлассификаторКвалификацияМедицинскогоПерсонала +
+ +Описание, пример вызова + +```bsl + +Функция КлассификаторКвалификацияМедицинскогоПерсонала() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыВызовСервера.КлассификаторКвалификацияМедицинскогоПерсонала() +``` +
+ +## ЗначенияДополнительныхРеквизитовМедицинскихРегистров +
+ +Описание, пример вызова + +```bsl + +Функция ЗначенияДополнительныхРеквизитовМедицинскихРегистров(ОбъектСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыВызовСервера.ЗначенияДополнительныхРеквизитовМедицинскихРегистров(ОбъектСсылка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МедицинскиеРегистрыКлиент.md b/src/content/docs/zup/МедицинскиеРегистрыКлиент.md new file mode 100644 index 0000000..8bd58ec --- /dev/null +++ b/src/content/docs/zup/МедицинскиеРегистрыКлиент.md @@ -0,0 +1,29 @@ +--- +title: Медицинские регистры клиент +slug: zup/медицинские-регистры-клиент +--- + + +## РеквизитыМедицинскогоРегистраЭлементПриИзменении +
+ +Описание, пример вызова + +```bsl + +Процедура РеквизитыМедицинскогоРегистраЭлементПриИзменении(Форма, ИмяЭлемента) Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистрыКлиент.РеквизитыМедицинскогоРегистраЭлементПриИзменении(Форма, ИмяЭлемента) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МедицинскиеРегистрыФРМО.md b/src/content/docs/zup/МедицинскиеРегистрыФРМО.md new file mode 100644 index 0000000..6fc8015 --- /dev/null +++ b/src/content/docs/zup/МедицинскиеРегистрыФРМО.md @@ -0,0 +1,419 @@ +--- +title: Медицинские регистры ФРМО +slug: zup/медицинские-регистры-фрмо +--- + + +## GetOrgList +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения данных одной или нескольких организаций. +// +// Параметры: +// orgTypeId - Число - тип организации: +// 1 - Государственное или муниципальное юридическое лицо. +// 2 - Частное юридическое лицо. +// 3 - Индивидуальный предприниматель. +// offset - Число - количество записей, которые нужно пропустить (отступ). +// limit - Число - количество записей, которые нужно получить. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистрыКлиентСервер.ПараметрыВызоваМетода. +// +Функция GetOrgList(orgTypeId, offset, limit) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.GetOrgList(orgTypeId, offset, limit) +``` +
+ +## GetOrg +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения данных указанной организации. +// +// Параметры: +// oid - Строка - идентификатор организации в ЕГИСЗ. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистрыКлиентСервер.ПараметрыВызоваМетода. +// +Функция GetOrg(oid) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.GetOrg(oid) +``` +
+ +## GetOrgDepart +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения данных одного или нескольких подразделений. +// +// Параметры: +// departTypeId - Число - тип подразделения: +// 1 - Амбулаторный. +// 2 - Стационарный. +// 3 - Лабораторно-диагностический. +// 4 - Инструментально-диагностический. +// 5 - Скорая медицинская помощь. +// 6 - Административно-хозяйственный (вспомогательный). +// 7 - Фармацевтический. +// oid - Строка - Идентификатор организации. +// offset - Число - количество записей, которые нужно пропустить (отступ). +// limit - Число - количество записей, которые нужно получить. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистрыКлиентСервер.ПараметрыВызоваМетода. +// +Функция GetOrgDepart(departTypeId, oid, offset, limit) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.GetOrgDepart(departTypeId, oid, offset, limit) +``` +
+ +## GetOrgStaff +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения всех сведений медицинского работника. +// +// Параметры: +// oid - Строка - идентификатор организации в ЕГИСЗ. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetOrgStaff(oid) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.GetOrgStaff(oid) +``` +
+ +## PostPutOrgStaff +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) +// или обновления (update) сведений о штатном расписании. +// +// Параметры: +// oid - Строка - идентификатор организации в ЕГИСЗ. +// entityId - Строка(36) – Идентификатор (GUID) записи блока данных о штатном расписании, +// которые необходимо изменить методом PUT (update) +// Для метода POST (create) оставлять в значении Неопределено. +// StaffData - Структура - Данные штатного расписания. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистрыКлиентСервер.ПараметрыВызоваМетода. +// +Функция PostPutOrgStaff(oid, entityId, StaffData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.PostPutOrgStaff(oid, entityId, StaffData) +``` +
+ +## StaffData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о штатном расписании. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// staffNum - Строка(20) – Номер штатного расписания. +// staffCreateDate - Дата – Дата утверждения. +// beginDate - Дата – Дата начала действия. +// endDate - Дата – Дата окончания действия. +// staffDetails - Массив – Записи штатного расписания (см. Функция staffDetails). +// +Функция StaffData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.StaffData() +``` +
+ +## StaffDetails +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о позиции штатного расписания. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// nrPmuDepartId - Строка – Идентификатор структурного подразделения МО (OID). +// departName - Строка – Наименование структурного подразделения МО. +// nrPmuDepartHospitalSubdivisionId - Строка – Идентификатор отделений стационарного подразделения (oid). +// hospitalName - Строка – Наименование отделения стационарного подразделения. +// postFedCode_code - Число – Код должности по Федеральному справочнику (1.2.643.5.1.13.13.99.2.885). +// postFedCode_name - Строка – Наименование должности по Федеральному справочнику (1.2.643.5.1.13.13.99.2.885). +// post_code - Число – Код должности (1.2.643.5.1.13.13.99.2.181). +// post_name - Строка – Наименование должности (1.2.643.5.1.13.13.99.2.181). +// flCount - Число – Количество физических лиц (человек). +// averageAge - Число – Средний возраст. +// rate - Число – Ставка, ед. +// busyRate - Число – Количество занятых штатных единиц. +// busyRateMain - Число – Количество занятых штатных единиц по основному месту работы. +// externalRate - Число – Количество внешних совместителей. +// vacancy - Число – Вакансий. +// staffNote - Строка(256) – Примечания к штатному расписанию. +// +Функция StaffDetails() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.StaffDetails() +``` +
+ +## GetSalaryPeriod +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения всех сведений медицинского работника. +// +// Параметры: +// oid - Строка - идентификатор организации в ЕГИСЗ. +// salaryPeriodType - Число - Тип периода заработной платы: +// 1 – Период фактических показателей. +// 2 – Период плановых показателей. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetSalaryPeriod(oid, salaryPeriodType, offset, limit) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.GetSalaryPeriod(oid, salaryPeriodType, offset, limit) +``` +
+ +## PostPutSalaryPeriod +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) +// или обновления (update) сведений о периоде заработной платы. +// +// Параметры: +// oid - Строка - идентификатор организации в ЕГИСЗ. +// entityId - Строка(36) – Идентификатор (GUID) записи блока данных о периоде заработной платы, +// которые необходимо изменить методом PUT (update) +// Для метода POST (create) оставлять в значении Неопределено. +// SalaryPeriodData - Структура - Данные периода заработной платы. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистрыКлиентСервер.ПараметрыВызоваМетода. +// +Функция PostPutSalaryPeriod(oid, entityId, SalaryPeriodData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.PostPutSalaryPeriod(oid, entityId, SalaryPeriodData) +``` +
+ +## PostPutSalaryPeriodRecord +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) +// или обновления (update) записи заработной платы. +// +// Параметры: +// oid - Строка - идентификатор организации в ЕГИСЗ. +// entityId - Строка(36) – Идентификатор (GUID) записи блока данных записи заработной платы, +// которые необходимо изменить методом PUT (update) +// Для метода POST (create) оставлять в значении Неопределено. +// SalaryPeriodRecordData - Структура - Данные записи заработной платы. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистрыКлиентСервер.ПараметрыВызоваМетода. +// +Функция PostPutSalaryPeriodRecord(oid, entityId, SalaryPeriodRecordData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.PostPutSalaryPeriodRecord(oid, entityId, SalaryPeriodRecordData) +``` +
+ +## SalaryPeriodData +
+ +Описание, пример вызова + +```bsl + + +// Конструктор структуры данных о периоде заработной платы. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// salaryPeriodId - Строка(GUID) – Идентификатор периода заработной платы. +// Только для обновления существующих записей метод PUT. +// salaryPeriodType - Число – Тип периода заработной платы: +// 1 – Период фактических показателей. +// 2 – Период плановых показателей. +// periodDate - Дата(ISO8601) – Отчетный период. Минимальное значение 01.01.2018. +// Пример заполнения ГГГГ-ММ-01. +// Для фактических показателей можно указывать дату только предыдущих месяцев. +// staff - Объект – Данные штатного расписания: +// staffId - Строка – Идентификатор штатного расписания (GUID). +// +Функция SalaryPeriodData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.SalaryPeriodData() +``` +
+ +## SalaryPeriodRecordData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о записи заработной платы. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// salaryPeriodRecordId - Строка(GUID) – Идентификатор записи заработной платы. +// Только для обновления существующих записей метод PUT. +// salaryPeriod - Объект – Период заработной платы записи: +// salaryPeriodId - Строка – Идентификатор периода ЗП (GUID). +// salaryPeriodType - Число – Тип периода заработной платы: +// 1 – Период фактических показателей. +// 2 – Период плановых показателей. +// periodDate - Дата(ISO8601) – Отчетный период. Минимальное значение 01.01.2018. +// Пример заполнения ГГГГ-ММ-01. +// Для фактических показателей можно указывать дату только предыдущих месяцев. +// departId - Строка – OID структурного подразделения. +// subdivisionId - Строка – OID отделения стационара (заполняется только для стационаров). +// postFedCode.code - Число – Код должности по Федеральному справочнику (1.2.643.5.1.13.13.99.2.885). +// postFedCode.name - Строка – Наименование должности по Федеральному справочнику (1.2.643.5.1.13.13.99.2.885). +// personalFileNumber - Строка – Идентификатор занятости (только для фактических показателей). "AABBBBBCCCCCCCC": +// A - код региона, +// B - код должности по федеральному справочнику 885, +// C - порядковый номер записи ЛД в рамках региона. +// personCardId - Строка – Идентификатор личного дела (в записях для позиций ШР не заполняется). +// financingSources - Массив объектов – Источники финансирования (см. Функция FinancingSourceData). +// +Функция SalaryPeriodRecordData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.SalaryPeriodRecordData() +``` +
+ +## FinancingSourceData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных об источнике финансирования. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// financingSourceId - Строка(GUID) – Идентификатор записи источника финансирования. +// Только для обновления существующих записей метод PUT. +// financingSource.code - Число – Идентификатор источника финансирования по Федеральному справочнику (1.2.643.5.1.13.13.99.2.1105). +// financingSource.name - Строка – Наименование источника финансирования по Федеральному справочнику (1.2.643.5.1.13.13.99.2.1105). +// Не обязательно к заполнению. +// financingSourceType - Число – Тип источника финансирования: +// 1 – Начисление. +// 2 – Удержание. +// accrualPurpose.code - Число – Идентификатор назначения начисления по Федеральному справочнику (1.2.643.5.1.13.13.99.2.1106). +// Заполняется только, если financingSourceType = 1. +// accrualPurpose.name - Строка – Наименование назначения начисления по Федеральному справочнику (1.2.643.5.1.13.13.99.2.1106). +// Не обязательно к заполнению. Заполняется только, если financingSourceType = 1 +// retentionPurpose.code - Число – Идентификатор назначения удержания по Федеральному справочнику (1.2.643.5.1.13.13.99.2.1107). +// Заполняется только, если financingSourceType = 2. +// retentionPurpose.name - Строка – Наименование назначения удержания по Федеральному справочнику (1.2.643.5.1.13.13.99.2.1107). +// Не обязательно к заполнению. Заполняется только, если financingSourceType = 2 +// accrual - Число – Начисление. Сумма в рублях, число с 2 знаками после запятой. Минимальное значение 0,01. +// Заполняется только, если financingSourceType = 1. +// retention - Число – Удержание. Сумма в рублях, число с 2 знаками после запятой. Минимальное значение 0,01. +// Заполняется только, если financingSourceType = 2. +// overtimeHours - Число – Количество часов переработок. Дробное число с 2 знаками после запятой. +// Не обязательно к заполнению. +// overtimePayment - Число – Выплата по переработкам. Сумма в рублях, число с 2 знаками после запятой. Минимальное значение 0,01. +// Не обязательно к заполнению. +// +Функция FinancingSourceData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМО.FinancingSourceData() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МедицинскиеРегистрыФРМР.md b/src/content/docs/zup/МедицинскиеРегистрыФРМР.md new file mode 100644 index 0000000..e978775 --- /dev/null +++ b/src/content/docs/zup/МедицинскиеРегистрыФРМР.md @@ -0,0 +1,950 @@ +--- +title: Медицинские регистры ФРМР +slug: zup/медицинские-регистры-фрмр +--- + + +## GetPerson +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения сведений медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetPerson(PersonKey) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.GetPerson(PersonKey) +``` +
+ +## GetPersonFull +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения всех сведений медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetPersonFull(PersonKey) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.GetPersonFull(PersonKey) +``` +
+ +## PostPutPerson +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода POST для создания (create) +// или PUT для изменения (update) сведений о медицинском работнике. +// +// Параметры: +// PersonKey - Структура - Данные идентификации медработника для метода PUT (см. описание функции PersonKey). +// Для метода POST (create) PersonKey.oid оставлять в значении Неопределено. +// PersonData - Структура - Данные медработника (см. описание функции PersonData). +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция PostPutPerson(PersonKey, PersonData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PostPutPerson(PersonKey, PersonData) +``` +
+ +## PersonData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры основных данных медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// +// ... +// +// documents - Массив – Документы, удостоверяющие личность (см. Функция PersonDocumentData). +// addresses - Массив – Адреса (см. Функция PersonAddressData). +// +Функция PersonData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonData() +``` +
+ +## PersonDocumentData +
+ +Описание, пример вызова + +```bsl + +// *** Документ, удостоверяющий личность. +//serial Строка Нет Серия документа, удостоверяющего личность Числовое поле до 10 символов +//number Строка Да Номер документа, удостоверяющего личность Числовое поле до 20 символов +//passDate Дата Да Дата выдачи документа, удостоверяющего личность Дата в формате ГГГГ-ММ-ДД +//passOrg Строка Да Организация выдачи документа, удостоверяющего личность Текст до 200 символов +//codeOrg Число Нет Код подразделения +//documentId Положительное число (unsigned int) Да Код документа, удостоверяющего личность Справочник ФНСИ «Документы, удостоверяющие личность», OID 1.2.643.5.1.13.13.99.2.48 +Функция PersonDocumentData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonDocumentData() +``` +
+ +## PersonAddressData +
+ +Описание, пример вызова + +```bsl + +Функция PersonAddressData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonAddressData() +``` +
+ +## GetPersonCard +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения личного дела медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetPersonCard(PersonKey) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.GetPersonCard(PersonKey) +``` +
+ +## PostPutPersonCard +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) или изменения данных личного дела медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// PersonCardData - Структура - см. описание функции PersonCardData. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция PostPutPersonCard(PersonKey, PersonCardData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PostPutPersonCard(PersonKey, PersonCardData) +``` +
+ +## PersonCardData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных личного дела медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// lastName - Строка – Фамилия медработника, необходимая для ключа запроса. +// oid - Строка – Идентификатор медицинской организации. +// id - Строка(36) – Идентификатор (GUID) записи блока данных, который возвращают методы GET (read) и POST (create). +// Для методов PUT (update) и DELETE этот идентификатор указывается как entityId в PersonKey. +// organization - Строка – Наименование организации по ФРМО. +// nrPmuDepartId - Строка – Идентификатор подразделения по ФРМО. +// nrPmuDepartHospitalSubdivisionId - Строка – Идентификатор отделения по ФРМО. +// roomOid - Строка – Идентификатор кабинета по ФРМО. +// contractNumber - Строка – Номер трудового договора. +// contractDate - Дата(ISO8601) – Дата заключения трудового договора. +// serviceNumber - Строка – Табельный номер. +// fedPositionId - Число – Должность по классификатору 1.2.643.5.1.13.13.99.2.885. +// seniority - Число – Трудовой стаж (дней). Необязательный параметр. +// services - Массив – Оказываемые медицинские услуги (см. функцию PersonCardServices). +// positionTypeId - Число – Тип занятия должности по классификатору 1.2.643.5.1.13.13.99.2.357. +// postId - Число – Должность по классификатору 1.2.643.5.1.13.13.99.2.181. +// rate - Число(5,4) – Ставка. +// beginDate - Дата(ISO8601) – Дата начала. +// endDate - Дата(ISO8601) – Дата окончания. +// endTypeId - Число – Основание окончания по классификатору 1.2.643.5.1.13.13.99.2.282. +// fireReasonId - Число – Причина увольнения по классификатору 1.2.643.5.1.13.13.99.2.196. +// targeted - Булево – Целевая подготовка. +// temporaryDerelictions - Массив – Список временных неисполнений функциональных обязанностей (см. функцию PersonCardTemporaryDerelictions). +// +Функция PersonCardData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonCardData() +``` +
+ +## PersonCardServices +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных об оказываемых медицинских услугах медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// code - Число – Код по классификатору 1.2.643.5.1.13.13.99.2.319. +// name - Строка – Наименование. Необязательный параметр. +Функция PersonCardServices() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonCardServices() +``` +
+ +## PersonCardTemporaryDerelictions +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о временных неисполнениях функциональных обязанностей медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// reasonId - Число – Причина неисполнения по классификатору 1.2.643.5.1.13.13.99.2.192. +// beginDate - Дата(ISO8601) – Дата начала неисполнения. +// endDate - Дата(ISO8601) – Дата окончания неисполнения. +Функция PersonCardTemporaryDerelictions() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonCardTemporaryDerelictions() +``` +
+ +## GetPersonProf +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения сведений о профессиональном образовании медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetPersonProf(PersonKey) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.GetPersonProf(PersonKey) +``` +
+ +## PostPutPersonProf +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) или изменения сведений о профессиональном образовании медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// PersonProfData - Структура - см. описание функции PersonProfData. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция PostPutPersonProf(PersonKey, PersonProfData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PostPutPersonProf(PersonKey, PersonProfData) +``` +
+ +## PersonProfData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о профессиональном образовании медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// profId - Строка(36) – Идентификатор (GUID) записи блока данных, который возвращают методы GET (read) и POST (create). +// Для методов PUT (update) и DELETE этот идентификатор указывается как entityId в PersonKey. +// institutionId - Строка – Образовательная организация (код классификатора 1.2.643.5.1.13.13.11.1519). +// docSerial - Строка(10) – Серия диплома. +// docNumber - Строка(20) – Номер диплома. +// docDate - Дата(ISO8601) – Дата выдачи диплома. +// +Функция PersonProfData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonProfData() +``` +
+ +## GetPersonPostgraduate +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения сведений о послевузовском образовании медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetPersonPostgraduate(PersonKey) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.GetPersonPostgraduate(PersonKey) +``` +
+ +## PostPutPersonPostgraduate +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) или изменения сведений о послевузовском образовании медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// PersonPostgraduateData - Структура - см. описание функции PersonPostgraduateData. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция PostPutPersonPostgraduate(PersonKey, PersonPostgraduateData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PostPutPersonPostgraduate(PersonKey, PersonPostgraduateData) +``` +
+ +## PersonPostgraduateData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о послевузовском образовании медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// postgraduateId - Строка(36) – Идентификатор (GUID) записи блока данных, который возвращают методы GET (read) и POST (create). +// Для методов PUT (update) и DELETE этот идентификатор указывается как entityId в PersonKey. +// isDuplicate - Булево – Истина – если документ является дубликатом. Ложь – если документ не является дубликатом. +// educPlace - Число – Место получения образования (0 – Россия/РСФСР, 1 – Республики СССР, 2 – иностранное государство). +// educationStageId - Число – Тип образования (код из классификатора 1.2.643.5.1.13.13.99.2.104). +// 1 Интернатура +// 2 Ординатура +// 3 Аспирантура +// 4 Докторантура +// 5 Соискательство +// isStudying - Булево – Учится по настоящее время. +// beginYear - Число – Год поступления. +// docSerial - Строка(6) – Серия диплома. +// docNumber - Строка(7) – Номер диплома. +// docDate - Дата(ISO8601) – Дата выдачи диплома. +// institutionId - Число – Образовательная организация (код из классификатора 1.2.643.5.1.13.13.11.1519). +// academicDegreeId - Число – Ученая степень (код из классификатора 1.2.643.5.1.13.13.11.1067). +// scienceBranchId - Число – Отрасль науки (код из классификатора 1.2.643.5.1.13.13.11.1068). +// specId - Число – Специальность для типов послевузовского образования «Интернатура» или «Ординатура» (код из классификатора 1.2.643.5.1.13.13.11.1066). +// doctSpecId - Число – Специальность для типов послевузовского образования «Аспирантура»/«Докторантура» (код из классификатора 1.2.643.5.1.13.13.99.2.220). +// isTargeted - Булево – Целевое обучение. +// targetedRegionId - Число – Заказчик целевого обучения (код из классификатора 1.2.643.5.1.13.13.99.2.206). +// dutyMonthsPeriod - Число – Срок исполнения обязательств в месяцах. +// isTargetTerminated - Булево – Расторгнуты ли обязательства по целевому обучению. +// terminationReasonId - Число – Причина расторжения целевых обязательств (код из классификатора 1.2.643.5.1.13.13.99.2.353). +// oksmId - Число – Страна (код из классификатора 1.2.643.5.1.13.2.1.1.63). +// unionRepublicId - Число – Союзная республика (код из классификатора 1.2.643.5.1.13.2.1.1.779). +// foreignInstitution - Строка(512) – Образовательная организация. +// hasForeignCert - Число – Наличие свидетельства о признании иностранного образования (0 – «Да», 1 – «Нет, но требуется», 2 – «Не требуется»). +// foreignCertSerial - Строка(2) – Серия бланка свидетельства о признании иностранного образования. +// foreignCertNumber - Строка(12) – Номер бланка свидетельства о признании иностранного образования. +// foreignCertDate - Дата(ISO8601) – Дата выдачи свидетельства. +// +// +Функция PersonPostgraduateData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonPostgraduateData() +``` +
+ +## GetPersonExt +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения сведений о дополнительном профессиональном образовании медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetPersonExt(PersonKey) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.GetPersonExt(PersonKey) +``` +
+ +## PostPutPersonExt +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) или изменения сведений о +// дополнительном профессиональном образовании медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// PersonPostgraduateData - Структура - см. описание функции PersonExtData. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция PostPutPersonExt(PersonKey, PersonExtData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PostPutPersonExt(PersonKey, PersonExtData) +``` +
+ +## PersonExtData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о дополнительном профессиональном образовании (ДПО) медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// extId - Строка(36) – Идентификатор (GUID) записи блока данных, который возвращают методы GET (read) и POST (create). +// Для методов PUT (update) и DELETE этот идентификатор указывается как entityId в PersonKey. +// profEducationKindId - Число – Вид ДПО (код из классификатора 1.2.643.5.1.13.13.99.2.297). +// 1 Повышение квалификации +// 2 Стажировка +// 3 Профессиональная переподготовка +// institutionId - Число – Образовательная организация (код из классификатора 1.2.643.5.1.13.13.11.1519). +// hoursCount - Число – Количество часов. +// theme - Строка(256) – Тематика. +// docSerial - Строка(6) – Серия диплома. +// docNumber - Строка(7) – Номер диплома. +// docDate - Дата(ISO8601) – Дата выдачи диплома. +// specId - Число – Специальность (код из классификатора 1.2.643.5.1.13.13.11.1066). +// +// +Функция PersonExtData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonExtData() +``` +
+ +## GetPersonCommon +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения сведений о среднем (общем) образовании медицинского работника. +// Подразумевается, что такое образование у человека только одно, т.к. возвращается не список, а единственный объект. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetPersonCommon(PersonKey) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.GetPersonCommon(PersonKey) +``` +
+ +## PostPutPersonCommon +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) или изменения сведений о среднем (общем) образовании медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// PersonCommonData - Структура - см. описание функции PersonCommonData. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция PostPutPersonCommon(PersonKey, PersonCommonData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PostPutPersonCommon(PersonKey, PersonCommonData) +``` +
+ +## PersonCommonData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о среднем (общем) образовании медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// commonId - Строка(36) – Идентификатор (GUID) записи блока данных, который возвращают методы GET (read) и POST (create). +// Для методов PUT (update) и DELETE этот идентификатор указывается как entityId в PersonKey. +// institution - Строка(512) – Образовательная организация. +// docSerial - Строка(5) – Серия аттестата. +// docNumber - Строка(14) – Номер аттестата. +// docDate - Дата(ISO8601) – Дата выдачи аттестата. +// profCourseSet - Массив – Профессиональные курсы (см. Функция PersonCommonProfCourse). +// Так как запись сведений о курсе не имеет идентификатора, +// то при обновлении данных весь список переписывается целиком. +// +Функция PersonCommonData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonCommonData() +``` +
+ +## PersonCommonProfCourse +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных профессионального курса, пройденного медицинским работником. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// docDate - Дата(ISO8601) – Дата выдачи документа. +// profCourseId - Число – Профессия. +// Справочник НСИ «ФРМР. Профессиональные курсы», OID 1.2.643.5.1.13.13.99.2.177). +// profCourseName - Строка – Наименование профессии. +// Справочник НСИ «ФРМР. Профессиональные курсы», OID 1.2.643.5.1.13.13.99.2.177). +// +Функция PersonCommonProfCourse() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonCommonProfCourse() +``` +
+ +## PostPutPersonCert +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) сведений о сертификате медицинского работника. +// Поскольку неизвестно, как сервис интерпретирует отсутствующие параметры данных, идентификатор параметра указывается всегда, +// даже если значение установлено в Неопределено - в этом случае в качестве значения используется пустая строка или пустой массив. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// PersonCertData - Структура - см. описание функции PersonCertData. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция PostPutPersonCert(PersonKey, PersonCertData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PostPutPersonCert(PersonKey, PersonCertData) +``` +
+ +## PersonCertData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о сертификате медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// certId - Строка(36) – Идентификатор (GUID) записи блока данных, который возвращают методы GET (read) и POST (create). +// Для методов PUT (update) и DELETE этот идентификатор указывается как entityId в PersonKey. +// institutionId - Строка(6) – Код учебного заведения в классификаторе ФРМР. +// institutionName - Строка(150) – Наименование учебного заведения в классификаторе ФРМР. +// certSerial - Строка(6) – Серия сертификата. +// certNumber - Строка(13) – Номер сертификата. +// examDate - Дата(ISO8601) – Дата сдачи сертификационного экзамена. +// passDate - Дата(ISO8601) – Дата выдачи сертификата. +// endDate - Дата(ISO8601) – Дата окончания срока действия сертификата специалиста. +// specId - Число – Специальность (код из классификатора 1.2.643.5.1.13.13.11.1066). +// specName - Строка(150) – Наименование специальности в классификаторе ФРМР. +// +Функция PersonCertData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonCertData() +``` +
+ +## GetPersonNomination +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения сведений о наградах медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetPersonNomination(PersonKey) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.GetPersonNomination(PersonKey) +``` +
+ +## PostPutPersonNomination +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) сведений о награде медицинского работника. +// Поскольку неизвестно, как сервис интерпретирует отсутствующие параметры данных, идентификатор параметра указывается всегда, +// даже если значение установлено в Неопределено - в этом случае в качестве значения используется пустая строка или пустой массив. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// PersonCertData - Структура - см. описание функции PersonCertData. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция PostPutPersonNomination(PersonKey, PersonNominationData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PostPutPersonNomination(PersonKey, PersonNominationData) +``` +
+ +## PersonNominationData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о награде медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// entityId - Число – Идентификатор записи блока данных, который возвращают методы GET (read) и POST (create). +// Для методов PUT (update) и DELETE этот идентификатор указывается как entityId в PersonKey. +// nominationId - Число – Награда (код из классификатора 1.2.643.5.1.13.13.99.2.44). +// nomNumber - Строка(20) – Номер. +// nomDate - Дата(ISO8601) – Дата. +// +Функция PersonNominationData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonNominationData() +``` +
+ +## GetPersonQualification +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для чтения сведений о квалификации медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция GetPersonQualification(PersonKey) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.GetPersonQualification(PersonKey) +``` +
+ +## PostPutPersonQualification +
+ +Описание, пример вызова + +```bsl + +// Возвращает параметры вызова rest-метода для создания (create) сведений о квалификации медицинского работника. +// Поскольку неизвестно, как сервис интерпретирует отсутствующие параметры данных, идентификатор параметра указывается всегда, +// даже если значение установлено в Неопределено - в этом случае в качестве значения используется пустая строка или пустой массив. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// PersonCertData - Структура - см. описание функции PersonCertData. +// +// Возвращаемое значение: +// Структура - см. описание функции МедицинскиеРегистры.ПараметрыВызоваМетода. +// +Функция PostPutPersonQualification(PersonKey, PersonQualificationData) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PostPutPersonQualification(PersonKey, PersonQualificationData) +``` +
+ +## PersonQualificationData +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры данных о квалификации медицинского работника. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// qualificationId - Число – Идентификатор записи блока данных, который возвращают методы GET (read) и POST (create). +// Для методов PUT (update) и DELETE этот идентификатор указывается как entityId в PersonKey. +// qualifyCategoryId - Число – Категория (код из классификатора 1.2.643.5.1.13.13.11.1494). +// beginDate - Дата(ISO8601) – Дата присвоения. +// endDate - Дата(ISO8601) – Дата окончания срока действия квалификационной категории. +// specId - Число – Специальность (код из классификатора 1.2.643.5.1.13.13.11.1066). +// fedPostId - Число – Должность по классификатору 1.2.643.5.1.13.13.99.2.885. +// postId - Число – Должность по классификатору 1.2.643.5.1.13.13.99.2.181. +// +Функция PersonQualificationData() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonQualificationData() +``` +
+ +## PersonKey +
+ +Описание, пример вызова + +```bsl + +// Конструктор структуры ключа, однозначно идентифицирующего медицинского работника. +// *** Подразумевается, что такое образование у человека только одно, т.к. метод GET возвращает не список, а единственный объект. +// +// Возвращаемое значение: +// Структура - параметры, необходимые для вызова метода сервиса REST. +// mo - Строка – Идентификатор организации. +// oid - Строка – OID Медицинского работника. +// snils - Строка(11) – СНИЛС. +// documentId - Число – Код документа, удостоверяющего личность. +// Справочник ФНСИ «Документы, удостоверяющие личность», OID 1.2.643.5.1.13.13.99.2.48. +// serial - Строка(10) – Серия документа, удостоверяющего личность. +// number - Строка(20) – Номер документа, удостоверяющего личность. +// passDate - Дата – Дата выдачи документа, удостоверяющего личность. +// entityId - Строка(36) – Идентификатор (GUID) записи блока специфических данных (об образовании, сертификате, +// аккредитации и т.п.), которые необходимо изменить или удалить методами PUT (update) +// или DELETE. Для остальных методов оставлять в значении Неопределено. +// +Функция PersonKey() Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonKey() +``` +
+ +## PersonKeyUrl +
+ +Описание, пример вызова + +```bsl + +// Формирует "командную" часть url запроса данных медицинского работника. +// +// Параметры: +// PersonKey - Структура - см. описание функции PersonKey. +// +// Возвращаемое значение: +// Строка - часть url, содержащая пары &параметр=значение. +// +Функция PersonKeyUrl(PersonKey, ПропуститьКлючMr = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.PersonKeyUrl(PersonKey, ПропуститьКлючMr); +``` +
+ +## ТегСоЗначениемИзЧислаИлиСтроки +
+ +Описание, пример вызова + +```bsl + +Функция ТегСоЗначениемИзЧислаИлиСтроки(Тег, ЗначениеИдентификатора) Экспорт +``` + +Пример вызова +```bsl +Результат = МедицинскиеРегистрыФРМР.ТегСоЗначениемИзЧислаИлиСтроки(Тег, ЗначениеИдентификатора)); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МедицинскиеРегистрыФормы.md b/src/content/docs/zup/МедицинскиеРегистрыФормы.md new file mode 100644 index 0000000..435903b --- /dev/null +++ b/src/content/docs/zup/МедицинскиеРегистрыФормы.md @@ -0,0 +1,29 @@ +--- +title: Медицинские регистры формы +slug: zup/медицинские-регистры-формы +--- + + +## УстановитьПараметрыВыбора +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьПараметрыВыбора(Форма, ИмяЭлементаУправления, КодКлассификатора) Экспорт +``` + +Пример вызова +```bsl +МедицинскиеРегистрыФормы.УстановитьПараметрыВыбора(Форма, ИмяЭлементаУправления, КодКлассификатора) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МенеджерОбменаЧерезУниверсальныйФормат13.md b/src/content/docs/zup/МенеджерОбменаЧерезУниверсальныйФормат13.md new file mode 100644 index 0000000..845f65f --- /dev/null +++ b/src/content/docs/zup/МенеджерОбменаЧерезУниверсальныйФормат13.md @@ -0,0 +1,1124 @@ +--- +title: Менеджер обмена через универсальный формат13 +slug: zup/менеджер-обмена-через-универсальный-формат13 +--- + + +## ПослеКонвертации +
+ +Описание, пример вызова + +```bsl + +Процедура ПослеКонвертации(КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПослеКонвертации(КомпонентыОбмена) +``` +
+ +## ПередОтложеннымЗаполнением +
+ +Описание, пример вызова + +```bsl + +Процедура ПередОтложеннымЗаполнением(КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПередОтложеннымЗаполнением(КомпонентыОбмена) +``` +
+ +## ВерсияФорматаМенеджераОбмена +
+ +Описание, пример вызова + +```bsl + +// Возвращает версию формата менеджера обмена. +// Возвращаемое значение: +// Число - номер версии. +Функция ВерсияФорматаМенеджераОбмена() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОбменаЧерезУниверсальныйФормат13.ВерсияФорматаМенеджераОбмена() +``` +
+ +## ЗаполнитьПравилаОбработкиДанных +
+ +Описание, пример вызова + +```bsl +// Заполняет таблицу правил обработки данных. +// +// Параметры: +// НаправлениеОбмена - строка ("Отправка" либо "Получение"). +// ПравилаОбработкиДанных - таблица значений, в которую добавляются правила. +Процедура ЗаполнитьПравилаОбработкиДанных(НаправлениеОбмена, ПравилаОбработкиДанных) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ЗаполнитьПравилаОбработкиДанных(НаправлениеОбмена, ПравилаОбработкиДанных) +``` +
+ +## ПОД_Документ_ВедомостьНаВыплатуЗПВКассу_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Документ_ВедомостьНаВыплатуЗПВКассу_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Документ_ВедомостьНаВыплатуЗПВКассу_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Документ_ВедомостьНаВыплатуЗППеречислением_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Документ_ВедомостьНаВыплатуЗППеречислением_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Документ_ВедомостьНаВыплатуЗППеречислением_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Документ_ВедомостьНаВыплатуЗПРаздатчиком_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Документ_ВедомостьНаВыплатуЗПРаздатчиком_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Документ_ВедомостьНаВыплатуЗПРаздатчиком_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Документ_ДоговорЗаймаСотруднику_Отправка_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Документ_ДоговорЗаймаСотруднику_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Документ_ДоговорЗаймаСотруднику_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ДобавитьПОД_Документ_ПлатежноеПоручение +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьПОД_Документ_ПлатежноеПоручение(ПравилаОбработкиДанных) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ДобавитьПОД_Документ_ПлатежноеПоручение(ПравилаОбработкиДанных)); +``` +
+ +## ПОД_Документ_ПлатежноеПоручение_ПриОбработке +
+ +Описание, пример вызова + +```bsl + + +Процедура ПОД_Документ_ПлатежноеПоручение_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Документ_ПлатежноеПоручение_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Справочник_Банки_Отправка_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Справочник_Банки_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Справочник_Банки_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Справочник_ВидыРаботСотрудников_Отправка_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Справочник_ВидыРаботСотрудников_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Справочник_ВидыРаботСотрудников_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Справочник_ДокументыФизическихЛиц_Отправка_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Справочник_ДокументыФизическихЛиц_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Справочник_ДокументыФизическихЛиц_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Справочник_РегистрацииВНалоговомОргане_Отправка_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Справочник_РегистрацииВНалоговомОргане_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Справочник_РегистрацииВНалоговомОргане_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Справочник_СпособыОтраженияЗарплатыВБухУчете_Отправка_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Справочник_СпособыОтраженияЗарплатыВБухУчете_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Справочник_СпособыОтраженияЗарплатыВБухУчете_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Справочник_ФизическиеЛица_Отправка_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Справочник_ФизическиеЛица_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Справочник_ФизическиеЛица_Отправка_ПриОбработке(ДанныеИБ, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Документ_ДанныеДляРасчетаЗарплаты_Получение_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Документ_ДанныеДляРасчетаЗарплаты_Получение_ПриОбработке(ДанныеXDTO, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Документ_ДанныеДляРасчетаЗарплаты_Получение_ПриОбработке(ДанныеXDTO, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Справочник_Банки_Получение_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Справочник_Банки_Получение_ПриОбработке(ДанныеXDTO, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Справочник_Банки_Получение_ПриОбработке(ДанныеXDTO, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Справочник_ДокументыФизическихЛиц_Получение_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Справочник_ДокументыФизическихЛиц_Получение_ПриОбработке(ДанныеXDTO, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Справочник_ДокументыФизическихЛиц_Получение_ПриОбработке(ДанныеXDTO, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ПОД_Справочник_СпособыОтраженияЗарплатыВБухУчетеГруппа_Получение_ПриОбработке +
+ +Описание, пример вызова + +```bsl + +Процедура ПОД_Справочник_СпособыОтраженияЗарплатыВБухУчетеГруппа_Получение_ПриОбработке(ДанныеXDTO, ИспользованиеПКО, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПОД_Справочник_СпособыОтраженияЗарплатыВБухУчетеГруппа_Получение_ПриОбработке(ДанныеXDTO, ИспользованиеПКО, КомпонентыОбмена)); +``` +
+ +## ЗаполнитьПравилаКонвертацииОбъектов +
+ +Описание, пример вызова + +```bsl +// Заполняет таблицу правил конвертации объектов. +// +// Параметры: +// НаправлениеОбмена - строка ("Отправка" либо "Получение"). +// ПравилаКонвертации - таблица значений, в которую добавляются правила. +Процедура ЗаполнитьПравилаКонвертацииОбъектов(НаправлениеОбмена, ПравилаКонвертации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ЗаполнитьПравилаКонвертацииОбъектов(НаправлениеОбмена, ПравилаКонвертации) +``` +
+ +## ДобавитьПКТЧ +
+ +Описание, пример вызова + +```bsl + +Функция ДобавитьПКТЧ(ПравилоКонвертации, ИмяТЧКонфигурации, ИмяТЧФормата) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОбменаЧерезУниверсальныйФормат13.ДобавитьПКТЧ(ПравилоКонвертации, ИмяТЧКонфигурации, ИмяТЧФормата)); +``` +
+ +## ДобавитьПКС +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьПКС(РодительПКС, СвойствоКонфигурации, СвойствоФормата, ИспользуетсяАлгоритмКонвертации = 0, Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ДобавитьПКС(РодительПКС, СвойствоКонфигурации, СвойствоФормата, ИспользуетсяАлгоритмКонвертации, ); +``` +
+ +## ПКО_Документ_ВедомостьНаВыплатуЗПВКассу_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ВедомостьНаВыплатуЗПВКассу_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ВедомостьНаВыплатуЗПВКассу_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Документ_ВедомостьНаВыплатуЗПВКассу_НДФЛ_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ВедомостьНаВыплатуЗПВКассу_НДФЛ_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ВедомостьНаВыплатуЗПВКассу_НДФЛ_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Документ_ВедомостьНаВыплатуЗППеречислением_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ВедомостьНаВыплатуЗППеречислением_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ВедомостьНаВыплатуЗППеречислением_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Документ_ВедомостьНаВыплатуЗППеречислением_НДФЛ_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ВедомостьНаВыплатуЗППеречислением_НДФЛ_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ВедомостьНаВыплатуЗППеречислением_НДФЛ_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Документ_ВедомостьНаВыплатуЗПРаздатчиком_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ВедомостьНаВыплатуЗПРаздатчиком_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ВедомостьНаВыплатуЗПРаздатчиком_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Документ_ВедомостьНаВыплатуЗПРаздатчиком_НДФЛ_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ВедомостьНаВыплатуЗПРаздатчиком_НДФЛ_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ВедомостьНаВыплатуЗПРаздатчиком_НДФЛ_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Документ_ДоговорЗаймаСотруднику_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ДоговорЗаймаСотруднику_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ДоговорЗаймаСотруднику_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Документ_НачислениеОценочныхОбязательствПоОтпускам_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_НачислениеОценочныхОбязательствПоОтпускам_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_НачислениеОценочныхОбязательствПоОтпускам_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Документ_ОтражениеЗарплатыВБухучете_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ОтражениеЗарплатыВБухучете_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ОтражениеЗарплатыВБухучете_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ДобавитьПКО_Документ_ПлатежноеПоручение +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьПКО_Документ_ПлатежноеПоручение(ПравилаКонвертации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ДобавитьПКО_Документ_ПлатежноеПоручение(ПравилаКонвертации)); +``` +
+ +## ПКО_Документ_ПлатежноеПоручение_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ПлатежноеПоручение_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ПлатежноеПоручение_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ДобавитьПКО_Документ_ПлатежноеПоручение_НДФЛ +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьПКО_Документ_ПлатежноеПоручение_НДФЛ(ПравилаКонвертации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ДобавитьПКО_Документ_ПлатежноеПоручение_НДФЛ(ПравилаКонвертации)); +``` +
+ +## ПКО_Документ_ПлатежноеПоручение_НДФЛ_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ПлатежноеПоручение_НДФЛ_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ПлатежноеПоручение_НДФЛ_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_БанковскиеСчетаКонтрагентов_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_БанковскиеСчетаКонтрагентов_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_БанковскиеСчетаКонтрагентов_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_ДокументыФизическихЛиц_Отправка_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_ДокументыФизическихЛиц_Отправка_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_ДокументыФизическихЛиц_Отправка_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_ЗППроекты_КакБанковскиеСчета_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_ЗППроекты_КакБанковскиеСчета_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_ЗППроекты_КакБанковскиеСчета_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_ЗППроекты_КакКонтрагенты_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_ЗППроекты_КакКонтрагенты_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_ЗППроекты_КакКонтрагенты_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_Контрагенты_ИзСтруктуры_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Контрагенты_ИзСтруктуры_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Контрагенты_ИзСтруктуры_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_Организации_Отправка_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Организации_Отправка_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Организации_Отправка_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_Подразделения_Отправка_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Подразделения_Отправка_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Подразделения_Отправка_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_ФизическиеЛица_Отправка_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_ФизическиеЛица_Отправка_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_ФизическиеЛица_Отправка_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Документ_ДанныеДляРасчетаЗарплаты_Получение_ПриКонвертацииДанныхXDTO +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Документ_ДанныеДляРасчетаЗарплаты_Получение_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Документ_ДанныеДляРасчетаЗарплаты_Получение_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_Организации_Получение_ПриКонвертацииДанныхXDTO +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Организации_Получение_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Организации_Получение_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_Организации_Получение_ПередЗаписьюПолученныхДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Организации_Получение_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Организации_Получение_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_Подразделения_Получение_ПередЗаписьюПолученныхДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Подразделения_Получение_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Подразделения_Получение_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_ФизическиеЛица_Получение_ПриКонвертацииДанныхXDTO +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_ФизическиеЛица_Получение_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_ФизическиеЛица_Получение_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_ФизическиеЛица_Получение_ПередЗаписьюПолученныхДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_ФизическиеЛица_Получение_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_ФизическиеЛица_Получение_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_Валюты_ПриКонвертацииДанныхXDTO +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Валюты_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Валюты_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_Валюты_ПередЗаписьюПолученныхДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Валюты_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Валюты_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_ВидыДокументовФизическихЛиц_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_ВидыДокументовФизическихЛиц_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_ВидыДокументовФизическихЛиц_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_ДополнительныеРеквизиты_ПередЗаписьюПолученныхДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_ДополнительныеРеквизиты_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_ДополнительныеРеквизиты_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_Пользователи_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Пользователи_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Пользователи_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_Пользователи_ПриКонвертацииДанныхXDTO +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Пользователи_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Пользователи_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_Пользователи_ПередЗаписьюПолученныхДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_Пользователи_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_Пользователи_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_РегистрацииВНалоговомОргане_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_РегистрацииВНалоговомОргане_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_РегистрацииВНалоговомОргане_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_РегистрацииВНалоговомОргане_ПриКонвертацииДанныхXDTO +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_РегистрацииВНалоговомОргане_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_РегистрацииВНалоговомОргане_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_РегистрацииВНалоговомОргане_ПередЗаписьюПолученныхДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_РегистрацииВНалоговомОргане_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_РегистрацииВНалоговомОргане_ПередЗаписьюПолученныхДанных(ПолученныеДанные, ДанныеИБ, КонвертацияСвойств, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчете_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчете_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчете_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчете_ПриКонвертацииДанныхXDTO +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчете_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчете_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена)); +``` +
+ +## ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчетеГруппа_ПриОтправкеДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчетеГруппа_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчетеГруппа_ПриОтправкеДанных(ДанныеИБ, ДанныеXDTO, КомпонентыОбмена, СтекВыгрузки)); +``` +
+ +## ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчетеГруппа_ПриКонвертацииДанныхXDTO +
+ +Описание, пример вызова + +```bsl + +Процедура ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчетеГруппа_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ПКО_Справочник_СпособыОтраженияЗарплатыВБухУчетеГруппа_ПриКонвертацииДанныхXDTO(ДанныеXDTO, ПолученныеДанные, КомпонентыОбмена)); +``` +
+ +## ЗаполнитьПравилаКонвертацииПредопределенныхДанных +
+ +Описание, пример вызова + +```bsl +// Заполняет таблицу правил конвертации предопределенных данных. +// +// Параметры: +// НаправлениеОбмена - строка ("Отправка" либо "Получение"). +// ПравилаКонвертации - таблица значений, в которую будут добавлены правила. +Процедура ЗаполнитьПравилаКонвертацииПредопределенныхДанных(НаправлениеОбмена, ПравилаКонвертации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ЗаполнитьПравилаКонвертацииПредопределенныхДанных(НаправлениеОбмена, ПравилаКонвертации) +``` +
+ +## ВерсияФорматаЧислом +
+ +Описание, пример вызова + +```bsl + +Функция ВерсияФорматаЧислом(СтрокаВерсии) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОбменаЧерезУниверсальныйФормат13.ВерсияФорматаЧислом(СтрокаВерсии)); +``` +
+ +## ЗаполнитьПараметрыКонвертации +
+ +Описание, пример вызова + +```bsl +// Заполняет параметры конвертации. +// +// Параметры: +// ПараметрыКонвертации - структура, в которую добавляются параметры конвертации. +Процедура ЗаполнитьПараметрыКонвертации(ПараметрыКонвертации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ЗаполнитьПараметрыКонвертации(ПараметрыКонвертации) +``` +
+ +## ВыполнитьПроцедуруМодуляМенеджера +
+ +Описание, пример вызова + +```bsl +// Процедура-обертка, выполняет запуск указанной в параметрах процедуры модуля менеджера обмена через формат. +// +// Параметры: +// ИмяПроцедуры - строка. +// СтруктураПараметров - структура, содержащая передаваемые параметры. +Процедура ВыполнитьПроцедуруМодуляМенеджера(ИмяПроцедуры, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОбменаЧерезУниверсальныйФормат13.ВыполнитьПроцедуруМодуляМенеджера(ИмяПроцедуры, Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МенеджерОборудованияВызовСервера.md b/src/content/docs/zup/МенеджерОборудованияВызовСервера.md new file mode 100644 index 0000000..9e8a4f5 --- /dev/null +++ b/src/content/docs/zup/МенеджерОборудованияВызовСервера.md @@ -0,0 +1,2038 @@ +--- +title: Менеджер оборудования вызов сервера +slug: zup/менеджер-оборудования-вызов-сервера +--- + + +## ВерсияБиблиотеки +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер версии библиотеки подключаемого оборудования. +// +Функция ВерсияБиблиотеки() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ВерсияБиблиотеки() +``` +
+ +## РевизияИнтерфейсаДрайверов +
+ +Описание, пример вызова + +```bsl + +// Получает ревизию требований для драйверов подключаемого оборудования. +// +Функция РевизияИнтерфейсаДрайверов() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.РевизияИнтерфейсаДрайверов() +``` +
+ +## ПолучитьДатаСеанса +
+ +Описание, пример вызова + +```bsl + +// Получает текущую дату сервера, приведенную к часовому поясу сеанса. +// Предназначена для использования вместо функции ТекущаяДатаСеанса. +// +// Возвращаемое значение: +// Результат - текущая дата сеанса. +// +Функция ПолучитьДатаСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьДатаСеанса() +``` +
+ +## ОборудованиеПоПараметрам +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает список подключенного в справочнике ПО +// +// Параметры: +// ТипыПО - Неопределено - Описание +// Идентификатор - Неопределено - Описание +// РабочееМесто - Неопределено - Описание +// Возвращаемое значение: +// Массив из Структура - Описание: +// * Наименование - Строка - . +Функция ОборудованиеПоПараметрам(ТипыПО = Неопределено, Идентификатор = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ОборудованиеПоПараметрам(ТипыПО, Идентификатор, ); +``` +
+ +## ПолучитьПараметрыУстройства +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает по идентификатору устройства его параметры. +// +Функция ПолучитьПараметрыУстройства(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьПараметрыУстройства(Идентификатор) +``` +
+ +## ПолучитьПараметрыРегистрацииУстройства +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает по идентификатору устройства параметры регистрации. +// +Функция ПолучитьПараметрыРегистрацииУстройства(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьПараметрыРегистрацииУстройства(Идентификатор) +``` +
+ +## СохранитьПараметрыУстройства +
+ +Описание, пример вызова + +```bsl + +// Процедура предназначена для сохранения параметров устройства +// в реквизит Параметры типа хранилище значения в элементе справочника. +// +Функция СохранитьПараметрыУстройства(Идентификатор, Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СохранитьПараметрыУстройства(Идентификатор, Параметры) +``` +
+ +## СохранитьПараметрыРегистрацииУстройства +
+ +Описание, пример вызова + +```bsl + +// Процедура предназначена для сохранения параметров регистрации устройства +// +Функция СохранитьПараметрыРегистрацииУстройства(Идентификатор, ПараметрыРегистрации) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СохранитьПараметрыРегистрацииУстройства(Идентификатор, ПараметрыРегистрации) +``` +
+ +## ПолучитьДанныеУстройства +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает структуру с данными устройства. +// +// Параметры: +// Идентификатор - СправочникСсылка.ПодключаемоеОборудование - экземпляр подключаемого оборудования. +// Возвращаемое значение: +// Структура - Описание: +// *ОбработчикДрайвераИмя - Строка - имя драйвера. +// *ОбработчикДрайвера - Строка - обработчик драйвера. +// *ИмяКомпьютера - Строка - наименование компьютера. +// *РабочееМесто - СправочникСсылка.РабочиеМеста - рабочее место. +// *Параметры - Структура - структура с полями: +// **ДатаНачала - Дата - . +// **ДатаОкончания - Дата - . +// **ПериодВыгрузки - Структура - структура с полями: +// ***ДатаНачала - Дата - дата начала загрузки. +// ***ДатаОкончания - Дата - дата окончания загрузки. +// *ИмяФайлаДрайвера - Строка - имя файла драйвера. +// *ИмяМакетаДрайвера - Строка - имя макета драйвера. +// *ПоставляетсяДистрибутивом - Булево - признак поставки дистрибутивом. +// *ИдентификаторОбъекта - Строка - идентификатор объекта строкой. +// *ВСоставеКонфигурации - Булево - признак поставке в составе конфигурации. +// *ДрайверОборудованияИмя - Строка - драйвер оборудования строкой. +// *ДрайверОборудования - СправочникСсылка.ДрайверОборудования - драйвер оборудования. +// *ТипОборудованияИмя - Строка - тип опоборудования строкой. +// *ТипОборудования - ПеречислениеСсылка.ТипыПодключаемогоОборудования - тип оборудования. +// *Наименование - Строка - наименование оборудования. +// *ИдентификаторУстройства - Строка - идентификатор устройства. +// *Ссылка - СправочникСсылка.ПодключаемоеОборудование - экземпляр подключаемого оборудования. +// +Функция ПолучитьДанныеУстройства(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьДанныеУстройства(Идентификатор) +``` +
+ +## ПолучитьДанныеДрайвера +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает структуру с данными драйвера. +// +// Параметры: +// Идентификатор - СправочникСсылка.ПодключаемоеОборудование - экземпляр подключаемого оборудования. +// Возвращаемое значение: +// Структура - Описание: +// * ВерсияДрайвера +// * ИмяФайлаДрайвера +// * ИмяМакетаДрайвера +// * ПоставляетсяДистрибутивом +// * ОбработчикДрайвера +// * ИдентификаторОбъекта +// * ВСоставеКонфигурации +// * ТипОборудования +// * ДрайверОборудованияИмя +// * ДрайверОборудования +// +Функция ПолучитьДанныеДрайвера(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьДанныеДрайвера(Идентификатор) +``` +
+ +## ПараметрыДрайвераПоОбработчику +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает параметры драйвера по наименованию обработчика. +// +Функция ПараметрыДрайвераПоОбработчику(НаименованиеОбработчикаДрайвера) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПараметрыДрайвераПоОбработчику(НаименованиеОбработчикаДрайвера) +``` +
+ +## ПолучитьРабочееМестоКлиента +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает из переменной сеанса имя компьютера клиента. +// +Функция ПолучитьРабочееМестоКлиента() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьРабочееМестоКлиента() +``` +
+ +## НайтиРабочиеМестаПоИД +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает список рабочих мест, соответствующих указанному имени компьютера. +// +Функция НайтиРабочиеМестаПоИД(ИдентификаторКлиента) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.НайтиРабочиеМестаПоИД(ИдентификаторКлиента) +``` +
+ +## УстановитьРабочееМестоКлиента +
+ +Описание, пример вызова + +```bsl + +// Функция устанавливает в переменную сеанса имя компьютера клиента. +// +Процедура УстановитьРабочееМестоКлиента(РабочееМестоКлиента) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.УстановитьРабочееМестоКлиента(РабочееМестоКлиента) +``` +
+ +## ПолучитьМакетССервера +
+ +Описание, пример вызова + +```bsl + +// Функция получает макет драйвера и сохраняет его во временное хранилище, +// возвращая ссылку на временное хранилище. +Функция ПолучитьМакетССервера(ИмяМакета) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьМакетССервера(ИмяМакета) +``` +
+ +## ПредопределенныйЭлемент +
+ +Описание, пример вызова + +```bsl + +// Получает ссылку предопределенного элемента по его полному имени. +// +// Параметры: +// ПолноеИмяПредопределенного - Строка - имя предопределенного элемента. +// Возвращаемое значение: +// СправочникСсылка.ПодключаемоеОборудование - Описание. +// +Функция ПредопределенныйЭлемент(Знач ПолноеИмяПредопределенного) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПредопределенныйЭлемент(ПолноеИмяПредопределенного) +``` +
+ +## ПравоДоступаСохранениеДанныхПользователя +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает доступность сохранение данных пользователя. +// +Функция ПравоДоступаСохранениеДанныхПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПравоДоступаСохранениеДанныхПользователя() +``` +
+ +## ПолучитьИмяТипаОборудования +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает имя перечисления из его метаданных. +// +Функция ПолучитьИмяТипаОборудования(ТипОборудования) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьИмяТипаОборудования(ТипОборудования) +``` +
+ +## ПолучитьТипОборудования +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает перечисление по имени. +// +Функция ПолучитьТипОборудования(ТипОборудованияИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьТипОборудования(ТипОборудованияИмя) +``` +
+ +## ПолучитьТипПодключаемогоОборудования +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает Тип подключаемого оборудования по ссылке. +// +Функция ПолучитьТипПодключаемогоОборудования(ПодключаемоеОборудование) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьТипПодключаемогоОборудования(ПодключаемоеОборудование) +``` +
+ +## СоздатьРабочееМестоКлиента +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает созданное рабочее место клиента. +// +Функция СоздатьРабочееМестоКлиента(Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СоздатьРабочееМестоКлиента(Параметры) +``` +
+ +## УстановитьПараметрыСеансаПодключаемогоОборудования +
+ +Описание, пример вызова + +```bsl + +// Процедура устанавливает значения параметров сеанса, относящихся к подключаемому оборудованию. +// +Процедура УстановитьПараметрыСеансаПодключаемогоОборудования(ИмяПараметра, УстановленныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.УстановитьПараметрыСеансаПодключаемогоОборудования(ИмяПараметра, УстановленныеПараметры) +``` +
+ +## ДрайвераДляПереустановки +
+ +Описание, пример вызова + +```bsl + +// Возвращает список оборудования для которого необходима переустановка компоненты. +// +// Параметр: +// РабочееМесто - СправочникСсылка.РабочиеМеста +// +// Возвращаемое значение +// Массив +// +Функция ДрайвераДляПереустановки(РабочееМесто) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ДрайвераДляПереустановки(РабочееМесто) +``` +
+ +## ДрайвераДляУстановки +
+ +Описание, пример вызова + +```bsl + +// Возвращает список оборудования для которого необходима установка компоненты. +// +// Параметр: +// РабочееМесто - СправочникСсылка.РабочиеМеста +// +// Возвращаемое значение +// Массив +// +Функция ДрайвераДляУстановки(РабочееМесто) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ДрайвераДляУстановки(РабочееМесто) +``` +
+ +## ЗаписатьДанные +
+ +Описание, пример вызова + +```bsl + +// Записывает изменения в переданном объекте. +// Для использования в обработчиках обновления. +// +// Параметры: +// Данные - Произвольный - объект, набор записей или менеджер константы, который +// необходимо записать. +// РегистрироватьНаУзлахПлановОбмена - Булево - включает регистрацию на узлах планов обмена при записи объекта. +// ВключитьБизнесЛогику - Булево - включает бизнес-логику при записи объекта. +// +Процедура ЗаписатьДанные(Знач Данные, Знач РегистрироватьНаУзлахПлановОбмена = Ложь, Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаписатьДанные(Данные, РегистрироватьНаУзлахПлановОбмена, ); +``` +
+ +## УстановитьПризнакПереустановкиДрайвера +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак необходимости переустановки оборудования для подключаемого оборудования на рабочем месте. +// +Процедура УстановитьПризнакПереустановкиДрайвера(РабочееМесто, ДрайверОборудования, Признак) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.УстановитьПризнакПереустановкиДрайвера(РабочееМесто, ДрайверОборудования, Признак) +``` +
+ +## УстановитьПризнакПереустановкиДрайвераДляОборудования +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак необходимости переустановки оборудования для подключаемого оборудования. +// +Процедура УстановитьПризнакПереустановкиДрайвераДляОборудования(ПодключаемоеОборудование, Признак) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.УстановитьПризнакПереустановкиДрайвераДляОборудования(ПодключаемоеОборудование, Признак) +``` +
+ +## ОбновитьУстановленныеДрайвера +
+ +Описание, пример вызова + +```bsl + +// Обновить установленные драйвера по справочнику подключаемого оборудования. +// +Процедура ОбновитьУстановленныеДрайвера(ТипОборудования) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ОбновитьУстановленныеДрайвера(ТипОборудования) +``` +
+ +## УстановитьПризнакУстановкиДрайвера +
+ +Описание, пример вызова + +```bsl + +// Устанавливает признак необходимости установки оборудования для подключаемого оборудования на рабочем месте. +// +Процедура УстановитьПризнакУстановкиДрайвера(РабочееМесто, ДрайверОборудования, Признак) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.УстановитьПризнакУстановкиДрайвера(РабочееМесто, ДрайверОборудования, Признак) +``` +
+ +## СохранитьПользовательскиеНастройкиПодключаемогоОборудования +
+ +Описание, пример вызова + +```bsl + +// Сохраняет пользовательские настройки подключаемого оборудования. +// +Процедура СохранитьПользовательскиеНастройкиПодключаемогоОборудования(СписокНастроек) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.СохранитьПользовательскиеНастройкиПодключаемогоОборудования(СписокНастроек) +``` +
+ +## ТипыИспользуемогоОборудованияТекущегоРабочегоМеста +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает типы используемого оборудования для текущего рабочего места. +// +Функция ТипыИспользуемогоОборудованияТекущегоРабочегоМеста() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ТипыИспользуемогоОборудованияТекущегоРабочегоМеста() +``` +
+ +## РасшифроватьКодМагнитнойКарты +
+ +Описание, пример вызова + +```bsl + +// Производит разложение данных дорожек магнитной карты по шаблонам. +// На входе: +// ДанныеДорожек - массив строк. Значения полученные из дорожек. +// ПараметрыДорожек - массив структур содержащих параметры настройки устройства. +// * Использовать, булево - признак использования дорожки. +// * НомерДорожки, число - порядковый номер дорожки 1-3. +// +// На выходе: +// Массив структур содержащих расшифрованные данные по всем подходящим шаблонам со ссылкой на них. +// * Массив - шаблоны +// * Структура - данные шаблона. +// - Шаблон, СправочникСсылка.ШаблоныМагнитныхКарт +// - ДанныеДорожек, массив полей всех дорожек. +// * Структура - данные поля. +// - Поле +// - ЗначениеПоля +Функция РасшифроватьКодМагнитнойКарты(ДанныеДорожек, ПараметрыДорожек) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.РасшифроватьКодМагнитнойКарты(ДанныеДорожек, ПараметрыДорожек) +``` +
+ +## ПолучитьОписаниеДрайвера +
+ +Описание, пример вызова + +```bsl + +// Получить описание драйвера XML пакета. +// +Функция ПолучитьОписаниеДрайвера(Данные) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьОписаниеДрайвера(Данные) +``` +
+ +## ТоварыТСД +
+ +Описание, пример вызова + +```bsl + +// Получить таблицу товаров из XML структуры для ТСД. +// +// Возвращаемое значение +// Массив +// +Функция ТоварыТСД(ДанныеЗагрузки, АлкогольнаяПродукция) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ТоварыТСД(ДанныеЗагрузки, АлкогольнаяПродукция) +``` +
+ +## СформироватьТаблицуТоваровТСД +
+ +Описание, пример вызова + +```bsl + +// Сформировать таблицу товаров в XML структуре для ТСД. +// +Функция СформироватьТаблицуТоваровТСД(ДанныеЗагрузки, ПолнаяВыгрузка, РевизияИнтерфейса = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СформироватьТаблицуТоваровТСД(ДанныеЗагрузки, ПолнаяВыгрузка, РевизияИнтерфейса); +``` +
+ +## ПодготовитьПакетыДляЗагрузкиТСД +
+ +Описание, пример вызова + +```bsl + +// Сформировать XML пакеты товаров для загрузки ТСД. +// +Функция ПодготовитьПакетыДляЗагрузкиТСД(ТаблицаВыгрузки, РазмерПакета, ПолнаяВыгрузка) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПодготовитьПакетыДляЗагрузкиТСД(ТаблицаВыгрузки, РазмерПакета, ПолнаяВыгрузка) +``` +
+ +## СформироватьТаблицуТоваровВесыСПечатьюЭтикеток +
+ +Описание, пример вызова + +```bsl + +// Сформировать таблицу товаров в XML структуре для весов с печатью этикеток. +// +Функция СформироватьТаблицуТоваровВесыСПечатьюЭтикеток(ДанныеЗагрузки) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СформироватьТаблицуТоваровВесыСПечатьюЭтикеток(ДанныеЗагрузки) +``` +
+ +## ПодготовитьПакетыДляЗагрузкиВВесыСПечатьюЭтикеток +
+ +Описание, пример вызова + +```bsl + +// Сформировать XML пакеты товаров для загрузки ТСД. +// +Функция ПодготовитьПакетыДляЗагрузкиВВесыСПечатьюЭтикеток(ТаблицаВыгрузки, РазмерПакета) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПодготовитьПакетыДляЗагрузкиВВесыСПечатьюЭтикеток(ТаблицаВыгрузки, РазмерПакета) +``` +
+ +## МеткиRFID +
+ +Описание, пример вызова + +```bsl + +// Получить таблицу меток RFID. +// +// Возвращаемое значение +// Массив +// +Функция МеткиRFID(ДанныеМеток) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.МеткиRFID(ДанныеМеток) +``` +
+ +## ПрочитатьАтрибут +
+ +Описание, пример вызова + +```bsl + +// Функция получает значение атрибута текущего элемента. +// +Функция ПрочитатьАтрибут(ЧтениеXML, ИмяАтрибута, ЗначениеАтрибута) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПрочитатьАтрибут(ЧтениеXML, ИмяАтрибута, ЗначениеАтрибута)); +``` +
+ +## ПрочитатьЭлементXML +
+ +Описание, пример вызова + +```bsl + +Функция ПрочитатьЭлементXML(ЧтениеXML, ТекстСообщенияОбОшибке) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПрочитатьЭлементXML(ЧтениеXML, ТекстСообщенияОбОшибке)); +``` +
+ +## ЗаписатьАтрибутЭлемента +
+ +Описание, пример вызова + +```bsl + +// Процедура записывает значение атрибута текущего элемента. +// +Процедура ЗаписатьАтрибутЭлемента(ЗаписьXML, ИмяАтрибута, ЗначениеАтрибута, ФорматнаяСтрока="ЧРД=.; ЧН=0; ЧГ=0; БЛ=false; БИ=true") Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаписатьАтрибутЭлемента(ЗаписьXML, ИмяАтрибута, ЗначениеАтрибута, ФорматнаяСтрока); +``` +
+ +## ПолучитьОписаниеМакета +
+ +Описание, пример вызова + +```bsl + +// Функция формирует структуру с описанием макета. +// +// Параметры: +// Источник - Строка - источник события. +// СообщениеОбОшибке - Строка - сообщение пользователю об ошибке +// Результат - см. СоздатьОписаниеМакета +// Возвращаемое значение: +// Булево - результат выполнения операции. +// +Функция ПолучитьОписаниеМакета(Источник, СообщениеОбОшибке, Результат) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьОписаниеМакета(Источник, СообщениеОбОшибке, Результат) +``` +
+ +## СоздатьОписаниеМакета +
+ +Описание, пример вызова + +```bsl + +// Создает описание макета. +// +// Возвращаемое значение: +// Структура - структура с полями: +// * Поля - Массив - массив полей. +// * Ширина - Число - ширина макета. +// * Высота - Число - высота макета. +// * Ориентация - Число - ориентация макета. +// * Масштаб - Число - масштаб. +Функция СоздатьОписаниеМакета() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СоздатьОписаниеМакета() +``` +
+ +## СформироватьДанныеДляПринтераЭтикеток +
+ +Описание, пример вызова + +```bsl + +// Функция формирует текст XML для передачи его принтеру этикеток. +// +Функция СформироватьДанныеДляПринтераЭтикеток(МассивЭтикеток, МакетЭтикетки) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СформироватьДанныеДляПринтераЭтикеток(МассивЭтикеток, МакетЭтикетки) +``` +
+ +## ПодготовитьПакетыДляПринтераЭтикеток +
+ +Описание, пример вызова + +```bsl + +// Сформировать XML пакеты товаров для загрузки ТСД. +// +Функция ПодготовитьПакетыДляПринтераЭтикеток(МассивЭтикеток, РазмерПакета, МакетЭтикетки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПодготовитьПакетыДляПринтераЭтикеток(МассивЭтикеток, РазмерПакета, МакетЭтикетки); +``` +
+ +## СохранитьXMLФайл +
+ +Описание, пример вызова + +```bsl + +// Функция формирует XML-описание макета. +// +Функция СохранитьXMLФайл(ШиринаЭтикетки, ВысотаЭтикетки, Ориентация, Поля) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СохранитьXMLФайл(ШиринаЭтикетки, ВысотаЭтикетки, Ориентация, Поля) +``` +
+ +## ОпределитьТипШтрихкода +
+ +Описание, пример вызова + +```bsl + +// Функция определяет тип штрихкода по значение кода. +// +Функция ОпределитьТипШтрихкода(Штрихкод) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ОпределитьТипШтрихкода(Штрихкод) +``` +
+ +## ПолучитьКодировкуФайла +
+ +Описание, пример вызова + +```bsl + +// Функция получения кодировки файла. +// Параметры: +// Кодировка - КодировкаТекста - кодировка при чтении текстового файла, по умолчанию КодировкаТекста.UTF8. +// +// Возвращаемое значение: +// Кодировка - КодировкаТекста. +Функция ПолучитьКодировкуФайла(Кодировка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьКодировкуФайла(Кодировка); +``` +
+ +## ПолучитьСодержаниеТекстовыхФайлов +
+ +Описание, пример вызова + +```bsl + +// Процедура получения содержания текстовых файлов. +// Параметры: +// ПомещаемыеФайлы - Массив Из Файл- имя файла или массив с именами файлов. +// Кодировка - КодировкаТекста - кодировка при чтении текстового файла, по умолчанию КодировкаТекста.UTF8. +// +Функция ПолучитьСодержаниеТекстовыхФайлов(ПомещаемыеФайлы, Кодировка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьСодержаниеТекстовыхФайлов(ПомещаемыеФайлы, Кодировка); +``` +
+ +## ПолучитьСодержаниеТекстовыхФайловИзХранилища +
+ +Описание, пример вызова + +```bsl + +// Функция получает содержание текстовых файлов из временного хранилища. +// Параметры: +// ПомещенныеФайлы - массив содержащий элементы типа ОписаниеПередаваемогоФайла, из которых читается содержание. +// Возвращаемое значение: +// РезультатЧтения - структура с ключами: +// - Успешно - булево. +// - СодержаниеФайлов - массив структур, с ключами ОписаниеПереданногоФайла и ТекстСодержания. +// или Неопределено, в случае Успешно = Ложь. +// - ТекстОшибки - строка. +// +Функция ПолучитьСодержаниеТекстовыхФайловИзХранилища(ПомещенныеФайлы, Кодировка) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьСодержаниеТекстовыхФайловИзХранилища(ПомещенныеФайлы, Кодировка) +``` +
+ +## ПроверитьДублированиеКодов +
+ +Описание, пример вызова + +```bsl + +// Функция выполняет проверку дублирования кодов в массивах групп товаров и товаров подготавливаемых для ККМ-Offline. +// Параметры: +// РасширеннаяВыгрузка - булево, признак расширенной выгрузки. +// ГруппыТоваров - массив, список групп товаров. +// Товары - массив, список товаров. +// Коды - строка, строка в которую через ", " будут перечислены дублирующиеся коды. +// Возвращаемое значение: +// Булево - если есть дублирование, возвращает Истина, иначе Ложь. +// +Функция ПроверитьДублированиеКодов(РасширеннаяВыгрузка, ГруппыТоваров, Товары, Коды) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПроверитьДублированиеКодов(РасширеннаяВыгрузка, ГруппыТоваров, Товары, Коды) +``` +
+ +## ЗаписатьФискальнуюОперацию +
+ +Описание, пример вызова + +```bsl + +// Записать операцию в журнал фискальных операций. +// +Процедура ЗаписатьФискальнуюОперацию(ПараметрыФискализации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаписатьФискальнуюОперацию(ПараметрыФискализации) +``` +
+ +## ДанныеФискальнойОперации +
+ +Описание, пример вызова + +```bsl + +// Получить данные журнала фискальных операций. +// +// Параметры: +// ДокументСсылка - ДокументСсылка - Документ-основание. +// +// Возвращаемое значение: +// Структура - Структура по свойствами: +// * НомерСменыККМ - Число - Номер чека ККМ. +// * Сумма - Число - Сумма. +// * ДокументОснование - ДокументСсылка - Документ-основание. +// * ДанныеXML - ХранилищеЗначений - Данные чека, переданные в ККТ (XML). +// +Функция ДанныеФискальнойОперации(ДокументСсылка, ИдентификаторЗаписи = Неопределено, ТипыДокументов = Неопределено, ТипРасчета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ДанныеФискальнойОперации(ДокументСсылка, ИдентификаторЗаписи, ТипыДокументов, ТипРасчета); +``` +
+ +## ФискальнаяОперацииПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Получить данные журнала фискальных операций. +// +// Параметры: +// ИдентификаторЗаписи - Идентификатор записи. +// +Функция ФискальнаяОперацииПоИдентификатору(ИдентификаторЗаписи) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ФискальнаяОперацииПоИдентификатору(ИдентификаторЗаписи) +``` +
+ +## СписокФискальныхОпераций +
+ +Описание, пример вызова + +```bsl + +// Получить список журнала фискальных операций. +// +// Параметры: +// ДокументСсылка - ДокументСсылка - Документ-основание. +// +// Возвращаемое значение: +// Структура - Структура по свойствами: +// * НомерСменыККМ - Число - Номер чека ККМ. +// * Сумма - Число - Сумма. +// * ДокументОснование - ДокументСсылка - Документ-основание. +// * ДанныеXML - ХранилищеЗначений - Данные чека, переданные в ККТ (XML). +// +Функция СписокФискальныхОпераций(ДокументСсылка, ТипыДокументов = Неопределено, ТипРасчета = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СписокФискальныхОпераций(ДокументСсылка, ТипыДокументов, ТипРасчета); +``` +
+ +## ДобавитьЧекВОчередьЧековККТ +
+ +Описание, пример вызова + +```bsl + +// Добавить чек в очередь чеков ККТ. +// +// Параметры: +// ПараметрыЧекаККТ - Структура - Параметры чека ККТ: +// * ПозицииЧека - Массив из См. МенеджерОборудованияКлиентСервер.ПараметрыФискальнойСтрокиЧека - . +// +Функция ДобавитьЧекВОчередьЧековККТ(ПараметрыЧекаККТ) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ДобавитьЧекВОчередьЧековККТ(ПараметрыЧекаККТ) +``` +
+ +## ДанныеЧекаВОчереди +
+ +Описание, пример вызова + +```bsl + +// Данные чека из очереди. +// +// Параметры: +// ИдентификаторЗаписи - Идентификатор записи. +// +Функция ДанныеЧекаВОчереди(ИдентификаторЗаписи) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ДанныеЧекаВОчереди(ИдентификаторЗаписи) +``` +
+ +## ЧекиВОчередиНаФискализацию +
+ +Описание, пример вызова + +```bsl + +// Чеки в очереди на фискализацию. +// +Функция ЧекиВОчередиНаФискализацию() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ЧекиВОчередиНаФискализацию() +``` +
+ +## УдалитьЧекИзОчереди +
+ +Описание, пример вызова + +```bsl + +// Удалить чек из очереди. +// +// Параметры: +// ДокументСсылка - ДокументСсылка - Документ-основание. +// +Процедура УдалитьЧекИзОчереди(ДокументСсылка) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.УдалитьЧекИзОчереди(ДокументСсылка) +``` +
+ +## ОчиститьОчередьЧеков +
+ +Описание, пример вызова + +```bsl + +// Очистить очередь чеков. +// +Процедура ОчиститьОчередьЧеков() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ОчиститьОчередьЧеков() +``` +
+ +## ЗаписатьСтатусЧекаВОчереди +
+ +Описание, пример вызова + +```bsl + +// Записать статус чека в очереди. +// +Процедура ЗаписатьСтатусЧекаВОчереди(ПараметрыФискализации, СтатусЧека, ОборудованиеККТ = Неопределено, ТекстОшибки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаписатьСтатусЧекаВОчереди(ПараметрыФискализации, СтатусЧека, ОборудованиеККТ, ТекстОшибки); +``` +
+ +## ПолучитьСтатусЧекаВОчереди +
+ +Описание, пример вызова + +```bsl + +// Данные чека из очереди. +// +// Параметры: +// ИдентификаторЗаписи - Идентификатор записи. +// +Функция ПолучитьСтатусЧекаВОчереди(ИдентификаторЗаписи) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьСтатусЧекаВОчереди(ИдентификаторЗаписи) +``` +
+ +## ПолучитьФискальнуюОперацию +
+ +Описание, пример вызова + +```bsl + +// Данные чека из очереди по фискальный признаку и номеру чеку ККМ. +// +// Параметры: +// ФискальныйПризнак - Фискальный признак +// НомерЧекаККМ - Номер чека ККМ +// +Функция ПолучитьФискальнуюОперацию(ФискальныйПризнак, НомерЧекаККМ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьФискальнуюОперацию(ФискальныйПризнак, НомерЧекаККМ); +``` +
+ +## ОбсуждениеФискализации +
+ +Описание, пример вызова + +```bsl + +Функция ОбсуждениеФискализации() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ОбсуждениеФискализации() +``` +
+ +## СоздатьСообщениеФискализации +
+ +Описание, пример вызова + +```bsl + +Процедура СоздатьСообщениеФискализации(ИдентификаторЧека, ОрганизацияИИН = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.СоздатьСообщениеФискализации(ИдентификаторЧека, ОрганизацияИИН); +``` +
+ +## СформироватьТаблицуПараметровДляОперацииФН +
+ +Описание, пример вызова + +```bsl + +// Сформировать таблицу параметров в XML для операции с ФН. +// +Функция СформироватьТаблицуПараметровДляОперацииФН(СтруктураПараметров, РевизияИнтерфейса = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СформироватьТаблицуПараметровДляОперацииФН(СтруктураПараметров, РевизияИнтерфейса); +``` +
+ +## ПараметрыИзXMLПакетаККТ +
+ +Описание, пример вызова + +```bsl + +// Получить таблицу параметров из ККТ. +// +// Возвращаемое значение +// Структура +// +Функция ПараметрыИзXMLПакетаККТ(Данные, ИдентификаторУстройства = Неопределено, РевизияИнтерфейса = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПараметрыИзXMLПакетаККТ(Данные, ИдентификаторУстройства, РевизияИнтерфейса); +``` +
+ +## ЗаписатьДанныеКоррекции +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаписатьДанныеКоррекции(ЗаписьXML, ДанныеКоррекции) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаписатьДанныеКоррекции(ЗаписьXML, ДанныеКоррекции)); +``` +
+ +## ЗаписатьДанныеАгента +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаписатьДанныеАгента(ЗаписьXML, ДанныеАгента, РевизияИнтерфейса = 0) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаписатьДанныеАгента(ЗаписьXML, ДанныеАгента, РевизияИнтерфейса); +``` +
+ +## ЗаписатьДанныеПоставщика +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаписатьДанныеПоставщика(ЗаписьXML, ДанныеПоставщика, РевизияИнтерфейса = 0) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаписатьДанныеПоставщика(ЗаписьXML, ДанныеПоставщика, РевизияИнтерфейса); +``` +
+ +## ЗаписатьДанныеКодаТоварнойНоменклатуры +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаписатьДанныеКодаТоварнойНоменклатуры(ЗаписьXML, Позиция, ПараметрыФискализации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаписатьДанныеКодаТоварнойНоменклатуры(ЗаписьXML, Позиция, ПараметрыФискализации)); +``` +
+ +## ЗаписатьДополнительныйРеквизитПользователя +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаписатьДополнительныйРеквизитПользователя(ЗаписьXML, ДополнительныйРеквизитПользователя); Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаписатьДополнительныйРеквизитПользователя(ЗаписьXML, ДополнительныйРеквизитПользователя);); +``` +
+ +## СформироватьXMLПакетДляФискализацияЧека +
+ +Описание, пример вызова + +```bsl + +// Процедура формирует XML пакет для Фискализация чека. +// Параметры: +// РасширеннаяВыгрузка - булево, признак расширенной выгрузки. +// Возвращаемое значение: +// Строка - если есть дублирование, возвращает Истина, иначе Ложь. +// +Процедура СформироватьXMLПакетДляФискализацияЧека(ОбщиеПараметры, ПараметрыФискализации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.СформироватьXMLПакетДляФискализацияЧека(ОбщиеПараметры, ПараметрыФискализации) +``` +
+ +## СформироватьXMLПакетДляЧекаКоррекции +
+ +Описание, пример вызова + +```bsl + +Процедура СформироватьXMLПакетДляЧекаКоррекции(ОбщиеПараметры, ПараметрыФискализации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.СформироватьXMLПакетДляЧекаКоррекции(ОбщиеПараметры, ПараметрыФискализации) +``` +
+ +## ПолучитьXMLПакетДляТекста +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьXMLПакетДляТекста(СтрокаТекста, РевизияИнтерфейса = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьXMLПакетДляТекста(СтрокаТекста, РевизияИнтерфейса); +``` +
+ +## ПолучитьXMLПакетДляТекстовогоДокумента +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьXMLПакетДляТекстовогоДокумента(НефискальныеДокументы, ВыходныеПараметры, ШиринаСтроки = 32, РевизияИнтерфейса = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьXMLПакетДляТекстовогоДокумента(НефискальныеДокументы, ВыходныеПараметры, ШиринаСтроки, РевизияИнтерфейса); +``` +
+ +## ПолучитьXMLПакетДляОперации +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьXMLПакетДляОперации(ОбщиеПараметры, РевизияИнтерфейса = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьXMLПакетДляОперации(ОбщиеПараметры, РевизияИнтерфейса); +``` +
+ +## ПолучитьПараметрыСостоянияИзXMLПакета +
+ +Описание, пример вызова + +```bsl + +// Получить параметры состояния из XML пакета. +// +Функция ПолучитьПараметрыСостоянияИзXMLПакета(Данные, НомерСмены = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьПараметрыСостоянияИзXMLПакета(Данные, НомерСмены); +``` +
+ +## ПолучитьПараметрыСменыИзXMLПакета +
+ +Описание, пример вызова + +```bsl + +// Получить таблицу параметров смены из ККТ. +// +Функция ПолучитьПараметрыСменыИзXMLПакета(ДанныеXML, РевизияИнтерфейса = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьПараметрыСменыИзXMLПакета(ДанныеXML, РевизияИнтерфейса); +``` +
+ +## ЗаполнитьРезультатыФискализацияЧекаИзXMLПакета +
+ +Описание, пример вызова + +```bsl + +// Заполнить результаты фискализация чека из XML пакета. +// +Процедура ЗаполнитьРезультатыФискализацияЧекаИзXMLПакета(ПараметрыФискализации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаполнитьРезультатыФискализацияЧекаИзXMLПакета(ПараметрыФискализации) +``` +
+ +## СформироватьШаблонЧека +
+ +Описание, пример вызова + +```bsl + +// Функция формирует шаблон чека. +// +Функция СформироватьШаблонЧека(ОбщиеПараметры, ДополнительныйТекст = Неопределено, ИдентификаторУстройства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.СформироватьШаблонЧека(ОбщиеПараметры, ДополнительныйТекст, ИдентификаторУстройства); +``` +
+ +## ШаблонАтрибутовЧекаДляОтсылки +
+ +Описание, пример вызова + +```bsl + +// Получить шаблон атрибутов чека для отсылки. +// +Функция ШаблонАтрибутовЧекаДляОтсылки(ПараметрыФискализации) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ШаблонАтрибутовЧекаДляОтсылки(ПараметрыФискализации) +``` +
+ +## ПодготовитьДанныеФискализацииЧека +
+ +Описание, пример вызова + +```bsl + +Функция ПодготовитьДанныеФискализацииЧека(ОбщиеПараметры, ПараметрыПодключения) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПодготовитьДанныеФискализацииЧека(ОбщиеПараметры, ПараметрыПодключения) +``` +
+ +## ПодготовитьЧекКоррекции +
+ +Описание, пример вызова + +```bsl + +Процедура ПодготовитьЧекКоррекции(ОбщиеПараметры, ОбщиеПараметрыСторно, ФФДККТ11) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ПодготовитьЧекКоррекции(ОбщиеПараметры, ОбщиеПараметрыСторно, ФФДККТ11)); +``` +
+ +## ПодготовитьДанныеЧекаКоррекции +
+ +Описание, пример вызова + +```bsl + +Функция ПодготовитьДанныеЧекаКоррекции(ОбщиеПараметры, ПараметрыПодключения) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПодготовитьДанныеЧекаКоррекции(ОбщиеПараметры, ПараметрыПодключения) +``` +
+ +## ПодготовитьДанныеИнкасации +
+ +Описание, пример вызова + +```bsl + +Функция ПодготовитьДанныеИнкасации(ОбщиеПараметры, ПараметрыПодключения) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПодготовитьДанныеИнкасации(ОбщиеПараметры, ПараметрыПодключения) +``` +
+ +## ОбработатьДанныеФискализацииЧекаКоррекции +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработатьДанныеФискализацииЧекаКоррекции(ПараметрыФискализации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ОбработатьДанныеФискализацииЧекаКоррекции(ПараметрыФискализации) +``` +
+ +## ОбработатьДанныеФискализацииЧека +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработатьДанныеФискализацииЧека(ПараметрыФискализации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ОбработатьДанныеФискализацииЧека(ПараметрыФискализации) +``` +
+ +## ОбработатьДанныеИнкасации +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработатьДанныеИнкасации(ПараметрыФискализации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ОбработатьДанныеИнкасации(ПараметрыФискализации) +``` +
+ +## ЗначениеXMLАтрибута +
+ +Описание, пример вызова + +```bsl + +Функция ЗначениеXMLАтрибута(ЧтениеXML, ИмяАтрибута, ДопИмяАтрибута = Неопределено, ЗначениеПоУмолчанию = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ЗначениеXMLАтрибута(ЧтениеXML, ИмяАтрибута, ДопИмяАтрибута, ЗначениеПоУмолчанию); +``` +
+ +## ЗагрузитьДанныеФискализацииИзXML +
+ +Описание, пример вызова + +```bsl + +// Получить структуру чека из XML. +// +Функция ЗагрузитьДанныеФискализацииИзXML(ДанныеXML) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ЗагрузитьДанныеФискализацииИзXML(ДанныеXML) +``` +
+ +## ПодсистемаСуществует +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если "функциональная" подсистема существует в конфигурации. +// Предназначена для реализации вызова необязательной подсистемы (условного вызова). +// +// У "функциональной" подсистемы снят флажок "Включать в командный интерфейс". +// +// Параметры: +// ПолноеИмяПодсистемы - Строка - полное имя объекта метаданных подсистема +// без слов "Подсистема." ИС учетом регистра символов. +// Например: "СтандартныеПодсистемы.ВариантыОтчетов". +// +// Пример: +// +// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ВариантыОтчетов") Тогда +// МодульВариантыОтчетов = ОбщегоНазначения.ОбщийМодуль("ВариантыОтчетов"); +// МодульВариантыОтчетов.<Имя метода>(); +// КонецЕсли; +// +// Возвращаемое значение: +// Булево. +// +Функция ПодсистемаСуществует(ПолноеИмяПодсистемы) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПодсистемаСуществует(ПолноеИмяПодсистемы) +``` +
+ +## ИспользуетсяПодсистемыФискальныхУстройств +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если используется подсистемы фискальных устройств и эти подсистемы существует в конфигурации. +// Предназначена для реализации вызова необязательной подсистемы (условного вызова). +// +// У хотя бы одной "функциональной" подсистемы включен флажок "Включать в командный интерфейс". +// +// Возвращаемое значение: +// Булево. +// +Функция ИспользуетсяПодсистемыФискальныхУстройств() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ИспользуетсяПодсистемыФискальныхУстройств() +``` +
+ +## ИспользуетсяПодсистемаОфлайнОборудования +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если используется подсистема Офлайн оборудование и эта подсистемы существует в конфигурации. +// Предназначена для реализации вызова необязательной подсистемы (условного вызова). +// +// Возвращаемое значение: +// Булево. +// +Функция ИспользуетсяПодсистемаОфлайнОборудования() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ИспользуетсяПодсистемаОфлайнОборудования() +``` +
+ +## ВыполненаПроверкаОбязательностиИПравильностиЗаполненияТэгов +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку обязательности заполняет тэгов. +// +// Параметры: +// Параметры - Параметры фискального чека. +// ИдентификаторУстройства - Идентификатор устройства ККТ. +// ОписаниеОшибки - Описание ошибки. +// +// Возвращаемое значение: +// Результат операции +// +Функция ВыполненаПроверкаОбязательностиИПравильностиЗаполненияТэгов(Параметры, ИдентификаторУстройства, ОписаниеОшибки) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ВыполненаПроверкаОбязательностиИПравильностиЗаполненияТэгов(Параметры, ИдентификаторУстройства, ОписаниеОшибки) +``` +
+ +## ПривестиДанныеКТребуемомуФормату +
+ +Описание, пример вызова + +```bsl + +// Процедура приводит к формату согласованному с ФНС. +// +// Параметры: +// ОсновныеПараметры - Параметры фискального чека. +// Отказ - Отказ при выполнении операции. +// ОписаниеОшибки - Описание ошибки. +// ИсправленыОсновныеПараметры - Были исправлены основные параметры +// +Процедура ПривестиДанныеКТребуемомуФормату(ОсновныеПараметры, Отказ, ОписаниеОшибки, ИсправленыОсновныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ПривестиДанныеКТребуемомуФормату(ОсновныеПараметры, Отказ, ОписаниеОшибки, ИсправленыОсновныеПараметры) +``` +
+ +## ЗаполнитьСведенияОПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьСведенияОПерсональныхДанных. +Процедура ЗаполнитьСведенияОПерсональныхДанных(ТаблицаСведений) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаполнитьСведенияОПерсональныхДанных(ТаблицаСведений) +``` +
+ +## ЗаполнитьОбластиПерсональныхДанных +
+ +Описание, пример вызова + +```bsl + +// См. ЗащитаПерсональныхДанныхПереопределяемый.ЗаполнитьОбластиПерсональныхДанных. +Процедура ЗаполнитьОбластиПерсональныхДанных(ОбластиПерсональныхДанных) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ЗаполнитьОбластиПерсональныхДанных(ОбластиПерсональныхДанных) +``` +
+ +## ПодготовитьЭлементУправления +
+ +Описание, пример вызова + +```bsl + +Процедура ПодготовитьЭлементУправления(ЭлементУправления) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервера.ПодготовитьЭлементУправления(ЭлементУправления) +``` +
+ +## ПолучитьКартинкуШтрихкода +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ГенерацияШтрихкодаВызовСервера.ИзображениеШтрихкода() +// Формирование изображения штрихкода. +// +// Параметры: +// ПараметрыШтрихкода - Структура (Конструктор ГенерацияШтрихкодаКлиентСервер.ПараметрыГенерацииШтрихкода()) +// +// Возвращаемое значение: +// Картинка - Картинка со сформированным штрихкодом или НЕОПРЕДЕЛЕНО. +// +Функция ПолучитьКартинкуШтрихкода(ПараметрыШтрихкода) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.ПолучитьКартинкуШтрихкода(ПараметрыШтрихкода) +``` +
+ +## КодыВидаНоменклатурнойКлассификации +
+ +Описание, пример вызова + +```bsl + +// Возвращает класификатор кода вида номенклатурной классификации +// +// Возвращаемое значение: +// ТаблицаЗначений. +// +Функция КодыВидаНоменклатурнойКлассификации() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервера.КодыВидаНоменклатурнойКлассификации() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МенеджерОборудованияВызовСервераПереопределяемый.md b/src/content/docs/zup/МенеджерОборудованияВызовСервераПереопределяемый.md new file mode 100644 index 0000000..e098608 --- /dev/null +++ b/src/content/docs/zup/МенеджерОборудованияВызовСервераПереопределяемый.md @@ -0,0 +1,669 @@ +--- +title: Менеджер оборудования вызов сервера переопределяемый +slug: zup/менеджер-оборудования-вызов-сервера-переопределяемый +--- + + +## ПолучитьДоступныеТипыОборудования +
+ +Описание, пример вызова + +```bsl + +// Возвращает список доступных типов оборудования. +// +// Возвращаемое значение: +// Массив - Массив доступных типов подключаемого оборудования в конфигурации. +// +Функция ПолучитьДоступныеТипыОборудования() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервераПереопределяемый.ПолучитьДоступныеТипыОборудования() +``` +
+ +## ВозможностьДобавленияНовыхДрайверов +
+ +Описание, пример вызова + +```bsl + +// Возвращает флаг возможности добавления новых драйверов в справочник драйверов. +// +// Возвращаемое значение: +// Булево - В случае разрешение добавления новых драйверов возвращает Истина. +// +Функция ВозможностьДобавленияНовыхДрайверов() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервераПереопределяемый.ВозможностьДобавленияНовыхДрайверов() +``` +
+ +## ИспользоватьПодключаемоеОборудование +
+ +Описание, пример вызова + +```bsl + +// Возвращает флаг возможности использовать подключаемое оборудование. +// +// Возвращаемое значение: +// Булево - В случае разрешение использовать подключаемое оборудование. +// +Функция ИспользоватьПодключаемоеОборудование() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервераПереопределяемый.ИспользоватьПодключаемоеОборудование() +``` +
+ +## ДоступноИспользованиеРазделенныхДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак возможности обращения к разделенным данным из текущего сеанса. +// +// Возвращаемое значение: +// Булево - В случае вызова в неразделенной конфигурации возвращает Истина. +// +Функция ДоступноИспользованиеРазделенныхДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервераПереопределяемый.ДоступноИспользованиеРазделенныхДанных() +``` +
+ +## ДоступноРаспределеннаяФискализации +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак доступности распределенной фискализации. +// +// Возвращаемое значение: +// Булево - В случае доступности распределенной фискализации. +// +Функция ДоступноРаспределеннаяФискализации() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервераПереопределяемый.ДоступноРаспределеннаяФискализации() +``` +
+ +## ОбновлениеБиблиотеки +
+ +Описание, пример вызова + +```bsl + +// Обновление библиотеки в целевой конфигурации. +// +Процедура ОбновлениеБиблиотеки() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ОбновлениеБиблиотеки() +``` +
+ +## ОбновитьПоставляемыеДрайвера +
+ +Описание, пример вызова + +```bsl + +// Обновить поставляемые драйверы в составе конфигурации. +// +Процедура ОбновитьПоставляемыеДрайвера() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ОбновитьПоставляемыеДрайвера() +``` +
+ +## ОбновитьУстановленныеДрайвера +
+ +Описание, пример вызова + +```bsl + +// Обновить установленные драйвера. +// +Процедура ОбновитьУстановленныеДрайвера() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ОбновитьУстановленныеДрайвера() +``` +
+ +## ВозможностьИспользоватьСнятыхСПоддержкиДрайверов +
+ +Описание, пример вызова + +```bsl + +// Возвращает флаг возможности использовать драйверов снятых с поддержки. +// +// Возвращаемое значение: +// Булево - В случае возможность использовать снятых с поддержки драйверов возвращает Истина. +// +Функция ВозможностьИспользоватьСнятыхСПоддержкиДрайверов() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервераПереопределяемый.ВозможностьИспользоватьСнятыхСПоддержкиДрайверов() +``` +
+ +## ПриЗаполненииОграниченияДоступа +
+ +Описание, пример вызова + +```bsl + +// Переопределяемая процедура для подсистемы управление доступом СтандартныеПодсистемы +// См. УправлениеДоступомПереопределяемый.ПриЗаполненииСписковСОграничениемДоступа. +// +Процедура ПриЗаполненииОграниченияДоступа(Менеджер, Ограничение) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ПриЗаполненииОграниченияДоступа(Менеджер, Ограничение) +``` +
+ +## ПодготовитьЭлементУправления +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с элементом формы +// служит для учета специфики визуального отображения в зависимости от типа клиента. +// +Процедура ПодготовитьЭлементУправления(ЭлементУправления, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ПодготовитьЭлементУправления(ЭлементУправления, СтандартнаяОбработка) +``` +
+ +## ОбновитьПараметрыККМОфлайн205 +
+ +Описание, пример вызова + +```bsl + +// Обновить параметры ККМ Офлайн. +// +Процедура ОбновитьПараметрыККМОфлайн205() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ОбновитьПараметрыККМОфлайн205() +``` +
+ +## ОбновитьПараметрыККМОфлайн211 +
+ +Описание, пример вызова + +```bsl + +// Обновить параметры ККМ Офлайн. +// +Процедура ОбновитьПараметрыККМОфлайн211() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ОбновитьПараметрыККМОфлайн211() +``` +
+ +## ОбновитьПараметрыККМОфлайнЭвотор +
+ +Описание, пример вызова + +```bsl + +//Обновить параметры ККМ Офлайн Эвотор +// +Процедура ОбновитьПараметрыККМОфлайнЭвотор() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ОбновитьПараметрыККМОфлайнЭвотор() +``` +
+ +## ОбновитьПараметрыДатыЗагрузкиККМОфлайнЭвотор +
+ +Описание, пример вызова + +```bsl + +//Обновить параметры ККМ Офлайн Эвотор +Процедура ОбновитьПараметрыДатыЗагрузкиККМОфлайнЭвотор() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ОбновитьПараметрыДатыЗагрузкиККМОфлайнЭвотор() +``` +
+ +## УстановитьПоследнююВерсиюФорматаОфлайнОборудование +
+ +Описание, пример вызова + +```bsl + +// Обновить параметры ККМ Офлайн. +// +Процедура УстановитьПоследнююВерсиюФорматаОфлайнОборудование() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.УстановитьПоследнююВерсиюФорматаОфлайнОборудование() +``` +
+ +## ЗаполнитьРеквизитыОрганизацииДляРегистрацииФН +
+ +Описание, пример вызова + +```bsl + +// Процедура заполняет реквизиты организации для регистрации ФН. +// +Процедура ЗаполнитьРеквизитыОрганизацииДляРегистрацииФН(Организация, ПараметрыРегистрации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ЗаполнитьРеквизитыОрганизацииДляРегистрацииФН(Организация, ПараметрыРегистрации) +``` +
+ +## СформироватьШаблонЧека +
+ +Описание, пример вызова + +```bsl + +// Переопределяет формируемый шаблон чека. +// +Функция СформироватьШаблонЧека(ОбщиеПараметры, ДополнительныйТекст, СтандартнаяОбработка, ТипОборудования = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервераПереопределяемый.СформироватьШаблонЧека(ОбщиеПараметры, ДополнительныйТекст, СтандартнаяОбработка, ТипОборудования); +``` +
+ +## ДоступноеККТДляФискализации +
+ +Описание, пример вызова + +```bsl + +// Переопределяет доступное ККТ для фискализации чека +// Параметры: +// РеквизитыЧека - Структура - реквизиты фискального чека +// СписокУстройств - Массив - список доступных ККТ для фискализации +// ИдентификаторУстройстваККТ - Ссылка - выбранное ККТ для фискализации +// +Процедура ДоступноеККТДляФискализации(РеквизитыЧека, СписокУстройств, ИдентификаторУстройстваККТ) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ДоступноеККТДляФискализации(РеквизитыЧека, СписокУстройств, ИдентификаторУстройстваККТ) +``` +
+ +## КодТовараЗаполняетсяТолькоДляDataMatrixGS1 +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак заполнения тега 1162 (код товара) только для DataMatrixGS1. +// +// Возвращаемое значение: +// Булево - Если код товара заполняется только для КМ DataMatrixGS1. +// +Функция КодТовараЗаполняетсяТолькоДляDataMatrixGS1() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервераПереопределяемый.КодТовараЗаполняетсяТолькоДляDataMatrixGS1() +``` +
+ +## ПолучитьПрефиксВесовогоТовара +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает префикс весового товара применяемого для генерации штрихкода. +// Используется при выгрузке в весы с печатью этикеток. +// +// Параметры: +// ПодключаемоеОборудованиеСсылка - Ссылка на экземпляр подключаемого оборудования. +// +// Возвращаемое значение: +// Число - Префикс весового товара. +// +Функция ПолучитьПрефиксВесовогоТовара(ПодключаемоеОборудованиеСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервераПереопределяемый.ПолучитьПрефиксВесовогоТовара(ПодключаемоеОборудованиеСсылка) +``` +
+ +## ПолучитьПрефиксШтучногоТовара +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает префикс штучного товара применяемого для генерации штрихкода. +// Используется при выгрузке в весы с печатью этикеток. +// +// Параметры: +// ПодключаемоеОборудованиеСсылка - Ссылка на экземпляр подключаемого оборудования. +// +// Возвращаемое значение: +// Число - Префикс штучного товара который фасуется на весах. +// +Функция ПолучитьПрефиксШтучногоТовара(ПодключаемоеОборудованиеСсылка) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияВызовСервераПереопределяемый.ПолучитьПрефиксШтучногоТовара(ПодключаемоеОборудованиеСсылка) +``` +
+ +## ЭкземплярОборудованияПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ПриСозданииНаСервере". +// +// Параметры: +// Объект - СправочникОбъект.ПодключаемоеОборудование - Объект подключаемого оборудования. +// ЭтаФорма - ФормаКлиентскогоПриложения - Форма настройки оборудования +// Отказ - Булево - Отказ создания +// Параметры - Структура - Параметры операции +// СтандартнаяОбработка - Булево - Стандартная обработка +// +Процедура ЭкземплярОборудованияПриСозданииНаСервере(Объект, ЭтаФорма, Отказ, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ЭкземплярОборудованияПриСозданииНаСервере(Объект, ЭтаФорма, Отказ, Параметры, СтандартнаяОбработка) +``` +
+ +## ЭкземплярОборудованияПриЧтенииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ПриЧтенииНаСервере". +// +// Параметры: +// ТекущийОбъект - СправочникОбъект.ПодключаемоеОборудование - Объект подключаемого оборудования. +// ЭтаФорма - ФормаКлиентскогоПриложения - Форма настройки оборудования +// +Процедура ЭкземплярОборудованияПриЧтенииНаСервере(ТекущийОбъект, ЭтаФорма) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ЭкземплярОборудованияПриЧтенииНаСервере(ТекущийОбъект, ЭтаФорма) +``` +
+ +## ЭкземплярОборудованияПередЗаписьюНаСервере +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ПередЗаписьюНаСервере". +// +// Параметры: +// Отказ - Булево - Отказ операции +// ТекущийОбъект - СправочникОбъект.ПодключаемоеОборудование - Объект подключаемого оборудования. +// ПараметрыЗаписи - Структура - Параметры операции +// +Процедура ЭкземплярОборудованияПередЗаписьюНаСервере(Отказ, ТекущийОбъект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ЭкземплярОборудованияПередЗаписьюНаСервере(Отказ, ТекущийОбъект, ПараметрыЗаписи) +``` +
+ +## ЭкземплярОборудованияПриЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ПриЗаписиНаСервере". +// +// Параметры: +// Отказ - Булево - Отказ операции +// ТекущийОбъект - СправочникОбъект.ПодключаемоеОборудование - Объект подключаемого оборудования. +// ПараметрыЗаписи - Структура - Параметры операции +// +Процедура ЭкземплярОборудованияПриЗаписиНаСервере(Отказ, ТекущийОбъект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ЭкземплярОборудованияПриЗаписиНаСервере(Отказ, ТекущийОбъект, ПараметрыЗаписи) +``` +
+ +## ЭкземплярОборудованияПослеЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ПослеЗаписиНаСервере". +// +// Параметры: +// ТекущийОбъект - СправочникОбъект.ПодключаемоеОборудование - Объект подключаемого оборудования. +// ПараметрыЗаписи - Структура - Параметры операции +// +Процедура ЭкземплярОборудованияПослеЗаписиНаСервере(ТекущийОбъект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ЭкземплярОборудованияПослеЗаписиНаСервере(ТекущийОбъект, ПараметрыЗаписи) +``` +
+ +## ЭкземплярОборудованияОбработкаПроверкиЗаполненияНаСервере +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ОбработкаПроверкиЗаполненияНаСервере". +// +// Параметры: +// Объект - СправочникОбъект.ПодключаемоеОборудование - Объект подключаемого оборудования. +// ЭтаФорма - ФормаКлиентскогоПриложения - Форма настройки оборудования +// Отказ - Булево - Отказ создания +// ПроверяемыеРеквизиты - Структура - Проверяемые реквизиты +// +Процедура ЭкземплярОборудованияОбработкаПроверкиЗаполненияНаСервере(Объект, ЭтаФорма, Отказ, ПроверяемыеРеквизиты) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ЭкземплярОборудованияОбработкаПроверкиЗаполненияНаСервере(Объект, ЭтаФорма, Отказ, ПроверяемыеРеквизиты) +``` +
+ +## ЭкземплярФискальныеОперацииПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре Фискальные операции +// при событии "ПриСозданииНаСервере". +// +// Параметры: +// Запись - Запись - Запись фискальные операции. +// ЭтаФорма - ФормаКлиентскогоПриложения - Форма настройки оборудования +// Отказ - Булево - Отказ создания +// Параметры - Структура - Параметры операции +// СтандартнаяОбработка - Булево - Стандартная обработка +// +Процедура ЭкземплярФискальныеОперацииПриСозданииНаСервере(Запись, ЭтаФорма, Отказ, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ЭкземплярФискальныеОперацииПриСозданииНаСервере(Запись, ЭтаФорма, Отказ, Параметры, СтандартнаяОбработка) +``` +
+ +## СписокФискальныеОперацииПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Список Фискальные операции +// при событии "ПриСозданииНаСервере". +// +// Параметры: +// ЭтаФорма – ФормаКлиентскогоПриложения – Форма настройки оборудования +// Отказ - Булево - Отказ создания +// Параметры - Структура - Параметры операции +// СтандартнаяОбработка - Булево - Стандартная обработка +// +Процедура СписокФискальныеОперацииПриСозданииНаСервере(ЭтаФорма, Отказ, Параметры, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.СписокФискальныеОперацииПриСозданииНаСервере(ЭтаФорма, Отказ, Параметры, СтандартнаяОбработка) +``` +
+ +## ФискализацияЧекаВОчереди +
+ +Описание, пример вызова + +```bsl + +// Завершение фискализация чека в очереди +// +// Параметры: +// ИдентификаторФискальнойЗаписи - Строка - Идентификатор фискальной записи +// ПараметрыФискализации - Структура - Параметры операции +// СтандартнаяОбработка - СправочникСсылка - СправочникСсылка.ПодключаемоеОборудование +// РезультатФискализации - Структура - Результат Фискализации +// +Процедура ФискализацияЧекаВОчереди(ИдентификаторФискальнойЗаписи, ПараметрыФискализации, ОборудованиеККТ, РезультатФискализации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияВызовСервераПереопределяемый.ФискализацияЧекаВОчереди(ИдентификаторФискальнойЗаписи, ПараметрыФискализации, ОборудованиеККТ, РезультатФискализации) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МенеджерОборудованияКлиент.md b/src/content/docs/zup/МенеджерОборудованияКлиент.md new file mode 100644 index 0000000..25226d7 --- /dev/null +++ b/src/content/docs/zup/МенеджерОборудованияКлиент.md @@ -0,0 +1,3239 @@ +--- +title: Менеджер оборудования клиент +slug: zup/менеджер-оборудования-клиент +--- + + +## ПередНачаломРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Функция, вызываемая перед началом работы системы. +// +Функция ПередНачаломРаботыСистемы() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПередНачаломРаботыСистемы() +``` +
+ +## ПриНачалеРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Функция, вызываемая при начале работы системы. +// +Функция ПриНачалеРаботыСистемы() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПриНачалеРаботыСистемы() +``` +
+ +## ПередЗавершениемРаботыСистемы +
+ +Описание, пример вызова + +```bsl + +// Функция, вызываемая при начале работы системы. +// Выполняет подготовку данных механизма. +Функция ПередЗавершениемРаботыСистемы() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПередЗавершениемРаботыСистемы() +``` +
+ +## ПолучитьПодключенноеУстройство +
+ +Описание, пример вызова + +```bsl + +// Поиск по идентификатору подключенного ранее устройства. +// +// Параметры: +// СписокПодключений - Массив из Структура - содержит: +// *Ссылка - СправочникСсылка.ПодключаемоеОборудование - . +// Идентификатор - СправочникСсылка.ПодключаемоеОборудование - . +// Возвращаемое значение: +// СправочникСсылка.ПодключаемоеОборудование - Описание. +Функция ПолучитьПодключенноеУстройство(СписокПодключений, Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПолучитьПодключенноеУстройство(СписокПодключений, Идентификатор) +``` +
+ +## ПолучитьПодключенныеУстройства +
+ +Описание, пример вызова + +```bsl + +// Поиск по типу подключенные ранее устройства. +// +// Параметры: +// СписокПодключений - Массив из Структура - где: +// *Ссылка - СправочникСсылка.ПодключаемоеОборудование - . +// ТипПО - ПеречислениеСсылка.ТипыПодключаемогоОборудования - Описание +// Идентификатор - Неопределено - Описание +// Возвращаемое значение: +// Массив Из Структура - где: +// *Ссылка - СправочникСсылка.ПодключаемоеОборудование - . +Функция ПолучитьПодключенныеУстройства(СписокПодключений, ТипПО, Идентификатор = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПолучитьПодключенныеУстройства(СписокПодключений, ТипПО, Идентификатор); +``` +
+ +## ВыполнитьНастройкуОборудования +
+ +Описание, пример вызова + +```bsl + +// Выполнить настройку оборудования. +// +Процедура ВыполнитьНастройкуОборудования(Идентификатор, ОповещениеПриЗавершении = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ВыполнитьНастройкуОборудования(Идентификатор, ОповещениеПриЗавершении); +``` +
+ +## ВыполнитьНастройкуОборудования_Завершение +
+ +Описание, пример вызова + +```bsl + +// Завершение настройки оборудования. +// +// Параметры: +// Результат - Структура - где: +// * Идентификатор - СправочникСсылка.ПодключаемоеОборудование - экземпляр подключаемого оборудования. +// * ПараметрыОборудования - Структура - структура параметров. +// Параметры - Структура - структура параметров выполнения операции. +// +Процедура ВыполнитьНастройкуОборудования_Завершение(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ВыполнитьНастройкуОборудования_Завершение(Результат, Параметры) +``` +
+ +## СохранитьПользовательскиеНастройкиПодключаемогоОборудования +
+ +Описание, пример вызова + +```bsl + +// Сохраняет пользовательские настройки подключаемого оборудования. +// +Процедура СохранитьПользовательскиеНастройкиПодключаемогоОборудования(СписокНастроек) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.СохранитьПользовательскиеНастройкиПодключаемогоОборудования(СписокНастроек) +``` +
+ +## ПодключениеСистемыВзаимодействия +
+ +Описание, пример вызова + +```bsl + +Процедура ПодключениеСистемыВзаимодействия() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПодключениеСистемыВзаимодействия() +``` +
+ +## ОбработкаОповещенияПодключенияСообщенийФискализации +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаОповещенияПодключенияСообщенийФискализации(ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ОбработкаОповещенияПодключенияСообщенийФискализации(ДополнительныеПараметры) +``` +
+ +## ОбработкаОповещенияСообщенийФискализации +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаОповещенияСообщенийФискализации(Сообщение, ДополнительныеПараметры) ЭКспорт Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ОбработкаОповещенияСообщенийФискализации(Сообщение, ДополнительныеПараметры) ЭКспорт); +``` +
+ +## ПолучитьДоступноеККТДляФискализации +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьДоступноеККТДляФискализации(РеквизитыЧека, СписокУстройств) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПолучитьДоступноеККТДляФискализации(РеквизитыЧека, СписокУстройств)); +``` +
+ +## ФискализацияЧековВОчереди_Завершение +
+ +Описание, пример вызова + +```bsl + +Процедура ФискализацияЧековВОчереди_Завершение(РезультатВыполнения, ПараметрыОперации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ФискализацияЧековВОчереди_Завершение(РезультатВыполнения, ПараметрыОперации) +``` +
+ +## ФискализацияЧековВОчереди_Начало +
+ +Описание, пример вызова + +```bsl + +Процедура ФискализацияЧековВОчереди_Начало(ПараметрыОперации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ФискализацияЧековВОчереди_Начало(ПараметрыОперации)); +``` +
+ +## ФискализацияЧековВОчереди +
+ +Описание, пример вызова + +```bsl + +Процедура ФискализацияЧековВОчереди() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ФискализацияЧековВОчереди() +``` +
+ +## ОткрытьРабочиеМеста +
+ +Описание, пример вызова + +```bsl + +// Открытие формы списка рабочих мест. +// +Процедура ОткрытьРабочиеМеста(ПараметрКоманды, ПараметрыВыполненияКоманды) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ОткрытьРабочиеМеста(ПараметрКоманды, ПараметрыВыполненияКоманды) +``` +
+ +## ВыбратьРМТекущегоСеанса +
+ +Описание, пример вызова + +```bsl + +// Процедура для выбора рабочего места текущего сеанса. +// +Процедура ВыбратьРМТекущегоСеанса(ПараметрКоманды, ПараметрыВыполненияКоманды) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ВыбратьРМТекущегоСеанса(ПараметрКоманды, ПараметрыВыполненияКоманды) +``` +
+ +## ОткрытьПодключаемоеОборудование +
+ +Описание, пример вызова + +```bsl + +// Открытие формы подключаемого Оборудования. +// +Процедура ОткрытьПодключаемоеОборудование(ПараметрКоманды, ПараметрыВыполненияКоманды) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ОткрытьПодключаемоеОборудование(ПараметрКоманды, ПараметрыВыполненияКоманды) +``` +
+ +## ОткрытьДрайверыОборудования +
+ +Описание, пример вызова + +```bsl + +// Открытие формы драйверов оборудования. +// +Процедура ОткрытьДрайверыОборудования(ПараметрКоманды, ПараметрыВыполненияКоманды) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ОткрытьДрайверыОборудования(ПараметрКоманды, ПараметрыВыполненияКоманды) +``` +
+ +## ПредложитьВыборРабочегоМеста +
+ +Описание, пример вызова + +```bsl + +// Функция предоставляет диалог выбора рабочего места. +// +Процедура ПредложитьВыборРабочегоМеста(ОбработкаОповещения, ИдентификаторКлиента = "") Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПредложитьВыборРабочегоМеста(ОбработкаОповещения, ИдентификаторКлиента); +``` +
+ +## ПредложитьВыборРабочегоМестаЗавершение +
+ +Описание, пример вызова + +```bsl + +// Завершение выбора рабочего места. +// +Процедура ПредложитьВыборРабочегоМестаЗавершение(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПредложитьВыборРабочегоМестаЗавершение(Результат, Параметры) +``` +
+ +## УстановитьРабочееМесто +
+ +Описание, пример вызова + +```bsl + +// Функция устанавливает рабочее место. +// +Процедура УстановитьРабочееМесто(РабочееМесто) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.УстановитьРабочееМесто(РабочееМесто) +``` +
+ +## ОбновитьРабочееМестоКлиента +
+ +Описание, пример вызова + +```bsl + +// Выполняет обновление имени компьютера в параметре сеанса "РабочееМестоКлиента". +// +Функция ОбновитьРабочееМестоКлиента() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ОбновитьРабочееМестоКлиента() +``` +
+ +## ПараметрыВыполненияОперацииНаОборудовании +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру выполнения операции на Оборудовании. +// +Функция ПараметрыВыполненияОперацииНаОборудовании(Результат = Ложь, ОписаниеОшибки = Неопределено, ИдентификаторУстройства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПараметрыВыполненияОперацииНаОборудовании(Результат, ОписаниеОшибки, ИдентификаторУстройства); +``` +
+ +## ПредложитьВыбратьУстройство +
+ +Описание, пример вызова + +```bsl + +// Процедура выбора устройства из доступных, привязанных к текущему рабочему месту. +// +Процедура ПредложитьВыбратьУстройство(ОповещениеВыбора, ТипОборудования, ТекстЗаголовкаВыбора, Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПредложитьВыбратьУстройство(ОповещениеВыбора, ТипОборудования, ТекстЗаголовкаВыбора, ); +``` +
+ +## ПредложитьВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПредложитьВыбратьУстройствоЗавершение(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПредложитьВыбратьУстройствоЗавершение(Результат, Параметры) +``` +
+ +## НачатьВыборФайлаДрайвера +
+ +Описание, пример вызова + +```bsl + +// Функция начинает выбор файла драйвера для последующей загрузки. +// +Процедура НачатьВыборФайлаДрайвера(ОповещениеПриВыборе) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыборФайлаДрайвера(ОповещениеПриВыборе) +``` +
+ +## ВыборФайлаДрайвераЗавершение +
+ +Описание, пример вызова + +```bsl + +// Завершение выбора файла драйвера. +// +Процедура ВыборФайлаДрайвераЗавершение(ВыбранныеФайлы, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ВыборФайлаДрайвераЗавершение(ВыбранныеФайлы, Параметры) +``` +
+ +## НачатьВыборФайлаРасширенияЗавершение +
+ +Описание, пример вызова + +```bsl + +// Завершение выбора файла +// +Процедура НачатьВыборФайлаРасширенияЗавершение(Установлено, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыборФайлаРасширенияЗавершение(Установлено, ДополнительныеПараметры) +``` +
+ +## НачатьВыборФайла +
+ +Описание, пример вызова + +```bsl + +// Функция начинает выбор файла. +// +Процедура НачатьВыборФайла(ОповещениеПриВыборе, Знач ИмяФайла, РежимДиалогаВыбораФайла = "Открытие") Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыборФайла(ОповещениеПриВыборе, ИмяФайла, РежимДиалогаВыбораФайла); +``` +
+ +## Пауза +
+ +Описание, пример вызова + +```bsl + +// Процедура формирует задержку указанной длительности. +// +// Параметры: +// Время - <Число> +// - Длительность задержки в секундах. +// +Процедура Пауза(Время) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.Пауза(Время) +``` +
+ +## ПреобразоватьСписокСтрокойВМассив +
+ +Описание, пример вызова + +```bsl + +// Преобразовать список строкой в массив. +// +Функция ПреобразоватьСписокСтрокойВМассив(Источник) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПреобразоватьСписокСтрокойВМассив(Источник) +``` +
+ +## СостояниеПроцесса +
+ +Описание, пример вызова + +```bsl + +// Выводит текст в панель состояния. +// +Процедура СостояниеПроцесса(ТекстСообщения, Прогресс = Неопределено, Пояснение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.СостояниеПроцесса(ТекстСообщения, Прогресс, Пояснение); +``` +
+ +## НачатьПодключениеОборудованиеПоТипу +
+ +Описание, пример вызова + +```bsl + +// Производит подключение доступного оборудования по списку типов ПО +// +Процедура НачатьПодключениеОборудованиеПоТипу(ОповещениеПриПодключении, ИдентификаторКлиента, ТипыПО) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключениеОборудованиеПоТипу(ОповещениеПриПодключении, ИдентификаторКлиента, ТипыПО) +``` +
+ +## НачатьПодключениеОборудованиеПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Начать подключать одиночный экземпляр устройства определяемый идентификатором. +// +Процедура НачатьПодключениеОборудованиеПоИдентификатору(ОповещениеПриПодключении, ИдентификаторКлиента, ИдентификаторУстройства) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключениеОборудованиеПоИдентификатору(ОповещениеПриПодключении, ИдентификаторКлиента, ИдентификаторУстройства) +``` +
+ +## НачатьПодключениеОборудования +
+ +Описание, пример вызова + +```bsl + +// Начать подключения устройства. +// +Процедура НачатьПодключениеОборудования(ОповещениеПриПодключении, ИдентификаторКлиента, ТипыПО = Неопределено, ИдентификаторУстройства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключениеОборудования(ОповещениеПриПодключении, ИдентификаторКлиента, ТипыПО, ИдентификаторУстройства); +``` +
+ +## НачатьПодключениеОборудования_ПолучениеОбъектаДрайвераЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПодключениеОборудования_ПолучениеОбъектаДрайвераЗавершение(ОбъектДрайвера, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключениеОборудования_ПолучениеОбъектаДрайвераЗавершение(ОбъектДрайвера, Параметры) +``` +
+ +## НачатьПодключениеОборудования_Завершение +
+ +Описание, пример вызова + +```bsl + +// НачинаетПодключениеОборудования. +// +// Параметры: +// РезультатВыполнения - Структура - результат выполнения операции. +// Параметры - Структура - где: +// *НовоеПодключение - Структура - где: +// **Наименование - Строка - . +// +Процедура НачатьПодключениеОборудования_Завершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключениеОборудования_Завершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьОтключениеОборудованиеПоТипу +
+ +Описание, пример вызова + +```bsl + +// Начать отключение устройств по типу оборудования. +// +Процедура НачатьОтключениеОборудованиеПоТипу(ОповещениеПриОтключении, ИдентификаторКлиента, ТипыПО) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОтключениеОборудованиеПоТипу(ОповещениеПриОтключении, ИдентификаторКлиента, ТипыПО) +``` +
+ +## НачатьОтключениеОборудованиеПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Начать отключать устройства определенное идентификатором. +// +Процедура НачатьОтключениеОборудованиеПоИдентификатору(ОповещениеПриОтключении, ИдентификаторКлиента, ИдентификаторУстройства) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОтключениеОборудованиеПоИдентификатору(ОповещениеПриОтключении, ИдентификаторКлиента, ИдентификаторУстройства) +``` +
+ +## НачатьОтключениеОборудование +
+ +Описание, пример вызова + +```bsl + +// Функция подключает устройства по типу оборудования. +// +Процедура НачатьОтключениеОборудование(ОповещениеПриОтключении, ИдентификаторКлиента, ТипыПО = Неопределено, ИдентификаторУстройства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОтключениеОборудование(ОповещениеПриОтключении, ИдентификаторКлиента, ТипыПО, ИдентификаторУстройства); +``` +
+ +## НачатьОтключениеОборудование_Завершение +
+ +Описание, пример вызова + +```bsl + +// Отключает оборудование. +// +// Параметры: +// РезультатВыполнения - Структура - структура результата выполнения операции. +// Параметры - Структура - где: +// *ПодключенноеУстройство - СправочникСсылка.ПодключаемоеОборудование - . +Процедура НачатьОтключениеОборудование_Завершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОтключениеОборудование_Завершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьОтключениеВсегоОборудования +
+ +Описание, пример вызова + +```bsl + +// Производит принудительное отключение всего подключенного оборудования, +// независимо от числа ссылок на подключение. +Процедура НачатьОтключениеВсегоОборудования(ОповещениеПриОтключении = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОтключениеВсегоОборудования(ОповещениеПриОтключении); +``` +
+ +## НачатьОтключениеВсегоОборудованияЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОтключениеВсегоОборудованияЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОтключениеВсегоОборудованияЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## ПодключитьОборудованиеПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Подключает одиночный экземпляр устройства определяемый идентификатором. +// +Функция ПодключитьОборудованиеПоИдентификатору(ИдентификаторКлиента, ИдентификаторУстройства, ОписаниеОшибки = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПодключитьОборудованиеПоИдентификатору(ИдентификаторКлиента, ИдентификаторУстройства, ОписаниеОшибки); +``` +
+ +## ПодключитьОборудование +
+ +Описание, пример вызова + +```bsl + +// Функция подключает устройства по типу оборудования. +// Возвращает результат выполнения функции. +// +Функция ПодключитьОборудование(ИдентификаторКлиента, ТипыПО = Неопределено, ИдентификаторУстройства = Неопределено, ОписаниеОшибки = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПодключитьОборудование(ИдентификаторКлиента, ТипыПО, ИдентификаторУстройства, ОписаниеОшибки); +``` +
+ +## ОтключитьОборудованиеПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +// Отключает устройство, определенное идентификатором. +// +Функция ОтключитьОборудованиеПоИдентификатору(ИдентификаторКлиента, ИдентификаторУстройства, ОписаниеОшибки = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ОтключитьОборудованиеПоИдентификатору(ИдентификаторКлиента, ИдентификаторУстройства, ОписаниеОшибки); +``` +
+ +## ОтключитьОборудование +
+ +Описание, пример вызова + +```bsl + +// Функция подключает устройства по типу оборудования. +// +Функция ОтключитьОборудование(ИдентификаторКлиента, ТипыПО = Неопределено, ИдентификаторУстройства = Неопределено, ОписаниеОшибки = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ОтключитьОборудование(ИдентификаторКлиента, ТипыПО, ИдентификаторУстройства, ОписаниеОшибки); +``` +
+ +## ВыполнитьКоманду +
+ +Описание, пример вызова + +```bsl + +Функция ВыполнитьКоманду(Идентификатор, Команда, ВходныеПараметры, ВыходныеПараметры, Таймаут = -1) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ВыполнитьКоманду(Идентификатор, Команда, ВходныеПараметры, ВыходныеПараметры, Таймаут); +``` +
+ +## ВыполнитьДополнительнуюКоманду +
+ +Описание, пример вызова + +```bsl + +// Выполняет дополнительную команду к драйверу, не требующую предварительного подключения устройства в системе. +// +// Параметры: +// Команда - Строка - наименование команды. +// ВходныеПараметры - Массив - массив входных параметров. +// ВыходныеПараметры - Массив - массив выходных параметров. +// Идентификатор - СправочникСсылка.ПодключаемоеОборудование - . +// Параметры - Структура - параметры выполнения операции. +// Возвращаемое значение: +// Булево - Описание +Функция ВыполнитьДополнительнуюКоманду(Команда, ВходныеПараметры, ВыходныеПараметры, Идентификатор, Параметры) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ВыполнитьДополнительнуюКоманду(Команда, ВходныеПараметры, ВыходныеПараметры, Идентификатор, Параметры) +``` +
+ +## ВыполнитьКомандуОбработчикаДрайвера +
+ +Описание, пример вызова + +```bsl + +// Выполняет команду обработчика драйвера, не требующую предварительного подключения устройства в системе. +// +Функция ВыполнитьКомандуОбработчикаДрайвера(Команда, ВходныеПараметры, ВыходныеПараметры, Идентификатор, Параметры, ПоддержкаАсинхронногоРежима) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ВыполнитьКомандуОбработчикаДрайвера(Команда, ВходныеПараметры, ВыходныеПараметры, Идентификатор, Параметры, ПоддержкаАсинхронногоРежима) +``` +
+ +## НачатьПодключениеОборудованиеПриОткрытииФормы +
+ +Описание, пример вызова + +```bsl + +// Начать подключение необходимых типов оборудования при открытии формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения +// ПоддерживаемыеТипыПодключаемогоОборудования - Строка +// Содержит перечень типов подключаемого оборудования, разделенных запятыми. +// +Процедура НачатьПодключениеОборудованиеПриОткрытииФормы(ОповещениеПриПодключении, Форма, ПоддерживаемыеТипыПодключаемогоОборудования) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключениеОборудованиеПриОткрытииФормы(ОповещениеПриПодключении, Форма, ПоддерживаемыеТипыПодключаемогоОборудования) +``` +
+ +## ПодключитьОборудованиеЗавершениеПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +// Обработчик оповещения по умолчанию +// +Процедура ПодключитьОборудованиеЗавершениеПоУмолчанию(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПодключитьОборудованиеЗавершениеПоУмолчанию(РезультатВыполнения, Параметры) +``` +
+ +## НачатьОтключениеОборудованиеПриЗакрытииФормы +
+ +Описание, пример вызова + +```bsl + +// Начать отключать оборудование по типу при закрытии формы. +// +Процедура НачатьОтключениеОборудованиеПриЗакрытииФормы(ОповещениеПриОтключении, Форма) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОтключениеОборудованиеПриЗакрытииФормы(ОповещениеПриОтключении, Форма) +``` +
+ +## ОтключитьОборудованиеЗавершениеПоУмолчанию +
+ +Описание, пример вызова + +```bsl + +Процедура ОтключитьОборудованиеЗавершениеПоУмолчанию(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ОтключитьОборудованиеЗавершениеПоУмолчанию(РезультатВыполнения, Параметры) +``` +
+ +## ДрайверУстановлен +
+ +Описание, пример вызова + +```bsl + +// Проверяет установлен ли драйвер. +// +Функция ДрайверУстановлен(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ДрайверУстановлен(Идентификатор) +``` +
+ +## ПереустановитьПомеченныеДрайверы +
+ +Описание, пример вызова + +```bsl + +// Установить или переустановить драйверы помеченные флагами. +// +Процедура ПереустановитьПомеченныеДрайверы() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПереустановитьПомеченныеДрайверы() +``` +
+ +## НачатьУстановкуРасширенияРаботыСФайламиЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьУстановкуРасширенияРаботыСФайламиЗавершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьУстановкуРасширенияРаботыСФайламиЗавершение(Результат, ДополнительныеПараметры) +``` +
+ +## НачатьПодключениеРасширенияРаботыСФайламиЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПодключениеРасширенияРаботыСФайламиЗавершение(Подключено, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключениеРасширенияРаботыСФайламиЗавершение(Подключено, ДополнительныеПараметры) +``` +
+ +## ПроверитьДоступностьРасширенияРаботыСФайлами +
+ +Описание, пример вызова + +```bsl + +// Проверить доступность расширения работы с Файлами. +// +Процедура ПроверитьДоступностьРасширенияРаботыСФайлами(ОповещениеПриЗавершении, ПредлагатьУстановку = Истина) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПроверитьДоступностьРасширенияРаботыСФайлами(ОповещениеПриЗавершении, ПредлагатьУстановку); +``` +
+ +## ОтключитьОбъектДрайвера +
+ +Описание, пример вызова + +```bsl + +// Отключение объекта драйвера. +// +Процедура ОтключитьОбъектДрайвера(ДанныеДрайвера) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ОтключитьОбъектДрайвера(ДанныеДрайвера) +``` +
+ +## ПолучитьОбъектДрайвера +
+ +Описание, пример вызова + +```bsl + +// Получение объекта драйвера +// +Функция ПолучитьОбъектДрайвера(ДанныеДрайвера, ТекстОшибки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПолучитьОбъектДрайвера(ДанныеДрайвера, ТекстОшибки); +``` +
+ +## НачатьПолучениеОбъектаДрайвераЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПолучениеОбъектаДрайвераЗавершение(Подключено, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПолучениеОбъектаДрайвераЗавершение(Подключено, ДополнительныеПараметры) +``` +
+ +## НачатьПолучениеОбъектаДрайвера +
+ +Описание, пример вызова + +```bsl + +// Начать получение объекта драйвера. +// +Процедура НачатьПолучениеОбъектаДрайвера(ОповещениеПриЗавершении, ДанныеДрайвера) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПолучениеОбъектаДрайвера(ОповещениеПриЗавершении, ДанныеДрайвера) +``` +
+ +## УстановитьДрайвер +
+ +Описание, пример вызова + +```bsl + +// Установить драйвер оборудования. +// +Процедура УстановитьДрайвер(Идентификатор, ОповещениеИзДистрибутиваПриЗавершении = Неопределено, ОповещениеИзАрхиваПриЗавершении = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.УстановитьДрайвер(Идентификатор, ОповещениеИзДистрибутиваПриЗавершении, ОповещениеИзАрхиваПриЗавершении); +``` +
+ +## НачатьВыполнениеКоманды +
+ +Описание, пример вызова + +```bsl + +// Начать выполнение команды ответственному обработчику драйвера +// +Процедура НачатьВыполнениеКоманды(ОповещениеПриЗавершении, Идентификатор, Команда, ВходныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКоманды(ОповещениеПриЗавершении, Идентификатор, Команда, ВходныеПараметры) +``` +
+ +## НачатьВыполнениеДополнительнойКоманды +
+ +Описание, пример вызова + +```bsl + +// Начать выполнение дополнительной команды к драйверу, не требующую предварительного подключения устройства в системе. +// +Процедура НачатьВыполнениеДополнительнойКоманды(ОповещениеПриЗавершении, Команда, ВходныеПараметры, Идентификатор, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеДополнительнойКоманды(ОповещениеПриЗавершении, Команда, ВходныеПараметры, Идентификатор, Параметры) +``` +
+ +## НачатьВыполнениеДополнительнойКоманды_Завершение +
+ +Описание, пример вызова + +```bsl + +// Завершение выполнение дополнительной команды к драйверу. +// Не требует предварительного подключения устройства в системе. +// +// Параметры: +// ОбъектДрайвера - СправочникСсылка.ДрайверыОборудования - . +// ПараметрыКоманды - Структура - где: +// *Параметры - Структура - . +Процедура НачатьВыполнениеДополнительнойКоманды_Завершение(ОбъектДрайвера, ПараметрыКоманды) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеДополнительнойКоманды_Завершение(ОбъектДрайвера, ПараметрыКоманды) +``` +
+ +## ПолучитьСобытиеОтУстройства +
+ +Описание, пример вызова + +```bsl + +// Производит получение события от устройства. +// +// Параметры: +// ОписаниеСобытия - Структура - содержит параметры: +// *Источник - Строка - источник события. +// ОписаниеОшибки - Строка - Описание +// Возвращаемое значение: +// Неопределено, Структура - Описание: +// * Источник - Строка - +// * Параметр +// * ИмяСобытия +Функция ПолучитьСобытиеОтУстройства(ОписаниеСобытия, ОписаниеОшибки = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПолучитьСобытиеОтУстройства(ОписаниеСобытия, ОписаниеОшибки); +``` +
+ +## ОбработатьСобытиеОтУстройства +
+ +Описание, пример вызова + +```bsl + +// Производит обработку данных события, полученных от клиента. +// +// Параметры: +// ОписаниеСобытия - Структура - содержит поля: +// *Источник - Строка - источник события. +// ОписаниеОшибки - Строка - Описание +// Возвращаемое значение: +// Булево - Описание +Функция ОбработатьСобытиеОтУстройства(ОписаниеСобытия, ОписаниеОшибки = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ОбработатьСобытиеОтУстройства(ОписаниеСобытия, ОписаниеОшибки); +``` +
+ +## НачатьВыполнениеКоманды_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеКоманды_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКоманды_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьВыполнениеКоманды_ПослеПроверкиСтатуса +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеКоманды_ПослеПроверкиСтатуса(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКоманды_ПослеПроверкиСтатуса(Результат, Параметры) +``` +
+ +## НачатьВыполнениеКоманды_ПослеПодтвержденияЗакрытияСмены +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеКоманды_ПослеПодтвержденияЗакрытияСмены(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКоманды_ПослеПодтвержденияЗакрытияСмены(Результат, Параметры) +``` +
+ +## НачатьВыполнениеКоманды_ПослеЗакрытияСмены +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеКоманды_ПослеЗакрытияСмены(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКоманды_ПослеЗакрытияСмены(Результат, Параметры) +``` +
+ +## НачатьВыполнениеКоманды_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеКоманды_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКоманды_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьВыполнениеКоманды_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +// Описание процедуры выполнения команды. +// +// Параметры: +// РезультатВыполнения - Структура - содержит параметры: +// *ПодключенноеУстройство - СправочникСсылка.ПодключаемоеОборудование - . +// *ДополнительныеПараметры - Структура - структура дополнительных параметров. +// Параметры - Структура - содержит параметры: +// *ДополнительныеПараметры - Структура - структура дополнительных параметров. +// +Процедура НачатьВыполнениеКоманды_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКоманды_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьФормированиеОтчетаОТекущемСостоянииРасчетов +
+ +Описание, пример вызова + +```bsl + +// Начать формирование отчета о текущем состоянии расчетов на фискальном устройстве. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьФормированиеОтчетаОТекущемСостоянииРасчетов(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьФормированиеОтчетаОТекущемСостоянииРасчетов(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьФормированиеОтчетаБезГашения +
+ +Описание, пример вызова + +```bsl + +// Начать формирование отчета отчет без гашения на фискальном устройстве. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьФормированиеОтчетаБезГашения(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьФормированиеОтчетаБезГашения(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьОткрытиеСменыНаФискальномУстройстве +
+ +Описание, пример вызова + +```bsl + +// Начать открытие смены на фискальном устройстве. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьОткрытиеСменыНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено, ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОткрытиеСменыНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства, ТипОборудования, ДополнительныеПараметры); +``` +
+ +## НачатьЗакрытиеСменыНаФискальномУстройстве +
+ +Описание, пример вызова + +```bsl + +// Начать закрытие смены на фискальном устройстве. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьЗакрытиеСменыНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено, КассоваяСмена = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьЗакрытиеСменыНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства, ТипОборудования, КассоваяСмена); +``` +
+ +## НачатьИнкассациюНаФискальномУстройстве +
+ +Описание, пример вызова + +```bsl + +// Производить инкассацию на фискальном устройстве. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьИнкассациюНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьИнкассациюНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьПолучениеШириныСтрокиПечатающегоУстройства +
+ +Описание, пример вызова + +```bsl + +// Процедура получает ширину строки в символах. +// +Процедура НачатьПолучениеШириныСтрокиПечатающегоУстройства(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПолучениеШириныСтрокиПечатающегоУстройства(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьФискализациюЧекаНаФискальномУстройстве +
+ +Описание, пример вызова + +```bsl + +// Производить печать чека на фискальном устройстве. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьФискализациюЧекаНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства = Неопределено, Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьФискализациюЧекаНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства, ); +``` +
+ +## НачатьФискализациюЧекаНаФискальномУстройствеПакетом +
+ +Описание, пример вызова + +```bsl + +// Производить печать чека на фискальном устройстве пакетом. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьФискализациюЧекаНаФискальномУстройствеПакетом(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьФискализациюЧекаНаФискальномУстройствеПакетом(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьПечатьТекста +
+ +Описание, пример вызова + +```bsl + +// Производить печать текста на фискальном устройстве. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьПечатьТекста(ОповещениеПриЗавершении, УникальныйИдентификатор, Текст, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПечатьТекста(ОповещениеПриЗавершении, УникальныйИдентификатор, Текст, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьПечатьТекстовыхДокументов +
+ +Описание, пример вызова + +```bsl + +// Производит печать текстового документа на фискальном устройстве. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьПечатьТекстовыхДокументов(ОповещениеПриЗавершении, УникальныйИдентификатор, НефискальныеДокументы, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПечатьТекстовыхДокументов(ОповещениеПриЗавершении, УникальныйИдентификатор, НефискальныеДокументы, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьФормированиеЧекаКоррекцииНаФискальномУстройстве +
+ +Описание, пример вызова + +```bsl + +// Производить формирование чека коррекции на фискальном устройстве. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьФормированиеЧекаКоррекцииНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьФормированиеЧекаКоррекцииНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьОткрытиеДенежногоЯщика +
+ +Описание, пример вызова + +```bsl + +// Осуществляет открытие денежного ящика. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ТипОборудования - тип оборудования. +// +Процедура НачатьОткрытиеДенежногоЯщика(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОткрытиеДенежногоЯщика(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьАннулированиеЧекаНаФискальномУстройстве +
+ +Описание, пример вызова + +```bsl + +// Производить аннулирование чека на фискальном устройстве. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// +Процедура НачатьАннулированиеЧекаНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьАннулированиеЧекаНаФискальномУстройстве(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьПолучениеПараметровФискальногоУстройства +
+ +Описание, пример вызова + +```bsl + +// Производить получение параметров фискального устройства. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// +Процедура НачатьПолучениеПараметровФискальногоУстройства(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено, ИспользоватьСохраненныеЗначения = Истина) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПолучениеПараметровФискальногоУстройства(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства, ИспользоватьСохраненныеЗначения); +``` +
+ +## НачатьПолучениеТекущегоСостоянияФискальногоУстройства +
+ +Описание, пример вызова + +```bsl + +// Получение текущего состояния фискального устройства. +// ОповещениеПриЗавершении - оповещение при завершении завершении. +// УникальныйИдентификатор - идентификатор формы. +// ИдентификаторУстройства - идентификатор устройства, если неопределенно - будет предложен выбор. +// +Процедура НачатьПолучениеТекущегоСостоянияФискальногоУстройства(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПолучениеТекущегоСостоянияФискальногоУстройства(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## НачатьОперациюФНДляФискальногоУстройства +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОперациюФНДляФискальногоУстройства(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства = Неопределено, ТипОборудования = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОперациюФНДляФискальногоУстройства(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации, ИдентификаторУстройства, ТипОборудования); +``` +
+ +## СформироватьТекстНефискальногоЧека +
+ +Описание, пример вызова + +```bsl + +// Функция формирует текст нефискального чека по шаблону. +// +Функция СформироватьТекстНефискальногоЧека(ШиринаСтроки, ТипДокумента, ВходныеПараметры, ДополнительныйТекст = Неопределено, ФорматФФД = "1.1") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.СформироватьТекстНефискальногоЧека(ШиринаСтроки, ТипДокумента, ВходныеПараметры, ДополнительныйТекст, ФорматФФД); +``` +
+ +## НачатьВыполнениеКомандыПечатиЧека +
+ +Описание, пример вызова + +```bsl + +// Начать выполнение команды печати чека ответственному обработчику драйвера +// +Процедура НачатьВыполнениеКомандыПечатиЧека(ОповещениеПриЗавершении, Идентификатор, Команда, Параметры, ВходныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКомандыПечатиЧека(ОповещениеПриЗавершении, Идентификатор, Команда, Параметры, ВходныеПараметры) +``` +
+ +## НачатьВыполнениеКомандыПечатиЧека_ЗавершениеОтмены +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеКомандыПечатиЧека_ЗавершениеОтмены(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКомандыПечатиЧека_ЗавершениеОтмены(РезультатВыполнения, Параметры) +``` +
+ +## НачатьВыполнениеКомандыПечатиЧека_ЗавершениеПроцессаПечатиСлипЧека +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеКомандыПечатиЧека_ЗавершениеПроцессаПечатиСлипЧека(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКомандыПечатиЧека_ЗавершениеПроцессаПечатиСлипЧека(РезультатВыполнения, Параметры) +``` +
+ +## НачатьВыполнениеКомандыПечатиЧека_ЗавершениеПроцессаПечати +
+ +Описание, пример вызова + +```bsl + +// Начинает выполнение печати чека. +// +// Параметры: +// РезультатВыполнения - Структура - структура результата выполнения операции. +// Параметры - Структура - где: +// *ПодключенноеУстройство - Структура - где: +// **Параметры - Структура - . +Процедура НачатьВыполнениеКомандыПечатиЧека_ЗавершениеПроцессаПечати(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКомандыПечатиЧека_ЗавершениеПроцессаПечати(РезультатВыполнения, Параметры) +``` +
+ +## НачатьВыполнениеКомандыПечатиЧека_ЗавершениеПечати +
+ +Описание, пример вызова + +```bsl + +// Завершение печати. +// +// Параметры: +// ПараметрыВыполнения - Структура - где: +// *ПодключенноеУстройство - Структура - где: +// **Параметры - Структура - . +// Параметры - Структура - . +Процедура НачатьВыполнениеКомандыПечатиЧека_ЗавершениеПечати(ПараметрыВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКомандыПечатиЧека_ЗавершениеПечати(ПараметрыВыполнения, Параметры) +``` +
+ +## НачатьВыполнениеКомандыПечатиЧека_ЗавершениеОткрытиеЧека +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеКомандыПечатиЧека_ЗавершениеОткрытиеЧека(РезультатОперации, ПараметрыВыполнения) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКомандыПечатиЧека_ЗавершениеОткрытиеЧека(РезультатОперации, ПараметрыВыполнения) +``` +
+ +## ПечатьЧекаПоШаблону +
+ +Описание, пример вызова + +```bsl + +// Вспомогательная функция - осуществляет печать чека по шаблону. +// +// Параметры: +// ОбщийМодульОборудования - Строка - . +// ОбъектДрайвера - СправочникСсылка.ДрайверыОборудования - . +// Параметры - Структура - . +// ПараметрыПодключения - Структура - . +// ВходныеПараметры - Структура - где: +// *ПозицииЧека - Массив из Структура - где: +// **Наименование - Строка - . +// ВыходныеПараметры - Структура - . +// Возвращаемое значение: +// Булево - Описание +// +Функция ПечатьЧекаПоШаблону(ОбщийМодульОборудования, ОбъектДрайвера, Параметры, ПараметрыПодключения, ВходныеПараметры, ВыходныеПараметры) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПечатьЧекаПоШаблону(ОбщийМодульОборудования, ОбъектДрайвера, Параметры, ПараметрыПодключения, ВходныеПараметры, ВыходныеПараметры) +``` +
+ +## ЗаполнитьПараметрыОперацииПодписиЧека +
+ +Описание, пример вызова + +```bsl + +// Заполнить параметры операции подписи чека. +// +Процедура ЗаполнитьПараметрыОперацииПодписиЧека(ПараметрыОперации, НомерСмены = Неопределено, Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ЗаполнитьПараметрыОперацииПодписиЧека(ПараметрыОперации, НомерСмены, ); +``` +
+ +## СформироватьШаблонИнфоКвитанции +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьШаблонИнфоКвитанции(Параметры, ШиринаСтроки, ПечатьШтрихкода = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.СформироватьШаблонИнфоКвитанции(Параметры, ШиринаСтроки, ПечатьШтрихкода); +``` +
+ +## ПараметрыРезультатаПодключенияЭквайринговогоТерминала +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру результата подключения эквайрингового терминала. +// +Функция ПараметрыРезультатаПодключенияЭквайринговогоТерминала(Результат = Ложь, ОписаниеОшибки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПараметрыРезультатаПодключенияЭквайринговогоТерминала(Результат, ОписаниеОшибки); +``` +
+ +## НачатьПодключенияЭквайринговогоТерминала +
+ +Описание, пример вызова + +```bsl + +// Начать подключение эквайрингово терминала. +// Возвращает структуру: +// Результат - Результат операции. +// ОписаниеОшибки - Описание ошибки (Для Результат = Ложь). +// ИдентификаторПодключенногоЭТ - Идентификатор эквайринговогой терминала. +// ИдентификаторПодключенногоПУ - Идентификатор фискального регистратора. +// ПечатьКвитанцийНаТерминале - Печать квитанций на терминале, если Истина то ИдентификаторПодключенногоПУ = Неопределено. +// +Процедура НачатьПодключенияЭквайринговогоТерминала(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройстваЭТ = Неопределено, ИдентификаторУстройстваПУ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключенияЭквайринговогоТерминала(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройстваЭТ, ИдентификаторУстройстваПУ); +``` +
+ +## НачатьПодключенияЭквайринговогоТерминала_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПодключенияЭквайринговогоТерминала_ВыбратьУстройствоЗавершение(ИдентификаторУстройстваЭТ, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключенияЭквайринговогоТерминала_ВыбратьУстройствоЗавершение(ИдентификаторУстройстваЭТ, Параметры) +``` +
+ +## НачатьПодключенияЭквайринговогоТерминала_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПодключенияЭквайринговогоТерминала_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключенияЭквайринговогоТерминала_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьПодключенияЭквайринговогоТерминала_ПечатьНаТерминалеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПодключенияЭквайринговогоТерминала_ПечатьНаТерминалеЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключенияЭквайринговогоТерминала_ПечатьНаТерминалеЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьПодключенияЭквайринговогоТерминала_ВыбратьПечатающегоУстройстваЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПодключенияЭквайринговогоТерминала_ВыбратьПечатающегоУстройстваЗавершение(ИдентификаторУстройстваПУ, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключенияЭквайринговогоТерминала_ВыбратьПечатающегоУстройстваЗавершение(ИдентификаторУстройстваПУ, Параметры) +``` +
+ +## НачатьПодключенияЭквайринговогоТерминала_ПечатающееУстройствоПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПодключенияЭквайринговогоТерминала_ПечатающееУстройствоПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПодключенияЭквайринговогоТерминала_ПечатающееУстройствоПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьОтключениеЭквайринговогоТерминала +
+ +Описание, пример вызова + +```bsl + +// Отключение подключенного эквайрингово терминала. +// Если эквайринговый терминал не поддерживает печать квитанций на терминале, для печати подключается печатающее устройство. +// Данной процедурой оно тоже будет отключено. +// Входящие параметры: +// ПараметрыОперации - Структура со следующими атрибутами. +// ИдентификаторУстройстваЭТ - Идентификатор подключенного эквайринговогой терминала. +// ИдентификаторУстройстваПУ - Идентификатор подключенного фискального регистратора. +// ПечатьКвитанцийНаТерминале - Печать квитанций на терминале, если True то ИдентификаторПодключенногоПУ = Неопределено. +// УникальныйИдентификатор - идентификатор формы. +// +Процедура НачатьОтключениеЭквайринговогоТерминала(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОтключениеЭквайринговогоТерминала(ОповещениеПриЗавершении, УникальныйИдентификатор, ПараметрыОперации) +``` +
+ +## НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале +
+ +Описание, пример вызова + +```bsl + +// Выполнить сверку итогов на эквайринговом терминале. +// Если эквайринговый терминал не поддерживает печать квитанций на терминале, для печати подключается печатающее устройство. +// +Процедура НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройстваЭТ = Неопределено, ИдентификаторУстройстваПУ = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройстваЭТ, ИдентификаторУстройстваПУ); +``` +
+ +## НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале_ВыполнениеКомандыЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале_ВыполнениеКомандыЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале_ВыполнениеКомандыЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале_ПечатьЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале_ПечатьЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеСверкиИтоговНаЭквайринговомТерминале_ПечатьЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## ПараметрыВыполненияЭквайринговойОперации +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров выполнения эквайринговой операции. +// +Функция ПараметрыВыполненияЭквайринговойОперации() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПараметрыВыполненияЭквайринговойОперации() Экспорт;); +``` +
+ +## НачатьВыполнениеОперацииНаЭквайринговомТерминале +
+ +Описание, пример вызова + +```bsl + +// Выполнить операции на эквайринговом терминале. +// Если эквайринговый терминал не поддерживает печать квитанций на терминале, для печати подключается печатающее устройство. +// +Процедура НачатьВыполнениеОперацииНаЭквайринговомТерминале(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройстваЭТ = Неопределено, ИдентификаторУстройстваПУ = Неопределено, ПараметрыОперации = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеОперацииНаЭквайринговомТерминале(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройстваЭТ, ИдентификаторУстройстваПУ, ПараметрыОперации); +``` +
+ +## НачатьВыполнениеОперацииНаЭквайринговомТерминале_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеОперацииНаЭквайринговомТерминале_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеОперацииНаЭквайринговомТерминале_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьВыполнениеОперацииНаЭквайринговомТерминале_ВыполнениеКомандыЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеОперацииНаЭквайринговомТерминале_ВыполнениеКомандыЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеОперацииНаЭквайринговомТерминале_ВыполнениеКомандыЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьВыполнениеОперацииНаЭквайринговомТерминале_ПослеЗакрытияВопроса +
+ +Описание, пример вызова + +```bsl + +// Начинает выполнение операции на эквайринговом терминале. +// +// Параметры: +// Результат +// РезультатВыполнения - Структура - где: +// *Параметры - Структура - . +Процедура НачатьВыполнениеОперацииНаЭквайринговомТерминале_ПослеЗакрытияВопроса(Результат, РезультатВыполнения) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеОперацииНаЭквайринговомТерминале_ПослеЗакрытияВопроса(Результат, РезультатВыполнения) +``` +
+ +## НачатьВыполнениеОперацииНаЭквайринговомТерминале_ПечатьЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеОперацииНаЭквайринговомТерминале_ПечатьЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеОперацииНаЭквайринговомТерминале_ПечатьЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьВыполнениеОперацииНаЭквайринговомТерминале_ОшибкаПечатиЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеОперацииНаЭквайринговомТерминале_ОшибкаПечатиЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеОперацииНаЭквайринговомТерминале_ОшибкаПечатиЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьВыводИнформацииНаДисплейПокупателя +
+ +Описание, пример вызова + +```bsl + +// Начать вывод тестовых строк на подключенные дисплеи покупателя. +// +Процедура НачатьВыводИнформацииНаДисплейПокупателя(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено, СтрокиТекста = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыводИнформацииНаДисплейПокупателя(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства, СтрокиТекста); +``` +
+ +## НачатьОчисткуДисплеяПокупателя +
+ +Описание, пример вызова + +```bsl + +// Начать очистку подключенных дисплеев покупателя. +// +Процедура НачатьОчисткуДисплеяПокупателя(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОчисткуДисплеяПокупателя(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства); +``` +
+ +## НачатьОперациюНаДисплейПокупателя_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОперациюНаДисплейПокупателя_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОперациюНаДисплейПокупателя_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьЗагрузкуДанныеИзТСД +
+ +Описание, пример вызова + +```bsl + +// Начать загрузку данных из терминала сбора данных. +// +Процедура НачатьЗагрузкуДанныеИзТСД(ОповещениеПриЗавершении, УникальныйИдентификатор, СворачиватьДанные = Ложь) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьЗагрузкуДанныеИзТСД(ОповещениеПриЗавершении, УникальныйИдентификатор, СворачиватьДанные); +``` +
+ +## НачатьЗагрузкуДанныеИзТСД_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьЗагрузкуДанныеИзТСД_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьЗагрузкуДанныеИзТСД_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьЗагрузкуДанныеИзТСД_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьЗагрузкуДанныеИзТСД_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьЗагрузкуДанныеИзТСД_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьЗагрузкуДанныеИзТСД_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьЗагрузкуДанныеИзТСД_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьЗагрузкуДанныеИзТСД_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьВыгрузкуДанныеВТСД +
+ +Описание, пример вызова + +```bsl + +// Начать выгрузку данных в терминал сбора данных. +// +Процедура НачатьВыгрузкуДанныеВТСД(ОповещениеПриЗавершении, УникальныйИдентификатор, ТаблицаВыгрузкиТоваров, ПолнаяВыгрузка = Истина) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыгрузкуДанныеВТСД(ОповещениеПриЗавершении, УникальныйИдентификатор, ТаблицаВыгрузкиТоваров, ПолнаяВыгрузка); +``` +
+ +## НачатьВыгрузкуДанныеВТСД_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыгрузкуДанныеВТСД_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыгрузкуДанныеВТСД_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьВыгрузкуДанныеВТСД_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +// Начинает выгрузку данных в ТСД. +// +// Параметры: +// РезультатПодключения - Структура - структура результата подключения. +// Параметры - Структура - где: +// *ТаблицаВыгрузкиТоваров - ТаблицаЗначений - где: +// **Наименование - Строка - . +Процедура НачатьВыгрузкуДанныеВТСД_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыгрузкуДанныеВТСД_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьВыгрузкуДанныеВТСД_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыгрузкуДанныеВТСД_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыгрузкуДанныеВТСД_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьОчисткуДанныеВТСД +
+ +Описание, пример вызова + +```bsl + +// Начать очистку данных в терминале сбора данных. +// +Процедура НачатьОчисткуДанныеВТСД(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОчисткуДанныеВТСД(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства); +``` +
+ +## НачатьОчисткуДанныеВТСД_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОчисткуДанныеВТСД_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОчисткуДанныеВТСД_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьОчисткуДанныеВТСД_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОчисткуДанныеВТСД_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОчисткуДанныеВТСД_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьОчисткуДанныеВТСД_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОчисткуДанныеВТСД_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОчисткуДанныеВТСД_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьПолученияВесаСЭлектронныхВесов +
+ +Описание, пример вызова + +```bsl + +// Получает вес с электронных весов. +// УникальныйИдентификатор - идентификатор формы. +// ОповещениеПриЗавершении - оповещение при завершении взвешивании и передачи веса. +// +Процедура НачатьПолученияВесаСЭлектронныхВесов(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено, ОтображатьСообщения = Ложь) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПолученияВесаСЭлектронныхВесов(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства, ОтображатьСообщения); +``` +
+ +## НачатьПолученияВесаСЭлектронныхВесов_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПолученияВесаСЭлектронныхВесов_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПолученияВесаСЭлектронныхВесов_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьПолученияВесаСЭлектронныхВесов_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПолученияВесаСЭлектронныхВесов_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПолученияВесаСЭлектронныхВесов_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьПолученияВесаСЭлектронныхВесов_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПолученияВесаСЭлектронныхВесов_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПолученияВесаСЭлектронныхВесов_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьУстановкуВесаТары +
+ +Описание, пример вызова + +```bsl + +// Начать установку веса тары на электронных весах. +// УникальныйИдентификатор - идентификатор формы. +// ОповещениеПриЗавершении - оповещение при завершении взвешивании и передачи веса. +// +Процедура НачатьУстановкуВесаТары(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено, Вес = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьУстановкуВесаТары(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства, Вес); +``` +
+ +## НачатьУстановкуВесаТары_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьУстановкуВесаТары_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьУстановкуВесаТары_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьУстановкуВесаТары_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьУстановкуВесаТары_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьУстановкуВесаТары_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьУстановкуВесаТары_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьУстановкуВесаТары_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьУстановкуВесаТары_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьПечатьЭтикеток +
+ +Описание, пример вызова + +```bsl + +// Начать печать этикеток. +// +Процедура НачатьПечатьЭтикеток(ОповещениеПриЗавершенииПечати, УникальныйИдентификатор, ОписаниеЭтикеткиВXML, ДанныеДляПечати, ИдентификаторУстройства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПечатьЭтикеток(ОповещениеПриЗавершенииПечати, УникальныйИдентификатор, ОписаниеЭтикеткиВXML, ДанныеДляПечати, ИдентификаторУстройства); +``` +
+ +## НачатьПечатьЭтикеток_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПечатьЭтикеток_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПечатьЭтикеток_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьПечатьЭтикеток_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПечатьЭтикеток_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПечатьЭтикеток_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьПечатьЭтикеток_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьПечатьЭтикеток_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьПечатьЭтикеток_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьИнициализацияПринтераЭтикеток +
+ +Описание, пример вызова + +```bsl + +// Начать инициализацию принтера этикеток. +// +Процедура НачатьИнициализацияПринтераЭтикеток(ОповещениеПриЗавершенииПечати, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьИнициализацияПринтераЭтикеток(ОповещениеПриЗавершенииПечати, УникальныйИдентификатор, ИдентификаторУстройства); +``` +
+ +## НачатьИнициализацияПринтераЭтикеток_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьИнициализацияПринтераЭтикеток_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьИнициализацияПринтераЭтикеток_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьИнициализацияПринтераЭтикеток_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьИнициализацияПринтераЭтикеток_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьИнициализацияПринтераЭтикеток_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьИнициализацияПринтераЭтикеток_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьИнициализацияПринтераЭтикеток_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьИнициализацияПринтераЭтикеток_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьРедактированиеМакета +
+ +Описание, пример вызова + +```bsl + +// Начать редактирование макета. +// +Процедура НачатьРедактированиеМакета(ОповещениеПриЗавершенииРедактирования, ОписаниеЭтикеткиВXML, АдресХранилищаСКД) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьРедактированиеМакета(ОповещениеПриЗавершенииРедактирования, ОписаниеЭтикеткиВXML, АдресХранилищаСКД) +``` +
+ +## НачатьРедактированиеМакета_Завершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьРедактированиеМакета_Завершение(Результат, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьРедактированиеМакета_Завершение(Результат, ДополнительныеПараметры) +``` +
+ +## НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток +
+ +Описание, пример вызова + +```bsl + +// Начать выгрузку данных в терминал сбора данных. +// +Процедура НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток(ОповещениеПриЗавершении, УникальныйИдентификатор, ТаблицаВыгрузкиТоваров, ИдентификаторУстройства = Неопределено, ЧастичнаяВыгрузка = Ложь, ОтображатьСообщения = Ложь) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток(ОповещениеПриЗавершении, УникальныйИдентификатор, ТаблицаВыгрузкиТоваров, ИдентификаторУстройства, ЧастичнаяВыгрузка, ОтображатьСообщения); +``` +
+ +## НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ФайловоеРасширениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ФайловоеРасширениеЗавершение(Подключено, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ФайловоеРасширениеЗавершение(Подключено, Параметры) +``` +
+ +## НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыгрузкуДанныеВВесыСПечатьюЭтикеток_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьОчисткуТоваровВВесахСПечатьюЭтикеток +
+ +Описание, пример вызова + +```bsl + +// Начать очистку товаров в весах с печатью этикеток. +// +Процедура НачатьОчисткуТоваровВВесахСПечатьюЭтикеток(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено, ОтображатьСообщения = Ложь) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОчисткуТоваровВВесахСПечатьюЭтикеток(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства, ОтображатьСообщения); +``` +
+ +## НачатьОчисткуТоваровВВесахСПечатьюЭтикеток_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОчисткуТоваровВВесахСПечатьюЭтикеток_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОчисткуТоваровВВесахСПечатьюЭтикеток_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьОчисткуТоваровВВесахСПечатьюЭтикеток_ПодключениеЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОчисткуТоваровВВесахСПечатьюЭтикеток_ПодключениеЗавершение(РезультатПодключения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОчисткуТоваровВВесахСПечатьюЭтикеток_ПодключениеЗавершение(РезультатПодключения, Параметры) +``` +
+ +## НачатьОчисткуТоваровВВесахСПечатьюЭтикеток_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОчисткуТоваровВВесахСПечатьюЭтикеток_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОчисткуТоваровВВесахСПечатьюЭтикеток_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## ПараметрыЗаписиМеткиRFID +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров записи метки RFID. +// +Функция ПараметрыЗаписиМеткиRFID() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПараметрыЗаписиМеткиRFID() Экспорт;); +``` +
+ +## НачатьОткрытиеСессииСчитывателяRFID +
+ +Описание, пример вызова + +```bsl + +// Начать открытие сессии считывателя RFID. +// +Процедура НачатьОткрытиеСессииСчитывателяRFID(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОткрытиеСессииСчитывателяRFID(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства); +``` +
+ +## НачатьОткрытиеСессииСчитывателяRFID_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьОткрытиеСессииСчитывателяRFID_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьОткрытиеСессииСчитывателяRFID_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьЗакрытиеСессииСчитывателяRFID +
+ +Описание, пример вызова + +```bsl + +// Начать закрытие сессии считывателя RFID. +// +Процедура НачатьЗакрытиеСессииСчитывателяRFID(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьЗакрытиеСессииСчитывателяRFID(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства); +``` +
+ +## НачатьЗакрытиеСессииСчитывателяRFID_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьЗакрытиеСессииСчитывателяRFID_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьЗакрытиеСессииСчитывателяRFID_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## НачатьЗаписьДанныхВМеткуRFID +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьЗаписьДанныхВМеткуRFID(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства, ПараметрыЗаписи, Таймаут = 0) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьЗаписьДанныхВМеткуRFID(ОповещениеПриЗавершении, УникальныйИдентификатор, ИдентификаторУстройства, ПараметрыЗаписи, Таймаут); +``` +
+ +## НачатьЗаписьДанныхВМеткуRFID_ВыбратьУстройствоЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьЗаписьДанныхВМеткуRFID_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьЗаписьДанныхВМеткуRFID_ВыбратьУстройствоЗавершение(ИдентификаторУстройства, Параметры) +``` +
+ +## НачатьЗаписьДанныхВМеткуRFID_ВыполнитьКомандуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьЗаписьДанныхВМеткуRFID_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьЗаписьДанныхВМеткуRFID_ВыполнитьКомандуЗавершение(РезультатВыполнения, Параметры) +``` +
+ +## ПолучитьСодержаниеТекстовыхФайлов +
+ +Описание, пример вызова + +```bsl + +// Процедура получения содержания текстовых файлов. +// Параметры: +// ИменаФайлов - Строка, Массив - имя файла или массив с именами файлов. +// ОписаниеОповещенияПриЗавершении - ОписаниеОповещения - вызывается после завершения чтения файлов. +// Кодировка - КодировкаТекста - кодировка при чтении текстового файла, по умолчанию КодировкаТекста.UTF8. +// +Процедура ПолучитьСодержаниеТекстовыхФайлов(ИменаФайлов, ОписаниеОповещенияПриЗавершении, Кодировка = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПолучитьСодержаниеТекстовыхФайлов(ИменаФайлов, ОписаниеОповещенияПриЗавершении, Кодировка); +``` +
+ +## ПолучитьСодержаниеТекстовыхФайловЗавершение +
+ +Описание, пример вызова + +```bsl + +// Процедура оповещения получения содержания текстовых файлов. +// Вызывается из процедуры ПолучитьСодержаниеТекстовыхФайлов. +// +Процедура ПолучитьСодержаниеТекстовыхФайловЗавершение(ПомещенныеФайлы, ДополнительныеПараметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПолучитьСодержаниеТекстовыхФайловЗавершение(ПомещенныеФайлы, ДополнительныеПараметры) +``` +
+ +## ПредложитьВыбратьСмену +
+ +Описание, пример вызова + +```bsl + +Процедура ПредложитьВыбратьСмену(ОповещениеВыбора, ТекстЗаголовкаВыбора, Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПредложитьВыбратьСмену(ОповещениеВыбора, ТекстЗаголовкаВыбора, ); +``` +
+ +## ПредложитьВыбратьСменуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура ПредложитьВыбратьСменуЗавершение(Результат, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.ПредложитьВыбратьСменуЗавершение(Результат, Параметры) +``` +
+ +## НачатьВыполнениеКоманды_ВыбратьСменуЗавершение +
+ +Описание, пример вызова + +```bsl + +Процедура НачатьВыполнениеКоманды_ВыбратьСменуЗавершение(СтруктураПараметровСмены, Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиент.НачатьВыполнениеКоманды_ВыбратьСменуЗавершение(СтруктураПараметровСмены, Параметры) +``` +
+ +## ПреобразоватьДанныеСоСканераВМассив +
+ +Описание, пример вызова + +```bsl + +Функция ПреобразоватьДанныеСоСканераВМассив(Параметр) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПреобразоватьДанныеСоСканераВМассив(Параметр) +``` +
+ +## ПреобразоватьДанныеСоСканераВСтруктуру +
+ +Описание, пример вызова + +```bsl + +Функция ПреобразоватьДанныеСоСканераВСтруктуру(Параметр) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиент.ПреобразоватьДанныеСоСканераВСтруктуру(Параметр) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МенеджерОборудованияКлиентПереопределяемый.md b/src/content/docs/zup/МенеджерОборудованияКлиентПереопределяемый.md new file mode 100644 index 0000000..e65a3ed --- /dev/null +++ b/src/content/docs/zup/МенеджерОборудованияКлиентПереопределяемый.md @@ -0,0 +1,304 @@ +--- +title: Менеджер оборудования клиент переопределяемый +slug: zup/менеджер-оборудования-клиент-переопределяемый +--- + + +## ДатаСеанса +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущую дату, приведенную к часовому поясу сеанса. +// Предназначена для использования вместо функции ТекущаяДата(). +// +// Возвращаемое значение: +// Результат - текущая дата. +// +Функция ДатаСеанса() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПереопределяемый.ДатаСеанса() +``` +
+ +## ПолучитьОбработчикДрайвера +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает объект обработчика драйвера по его наименованию. +// +// Параметры: +// ОбработчикДрайвера - Перечисление, ссылка на обработчик драйвера подключаемого оборудования. +// ЗагружаемыйДрайвер - Булево, признак, что драйвер загружаемый +// ТипОборудованияИмя - Строка, представление типа оборудования +// +// Возвращаемое значение: +// Результат - Используемый модуль обработчика драйвера. +// +Функция ПолучитьОбработчикДрайвера(ОбработчикДрайвера, ЗагружаемыйДрайвер, ТипОборудованияИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПереопределяемый.ПолучитьОбработчикДрайвера(ОбработчикДрайвера, ЗагружаемыйДрайвер, ТипОборудованияИмя) +``` +
+ +## НачатьОтправкуЭлектронногоЧека +
+ +Описание, пример вызова + +```bsl + +// Процедура отправляет электронное сообщение на электронную почта и абонентский номер. +// +Процедура НачатьОтправкуЭлектронногоЧека(ПараметрыЧека, ТекстСообщения, ПокупательEmail, ПокупательНомер) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.НачатьОтправкуЭлектронногоЧека(ПараметрыЧека, ТекстСообщения, ПокупательEmail, ПокупательНомер) +``` +
+ +## НачатьРассылкуНефискальныхДокументов +
+ +Описание, пример вызова + +```bsl + +// Начинает рассылку или ставит задачу на рассылку нефискальных документов. +// Которые заданы в шаблоне чека. +Процедура НачатьРассылкуНефискальныхДокументов(Параметры) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.НачатьРассылкуНефискальныхДокументов(Параметры) +``` +
+ +## ДоступноеККТДляФискализации +
+ +Описание, пример вызова + +```bsl + +// Переопределяет доступное ККТ для фискализации чека +// Параметры: +// РеквизитыЧека - Структура - реквизиты фискального чека +// СписокУстройств - Массив - список доступных ККТ для фискализации +// ИдентификаторУстройстваККТ - Ссылка - выбранное ККТ для фискализации +// +Процедура ДоступноеККТДляФискализации(РеквизитыЧека, СписокУстройств, ИдентификаторУстройстваККТ) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.ДоступноеККТДляФискализации(РеквизитыЧека, СписокУстройств, ИдентификаторУстройстваККТ) +``` +
+ +## ЭкземплярОборудованияПриОткрытии +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ПриОткрытии". +// +// Параметры: +// Объект - СправочникОбъект.ПодключаемоеОборудование - объект подключаемого оборудования. +// ЭтаФорма - ФормаКлиентскогоПриложения - форма владелец. +// Отказ - Булево - признак отказа. +// +Процедура ЭкземплярОборудованияПриОткрытии(Объект, ЭтаФорма, Отказ) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.ЭкземплярОборудованияПриОткрытии(Объект, ЭтаФорма, Отказ) +``` +
+ +## ЭкземплярОборудованияПередЗакрытием +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ПередЗакрытием". +// +// +// Параметры: +// Объект - СправочникОбъект.ПодключаемоеОборудование - объект подключаемого оборудования. +// ЭтаФорма - ФормаКлиентскогоПриложения - форма владелец. +// Отказ - Булево - признак отказа. +// СтандартнаяОбработка - Булево - признак стандартной обработки. +// +Процедура ЭкземплярОборудованияПередЗакрытием(Объект, ЭтаФорма, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.ЭкземплярОборудованияПередЗакрытием(Объект, ЭтаФорма, Отказ, СтандартнаяОбработка) +``` +
+ +## ЭкземплярОборудованияПередЗаписью +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ПередЗаписью". +// +// Параметры: +// Объект - СправочникОбъект.ПодключаемоеОборудование - объект подключаемого оборудования. +// ЭтаФорма - ФормаКлиентскогоПриложения - форма владелец. +// Отказ - Булево - признак отказа. +// ПараметрыЗаписи - Структура - параметры записи оборудования. +// +Процедура ЭкземплярОборудованияПередЗаписью(Объект, ЭтаФорма, Отказ, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.ЭкземплярОборудованияПередЗаписью(Объект, ЭтаФорма, Отказ, ПараметрыЗаписи) +``` +
+ +## ЭкземплярОборудованияПослеЗаписи +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ПослеЗаписи". +// +// Параметры: +// Объект - СправочникОбъект.ПодключаемоеОборудование - объект подключаемого оборудования. +// ЭтаФорма - ФормаКлиентскогоПриложения - форма владелец. +// ПараметрыЗаписи - Структура - параметры записи оборудования. +// +Процедура ЭкземплярОборудованияПослеЗаписи(Объект, ЭтаФорма, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.ЭкземплярОборудованияПослеЗаписи(Объект, ЭтаФорма, ПараметрыЗаписи) +``` +
+ +## ЭкземплярОборудованияОбработкаНавигационнойСсылки +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ОбработкаНавигационнойСсылки". +// +// Параметры: +// Объект - СправочникОбъект.ПодключаемоеОборудование - объект подключаемого оборудования. +// ЭтаФорма - ФормаКлиентскогоПриложения - форма владелец. +// НавигационнаяСсылкаФорматированнойСтроки - НавигационнаяСсылка - навигационная ссылка. +// СтандартнаяОбработка - Булево - признак стандартной обработки. +// +Процедура ЭкземплярОборудованияОбработкаНавигационнойСсылки(Объект, ЭтаФорма, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.ЭкземплярОборудованияОбработкаНавигационнойСсылки(Объект, ЭтаФорма, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) +``` +
+ +## ЭкземплярОборудованияТипОборудованияВыбор +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Экземпляре оборудования +// при событии "ТипОборудованияОбработкаВыбора". +// +// Параметры: +// Объект - СправочникОбъект.ПодключаемоеОборудование - объект подключаемого оборудования. +// ЭтаФорма - ФормаКлиентскогоПриложения - форма владелец. +// ЭтотОбъект - СправочникОбъект.ПодключаемоеОборудование - текущий объект подключаемого оборудования. +// Элемент - Элемент - изменяемый элемент. +// ВыбранноеЗначение - ПеречислениеСсылка.ТипыПодключаемогоОборудования - выбранное значение. +// +Процедура ЭкземплярОборудованияТипОборудованияВыбор(Объект, ЭтаФорма, ЭтотОбъект, Элемент, ВыбранноеЗначение) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.ЭкземплярОборудованияТипОборудованияВыбор(Объект, ЭтаФорма, ЭтотОбъект, Элемент, ВыбранноеЗначение) +``` +
+ +## ФормаЗаписиФискальныеОперацииОбработкаНавигационнойСсылки +
+ +Описание, пример вызова + +```bsl + +// Дополнительные переопределяемые действия с управляемой формой в Фискальные операции +// при событии "ОбработкаНавигационнойСсылки". +// +Процедура ФормаЗаписиФискальныеОперацииОбработкаНавигационнойСсылки(Запись, ЭтаФорма, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.ФормаЗаписиФискальныеОперацииОбработкаНавигационнойСсылки(Запись, ЭтаФорма, НавигационнаяСсылкаФорматированнойСтроки, СтандартнаяОбработка) +``` +
+ +## ОбработатьСобытие +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработатьСобытие() Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентПереопределяемый.ОбработатьСобытие() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МенеджерОборудованияКлиентПовтИсп.md b/src/content/docs/zup/МенеджерОборудованияКлиентПовтИсп.md new file mode 100644 index 0000000..cf9094e --- /dev/null +++ b/src/content/docs/zup/МенеджерОборудованияКлиентПовтИсп.md @@ -0,0 +1,284 @@ +--- +title: Менеджер оборудования клиент повт исп +slug: zup/менеджер-оборудования-клиент-повт-исп +--- + + +## ПолучитьОбработчикДрайвера +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает объект обработчика драйвера по его наименованию. +// +// Параметры: +// ОбработчикДрайвера +// ЗагружаемыйДрайвер +// ТипОборудованияИмя +// Возвращаемое значение: +// +Функция ПолучитьОбработчикДрайвера(ОбработчикДрайвера, ЗагружаемыйДрайвер, ТипОборудованияИмя) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.ПолучитьОбработчикДрайвера(ОбработчикДрайвера, ЗагружаемыйДрайвер, ТипОборудованияИмя) +``` +
+ +## ОборудованиеПоПараметрам +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает список подключенного в справочнике ПО +// +// Параметры: +// ТипыПО - Неопределено - Описание. +// Идентификатор - Неопределено - Описание. +// РабочееМесто - Неопределено - Описание. +// Возвращаемое значение: +// Массив из Структура - содержит: +// *Наименование - Строка - . +Функция ОборудованиеПоПараметрам(ТипыПО = Неопределено, Идентификатор = Неопределено, Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.ОборудованиеПоПараметрам(ТипыПО, Идентификатор, ); +``` +
+ +## ПолучитьПараметрыУстройства +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру параметров конкретного экземпляра устройства. +// При первом обращении получает из БД сохраненные ранее параметры. +Функция ПолучитьПараметрыУстройства(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.ПолучитьПараметрыУстройства(Идентификатор) +``` +
+ +## ПолучитьДанныеУстройства +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает структуру с данными устройства +// (со значениями реквизитов элемента справочника). +// +// Параметры: +// Идентификатор - СправочникСсылка.ПодключаемоеОборудование - . +// Возвращаемое значение: +// Структура - Описание: +// *ОбработчикДрайвераИмя - Строка - имя драйвера. +// *ОбработчикДрайвера - Строка - обработчик драйвера. +// *ИмяКомпьютера - Строка - наименование компьютера. +// *РабочееМесто - СправочникСсылка.РабочиеМеста - рабочее место. +// *Параметры - Структура - структура с полями: +// **ДатаНачала - Дата - . +// **ДатаОкончания - Дата - . +// **ПериодВыгрузки - Структура - структура с полями: +// ***ДатаНачала - Дата - дата начала загрузки. +// ***ДатаОкончания - Дата - дата окончания загрузки. +// *ИмяФайлаДрайвера - Строка - имя файла драйвера. +// *ИмяМакетаДрайвера - Строка - имя макета драйвера. +// *ПоставляетсяДистрибутивом - Булево - признак поставки дистрибутивом. +// *ИдентификаторОбъекта - Строка - идентификатор объекта строкой. +// *ВСоставеКонфигурации - Булево - признак поставке в составе конфигурации. +// *ДрайверОборудованияИмя - Строка - драйвер оборудования строкой. +// *ДрайверОборудования - СправочникСсылка.ДрайверОборудования - драйвер оборудования. +// *ТипОборудованияИмя - Строка - тип опоборудования строкой. +// *ТипОборудования - ПеречислениеСсылка.ТипыПодключаемогоОборудования - тип оборудования. +// *Наименование - Строка - наименование оборудования. +// *ИдентификаторУстройства - Строка - идентификатор устройства. +// *Ссылка - СправочникСсылка.ПодключаемоеОборудование - экземпляр подключаемого оборудования. +// +Функция ПолучитьДанныеУстройства(Идентификатор) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.ПолучитьДанныеУстройства(Идентификатор) +``` +
+ +## ПолучитьРабочееМестоКлиента +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя компьютера клиента. +// При первом обращении получает имя компьютера из переменной сеанса. +Функция ПолучитьРабочееМестоКлиента() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.ПолучитьРабочееМестоКлиента() +``` +
+ +## НайтиРабочиеМестаПоИД +
+ +Описание, пример вызова + +```bsl + +// Возвращает имя компьютера клиента. +// При первом обращении получает имя компьютера из переменной сеанса. +Функция НайтиРабочиеМестаПоИД(ИдентификаторКлиента) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.НайтиРабочиеМестаПоИД(ИдентификаторКлиента) +``` +
+ +## РевизияИнтерфейсаДрайверов +
+ +Описание, пример вызова + +```bsl + +// Получает ревизию требований для драйверов подключаемого оборудования. +// +Функция РевизияИнтерфейсаДрайверов() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.РевизияИнтерфейсаДрайверов() +``` +
+ +## КодРасчетаДенежнымиСредствами +
+ +Описание, пример вызова + +```bsl + +// Получить код типа расчета денежными средствами. +// +Функция КодРасчетаДенежнымиСредствами(ТипРасчета) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.КодРасчетаДенежнымиСредствами(ТипРасчета) +``` +
+ +## ПодсистемаСуществует +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если "функциональная" подсистема существует в конфигурации. +// Предназначена для реализации вызова необязательной подсистемы (условного вызова). +// +// У "функциональной" подсистемы снят флажок "Включать в командный интерфейс". +// +// Параметры: +// ПолноеИмяПодсистемы - Строка - полное имя объекта метаданных подсистема +// без слов "Подсистема." ИС учетом регистра символов. +// Например: "СтандартныеПодсистемы.ВариантыОтчетов". +// +// Пример: +// +// Если ОбщегоНазначения.ПодсистемаСуществует("СтандартныеПодсистемы.ВариантыОтчетов") Тогда +// МодульВариантыОтчетов = ОбщегоНазначения.ОбщийМодуль("ВариантыОтчетов"); +// МодульВариантыОтчетов.<Имя метода>(); +// КонецЕсли; +// +// Возвращаемое значение: +// Булево. +// +Функция ПодсистемаСуществует(ПолноеИмяПодсистемы) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.ПодсистемаСуществует(ПолноеИмяПодсистемы) +``` +
+ +## ИспользуетсяПодсистемыФискальныхУстройств +
+ +Описание, пример вызова + +```bsl + +// Возвращает Истина, если используется подсистемы фискальных устройств и эти подсистемы существует в конфигурации. +// Предназначена для реализации вызова необязательной подсистемы (условного вызова). +// +// У хотя бы одной "функциональной" подсистемы включен флажок "Включать в командный интерфейс". +// +// Возвращаемое значение: +// Булево. +// +Функция ИспользуетсяПодсистемыФискальныхУстройств() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.ИспользуетсяПодсистемыФискальныхУстройств() +``` +
+ +## ОбщийМодуль +
+ +Описание, пример вызова + +```bsl + +// Возвращает ссылку на общий модуль по имени. +// +// Параметры: +// Имя - Строка - имя общего модуля, например: +// "ОбщегоНазначения", +// "ОбщегоНазначенияКлиент". +// +// Возвращаемое значение: +// ОбщийМодуль. +// +Функция ОбщийМодуль(Имя) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентПовтИсп.ОбщийМодуль(Имя) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МенеджерОборудованияКлиентСервер.md b/src/content/docs/zup/МенеджерОборудованияКлиентСервер.md new file mode 100644 index 0000000..d0ea3b5 --- /dev/null +++ b/src/content/docs/zup/МенеджерОборудованияКлиентСервер.md @@ -0,0 +1,1555 @@ +--- +title: Менеджер оборудования клиент сервер +slug: zup/менеджер-оборудования-клиент-сервер +--- + + +## ЗаполнитьНаименованиеРабочегоМеста +
+ +Описание, пример вызова + +```bsl + +// Функция заполняет наименование рабочего места клиента по имени пользователя. +// +// Параметры: +// Объект - СправочникОбъект.РабочиеМеста - рабочее место текущего сеанса. +// +Процедура ЗаполнитьНаименованиеРабочегоМеста(Объект, ИмяПользователя) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентСервер.ЗаполнитьНаименованиеРабочегоМеста(Объект, ИмяПользователя) +``` +
+ +## ОпределитьТипШтрихкода +
+ +Описание, пример вызова + +```bsl + +// Функция определяет тип штрихкода по значение кода. +// +Функция ОпределитьТипШтрихкода(Знач Штрихкод) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ОпределитьТипШтрихкода(Штрихкод) +``` +
+ +## ПолучитьСтруктуруЗаписиEPC +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает пустую структуру записи EPC. +// +// Возвращаемое значение: +// - Структура +// Результат - Результат декодирования (успешно или нет) +// EPC - Значение EPC в виде HEX строки +// EPC_BIN - Значение EPC в виде бинарной строки +// Формат - Распознанный формат данных SGTIN-96 или SGTIN-198 +// GTIN - GTIN +// СерийныйНомер - Серийный номер SGTIN +// ПрефиксКомпании - Префикс компании +// URI - EPC Tag URI +// +Функция ПолучитьСтруктуруЗаписиEPC() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПолучитьСтруктуруЗаписиEPC() +``` +
+ +## РассчитатьКонтрольныйСимволGTIN8 +
+ +Описание, пример вызова + +```bsl + +// Расчет контрольной цифры для GTIN-8. +// +// Параметры: +// GTIN - Текстовая строка с GTIN-8. Может содержать числа от 0 до 9. +// +// Возвращаемое значение: +// - Контрольный символ (число) рассчитанный по алгоритму для GTIN. +// +Функция РассчитатьКонтрольныйСимволGTIN8(Знач GTIN) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.РассчитатьКонтрольныйСимволGTIN8(GTIN) +``` +
+ +## РассчитатьКонтрольныйСимволGTIN12 +
+ +Описание, пример вызова + +```bsl + +// Расчет контрольной цифры для GTIN-12. +// +// Параметры: +// GTIN - Текстовая строка с GTIN-12. Может содержать числа от 0 до 9. +// +// Возвращаемое значение: +// - Контрольный символ (число) рассчитанный по алгоритму для GTIN. +// +Функция РассчитатьКонтрольныйСимволGTIN12(Знач GTIN) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.РассчитатьКонтрольныйСимволGTIN12(GTIN) +``` +
+ +## РассчитатьКонтрольныйСимволGTIN13 +
+ +Описание, пример вызова + +```bsl + +// Расчет контрольной цифры для GTIN-13. +// +// Параметры: +// GTIN - Текстовая строка с GTIN-13. Может содержать числа от 0 до 9. +// +// Возвращаемое значение: +// - Контрольный символ (число) рассчитанный по алгоритму для GTIN. +// +Функция РассчитатьКонтрольныйСимволGTIN13(Знач GTIN) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.РассчитатьКонтрольныйСимволGTIN13(GTIN) +``` +
+ +## РассчитатьКонтрольныйСимволGTIN14 +
+ +Описание, пример вызова + +```bsl + +// Расчет контрольной цифры для GTIN-14. +// +// Параметры: +// GTIN - Текстовая строка с GTIN-14. Может содержать числа от 0 до 9. +// +// Возвращаемое значение: +// - Контрольный символ (число) рассчитанный по алгоритму для GTIN. +// +Функция РассчитатьКонтрольныйСимволGTIN14(Знач GTIN) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.РассчитатьКонтрольныйСимволGTIN14(GTIN) +``` +
+ +## РассчитатьКонтрольныйСимволGTIN +
+ +Описание, пример вызова + +```bsl + +// Универсальная функция расчета контрольной цифры GTIN. +// GTIN допускает в формате GTIN-8, GTIN-12, GTIN-13, GTIN-14 c контрольным символом. +// +// Параметры: +// GTIN - Текстовая строка с GTIN(c контрольным символом). Может содержать числа от 0 до 9. +// +// Возвращаемое значение: +// - Контрольный символ (число) рассчитанный по алгоритму для GTIN. +// +Функция РассчитатьКонтрольныйСимволGTIN(Знач GTIN) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.РассчитатьКонтрольныйСимволGTIN(GTIN) +``` +
+ +## ПроверитьКорректностьGTIN +
+ +Описание, пример вызова + +```bsl + +// Функция проверяет корректность GTIN. +// GTIN допускает в формате GTIN-8, GTIN-12, GTIN-13, GTIN-14 c контрольным символом. +// +// Параметры: +// GTIN - Текстовая строка с GTIN(c контрольным символом). Может содержать числа от 0 до 9. +// +// Возвращаемое значение: +// - Булево +// +Функция ПроверитьКорректностьGTIN(Знач GTIN) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПроверитьКорректностьGTIN(GTIN) +``` +
+ +## ДекодированиеДанныхSGTIN +
+ +Описание, пример вызова + +```bsl + +// Декодирование данных по значение EPC(HEX строка). Поддерживается формат SGTIN-96 и SGTIN-198. +// +// Параметры: +// EPC - Строка содержащая значение банка EPC в HEX виде. +// +// Возвращаемое значение: +// - Структура +// Результат - Результат декодирования (успешно или нет) +// EPC - Значение EPC в виде HEX строки +// EPC_BIN - Значение EPC в виде бинарной строки +// Формат - Распознанный формат данных SGTIN-96 или SGTIN-198 +// GTIN - GTIN +// СерийныйНомер - Серийный номер SGTIN +// ПрефиксКомпании - Префикс компании +// URI - EPC Tag URI +// +Функция ДекодированиеДанныхSGTIN(EPC) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ДекодированиеДанныхSGTIN(EPC) +``` +
+ +## ПустойEPC +
+ +Описание, пример вызова + +```bsl + +// Функция определяет, содержит ли EPC значащую информацию (GTIN или СерийныйНомер) по формату SGTIN. +// +// Параметры: +// EPC - Строка содержащая значение банка EPC в HEX виде. +// +// Возвращаемое значение: +// - Булево +// +Функция ПустойEPC(EPC) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПустойEPC(EPC) +``` +
+ +## СформироватьДанныеSGTIN96 +
+ +Описание, пример вызова + +```bsl + +// Сформировать значение EPC в формате SGTIN-96 для GTIN и серийного номера. +// GTIN допускает в формате GTIN-8, GTIN-12, GTIN-13, GTIN-14. +// +// Параметры: +// GTIN - GTIN товарной номенклатуры. Текстовая строка с GTIN(c контрольным символом). +// СерийныйНомер - Серийный номер номенклатуры. +// Фильтр - +// +// Возвращаемое значение: +// - Строка HEX с сформированным EPC для записи на метку RFID. +// +Функция СформироватьДанныеSGTIN96(Знач GTIN, Знач СерийныйНомер, Знач Фильтр = 3) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.СформироватьДанныеSGTIN96(GTIN, СерийныйНомер, Фильтр); +``` +
+ +## ПолучитьСерийныйНомерПоTID +
+ +Описание, пример вызова + +```bsl + +// Сформировать серийный номер по правилам производителей чипов. +// +Функция ПолучитьСерийныйНомерПоTID(Знач TID, Знач EPC = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПолучитьСерийныйНомерПоTID(TID, EPC); +``` +
+ +## ПреобразоватьHEXВСтроку +
+ +Описание, пример вызова + +```bsl + +// Преобразовывает HEX строку в строку символов. +// +// Параметры: +// СтрокаHEX - Строка HEX содержащая символы. +// +// Возвращаемое значение: +// - Тестовая строка +// +Функция ПреобразоватьHEXВСтроку(Знач СтрокаHEX) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПреобразоватьHEXВСтроку(СтрокаHEX) +``` +
+ +## ПреобразоватьСтрокуВHEX +
+ +Описание, пример вызова + +```bsl + +// Преобразовывает строку символов в HEX строку. +// +// Параметры: +// Строка - Тестовая строка +// +// Возвращаемое значение: +// - СтрокаHEX - Строка HEX содержащая символы. +// +Функция ПреобразоватьСтрокуВHEX(Знач Строка) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПреобразоватьСтрокуВHEX(Строка) +``` +
+ +## ПреобразоватьHEXВБинарнуюСтроку +
+ +Описание, пример вызова + +```bsl + +// Функция - Преобразовать HEX в бинарную строку +// +// Параметры: +// СтрокаHEX - Строка HEX содержащая символы. +// +// Возвращаемое значение: +// - Текстовая строка в бинарном представлении (Пример "000010101"). +// +Функция ПреобразоватьHEXВБинарнуюСтроку(Знач СтрокаHEX) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПреобразоватьHEXВБинарнуюСтроку(СтрокаHEX) +``` +
+ +## ПреобразоватьБинарнуюСтрокуВHEX +
+ +Описание, пример вызова + +```bsl + +// Функция - Преобразовать бинарную строку ВHEX +// +// Параметры: +// БинарнаяСтрока- Текстовая строка в бинарном представлении (Пример "000010101"). +// +// Возвращаемое значение: +// - Строка HEX содержащая символы. +// +Функция ПреобразоватьБинарнуюСтрокуВHEX(Знач БинарнаяСтрока) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПреобразоватьБинарнуюСтрокуВHEX(БинарнаяСтрока) +``` +
+ +## ПреобразоватьБинарнуюСтрокуВЧисло +
+ +Описание, пример вызова + +```bsl + +// Функция - Преобразовать бинарную строку в десятичное число +// +// Параметры: +// БинарнаяСтрока - Текстовая строка в бинарном представлении (Пример "000010101"). +// +// Возвращаемое значение: +// - Десятичное число. +// +Функция ПреобразоватьБинарнуюСтрокуВЧисло(Знач БинарнаяСтрока) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПреобразоватьБинарнуюСтрокуВЧисло(БинарнаяСтрока) +``` +
+ +## ПреобразоватьЧислоВБинарнуюСтроку +
+ +Описание, пример вызова + +```bsl + +// Функция - Преобразовать десятичное число в бинарную строку +// +// Параметры: +// Число - Десятичное число которое будет преобразовано в бинарный вид. +// +// Возвращаемое значение: +// - Текстовая строка в бинарном представлении (Пример "000010101"). +// +Функция ПреобразоватьЧислоВБинарнуюСтроку(Знач Число) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПреобразоватьЧислоВБинарнуюСтроку(Число) +``` +
+ +## ИННСоответствуетТребованиям +
+ +Описание, пример вызова + +```bsl + +// Проверяет соответствие ИНН требованиям. +// +// Параметры: +// ИНН - Строка - проверяемый индивидуальный номер налогоплательщика. +// ЭтоЮридическоеЛицо - Булево - признак, является ли владелец ИНН юридическим лицом. +// ТекстСообщения - Строка - текст сообщения о найденных ошибках. +// +// Возвращаемое значение: +// Булево - Истина, если соответствует. +// +Функция ИННСоответствуетТребованиям(Знач ИНН, ЭтоЮридическоеЛицо, ТекстСообщения) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ИННСоответствуетТребованиям(ИНН, ЭтоЮридическоеЛицо, ТекстСообщения) +``` +
+ +## СформироватьТекстНефискальногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Функция формирует текст нефискального документа по шаблону. +// +// Параметры: +// ОбщиеПараметры - Структура - где: +// *ПозицииЧека - Массив из Структура - где: +// **Наименование - Строка - . +// **ДанныеПоставщика - Структура - где: +// ***Наименование - Строка - . +// **ДанныеАгента - Структура - где: +// ***ОператорПеревода - Структура - +// ****Наименование - Строка - . +// *ДанныеПоставщика - Структура - где: +// **Наименование - Строка - . +// *ДанныеАгента - Структура - где: +// ** ОператорПеревода - Структура - +// ***Наименование - Строка - . +// +// Возвращаемое значение: +// Массив - . +Функция СформироватьТекстНефискальногоДокумента(ТипДокумента, ОбщиеПараметры, ШиринаСтроки = 32, ДополнительныйТекст = Неопределено, ФорматФФД = "1.1") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.СформироватьТекстНефискальногоДокумента(ТипДокумента, ОбщиеПараметры, ШиринаСтроки, ДополнительныйТекст, ФорматФФД); +``` +
+ +## СформироватьТекстНефискальногоЧека +
+ +Описание, пример вызова + +```bsl + +// Функция формирует текст нефискального чека по шаблону. +// +Функция СформироватьТекстНефискальногоЧека(ОбщиеПараметры, ШиринаСтроки = 32, ФорматФФД = "1.1") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.СформироватьТекстНефискальногоЧека(ОбщиеПараметры, ШиринаСтроки, ФорматФФД); +``` +
+ +## ПараметрыQRКодаЧекаККТ +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает структуру параметров QR кода чека ККТ. +// +Функция ПараметрыQRКодаЧекаККТ() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыQRКодаЧекаККТ() +``` +
+ +## РасшифроватьQRКодЧекаККТ +
+ +Описание, пример вызова + +```bsl + +// Функция расшифровывает QR код для чека ККТ. Структура описана в документе ФФД в разделе 61. +// +Функция РасшифроватьQRКодЧекаККТ(ЗначениеQRКода) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.РасшифроватьQRКодЧекаККТ(ЗначениеQRКода) +``` +
+ +## СформироватьQRКодЧекаККТ +
+ +Описание, пример вызова + +```bsl + +// Функция формирует QR код для чека ККТ. Структура описана в документе ФФД в разделе 61. +// +Функция СформироватьQRКодЧекаККТ(ПараметрыQRКода) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.СформироватьQRКодЧекаККТ(ПараметрыQRКода) +``` +
+ +## КодСистемыНалогообложенияККТ +
+ +Описание, пример вызова + +```bsl + +// Получить код системы налогообложения ККТ. +// +Функция КодСистемыНалогообложенияККТ(СистемаНалогообложенияККТ) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.КодСистемыНалогообложенияККТ(СистемаНалогообложенияККТ) +``` +
+ +## СистемаНалогообложенияККТПоКоду +
+ +Описание, пример вызова + +```bsl + +// Получить систему налогообложения ККТ по коду +// +Функция СистемаНалогообложенияККТПоКоду(КодСистемыНалогообложенияККТ) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.СистемаНалогообложенияККТПоКоду(КодСистемыНалогообложенияККТ) +``` +
+ +## НаименованиеСистемыНалогообложения +
+ +Описание, пример вызова + +```bsl + +// Получить наименование системы налогообложения по коду. +// +Функция НаименованиеСистемыНалогообложения(СистемаНалогообложения, Кратко = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.НаименованиеСистемыНалогообложения(СистемаНалогообложения, Кратко); +``` +
+ +## КодРасчетаДенежнымиСредствами +
+ +Описание, пример вызова + +```bsl + +// Получить код расчета денежными средствами. +// +Функция КодРасчетаДенежнымиСредствами(ТипРасчета) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.КодРасчетаДенежнымиСредствами(ТипРасчета) +``` +
+ +## РасчетДенежнымиСредствамиПоКоду +
+ +Описание, пример вызова + +```bsl + +// Получить типа расчета денежными средствами по коду. +// +Функция РасчетДенежнымиСредствамиПоКоду(КодПризнакаРасчета) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.РасчетДенежнымиСредствамиПоКоду(КодПризнакаРасчета) +``` +
+ +## КодПризнакаСпособаРасчета +
+ +Описание, пример вызова + +```bsl + +// Получить код признака способа расчета. +// +Функция КодПризнакаСпособаРасчета(ПризнакСпособаРасчета) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.КодПризнакаСпособаРасчета(ПризнакСпособаРасчета) +``` +
+ +## ПризнакСпособаРасчетаПоКоду +
+ +Описание, пример вызова + +```bsl + +// Получить признак способа расчета по коду. +// +Функция ПризнакСпособаРасчетаПоКоду(КодПризнакаСпособаРасчета) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПризнакСпособаРасчетаПоКоду(КодПризнакаСпособаРасчета) +``` +
+ +## НаименованиеПризнакаСпособаРасчета +
+ +Описание, пример вызова + +```bsl + +// Получить наименование признака способа расчета по коду. +// +Функция НаименованиеПризнакаСпособаРасчета(ПризнакСпособаРасчета) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.НаименованиеПризнакаСпособаРасчета(ПризнакСпособаРасчета) Экспорт;); +``` +
+ +## КодПризнакаПредметаРасчета +
+ +Описание, пример вызова + +```bsl + +// Получить код признака способа расчета. +// +Функция КодПризнакаПредметаРасчета(ПризнакПредметаРасчета, РевизияИнтерфейса = 0) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.КодПризнакаПредметаРасчета(ПризнакПредметаРасчета, РевизияИнтерфейса); +``` +
+ +## ПризнакПредметаРасчетаПоКоду +
+ +Описание, пример вызова + +```bsl + +// Получить признак способа расчета по коду. +// +Функция ПризнакПредметаРасчетаПоКоду(КодПризнакаПредметаРасчета) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПризнакПредметаРасчетаПоКоду(КодПризнакаПредметаРасчета) +``` +
+ +## КодПризнакаАгента +
+ +Описание, пример вызова + +```bsl + +// Получить признак агента по коду. +// +Функция КодПризнакаАгента(КодПризнакаАгента) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.КодПризнакаАгента(КодПризнакаАгента) +``` +
+ +## ПризнакАгентаПоКоду +
+ +Описание, пример вызова + +```bsl + +// Получить код типа признака агента. +// +Функция ПризнакАгентаПоКоду(ПризнакАгента) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПризнакАгентаПоКоду(ПризнакАгента) +``` +
+ +## КодПричиныИзмененияСведенийККТ +
+ +Описание, пример вызова + +```bsl + +// Получить код причины изменения сведений о ККТ. +// +Функция КодПричиныИзмененияСведенийККТ(ПричинаИзмененияСведенийККТ) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.КодПричиныИзмененияСведенийККТ(ПричинаИзмененияСведенийККТ) +``` +
+ +## КодТипаМаркировкиККТ +
+ +Описание, пример вызова + +```bsl + +// Получить код типа маркировки ККТ по коду. +// +Функция КодТипаМаркировкиККТ(ТипМаркировкиККТ) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.КодТипаМаркировкиККТ(ТипМаркировкиККТ) +``` +
+ +## ТипМаркировкиККТПоКоду +
+ +Описание, пример вызова + +```bsl + +// Получить код типа маркировки ККТ. +// +Функция ТипМаркировкиККТПоКоду(КодТипМаркировкиККТ) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ТипМаркировкиККТПоКоду(КодТипМаркировкиККТ) +``` +
+ +## ПараметрыФискальногоНакопителяОбщие +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру общих параметров фискального накопителя. +// +Функция ПараметрыФискальногоНакопителяОбщие() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыФискальногоНакопителяОбщие() +``` +
+ +## ПараметрыРегистрацииККТ +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров регистрации ККТ. +// +Функция ПараметрыРегистрацииККТ() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыРегистрацииККТ() +``` +
+ +## ПараметрыОперацииФискализацииНакопителя +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров Фискализации ФН. +// +Функция ПараметрыОперацииФискализацииНакопителя() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыОперацииФискализацииНакопителя() +``` +
+ +## ПараметрыВыполненияОперации +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров выполнения операции. +// +Функция ПараметрыВыполненияОперации() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыВыполненияОперации() Экспорт;); +``` +
+ +## ПараметрыДанныеАгента +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру данных агента. +// +// Описание +// +// Возвращаемое значение: +// Структура - Описание: +// * ОператорПоПриемуПлатежей - Структура -: +// ** Телефон - Неопределено - +// * ОператорПеревода - Структура - структура данных с полями: +// ** Телефон - Строка - +// ** Наименование - Строка - +// ** Адрес - Строка - +// ** ИНН - Строка - +// * ПлатежныйАгент - Структура - структура данных с полями: +// ** Операция - Строка - +// ** Телефон - Строка - +// +Функция ПараметрыДанныеАгента() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыДанныеАгента() +``` +
+ +## ПараметрыДанныеПоставщика +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру данных поставщика. +// +// Возвращаемое значение: +// Структура - Описание: +// * ИНН +// * Наименование +// * Телефон +Функция ПараметрыДанныеПоставщика() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыДанныеПоставщика() +``` +
+ +## ПараметрыДанныеКодаТоварнойНоменклатуры +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру данных кода товарной номенклатуры. +// +Функция ПараметрыДанныеКодаТоварнойНоменклатуры() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыДанныеКодаТоварнойНоменклатуры() +``` +
+ +## ПараметрыДополнительногоРеквизитаПользователя +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру дополнительного реквизита пользователя. +// +Функция ПараметрыДополнительногоРеквизитаПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыДополнительногоРеквизитаПользователя() +``` +
+ +## ПараметрыОперацииФискализацииЧека +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров операции фискализации чека. +// +// Возвращаемое значение: +// Структура - Описание: +// * ДанныеКоррекции - Структура -: +// ** НомерПредписания +// ** ДатаКоррекции +// ** ОписаниеКоррекции +// ** ТипКоррекции - Число - +// * НеприменениеККТ - Булево - +// * КорректируемыйДокумент +// * ЕстьПерсональныеДанные - Булево - +// * ИндивидуальныйРежимПодготовкиДанныхКПередачеВОФД - Булево - +// * ДопустимоеРасхождениеФорматноЛогическогоКонтроля - Число - +// * СпособФорматноЛогическогоКонтроля - Неопределено - +// * СформироватьЧекКоррекции - Булево - +// * ДополнительныйРеквизитПользователя - Структура -: +// ** Значение +// ** Наименование +// * ДополнительныйРеквизит - Неопределено - +// * НефискальныеДокументы - Массив - +// * КассаККМ +// * ШаблонЧека +// * ТаблицаОплат - Массив - +// * ПозицииЧека - Массив - +// * КопийЧека - Число - +// * ТекстПодвала - Строка - +// * ТекстШапки - Строка - +// * ДатаВремя - Дата - +// * НомерСмены +// * НомерЧека +// * НомерКассы +// * НаименованиеМагазина +// * АдресМагазина +// * ОрганизацияКПП +// * ОрганизацияИНН +// * ОрганизацияНазвание +// * СерийныйНомер +// * ПолучательИНН +// * Получатель +// * ДанныеПоставщика - Структура -: +// ** ИНН +// ** Наименование +// ** Телефон +// * ДанныеАгента - Структура -: +// ** ОператорПоПриемуПлатежей - Структура -: +// *** Телефон - Неопределено - +// ** ОператорПеревода - Структура -: +// *** Телефон - Строка - +// *** Наименование - Строка - +// *** Адрес - Строка - +// *** ИНН - Строка - +// ** ПлатежныйАгент - Структура -: +// *** Операция - Строка - +// *** Телефон - Строка - +// * ПризнакАгента - Неопределено - +// * ПокупательНомер +// * ПокупательEmail +// * ОтправительEmail +// * МестоРасчетов +// * АдресРасчетов +// * СистемаНалогообложения - ПеречислениеСсылка.ТипыСистемНалогообложенияККТ - +// * Отправляет1СEmail - Булево - +// * Отправляет1СSMS - Булево - +// * ТипРасчета - ПеречислениеСсылка.ТипыРасчетаДенежнымиСредствами - +// * Электронно - Булево - +// * ТорговыйОбъект - Неопределено - +// * Организация - Неопределено - +// * ИдентификаторФискальнойЗаписи - Неопределено - +// * ДокументОснование - Неопределено - +// * КассирИНН - Неопределено - +// * Кассир - Строка - +Функция ПараметрыОперацииФискализацииЧека() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыОперацииФискализацииЧека() Экспорт;); +``` +
+ +## ПараметрыФискальнойСтрокиЧека +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров фискальной строки для фискализации чека. +// +// Возвращаемое значение: +// Структура - Описание: +// * Штрихкод +// * НомерСекции - Число - +// * ДополнительныйРеквизит +// * СуммаАкциза +// * НомерТаможеннойДекларации +// * КодСтраныПроисхожденияТовара +// * ДанныеКодаТоварнойНоменклатуры - Структура -: +// ** КодКонтрольнойМарки +// ** СерийныйНомер +// ** ГлобальныйИдентификаторТорговойЕдиницы +// ** КонтрольныйИдентификационныйЗнак +// ** ТипМаркировки +// * ЕдиницаИзмерения +// * ДанныеПоставщика - Структура -: +// ** ИНН +// ** Наименование +// ** Телефон +// * ДанныеАгента - Структура -: +// ** ОператорПоПриемуПлатежей - Структура -: +// *** Телефон - Неопределено - +// ** ОператорПеревода +// ** ПлатежныйАгент +// * ПризнакАгентаПоПредметуРасчета +// * ПризнакПредметаРасчета - Неопределено - +// * ПризнакСпособаРасчета - Неопределено - +// * СуммаНДС - Неопределено - +// * СтавкаНДС - Неопределено - +// * СуммаСкидок +// * Сумма - Число - +// * ЦенаСоСкидками - Число - +// * Цена - Число - +// * Количество - Число - +// * Наименование +// * НомерСтрокиТовара +// * ФискальнаяСтрока. +// +Функция ПараметрыФискальнойСтрокиЧека() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыФискальнойСтрокиЧека() Экспорт;); +``` +
+ +## ПараметрыТекстовойСтрокиЧека +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров текстовой строки для фискализации чека. +// +Функция ПараметрыТекстовойСтрокиЧека(Текст = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыТекстовойСтрокиЧека(Текст); +``` +
+ +## ПараметрыШтрихкодВСтрокеЧека +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров штрихкода в строке для фискализации чека. +// +Функция ПараметрыШтрихкодВСтрокеЧека(ТипШтрихкодаЗнач = Неопределено, ШтрихКодЗнач = Неопределено, ШтрихКодBase64 = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыШтрихкодВСтрокеЧека(ТипШтрихкодаЗнач, ШтрихКодЗнач, ШтрихКодBase64); +``` +
+ +## ПараметрыСтрокиОплаты +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров строки оплаты. +// +Функция ПараметрыСтрокиОплаты() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыСтрокиОплаты() +``` +
+ +## ПараметрыДанныеКоррекции +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров строки оплаты. +// +Функция ПараметрыДанныеКоррекции() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыДанныеКоррекции() +``` +
+ +## ПараметрыОперацииЧекаКоррекции +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров выполнения операции чека коррекции. +// +Функция ПараметрыОперацииЧекаКоррекции() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыОперацииЧекаКоррекции() Экспорт;); +``` +
+ +## ПараметрыОткрытияЗакрытияСмены +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров открытия и закрытия смены. +// +Функция ПараметрыОткрытияЗакрытияСмены() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыОткрытияЗакрытияСмены() Экспорт;); +``` +
+ +## ПараметрыИнкассации +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров инкассацию на фискальном устройстве. +// +Функция ПараметрыИнкассации() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыИнкассации() Экспорт;); +``` +
+ +## ПараметрыОперацииАннулированияЧека +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров выполнения эквайринговой операции. +// +Функция ПараметрыОперацииАннулированияЧека() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыОперацииАннулированияЧека() Экспорт;); +``` +
+ +## ПараметрыФискализацииЧека +
+ +Описание, пример вызова + +```bsl + +// Заполнить структуру фискализации чека +// +Функция ПараметрыФискализацииЧека() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыФискализацииЧека() +``` +
+ +## ПараметрыСтрокиВыгрузкиВТСД +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров строки выгрузки в ТСД. +// +Функция ПараметрыСтрокиВыгрузкиВТСД() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыСтрокиВыгрузкиВТСД() +``` +
+ +## ПостроитьПолеПереносом +
+ +Описание, пример вызова + +```bsl + +// Выстраивает строку по длине поля, если поле длинное - переносит на следующую строку. +// +Функция ПостроитьПолеПереносом(Знач Текст, Знач ДлинаПоля, ДобСимвол = "", ПоЦентру = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПостроитьПолеПереносом(Текст, ДлинаПоля, ДобСимвол, ПоЦентру); +``` +
+ +## ПостроитьПоле +
+ +Описание, пример вызова + +```bsl + +// Обрезает передаваемую строку по длине поля, если поле слишком короткое - дополняет символами. +// +Функция ПостроитьПоле(Знач Текст, Знач ДлинаПоля, ДобСимвол = "", ДобавлятьСправа = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПостроитьПоле(Текст, ДлинаПоля, ДобСимвол, ДобавлятьСправа); +``` +
+ +## ВыстроитьПоля +
+ +Описание, пример вызова + +```bsl + +// Формирует строку из двух полей, если передается одно поле дополняет символами до нужного размера. +// +Функция ВыстроитьПоля(Знач Текст1, Знач Текст2 = "", Знач ДлинаПоля) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ВыстроитьПоля(Текст1, Текст2, ДлинаПоля) +``` +
+ +## ВыравнитьПоле +
+ +Описание, пример вызова + +```bsl + +// Выравнить передаваемую строку по длине поля, если поле слишком короткое - дополняет символами. +// +Функция ВыравнитьПоле(Знач Текст, Знач ДлинаПоля = 32, Знач Выравнивание = "Лево", ДобСимвол = "") Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ВыравнитьПоле(Текст, ДлинаПоля, Выравнивание, ДобСимвол); +``` +
+ +## ДобавитьЛидирующиеНули +
+ +Описание, пример вызова + +```bsl + +Функция ДобавитьЛидирующиеНули(Знач Строка, Знач ДлиннаСтроки) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ДобавитьЛидирующиеНули(Строка, ДлиннаСтроки)); +``` +
+ +## ТребуетсяВызовСобытияПослеВыполненияКомандыФискальнымУстройством +
+ +Описание, пример вызова + +```bsl + +// Определяет необходимость выполнения серверного события ПослеВыполненияКомандыФискальнымУстройством. +// +Функция ТребуетсяВызовСобытияПослеВыполненияКомандыФискальнымУстройством(Контекст) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ТребуетсяВызовСобытияПослеВыполненияКомандыФискальнымУстройством(Контекст) +``` +
+ +## КомандыРаботыСоСменами +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив команд работы с кассовой сменой. +// +Функция КомандыРаботыСоСменами() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.КомандыРаботыСоСменами()); +``` +
+ +## ПараметрыСчетчиковОпераций +
+ +Описание, пример вызова + +```bsl + +// Параметры счетчиков операций. +// +Функция ПараметрыСчетчиковОпераций() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыСчетчиковОпераций() +``` +
+ +## ПараметрыНормализуемыхФискальныхДанных +
+ +Описание, пример вызова + +```bsl + +// Заполняет структуру параметров нормализуемых фискальных данных. +// +Функция ПараметрыНормализуемыхФискальныхДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ПараметрыНормализуемыхФискальныхДанных() +``` +
+ +## ТребуетсяЗакрытиеСмены +
+ +Описание, пример вызова + +```bsl + +Функция ТребуетсяЗакрытиеСмены(СтатусСмены) Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ТребуетсяЗакрытиеСмены(СтатусСмены) +``` +
+ +## ТекстОшибки_Подсистема_ЧекопечатающиеУстройства +
+ +Описание, пример вызова + +```bsl + +Функция ТекстОшибки_Подсистема_ЧекопечатающиеУстройства() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияКлиентСервер.ТекстОшибки_Подсистема_ЧекопечатающиеУстройства()); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МенеджерОборудованияКлиентСерверПереопределяемый.md b/src/content/docs/zup/МенеджерОборудованияКлиентСерверПереопределяемый.md new file mode 100644 index 0000000..525e538 --- /dev/null +++ b/src/content/docs/zup/МенеджерОборудованияКлиентСерверПереопределяемый.md @@ -0,0 +1,57 @@ +--- +title: Менеджер оборудования клиент сервер переопределяемый +slug: zup/менеджер-оборудования-клиент-сервер-переопределяемый +--- + + +## ОбработкаЗаполненияИмяКассира +
+ +Описание, пример вызова + +```bsl + +// Обработчик события вызывается при получении имени кассира. +// +// Параметры: +// ИмяКассира - Строка, Неопределено - Текст, используемый для заполнения документа +// СтандартнаяОбработка - Булево +// +Процедура ОбработкаЗаполненияИмяКассира(ИмяКассира, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентСерверПереопределяемый.ОбработкаЗаполненияИмяКассира(ИмяКассира, СтандартнаяОбработка) +``` +
+ +## ОбработкаЗаполненияИННКассира +
+ +Описание, пример вызова + +```bsl + +// Обработчик события вызывается при получении ИНН кассира. +// +// Параметры: +// ИННКассира - Строка, Неопределено - Текст, используемый для заполнения документа +// СтандартнаяОбработка - Булево +// +Процедура ОбработкаЗаполненияИННКассира(ИННКассира, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +МенеджерОборудованияКлиентСерверПереопределяемый.ОбработкаЗаполненияИННКассира(ИННКассира, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МенеджерОборудованияСерверПовтИсп.md b/src/content/docs/zup/МенеджерОборудованияСерверПовтИсп.md new file mode 100644 index 0000000..4903f4f --- /dev/null +++ b/src/content/docs/zup/МенеджерОборудованияСерверПовтИсп.md @@ -0,0 +1,31 @@ +--- +title: Менеджер оборудования сервер повт исп +slug: zup/менеджер-оборудования-сервер-повт-исп +--- + + +## ТипыПодключенногоОборудования +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает возможные типы подключенного оборудования к рабочему месту. +// +Функция ТипыПодключенногоОборудования() Экспорт +``` + +Пример вызова +```bsl +Результат = МенеджерОборудованияСерверПовтИсп.ТипыПодключенногоОборудования() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МиграцияПриложений.md b/src/content/docs/zup/МиграцияПриложений.md new file mode 100644 index 0000000..308ab32 --- /dev/null +++ b/src/content/docs/zup/МиграцияПриложений.md @@ -0,0 +1,697 @@ +--- +title: Миграция приложений +slug: zup/миграция-приложений +--- + + +## НачатьВыгрузку +
+ +Описание, пример вызова + +```bsl + +// Инициализирует выгрузку. +// +// Параметры: +// АдресПриложения - Строка - url приложения, которое создано специально для миграции. +// Логин - Строка - логин пользователя в этом приложении. +// Пароль - Строка - пароль пользователя. +// ВыгружатьНастройкиПользователей - Соответствие из КлючИЗначение - коллекция пользователей, настройки которых нужно выгружать: +// * Ключ - СправочникСсылка.Пользователи - пользователь, настройки которого нужно выгрузить. +// * Значение - Строка - новый логин пользователя. +// ЗавершитьМиграциюАвтоматически - Булево - если Истина, то будет выполнена попытка установить монопольный режим и +// завершить миграцию. +// ДополнительныеСвойства - Структура - доп. свойства для сохранения. +// +Процедура НачатьВыгрузку(АдресПриложения, Логин, Пароль, ВыгружатьНастройкиПользователей, ЗавершитьМиграциюАвтоматически, ДополнительныеСвойства) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.НачатьВыгрузку(АдресПриложения, Логин, Пароль, ВыгружатьНастройкиПользователей, ЗавершитьМиграциюАвтоматически, ДополнительныеСвойства) +``` +
+ +## ОтменитьВыгрузку +
+ +Описание, пример вызова + +```bsl + +// Отменяет выгрузку. +// +Процедура ОтменитьВыгрузку() Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ОтменитьВыгрузку() +``` +
+ +## СостояниеВыгрузки +
+ +Описание, пример вызова + +```bsl + +// Возвращает состояние выгрузки. +// +// Возвращаемое значение: +// Структура - структура с ключами: +// * ДатаНачала - Дата - универсальная дата начала перехода. +// * НомерОтправленногоСообщения - Число - номер отправленного сообщения. +// * НомерПринятогоСообщения - Число - количество обработанных сообщений. +// * ИзмененоОбъектов - Число - количество зарегистрированных изменений. +// * ВыгруженоОбъектов - Число - количество выгруженных объектов. +// * ЗагруженоОбъектов - Число - количество загруженных объектов. +// * ЗагрузитьОбъектов - Число - количество объектов, которые еще нужно загрузить. +// * ДатаЗавершения - Дата - универсальная дата завершения перехода. +// * Состояние - ПеречислениеСсылка.СостоянияМиграцииПриложения - состояние миграции. +// * Комментарий - Строка - доп. описание состояния. +// +Функция СостояниеВыгрузки() Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.СостояниеВыгрузки() +``` +
+ +## НачатьЗагрузку +
+ +Описание, пример вызова + +```bsl + +// Инициализирует загрузку. +// +// Параметры: +// ПользователиОбласти - Соответствие - в качестве ключа исходная ссылка, в качестве значения логин пользователя. +// +Процедура НачатьЗагрузку(ПользователиОбласти) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.НачатьЗагрузку(ПользователиОбласти) +``` +
+ +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// См. ОчередьЗаданийПереопределяемый.ПриОпределенииПсевдонимовОбработчиков. +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки +
+ +Описание, пример вызова + +```bsl + +// См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки. +// +// Параметры: +// Типы - См. ВыгрузкаЗагрузкаДанныхПереопределяемый.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки.Типы +// +Процедура ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПриЗаполненииТиповИсключаемыхИзВыгрузкиЗагрузки(Типы) +``` +
+ +## ПриОпределенииНастроекРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// См. РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроекРегламентныхЗаданий +// +// Параметры: +// Настройки - см. РегламентныеЗаданияПереопределяемый.ПриОпределенииНастроекРегламентныхЗаданий.Настройки +Процедура ПриОпределенииНастроекРегламентныхЗаданий(Настройки) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПриОпределенииНастроекРегламентныхЗаданий(Настройки) +``` +
+ +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазыБСП.ПриДобавленииОбработчиковОбновления +// +// Параметры: +// Обработчики - см. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ПриДобавленииПараметровРаботыКлиентаПриЗапуске +
+ +Описание, пример вызова + +```bsl + +// См. ОбщегоНазначенияПереопределяемый.ПриДобавленииПараметровРаботыКлиентаПриЗапуске. +Процедура ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПриДобавленииПараметровРаботыКлиентаПриЗапуске(Параметры) +``` +
+ +## ЗаданиеВыгрузка +
+ +Описание, пример вызова + +```bsl + +// Регламентное задание МиграцияПриложенийВыгрузка. +// +Процедура ЗаданиеВыгрузка(ЗавершитьМиграцию = Ложь) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ЗаданиеВыгрузка(ЗавершитьМиграцию); +``` +
+ +## ЗаданиеЗагрузка +
+ +Описание, пример вызова + +```bsl + +// Регламентное задание МиграцияПриложенийЗагрузка. +// +Процедура ЗаданиеЗагрузка() Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ЗаданиеЗагрузка() +``` +
+ +## ПроверитьСоставПланаОбмена +
+ +Описание, пример вызова + +```bsl + +// Проверяет состав плана обмена, в случае некорректного состава вызывается исключение. +// Проверки: +// 1) У всех объектов выключена авторегистрация. +// 2) В составе есть все объекты необходимые для обмена. +// +Процедура ПроверитьСоставПланаОбмена() Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПроверитьСоставПланаОбмена() +``` +
+ +## ПередЗаписьюОбъекта +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписьюОбъекта. +// +Процедура ПередЗаписьюОбъекта(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПередЗаписьюОбъекта(Источник, Отказ) +``` +
+ +## ПередЗаписьюДокумента +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ЗаписьюДокумента. +// +Процедура ПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## ПередЗаписьюНабора +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписьюНабора. +// +Процедура ПередЗаписьюНабора(Источник, Отказ, Замещение) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПередЗаписьюНабора(Источник, Отказ, Замещение) +``` +
+ +## ПередЗаписьюНабораРасчета +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередЗаписьюНабораРасчета. +// +Процедура ПередЗаписьюНабораРасчета(Источник, Отказ, Замещение, ТолькоЗапись, ЗаписьФактическогоПериодаДействия, ЗаписьПерерасчетов) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПередЗаписьюНабораРасчета(Источник, Отказ, Замещение, ТолькоЗапись, ЗаписьФактическогоПериодаДействия, ЗаписьПерерасчетов) +``` +
+ +## ПередУдалениемОбъекта +
+ +Описание, пример вызова + +```bsl + +// Обработчик подписки на событие ПередУдалениемОбъекта. +// +Процедура ПередУдалениемОбъекта(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.ПередУдалениемОбъекта(Источник, Отказ) +``` +
+ +## АбонентыПользователя +
+ +Описание, пример вызова + +```bsl + +// Получается абонентов пользователя из сервиса. +// Используется во внешней обработке перехода в сервис, которая должна работать на БТС от 1.2.2. +// +// Параметры: +// ИсточникПараметровДоступа - ФормаКлиентскогоПриложения, Структура - +// +// Возвращаемое значение: +// СписокЗначений - в качестве значения код, в качестве представления наименование. +// +Функция АбонентыПользователя(ИсточникПараметровДоступа) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.АбонентыПользователя(ИсточникПараметровДоступа) +``` +
+ +## ВызватьМетодПрограммногоИнтерфейса +
+ +Описание, пример вызова + +```bsl + +// Вызывает метода программного интерфейса менеджера сервиса. +// +// Параметры: +// ИсточникПараметровДоступа - ФормаКлиентскогоПриложения, Структура - +// ПараметрыМетода - Структура - параметры вызываемого метода. +// Метод - Строка, Неопределено - имя метода для подстановки в URL запроса. Если не указано, в менеджере сервиса +// будет использовано имя метода из параметров запроса. +// +// Возвращаемое значение: +// Структура - результат запроса: +// * Поле - Произвольный - произвольный набор полей. +Функция ВызватьМетодПрограммногоИнтерфейса(ИсточникПараметровДоступа, ПараметрыМетода, Метод = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.ВызватьМетодПрограммногоИнтерфейса(ИсточникПараметровДоступа, ПараметрыМетода, Метод); +``` +
+ +## СервисПоддерживаетМиграцию +
+ +Описание, пример вызова + +```bsl + +// Выполняет проверку сервиса. +// Используется во внешней обработке перехода в сервис, которая должна работать на БТС от 1.2.2. +// +// Параметры: +// ИмяСервера - Строка - имя сервера. +// АдресПрограммногоИнтерфейса - Строка - выходной параметр. +// АдресРегистрации - Строка - выходной параметр. +// АдресВосстановления - Строка - выходной параметр. +// РегистрацияРазрешена - Булево - выходной параметр. +// Возвращаемое значение: +// Булево - Истина - в случае если поддерживает миграцию. +// +Функция СервисПоддерживаетМиграцию(ИмяСервера, АдресПрограммногоИнтерфейса, АдресРегистрации, АдресВосстановления, РегистрацияРазрешена) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.СервисПоддерживаетМиграцию(ИмяСервера, АдресПрограммногоИнтерфейса, АдресРегистрации, АдресВосстановления, РегистрацияРазрешена) +``` +
+ +## ПользователиСервиса +
+ +Описание, пример вызова + +```bsl + +// Получает пользователей сервиса. +// Используется во внешней обработке перехода в сервис, которая должна работать на БТС от 1.2.2. +// +// Параметры: +// ИсточникПараметровДоступа - ФормаКлиентскогоПриложения, Структура - +// +// Возвращаемое значение: +// Массив Из Структура - описание: +// * Логин - Строка - +// * Наименование - Строка - +// * ЭлектроннаяПочта - Строка - +// * Роль - см. МиграцияПриложенийКлиентСервер.ПредставлениеРоли +// +Функция ПользователиСервиса(ИсточникПараметровДоступа) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.ПользователиСервиса(ИсточникПараметровДоступа) +``` +
+ +## СоздатьПриложениеДляМиграции +
+ +Описание, пример вызова + +```bsl + +// Создает приложение для миграции в сервисе. +// +// Параметры: +// ИсточникПараметровДоступа - ФормаКлиентскогоПриложения, Структура - +// Наименование - Строка - Наименование приложения. +// ЧасовойПояс - Строка - часовой пояс приложения. +// ПраваПользователей - ТаблицаЗначений - таблица с колонками: +// * Логин - Строка - логин пользователя сервиса. +// * Пользователь - СправочникСсылка.Пользователи - пользователь к которому будет привязан пользователь сервиса. +// * Право - Строка - см. МиграцияПриложенийКлиентСервер.ИдентификаторAPIПрава. +// РасширенияДляВосстановления - ТаблицаЗначений - таблица с колонками: +// * Имя - Строка +// * Версия - Строка +// +// Возвращаемое значение: +// Структура - ключи: +// * АдресПриложения - Строка - url приложения. +// * Логин - Строка - логин служебного пользователя. +// * Пароль - Строка - пароль служебного пользователя. +// * Код - Число - код области. +// +Функция СоздатьПриложениеДляМиграции(ИсточникПараметровДоступа, Наименование, ЧасовойПояс, ПраваПользователей, Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.СоздатьПриложениеДляМиграции(ИсточникПараметровДоступа, Наименование, ЧасовойПояс, ПраваПользователей, ); +``` +
+ +## ДанныеОбслуживающейОрганизации +
+ +Описание, пример вызова + +```bsl + +// Получает данные обслуживающей организации в сервисе. +// +// Параметры: +// ИсточникПараметровДоступа - ФормаКлиентскогоПриложения, Структура - +// +// Возвращаемое значение: +// Структура - ключи: +// * Код - Число +// * Наименование - Строка +// * ЭлектроннаяПочта - Строка +// * Телефон - Строка +// * ОписаниеОшибки - Строка +// +Функция ДанныеОбслуживающейОрганизации(ИсточникПараметровДоступа) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.ДанныеОбслуживающейОрганизации(ИсточникПараметровДоступа) +``` +
+ +## Зарегистрироваться +
+ +Описание, пример вызова + +```bsl + +// Регистрирует в сервисе. +// +// Параметры: +// ИмяСервера - Строка - имя сервера +// Наименование - Строка - наименование абонента +// Логин - Строка - +// ЭлектроннаяПочта - Строка - адрес электронной почты +// Пароль - Строка - +// Телефон - Строка - телефон абонента +// +// Возвращаемое значение: +// Булево - результат регистрации. +// +Функция Зарегистрироваться(ИмяСервера, Наименование, Логин, ЭлектроннаяПочта, Пароль, Телефон) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.Зарегистрироваться(ИмяСервера, Наименование, Логин, ЭлектроннаяПочта, Пароль, Телефон) +``` +
+ +## ПодтвердитьРегистрацию +
+ +Описание, пример вызова + +```bsl + +// Подтверждает регистрацию в сервисе. +// +// Параметры: +// ИмяСервера - Строка - имя сервера +// КодПодтверждения - Строка - код подтверждения регистрации +// +// Возвращаемое значение: +// Булево - результат подтверждения регистрации. +// +Функция ПодтвердитьРегистрацию(ИмяСервера, КодПодтверждения) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.ПодтвердитьРегистрацию(ИмяСервера, КодПодтверждения) +``` +
+ +## Описание +
+ +Описание, пример вызова + +```bsl + +// Возвращает описание данных логического хранилища. +// +// Параметры: +// ИдентификаторХранилища - Строка - идентификатор логического хранилища. +// ИдентификаторДанных - Строка - идентификатор данных хранилища. +// +// Возвращаемое значение: +// Структура - описание состояния задания очереди: +// * ИмяФайла - Строка - имя файла. +// * Размер - Число - размер файла в байтах. +// * Данные - ДвоичныеДанные - двоичные данные файла описания задания. +// +Функция Описание(ИдентификаторХранилища, ИдентификаторДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.Описание(ИдентификаторХранилища, ИдентификаторДанных) +``` +
+ +## Данные +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные логического хранилища. +// +// Параметры: +// ОписаниеДанных - Структура - описание данных хранилища. +// +// Возвращаемое значение: +// ДвоичныеДанные - +// +Функция Данные(ОписаниеДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.Данные(ОписаниеДанных) +``` +
+ +## Загрузить +
+ +Описание, пример вызова + +```bsl + +// Записывает данные в логическое хранилище. +// Выполняет действия: +// - сохраняет файл данных в файловом хранилище +// - планирует задание очереди заданий на обработки файла +// - возвращается идентификатор задания в ответ. +// +// Возвращаемое значение: +// Структура - состояние загрузки: +// * id - Структура: +// ** Успешно - Булево +// ** Комментарий - Строка +// ** СостояниеЗагрузки - см. СостояниеЗагрузки +// +Функция Загрузить(ОписаниеДанных) Экспорт +``` + +Пример вызова +```bsl +Результат = МиграцияПриложений.Загрузить(ОписаниеДанных) +``` +
+ +## УдалитьВременныхПользователей +
+ +Описание, пример вызова + +```bsl + +// Обработчик обновления +Процедура УдалитьВременныхПользователей() Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.УдалитьВременныхПользователей() +``` +
+ +## УдалитьВременногоПользователя +
+ +Описание, пример вызова + +```bsl + +Процедура УдалитьВременногоПользователя(Имя) Экспорт +``` + +Пример вызова +```bsl +МиграцияПриложений.УдалитьВременногоПользователя(Имя) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МногофункциональныеДокументыБЗККлиентСервер.md b/src/content/docs/zup/МногофункциональныеДокументыБЗККлиентСервер.md new file mode 100644 index 0000000..1f8175b --- /dev/null +++ b/src/content/docs/zup/МногофункциональныеДокументыБЗККлиентСервер.md @@ -0,0 +1,92 @@ +--- +title: Многофункциональные документы БЗК клиент сервер +slug: zup/многофункциональные-документы-бзк-клиент-сервер +--- + + +## РазделыДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, ключами которой являются имена разделов данные которых представлены в +// в многофункциональных документах, по сути представляет собой перечисление. +// +// Возвращаемое значение: +// Структура - Описание: +// * КадровыеДанные - Строка - соответствует разделу данных КадровыеДанные +// * ПлановыеНачисления - Строка - соответствует разделу данных ПлановыеНачисления +// * НачисленнаяЗарплата - Строка - соответствует разделу данных НачисленнаяЗарплата +// * РабочееВремя - Строка - соответствует разделу данных РабочееВремя +// +Функция РазделыДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = МногофункциональныеДокументыБЗККлиентСервер.РазделыДанных() +``` +
+ +## ВидыПравНаРазделыДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает структуру, ключами которой являются виды прав на данные отдельных учетов +// в многофункциональных документах, по сути представляет собой перечисление. +// +// Возвращаемое значение: +// Структура - Описание: +// * Просмотр - Строка - соответствует праву Просмотр +// * Редактирование - Строка - соответствует праву Редактирование +// +Функция ВидыПравНаРазделыДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = МногофункциональныеДокументыБЗККлиентСервер.ВидыПравНаРазделыДанных() +``` +
+ +## НовыйОписаниеРазделаДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает пустую структуру - описание раздела данных многофункционального документа +// +// Возвращаемое значение: +// Структура - Описание: +// * РеквизитОтветсвенный - Строка, Неопределено - имя реквизита в котором хранится ответственный утвердивший раздел, +// если значение Неопределено, значит в документе нет соответствующего поля +// * РеквизитСостояние - Строка, Неопределено - имя реквизита, в котором хранится состояние раздела (булево, +// либо раздел утвержден, либо нет). Если значение Неопределено, значит в документе нет соответствующего поля +// * ТребуетсяУтверждениеПриПроведении - Булево - признак того что необходимо выполнять проверку +// на то что раздел утвержден при проведении документа. +// * СообщениеДокументНеУтвержден - Строка - сообщение которое будет выдано при проверке документа при проведении, +// если раздел не утвержден +// +Функция НовыйОписаниеРазделаДанных() Экспорт +``` + +Пример вызова +```bsl +Результат = МногофункциональныеДокументыБЗККлиентСервер.НовыйОписаниеРазделаДанных() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МониторПортала1СИТСКлиент.md b/src/content/docs/zup/МониторПортала1СИТСКлиент.md new file mode 100644 index 0000000..2e61535 --- /dev/null +++ b/src/content/docs/zup/МониторПортала1СИТСКлиент.md @@ -0,0 +1,35 @@ +--- +title: Монитор портала 1С ИТС клиент +slug: zup/монитор-портала-1с-итс-клиент +--- + + +## ОткрытьМонитор +
+ +Описание, пример вызова + +```bsl + +// Открывает Монитор Портала 1С:ИТС. +// +// Параметры: +// ДополнительныеПараметры - Структура, Неопределено - дополнительные параметры +// открытия Монитора Портала 1С:ИТС; +// +Процедура ОткрытьМонитор(ДополнительныеПараметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСКлиент.ОткрытьМонитор(ДополнительныеПараметры); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МониторПортала1СИТСКлиентПереопределяемый.md b/src/content/docs/zup/МониторПортала1СИТСКлиентПереопределяемый.md new file mode 100644 index 0000000..92b1ea5 --- /dev/null +++ b/src/content/docs/zup/МониторПортала1СИТСКлиентПереопределяемый.md @@ -0,0 +1,167 @@ +--- +title: Монитор портала 1С ИТС клиент переопределяемый +slug: zup/монитор-портала-1с-итс-клиент-переопределяемый +--- + + +## ПередПолучениемДанныхМонитора +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед началом получения данных в форме Монитора в контексте клиента. +// Описание формы Монитора см. в методе ПриСозданииФормыМонитора общего +// модуля МониторПортала1СИТСПереопределяемый, параметр Форма. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма Монитора. +// +//@skip-warning +Процедура ПередПолучениемДанныхМонитора(Форма) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСКлиентПереопределяемый.ПередПолучениемДанныхМонитора(Форма) +``` +
+ +## ОбработатьКомандуВФормеМонитора +
+ +Описание, пример вызова + +```bsl + +// Вызывается при обработке команды в форме Монитора Портала 1С:ИТС +// из обработчика "Подключаемый_ОбработатьКоманду". +// Описание формы Монитора см. в методе ПриСозданииФормыМонитора общего +// модуля МониторПортала1СИТСПереопределяемый, параметр Форма. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма Монитора; +// Команда - КомандаФормы - команда, для которой вызывается обработчик; +// +//@skip-warning +Процедура ОбработатьКомандуВФормеМонитора(Форма, Команда) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСКлиентПереопределяемый.ОбработатьКомандуВФормеМонитора(Форма, Команда) +``` +
+ +## ПриНажатииДекорацииВФормеМонитора +
+ +Описание, пример вызова + +```bsl + +// Вызывается при обработке события Нажатие элемента декорации в +// форме Монитора Интернет-поддержки из обработчика "Подключаемый_ДекорацияНажатие". +// Описание формы Монитора см. в методе ПриСозданииФормыМонитора общего +// модуля МониторПортала1СИТСПереопределяемый, параметр Форма. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма Монитора; +// Элемент - ДекорацияФормы - декорация, для которой вызвано событие; +// +//@skip-warning +Процедура ПриНажатииДекорацииВФормеМонитора(Форма, Элемент) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСКлиентПереопределяемый.ПриНажатииДекорацииВФормеМонитора(Форма, Элемент) +``` +
+ +## ОбработатьНавигационнуюСсылкуВФормеМонитора +
+ +Описание, пример вызова + +```bsl + +// Вызывается при обработке события ОбработкаНавигационнойСсылки элемента +// декорации в форме Монитора Портала 1С:ИТС из обработчика +// "Подключаемый_ОбработатьНавигационнуюСсылку"; +// Описание формы Монитора см. в методе ПриСозданииФормыМонитора общего +// модуля МониторПортала1СИТСПереопределяемый, параметр Форма. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма Монитора; +// Элемент - ДекорацияФормы - декорация, для которой вызвано событие; +// НавигационнаяСсылкаФорматированнойСтроки - Строка - ссылка; +// СтандартнаяОбработка - Булево - признак стандартной обработки; +// +//@skip-warning +Процедура ОбработатьНавигационнуюСсылкуВФормеМонитора( Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСКлиентПереопределяемый.ОбработатьНавигационнуюСсылкуВФормеМонитора(); +``` +
+ +## ПриВыполненииОбработчикаОжиданияВФормеМонитора +
+ +Описание, пример вызова + +```bsl + +// Вызывается при выполнении обработчика ожидания в форме Монитора Портала 1С:ИТС. +// Описание формы Монитора см. в методе ПриСозданииФормыМонитора общего +// модуля МониторПортала1СИТСПереопределяемый, параметр Форма. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма Монитора. +// +//@skip-warning +Процедура ПриВыполненииОбработчикаОжиданияВФормеМонитора(Форма) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСКлиентПереопределяемый.ПриВыполненииОбработчикаОжиданияВФормеМонитора(Форма) +``` +
+ +## ПриЗакрытииФормыМонитора +
+ +Описание, пример вызова + +```bsl + +// Вызывается при обработке события ПриЗакрытии в форме Монитора Портала 1С:ИТС. +// Описание формы Монитора см. в методе ПриСозданииФормыМонитора общего +// модуля МониторПортала1СИТСПереопределяемый, параметр Форма. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма Монитора; +// ЗавершениеРаботы - Булево - одноименный параметр обработчика формы. +// +//@skip-warning +Процедура ПриЗакрытииФормыМонитора(Форма, ЗавершениеРаботы) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСКлиентПереопределяемый.ПриЗакрытииФормыМонитора(Форма, ЗавершениеРаботы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МониторПортала1СИТСПереопределяемый.md b/src/content/docs/zup/МониторПортала1СИТСПереопределяемый.md new file mode 100644 index 0000000..7e6a91f --- /dev/null +++ b/src/content/docs/zup/МониторПортала1СИТСПереопределяемый.md @@ -0,0 +1,183 @@ +--- +title: Монитор портала 1С ИТС переопределяемый +slug: zup/монитор-портала-1с-итс-переопределяемый +--- + + +## ПриОпределенииОбщихПараметровМонитора +
+ +Описание, пример вызова + +```bsl + +// Определяет общие параметры функциональности Монитора Портала 1С:ИТС. +// +// Параметры: +// ПараметрыМонитора - Структура - общие параметры Монитора: +// * ИспользоватьОтображениеПриНачалеРаботы - Булево - управляет использованием +// отображения Монитора при начале работы программы. Истина - использовать, +// Ложь - не использовать. Значение по умолчанию - Истина; +// +//@skip-warning +Процедура ПриОпределенииОбщихПараметровМонитора(ПараметрыМонитора) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСПереопределяемый.ПриОпределенииОбщихПараметровМонитора(ПараметрыМонитора) +``` +
+ +## ПриСозданииФормыМонитора +
+ +Описание, пример вызова + +```bsl + +// Вызывается при создании формы Монитора Портала 1С:ИТС. +// Используется для создания собственных реквизитов и элементов формы. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма Монитора. В форме доступны для использования: +// - реквизит ДополнительныеПараметры с типом Произвольный - реквизит может +// быть использован для хранения собственных параметров в контексте формы +// без необходимости реализации отдельных реквизитов; +// - метод "Подключаемый_ОбработатьКоманду" - процедура-обработчик, +// которую необходимо назначать при добавлении новых команд формы Монитора +// в качестве значения свойства Действие объекта КомандаФормы. Обработка +// действия реализуется в методе +// МониторПортала1СИТСКлиентПереопределяемый.ОбработатьКомандуВФормеМонитора(); +// - метод "Подключаемый_ДекорацияНажатие" - процедура-обработчик, которую +// необходимо назначать при добавлении новых декораций формы в качестве значения +// параметра Действие при вызове метода УстановитьДействие("Нажатие", <Действие>) +// объекта ДекорацияФормы. Обработка действия выполняется в методе +// МониторПортала1СИТСКлиентПереопределяемый.ПриНажатииДекорацииВФормеМонитора(); +// - метод "Подключаемый_ОбработатьНавигационнуюСсылку" - процедура-обработчик, которую +// необходимо назначать при добавлении новых декораций формы в качестве значения +// параметра Действие при вызове метода УстановитьДействие("ОбработкаНавигационнойСсылки", <Действие>) +// объекта ДекорацияФормы. Обработка действия выполняется в методе +// МониторПортала1СИТСКлиентПереопределяемый.ОбработатьНавигационнуюСсылкуВФормеМонитора(); +// - метод "Подключаемый_ОбработатьОжидание" - процедура-обработчик, которую необходимо использовать +// для реализации собственного обработчика ожидания посредством вызова метода +// ПодключитьОбработчикОжидания("Подключаемый_ОбработатьОжидание", <Интервал>, <Однократно>) формы +// Монитора. Тело обработчика реализуется в методе +// МониторПортала1СИТСКлиентПереопределяемый.ПриВыполненииОбработчикаОжиданияВФормеМонитора(); +// - группа формы Элементы.ГруппаСодержимое - все новые элементы формы необходимо размещать +// внутри данной группы перед/после элементов: +// - Элементы.ГруппаВыполнениеУсловийСопровождения; +// - Элементы.ГруппаСервисы1С; +// - Элементы.ГруппаОбновлениеПрограммы; +// - Элементы.ГруппаСмТакже; +// ПараметрыСоздания - Структура - параметры создания формы Монитора: +// * СсылкиСмТакже - ТаблицаЗначений - список ссылок, отображаемых в разделе "См. также". +// Колонки: +// ** Ссылка - Строка - ссылка для перехода. Ссылки, отличающиеся от шаблонов "HTTP://*", +// "https://*", "mailto:*" передаются для обработки в метод +// МониторПортала1СИТСКлиентПереопределяемый.ОбработатьНавигационнуюСсылкуВФормеМонитора(); +// ** Заголовок - Строка - заголовок ссылки; +// ** Колонка - Число - номер колонки, в которой должна быть отображена ссылка. +// Допустимые значения: 1 - левая колонка, 2 - правая колонка; +// Значение по умолчанию - 1. +// +//@skip-warning +Процедура ПриСозданииФормыМонитора(Форма, ПараметрыСоздания) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСПереопределяемый.ПриСозданииФормыМонитора(Форма, ПараметрыСоздания) +``` +
+ +## ПередПолучениемДанныхМонитора +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед началом получения данных в форме Монитора в контексте сервера. +// Описание формы Монитора см. в методе ПриСозданииФормыМонитора, параметр Форма. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма Монитора; +// ПараметрыПолученияДополнительныхДанных - Произвольный - в параметре возвращаются +// параметры получения дополнительных данных для обработке в методе +// ПриПолученииДополнительныхДанныхМонитора(); +// Может быть использовано для исключения повторного получения +// полученных ранее данных. +// +//@skip-warning +Процедура ПередПолучениемДанныхМонитора(Форма, ПараметрыПолученияДополнительныхДанных) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСПереопределяемый.ПередПолучениемДанныхМонитора(Форма, ПараметрыПолученияДополнительныхДанных) +``` +
+ +## ПриПолученииДополнительныхДанныхМонитора +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении данных Монитора Портала 1С:ИТС для получения дополнительных +// данных Монитора, которые могут быть обработаны в методе ОтобразитьДополнительныеДанныеМонитора(). +// Метод вызывается в фоновом задании, результаты возвращаются в форму Монитора через временное +// хранилище (должны быть доступны для помещения во временное хранилище). +// Описание формы Монитора см. в методе ПриСозданииФормыМонитора(). +// +// Параметры: +// ДополнительныеДанные - Произвольный - в параметре возвращаются данные для +// отображения в форме Монитора; +// ПараметрыПолученияДополнительныхДанных - Произвольный - параметры получения дополнительных данных, +// полученные в методе ПриОпределенииПараметровПолученияДополнительныхДанныхМонитора(); +// +//@skip-warning +Процедура ПриПолученииДополнительныхДанныхМонитора(ДополнительныеДанные, ПараметрыПолученияДополнительныхДанных) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСПереопределяемый.ПриПолученииДополнительныхДанныхМонитора(ДополнительныеДанные, ПараметрыПолученияДополнительныхДанных) +``` +
+ +## ОтобразитьДополнительныеДанныеМонитора +
+ +Описание, пример вызова + +```bsl + +// Вызывается для отображения дополнительных данных Монитора, полученных в методе +// ПриПолученииДополнительныхДанныхМонитора(). +// Описание формы Монитора см. в методе ПриСозданииФормыМонитора, параметр Форма. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма Монитора; +// ДополнительныеДанные - Произвольный - дополнительные данные, полученные в методе +// ПриПолученииДополнительныхДанныхМонитора(). +// +//@skip-warning +Процедура ОтобразитьДополнительныеДанныеМонитора(Форма, ДополнительныеДанные) Экспорт +``` + +Пример вызова +```bsl +МониторПортала1СИТСПереопределяемый.ОтобразитьДополнительныеДанныеМонитора(Форма, ДополнительныеДанные) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/Мультирежим.md b/src/content/docs/zup/Мультирежим.md new file mode 100644 index 0000000..89aa833 --- /dev/null +++ b/src/content/docs/zup/Мультирежим.md @@ -0,0 +1,112 @@ +--- +title: Мультирежим +slug: zup/мультирежим +--- + + +## СертификатПользователя +
+ +Описание, пример вызова + +```bsl + +Функция СертификатПользователя(УчетнаяЗапись, ПереченьСвойств = Неопределено, Знач Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = Мультирежим.СертификатПользователя(УчетнаяЗапись, ПереченьСвойств, Пользователь); +``` +
+ +## ЕстьПравоНаОтправкуОбъекта +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьПравоНаОтправкуОбъекта(СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = Мультирежим.ЕстьПравоНаОтправкуОбъекта(СсылкаНаОбъект) +``` +
+ +## ЕстьПравоНаОрган +
+ +Описание, пример вызова + +```bsl + +// Здесь параметр Направление - это Перечисления.ТипыКонтролирующихОрганов +Функция ЕстьПравоНаОрган(УчетнаяЗапись, Направление) Экспорт +``` + +Пример вызова +```bsl +Результат = Мультирежим.ЕстьПравоНаОрган(УчетнаяЗапись, Направление) +``` +
+ +## ПрерватьПроверкуПравМультирежима +
+ +Описание, пример вызова + +```bsl + +Функция ПрерватьПроверкуПравМультирежима(УчетнаяЗапись, Направление) Экспорт +``` + +Пример вызова +```bsl +Результат = Мультирежим.ПрерватьПроверкуПравМультирежима(УчетнаяЗапись, Направление) +``` +
+ +## ВОрганМожноОтправлятьБезУчетки +
+ +Описание, пример вызова + +```bsl + +// Здесь параметр Орган - это Перечисления.ТипыКонтролирующихОрганов +Функция ВОрганМожноОтправлятьБезУчетки(Орган) Экспорт +``` + +Пример вызова +```bsl +Результат = Мультирежим.ВОрганМожноОтправлятьБезУчетки(Орган) +``` +
+ +## ЕстьПравоНаОрганПоОрганизации +
+ +Описание, пример вызова + +```bsl + +// Здесь параметр Орган - это Перечисления.ТипыКонтролирующихОрганов +Функция ЕстьПравоНаОрганПоОрганизации(Организация, Орган, ПроверятьДляТекущегоПользователя = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = Мультирежим.ЕстьПравоНаОрганПоОрганизации(Организация, Орган, ПроверятьДляТекущегоПользователя); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/МультирежимВызовСервера.md b/src/content/docs/zup/МультирежимВызовСервера.md new file mode 100644 index 0000000..dfd41d0 --- /dev/null +++ b/src/content/docs/zup/МультирежимВызовСервера.md @@ -0,0 +1,45 @@ +--- +title: Мультирежим вызов сервера +slug: zup/мультирежим-вызов-сервера +--- + + +## ЕстьПравоНаОтправкуОбъекта +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьПравоНаОтправкуОбъекта(СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +Результат = МультирежимВызовСервера.ЕстьПравоНаОтправкуОбъекта(СсылкаНаОбъект) +``` +
+ +## ЕстьПравоНаОрган +
+ +Описание, пример вызова + +```bsl + +Функция ЕстьПравоНаОрган(УчетнаяЗапись, Направление) Экспорт +``` + +Пример вызова +```bsl +Результат = МультирежимВызовСервера.ЕстьПравоНаОрган(УчетнаяЗапись, Направление) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/НастройкиБЭДКлиентСервер.md b/src/content/docs/zup/НастройкиБЭДКлиентСервер.md new file mode 100644 index 0000000..8cb9ca1 --- /dev/null +++ b/src/content/docs/zup/НастройкиБЭДКлиентСервер.md @@ -0,0 +1,37 @@ +--- +title: Настройки БЭД клиент сервер +slug: zup/настройки-бэд-клиент-сервер +--- + + +## ТекстСообщенияОНеобходимостиНастройкиСистемы +
+ +Описание, пример вызова + +```bsl + +// Возвращает текст сообщения пользователю о необходимости настройки системы. +// +// Параметры: +// ВидОперации - Строка - признак выполняемой операции. +// +// Возвращаемое значение: +// ТекстСообщения - Строка - Строка сообщения. +// +Функция ТекстСообщенияОНеобходимостиНастройкиСистемы(ВидОперации) Экспорт +``` + +Пример вызова +```bsl +Результат = НастройкиБЭДКлиентСервер.ТекстСообщенияОНеобходимостиНастройкиСистемы(ВидОперации) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/НастройкиСистемыНалогообложения.md b/src/content/docs/zup/НастройкиСистемыНалогообложения.md new file mode 100644 index 0000000..cf87f38 --- /dev/null +++ b/src/content/docs/zup/НастройкиСистемыНалогообложения.md @@ -0,0 +1,96 @@ +--- +title: Настройки системы налогообложения +slug: zup/настройки-системы-налогообложения +--- + + +## ПриЗаполненииСписковСОграничениемДоступа +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступомПереопределяемый.ПриЗаполненииСписковСОграничениемДоступа. +Процедура ПриЗаполненииСписковСОграничениемДоступа(Списки) Экспорт +``` + +Пример вызова +```bsl +НастройкиСистемыНалогообложения.ПриЗаполненииСписковСОграничениемДоступа(Списки) +``` +
+ +## ПриЗаполненииВидовОграниченийПравОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// См. УправлениеДоступомПереопределяемый.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных. +Процедура ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) Экспорт +``` + +Пример вызова +```bsl +НастройкиСистемыНалогообложения.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) +``` +
+ +## ЗарегистрироватьОбработчикиОбновления +
+ +Описание, пример вызова + +```bsl + +// См. ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +Процедура ЗарегистрироватьОбработчикиОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +НастройкиСистемыНалогообложения.ЗарегистрироватьОбработчикиОбновления(Обработчики) +``` +
+ +## ЗаполнитьТаблицуПереименованияОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +Процедура ЗаполнитьТаблицуПереименованияОбъектовМетаданных(Итог) Экспорт +``` + +Пример вызова +```bsl +НастройкиСистемыНалогообложения.ЗаполнитьТаблицуПереименованияОбъектовМетаданных(Итог) +``` +
+ +## ОбновитьНастройкиПримененияЕНВД +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьНастройкиПримененияЕНВД(ПараметрыОбновления = Неопределено) Экспорт +``` + +Пример вызова +```bsl +НастройкиСистемыНалогообложения.ОбновитьНастройкиПримененияЕНВД(ПараметрыОбновления); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОблачныйАрхив20.md b/src/content/docs/zup/ОблачныйАрхив20.md new file mode 100644 index 0000000..3d99cd9 --- /dev/null +++ b/src/content/docs/zup/ОблачныйАрхив20.md @@ -0,0 +1,99 @@ +--- +title: Облачный архив20 +slug: zup/облачный-архив20 +--- + + +## Обслуживание_ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ПриСозданииНаСервере() формы Обслуживание панели администрирования БСП. Выполняет настройку +// отображения элементов управления связанных с облачным архивом. +// +// Параметры: +// Форма - см. Обработка.ПанельАдминистрированияБСП.Форма.Обслуживание +// +Процедура Обслуживание_ПриСозданииНаСервере(Форма) Экспорт +``` + +Пример вызова +```bsl +ОблачныйАрхив20.Обслуживание_ПриСозданииНаСервере(Форма) +``` +
+ +## ИспользуетсяПодсистемаРезервногоКопированияИБ +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак работы подсистемы РезервноеКопированиеИБ в качестве основной подсистемы архивирования. +// +// Возвращаемое значение: +// Булево - Истина, если подсистема РезервноеКопированиеИБ является основной подсистемой архивирования. +// +Функция ИспользуетсяПодсистемаРезервногоКопированияИБ() Экспорт +``` + +Пример вызова +```bsl +Результат = ОблачныйАрхив20.ИспользуетсяПодсистемаРезервногоКопированияИБ() +``` +
+ +## СозданиеРезервнойКопииДоступно +
+ +Описание, пример вызова + +```bsl + +// Проверяет доступность инструмента создания резервной копии в Облачный архив. +// +// Возвращаемое значение: +// Булево - Истина, если инструмент создания резервной копии доступен. +// +Функция СозданиеРезервнойКопииДоступно() Экспорт +``` + +Пример вызова +```bsl +Результат = ОблачныйАрхив20.СозданиеРезервнойКопииДоступно() +``` +
+ +## ПодключениеОблачногоАрхиваВыполнено +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак подключения информационной базы к Облачному архиву. +// +// Возвращаемое значение: +// Булево - Истина, если параметры резервного копирования хранят информацию о пройденной процедуре регистрации в +// сервисе Облачного архива. +// +Функция ПодключениеОблачногоАрхиваВыполнено() Экспорт +``` + +Пример вызова +```bsl +Результат = ОблачныйАрхив20.ПодключениеОблачногоАрхиваВыполнено() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОблачныйАрхив20Клиент.md b/src/content/docs/zup/ОблачныйАрхив20Клиент.md new file mode 100644 index 0000000..f8af48d --- /dev/null +++ b/src/content/docs/zup/ОблачныйАрхив20Клиент.md @@ -0,0 +1,168 @@ +--- +title: Облачный архив20 клиент +slug: zup/облачный-архив20-клиент +--- + + +## Обслуживание_ОбработкаОповещения +
+ +Описание, пример вызова + +```bsl + +// Вызывается из обработчика ОбработкаОповещения формы Обслуживание панели администрирования БСП. Управляет отображением +// элементов управления связанных состоянием работы облачного архива. +// +// Параметры: +// Форма - см. Обработка.ПанельАдминистрированияБСП.Форма.Обслуживание +// ИмяСобытия - Строка +// Параметр - Произвольный +// Источник - Произвольный +// +Процедура Обслуживание_ОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) Экспорт +``` + +Пример вызова +```bsl +ОблачныйАрхив20Клиент.Обслуживание_ОбработкаОповещения(Форма, ИмяСобытия, Параметр, Источник) +``` +
+ +## Обслуживание_ХранениеРезервныхКопийПриИзменении +
+ +Описание, пример вызова + +```bsl + +// Управляет видимостью элементов в соответствии с выбранным вариантом хранения резервных копий. +// +// Параметры: +// Форма - см. Обработка.ПанельАдминистрированияБСП.Форма.Обслуживание +// ХранениеРезервныхКопий - Строка - способ хранения резервных копий: +// • "СтандартныеПодсистемы.РезервноеКопированиеИБ" - если используется подсистема резервного копирования БСП. +// • "ИнтернетПоддержкаПользователей.ОблачныйАрхив20" - если используется подсистема резервного копирования БИП. +// +Процедура Обслуживание_ХранениеРезервныхКопийПриИзменении(Форма, ХранениеРезервныхКопий) Экспорт +``` + +Пример вызова +```bsl +ОблачныйАрхив20Клиент.Обслуживание_ХранениеРезервныхКопийПриИзменении(Форма, ХранениеРезервныхКопий) +``` +
+ +## ОткрытьФормуНастройкиОблачногоАрхива +
+ +Описание, пример вызова + +```bsl + +// Вызывается из панели администрирования БСП. Открывает форму подключения, обновления или настройки Облачного архива в +// зависимости от текущего статуса работы подсистемы. +// +Процедура ОткрытьФормуНастройкиОблачногоАрхива() Экспорт +``` + +Пример вызова +```bsl +ОблачныйАрхив20Клиент.ОткрытьФормуНастройкиОблачногоАрхива() +``` +
+ +## ОткрытьФормуРезервногоКопирования +
+ +Описание, пример вызова + +```bsl + +// Вызывается из панели администрирования БСП. Открывает форму создания ручной резервной копии. +// +Процедура ОткрытьФормуРезервногоКопирования() Экспорт +``` + +Пример вызова +```bsl +ОблачныйАрхив20Клиент.ОткрытьФормуРезервногоКопирования() +``` +
+ +## ОткрытьСписокРезервныхКопий +
+ +Описание, пример вызова + +```bsl + +// Вызывается из панели администрирования БСП. Открывает веб-страницу списка ранее выполненных резервных копий на +// портале облачного архива. +// +Процедура ОткрытьСписокРезервныхКопий() Экспорт +``` + +Пример вызова +```bsl +ОблачныйАрхив20Клиент.ОткрытьСписокРезервныхКопий() +``` +
+ +## ПараметрыСозданияРезервнойКопии +
+ +Описание, пример вызова + +```bsl + +// Параметры создания резервной копии в Облачный архив. +// +// Возвращаемое значение: +// Структура: +// * Комментарий - Строка - дополнительная информация, которая будет отображаться в интерфейсе личного кабинета +// пользователя на портале Облачного архива. +// Значение по умолчанию: см. СтандартныеПодсистемыКлиент.ПараметрыРаботыКлиента свойство ЗаголовокПриложения. +// * ЗапуститьПриОткрытии - Булево - Истина, если необходимо незамедлительно запустить процесс резервного +// копирования. +// Значение по умолчанию: Ложь. +// +Функция ПараметрыСозданияРезервнойКопии() Экспорт +``` + +Пример вызова +```bsl +Результат = ОблачныйАрхив20Клиент.ПараметрыСозданияРезервнойКопии() +``` +
+ +## СоздатьРезервнуюКопию +
+ +Описание, пример вызова + +```bsl + +// Запускает процесс создания резервной копии в Облачный архив. +// +// Параметры: +// Параметры - Неопределено - запускает процесс создания резервной копии с параметрами по умолчанию. +// см. ОблачныйАрхив20Клиент.ПараметрыСозданияРезервнойКопии +// - см. ОблачныйАрхив20Клиент.ПараметрыСозданияРезервнойКопии +// +Процедура СоздатьРезервнуюКопию(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОблачныйАрхив20Клиент.СоздатьРезервнуюКопию(Параметры); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменДаннымиВнутренняяПубликация.md b/src/content/docs/zup/ОбменДаннымиВнутренняяПубликация.md new file mode 100644 index 0000000..932f1ec --- /dev/null +++ b/src/content/docs/zup/ОбменДаннымиВнутренняяПубликация.md @@ -0,0 +1,237 @@ +--- +title: Обмен данными внутренняя публикация +slug: zup/обмен-данными-внутренняя-публикация +--- + + +## ВыполнитьОбменДаннымиПоСценарию +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполнитьОбменДаннымиПоСценарию(КодСценарияОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВнутренняяПубликация.ВыполнитьОбменДаннымиПоСценарию(КодСценарияОбмена) +``` +
+ +## ВыполнитьОбменДаннымиВручную +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполнитьОбменДаннымиВручную(Узел, ПараметрыОбмена, ДополнениеВыгрузки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВнутренняяПубликация.ВыполнитьОбменДаннымиВручную(Узел, ПараметрыОбмена, ДополнениеВыгрузки); +``` +
+ +## ВыполнитьОчередьЗадач +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполнитьОчередьЗадач(Задача, ЗадачаПред = "") Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВнутренняяПубликация.ВыполнитьОчередьЗадач(Задача, ЗадачаПред); +``` +
+ +## ЗадачаПоИдентификатору +
+ +Описание, пример вызова + +```bsl + +Функция ЗадачаПоИдентификатору(ИдентификаторЗадачи) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиВнутренняяПубликация.ЗадачаПоИдентификатору(ИдентификаторЗадачи) +``` +
+ +## СледующаяЗадача +
+ +Описание, пример вызова + +```bsl + +Функция СледующаяЗадача(ИдентификаторЗадачи) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиВнутренняяПубликация.СледующаяЗадача(ИдентификаторЗадачи) +``` +
+ +## ПоУзлуЗапланированОбмен +
+ +Описание, пример вызова + +```bsl + +Функция ПоУзлуЗапланированОбмен(Узел, Сценарий = "", ИдентификаторОбмена = "") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиВнутренняяПубликация.ПоУзлуЗапланированОбмен(Узел, Сценарий, ИдентификаторОбмена); +``` +
+ +## ОтменитьОчередьЗадач +
+ +Описание, пример вызова + +```bsl + +Процедура ОтменитьОчередьЗадач(Узел, Сценарий, ИдентификаторОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВнутренняяПубликация.ОтменитьОчередьЗадач(Узел, Сценарий, ИдентификаторОбмена) +``` +
+ +## ОтметитьВыполнениеЗадачи +
+ +Описание, пример вызова + +```bsl + +Процедура ОтметитьВыполнениеЗадачи(Задача, Ошибка) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВнутренняяПубликация.ОтметитьВыполнениеЗадачи(Задача, Ошибка) +``` +
+ +## ПриОжиданииВыгрузкиДанных +
+ +Описание, пример вызова + +```bsl + +Процедура ПриОжиданииВыгрузкиДанных(ПараметрыОбмена, ПродолжитьОжидание) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВнутренняяПубликация.ПриОжиданииВыгрузкиДанных(ПараметрыОбмена, ПродолжитьОжидание) +``` +
+ +## ФормаУзлаПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +Процедура ФормаУзлаПриСозданииНаСервере(Форма, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВнутренняяПубликация.ФормаУзлаПриСозданииНаСервере(Форма, Отказ) +``` +
+ +## ВыполнитьВыгрузкуДляУзлаИнформационнойБазыВСервисПередачиФайлов +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполнитьВыгрузкуДляУзлаИнформационнойБазыВСервисПередачиФайлов(ИмяПланаОбмена, КодУзлаИнформационнойБазы, ИдентификаторЗадачи) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВнутренняяПубликация.ВыполнитьВыгрузкуДляУзлаИнформационнойБазыВСервисПередачиФайлов(ИмяПланаОбмена, КодУзлаИнформационнойБазы, ИдентификаторЗадачи) +``` +
+ +## ВыполнитьЗагрузкуДляУзлаИнформационнойБазыИзСервисаПередачиФайлов +
+ +Описание, пример вызова + +```bsl + +Процедура ВыполнитьЗагрузкуДляУзлаИнформационнойБазыИзСервисаПередачиФайлов(ИмяПланаОбмена, КодУзлаИнформационнойБазы, ИдентификаторЗадачи, ИдентификаторФайла) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВнутренняяПубликация.ВыполнитьЗагрузкуДляУзлаИнформационнойБазыИзСервисаПередачиФайлов(ИмяПланаОбмена, КодУзлаИнформационнойБазы, ИдентификаторЗадачи, ИдентификаторФайла) +``` +
+ +## ВСервисеДоступенExchangeAdministrationManage_3_0_1_1 +
+ +Описание, пример вызова + +```bsl + +Функция ВСервисеДоступенExchangeAdministrationManage_3_0_1_1() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиВнутренняяПубликация.ВСервисеДоступенExchangeAdministrationManage_3_0_1_1() +``` +
+ +## НастройкиОбменаДляУзлаИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +Функция НастройкиОбменаДляУзлаИнформационнойБазы(Узел, Действие, Отказ) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиВнутренняяПубликация.НастройкиОбменаДляУзлаИнформационнойБазы(Узел, Действие, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменДаннымиВнутренняяПубликацияВызовСервера.md b/src/content/docs/zup/ОбменДаннымиВнутренняяПубликацияВызовСервера.md new file mode 100644 index 0000000..ce2f631 --- /dev/null +++ b/src/content/docs/zup/ОбменДаннымиВнутренняяПубликацияВызовСервера.md @@ -0,0 +1,29 @@ +--- +title: Обмен данными внутренняя публикация вызов сервера +slug: zup/обмен-данными-внутренняя-публикация-вызов-сервера +--- + + +## ФлагНастройкиНеПредлагатьПерейтиНаВебСервис +
+ +Описание, пример вызова + +```bsl + +Функция ФлагНастройкиНеПредлагатьПерейтиНаВебСервис(ОбъектНастройки, Значение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиВнутренняяПубликацияВызовСервера.ФлагНастройкиНеПредлагатьПерейтиНаВебСервис(ОбъектНастройки, Значение); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменДаннымиВнутренняяПубликацияКлиент.md b/src/content/docs/zup/ОбменДаннымиВнутренняяПубликацияКлиент.md new file mode 100644 index 0000000..beb6f18 --- /dev/null +++ b/src/content/docs/zup/ОбменДаннымиВнутренняяПубликацияКлиент.md @@ -0,0 +1,29 @@ +--- +title: Обмен данными внутренняя публикация клиент +slug: zup/обмен-данными-внутренняя-публикация-клиент +--- + + +## ОбработкаНавигационнойСсылкиВФормеУзла +
+ +Описание, пример вызова + +```bsl + +Процедура ОбработкаНавигационнойСсылкиВФормеУзла(Форма, НавигационнаяСсылка, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиВнутренняяПубликацияКлиент.ОбработкаНавигационнойСсылкиВФормеУзла(Форма, НавигационнаяСсылка, СтандартнаяОбработка) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменДаннымиЗарплата3Бухгалтерия3.md b/src/content/docs/zup/ОбменДаннымиЗарплата3Бухгалтерия3.md new file mode 100644 index 0000000..08ba53f --- /dev/null +++ b/src/content/docs/zup/ОбменДаннымиЗарплата3Бухгалтерия3.md @@ -0,0 +1,81 @@ +--- +title: Обмен данными зарплата3 бухгалтерия3 +slug: zup/обмен-данными-зарплата3-бухгалтерия3 +--- + + +## ОбменИспользуется +
+ +Описание, пример вызова + +```bsl + +// Определяет использование обмена данными с БП3. +// Если в параметрах указана организация, то вычисляется использование обмена по этой организации, иначе по всем или любой. +// +// Параметры: +// Организация - СправочникСсылка.Организации, Неопределено - организация, для которой определяется использование обмена. +// НастройкиОбмена - Структура, Неопределено - описание см НастройкиОбмена(). +// +// Возвращаемое значение: +// Булево - Истина если обмен используется, Ложь - в противном случае. +// +Функция ОбменИспользуется(Организация = Неопределено, НастройкиОбмена = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиЗарплата3Бухгалтерия3.ОбменИспользуется(Организация, НастройкиОбмена); +``` +
+ +## ОбработкаРегистрацииНачальнойВыгрузкиДанных +
+ +Описание, пример вызова + +```bsl + +// См. ОбменДаннымиПереопределяемый.РегистрацияИзмененийНачальнойВыгрузкиДанных +Процедура ОбработкаРегистрацииНачальнойВыгрузкиДанных(Знач Получатель, СтандартнаяОбработка, Отбор) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиЗарплата3Бухгалтерия3.ОбработкаРегистрацииНачальнойВыгрузкиДанных(Получатель, СтандартнаяОбработка, Отбор) +``` +
+ +## НастройкиОбмена +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки обмена с БП3. +// +// Возвращаемое значение: +// Структура - настройки обмена, структура с ключами +// * ИспользуетсяОбменПоВсемОрганизациям - Булево +// * ИспользуетсяОбменПоОрганизациям - Булево +// * ИспользованиеОбменаПоОрганизациям - Соответствие +// * ПерсональныеДанныеНеВыгружаются - Булево +// +Функция НастройкиОбмена() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиЗарплата3Бухгалтерия3.НастройкиОбмена() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменДаннымиЗарплата3Бухгалтерия3Внутренний.md b/src/content/docs/zup/ОбменДаннымиЗарплата3Бухгалтерия3Внутренний.md new file mode 100644 index 0000000..79ba2aa --- /dev/null +++ b/src/content/docs/zup/ОбменДаннымиЗарплата3Бухгалтерия3Внутренний.md @@ -0,0 +1,29 @@ +--- +title: Обмен данными зарплата3 бухгалтерия3 внутренний +slug: zup/обмен-данными-зарплата3-бухгалтерия3-внутренний +--- + + +## ОбновитьНастройкиИспользованияОбменаДанными +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьНастройкиИспользованияОбменаДанными() Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиЗарплата3Бухгалтерия3Внутренний.ОбновитьНастройкиИспользованияОбменаДанными() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменДаннымиСобытияЗарплатаИУправлениеПерсоналом.md b/src/content/docs/zup/ОбменДаннымиСобытияЗарплатаИУправлениеПерсоналом.md new file mode 100644 index 0000000..eb3c0bf --- /dev/null +++ b/src/content/docs/zup/ОбменДаннымиСобытияЗарплатаИУправлениеПерсоналом.md @@ -0,0 +1,108 @@ +--- +title: Обмен данными события зарплата и управление персоналом +slug: zup/обмен-данными-события-зарплата-и-управление-персоналом +--- + + +## ОбменЗарплата3Бухгалтерия3ПередЗаписью +
+ +Описание, пример вызова + +```bsl +// Обмен Зарплата и управление персоналом 3.0 и Бухгалтерия предприятия 3.0. + +// Процедура-обработчик события "ПередЗаписью" ссылочных типов данных (кроме документов) для механизма регистрации +// объектов на узлах. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, для которого выполняется механизм регистрации. +// Источник - источник события, кроме типа ДокументОбъект. +// Отказ - Булево - флаг отказа от выполнения обработчика. +// +Процедура ОбменЗарплата3Бухгалтерия3ПередЗаписью(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытияЗарплатаИУправлениеПерсоналом.ОбменЗарплата3Бухгалтерия3ПередЗаписью(Источник, Отказ) +``` +
+ +## ОбменЗарплата3Бухгалтерия3ПередЗаписьюДокумента +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПередЗаписью" документов для механизма регистрации объектов на узлах. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, для которого выполняется механизм регистрации. +// Источник - ДокументОбъект - источник события. +// Отказ - Булево - флаг отказа от выполнения обработчика. +// +Процедура ОбменЗарплата3Бухгалтерия3ПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытияЗарплатаИУправлениеПерсоналом.ОбменЗарплата3Бухгалтерия3ПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) +``` +
+ +## ОбменЗарплата3Бухгалтерия3ПередЗаписьюРегистра +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПередЗаписью" регистров для механизма регистрации объектов на узлах. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, для которого выполняется механизм регистрации. +// Источник - НаборЗаписейРегистра - источник события. +// Отказ - Булево - флаг отказа от выполнения обработчика. +// Замещение - Булево - признак замещения существующего набора записей. +// +Процедура ОбменЗарплата3Бухгалтерия3ПередЗаписьюРегистра(Источник, Отказ, Замещение) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытияЗарплатаИУправлениеПерсоналом.ОбменЗарплата3Бухгалтерия3ПередЗаписьюРегистра(Источник, Отказ, Замещение) +``` +
+ +## ОбменЗарплата3Бухгалтерия3ПередУдалением +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события "ПередУдалением" ссылочных типов данных для механизма регистрации объектов на узлах. +// +// Параметры: +// ИмяПланаОбмена - Строка - имя плана обмена, для которого выполняется механизм регистрации. +// Источник - источник события. +// Отказ - Булево - флаг отказа от выполнения обработчика. +// +Процедура ОбменЗарплата3Бухгалтерия3ПередУдалением(Источник, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиСобытияЗарплатаИУправлениеПерсоналом.ОбменЗарплата3Бухгалтерия3ПередУдалением(Источник, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменДаннымиУниверсальныйФормат.md b/src/content/docs/zup/ОбменДаннымиУниверсальныйФормат.md new file mode 100644 index 0000000..a64429f --- /dev/null +++ b/src/content/docs/zup/ОбменДаннымиУниверсальныйФормат.md @@ -0,0 +1,125 @@ +--- +title: Обмен данными универсальный формат +slug: zup/обмен-данными-универсальный-формат +--- + + +## ИспользуетсяОбменУправлениеПредприятием2 +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак существования настроенной синхронизации с конфигурацией "1С:ERP Управление предприятием 2". +// Параметры: +// УдаляемыйУзел - ПланОбменаСсылка - Ссылка на удаляемый узел обмена. +// Возвращаемое значение: +// Булево - Истина, если есть хотя бы одна настроенная синхронизация с "1С:ERP Управление предприятием 2". +// +Функция ИспользуетсяОбменУправлениеПредприятием2(УдаляемыйУзел = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиУниверсальныйФормат.ИспользуетсяОбменУправлениеПредприятием2(УдаляемыйУзел); +``` +
+ +## ВедомостиВыгружаютсяКакЗаявки +
+ +Описание, пример вызова + +```bsl + +// Возвращает признак выгрузки ведомостей как заявок. +// +// Возвращаемое значение: +// Булево - Истина, если есть хотя бы одна настроенная синхронизация с с выгрузкой ведомостей как заявок. +// +Функция ВедомостиВыгружаютсяКакЗаявки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиУниверсальныйФормат.ВедомостиВыгружаютсяКакЗаявки() +``` +
+ +## РегистрацияИзмененияДляНачальнойВыгрузки +
+ +Описание, пример вызова + +```bsl + +// Обработчик регистрации изменений для начальной выгрузки данных. +// +// см. ОбменДаннымиПереопределяемый.РегистрацияИзмененийНачальнойВыгрузкиДанных() +// +Процедура РегистрацияИзмененияДляНачальнойВыгрузки(Знач Получатель, СтандартнаяОбработка, Отбор) Экспорт +``` + +Пример вызова +```bsl +ОбменДаннымиУниверсальныйФормат.РегистрацияИзмененияДляНачальнойВыгрузки(Получатель, СтандартнаяОбработка, Отбор) +``` +
+ +## ИспользуетсяОбменБП3 +
+ +Описание, пример вызова + +```bsl + +// Определяет использование обмена данными с БП3. +// Если в параметрах указана организация, то вычисляется использование обмена по этой организации, иначе по всем или любой. +// +// Параметры: +// Организация - СправочникСсылка.Организации, Неопределено - организация, для которой определяется использование обмена. +// +// Возвращаемое значение: +// Булево - Истина если обмен используется, Ложь - в противном случае. +// +Функция ИспользуетсяОбменБП3(Организация = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиУниверсальныйФормат.ИспользуетсяОбменБП3(Организация); +``` +
+ +## НастройкиОбменаБП3 +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки обмена с БП3. +// +// Возвращаемое значение: +// Структура - настройки обмена, структура с ключами +// * ИспользуетсяОбменПоВсемОрганизациям - Булево +// * ИспользуетсяОбменПоОрганизациям - Булево +// * ИспользованиеОбменаПоОрганизациям - Соответствие +// +Функция НастройкиОбменаБП3() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменДаннымиУниверсальныйФормат.НастройкиОбменаБП3() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменСБанками.md b/src/content/docs/zup/ОбменСБанками.md new file mode 100644 index 0000000..7041b6e --- /dev/null +++ b/src/content/docs/zup/ОбменСБанками.md @@ -0,0 +1,1001 @@ +--- +title: Обмен с банками +slug: zup/обмен-с-банками +--- + + +## ИспользуетсяСервисДиректБанк +
+ +Описание, пример вызова + +```bsl + +// Определяет, используется ли сервис 1C:ДиректБанк +// +// Возвращаемое значение: +// Булево - значение функциональной опции. +// +Функция ИспользуетсяСервисДиректБанк() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ИспользуетсяСервисДиректБанк() +``` +
+ +## ВозможенПрямойОбменСБанком +
+ +Описание, пример вызова + +```bsl + +// Определяет, возможен ли прямой обмен с банком +// +// Параметры: +// БИК - Строка - БИК банка +// Проект - Число, Неопределено - Признак проекта, которые поддерживает банк. +// * 1 - Платежные документы. +// * 2 - Зарплатные документы. +// * Неопределено - любой из проектов. +// Рекомендуется - Булево - (возвращаемый параметр) - признак, что в банке поддержано +// автоматическое получение настроек обмена. +// +// Возвращаемое значение: +// Булево - Если Истина, то возможен прямой обмен с банком, иначе Ложь. +// +Функция ВозможенПрямойОбменСБанком(БИК, Проект = Неопределено, Рекомендуется = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ВозможенПрямойОбменСБанком(БИК, Проект, Рекомендуется); +``` +
+ +## ФормаПросмотраЭД +
+ +Описание, пример вызова + +```bsl + +// Формирует табличный документ на основании данных электронного документа +// +// Параметры: +// СообщениеОбмена - ДокументСсылка.СообщениеОбменСБанками - ссылка на сообщение обмена с банком. +// +// Возвращаемое значение: +// ТабличныйДокумент, Неопределено - сформированная форма просмотра электронного документа или Неопределено. +// +Функция ФормаПросмотраЭД(СообщениеОбмена) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ФормаПросмотраЭД(СообщениеОбмена) +``` +
+ +## ГотовыеКОтправкеДокументы +
+ +Описание, пример вызова + +```bsl + +// Определяет готовые к отправке платежные документы +// +// Параметры: +// МассивДокументов - Массив из ОпределяемыйТип.ВладелецОбменСБанками - исходный массив документов, +// которые предполагается отправить в банк. +// +// Возвращаемое значение: +// Массив из ОпределяемыйТип.ВладелецОбменСБанками - массив документов, которые можно отправить в банк. +// +Функция ГотовыеКОтправкеДокументы(МассивДокументов) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ГотовыеКОтправкеДокументы(МассивДокументов) +``` +
+ +## НастройкаОбмена +
+ +Описание, пример вызова + +```bsl + +// Производит поиск настройки обмена с банком. Возвращает первую найденную настройку обмена. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - организация, указанная в настройке; +// Банк - ОпределяемыйТип.БанкОбменСБанками - банк, указанный в настройке; +// ТолькоДействительная - Булево - Истина - поиск только действующей настройки, Ложь - поиск любой настройки. +// +// Возвращаемое значение: +// СправочникСсылка.НастройкиОбменСБанками, Неопределено - найденная настройка обмена с банком. +// +Функция НастройкаОбмена(Организация, Банк = Неопределено, ТолькоДействительная = Истина) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.НастройкаОбмена(Организация, Банк, ТолькоДействительная); +``` +
+ +## ПолучитьСтатусыДокументов +
+ +Описание, пример вызова + +```bsl + +// Получает текущие статусы документов. +// +// Параметры: +// МассивОбъектов - Массив - документы, для которых требуется получить статусы +// * ДокументСсылка - ссылка на документ информационной базы +// МассивСтатусов - Массив - статусы документов из первого параметра +// * ПеречислениеСсылка.СтатусыОбменСБанками - текущий статус электронного документа, +// * Неопределено - нет актуального электронного документа для документа информационной базы. +// +Процедура ПолучитьСтатусыДокументов(МассивОбъектов, МассивСтатусов) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПолучитьСтатусыДокументов(МассивОбъектов, МассивСтатусов) +``` +
+ +## ПриВыводеНавигационнойСсылкиВФормеОбъектаИБ +
+ +Описание, пример вызова + +```bsl + +// Формирование текстового представления рекламы 1С:ДиректБанк. +// +// Параметры: +// ДополнительнаяИнформация - Структура - с полями: +// * Картинка - Картинка - картинка из библиотеки картинок; +// * Текст - Строка - форматированный текст надписи с навигационными ссылками. +// МассивСсылок - Массив - список ссылок на объекты. +Процедура ПриВыводеНавигационнойСсылкиВФормеОбъектаИБ(ДополнительнаяИнформация, МассивСсылок) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриВыводеНавигационнойСсылкиВФормеОбъектаИБ(ДополнительнаяИнформация, МассивСсылок) +``` +
+ +## ПараметрыОбмена +
+ +Описание, пример вызова + +```bsl + +// Получает параметры обмена с банком +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - ссылка на организацию. +// Банк - ОпределяемыйТип.БанкОбменСБанками - ссылка на банк. +// +// Возвращаемое значение: +// Неопределено - отсутствует настройка обмена с банком через сервис 1С:ДиректБанк. +// Структура - текущие параметры обмена с банком. Содержит поля: +// * НастройкаОбмена - СправочникСсылка.НастройкиОбменСБанками - ссылка на настройку обмена с банком. +// * Недействительна - Булево - признак отключенной настройки или помеченной на удаление. +// * ДоступноАвтоматическоеПолучениеВыписки - Булево - по текущей настройке обмена возможно получение выписки в автоматическом режиме. +// * ПринимаемыеВидыЭД - Массив - виды электронных документов, принимаемых банком. В элементах массива ПеречислениеСсылка.ВидыЭДОбменСБанками. +// * ДатаПоследнегоПолученияВыписки - Дата - дата последнего получения выписки банка. +// * ТекстОшибки - Строка - текст ошибки, которая произошла при последнем получении выписки. +// * ВключеноАвтоматическоеПолучениеВыписки - Булево - по текущей настройке обмена запущено автоматическое получение выписки банка. +// * ДатаПоследнейСинхронизации - Дата - дата последнего запуска синхронизации с банком. +// +Функция ПараметрыОбмена(Организация, Банк) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ПараметрыОбмена(Организация, Банк) +``` +
+ +## НастройкиОбмена +
+ +Описание, пример вызова + +```bsl + +// Формирует таблицу с настройками обмена по переданной таблице отбора +// +// Параметры: +// ТаблицаОтбора - ТаблицаЗначений - Таблица отбора, содержит колонки: +// * Организация - ОпределяемыйТип.Организация - ссылка на организацию +// * Банк - ОпределяемыйТип.БанкОбменСБанками - ссылка на банк. +// +// Возвращаемое значение: +// ТаблицаЗначений - содержит таблицу отбора, с дополнительными колонками: +// * Организация - ОпределяемыйТип.Организация - ссылка на организацию +// * Банк - ОпределяемыйТип.БанкОбменСБанками - ссылка на банк. +// * ЕстьНастройкаОбмена - Булево - для данной строки отбора существует действующая настройка обмена. +// * НастройкаОбмена - СправочникСсылка.НастройкиОбменСБанками - ссылка на настройку обмена с банком. +// +Функция НастройкиОбмена(ТаблицаОтбора) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.НастройкиОбмена(ТаблицаОтбора) +``` +
+ +## БанкиСПрямымОбменом +
+ +Описание, пример вызова + +```bsl + +// Получает таблицу БИКов банков, поддерживающих прямой обмен +// +// Возвращаемое значение: +// ТаблицаЗначений - содержит информацию по банкам, поддерживающим прямой обмен +// * БИК - строка - БИК банка +// * ЗарплатныйПроект - Булево - признак поддержки банком зарплатного проекта. +// +Функция БанкиСПрямымОбменом() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.БанкиСПрямымОбменом() +``` +
+ +## ПараметрыСозданияФормыСписка +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбменСБанкамиКлиентСервер.ПараметрыСозданияФормыСписка. +// Формирует параметры создания формы списка документов. +// +// Возвращаемое значение: +// Структура - содержит поля: +// * ГруппаКоманд - Структура - параметры создания группы команд 1С:ДиректБанк, содержит поля: +// ** Добавить - Булево - если Истина (по умолчанию), то группа команд будет создана автоматически +// ** Родитель - ГруппаФормы, ТаблицаФормы, ФормаКлиентскогоПриложения - родитель для добавляемого элемента. +// Если не задан, то родителем будет являться ФормаОбъект.КоманднаяПанель. +// ** МестоРасположения - Строка - имя элемента, перед которым нужно разместить группу команд. +// Если не задан, то группа помещается в конец командной панели формы. +// * ДинамическийСписок - Структура - параметры изменения запроса динамического списка: +// ** Изменить - Булево - если Истина (по умолчанию), то в запрос динамического списка добавляются +// дополнительные поля. +// ** ИмяРеквизита - Строка - имя реквизита формы динамического списка. "Список" по-умолчанию. +// * СписокДокументов - Структура - параметры добавления колонок в список документов: +// ** ДобавитьКолонки - Булево - если Истина (по умолчанию), то в список добавляются дополнительные колонки. +// ** ИмяЭлемента - Строка - имя элемента формы динамического списка документов. "Список" по-умолчанию +// ** ИмяРеквизита - Строка - имя реквизита формы динамического списка документов. "Список" по-умолчанию +// ** МестоРасположения - Строка - имя элемента, перед которым нужно разместить новую колонку. +// Если не задан, то перемещается в конец колонок таблицы. +// * ПерепискаСБанками - Структура - параметры добавления ссылки на переписку с банками: +// ** ДобавитьСсылку - Булево - если Истина (по умолчанию), то добавляется ссылка на переписку с банками. +// ** Родитель - Строка - имя родителя добавляемого элемента. +// Если не указан, то элемент добавляется в конец формы. +// ** МестоРасположения - Строка - имя элемента, перед которым нужно разместить ссылку на переписку с банками. +// * Реклама - Структура - параметры отображения рекламы ДиректБанк: +// ** Добавить - Булево - если Истина (по умолчанию), то на форму добавляется реклама ДиректБанка. +// ** Родитель - Строка - имя родителя добавляемого элемента. +// Если не указан, то элемент добавляется в конец формы. +// ** МестоРасположения - Строка - имя элемента, перед которым нужно разместить рекламу. +// +Функция ПараметрыСозданияФормыСписка() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ПараметрыСозданияФормыСписка() +``` +
+ +## ПараметрыСозданияФормыДокумента +
+ +Описание, пример вызова + +```bsl + +// Устарела. Следует использовать ОбменСБанкамиКлиентСервер.ПараметрыСозданияФормыДокумента. +// Формирует параметры для дополнения формы документа +// +// Возвращаемое значение: +// Структура - Описание: +// * МестоРасположенияСостояния - Строка - элемент, перед которым нужно разместить состояние документа. +// * РодительСостояния - Строка - элемент, в котором нужно разместить состояние. +Функция ПараметрыСозданияФормыДокумента() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ПараметрыСозданияФормыДокумента() +``` +
+ +## ПолучитьДанныеВыпискиБанкаДеревоЗначений +
+ +Описание, пример вызова + +```bsl + +// Получает выписку банка в виде дерева значений. +// +// Параметры: +// ЭлектронныеДокументы - ДокументСсылка.СообщениеОбменСБанками, Массив - содержит выписку банка; +// ДеревоДанных - ДеревоЗначений - содержит дерево данных выписки. +// +Процедура ПолучитьДанныеВыпискиБанкаДеревоЗначений(ЭлектронныеДокументы, ДеревоДанных) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПолучитьДанныеВыпискиБанкаДеревоЗначений(ЭлектронныеДокументы, ДеревоДанных) +``` +
+ +## ПолучитьДанныеВыпискиБанкаТекстовыйФормат +
+ +Описание, пример вызова + +```bsl + +// Получает выписку банка в текстовом формате, а также массив ссылок на банковские счета организаций в выписке. +// +// Параметры: +// СообщениеОбмена - ДокументСсылка.СообщениеОбменСБанками, Массив - содержит ссылку или массив ссылок на выписки банка +// СсылкаНаХранилище - Строка - содержит ссылку на хранилище тестовых данных; +// МассивСчетов - Массив - содержит ссылки на банковские счета организации. +// +Процедура ПолучитьДанныеВыпискиБанкаТекстовыйФормат( Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПолучитьДанныеВыпискиБанкаТекстовыйФормат(); +``` +
+ +## ДанныеВыпискиБанкаТаблицаЗначений +
+ +Описание, пример вызова + +```bsl + +// Получает выписку банка в виде таблицы значений. +// Повторяет структуру макета Обработки.ОбменСБанками.Макеты.ВыпискаБанка. +// +// Параметры: +// ЭлектронныеДокументы - ДокументСсылка.СообщениеОбменСБанками, Массив - содержит выписку банка. +// +// Возвращаемое значение: +// ТаблицаЗначений - содержит данные выписки. +// Структура соответствует макету Обработки.ОбменСБанками.Макеты.ВыпискаБанка. +// +Функция ДанныеВыпискиБанкаТаблицаЗначений(ЭлектронныеДокументы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ДанныеВыпискиБанкаТаблицаЗначений(ЭлектронныеДокументы) +``` +
+ +## ПравоВыполненияОбмена +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность выполнения обмена с банком для текущего пользователя +// +// Параметры: +// ВыводитьСообщение - Булево - признак необходимости вывода сообщения о недостаточности прав. +// +// Возвращаемое значение: +// Булево - наличие права на выполнение обмена с банком. +// +Функция ПравоВыполненияОбмена(ВыводитьСообщение = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ПравоВыполненияОбмена(ВыводитьСообщение); +``` +
+ +## ПравоЧтенияДанных +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность чтения данных обмена с банком для текущего пользователя +// +// Параметры: +// ВыводитьСообщение - Булево - признак необходимости вывода сообщения о недостаточности прав. +// +// Возвращаемое значение: +// Булево - наличие права на чтение данных обмена с банком. +// +Функция ПравоЧтенияДанных(ВыводитьСообщение = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ПравоЧтенияДанных(ВыводитьСообщение); +``` +
+ +## ПравоНастройки +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность настройки обмена с банком для текущего пользователя +// +// Возвращаемое значение: +// Булево - наличие права на настройку обмена с банком. +// +Функция ПравоНастройки() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ПравоНастройки() +``` +
+ +## ПравоЧтенияНастроек +
+ +Описание, пример вызова + +```bsl + +// Проверяет возможность чтения настроек обмена с банками для текущего пользователя +// +// Возвращаемое значение: +// Булево - наличие права на чтение настроек обмена с банком. +// +Функция ПравоЧтенияНастроек() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.ПравоЧтенияНастроек() +``` +
+ +## ПриСозданииФормыСпискаНаСервере +
+ +Описание, пример вызова + +```bsl + +// Дополняет форму списка документов, отправляемых в банк. +// +// Параметры: +// ФормаОбъект - ФормаКлиентскогоПриложения - дополняемая форма +// Параметры - см. ОбменСБанкамиКлиентСервер.ПараметрыСозданияФормыСписка +Процедура ПриСозданииФормыСпискаНаСервере(ФормаОбъект, Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриСозданииФормыСпискаНаСервере(ФормаОбъект, Параметры); +``` +
+ +## ПриСозданииФормыДокументаНаСервере +
+ +Описание, пример вызова + +```bsl + +// Событие возникает при создании формы документа. Добавляет элементы на форму +// +// Параметры: +// ФормаОбъект - ФормаКлиентскогоПриложения - дополняемая форма +// Параметры - см. ПараметрыСозданияФормыДокумента +Процедура ПриСозданииФормыДокументаНаСервере(ФормаОбъект, Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриСозданииФормыДокументаНаСервере(ФормаОбъект, Параметры); +``` +
+ +## ПослеЗаписиНаСервере +
+ +Описание, пример вызова + +```bsl + +// Событие записи документа из формы. Обновляет текст состояния обмена с банком. +// +// Параметры: +// ФормаОбъект - ФормаКлиентскогоПриложения - форма, на которой произошла запись объекта. +// ТекущийОбъект - ОпределяемыйТип.ВладелецОбъектОбменСБанками - записываемый объект. +// ПараметрыЗаписи - Структура - Структура, содержащая параметры записи. +Процедура ПослеЗаписиНаСервере(ФормаОбъект, ТекущийОбъект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПослеЗаписиНаСервере(ФормаОбъект, ТекущийОбъект, ПараметрыЗаписи) +``` +
+ +## ДоступныНовыеДанные +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении уведомления о новых данных. +// В теле следует проверить, необходимы ли эти данные приложению, +// и если да - установить флажок Загружать. +// +// Параметры: +// Дескриптор - ОбъектXDTO - Descriptor. +// Загружать - Булево - возвращаемое. +// +Процедура ДоступныНовыеДанные(Знач Дескриптор, Загружать) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ДоступныНовыеДанные(Дескриптор, Загружать) +``` +
+ +## ОбработатьНовыеДанные +
+ +Описание, пример вызова + +```bsl + +// Вызывается после вызова ДоступныНовыеДанные, позволяет разобрать данные. +// +// Параметры: +// Дескриптор - ОбъектXDTO - Дескриптор. +// ПутьКФайлу - Строка - Полное имя извлеченного файла. Файл будет автоматически удален +// после завершения процедуры. +// +Процедура ОбработатьНовыеДанные(Знач Дескриптор, Знач ПутьКФайлу) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ОбработатьНовыеДанные(Дескриптор, ПутьКФайлу) +``` +
+ +## ОбработкаДанныхОтменена +
+ +Описание, пример вызова + +```bsl + +// Вызывается при отмене обработки данных в случае сбоя. +// +// Параметры: +// Дескриптор - ОбъектXDTO - Descriptor. +// +//@skip-warning +Процедура ОбработкаДанныхОтменена(Знач Дескриптор) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ОбработкаДанныхОтменена(Дескриптор) +``` +
+ +## СостояниеБанковскогоДокументаСтрокой +
+ +Описание, пример вызова + +```bsl + +// Получает сводное состояние банковского документа в виде строки. +// +// Параметры: +// СостояниеЭД - ПеречислениеСсылка.СостоянияОбменСБанками - текущее состояние электронного документооборота. +// +// Возвращаемое значение: +// Строка - сводное упрощенное состояние. +// +Функция СостояниеБанковскогоДокументаСтрокой(СостояниеЭД) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанками.СостояниеБанковскогоДокументаСтрокой(СостояниеЭД) +``` +
+ +## ОбработатьРегистрПодписываемыеВидыЭД +
+ +Описание, пример вызова + +```bsl + +// Заполняет регистр сведений ПодписываемыеВидыЭД +// +// Параметры: +// Параметры - Структура - параметры обработки обновления. +// +Процедура ОбработатьРегистрПодписываемыеВидыЭД(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ОбработатьРегистрПодписываемыеВидыЭД(Параметры) +``` +
+ +## ПеренестиСтатусыЭлектронныхПодписей +
+ +Описание, пример вызова + +```bsl + +// Переносит статусы проверки подписей из документа СообщениеОбменСБанками в справочник СообщениеОбменСБанкамиПрисоединенныеФайлы +// +// Параметры: +// Параметры - Структура - параметры обработки обновления. +// +Процедура ПеренестиСтатусыЭлектронныхПодписей(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПеренестиСтатусыЭлектронныхПодписей(Параметры) +``` +
+ +## ВключитьАвтоматическоеОбновлениеСпискаБанков +
+ +Описание, пример вызова + +```bsl + +// Включает регламентное задание ЗагрузкаСпискаБанковОбменСБанками +// +// Параметры: +// Параметры - Структура - параметры обработки обновления. +// +Процедура ВключитьАвтоматическоеОбновлениеСпискаБанков(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ВключитьАвтоматическоеОбновлениеСпискаБанков(Параметры) +``` +
+ +## ДобавитьБазовыеПраваЭД +
+ +Описание, пример вызова + +```bsl + +// Процедура - Добавить базовые права ЭД +// +// Параметры: +// ОписаниеПрофиля - см. УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа. +// +Процедура ДобавитьБазовыеПраваЭД(ОписаниеПрофиля) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ДобавитьБазовыеПраваЭД(ОписаниеПрофиля) +``` +
+ +## ДобавитьВыполнениеОбменаЭД +
+ +Описание, пример вызова + +```bsl + +// Процедура - Добавить права на выполнение обмена +// +// Параметры: +// ОписаниеПрофиля - см. УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа. +// +Процедура ДобавитьВыполнениеОбменаЭД(ОписаниеПрофиля) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ДобавитьВыполнениеОбменаЭД(ОписаниеПрофиля) +``` +
+ +## ДобавитьНастройкуПараметровЭД +
+ +Описание, пример вызова + +```bsl + +// Процедура - Добавить права на изменение настроек обмена +// +// Параметры: +// ОписаниеПрофиля - см. УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа. +// +Процедура ДобавитьНастройкуПараметровЭД(ОписаниеПрофиля) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ДобавитьНастройкуПараметровЭД(ОписаниеПрофиля) +``` +
+ +## ДобавитьЧтениеЭД +
+ +Описание, пример вызова + +```bsl + +// Процедура - Добавить права на чтение настроек обмена +// +// Параметры: +// ОписаниеПрофиля - см. УправлениеДоступом.НовоеОписаниеПрофиляГруппДоступа. +// +Процедура ДобавитьЧтениеЭД(ОписаниеПрофиля) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ДобавитьЧтениеЭД(ОписаниеПрофиля) +``` +
+ +## ПриСозданииФормыПроверкаСертификата +
+ +Описание, пример вызова + +```bsl + +// См. процедуру ЭлектроннаяПодписьПереопределяемый.ПриСозданииФормыПроверкаСертификата. +// +Процедура ПриСозданииФормыПроверкаСертификата( Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриСозданииФормыПроверкаСертификата(); +``` +
+ +## ПриПопыткеЗанятьФайл +
+ +Описание, пример вызова + +```bsl + +// См. процедуру РаботаСФайламиПереопределяемый.ПриПопыткеЗанятьФайл. +Процедура ПриПопыткеЗанятьФайл(ДанныеФайла, ОписаниеОшибки) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриПопыткеЗанятьФайл(ДанныеФайла, ОписаниеОшибки) +``` +
+ +## ПриОпределенииОбъектовСКомандамиПечати +
+ +Описание, пример вызова + +```bsl + +// См. процедуру УправлениеПечатьюПереопределяемый.ПриОпределенииОбъектовСКомандамиПечати. +Процедура ПриОпределенииОбъектовСКомандамиПечати(СписокОбъектов) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриОпределенииОбъектовСКомандамиПечати(СписокОбъектов) +``` +
+ +## ПриЗаполненииВидовОграниченийПравОбъектовМетаданных +
+ +Описание, пример вызова + +```bsl + +// См. ЭлектронноеВзаимодействие.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных +Процедура ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриЗаполненииВидовОграниченийПравОбъектовМетаданных(Описание) +``` +
+ +## ПриПолученииСпискаШаблонов +
+ +Описание, пример вызова + +```bsl + +// См. ЭлектронноеВзаимодействие.ПриПолученииСпискаШаблонов. +Процедура ПриПолученииСпискаШаблонов(ШаблоныЗаданий) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриПолученииСпискаШаблонов(ШаблоныЗаданий) +``` +
+ +## ПриОпределенииПсевдонимовОбработчиков +
+ +Описание, пример вызова + +```bsl + +// См. ЭлектронноеВзаимодействие.ПриОпределенииПсевдонимовОбработчиков. +Процедура ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриОпределенииПсевдонимовОбработчиков(СоответствиеИменПсевдонимам) +``` +
+ +## ПриОпределенииНастроекРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// См. процедуру ЭлектронноеВзаимодействие.ПриОпределенииНастроекРегламентныхЗаданий. +// +Процедура ПриОпределенииНастроекРегламентныхЗаданий(Настройки) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриОпределенииНастроекРегламентныхЗаданий(Настройки) +``` +
+ +## ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам +
+ +Описание, пример вызова + +```bsl + +// СтандартныеПодсистемы.ПрофилиБезопасности +// См. РаботаВБезопасномРежимеПереопределяемый.ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам +Процедура ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам(ЗапросыРазрешений) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриЗаполненииРазрешенийНаДоступКВнешнимРесурсам(ЗапросыРазрешений) +``` +
+ +## ПриОпределенииВидовПодключаемыхКоманд +
+ +Описание, пример вызова + +```bsl + +// См. ПодключаемыеКомандыПереопределяемый.ПриОпределенииВидовПодключаемыхКоманд. +Процедура ПриОпределенииВидовПодключаемыхКоманд(ВидыПодключаемыхКоманд) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриОпределенииВидовПодключаемыхКоманд(ВидыПодключаемыхКоманд) +``` +
+ +## ПриОпределенииКомандПодключенныхКОбъекту +
+ +Описание, пример вызова + +```bsl + +// См. ПодключаемыеКомандыПереопределяемый.ПриОпределенииКомандПодключенныхКОбъекту. +Процедура ПриОпределенииКомандПодключенныхКОбъекту(НастройкиФормы, Источники, ПодключенныеОтчетыИОбработки, Команды) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриОпределенииКомандПодключенныхКОбъекту(НастройкиФормы, Источники, ПодключенныеОтчетыИОбработки, Команды) +``` +
+ +## ПриОпределенииИспользуемыхВерсийВнешнихКомпонент +
+ +Описание, пример вызова + +```bsl + +// См. процедуру ПолучениеВнешнихКомпонентВМоделиСервисаПереопределяемый.ПриОпределенииИспользуемыхВерсийВнешнихКомпонент +// +Процедура ПриОпределенииИспользуемыхВерсийВнешнихКомпонент(Идентификаторы) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанками.ПриОпределенииИспользуемыхВерсийВнешнихКомпонент(Идентификаторы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменСБанкамиВыплатыСамозанятымПереопределяемый.md b/src/content/docs/zup/ОбменСБанкамиВыплатыСамозанятымПереопределяемый.md new file mode 100644 index 0000000..2ee5c1f --- /dev/null +++ b/src/content/docs/zup/ОбменСБанкамиВыплатыСамозанятымПереопределяемый.md @@ -0,0 +1,89 @@ +--- +title: Обмен с банками выплаты самозанятым переопределяемый +slug: zup/обмен-с-банками-выплаты-самозанятым-переопределяемый +--- + + +## ДанныеПлатежногоПорученияРеестраВыплатСамозанятым +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные в виде структуры по связанному документу ПлатежноеПоручение +// +// Параметры: +// РеестрВыплатыСамозанятым - ДокументСсылка +// ДанныеПлатежногоПоручения - Структура - структура задается функцией-конструктором ОбменСБанкамиВыплатыСамозанятымСлужебный.ДанныеПлатежногоПоручения() +// +Процедура ДанныеПлатежногоПорученияРеестраВыплатСамозанятым(РеестрВыплатыСамозанятым, ДанныеПлатежногоПоручения) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиВыплатыСамозанятымПереопределяемый.ДанныеПлатежногоПорученияРеестраВыплатСамозанятым(РеестрВыплатыСамозанятым, ДанныеПлатежногоПоручения) +``` +
+ +## ДанныеРеестраВыплатСамозанятым +
+ +Описание, пример вызова + +```bsl + +// Получает данные документов из документа РеестрВыплатыСамозанятым и заполняет данные в структуре ДанныеДокументов +// +// Параметры: +// РеестрВыплатыСамозанятым - ДокументСсылка - ссылка на документ, +// по которому требуется получить данные. +// ДанныеДокумента - Структура - структура задается функцией-конструктором +// ОбменСБанкамиВыплатыСамозанятымСлужебный.ДанныеЗаполненияРеестрВыплатСамозанятым() +// +Процедура ДанныеРеестраВыплатСамозанятым(РеестрВыплатыСамозанятым, ДанныеДокумента) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиВыплатыСамозанятымПереопределяемый.ДанныеРеестраВыплатСамозанятым(РеестрВыплатыСамозанятым, ДанныеДокумента) +``` +
+ +## ПриЗагрузкеРеестраЧековВыплатСамозанятым +
+ +Описание, пример вызова + +```bsl + +// Осуществляет загрузку информации по чекам самозанятых в документ Выплаты самозанятым +// +// Параметры: +// ДанныеЗаполнения - Структура - данные для заполнения информации по чекам +// - ОбщиеДанные - Структура - данные для заполнения обшей информации по чекам, +// определяется функцией-конструктором ОбменСБанкамиВыплатыСамозанятымСлужебный.ДанныеЗаполнения() +// - МассивЧеков - Массив - массив из структур ДанныеЗаполненияЧекСамозанятого +// * ДанныеЗаполненияЧекСамозанятого - Структура - данные для заполнения информации по чекам по каждому самозанятому, +// определяется функцией-конструктором ОбменСБанкамиВыплатыСамозанятымСлужебный.ДанныеЗаполнения() +// - КонтрольныеСуммы - Структура - данные для контроля заполнения +// * КоличествоЗаписей - Число - количество записей про выплаты самозанятым +// * СуммаИтого - Число - итоговая сумма, выплаченная самозанятым банком +// СсылкаНаДокумент - ДокументСсылка - документ, в котором происходит заполнение данных +// +Процедура ПриЗагрузкеРеестраЧековВыплатСамозанятым(ДанныеЗаполнения, СсылкаНаДокумент) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиВыплатыСамозанятымПереопределяемый.ПриЗагрузкеРеестраЧековВыплатСамозанятым(ДанныеЗаполнения, СсылкаНаДокумент) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменСБанкамиКлиент.md b/src/content/docs/zup/ОбменСБанкамиКлиент.md new file mode 100644 index 0000000..0add289 --- /dev/null +++ b/src/content/docs/zup/ОбменСБанкамиКлиент.md @@ -0,0 +1,542 @@ +--- +title: Обмен с банками клиент +slug: zup/обмен-с-банками-клиент +--- + + +## ОткрытьСоздатьНастройкуОбмена +
+ +Описание, пример вызова + +```bsl + +// Создает настройку обмена с банком или открывает существующую. +// Если банк не известен системе, то открывается форма новой настройки обмена с банком, +// в которой заполнена только Организация и Банк. +// Если банк известен системе, но не поддерживает автоматическое получение настроек, +// то предлагается выбор файла настроек, загружает настройки из файла +// и открывает заполненную форму настроек обмена с банком. +// Если банк известен системе и поддерживает автоматическое получение настроек, +// то настройка создается автоматически и производится тест настроек. +// +// Параметры: +// Организация - СправочникСсылка.Организации - ссылка на организацию. +// Банк - СправочникСсылка.КлассификаторБанков - ссылка на банк. +// НомерБанковскогоСчета - Строка - номер банковского счета. +// ОбработчикОповещения - ОписаниеОповещения - содержит описание процедуры, +// которая будет вызвана после создания настройки обмена с банком, не вызывается если настройка обмена уже существует. Параметры процедуры: +// * НастройкаОбмена - СправочникСсылка.НастройкиОбменСБанками - созданная настройка обмена с банком. +// * ДополнительныеПараметры - Произвольный - значение, которое было указано при создании объекта ОписаниеОповещения. +// +Процедура ОткрытьСоздатьНастройкуОбмена(Организация, Банк, НомерБанковскогоСчета = "", ОбработчикОповещения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОткрытьСоздатьНастройкуОбмена(Организация, Банк, НомерБанковскогоСчета, ОбработчикОповещения); +``` +
+ +## ОткрытьНастройкиDirectBankСОтбором +
+ +Описание, пример вызова + +```bsl + +// Открывает форму списка настроек обмена с отбором по организации или банку. +// +// Параметры: +// СсылкаНаОбъект - СправочникСсылка - ссылка на объект отбора. Ссылка должна быть только на организацию или банк. +// +Процедура ОткрытьНастройкиDirectBankСОтбором(СсылкаНаОбъект) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОткрытьНастройкиDirectBankСОтбором(СсылкаНаОбъект) +``` +
+ +## ОбработкаНавигационнойСсылкиРекламыДиректБанк +
+ +Описание, пример вызова + +```bsl + +// Процедура обрабатывает нажатие ссылки форматированной строки рекламы 1С:ДиректБанк. +// +// Параметры: +// НавигационнаяСсылка - Строка - текст навигационной ссылки; +// СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события. +// +Процедура ОбработкаНавигационнойСсылкиРекламыДиректБанк(НавигационнаяСсылка, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОбработкаНавигационнойСсылкиРекламыДиректБанк(НавигационнаяСсылка, СтандартнаяОбработка) +``` +
+ +## ВключитьАвтоматическоеПолучениеВыписки +
+ +Описание, пример вызова + +```bsl + +// Включает автоматическое получение выписки. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение, вызываемое после выполнения процедуры. Параметры выполнения: +// Результат - Булево - если Истина, то автоматическое получение выписки подключено успешно. +// Организация - ОпределяемыйТип.Организация - ссылка на организацию. +// Банк - ОпределяемыйТип.БанкОбменСБанками - ссылка на банк. +// +Процедура ВключитьАвтоматическоеПолучениеВыписки(Оповещение, Организация, Банк) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ВключитьАвтоматическоеПолучениеВыписки(Оповещение, Организация, Банк) +``` +
+ +## ОтключитьАвтоматическоеПолучениеВыписки +
+ +Описание, пример вызова + +```bsl + +// Отключает автоматическое получение выписки. +// +// Параметры: +// Организация - ОпределяемыйТип.Организация - ссылка на организацию. +// Банк - ОпределяемыйТип.БанкОбменСБанками - ссылка на банк. +// +// Возвращаемое значение: +// Булево - Истина, если автоматическое получение выписки было отключено. +// +Функция ОтключитьАвтоматическоеПолучениеВыписки(Организация, Банк) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанкамиКлиент.ОтключитьАвтоматическоеПолучениеВыписки(Организация, Банк) +``` +
+ +## ПолучитьВыписку +
+ +Описание, пример вызова + +```bsl + +// Отправляет запрос выписки в банк, а после получения выписки вызывает обработчик из оповещения. +// +// Параметры: +// Оповещение - ОписаниеОповещения - оповещение, вызываемое после получения выписки банка. +// * Результат - Структура - содержит следующие поля: +// ** Успех - Булево - если Истина, то операция успешно выполнена. +// ** Выписки - Массив - массив документов, содержащих данные выписок. +// *** ДокументСсылка.СообщениеОбменСБанками - ссылка на сообщение обмена с выпиской банка. +// БанковскийСчет - ОпределяемыйТип.СчетОрганизацииОбменСБанками - ссылка на банковский счет организации +// ДатаНачала - Дата - начало периода запроса. +// ДатаОкончания - Дата - окончание периода запроса. +// +Процедура ПолучитьВыписку(Оповещение, БанковскийСчет, ДатаНачала, Знач ДатаОкончания) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ПолучитьВыписку(Оповещение, БанковскийСчет, ДатаНачала, ДатаОкончания) +``` +
+ +## СинхронизироватьСБанком +
+ +Описание, пример вызова + +```bsl + +// Отправляет подготовленные документы в банк и получает новые. +// Если параметры не переданы то выполняется синхронизация по всем настройкам с банками. +// +// Параметры: +// Организация - СправочникСсылка.Организации - организация из расчетного счета. +// Банк - СправочникСсылка.КлассификаторБанков - банк из расчетного счета. +// +Процедура СинхронизироватьСБанком(Организация = Неопределено, Банк = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.СинхронизироватьСБанком(Организация, Банк); +``` +
+ +## СформироватьПодписатьОтправитьЭД +
+ +Описание, пример вызова + +```bsl + +// Процедура создает, подписывает и отправляет электронный документ. +// +// Параметры: +// ПараметрКоманды - ДокументСсылка, Массив - ссылки на документы ИБ, которые необходимо отправить в банк. +// СообщениеОбмена - ДокументСсылка.СообщениеОбменСБанками - электронный документ, который надо подписать, отправить. +// +Процедура СформироватьПодписатьОтправитьЭД(ПараметрКоманды, СообщениеОбмена = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.СформироватьПодписатьОтправитьЭД(ПараметрКоманды, СообщениеОбмена); +``` +
+ +## ОтправитьПовторноЭД +
+ +Описание, пример вызова + +```bsl + +// Процедура отправляет повторно электронный документ. +// +// Параметры: +// ПараметрКоманды - ОпределяемыйТип.ВладелецОбменСБанками - ссылка на объект ИБ, +// электронные документы которого нужно отправить, +// СообщениеОбмена - ДокументСсылка.СообщениеОбменСБанками - сообщение, которые нужно отправить. +// +Процедура ОтправитьПовторноЭД(ПараметрКоманды, СообщениеОбмена = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОтправитьПовторноЭД(ПараметрКоманды, СообщениеОбмена); +``` +
+ +## ОткрытьАктуальныйЭД +
+ +Описание, пример вызова + +```bsl + +// Открывает актуальный ЭД по документу ИБ +// +// Параметры: +// ПараметрКоманды - ДокументСсылка- ссылка на документ ИБ; +// Источник - ФормаКлиентскогоПриложения - Форма источник; +// ПараметрыОткрытия - Структура - дополнительные параметры просмотра. +// +Процедура ОткрытьАктуальныйЭД(ПараметрКоманды, Источник = Неопределено, ПараметрыОткрытия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОткрытьАктуальныйЭД(ПараметрКоманды, Источник, ПараметрыОткрытия); +``` +
+ +## ОткрытьСписокЭД +
+ +Описание, пример вызова + +```bsl + +// Открывает форму со списком электронных документов для данного владельца. +// +// Параметры: +// СсылкаНаОбъект - ДокументСсылка - Ссылка на объект ИБ, электронные документы которого надо увидеть или сообщение обмена. +// ПараметрыОткрытия - Структура - дополнительные параметры просмотра списка электронных документов. +// +Процедура ОткрытьСписокЭД(СсылкаНаОбъект, ПараметрыОткрытия = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОткрытьСписокЭД(СсылкаНаОбъект, ПараметрыОткрытия); +``` +
+ +## СформироватьНовыйЭД +
+ +Описание, пример вызова + +```bsl + +// Процедура создает новый электронный документ. +// +// Параметры: +// ПараметрКоманды - ОпределяемыйТип.ВладелецОбменСБанками - ссылка на объект ИБ, +// электронные документы которого надо отправить. +// Показывать - Булево - признак того что созданный документ будет показан пользователю. +// +Процедура СформироватьНовыйЭД(ПараметрКоманды, Показывать=Истина) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.СформироватьНовыйЭД(ПараметрКоманды, Показывать); +``` +
+ +## ОткрытьФормуПросмотраЭлектронногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Открывает форму просмотра электронного документа. +// +// Параметры: +// СообщениеОбмена - ДокументСсылка.СообщениеОбменСБанками - сообщение, в которому привязан открываемый электронный документ. +// +Процедура ОткрытьФормуПросмотраЭлектронногоДокумента(СообщениеОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОткрытьФормуПросмотраЭлектронногоДокумента(СообщениеОбмена) +``` +
+ +## ПриДополнительнойПроверкеСертификата +
+ +Описание, пример вызова + +```bsl + +// Вызывается из одноименной процедуры модуля ЭлектроннаяПодписьКлиентПереопределяемый. +// +// Параметры: +// Параметры - Структура - со свойствами: +// * ОжидатьПродолжения - Булево - (возвращаемое значение) - если Истина, тогда дополнительная проверка +// будет выполнятся асинхронно, продолжение возобновится после выполнения оповещения. +// Начальное значение Ложь. +// * Оповещение - ОписаниеОповещения - обработка, которую нужно вызывать для продолжения +// после асинхронного выполнения дополнительной проверки. +// * Сертификат - СправочникСсылка.СертификатыКлючейЭлектроннойПодписиИШифрования - проверяемый сертификат. +// * Проверка - Строка - имя проверки, добавленное в процедуре ПриСозданииФормыПроверкаСертификата +// общего модуля ЭлектроннаяПодписьПереопределяемый. +// * МенеджерКриптографии - МенеджерКриптографии - подготовленный менеджер криптографии для +// выполнения проверки. +// - Неопределено - если стандартные проверки отключены в процедуре +// ПриСозданииФормыПроверкаСертификата общего модуля ЭлектроннаяПодписьПереопределяемый. +// * ОписаниеОшибки - Строка - (возвращаемое значение) - описание ошибки, полученной при выполнении проверки. +// Это описание сможет увидеть пользователь при нажатии на картинку результата. +// * ЭтоПредупреждение - Булево - (возвращаемое значение) - вид картинки Ошибка/Предупреждение +// начальное значение Ложь. +// +Процедура ПриДополнительнойПроверкеСертификата(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ПриДополнительнойПроверкеСертификата(Параметры) +``` +
+ +## ОбработкаНавигационнойСсылкиВФормеПечатиБСП +
+ +Описание, пример вызова + +```bsl + +// Процедура обрабатывает нажатие на рекламную ссылку на форме печати БСП. +// +// Параметры: +// НавигационнаяСсылка - Строка - текст навигационной ссылки; +// МассивСсылок - Массив - ссылка на объекты ИБ, которые передали на печать. +// +Процедура ОбработкаНавигационнойСсылкиВФормеПечатиБСП(НавигационнаяСсылка, МассивСсылок) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОбработкаНавигационнойСсылкиВФормеПечатиБСП(НавигационнаяСсылка, МассивСсылок) +``` +
+ +## ОбработатьСобытиеНаФормеСписка +
+ +Описание, пример вызова + +```bsl + +// Обрабатывает события нажатия на рекламу или ссылку переписки с банками. +// Вызывается из процедуры Подключаемый_ОбработатьСобытиеДиректБанк +// Параметр1 - Произвольный - +// Параметр2 - Произвольный - +// Параметр3 - Произвольный - +Процедура ОбработатьСобытиеНаФормеСписка( Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОбработатьСобытиеНаФормеСписка(); +``` +
+ +## ОбработатьОповещениеФормыСписка +
+ +Описание, пример вызова + +```bsl + +// Обрабатывает оповещение, возникающее на форме списка документов. +// +// Параметры: +// Объект - ФормаКлиентскогоПриложения - форма, на которой возникло оповещение. +// ИмяСобытия - Строка - Имя события +// Параметр - Произвольный - Параметр сообщения +// Источник - Произвольный - Источник события. +// ПараметрыСозданияФормыСписка - см. ОбменСБанками.ПараметрыСозданияФормыСписка +Процедура ОбработатьОповещениеФормыСписка( Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОбработатьОповещениеФормыСписка(); +``` +
+ +## ПослеЗаписи +
+ +Описание, пример вызова + +```bsl + +// Обработка события после записи документа. Оповещает об изменении данных обмена с банками, +// т.к. произошла запись нового состояния обмена с банком. +// +// Параметры: +// Объект - ФормаКлиентскогоПриложения - форма, на которой произошла запись объекта. +// ПараметрыЗаписи - Структура - Структура, содержащая параметры записи. +Процедура ПослеЗаписи(Объект, ПараметрыЗаписи) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ПослеЗаписи(Объект, ПараметрыЗаписи) +``` +
+ +## ОбработатьОповещениеФормыДокумента +
+ +Описание, пример вызова + +```bsl + +// Событие возникает при получении оповещения в форме документа. +// Необходима для обновления состояния электронного документа. +// +// Параметры: +// ФормаОбъект - ФормаКлиентскогоПриложения - форма, получившая оповещение. +// ИмяСобытия - Строка - идентификатор события +// Параметр - Произвольный - Параметр сообщения. +// Источник - Произвольный - Источник события. +Процедура ОбработатьОповещениеФормыДокумента(ФормаОбъект, ИмяСобытия, Параметр, Источник) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОбработатьОповещениеФормыДокумента(ФормаОбъект, ИмяСобытия, Параметр, Источник) +``` +
+ +## ПриВыбореСтрокиИзСпискаДокументов +
+ +Описание, пример вызова + +```bsl + +// Событие возникает при нажатии на строку динамического списка документов. +// +// Параметры: +// Элемент - ТаблицаФормы - элемент формы, в котором произошло событие +// ВыбраннаяСтрока - ОпределяемыйТип.ВладелецОбменСБанками - ссылка на прикладной документ. +// Поле - ПолеФормы - Активное поле (колонка). +// СтандартнаяОбработка - Булево - В данный параметр передается признак выполнения стандартной обработки события. +Процедура ПриВыбореСтрокиИзСпискаДокументов(Элемент, ВыбраннаяСтрока, Поле, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ПриВыбореСтрокиИзСпискаДокументов(Элемент, ВыбраннаяСтрока, Поле, СтандартнаяОбработка) +``` +
+ +## ПриНажатииНаГиперссылку +
+ +Описание, пример вызова + +```bsl + +// Обрабатывает событие нажатия на гиперссылку в форме списка платежных документов +// +// Параметры: +// ДокументСсылка - ДокументСсылка.СообщениеОбменСБанками - сообщение обмена с банком +// СтандартнаяОбработка - Булево - признак стандартной обработки нажатия на ссылку. +// +Процедура ПриНажатииНаГиперссылку(ДокументСсылка, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ПриНажатииНаГиперссылку(ДокументСсылка, СтандартнаяОбработка) +``` +
+ +## ОбновитьРекламуДиректБанк +
+ +Описание, пример вызова + +```bsl + +// Процедура обновляет отображение контекстной рекламы 1С:ДиректБанк при оповещении формы. +// +// Параметры: +// ИмяСобытия - Строка - идентификатор сообщения оповещения формы; +// ГруппаРекламы - ГруппаФормы - группа элементов контекстной рекламы; +// ДекорацияТекстРекламы - ДекорацияФормы - декорация, в заголовке которой отображается текст рекламы. +// +Процедура ОбновитьРекламуДиректБанк(ИмяСобытия, ГруппаРекламы, ДекорацияТекстРекламы) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиент.ОбновитьРекламуДиректБанк(ИмяСобытия, ГруппаРекламы, ДекорацияТекстРекламы) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменСБанкамиКлиентПереопределяемый.md b/src/content/docs/zup/ОбменСБанкамиКлиентПереопределяемый.md new file mode 100644 index 0000000..c2588ed --- /dev/null +++ b/src/content/docs/zup/ОбменСБанкамиКлиентПереопределяемый.md @@ -0,0 +1,72 @@ +--- +title: Обмен с банками клиент переопределяемый +slug: zup/обмен-с-банками-клиент-переопределяемый +--- + + +## РазобратьВыпискуБанка +
+ +Описание, пример вызова + +```bsl + +// Открывает форму разбора банковской выписки. +// +// Параметры: +// СообщениеОбмена - ДокументСсылка.СообщениеОбменСБанками - сообщение с выпиской банка. +// +Процедура РазобратьВыпискуБанка(СообщениеОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиентПереопределяемый.РазобратьВыпискуБанка(СообщениеОбмена) +``` +
+ +## ПриФормированииЭлектронныхДокументов +
+ +Описание, пример вызова + +```bsl + +// Событие возникает при формировании электронных документов. +// Если для какого-либо объекта невозможно формирование электронного документа, +// тогда нужно присвоить СтандартнаяОбработка = Ложь. +// (например, в ЗУП есть документ ВедомостьНаВыплатуЗарплатыВБанк, +// который может быть отправлен в банк только для вида "ПоЗарплатномуПроекту") +// Затем можно реализовать следующие сценарии обработки данной ситуации +// 1. Вывести сообщение +// 2. Вывести подробную инструкцию в отдельном окне, в котором описан порядок обработки таких документов. +// 3. Запустить помощник, который позволит создать "правильные" документы для отправки в банк. +// Итоговый массив (сокращенный и дополненный) вернуть через ОбработчикОповещения. +// +// Параметры: +// ОбработчикОповещения - ОписаниеОповещения - Обработчик, который нужно вызвать, если СтандартнаяОбработка = Ложь; +// * Результат - Массив - массив ссылок на объекты, для которых возможно формирование электронных документов. +// Может быть дополнен новыми документами. +// МассивДокументов - Массив - Массив ссылок на документы, для которых пользователь собирается сформировать +// электронные документы для отправки в банк. +// ПараметрыВыполненияКоманды - см. ПодключаемыеКомандыКлиент.ПараметрыВыполненияКоманды +// СтандартнаяОбработка - Булево - необходимо присвоить Ложь, если в МассивДокументов есть документы, +// для которых не формируются электронные документы. +// +//@skip-warning пустой метод +Процедура ПриФормированииЭлектронныхДокументов( Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиентПереопределяемый.ПриФормированииЭлектронныхДокументов(); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменСБанкамиКлиентСервер.md b/src/content/docs/zup/ОбменСБанкамиКлиентСервер.md new file mode 100644 index 0000000..b57a9f4 --- /dev/null +++ b/src/content/docs/zup/ОбменСБанкамиКлиентСервер.md @@ -0,0 +1,151 @@ +--- +title: Обмен с банками клиент сервер +slug: zup/обмен-с-банками-клиент-сервер +--- + + +## ЗаголовокНастройкиОбменаСБанком +
+ +Описание, пример вызова + +```bsl + +// Формирует текст гиперссылки для размещения в форме элемента справочника БанковскиеСчетаОрганизации. +// +// Параметры: +// Организация - СправочникСсылка.Организации - организация, указанная в счете. +// Банк - СправочникСсылка.КлассификаторБанков - банк, указанный в счете. +// +// Возвращаемое значение: +// Строка - текст для гиперссылки. +// +Функция ЗаголовокНастройкиОбменаСБанком(Знач Организация, Знач Банк) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанкамиКлиентСервер.ЗаголовокНастройкиОбменаСБанком(Организация, Банк) +``` +
+ +## ПоказатьРекламуДиректБанк +
+ +Описание, пример вызова + +```bsl + +// Управляет видимостью и содержанием контекстной рекламы 1С:ДиректБанк. +// +// Параметры: +// ГруппаРекламы - ГруппаФормы - группа элементов контекстной рекламы; +// ДекорацияТекстРекламы - ДекорацияФормы - декорация, в заголовке которой отображается текст рекламы. +// +Процедура ПоказатьРекламуДиректБанк(ГруппаРекламы, ДекорацияТекстРекламы) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиКлиентСервер.ПоказатьРекламуДиректБанк(ГруппаРекламы, ДекорацияТекстРекламы) +``` +
+ +## ТекстСсылкиПерепискаСБанками +
+ +Описание, пример вызова + +```bsl + +// Возвращает текст гиперссылки для открытия переписки с банками +// +// Возвращаемое значение: +// Строка - текст гиперссылки +// Неопределено - нет настройки обмена с письмами. Гиперссылку не нужно выводить. +// +Функция ТекстСсылкиПерепискаСБанками() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанкамиКлиентСервер.ТекстСсылкиПерепискаСБанками() +``` +
+ +## ПараметрыСозданияФормыСписка +
+ +Описание, пример вызова + +```bsl + +// Формирует параметры создания формы списка документов. +// +// Возвращаемое значение: +// Структура - содержит поля: +// * ГруппаКоманд - Структура - параметры создания группы команд 1С:ДиректБанк, содержит поля: +// ** Добавить - Булево - если Истина (по умолчанию), то группа команд будет создана автоматически +// ** Родитель - ГруппаФормы, ТаблицаФормы, ФормаКлиентскогоПриложения - родитель для добавляемого элемента. +// Если не задан, то родителем будет являться ФормаОбъект.КоманднаяПанель. +// ** МестоРасположения - Строка - имя элемента, перед которым нужно разместить группу команд. +// Если не задан, то группа помещается в конец командной панели формы. +// * ДинамическийСписок - Структура - параметры изменения запроса динамического списка: +// ** Изменить - Булево - если Истина (по умолчанию), то в запрос динамического списка добавляются +// дополнительные поля. +// ** ИмяРеквизита - Строка - имя реквизита формы динамического списка. "Список" по-умолчанию. +// * СписокДокументов - Структура - параметры добавления колонок в список документов: +// ** ДобавитьКолонки - Булево - если Истина (по умолчанию), то в список добавляются дополнительные колонки. +// ** ИмяЭлемента - Строка - имя элемента формы динамического списка документов. "Список" по-умолчанию +// ** ИмяРеквизита - Строка - имя реквизита формы динамического списка документов. "Список" по-умолчанию +// ** МестоРасположения - Строка - имя элемента, перед которым нужно разместить новую колонку. +// Если не задан, то перемещается в конец колонок таблицы. +// * ПерепискаСБанками - Структура - параметры добавления ссылки на переписку с банками: +// ** ДобавитьСсылку - Булево - если Истина (по умолчанию), то добавляется ссылка на переписку с банками. +// ** Родитель - Строка - имя родителя добавляемого элемента. +// Если не указан, то элемент добавляется в конец формы. +// ** МестоРасположения - Строка - имя элемента, перед которым нужно разместить ссылку на переписку с банками. +// * Реклама - Структура - параметры отображения рекламы ДиректБанк: +// ** Добавить - Булево - если Истина (по умолчанию), то на форму добавляется реклама ДиректБанка. +// ** Родитель - Строка - имя родителя добавляемого элемента. +// Если не указан, то элемент добавляется в конец формы. +// ** МестоРасположения - Строка - имя элемента, перед которым нужно разместить рекламу. +// +Функция ПараметрыСозданияФормыСписка() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанкамиКлиентСервер.ПараметрыСозданияФормыСписка() +``` +
+ +## ПараметрыСозданияФормыДокумента +
+ +Описание, пример вызова + +```bsl + +// Формирует параметры для дополнения формы документа +// +// Возвращаемое значение: +// Структура - Описание: +// * МестоРасположенияСостояния - Строка - элемент, перед которым нужно разместить состояние документа. +// * РодительСостояния - Строка - элемент, в котором нужно разместить состояние. +Функция ПараметрыСозданияФормыДокумента() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанкамиКлиентСервер.ПараметрыСозданияФормыДокумента() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменСБанкамиПереопределяемый.md b/src/content/docs/zup/ОбменСБанкамиПереопределяемый.md new file mode 100644 index 0000000..16c8933 --- /dev/null +++ b/src/content/docs/zup/ОбменСБанкамиПереопределяемый.md @@ -0,0 +1,547 @@ +--- +title: Обмен с банками переопределяемый +slug: zup/обмен-с-банками-переопределяемый +--- + + +## ПолучитьАктуальныеВидыЭД +
+ +Описание, пример вызова + +```bsl + +// Заполняет массив актуальными видами электронных документов для прикладного решения. +// +// Параметры: +// Массив - Массив из ПеречислениеСсылка.ВидыЭДОбменСБанками - виды актуальных ЭД +// Добавлять можно только следующие значения: +// - Перечисления.ВидыЭДОбменСБанками.ЗапросВыписки +// - Перечисления.ВидыЭДОбменСБанками.ПлатежноеПоручение +// - Перечисления.ВидыЭДОбменСБанками.ПлатежноеТребование +// - Перечисления.ВидыЭДОбменСБанками.ПоручениеНаПереводВалюты +// - Перечисления.ВидыЭДОбменСБанками.ПоручениеНаПокупкуВалюты +// - Перечисления.ВидыЭДОбменСБанками.ПоручениеНаПродажуВалюты +// - Перечисления.ВидыЭДОбменСБанками.РаспоряжениеНаОбязательнуюПродажуВалюты +// - Перечисления.ВидыЭДОбменСБанками.СписокНаЗачислениеДенежныхСредствНаСчетаСотрудников +// - Перечисления.ВидыЭДОбменСБанками.СписокНаОткрытиеСчетовПоЗарплатномуПроекту +// - Перечисления.ВидыЭДОбменСБанками.СписокУволенныхСотрудников +// - Перечисления.ВидыЭДОбменСБанками.Письмо +// - Перечисления.ВидыЭДОбменСБанками.РеестрВыплатСамозанятым +// +Процедура ПолучитьАктуальныеВидыЭД(Массив) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПолучитьАктуальныеВидыЭД(Массив) +``` +
+ +## ПолучитьНомераБанковскихСчетов +
+ +Описание, пример вызова + +```bsl + +// Используется для получения номеров счетов в виде массив строк +// +// Параметры: +// Организация - СправочникСсылка.Организации - отбор по организации. +// Банк - СправочникСсылка.КлассификаторБанков - отбор по банку. +// МассивНомеровБанковскихСчетов - Массив - Массив возврата, в элементах строки с номерами счетов. +// +Процедура ПолучитьНомераБанковскихСчетов(Организация, Банк, МассивНомеровБанковскихСчетов) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПолучитьНомераБанковскихСчетов(Организация, Банк, МассивНомеровБанковскихСчетов) +``` +
+ +## ЗаполнитьПараметрыЭДПоИсточнику +
+ +Описание, пример вызова + +```bsl + +// Определяет параметры электронного документа по типу владельца. +// +// Параметры: +// Источник - ДокументСсылка, ДокументОбъект - Источник объекта, либо ссылка документа/справочника-источника. +// ПараметрыЭД - Структура - структура параметров источника, необходимых для определения +// настроек обмена ЭД. Обязательные параметры: ВидЭД, Банк, Организация. +// +Процедура ЗаполнитьПараметрыЭДПоИсточнику(Источник, ПараметрыЭД) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ЗаполнитьПараметрыЭДПоИсточнику(Источник, ПараметрыЭД) +``` +
+ +## ЗаполнитьДанныеПлатежныхПоручений +
+ +Описание, пример вызова + +```bsl + +// Подготавливает данные для электронного документа типа Платежное поручение. +// +// Параметры: +// МассивСсылок - Массив - содержит ссылки на документы информационной базы, на основании которых будут созданы электронные документы. +// ДанныеДляЗаполнения - Массив - содержит пустые деревья значений, которые необходимо заполнить данными. +// Дерево значений повторяет структуру макета ПлатежноеПоручение из обработки ОбменСБанками. +// Если по какому-либо документу не удалось получить данные, то текст ошибки необходимо поместить вместо дерева значений. +// ВНИМАНИЕ! Порядок элементов массива ДанныеДляЗаполнения соответствует порядку элементов массива МассивСсылок. +// +Процедура ЗаполнитьДанныеПлатежныхПоручений(МассивСсылок, ДанныеДляЗаполнения) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ЗаполнитьДанныеПлатежныхПоручений(МассивСсылок, ДанныеДляЗаполнения) +``` +
+ +## ЗаполнитьДанныеПлатежныхТребований +
+ +Описание, пример вызова + +```bsl + +// Подготавливает данные для электронного документа типа Платежное требование. +// +// Параметры: +// МассивСсылок - Массив - содержит ссылки на документы информационной базы, на основании которых будут созданы электронные документы. +// ДанныеДляЗаполнения - Массив - содержит пустые деревья значений, которые необходимо заполнить данными. +// Дерево значений повторяет структуру макета ПлатежноеТребование из обработки ОбменСБанками. +// Если по какому-либо документу не удалось получить данные, то текст ошибки необходимо поместить вместо дерева значений. +// ВНИМАНИЕ! Порядок элементов массива ДанныеДляЗаполнения соответствует порядку элементов массива МассивСсылок. +// +Процедура ЗаполнитьДанныеПлатежныхТребований(МассивСсылок, ДанныеДляЗаполнения) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ЗаполнитьДанныеПлатежныхТребований(МассивСсылок, ДанныеДляЗаполнения) +``` +
+ +## ЗаполнитьДанныеПорученийНаПереводВалюты +
+ +Описание, пример вызова + +```bsl + +// Подготавливает данные для электронного документа типа Поручение на перевод валюты. +// +// Параметры: +// МассивСсылок - Массив - содержит ссылки на документы информационной базы, на основании которых будут созданы электронные документы. +// ДанныеДляЗаполнения - Массив - содержит пустые деревья значений, которые необходимо заполнить данными. +// Дерево значений повторяет структуру макета ПоручениеНаПереводВалюты из обработки ОбменСБанками. +// Если по какому-либо документу не удалось получить данные, то текст ошибки необходимо поместить вместо дерева значений. +// ВНИМАНИЕ! Порядок элементов массива ДанныеДляЗаполнения соответствует порядку элементов массива МассивСсылок. +// +//@skip-warning +Процедура ЗаполнитьДанныеПорученийНаПереводВалюты(МассивСсылок, ДанныеДляЗаполнения) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ЗаполнитьДанныеПорученийНаПереводВалюты(МассивСсылок, ДанныеДляЗаполнения) +``` +
+ +## ЗаполнитьДанныеПорученийНаПокупкуВалюты +
+ +Описание, пример вызова + +```bsl + +// Подготавливает данные для электронного документа типа Поручение на покупку валюты. +// +// Параметры: +// МассивСсылок - Массив - содержит ссылки на документы информационной базы, на основании которых будут созданы электронные документы. +// ДанныеДляЗаполнения - Массив - содержит пустые деревья значений, которые необходимо заполнить данными. +// Дерево значений повторяет структуру макета ПоручениеНаПокупкуВалюты из обработки ОбменСБанками. +// Если по какому-либо документу не удалось получить данные, то текст ошибки необходимо поместить вместо дерева значений. +// ВНИМАНИЕ! Порядок элементов массива ДанныеДляЗаполнения соответствует порядку элементов массива МассивСсылок. +// +//@skip-warning +Процедура ЗаполнитьДанныеПорученийНаПокупкуВалюты(МассивСсылок, ДанныеДляЗаполнения) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ЗаполнитьДанныеПорученийНаПокупкуВалюты(МассивСсылок, ДанныеДляЗаполнения) +``` +
+ +## ЗаполнитьДанныеПорученийНаПродажуВалюты +
+ +Описание, пример вызова + +```bsl + +// Подготавливает данные для электронного документа типа Поручение на продажу валюты. +// +// Параметры: +// МассивСсылок - Массив - содержит ссылки на документы информационной базы, на основании которых будут созданы электронные документы. +// ДанныеДляЗаполнения - Массив - содержит пустые деревья значений, которые необходимо заполнить данными. +// Дерево значений повторяет структуру макета ПоручениеНаПродажуВалюты из обработки ОбменСБанками. +// Если по какому-либо документу не удалось получить данные, то текст ошибки необходимо поместить вместо дерева значений. +// ВНИМАНИЕ! Порядок элементов массива ДанныеДляЗаполнения соответствует порядку элементов массива МассивСсылок. +// +//@skip-warning +Процедура ЗаполнитьДанныеПорученийНаПродажуВалюты(МассивСсылок, ДанныеДляЗаполнения) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ЗаполнитьДанныеПорученийНаПродажуВалюты(МассивСсылок, ДанныеДляЗаполнения) +``` +
+ +## ЗаполнитьДанныеРаспоряженийНаОбязательнуюПродажуВалюты +
+ +Описание, пример вызова + +```bsl + +// Подготавливает данные для электронного документа типа Распоряжение на обязательную продажу валюты. +// +// Параметры: +// МассивСсылок - Массив - содержит ссылки на документы информационной базы, на основании которых будут созданы электронные документы. +// ДанныеДляЗаполнения - Массив - содержит пустые деревья значений, которые необходимо заполнить данными. +// Дерево значений повторяет структуру макета РаспоряжениеНаОбязательнуюПродажуВалюты из обработки ОбменСБанками. +// Если по какому-либо документу не удалось получить данные, то текст ошибки необходимо поместить вместо дерева значений. +// ВНИМАНИЕ! Порядок элементов массива ДанныеДляЗаполнения соответствует порядку элементов массива МассивСсылок. +// +//@skip-warning +Процедура ЗаполнитьДанныеРаспоряженийНаОбязательнуюПродажуВалюты(МассивСсылок, ДанныеДляЗаполнения) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ЗаполнитьДанныеРаспоряженийНаОбязательнуюПродажуВалюты(МассивСсылок, ДанныеДляЗаполнения) +``` +
+ +## ЗаполнитьДанныеСправокОПодтверждающихДокументах +
+ +Описание, пример вызова + +```bsl + +// Подготавливает данные для электронного документа типа Справка о подтверждающих документах. +// +// Параметры: +// МассивСсылок - Массив - содержит ссылки на документы информационной базы, на основании которых будут созданы электронные документы. +// ДанныеДляЗаполнения - Массив - содержит пустые деревья значений, которые необходимо заполнить данными. +// Дерево значений повторяет структуру макета СправкаОПодтверждающихДокументах из обработки ОбменСБанками. +// Если по какому-либо документу не удалось получить данные, то текст ошибки необходимо поместить вместо дерева значений. +// ВНИМАНИЕ! Порядок элементов массива ДанныеДляЗаполнения соответствует порядку элементов массива МассивСсылок. +// +//@skip-warning +Процедура ЗаполнитьДанныеСправокОПодтверждающихДокументах(МассивСсылок, ДанныеДляЗаполнения) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ЗаполнитьДанныеСправокОПодтверждающихДокументах(МассивСсылок, ДанныеДляЗаполнения) +``` +
+ +## ПриПолученииУведомленияОЗачислении +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении уведомления о зачислении валюты +// +// Параметры: +// ДеревоРазбора - ДеревоЗначений - дерево данных, соответствующее макету Обработки.ОбменСБанками.УведомлениеОЗачислении +// НовыйДокументСсылка - ДокументСсылка - ссылка на созданный документ на основании данных электронного документа. +// +//@skip-warning +Процедура ПриПолученииУведомленияОЗачислении(ДеревоРазбора, НовыйДокументСсылка) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПриПолученииУведомленияОЗачислении(ДеревоРазбора, НовыйДокументСсылка) +``` +
+ +## ПроверитьИспользованиеТестовогоРежима +
+ +Описание, пример вызова + +```bsl + +// Включает тестовый режим обмена в банком. +// При включении тестового режима возможно ручное указание URL сервера для получения настроек обмена. +// +// Параметры: +// ИспользуетсяТестовыйРежим - Булево - признак использования тестового режима. +// +Процедура ПроверитьИспользованиеТестовогоРежима(ИспользуетсяТестовыйРежим) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПроверитьИспользованиеТестовогоРежима(ИспользуетсяТестовыйРежим) +``` +
+ +## ПриПолученииВыписки +
+ +Описание, пример вызова + +```bsl + +// Событие возникает при получении выписки из регламентного задания или при синхронизации. +// Необходимо создать документы в информационной базе для отражения произведенных по счету операций. +// Для получения данных выписки в удобном формате можно использовать следующие процедуры: +// - ОбменСБанками.ПолучитьДанныеВыпискиБанкаДеревоЗначений() +// - ОбменСБанками.ПолучитьДанныеВыпискиБанкаТекстовыйФормат() - только для рублевых выписок. +// +// Параметры: +// СообщениеОбмена - ДокументСсылка.СообщениеОбменСБанками - ссылка на сообщение обмена, содержащий выписку банка. +// +Процедура ПриПолученииВыписки(СообщениеОбмена) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПриПолученииВыписки(СообщениеОбмена) +``` +
+ +## ПриОпределенииКомандДиректБанк +
+ +Описание, пример вызова + +```bsl + +// Вызывается однократно при первом формировании списка команд, выводимых в форме конкретного объекта конфигурации. +// Возможно изменение значений структуры в параметре Команды. Например, можно добавить условие видимости команды. +// +// Параметры: +// НастройкиФормы - Структура - см. ПодключаемыеКомандыПереопределяемый.ПриОпределенииКомандПодключенныхКОбъекту +// Источники - ДеревоЗначений - см. ПодключаемыеКомандыПереопределяемый.ПриОпределенииКомандПодключенныхКОбъекту +// ПодключенныеОтчетыИОбработки - см.ПодключаемыеКомандыПереопределяемый.ПриОпределенииКомандПодключенныхКОбъекту +// Команды - ФиксированнаяСтруктура - команды, добавленные подсистемой ОбменСБанками. +// * Ключ - Строка - Идентификатор добавленной команды. Может содержать следующие значения: +// "ДиректБанкОтправка", "ДиректБанкПросмотр", "ДиректБанкСоздать", "ДиректБанкСписок", "ДиректБанкВыписки", +// "ДиректБанкПисьма" +// * Значение - СтрокаТаблицыЗначений - структура таблицы описана +// в ПодключаемыеКомандыПереопределяемый.ПриОпределенииКомандПодключенныхКОбъекту +//@skip-warning пустая процедура в БЭД +Процедура ПриОпределенииКомандДиректБанк(НастройкиФормы, Источники, ПодключенныеОтчетыИОбработки, Команды) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПриОпределенииКомандДиректБанк(НастройкиФормы, Источники, ПодключенныеОтчетыИОбработки, Команды) +``` +
+ +## ПослеОтправкиЭД +
+ +Описание, пример вызова + +```bsl + +// Для выполнения действий после отправки электронных документов в прикладной конфигурации +// +// Параметры: +// РезультатОтправки - Структура - результат выполнения предыдущей процедуры СформироватьИОтправитьПакетыВБанк +// * КоличествоПодготовленных - Число - количество подготовленных документов +// * ОтправленныеДокументы - Массив - содержит ссылки на документы, которые были отправлены +// * ОтправленныеСообщенияОбмена - Массив - содержит ссылки на ДокументСсылка.СообщениеОбменСБанками, которые были отправлены +// +Процедура ПослеОтправкиЭД(РезультатОтправки) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПослеОтправкиЭД(РезультатОтправки) +``` +
+ +## ПриФормированииXMLФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается для формирования XML файла в прикладном решении. +// +// Параметры: +// ОбъектДляВыгрузки - ДокументСсылка - ссылка на документ, на основании которого будет сформирован ЭД. +// ИмяФайла - Строка - имя сформированного файла. +// АдресФайла - Строка - АдресВременногоХранилища, содержит двоичные данные файла. +// +//@skip-warning +Процедура ПриФормированииXMLФайла(ОбъектДляВыгрузки, ИмяФайла, АдресФайла) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПриФормированииXMLФайла(ОбъектДляВыгрузки, ИмяФайла, АдресФайла) +``` +
+ +## ЗаполнитьТабличныйДокумент +
+ +Описание, пример вызова + +```bsl + +// Формирует табличный документ на основании файла XML для визуального отображения электронного документа. +// +// Параметры: +// ИмяФайла - Строка - полный путь к файлу XML +// ТабличныйДокумент - ТабличныйДокумент - возвращаемое значение, визуальное отображение данных файла. +// +//@skip-warning +Процедура ЗаполнитьТабличныйДокумент(Знач ИмяФайла, ТабличныйДокумент) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ЗаполнитьТабличныйДокумент(ИмяФайла, ТабличныйДокумент) +``` +
+ +## ПриПолученииXMLФайла +
+ +Описание, пример вызова + +```bsl + +// Вызывается при получении файла из банка. +// +// Параметры: +// АдресДанныхФайла - Строка - адрес временного хранилища с двоичными данными файла. +// ИмяФайла - Строка - формализованное имя файла данных. +// ОбъектВладелец - ДокументСсылка - (возвращаемый параметр) ссылка на документ, который был создан на основании ЭД. +// ДанныеОповещения - Структура - (возвращаемый параметр) данные для вызова метода Оповестить на клиенте. +// * Ключ - Строка - имя события. +// * Значение - Произвольный - параметр сообщения. +//@skip-warning +Процедура ПриПолученииXMLФайла(АдресДанныхФайла, ИмяФайла, ОбъектВладелец, ДанныеОповещения) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПриПолученииXMLФайла(АдресДанныхФайла, ИмяФайла, ОбъектВладелец, ДанныеОповещения) +``` +
+ +## ПриИзмененииСостоянияЭД +
+ +Описание, пример вызова + +```bsl + +// Вызывается при изменении состояния электронного документооборота. +// +// Параметры: +// СсылкаНаОбъект - ДокументСсылка - владелец электронного документооборота; +// СостояниеЭД - ПеречислениеСсылка.СостоянияОбменСБанками - новое состояние электронного документооборота. +// +//@skip-warning +Процедура ПриИзмененииСостоянияЭД(СсылкаНаОбъект, СостояниеЭД) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПриИзмененииСостоянияЭД(СсылкаНаОбъект, СостояниеЭД) +``` +
+ +## ПередОбработкойЭлектронныхДокументов +
+ +Описание, пример вызова + +```bsl + +// Позволяет скорректировать входящие параметры перед обработкой электронных документов. +// +// Параметры: +// Параметры - Структура - параметры обработки электронных документов, содержит поля: +// * МассивСсылокНаОбъект - Массив - содержит ссылки на документы, которые необходимо обработать; +// * МассивОтпечатковСертификатов - Массив - отпечатки доступных сертификатов на клиенте; +// * Действия - Строка - последовательность необходимых действий с электронным документом; +// * СообщениеОбмена - ДокументСсылка.СообщениеОбменСБанками - ссылка сообщение обмена, который нужно обработать; +// * СессииОбменСБанками - Соответствие - существующие сессии обмена со Сбербанком +// - Неопределено - нет установленных сессий. +// * Фрод - Структура - содержит адреса сетевого оборудования клиента: +// ** MAC - Массив из Строка - MAC адреса сетевого оборудования клиента. +// ** IP - Массив из Строка - IP адреса сетевого оборудования клиента. +// ** IPАдресКлиента - Строка - IP адрес клиента с точки зрения сервера. +// +Процедура ПередОбработкойЭлектронныхДокументов(Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ПередОбработкойЭлектронныхДокументов(Параметры) +``` +
+ +## ДобавитьСвязанныеДокументы +
+ +Описание, пример вызова + +```bsl + +// Процедура добавляет связанные документы для прикладной конфигурации +// +// Параметры: +// ТекущийДокумент - ДокументСсылка - ссылка на документ, для которого нужно добавить связанный документ. +// МассивДокументов - Массив из ДокументСсылка - массив документов, в который необходимо добавить +// связанные документы для прикладной конфигурации. +// +Процедура ДобавитьСвязанныеДокументы(ТекущийДокумент, МассивДокументов) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПереопределяемый.ДобавитьСвязанныеДокументы(ТекущийДокумент, МассивДокументов) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектам.md b/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектам.md new file mode 100644 index 0000000..7386301 --- /dev/null +++ b/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектам.md @@ -0,0 +1,161 @@ +--- +title: Обмен с банками по зарплатным проектам +slug: zup/обмен-с-банками-по-зарплатным-проектам +--- + + +## ДанныеДокументовДляОбменаСБанком +
+ +Описание, пример вызова + +```bsl + +// Возвращает данные документов для обмена с банком по зарплатным проектам. +// +// Параметры: +// Документы - Массив из ОпределяемыйТип.ВедомостьВБанкЗарплатаКадры, +// Массив из ДокументСсылка.ЗаявкаНаОткрытиеЛицевыхСчетовСотрудников, +// Массив из ДокументСсылка.ЗаявкаНаОткрытиеЛицевыхСчетовСотрудников - +// документы, по которым требуется получить данные. +// ДатаПолученияДанных - Дата - дата формирования файла. +// ПлатежныйДокумент - ДокументСсылка - платежный документ, в который входят ведомости. +// +// Возвращаемое значение: +// - Соответствие: +// * Ключ - ОпределяемыйТип.ВедомостьВБанкЗарплатаКадры, +// ДокументСсылка.ЗаявкаНаОткрытиеЛицевыхСчетовСотрудников, +// ДокументСсылка.ЗаявкаНаОткрытиеЛицевыхСчетовСотрудников - +// документ, данные по которому возвращаются. +// * Значение - Структура - данные документа. +// - Неопределено - когда нет документов, по которым требуется получить данные. +// +Функция ДанныеДокументовДляОбменаСБанком(Документы, ДатаПолученияДанных, ПлатежныйДокумент = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанкамиПоЗарплатнымПроектам.ДанныеДокументовДляОбменаСБанком(Документы, ДатаПолученияДанных, ПлатежныйДокумент); +``` +
+ +## УстановитьДоступностьСпособовЗачисленияПоЗарплатномуПроекту +
+ +Описание, пример вызова + +```bsl + +// В зависимости от зарплатного проекта устанавливает доступность у соответствия способов зачисления выплат. +// +// Параметры: +// СпособыЗачисления - см. НовоеСоответствиеСпособовЗачисления(), +// ЗарплатныйПроект - СправочникСсылка.ЗарплатныеПроекты. +// +Процедура УстановитьДоступностьСпособовЗачисленияПоЗарплатномуПроекту(СпособыЗачисления, ЗарплатныйПроект) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектам.УстановитьДоступностьСпособовЗачисленияПоЗарплатномуПроекту(СпособыЗачисления, ЗарплатныйПроект) +``` +
+ +## НовоеСоответствиеСпособовЗачисления +
+ +Описание, пример вызова + +```bsl + +// Возвращает новое соответствие со способами зачисления выплат +// +// Возвращаемое значение: +// - Соответствие: +// * Ключ - ПеречислениеСсылка.СпособыЗачисленияВыплат. +// * Значение - Булево - доступность способа зачисления. +// +Функция НовоеСоответствиеСпособовЗачисления() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанкамиПоЗарплатнымПроектам.НовоеСоответствиеСпособовЗачисления() +``` +
+ +## СоответствиеФорматовФайла +
+ +Описание, пример вызова + +```bsl + +// Возвращает соответствие между форматом файла перечислением и цифрой версии формата +// +// Возвращаемое значение: +// Соответствие из КлючИЗначение: +// * Ключ - Перечисление.ФорматыФайловОбменаПоЗарплатномуПроекту +// * Значение - Число - Номер версии формата +// +Функция СоответствиеФорматовФайла() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанкамиПоЗарплатнымПроектам.СоответствиеФорматовФайла() +``` +
+ +## ЗарплатныйПроектПоддерживаетСпособыЗачисленияВыплат +
+ +Описание, пример вызова + +```bsl + +// Возвращает поддерживаются ли разные способы зачисления выплат по зарплатному проекту +// +// Параметры: +// ЗарплатныйПроект - СправочникСсылка.ЗарплатныеПроекты - зарплатный проект. +// +Функция ЗарплатныйПроектПоддерживаетСпособыЗачисленияВыплат(ЗарплатныйПроект) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанкамиПоЗарплатнымПроектам.ЗарплатныйПроектПоддерживаетСпособыЗачисленияВыплат(ЗарплатныйПроект) +``` +
+ +## НомерТелефонаДляОбменаСБанками +
+ +Описание, пример вызова + +```bsl + +// Возвращает номер телефона в виде 10 цифр +// +// Параметры: +// НомерТелефонаПредставление - Строка - полный номер телефона со всеми знаками +// +// Возвращаемое значение: +// Строка +// +Функция НомерТелефонаДляОбменаСБанками(НомерТелефонаПредставление) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбменСБанкамиПоЗарплатнымПроектам.НомерТелефонаДляОбменаСБанками(НомерТелефонаПредставление) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектамКлиент.md b/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектамКлиент.md new file mode 100644 index 0000000..4c635ac --- /dev/null +++ b/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектамКлиент.md @@ -0,0 +1,35 @@ +--- +title: Обмен с банками по зарплатным проектам клиент +slug: zup/обмен-с-банками-по-зарплатным-проектам-клиент +--- + + +## ВыгрузитьВФайлПлатежныеДокументыПеречисленияЗарплаты +
+ +Описание, пример вызова + +```bsl + +// Выгружает файл обмена с банком по платежному документу, который объединяет ведомости в банк. +// +// Параметры: +// ПлатежныеДокументы - Массив - платежные документы (ДокументСсылка). +// Форма - ФормаКлиентскогоПриложения - форма, из которой производится выгрузка файла. +// +Процедура ВыгрузитьВФайлПлатежныеДокументыПеречисленияЗарплаты(ПлатежныеДокументы, Форма) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамКлиент.ВыгрузитьВФайлПлатежныеДокументыПеречисленияЗарплаты(ПлатежныеДокументы, Форма) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.md b/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.md new file mode 100644 index 0000000..4e95152 --- /dev/null +++ b/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.md @@ -0,0 +1,730 @@ +--- +title: Обмен с банками по зарплатным проектам переопределяемый +slug: zup/обмен-с-банками-по-зарплатным-проектам-переопределяемый +--- + + +## ЗаполнитьМетаданныеПлатежногоДокументаПеречисленияЗарплаты +
+ +Описание, пример вызова + +```bsl + +// Позволяет определить метаданные платежного документа. +// +// Параметры: +// МетаданныеДокумента - ОбъектМетаданных - Метаданные платежного документа. +// +// Пример: +// МетаданныеДокумента = Метаданные.Документы.ПлатежноеПоручение; +// +Процедура ЗаполнитьМетаданныеПлатежногоДокументаПеречисленияЗарплаты(МетаданныеДокумента) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ЗаполнитьМетаданныеПлатежногоДокументаПеречисленияЗарплаты(МетаданныеДокумента) +``` +
+ +## ВедомостиПлатежногоДокументаПеречисленияЗарплаты +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить получение ведомостей платежного документа. +// +// Параметры: +// ПлатежныйДокумент - ДокументСсылка - платежный документ, ведомости которого требуется получить. +// Ведомости - Массив из ОпределяемыйТип.ВедомостьВБанкЗарплатаКадры - ведомости платежного документа. +// СтандартнаяОбработка - Булево - Ложь, если установлено переопределение получения ведомостей. +// +Процедура ВедомостиПлатежногоДокументаПеречисленияЗарплаты(ПлатежныйДокумент, Ведомости, СтандартнаяОбработка = Истина) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ВедомостиПлатежногоДокументаПеречисленияЗарплаты(ПлатежныйДокумент, Ведомости, СтандартнаяОбработка); +``` +
+ +## ДополнитьПлатежныйДокумент +
+ +Описание, пример вызова + +```bsl + +// Позволяет дополнить платежный документ массивом ведомостей. +// +// Параметры: +// ПлатежныйДокумент - ДокументСсылка - платежный документ, в который требуется добавить ведомости. +// Ведомости - Массив из ОпределяемыйТип.ВедомостьВБанкЗарплатаКадры - добавляемые ведомости в банк. +// СтандартнаяОбработка - Булево - Ложь, если установлено переопределение дополнения ведомостей. +// +Процедура ДополнитьПлатежныйДокумент(ПлатежныйДокумент, Ведомости, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ДополнитьПлатежныйДокумент(ПлатежныйДокумент, Ведомости, СтандартнаяОбработка) +``` +
+ +## ПередЗаписьюПлатежногоДокументаПеречисленияЗарплаты +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить действия для обработчика ПередЗаписью +// +// Параметры: +// Источник - ДокументОбъект - платежный документ +// Отказ - Булево - Признак отказа от записи. +// СтандартнаяОбработка - Булево - Требуется установить Ложь, если установлено переопределение действий. +// +Процедура ПередЗаписьюПлатежногоДокументаПеречисленияЗарплаты(Источник, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ПередЗаписьюПлатежногоДокументаПеречисленияЗарплаты(Источник, Отказ, СтандартнаяОбработка) +``` +
+ +## ПриЗаписиПлатежногоДокументаПеречисленияЗарплаты +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить действия для обработчика ПриЗаписи +// +// Параметры: +// Источник - ДокументОбъект - платежный документ +// Отказ - Булево - Признак отказа от записи. +// СтандартнаяОбработка - Булево - Требуется установить Ложь, если установлено переопределение действий. +// +Процедура ПриЗаписиПлатежногоДокументаПеречисленияЗарплаты(Источник, Отказ, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ПриЗаписиПлатежногоДокументаПеречисленияЗарплаты(Источник, Отказ, СтандартнаяОбработка) +``` +
+ +## ЗаполнитьНомерРеестраПлатежногоДокумента +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить номер реестра платежного документа +// +// Параметры: +// ПлатежныйДокумент - ДокументСсылка - Платежный документ. +// НомерРеестра - Строка - Номер реестра файла, выгружаемого в банк. +// +Процедура ЗаполнитьНомерРеестраПлатежногоДокумента(ПлатежныйДокумент, НомерРеестра) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ЗаполнитьНомерРеестраПлатежногоДокумента(ПлатежныйДокумент, НомерРеестра) +``` +
+ +## ОпределитьДоступностьПередачиВБанкРеестровНаЗачислениеЗарплаты +
+ +Описание, пример вызова + +```bsl + +// Позволяет отключить возможность передачи реестров на зачисление зарплаты по зарплатным проектам. +// Предназначен для случаев, когда передача реестров осуществляется специализированными документами, +// и универсальный инструмент ввода не требуется. +// +// Параметры: +// ДоступностьПередачиВБанк - Булево - возможность передачи реестров, по умолчанию Истина. +// +Процедура ОпределитьДоступностьПередачиВБанкРеестровНаЗачислениеЗарплаты(ДоступностьПередачиВБанк) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьДоступностьПередачиВБанкРеестровНаЗачислениеЗарплаты(ДоступностьПередачиВБанк) +``` +
+ +## ОпределитьАдресФайлаОбменаСБанкамиПоЗарплатнымПроектам +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить адрес временного хранилища, в котором хранится передаваемый файл обмена с банками. +// В методе необходимо сформировать собственный файл для передачи в банк и поместить его во временное +// хранилище, при этом формирование файла по стандарту HTTP://v8.1c.ru/EDI/edi_stnd/109 не будет произведено. +// Если для обмена используется xml-файл, но с отличной от стандарта структурой, то в данной процедуре необходимо +// переопределить: КорневыеСвойства, СоответствиеПолей, ОбязательныеПоля, СоответствиеПреобразованияЗначений. +// Если не хватает выбранных из документа данных, то необходимо переопределить коллекции: ДанныеСтрокДокумента, +// ДанныеСтрокДокумента. +// +// Параметры: +// АдресФайла - Строка - адрес временного хранилища записываемого файла. +// ДанныеШапкиДокумента - Структура - поля шапки документа, по которому формируется файл. +// ДанныеСтрокДокумента - Массив - структуры со строками документа, по которому формируется файл. +// КорневыеСвойства - Соответствие - корневые свойства формируемого файла, +// см. ОбменСБанкамиПоЗарплатнымПроектам.КорневыеСвойства. +// СоответствиеПолей - Соответствие - соответствие между полями формата и полями выгружаемой коллекции, +// см. ОбменСБанкамиПоЗарплатнымПроектам.СоответствиеПолейФайла. +// ОбязательныеПоля - Массив - обязательных для заполнения полей файла, +// см. ОбменСБанкамиПоЗарплатнымПроектам.ОбязательныеПоляФайла. +// СоответствиеПреобразованияЗначений - Соответствие - соответствие значений для преобразования, +// см. ОбменСБанкамиПоЗарплатнымПроектам.СоответствиеПреобразованияЗначений. +// +Процедура ОпределитьАдресФайлаОбменаСБанкамиПоЗарплатнымПроектам(АдресФайла, ДанныеШапкиДокумента, ДанныеСтрокДокумента, КорневыеСвойства, Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьАдресФайлаОбменаСБанкамиПоЗарплатнымПроектам(АдресФайла, ДанныеШапкиДокумента, ДанныеСтрокДокумента, КорневыеСвойства, ); +``` +
+ +## ОпределитьИмяФайлаОбменаСБанкамиПоЗарплатнымПроектам +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить имя файла обмена с банком. +// +// Параметры: +// ИмяФайла - Строка - имя файла обмена с банком. +// Ссылка - ДокументСсылка - документ, по которому создается файл обмена. +// +// Описание: +// Описание для формируемого по умолчанию имени файла см. +// ОбменСБанкамиПоЗарплатнымПроектам.ИмяФайлаОбменаСБанкамиПоЗарплатнымПроектам. +// +Процедура ОпределитьИмяФайлаОбменаСБанкамиПоЗарплатнымПроектам(ИмяФайла, Ссылка) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьИмяФайлаОбменаСБанкамиПоЗарплатнымПроектам(ИмяФайла, Ссылка) +``` +
+ +## ОпределитьКорневыеСвойства +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить корневые свойства XDTO-пакета формируемого файла. +// +// Параметры: +// КорневыеСвойства - Соответствие - корневые свойства XDTO-пакета, зависят от вида документов. +// Ключ элемента соответствия идентифицирует название корневого свойства. +// В значении элемента указывается массив свойств, которые будут выгружены. +// ВидОперации - Строка - Вид операции обмена с банками, для которого получаются корневые свойства. +// +Процедура ОпределитьКорневыеСвойства(КорневыеСвойства, ВидОперации) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьКорневыеСвойства(КорневыеСвойства, ВидОперации) +``` +
+ +## ОпределитьСоответствиеПолейФайла +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить соответствие между полями файла и полями выгружаемой коллекции. +// +// Параметры: +// СоответствиеПолей - Соответствие - Соответствие полей документа и файла: +// * Ключ - название поля в файле; +// * Значение - название поля в документе. +// ВидОперации - Строка - Вид операции обмена с банками, для которого получается соответствие полей. +// ФорматФайла - ПеречислениеСсылка.ФорматыФайловОбменаПоЗарплатномуПроекту - Версия формата файла обмена. +// +Процедура ОпределитьСоответствиеПолейФайла(СоответствиеПолей, ВидОперации, ФорматФайла = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьСоответствиеПолейФайла(СоответствиеПолей, ВидОперации, ФорматФайла); +``` +
+ +## ОпределитьОбязательныеПоляФайла +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить соответствие обязательных для заполнения полей файла. +// Для группы используется соответствие обязательных полей, где также можно указать обязательность самой группы +// добавив элемент "ЗначениеОбязательноДляЗаполнения". +// +// Параметры: +// ОбязательныеПоля - Соответствие - описание обязательности полей файла. +// Ключ элемента соответствия идентифицирует название поля, обязательного для заполнения. +// В значении указывается Истина,если поле обязательно для заполнения, иначе Ложь. +// По умолчанию, если поле не включено в соответствие, используется значение Ложь. +// ВидОперации - Строка - Вид операции обмена с банками. +// +// Пример: +// Группа УдостоверениеЛичности обязательна для заполнения, она содержит поля: +// ВидДокумента - обязательное, +// Номер - обязательное, +// Серия - не обязательное, +// ДатаВыдачи - обязательное. +// КемВыдан - обязательное. +// +// СоответствиеУдостоверениеЛичности = Новый Соответствие; +// СоответствиеУдостоверениеЛичности.Вставить("ВидДокумента", Истина); +// СоответствиеУдостоверениеЛичности.Вставить("Номер", Истина); +// СоответствиеУдостоверениеЛичности.Вставить("ДатаВыдачи", Истина); +// СоответствиеУдостоверениеЛичности.Вставить("КемВыдан", Истина); +// СоответствиеУдостоверениеЛичности.Вставить("ЗначениеОбязательноДляЗаполнения", Истина); +// СоответствиеОткрытиеСчетов = Новый Соответствие; +// СоответствиеОткрытиеСчетов.Вставить("УдостоверениеЛичности", СоответствиеУдостоверениеЛичности); +// ОбязательныеПоля.Вставить("ОткрытиеСчетов", СоответствиеОткрытиеСчетов); +// +Процедура ОпределитьОбязательныеПоляФайла(ОбязательныеПоля, ВидОперации) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьОбязательныеПоляФайла(ОбязательныеПоля, ВидОперации) +``` +
+ +## ОпределитьСоответствиеПреобразованияЗначений +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить соответствие значений для преобразования. +// +// Параметры: +// СоответствиеПреобразованияЗначений - Соответствие - соответствие значений для преобразования: +// * Ключ - преобразуемое значение; +// * Значение - преобразованное значение. +// ВидОперации - Строка - Вид операции обмена с банками, для которого получается соответствие полей. +// +// Пример: +// В файле для определения пола физического лица используется строка "Женский" или "Мужской". +// При выгрузке в файл следует указать преобразование пола физического лица, выбранных из документа: +// СоответствиеПреобразованияЗначений.Вставить(Перечисления.ПолФизическогоЛица.Женский, "Женский"); +// СоответствиеПреобразованияЗначений.Вставить(Перечисления.ПолФизическогоЛица.Мужской, "Мужской"); +// +// В файле для определения статуса операции по зачислению зарплаты используется строка "Зачислено", "НеЗачислено". +// При загрузке из файла следует указать преобразование статуса: +// СоответствиеПреобразованияЗначений.Вставить(ВРег("Зачислено"), Перечисления.РезультатыЗачисленияЗарплаты.Зачислено); +// СоответствиеПреобразованияЗначений.Вставить(ВРег("НеЗачислено"), Перечисления.РезультатыЗачисленияЗарплаты.НеЗачислено); +// +Процедура ОпределитьСоответствиеПреобразованияЗначений(СоответствиеПреобразованияЗначений, ВидОперации) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьСоответствиеПреобразованияЗначений(СоответствиеПреобразованияЗначений, ВидОперации) +``` +
+ +## ОпределитьСоответствиеТипов +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить соответствие типов между наименованиями полей файла и колонок коллекции. +// +// Параметры: +// СоответствиеТипов - Соответствие - Описание типов полей документа. +// Ключ идентифицирует название поля в файле. +// Значение содержит тип поля в коллекции. +// ВидОперации - Строка - Вид операции обмена с банками, для которого получается соответствие типов. +// +Процедура ОпределитьСоответствиеТипов(СоответствиеТипов, ВидОперации) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьСоответствиеТипов(СоответствиеТипов, ВидОперации) +``` +
+ +## ОпределитьЗначениеПоля +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить значение поля, выгружаемое в файл. +// +// Параметры: +// ЗначениеПоля - Произвольный - Значение поля, выгружаемое в файл. +// СвойствоПриемника - СписокXDTO, Произвольный, ОбъектXDTO - Свойство ОбъектаXDTO, в которое будет записано значение поля. +// ЗначениеКорректно - Булево - Истина, если значение корректно и должно быть выгружено в файл, +// Ложь - значение не будет выгружено в файл. +// ОбъектXDTO - ОбъектXDTO - заполняемый ОбъектXDTO. +// ДанныеШапкиДокумента - Структура - поля шапки документа, по которому формируется файл. +// ДанныеСтрокДокумента - Массив - строки документа, по которому формируется файл. +// СоответствиеПолей - Соответствие - соответствие между полями формата и полями выгружаемой коллекции, +// см. ОбменСБанкамиПоЗарплатнымПроектам.СоответствиеПолейФайла. +// ОбязательныеПоля - Массив - обязательные для заполнения поля файла, +// см. ОбменСБанкамиПоЗарплатнымПроектам.ОбязательныеПоляФайла. +// СоответствиеПреобразованияЗначений - - Соответствие - соответствие значений для преобразования, +// см. ОбменСБанкамиПоЗарплатнымПроектам.СоответствиеПреобразованияЗначений. +// Ошибки - Структура - ошибки, которые будут показаны пользователю, см. ОбщегоНазначенияКлиентСервер.ДобавитьОшибкуПользователю. +// +Процедура ОпределитьЗначениеПоля(ЗначениеПоля, СвойствоПриемника, ЗначениеКорректно, ОбъектXDTO, ДанныеШапкиДокумента, ДанныеСтрокДокумента, Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьЗначениеПоля(ЗначениеПоля, СвойствоПриемника, ЗначениеКорректно, ОбъектXDTO, ДанныеШапкиДокумента, ДанныеСтрокДокумента, ); +``` +
+ +## ПреобразоватьЗначениеПоСоответствию +
+ +Описание, пример вызова + +```bsl + +// Преобразует значение коллекции, в соответствии с полем преобразования. +// +// Параметры: +// ЗначениеДляПреобразования - Произвольный - значение для преобразования. +// СоответствиеПреобразованияЗначений - Соответствие - правила преобразования значений. +// +Процедура ПреобразоватьЗначениеПоСоответствию(ЗначениеДляПреобразования, СоответствиеПреобразованияЗначений) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ПреобразоватьЗначениеПоСоответствию(ЗначениеДляПреобразования, СоответствиеПреобразованияЗначений) +``` +
+ +## ОпределитьДанныеШапкиДокументаДляПолученияТекстаФайла +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить данные документа для формирования файла обмена. +// +// Параметры: +// ДанныеШапкиДокумента - СтрокаТаблицыЗначений - данные шапки документа. +// Ссылка - ДокументСсылка - документ. +// ДатаПолученияДанных - Дата - дата формирования файла. +// +Процедура ОпределитьДанныеШапкиДокументаДляПолученияТекстаФайла(ДанныеШапкиДокумента, Ссылка, ДатаПолученияДанных) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьДанныеШапкиДокументаДляПолученияТекстаФайла(ДанныеШапкиДокумента, Ссылка, ДатаПолученияДанных) +``` +
+ +## ОпределитьДанныеСтрокДокументовДляПолученияТекстаФайла +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить данные строк документа для формирования файла обмена. +// +// Параметры: +// ДанныеСтрокДокументов - ТаблицаЗначений - данные строк документа. +// ДатаПолученияДанных - Дата - дата формирования файла. +// +Процедура ОпределитьДанныеСтрокДокументовДляПолученияТекстаФайла(ДанныеСтрокДокументов, ДатаПолученияДанных) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьДанныеСтрокДокументовДляПолученияТекстаФайла(ДанныеСтрокДокументов, ДатаПолученияДанных) +``` +
+ +## ДополнитьКолонкиДанныхСтрокДокументов +
+ +Описание, пример вызова + +```bsl + +// Позволяет дополнить колонки получаемых данных из объекта. +// +// Параметры: +// ДанныеСтрокДокументов - Структура - строка документа, по которому формируется файл. +// +Процедура ДополнитьКолонкиДанныхСтрокДокументов(ДанныеСтрокДокументов) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ДополнитьКолонкиДанныхСтрокДокументов(ДанныеСтрокДокументов) +``` +
+ +## ЗаполнитьКолонкиДанныхСтрокДокумента +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить значения в данных строки документа. +// +// Параметры: +// СтрокаДанныхДокумента - Структура - строка документа, по которому формируется файл. +// +Процедура ЗаполнитьКолонкиДанныхСтрокДокумента(СтрокаДанныхДокумента) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ЗаполнитьКолонкиДанныхСтрокДокумента(СтрокаДанныхДокумента) +``` +
+ +## ЗаполнитьДанныеОплатыВедомостей +
+ +Описание, пример вызова + +```bsl + +// Заполняет данные платежного поручения по ведомости. +// +// Параметры: +// Объект - ДокументОбъект - ведомость, по которой нужно узнать номер и дату платежного поручения. +// НомерПлатежногоПоручения - Строка - номер платежного поручения, которое было создано по ведомости. +// ДатаПлатежногоПоручения - Дата - дата платежного поручения, которое было создано по ведомости. +// ПлатежныйДокумент - ДокументСсылка - платежный документ, передается, если выгружается файл по платежному документу. +// +Процедура ЗаполнитьДанныеОплатыВедомостей(Объект, НомерПлатежногоПоручения, ДатаПлатежногоПоручения, ПлатежныйДокумент = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ЗаполнитьДанныеОплатыВедомостей(Объект, НомерПлатежногоПоручения, ДатаПлатежногоПоручения, ПлатежныйДокумент); +``` +
+ +## ОпределитьДанныеДокументаПодтверждения +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить данные документа для загружаемого файла-подтверждения из обмена. +// +// Параметры: +// ДанныеДокумента - Соответствие - см. Документ.ПодтверждениеОткрытияЛицевыхСчетовСотрудников.ДанныеПодтвержденияОткрытияЛицевыхСчетов +// Ссылка - ДокументСсылка - документ-подтверждение. +// +Процедура ОпределитьДанныеДокументаПодтверждения(ДанныеДокумента, Ссылка) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьДанныеДокументаПодтверждения(ДанныеДокумента, Ссылка) +``` +
+ +## ОбработкаПроверкиЗаполнения +
+ +Описание, пример вызова + +```bsl + +// Позволяет реализовать проверку заполнения реквизитов выгружаемого документа. +// Вызывается из обработки проверки заполнения документа. +// +// Параметры: +// Документ - ДокументОбъект - документ, в котором требуется проверить заполнение реквизитов. +// Отказ - Булево - признак отказа от продолжения работы после выполнения проверки заполнения. +// ПроверяемыеРеквизиты - Массив - пути к реквизитам, для которых будет выполнена проверка заполнения. +// СтандартнаяОбработка - Булево - флаг дальнейшей проверки заполнения: +// Истина - будет продолжена стандартная проверка заполнения, +// Ложь - проверка заполнения будет завершена. +// +Процедура ОбработкаПроверкиЗаполнения(Документ, Отказ, ПроверяемыеРеквизиты, СтандартнаяОбработка = Истина) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОбработкаПроверкиЗаполнения(Документ, Отказ, ПроверяемыеРеквизиты, СтандартнаяОбработка); +``` +
+ +## ОбработатьЗагрузку +
+ +Описание, пример вызова + +```bsl + +// Обрабатывает загрузку пользовательского формата файла обмена. +// +// Параметры: +// ПолноеИмяФайла - Строка - полный путь к файлу. +// ЗагруженныйДокумент - ДокументСсылка - загруженный документ. +// СтандартнаяОбработка - Булево - флаг дальнейшей обработки загрузки файла обмена: +// Истина - будет продолжена стандартная обработка файла обмена, +// Ложь - обработка файла обмена будет завершена. +// ДокументОбъектПодтверждение - ДокументОбъект - документ-подтверждение. +// +Процедура ОбработатьЗагрузку(ПолноеИмяФайла, ЗагруженныйДокумент, СтандартнаяОбработка, ДокументОбъектПодтверждение = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОбработатьЗагрузку(ПолноеИмяФайла, ЗагруженныйДокумент, СтандартнаяОбработка, ДокументОбъектПодтверждение); +``` +
+ +## ОпределитьСтруктуруДляЗаполненияДокументаПоПодтверждениюБанка +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить структуру для заполнения подтверждения из банка. +// +// Параметры: +// СтруктураДанныхДляЗаполненияДокумента - Структура - данные для заполнения подтверждения из банка. +// ОбъектXDTO - ОбъектXDTO - заполненный ОбъектXDTO. +// КорневыеСвойства - Соответствие - корневые свойства загружаемого файла. +// СоответствиеПолей - Соответствие - соответствие между полями коллекции и полями файла. +// СоответствиеПреобразованияЗначений - Соответствие - соответствие значений для преобразования. +// СоответствиеТипов - Соответствие - соответствие типов между наименованиями полей файла и колонок коллекции. +// ПервичныйДокумент - ДокументСсылка - первичный документ, по которому производится загрузка подтверждения. +// Отказ - Булево - Если установить в Истина - документ не будет создан. +// +Процедура ОпределитьСтруктуруДляЗаполненияДокументаПоПодтверждениюБанка(СтруктураДанныхДляЗаполненияДокумента, ОбъектXDTO, Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьСтруктуруДляЗаполненияДокументаПоПодтверждениюБанка(СтруктураДанныхДляЗаполненияДокумента, ОбъектXDTO, ); +``` +
+ +## ОпределитьДанныеСотрудниковДляОткрытияЛицевыхСчетов +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить кадровые данные сотрудников по списку физических лиц. +// +// Параметры: +// ДанныеСотрудников - ТаблицаЗначений - кадровые данные сотрудников. +// СписокФизическихЛиц - Массив - физические лица (СправочникСсылка.ФизическиеЛица), по которым нужно получить кадровые данные. +// СписокСотрудников - Массив - сотрудники (СправочникСсылка.Сотрудники), по которым нужно получить кадровые данные. +// ДатаПолученияДанных - Дата - дата, на которую будут получены периодические значения. +// Организация - СправочникСсылка.Организации - Организация. +// ЗарплатныйПроект - СправочникСсылка.ЗарплатныеПроекты - зарплатный проект. +// +Процедура ОпределитьДанныеСотрудниковДляОткрытияЛицевыхСчетов(ДанныеСотрудников, СписокФизическихЛиц, СписокСотрудников, Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьДанныеСотрудниковДляОткрытияЛицевыхСчетов(ДанныеСотрудников, СписокФизическихЛиц, СписокСотрудников, ); +``` +
+ +## ОпределитьДанныеСотрудниковДляЗакрытияЛицевыхСчетов +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить кадровые данные сотрудников на закрытие лицевых счетов. +// +// Параметры: +// МенеджерВременныхТаблиц - МенеджерВременныхТаблиц - менеджер временных таблиц +// ЗакрытиеЛицевыхСчетов - РезультатЗапроса - результат запроса с данными сотрудников. +// +Процедура ОпределитьДанныеСотрудниковДляЗакрытияЛицевыхСчетов(МенеджерВременныхТаблиц, ЗакрытиеЛицевыхСчетов) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ОпределитьДанныеСотрудниковДляЗакрытияЛицевыхСчетов(МенеджерВременныхТаблиц, ЗакрытиеЛицевыхСчетов) +``` +
+ +## ПриОпределенииИспользованияТиповогоЭОИСБанком +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить использование типового обмена электронными документами с банком. +// +// Параметры: +// ЗарплатныйПроект - СправочникСсылка.ЗарплатныеПроекты - зарплатный проект. +// ИспользоватьТиповойОбмен - Булево - Истина, если используется типовой обмен, иначе Ложь. +// +Процедура ПриОпределенииИспользованияТиповогоЭОИСБанком(ЗарплатныйПроект, ИспользоватьТиповойОбмен) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамПереопределяемый.ПриОпределенииИспользованияТиповогоЭОИСБанком(ЗарплатныйПроект, ИспользоватьТиповойОбмен) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектамРасширенный.md b/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектамРасширенный.md new file mode 100644 index 0000000..90be16b --- /dev/null +++ b/src/content/docs/zup/ОбменСБанкамиПоЗарплатнымПроектамРасширенный.md @@ -0,0 +1,45 @@ +--- +title: Обмен с банками по зарплатным проектам расширенный +slug: zup/обмен-с-банками-по-зарплатным-проектам-расширенный +--- + + +## ВедомостьПрочихДоходовВБанкПередЗаписью +
+ +Описание, пример вызова + +```bsl + +Процедура ВедомостьПрочихДоходовВБанкПередЗаписью(ВедомостьОбъект) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамРасширенный.ВедомостьПрочихДоходовВБанкПередЗаписью(ВедомостьОбъект) +``` +
+ +## ВедомостьПрочихДоходовВБанкПриЗаписи +
+ +Описание, пример вызова + +```bsl + +Процедура ВедомостьПрочихДоходовВБанкПриЗаписи(ВедомостьОбъект, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбменСБанкамиПоЗарплатнымПроектамРасширенный.ВедомостьПрочихДоходовВБанкПриЗаписи(ВедомостьОбъект, Отказ) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбновлениеБЗК.md b/src/content/docs/zup/ОбновлениеБЗК.md new file mode 100644 index 0000000..a2447cf --- /dev/null +++ b/src/content/docs/zup/ОбновлениеБЗК.md @@ -0,0 +1,93 @@ +--- +title: Обновление БЗК +slug: zup/обновление-бзк +--- + + +## ОсновнойРежимВыполненияОбновления +
+ +Описание, пример вызова + +```bsl + +// Возвращает основной режим выполнения обработчиков обновления Зарплатно-кадровой библиотеки. +// +// Возвращаемое значение: +// Строка - "Монопольно" или "Отложенно". +// +Функция ОсновнойРежимВыполненияОбновления() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеБЗК.ОсновнойРежимВыполненияОбновления() +``` +
+ +## ДобавитьОбработчикПерехода +
+ +Описание, пример вызова + +```bsl + +// Добавляет обработчик обновления который будет выполняться при переходе с конфигурации с другим именем. +// +// Параметры: +// Обработчики - ТаблицаЗначений - Передается "как есть" из одноименного параметра вызывающей процедуры. +// ИмяПроцедуры - Строка - Имя вызываемой процедуры. Процедура будет вызвана без параметров. +// ОбщиеДанные - Булево - Истина, если изменяемые процедурой данные неразделенные. Ложь - если разделенные. +// ПереходСБазовых - Булево - Истина, если требуется выполнять при переходе с базовых конфигураций. +// ПереходСПроф - Булево - Истина, если требуется выполнять при переходе с обычных конфигураций. +// +Процедура ДобавитьОбработчикПерехода(Обработчики, ИмяПроцедуры, ОбщиеДанные, ПереходСБазовых = Истина, ПереходСПроф = Истина) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеБЗК.ДобавитьОбработчикПерехода(Обработчики, ИмяПроцедуры, ОбщиеДанные, ПереходСБазовых, ПереходСПроф); +``` +
+ +## ИменаБазовыхКонфигураций +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив строк - имена базовых конфигураций для зарплатных обработчиков обновления. +Функция ИменаБазовыхКонфигураций() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеБЗК.ИменаБазовыхКонфигураций() +``` +
+ +## ИменаКонфигурацийПроф +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив строк - имена Проф конфигураций для зарплатных обработчиков обновления. +Функция ИменаКонфигурацийПроф() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбновлениеБЗК.ИменаКонфигурацийПроф() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбновлениеИнформационнойБазыБИД.md b/src/content/docs/zup/ОбновлениеИнформационнойБазыБИД.md new file mode 100644 index 0000000..7fda1e9 --- /dev/null +++ b/src/content/docs/zup/ОбновлениеИнформационнойБазыБИД.md @@ -0,0 +1,266 @@ +--- +title: Обновление информационной базы БИД +slug: zup/обновление-информационной-базы-бид +--- + + +## ПриДобавленииПодсистемы +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Сведения о библиотеке (или конфигурации). + +// Заполняет основные сведения о библиотеке или основной конфигурации. +// Библиотека, имя которой имя совпадает с именем конфигурации в метаданных, определяется как основная конфигурация. +// +// Параметры: +// Описание - Структура: +// +// * Имя - Строка - имя библиотеки, например, "СтандартныеПодсистемы". +// * Версия - Строка - версия в формате из 4-х цифр, например, "2.1.3.1". +// +// * ИдентификаторИнтернетПоддержки - Строка - уникальное имя программы в сервисах Интернет-поддержки. +// * ТребуемыеПодсистемы - Массив из Строка - имена других библиотек, от которых зависит данная библиотека. +// Обработчики обновления таких библиотек должны быть вызваны ранее +// обработчиков обновления данной библиотеки. +// При циклических зависимостях или, напротив, отсутствии каких-либо зависимостей, +// порядок вызова обработчиков обновления определяется порядком добавления модулей +// в процедуре ПриДобавленииПодсистем общего модуля +// ПодсистемыКонфигурацииПереопределяемый. +// * РежимВыполненияОтложенныхОбработчиков - Строка - "Последовательно" - отложенные обработчики обновления выполняются +// последовательно в интервале от номера версии информационной базы до номера +// версии конфигурации включительно или "Параллельно" - отложенный обработчик после +// обработки первой порции данных передает управление следующему обработчику, а после +// выполнения последнего обработчика цикл повторяется заново. +// * ЗаполнятьДанныеНовыхПодсистемПриПереходеСДругойПрограммы - Булево - если установить Истина, то при переходе с +// другой программы будут автоматически выполнены обработчики начального заполнения +// новых подсистем. При описании обработчика обновления можно при необходимости +// отключить его выполнение, указав свойство НеВыполнятьПриПереходеСДругойПрограммы. +// +Процедура ПриДобавленииПодсистемы(Описание) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИД.ПриДобавленииПодсистемы(Описание) +``` +
+ +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обработчики обновления информационной базы. + +// Добавляет в список процедуры-обработчики обновления данных ИБ +// для всех поддерживаемых версий библиотеки или конфигурации. +// Вызывается перед началом обновления данных ИБ для построения плана обновления. +// +// Параметры: +// Обработчики - ТаблицаЗначений - описание полей, см. в процедуре. +// ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +// +// Пример: +// Обработчик = Обработчики.Добавить(); +// Обработчик.Версия = "1.1.0.0"; +// Обработчик.Процедура = "ОбновлениеИБ.ПерейтиНаВерсию_1_1_0_0"; +// Обработчик.РежимВыполнения = "Монопольно"; +// +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИД.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ПередОбновлениемИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед процедурами-обработчиками обновления данных ИБ. +// +Процедура ПередОбновлениемИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИД.ПередОбновлениемИнформационнойБазы() +``` +
+ +## ПослеОбновленияИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после завершения обновления данных ИБ. +// +// Параметры: +// ПредыдущаяВерсия - Строка - версия до обновления. "0.0.0.0" для "пустой" ИБ. +// ТекущаяВерсия - Строка - версия после обновления. +// ВыполненныеОбработчики - ДеревоЗначений - список выполненных процедур-обработчиков обновления, +// сгруппированных по номеру версии. +// ВыводитьОписаниеОбновлений - Булево - если установить Истина, то будет выведена форма +// с описанием обновлений. По умолчанию, Истина. +// Возвращаемое значение. +// МонопольныйРежим - Булево - Истина, если обновление выполнялось в монопольном режиме. +// +// Пример: +// Для Каждого Версия Из ВыполненныеОбработчики.Строки Цикл +// +// Если Версия.Версия = "*" Тогда +// // Обработчик, который может выполнятся при каждой смене версии. +// Иначе +// // Обработчик, который выполняется для определенной версии. +// КонецЕсли; +// +// Для Каждого Обработчик Из Версия.Строки Цикл +// ... +// КонецЦикла; +// +// КонецЦикла; +// +Процедура ПослеОбновленияИнформационнойБазы(Знач ПредыдущаяВерсия, Знач ТекущаяВерсия, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИД.ПослеОбновленияИнформационнойБазы(ПредыдущаяВерсия, ТекущаяВерсия, ); +``` +
+ +## ПриПодготовкеМакетаОписанияОбновлений +
+ +Описание, пример вызова + +```bsl + +// Вызывается при подготовке табличного документа с описанием изменений в программе. +// +// Параметры: +// Макет - ТабличныйДокумент - описание обновления всех библиотек и конфигурации. +// Макет можно дополнить или заменить. +// См. также общий макет ОписаниеИзмененийСистемы. +// +Процедура ПриПодготовкеМакетаОписанияОбновлений(Знач Макет) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИД.ПриПодготовкеМакетаОписанияОбновлений(Макет) +``` +
+ +## ПриОпределенииРежимаОбновленияДанных +
+ +Описание, пример вызова + +```bsl + +// Вызывается при определении режима обновления данных. +// +// Параметры: +// РежимОбновленияДанных - Строка - режим обновления. +// СтандартнаяОбработка - Булево - Ложь, если нужно изменить режим по умолчанию. +// +Процедура ПриОпределенииРежимаОбновленияДанных(РежимОбновленияДанных, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИД.ПриОпределенииРежимаОбновленияДанных(РежимОбновленияДанных, СтандартнаяОбработка) +``` +
+ +## ПриДобавленииОбработчиковПереходаСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список процедуры-обработчики перехода с другой программы (с другим именем конфигурации). +// Например, для перехода между разными, но родственными конфигурациями: базовая -> проф -> корп. +// Вызывается перед началом обновления данных ИБ. +// +// Параметры: +// Обработчики - ТаблицаЗначений: +// * ПредыдущееИмяКонфигурации - Строка - имя конфигурации, с которой выполняется переход; +// или "*", если нужно выполнять при переходе с любой конфигурации. +// * Процедура - Строка - полное имя процедуры-обработчика перехода с программы +// ПредыдущееИмяКонфигурации. +// Например, "ОбновлениеИнформационнойБазыУПП.ЗаполнитьУчетнуюПолитику" +// Обязательно должна быть экспортной. +// +// Пример: +// Обработчик = Обработчики.Добавить(); +// Обработчик.ПредыдущееИмяКонфигурации = "УправлениеТорговлей"; +// Обработчик.Процедура = "ОбновлениеИнформационнойБазыУПП.ЗаполнитьУчетнуюПолитику"; +// +Процедура ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИД.ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) +``` +
+ +## ПриЗавершенииПереходаСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после выполнения всех процедур-обработчиков перехода с другой программы (с другим именем конфигурации), +// и до начала выполнения обновления данных ИБ. +// +// Параметры: +// ПредыдущееИмяКонфигурации - Строка - имя конфигурации до перехода. +// ПредыдущаяВерсияКонфигурации - Строка - имя предыдущей конфигурации (до перехода). +// Параметры - Структура: +// * ВыполнитьОбновлениеСВерсии - Булево - по умолчанию Истина. Если установить Ложь, +// то будут выполнена только обязательные обработчики обновления (с версией "*"). +// * ВерсияКонфигурации - Строка - номер версии после перехода. +// По умолчанию, равен значению версии конфигурации в свойствах метаданных. +// Для того чтобы выполнить, например, все обработчики обновления с версии ПредыдущаяВерсияКонфигурации, +// следует установить значение параметра в ПредыдущаяВерсияКонфигурации. +// Для того чтобы выполнить вообще все обработчики обновления, установить значение "0.0.0.1". +// * ОчиститьСведенияОПредыдущейКонфигурации - Булево - по умолчанию Истина. +// Для случаев когда предыдущая конфигурация совпадает по имени с подсистемой текущей конфигурации, следует +// указать Ложь. +// +Процедура ПриЗавершенииПереходаСДругойПрограммы(ПредыдущееИмяКонфигурации, ПредыдущаяВерсияКонфигурации, Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБИД.ПриЗавершенииПереходаСДругойПрограммы(ПредыдущееИмяКонфигурации, ПредыдущаяВерсияКонфигурации, Параметры) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбновлениеИнформационнойБазыБПО.md b/src/content/docs/zup/ОбновлениеИнформационнойБазыБПО.md new file mode 100644 index 0000000..bfe56ab --- /dev/null +++ b/src/content/docs/zup/ОбновлениеИнформационнойБазыБПО.md @@ -0,0 +1,368 @@ +--- +title: Обновление информационной базы БПО +slug: zup/обновление-информационной-базы-бпо +--- + + +## ПриДобавленииПодсистемы +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Сведения о библиотеке (или конфигурации). + +// Заполняет основные сведения о библиотеке или основной конфигурации. +// Библиотека, имя которой имя совпадает с именем конфигурации в метаданных, определяется как основная конфигурация. +// +// Параметры: +// Описание - Структура - сведения о библиотеке: +// +// * Имя - Строка - имя библиотеки, например, "СтандартныеПодсистемы". +// * Версия - Строка - версия в формате из 4-х цифр, например, "2.1.3.1". +// +// * ТребуемыеПодсистемы - Массив - имена других библиотек (Строка), от которых зависит данная библиотека. +// Обработчики обновления таких библиотек должны быть вызваны ранее +// обработчиков обновления данной библиотеки. +// При циклических зависимостях или, напротив, отсутствии каких-либо зависимостей, +// порядок вызова обработчиков обновления определяется порядком добавления модулей +// в процедуре ПриДобавленииПодсистем общего модуля +// ПодсистемыКонфигурацииПереопределяемый. +// +Процедура ПриДобавленииПодсистемы(Описание) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ПриДобавленииПодсистемы(Описание) +``` +
+ +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обработчики обновления информационной базы. + +// Добавляет в список процедуры-обработчики обновления данных ИБ +// для всех поддерживаемых версий библиотеки или конфигурации. +// Вызывается перед началом обновления данных ИБ для построения плана обновления. +// +// Параметры: +// Обработчики - ТаблицаЗначений - описание полей, см. в процедуре. +// ОбновлениеИнформационнойБазы.НоваяТаблицаОбработчиковОбновления. +// +// Пример добавления процедуры-обработчика в список: +// Обработчик = Обработчики.Добавить(); +// Обработчик.Версия = "1.1.0.0"; +// Обработчик.Процедура = "ОбновлениеИБ.ПерейтиНаВерсию_1_1_0_0"; +// Обработчик.РежимВыполнения = "Оперативно"; +// +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ПередОбновлениемИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается перед процедурами-обработчиками обновления данных ИБ. +// +Процедура ПередОбновлениемИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ПередОбновлениемИнформационнойБазы() +``` +
+ +## ПослеОбновленияИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после завершения обновления данных ИБ. +// +// Параметры: +// ПредыдущаяВерсия - Строка - версия до обновления. "0.0.0.0" для "пустой" ИБ. +// ТекущаяВерсия - Строка - версия после обновления. +// ВыполненныеОбработчики - ДеревоЗначений - список выполненных процедур-обработчиков обновления, +// сгруппированных по номеру версии. +// ВыводитьОписаниеОбновлений - Булево - если установить Истина, то будет выведена форма +// с описанием обновлений. По умолчанию, Истина. +// Возвращаемое значение. +// МонопольныйРежим - Булево - Истина, если обновление выполнялось в монопольном режиме. +// +// Пример обхода выполненных обработчиков обновления: +// +// Для Каждого Версия Из ВыполненныеОбработчики.Строки Цикл +// +// Если Версия.Версия = "*" Тогда +// // Обработчик, который может выполнятся при каждой смене версии. +// Иначе +// // Обработчик, который выполняется для определенной версии. +// КонецЕсли; +// +// Для Каждого Обработчик Из Версия.Строки Цикл +// ... +// КонецЦикла; +// +// КонецЦикла; +// +Процедура ПослеОбновленияИнформационнойБазы(Знач ПредыдущаяВерсия, Знач ТекущаяВерсия, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ПослеОбновленияИнформационнойБазы(ПредыдущаяВерсия, ТекущаяВерсия, ); +``` +
+ +## ПриПодготовкеМакетаОписанияОбновлений +
+ +Описание, пример вызова + +```bsl + +// Вызывается при подготовке табличного документа с описанием изменений в программе. +// +// Параметры: +// Макет - ТабличныйДокумент - описание обновления всех библиотек и конфигурации. +// Макет можно дополнить или заменить. +// См. также общий макет ОписаниеИзмененийСистемы. +// +Процедура ПриПодготовкеМакетаОписанияОбновлений(Знач Макет) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ПриПодготовкеМакетаОписанияОбновлений(Макет) +``` +
+ +## ПриОпределенииРежимаОбновленияДанных +
+ +Описание, пример вызова + +```bsl + +// Позволяет переопределить режим обновления данных информационной базы. +// Для использования в редких (нештатных) случаях перехода, не предусмотренных в +// стандартной процедуре определения режима обновления. +// +// Параметры: +// РежимОбновленияДанных - Строка - в обработчике можно присвоить одно из значений: +// "НачальноеЗаполнение" - если это первый запуск пустой базы (области данных); +// "ОбновлениеВерсии" - если выполняется первый запуск после обновление конфигурации базы данных; +// "ПереходСДругойПрограммы" - если выполняется первый запуск после обновление конфигурации базы данных, +// в которой изменилось имя основной конфигурации. +// +// СтандартнаяОбработка - Булево - если присвоить Ложь, то стандартная процедура +// определения режима обновления не выполняется, +// а используется значение РежимОбновленияДанных. +// +Процедура ПриОпределенииРежимаОбновленияДанных(РежимОбновленияДанных, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ПриОпределенииРежимаОбновленияДанных(РежимОбновленияДанных, СтандартнаяОбработка) +``` +
+ +## ПриДобавленииОбработчиковПереходаСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// Добавляет в список процедуры-обработчики перехода с другой программы (с другим именем конфигурации). +// Например, для перехода между разными, но родственными конфигурациями: базовая -> проф -> корп. +// Вызывается перед началом обновления данных ИБ. +// +// Параметры: +// Обработчики - ТаблицаЗначений - с колонками: +// * ПредыдущееИмяКонфигурации - Строка - имя конфигурации, с которой выполняется переход; +// или "*", если нужно выполнять при переходе с любой конфигурации. +// * Процедура - Строка - полное имя процедуры-обработчика перехода с программы ПредыдущееИмяКонфигурации. +// Например, "ОбновлениеИнформационнойБазыУПП.ЗаполнитьУчетнуюПолитику" +// Обязательно должна быть экспортной. +// +// Пример добавления процедуры-обработчика в список: +// Обработчик = Обработчики.Добавить(); +// Обработчик.ПредыдущееИмяКонфигурации = "УправлениеТорговлей"; +// Обработчик.Процедура = "ОбновлениеИнформационнойБазыУПП.ЗаполнитьУчетнуюПолитику"; +// +Процедура ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики) +``` +
+ +## ПриЗавершенииПереходаСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// Вызывается после выполнения всех процедур-обработчиков перехода с другой программы (с другим именем конфигурации), +// и до начала выполнения обновления данных ИБ. +// +// Параметры: +// ПредыдущееИмяКонфигурации - Строка - имя конфигурации до перехода. +// ПредыдущаяВерсияКонфигурации - Строка - имя предыдущей конфигурации (до перехода). +// Параметры - Структура - +// * ВыполнитьОбновлениеСВерсии - Булево - по умолчанию Истина. Если установить Ложь, +// то будут выполнена только обязательные обработчики обновления (с версией "*"). +// * ВерсияКонфигурации - Строка - номер версии после перехода. +// По умолчанию, равен значению версии конфигурации в свойствах метаданных. +// Для того чтобы выполнить, например, все обработчики обновления с версии ПредыдущаяВерсияКонфигурации, +// следует установить значение параметра в ПредыдущаяВерсияКонфигурации. +// Для того чтобы выполнить вообще все обработчики обновления, установить значение "0.0.0.1". +// * ОчиститьСведенияОПредыдущейКонфигурации - Булево - по умолчанию Истина. +// Для случаев когда предыдущая конфигурация совпадает по имени с подсистемой текущей конфигурации, следует указать Ложь. +// +Процедура ПриЗавершенииПереходаСДругойПрограммы(Знач ПредыдущееИмяКонфигурации, Знач ПредыдущаяВерсияКонфигурации, Параметры) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ПриЗавершенииПереходаСДругойПрограммы(ПредыдущееИмяКонфигурации, ПредыдущаяВерсияКонфигурации, Параметры) +``` +
+ +## ОбновитьПоставляемыеДрайвера +
+ +Описание, пример вызова + +```bsl + +// Обновить поставляемые драйвера БПО. +// +Процедура ОбновитьПоставляемыеДрайвера(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ОбновитьПоставляемыеДрайвера(Параметры); +``` +
+ +## ОбновитьПараметрыККМОфлайн205 +
+ +Описание, пример вызова + +```bsl + +// Обновить параметры ККМ Офлайн. +// +Процедура ОбновитьПараметрыККМОфлайн205(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ОбновитьПараметрыККМОфлайн205(Параметры); +``` +
+ +## ОбновитьПараметрыККМОфлайнЭвотор +
+ +Описание, пример вызова + +```bsl + +// Обновить параметры ККМ Офлайн Эвотор. +// +Процедура ОбновитьПараметрыККМОфлайнЭвотор(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ОбновитьПараметрыККМОфлайнЭвотор(Параметры); +``` +
+ +## ОбновитьПараметрыДатыЗагрузкиККМОфлайнЭвотор +
+ +Описание, пример вызова + +```bsl + +Процедура ОбновитьПараметрыДатыЗагрузкиККМОфлайнЭвотор(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ОбновитьПараметрыДатыЗагрузкиККМОфлайнЭвотор(Параметры); +``` +
+ +## ОбновитьПараметрыККМОфлайн211 +
+ +Описание, пример вызова + +```bsl + +// Обновить параметры ККМ Офлайн. +// +Процедура ОбновитьПараметрыККМОфлайн211(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.ОбновитьПараметрыККМОфлайн211(Параметры); +``` +
+ +## УстановитьПоследнююВерсиюФорматаОфлайнОборудование +
+ +Описание, пример вызова + +```bsl + +Процедура УстановитьПоследнююВерсиюФорматаОфлайнОборудование(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБПО.УстановитьПоследнююВерсиюФорматаОфлайнОборудование(Параметры); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбновлениеИнформационнойБазыБРО.md b/src/content/docs/zup/ОбновлениеИнформационнойБазыБРО.md new file mode 100644 index 0000000..781c88d --- /dev/null +++ b/src/content/docs/zup/ОбновлениеИнформационнойБазыБРО.md @@ -0,0 +1,134 @@ +--- +title: Обновление информационной базы БРО +slug: zup/обновление-информационной-базы-бро +--- + + +## ПриДобавленииПодсистемы +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Объявление библиотеки. + +// Описание этой же процедуры смотрите в модуле ОбновлениеИнформационнойБазыБСП. +// +Процедура ПриДобавленииПодсистемы(Описание) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБРО.ПриДобавленииПодсистемы(Описание) +``` +
+ +## ПриДобавленииОбработчиковОбновления +
+ +Описание, пример вызова + +```bsl + +//////////////////////////////////////////////////////////////////////////////// +// Обработчики событий обновления информационной базы. + +// Описание этой же процедуры смотрите в модуле ОбновлениеИнформационнойБазыБСП. +// +Процедура ПриДобавленииОбработчиковОбновления(Обработчики) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБРО.ПриДобавленииОбработчиковОбновления(Обработчики) +``` +
+ +## ПередОбновлениемИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Описание этой же процедуры смотрите в модуле ОбновлениеИнформационнойБазыБСП. +// +Процедура ПередОбновлениемИнформационнойБазы() Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБРО.ПередОбновлениемИнформационнойБазы() +``` +
+ +## ПослеОбновленияИнформационнойБазы +
+ +Описание, пример вызова + +```bsl + +// Описание этой же процедуры смотрите в модуле ОбновлениеИнформационнойБазыБСП. +// +Процедура ПослеОбновленияИнформационнойБазы(Знач ПредыдущаяВерсия, Знач ТекущаяВерсия, Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБРО.ПослеОбновленияИнформационнойБазы(ПредыдущаяВерсия, ТекущаяВерсия, ); +``` +
+ +## ПриПодготовкеМакетаОписанияОбновлений +
+ +Описание, пример вызова + +```bsl + +// Описание этой же процедуры смотрите в модуле ОбновлениеИнформационнойБазыБСП. +// +Процедура ПриПодготовкеМакетаОписанияОбновлений(Знач Макет) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБРО.ПриПодготовкеМакетаОписанияОбновлений(Макет) +``` +
+ +## ЗаполнитьОбработчикиРазделенныхДанных +
+ +Описание, пример вызова + +```bsl + +// Заполняет обработчик разделенных данных, зависимый от изменения неразделенных данных (Обработчик.Версия = "*" поддерживается). +// +// Параметры: +// Параметры - ТаблицаЗначений, Неопределено - см. описание +// функции НоваяТаблицаОбработчиковОбновления общего модуля +// ОбновлениеИнформационнойБазы. +// В случае прямого вызова (не через механизм обновления +// версии ИБ) передается Неопределено. +// +Процедура ЗаполнитьОбработчикиРазделенныхДанных(Параметры = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбновлениеИнформационнойБазыБРО.ЗаполнитьОбработчикиРазделенныхДанных(Параметры); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбработкаЗаявленийАбонента.md b/src/content/docs/zup/ОбработкаЗаявленийАбонента.md new file mode 100644 index 0000000..f79ea61 --- /dev/null +++ b/src/content/docs/zup/ОбработкаЗаявленийАбонента.md @@ -0,0 +1,174 @@ +--- +title: Обработка заявлений абонента +slug: zup/обработка-заявлений-абонента +--- + + +## ОбработкаЗаявленийАбонентов +
+ +Описание, пример вызова + +```bsl + +// Регламентное задание. +Процедура ОбработкаЗаявленийАбонентов(ДокументЗаявление) Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонента.ОбработкаЗаявленийАбонентов(ДокументЗаявление) +``` +
+ +## ВыгрузитьЗаявлениеАбонентаВМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +Функция ВыгрузитьЗаявлениеАбонентаВМоделиСервиса(Знач ЗаявлениеАбонента, Знач Алгоритм) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонента.ВыгрузитьЗаявлениеАбонентаВМоделиСервиса(ЗаявлениеАбонента, Алгоритм) +``` +
+ +## ЗаявлениеСформироватьЗаявлениеНаРегистрацию +
+ +Описание, пример вызова + +```bsl + +Функция ЗаявлениеСформироватьЗаявлениеНаРегистрацию( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонента.ЗаявлениеСформироватьЗаявлениеНаРегистрацию(); +``` +
+ +## ЗаявлениеСформироватьЗаявлениеНаИзменение +
+ +Описание, пример вызова + +```bsl + +Функция ЗаявлениеСформироватьЗаявлениеНаИзменение( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонента.ЗаявлениеСформироватьЗаявлениеНаИзменение(); +``` +
+ +## СоздатьЗаявлениеНаИзменениеВСкрытомРежиме +
+ +Описание, пример вызова + +```bsl + +Функция СоздатьЗаявлениеНаИзменениеВСкрытомРежиме(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонента.СоздатьЗаявлениеНаИзменениеВСкрытомРежиме(Организация) +``` +
+ +## СоздатьНовоеЗаявлениеНаПереход +
+ +Описание, пример вызова + +```bsl + +Функция СоздатьНовоеЗаявлениеНаПереход(ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонента.СоздатьНовоеЗаявлениеНаПереход(ВходящийКонтекст) +``` +
+ +## ПолучитьДанныеСотрудника +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьДанныеСотрудника(ВидВладельцаЭЦП, ДанныеОрганизации, Сотрудник) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонента.ПолучитьДанныеСотрудника(ВидВладельцаЭЦП, ДанныеОрганизации, Сотрудник) +``` +
+ +## ПользовательНачалИспользоватьОтчетность +
+ +Описание, пример вызова + +```bsl + +Функция ПользовательНачалИспользоватьОтчетность(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонента.ПользовательНачалИспользоватьОтчетность(Организация) +``` +
+ +## СостояниеЗаявленияНаПодключениеОтчетности +
+ +Описание, пример вызова + +```bsl + +Функция СостояниеЗаявленияНаПодключениеОтчетности(Организация) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонента.СостояниеЗаявленияНаПодключениеОтчетности(Организация) +``` +
+ +## ДобавитьОтборПоОрганизации +
+ +Описание, пример вызова + +```bsl + +Процедура ДобавитьОтборПоОрганизации(Запрос, Организация) Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонента.ДобавитьОтборПоОрганизации(Запрос, Организация)); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбработкаЗаявленийАбонентаВызовСервера.md b/src/content/docs/zup/ОбработкаЗаявленийАбонентаВызовСервера.md new file mode 100644 index 0000000..b48bd14 --- /dev/null +++ b/src/content/docs/zup/ОбработкаЗаявленийАбонентаВызовСервера.md @@ -0,0 +1,243 @@ +--- +title: Обработка заявлений абонента вызов сервера +slug: zup/обработка-заявлений-абонента-вызов-сервера +--- + + +## СледующееЗаявлениеТребующееРеакцииПользователя +
+ +Описание, пример вызова + +```bsl + +Функция СледующееЗаявлениеТребующееРеакцииПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.СледующееЗаявлениеТребующееРеакцииПользователя() +``` +
+ +## ВключитьОтслеживаниеИзмененияСтатусаЗаявления +
+ +Описание, пример вызова + +```bsl + +Процедура ВключитьОтслеживаниеИзмененияСтатусаЗаявления(ДокументЗаявление) Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаВызовСервера.ВключитьОтслеживаниеИзмененияСтатусаЗаявления(ДокументЗаявление) +``` +
+ +## ОтключитьОтслеживаниеИзменениеСтатусаЗаявления +
+ +Описание, пример вызова + +```bsl + +Процедура ОтключитьОтслеживаниеИзменениеСтатусаЗаявления(ДокументЗаявление) Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаВызовСервера.ОтключитьОтслеживаниеИзменениеСтатусаЗаявления(ДокументЗаявление) +``` +
+ +## ПолучитьИРазобратьОтветНаЗаявление +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьИРазобратьОтветНаЗаявление( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.ПолучитьИРазобратьОтветНаЗаявление(); +``` +
+ +## ОтправленныеЗаявленияАбонентов +
+ +Описание, пример вызова + +```bsl + +Функция ОтправленныеЗаявленияАбонентов( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.ОтправленныеЗаявленияАбонентов(); +``` +
+ +## ЕстьОтправленныеИлиОдобренныеЗаявления +
+ +Описание, пример вызова + +```bsl + +// Проверяет наличие отправленных или одобренных заявления по 1С-Отчетности +// Внимание! Не менять без согласования с БП3. Вызывается из БП3. +// +// Возвращаемое значение: +// Булево - есть ли отправленные или одобренные заявлений +// +Функция ЕстьОтправленныеИлиОдобренныеЗаявления() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.ЕстьОтправленныеИлиОдобренныеЗаявления() +``` +
+ +## ОбновитьРеквизитыЗаявления +
+ +Описание, пример вызова + +```bsl + +Функция ОбновитьРеквизитыЗаявления(Документ, РеквизитыДокумента) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.ОбновитьРеквизитыЗаявления(Документ, РеквизитыДокумента) +``` +
+ +## ПолучитьСтруктуруРеквизитовЗаявления +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьСтруктуруРеквизитовЗаявления(Документ) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.ПолучитьСтруктуруРеквизитовЗаявления(Документ) +``` +
+ +## СформироватьИОтправитьЗаявлениеВМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +Функция СформироватьИОтправитьЗаявлениеВМоделиСервиса(ДокументЗаявление, Алгоритм) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.СформироватьИОтправитьЗаявлениеВМоделиСервиса(ДокументЗаявление, Алгоритм) +``` +
+ +## ОбработатьИзменениеСтатусаЗаявленияАбонентаВМоделиСервиса +
+ +Описание, пример вызова + +```bsl + +Функция ОбработатьИзменениеСтатусаЗаявленияАбонентаВМоделиСервиса(ДокументЗаявление) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.ОбработатьИзменениеСтатусаЗаявленияАбонентаВМоделиСервиса(ДокументЗаявление) +``` +
+ +## ПолучитьОтветСервераНаЗаявлениеАбонента +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьОтветСервераНаЗаявлениеАбонента(ДокументЗаявление) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.ПолучитьОтветСервераНаЗаявлениеАбонента(ДокументЗаявление) +``` +
+ +## ПолучитьРеквизитОблачнойПодписи +
+ +Описание, пример вызова + +```bsl + +Функция ПолучитьРеквизитОблачнойПодписи(ДокументЗаявление, ВидПараметра) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.ПолучитьРеквизитОблачнойПодписи(ДокументЗаявление, ВидПараметра) +``` +
+ +## ПоддерживаетсяВторичноеЗаявление +
+ +Описание, пример вызова + +```bsl + +Функция ПоддерживаетсяВторичноеЗаявление(УчетнаяЗапись) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.ПоддерживаетсяВторичноеЗаявление(УчетнаяЗапись) +``` +
+ +## ВерсияБСП +
+ +Описание, пример вызова + +```bsl + +Функция ВерсияБСП() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаВызовСервера.ВерсияБСП() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбработкаЗаявленийАбонентаГлобальный.md b/src/content/docs/zup/ОбработкаЗаявленийАбонентаГлобальный.md new file mode 100644 index 0000000..cfe04fa --- /dev/null +++ b/src/content/docs/zup/ОбработкаЗаявленийАбонентаГлобальный.md @@ -0,0 +1,29 @@ +--- +title: Обработка заявлений абонента глобальный +slug: zup/обработка-заявлений-абонента-глобальный +--- + + +## СообщитьОбОдобренныхЗаявленияхАбонента +
+ +Описание, пример вызова + +```bsl + +Процедура СообщитьОбОдобренныхЗаявленияхАбонента() Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаГлобальный.СообщитьОбОдобренныхЗаявленияхАбонента() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбработкаЗаявленийАбонентаКлиент.md b/src/content/docs/zup/ОбработкаЗаявленийАбонентаКлиент.md new file mode 100644 index 0000000..36f6936 --- /dev/null +++ b/src/content/docs/zup/ОбработкаЗаявленийАбонентаКлиент.md @@ -0,0 +1,193 @@ +--- +title: Обработка заявлений абонента клиент +slug: zup/обработка-заявлений-абонента-клиент +--- + + +## ПодключитьОбработчикПроверкиЗаявлений +
+ +Описание, пример вызова + +```bsl + +Процедура ПодключитьОбработчикПроверкиЗаявлений(Интервал = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаКлиент.ПодключитьОбработчикПроверкиЗаявлений(Интервал); +``` +
+ +## ОтключитьОбработчикПроверкиЗаявлений +
+ +Описание, пример вызова + +```bsl + +Процедура ОтключитьОбработчикПроверкиЗаявлений() Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаКлиент.ОтключитьОбработчикПроверкиЗаявлений() +``` +
+ +## ВключитьАвтоматическуюПроверкуСтатуса +
+ +Описание, пример вызова + +```bsl + +Процедура ВключитьАвтоматическуюПроверкуСтатуса(ДокументЗаявление) Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаКлиент.ВключитьАвтоматическуюПроверкуСтатуса(ДокументЗаявление) +``` +
+ +## СообщитьОбОдобренныхЗаявленияхАбонента_ПослеПолученияКонтекста +
+ +Описание, пример вызова + +```bsl + +Процедура СообщитьОбОдобренныхЗаявленияхАбонента_ПослеПолученияКонтекста(Результат, ВходящийКонтекст) Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаКлиент.СообщитьОбОдобренныхЗаявленияхАбонента_ПослеПолученияКонтекста(Результат, ВходящийКонтекст) +``` +
+ +## ПодсказкаКСертификатуОбработкаНавигационнойСсылки +
+ +Описание, пример вызова + +```bsl + +Процедура ПодсказкаКСертификатуОбработкаНавигационнойСсылки(Форма, НавигационнаяСсылка, СтандартнаяОбработка) Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаКлиент.ПодсказкаКСертификатуОбработкаНавигационнойСсылки(Форма, НавигационнаяСсылка, СтандартнаяОбработка) +``` +
+ +## ПараметрыНовогоСертификата +
+ +Описание, пример вызова + +```bsl + +////////////////////////////////////////////////////////////////////////////////////////////// +// Данные для запроса на сертификат +// +////////////////////////////////////////////////////////////////////////////////////////////// +Функция ПараметрыНовогоСертификата(ДокументЗаявление) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаКлиент.ПараметрыНовогоСертификата(ДокументЗаявление) +``` +
+ +## ДоступноСканирование +
+ +Описание, пример вызова + +```bsl + +Функция ДоступноСканирование() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаКлиент.ДоступноСканирование() +``` +
+ +## ФормаОповещенияИлиМастераУжеОткрыта +
+ +Описание, пример вызова + +```bsl + +Функция ФормаОповещенияИлиМастераУжеОткрыта() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаКлиент.ФормаОповещенияИлиМастераУжеОткрыта() +``` +
+ +## ОткрытьФормуПомощи +
+ +Описание, пример вызова + +```bsl + +Процедура ОткрытьФормуПомощи(Форма, ФИО = "", НомерТелефона = "", СсылкаНаИнструкцию = "") Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаКлиент.ОткрытьФормуПомощи(Форма, ФИО, НомерТелефона, СсылкаНаИнструкцию); +``` +
+ +## Открыть1СОтчетностьНаЗакладкеОтчеты +
+ +Описание, пример вызова + +```bsl + +Процедура Открыть1СОтчетностьНаЗакладкеОтчеты() Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаКлиент.Открыть1СОтчетностьНаЗакладкеОтчеты() +``` +
+ +## ОткрытьЗаявлениеНаПодключение +
+ +Описание, пример вызова + +```bsl + +Процедура ОткрытьЗаявлениеНаПодключение(ЗаявлениеНаПодключение) Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаКлиент.ОткрытьЗаявлениеНаПодключение(ЗаявлениеНаПодключение) +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбработкаЗаявленийАбонентаКлиентСервер.md b/src/content/docs/zup/ОбработкаЗаявленийАбонентаКлиентСервер.md new file mode 100644 index 0000000..b687a6f --- /dev/null +++ b/src/content/docs/zup/ОбработкаЗаявленийАбонентаКлиентСервер.md @@ -0,0 +1,88 @@ +--- +title: Обработка заявлений абонента клиент сервер +slug: zup/обработка-заявлений-абонента-клиент-сервер +--- + + +## УстановитьПараметрПодключения +
+ +Описание, пример вызова + +```bsl + +// Устанавливает значение параметра облачной подписи в заявление по его виду +// +// Параметры: +// ОбъектДокумента - ДокументОбъект.ЗаявлениеАбонентаСпецоператораСвязи +// ВидПараметра - ПеречислениеСсылка.ПараметрыПодключенияКОблачнойПодписи, Строка +// ТекущееЗначение - Строка, Булево, СправочникСсылка.УчетныеЗаписиDSS +// +// Возвращаемое значение: +// Строка, Булево, СправочникСсылка.УчетныеЗаписиDSS +// +Процедура УстановитьПараметрПодключения(ОбъектДокумента, ВидПараметра, ТекущееЗначение) Экспорт +``` + +Пример вызова +```bsl +ОбработкаЗаявленийАбонентаКлиентСервер.УстановитьПараметрПодключения(ОбъектДокумента, ВидПараметра, ТекущееЗначение) +``` +
+ +## ПолучитьПараметрПодключения +
+ +Описание, пример вызова + +```bsl + +// Возвращает установленое значение параметра облачной подписи в заявление по его виду +// +// Параметры: +// ОбъектДокумента - ДокументОбъект.ЗаявлениеАбонентаСпецоператораСвязи, ДокументСсылка.ЗаявлениеАбонентаСпецоператораСвязи +// ВидПараметра - ПеречислениеСсылка.ПараметрыПодключенияКОблачнойПодписи, Строка +// +// Возвращаемое значение: +// Строка, Булево, СправочникСсылка.УчетныеЗаписиDSS +// +Функция ПолучитьПараметрПодключения(ОбъектДокумента, ВидПараметра) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаКлиентСервер.ПолучитьПараметрПодключения(ОбъектДокумента, ВидПараметра) +``` +
+ +## СведенияОблачнойПодписиЗаявления +
+ +Описание, пример вызова + +```bsl + +// Формирует структуру для хранения информации об используемой облачной подписи в заявлениях. +// +// Параметры: +// ОбъектДокумента - ДокументСсылка.ЗаявлениеАбонентаСпецоператораСвязи, Структура, ДанныеФормыСтруктура +// +// Возвращаемое значение: +// Структура +// +Функция СведенияОблачнойПодписиЗаявления(ОбъектДокумента = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаЗаявленийАбонентаКлиентСервер.СведенияОблачнойПодписиЗаявления(ОбъектДокумента); +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбработкаНовостей.md b/src/content/docs/zup/ОбработкаНовостей.md new file mode 100644 index 0000000..64394b7 --- /dev/null +++ b/src/content/docs/zup/ОбработкаНовостей.md @@ -0,0 +1,2967 @@ +--- +title: Обработка новостей +slug: zup/обработка-новостей +--- + + +## РазрешитьРаботуСНовостями +
+ +Описание, пример вызова + +```bsl + +// Включает работу с новостями. +// Если включение происходит после обновления конфигурации, то можно загрузить данные из макетов. +// Возможно использование в коробке или в неразделенном сеансе при работе в модели сервиса. +// При попытке запуска в модели сервиса в разделенном сеансе будет выдано исключение. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - см. ОбработкаНовостейКлиентСервер.НоваяЗаписьРезультатовВыполненияОпераций, +// а также дополнительные ключи: +// * ЗагрузитьВсеСтандартныеЗначения - Булево - если ИСТИНА, то запустить загрузку стандартных значений из макетов; +// * ДополнительныеСвойства - Структура - будет передано в менеджер значения константы без изменений. +// +Процедура РазрешитьРаботуСНовостями(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.РазрешитьРаботуСНовостями(КонтекстВыполнения); +``` +
+ +## ЗапретитьРаботуСНовостями +
+ +Описание, пример вызова + +```bsl + +// Отключает работу с новостями. +// Возможно использование в коробке или в неразделенном сеансе при работе в модели сервиса. +// Пример использования: при старте программы запретить новости (т.к. работает "мастер первоначальной настройки"), +// а после завершения работы мастера разрешить работу с новостями. +// При попытке запуска в модели сервиса в разделенном сеансе будет выдано исключение. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - см. ОбработкаНовостейКлиентСервер.НоваяЗаписьРезультатовВыполненияОпераций, +// а также дополнительные ключи: +// * ДополнительныеСвойства - Структура - будет передано в менеджер значения константы без изменений. +// +Процедура ЗапретитьРаботуСНовостями(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ЗапретитьРаботуСНовостями(КонтекстВыполнения); +``` +
+ +## УстановитьСостояниеНовостейДляПользователей +
+ +Описание, пример вызова + +```bsl + +// Процедура устанавливает одинаковые состояния для новостей в текущей области данных. +// Это полезно, например, при первом старте программы (при создании из cf), +// когда необходимо отключить оповещения и поставить признак прочтенности +// у всех новостей для предыдущих версий программы. +// Так как справочник Пользователи разделенный, то в модели сервиса процедуру +// можно запускать только в разделенном сеансе. +// +// Параметры: +// ВыбранныеПользователи - Массив из СправочникСсылка.Пользователи, СправочникСсылка.Пользователи, Неопределено - Массив пользователей +// или единственный пользователь, для которых необходимо установить состояния новостей; +// СтруктураОтборов - Структура - структура со значениями отборов. Возможные ключи: +// * СписокНовостей - СписокЗначений - список новостей. Если параметр установлен, +// то остальные параметры отбора игнорируются; +// * СписокЛентНовостей - СписокЗначений - список лент новостей. Если не указан, то по всем.; +// * ИнтервалВерсийПродукта - Структура - отбор по версиям продукта. Содержит ключи: +// * Продукт - Строка - наименование продукта; +// * ВерсияОТ - Строка - начальная версия в формате 99.99.999.9999; +// * ВерсияДО - Строка - конечная версия в формате 99.99.999.9999; +// * ИнтервалВерсийПлатформы - Структура - отбор по версиям платформы. Содержит ключи: +// * ВерсияОТ - Строка - начальная версия в формате 99.99.999.9999; +// * ВерсияДО - Строка - конечная версия в формате 99.99.999.9999; +// ЗначенияСостояний - Структура - структура значений для заполнения реквизитов +// регистра сведений СостоянияНовостей. Возможны ключи: +// * Прочтена - Булево - Признак прочтенности. Если не указано, то не будет изменено; +// * Пометка - Число - Признак пометки флажком. Если не указано, то не будет изменено; +// * ОповещениеВключено - Булево - Признак снятия оповещения. Если не указано, то не будет изменено; +// * ДатаНачалаОповещения - Дата - Дата начала оповещения (UTC+0). Если не указано, то не будет изменено; +// * УдаленаИзСпискаНовостей - Булево - Признак помещения в корзину. Если не указано, то не будет изменено. +// +Процедура УстановитьСостояниеНовостейДляПользователей( Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.УстановитьСостояниеНовостейДляПользователей(); +``` +
+ +## ИзменитьПометкуНовостей +
+ +Описание, пример вызова + +```bsl + +// Процедура помечает для текущего пользователя несколько новостей пометкой (число 0..9, где 0 = нет пометки). +// При вызове из неразделенного сеанса в модели сервиса будет ошибка. +// +// Параметры: +// МассивНовостей - Массив из СправочникСсылка.Новости - массив ссылок на новости; +// Пометка - Число - число в интервале 0..9, где 0 - неотмеченная новость. +// +Процедура ИзменитьПометкуНовостей(Знач МассивНовостей, Знач Пометка = 1) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ИзменитьПометкуНовостей(МассивНовостей, Пометка); +``` +
+ +## ИзменитьПризнакПрочтенностиНовостей +
+ +Описание, пример вызова + +```bsl + +// Процедура изменяет для текущего пользователя признак прочтенности у новостей. +// При вызове из неразделенного сеанса в модели сервиса будет ошибка. +// +// Параметры: +// МассивНовостей - Массив из СправочникСсылка.Новости - массив ссылок на новости; +// ПризнакПрочтенности - Булево - Истина, если новость надо пометить как прочтенную, Ложь - как непрочтенную. +// +Процедура ИзменитьПризнакПрочтенностиНовостей(Знач МассивНовостей, Знач ПризнакПрочтенности = Истина) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ИзменитьПризнакПрочтенностиНовостей(МассивНовостей, ПризнакПрочтенности); +``` +
+ +## ИзменитьПризнакУдаленияИзСпискаНовостей +
+ +Описание, пример вызова + +```bsl + +// Процедура изменяет для текущего пользователя признак удаления из списка у новостей. +// При вызове из неразделенного сеанса в модели сервиса будет ошибка. +// +// Параметры: +// МассивНовостей - Массив из СправочникСсылка.Новости - массив ссылок на новости; +// ПризнакУдаленияИзСписка - Булево - Истина - удалить из списка новостей (в корзину), Ложь - восстановить из корзины. +// +Процедура ИзменитьПризнакУдаленияИзСпискаНовостей(Знач МассивНовостей, Знач ПризнакУдаленияИзСписка = Истина) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ИзменитьПризнакУдаленияИзСпискаНовостей(МассивНовостей, ПризнакУдаленияИзСписка); +``` +
+ +## ИзменитьПризнакОповещенияНовостей +
+ +Описание, пример вызова + +```bsl + +// Процедура изменяет для текущего пользователя признак прекращения оповещения у новостей. +// Имеет смысл только для важных и очень важных новостей. +// При вызове из неразделенного сеанса в модели сервиса будет ошибка. +// +// Параметры: +// МассивНовостей - Массив из СправочникСсылка.Новости - массив ссылок на новости; +// ОповещениеВключено - Булево - Истина, если новость будет всплывать, ложь - не будет; +// ДатаНачалаОповещения - Дата - дата (UTC+0), начиная с которой необходимо включить всплывание. +// +Процедура ИзменитьПризнакОповещенияНовостей(Знач МассивНовостей, Знач ОповещениеВключено = Ложь, Знач ДатаНачалаОповещения = '00010101') Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ИзменитьПризнакОповещенияНовостей(МассивНовостей, ОповещениеВключено, ДатаНачалаОповещения); +``` +
+ +## ПолучитьСостояниеОповещения +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает реальное состояние оповещения для новости на текущую дату. +// Возможна ситуация, когда записи в регистре сведений "СостоянияНовостей" нет, тогда программа рассчитывает их, +// исходя из состояния Важности новости и Важности в привязке к метаданным (если важность > 0, то оповещение включено). +// +// Параметры: +// МассивНовостей - Массив из СправочникСсылка.Новости - массив новостей, которые необходимо обработать. +// +// Возвращаемое значение: +// Соответствие - соответствие, где: +// * ключ - СправочникСсылка.Новости; +// * значение - Булево - должно ли быть включено оповещение на данный момент или нет. +// +Функция ПолучитьСостояниеОповещения(МассивНовостей) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьСостояниеОповещения(МассивНовостей) +``` +
+ +## ПолучитьЗагруженныеНовости +
+ +Описание, пример вызова + +```bsl + +// На основании значении регистра сведений ДатыЗагрузкиПоследнихНовостей до и после загрузки определяет, +// какие новости были загружены. +// +// Параметры: +// ТаблицаДатЗагрузокНовостейПередПолучением - ТаблицаЗначений - состав колонок соответствует +// регистру сведений ДатыЗагрузкиПоследнихНовостей. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица значений с колонками: +// * Новость - СправочникСсылка.Новости - ссылка на новость; +// * НовостьУникальныйИдентификатор - УникальныйИдентификатор - УИН от ссылки на новость; +// * НовостьНаименование - Строка - заголовок новости; +// * НовостьПодзаголовок - Строка - подзаголовок новости; +// * НовостьДатаПубликации - Дата - дата публикации; +// * НовостьДатаЗавершения - Дата - дата завершения; +// * НовостьПометкаУдаления - Булево - пометка удаления; +// * НовостьЛентаНовостей - СправочникСсылка.ЛентыНовостей - лента новостей; +// * НовостьКодЛентыНовостей - Строка - код ленты новостей. +// +Функция ПолучитьЗагруженныеНовости(ТаблицаДатЗагрузокНовостейПередПолучением) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьЗагруженныеНовости(ТаблицаДатЗагрузокНовостейПередПолучением) +``` +
+ +## ПолучитьПредставлениеКатегорииИЗначения +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает результат конкатенации КатегорияНовостей и ЗначениеКатегорииНовостей. +// Нужно только для формирования XML-представления новости. +// +// Параметры: +// КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей - категория новостей; +// ЗначениеКатегорииНовостей - Произвольный - значение категории новостей. +// +// Возвращаемое значение: +// Строка - строковое описание связки категории и значения. +// +Функция ПолучитьПредставлениеКатегорииИЗначения(КатегорияНовостей, ЗначениеКатегорииНовостей) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьПредставлениеКатегорииИЗначения(КатегорияНовостей, ЗначениеКатегорииНовостей) +``` +
+ +## ИзменитьПользовательскуюВидимостьЛентНовостей +
+ +Описание, пример вызова + +```bsl + +// Изменяет настройку видимости лент новостей для пользователя. +// Работает только в коробке или в разделенном режиме модели сервиса. +// +// Параметры: +// ЛентыНовостей - СправочникСсылка.ЛентаНовостей, Массив из СправочникСсылка.ЛентаНовостей - Ленты новостей, +// для которых необходимо изменить настройку видимости; +// Видимость - Булево - истина = лента видима, ложь = лента скрыта; +// Пользователь - СправочникСсылка.Пользователи - пользователь, +// для которого необходимо изменить признак видимости ленты новостей; +// +Процедура ИзменитьПользовательскуюВидимостьЛентНовостей(ЛентыНовостей, Видимость = Ложь, Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ИзменитьПользовательскуюВидимостьЛентНовостей(ЛентыНовостей, Видимость, Пользователь); +``` +
+ +## ИзменитьВидимостьЛентНовостейДляОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Изменяет настройку видимости лент новостей для текущей области данных. +// Должно запускаться или в коробке, или в разделенном сеансе. +// +// Параметры: +// ЛентыНовостей - СправочникСсылка.ЛентаНовостей, Массив из СправочникСсылка.ЛентыНовостей - Ленты новостей, +// для которых необходимо изменить настройку видимости; +// Видимость - Булево - истина = лента видима, ложь = лента скрыта; +// ПричинаОтключения - Строка - произвольный текст, описывающий причину отключения +// ленты новостей для области данных. +// Если Видимость = Истина, то этот параметр будет проигнорирован. +// МассивОбластейДанных - Массив из Число, Неопределено - при запуске в неразделенном сеансе в модели сервиса можно передать +// список номеров областей, для которых необходимо изменить видимость ленты новостей. +// В остальных режимах работы (в коробке, в разделенном сеансе) +// этот параметр будет проигнорирован. +// +Процедура ИзменитьВидимостьЛентНовостейДляОбластиДанных( Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ИзменитьВидимостьЛентНовостейДляОбластиДанных(); +``` +
+ +## ИзменитьПользовательскиеСпособыОповещенияЛентНовостей +
+ +Описание, пример вызова + +```bsl + +// Устанавливает настройки оповещения для ленты новостей и для пользователя. +// Работает только в коробке или в разделенном режиме модели сервиса. +// +// Параметры: +// ЛентыНовостей - СправочникСсылка.ЛентаНовостей, Массив из СправочникСсылка.ЛентаНовостей - Ленты новостей, +// для которых необходимо изменить настройку видимости; +// НастройкиОповещения - Структура - см. ПолучитьНастройкиОповещенияЛентыНовостей; +// Пользователь - СправочникСсылка.Пользователи, Неопределено - Пользователь, для которого необходимо получить способ оповещения; +// Если Неопределено, то текущий пользователь. +// +Процедура ИзменитьПользовательскиеСпособыОповещенияЛентНовостей(ЛентыНовостей, НастройкиОповещения, Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ИзменитьПользовательскиеСпособыОповещенияЛентНовостей(ЛентыНовостей, НастройкиОповещения, Пользователь); +``` +
+ +## ЭтоВнешнийПользовательСВозможностьюЧтениеНовостей +
+ +Описание, пример вызова + +```bsl + +// Подсистема ЧтениеНовостей не рассчитана на работу с внешними пользователями, +// поэтому если в программу зашел внешний пользователь, и у него включена роль ЧтениеНовостей или ПолныеПрава +// или РедактированиеНовостей, то вывести сообщение в журнал регистрации. +// +// Возвращаемое значение: +// Булево - Истина, если это внешний пользователь с возможностью чтения новостей +// (доступна одна из ролей: ЧтениеНовостей, РедактированиеНовостей, ПолныеПрава). +// +Функция ЭтоВнешнийПользовательСВозможностьюЧтениеНовостей() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ЭтоВнешнийПользовательСВозможностьюЧтениеНовостей() +``` +
+ +## ПараметрыТекущегоПользователя +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает фиксированную структуру с часто используемыми параметрами пользователя. +// +// Возвращаемое значение: +// ФиксированнаяСтруктура - фиксированная структура с ключами: +// * ИмяПользователяИБ - Строка - имя пользователя; +// * ЕстьРольЧтенияНовостей - Булево - доступность указанной роли; +// * ЕстьРольРедактированиеНовостей - Булево - доступность указанной роли; +// * ЕстьРольПолныеПрава - Булево - доступность указанной роли; +// * ЕстьРольАдминистраторСистемы - Булево - доступность указанной роли; +// * ЭтоВнешнийПользователь - Булево - это внешний пользователь; +// * ЭтоФоновоеЗадание - Булево - это фоновое задание; +// * ТекущийПользовательСсылка - СправочникСсылка.Пользователи - ссылка на элемент справочника. +// +Функция ПараметрыТекущегоПользователя() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПараметрыТекущегоПользователя() +``` +
+ +## ПриИзмененииЗначенийОтборовОбщих +
+ +Описание, пример вызова + +```bsl + +// В некоторых новостях может быть установлена категория, проверяющая состояние некоторой функциональной опции, +// например "Эта новость только если подключен Облачный архив" с текстом "Вышла новая версия Облачного архива", +// или "Эта новость только если не подключены СПАРК Риски" с текстом "Предлагаем подключить СПАРК Риски". +// После изменения значения этой категории (подключили / отключили услугу и т.п.), необходимо показать или скрыть некоторые новости, +// а для этого необходимо пересчитать отборы. +// Условия показа новости могут быть как общие для всех новостей всей информационной базы, так и только для отдельной области данных. +// Процедура заполняет регистры сведений ОтборыПоЛентамНовостейОбщие и РассчитанныеОтборыПоНовостям_Общие +// чтобы отобразить или скрыть некоторые новости. +// Вызывается автоматически регламентным заданием пересчета отборов или при обновлении конфигурации, но +// для того, чтобы отфильтровать новости сразу, то может также вызываться вручную в модели сервиса в неразделенном сеансе, или в коробке. +// +Процедура ПриИзмененииЗначенийОтборовОбщих() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПриИзмененииЗначенийОтборовОбщих() +``` +
+ +## ПриИзмененииЗначенийОтборовДляОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// В некоторых новостях может быть установлена категория, проверяющая состояние некоторой функциональной опции, +// например "Эта новость только если подключен Облачный архив" с текстом "Вышла новая версия Облачного архива", +// или "Эта новость только если не подключены СПАРК Риски" с текстом "Предлагаем подключить СПАРК Риски". +// После изменения значения этой категории (подключили / отключили услугу и т.п.), необходимо показать или скрыть некоторые новости, +// а для этого необходимо пересчитать отборы. +// Условия показа новости могут быть как общие для всех новостей всей информационной базы, так и только для отдельной области данных. +// Процедура заполняет регистры сведений ОтборыПоЛентамНовостейДляОбластиДанных и РассчитанныеОтборыПоНовостям_ДляОбластиДанных +// чтобы отобразить или скрыть некоторые новости. +// Должно вызываться вручную после изменения необходимых для отбора новостей значений. +// Может работать в модели сервиса. +// В модели сервиса работает независимо от того, вошли в область данных или нет. +// Если вошли в область данных, то будут пересчитаны только отборы по текущей области данных. +// +Процедура ПриИзмененииЗначенийОтборовДляОбластиДанных() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПриИзмененииЗначенийОтборовДляОбластиДанных() +``` +
+ +## ПриИзмененииЗначенийОтборовПользовательских +
+ +Описание, пример вызова + +```bsl + +// Процедура заполняет регистр сведений ОтборыПоЛентамНовостейПользовательские и РассчитанныеОтборыПоНовостям_Пользовательские +// чтобы отобразить или скрыть некоторые новости. +// Должно вызываться вручную после изменения необходимых для отбора новостей значений. +// Может работать в модели сервиса. +// В модели сервиса работает независимо от того, вошли в область данных или нет. +// Если вошли в область данных, то будут пересчитаны только отборы по текущей области данных. +// +// Параметры: +// Пользователь - Неопределено, СправочникСсылка.Пользователи, Массив из СправочникСсылка.Пользователи - пользователи, +// по которым необходимо пересчитать новости-исключения. Если Неопределено, то по всем. +// +Процедура ПриИзмененииЗначенийОтборовПользовательских(Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПриИзмененииЗначенийОтборовПользовательских(Пользователь); +``` +
+ +## ЗначенияОтборов_Общие +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений (возможно с одной строкой данных) для передачи как параметр в +// ОбработкаНовостей.ДобавитьПрограммноеЗначениеОтбора_Общий, +// ОбработкаНовостей.ПолучитьПрограммноеЗначениеОтбора_Общий, +// ОбработкаНовостей.УдалитьПрограммноеЗначениеОтбора_Общий. +// +// Параметры: +// ДанныеОтбора - Структура - данные отбора с ключами: +// * КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей - Категория. Если Неопределено, +// то возвратится пустая таблица значений; +// * ЗначениеКатегорииНовостей - Характеристика.КатегорииНовостей - Значение категории. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица значений с колонками: +// * КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей - Категория; +// * ЗначениеКатегорииНовостей - Характеристика.КатегорииНовостей - Значение категории; +// * ДатаОбновления - Дата - дата и время обновления записи (в формате нулевого меридиана); +// * УсловиеВыполнено - Булево - признак выполнения этого условия. +// +Функция ЗначенияОтборов_Общие(ДанныеОтбора = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ЗначенияОтборов_Общие(ДанныеОтбора); +``` +
+ +## ЗначенияОтборов_ДляОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений (возможно с одной строкой данных) для передачи как параметр в +// ОбработкаНовостей.ДобавитьПрограммноеЗначениеОтбора_ДляОбластиДанных, +// ОбработкаНовостей.ПолучитьПрограммноеЗначениеОтбора_ДляОбластиДанных, +// ОбработкаНовостей.УдалитьПрограммноеЗначениеОтбора_ДляОбластиДанных. +// +// Параметры: +// ДанныеОтбора - Структура - данные отбора с ключами: +// * КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей - Категория. Если Неопределено, +// то возвратится пустая таблица значений; +// * ЗначениеКатегорииНовостей - Характеристика.КатегорииНовостей - Значение категории; +// * НомерОбластиДанных - Число, Неопределено - номер области данных. +// Надо заполнять только при вызове в модели сервиса из неразделенного сеанса. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица значений с колонками: +// * КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей - Категория; +// * ЗначениеКатегорииНовостей - Характеристика.КатегорииНовостей - Значение категории; +// * ДатаОбновления - Дата - дата и время обновления записи (в формате нулевого меридиана); +// * НомерОбластиДанных - Число, Неопределено - номер области данных; +// * УсловиеВыполнено - Булево - признак выполнения этого условия. +// +Функция ЗначенияОтборов_ДляОбластиДанных(ДанныеОтбора = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ЗначенияОтборов_ДляОбластиДанных(ДанныеОтбора); +``` +
+ +## ЗначенияОтборов_Пользовательские +
+ +Описание, пример вызова + +```bsl + +// Возвращает таблицу значений (возможно с одной строкой данных) для передачи как параметр в +// ОбработкаНовостей.ДобавитьПрограммноеЗначениеОтбора_Пользовательский, +// ОбработкаНовостей.ПолучитьПрограммноеЗначениеОтбора_Пользовательский, +// ОбработкаНовостей.УдалитьПрограммноеЗначениеОтбора_Пользовательский. +// +// Параметры: +// ДанныеОтбора - Структура - данные отбора с ключами: +// * КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей - Категория. Если Неопределено, +// то возвратится пустая таблица значений; +// * ЗначениеКатегорииНовостей - Характеристика.КатегорииНовостей - Значение категории; +// * Пользователь - СправочникСсылка.Пользователи - пользователь, для которого устанавливается отбор; +// * НомерОбластиДанных - Число, Неопределено - номер области данных. +// Надо заполнять только при вызове в модели сервиса из неразделенного сеанса. +// +// Возвращаемое значение: +// ТаблицаЗначений - таблица значений с колонками: +// * КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей - Категория; +// * ЗначениеКатегорииНовостей - Характеристика.КатегорииНовостей - Значение категории; +// * ДатаОбновления - Дата - дата и время обновления записи (в формате нулевого меридиана); +// * Пользователь - СправочникСсылка.Пользователи - пользователь, для которого устанавливается отбор; +// * НомерОбластиДанных - Число, Неопределено - номер области данных; +// * УсловиеВыполнено - Булево - признак выполнения этого условия. +// +Функция ЗначенияОтборов_Пользовательские(ДанныеОтбора = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ЗначенияОтборов_Пользовательские(ДанныеОтбора); +``` +
+ +## ДобавитьПрограммноеЗначениеОтбора_Общий +
+ +Описание, пример вызова + +```bsl + +// Добавляет значения отбора (общего). +// На основании этих данных потом будет рассчитываться видимость новостей. +// Не забыть добавить коды категорий в ОбработкаНовостейПереопределяемый.ЗаполнитьКодыКатегорийДляАвтоматическогоРасчетаОтборовНовостей; +// При попытке записать данные в модели сервиса в разделенном режиме будет ошибка. +// Можно последовательно добавить много значений отборов, а потом вызвать "ОбработкаНовостей.ПриИзмененииЗначенийОтборовОбщих". +// +// Параметры: +// ЗначенияОтборов - ТаблицаЗначений - описание см. ЗначенияОтборов_Общие(). +// +Процедура ДобавитьПрограммноеЗначениеОтбора_Общий(ЗначенияОтборов) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ДобавитьПрограммноеЗначениеОтбора_Общий(ЗначенияОтборов) +``` +
+ +## ДобавитьПрограммноеЗначениеОтбора_ДляОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Добавляет значения отбора (для области данных). +// На основании этих данных потом будет рассчитываться видимость новостей. +// Не забыть добавить коды категорий в ОбработкаНовостейПереопределяемый.ЗаполнитьКодыКатегорийДляАвтоматическогоРасчетаОтборовНовостей; +// При записи данных в модели сервиса в неразделенном режиме необходимо заполнять "НомерОбласти" в ЗначенияОтборов. +// Можно последовательно добавить много значений отборов, а потом вызвать "ОбработкаНовостей.ПриИзмененииЗначенийОтборовДляОбластиДанных". +// +// Параметры: +// ЗначенияОтборов - ТаблицаЗначений - описание см. ЗначенияОтборов_ДляОбластиДанных(). +// +Процедура ДобавитьПрограммноеЗначениеОтбора_ДляОбластиДанных(ЗначенияОтборов) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ДобавитьПрограммноеЗначениеОтбора_ДляОбластиДанных(ЗначенияОтборов) +``` +
+ +## ДобавитьПрограммноеЗначениеОтбора_Пользовательский +
+ +Описание, пример вызова + +```bsl + +// Добавляет значения отбора (пользовательского). +// На основании этих данных потом будет рассчитываться видимость новостей. +// При записи данных в модели сервиса в неразделенном режиме необходимо заполнять "НомерОбласти" в ЗначенияОтборов. +// Можно последовательно добавить много значений отборов, а потом вызвать "ОбработкаНовостей.ПриИзмененииЗначенийОтборовПользовательских". +// +// Параметры: +// ЗначенияОтборов - ТаблицаЗначений - описание см. ЗначенияОтборов_Пользовательские(). +// +Процедура ДобавитьПрограммноеЗначениеОтбора_Пользовательский(ЗначенияОтборов) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ДобавитьПрограммноеЗначениеОтбора_Пользовательский(ЗначенияОтборов) +``` +
+ +## УдалитьПрограммноеЗначениеОтбора_Общий +
+ +Описание, пример вызова + +```bsl + +// Удаляет значения отбора (общего). +// На основании этих данных потом будет рассчитываться видимость новостей. +// Не забыть добавить коды категорий в ОбработкаНовостейПереопределяемый.ЗаполнитьКодыКатегорийДляАвтоматическогоРасчетаОтборовНовостей; +// При попытке записать данные в модели сервиса в разделенном режиме будет ошибка. +// Можно последовательно удалить много значений отборов, а потом вызвать "ОбработкаНовостей.ПриИзмененииЗначенийОтборовОбщих". +// +// Параметры: +// ЗначенияОтборов - ТаблицаЗначений - описание см. ЗначенияОтборов_Общие(). +// +Процедура УдалитьПрограммноеЗначениеОтбора_Общий(ЗначенияОтборов) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.УдалитьПрограммноеЗначениеОтбора_Общий(ЗначенияОтборов) +``` +
+ +## УдалитьПрограммноеЗначениеОтбора_ДляОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Удаляет значения отбора (для области данных). +// На основании этих данных потом будет рассчитываться видимость новостей. +// Не забыть добавить коды категорий в ОбработкаНовостейПереопределяемый.ЗаполнитьКодыКатегорийДляАвтоматическогоРасчетаОтборовНовостей; +// При записи данных в модели сервиса в неразделенном режиме необходимо заполнять "НомерОбласти" в ЗначенияОтборов. +// Можно последовательно удалить много значений отборов, а потом вызвать "ОбработкаНовостей.ПриИзмененииЗначенийОтборовДляОбластиДанных". +// +// Параметры: +// ЗначенияОтборов - ТаблицаЗначений - описание см. ЗначенияОтборов_ДляОбластиДанных(). +// +Процедура УдалитьПрограммноеЗначениеОтбора_ДляОбластиДанных(ЗначенияОтборов) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.УдалитьПрограммноеЗначениеОтбора_ДляОбластиДанных(ЗначенияОтборов) +``` +
+ +## УдалитьПрограммноеЗначениеОтбора_Пользовательский +
+ +Описание, пример вызова + +```bsl + +// Удаляет значения отбора (пользовательского). +// На основании этих данных потом будет рассчитываться видимость новостей. +// При записи данных в модели сервиса в неразделенном режиме необходимо заполнять "НомерОбласти" в ЗначенияОтборов. +// Можно последовательно удалить много значений отборов, а потом вызвать "ОбработкаНовостей.ПриИзмененииЗначенийОтборовПользовательских". +// +// Параметры: +// ЗначенияОтборов - ТаблицаЗначений - описание см. ЗначенияОтборов_Пользовательские(). +// +Процедура УдалитьПрограммноеЗначениеОтбора_Пользовательский(ЗначенияОтборов) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.УдалитьПрограммноеЗначениеОтбора_Пользовательский(ЗначенияОтборов) +``` +
+ +## ПолучитьПрограммноеЗначениеОтбора_Общий +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущие значения категорий (общие) для отборов новостей. +// +// Параметры: +// КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей, Строка, Неопределено - Категория для отбора или ее код. +// +// Возвращаемое значение: +// ТаблицаЗначений - см. ЗначенияОтборов_Общие(). +// +Функция ПолучитьПрограммноеЗначениеОтбора_Общий( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьПрограммноеЗначениеОтбора_Общий(); +``` +
+ +## ПолучитьПрограммноеЗначениеОтбора_ДляОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущие значения категорий (для области данных) для отборов новостей. +// +// Параметры: +// КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей, Строка, Неопределено - Категория для отбора или ее код; +// НомерОбластиДанных - Число, Неопределено - номер области данных; +// +// Возвращаемое значение: +// ТаблицаЗначений - см. ЗначенияОтборов_ДляОбластиДанных(). +// +Функция ПолучитьПрограммноеЗначениеОтбора_ДляОбластиДанных( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьПрограммноеЗначениеОтбора_ДляОбластиДанных(); +``` +
+ +## ПолучитьПрограммноеЗначениеОтбора_Пользовательский +
+ +Описание, пример вызова + +```bsl + +// Возвращает текущие значения категорий (пользовательские) для отборов новостей. +// +// Параметры: +// КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей, Строка, Неопределено - Категория для отбора или ее код; +// Пользователь - СправочникСсылка.Пользователи - пользователь; +// НомерОбластиДанных - Число, Неопределено - номер области данных; +// +// Возвращаемое значение: +// ТаблицаЗначений - см. ЗначенияОтборов_Пользовательские(). +// +Функция ПолучитьПрограммноеЗначениеОтбора_Пользовательский( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьПрограммноеЗначениеОтбора_Пользовательский(); +``` +
+ +## ПриПереходеСДругойПрограммы +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик перехода с другой программы, например с БухгалтерияБазовая на БухгалтерияПРОФ. +// В случае перехода с другой программы надо будет загрузить новости по новой программе (БухгалтерияПРОФ) за 1 месяц, +// для этого необходимо отредактировать данные регистра сведений ДатыЗагрузкиПоследнихНовостей. +// Должна вызываться или вручную, или с помощью функциональности БСП (см. ПриДобавленииОбработчиковПереходаСДругойПрограммы(Обработчики)). +// +Процедура ПриПереходеСДругойПрограммы() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПриПереходеСДругойПрограммы() +``` +
+ +## КонтекстныеНовости_ПриСозданииНаСервере +
+ +Описание, пример вызова + +```bsl + +// Процедура выполняет все необходимые действия для управления контекстными новостями. +// Должна вызываться из ПриСозданииНаСервере(). +// Она используется в том случае, если выбрана стратегия расчета списка контекстных новостей в ПриСозданииНаСервере. +// +// Параметры: +// Форма - ФормаКлиентскогоПриложения - форма, в которой необходимо включить +// механизм контекстных новостей; +// ИдентификаторМетаданных - Строка - Идентификатор метаданных, должен совпадать с таким же +// идентификатором в самой новости; +// ИдентификаторФормы - Строка - Идентификатор формы, должен совпадать с таким же +// идентификатором в самой новости; +// НастройкиОтображенияНовостей - Структура, Неопределено - структура настроек для создания +// кнопки / подменю / панели новостей +// или Неопределено, если кнопку / подменю / панель создавать не надо. Ключи: +// * ЭлементФормыДляРазмещенияКомандыНовостей - ЭлементФормы - Группа формы, в которой необходимо разместить +// создаваемую кнопку / подменю / панели новостей; +// * ТипЗначенияКомандыНовостей - Тип, Неопределено - может быть Тип("КнопкаФормы") +// (для создания кнопки Новости) +// или Тип("ГруппаФормы") для создания подменю новостей, +// или Неопределено, если не надо создавать кнопку / подменю. +// По-умолчанию берется Тип("ГруппаФормы") для создания подменю новостей. +// * СпособОтображенияПанелиКонтекстныхНовостей - Строка, Неопределено - "СписокНовостей", "Листание", "Автолистание", "Скрыть". +// ЗаголовокФормыКонтекстныхНовостей - Строка - заголовок формы, которая появляется при нажатии на кнопку +// показа списка контекстных новостей из формы; +// СоздаватьРеквизитФормы - Булево - Истина, если надо динамически создать реквизит +// "Новости" произвольного типа; +// НастройкиЗаполненияНовостями - Структура - структура, определяющая стратегию получения +// и хранения новостей; +// Можно получать новости на сервере в ПриСозданииНаСервере - это будет +// тратить время при каждом открытии формы, но позволит реализовать +// сценарий показа новостей при наступлении клиентских +// событий (ПриИзмененииГалочки, ПриУстановкеДатыБольше2014 и т.п.); +// Можно получать новости в обработчике ожидания после открытия формы, +// также будет задействован клиентский кэш. Это сократит время открытия +// формы, но некоторые сценарии станут недоступны. +// Ключи: +// * ПолучатьНовостиНаСервере - Булево - если Истина, то новости будут получаться в этой процедуре. +// По-умолчанию = Истина; +// * ХранитьМассивНовостейТолькоНаСервере - Булево - если Истина, то на клиента не передается массив новостей. +// Это сокращает размер передаваемых данных, но не дает возможность +// показывать новости по другим событиям, отличным от ПриОткрытии. +// Имеет смысл только если ПолучатьНовостиНаСервере = Истина. +// По-умолчанию = Ложь. +// * ПолучатьКатегорииНовостей - Булево - если Истина, то в реквизите формы будут также +// сохраняться категории новостей. +// Это может быть полезно для реализации особенного отбора новостей, +// который невозможно реализовать с помощью +// регистров сведений ОтборыПоЛентамНовостей*; +// ИдентификаторыСобытийПриОткрытии - Строка, Массив из Строка - строка или массив строк идентификаторов +// события "ПриОткрытии". Если передано какое-то значение, +// то будет подсчитано количество очень важных контекстных +// новостей. И если это количество > 0, то открывающая форма инициирует +// открытие формы просмотра таких новостей. +// +Процедура КонтекстныеНовости_ПриСозданииНаСервере( Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.КонтекстныеНовости_ПриСозданииНаСервере(); +``` +
+ +## УстановитьНастройкиПоказаНовостей +
+ +Описание, пример вызова + +```bsl + +// Установка настроек чтения новостей. +// Работает только в коробке или в неразделенном сеансе в модели сервиса. +// +// Параметры: +// Настройки - Структура - структура настроек. Список ключей см. в ХранилищеНастроек.НастройкиНовостей.ПровестиВалидациюНастроек +// для НастройкиПоказаНовостейНастроенныеАдминистратором. +// +Процедура УстановитьНастройкиПоказаНовостей(Настройки) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.УстановитьНастройкиПоказаНовостей(Настройки) +``` +
+ +## ПолучитьЛентуНовостейПоКоду +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает ссылку на ленту новостей по ее коду. +// +// Параметры: +// ЛентаНовостейКод - Строка - код ленты новостей. +// +// Возвращаемое значение: +// СправочникСсылка.ЛентыНовостей - ссылка на ленту новостей или пустая ссылка, если нет ленты новостей с таким кодом. +// +Функция ПолучитьЛентуНовостейПоКоду(ЛентаНовостейКод) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьЛентуНовостейПоКоду(ЛентаНовостейКод) +``` +
+ +## ПолучитьОтключенныеЛентыНовостей +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив отключенных лент новостей. +// Вынесено из Хранилища настроек.НастройкиНовостей, т.к. выполняется очень часто для контекстных новостей. +// При изменении настроек лент новостей необходимо сбросить кэш с помощью ОбновитьПовторноИспользуемыеЗначения(). +// +// Параметры: +// ИмяПользователяИБ - Строка - Имя пользователя, для которого необходимо рассчитать данные. +// +// Возвращаемое значение: +// Массив из СправочникСсылка.ЛентыНовостей - Массив отключенных лент новостей. +// +Функция ПолучитьОтключенныеЛентыНовостей(ИмяПользователяИБ) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьОтключенныеЛентыНовостей(ИмяПользователяИБ) +``` +
+ +## ПолучитьЛентыНовостейПодпискаВключена +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив лент новостей, на которые пользователь "подписан" любым способом - самостоятельно или принудительно. +// При изменении настроек лент новостей необходимо сбросить кэш с помощью ОбновитьПовторноИспользуемыеЗначения(). +// +// Параметры: +// ИмяПользователяИБ - Строка - Имя пользователя, для которого необходимо рассчитать данные. +// +// Возвращаемое значение: +// Массив из СправочникСсылка.ЛентыНовостей - Массив лент новостей, на которые пользователь +// или подписан самостоятельно или подписан принудительно. +// +Функция ПолучитьЛентыНовостейПодпискаВключена(ИмяПользователяИБ) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьЛентыНовостейПодпискаВключена(ИмяПользователяИБ) +``` +
+ +## ПолучитьЛентыНовостейПодпискаВключенаПользователем +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив лент новостей, на которые пользователь "подписан" самостоятельно (но НЕ принудительно). +// При изменении настроек лент новостей необходимо сбросить кэш с помощью ОбновитьПовторноИспользуемыеЗначения(). +// +// Параметры: +// ИмяПользователяИБ - Строка - Имя пользователя, для которого необходимо рассчитать данные. +// +// Возвращаемое значение: +// Массив из СправочникСсылка.ЛентыНовостей - Массив лент новостей, на которые пользователь +// подписан самостоятельно (но НЕ принудительно). +// +Функция ПолучитьЛентыНовостейПодпискаВключенаПользователем(ИмяПользователяИБ) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьЛентыНовостейПодпискаВключенаПользователем(ИмяПользователяИБ) +``` +
+ +## ПолучитьЛентыНовостейПодпискаОтключенаПользователем +
+ +Описание, пример вызова + +```bsl + +// Возвращает массив лент новостей, на которые пользователь может "подписаться", а сейчас отписан. +// При изменении настроек лент новостей необходимо сбросить кэш с помощью ОбновитьПовторноИспользуемыеЗначения(). +// +// Параметры: +// ИмяПользователяИБ - Строка - Имя пользователя, для которого необходимо рассчитать данные. +// +// Возвращаемое значение: +// Массив из СправочникСсылка.ЛентыНовостей - Массив лент новостей, на которые пользователь +// может "подписаться", а сейчас отписан. +// +Функция ПолучитьЛентыНовостейПодпискаОтключенаПользователем(ИмяПользователяИБ) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьЛентыНовостейПодпискаОтключенаПользователем(ИмяПользователяИБ) +``` +
+ +## ПолучитьНастройкиЛентНовостей +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки подписки и оповещений лент новостей. +// При изменении настроек лент новостей необходимо сбросить кэш с помощью ОбновитьПовторноИспользуемыеЗначения(). +// +// Параметры: +// Пользователь - Строка, СправочникСсылка.Пользователи - Имя пользователя, для которого необходимо рассчитать данные +// или ссылка на пользователя; +// ЛентаНовостей - СправочникСсылка.ЛентыНовостей, Неопределено - для какой ленты новостей получать настройки, +// или для всех (если Неопределено). +// +// Возвращаемое значение: +// Массив - Массив структур с ключами: +// * КодЛентыНовостей - Строка - код ленты новостей; +// * ЛентаНовостей - СправочникСсылка.ЛентыНовостей; +// * ОбязательныйКанал - Булево; +// * ПодпискаПринудительно - Строка - возможные значения "Подписан", "Отписан", "Неопределено"; +// * ПодпискаСамостоятельно - Строка - возможные значения "Подписан", "Отписан"; +// * СпособОповещения - ПеречислениеСсылка.СпособыОповещенияПользователяОНовостях. +// +Функция ПолучитьНастройкиЛентНовостей(Пользователь, ЛентаНовостей = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьНастройкиЛентНовостей(Пользователь, ЛентаНовостей); +``` +
+ +## ПолучитьНастройкиОповещенияЛентыНовостей +
+ +Описание, пример вызова + +```bsl + +// Возвращает настройки оповещения ленты новостей. +// При изменении настроек лент новостей необходимо сбросить кэш с помощью ОбновитьПовторноИспользуемыеЗначения(). +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи - Пользователь, для которого необходимо получить способ оповещения; +// ЛентаНовостей - СправочникСсылка.ЛентыНовостей - для какой ленты новостей получать способ оповещения. +// +// Возвращаемое значение: +// Структура - структура с ключами: +// * КодЛентыНовостей - Строка - код ленты новостей; +// * ЛентаНовостей - СправочникСсылка.ЛентыНовостей; +// * СпособОповещения - ПеречислениеСсылка.СпособыОповещенияПользователяОНовостях. +// +Функция ПолучитьНастройкиОповещенияЛентыНовостей(Пользователь, ЛентаНовостей) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьНастройкиОповещенияЛентыНовостей(Пользователь, ЛентаНовостей) +``` +
+ +## РазрешенаРаботаСНовостями +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает результат - можно ли работать с новостями. +// Это результат функциональной опции "РазрешенаРаботаСНовостями" +// И доступны нужные роли +// И это не внешний пользователь. +// +// Возвращаемое значение: +// Булево - ИСТИНА, если есть возможность работы с новостями. +// +Функция РазрешенаРаботаСНовостями() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.РазрешенаРаботаСНовостями() +``` +
+ +## РазрешенаРаботаСНовостямиТекущемуПользователю +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает результат - можно ли работать с новостями текущему пользователю. +// Это результат функциональной опции "РазрешенаРаботаСНовостями" +// И доступны нужные роли +// И это не внешний пользователь +// И задан параметр сеанса ТекущийПользователь (т.е. мы не зашли в базу с отключенным списком пользователей). +// Если сеанс запущен без разделителей (пользователь АдминистраторСистемы зашел в область данных), +// то для него разрешить работу с новостями. +// +// Возвращаемое значение: +// Булево - ИСТИНА, если есть возможность работы с новостями текущему пользователю. +// +Функция РазрешенаРаботаСНовостямиТекущемуПользователю() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.РазрешенаРаботаСНовостямиТекущемуПользователю() +``` +
+ +## РазрешенаРаботаСНовостямиЧерезИнтернет +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает результат - можно ли работать с новостями через интернет. +// Это результат функциональной опции "РазрешенаРаботаСНовостямиЧерезИнтернет" +// И доступны нужные роли +// И это не внешний пользователь. +// +// Возвращаемое значение: +// Булево - ИСТИНА, если разрешена работа с новостями через интернет, ЛОЖЬ, если можно работать только с локальными новостями. +// +Функция РазрешенаРаботаСНовостямиЧерезИнтернет() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.РазрешенаРаботаСНовостямиЧерезИнтернет() +``` +
+ +## НайтиНовости +
+ +Описание, пример вызова + +```bsl + +// Выполняет полнотекстовый поиск по новостям. Возможна передача дополнительных параметров (период поиска и т.п.). +// +// Параметры: +// СтруктураПараметровПоиска - Структура с ключами: +// * СтрокПоиска - Строка; +// * ПоискДатаОТ - Дата; +// * ПоискДатаДО - Дата; +// * НовостиОбластьПоиска - Неопределено, Массив из СправочникСсылка.Новости - массив ссылок на новости, в которых надо искать; +// Если не заполнено, то поиск будет во всех новостях. Если передан массив ссылок на новости, +// то поиск будет осуществляться только в этих новостях. +// Имеет смысл заполнять для форм контекстных новостей, когда поиск осуществляется только среди уже отобранных новостей. +// +// Возвращаемое значение: +// Массив из СправочникСсылка.Новости. +// +Функция НайтиНовости(СтруктураПараметровПоиска) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.НайтиНовости(СтруктураПараметровПоиска) +``` +
+ +## ПолучитьОбъектНовости +
+ +Описание, пример вызова + +```bsl + +// Добавление новости или получение объекта новости по уникальному идентификатору. +// +// Параметры: +// ЛентаНовостей - СправочникСсылка.ЛентыНовостей; +// УИННовости - Строка - уникальный идентификатор новостей; +// ДатаПубликации - Дата - дата публикации; +// ОчищатьТабличныеЧасти - Булево - очищать табличные части. +// Как правило объект "Новости" получается для его перезаполнения. +// +// Возвращаемое значение: +// СправочникОбъект.Новости - объект новой или существующей новости. +// +Функция ПолучитьОбъектНовости( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьОбъектНовости(); +``` +
+ +## ПолучитьСсылкуНаНовость +
+ +Описание, пример вызова + +```bsl + +// Получение структуры новости по уникальному идентификатору и ленте новостей. +// +// Параметры: +// ЛентаНовостей - СправочникСсылка.ЛентыНовостей; +// УИННовости - Строка - уникальный идентификатор новостей. +// +// Возвращаемое значение: +// Структура с ключами: +// * Ссылка - СправочникСсылка.Новости; +// * УИН_ИБ - Строка - Уникальный идентификатор ссылки на новость в ИБ; +// * ДатаПубликации - Дата; +// * ПометкаУдаления - Булево. +// +Функция ПолучитьСсылкуНаНовость(ЛентаНовостей, УИННовости) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьСсылкуНаНовость(ЛентаНовостей, УИННовости) +``` +
+ +## ПолучитьКонтекстныеНовости +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает таблицу новостей для определенного объекта метаданных, имени формы и события. +// Настроенные пользователем отборы НЕ накладываются. +// При вызове из неразделенного сеанса в модели сервиса будет ошибка. +// +// Параметры: +// СписокЛентНовостей - СписокЗначений, Массив, Неопределено - в каких лентах новостей искать новость; +// ИмяМетаданных - Строка - имя метаданных, обязательная часть идентификатора новости; +// ИмяФормы - Строка, Неопределено - имя формы, необязательная часть идентификатора новости; +// ИмяСобытия - Строка, Неопределено - имя события, необязательная часть идентификатора новости; +// Вариант - Строка: +// * если = "Для форм, все поля", то выводить подробную таблицу, с событиями и именами форм - в этом случае новости +// будут встречаться по два раза. Этот вариант нужен для заполнения реквизита Новости справочников +// и документов (чтобы при возникновении события можно было показать новость). +// * если = "Для форм, простой", то выводить таблицу с именами форм, но без событий +// (удобно для получения уникального списка новостей). +// * если = "Для формы контекстных новостей", то выводить сжатую таблицу с уникальностью по новостям. +// Этот вариант нужен для формы контекстных новостей; +// НастройкиПолученияНовостей - Структура, Неопределено - структура с ключами: +// * ПолучатьКатегорииНовостей - Булево - если Истина, то в реквизите формы будут также сохраняться +// категории новостей. Это может быть полезно для реализации особенного +// отбора новостей, который невозможно реализовать +// с помощью регистров сведений ОтборыПоЛентамНовостей*. +// +// Возвращаемое значение: +// Таблица значений с колонками: +// * НомерСтрокиНовости - Число - для реализации нажатия в подменю формы; +// * ЛентаНовостей - СправочникСсылка.ЛентаНовостей; +// * Новость - СправочникСсылка.Новости; +// * НовостьНаименование - Строка (100) - заголовок новости; +// * НовостьПодзаголовок - Строка (100) - подзаголовок новости; +// * НовостьКодЛентыНовостей - Строка (20) - код ленты новостей; +// * УИННовости - Строка (255) -; +// * ДатаПубликации - Дата; +// * Важность - Число (1,0) - рассчитанная на текущую дату контекстная важность +// (с учетом даты сброса контекстной важности); +// * Актуальность - Булево - рассчитанная на текущую дату актуальность (с учетом даты завершения новости); +// * Метаданные - Строка (50); +// * Форма - Строка (50); +// * Событие - Строка (50) // Для варианта "Для форм, простой" - пустая строка; +// * ПоказыватьВФормеОбъекта - Булево // Для варианта "Для форм, простой" - всегда ЛОЖЬ; +// * ЭтоПостояннаяНовость - Булево // Для варианта "Для форм, простой" - всегда ЛОЖЬ; +// * Прочтена - Булево; +// * ОповещениеВключено - Булево // Ложь, если ДатаНачалаОповещения > ТекущаяУниверсальнаяДата(); +// * ДатаНачалаОповещения - Дата // Для варианта "Для форм, простой" - всегда пустая дата (01.01.0001); +// * ИконкаНовости - Картинка, Неопределено - иконка важной новости; +// * СпособОповещения - Строка - имя перечисления СпособыОповещенияПользователяОНовостях. +// +Функция ПолучитьКонтекстныеНовости( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьКонтекстныеНовости(); +``` +
+ +## НайтиКонтекстнуюНовостьВМассиве +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает структуру новости из массива структур контекстных новостей. +// Массив структур готовится с помощью ОбщегоНазначения.ТаблицаЗначенийВМассив(ПолучитьКонтекстныеНовости(...)). +// +// Параметры: +// АдресМассиваНовостей - Строка - Адрес временного хранилища; +// НомерСтрокиНовости - Число - идентификатор новости, которую необходимо найти по значению ключа НомерСтрокиНовости. +// +// Возвращаемое значение: +// Структура - структура с ключами: +// * НомерСтрокиНовости - Число - для реализации нажатия в подменю формы; +// * ЛентаНовостей - СправочникСсылка.ЛентаНовостей; +// * Новость - СправочникСсылка.Новости; +// * НовостьНаименование - Строка (100) - заголовок новости; +// * НовостьПодзаголовок - Строка (100) - подзаголовок новости; +// * УИННовости - Строка (255) -; +// * ДатаПубликации - Дата; +// * Важность - Число (1,0) - рассчитанная на текущую дату контекстная важность +// (с учетом даты сброса контекстной важности); +// * Актуальность - Булево - рассчитанная на текущую дату актуальность (с учетом даты завершения новости); +// * Метаданные - Строка (50); +// * Форма - Строка (50); +// * Событие - Строка (50) // Для варианта "Для форм, простой" - пустая строка; +// * ПоказыватьВФормеОбъекта - Булево // Для варианта "Для форм, простой" - всегда ЛОЖЬ; +// * ЭтоПостояннаяНовость - Булево // Для варианта "Для форм, простой" - всегда ЛОЖЬ; +// * Прочтена - Булево; +// * ОповещениеВключено - Булево; +// * ДатаНачалаОповещения - Дата // Для варианта "Для форм, простой" - всегда пустая дата (01.01.0001). +// +Функция НайтиКонтекстнуюНовостьВМассиве(АдресМассиваНовостей, НомерСтрокиНовости) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.НайтиКонтекстнуюНовостьВМассиве(АдресМассиваНовостей, НомерСтрокиНовости) +``` +
+ +## ВсеОбновленияНовостей +
+ +Описание, пример вызова + +```bsl + +// Процедура выполняет все обновления новостей: +// 1. Получение и обработка новостей с серверов новостных центров +// (ежеминутно, каждые 15 минут, каждый час, ежедневно); +// 2. Обновление классификаторов (ежедневно); +// 3. Автоудаление новостей (ежедневно); +// 4. Обновление периодических свойств (важность, актуальность) (каждые 30 минут); +// 5. Обновление привязок к метаданным (+ важность) (каждые 30 минут); +// 6. Проверка версии платформы (каждые 6 часов); +// +Процедура ВсеОбновленияНовостей() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ВсеОбновленияНовостей() +``` +
+ +## УдалитьНовости_Ежедневно +
+ +Описание, пример вызова + +```bsl + +// Процедура запускает удаление новостей (неактуальных и актуальных). +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура УдалитьНовости_Ежедневно(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.УдалитьНовости_Ежедневно(КонтекстВыполнения); +``` +
+ +## ОбновлениеПериодическихСвойствНовостей +
+ +Описание, пример вызова + +```bsl + +// Процедура запускает пересчет периодических свойств новостей (важность, актуальность). +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ОбновлениеПериодическихСвойствНовостей(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеПериодическихСвойствНовостей(КонтекстВыполнения); +``` +
+ +## ОбновлениеПривязокКМетаданным +
+ +Описание, пример вызова + +```bsl + +// Процедура запускает пересчет привязок к метаданным (+ контекстная важность). +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ОбновлениеПривязокКМетаданным(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеПривязокКМетаданным(КонтекстВыполнения); +``` +
+ +## ПолучитьИОбработатьНовостиПоЛентамНовостей +
+ +Описание, пример вызова + +```bsl + +// Процедура запускает получение файлов новостей и обновление новостей для лент новостей по списку лент новостей. +// Процедуры должны иметь похожий код: +// Справочник.Новости.ЗагрузитьСтандартныеЗначения(); +// ОбработкаНовостей.ПолучитьИОбработатьНовостиПоЛентамНовостей(). +// Если включено разделение данных, то запускать вручную можно только при отключенных разделителях. +// +// Параметры: +// МассивЛентНовостей - Массив - список лент новостей. Если пустой, то по всем лентам новостей; +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ПолучитьИОбработатьНовостиПоЛентамНовостей(МассивЛентНовостей, КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПолучитьИОбработатьНовостиПоЛентамНовостей(МассивЛентНовостей, КонтекстВыполнения); +``` +
+ +## ОбновитьСтандартныеСпискиДляНовостей_Ежедневно +
+ +Описание, пример вызова + +```bsl + +// Процедура запускает обновление стандартных списков для новостей с графиком получения "Ежедневно" +// Это списки лент новостей, категорий новостей, значений категорий новостей и т.п. +// +// Должно запускаться от имени пользователя с правами, достаточными для изменения этих данных. +// +// Если включено разделение данных, то запускать вручную можно только при отключенных разделителях. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ОбновитьСтандартныеСпискиДляНовостей_Ежедневно(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновитьСтандартныеСпискиДляНовостей_Ежедневно(КонтекстВыполнения); +``` +
+ +## ПересчитатьНеобработанныеКатегорииНовостей +
+ +Описание, пример вызова + +```bsl + +// В связи с раздельной загрузкой новостей и классификаторов (категорий и значений категорий) возможна ситуация, +// когда в новости указана категория или значение, которые еще не загружены в базу данных. +// Поэтому при загрузке новостей строковые представления категорий и значений вначале сохраняются +// в регистры сведений КатегорииНовостей*Необработанные, а затем переносятся +// в регистры сведений КатегорииНовостей* с помощью этой процедуры. +// Должно запускаться от имени пользователя с правами, достаточными для изменения этих данных. +// Если включено разделение данных, то запускать вручную можно только при отключенных разделителях. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ПересчитатьНеобработанныеКатегорииНовостей(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПересчитатьНеобработанныеКатегорииНовостей(КонтекстВыполнения); +``` +
+ +## ПересчитатьОтборыПоНовостям_РедкоМеняющиеся +
+ +Описание, пример вызова + +```bsl + +// Процедура обрабатывает регистр сведений "РассчитанныеОтборыПоНовостям_РедкоМеняющиеся". +// В этом регистре хранятся заранее рассчитанные результаты отборов по новостям по редко меняющимся категориям: +// - Версия платформы; +// - Версия конфигурации; +// - Продукт (включает в себя Имя+Версия, поэтому тоже меняется). +// Этот регистр имеет смысл пересчитывать после получения новостей, а также после обновления конфигурации и платформы. +// Для расчета будет браться информация из двух регистров - КатегорииНовостейПростые и КатегорииНовостейИнтервалыВерсий. +// +// Должно запускаться от имени пользователя с правами, достаточными для изменения этих данных. +// +// Если включено разделение данных, то запускать вручную можно только при отключенных разделителях. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ПересчитатьОтборыПоНовостям_РедкоМеняющиеся(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПересчитатьОтборыПоНовостям_РедкоМеняющиеся(КонтекстВыполнения); +``` +
+ +## ПересчитатьОтборыПоНовостям_Общие +
+ +Описание, пример вызова + +```bsl + +// Процедура обрабатывает регистр сведений "РассчитанныеОтборыПоНовостям_Общие". +// В этом регистре хранятся заранее рассчитанные результаты отборов по новостям по настроенным администратором отборам, +// за исключением отборов по категориям: +// - Версия платформы; +// - Версия конфигурации; +// - Продукт (включает в себя Имя+Версия, поэтому тоже меняется); +// которые рассчитываются и сохраняются в другом регистре. +// Этот регистр имеет смысл пересчитывать после получения новостей, а также после изменения +// отборов в справочнике ЛентыНовостей. +// Также работает в модели сервиса в неразделенном сеансе. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ПересчитатьОтборыПоНовостям_Общие(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПересчитатьОтборыПоНовостям_Общие(КонтекстВыполнения); +``` +
+ +## ПересчитатьОтборыПоНовостям_ДляОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Процедура обрабатывает регистр сведений "РассчитанныеОтборыПоНовостям_ДляОбластиДанных". +// В случае запуска из коробки или в разделенном сеансе, также автоматически рассчитывает +// значения автоматических отборов и заполняет регистр сведений ОтборыПоЛентамНовостейДляОбластиДанных. +// В случае запуска в неразделенном сеансе в модели сервиса просто пересчитывает отборы по новостям. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ПересчитатьОтборыПоНовостям_ДляОбластиДанных(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПересчитатьОтборыПоНовостям_ДляОбластиДанных(КонтекстВыполнения); +``` +
+ +## ПересчитатьОтборыПоНовостям_Пользовательские +
+ +Описание, пример вызова + +```bsl + +// Процедура обрабатывает регистр сведений "РассчитанныеОтборыПоНовостям_Пользовательские". +// В этом регистре хранятся заранее рассчитанные результаты отборов по новостям по настроенным пользователем отборам, +// за исключением отборов по категориям: +// - Версия платформы; +// - Версия конфигурации; +// - Продукт (включает в себя Имя+Версия, поэтому тоже меняется); +// которые рассчитываются и сохраняются в другом регистре. +// Этот регистр имеет смысл пересчитывать после получения новостей, после изменения отборов в справочнике +// ЛентыНовостей (по всем пользователям), а также после настройки пользовательских отборов (для текущего пользователя). +// +// Параметры: +// Пользователь - Неопределено, СправочникСсылка.Пользователи, Массив - пользователи, по которым необходимо +// пересчитать новости-исключения. Если Неопределено, то по всем; +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ПересчитатьОтборыПоНовостям_Пользовательские(Пользователь = Неопределено, КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПересчитатьОтборыПоНовостям_Пользовательские(Пользователь, КонтекстВыполнения); +``` +
+ +## ЗаполнитьЗначенияАвтоматическихОтборов_Общие +
+ +Описание, пример вызова + +```bsl + +// Процедура заполняет регистр сведений ОтборыПоЛентамНовостейОбщие автоматически рассчитываемыми значениями отборов, +// а также заранее сохраненными значениями из регистра сведений ЗначенияКатегорийОбщие. +// Аналогичное автозаполнение работает для "ЗначенияКатегорийОбщие", "ЗначенияКатегорийДляОбластиДанных", +// но отключено для "ЗначенияКатегорийПользовательские". +// Также работает в модели сервиса в неразделенном сеансе. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ЗаполнитьЗначенияАвтоматическихОтборов_Общие(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ЗаполнитьЗначенияАвтоматическихОтборов_Общие(КонтекстВыполнения); +``` +
+ +## ЗаполнитьЗначенияАвтоматическихОтборов_ДляОбластиДанных +
+ +Описание, пример вызова + +```bsl + +// Процедура заполняет регистр сведений ОтборыПоЛентамНовостейДляОбластиДанных автоматически рассчитываемыми значениями отборов, +// а также заранее сохраненными значениями из регистра сведений ЗначенияКатегорийДляОбластиДанных. +// Аналогичное автозаполнение работает для "ЗначенияКатегорийОбщие", "ЗначенияКатегорийДляОбластиДанных", +// но отключено для "ЗначенияКатегорийПользовательские". +// Может вызываться как в разделенном, так и в неразделенном режиме. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ЗаполнитьЗначенияАвтоматическихОтборов_ДляОбластиДанных(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ЗаполнитьЗначенияАвтоматическихОтборов_ДляОбластиДанных(КонтекстВыполнения); +``` +
+ +## РассчитатьОтборПоКатегории +
+ +Описание, пример вызова + +```bsl + +// Процедура рассчитывает значение отбора по категории и значению категории для дальнейшего определения, +// какие новости скрывать в зависимости от категории и значения категории новости. +// +// Параметры: +// КатегорияНовостей - ПланВидовХарактеристикСсылка.КатегорииНовостей - категория новостей; +// КодКатегорииНовостей - Строка - код категории новостей; +// ЗначениеКатегорииНовостей - Строка - значение категории новостей; +// РезультатРасчета - Булево - в эту переменную будет возвращено значение расчета по категории новостей; +// ОбластьДанных - Число, Неопределено - номер области данных или Неопределено для неразделенных значений +// или при работе в коробке; +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура РассчитатьОтборПоКатегории( Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.РассчитатьОтборПоКатегории(); +``` +
+ +## ПроверитьИзменениеВерсииПлатформы +
+ +Описание, пример вызова + +```bsl + +// Процедура проверяет, была ли изменена версия платформы с момента последнего запуска и запускает необходимые процедуры. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ПроверитьИзменениеВерсииПлатформы(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПроверитьИзменениеВерсииПлатформы(КонтекстВыполнения); +``` +
+ +## ОптимизироватьОтборыПоНовостям +
+ +Описание, пример вызова + +```bsl + +// Процедура удаляет из регистров сведений ОтборыПоЛентамНовостейОбщие, ОтборыПоЛентамНовостейДляОбластиДанных +// и ОтборыПоЛентамНовостейПользовательские категории значения категорий, которые некорректны. +// Некорректными записями этих регистров считаются: +// 1. записи с категориями, которых нет в табличной части "ДоступныеКатегорииНовостей" в ленте новостей; +// 2. общие отборы по области данных, по значениям категорий, по которым уже установлен общий отбор (неразделенный), +// а значения отбора по области данных не входят в подмножество общего отбора (неразделенного) +// (например, общий отбор (неразделенный): География = Москва, Хабаровск, +// а отбор по области данных установили География = Киев); +// 3. пользовательские отборы по категориям, по которым в ленте новостей установлен признак +// РазрешеноНастраиватьПользователям = Ложь, (за исключением записей, +// у которых реквизит УстановленоПрограммно = Истина); +// 4. пользовательские отборы, по значениям категорий, по которым уже установлен общий отбор +// (неразделенный или по области данных), а значения пользовательского отбора не входят +// в подмножество общего отбора (неразделенного или по области данных) (например, общий отбор: +// География = Москва, Хабаровск, а пользователь установил География = Киев); +// Такие ситуации возможны, если: +// а) со временем из какой-то ленты новостей удалили категории; +// б) администратор со временем отключил пользователям возможность настраивать какие-то категории +// (но программно может задавать им отборы); +// в) администратор со временем изменил общие неразделенные отборы; +// г) администратор со временем изменил общие отборы по области данных. +// Процедура должна вызываться после получения новостей, но перед пересчетом отборов (ПересчитатьОтборыПоНовостям_*). +// При работе в локальном режиме может запускаться без ограничений. +// При работе в модели сервиса: +// - если запущена из неразделенного сеанса (регламентным заданием), то пересчитает и общие, +// и общие для области данных, и пользовательские отборы; +// - если запущена из разделенного сеанса (обработчик обновления каждой области данных), +// то пересчитает только общие для области данных и пользовательские отборы. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ОптимизироватьОтборыПоНовостям(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОптимизироватьОтборыПоНовостям(КонтекстВыполнения); +``` +
+ +## КоличествоНастроенныхОтборов +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает структуру с количеством настроенных пользовательских, административных (общих) +// и общих для области данных отборов. +// Если пользовательские отборы не заданы, то необходимо проверять только административные отборы. +// Если административные (общие) отборы не заданы, то можно показывать все новости. +// Это позволит оптимизировать быстродействие запросы выборки новостей (не накладывая лишних условий). +// В количество отборов не попадают отборы по Продукту, Версии Продукта и Версии платформы, +// т.к. по ним есть отдельный регистр сведений. +// При вызове из неразделенного сеанса в модели сервиса КоличествоПользовательскихОтборов будет пустым. +// ////! Значения КоличествоОбщихОтборов, КоличествоДляОбластиДанныхОтборов пока не используются. +// +// Параметры: +// Пользователь - СправочникСсылка.Пользователи - (необязательное) Пользователь, +// по которому необходимо проверить пользовательский отбор. +// Если не задано, то текущий пользователь. +// +// Возвращаемое значение: +// Структура - Структура с ключами "КоличествоОбщихОтборов", "КоличествоДляОбластиДанныхОтборов", +// "КоличествоПользовательскихОтборов". +// +Функция КоличествоНастроенныхОтборов(Пользователь = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.КоличествоНастроенныхОтборов(Пользователь); +``` +
+ +## СбросСостоянияНовостиДляВсехПользователей +
+ +Описание, пример вызова + +```bsl + +// Процедура сбрасывает все настройки всех пользователей при повторном получении (перепубликации) новости. +// В случае работы в неразделенном режиме - для всех пользователей. +// В случае работы в разделенном режиме - для всех пользователей всех областей данных. +// +// Параметры: +// НовостьСсылка - СправочникСсылка.Новости - Ссылка на новость. +// +Процедура СбросСостоянияНовостиДляВсехПользователей(НовостьСсылка) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.СбросСостоянияНовостиДляВсехПользователей(НовостьСсылка) +``` +
+ +## НайтиИОбработатьНеактивныеЛентыНовостей +
+ +Описание, пример вызова + +```bsl + +// Процедура анализирует регистр сведений ДатыЗагрузкиПоследнихНовостей, и если по ленте новостей были проблемы +// с получением новостей, то в этой ленте новостей будет создана специальная новость с предложением +// отключить ленту новостей из автоматического обновления, чтобы не генерировать ненужный трафик или не заставлять +// сервер зависать при обращении на несуществующий адрес. +// Новость о ошибке имеет фиксированный УИН - 6588f3f9-d569-478f-a370-7cd75d833966. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура НайтиИОбработатьНеактивныеЛентыНовостей(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.НайтиИОбработатьНеактивныеЛентыНовостей(КонтекстВыполнения); +``` +
+ +## ПередЗаписьюПользователя +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события перед записью элемента справочника Пользователи. +// Определяет разные параметры: +// - что записывается новый пользователь; +// - реквизиты пользователя ДО записи (Недействителен, Служебный, Подготовлен, ИдентификаторПользователяИБ, ИдентификаторПользователяСервиса); +// и передает эту информацию дальше, в подписку на событие "ПриЗаписи". +// +// Параметры: +// ПользовательОбъект - СправочникОбъект.Пользователи - записываемый объект; +// Отказ - Булево - установить в Истина, если надо отменить запись. +// +Процедура ПередЗаписьюПользователя(ПользовательОбъект, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПередЗаписьюПользователя(ПользовательОбъект, Отказ) +``` +
+ +## ПриЗаписиПользователя +
+ +Описание, пример вызова + +```bsl + +// Процедура-обработчик события при записи элемента справочника Пользователи. +// +// Параметры: +// ПользовательОбъект - СправочникОбъект.Пользователи - записываемый объект; +// Отказ - Булево - установить в Истина, если надо отменить запись. +// +Процедура ПриЗаписиПользователя(ПользовательОбъект, Отказ) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПриЗаписиПользователя(ПользовательОбъект, Отказ) +``` +
+ +## ИзменитьИспользованиеРегламентныхЗаданий +
+ +Описание, пример вызова + +```bsl + +// Процедура включает / отключает регламентное задание. +// +// Параметры: +// Использовать - Булево - Ложь - отключить использование регламентного задания, Истина - включить, иначе - без изменений. +// +Процедура ИзменитьИспользованиеРегламентныхЗаданий(Использовать) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ИзменитьИспользованиеРегламентныхЗаданий(Использовать) +``` +
+ +## ПолучитьРасписаниеОбновленийНовостей +
+ +Описание, пример вызова + +```bsl + +// Необходимо предусмотреть такой интервал запуска регламентного задания, +// чтобы это не сильно влияло на производительность системы. +// Поэтому вместо фиксированного запуска 1 раз в 5 минут предусмотреть варианты: +// - 1 раз в 5 минут, если есть активные ленты новостей с такой частотой обновления; +// - 1 раз в 15 минут, если есть активные ленты новостей с такой частотой обновления; +// - иначе 1 раз в час. +// При запуске реже, чем 1 раз в 5 минут мы понимаем, что обновление вспомогательных данных будет проходить реже, +// зато в целом система будет работать быстрее. +// +// Параметры: +// АвтоопределениеЧастотыЗапуска - Булево - Истина, если необходимо проанализировать частоту запуска существующих лент новостей. +// +// Возвращаемое значение: +// РасписаниеРегламентногоЗадания - расписание запуска регламентного задания "ВсеОбновленияНовостей". +// +Функция ПолучитьРасписаниеОбновленийНовостей(АвтоопределениеЧастотыЗапуска = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьРасписаниеОбновленийНовостей(АвтоопределениеЧастотыЗапуска); +``` +
+ +## ПолучитьРегламентноеЗаданиеВсеОбновленияНовостей +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает регламентное задание ВсеОбновленияНовостей, сохраненное в информационной базе. +// +// Параметры: +// ИсточникВызова - Строка - произвольная строка для сохранения ошибок в журнале регистрации. +// +// Возвращаемое значение: +// РегламентноеЗадание - регламентное задание "ВсеОбновленияНовостей", сохраненное в информационной базе. +// +Функция ПолучитьРегламентноеЗаданиеВсеОбновленияНовостей(ИсточникВызова) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьРегламентноеЗаданиеВсеОбновленияНовостей(ИсточникВызова)); +``` +
+ +## СбросУНовостейПризнакаТребуетсяПересчетОтборов +
+ +Описание, пример вызова + +```bsl + +// Процедура очищает у новостей признак "ТребуетсяПересчетОтборов" в регистре сведений "СвойстваНовостей". +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура СбросУНовостейПризнакаТребуетсяПересчетОтборов(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.СбросУНовостейПризнакаТребуетсяПересчетОтборов(КонтекстВыполнения); +``` +
+ +## УдалениеНовостей_ПолучитьСписокДанныхДляУдаления +
+ +Описание, пример вызова + +```bsl + +// Функция подготавливает список данных для удаления. +// +// Параметры: +// ТекущаяДатаДляРасчетов - Дата - текущая дата, относительно которой необходимо рассчитывать интервал удаляемых данных; +// Отборы - Структура - отборы удаляемых данных. Структура с ключами: +// * Актуальные - если ИСТИНА, то удалять актуальные новости; +// * Неактуальные - если ИСТИНА, то удалять НЕактуальные новости; +// * ПомеченныеНаУдаление - если ИСТИНА, то удалять помеченные на удаление новости; +// * СтараяВерсия - если ИСТИНА, то удалять новости для старых версий платформы или конфигурации. +// +// Возвращаемое значение: +// Структура - Структура удаляемых данных с ключами: +// * НовостиДляУдаления - Массив ссылок на удаляемые новости; +// * НовостиДляУстановкиПометкиУдаления - Массив ссылок на новости, которые будут помечены на удаление; +// * КатегорииНовостейПростыеНеобработанные - массив структур с измерениями регистра сведений КатегорииНовостейПростыеНеобработанные: +// ** КатегорияНовостейСтрока; +// ** ЗначениеКатегорииНовостейСтрока; +// ** ЛентаНовостей; +// ** УИННовости. +// * КатегорииНовостейИнтервалыВерсийНеобработанные - массив структур с измерениями регистра сведений КатегорииНовостейИнтервалыВерсийНеобработанные: +// ** КатегорияНовостейСтрока; +// ** ЛентаНовостей; +// ** УИННовости; +// ** Продукт; +// ** ВерсияОТ; +// ** ВерсияДО. +// +Функция УдалениеНовостей_ПолучитьСписокДанныхДляУдаления(ТекущаяДатаДляРасчетов, Отборы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.УдалениеНовостей_ПолучитьСписокДанныхДляУдаления(ТекущаяДатаДляРасчетов, Отборы)); +``` +
+ +## УдалениеНовостей_ПометитьНаУдалениеДанные +
+ +Описание, пример вызова + +```bsl + +// Процедура помечает на удаление новости со вспомогательными данными по переданному списку данных. +// +// Параметры: +// ДанныеДляУдаления - Структура - соответствует возвращаемому значению функции УдалениеНовостей_ПолучитьСписокДанныхДляУдаления; +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура УдалениеНовостей_ПометитьНаУдалениеДанные(ДанныеДляУдаления, КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.УдалениеНовостей_ПометитьНаУдалениеДанные(ДанныеДляУдаления, КонтекстВыполнения); +``` +
+ +## ЗагрузитьВсеСтандартныеЗначения +
+ +Описание, пример вызова + +```bsl + +// Процедура загружает все стандартные значения необходимые для подсистемы новостей из макетов с именем "СтандартныеЗначения". +// Имеет смысл заполнять значения из макета: +// - при обновлении конфигурации (когда подключение к интернету может занять много времени); +// - при первоначальном заполнении пустой базы, когда не заполнены параметры, логины и пароли для доступа к веб-сервисам обновлений. +// +// Параметры: +// КонтекстВыполнения - Структура, Неопределено - структура контекста выполнения. +// +Процедура ЗагрузитьВсеСтандартныеЗначения(КонтекстВыполнения = Неопределено) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ЗагрузитьВсеСтандартныеЗначения(КонтекстВыполнения); +``` +
+ +## ПолучитьКонтекстныеНовостиДляФормы +
+ +Описание, пример вызова + +```bsl + +// Функция получает все необходимые данные по контекстным новостям. +// Может использоваться как при стратегии получения новостей в ПриСозданииНаСервере(), +// так и в обработчике ожидания из ПриОткрытии() формы. +// +// Параметры: +// ИдентификаторМетаданных - Строка - Идентификатор метаданных, должен совпадать с таким же +// идентификатором в самой новости; +// ИдентификаторФормы - Строка - Идентификатор формы, должен совпадать с таким же +// идентификатором в самой новости; +// ЗаголовокФормыКонтекстныхНовостей - Строка - Заголовок формы контекстных новостей (в случае, если будут новости +// для отображения в этой форме); +// ИдентификаторыСобытийПриОткрытии - Строка, Массив - строка или массив строк идентификаторов события "ПриОткрытии". +// Если передано какое-то значение, то будет подсчитано количество +// очень важных контекстных новостей. +// И если это количество > 0, то открывающая форма инициирует открытие формы +// просмотра таких новостей; +// НастройкиПолученияНовостей - Структура, Неопределено - структура с ключами: +// * ПолучатьКатегорииНовостей - Булево - если Истина, то в реквизите формы будут также сохраняться +// категории новостей. Это может быть полезно для реализации особенного +// отбора новостей, который невозможно реализовать с помощью регистров +// сведений ОтборыПоЛентамНовостей*. +// +// Возвращаемое значение: +// Структура - структура контекстных новостей для указанной комбинации +// ИдентификаторМетаданных / ИдентификаторФормы с ключами: +// * ДатаЗаполнения - Дата - если прошло много времени, то обновить; +// * Новости - Массив из Структура: +// ** НомерСтрокиНовости - Число - номер строки; +// ** ЛентаНовостей - СправочникСсылка.ЛентаНовостей - лента новостей; +// ** Новость - СправочникСсылка.Новости -ссылка; +// ** НовостьНаименование - Строка -; +// ** НовостьПодзаголовок - Строка -; +// ** УИННовости - Строка -; +// ** ДатаПубликации - Дата -; +// ** Важность - Число -; +// ** Актуальность - Булево -; +// ** Метаданные - Строка -; +// ** Форма - Строка -; +// ** Событие - Строка -; +// ** ПоказыватьВФормеОбъекта - Булево -; +// ** ЭтоПостояннаяНовость - Булево -; +// ** Прочтена - Булево -; +// ** ОповещениеВключено - Булево -; +// ** ДатаНачалаОповещения - Дата - ; +// ** СпособОповещения - Строка - имя перечисления СпособыОповещенияПользователяОНовостях для Ленты новостей; +// * ЗаголовокФормыКонтекстныхНовостей - Строка; +// * КоличествоНовостей - Число - общее количество уникальных новостей +// для этих метаданных / формы; +// * КоличествоНепрочитанныхНовостей - Число - общее количество уникальных непрочтенных новостей +// для этих метаданных / формы; +// * КоличествоВажныхНовостейПриОткрытии - Число - количество важных новостей, +// которые надо показать при открытии; +// * КоличествоОченьВажныхНовостейПриОткрытии - Число - количество очень важных новостей, +// которые надо показать при открытии; +// * КоличествоПостоянныхНовостей - Число - количество новостей с признаком ЭтоПостояннаяНовость; +// * МассивСтруктурВажныхНовостей - Массив структур - важные новости, +// которые необходимо показать при открытии; +// ** Новость - СправочникСсылка.Новости - ссылка на новость; +// ** НавигационнаяСсылка - Строка - навигационная ссылка; +// ** НовостьНаименование - Строка - заголовок; +// ** НовостьПодзаголовок - Строка - подзаголовок; +// ** НовостьКодЛентыНовостей - Строка - код ленты новостей; +// ** ОповещениеВключено - Булево - признак того, что новость необходимо показать; +// ** ИконкаНовости - Картинка, Неопределено - картинка важной новости; +// ** СпособОповещения - Строка - имя перечисления СпособыОповещенияПользователяОНовостях; +// * МассивСтруктурПостоянныхНовостей - Массив структур - новости, которые можно использовать +// для формирования информационных ссылок; +// ** Новость - СправочникСсылка.Новости - ссылка на новость; +// ** НовостьНаименование - Строка - заголовок новости (для формирования представления). +// +Функция ПолучитьКонтекстныеНовостиДляФормы( Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьКонтекстныеНовостиДляФормы(); +``` +
+ +## ПолучитьСостояниеПанелиКонтекстныхНовостей +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает состояние панели контекстных новостей для текущего пользователя. +// +// Параметры: +// ИдентификаторМетаданных - Строка - Идентификатор метаданных, должен совпадать с таким же +// идентификатором в самой новости; +// ИдентификаторФормы - Строка - Идентификатор формы, должен совпадать с таким же +// идентификатором в самой новости; +// +// Возвращаемое значение: +// Структура - структура с ключами: +// * Видимость - Булево - Ложь, если панель контекстных новостей отключена пользователем; +// * ДатаОтключения - Дата - дата, когда отключили панель контекстных новостей или пустая дата (если Видимость = Истина); +// * ДатаПоследнейНовости - Дата - дата самой последней новости перед отключением панели контекстных новостей +// (для принятия решения о принудительном включении) или пустая дата (если Видимость = Истина). +// +Функция ПолучитьСостояниеПанелиКонтекстныхНовостей(ИдентификаторМетаданных, ИдентификаторФормы) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьСостояниеПанелиКонтекстныхНовостей(ИдентификаторМетаданных, ИдентификаторФормы)); +``` +
+ +## ПанельКонтекстныхНовостей_ИзменитьВидимость +
+ +Описание, пример вызова + +```bsl + +// Процедура управляет видимостью панели контекстных новостей в форме, а также сохраняет настройки (дату закрытия), +// чтобы через некоторое время снова открыть панель. +// +// Параметры: +// Новости - Структура - состав ключей см. в коде ОбработкаНовостей.КонтекстныеНовости_ПриСозданииНаСервере, +// заполнение переменной ОписаниеНовостей; +// Видимость - Булево - новое состояние видимости. +// +Процедура ПанельКонтекстныхНовостей_ИзменитьВидимость(Новости, Видимость) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПанельКонтекстныхНовостей_ИзменитьВидимость(Новости, Видимость) +``` +
+ +## ОчиститьКатегорииНовости +
+ +Описание, пример вызова + +```bsl + +// Процедура очищает все категории для новости ОбъектНовость из регистра сведений КатегорииНовостейПростыеНеобработанные, +// КатегорииНовостейПростые, КатегорииНовостейИнтервалыВерсийНеобработанные и КатегорииНовостейИнтервалыВерсий. +// Такая очистка производится, например, при загрузке новости. +// Если новость была изменена, то вначале очищаются все категории, а затем загружаются заново. +// +// Параметры: +// ОбъектНовость - СправочникОбъект.Новости. +// +Процедура ОчиститьКатегорииНовости(ОбъектНовость) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОчиститьКатегорииНовости(ОбъектНовость) +``` +
+ +## ОбновлениеИнформационнойБазы_ОбщиеДанные_ПервыйЗапуск +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при первом запуске библиотеки БИП. +// Перенесено в этот модуль из ОбновлениеИнформационнойБазыБИП, +// чтобы при частичном внедрении (без подсистемы Новостей) не выдавались ошибки при проверке конфигурации. +// +Процедура ОбновлениеИнформационнойБазы_ОбщиеДанные_ПервыйЗапуск() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеИнформационнойБазы_ОбщиеДанные_ПервыйЗапуск() +``` +
+ +## ОбновлениеИнформационнойБазы_ОбластьДанных_ПервыйЗапуск +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при первом запуске библиотеки БИП. +// Процедура - для каждой области данных. +// Перенесено в этот модуль из ОбновлениеИнформационнойБазыБИП, +// чтобы при частичном внедрении (без подсистемы Новостей) не выдавались ошибки при проверке конфигурации. +// +Процедура ОбновлениеИнформационнойБазы_ОбластьДанных_ПервыйЗапуск() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеИнформационнойБазы_ОбластьДанных_ПервыйЗапуск() +``` +
+ +## ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при обновлении библиотеки БИП на любую новую версию. +// Процедура - для общих данных. +// Перенесено в этот модуль из ОбновлениеИнформационнойБазыБИП, +// чтобы при частичном внедрении (без подсистемы Новостей) не выдавались ошибки при проверке конфигурации. +// +Процедура ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию() +``` +
+ +## ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию_2_1_4 +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при обновлении библиотеки БИП на новую версию. +// Процедура - для общих данных. +// Перенесено в этот модуль из ОбновлениеИнформационнойБазыБИП, +// чтобы при частичном внедрении (без подсистемы Новостей) не выдавались ошибки при проверке конфигурации. +// +Процедура ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию_2_1_4() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию_2_1_4() +``` +
+ +## ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию_2_1_5 +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при обновлении библиотеки БИП на новую версию. +// Процедура - для общих данных. +// Перенесено в этот модуль из ОбновлениеИнформационнойБазыБИП, +// чтобы при частичном внедрении (без подсистемы Новостей) не выдавались ошибки при проверке конфигурации. +// +Процедура ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию_2_1_5() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию_2_1_5() +``` +
+ +## ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию_2_2_3 +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при обновлении библиотеки БИП на новую версию. +// Процедура - для общих данных. +// +Процедура ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию_2_2_3() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеИнформационнойБазы_ОбщиеДанные_ПерейтиНаВерсию_2_2_3() +``` +
+ +## ОбновлениеИнформационнойБазы_ОбластьДанных_ПерейтиНаВерсию +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при обновлении библиотеки БИП на любую новую версию. +// Процедура - для каждой области данных. +// Перенесено в этот модуль из ОбновлениеИнформационнойБазыБИП, +// чтобы при частичном внедрении (без подсистемы Новостей) не выдавались ошибки при проверке конфигурации. +// +Процедура ОбновлениеИнформационнойБазы_ОбластьДанных_ПерейтиНаВерсию() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеИнформационнойБазы_ОбластьДанных_ПерейтиНаВерсию() +``` +
+ +## ОбновлениеИнформационнойБазы_ОбластьДанных_ПерейтиНаВерсию_2_1_4 +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при обновлении библиотеки БИП на новую версию. +// Процедура - для каждой области данных. +// Перенесено в этот модуль из ОбновлениеИнформационнойБазыБИП, +// чтобы при частичном внедрении (без подсистемы Новостей) не выдавались ошибки при проверке конфигурации. +// +Процедура ОбновлениеИнформационнойБазы_ОбластьДанных_ПерейтиНаВерсию_2_1_4() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеИнформационнойБазы_ОбластьДанных_ПерейтиНаВерсию_2_1_4() +``` +
+ +## ОбновлениеИнформационнойБазы_ОбластьДанных_ПерейтиНаВерсию_2_1_5 +
+ +Описание, пример вызова + +```bsl + +// Процедура вызывается при обновлении библиотеки БИП на новую версию. +// Процедура - для каждой области данных. +// Перенесено в этот модуль из ОбновлениеИнформационнойБазыБИП, +// чтобы при частичном внедрении (без подсистемы Новостей) не выдавались ошибки при проверке конфигурации. +// +Процедура ОбновлениеИнформационнойБазы_ОбластьДанных_ПерейтиНаВерсию_2_1_5() Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ОбновлениеИнформационнойБазы_ОбластьДанных_ПерейтиНаВерсию_2_1_5() +``` +
+ +## ПроверитьПравильностьВнедренияПодсистемы +
+ +Описание, пример вызова + +```bsl + +// Функция проверяет правильность внедрения подсистемы Новости. +// В случае ошибок возвращаются тексты ошибок. +// +// Параметры: +// ВариантПроверки - Строка - Вариант проверки ("ТолькоПереопределения", "Все"). +// +// Возвращаемое значение: +// - Строка - тексты ошибок или пустая строка, если ошибок не было. +// +Функция ПроверитьПравильностьВнедренияПодсистемы(ВариантПроверки = "Все") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПроверитьПравильностьВнедренияПодсистемы(ВариантПроверки); +``` +
+ +## Проверка_ОбщиеРеквизиты +
+ +Описание, пример вызова + +```bsl + +// Процедура проверяет правильность установки свойств состава общего реквизита для объекта метаданных. +// +// Параметры: +// ЛокальныйОбщийРеквизит - ОбщийРеквизит - общий реквизит, для которого осуществляется проверка; +// ЛокальныйОбъектМетаданных - ОбъектМетаданных - проверяемый объект; +// ПравильноеЗначениеИспользования - ИспользованиеОбщегоРеквизита - правильное значение, которое должно быть; +// Результат - Строка - сюда будет дописан текст ошибки. +// +Процедура Проверка_ОбщиеРеквизиты( Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.Проверка_ОбщиеРеквизиты(); +``` +
+ +## Проверка_Права +
+ +Описание, пример вызова + +```bsl + +// Процедура проверяет правильность установки прав для объекта метаданных. +// +// Параметры: +// ЛокальнаяРоль - Роль - проверяемая роль; +// ЛокальноеПраво - Строка - проверяемое право; +// ПравильноеЗначениеПрава - Булево - правильное значение, которое должно быть; +// ЛокальныйОбъектМетаданных - ОбъектМетаданных - проверяемый объект; +// Результат - Строка - сюда будет дописан текст ошибки. +// +Процедура Проверка_Права( Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.Проверка_Права(); +``` +
+ +## ТекущийПользовательИБ +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает текущего пользователя ИБ. +// Если список пользователей информационной базы пустой, то в качестве текущего пользователя будет возвращен +// пользователь с пустым именем и идентификатором объекта, полученного методом НайтиПоИмени, если в параметре указано пустое имя. +// +// Возвращаемое значение: +// ПользовательИнформационнойБазы - текущий пользователь ИБ. Может быть пустым, если в конфигураторе не заполнены пользователи ИБ. +// +Функция ТекущийПользовательИБ() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ТекущийПользовательИБ() +``` +
+ +## ПолучитьРедакторовЛентыНовостей +
+ +Описание, пример вызова + +```bsl + +// Функция возвращает список пользователей, которым разрешено редактировать новости в этой ленте новостей. +// Разрешено редактировать новости пользователям с включенной ролью ПолныеПрава (без каких-либо дополнительных настроек) +// и пользователям с ролью "РедактированиеНовостей" (если это разрешение явно указано). +// У ЛентыНовостей обязательно должны быть такие настройки: ЗагруженоССервера = Ложь, ЛокальнаяЛентаНовостей = Истина. +// +// Параметры: +// ЛентаНовостей - СправочникСсылка.ЛентыНовостей, Структура - Лента новостей, +// для которой необходимо выполнить проверку. +// Если передана структура, то там обязательно должны быть ключи: +// * Ссылка - СправочникСсылка.ЛентыНовостей; +// * ЗагруженоССервера - Булево; +// * ЛокальнаяЛентаНовостей - Булево; +// ВыводитьВсехПользователей - Булево - Истина, если выводить всех пользователей с ролью РедактированиеНовостей, +// Ложь - если выводить только тех, у кого право редактирования включено; +// +// Возвращаемое значение: +// Массив - массив структур всех пользователей, которым разрешено редактировать новости +// в этой ленте новостей, с ключами: +// * Пользователь - СправочникСсылка.Пользователи; +// * ПользовательПредставление - Строка; +// * ПолныеПрава - Булево - доступна роль АдминистраторСистемы и ПолныеПрава +// (т.е. может редактировать новости без дополнительных разрешений); +// * Пометка - Булево - Истина, если разрешено редактировать ленту новостей. +// +Функция ПолучитьРедакторовЛентыНовостей(ЛентаНовостей, ВыводитьВсехПользователей = Ложь) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьРедакторовЛентыНовостей(ЛентаНовостей, ВыводитьВсехПользователей); +``` +
+ +## ЗаписатьСообщениеВЖурналРегистрации +
+ +Описание, пример вызова + +```bsl + +// АПК:142-выкл 5 необязательных параметров. + +// Процедура записывает сообщение в журнал регистрации. +// +// Параметры: +// ИмяСобытия - строка; +// ИдентификаторШага - строка; +// УровеньРегистрации - строковое представление константы УровеньЖурналаРегистрации; +// ОбъектМетаданных - строковое представление объекта метаданных; +// Данные - данные; +// Комментарий - строка - произвольный комментарий; +// ВестиПодробныйЖурналРегистрации - Булево - признак записи незначащих событий (Информации и Примечания). +// +Процедура ЗаписатьСообщениеВЖурналРегистрации( Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ЗаписатьСообщениеВЖурналРегистрации(); +``` +
+ +## ВыгрузитьВсеСобытияЖурналаРегистрации +
+ +Описание, пример вызова + +```bsl + +// АПК:142-вкл + +// Выгружает журнал регистрации по событиям во временное хранилище. +// +// Параметры: +// ПараметрыОтбора - Структура - структура с ключами: +// * ДатаНачала - Дата - начало периода журнала; +// * ДатаОкончания - Дата - конец периода журнала; +// * Событие - Массив - массив событий (см. [МодульПодсистемыКлиентСервер].ПолучитьСписокВсехСобытийЖурналаРегистрации); +// * Метаданные - Массив, Неопределено - массив метаданных для отбора. +// ПараметрыФайлаВыгрузки - Структура, Неопределено - структура с ключами: +// * Архивировать - Булево - Истина, если необходимо архивировать выгрузку. +// +// Возвращаемое значение: +// Структура с ключами: +// * АдресВременногоХранилищаФайла - Строка - Адрес выгруженных данных в хранилище; +// * ТекстОшибки - Строка - Текст ошибки или пустая строка. +// +Функция ВыгрузитьВсеСобытияЖурналаРегистрации(ПараметрыОтбора, ПараметрыФайлаВыгрузки = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ВыгрузитьВсеСобытияЖурналаРегистрации(ПараметрыОтбора, ПараметрыФайлаВыгрузки); +``` +
+ +## ПредставлениеОбъектаХДТО +
+ +Описание, пример вызова + +```bsl + +// Для объекта ХДТО возвращает его xml представление - нужно для отладки. +// В отличие от ОбщегоНазначения.ОбъектXDTOВСтрокуXML возвращает строку другого формата. +// +// Параметры: +// ОбъектХДТО - ОбъектXDTO - требуемый объект; +// ФабрикаХДТО - ФабрикаXDTO - на каком основании создавать тип (может быть по-умолчанию - из конфигурации, и из веб-сервиса). +// +// Возвращаемое значение: +// Строка - xml-представление объекта. +// +Функция ПредставлениеОбъектаХДТО(ОбъектХДТО, ФабрикаХДТО = Неопределено) Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПредставлениеОбъектаХДТО(ОбъектХДТО, ФабрикаХДТО); +``` +
+ +## КомментарийДляЖурналаРегистрации +
+ +Описание, пример вызова + +```bsl + +// Возвращает текст комментария для записи в журнал регистрации. +// +// Параметры: +// ОписаниеШага - Строка - описание шага; +// ШагВыполнения - Структура - структура шага выполнения; +// КонтекстВыполнения - Структура - контекст выполнения; +// Вариант - Строка - "Простой" или "Расширенный". +// +// Возвращаемое значение: +// Строка - Текст для записи в журнал регистрации. +// +Функция КомментарийДляЖурналаРегистрации(ОписаниеШага, ШагВыполнения, КонтекстВыполнения, Вариант = "Простой") Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.КомментарийДляЖурналаРегистрации(ОписаниеШага, ШагВыполнения, КонтекстВыполнения, Вариант); +``` +
+ +## ПолучитьДополнительныеСтандартныеЗначенияКлассификаторов +
+ +Описание, пример вызова + +```bsl + +// Процедура по имени объекта метаданных дополняет стандартные значения. +// По-умолчанию стандартные значения берутся из макетов с именем "СтандартныеЗначения" для следующих объектов метаданных: +// - Справочник.ЗначенияКатегорийНовостей, +// - Справочник.ЛентыНовостей, +// - ПланВидовХарактеристик.КатегорииНовостей. +// +// Параметры: +// ИмяОбъектаМетаданных - Строка - Имя загружаемого объект метаданных. Возможные значения: +// * "Справочники.ЗначенияКатегорийНовостей"; +// * "Справочники.ЛентыНовостей"; +// * "ПланыВидовХарактеристик.КатегорииНовостей". +// СтандартныеЗначения - Соответствие - Сюда необходимо добавить свои тексты стандартных значений. +// Тексты должны быть оформлены в формате XML так же, как это сделано +// в макете СтандартныеЗначения нужного объекта метаданных: +// * Ключ - произвольный идентификатор; +// * Значение - Текст в формате XML. +// +Процедура ПолучитьДополнительныеСтандартныеЗначенияКлассификаторов(ИмяОбъектаМетаданных, СтандартныеЗначения) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПолучитьДополнительныеСтандартныеЗначенияКлассификаторов(ИмяОбъектаМетаданных, СтандартныеЗначения) +``` +
+ +## ПолучитьДополнительныеСтандартныеЗначенияНовостей +
+ +Описание, пример вызова + +```bsl + +// Процедура по ссылке на ленту новостей дополняет стандартные значения. +// По-умолчанию стандартные значения берутся из макетов справочника Новости с именем "СтандартныеЗначения_<КодЛентыНовостей>". +// +// Параметры: +// ЛентаНовостей - СправочникСсылка.ЛентыНовостей - Ссылка на ленту новостей, в которую необходимо загрузить данные; +// СтандартныеЗначения - Соответствие - Сюда необходимо добавить свои тексты стандартных значений. +// Тексты должны быть оформлены в формате XML так же, как это сделано +// в макете СтандартныеЗначения нужного объекта метаданных: +// * Ключ - произвольный идентификатор; +// * Значение - Текст в формате XML. +// +Процедура ПолучитьДополнительныеСтандартныеЗначенияНовостей(ЛентаНовостей, СтандартныеЗначения) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ПолучитьДополнительныеСтандартныеЗначенияНовостей(ЛентаНовостей, СтандартныеЗначения) +``` +
+ +## ДополнительноОбработатьКлассификаторПослеПолученияПослеЗаписи +
+ +Описание, пример вызова + +```bsl + +// Если после получения и записи классификатора надо что-то сделать, то это можно сделать в этой процедуре. +// Классификатор уже записан в базу данных, поэтому можно менять связанные справочники и регистры сведений. +// Для обеспечения целостности приходящих с серверов 1С данных, обработчика ПередЗаписью нет, +// т.е. манипулировать отменой записи нельзя. Также отсутствует параметр Отказ. +// +// Параметры: +// КлассификаторСсылка - СправочникСсылка - Классификатор, который был только что записан. +// +Процедура ДополнительноОбработатьКлассификаторПослеПолученияПослеЗаписи(КлассификаторСсылка) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ДополнительноОбработатьКлассификаторПослеПолученияПослеЗаписи(КлассификаторСсылка) +``` +
+ +## ИсправитьЗадвоенияКатегорийНовостейПослеЗаписи +
+ +Описание, пример вызова + +```bsl + +// Проверка и исправление задвоений категорий новостей. Считаем, что "КлассификаторСсылка" - это правильные данные. +// +// Параметры: +// КлассификаторСсылка - СправочникСсылка - Классификатор, который был только что записан. +// +Процедура ИсправитьЗадвоенияКатегорийНовостейПослеЗаписи(КлассификаторСсылка) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ИсправитьЗадвоенияКатегорийНовостейПослеЗаписи(КлассификаторСсылка)); +``` +
+ +## ИсправитьЗадвоенияЗначенийКатегорийНовостейПослеЗаписи +
+ +Описание, пример вызова + +```bsl + +// Проверка и исправление задвоений значений категорий новостей. Считаем, что "КлассификаторСсылка" - это правильные данные. +// +// Параметры: +// КлассификаторСсылка - СправочникСсылка - Классификатор, который был только что записан. +// +Процедура ИсправитьЗадвоенияЗначенийКатегорийНовостейПослеЗаписи(КлассификаторСсылка) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.ИсправитьЗадвоенияЗначенийКатегорийНовостейПослеЗаписи(КлассификаторСсылка)); +``` +
+ +## ФорматДатыВремениДляНовости +
+ +Описание, пример вызова + +```bsl + +// Возвращает строку формата даты и времени для новостей. +// +// Возвращаемое значение: +// Строка - формат даты и времени для новостей. +// +Функция ФорматДатыВремениДляНовости() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ФорматДатыВремениДляНовости() +``` +
+ +## УстановитьСостояниеПодсистемы +
+ +Описание, пример вызова + +```bsl + +// Устанавливает состояние подсистемы. +// +// Параметры: +// СостояниеПодсистемы - Строка - Допустимые состояния: +// * Активна - подсистема работает в штатном режиме, все новости показываются; +// * ТребуетсяПересчетОтборовПослеДлительногоОжидания - база долго не запускалась, возможно устарели все отборы. +// Никакие новости не показываются, пока не будут пересчитаны отборы. Не более 1 часа; +// * СейчасЗагружаютсяНовости - в данный момент происходит загрузка новостей, после которой будут пересчитываться отборы. +// Новые и обновленные новости в этот момент показывать НЕ надо (т.к. могли измениться отборы); Не более 6 часов; +// +Процедура УстановитьСостояниеПодсистемы(СостояниеПодсистемы) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостей.УстановитьСостояниеПодсистемы(СостояниеПодсистемы) +``` +
+ +## ПолучитьСостояниеПодсистемы +
+ +Описание, пример вызова + +```bsl + +// Получает состояние подсистемы. +// +// Возвращаемое значение: +// Строка - см. параметр "СостояниеПодсистемы", метод ОбработкаНовостей.УстановитьСостояниеПодсистемы(). +// +Функция ПолучитьСостояниеПодсистемы() Экспорт +``` + +Пример вызова +```bsl +Результат = ОбработкаНовостей.ПолучитьСостояниеПодсистемы() +``` +
+ +--- + +© 2024, **ООО 1С-Софт** +Все права защищены. Эта программа и сопроводительные материалы предоставляются +в соответствии с условиями лицензии [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode). + +--- diff --git a/src/content/docs/zup/ОбработкаНовостейВызовСервера.md b/src/content/docs/zup/ОбработкаНовостейВызовСервера.md new file mode 100644 index 0000000..3cf3de5 --- /dev/null +++ b/src/content/docs/zup/ОбработкаНовостейВызовСервера.md @@ -0,0 +1,558 @@ +--- +title: Обработка новостей вызов сервера +slug: zup/обработка-новостей-вызов-сервера +--- + + +## ДополнительноОбработатьТекстНовостиПередПоказом +
+ +Описание, пример вызова + +```bsl + +// Если перед выводом новости пользователю, разработчику надо "доработать" ее текст - заменить какие-то теги, +// удалить блоки текста и т.п., то это можно сделать в этой процедуре. +// При формировании текста происходит несколько стадий: вначале компонуется ХТМЛ-текст одной или списка новостей +// (то, что внутри ), затем полученный текст обрамляется тегами и стилями. +// В этой функции можно обработать текст одной новости, без стилей (то, что внутри ). +// +// Параметры: +// ОбъектНовости - СправочникОбъект.Новости - Новость, для которой необходимо изменить уже подготовленный текст; +// ТекстХТМЛ - Строка - уже подготовленный текст, который по-умолчанию будет отображен в форме просмотра новости. +// +// Возвращаемое значение: +// Строка - окончательный текст новости (то, что внутри ). +// +Процедура ДополнительноОбработатьТекстНовостиПередПоказом(ОбъектНовости, ТекстХТМЛ) Экспорт +``` + +Пример вызова +```bsl +ОбработкаНовостейВызовСервера.ДополнительноОбработатьТекстНовостиПередПоказом(ОбъектНовости, ТекстХТМЛ) +``` +
+ +## ДополнительноОбработатьТекстСпискаНовостейПередПоказом +
+ +Описание, пример вызова + +```bsl + +// Если перед выводом новости пользователю, разработчику надо "доработать" ее текст - заменить какие-то теги, стили, +// удалить блоки текста и т.п., то это можно сделать в этой процедуре. +// При формировании текста происходит несколько стадий: вначале компонуется ХТМЛ-текст одной или списка новостей +// (то, что внутри ), затем полученный текст обрамляется тегами и стилями. +// В этой процедуре можно обработать результирующий текст одной или списка новости, включая заголовки, стили и т.п. +// В тексте списка новостей есть комментарии, которые можно быстро заменить с помощью строковых функций: +// (находится внутри ) +// например, если точно известно, что на компьютере установлен Internet Explorer последней версии, то можно добавить тег +// +// и тогда в новостях можно будет выводить SVG картинки; +// /* Здесь можно вставить свои стили */ (находится внутри