Skip to main content
Ask ChatGPT

Introduction

You can upload metadata (field values, properties, classifications, etc.) alongside files in Aprimo DAM using a comma-separated values (CSV) file. Metadata upload works in:

  1. PowerShell Script for File Uploads
  2. File Upload through the REST API

Use Cases​

1. Bulk Ingestion​

  • You have many files and corresponding metadata from an external system.
  • Use the PowerShell Script for File Uploads, specifying the metadata file and metadata schema as parameters.
  • The files and metadata are then saved as new records.

2. Hotfolder​

  • Users place files and a CSV metadata file into a hotfolder.
  • A scheduled task runs the PowerShell Script (e.g., every hour) using the metadata schema parameter.
  • The script finds the CSV in the hotfolder and uploads both files and metadata as new records.

3. Upload Through REST​

  • Upload the CSV and receive a token.
  • Upload the image and receive another token.
  • Create a new record via REST, including:
    • The image token
    • The CSV token
    • The schema name

Prerequisites​

  • Each file has a unique filename.
  • The CSV is formatted correctly.
  • Aprimo DAM has an XML schema (.dataExchangeSchemas) defining how to parse the CSV.
  • Supported field definitions include: Text, Numeric, Duration, Date, Time, DateTime, Option List, Text List, and Classification List.

CSV File Requirements​

  • Comma-Separated Values file:
    • First row: column headers, separated by semicolons.
    • Field values: in quotes and separated by semicolons. Multiple values in one field are separated by commas.
    • One column must map to FileName (identified by isFilter in the XML schema).
    • Any extra CSV columns not used in the schema are ignored.

Example CSV
FileName;ProductNr;Stock;ProductName;ManufactorDate;Colors "france.jpg";"2";"100";"Product 1";"02/05/2017";"Blue,Green" "germany.jpg";"4";"99";"Product 2";"30/04/2017";"Red,Yellow"

Example Column Node

<column name="FileName" type="property" value="Files.LatestMaster.FileName" isFilter="true" />

When Aprimo DAM uploads france.jpg, it finds the matching row in the CSV via the FileName column. It then applies other columns to the record’s fields/properties as defined in the schema.

Field Data Types​

Time & DateTime​

  • The value is culture-specific. For a date like 03-05-2018:
    • en-US → March 5, 2018
    • nl-BE → May 3, 2018

Classification List​

  • You can provide either the classification ID (GUID) or the full label path.
  • For multiple classifications, separate them with commas, e.g.
/DAM/Images/Stock photos, /Types/Document
  • Label paths must be in the UI language of the user importing the file.

Option List​

  • Use the option label (in the user’s UI language), not the option name.

Schema​

The XML schema for metadata upload is located in Aprimo DAM under .dataExchangeSchemas.

Usage​

PowerShell Script for File Uploads​

  • Specify MetaDataSchemaName to enable Metadata Upload.
  • If no path is specified, the script assumes the metadata CSV is in the same folder as the files.
tip

For scheduled scripts, ensure the metadata CSV is in place first to avoid creating records without metadata.

Upload Through REST​

  • Upload the metadata CSV and get a token.
  • In your Record create/modify request, set:
"metadata": {
  "name": "example1",
  "token": "YOUR_TOKEN_HERE"
}
  • Include the schema name and token in your call.