Configuration setting for Tentaculo consists in creating a configuration file in the json-format and then uploading it to Cerebro.

Uploading configuration

In order to upload a configuration file to Cerebro:

  1. open Administrator window (Main menu - Tools - Administrator...);
  2. go to Universe tab;
  3. go to Tentaculo section;
  4. in this section, click on Load the configuration setting from the file....

After the upload is completed, Tentaculo configuration will be available to all users in your universe.

Note:

In order to make sure that the configuration is correct, it is recommended to use the debug mode first.

Configuration setting

Tentaculo configuration customization consists of two parts:

  • configuring the file storage access protocol. To do this, you need to fill in two sections in the configuration file:
    - protocol – list of storage access protocols;
    - project_path – list of projects' root paths.
  • configuring the naming convention. To do this, you need to fill:
    - file_path – a task description list in Cerebro which match your file structure;
    - soft_folder (optional) – is an additional variable for structuring files and directories – depending on the local application in which the files are created. It is used in file_path to describe file paths;
    - trans_mode (optional) – this variable allows you to enable transliteration of file paths corresponding to tasks for each application in Cerebro;
    -case_mode (optional) – this variable allows you to define the character case in file paths.

Example of Configuration

Access protocol setting

Section protocol

The protocol variable allows you to configure file access protocols; note that different values ​​are possible depending on the application in which the plugin is launched.

Element structure:

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

The key is the internal name of one of the supported applications ("cerebro", "maya", "nuke", "houdini" и т.д.), and the value is a string containing a protocol name or a list of protocol names. The all key allows you to set the protocols for all possible programs at once, including Cerebro. If you need to specify an individual file access mode for any of the applications used, then you need to set your own protocol, different from the all one.

Note:

A value must be specified for the "cerebro" variable so that Cerebro application could independently determine which protocol it will use to access files. Otherwise, access to the file storage from Cerebro application will be denied. This is done to control access to your main file structure.

Possible protocol variable values for different applications:

  • network (default value) – used when working in the company's internal network; files are accessed directly in the network directory without being copied to the local directory;
  • local – used when working in the company's internal network; before file access is granted, files are copied to the local directory of the workstation;
  • cargador – used for remote work; access to files is granted via our Cargador service;
  • ftp – used for remote work; files can be accessed via the FTP protocol. Connection parameters are set by using a colon after the protocol name, for example, "ftp:ftp://mycompany.com";
  • "s3 – used for remote work, access to files occurs via S3 API, cloud storage (Amazon S3, Google Cloud Storage, Yandex.Cloud Object Storage, etc). Connection parameters are set by using a colon after the protocol name, for example, "s3:https://storage.yandexcloud.net/mycompany".

You can set one or more protocols for each application, including Cerebro. For example, you might have a network drive that is accessible both on the local network and via FTP. In this case, you can set two protocols:

"cerebro": ["network", "ftp:ftp://mycompany.com"]

Additionally, when trying to access files, the user will be able to choose the protocol that suits him best – depending on where the user is at the moment, whether it's the office or a remote location.

Section project_path

The project_path variable contains a list of elements that describe the root paths to project files:

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

Each of the elements describes possible file paths to the project's root directory and contains the following fields:

  • project_name –project name in Cerebro. If an empty string is specified as a value, then this structure contains default values ​​for all projects that are not described in other list structures;
  • task_activity – the name of the activity. If the path leading to the root directory depends on it. For example, files for different types of activities can be stored on different servers. An empty value also means that the described paths are by default applicable to tasks containing any kind of activity;
  • paths – a list of possible paths leading to the root directory, for example, for different operating systems. For example
"paths": 
[
"//server/projects", // for Windows
"/Volumes/projects", // for MacOs
"/server/projects", // for Linux
"/ftp_server/projects" // for FTP
]

The variables project_name and task_activity are, in fact, the key for task mapping in Cerebro, when files are either shared or downloaded. As for the paths variable, it determines where the files for this specific task should be located.

Note:

For cloud storages connected via S3 API, project_path, it is not required, since there are no folders in these storages, there are only tags imitating folders.

For Cargador storage, project_path it is not required, since the root access is determined by the storage itself.

Naming convention settings

Section file_path

The file_path variable contains a list of elements describing how tasks in different branches and projects match your file structure:

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

Each of the structures describes a set of subfolders and a file name template which are used to store file versions; and it contains the following fields:

  • folder_path – a formatted path in Cerebro to the beginning of the project branch (usually it is the name of the project or project section), where the rules described in this structure will be applied. If the value is an empty string, then this structure contains default values ​​for all projects and branches not described in other structures on this list;
  • task_activity – the name of the activity type, if file naming depends on it. An empty value also means that the described parameters automatically apply to any activity tasks.
  • name (required field) – a formatted file name, can also be a list, for example "$(task_name)_foo", "$(task_name)_bar". In case there is a list of names, the user will be given an opportunity to choose one of the names;
  • name_editable (by default false) – indicates the possibility to manually specify the file name when adding it to the task. Possible values: true, false.
  • publish – a formatted path to the directory containing the main published version of the file. It is not required in Cargador because this storage has its own directory structure for file storing.
  • version – a formatted path to the directory containing file versions. Not required for Cargador storage.
  • ver_prefix – an additional element in the numbered version of a file name;
  • ver_padding (by default 3) – describes the number of characters in the version number;
  • local (by default same as publish) – a formatted path to the directory containing the local version of the file;
  • publish_status – the task status name that will be used by default in the report publishing window.

The folder_path and task_activity variables are, in fact, the key for task mapping in Cerebro, when files are either shared or downloaded. The rest of the variables determine where the files for this task should be located.

If the value of the publish or version field is not specified, then when the file is sent to the storage, the main or the numbered version of the file respectively will not be created.

Formatted paths and names can contain the following substitute variables:

  • $(url[0]), $(url[1]) … $(url[i]) – the name of an individual element from the path to the selected task in Cerebro, where "i" is the nesting level of the element, starting from the project's root. For example, $(url[0]) is the name of the project, $(url[1]) is the name of the first level subtask, etc.;
  • $(soft_folder) – is an auxiliary variable which can be set in the soft_folder section, and which depends on the application used to create the files. It is used so that this variable can serve as a substitute in paths and file names;
  • $(task_name) – is the name of the selected task in Cerebro, i.e. the last element from the $(url[i]) list;
  • $(task_path) – is the path leading to the selected task in Cerebro; it consists of all $(url[i]) elements, including the last one;
  • $(task_parent_name) – is the name of the parent task in relation to the selected one;
  • $(task_parent_path) – is the path to the parent task in Cerebro.

In formatted strings, you can also use operating system's environment variables if their names do not match the variables listed above. Their application format is the same: $(VARIABLE_NAME).

Раздел soft_folder

The value of the soft_folder variable is set depending on the application in which the files are created.

Element structure:

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

The key in a set of paths is the internal name of one of the supported applications («maya», «nuke», «houdini» и т.д.), while the value is a string containing the variable value. It is used in the file_path section to specify file paths or file names, depending on the application in which the files are created.

Note:

Please, note that the keys do not list cerebro, since Cerebro application does not create files. When you share files using Cerebro application, the soft_folder value will be determined by the file extension corresponding to any of the supported applications.

Section trans_mode

The trans_mode variable allows you to enable transliteration of file paths corresponding to tasks in Cerebro – depending on the application in which the files are created or shared.

Element structure:

"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
}

Possible values: true, false. Transliteration is enabled by default.

When transliteration mode is enabled, all non-Latin characters in the file path are automatically converted to Latin characters, while spaces are converted into underscores («_»). For instance, instead of the /Project 01/Моделирование path, there will be used the /Project_01/Modelirovanie path.

Section case_mode

The case_mode variable allows you to define the character case of file paths which correspond to tasks in Cerebro – depending on the application in which the files are created or shared.

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

The possible values are "", "lowercase", "uppercase", "capitalize". The default is empty value.

Empty value means that the character case in file paths will match the case of the corresponding tasks in Cerebro.

<<Previous Next >>

Did this answer your question?