DC 4.10.0 - Import configuration

DC 4.10.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. Here is a list of all possible configurations.

<LanguageId></LanguageId> <UploadDirectory></UploadDirectory> <SheetDirectory></SheetDirectory> <SuccessDirectory></SuccessDirectory> <FailureDirectory></FailureDirectory> <DeleteEmptyDirectories></DeleteEmptyDirectories> <RunUpload></RunUpload> <ComputerName></ComputerName> <UploadChunkSize></UploadChunkSize> <MetafieldGroupId></MetafieldGroupId> <FileNameStampType></FileNameStampType> <FileNameStampMetafieldId></FileNameStampMetafieldId> <BatchPriority></BatchPriority> <BatchCluster></BatchCluster> <BatchProgId></BatchProgId> <RunMetadataUpdate></RunMetadataUpdate> <MetadataFileName></MetadataFileName> <Culture></Culture> <BulkSize></BulkSize> <MetadataParser></MetadataParser> <ComboSeparator></ComboSeparator> <FilenameColumn></FilenameColumn> <MetafieldIdRow></MetafieldIdRow> <DataStartRow></DataStartRow> <MatchSearchName></MatchSearchName> <MatchTokenColumn></MatchTokenColumn> <MatchTokenTag></MatchTokenTag> <MatchTokenFallbackType></MatchTokenFallbackType> <ArchiveOnReplace></ArchiveOnReplace> <Active>false</Active>

Key

Description

Data type / description

Default value 1)

In use when

LanguageId

A valid DAM system language ID.

Integer

None

Always. Required.

UploadDirectory

The hotfolder to watch for input.

String

None

Always. Required.

SheetDirectory

Directory for metadata sheets. When left empty it defaults to UploadDirectory.

String

None

When RunMetadata is true and MetadataParser is CSV or Excel. Optional.

SuccessDirectory

Where to put files successfully uploaded - including metadata files. Leave empty to simply delete these files.

String

Empty

Always. Optional.

FailureDirectory

Where 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.

String

Empty

Always. Optional.

DeleteEmptyDirectories

When true all empty directories below UploadDirectory will be deleted after files and/or metadata have been ingested.

Boolean

False

Always. Optional.

RunUpload

Set true when in need of asset ingest.

Boolean

False

Always. Optional, but if not set RunMetadata must be true.

ComputerName

An identification token of the uploading application.

String

Importer

When RunUpload is true. Optional.

UploadChunkSize

Size in bytes of chunks when uploading files.

Integer / cannot be lower than 1mb

26214400 (25mb) 2)

When RunUpload is true. Optional.

MetafieldGroupId

New assets will get this MetafieldGroupId. While this is technically still a supported feature in DAM it is not recommended to use this feature. Please consult with RnD before ever touching this.

Integer

10025

When RunUpload is true. Optional.

FileNameStampType

How filename is stamped. Example:

  • FileNameOnly: AwesomeMe.jpg

  • RelativePath: \GoodStuff\AwesomeMe.jpg (if 

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

Enum:

  • FileNameOnly

  • RelativePath

  • AbsolutePath

RelativePath

When RunUpload is true and FileNameStampMetafieldId is set. Optional.

FileNameStampMetafieldId

Id of metafield where filename will be stamped.

Integer

None

When RunUpload is true. Optional.

BatchPriority

A priority for the job chain in batch system.

Integer

None

When RunUpload is true. Optional.

BatchCluster

A reference to a specific batch system processor as can be looked up in tblJobServer.ServerName.

String

None

When RunUpload is true. Optional.

BatchProgId

A reference to a DAM ProgID which will spawn extra job for batch to perform on an asset file before normal upload process continues.

String

None

When RunUpload is true. Optional.

RunMetadataUpdate

Set true when i need of metadata ingest.

Boolean

False

Always. Optional, but if not set RunUpload must be true.

MetadataFileName

A fullpath reference to a file containing metadata configuration. See Metadata Configuration.

String

None

When RunMetadata is true and metadata is preconfigured (Xml2Metadata).

Culture

A standard string describing a culture setting. See Culture names and identifiers for supported values.

String

en-US

When RunMetadata is true and there are any dates or floating points in the metadata input.

BulkSize

How many assets are updated in one bulk.

Integer

5

When 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

None

When RunMetadata is true. Required then and ignored otherwise.

ComboSeparator

When 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.

FileNameColumn

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

Integer (1-based index)

None

When RunMetadata and RunUpload are both true and input type is any of the sheet types.

MetafieldIdRow

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

Integer (1-based index)

None

When RunMetadata and RunUpload are both true and input type is any of the sheet types.

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 (1-based index)

None

When 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 importer

Always if set.

MatchTokenColumn

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

Integer (1-based index)

None

When MatchSearchName is set and MetadataParser is any of the sheet types. Optional.

MatchTokenTag

Which tag in the xml holds the token to use as input for MatchSearchName

String

None

When MatchSearchName is set and MetadataParser is Xml2Metadata. Optional.

MatchTokenFallbackType

When 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

  • RelativePath

  • AbsolutePath

RelativePath

When 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.

ArchiveOnReplace

Whether to overwrite (false) or archive (true) an asset when replacing.

Boolean

False

When 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.