DC 5.6 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>
<LastWriteDelayBeforeUpload></LastWriteDelayBeforeUpload>
<TreatZeroByteFilesAsFailed></TreatZeroByteFilesAsFailed>
<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>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. |
ZipContentDirectory | Directory for zipped content. Zip content will be unpacked to UploadDirectory. | String | Nonde | Whenever set this directory will always be checked first and all content unzipped before reading UploadDirectory. |
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. |
FileNameStampType | How filename is stamped. Example:
| Enum:
| 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. |
LastWriteDelayBeforeUpload | Delay in seconds from a file has last been written to the Importer will upload it. The default is zero and this has been the default behavior for the Importer since the beginning. Leave this at 0 unless using FTP or perhaps a 3rd party file integration that fails even when TreatZeroByteFilesAsFailed is false. | Integer | 0 | When RunUpload is true. Optional. |
TreatZeroByteFilesAsFailed | How to handle zero-byte failes. True will handle them as failed files. False will ignore and essentially retry again later. It is important to set this false when input is ftp or similar input that allocates a zero-byte file and writes it later. The default is false and this alters the behavior which before the introduction of this setting always treated zero-byte files as failed. This setting was introduced in the 5.4.0-139 build. | Boolean | False | 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.
| Enum:
| 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. |
ComboMatchStyle | When matching input values against existing tree- or combovalues should the importer user textvalue or optionvalue. | Enum:
| TextValue | When 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. |
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:
| 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:
| 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. |
MatchBatchSize | How many match tokens are queried at a time. | Integer between 1 and 100 | 10 | Only 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. |
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. |
Default value is in effect when the xml element is empty or not present at all.
Higher numbers may increase performance on fast networks. Test with debug logging to see timings.