---
title: 'Vimeo Cloud Export'
url: 'https://docs.brix.ch/celum_connectors/vimeo_cloud_export'
markdown: 'https://docs.brix.ch/celum_connectors/vimeo_cloud_export.md'
lang: en
date: '2026-10-26'
description: 'Technical documentation for the CELUM Connector "Vimeo Cloud Export" – Software developed by brix'
taxonomy:
  category:
    - docs
---

[](#) 

  [ Welcome ](https://docs.brix.ch/)     [ CELUM Connectors ](https://docs.brix.ch/celum_connectors)      Vimeo Cloud Export    

# Vimeo Cloud Export

![No UI](https://img.shields.io/static/v1?label=UI&message=none&color=inactive)

Vimeo Cloud Export is a [Cloud Export](https://docs.brix.ch/celum_connectors/cloud_export) extension which allows you to synchronize video assets from CELUM to Vimeo.

#### Table of Contents

- [Requirements](#requirements)
- [Dependencies](#dependencies)
- [Properties](#properties)
    - [General](#general)
        - - [cloudExport.general.license](#cloudexport-general-licen)
            - [cloudExport.general.taskGroupName](#cloudexport-general-taskg)
    - [Export Definitions](#export-definitions)
        - - [cloudExport.{key}.type](#cloudexport-key-type)
            - [cloudExport.{key}.scopeExpression](#cloudexport-key-scopeexpr)
            - [cloudExport.{key}.deleteOutOfScopeRemoteAssets](#cloudexport-key-deleteout)
            - [cloudExport.{key}.downloadFormatId](#cloudexport-key-downloadf)
            - [cloudExport.{key}.taskName](#cloudexport-key-taskname)
            - [cloudExport.{key}.taskCronExpression](#cloudexport-key-taskcrone)
            - [cloudExport.{key}.oauthProfileName](#cloudexport-key-oauthprof)
            - [cloudExport.{key}.videoTitle.infoFieldId](#cloudexport-key-videotitl)
            - [cloudExport.{key}.videoDescription.infoFieldId](#cloudexport-key-videodesc)
            - [cloudExport.{key}.folderUri](#cloudexport-key-folderuri)
            - [cloudExport.{key}.albumURIs](#cloudexport-key-albumuris)
            - [cloudExport.{key}.teamId](#cloudexport-key-teamid)
            - [cloudExport.{key}.useEmbedUrl](#cloudexport-key-useembedu)
            - [cloudExport.{key}.uploadThumbnail](#cloudexport-key-uploadthu)
            - [cloudExport.{key}.generateChapters](#cloudexport-key-generatec)
            - [cloudExport.{key}.vttData.infoFieldId](#cloudexport-key-vttdata-i)
            - [cloudExport.{key}.chapterTitlePattern](#cloudexport-key-chapterti)
- [Compatibility Matrix](#compatibility-matrix)
- [Release Notes](#release-notes)
    - - - [1.0](#1-0)
            - [1.1](#1-1)
            - [1.3](#1-3)
            - [1.4](#1-4)
            - [1.5](#1-5)

## Requirements

CELUM Content 22.1 or later

## Dependencies

- [Cloud Export](https://docs.brix.ch/celum_connectors/cloud_export)
- OAuth Code Storage

## Properties

To be configured in {home}/appserver/conf/custom.properties

### General

##### cloudExport.general.license

> type: String, **required: yes**, default: -

The license key for the plugin (product: cloudExport), provided by *brix*.

##### cloudExport.general.taskGroupName

> type: String, required: no, default: Cloud Export

The name of the CELUM system task group.

### Export Definitions

Multiple exports can be configured, replace the {key} placeholder with a descriptive name for each export definition.

##### cloudExport.{key}.type

> type: String, **required: yes**

The type of this export definition. Set this to **vimeo**.

##### cloudExport.{key}.scopeExpression

> type: String, **required: yes**

A [Search Util 2](https://docs.brix.ch/celum_extensions/search_util_2) expression. All assets matching the expression will be exported.

##### cloudExport.{key}.deleteOutOfScopeRemoteAssets

> type: Boolean, default: false

Whether to delete assets from the export destination when they leave the defined scope.

##### cloudExport.{key}.downloadFormatId

> type: Integer, **required: yes**

The ID of the download format to use for this export.

##### cloudExport.{key}.taskName

> type: String, required: no, default: Cloud Export '{key}'

The name of the system task which executes the export.

##### cloudExport.{key}.taskCronExpression

> type: String, required: no, default: -

A [Quartz](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) cron expression specifying how often and when the export task should run.

##### cloudExport.{key}.oauthProfileName

> type: String, **required: yes**

The name of the profile created with OAuth code storage.

##### cloudExport.{key}.videoTitle.infoFieldId

> type: Integer, required: no

ID of the information field to use as title for the Vimeo video.

##### cloudExport.{key}.videoDescription.infoFieldId

> type: String, required: no

ID of the information field to use as description for the Vimeo video.

##### cloudExport.{key}.folderUri

> type: String, required: no

URI of the Vimeo folder to upload the videos to.

##### cloudExport.{key}.albumURIs

> type: String, required: no

Comma-separated list of Vimeo showcase (previously album) URIs to assign the videos to.

##### cloudExport.{key}.teamId

> type: Integer, required: no, default: -

Needs to be configured if your user is part of a team.

##### cloudExport.{key}.useEmbedUrl

> type: Boolean, default: false

Whether to save the Vimeo embed URL or the Vimeo video link as Public URL on the asset.

##### cloudExport.{key}.uploadThumbnail

> type: Boolean, default: false

If set to true, the CELUM preview image will be uploaded as thumbnail to Vimeo.

##### cloudExport.{key}.generateChapters

> type: Boolean, default: false

Enables chapter generation feature, if set to true. This requires you to also configure the next two properties.

##### cloudExport.{key}.vttData.infoFieldId

> type: Integer, required: if generateChapters = true

The ID of the text information field containing the chapter information in WEBVTT format.

##### cloudExport.{key}.chapterTitlePattern

> type: String, required: if generateChapters = true

A regex pattern to extract the chapter title from WEBVTT cue text. Capture group 1 will be used as the title.

## Compatibility Matrix

| vimeoCloudExport | CELUM |
|---|---|
| 1.0 - 1.6 | 6.4.0 - 6.19 |
| 1.7 | 6.20 |

## Release Notes

##### 1.0

> Released 2023-03-06

Initial version

##### 1.1

> Released 2023-03-13

Added support to move newly uploaded videos to a folder in Vimeo.

##### 1.3

> Released 2023-03-28

Added option to alternatively save the embed URL instead of the video link as Public URL on the asset.

##### 1.4

> Released 2023-04-24

Added thumbnail upload feature

##### 1.5

> Released 2024-03-28

Added chapter feature

 [ ](https://docs.brix.ch/celum_connectors/cloud_export) [](https://docs.brix.ch/celum_connectors/youtube_cloud_export)

---

## Navigation

- Parent: [CELUM Connectors](https://docs.brix.ch/celum_connectors.md)
- Previous: [Cloud Export](https://docs.brix.ch/celum_connectors/cloud_export.md)
- Next: [YouTube Cloud Export](https://docs.brix.ch/celum_connectors/youtube_cloud_export.md)
