Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.


Name

Description

TypeMandatory field

Parameters






ContextContext for working with a tabular document via ONLYOFFICE.Robin.OnlyOfficeCellYes
Macro Path

Path to the js file that contains the JS code for the macro

Acceptable file extension

Запустить внешний макрос Редактор таблиц Версия 1 (Python)

Группа действий: ONLYOFFICE

Описание

Действие запускает в документе макрос, JS-код которого указан в отдельном файле.

Для работы с действием должно быть установлено приложение ONLYOFFICE.

Действие запускает макрос, указанный в отдельно файле формата .js. Язык, на котором написан макрос, должен быть JavaScript.

Примеры макросов - https://api.onlyoffice.com/plugin/macrosamples/

Более подробно  ознакомиться с работой приложения ONLYOFFICE Редактор таблиц можно в Руководстве пользователя https://helpcenter.ONLYOFFICE.com/ru/userguides/docs-se.aspx

Иконка

Image Removed

Настройка параметров и их настройка 

Входные параметры

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

  • Поле не нужно заполнять, если в макросе нет входных параметров
  • Поле нужно обязательно заполнить, если в макросе есть входные параметры
  • В коллекции должно быть ровно столько элементов, сколько входных параметров в макросе. Элементы, содержащие значения параметров, должны быть указаны в том же порядке, в котором соотв. параметры перечислены в коде макроса.

Название

Название 

Описание

Тип данныхОбязательное
КонтекстКонтекст для работы с табличным документом через ONLYOFFICE.Robin.OnlyOfficeCellДаПуть к макросу

Путь к файлу в формате js, который содержит JS-код макроса

Допустимое расширение файла: .js

Robin.FilePathДаYesПараметрыRobin.Collection НетТип результата
Parameters

Values for macro input parameters. Parameter values should be specified in the collection in the same order in which these parameters are listed in the macro code

  • The field does not need to be filled in if there are no input parameters in the macro
  • The field must be filled in if there are input parameters in the macro
  • There must be exactly as many elements in the collection as there are input parameters in the macro. Elements containing parameter values must be listed in the same order in which the corresponding parameters are listed in the macro code.
Robin.Collection No
Result type

The type of data that the macro should return as a result of its operation. If the macro does not return a result, this field can be left blank

  • Since the types in Onlyoffice do not coincide with our types, for correct conversion of the macro result it is necessary to specify what type of data we expect to get
  • Field in the form of a dropdown list

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

  • Т.к. типы в Onlyoffice не совпадают с нашими типами, для корректной конвертации результата макроса нужно уточнять, какой тип данных мы ожидаем получить
  • Поле в виде выпадающего списка
  • Доступные значения списка:
    • Строка
    • Число
    • Коллекция
    • Таблица
    • Макрос без результата
  • Значения списка на англ.:
  • Available list values:
      • String
      • Number
      • Collection
      • Table
      • Macro with no result
    • Значение по умолчанию- "Макрос без результата"
    • Если результат макроса - коллекция или таблица, то действие вернет их как коллекцию строк или таблицу со строковыми значениями, соответственно
    • Default value - “Macro with no result”
    • If the result of the macro is a collection or a table, the action will return them as a collection of rows or a table with string values, respectively
    • The action will not terminate with an error if “Macro with no result” is selected and the action returns a resultДействие не завершится с ошибкой, если выбрано "Макрос без результата", а действие возвращает результат.
Robin.StringНетNo

Выходные параметрыResults

РезультатResultThe value returned by the running macro. If the macro returns nothing, the result will be emptyЗначение, возвращаемое запущенным макросом. Если макрос ничего не возвращает, результат будет пустымRobin.Object

Особые условия

  1. При запуске действий ONLYOFFICE документ должен быть закрыт.

...

      4. Реализация полного цикла работы с таблицей должна содержать все 4 действия Редактора таблиц - "Открыть файл" -для начала работ с файлом, "Запустить внешний макрос." - для внесения изменений, "Сохранить файл" -для сохранения изменений и "Закрыть файл" по окончании работ с файлом.     

Пример использования 

Вариант1

Задача

Существует табличный документ: "Книга 1.xlsx". Необходимо открыть данный документ в ONLYOFFICE и внести изменения с помощью внешнего макроса

Решение

При запуске действий ONLYOFFICE документ должен быть закрыт.

...

Поэтому  пример реализации будет содержать все 4 действия. Красная точка является точкой останова, т.е. на том действии, на которое мы ее поставим, робот перейдет в режим остановка. Для продолжения будет необходимо нажать кнопку "Старт".

Реализация

1.Открыть группу действий "ONLYOFFICE".   

...

7. Нажать кнопку "Старт"..

Результат

Робот отработал успешно.



Вариант 2

Задача

Существует табличный документ: "Книга 1.xlsx". Необходимо открыть данный документ в ONLYOFFICE и внести изменения с помощью внешнего макроса без параметров

Решение

При запуске действий ONLYOFFICE документ должен быть закрыт.

...

Поэтому  пример реализации будет содержать все 4 действия. Красная точка является точкой останова, т.е. на том действии, на которое мы ее поставим, робот перейдет в режим остановка. Для продолжения будет необходимо нажать кнопку "Старт".

Реализация

1.Открыть группу действий "ONLYOFFICE".   

...

    • в параметре "Путь к макросу" указать путь к папке, где размещен макрос
    • в параметре "Тип результата", в выпадающем списке галочкой отметить выбранный тип

6. Для того, чтобы закрыть файл с изменениями, нужно последовательно воспользоваться действиями "Сохранить" и "Закрыть".

...

7. Нажать кнопку "Старт"..

Результат

Робот отработал успешно.

 

...