DC 5.9 Import configuration

Owned by Rasmus Hjelmberg Duemose Hansen
Oct 16, 2023
4 min read

The importer service is configured from the MediaManager UI under General settings/Importer.

It is enabled by creating a configuration and enabling that.

To create a new import configuration, navigate to the before-mentioned path and hit the Create new button in the top right corner (see screenshot)

From here, there are the following configuration options.

The UI will change depending on a few of the selections and the below screenshot highlights as many options as possible.

Key

Description

Data type / description

Default value

Key

Description

Data type / description

Default value

Name

A name that must be unique used to identify the import configuration

String

None

Upload directory

This is the hot folder import path.

If this is running on a virtual machine, this must point to an accessible directory on the web server (e.g. C:\Storage\upload\hotfolder).

If this is running in kubernetes in must be a relative path on the provided sftp server (e.g. /hotfolder)

String

None

Active

This enabled/disabled the import configuration

Bit

False

Zip content directory

If this is specified, then a zip file containing the entire import can be dropped in this directory. The contents is then extracted and put in the specified UploadDirectory

String

None

Run upload

Specifies if this configuration is used for upload or metadata import. If false, no files are uploaded and the import configuration is assumed to be metadata import

Bit

True

Computer name

An identification token of the uploading application. This name can be used in automations to identify where the upload is coming from 

String

None

Archive on replace

Specifies if the import should do duplicate detection. If yes, duplicates are replaced.

Bit

True

Keep metadata

If ArchiveOnReplace is true, this specifies if the metadata should be copied to the new version. If true, the metadata is copied

Bit

True

File name stamp type

How filename is stamped. Example:

  • FileNameOnly: AwesomeMe.jpg

  • FileNameNoExtension: AwesomeMe

  • RelativePath: \GoodStuff\AwesomeMe.jpg (if 

  • AbsolutePath C:\Upload\GoodStuff\AwesomeMe.jpg

Enum:

  • FileNameOnly

  • FileNameNoExtension

  • RelativePath

  • AbsolutePath

RelativePath

Stamp Field

Specifies the metadata string field in which the upload filename is put in. The value is based on FileNameStampType configuration

String

Fullpath UNC metadata field

Success Action

Specifies what to do with the file on Success. Notice you must specify a destination directory on Move action.

Enum

  • Delete

  • Move

  • Keep

Delete

Failure Action

Specifies what to do with the file on Failure. Notice you must specify a destination directory on Move action.

Enum

  • Delete

  • Move

  • Keep

Move

Delete Empty Directories

If true, any sub directory that is empty once the import has completed will be deleted

Bit

False

last Write Delay before upload

This specifies for how long the importer should wait before uploading files after the files has been moved to the hot folder. This may need to be increased for sFTP drop folders as that is transported over the internet, rather than an internal file copy on disk.

Int

0

Treat zero byte files (empty files) as failed

This is related to the above setting. If the file is uploaded before the move to the folder has been completed, then specially FTP servers will create a new file which has zero bytes. This generally should be True.

Bit

True

Culture

This controls how datetime and floats are parsed in metadata import as they may depend on the language. If in doubt use Invariant

List of Langauages

Invariant

Uploaders user id

This controls which user the import should upload as.

Int

10000

Combo separator

This controls which separator is used to separate multi values like combo values.

String

;

Combo match style

Determines if the combo is matched on textual value (which is different between languages) or option value (which is the non-language unique identifier).

Enum

  • TextValue

  • OptionValue

TextValue

Match search name

This configures which API endpoint to use for duplicate detection. This is mainly used to switch between filename matching or assetid matching

List of searches

DamImporterMatchSearch

Multi value update method

This configures how to treat multi values if the field being updated already contain other values

Enum

  • Merge

  • Override

  • Remove

Override

Match token fallback type

The default match token is what is configured in File name stamp type, however, this can be used as fallback

Enum:

  • FileNameOnly

  • FileNameNoExtension

  • RelativePath

  • AbsolutePath

Relative path

Metadata import type

This configures what the input for the metadata should be. Do not import implicitly disabled metadata import for the import configuration (i.e. asset upload only).

Enum:

  • Import from sheets

  • Import from xml

  • Do not import

Import from sheets

Sheet type

If Import from sheets is configured, then this controls the type of the sheet

Enum

  • Excel

  • CSV

Excel

Sheet directory

The directory in which the sheet is uploaded. Similar to Upload directory

String

None

MetafieldIdRow

Which row in the sheet holds the metadata configuration (metafield IDs).

Integer (0-based index)

None

DataStartRow

Which row in the sheet does data start. This allows the sheet to contain 1 or more rows in the beginning which are ignored by the Importer.

Integer (0-based index)

None

MatchTokenColumn

Which column in the sheet holds the token to use as input for MatchSearchName

Integer (0-based index)

None

FileNameColumn

Which column in the sheet holds the filename of the file to upload.

Integer (0-based index)

None