upload

The upload property of a dcx processor serves two purposes:

  • It selects which incoming events will be handled, based on publication, content type and state

  • It specifies how the selected events are to be handled

    - filter:
        publications:
          - tomorrow-online
        content-types:
          - picture
          - graphic
        states:
          - approved
          - published
      content:
      folder: native

The upload property is an array, each element of which contains the following entries:

filter (optional, default: no additional filtering)

A DC-X-specific filter that works in exactly the same way as the global filter described in filter. It performs additional filtering to select only those events that are to be handled by the DC-X processor.

Note that if deleted is included the list of states, then whenever a matching content item is deleted in the Content Store, it will also be deleted from DC-X.

content (required)

Contains a required tags property that defines the details of how content is uploaded to the DC-X server, in the form of mappings between content item fields and DC-X tags. For details, see tags. If the content types to be uploaded are stories/storylines rather than binary assets, then content may also contain an image-container property (see image-container).

folder (optional, default: story)

The name of an existing import folder in the DC-X system to which stories will be uploaded. You are recommended to use the default folder name story, which exists in a standard DC-X installation.

upload-configuration (optional, default: native_hotfolder)

The name of an existing upload configuration in the DC-X system to be used for uploading binary assets. You are recommended to use the default configuration name native_hotfolder, which exists in a standard DC-X installation.

document-type (required for story/storyline uploads, not used for binary asset uploads)

The name of a document type defined in DC-X. Uploaded stories/storylines will be created as documents of this type. This property is not used when uploading binary assets.