DC 5.3.0 Import configuration

There are 3 levels of configuration. This section describes the importĀ configuration. All import configurations are xml-files located in a subfolder of the Importer installation namedĀ ImportConfigs. Every xml-file in this subfolder will be perceived as a configuration file. Only files with xml extension are read. Everything else is ignored. Here is a list of all possible configurations.

  <LanguageId></LanguageId>
  <UploadDirectory></UploadDirectory>
  <SheetDirectory></SheetDirectory>
  <ZipContentDirectory></ZipContentDirectory>
  <SuccessDirectory></SuccessDirectory>
  <FailureDirectory></FailureDirectory>
  <DeleteEmptyDirectories></DeleteEmptyDirectories>
  <RunUpload></RunUpload>
  <ComputerName></ComputerName>
  <UploadChunkSize></UploadChunkSize>
  <FileNameStampType></FileNameStampType>
  <FileNameStampMetafieldId></FileNameStampMetafieldId>
  <RunMetadataUpdate></RunMetadataUpdate>
  <MetadataFileName></MetadataFileName>
  <Culture></Culture>
  <BulkSize></BulkSize>
  <MetadataParser></MetadataParser>
  <ComboSeparator></ComboSeparator>
  <ComboMatchStyle></ComboMatchStyle>
  <FilenameColumn></FilenameColumn>
  <MetafieldIdRow></MetafieldIdRow>
  <DataStartRow></DataStartRow>
  <MatchSearchName></MatchSearchName>
  <MatchTokenColumn></MatchTokenColumn>
  <MatchTokenTag></MatchTokenTag>
  <MatchTokenFallbackType></MatchTokenFallbackType>
  <MatchBatchSize></MatchBatchSize>
  <ArchiveOnReplace></ArchiveOnReplace>
  <Active>false</Active>
KeyDescriptionData type / descriptionDefault valueĀ 1)In use when
LanguageIdA valid DAM system language ID.IntegerNoneAlways. Required.
UploadDirectoryThe hotfolder to watch for input.StringNoneAlways. Required.
SheetDirectoryDirectory for metadata sheets. When left empty it defaults toĀ UploadDirectory.StringNoneWhen RunMetadata is true and MetadataParser is CSV or Excel. Optional.
ZipContentDirectoryDirectory for zipped content. Zip content will be unpacked to UploadDirectory.StringNondeWhenever set this directory will always be checked first and all content unzipped before reading UploadDirectory.
SuccessDirectoryWhere to put files successfully uploaded - including metadata files. Leave empty to simply delete these files.StringEmptyAlways. Optional.
FailureDirectoryWhere to put files that failed during upload og metadata processing. Leave empty to simply leave failed in place in which case they will be retried. It is recommended to set this to avoid having the Importer repeatedly try and fail.StringEmptyAlways. Optional.
DeleteEmptyDirectoriesWhen true all empty directories belowĀ UploadDirectoryĀ will be deleted after files and/or metadata have been ingested.BooleanFalseAlways. Optional.
RunUploadSet true when in need of asset ingest.BooleanFalseAlways. Optional, but if not set RunMetadata must be true.
ComputerNameAn identification token of the uploading application.StringImporterWhen RunUpload is true. Optional.
UploadChunkSizeSize in bytes of chunks when uploading files.Integer / cannot be lower than 1mb26214400 (25mb) 2)When RunUpload is true. Optional.
FileNameStampType

How filename is stamped. Example:

  • FileNameOnly: AwesomeMe.jpg
  • FileNameNoExtension: AwesomeMe
  • RelativePath: \GoodStuff\AwesomeMe.jpg (ifĀ 
  • AbsolutePath C:\Upload\GoodStuff\AwesomeMe.jpg

Enum:

  • FileNameOnly
  • FileNameNoExtension (5.2.1+)
  • RelativePath
  • AbsolutePath
RelativePathWhen RunUpload is true and FileNameStampMetafieldId is set. Optional.
FileNameStampMetafieldIdId of metafield where filename will be stamped.IntegerNoneWhen RunUpload is true. Optional.
RunMetadataUpdateSet true when i need of metadata ingest.BooleanFalseAlways. Optional, but if not set RunUpload must be true.
MetadataFileNameA fullpath reference to a file containing metadata configuration. See Metadata Configuration.StringNoneWhen RunMetadata is true and metadata is preconfigured (Xml2Metadata).
CultureA standard string describing a culture setting. SeeĀ Culture names and identifiers for supported values.Stringen-USWhen RunMetadata is true and there are any dates or floating points in the metadata input.
BulkSizeHow many assets are updated in one bulk.Integer5When RunMetadata is true.
MetadataParser

The type of medata input.

  • CSV: when metadata is a CSV sheet.
  • Excel: when metadata is an Excel sheet.
  • Xml2Metadata: when metadata is an xml file.

Enum:

  • CSV
  • Excel
  • Xml2Metadata
NoneWhen RunMetadata is true. Required then and ignored otherwise.
ComboSeparatorWhen special character to use as delimiter for values of any combo or tree type.1 special character.;When RunMetadata is true and MetadataParser is any of the sheet types. Optional (but required if your delimiter is different from the default.
ComboMatchStyleWhen matching input values against existing tree- or combovalues should the importer user textvalue or optionvalue.

Enum:

  • TextValue
  • Option
TextValueWhen RunMetadata is true this settings will have an effect for every metafield of tree- or combotype. It is possible to specify for specific metafields in which case this setting is ignored.
FileNameColumnWhich column in the sheet holds the filename of the file to upload.Integer (1-based index)NoneWhen RunMetadata and RunUpload are both true and input type is any of the sheet types.
MetafieldIdRowWhich row in the sheet holds the metadata configuration (metafield IDs).Integer (1-based index)NoneWhen RunMetadata and RunUpload are both true and input type is any of the sheet types.
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 (1-based index)NoneWhen RunMetadata and RunUpload are both true and input type is any of the sheet types.
MatchSearchName

When set a search will be executed the purpose of which varies with configuration:

  • RunUpload is true: The search result will be used to determine if an asset must be replaced.
  • RunMetadata is true and RunUpload is false: The search result is used to determine the asset to be metadata updated.
String matching a valid DAM search.None but "DamImporterMatchSearch" comes with the importerAlways if set.
MatchTokenColumnWhich column in the sheet holds the token to use as input for MatchSearchNameInteger (1-based index)NoneWhen MatchSearchName is set and MetadataParser is any of the sheet types. Optional.
MatchTokenTagWhich tag in the xml holds the token to use as input for MatchSearchNameStringNoneWhen MatchSearchName is set and MetadataParser is Xml2Metadata. Optional.
MatchTokenFallbackTypeWhen MatchTokenColumn / MatchTokenTag are either not set or the value is empty a fallback is made to the filename of the uploaded asset (and thus is only possible when RunUpload is true).

Enum:

  • FileNameOnly
  • FileNameNoExtension (5.2.1+)
  • RelativePath
  • AbsolutePath
RelativePathWhen RunUpload is true, MatchSearchName is set and MatchTokenColumn / MatchTokenTag are unset or the value thereof is empty. Optional unless the default differs from what is needed.
MatchBatchSizeHow many match tokens are queried at a time.Integer between 1 and 10010Only in effect when RunUpload is false and RunMetadata is true as in an upload scenario tokens are always quesried one at a time. This setting was introduced in DAM 5.1.1.
ArchiveOnReplaceWhether to overwrite (false) or archive (true) an asset when replacing.BooleanFalseWhen RunUpload is true, MatchSearchNameĀ  is set.Ā Optional unless the default differs from what is needed.
  1. Default value is in effect when the xml element is empty or not present at all.
  2. Higher numbers may increase performance on fast networks. Test with debug logging to see timings.