pyrus-sync:register:export-settings

Настройки экспорта

Конфигурация экспорта в Pyrus Sync задается в формате JSON. Это текстовый формат хранения и передачи структурированных данных.

Условия и правила настройки

  • Все поля как в шаблоне формы Pyrus, для которой вы настраиваете экспорт, так и в файле CSV, должны иметь уникальные названия. Учтите, что пробелы в начале и в конце названия система не учитывает, а регистр — учитывает (названия полей «Счет» и «счет» считаются разными).
  • Для настройки интеграции вам потребуются права руководителя формы. Для запуска уже настроенного экспорта достаточно приложения Pyrus Sync и статуса участника формы.
  • Механизм экспорта умеет выгружать поля типа файл. Однако файлы, приложенные к задаче вне полей формы, экспортировать нельзя.

Формат конфигурации

Обмен данными между Pyrus и файлом CSV настраивается в окне конфигурации.

  • Name – обязательное поле; название конфигурации. Например:

    "Name": "Export Согласование расходов",

  • Path – обязательное поле; путь, куда будет сохранен CSV файл с результатами экспорта:

    "Path": "C:\\pyrus",

  • Delimiter – необязательное поле; символ-разделитель колонок для файлов CSV. Если не указано, определяется автоматически, в зависимости от настроек компьютера. В российской локали это «;».

    "Delimiter": ";",

  • Encoding – необязательное поле; кодировка CSV файла. Если не указано, используется CP1251. Полный список можно найти здесь. К примеру, смена кодировки на UTF-8 выглядит так:

    "Encoding": "utf-8",

  • ShowUserIds – необязательное поле; список ID пользователей, которые видят настроенные конфигурации и могут запускать экспорт. Если не указано, экспорт могут запускать все участники проекта. Менеджер проекта может запускать экспорт всегда, даже если его ID не указан. Чтобы задать, кто из сотрудников сможет запускать экспорт, укажите их ID через запятую, например:

    "ShowUserIds": [123183, 123193],
Узнать ID пользователя можно в адресной строке, в режиме поиска по его имени.

  • ExportSettings – необязательное поле; правила экспорта.
  • ExportRules – необязательное поле; условия обработки задач. У каждого условия есть два обязательных элемента: список условий (Conditions) и правила отображения (ColumnMap).

Настройка правил экспорта в разделе ExportSettings

  • ScheduleUserIds – необязательное поле; список ID пользователей для запуска экспорта по расписанию. Перечислите через запятую ID тех сотрудников, от имени которых нужно запускать экспорт. Если ID не указаны, экспорт по расписанию запускается от имени всех пользователей. Допустим, для какой-то формы вы настроили экспорт по расписанию и не указали параметр ScheduleUserIds. Если, например, три сотрудника запустили Pyrus Sync и у них есть доступ в эту форму, у всех троих будет запущен экспорт по расписанию.
  • ScheduledTime – необязательное поле; время запуска по расписанию. Указывается в кавычках, минуты от часов отделяются двоеточием. Например, “12:24”.
  • ScheduledPeriod – необязательное поле; запуск каждые N минут (N- целое число). Например, если синхронизация требуется каждые 15 минут писать следует :15, без кавычек. Если указано расписание, ScheduledTime, то это поле система проигнорирует.
  • ScheduleResultUser – необязательное поле; определяет, кого система оповестит о результатах выгрузки. По умолчанию сообщение получит тот пользователь, под чьим аккаунтом в Pyrus Sync настраивался экспорт.
  • StepNo – необязательное поле; номер этапа. Если указано, то экспортируются только формы, находящиеся на определенном этапе, иначе - все формы.
  • ApproveAfterExport: true – необязательное поле. Если указано, после экспорта Pyrus Sync проставит от своего имени согласование в задаче. Если все пользователи текущего этапа уже согласовали задачу, она перейдет на следующий этап.
  • CloseAfterExport: true – необязательное поле. Если указано, Pyrus Sync закроет задачу после экспорта при условии, что пользователь, под чьим аккаунтом запущен Pyrus Sync, обладает правом закрывать задачи по этой форме.
  • FileName – шаблон имени файла для сохранения результата выгрузки. По умолчанию - строка, состоящая из названия формы, имени пользователя, даты и времени экспорта с расширением «.csv»

Настройка условий обработки задач при экспорте, ExportRules

Если требуется экспортировать задачи, только подходящие под определенные критерии или, например, осуществить экспорт разных видов для разных типов задач, нужен этот раздел. У каждого правила (ExportRules) есть два обязательных элемента: список условий (Conditions) и правила отображения (ColumnMap). Если в форме есть поле типа Таблица, то правила экспорта будет применяться сначала для задачи с таким полем в целом, а потом для каждой строки таблицы.

Элемент Conditions

  • PyrusField – обязательное, название поля в форме.
  • Values - обязательное, список значений PyrusField.
  • IsNotNull: true – правило применяется, если поле PyrusField заполнено.

Элемент ColumnMap Здесь указывается список колонок, которые должны войти в файл выгрузки. Можно также настроить, из какого поля Pyrus в какую колонку CSV файла будут писаться данные. Если раздел присутствует, список должен содержать не менее одного элемента. Важно помнить, что последним элементом списка должен быть ColumnMap[]. Иначе в экспорт войдут не все нужные данные.

  • PyrusField – название поля формы.
  • CsvColumn – название соответствующей ему колонки в CSV файле. Если это поле не указано, то название колонки в файле будет совпадать с значением PyrusField.

Возникли вопросы? Мы всегда рядом, чтобы помочь.

СВЯЖИТЕСЬ С НАМИ

8 800 555-69-55
бесплатно по России

+7 495 980-13-11
для звонков из других стран