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

Старая версия 2

changes.mady.by.user lismaili@rpa-robin.ru

Сохранено

по сравнению с

Новая версия Текущий

changes.mady.by.user Рукобратская Анна

Сохранено

Ключ

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

...

Run external macro Version 1 (Python)

...

Action group: ONLYOFFICE

Описание

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

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

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

...

Description

The action launches a macro in the document, JS-code of which is specified in a separate file.

The ONLYOFFICE application must be installed to work with the action.

The action runs a macro specified in a separate .js file. The language in which the macro is written must be JavaScript.

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

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

Иконка

Image Removed

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

You can familiarize yourself with the operation of the ONLYOFFICE Table Editor application in the User Manual.

Action icon

Image Added

Settings of parameters

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


Name

Description

TypeMandatory field

Parameters






ContextContext for working with a tabular document via ONLYOFFICE

Название

Название 

Описание

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

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

Acceptable file extension

Путь к макросу

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

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

Robin.FilePathДаYes
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
  • Available list values
Тип результата

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

  • Т.к. типы в Onlyoffice не совпадают с нашими типами, для корректной конвертации результата макроса нужно уточнять, какой тип данных мы ожидаем получить
  • Поле в виде выпадающего списка
  • Доступные значения списка:
    • Строка
    • Число
    • Коллекция
    • Таблица
    • Макрос без результата
    • Значения списка на англ.
  • :
    • 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

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


Special conditions of use

  1. When running ONLYOFFICE actions, the document must be closed

...

  1. .

      2. Расширения файлов, которые может открыть действиеFile extensions that the action can open: .xlsx, .xls, ods.

      3. Для корректного запуска действий при работе с  ОС Windows необходимо добавить engПлагин ONLYOFFICEFor correct start of actions when working with actions of ONLYOFFICE group of Windows OS it is necessary to add ONLYOFFICE plugin.

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

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

Вариант1

Задача

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

Решение

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

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

Если мы хотим внести изменения в открытый файл, то сначала необходимо запустить действие "Внешний макрос", внести изменения в файл и запустить действие engСохранить Редактор таблиц .

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

Реализация

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

2. Для реализации робота собрать следующую схему робота:

Image Removed

3. Переместить на рабочую область студии действие "Открыть", предварительно разместив  файл для загрузки в одной из папок на компьютере.

4. Заполнить параметры действия "Открыть Редактор таблиц",  указав путь к файлу. Подробнее можно посмотреть тут: engОткрыть Редактор таблиц

Image Removed

5. Заполнить параметры действия "Запустить внешний макрос Редактор таблиц".

Image Removed 

Для этого нужно:

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

b. Последовательно заполнить поля "Контекст" (1), "Путь к макросу" (2), "Параметры"(3), "Тип результата"(4).

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

Image Removed

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

7. Для этого на схеме  необходимо кликнуть курсор на действие engСохранить Редактор таблиц , и заполнить поле "Параметры"  для этого действия. 

Image Removed

6. Заполнить параметры действия engЗакрыть  Редактор таблиц

Image Removed

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

Результат

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

 Image Removed

Вариант1

Задача

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

Решение

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

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

Если мы хотим внести изменения в открытый файл, то сначала необходимо запустить действие "Внешний макрос", внести изменения в файл и запустить действие engСохранить Редактор таблиц .

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

Реализация

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

2. Для реализации робота собрать следующую схему робота:

Image Removed

3. Переместить на рабочую область студии действие "Открыть", предварительно разместив  файл для загрузки в одной из папок на компьютере.

4. Заполнить параметры действия "Открыть Редактор таблиц",  указав путь к файлу. Подробнее можно посмотреть тут: engОткрыть Редактор таблиц

Image Removed

5. Заполнить параметры действия "Запустить внешний макрос Редактор таблиц".

Image Removed

Для этого нужно:

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

b. Последовательно заполнить поля "Контекст" (1), "Путь к макросу" (2), "Параметры"(3), "Тип результата"(4).

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

Image Removed

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

7. Для этого на схеме  необходимо кликнуть курсор на действие engСохранить Редактор таблиц , и заполнить поле "Параметры"  для этого действия. 

Image Removed

6. Заполнить параметры действия engЗакрыть  Редактор таблиц

Image Removed

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

Результат

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

 Image Removed

Вариант2

Задача

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

Решение

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

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

Если мы хотим внести изменения в открытый файл, то сначала необходимо запустить действие "Внешний макрос", внести изменения в файл и запустить действие engСохранить Редактор таблиц .

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

Реализация

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

2. Для реализации робота собрать следующую схему робота:

Image Removed

3. Переместить на рабочую область студии действие "Открыть", предварительно разместив  файл для загрузки в одной из папок на компьютере.

4. Заполнить параметры действия "Открыть Редактор таблиц",  указав путь к файлу. Подробнее можно посмотреть тут: engОткрыть Редактор таблиц

Image Removed

5. Заполнить параметры действия "Запустить внешний макрос Редактор таблиц".

Image Removed

Для этого нужно:

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

b. Последовательно заполнить поля "Контекст", "Путь к макросу", "Тип результата".

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

Image Removed

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

7. Для этого на схеме  необходимо кликнуть курсор на действие engСохранить Редактор таблиц , и заполнить поле "Параметры"  для этого действия. 

Image Removed

6. Заполнить параметры действия engЗакрыть  Редактор таблиц

Image Removed

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

Результат

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

 

 

 

Realization of the full cycle of work with the table should contain all 4 actions of the Table Editor - "Open" - to start working with the file, "Run external macro". - to make changes, "Save" - to save changes and "Close" at the end of work with the file. 

Example of use

Option 1

Task

There is a tabular document: "Book 1.xlsx". It is necessary to open this document in ONLYOFFICE and make changes using an external macro.

Solution

When running ONLYOFFICE actions, the document must be closed.

In order to open a document it is necessary to build and run the robot, having filled in its parameters beforehand.

If we want to make changes to an open file, we must first run the "Run external macro" action, make changes to the file and run the Save (ONLYOFFICE) action.

Therefore, the example implementation will contain all 4 actions. The red dot is a breakpoint, i.e. the robot will enter the stop mode at the action we set it to. To continue, it will be necessary to click the "Start" button.

Implementation

1. Open the ONLYOFFICE action group.   

2. Assemble a robot scheme consisting of actions:

Image Added

3. Move the "Open" action to the Studio workspace, having previously placed the file to load in one of the folders on your computer.

4. Set the parameters of the "Open" action by specifying the path to the file. You can see more details here: Open (ONLYOFFICE)

Image Added

5. Set the parameters of the "Run external macro" action.

Image Added 

This is to:

a. Create a folder on your computer where the macros and the source file will be placed.

b. Consecutively fill in the fields "Context" (1), "Macro Path" (2), "Parameters"(3), "Result type"(4).

    • in the "Macro Path" parameter specify the path to the folder where the macro is placed
    • in the "Parameters" parameter specify the number of records and specify their value, if necessary
      Image Added
  •  
    • in the "Result type" parameter, check the selected type in the dropdown list

Image Added

6. In order to close the file with changes, you need to use the "Save" and "Close" actions in sequence.

7. To do this, you must click on the Save (ONLYOFFICE) action on the scheme, and fill in the Parameters field for this action. 

Image Added

6. Set the parameters of the action Close (ONLYOFFICE)

Image Added

7. Launch the robot using the "Start" button in the top panel.

Result

The program robot completed successfully.

Image Added


Option 2

Task

There is a tabular document: "Book 1.xlsx". It is necessary to open this document in ONLYOFFICE and make changes using an external macro without parameters

Solution

When running ONLYOFFICE actions, the document must be closed.

In order to open a document it is necessary to build and run the robot, having filled in its parameters beforehand.

If we want to make changes to an open file, we must first run the action "Run external macro", make changes to the file and run the action

Therefore, the example implementation will contain all 4 actions. The red dot is a breakpoint, i.e. the robot will go to the stop mode on the action on which we put it. To continue, it will be necessary to press the "Start" button.

Implementation

1. Open the ONLYOFFICE action group.     

2. Assemble a robot scheme consisting of actions:

Image Added

3. Move the "Open" action to the Studio workspace, having previously placed the file to load in one of the folders on your computer.

4. Set the parameters of the "Open" action by specifying the path to the file. You can see more details here: Open (ONLYOFFICE)

Image Added

5. Set the parameters of the "Run external macro" action.

Image Added

This is to:

a. Create a folder on your computer where the macros and the source file will be placed.

b. Consecutively fill in the fields "Context" (1), "Macro Path" (2), "Parameters"(3), "Result type"(4).

    • in the "Macro Path" parameter specify the path to the folder where the macro is placed
    • in the "Result type" parameter, check the selected type in the dropdown list.

Image Added

6.  In order to close the file with changes, you need to use the "Save" and "Close" actions in sequence.

7. To do this, you must click on the Save (ONLYOFFICE) action on the scheme, and fill in the Parameters field for this action. 

Image Added

6. Set the parameters of the action Close (ONLYOFFICE)

Image Added

7. Launch the robot using the "Start" button in the top panel.

Result

The program robot completed successfully.

 Image Added

...