Delivery Module

The Delivery Module allows you to deliver tracks, albums, or playlists and associated metadata out of the system to external partners, streaming platforms (such as Spotify and YouTube), distributors, PROs, and customers.

Getting Started

We recommend setting things up in the following order, but feel free to jump to the section most relevant to you:

• Routes — Set up where you're delivering to
• Mappings — Define the metadata format
• Paths — Control your file and folder naming
• Packages — Select the tracks you want to deliver
• Setups — Bring everything together and deliver

Note: Routes, Mappings, and Paths will usually be a one-time setup for each endpoint. Packages and Setups will be created for each delivery.

Routes

Routes define where you're delivering to — the credentials and connection details for your endpoint (e.g., a DSP, distributor, or partner). Routes only need to be set up once per endpoint and can then be reused for multiple deliveries.

Creating a Route

1. Go to Admin > Delivery > Routes
2. Click + Create in the top right corner
3. Enter a name for the Route (e.g., "Spotify Delivery")
4. For DDEX deliveries only: Enter your DPID code
   1. More information can be found here: https://dpid.ddex.net/register
5. Select the Type based on where you're delivering

Supported Route Types

Amazon S3: Select this if your endpoint wants delivery to an Amazon S3 bucket. You'll need to enter the Access Key ID, Secret Access Key, Bucket, Key Prefix, and Region. These credentials should be provided by your endpoint.

Helpful AWS documentation:

• Security credentials: https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html
• S3 documentation: https://docs.aws.amazon.com/s3/

FTP: Select this if your endpoint uses a standard FTP server. You'll need the Host, Port, Username, and Password — all provided by your endpoint.

SFTP (Password): Select this if your endpoint uses an SFTP server with password authentication. You'll need the Host, Port, Username, and Password — all provided by your endpoint.

SFTP (Key): Select this if your endpoint uses an SFTP server with key-based authentication. You'll need a Private Key file. You can also use the Generate Private Key toggle to generate one for your endpoint to use.

Dropbox: Select this if your endpoint wants delivery to Dropbox using an access token. You'll need to generate the token from your Dropbox app homepage.

Dropbox OAuth: Select this if your endpoint wants delivery to Dropbox using OAuth authentication.

Box (Credentials): Select this if your endpoint uses Box and wants to authenticate with username and password credentials.

Box (Access Token): Select this if your endpoint uses Box and wants to authenticate with an access token.

Wasabi S3: Select this if your endpoint uses Wasabi cloud storage (S3-compatible). Setup is similar to Amazon S3 — credentials should be provided by your endpoint.

Mappings

Mappings define the metadata format for your delivery — what fields are included, how they're structured, and any transformations applied to the data.

Available Formats

Standard delivery formats:

• DDEX v3.8.2 — standard DDEX format, includes Release Deals, language of performance, and contributor ID
• DDEX v4.2 — standard DDEX format, includes Release Deals
• Fuga — standard Fuga format
• Custom (CSV) — build your own custom metadata export in CSV format
• Custom (JSON) — build your own custom metadata export in JSON format
• DigAS (JSON) — deliver metadata in DigAS JSON format

Embedded metadata formats (embed metadata directly into audio files):

• MP3 Embedding (ID3) — embed metadata into MP3 files
• WAV Embedding (RIFF) — embed metadata into WAV files
• AIFF Embedding (ID3) — embed metadata into AIFF files
• FLAC Embedding (Vorbis) — embed metadata into FLAC files

Creating a Mapping

1. Go to Admin > Delivery > Mappings
2. Click + Create in the top right corner
3. Enter a name and select the relevant Format
4. Configure the Field Mapping (see below)
5. Click Save

 

Preview

The Preview section lets you select an Album and Master to see how your mapping will look before delivering. Once you select both, a new column appears in the Field Mapping showing exactly how each field will be populated for that record. Use this to confirm everything is mapped correctly before running a delivery.

Field Mapping

The Field Mapping section is where you map your endpoint's required fields (Target) to the data in your Synchtank system (Your Data Source).

Each row has a Target field on the left — this is what your endpoint expects to receive. On the right, you assign the Synchtank data that should populate it. You can mark any field as Mandatory using the toggle between the Target and Source columns — this ensures that the field must have data before the delivery can proceed.

To configure a field, click the pencil icon to open the Sources modal. From here you can:

• Add Source Field: select a Synchtank data field as the source. You can drill down through entities (Master, Album, etc.) and their available fields
• Add Transform: apply one or more transformations to modify the value before it's delivered (see Per-field Transformations below)
• Add Fixed Value: add a static text value that will always output the same content regardless of the track data
• Output Settings: appears when you add more than one source (via Add Source Field or Add Fixed Value). Controls how the value is output when multiple sources are present (Default, First Item, or Join Items)

Per-field Transformations

Transformations let you modify a field's value at delivery time without changing the source data in your system. Click + Add Transform inside the Sources modal to apply one or more of the following:

• Translate: map specific input values to different output values using a lookup table. Add as many pairs as needed.
• Transliterate Non-Latin Characters: converts accented and non-Latin characters to their closest ASCII equivalent during delivery. This can improve compatibility with external systems that do not support special characters. No additional configuration is required.

• List to String: convert a list of values into a single string. Fields: Strategy.
• Boolean to String: convert a true/false value into custom text. Fields: True value, False value.
• Prefix and Suffix: add static text before or after a field value. Fields: Prefix, Suffix.
• Find and Replace: replace a specific character or text string with another. Fields: Find, Replace with.
• Array Filter: filter items from an array based on a comparison. Fields: Array field, Field for comparison, Operator, Value for comparison.
• Left Padding: pad a field value on the left with a specific character up to a defined length. Fields: Length, Padding character.
• Conditional Value: output different values based on a condition. Fields: Condition, Value if true, Value if false (optional).

Translations

The Translations section sits below the Field Mapping and works at the mapping level — not per field. Use it to define global value translations that apply across the entire mapping. Click + Add Translation to create one.

Embedded Metadata Mappings

You can create mappings to embed metadata directly into audio files as part of the delivery. This gives downstream users access to track information without needing a separate metadata file.

Supported formats: MP3, WAV, FLAC, and AIFF

To create an embedded metadata mapping, select one of the embedding formats (e.g. MP3 Embedding (ID3), WAV Embedding (RIFF), or AIFF Embedding (ID3)) when creating a new mapping, and configure the field mapping as usual.

Custom CSV

This allows you to create your own metadata export format and build your own custom CSV spreadsheets tailored to your endpoint's requirements.

When creating a Custom CSV mapping, there is an optional Template File field. This lets you pull in a custom spreadsheet that has been previously uploaded to the Mapping Templates page. When a template is selected, the column names from the spreadsheet automatically populate the field mapping on the left-hand side — so you just need to map each column to the right Synchtank data source on the right.

Recommended workflow for Custom CSV:

1. Ask your endpoint for their metadata template spreadsheet
2. Go to Admin > Delivery > Mappings > Mapping Templates and upload the file
3. Go to Admin > Delivery > Mappings and click + Create
4. Select Custom (CSV) as the format
5. In the Template File field, select the template you uploaded
6. The column names from the spreadsheet will auto-populate on the left — map each one to the correct Synchtank data source on the right
7. Click Save

Mapping Templates

If your endpoint has a specific metadata format they want to receive, they may send you a spreadsheet template. You can upload this under Admin > Delivery > Mappings > Mapping Templates, and it will be stored for use when creating new Custom CSV mappings.

Paths

Paths control how your delivered files and folders are named. Each Path has a name, a Batch By setting, and a set of File Paths — one for each file type being delivered.

Creating a Path

1. Go to Admin > Delivery > Paths
2. Click + Create
3. Enter a Name for the Path
4. Select the Batch By type — this controls how files are grouped:
1. UPC — group by UPC code
2. Package — group by Delivery Package
3. Track — group by individual track
5. Strict Special Character Sanitization: A toggle sits below the path setup fields. When on, all special characters are stripped from file paths before delivery. When off, most special characters are allowed through — though some will still be stripped.
   
6. Once a Batch By type is selected, the File Paths section appears
   

 File Paths

The File Paths section lets you define the naming structure for each file type in your delivery:

• Metadata File
• Audio Files
• Stem Files
• Child Track Files
• Image Files
• Waveform Files
• Complete Flag

To build a file path, type @ to open a list of available dynamic tokens (e.g., TRACK:UPC, FILE_OBJECT:EXTENSION, PROCESS:TIMESTAMP) and select one to insert it. You can combine multiple tokens with static text (e.g.,/resources/) to create the exact path structure your endpoint requires.

Tips:

• Transformations are applied in the order they are listed
• Transformations are applied to all tokens of the same type

Token Transformations

Click on any token to apply transformations to its value. The following three options are available regardless of which file type row you're configuring:

• Find and Replace — replace a specific character or string within the token value. Fields: Find, Replace with.
• Convert Character Encoding — converts the token value to ASCII, replacing or removing any non-ASCII characters. Useful for endpoints that can't handle special characters.
• Left Padding — pad the token value on the left with a specific character up to a defined length. Fields: Length, Padding character.
• Drag and drop: You can reorder transformations by dragging and dropping them. This is useful when you have multiple transformations applied to a token and need to change the order in which they are applied.

Packages

A Delivery Package is a collection of tracks, albums, or playlists that you want to deliver to a specific destination.

Creating a Delivery Package

1. Go to Admin > Delivery > Packages
2. Click + Create in the top right corner
3. Enter a name and description
4. Main Versions Only — toggle available at creation to include main (parent) versions only, excluding child tracks. Useful when delivering to endpoints that don't use child track data.
5. Click Save

Once saved, the Sources section appears with an + Add Source button. From here you can add content directly to the package — albums, masters, playlists, and more. Search buttons allow you to search for masters and albums using the same advanced search available in the Masters and Albums sections.

You can also add content to a package from other sections of the Admin:

From Masters:

1. Go to Admin > Catalog > Masters
2. Search for the tracks you want to add
3. Select one or more tracks
4. Click the Add to Delivery Package button above the track list
5. Select the relevant Package and click Save

From Albums:

1. Go to Admin > Catalog > Albums
2. Select the album(s) you want to add
3. Click the Add to Delivery Package icon above the list
4. Select the relevant Package and click Save — this will add the full album and all its tracks

From Playlists:

1. Go to Admin > Catalog > Playlists
2. Select the playlist(s) you want to add
3. Click the Add to Delivery Package icon above the list
4. Select the relevant Package and click Save

Copying a Package

You can now copy an existing Delivery Package using the copy option in the package list. When copying, you will be asked to choose what to include in the copy:

• Main versions only — copies only the primary versions of the tracks
• Include child tracks — copies the main versions and all associated child tracks (e.g. versions, remixes, instrumentals)

This is useful for endpoints that don't use child tracks, allowing you to quickly create a clean copy without them.

Setups

Once you have your Package, Route, Mapping, and Path configured, you bring them all together in a Setup to create and run a delivery.

Creating a Setup

1. Go to Admin > Delivery > Setups
2. Click + Create
3. Fill in the Setup Information fields:
   • Delivery Package (mandatory)
   • Deliver locally on the server (optional toggle) — allows users to deliver to themselves to test files prior to actual delivery.
     When enabled, files are downloaded directly from the server when the delivery is complete, and the Delivery Route field is hidden. It can also be used to create custom reports.
   • Delivery Route (mandatory, unless Deliver locally is enabled)
   • Data Format (mandatory) — if you select a DDEX format, an additional Choreography Type field appears (Release by Release, ERN-C v1.2, ERN-C v1.5). If you select Custom CSV, Custom JSON, DigAS JSON, or a DDEX format, a Delivery Path Setup field appears where you select your Path configuration.
   • Batch By (mandatory)
   • Delivery Mapping (Metadata) — select your mapping
   • Source Audio Format — defaults to Auto-detect (recommended for most deliveries)
   • Send an email when the delivery process is complete (optional toggle)
4. Configure Content Options:
   • Include Metadata
   • UTF-8 Byte Order Mark (BOM) (toggle) — when enabled, adds a UTF-8 BOM to delivered CSV files. This prevents special characters such as accented characters and apostrophes from displaying incorrectly when the file is opened in Excel on Windows.
     • Note: This option only affects the delivered output — it does not modify any source data in Synchtank.
   • Include Audio — choose one or more formats: MP3 (with Target Bitrate and Embedded Metadata Mapping options), WAV, AIFF, FLAC, ADM
   • Include Peak Files/Waveforms
   • Include Artwork — JPG and/or TIFF
   • Include Child Tracks (versions/remixes/etc)
   • Include Stems
   • Include Delivery Complete File
5. Click Save

Running a Delivery

Once your Setup is ready, click Deliver in the top right corner to start the delivery process. Your tracks and associated metadata will be sent to your endpoint as configured.

Progress bar: A progress bar is now visible during the delivery process, so you can see how far along the delivery is in real time.

Processes

Each Setup has a Processes section that shows the history of all deliveries run from that Setup.

When you open a delivery process, you can see:

• Process — setup details, delivery status, and a visual Delivery Pipeline showing each stage of the delivery
• Delivery Errors — a list of any errors that occurred, now categorized by type (e.g. validation errors, network errors) to make them easier to identify and fix
• Delivered Files — a breakdown of all files delivered, including category labels (meta, audio, artwork) and file size

A Run Reports section shows automatically generated reports once a delivery completes — including tracks delivered, tracks failed, duration, and bytes transferred.

Retry button: If a delivery fails, a Retry button appears on the failed process. Clicking it re-runs the delivery and generates a new report.

Copying a Setup

You can duplicate an existing Setup using the three-dot (⋮) menu on any Setup row in the list. This is useful when you have a complex configuration you want to reuse with minor changes.

1. Click the ⋮ menu on the Setup you want to copy
   
2. A modal appears asking you to select a Delivery Package for the new copy
3. Select the package and click Copy
4. The new Setup opens pre-populated with all the same settings from the original — ready for you to review and adjust as needed
5. Changes to the copy do not affect the original Setup