Skip to content
This repository has been archived by the owner on Sep 20, 2024. It is now read-only.

Commit

Permalink
change instance to subset and fix some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
mkolar committed May 7, 2021
1 parent 073f9a1 commit ea8f093
Showing 1 changed file with 25 additions and 24 deletions.
49 changes: 25 additions & 24 deletions website/docs/project_settings/settings_project_global.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,39 +13,40 @@ Project settings can have project specific values. Each new project is using stu
Projects always use default project values unless they have [project override](../admin_settings#project-overrides) (orage colour). Any changes in default project may affect all existing projects.
:::

## Publish plugins

Publish plugins used across all integrations.
## Profile filters

**Profile filters**
Many of the settings are using a concept of **Profile filters**

Many of the plugins are using a concept of **Profile filters**

You can define multiple profiles to choose from for different contexts. Each filter is evaluated for a profile and
You can define multiple profiles to choose from for different contexts. Each filter is evaluated and a
profile with filters matching the current context the most, is used.

You can define profile without filters and use it as **default**.
You can define profile without any filters and use it as **default**.

Only **one or none** profile will be returned per instance.
Only **one or none** profile will be returned per context.

All context filters are lists which may contain strings or Regular expressions (RegEx).
- **`hosts`** - Host from which publishing was triggered. `["maya", "nuke"]`
- **`families`** - Main family of processed instance. `["plate", "model"]`
- **`tasks`** - Task of processed instance. `["modeling", "animation"]`
- **`families`** - Main family of processed subset. `["plate", "model"]`
- **`tasks`** - Currently processed task. `["modeling", "animation"]`

:::important Filtering
Filters are optional. In case when multiple profiles match current context, profile with higher number of matched filters has higher priority that profile without filters.
(Eg. order of when filter is added doesn't matter only precision of matching does.)
(Eg. order of when filter is added doesn't matter, only the precision of matching does.)
:::

## Publish plugins

Publish plugins used across all integrations.


### Extract Review
Plugin responsible for automatic FFmpeg conversion to variety of formats.

Extract review is using [profile filtering](#profile_filters) to be able render different outputs for different situations.
Extract review is using [profile filtering](#profile-filters) to be able render different outputs for different situations.

Applicable context filters:
**`hosts`** - Host from which publishing was triggered. `["maya", "nuke"]`
- **`families`** - Main family of processed instance. `["plate", "model"]`
- **`families`** - Main family of processed subset. `["plate", "model"]`

![global_extract_review_profiles](assets/global_extract_review_profiles.png)

Expand Down Expand Up @@ -82,32 +83,32 @@ Profile may generate multiple outputs from a single input. Each output must defi

### IntegrateAssetNew

Saves information for all published instances into DB, published assets are available for other hosts, tools and tasks after.
Saves information for all published subsets into DB, published assets are available for other hosts, tools and tasks after.
#### Template name profiles

Allows to select [anatomy variant](admin_settings_project_anatomy.md#templates) based on context of processed published instance.
Allows to select [anatomy template](admin_settings_project_anatomy.md#templates) based on context of subset being published.

For example for `render` profile you want to publish and store assets in different location (based on anatomy setting) then for `publish` profile.
[Profile filtering](#profile_filters) is used to select between appropriate template for each context of published instances.
For example for `render` profile you might want to publish and store assets in different location (based on anatomy setting) then for `publish` profile.
[Profile filtering](#profile-filters) is used to select between appropriate template for each context of published subsets.

Applicable context filters:
- **`hosts`** - Host from which publishing was triggered. `["maya", "nuke"]`
- **`tasks`** - Task of processed instance. `["modeling", "animation"]`
- **`tasks`** - Current task. `["modeling", "animation"]`

![global_integrate_new_template_name_profile](assets/global_integrate_new_template_name_profile.png)

(This image shows use case where `render` anatomy template is used for instances of families ['review,'render', 'prerender'], `publish` template is chosen for all other.)
(This image shows use case where `render` anatomy template is used for subsets of families ['review, 'render', 'prerender'], `publish` template is chosen for all other.)

#### Subset grouping profiles

Published instances might be grouped together for cleaner and easier selection in some loader tools (in [Loader](#artist_tools#subset-groups) for example)
Published subsets might be grouped together for cleaner and easier selection in **[Loader](artist_tools.md#subset-groups)**

Group name is chosen with use of [profile filtering](#profile_filters)
Group name is chosen with use of [profile filtering](#profile-filters)

Applicable context filters:
- **`families`** - Main family of processed instance. `["plate", "model"]`
- **`families`** - Main family of processed subset. `["plate", "model"]`
- **`hosts`** - Host from which publishing was triggered. `["maya", "nuke"]`
- **`tasks`** - Task of processed instance. `["modeling", "animation"]`
- **`tasks`** - Current task. `["modeling", "animation"]`

![global_integrate_new_template_name_profile](assets/global_integrate_new_subset_group.png)

Expand Down

0 comments on commit ea8f093

Please sign in to comment.