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)

Target

A Target is defined in the following WSDL:

<complexType name="target"> <complexContent> <extension base="impl:named-asset"> <sequence> <!-- For defining the parent target relationship REQUIRED --> <choice> <element maxOccurs="1" minOccurs="1" name="parentTargetId" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="parentTargetPath" type="xsd:string"/> </choice> <!-- The path of this target. When creating this need not be specified. When editing this will be the CURRENT path of the target. --> <element maxOccurs="1" minOccurs="0" name="path" type="xsd:string"/> <!-- For defining the base folder relationship REQUIRED --> <choice> <element maxOccurs="1" minOccurs="1" name="baseFolderId" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="baseFolderPath" type="xsd:string"/> </choice> <!-- The output file extension, for example ".html" REQUIRED --> <element maxOccurs="1" minOccurs="1" name="outputExtension" type="xsd:string"/> <!-- The CSS classes that pages using this target will have available to them in the WYSIWYG editor (comma-delimted list) NOT REQUIRED default: empty --> <element maxOccurs="1" minOccurs="0" name="cssClasses" type="xsd:string"/> <!-- The file that defines the CSS classes in the cssClasses field NOT REQUIRED default: none --> <choice> <element maxOccurs="1" minOccurs="0" name="cssFileId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="cssFilePath" type="xsd:string"/> </choice> <!-- The content type this target serializes its output as REQUIRED --> <element maxOccurs="1" minOccurs="1" name="serializationType" type="impl:serialization-type"/> <!-- When the serializationType is "XML", should Cascade include the XML declaration in published files? NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="includeXMLDeclaration" type="xsd:boolean"/> <!-- When publishing, whether or not to include the target path as part of the path of the published file NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="includeTargetPath" type="xsd:boolean"/> <!-- When publishing, whether or not to remove the base folder's path from the path of the published file NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="removeBaseFolder" type="xsd:boolean"/> <!-- Whether or not to publish this target on a schedule NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="usesScheduledPublishing" type="xsd:boolean"/> <!-- The base time this target will be published. For example if one wanted this target to publish at 0100, 0500, 0900, 1300, 1700, 2100, I would enter one of those times here and set the "publishInterval" to 4, and the "publishIntervalUnits" to "hours" NOT REQUIRED default: 00:00 (midnight) --> <element maxOccurs="1" minOccurs="0" name="timeToPublish" type="xsd:time"/> <!-- The interval at which this target will be published NOT REQUIRED default: 1 --> <element maxOccurs="1" minOccurs="0" name="publishInterval" type="xsd:positiveInteger"/> <!-- The time unit for publishInterval NOT REQUIRED default: "hours" --> <element maxOccurs="1" minOccurs="0" name="publishIntervalUnits" type="impl:timeUnits"/> <!-- the array of children --> <element maxOccurs="1" minOccurs="0" name="children" nillable="true" type="impl:container-children"/> </sequence> </extension> </complexContent> </complexType>

A Target extends Named Asset. In addition to the fields provided by that complex type, the target complex type implements all the fields as available from within the Cascade Server web interface when creating or editing. The required fields are the parent folder relationship, base folder relationship, output file extension, and serialization type.

The searialization type is a String defined by the following simple type restriction:

<simpleType name="serialization-type"> <restriction base="xsd:string"> <enumeration value="HTML"/> <enumeration value="XML"/> <enumeration value="PDF"/> <enumeration value="RTF"/> <enumeration value="WML"/> </restriction> </simpleType>

The available serialization types are "HTML", "XML", "PDF", "RTF", and "WML".

The "children" element is only populated during a read operation. When creating or editing an Target, this element will be ignored. You will not be able to specify the children of this target in this manner. To do this, you will want to specify the parent target relationship using the elements "parentTargetId" or "parentTargetPath".

Scheduled Publishing

It is also possible to specify that this Target be published on a schedule. To do this, first enable scheduled publishing by setting the "usesScheduledPublishing" element to true. Then you must specify a base time to publish and an interval. The format for the base time to publish is "hh:mm"; the interval value is a positive integer, and the interval units are either "hours" or "days".

Comments

Wiki | Edit