Skip to main content
Ask ChatGPT

DAM Package Instructions

Overview​

The package-instruction.json file optimizes package uploads by linking existing DAM files instead of re-uploading them. This prevents unnecessary data transfer, especially for InDesign documents with placed DAM images.

For more details:

Rate Limiting

Before you begin developing, read about Aprimo Rate Limiting.

How It Works​

The Creative Cloud Connector uses the instruction file to establish publication item links at check-in. Instead of downloading and re-uploading files already in DAM, the instruction file recreates the links.

Use Case​

  1. A user uploads an InDesign package to DAM, which is unpacked with the InDesign file as the master file.
  2. A creative user checks out the master file via the Creative Cloud Connector.
  3. After editing, the user checks it back in, and DAM recreates the package.
  4. Instead of including placed files, the Connector adds package-instruction.json, which contains link instructions.
  5. At check-in, DAM updates the master file and maintains links to the placed files.

Key Benefits​

  • Prevents redundant file transfers
  • Maintains accurate publication item links
  • Supports both publication item links and record links

Using the Instruction File​

To replace actual files with links:

  1. Place package-instruction.json in the package root.
  2. Reference the file versions you want to link as publication items.
  3. Include a file path to ensure correct processing.

Example Instruction File​

{
  "instructions": [
    {
      "fileVersionId": "d720224b-981b-40af-8a87-ab8f0095e98b",
      "path": "/NameOfMyFolder/Links/FileName_01.psd",
      "type": "pubItem"
    },
    {
      "recordId": "95354bd5ea9d4977a24dab8f0095bddd",
      "path": "/NameOfMyFolder/Related/FileName_02.pdf",
      "type": "recordLink",
      "linkField": "linkField"
    }
  ]
}

Attributes​

Publication Item Attributes​

  • type: "pubItem"
  • fileVersionId: GUID of the referenced file version
  • path: Relative file path in the package
  • type: "recordLink"
  • linkField: Name of the record link or record list field
  • recordId: GUID of the linked record
  • path: Relative file path in the package After upload, the new master file contains links to the referenced DAM content.

Prerequisites​

Ensure the following settings are configured:

  • Instruction File:

    • Located in the root folder
    • Named package-instruction.json

  • Package System Settings (.packageIngestionConfiguration):

    • Defines the package type
    • Matches file paths using regex
<records>
    <add regex="links\\(.*?)$" linkType="recordLink" linkField="FD RecordLink One2Many" checkDuplicate="true">
      <classification type="namePath" value="Flying Dutchmen" />
    </add>
</records>

Support & Conflict Resolution​

  • Check the file version manifest to confirm instructions were applied.
  • See the manifest section in the Package Upload Page of the Administrator Guide.

Example Manifest Entry:

<file path="\NameOfMyFolder\Links\FileName_01.psd">
    <placements>
        <placement fileName="FileName_01.psd" type="PubItem">
            <record state="frominstruction" id="95354bd5-ea9d-4977-a24d-ab8f0095bddd" />
            <fileVersion id="d720224b-981b-40af-8a87-ab8f0095e98b" />
        </placement>
    </placements>
</file>

Potential Conflicts​

  • File Path Mismatch: If the file path in the instruction file does not match the regex in the package settings, the file is ignored.
  • Link Type Priority:
    • If the package setting defines files as publication items, but the instruction file sets them as record links, the instruction file takes precedence.
    • This approach ensures that files are correctly linked, reducing unnecessary uploads while maintaining accurate file associations.