Administrative Area Components

• User
• Group
• Containered Asset
• Asset Factory
• Asset Factory Container
• Page Configuration Set
• Page Configuration Set Container
• Structured Data Definition
• Asset Factory Container
• Metadata Set
• Metadata Set Container
• Publish Set
• Publish Set Container
• Target
• Destination
• File System Transport
• FTP Transport
• Workflow Definition
• Workflow Definition Container

NEWS & TIPS

• Site Access Keys
• Top: Alt+t
  Previous: Alt+,
  Next: Alt+.
  Up: Alt+;
  (Note: use Ctrl on the Mac)

Metadata Set

A Metadata Set is defined in the following WSDL:

<complexType name="metadataSet"> <complexContent> <extension base="impl:containered-asset"> <sequence> <!-- Whether or not the author field is required on assets using this metadata set NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="authorFieldRequired" type="xsd:boolean"/> <!-- The visibility of the author field for assets using this metadata set NOT REQUIRED default "visible" --> <element maxOccurs="1" minOccurs="0" name="authorFieldVisibility" type="impl:metadata-field-visibility"/> <!-- Whether or not the description field is required on assets using this metadata set NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="descriptionFieldRequired" type="xsd:boolean"/> <!-- The visibility of the description field for assets using this metadata set NOT REQUIRED default "visible" --> <element maxOccurs="1" minOccurs="0" name="descriptionFieldVisibility" type="impl:metadata-field-visibility"/> <!-- Whether or not the display name field is required on assets using this metadata set NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="displayNameFieldRequired" type="xsd:boolean"/> <!-- The visibility of the display name field for assets using this metadata set NOT REQUIRED default "visible" --> <element maxOccurs="1" minOccurs="0" name="displayNameFieldVisibility" type="impl:metadata-field-visibility"/> <!-- Whether or not the end date field is required on assets using this metadata set NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="endDateFieldRequired" type="xsd:boolean"/> <!-- The visibility of the end date field for assets using this metadata set NOT REQUIRED default "visible" --> <element maxOccurs="1" minOccurs="0" name="endDateFieldVisibility" type="impl:metadata-field-visibility"/> <!-- Whether or not the keywords field is required on assets using this metadata set NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="keywordsFieldRequired" type="xsd:boolean"/> <!-- The visibility of the keywords field for assets using this metadata set NOT REQUIRED default "visible" --> <element maxOccurs="1" minOccurs="0" name="keywordsFieldVisibility" type="impl:metadata-field-visibility"/> <!-- Whether or not the review date field is required on assets using this metadata set NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="reviewDateFieldRequired" type="xsd:boolean"/> <!-- The visibility of the review date field for assets using this metadata set NOT REQUIRED default "visible" --> <element maxOccurs="1" minOccurs="0" name="reviewDateFieldVisibility" type="impl:metadata-field-visibility"/> <!-- Whether or not the start date field is required on assets using this metadata set NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="startDateFieldRequired" type="xsd:boolean"/> <!-- The visibility of the start date field for assets using this metadata set NOT REQUIRED default "visible" --> <element maxOccurs="1" minOccurs="0" name="startDateFieldVisibility" type="impl:metadata-field-visibility"/> <!-- Whether or not the summary field is required on assets using this metadata set NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="summaryFieldRequired" type="xsd:boolean"/> <!-- The visibility of the summary field for assets using this metadata set NOT REQUIRED default "visible" --> <element maxOccurs="1" minOccurs="0" name="summaryFieldVisibility" type="impl:metadata-field-visibility"/> <!-- Whether or not the teaser field is required on assets using this metadata set NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="teaserFieldRequired" type="xsd:boolean"/> <!-- The visibility of the teaser field for assets using this metadata set NOT REQUIRED default "visible" --> <element maxOccurs="1" minOccurs="0" name="teaserFieldVisibility" type="impl:metadata-field-visibility"/> <!-- Whether or not the title field is required on assets using this metadata set NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="titleFieldRequired" type="xsd:boolean"/> <!-- The visibility of the title field for assets using this metadata set NOT REQUIRED default "visible" --> <element maxOccurs="1" minOccurs="0" name="titleFieldVisibility" type="impl:metadata-field-visibility"/> <!-- The dynamic metadata field definitions --> <element maxOccurs="1" minOccurs="0" name="dynamicFields" type="impl:dynamic-metadata-field-definitions"/> </sequence> </extension> </complexContent> </complexType>

A Metadata Set extends Containered Asset. In addition to the fields provided by that complex type, the metadata set complex type implements all the fields as available from within the Cascade Server web interface when creating or editing. There are no required fields.

For each wired field, the user is able to specify both the visibility and whether or not that wired field is required. To specify the visibility, use a String defined in the following simple type restriction:

<simpleType name="metadata-field-visibility"> <restriction base="xsd:string"> <enumeration value="inline"/> <enumeration value="hidden"/> <enumeration value="visible"/> </restriction> </simpleType>

The available Strings are "inline" (which makes the field appear on all panes when editing), "hidden" (the field will not appear at all), or "visibile" (which is the default - the field will appear only on the "metadata" pane).

Defining Custom (Dynamic) Metadata Fields

A Metadata Set contains a list of Dynamic Metadata Field definitions, each of which define a custom metadata field (text field, radio buttons, or a dropdown/multiselect). A Dynamic Metadata Field Definition object is defined by the following complex type in the WSDL:

<complexType name="dynamicMetadataFieldDefinition"> <sequence> <!-- The name of the dynamic metadata field REQUIRED --> <element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/> <!-- The type of the dynamic metadata field REQUIRED --> <element maxOccurs="1" minOccurs="1" name="fieldType" type="impl:dynamic-metadata-field-type"/> <!-- Whether or not this field is required NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="required" type="xsd:boolean"/> <!-- The visibility of this field NOT REQUIRED default visible --> <element maxOccurs="1" minOccurs="0" name="visibility" type="impl:metadata-field-visibility"/> <!-- The XML configuration of this field REQUIRED --> <element maxOccurs="1" minOccurs="1" name="configurationXML" type="xsd:string"/> </sequence> </complexType>

Each Dynamic Metadata Field Definition has three required fields: name, the type of the field, and the configuration XML for that field. It is also possible to specify the visibility and whether or not that field is required, just like for the wired fields.

A Dynamic Metadata Field Definition's type is one of the Strings defined by the following simple type restriction:

<simpleType name="dynamic-metadata-field-type"> <restriction base="xsd:string"> <enumeration value="text"/> <enumeration value="radio"/> <enumeration value="dropdown"/> </restriction> </simpleType>

The available Strings are "text", "radio", and "dropdown".

Each dynamic field must also have an XML configuration. Text type definitions do not use this configuration, so it can be left blank (but must be included). A DTD for the Configuration XML for radio buttons and dropdowns is available from within the product. It is suggested that the configuration XML be surrounded in CDATA tags lest the SOAP processor think this XML is part of the SOAP message.

Comments

Wiki | Edit