Soko documentation

Explore

Project templates

Folder structure settings

Folder objects

Folder Objects help managers organize and structure projects efficiently. Tasks can be grouped into multiple folders to enhance the overall project organization. These folders can be either Generic Folders or Custom Folder Objects, such as sequences, shots, or assets.

Custom folders make it easy to filter and manage specific types of folder objects across multiple folders. For example, you can filter and view all shots within all sequences. You can also define types for each folder object. For example, the Asset folder can have types such as Character, Prop, Environment, and so on.

To add a new Folder Object to the project template:

Click the “+” icon next to the Soko Folder Object group.

Select the desired folder object.

Click Assign to include it in the project template.

⁠

If the desired Folder Object is not already defined as an

enumerator⁠

, a “+” icon will appear next to the search area. Clicking on this icon opens a new window where you can input the required details, such as:

Short Name

Icon

Screen Priority

Color

Additionally, you can specify whether the folder object is Typeable or not. Once all the information is filled out, click Create, and the new Folder Object will be added.

⁠

Local Storage Directory Structure

In the Local Storage Directory Structure group, you can define the directory structure that will be created on your local storage when a Soko project is created. This feature is available only when creating a new project via the Soko Desktop app, not through a web browser.

Folders and files for work files, published inputs, and outputs are created based on Path Templates. Local Storage Directory Structure folders are created at the beginning of the project and can be used to store temporary files or files from the client that you do not want to publish to Soko.

By defining this structure, you ensure that every project follows a consistent folder organization, keeping all projects uniformly organized.

When you hover over a specific folder, you can:

Duplicate it

Delete it

Create a subfolder

After defining the directory structure, make sure to save it by clicking on the “Save” icon.

⁠

Roots

In the Roots group, you can define root folder paths for your projects. These paths determine where every new project using this template will be created. They are also used when setting up Path Templates for Work Files or Published Files.

To configure a root path, you need to specify:

A Name for the root folder.

The Path where project files will be stored.

You also have the option to define different paths for different operating systems to accommodate cross-platform workflows.

If you need project files stored in multiple locations (e.g., work files on one storage and published files on another), you can add additional root paths by clicking the “+” icon [3].

⁠

Path templates

In the Path Templates group, you can find all options related to Work and Publish files. You can define where these files will be stored and specify their naming conventions.

Soko is compatible with the Ayon pipeline tool. You can toggle between the Ayon and Soko naming conventions by clicking the Convention Switch button[1].

⁠

General variables

General variables such as Version Padding[1], Version Start[2], or Frame Padding[3] can be used in Path Templates.

⁠

Version padding

Version padding refers to the addition of leading zeros to a version number to ensure a consistent length.

For example:

001 has a padding of 3 because the number is formatted with three digits.

05 has a padding of 2 because it uses two digits.

Version start

Version Start defines the number used for the first version. Typically, the number 1 is used, but some companies prefer to start with 0. In such cases, the first version will be v000 instead of v001.

Frame padding

Frame Padding refers to the addition of leading zeros to a frame number to ensure a consistent length.

Version and Frame template

Version template and frame template can be used in Publish and Work files and in file templates.

Naming convention is based on python syntax. For example we would like to have version padding 3 and each version will start with character “v” that is “v001” for the first version. We used this Version template v{version:0>3}

“v” - is text “v”

“version” is the actual version number

“:0” - This is a fill character. In this case, 0 is used to indicate that the empty spaces in the resulting string should be filled with zeros.

">" This is the alignment specifier. It specifies that the string should be right-aligned within the specified width.

“3”: This is the width specifier. It specifies the minimum width of the resulting string

Work files

In the Work Files group, you can specify where the work files will be created.

In the Directory Template, define the path to the directory where the work file will be created.

In the File Name Template, set the naming convention for the file name.

For more information about the keys and variables you can use in the directory and file templates, refer to the

Path Naming Convention⁠

page.

⁠

Output name

In the Output Name, you specify the name of the published output. Different Output Names can be used for different Output Types. For example, you can add the prefix “render” for a render outputs.

Additional options allow you to create different output names based on:

The application you are publishing from (for Ayon pipeline only).

The task type.

The task name.

To add a new Output Profile, click the “+” icon located on the left of the Output Name header.

⁠

You can view the Output Name in the side panel under the Output tab. All versions of a specific output are stored within the Output Name group. The Output Name is also displayed in the Version View table.

⁠

Publish

In the Publish group, you can specify where the publish files will be created.

In the Directory Template, define the path to the directory where the publish file will be created.

In the File Name Template, set the naming convention for the file name.

For more information about the keys and variables you can use in the directory and file templates, refer to the

Path Naming Convention⁠

page.

⁠

Main

In the Main group, you can specify where the main version of published files will be created.

In the Directory Template, define the path to the directory where the main file will be stored.

In the File Name Template, set the naming convention for the main file name.

⁠

The Main File represents a copy of the published version without a version number. This is useful for smaller projects where you want to "automatically" update reference files, for example, in Nuke or Maya. Instead of using versioned files directly, you can import the main version. In the Soko Side Panel or Versions Table, you can select which version should be marked as the main. Each time the main version is updated, the old main version is deleted and replaced by the new one.

Warning: While this approach may seem convenient, it is not recommended for larger projects where maintaining consistency and tracking input data is critical. Using a single main version can cause issues if you need to revert to a specific version, as you may lose track of the input file versions used to create it. Only one main version exists at any given time, which can lead to inconsistencies in larger workflows.

⁠

Delivery

In the Delivery group, you can specify delivery locations for published files.

In the Directory Template, define the path to the directory where the published files will be copied.

In the File Name Template, set the naming convention for the file name.

⁠

Out of the box, Soko includes the Copy to Dailies action. When this action is run on a selected version, the files from that version are copied to a location defined by the Dailies Delivery Template. You can adjust the dailies location as needed.

⁠

Other

In the Other group, you can specify additional locations based on your requirements.

⁠

Out of the box, there is a Browse Location defined, which specifies the folder that opens when you click the Browse icon in the project directory tree, a path element in the project table, the side panel, or in the Review or User View.

⁠

Want to print your doc?
This is not the way.

Try clicking the ⋯ next to your doc name or using a keyboard shortcut (

CtrlP

) instead.