Russian (Русский) - Change language

Document

Назначение

Тип данных Document используется для хранения информации о документе.

Поля

Имя Тип Описание
Id int

Идентификатор документа.

Единственный способ установить идентификатор документа – получить его с помощью метода GetBatchIdsRange, который позволяет зарезервировать набор идентификаторов для новых документов. Рекомендуется задавать идентификатор до того, как документ будет добавлен в пакет.  

Идентификатор будет сгенерирован автоматически, если присвоить идентификатору значение -1.

BatchId int Идентификатор пакета
ParentId int

Идентификатор родительского документа в комплекте.

Если новый документ должен входить в комплект документов, полю присваивается значение родительского документа этого комплекта.

Если новый документ не входит в комплекты, полю присваивается значение 0

Внимание! Родительский документ должен быть создан раньше дочерних.

ChildrenOrder ChildrenOrder []

Набор дочерних документов, позволяющий отсортировать документы комплекта.

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

Если поле не заполнено, добавляемые в комплект документы будут сортироваться в порядке добавления.

DocIndex int Порядковый номер документа в пакете
TemplateName string Имя определения документа
ProcessingStageType int Тип этапа обработки. Значения из ProcessingStageType
Comment string Комментарий
Pages Page [] Набор страниц документа
IsProcessed bool Признак завершения обработки документа
HasProcessingErrors bool Признак наличия ошибок обработки документа
HasDocumentErrors bool Признак наличия ошибок в документе (форматные ошибки, ошибки проверочных правил или сборки)
ErrorText string Текст ошибки обработки
ExternalId string Пользовательский идентификатор документа
Properties RegistrationProperty [] Набор регистрационных параметров
Priority Priority [] Приоритет документа
FileVersion int Версия файла с бинарными данными
OwnerId int Идентификатор пользователя или группы - владельца документа
StageExternalId int Идентификатор этапа обработки (уникален внутри типа пакета)
TaskId int Идентификатор задания, владеющего документом
UncertainSymbols int Количество неуверенно распознанных символов
VerificationSymbols int Количество верифицированных символов
TotalSymbols int Количество символов в документе
HasErrors bool Признак наличия ошибок правил проверки
HasWarnings bool Признак наличия предупреждений правил проверки
HasAssemblingErrors bool Признак наличия ошибок сборки
HasAttachments bool Признак наличия файлов-приложений
Flags int

Набор флагов, описывающих состояние документа. Значение поля складывается из значений флагов, в числе которых:

  • BIF_IsAnalyzed = 0x100 – показывает, что документ проанализирован;
  • BIF_IsRecognized = 0x200 – показывает, что документ распознан;
  • BIF_IsVerified = 0x400 – показывает, что документ верифицирован;
  • BIF_IsExported = 0x800 – показывает, что документ проэкспортирован;
  • BIF_HasRuleErrors = 0x10000 – показывает, что документ содержит ошибки выполнения правил;
  • BIF_HasRuleWarnings = 0x20000 - показывает, что документ содержит предупреждения выполнения правил;
  • BIF_HasMergeVersionErrors = 0x80000 - показывает, что при слиянии результатов двойной верификации возникли ошибки (результаты, полученные операторами, не совпадают);
  • BIF_HasUserAttachments = 0x100000 - показывает, что документ содержит приложения;
  • BIF_HasUnmatchedFieldErrors = 0x200000 - показывает, что документ содержит неналоженные поля;
  • BIF_NeedsPreprocessing = 0x800000 - показывает, что для документа требуется предварительная обработка изображений;
  • BIF_IsManuallyCreated = 0x1000000 - показывает, что документ был создан вручную;
  • BIF_IsExcludedFromAutomaticAssembling = 0x2000000 - показывает, что документ исключен из автоматической сборки;
  • BIF_IsSourceImageAttached = 0x4000000 - показывает, что к документу прикреплен файл с исходным изображением.

Замечание. Описаны только флаги, имеющие смысл при работе с заданиями методами Web Services API.

10.11.2020 12:08:08


Please leave your feedback about this article