# iconik

OffShoot's iconik integration enables you to generate iconik sidecar files for transferred clips automatically. By mirroring your iconik tags with elements in OffShoot's presets, any metadata the user enters upon transferring media is carried over into iconik.

{% hint style="info" %}
If you're looking to generate camera metadata, stills, and proxies for use in iconik, have a look at [EditReady Server](https://docs.hedge.video/editready-server).
{% endhint %}

## Requirements

* [OffShoot 23.2 or newer](https://docs.hedge.video/offshoot/releases), or a legacy release: Hedge 22.2, 22.3, or 23.1
* The [iconik Storage Gateway](https://app.iconik.io/help/pages/isg/) ("ISG"), connecting your on-premise storage with iconik. 

## How to set up

1. First, look up your tags in iconik, as you'll want to mirror them in your OffShoot setup.
2. In iconik, enable the `Sidecar Metadata View` option for your ISG ([docs](https://app.iconik.io/help/pages/admin/storage/editing/files)), and select a view:

<figure><img src="https://1060439511-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LStRji2w1AYja1bLBFv%2Fuploads%2Fk4tsodnGYHLnueL3viur%2Ficonik.png?alt=media&#x26;token=04daa641-756e-4440-a20c-4f9ed308c170" alt=""><figcaption></figcaption></figure>

3. In OffShoot's Organize panel, set up an OffShoot preset: `OffShoot > Settings > Organize`.&#x20;
4. Add Elements for all iconik tags you want to populate using the `+` button, and use them in `Auto Label`, `Rename Files`, or `Create Folders.`\
   \
   Tip: use curly brackets around your tag names to turn them into Elements. A valid Element will be converted into a blue block with a name. In this example screenshot, `{Card}` was converted to an Element. &#x20;

<figure><img src="https://1060439511-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LStRji2w1AYja1bLBFv%2Fuploads%2FBW9SAVJj1LLNmrftb1jH%2Fimage.png?alt=media&#x26;token=6f423e70-d15f-49e8-8de7-6a8743584210" alt=""><figcaption></figcaption></figure>

5. Enable the iconik integration in `Settings > Integrations > iconik`

<figure><img src="https://1060439511-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LStRji2w1AYja1bLBFv%2Fuploads%2FIRTKdSnMmBVM37rR6X09%2Ficonik-integration.png?alt=media&#x26;token=00de7531-7b68-4aa0-bed2-61a259933cd0" alt=""><figcaption><p>iconik integration settings</p></figcaption></figure>

6. Specify which Destination(s) OffShoot should place iconik sidecars on.\
   \
   List one or more destinations on which OffShoot will create your iconik sidecars. If you don't specify a Destination, sidecar files are created for *all* Destinations.\
   \
   There are two ways to specify a Destination:
   1. By volume name, e.g. `RAID`
   2. By folder path. Use wildcards (\*) for more flexibility, e.g. `*/proxies`

{% hint style="info" %}
Add multiple Destinations by separating them with a semicolon:

`Backup 1;Backup 2;Backup 3`
{% endhint %}

7. Specify which file extensions OffShoot should generate iconik sidecar files for. If no file extensions are specified, OffShoot will generate sidescars for *all* files.

{% hint style="info" %}
Add multiple extensions by separating them with a semicolon:

`.R3D;.MOV`
{% endhint %}

8. Define which iconik tags should be included in your iconik sidecars. This list should be identical to all the Elements you created in step `2`.\
   \
   E.g. `{Card}{Location}{ShootDay}`

{% hint style="info" %}

* iconik can't process Element names that contain spaces.&#x20;
* OffShoot will not include any unspecified Elements during sidecar generation, so make sure you include all you need to show up in iconik.
* File elements (e.g. {Filename}, {File extension}, etc.) are currently unsupported.
  {% endhint %}

9. You're all set up. Now, create a transfer by setting a Source and Destination, and you'll be prompted to add your metadata.&#x20;

<figure><img src="https://1060439511-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LStRji2w1AYja1bLBFv%2Fuploads%2FCPHppJNPtcxIZG8Afy2t%2Fimage.png?alt=media&#x26;token=39c0a622-d64e-4355-8f7c-4140d81b3eb5" alt=""><figcaption><p>Add transfers</p></figcaption></figure>

10. The generated sidecar files are ready to be automatically processed by the [iconik Storage Gateway](https://app.iconik.io/help/pages/isg/) app.

<figure><img src="https://1060439511-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LStRji2w1AYja1bLBFv%2Fuploads%2F9jYnxrhKifjSjwZAnqkt%2FPasted_Image_09_07_2024__12_32.png?alt=media&#x26;token=aea011e4-d822-46a8-a3bb-82754654b9e2" alt=""><figcaption><p>iconik sidecar files</p></figcaption></figure>

## Iconik Presets (Pro)

OffShoot Pro users can define iconik settings in a Pro Preset:

```
"iconikSidecarDestinations" : ["T1"],
"iconikSidecarExtensions" : [".MXF"],
"iconikSidecarElements" : ["{Project}","{ShootDay}","{Location}","{Type}"],
    
```

Example preset:

{% file src="<https://1060439511-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LStRji2w1AYja1bLBFv%2Fuploads%2FTFmBnAsNUXv30LIx5xJx%2Ficonik%20pro%20preset.hedge?alt=media&token=5c95f627-d87f-42be-b68c-af3ec14355b5>" %}