Введение
Для расширения функциональности в ПО Comindware Platform предусмотрены инструменты написания и использования скриптов на языке C#. ПО позволяет внедрять C#-скрипты при настройке различных сущностей и функций приложения.
Возможности использования C#-скриптов
ПО позволяет использовать C#-скрипты при настройке следующих сущностей и функций:
- Шаблон любого типа → Кнопка → Скрипт операции
- Шаблон процесса → Задача-выполнение сценария → Скрипт задачи
- Шаблон процесса → Пользовательская задача → Вычисление заголовка задачи
- Шаблон процесса → Пользовательская задача → Вычисление исполнителей задачи
- Шаблон процесса → Пользовательская задача → Вычисление продолжительности задачи
- Сценарий → Изменение значений атрибутов скриптом
- Сценарий → Проверка результата скрипта
- Шаблон процесса → Развилка «или/или» → Вычисление условий выбора потоков
- Шаблон процесса → Конечное событие и промежуточное событие → Вычисление продолжительности процесса
- Шаблон процесса → Конечное событие-отправка сообщения и промежуточное событие-отправка сообщения → Тип сообщения → Вычисление экземпляра процесса, в который отправляется сообщение сообщения
- Шаблон процесса → Конечное событие-отправка сообщения и промежуточное событие-отправка сообщения → Вычисление значения атрибута сообщения
Входные и выходные данные C#-скрипта
Скрипт оформляется как public class с предопределённым именем Script. При выполнении скрипта вызывается метод public static Main этого класса. Скрипт компилируется при сохранении настраиваемой сущности.
Перед компиляцией тело скрипта помещается в уникальное пространство имён (namespace) во избежание интерференции между скриптами. Для удобства разработчика в том же пространстве имён автоматически создаётся вспомогательный класс коротких синонимов для обращения к API вида:
static class Api {
public static Comindware.TeamNetwork.Api.PublicServices TeamNetwork;
public static Comindware.Process.Api.IPublicServices Process;
public static Comindware.Platform.Api.IPublicServices Base;
}
Если скомпилировать скрипт не удалось, выводятся предупреждение и детализированное описание ошибок компиляции в области «Журнал действий и ошибок» в информационной панели.
Перекомпиляция и проверка её успешности происходят каждый раз при сохранении, проверке или публикации сущности, в которую внедрён скрипт.
Описание скриптов для различных сущностей
Шаблон любого типа → Кнопка → Скрипт операции
Заготовка скрипта
public class Script {
public static UserCommandResult Main (UserCommandContext userCommandContext) {
// Тело скрипта
}
}
Входные данные
UserCommandContext userCommandContext {
string[] ObjectIds, // массив ID выбранных записей в таблице
// (пустой массив, если записи не выбраны)
// или массив из одного элемента с ID записи на форме
string[] SelectedIds, // массив ID записей, выбранных в таблице на форме
// (пустой массив, если записи не выбраны)
string CurrentUserId, // ID аккаунта текущего пользователя
string DocumentTemplateId, // ID шаблона, к которому относится команда
dateTime CurrentRequestTime, // дата и время текущего запроса
bool ExportAsPdf, // флаг экспорта в PDF
string FileName, // имя файла при выгрузке данных по шаблону экспорта
DatasetQuery Query // список, с которого произошел запуск операции
},
Выходные данные
UserCommandResult {
bool Success, // флаг успешного завершения операции
bool Commited, // флаг необходимости коммита операции
enum UserCommandResultType ResultType, // тип возвращаемого результата.
// В зависимости от значения производятся действия:
// DataChange — обновление данных
// Notificate — сообщение пользователю
// Navigate — переход на страницу
// File — скачивание файла
// набор данных для перехода на другую страницу
UserCommandNavigationResult NavigationResult {
string Title, // заголовок
string ObjectId, // ID записи
string ContainerId, // ID контейнера
ContextType Context // тип отображения
// Undefined, Void, Any, Task, Case, Record, Process, List, Form, Page, Container
},
// объект выгружаемого файла
UserCommandFileResult File {
string Name, // имя файла
string Type,
byte[] Content // тело файла
},
// сообщение об окончании операции
UserCommandMessage[] Messages {
enum Severity, // уровень важности сообщения
// SeverityLevel (Critical, Fatal, Low, Major, None, Normal)
string Text
}
}
Шаблон процесса → Задача-выполнение сценария → Скрипт задачи
Заготовка скрипта
public class Script {
public static void Main(Comindware.Process.Api.Data.ScriptContext context) {
// Тело скрипта
}
}
Входные данные
Comindware.Process.Api.Data.ScriptContext context {
string ProcessID, // ID экземпляра процесса
string BusinessObjectID, // ID записи, связанной с экземпляром процесса
},
Выходные данные
void
// Возвращаемые параметры отсутствуют
Шаблон процесса → Пользовательская задача → Вычисление заголовка задачи
Заготовка скрипта
public class Script {
public static string Main(Comindware.Process.Api.Data.ScriptContext context) {
// Тело скрипта
}
}
Входные данные
Comindware.Process.Api.Data.ScriptContext context {
string ProcessID, // ID экземпляра процесса
string BusinessObjectID, // ID записи, связанной с экземпляром процесса
},
Выходные данные
string
// Заголовку задачи присваивается возвращённое строковое значение
Шаблон процесса → Пользовательская задача → Вычисление исполнителей задачи
Заготовка скрипта
public class Script {
public static IEnumerable<string> Main(Comindware.Process.Api.Data.ScriptContext context) {
// Тело скрипта
}
}
Входные данные
Comindware.Process.Api.Data.ScriptContext context {
string ProcessID, // ID экземпляра процесса
string BusinessObjectID // ID записи, связанной с экземпляром процесса
},
Выходные данные
IEnumerable<string>
// Скрипт должен вернуть список ID аккаунтов
Шаблон процесса → Пользовательская задача → Вычисление продолжительности задачи
Заготовка скрипта
public class Script {
public static TimeSpan Main (Comindware.Process.Api.Data.ScriptContext context) {
// Тело скрипта
}
}
Входные данные
Comindware.Process.Api.Data.ScriptContext context {
string ProcessID, // ID экземпляра процесса
string BusinessObjectID, // ID записи, связанной с экземпляром процесса
},
Comindware.Entities, // используется для доступа к данным шаблонов записей
Выходные данные
TimeSpan
// Продолжительности задачи присваивается возвращённое значение длительности
Сценарий → Изменение значений атрибутов скриптом
Заготовка скрипта
public class Script {
public static string // string, int, decimal, dateTime, bool, TimeSpan или IEnumerable<string>
Main(string ObjectID) {
// Тело скрипта
}
}
Входные данные
string ProcessID, // ID экземпляра процесса,
string ObjectID, // ID записи,
Выходные данные
string, int, decimal, dateTime, TimeSpan, bool, IEnumerable<string>
// Атрибуту присваивается возвращённое значение соответствующего типа
Сценарий → Проверка результата выполнения скрипта
Заготовка скрипта
public class Script
{
public static bool Main([Object fullObjectID])
{
var ObjectID = fullObjectID.ToString().Replace("user.", "");
// Тело скрипта
}
}
Входные данные
string fullObjectID // ID записи с префиксом, необязательный аргумент
Выходные данные
bool
// В зависимости от результата выполения возвращается true или false
Шаблон процесса → Развилка «или/или» → Вычисление условий выбора потоков
Заготовка скрипта
public class Script {
public static bool Main(Comindware.Process.Api.Data.ScriptContext context) {
// Тело скрипта
}
}
Входные данные
Comindware.Process.Api.Data.ScriptContext context {
string ProcessID, // ID экземпляра процесса
string BusinessObjectID, // ID записи, связанной с экземпляром процесса
},
Выходные данные
bool
// Если скрипт вернул true, токен идёт по этому потоку управления
Шаблон процесса → Конечное событие и промежуточное событие → Вычисление продолжительности процесса
Заготовка скрипта
public class Script {
public static TimeSpan Main (Comindware.Process.Api.Data.ScriptContext context) {
// Тело скрипта
}
}
Входные данные
Comindware.Process.Api.Data.ScriptContext context {
string ProcessID, // ID экземпляра процесса
string BusinessObjectID, // ID записи, связанной с экземпляром процесса
},
Выходные данные
TimeSpan
// Продолжительности процесса присваивается возвращённое значение длительности
Шаблон процесса → Конечное событие-отправка сообщения и промежуточное событие-отправка сообщения → Тип сообщения → Вычисление экземпляра процесса, в который отправляется сообщение
Заготовка скрипта
public class Script {
public static void Main(Comindware.Process.Api.Data.ScriptContext context) {
// Тело скрипта
}
}
Входные данные
Comindware.Process.Api.Data.ScriptContext context {
string ProcessID, // ID экземпляра процесса
string BusinessObjectID, // ID записи, связанной с экземпляром процесса
},
Выходные данные
string
// Скрипт должен вернуть ID экземпляра процесса
Шаблон процесса → Конечное событие-отправка сообщения и промежуточное событие-отправка сообщения → Вычисление значения атрибута сообщения
Заготовка скрипта
public class Script {
public static string Main(Comindware.Process.Api.Data.ScriptContext context) {
// Тело скрипта
}
}
Входные данные
Comindware.Process.Api.Data.ScriptContext context {
string ProcessID, // ID экземпляра процесса
string BusinessObjectID // ID записи, связанной с экземпляром процесса
},
Выходные данные
string, number, dateTime, TimeSpan, bool
// Атрибуту присваивается возвращённое строковое значение
Пространство используемых библиотек
Во всех пользовательских C#-скриптах ПО позволяет подключать перечисленные ниже библиотеки и использовать их публичные классы.
API для взаимодействия с Comindware Platform
- Comindware.Logics.Transaction
- Comindware.Data.Entity.ITransaction
- Comindware.Data.Entity.IEntitySet
- Comindware.Platform.Common
- Comindware.Logics
- Comindware.Data.Entity
- Comindware.Data.Api
- Comindware.Teamnetwork.Api
- Comindware.Process.Api
- Comindware.Platform.Api
Системные библиотеки и классы .Net Framework
- netstandard — API-интерфейс .NET
- System.Runtime — основные примитивы, классы и базовые классы .NET
- mscorlib — базовые классы .NET
- System.Core — базовые классы .NET
- System.Xml — обработка XML- документов
- System.Xml.Linq — обработка XML-документов посредством LINQ to XML
- System — базовые классы .NET
- System.object — исходный базовый класс .NET
- System.Linq.Enumerable — запросы к объектам с интерфейсом IEnumerable
Вспомогательные библиотеки и классы
- System.Xml. XmlDocument — обработка XML- документов
- System.Xml.Linq. XDocument — обработка XML- документов
- System.Net. HttpWebRequest — формирование HTTP -запросов
- Newtonsoft.Json. JsonSerializerSettings — определение параметров объекта JsonSerializer
- System.IO.Compression.ZipArchive — обработка ZIP -архивов
- System.DirectoryServices. DirectoryEntry — взаимодействие с Active Directory
- System.Data.SqlClient. SqlConnection — взаимодействи с базой данных
- System.Drawing.Bitmap — обработка изображений
- RestSharp.RestRequest — формирование HTTP- запросов
- RestSharp.Authenticators.HttpBasicAuthenticator — аутентификация HTTP-запросов
- NLog.Logger — подсистема журналирования
- Aspose.BarCode — обработка штрихкодов
- Aspose.Cells — обработка файлов в формате Excel
- Aspose.Words — обработка файлов в формате Word