Настройка конфигурации для Tentaculo заключается в создании конфигурационного файла формата json и последующей загрузки его в Cerebro.

Загрузка конфигурации

Для того чтобы загрузить конфигурационный файл в Cerebro:

  1. откройте окно Администратор (Главное меню - Инструменты - Администратор...);
  2. перейдите на вкладку Вселенная;
  3. перейдите в раздел Tentaculo;
  4. в данном разделе нажмите кнопку Загрузить конфигурацию из файла.

После загрузки конфигурация Tentaculo будет доступна всем пользователям вашей вселенной.

Примечание:

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

Настройка конфигурации

Настройка конфигурации Tentaculo состоит из следующих частей:

  • настройка протокола доступа к файловому хранилищу. Для этого необходимо в конфигурационном файле заполнить два раздела:
    - protocol – перечень протоколов доступа к хранилищу;
    - project_path (обязательный параметр) – перечень корневых путей до проектов.
  • настройка соглашения по именованию. Для настройки соглашения об именовании в конфигурационном файле заполнить следующие разделы:
    - file_path (обязательный параметр)– перечень описаний соответствия задач в Cerebro с вашей файловой структурой;
    - soft_folder – дополнительная переменная, для возможности структурирования файлов и директорий в зависимости от рабочего приложения, в которой создаются файлы. Применяется в file_path в описании файловых путей;
    - trans_mode – переменная позволяет включить транслитерацию файловых путей, соответствующих задачам в Cerebro для каждого приложения;
    - case_mode – переменная позволяет определить регистр символов в путях к файлам;
  • расширение возможностей Tentaculo:
    - processors - определяет набор Python-скриптов, дополнительно выполняемых при совершении действий в плагине (см. раздел Процессоры);

Примеры конфигурации.

Настройка протокола доступа

Раздел protocol

Переменная protocol позволяет задать протоколы доступа к файлам, причем возможны различные значения в зависимости от приложения, в котором запускается плагин.

Структура элемента:

"protocol": 
{
all: []
"cerebro": [],
"maya": "",
"nuke": "",
"houdini": "",
"blender": "",
"cinema4d": "",
"3dsmax": "",
"katana": "",
"revit": "",
"autocad": "",
"tbharmony": "",
"photoshop": "",
"aftereffects": "",
"indesign": "",
"illustrator": "",
"animate": "",
"premiere": ""
}

В качестве ключа выступает внутреннее название одного из поддерживаемых приложений ("cerebro", "maya", "nuke", "houdini" и т.д.), а значением является строка с названием или списком названий протоколов. Использование ключа all позволяет задать протоколы сразу для всех возможных программ, включая Cerebro. В случае, если для какого-либо из используемых приложений требуется указать индивидуальный способ доступа к файлам, то необходимо задать свой протокол, отличный от all.

Примечание:

Обязательно должно быть указано значение для переменной "cerebro", чтобы приложение Cerebro самостоятельно определяло по какому протоколу оно будет получать доступ к файлам. В противном случае доступ к файловому хранилищу из приложения Cerebro будет запрещен. Сделано это в целях контроля доступа к вашей основной файловой структуре.

Возможные значения переменной protocol для того или иного приложения:

  • network (значение по умолчанию) – для работы во внутренней сети компании, происходит доступ к файлам непосредственно в сетевом каталоге без копирования в локальную директорию;
  • local – для работы во внутренней сети компании, перед обращением к файлам происходит их копирование в локальную директорию на рабочей станции;
  • cargador – для удаленной работы, доступ к файлам происходит через нашу службу Cargador;
  • ftp – для удаленной работы, доступ к файлам происходит через протокол FTP. Параметры для соединения задаются через двоеточие после имени протокола, например, "ftp:ftp://mycompany.com";
  • s3 – для удаленной работы, доступ к файлам происходит посредством S3 API, с облачным хранилищем (Amazon S3, Google Cloud Storage, Яндекс.Облако Объектное Хранилище и другими). Параметры для соединения задаются через двоеточие после имени протокола, например, "s3:https://storage.yandexcloud.net/mycompany".

Для каждого приложения, включая Cerebro, можно задать один или несколько протоколов. Например, у вас может быть сетевой диск, который доступен и в локально сети и по FTP. В таком случае вы можете задать два протокола:

"cerebro": ["network", "ftp:ftp://mycompany.com"]
При этом пользователь, при попытке доступа к файлам сможет выбрать, подходящий ему протокол, в зависимости от того, где он находится - в офисе или удаленно.

Раздел project_path

Обязательная переменная project_path содержит список из элементов, описывающих корневые пути до проектных файлов:

"project_path": 
[
{
"project_name": "",
"task_activity": ""
"path": []
}
]

Каждый из элементов описывает возможные файловые пути до корневой директории проекта и содержит следующие поля:

  • project_name – имя проекта в Cerebro. Если в качестве значения задана пустая строка, то данная структура содержит значения по умолчанию для всех проектов, не описанных в остальных структурах списка;
  • task_activity – название вида деятельности, от которого зависит путь до корневой директории. Например, файлы для разных видов деятельности могут храниться на разных серверах.
    Пустое значение также означает, что описанные пути применимы по умолчанию к задачам с любым видом деятельности;
  • path – список возможных путей до корневой директории, например, для различных операционных систем. Например:
"paths": 
[
"//server/projects", // for Windows
"/Volumes/projects", // for MacOs
"/server/projects", // for Linux
"/ftp_server/projects" // for FTP
]

Переменные project_name и task_activity, по сути, являются ключом для сопоставления задачи в Cerebro, в которой выкладываются или скачиваются файлы. А переменная paths определяет, где должны находится файлы для этой задачи.

Примечание:

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

Для хранилища Cargador project_path не требуется, поскольку в корневой доступ определяется самим хранилищем.

Настройки соглашения об именовании

Раздел file_path

Переменная file_path содержит список из элементов, описывающих соответствия задач в разных ветках и проектах с вашей файловой структурой:

"file_path": 
[
{
"folder_path": "",
"task_activity": "",
"name": "",
"name_editable": false,
"publish": "",
"version": "",
"ver_prefix": "",
"ver_padding": "",
"local": "",
"publish_status": ""
}
]

Каждая из структур описывает набор вложенных папок и шаблон имени файла, применяемые для хранения версий файлов, и содержит следующие поля:

  • folder_path – форматированный путь в Cerebro до начала ветки проекта (обычно название проекта или раздела в проекте), в которой будут применяться правила, описанные в данной структуре. Если в качестве значения задана пустая строка, то данная структура содержит значения по умолчанию для всех проектов и веток, не описанных в остальных структурах списка;
  • task_activity – название вида деятельности, если от него зависит именование файлов. Пустое значение также означает, что описанные параметры применимы по умолчанию к задачам с любым видом деятельности.
  • name (обязательное поле) – форматированное имя файла. Определяет правило именования публикуемых файлов. Может быть списком, например ["$(task_name)_foo", "$(task_name)_bar"], в данном случае пользователю будет дана возможность выбрать одно из имен;
  • name_editable (по умолчанию false) – признак возможности задать вручную имя файла при его добавлении к задаче. Возможные значения: true, false.
  • publish – форматированный путь до директории, содержащей основную опубликованную версию файла. Не требуется для хранилища Cargador, т.к. оно имеет собственную структуру директорий для хранения файлов.
  • version – форматированный путь до директории с версиями файла. Не требуется для хранилища Cargador.
  • ver_prefix – добавочный элемент в имени файла нумерованной версии, который задает дополнительный префикс для версионных файлов и указывается между базовым названием файла и номером версии (напр. file_ver001).
  • ver_padding (по умолчанию 3) – количество знаков в номере версии;
  • local (по умолчанию совпадает с publish) – форматированный путь до директории, содержащей рабочую версию (local version) файла;
  • publish_status – имя статуса задачи, который будет предлагаться по умолчанию в окне публикации отчета.

Переменные folder_path и task_activity, по сути, являются ключом для сопоставления задачи в Cerebro, в которой выкладываются или скачиваются файлы. А остальные переменные определяют, где должны находится файлы для этой задачи.

Если не задано значение поля publish или version, то при отправке файла в хранилище не будет создана, соответственно, основная или нумерованная версии файла.

Любые составляющие переменной file_path могут содержать следующие подставляемые переменные:

  • $(url[0]), $(url[1]) … $(url[i]) – имя отдельного элемента из пути до выбранной задачи в Cerebro, где i – уровень вложенности элемента, начиная от корня проекта. Например, $(url[0]) – имя проекта, $(url[1]) – имя подзадачи первого уровня и т.д.
  • $(soft_folder) – вспомогательная переменная, задается в разделе soft_folder и зависит от приложения, в котором создаются файлы. Используется для того, чтобы в путях и именах файлов можно было подставлять эту переменную.
  • $(task_name) – название выбранной задачи в Cerebro, т.е. последний элемент из перечня $(url[i]);
  • $(task_path) – путь до выбранной задачи в Cerebro, состоит из всех элементов $(url[i]), включая последний;
  • $(task_parent_name) – название родительской задачи по отношению к выбранной;
  • $(task_parent_path) – путь до родительской задачи в Cerebro.

Возможно вырезать только часть переменной, используя синтаксис $(var[i:j]), где i и j - начальный и конечный индекс в строке. Напр.:

$(soft_folder) = ‘maya’

$(soft_folder[0:2]) = ‘ma’

В форматированных строках можно также использовать переменные окружения операционной системы, если их названия не совпадают с перечисленными выше переменными. Формат их использования такой же: $(VARIABLE_NAME).

Раздел soft_folder

Опциональная переменная soft_folder определяет значение одноименного подменяемого параметра в зависимости от приложения, в котором используется плагин.

Структура элемента soft_folder:

"soft_folder":
{
"maya": "",
"nuke": "",
"houdini": "",
"blender": "",
"cinema4d": "",
"3dsmax": "",
"katana": "",
"revit": "",
"autocad": "",
"tbharmony": "",
"photoshop": "",
"aftereffects": "",
"indesign": "",
"illustrator": "",
"animate": "",
"premiere": ""
}

В качестве ключа в наборе путей выступает внутреннее название одного из поддерживаемых приложений («maya», «nuke», «houdini» и т.д.), а значением является строка со значением переменной. Используется в разделе file_path для уточнения путей или имен файлов в зависимости от приложения, в котором создаются файлы.

Примечание:

Обратите внимание, что в ключах отсутствует cerebro, поскольку само приложение Cerebro не создает файлов. При выкладывании файлов из приложения Cerebro, значение soft_folder будет определяться по разрешению файла, соответствующего какому-либо из поддерживаемых приложений.

Раздел trans_mode

Переменная trans_mode позволяет включить транслитерацию файловых путей, соответствующих задачам в Cerebro, причем в зависимости от приложения, в котором создаются или выкладываются файлы.

Структура элемента trans_mode:

"trans_mode": 
{
"cerebro": true
"maya": true,
"nuke": true,
"houdini": true,
"blender": true,
"cinema4d": true,
"3dsmax": true,
"katana": true,
"revit": true,
"autocad": true,
"tbharmony": true,
"photoshop": true,
"aftereffects": true,
"indesign": true,
"illustrator": true,
"animate": true,
"premiere": true
}

Возможные значения: true, false. По умолчанию транслитерация включена.

При включенном режиме транслитерации все буквы не латинского алфавита, содержащиеся в файловом пути, автоматически преобразуются в латиницу, а также пробелы преобразуются в знаки подчеркивания («_»). Например, вместо пути /Project 01/Моделирование будет использован путь /Project_01/Modelirovanie.

Раздел case_mode

Переменная case_mode позволяет определить регистр букв файловых путей, соответствующих задачам в Cerebro, причем в зависимости от приложения, в котором создаются или выкладываются файлы.

"case_mode":
{
"cerebro": ""
"maya": "",
"nuke": "",
"houdini": "",
"blender": "",
"cinema4d": "",
"3dsmax": "",
"katana": "",
"revit": "",
"autocad": "",
"tbharmony": "",
"photoshop": "",
"aftereffects": "",
"indesign": "",
"illustrator": "",
"animate": "",
"premiere": ""
}

Возможные значения: "", "lowercase", "uppercase", "capitalize". Если значение не указано это означает, что регистр букв в файловых путях будет повторять регистр соответствующих задач в Cerebro.

Раздел processor

Опциональная переменная processors определяет набор python - скриптов, дополнительно выполняемых при совершении действий в плагине, таких как открытие файла, создание нового файла в задаче, сохранение версии, публикация отчёта (см. раздел Процессоры) и тп.

<< Назад Вперед >>

Вы нашли ответ?