Skip to content

winAgent.md

Latest commit

 

History

History
165 lines (121 loc) · 6.38 KB

winAgent.md

File metadata and controls

165 lines (121 loc) · 6.38 KB

WinAgent

 

Deprecation warning! Данный интерфейс более не развивается и будет удален в будущих версиях приложения. Если вы его используете, вам необходимо реализовать взаимодействие через коннектор http

 

WinAgent – сервис создания отчётов MS Word и Excel, работающий по протоколу HTTP. Для его работы на выделенной машине под управлением Windows должен быть установлен сам сервис и MS Office, включающий пакеты Word и Excel. WinAgent принимает на вход отчёты из Optimacros и файл MS Word или MS Excel с макросом (расширение docm или xlsm) и запускает макрос. Макрос должен заранее знать, где будут располагаться входящие файлы. Он будет автомагически располагать в шаблоне данные этих файлов в зависимости от задачи.

Все интерфейсы этого раздела находятся в пространстве имён WinAgent.

Интерфейс WinAgentBuilder

interface WinAgentBuilder {
	setCommandUrl(url: string): this;
	setDownloadUrl(url: string): this;
	auth(): Http.HttpAuth;
	setConnectTimeout(sec: number): this;
	setRequestTimeout(sec: number): this;
	setOperationTimeout(sec: number): this;
	makeRunMacrosAction(): RunMacroAction;
}

Интерфейс, реализующий шаблон проектирования строитель, для настройки доступа к WinAgent.

 

setCommandUrl(url: string): this;

Устанавливает URL агента, на который будут подаваться команды из скрипта. Возвращает this.

 

setDownloadUrl(url: string): this;

Устанавливает URL, по которому можно будет скачивать результирующие документы. Возвращает this.

 

auth(): Http.HttpAuth;

Возвращает интерфейс Http.HttpAuth доступа к настройкам аутентификации WinAgent.

 

setConnectTimeout(sec: number): this;

Устанавливает таймаут ожидания соединения по HTTP в секундах. Значение по умолчанию: 10. Возвращает this.

 

setRequestTimeout(sec: number): this;

Устанавливает таймаут ожидания ответа от внешнего ресурса в секундах. Значение по умолчанию: 600. Возвращает this.

 

setOperationTimeout(sec: number): this;

Устанавливает таймаут ожидания WinAgent'ом исполнения макроса VBA в секундах. Значение по умолчанию: 150. Возвращает this.

 

makeRunMacrosAction(): RunMacroAction;

Возвращает интерфейс RunMacroAction настройки и запуска макроса.

 

Интерфейс BaseAction

interface BaseAction {
	run(): BaseActionResult;
}

Базовый интерфейс действия.

 

run(): BaseActionResult;

Выполняет действие и возвращает базовый интерфейс BaseActionResult доступа к данным его результата.

 

Интерфейс RunMacroAction

interface RunMacroAction extends BaseAction {
	setMacroName(macroName: string): this;
	setMacroFilePath(macroFilePath: string): this;
	setDataFilePaths(dataFilePaths: string[]): this;
	run(): RunMacroActionResult;
}

Интерфейс, реализующий шаблон проектирования строитель, для настройки запуска макроса. Наследуется от BaseAction.

 

setMacroName(macroName: string): this;

Устанавливает имя макроса. Значение по умолчанию: 'process'. Возвращает this.

 

setMacroFilePath(macroFilePath: string): this;

Устанавливает имя файла с макросом. Возвращает this.

 

setDataFilePaths(dataFilePaths: string[]): this;

Задаёт массив входных файлов с данными для макроса. Возвращает this.

 

run(): RunMacroActionResult;

Запускает макрос и возвращает интерфейс RunMacroActionResult доступа к данным его результата.

 

Интерфейс BaseActionResult

interface BaseActionResult {
}

Базовый интерфейс результата действия. Он пустой.

 

Интерфейс RunMacroActionResult

interface RunMacroActionResult extends BaseActionResult {
	getFilePaths(): string[];
}

Интерфейс доступа к данным результата выполнения макроса. Наследуется от BaseActionResult.

 

getFilePaths(): string[];

Возвращает список имён результирующих файлов.

 

API Reference

Оглавление