Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version published after converting to the new editor

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

...

KeyDescriptionData type / descriptionDefault value
NameA name that must be unique used to identify the import configurationStringNone
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)

StringNone
ActiveThis enabled/disabled the import configurationBitFalse
Zip content directoryIf 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 UploadDirectoryStringNone
Run uploadSpecifies 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 importBitTrue
Computer nameAn identification token of the uploading application. This name can be used in automations to identify where the upload is coming from StringNone
Archive on replaceSpecifies if the import should do duplicate detection. If yes, duplicates are replaced.BitTrue
Keep metadataIf ArchiveOnReplace is true, this specifies if the metadata should be copied to the new version. If true, the metadata is copiedBitTrue
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 FieldSpecifies the metadata string field in which the upload filename is put in. The value is based on FileNameStampType configurationStringFullpath 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 ActionSpecifies 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 DirectoriesIf true, any sub directory that is empty once the import has completed will be deletedBitFalse
last Write Delay before uploadThis 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.Int0
Treat zero byte files (empty files) as failedThis 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.BitTrue
CultureThis controls how datetime and floats are parsed in metadata import as they may depend on the language. If in doubt use InvariantList of LangauagesInvariant
Uploaders user idThis controls which user the import should upload as.Int10000
Combo separatorThis controls which separator is used to separate multi values like combo values.String;
Combo match styleDetermines 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 nameThis configures which API endpoint to use for duplicate detection. This is mainly used to switch between filename matching or assetid matchingList of searchesDamImporterMatchSearch
Match token fallback typeThe 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 typeThis 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 typeIf Import from sheets is configured, then this controls the type of the sheet

Enum

  • Excel
  • CSV
Excel
Sheet directoryThe directory in which the sheet is uploaded. Similar to Upload directoryStringNone
MetafieldIdRowWhich row in the sheet holds the metadata configuration (metafield IDs).Integer (0-based index)None
DataStartRowWhich 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
MatchTokenColumnWhich column in the sheet holds the token to use as input for MatchSearchNameInteger (0-based index)None
FileNameColumnWhich column in the sheet holds the filename of the file to upload.Integer (0-based index)None

...