|
<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > DocflowApproval – документооборот. Движение документов Серверные функции модуля DocflowApproval |
|
|
<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > DocflowApproval – документооборот. Движение документов Серверные функции модуля DocflowApproval |
|
Имя функции |
Модификатор |
Атрибут |
Описание |
– |
[Public] |
Добавить исполнителя в задание согласования |
|
virtual |
– |
Добавить новых согласующих |
|
virtual |
[Remote] |
Проверить права текущего сотрудника на утверждение документа |
|
virtual |
[Remote] |
Проверить права сотрудника на утверждение документа |
|
CreateDocumentFlowTask + перегрузки |
static |
[Public] |
Создать задачу на согласование документа по процессу |
virtual |
[Remote] |
Проверить, является ли сотрудник согласующим (указан исполнителем хотя бы в одном с блоке "Согласование" задачи) |
|
virtual |
– |
Получить документы, которые возможно преобразовать в PDF |
|
virtual |
– |
Получить список новых исполнителей из блока согласования, добавленных на предыдущих кругах |
|
virtual |
– |
Получение заданий на рассмотрение или создание поручения в рамках согласования по регламенту |
|
virtual |
– |
Получить адресатов для выходного свойства блока |
|
static |
[Public] |
ПОлучить количество сущностей |
|
virtual |
– |
Получить список сотрудников, у которых можно запросить продление срока |
|
virtual |
– |
Получить список сотрудников без исполнителя, у которых можно запросить продление срока |
|
– |
[Public] |
Получить созданные задачи на согласование документа по процессу |
|
virtual |
– |
Получение активных задач на рассмотрение |
|
static |
[Remote] |
Получить доступные сервисы обмена |
|
virtual |
– |
Получить последнее выполненное задание на доработку |
|
virtual |
– |
Получить время последнего выполненного задания на доработку в рамках задачи |
|
virtual |
– |
Получение активных заданий на обработку документа за пределами текущей задачи |
|
static |
[Public] |
Получить всех участников задачи |
|
virtual |
[Public] |
Получить ответственного за возврат |
|
virtual |
– |
Выдать права на документы на чтение |
|
virtual |
[Remote] |
Проверить, есть ли по документу задания на рассмотрение или создание поручения в рамках согласования по регламенту |
|
virtual |
[Remote] |
Проверить, созданы ли по документу задачи на рассмотрение |
|
virtual |
[Remote] |
Проверить, созданы ли по документу задания на обработку за рамками текущей задачи |
|
static |
[Public] |
Увеличить целочисленный параметр процесса на заданное число |
|
virtual |
– |
Проверить наличие связи между документом и приложением |
|
virtual |
– |
Проверить, отправлялся ли документ в сервисы обмена |
|
static |
[Public] |
Проверить, есть ли хотя бы одна отправка контрагенту в схеме задачи |
|
virtual |
– |
Проверить, нужно ли отправлять на согласование |
|
virtual |
[Remote] |
Необходимо ли требовать усиленную подпись |
|
virtual |
– |
Проверить, согласовал ли исполнитель документ в рамках задачи |
|
virtual |
– |
Проверить, подписал ли исполнитель документ в рамках задачи |
|
virtual |
– |
Отправить запрос на подготовку предпросмотра для документов из вложений задания |
|
virtual |
[Public] |
Связать с основным документом документы из списка, если они не были связаны ранее |
|
virtual |
– |
Удалить исполнителей, которые уже согласовали документ в рамках задачи |
|
virtual |
– |
Удалить исполнителей, которые уже подписали документ в рамках задачи |
|
virtual |
– |
Обновить выдачу документов эл. обмена после отправки в сервис обмена |
|
virtual |
– |
Обновить выдачу бумажного документа после отправки |
Добавить исполнителя в задание согласования.
Синтаксис
[Public, Remote]
public void AddApprover(IAssignment assignment, IEmployee newApprover, DateTime? deadline)
Параметры
assignment – Задание;
newApprover – Новый согласующий;
deadline – Новый срок для задания.
Добавить новых согласующих.
Синтаксис
public virtual void AddNewPerformers(DocflowApproval.Server.DocflowApprovalBlocks.ApprovalBlock block, IEntityReworkAssignment previousReworkAsg)
Параметры
block – Блок согласования;
previousReworkAsg – Последнее выполненное задание на доработку.
CheckCurrentEmployeeRightsToApprove
Проверить права текущего сотрудника на утверждение документа.
Синтаксис
[Remote]
public virtual string CheckCurrentEmployeeRightsToApprove(IElectronicDocument document)
Параметры
document – Документ.
Возвращаемое значение
string – Текст ошибки, если прав нет, иначе - пустая строка.
Проверить права сотрудника на утверждение документа.
Синтаксис
[Remote]
public virtual string CheckEmployeeRightsToApprove(IEmployee employee, IElectronicDocument document)
Параметры
employee – Сотрудник;
document – Документ.
Возвращаемое значение
string – Текст ошибки, если прав нет, иначе - пустая строка.
Создать задачу на согласование документа по процессу.
Перегрузки
Имя функции |
Описание |
Создать задачу на согласование документа по процессу |
|
CreateDocumentFlowTask (long documentId, string text, List<long> addApproverIds) |
Создать задачу на согласование по регламенту |
CreateDocumentFlowTask (IOfficialDocument document)
Создать задачу на согласование документа по процессу.
Синтаксис
[Remote(PackResultEntityEagerly = true), Public]
public static IDocumentFlowTask CreateDocumentFlowTask(IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
IDocumentFlowTask – Задача на согласование документа по процессу.
CreateDocumentFlowTask (long documentId, string text, List<long> addApproverIds)
Создать задачу на согласование по регламенту.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual long CreateDocumentFlowTask(long documentId, string text, List<long> addApproverIds)
Параметры
documentId – ИД согласуемого документа;
text – Текст задачи;
addApproverIds – Список ИД дополнительных согласующих.
Возвращаемое значение
long – ИД созданной задачи.
Проверить, является ли сотрудник согласующим (указан исполнителем хотя бы в одном с блоке "Согласование" задачи).
Синтаксис
[Remote(IsPure = true)]
public virtual bool EmployeeIsApprover(ITask task, IEmployee employee)
Параметры
task – Задача;
employee – Сотрудник.
Возвращаемое значение
bool – True, если сотрудник является согласующим, иначе - false.
Получить документы, которые возможно преобразовать в PDF.
Синтаксис
public virtual List<IOfficialDocument> FilterDocumentsToConvertToPdf(List<IOfficialDocument> documents)
Параметры
documents – Список документов.
Возвращаемое значение
List<IOfficialDocument> – Документы, которые возможно преобразовать в PDF.
Получить список новых исполнителей из блока согласования, добавленных на предыдущих кругах.
Синтаксис
public virtual List<IEmployee> GetAddedApprovers(List<IEmployee> blockPerformers, string blockId, IEntityReworkAssignment previousReworkAsg)
Параметры
blockPerformers – Исполнители блока;
blockId – ИД блока;
previousReworkAsg – Предыдущее задание на доработку.
Возвращаемое значение
List<IEmployee> – Исполнители, не попавшие в блок.
GetApprovalReviewOrExecutionAssignments
Получение заданий на рассмотрение или создание поручения в рамках согласования по регламенту.
Синтаксис
public virtual IQueryable<IAssignment> GetApprovalReviewOrExecutionAssignments(IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
IQueryable<IAssignment> – Задания на рассмотрение или создание поручения в рамках согласования по регламенту.
Получить адресатов для выходного свойства блока.
Синтаксис
public virtual System.Collections.Generic.IEnumerable<IEmployee> GetBlockOutAddressees(System.Collections.Generic.IEnumerable<IEmployee> blockAddressees, System.Collections.Generic.IEnumerable<IEmployee> assignmentAddressees)
Параметры
blockAddressees – Адресаты блока;
assignmentAddressees – Адресаты задания.
Возвращаемое значение
System.Collections.Generic.IEnumerable<IEmployee> – Адресаты для выходного свойства блока.
ПОлучить количество сущностей.
Синтаксис
[Public, ExpressionElement("GetCountExpressionElementName", "GetCountExpressionElementDescription")]
public static int GetCount(System.Collections.Generic.IEnumerable<IEntity> entities)
Параметры
entities – Сущности.
Возвращаемое значение
int – Количество сущностей.
Получить список сотрудников, у которых можно запросить продление срока.
Первый в списке сотрудник подставится по умолчанию в поле Кому в задаче на продление.
Синтаксис
public virtual List<IUser> GetDeadlineAssignees(IAssignment assignment)
Параметры
assignment – Задание, из которого запрашивают продление.
Возвращаемое значение
List<IUser> – Список сотрудников.
GetDeadlineAssigneesWithoutPerformer
Получить список сотрудников без исполнителя, у которых можно запросить продление срока.
Первый в списке сотрудник подставится по умолчанию в поле Кому в задаче на продление.
Синтаксис
public virtual List<IUser> GetDeadlineAssigneesWithoutPerformer(IAssignment assignment)
Параметры
assignment – Задание, из которого запрашивают продление.
Возвращаемое значение
List<IUser> – Список сотрудников.
Получить созданные задачи на согласование документа по процессу.
Синтаксис
[Public, Remote]
public IQueryable<IDocumentFlowTask> GetDocumentFlowTasks(IElectronicDocument document)
Параметры
document – Документ.
Возвращаемое значение
IQueryable<IDocumentFlowTask> – Список созданных задач на согласование документа по процессу.
Получение активных задач на рассмотрение.
Синтаксис
public virtual IQueryable<IDocumentReviewTask> GetDocumentReviewTasks(IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
IQueryable<IDocumentReviewTask> – Активные задачи на рассмотрение.
Получить доступные сервисы обмена.
Синтаксис
[Remote(IsPure = true)]
public static Structures.Module.ExchangeServices GetExchangeServices(Docflow.IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
Structures.Module.ExchangeServices – Сервисы обмена.
GetLastCompletedReworkAssignment
Получить последнее выполненное задание на доработку.
Синтаксис
public virtual IEntityReworkAssignment GetLastCompletedReworkAssignment(Workflow.ITask task)
Параметры
task – Задача.
Возвращаемое значение
IEntityReworkAssignment – Задание на доработку.
Получить время последнего выполненного задания на доработку в рамках задачи.
Синтаксис
public virtual DateTime? GetLastReworkCompletedTime(ITask task)
Параметры
task – Задача.
Возвращаемое значение
DateTime? – Время последнего выполненного задания на доработку или null, если задания не было.
GetOtherDocumentProcessingAssignments
Получение активных заданий на обработку документа за пределами текущей задачи.
Синтаксис
public virtual IQueryable<DocflowApproval.IDocumentProcessingAssignment> GetOtherDocumentProcessingAssignments(ITask task, IOfficialDocument document)
Параметры
task – Текущая задача;
document – Документ.
Возвращаемое значение
IQueryable<DocflowApproval.IDocumentProcessingAssignment> – Активные задания на обработку документа за пределами текущей задачи.
Получить всех участников задачи.
Участниками являются исполнители всех выполненных или текущих заданий в задаче,
в т.ч. исполнители подзадач и задач, для которых текущая задача является подзадачей.
Синтаксис
[Public, ExpressionElement("TaskPerformers", "TaskPerformersDescription")]
public static List<IEmployee> GetPerformers(Sungero.Workflow.ITask task)
Параметры
task – Задача.
Возвращаемое значение
List<IEmployee> – Список участников.
Получить ответственного за возврат.
Ответственным считается:
1. Кому выдан из строки в Выдаче с действием Endorsement с пустой датой возврата;
2. Кому выдан из последней по дате выдачи строки в Выдаче с действием Sending;
3. Ответственный за документ, если это несистемный пользователь;
4. Инициатор задачи, если это несистемный пользователь;
5. Кому выдан из последней по дате выдачи строки в Выдаче с действием Endorsement;
Null, если не удалось определить ответственного за возврат.
Синтаксис
[Public]
public virtual IEmployee GetResponsibleToReturn(IOfficialDocument document, ITask task)
Параметры
document – Документ;
task – Задача возврата.
Возвращаемое значение
IEmployee – Ответственный за возврат.
GrantReadAccessRightsToDocuments
Выдать права на документы на чтение.
Синтаксис
public virtual void GrantReadAccessRightsToDocuments(List<IElectronicDocument> documents, IRecipient recipient)
Параметры
documents – Список документов;
recipient – Субъект прав.
HasApprovalReviewOrExecutionAssignments
Проверить, есть ли по документу задания на рассмотрение или создание поручения в рамках согласования по регламенту.
Синтаксис
[Remote(IsPure = true)]
public virtual bool HasApprovalReviewOrExecutionAssignments(IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
bool – True, если по документу есть задания на рассмотрение или создание поручения в рамках согласования по регламенту.
Проверить, созданы ли по документу задачи на рассмотрение.
Синтаксис
[Remote(IsPure = true)]
public virtual bool HasDocumentReviewTasks(IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
bool – True, если по документу созданы задачи на рассмотрение.
HasOtherDocumentProcessingAssignments
Проверить, созданы ли по документу задания на обработку за рамками текущей задачи.
Синтаксис
[Remote(IsPure = true)]
public virtual bool HasOtherDocumentProcessingAssignments(ITask task, IOfficialDocument document)
Параметры
task – Текущая задача;
document – Документ.
Возвращаемое значение
bool – True, если по документу уже созданы задания на обработку за рамками текущей задачи.
Увеличить целочисленный параметр процесса на заданное число.
Синтаксис
[Public, ExpressionElement("IncreaseParameter", "IncreaseParameterDescription", "", "NumberToAdd")]
public static int IncreaseIntegerParameter(int parameter, int number)
Параметры
parameter – Целочисленный параметр процесса;
number – Прибавляемое число.
Возвращаемое значение
int – Увеличенный целочисленный параметр процесса.
IsAddendumAlreadyRelatedToPrimaryDocument
Проверить наличие связи между документом и приложением.
Синтаксис
public virtual bool IsAddendumAlreadyRelatedToPrimaryDocument(IElectronicDocument primaryDocument, IElectronicDocument addendum)
Параметры
primaryDocument – Основной документ;
addendum – Приложение.
Возвращаемое значение
bool – True - если документы связаны, иначе - False.
Проверить, отправлялся ли документ в сервисы обмена.
Синтаксис
public virtual bool IsExchangeDocument(IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
bool – True - если документ отправлялся в сервисы обмена, иначе - false.
IsSendingToCounterpartyEnabledInScheme
Проверить, есть ли хотя бы одна отправка контрагенту в схеме задачи.
Синтаксис
[Public, Remote]
public static bool IsSendingToCounterpartyEnabledInScheme(ITask task)
Параметры
task – Задача.
Возвращаемое значение
bool – True - если отправка включена, иначе - false.
Проверить, нужно ли отправлять на согласование.
Синтаксис
public virtual bool NeedSendForApproval(ITask task, IRecipient performer, string blockId, IEntityReworkAssignment previousReworkAsg)
Параметры
task – Задача;
performer – Исполнитель;
blockId – ИД блока согласования;
previousReworkAsg – Предыдущее задание на доработку.
Возвращаемое значение
bool – True - отправить на согласование, иначе - false.
Необходимо ли требовать усиленную подпись.
Синтаксис
[Remote(IsPure = true)]
public virtual bool NeedStrongSignature(ITask task)
Параметры
task – Задача.
Возвращаемое значение
bool – True - необходимо требовать, False - нет.
Проверить, согласовал ли исполнитель документ в рамках задачи.
Синтаксис
public virtual bool PerformerHasAlreadyApproved(ITask task, IRecipient performer, IEntityReworkAssignment previousReworkAsg)
Параметры
task – Родительская задача;
performer – Исполнитель;
previousReworkAsg – Предыдущее задание на доработку.
Возвращаемое значение
bool – True - исполнитель уже согласовал документ, False - нет.
Проверить, подписал ли исполнитель документ в рамках задачи.
Синтаксис
public virtual bool PerformerHasAlreadySigned(ITask task, IRecipient performer)
Параметры
task – Родительская задача;
performer – Исполнитель.
Возвращаемое значение
bool – True - исполнитель уже подписал документ, False - нет.
Отправить запрос на подготовку предпросмотра для документов из вложений задания.
Предпросмотр для электронных документов.
Синтаксис
public virtual void PrepareAllAttachmentsPreviews(IAssignment assignment)
Параметры
assignment – Задание.
RelateDocumentsToPrimaryDocumentAsAddenda
Связать с основным документом документы из списка, если они не были связаны ранее.
Синтаксис
[Public]
public virtual void RelateDocumentsToPrimaryDocumentAsAddenda(IElectronicDocument primaryDocument, List<IElectronicDocument> documents)
Параметры
primaryDocument – Основной документ;
documents – Список документов.
RemovePerformersWhoAlreadyApproved
Удалить исполнителей, которые уже согласовали документ в рамках задачи.
Синтаксис
public virtual void RemovePerformersWhoAlreadyApproved(DocflowApproval.Server.DocflowApprovalBlocks.ApprovalBlock block, ITask task, IEntityReworkAssignment previousReworkAsg)
Параметры
block – Блок согласования;
task – Задача;
previousReworkAsg – Последнее выполненное задание на доработку.
RemovePerformersWhoAlreadySigned
Удалить исполнителей, которые уже подписали документ в рамках задачи.
Синтаксис
public virtual void RemovePerformersWhoAlreadySigned(DocflowApproval.Server.DocflowApprovalBlocks.SigningBlock block, ITask task)
Параметры
block – Блок подписания;
task – Задача.
UpdateExchangeDocumentsTrackingAfterSending
Обновить выдачу документов эл. обмена после отправки в сервис обмена.
Синтаксис
public virtual void UpdateExchangeDocumentsTrackingAfterSending(List<Exchange.IExchangeDocumentInfo> infos, DateTime returnDeadline, ITask returnTask, long? deliveredTo)
Параметры
infos – Сведения о документах эл. обмена;
returnDeadline – Срок возврата;
returnTask – Задача на контроль возврата;
deliveredTo – Кому передан.
UpdatePaperDocumentTrackingAfterSending
Обновить выдачу бумажного документа после отправки.
Синтаксис
public virtual void UpdatePaperDocumentTrackingAfterSending(IOfficialDocument document, IEmployee responsible, DateTime returnDeadline, ITask returnTask)
Параметры
document – Документ;
responsible – Ответственный;
returnDeadline – Срок возврата;
returnTask – Задача на контроль возврата.
| © Компания Directum, 2024 |